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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-irremote-4.1.13.tar.gz
Algorithm Hash digest
SHA256 3684a8b9423f5a35352b3be8346cd11aaced5da868cb1d03bc9c20f21dddeacf
MD5 7978b050030faea37618007e659e86cd
BLAKE2b-256 32e571d839d96f15ab166febd87dbdd0b153d5775980aeeff18f172208ca67de

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_irremote-4.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 66c6d9cec8f7f0b88d1261a09a7353425c4eb2f961d2c1d41da1bbb5399b05ff
MD5 7de44ab21932a64a31452fa259fe54d5
BLAKE2b-256 25c6ad270e685bc445aa91400368b7747cdee781209c99603b44542b6b51249d

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