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

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-irremote-4.1.18.tar.gz
Algorithm Hash digest
SHA256 d7878eb8891435d8a101fc32ce73587e72d1e1ef17bb784eb13f4a69fca4a372
MD5 f8752ee2330abe224b8f836bf01884ba
BLAKE2b-256 a1c7f933ac4a69e0281e5a8724ea1e88e4395bab4f0e4e80a303960bdf81bdbe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_irremote-4.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 ae63441f0d260ad36d51dca94134b5123e839270e923525423668ef6c72350e0
MD5 cbd0a09134706d060b7473b67f3ea682
BLAKE2b-256 1d30d5377214d0ef1b68c51be8e1900b3d67032c37af1d1bd57d9d93d5edef6a

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