Skip to content
CircuitPython drivers for IR remote send and receive
Branch: master
Clone or download
Latest commit 19894fa May 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs formatting update Feb 28, 2018
examples Fixed Travis Errors May 11, 2019
.gitignore PyPi setup. Aug 6, 2018
.pylintrc PyPi setup. Aug 6, 2018
.readthedocs.yml updated .travis & .readthedocs yml Feb 27, 2018
.travis.yml
CODE_OF_CONDUCT.md Initial commit with rough testing code. Apr 12, 2017
LICENSE Initial commit with rough testing code. Apr 12, 2017
README.rst change 'travis-ci.org' to 'travis-ci.com' Dec 21, 2018
adafruit_irremote.py fix read_pulses for pylint by having one positional arg Dec 3, 2018
requirements.txt Initial commit with rough testing code. Apr 12, 2017
setup.py PyPi setup. Aug 6, 2018

README.rst

Introduction

Documentation Status Discord Build Status

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.

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()

# size must match what you are decoding! for NEC use 4
received_code = bytearray(4)

while True:
    pulses = decoder.read_pulses(pulsein)
    print("Heard", len(pulses), "Pulses:", pulses)
    try:
        code = decoder.decode_bits(pulses, debug=False)
        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("----------------------------")

Contributing

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

Building locally

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-irremote --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

You can’t perform that action at this time.