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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-irremote-4.1.10.tar.gz
Algorithm Hash digest
SHA256 c442eaf041b3b69ba3a433377dadff7dde10af932a8652bcb2b6222f328d7725
MD5 bb3dbb59deeb9f9946d2de105b2ecf55
BLAKE2b-256 e1c3dfeade51543f0e8568800e1493366ebc9d572a5a3a939ed5030d81d303f6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_irremote-4.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 3e27686d53f74dbb1d22036796b44f3c3f74242e2d472e81288d877b76a3e5a9
MD5 e96ffe5503a8166905151aa318df27f5
BLAKE2b-256 efa53f0e9e20a166b13b50b5a2dcba87c68a8347bb5d8cf0f6cac759c5c71645

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