Documentation for adding new protocol

Author: ArminJo

README.md

@@ -236,7 +236,7 @@ There are some other solutions to this on more powerful processors,
 - The **minimal CPU frequency** for receiving is 4 MHz, since the 50 µs timer ISR takes around 12 µs on a 16 MHz ATmega.
 - To **increase strength of sent output signal** you can increase the current through the send diode, and/or use 2 diodes in series,
  since one IR diode requires only 1.5 volt.
- - The line \#include "ATtinySerialOut.h" in PinDefinitionsAndMore.h (requires the library to be installed) saves 370 bytes program space and 38 bytes RAM for **Digispark boards** as well as enables serial output at 8MHz.
+ - The line \#include "ATtinySerialOut.h" in PinDefinitionsAndMore.h (requires the library to be installed) saves 370 bytes program memory and 38 bytes RAM for **Digispark boards** as well as enables serial output at 8MHz.
  - The default software generated PWM has **problems on AVR running with 8 MHz**. The PWM frequency is around 30 instead of 38 kHz and RC6 is not reliable. You can switch to timer PWM generation by `#define SEND_PWM_BY_TIMER`.
 
 
@@ -274,7 +274,7 @@ If you do not know which protocol your IR transmitter uses, you have several cho
  For **long codes** with more than 48 bits like from air conditioners, you can **change the length of the input buffer** in [IRremote.h](src/IRremoteInt.h#L36).
 - The [IRMP AllProtocol example](https://github.com/ukw100/IRMP#allprotocol-example) prints the protocol and data for one of the **40 supported protocols**.
  The same library can be used to send this codes.
-- If you have a bigger Arduino board at hand (> 100 kByte program space) you can try the
+- If you have a bigger Arduino board at hand (> 100 kByte program memory) you can try the
  [IRremoteDecode example](https://github.com/bengtmartensson/Arduino-DecodeIR/blob/master/examples/IRremoteDecode/IRremoteDecode.ino) of the Arduino library [DecodeIR](https://github.com/bengtmartensson/Arduino-DecodeIR).
 - Use [IrScrutinizer](http://www.harctoolbox.org/IrScrutinizer.html).
  It can automatically generate a send sketch for your protocol by exporting as "Arduino Raw". It supports IRremote,
@@ -352,13 +352,13 @@ Modify them by enabling / disabling them, or change the values if applicable.
 | `SEND_PWM_BY_TIMER` |  disabled | Disable carrier PWM generation in software and use (restricted) hardware PWM. Enabled for ESP32 and RP2040 in all examples. |
 | `USE_NO_SEND_PWM` |  disabled | Use no carrier PWM, just simulate an **active low** receiver signal. Overrides `SEND_PWM_BY_TIMER` definition. |
 | `USE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN` |  disabled | Use or simulate open drain output mode at send pin. **Attention, active state of open drain is LOW**, so connect the send LED between positive supply and send pin! |
-| `EXCLUDE_EXOTIC_PROTOCOLS` |  disabled | If activated, BOSEWAVE, WHYNTER and LEGO_PF are excluded in `decode()` and in sending with `IrSender.write()`. Saves up to 650 bytes program space. |
-| `EXCLUDE_UNIVERSAL_PROTOCOLS` |  disabled | If activated, the universal decoder for pulse width or pulse distance protocols and decodeHash (special decoder for all protocols) are excluded in `decode()`. Saves up to 1000 bytes program space. |
+| `EXCLUDE_EXOTIC_PROTOCOLS` |  disabled | If activated, BOSEWAVE, WHYNTER and LEGO_PF are excluded in `decode()` and in sending with `IrSender.write()`. Saves up to 650 bytes program memory. |
+| `EXCLUDE_UNIVERSAL_PROTOCOLS` |  disabled | If activated, the universal decoder for pulse width or pulse distance protocols and decodeHash (special decoder for all protocols) are excluded in `decode()`. Saves up to 1000 bytes program memory. |
 | `DECODE_<Protocol name>` |  all | Selection of individual protocol(s) to be decoded. You can specify multiple protocols. See [here](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/IRremote.hpp#L98-L121)  |
 | `MARK_EXCESS_MICROS` |  20 | MARK_EXCESS_MICROS is subtracted from all marks and added to all spaces before decoding, to compensate for the signal forming of different IR receiver modules. |
 | `RECORD_GAP_MICROS` |  5000 | Minimum gap between IR transmissions, to detect the end of a protocol.<br/>Must be greater than any space of a protocol e.g. the NEC header space of 4500 µs.<br/>Must be smaller than any gap between a command and a repeat; e.g. the retransmission gap for Sony is around 24 ms.<br/>Keep in mind, that this is the delay between the end of the received command and the start of decoding. |
 | `FEEDBACK_LED_IS_ACTIVE_LOW` |  disabled | Required on some boards (like my BluePill and my ESP8266 board), where the feedback LED is active low. |
-| `NO_LED_FEEDBACK_CODE` |  disabled | This completely disables the LED feedback code for send and receive, thus saving around 100 bytes program space for receiving, around 500 bytes for sending and halving the receiver ISR processing time. |
+| `NO_LED_FEEDBACK_CODE` |  disabled | This completely disables the LED feedback code for send and receive, thus saving around 100 bytes program memory for receiving, around 500 bytes for sending and halving the receiver ISR processing time. |
 | `IR_INPUT_IS_ACTIVE_HIGH` |  disabled | Enable it if you use a RF receiver, which has an active HIGH output signal. |
 | `IR_SEND_DUTY_CYCLE_PERCENT` |  30 | Duty cycle of IR send signal. |
 | `MICROS_PER_TICK` |  50 | Resolution of the raw input buffer data. Corresponds to 2 pulses of each 26.3 µs at 38 kHz. |
@@ -371,7 +371,7 @@ These next macros for **TinyIRReceiver** must be defined in your program before
 |-|-|-|
 | `IR_INPUT_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 space. |
+| `NO_LED_FEEDBACK_CODE` | disabled | Enable it to disable the feedback LED function. Saves 14 bytes program memory. |
 
 ### Changing include (*.h) files with Arduino IDE
 First, use *Sketch > Show Sketch Folder (Ctrl+K)*.<br/>

changelog.md

@@ -1,6 +1,8 @@
 # Changelog
 The latest version may not be released!
 See also the commit log at github: https://github.com/Arduino-IRremote/Arduino-IRremote/commits/master
+## 3.6.2
+- Changed TOLERANCE to TOLERANCE_FOR_DECODERS_MARK_OR_SPACE_MATCHING and documented it.
 
 ## 3.6.1
 - Switched Bose internal protocol timing for 0 and 1 -> old 1 timing is now 0 and vice versa.

examples/IRDispatcherDemo/IRCommandDispatcher.hpp

@@ -31,8 +31,8 @@
  *  You should have received a copy of the GNU General Public License
  *  along with this program.  If not, see <http://www.gnu.org/licenses/gpl.html>.
  */
-#ifndef IR_COMMAND_DISPATCHER_HPP
-#define IR_COMMAND_DISPATCHER_HPP
+#ifndef _IR_COMMAND_DISPATCHER_HPP
+#define _IR_COMMAND_DISPATCHER_HPP
 
 #include <Arduino.h>
 
@@ -139,7 +139,7 @@ void handleReceivedIRData()
 
     if (IRDispatcher.IRReceivedData.address == IR_ADDRESS) {
         IRDispatcher.checkAndCallCommand(true);
-#ifdef INFO
+#if defined(INFO)
         } else {
         CD_INFO_PRINT(F("Wrong address. Expected 0x"));
         CD_INFO_PRINTLN(IR_ADDRESS, HEX);
@@ -165,14 +165,14 @@ void IRCommandDispatcher::checkAndCallCommand(bool aCallAlsoBlockingCommands) {
             /*
              * Command found
              */
-#ifdef INFO
+#if defined(INFO)
             const __FlashStringHelper *tCommandName = reinterpret_cast<const __FlashStringHelper*>(IRMapping[i].CommandString);
 #endif
             /*
              * Check for repeat and if it is allowed for the current command
              */
             if (IRReceivedData.isRepeat && !(IRMapping[i].Flags & IR_COMMAND_FLAG_REPEATABLE)) {
-#ifdef DEBUG
+#if defined(DEBUG)
                 Serial.print(F("Repeats of command \""));
                 Serial.print(tCommandName);
                 Serial.println("\" not accepted");
@@ -184,7 +184,7 @@ void IRCommandDispatcher::checkAndCallCommand(bool aCallAlsoBlockingCommands) {
              * Do not accept recursive call of the same command
              */
             if (currentBlockingCommandCalled == IRReceivedData.command) {
-#ifdef DEBUG
+#if defined(DEBUG)
                 Serial.print(F("Recursive command \""));
                 Serial.print(tCommandName);
                 Serial.println("\" not accepted");
@@ -246,7 +246,7 @@ void IRCommandDispatcher::checkAndCallCommand(bool aCallAlsoBlockingCommands) {
                     CD_INFO_PRINTLN (tCommandName);
 
                     IRMapping[i].CommandToCall();
-#ifdef TRACE
+#if defined(TRACE)
                     Serial.println(F("End of blocking command"));
 #endif
                     executingBlockingCommand = false;
@@ -309,5 +309,5 @@ void IRCommandDispatcher::setRequestToStopReceived() {
     requestToStopReceived = true;
 }
 
-#endif // #ifndef IR_COMMAND_DISPATCHER_HPP
+#endif // _IR_COMMAND_DISPATCHER_HPP
 #pragma once

examples/IRDispatcherDemo/IRDispatcherDemo.ino

@@ -30,7 +30,7 @@
  * Choose the library to be used for IR receiving
  */
 #define USE_TINY_IR_RECEIVER // Recommended, but only for NEC protocol!!! If disabled and IRMP_INPUT_PIN is defined, the IRMP library is used for decoding
-//#define TINY_RECEIVER_USE_ARDUINO_ATTACH_INTERRUPT // costs 112 bytes program space + 4 bytes RAM
+//#define TINY_RECEIVER_USE_ARDUINO_ATTACH_INTERRUPT // costs 112 bytes program memory + 4 bytes RAM
 
 #include "PinDefinitionsAndMore.h"
 // Some kind of auto detect library if USE_TINY_IR_RECEIVER is deactivated
@@ -57,20 +57,22 @@
   #endif
 
 #elif defined(USE_IRMP_LIBRARY)
-#define IRMP_USE_COMPLETE_CALLBACK       1 // Enable callback functionality is required if IRMP library is used
-
+/*
+ * IRMP version
+ */
+#define IRMP_USE_COMPLETE_CALLBACK       1 // Enable callback functionality. It is required if IRMP library is used.
 #if defined(ALTERNATIVE_IR_FEEDBACK_LED_PIN)
 #define FEEDBACK_LED_PIN    ALTERNATIVE_IR_FEEDBACK_LED_PIN
 #endif
 
-//#define IRMP_ENABLE_PIN_CHANGE_INTERRUPT  // Enable interrupt functionality (not for all protocols) - requires around 376 additional bytes of program space
+//#define IRMP_ENABLE_PIN_CHANGE_INTERRUPT  // Enable interrupt functionality (not for all protocols) - requires around 376 additional bytes of program memory
 
-#define IRMP_PROTOCOL_NAMES 1               // Enable protocol number mapping to protocol strings - requires some program space. Must before #include <irmp*>
+#define IRMP_PROTOCOL_NAMES 1               // Enable protocol number mapping to protocol strings - requires some program memory. Must before #include <irmp*>
 
 #define IRMP_SUPPORT_NEC_PROTOCOL         1 // this enables only one protocol
 //#define IRMP_SUPPORT_KASEIKYO_PROTOCOL    1
 
-#  ifdef ALTERNATIVE_IR_FEEDBACK_LED_PIN
+#  if defined(ALTERNATIVE_IR_FEEDBACK_LED_PIN)
 #define IRMP_FEEDBACK_LED_PIN   ALTERNATIVE_IR_FEEDBACK_LED_PIN
 #  endif
 /*
@@ -150,7 +152,7 @@ void setup() {
     Serial.println(F("at pin " STR(IRMP_INPUT_PIN)));
 #  endif
 
-#  ifdef ALTERNATIVE_IR_FEEDBACK_LED_PIN
+#  if defined(ALTERNATIVE_IR_FEEDBACK_LED_PIN)
     irmp_irsnd_LEDFeedback(true); // Enable receive signal feedback at ALTERNATIVE_IR_FEEDBACK_LED_PIN
     Serial.println(F("IR feedback pin is " STR(ALTERNATIVE_IR_FEEDBACK_LED_PIN)));
 #  endif

examples/IRremoteInfo/IRremoteInfo.ino

@@ -61,35 +61,35 @@ void dumpRAW_BUFFER_LENGTH() {
 
 void dumpTIMER() {
     bool flag = false;
-#ifdef IR_USE_TIMER1
+#if defined(IR_USE_TIMER1)
     Serial.print(F("Timer defined for use: "));
     Serial.println(F("Timer1"));
     flag = true;
 #endif
-#ifdef IR_USE_TIMER2
+#if defined(IR_USE_TIMER2)
     Serial.print(F("Timer defined for use: "));
     Serial.println(F("Timer2"));
     flag = true;
 #endif
-#ifdef IR_USE_TIMER3
+#if defined(IR_USE_TIMER3)
   Serial.print(F("Timer defined for use: ")); Serial.println(F("Timer3")); flag = true;
 #endif
-#ifdef IR_USE_TIMER4
+#if defined(IR_USE_TIMER4)
   Serial.print(F("Timer defined for use: ")); Serial.println(F("Timer4")); flag = true;
 #endif
-#ifdef IR_USE_TIMER5
+#if defined(IR_USE_TIMER5)
   Serial.print(F("Timer defined for use: ")); Serial.println(F("Timer5")); flag = true;
 #endif
-#ifdef IR_USE_TIMER4_HS
+#if defined(IR_USE_TIMER4_HS)
   Serial.print(F("Timer defined for use: ")); Serial.println(F("Timer4_HS")); flag = true;
 #endif
-#ifdef IR_USE_TIMER_CMT
+#if defined(IR_USE_TIMER_CMT)
   Serial.print(F("Timer defined for use: ")); Serial.println(F("Timer_CMT")); flag = true;
 #endif
-#ifdef IR_USE_TIMER_TPM1
+#if defined(IR_USE_TIMER_TPM1)
   Serial.print(F("Timer defined for use: ")); Serial.println(F("Timer_TPM1")); flag = true;
 #endif
-#ifdef IR_USE_TIMER_TINY0
+#if defined(IR_USE_TIMER_TINY0)
   Serial.print(F("Timer defined for use: ")); Serial.println(F("Timer_TINY0")); flag = true;
 #endif
 
@@ -289,7 +289,7 @@ void dumpProtocols() {
     Serial.println(F("Disabled"));
 #endif
 
-#if !defined(EXCLUDE_EXOTIC_PROTOCOLS) // saves around 2000 bytes program space
+#if !defined(EXCLUDE_EXOTIC_PROTOCOLS) // saves around 2000 bytes program memory
 
     Serial.print(F("BOSEWAVE:     "));
 #if defined(DECODE_BOSEWAVE)

examples/ReceiveAndSend/ReceiveAndSend.ino

@@ -49,7 +49,7 @@
  */
 #include "PinDefinitionsAndMore.h"
 
-//#define EXCLUDE_EXOTIC_PROTOCOLS // saves around 900 bytes program space
+//#define EXCLUDE_EXOTIC_PROTOCOLS // saves around 900 bytes program memory
 
 #include <IRremote.hpp>
 

examples/ReceiveDump/ReceiveDump.ino

@@ -72,7 +72,17 @@ void setup() {
     Serial.print(F("Ready to receive IR signals of protocols: "));
     printActiveIRProtocols(&Serial);
     Serial.print(F("at pin "));
+#if defined(ARDUINO_ARCH_STM32) || defined(ESP8266)
+    Serial.println(IR_RECEIVE_PIN_STRING);
+#else
     Serial.println(IR_RECEIVE_PIN);
+#endif
+
+    // infos for receive
+    Serial.print(RECORD_GAP_MICROS);
+    Serial.println(F(" us is the (minimum) gap, after which the start of a new IR packet is assumed"));
+    Serial.print(MARK_EXCESS_MICROS);
+    Serial.println(F(" us are subtracted from all marks and added to all spaces for decoding"));
 }
 
 //+=============================================================================

examples/ReceiveOneAndSendMultiple/ReceiveOneAndSendMultiple.ino

@@ -160,7 +160,7 @@ void sendSamsungSmartHubMacro(bool aDoSelect) {
     IrReceiver.stop(); // ESP32 uses another timer for tone()
 #    endif
     if (millis() < tWaitTimeAfterBoot) {
-        // division by 1000 and printing requires much (8%) program space
+        // division by 1000 and printing requires much (8%) program memory
         Serial.print(F("It is "));
         Serial.print(millis() / 1000);
         Serial.print(F(" seconds after boot, Samsung H5273 TV requires "));

examples/SendAndReceive/SendAndReceive.ino

@@ -41,11 +41,11 @@
  */
 #include "PinDefinitionsAndMore.h"
 
-//#define EXCLUDE_UNIVERSAL_PROTOCOLS // Saves up to 1000 bytes program space.
+//#define EXCLUDE_UNIVERSAL_PROTOCOLS // Saves up to 1000 bytes program memory.
 //#define EXCLUDE_EXOTIC_PROTOCOLS
 //#define SEND_PWM_BY_TIMER
 //#define USE_NO_SEND_PWM
-//#define NO_LED_FEEDBACK_CODE // saves 500 bytes program space
+//#define NO_LED_FEEDBACK_CODE // saves 500 bytes program memory
 //#define DEBUG // Activate this for lots of lovely debug output from the decoders.
 #define INFO // To see valuable informations from universal decoder for pulse width or pulse distance protocols
 

examples/SendDemo/SendDemo.ino

@@ -37,10 +37,10 @@
  */
 #include "PinDefinitionsAndMore.h"
 
-//#define EXCLUDE_EXOTIC_PROTOCOLS // saves around 240 bytes program space if IrSender.write is used
+//#define EXCLUDE_EXOTIC_PROTOCOLS // saves around 240 bytes program memory if IrSender.write is used
 //#define SEND_PWM_BY_TIMER
 //#define USE_NO_SEND_PWM
-//#define NO_LED_FEEDBACK_CODE // saves 566 bytes program space
+//#define NO_LED_FEEDBACK_CODE // saves 566 bytes program memory
 
 #include <IRremote.hpp>
 
@@ -124,7 +124,7 @@ void loop() {
     delay(DELAY_AFTER_SEND);
 
     if (sRepeats == 0) {
-#if FLASHEND >= 0x3FFF  // For 16k flash or more, like ATtiny1604. Code does not fit in program space of ATtiny85 etc.
+#if FLASHEND >= 0x3FFF  // For 16k flash or more, like ATtiny1604. Code does not fit in program memory of ATtiny85 etc.
         /*
          * Send constant values only once in this demo
          */
@@ -242,7 +242,7 @@ void loop() {
     IrSender.sendRC6(sAddress, sCommand, sRepeats, true);
     delay(DELAY_AFTER_SEND);
 
-#if FLASHEND >= 0x3FFF  // For 16k flash or more, like ATtiny1604. Code does not fit in program space of ATtiny85 etc.
+#if FLASHEND >= 0x3FFF  // For 16k flash or more, like ATtiny1604. Code does not fit in program memory of ATtiny85 etc.
     /*
      * Next example how to use the IrSender.write function
      */