Repository files navigation

This library enables you tosendand receive infra-red signals on anESP8266 or anESP32 using theArduino framework using common 940nm IR LEDs and common IR receiver modules. e.g. TSOP{17,22,24,36,38,44,48}* demodulators etc.

Version 2.8.6 of the library is nowavailable. You can view theRelease Notes for all the significant changes.

Usage of the library has been slightly changed in v2.0. You will need to change your usage to work with v2.0 and beyond. You can read more about the changes required on ourUpgrade to v2.0 page.

The library has changed from using constants declared as#define toconst withthe appropriate naming per theC++ style guide.This may potentially cause old programs to not compile.The most likely externally used#defines have beenaliased for limitedbackward compatibility for projects using the old style. Going forward, only thenewkConstantName style will be supported for new protocol additions.

In the unlikely case, it does break your code, then you may have been referencingsomething you likely should not have. You should be able to quickly determinethe new name from the old. e.g.CONSTANT_NAME tokConstantName.Use common sense or examining the library's code if this does affect code.

You can find the details of which protocols & devices are supportedhere.

Before reporting an issue or asking for help, please try to follow ourTroubleshooting Guide first.

Some common answers to common questions and problems are on ourF.A.Q. wiki page.

This library usesDoxygen toautomatically document thelibrary'sAPI.You can find ithere.

1. Click the"Sketch" ->"Include Library" ->"Manage Libraries..." Menu items.
2. EnterIRremoteESP8266 into the"Filter your search..." top right search box.
3. Click on the IRremoteESP8266 result of the search.
4. Select the version you wish to install and click"Install".

1. Click on"Clone or Download" button, then"Download ZIP" on the page.
2. Extract the contents of the downloaded zip file.
3. Rename the extracted folder to"IRremoteESP8266".
4. Move this folder to your libraries directory. (under windows:C:\Users\YOURNAME\Documents\Arduino\libraries\)
5. Restart your Arduino IDE.
6. Check out the examples.

cd ~/Arduino/librariesgit clone https://github.com/crankyoldgit/IRremoteESP8266.git

cd ~/Arduino/libraries/IRremoteESP8266 && git pull

If you want tocontribute to this project, consider:

• Reporting bugs and errors
• Ask for enhancements
• Improve our documentation
• Creating issues andpull requests
• Tell other people about this library

Availablehere

This library was originally based on Ken Shirriff's work (https://github.com/shirriff/Arduino-IRremote/)

Mark Szabo has updated the IRsend class to work on ESP8266 andSebastien Warin the receiving & decoding part (IRrecv class).

As of v2.0, the library was almost entirely re-written with the ESP8266's resources in mind.