IRremote Arduino Library
Available as Arduino library "IRremote"
This library enables you to send and receive using infra-red signals on an Arduino.
Tutorials and more information will be made available on the official homepage.
Click on the LibraryManager badge above to see the instructions.
- IR does not work right when I use Neopixels (aka WS2811/WS2812/WS2812B)
Whether you use the Adafruit Neopixel lib, or FastLED, interrupts get disabled on many lower end CPUs like the basic arduinos. In turn, this stops the IR interrupt handler from running when it needs to. There are some solutions to this on some processors, see this page from Marc MERLIN
- Arduino Uno / Mega / Leonardo / Duemilanove / Diecimila / LilyPad / Mini / Fio / Nano etc.
- Teensy 1.0 / 1.0++ / 2.0 / 2++ / 3.0 / 3.1 / Teensy-LC; Credits: @PaulStoffregen (Teensy Team)
- ATmega8, 48, 88, 168, 328
- ATmega8535, 16, 32, 164, 324, 644, 1284,
- ATmega64, 128
- ATtiny 84 / 85
- SAMD21 (receive only)
- ESP32 (receive only)
- ESP8266 is supported in a fork based on an old codebase that isn't as recent, but it works reasonably well given that perfectly timed sub millisecond interrupts are different on that chip. See https://github.com/markszabo/IRremoteESP8266
- Sparkfun Pro Micro
We are open to suggestions for adding support to new boards, however we highly recommend you contact your supplier first and ask them to provide support from their side.
|Atmega32u4||5, 9, 13||1, 3, 4|
|ATmega48, ATmega88, ATmega168, ATmega328||3, 9||1, 2|
|ATmega1284||13, 14, 6||1, 2, 3|
|ATmega164, ATmega324, ATmega644||13, 14||1, 2|
|ATmega8535 ATmega16, ATmega32||13||1|
|ATmega1280, ATmega2560||5, 6, 9, 11, 46||1, 2, 3, 4, 5|
|ESP32||N/A (not supported)||1|
|Sparkfun Pro Micro||9, 5, 5||1, 3, 4_HS|
|Teensy 2.0||9, 10, 14||1, 3, 4_HS|
|Teensy++ 1.0 / 2.0||1, 16, 25||1, 2, 3|
|Teensy 3.0 / 3.1||5||CMT|
The following are strictly community supported patches that have yet to make it into mainstream. If you have issues feel free to ask here. If it works well then let us know!
The table above lists the currently supported timers and corresponding send pins, many of these can have additional pins opened up and we are open to requests if a need arises for other pins.
- TODO (Check examples for now)
This project documents the library API using Doxygen.
It is planned to make generated and up-to-date API documentation available online.
To generate the API documentation,
Doxygen, as well as Graphviz should be installed.
(Note that on Windows, it may be necessary to add the Graphviz binary directory
PATH variable manually.)
With Doxygen and Graphviz installed, issue the command
doxygen from the command line in the main project directory, which will
generate the API documentation in HTML format.
The just generated
api-doc/index.html can now be opened in a browser.
If you want to contribute to this project:
- Report bugs and errors
- Ask for enhancements
- Create issues and pull requests
- Tell other people about this library
- Contribute new protocols
Check here for some guidelines.
Please only email me if it is more appropriate than creating an Issue / PR. I will not respond to requests for adding support for particular boards, unless of course you are the creator of the board and would like to cooperate on the project. I will also ignore any emails asking me to tell you how to implement your ideas. However, if you have a private inquiry that you would only apply to you and you would prefer it to be via email, by all means.
Copyright 2009-2012 Ken Shirriff