Skip to main content

CircuitPython library for infrared transmit and receive.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_irremote-5.0.5.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_irremote-5.0.5.tar.gz
Algorithm Hash digest
SHA256 9dde752e844ec6a096134806f702f72c2bece729a76ba36121a1ba3fdd2b58b0
MD5 467b6957e0d107787435809cfa3d8c5d
BLAKE2b-256 c2631efc0d86a884bf31d9617bbaac00de53b98a06ac2d9ca321e453371acc0e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_irremote-5.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 91ea54e0426166eab4f8e85ffd747bc004b259f00f8d4a6a6348c702007ae311
MD5 c7b40c75b5bc227b6335b16294450639
BLAKE2b-256 71199832ee727196b9ce75551798f4ac61e04c0190960b96414a2a9507cfa624

See more details on using hashes here.

Supported by

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