Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-irremote/badge/?version=latest
:target: https://docs.circuitpython.org/projects/irremote/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_IRRemote/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_IRRemote/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
CircuitPython driver for use with IR Receivers.
Examples of products to use this library with:
* `Circuit Playground Express <https://www.adafruit.com/product/3333>`_
* `IR Receiver Sensor <https://www.adafruit.com/product/157>`_
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
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>`_.
Installing from PyPI
====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-irremote/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-irremote
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-irremote
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-irremote
Usage Example
=============
.. code-block:: python
# 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 <https://docs.circuitpython.org/projects/irremote/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_IRRemote/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-irremote",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, infrared, transmit, receive, tx, rx, ir, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/62/60/b42c3713700a1d8deaac5058bb48479d14a3392cee249929d6018cd9a040/adafruit_circuitpython_irremote-5.0.2.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-irremote/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/irremote/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_IRRemote/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_IRRemote/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython driver for use with IR Receivers.\n\nExamples of products to use this library with:\n\n* `Circuit Playground Express <https://www.adafruit.com/product/3333>`_\n\n* `IR Receiver Sensor <https://www.adafruit.com/product/157>`_\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-irremote/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-irremote\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-irremote\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-irremote\n\nUsage Example\n=============\n\n.. code-block:: python\n\n # Circuit Playground Express Demo Code\n # Adjust the pulseio 'board.PIN' if using something else\n import pulseio\n import board\n import adafruit_irremote\n\n pulsein = pulseio.PulseIn(board.REMOTEIN, maxlen=120, idle_state=True)\n decoder = adafruit_irremote.GenericDecode()\n\n\n while True:\n pulses = decoder.read_pulses(pulsein)\n print(\"Heard\", len(pulses), \"Pulses:\", pulses)\n try:\n code = decoder.decode_bits(pulses)\n print(\"Decoded:\", code)\n except adafruit_irremote.IRNECRepeatException: # unusual short code!\n print(\"NEC repeat!\")\n except adafruit_irremote.IRDecodeException as e: # failed to decode\n print(\"Failed to decode: \", e.args)\n\n print(\"----------------------------\")\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/irremote/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_IRRemote/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for infrared transmit and receive.",
"version": "5.0.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_IRRemote"
},
"split_keywords": [
"adafruit",
" infrared",
" transmit",
" receive",
" tx",
" rx",
" ir",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3094a509faf5f81be47e153777d0dc8e97f71ba003e9c753c8dcf00c623cf149",
"md5": "5b380f46ad11ea09647d4b0c1882c3e8",
"sha256": "4cd857eb0fa794a0dc99cfd612a257888a957e8f5192cc89a3b508b529b06746"
},
"downloads": -1,
"filename": "adafruit_circuitpython_irremote-5.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5b380f46ad11ea09647d4b0c1882c3e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8139,
"upload_time": "2024-10-07T22:01:15",
"upload_time_iso_8601": "2024-10-07T22:01:15.298400Z",
"url": "https://files.pythonhosted.org/packages/30/94/a509faf5f81be47e153777d0dc8e97f71ba003e9c753c8dcf00c623cf149/adafruit_circuitpython_irremote-5.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6260b42c3713700a1d8deaac5058bb48479d14a3392cee249929d6018cd9a040",
"md5": "18216aec7bb019bb126cc87500993e68",
"sha256": "4eddfd8d204a6ec5169c8a99a205dce61ac09967d391405c8336e4196a233f01"
},
"downloads": -1,
"filename": "adafruit_circuitpython_irremote-5.0.2.tar.gz",
"has_sig": false,
"md5_digest": "18216aec7bb019bb126cc87500993e68",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29348,
"upload_time": "2024-10-07T22:01:16",
"upload_time_iso_8601": "2024-10-07T22:01:16.865481Z",
"url": "https://files.pythonhosted.org/packages/62/60/b42c3713700a1d8deaac5058bb48479d14a3392cee249929d6018cd9a040/adafruit_circuitpython_irremote-5.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:01:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_IRRemote",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-irremote"
}
JSON
