Introduction

CircuitPython driver for use with IR Receivers.

Examples of products to use this library with:

• Circuit Playground Express
• IR Receiver Sensor

Dependencies

This driver depends on:

• Adafruit CircuitPython

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 .env
source .env/bin/activate
pip3 install adafruit-circuitpython-irremote

Usage Example

# Circuit Playground Express Demo Code# Adjust the pulseio 'board.PIN' if using something elseimportpulseioimportboardimportadafruit_irremotepulsein=pulseio.PulseIn(board.REMOTEIN, maxlen=120, idle_state=True)
decoder=adafruit_irremote.GenericDecode()
# size must match what you are decoding! for NEC use 4received_code=bytearray(4)
whileTrue:
pulses=decoder.read_pulses(pulsein)
print("Heard", len(pulses), "Pulses:", pulses)
try:
code=decoder.decode_bits(pulses, debug=False)
print("Decoded:", code)
exceptadafruit_irremote.IRNECRepeatException: # unusual short code!print("NEC repeat!")
exceptadafruit_irremote.IRDecodeExceptionase: # failed to decodeprint("Failed to decode: ", e.args)
print("----------------------------")

Contributing

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

Documentation

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