https://github.com/fonger/esp8266-rtos-ir
Infrared remote control library for latest ESP8266 RTOS SDK 3.2, esp-idf style
https://github.com/fonger/esp8266-rtos-ir
esp-idf esp8266 esp8266-rtos espressif infrared ir-remote rtos
Last synced: about 1 month ago
JSON representation
Infrared remote control library for latest ESP8266 RTOS SDK 3.2, esp-idf style
- Host: GitHub
- URL: https://github.com/fonger/esp8266-rtos-ir
- Owner: Fonger
- License: mit
- Created: 2019-09-09T06:03:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-09-11T08:54:22.000Z (over 5 years ago)
- Last Synced: 2025-03-17T15:01:44.260Z (about 1 month ago)
- Topics: esp-idf, esp8266, esp8266-rtos, espressif, infrared, ir-remote, rtos
- Language: C
- Homepage:
- Size: 34.2 KB
- Stars: 15
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ESP8266-RTOS-IR
Infrared rx/tx library for [espressif/ESP8266_RTOS_SDK](https://github.com/espressif/ESP8266_RTOS_SDK) (v3.2+, esp-idf style) to send and receive IR commands.
Receiving IR codes can be done on arbitrary pin (which supports GPIO mode and pin change interrupts),
**transmission though can only be done on `GPIO14`**.
This library use i2s WS pin to send accurate 38KHz IR signals with 50% duty cycle without blocking CPU like other libraries do.
Recently, espressif has released official IR feature (`driver/ir-rx.h` `driver/ir-tx.h`) in master branch but this library is more lightweight.
## Compatibility
ESP8266_RTOS_SDK v3.2+
## Installation
Because of [this issue #663](https://github.com/espressif/ESP8266_RTOS_SDK/issues/663) you should add the following line to `$IDF_PATH/components/freertos/port/esp8266/include/freertos/FreeRTOSConfig.h` manually.
```c
#define INCLUDE_xTimerPendFunctionCall 1
```
Then you can clone this project inside your components folder.
## Usage
Example sending command:
```c
#include
#include
static int16_t[] command1 = {
3291, -1611,
443, -370, 425, -421, 421, -1185, 424, -422,
421, -1185, 425, -421, 421, -370, 424, -392,
448, -1188, 423, -1214, 444, -372, 422, -395,
447, -397, 420, -1186, 449, -1185, 424, -423,
419, -375, 441, -372, 423, -422, 420, -372,
444, -370, 424, -422, 420, -372, 421, -393,
424, -421, 421, -371, 422, -392, 449, -398,
420, -1185, 450, -396, 421, -370, 422, -423,
};
ir_tx_init();
ir_raw_send(command1, sizeof(command1) / sizeof(*command1));
```
Example receiving NEC-like command:
```c
#include
#include
#define IR_RX_GPIO 12
static ir_generic_config_t my_protocol_config = {
.header_mark = 3200,
.header_space = -1600,
.bit1_mark = 400,
.bit1_space = -1200,
.bit0_mark = 400,
.bit0_space = -400,
.footer_mark = 400,
.footer_space = -8000,
.tolerance = 10,
};
ir_rx_init(IR_RX_GPIO, 1024);
ir_decoder_t *generic_decoder = ir_generic_make_decoder(&my_protocol_config);
uint8_t buffer[32];
while (1) {
uint16_t size = ir_recv(generic_decoder, 0, buffer, sizeof(buffer));
if (size <= 0)
continue;
printf("Decoded packet (size = %d): ", size);
for (int i=0; i < size; i++) {
printf("0x%02x ", buffer[i]);
if (i % 16 == 15)
// newline after every 16 bytes of packet data
printf("\n");
}
if (size % 16)
// print final newline unless packet size is multiple of 16 and newline
// was printed inside of loop
printf("\n");
}
```
## License
MIT licensed. See the bundled [LICENSE](https://github.com/Fonger/ESP8266-RTOS-IR/blob/master/LICENSE) file for more details.
This library is based on [maximkulkin/esp-ir](https://github.com/maximkulkin/esp-ir) which works with [esp-open-rtos](https://github.com/SuperHouse/esp-open-rtos) instead of the official espressif SDK.