Nano running AllProtocol example | YouTube Video | Instructable |
---|---|---|
![]() |
![]() |
![]() |
Sony SIRCS
NEC + APPLE + ONKYO
Samsung + Samsg32
Kaseikyo
JVC
NEC16 + NEC42
Matsushita
DENON
Sharp
RC5
RC6 & RC6A
IR60 (SDA2008) Grundig
Siemens Gigaset
Nokia
BOSE
Kathrein
NUBERT
FAN (ventilator)
SPEAKER (~NUBERT)
Bang & Olufsen
RECS80 (SAA3004)
RECS80EXT (SAA3008)
Thomson
NIKON camera
Netbox keyboard
ORTEK (Hama)
Telefunken 1560
FDC3402 keyboard
RC Car
iRobot Roomba
RUWIDO
T-Home
A1 TV BOX
LEGO Power RC
RCMM 12,24, or 32
LG Air Condition
Samsung48
Merlin
Pentax
S100
ACP24
TECHNICS
PANASONIC Beamer
Mitsubishi Aircond
VINCENT
SAMSUNG AH
GREE CLIMATE
RCII T+A
RADIO e.g. TEVION
METZ
NEC
Kaseiko
Denon
RC6
Samsung + Samsg32
were successfully tested in interrupt mode, but there are many protocols which in principle cannot be decoded in this mode.
For applications only requiring NEC protocol, there is a receiver which has very small codesize of 500 bytes and does NOT require any timer. See the MinimalReceiver and IRDispatcherDemo example how to use it. Mapping of pins to interrupts can be found here.
The VS1838B is used as receiver for all examples and tests. This module has a 120 µs on/low and a 100 µs off/high delay between received signal and output. So it shortens the mark and extends the space by 20 µs. | IR-Receiver connection | Serial LCD connection |
---|---|---|
![]() |
![]() |
For ESP8266/ESP32, this library supports an impressive set of protocols and a lot of air conditioners ATtiny and Digispark boards are tested with the recommended ATTinyCore using New Style pin mapping for the pro board. |
Architecture | CPU | Board |
---|---|---|---|
avr | ATmega16, ATmega328P, ATmega32U4, ATtinyX5, ATtinyX7 | Uno, Nano, Leonardo, Sparkfun Pro Micro, Digispark etc. | |
megaavr | ATmega4809 | Uno WiFi Rev 2, Nano Every | |
samd | SAMD21G18A | Zero, MKR*, etc. but not DUE, which is sam architecture | |
esp8266 | All protocols does not fit in IRAM | all | |
esp32 | % | all | |
stm32 | STM32F1xx | BluePill | |
STM32F1 | STM32F1xx | BluePill | |
apollo3 | Ambiq Apollo3 | Sparkfun Apollo3 + Artemis | |
mbed | nRF528x | Nano 33 BLE | |
Teensiduino | all - but limited support | >= Teensy 3 |
This is a short comparison and may not be complete or correct.
I created this comparison matrix for myself in order to choose a small IR lib for my project and to have a quick overview, when to choose which library.
It is dated from 24.06.2022 and updated 10/2023. If you have complains about the data or request for extensions, please send a PM or open a discussion.
Here you find an ESP8266/ESP32 version of IRremote with an impressive list of supported protocols.
Subject | IRMP | IRLremote | IRLib2 mostly unmaintained |
IRremote | TinyIR | IRsmallDecoder |
---|---|---|---|---|---|---|
Number of protocols | 50 | Nec + Panasonic + Hash * | 12 + Hash * | 17 + PulseDistance + Hash * | NEC + FAST | NEC + RC5 + Sony + Samsung |
Timing method receive | Timer2 or interrupt for pin 2 or 3 | Interrupt | Timer2 or interrupt for pin 2 or 3 | Timer2 | Interrupt | Interrupt |
Timing method send | PWM and timing with Timer2 interrupts | Timer2 interrupts | Timer2 and blocking wait | PWM with Timer2 and/or blocking wait with delay Microseconds() |
blocking wait with delay Microseconds() |
% |
Send pins | All | All | All ? | Timer dependent | All | % |
Decode method | OnTheFly | OnTheFly | RAM | RAM | OnTheFly | OnTheFly |
Encode method | OnTheFly | OnTheFly | OnTheFly | OnTheFly or RAM | OnTheFly | % |
Callback suppport | x | % | % | x | x | % |
Repeat handling | Receive + Send (partially) | % | ? | Receive + Send | Receive + Send | Receive |
LED feedback | x | % | x | x | Receive | % |
FLASH usage (simple NEC example with 5 prints) | 1820 (4300 for 15 main / 8000 for all 40 protocols) (+200 for callback) (+80 for interrupt at pin 2+3) |
1270 (1400 for pin 2+3) |
4830 | 1770 | 900 | ?1100? |
RAM usage | 52 (73 / 100 for 15 (main) / 40 protocols) |
62 | 334 | 227 | 19 | 29 |
Supported platforms | avr, megaavr, attiny, Digispark (Pro), esp8266, ESP32, STM32, SAMD 21, Apollo3 (plus arm and pic for non Arduino IDE) |
avr, esp8266 | avr, SAMD 21, SAMD 51 | avr, attiny, esp8266, esp32, SAM, SAMD | All platforms with attach Interrupt() |
All platforms with attach Interrupt() |
Last library update | 5/2023 | 4/2018 | 11/2022 | 9/2023 | 5/2023 | 2/2022 |
Remarks | Decodes 40 protocols concurrently. 39 Protocols to send. Work in progress. |
Only one protocol at a time. | Consists of 5 libraries. *Project containing bugs - 63 issues, 10 pull requests. | Universal decoder and encoder. Supports Pronto codes and sending of raw timing values. |
Requires no timer. | Requires no timer. |
* The Hash protocol gives you a hash as code, which may be sufficient to distinguish your keys on the remote, but may not work with some protocols like Mitsubishi
You may use every pin for input or output, just define it like #define IRMP_INPUT_PIN 2
and #define IRSND_OUTPUT_PIN 3
. The PWM of the output pin is generated by software bit banging.
If you want to use pin numbers for input, output and LED feedback specified at runtime, you must define IRMP_IRSND_ALLOW_DYNAMIC_PINS
. See ReceiveAndSendDynamicPins example.
The irmp_init
and irsnd_init
function then allows up to 3 parameters uint_fast8_t aIrmpInputPin/aIrsndOutputPin, uint_fast8_t aIrmpFeedbackLedPin, bool aIrmpLedFeedbackPinIsActiveLow
.
Be aware, only one pin and enable flag for receive and send feedback LED is supported.
Receiving and sending is possible with this library, but since we use only 1 timer, receiving is inhibited while sending the IR signal.
Sending the IR signal starts with saving current timer configuration, setting the timer to the send configuration / frequency, sending the signal (and waiting for the gap after the signal) and then automatically reset the timer to its previous (receiving) configuration.
// Init functions
void irmp_init (void);
void irmp_init(uint_fast8_t aIrmpInputPin);
void irmp_init(uint_fast8_t aIrmpInputPin, uint_fast8_t aIrmpFeedbackLedPin);
void irmp_init(uint_fast8_t aIrmpInputPin, uint_fast8_t aIrmpFeedbackLedPin, bool aIrmpLedFeedbackPinIsActiveLow);
void irmp_register_complete_callback_function(void (*aCompleteCallbackFunction)(void));
// Info function
bool irmp_IsBusy();
void irmp_print_active_protocols(Print *aSerial);
// Main check for result function used in loop()
bool irmp_get_data (IRMP_DATA *)
// Result print functions
void irmp_result_print(Print *aSerial, IRMP_DATA * aIRMPDataPtr);
void irmp_result_print(IRMP_DATA *aIRMPDataPtr);
// Init functions
void irsnd_init (void);
// 3 additional init functions if IRMP_IRSND_ALLOW_DYNAMIC_PINS is defined
void irsnd_init(uint_fast8_t aIrsndOutputPin);
void irsnd_init(uint_fast8_t aIrsndOutputPin, uint_fast8_t aIrmpFeedbackLedPin);
void irsnd_init(uint_fast8_t aIrsndOutputPin, uint_fast8_t aIrmpFeedbackLedPin, bool aIrmpLedFeedbackPinIsActiveLow);
// Send function - sends frame AND trailing space
bool irsnd_send_data (IRMP_DATA *, uint8_t);
// Info functions
bool irsnd_is_busy (void);
void irsnd_stop (void);
// LED feedback function
void irmp_irsnd_LEDFeedback(bool aEnableBlinkLed);
// Timer management functions for
void disableIRTimerInterrupt(void);
void enableIRTimerInterrupt(void);
void storeIRTimer(void);
void restoreIRTimer(void);
In order to fit the examples to the 8K flash of ATtiny85 and ATtiny88, the Arduino library ATtinySerialOut is required for this CPU's.
Receives up to 40 protocols concurrently and displays the short result on a 1602 LCD. The LCD can be connected parallel or serial (I2C).
This examples are a good starting point.
SimpleReceiver can be tested online with WOKWI.
Click on the receiver while simulation is running to specify individual IR codes.
If code size matters, look at these examples.
The MinimalReceiver example uses the TinyReceiver library which can only receive NEC and FAST codes, but does not require any timer.
MinimalReceiver can be tested online with WOKWI.
Click on the receiver while simulation is running to specify individual IR codes.
If the protocol is not NEC and code size matters, look at this example.
MinimalReceiver can be tested online with WOKWI.
Click on the receiver while simulation is running to specify individual IR codes.
This example analyzes the signal delivered by your IR receiver module.
Values can be used to determine the stability of the received signal as well as a hint for determining the protocol.
It also computes the MARK_EXCESS_MICROS value, which is the extension of the mark (pulse) duration introduced by the IR receiver module.
It can be tested online with WOKWI.
Click on the receiver while simulation is running to specify individual IR codes.
To customize the library to different requirements, there are some compile options / macros available, which must be set before including the library e.g. with #include <irmp.hpp>
.
Modify it by setting the value to 1 or 0. Or define the macro with the -D compiler option for global compile (the latter is not possible with the Arduino IDE, so consider using Sloeber.
Name | Default value | Description |
---|---|---|
IRMP_INPUT_PIN |
2 | The pin number which gets compiled in, if not using IRMP_IRSND_ALLOW_DYNAMIC_PINS . See also PinDefinitionsAndMore.h |
IRMP_FEEDBACK_LED_PIN |
LED_BUILTIN |
The pin number for the feedback led which gets compiled in, if not using IRMP_IRSND_ALLOW_DYNAMIC_PINS . |
FEEDBACK_LED_IS_ACTIVE_LOW |
disabled | Required on some boards (like my like my BluePill and my ESP8266 board), where the feedback LED is active low. |
NO_LED_FEEDBACK_CODE |
disabled | Enable it to disable the feedback LED function. Saves 30 bytes program memory. |
IRMP_IRSND_ALLOW_DYNAMIC_PINS |
disabled | Allows to specify pin number at irmp_init() - see above. This requires additional program memory. |
IRMP_PROTOCOL_NAMES |
0 / disabled | Enable protocol number mapping to protocol strings - needs some program memory. |
IRMP_USE_COMPLETE_CALLBACK |
0 / disabled | Use Callback if complete data was received. Requires call to irmp_register_complete_callback_function(). |
IRMP_ENABLE_PIN_CHANGE_INTERRUPT |
disabled | Use Arduino attachInterrupt() and do no polling with timer ISR. This restricts the available input pins and protocols. The results are equivalent to results acquired with a sampling rate of 15625 Hz (chosen to avoid time consuming divisions). For AVR boards an own interrupt handler for INT0 or INT1 is used instead of Arduino attachInterrupt(). |
IRMP_ENABLE_RELEASE_DETECTION |
0 / disabled | If user releases a key on the remote control, last protocol/address/command will be returned with flag IRMP_FLAG_RELEASE set. |
IRMP_HIGH_ACTIVE |
0 / disabled | Set to 1 if you use a RF receiver, which has an active HIGH output signal. |
IRMP_32_BIT |
0 / disabled | This enables MERLIN protocol, but decreases performance for AVR. Enabled by default for 32 bit platforms. |
F_INTERRUPTS |
15000 | The IRMP sampling frequency. |
USE_ONE_TIMER_FOR_IRMP_AND_IRSND |
disabled | Must be defined if you use receiving and sending simultaneously, since both use the same timer resource. Must not be enabled if you only use receiving. |
IRSND_USE_CALLBACK |
0 / disabled | Calls a function if send output signal changes to active (sending the IR signal). |
IR_OUTPUT_IS_ACTIVE_LOW |
disabled | Output LOW for active IR signal. Use it if IR LED is connected between VCC and output pin. |
IRSND_GENERATE_NO_SEND_RF |
disabled | Do not generate the carrier frequency (of 38 kHz), just simulate an active low receiver signal. |
IRSND_IR_FREQUENCY |
38000 | The modulation frequency for sent signal. The send signal is generated by bit banging, so the internal interrupt frequency is IRSND_IR_FREQUENCY * 2 . The send control function is called at a rate of IRSND_IR_FREQUENCY / 2 , resulting in a send packet signal resolution of 2 on/off periods. |
- | - | - |
IRMP_MEASURE_TIMING + IR_TIMING_TEST_PIN |
enabled | For development only. The test pin is switched high at the very beginning and low at the end of the ISR. |
These next macros for TinyIRReceiver must be defined in your program before the line #include <TinyIRReceiver.hpp> to take effect. |
Name | Default value | Description |
---|---|---|---|
IR_RECEIVE_PIN |
2 | The pin number for TinyIRReceiver IR input, which gets compiled in. | |
IR_FEEDBACK_LED_PIN |
LED_BUILTIN |
The pin number for TinyIRReceiver feedback LED, which gets compiled in. | |
NO_LED_FEEDBACK_CODE |
disabled | Enable it to disable the feedback LED function. Saves 14 bytes program memory. |
First, use Sketch > Show Sketch Folder (Ctrl+K).
If you have not yet saved the example as your own sketch, then you are instantly in the right library folder.
Otherwise you have to navigate to the parallel libraries
folder and select the library you want to access.
In both cases the library source and include files are located in the libraries src
directory.
The modification must be renewed for each new library version!
If you are using Sloeber as your IDE, you can easily define global symbols with Properties > Arduino > CompileOptions.
The IRMP receive library works by polling the input pin at a rate of 10 to 20 kHz. Default is 15 kHz.
Some protocols (NEC, Kaseiko, Denon, RC6, Samsung + Samsg32) can be received without timer usage, just by using interrupts from the input pin by defining IRMP_ENABLE_PIN_CHANGE_INTERRUPT
. There are many protocols which in principle cannot be decoded in this mode. See Interrupt example.
In interrupt mode, the micros()
function is used as timebase.
The IRMP send library works by bit banging the output pin at a frequency of 38 kHz. This avoids blocking waits and allows to choose an arbitrary pin, you are not restricted to PWM generating pins like pin 3 or 11. The interrupts for send pin bit banging require 50% CPU time on a 16 MHz AVR.
If both receiving and sending is required, the timer is set up for receiving and reconfigured for the duration of sending data, thus preventing receiving in polling mode while sending data.
The tone library (using timer 2) is still available. You can use it alternating with IR receive and send, see ReceiveAndSend example.
Serial LCD output | Arduino Serial Monitor output |
---|---|
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
http://www.mikrocontroller.net/articles/IRMP_-_english
http://www.mikrocontroller.net/articles/IRSND_-_english
http://www.mikrocontroller.net/articles/IRMP
http://www.mikrocontroller.net/articles/IRSND
https://www.mikrocontroller.net/topic/irmp-infrared-multi-protocol-decoder?goto=6996113#6996137
F_CPU
error introduced with 3.4.1.initPCIInterrupt()
to enablePCIInterrupt()
and added disablePCIInterrupt()
.irsnd_send_data()
to be false on error conditions.ICACHE_RAM_ATTR
error introduced with 3.4.1.irmp_tone()
, since it statically allocates the tone interrupt vector.IRSND_GENERATE_NO_SEND_RF
compile switch.irsnd_data_print()
.IRMP_FEEDBACK_LED_PIN
compile switch.IRMP16
protocol from the all list.irmp_protocol_names
.irmp_print_protocol_name()
.bool irmp_IsBusy()
if IRMP_ENABLE_PIN_CHANGE_INTERRUPT
is defined.bool irmp_IsBusy()
.USE_ONE_TIMER_FOR_IRMP_AND_IRSND
macro.reset interrupt flags
found by user yumkam.MinimalReceiver
example.IRMP_IRSND_ALLOW_DYNAMIC_PINS
and extended irmp_init()
and irsnd_init()
to allow input, output and LED feedback pin selection at runtime.irmp_print_active_protocols()
.TIMER2_COMPB_vect
to be compatible with tone library.irmp_disable_timer_interrupt()
and irmp_enable_timer_interrupt()
.irmp_result_print(Print *aSerial)
.The library examples are tested with GitHub Actions for the following boards: