Introduction

.. image:: https://readthedocs.org/projects/makers-circuitpython-remote_control/badge/?version=latest :target: https://makers-circuitpython-remote-control.readthedocs.io/en/latest/ :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg :target: https://adafru.it/discord :alt: Discord

.. image:: https://travis-ci.org/fmorton/Makers_CircuitPython_remote_control.svg?branch=master :target: https://travis-ci.org/fmorton/Makers_CircuitPython_remote_control :alt: Build Status

CircuitPython helper for remote controls

Examples of products to use this library with:

• Circuit Playground Express <https://www.adafruit.com/product/3333>_
• Mini Remote Control <https://www.adafruit.com/product/389>_

Dependencies

This driver depends on:

• Adafruit CircuitPython <https://github.com/adafruit/circuitpython>_
• Adafruit CircuitPython drivers for IR remote send and receive <https://github.com/adafruit/Adafruit_CircuitPython_IRRemote>_

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>_.

Usage Example

.. code-block:: python

import time import makers_remote_control

remote_control = makers_remote_control.RemoteControl(debug=False)

while True: code = remote_control.code()

  if code == remote_control.UP:
      print("Faster")
  elif code == remote_control.DOWN:
      print("Slower")
  elif code == remote_control.LEFT:
      print("Left")
  elif code == remote_control.RIGHT:
      print("Right")
  elif code == 4:
      print("Something for Four")
  elif code == 6:
      print("Something for Six")
  elif code != remote_control.UNKNOWN:
      print("Code: ", code)

  time.sleep(0.1)

Contributing

Contributions are welcome! Please read our Code of Conduct <https://github.com/fmorton/Makers_CircuitPython_remote_control/blob/master/CODE_OF_CONDUCT.md>_ before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you'll need to install the circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>_ package.

.. code-block:: shell

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

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

.. code-block:: shell

source .env/bin/activate

Then run the build:

.. code-block:: shell

circuitpython-build-bundles --filename_prefix makers-circuitpython-remote_control --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):

.. code-block:: shell

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

Now, once you have the virtual environment activated:

.. code-block:: shell

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.