87 lines
4.7 KiB
Markdown
87 lines
4.7 KiB
Markdown
# IRremote ESP8266 Library
|
|
|
|
[](https://travis-ci.org/markszabo/IRremoteESP8266)
|
|
[](http://isitmaintained.com/project/markszabo/IRremoteESP8266 "Average time to resolve an issue")
|
|
[](http://isitmaintained.com/project/markszabo/IRremoteESP8266 "Percentage of issues still open")
|
|
[](https://gitlicense.com/license/markszabo/IRremoteESP8266)
|
|
|
|
This library enables you to **send _and_ receive** infra-red signals on an [ESP8266 using the Arduino framework](https://github.com/esp8266/Arduino) using common 940nm IR LEDs and common IR receiver modules. e.g. TSOP{17,22,24,36,38,44,48}* etc.
|
|
|
|
## v2.3.2 Now Available
|
|
Version 2.3.2 of the library is now [available](https://github.com/markszabo/IRremoteESP8266/releases/latest). You can view the [Release Notes](ReleaseNotes.md) for all the significant changes.
|
|
|
|
#### Upgrading from pre-v2.0
|
|
Usage of the library slight changed at 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/markszabo/IRremoteESP8266/wiki/Upgrading-to-v2.0) page.
|
|
|
|
## Troubleshooting
|
|
Before reporting an issue or asking for help, please try to follow our [Troubleshooting Guide](https://github.com/markszabo/IRremoteESP8266/wiki/Troubleshooting-Guide) first.
|
|
|
|
## Frequently Asked Questions
|
|
Some common answers to common questions and problems are on our [F.A.Q. wiki page](https://github.com/markszabo/IRremoteESP8266/wiki/Frequently-Asked-Questions).
|
|
|
|
## Library History
|
|
This library was originally based on Ken Shirriff's work (https://github.com/shirriff/Arduino-IRremote/)
|
|
|
|
[Mark Szabo](https://github.com/markszabo/IRremoteESP8266) has updated the IRsend class to work on ESP8266 and [Sebastien Warin](https://github.com/sebastienwarin/IRremoteESP8266) the receiving & decoding part (IRrecv class).
|
|
|
|
As of v2.0, the library was almost entirely re-written with the ESP8266's resources in mind.
|
|
|
|
## Installation
|
|
##### Official releases via the Arduino IDE v1.8+ (Windows & Linux)
|
|
1. Click the _"Sketch"_ -> _"Include Library"_ -> _"Manage Libraries..."_ Menu items.
|
|
1. Enter `IRremoteESP8266` into the _"Filter your search..."_ top right search box.
|
|
1. Click on the IRremoteESP8266 result of the search.
|
|
1. Select the version you wish to install and click _"Install"_.
|
|
|
|
##### Manual Installation for Windows
|
|
1. Click on _"Clone or Download"_ button, then _"[Download ZIP](https://github.com/markszabo/IRremoteESP8266/archive->master.zip)"_ on the page.
|
|
1. Extract the contents of the downloaded zip file.
|
|
1. Rename the extracted folder to _"IRremoteESP8266"_.
|
|
1. Move this folder to your libraries directory. (under windows: `C:\Users\YOURNAME\Documents\Arduino\libraries\`)
|
|
1. Restart your Arduino IDE.
|
|
1. Check out the examples.
|
|
|
|
##### Using Git to install library ( Linux )
|
|
```
|
|
cd ~/Arduino/libraries
|
|
git clone https://github.com/markszabo/IRremoteESP8266.git
|
|
```
|
|
###### To Update to the latest version of the library
|
|
```
|
|
cd ~/Arduino/libraries/IRremoteESP8266 && git pull
|
|
```
|
|
|
|
## Unit Tests
|
|
_**For Library Developers**_<br>
|
|
The [Unit Tests](https://en.wikipedia.org/wiki/Unit_testing) under the [test/](https://github.com/markszabo/IRremoteESP8266/tree/master/test) directory are for a Unix machine, **not** the micro-controller (ESP8266).
|
|
The tests are for execution under [Travis](https://travis-ci.org/) and on a developer's machine.
|
|
All internal library code _must_ use [c99 exact-width type definitions](https://en.wikipedia.org/wiki/C_data_types#Fixed-width_integer_types).
|
|
e.g. uint16_t etc.
|
|
You _must_ disable any Arduino/ESP8266 specific code _(e.g. `Serial.print()` etc.)_ using something like:
|
|
```
|
|
#ifndef UNIT_TEST
|
|
<Arduino specific code ...>
|
|
#endif
|
|
```
|
|
|
|
Unit Tests & Test Coverage are not perfect as we can not emulate hardware specific features and differences. e.g. Interrupts, GPIOs, CPU instruction timing etc, etc.
|
|
|
|
The example code has no unit tests.
|
|
|
|
To run all the tests yourself, try the following:
|
|
```
|
|
$ cd test
|
|
$ make run
|
|
```
|
|
|
|
## Contributing
|
|
If you want to [contribute](.github/CONTRIBUTING.md#how-can-i-contribute) to this project, consider:
|
|
- [Report](.github/CONTRIBUTING.md#reporting-bugs) bugs and errors
|
|
- Ask for enhancements
|
|
- Improve our documentation
|
|
- [Create issues](.github/CONTRIBUTING.md#reporting-bugs) and [pull requests](.github/CONTRIBUTING.md#pull-requests)
|
|
- Tell other people about this library
|
|
|
|
## Contributors
|
|
Available [here](.github/Contributors.md)
|