|
1 | | - |
2 | | - |
3 | | -[](../../actions/workflows/Build.yml) |
4 | | -[](../../actions/workflows/Lint.yml) |
5 | | -[](../../actions/workflows/UnitTests.yml) |
6 | | -[](../../actions/workflows/Documentation.yml/badge.svg) |
7 | | -[](https://www.ardu-badge.com/IRremoteESP8266) |
8 | | -[](https://gitlicense.com/license/crankyoldgit/IRremoteESP8266) |
9 | | - |
10 | | -This library enables you to **send _and_ receive** infra-red signals on an [ESP8266](https://github.com/esp8266/Arduino) or an |
11 | | -[ESP32](https://github.com/espressif/arduino-esp32) using the [Arduino framework](https://www.arduino.cc/) using common 940nm IR LEDs and common IR receiver modules. e.g. TSOP{17,22,24,36,38,44,48}* demodulators etc. |
12 | | - |
13 | | -## v2.8.6 Now Available |
14 | | -Version 2.8.6 of the library is now [available](https://github.com/crankyoldgit/IRremoteESP8266/releases/latest). You can view the [Release Notes](ReleaseNotes.md) for all the significant changes. |
15 | | - |
16 | | -#### Upgrading from pre-v2.0 |
17 | | -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 our [Upgrade to v2.0](https://github.com/crankyoldgit/IRremoteESP8266/wiki/Upgrading-to-v2.0) page. |
18 | | - |
19 | | -#### Upgrading from pre-v2.5 |
20 | | -The library has changed from using constants declared as `#define` to |
21 | | -[const](https://google.github.io/styleguide/cppguide.html#Constant_Names) with |
22 | | -the appropriate naming per the |
23 | | -[C++ style guide](https://google.github.io/styleguide/cppguide.html). |
24 | | -This may potentially cause old programs to not compile. |
25 | | -The most likely externally used `#define`s have been _aliased_ for limited |
26 | | -backward compatibility for projects using the old style. Going forward, only the |
27 | | -new `kConstantName` style will be supported for new protocol additions. |
28 | | - |
29 | | -In the unlikely case, it does break your code, then you may have been referencing |
30 | | -something you likely should not have. You should be able to quickly determine |
31 | | -the new name from the old. e.g. `CONSTANT_NAME` to `kConstantName`. |
32 | | -Use common sense or examining the library's code if this does affect code. |
33 | | - |
34 | | -## Supported Protocols |
35 | | -You can find the details of which protocols & devices are supported |
36 | | -[here](https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md). |
37 | | - |
38 | | -## Troubleshooting |
39 | | -Before reporting an issue or asking for help, please try to follow our [Troubleshooting Guide](https://github.com/crankyoldgit/IRremoteESP8266/wiki/Troubleshooting-Guide) first. |
40 | | - |
41 | | -## Frequently Asked Questions |
42 | | -Some common answers to common questions and problems are on our [F.A.Q. wiki page](https://github.com/crankyoldgit/IRremoteESP8266/wiki/Frequently-Asked-Questions). |
43 | | - |
44 | | -## Library API Documentation |
45 | | -This library uses [Doxygen](https://www.doxygen.nl/index.html) to [automatically document](https://crankyoldgit.github.io/IRremoteESP8266/doxygen/html/) the [library's](https://crankyoldgit.github.io/IRremoteESP8266/doxygen/html/) [API](https://en.wikipedia.org/wiki/Application_programming_interface). |
46 | | -You can find it [here](https://crankyoldgit.github.io/IRremoteESP8266/doxygen/html/). |
47 | | - |
48 | | -## Installation |
49 | | -##### Official releases via the Arduino IDE v1.8+ (Windows & Linux) |
50 | | -1. Click the _"Sketch"_ -> _"Include Library"_ -> _"Manage Libraries..."_ Menu items. |
51 | | -1. Enter `IRremoteESP8266` into the _"Filter your search..."_ top right search box. |
52 | | -1. Click on the IRremoteESP8266 result of the search. |
53 | | -1. Select the version you wish to install and click _"Install"_. |
54 | | - |
55 | | -##### Manual Installation for Windows |
56 | | -1. Click on _"Clone or Download"_ button, then _"[Download ZIP](https://github.com/crankyoldgit/IRremoteESP8266/archive->master.zip)"_ on the page. |
57 | | -1. Extract the contents of the downloaded zip file. |
58 | | -1. Rename the extracted folder to _"IRremoteESP8266"_. |
59 | | -1. Move this folder to your libraries directory. (under windows: `C:\Users\YOURNAME\Documents\Arduino\libraries\`) |
60 | | -1. Restart your Arduino IDE. |
61 | | -1. Check out the examples. |
62 | | - |
63 | | -##### Using Git to install the library ( Linux ) |
64 | | -``` |
65 | | -cd ~/Arduino/libraries |
66 | | -git clone https://github.com/crankyoldgit/IRremoteESP8266.git |
67 | | -``` |
68 | | -###### To update to the latest version of the library |
69 | | -``` |
70 | | -cd ~/Arduino/libraries/IRremoteESP8266 && git pull |
71 | | -``` |
72 | | - |
73 | | -## Contributing |
74 | | -If you want to [contribute](.github/CONTRIBUTING.md#how-can-i-contribute) to this project, consider: |
75 | | -- [Reporting](.github/CONTRIBUTING.md#reporting-bugs) bugs and errors |
76 | | -- Ask for enhancements |
77 | | -- Improve our documentation |
78 | | -- [Creating issues](.github/CONTRIBUTING.md#reporting-bugs) and [pull requests](.github/CONTRIBUTING.md#pull-requests) |
79 | | -- Tell other people about this library |
80 | | - |
81 | | -## Contributors |
82 | | -Available [here](.github/Contributors.md) |
83 | | - |
84 | | -## Library History |
85 | | -This library was originally based on Ken Shirriff's work (https://github.com/shirriff/Arduino-IRremote/) |
86 | | - |
87 | | -[Mark Szabo](https://github.com/crankyoldgit/IRremoteESP8266) has updated the IRsend class to work on ESP8266 and [Sebastien Warin](https://github.com/sebastienwarin/IRremoteESP8266) the receiving & decoding part (IRrecv class). |
88 | | - |
89 | | -As of v2.0, the library was almost entirely re-written with the ESP8266's resources in mind. |
| 1 | + |
| 2 | + |
| 3 | +[](../../actions/workflows/Build.yml) |
| 4 | +[](../../actions/workflows/Lint.yml) |
| 5 | +[](../../actions/workflows/UnitTests.yml) |
| 6 | +[](../../actions/workflows/Documentation.yml/badge.svg) |
| 7 | +[](https://www.ardu-badge.com/IRremoteESP8266) |
| 8 | +[](https://gitlicense.com/license/crankyoldgit/IRremoteESP8266) |
| 9 | + |
| 10 | +This library enables you to **send _and_ receive** infra-red signals on an [ESP8266](https://github.com/esp8266/Arduino) or an |
| 11 | +[ESP32](https://github.com/espressif/arduino-esp32) using the [Arduino framework](https://www.arduino.cc/) using common 940nm IR LEDs and common IR receiver modules. e.g. TSOP{17,22,24,36,38,44,48}* demodulators etc. |
| 12 | + |
| 13 | +## v2.8.7 Now Available |
| 14 | +Version 2.8.7 of the library is now [available](https://github.com/crankyoldgit/IRremoteESP8266/releases/latest). You can view the [Release Notes](ReleaseNotes.md) for all the significant changes. |
| 15 | + |
| 16 | +#### Upgrading from pre-v2.0 |
| 17 | +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 our [Upgrade to v2.0](https://github.com/crankyoldgit/IRremoteESP8266/wiki/Upgrading-to-v2.0) page. |
| 18 | + |
| 19 | +#### Upgrading from pre-v2.5 |
| 20 | +The library has changed from using constants declared as `#define` to |
| 21 | +[const](https://google.github.io/styleguide/cppguide.html#Constant_Names) with |
| 22 | +the appropriate naming per the |
| 23 | +[C++ style guide](https://google.github.io/styleguide/cppguide.html). |
| 24 | +This may potentially cause old programs to not compile. |
| 25 | +The most likely externally used `#define`s have been _aliased_ for limited |
| 26 | +backward compatibility for projects using the old style. Going forward, only the |
| 27 | +new `kConstantName` style will be supported for new protocol additions. |
| 28 | + |
| 29 | +In the unlikely case, it does break your code, then you may have been referencing |
| 30 | +something you likely should not have. You should be able to quickly determine |
| 31 | +the new name from the old. e.g. `CONSTANT_NAME` to `kConstantName`. |
| 32 | +Use common sense or examining the library's code if this does affect code. |
| 33 | + |
| 34 | +## Supported Protocols |
| 35 | +You can find the details of which protocols & devices are supported |
| 36 | +[here](https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md). |
| 37 | + |
| 38 | +## Troubleshooting |
| 39 | +Before reporting an issue or asking for help, please try to follow our [Troubleshooting Guide](https://github.com/crankyoldgit/IRremoteESP8266/wiki/Troubleshooting-Guide) first. |
| 40 | + |
| 41 | +## Frequently Asked Questions |
| 42 | +Some common answers to common questions and problems are on our [F.A.Q. wiki page](https://github.com/crankyoldgit/IRremoteESP8266/wiki/Frequently-Asked-Questions). |
| 43 | + |
| 44 | +## Library API Documentation |
| 45 | +This library uses [Doxygen](https://www.doxygen.nl/index.html) to [automatically document](https://crankyoldgit.github.io/IRremoteESP8266/doxygen/html/) the [library's](https://crankyoldgit.github.io/IRremoteESP8266/doxygen/html/) [API](https://en.wikipedia.org/wiki/Application_programming_interface). |
| 46 | +You can find it [here](https://crankyoldgit.github.io/IRremoteESP8266/doxygen/html/). |
| 47 | + |
| 48 | +## Installation |
| 49 | +##### Official releases via the Arduino IDE v1.8+ (Windows & Linux) |
| 50 | +1. Click the _"Sketch"_ -> _"Include Library"_ -> _"Manage Libraries..."_ Menu items. |
| 51 | +1. Enter `IRremoteESP8266` into the _"Filter your search..."_ top right search box. |
| 52 | +1. Click on the IRremoteESP8266 result of the search. |
| 53 | +1. Select the version you wish to install and click _"Install"_. |
| 54 | + |
| 55 | +##### Manual Installation for Windows |
| 56 | +1. Click on _"Clone or Download"_ button, then _"[Download ZIP](https://github.com/crankyoldgit/IRremoteESP8266/archive->master.zip)"_ on the page. |
| 57 | +1. Extract the contents of the downloaded zip file. |
| 58 | +1. Rename the extracted folder to _"IRremoteESP8266"_. |
| 59 | +1. Move this folder to your libraries directory. (under windows: `C:\Users\YOURNAME\Documents\Arduino\libraries\`) |
| 60 | +1. Restart your Arduino IDE. |
| 61 | +1. Check out the examples. |
| 62 | + |
| 63 | +##### Using Git to install the library ( Linux ) |
| 64 | +``` |
| 65 | +cd ~/Arduino/libraries |
| 66 | +git clone https://github.com/crankyoldgit/IRremoteESP8266.git |
| 67 | +``` |
| 68 | +###### To update to the latest version of the library |
| 69 | +``` |
| 70 | +cd ~/Arduino/libraries/IRremoteESP8266 && git pull |
| 71 | +``` |
| 72 | + |
| 73 | +## Contributing |
| 74 | +If you want to [contribute](.github/CONTRIBUTING.md#how-can-i-contribute) to this project, consider: |
| 75 | +- [Reporting](.github/CONTRIBUTING.md#reporting-bugs) bugs and errors |
| 76 | +- Ask for enhancements |
| 77 | +- Improve our documentation |
| 78 | +- [Creating issues](.github/CONTRIBUTING.md#reporting-bugs) and [pull requests](.github/CONTRIBUTING.md#pull-requests) |
| 79 | +- Tell other people about this library |
| 80 | + |
| 81 | +## Contributors |
| 82 | +Available [here](.github/Contributors.md) |
| 83 | + |
| 84 | +## Library History |
| 85 | +This library was originally based on Ken Shirriff's work (https://github.com/shirriff/Arduino-IRremote/) |
| 86 | + |
| 87 | +[Mark Szabo](https://github.com/crankyoldgit/IRremoteESP8266) has updated the IRsend class to work on ESP8266 and [Sebastien Warin](https://github.com/sebastienwarin/IRremoteESP8266) the receiving & decoding part (IRrecv class). |
| 88 | + |
| 89 | +As of v2.0, the library was almost entirely re-written with the ESP8266's resources in mind. |
0 commit comments