Skip to content

Latest commit

 

History

History
102 lines (72 loc) · 2.97 KB

README.md

File metadata and controls

102 lines (72 loc) · 2.97 KB
Raw

ESP8266-RTOS-IR

Infrared rx/tx library for 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 you should add the following line to $IDF_PATH/components/freertos/port/esp8266/include/freertos/FreeRTOSConfig.h manually.

#define INCLUDE_xTimerPendFunctionCall  1

Then you can clone this project inside your components folder.

Usage

Example sending command:

#include <ir/ir.h>
#include <ir/raw.h>

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:

#include <ir/ir.h>
#include <ir/generic.h>

#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 file for more details.

This library is based on maximkulkin/esp-ir which works with esp-open-rtos instead of the official espressif SDK.