Skip to main content

CircuitPython library for infrared transmit and receive.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

CircuitPython driver for use with IR Receivers.

Examples of products to use this library with:

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-irremote

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-irremote

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-irremote

Usage Example

# Circuit Playground Express Demo Code
# Adjust the pulseio 'board.PIN' if using something else
import pulseio
import board
import adafruit_irremote

pulsein = pulseio.PulseIn(board.REMOTEIN, maxlen=120, idle_state=True)
decoder = adafruit_irremote.GenericDecode()


while True:
    pulses = decoder.read_pulses(pulsein)
    print("Heard", len(pulses), "Pulses:", pulses)
    try:
        code = decoder.decode_bits(pulses)
        print("Decoded:", code)
    except adafruit_irremote.IRNECRepeatException:  # unusual short code!
        print("NEC repeat!")
    except adafruit_irremote.IRDecodeException as e:     # failed to decode
        print("Failed to decode: ", e.args)

    print("----------------------------")

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-irremote-4.1.14.tar.gz (29.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-irremote-4.1.14.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-irremote-4.1.14.tar.gz
Algorithm Hash digest
SHA256 b92c476cf1503e394b259dc6cc5fa768964e2750d75dd27939242857c5236910
MD5 ba738e23901ab52df6ebc6231edf579f
BLAKE2b-256 51ab790aaba86b0b6a5207491560347d23225355edefd7cb9ac8569f5a421e75

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_irremote-4.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_irremote-4.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 46c6cd9c1ac5879ac67a663011070c6a9a44aa46c4b8253db6b0845d89aaf3c1
MD5 112ef5c98efe9b54e8307ea8c164daf9
BLAKE2b-256 d8657316f77983264143167d2ca4438a480c4f239cbd05335864ab0e4fe12413

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page