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.8.tar.gz (30.8 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-irremote-4.1.8.tar.gz
Algorithm Hash digest
SHA256 62500a05c7255034e22b5b8c8d2dc874615798f98cdb4405949e110da948b427
MD5 36f934a15f24d89849c9f519d926790b
BLAKE2b-256 e066d229055b1d417dbc45ed3f445d92aabcd1adcaea39e672ecb86b46099833

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_irremote-4.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 aa6b519e229bc2c593f52a19fe5e475a462ce5c4663b1c3396b8f237c37f948e
MD5 6b4a26848226f2a0983ff55a9ef5a334
BLAKE2b-256 ec847914e881f59d8b3190f61fbf33d0c1125c34e0e3d4444b2046b739ac5151

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