Bumped version to 3.3.0. Added lastDecodedProtocol and CheckForRecordGapsMicros().

Author: ArminJo

.github/workflows/LibraryBuild.yml

@@ -109,14 +109,14 @@ jobs:
           - arduino-boards-fqbn: digistump:avr:digispark-tiny:clock=clock1
             platform-url: https://raw.githubusercontent.com/ArminJo/DigistumpArduino/master/package_digistump_index.json
             required-libraries: ATtinySerialOut
-            sketches-exclude: UnitTest,ControlRelay,ReceiveAndSend,ReceiveDump,SendProntoDemo,SendBoseWaveDemo,MicroGirs,IRDispatcherDemo,SendLGAirConditionerDemo,ReceiverTimingAnalysis,IRremoteExtensionTest # Does not fit in FLASH or RAM, missing digitalPinToInterrupt
+            sketches-exclude: UnitTest,ControlRelay,ReceiveAndSend,SendAndReceive,ReceiveDump,SendProntoDemo,SendBoseWaveDemo,MicroGirs,IRDispatcherDemo,SendLGAirConditionerDemo,ReceiverTimingAnalysis,IRremoteExtensionTest # Does not fit in FLASH or RAM, missing digitalPinToInterrupt
             build-properties: # the flags were put in compiler.cpp.extra_flags
               All: -DEXCLUDE_EXOTIC_PROTOCOLS -DEXCLUDE_UNIVERSAL_PROTOCOLS
 
           - arduino-boards-fqbn: digistump:avr:MHETtiny88  # ATtiny88 China clone board @16 MHz
             platform-url: https://raw.githubusercontent.com/ArminJo/DigistumpArduino/master/package_digistump_index.json
             required-libraries: ATtinySerialOut
-            sketches-exclude: UnitTest,ControlRelay,ReceiveAndSend,ReceiveDump,SendProntoDemo,SendBoseWaveDemo,MicroGirs,IRDispatcherDemo,SendLGAirConditionerDemo,ReceiverTimingAnalysis,IRremoteExtensionTest # Does not fit in FLASH or RAM, missing digitalPinToInterrupt
+            sketches-exclude: UnitTest,ControlRelay,ReceiveAndSend,SendAndReceive,ReceiveDump,SendProntoDemo,SendBoseWaveDemo,MicroGirs,IRDispatcherDemo,SendLGAirConditionerDemo,ReceiverTimingAnalysis,IRremoteExtensionTest # Does not fit in FLASH or RAM, missing digitalPinToInterrupt
             build-properties: # the flags were put in compiler.cpp.extra_flags
               All: -DEXCLUDE_EXOTIC_PROTOCOLS -DEXCLUDE_UNIVERSAL_PROTOCOLS
 

README.md

@@ -122,7 +122,7 @@ If you see something like `Protocol=UNKNOWN Hash=0x13BD886C 35 bits received` as
 - If you have an **odd number of bits** received, it is likely, that your receiver circuit has problems. Maybe because the IR signal is too weak.
 - If you see timings like `+ 600,- 600     + 550,- 150     + 200,- 100     + 750,- 550` then one 450 µs space was split into two 150 and 100 µs spaces with a spike / error signal of 200 µs between. Maybe because of a defective receiver or a weak signal in conjunction with another light emitting source nearby.
 - If you see timings like `+ 500,- 550     + 450,- 550     + 500,- 500     + 500,-1550`, then marks are generally shorter than spaces and therefore `MARK_EXCESS_MICROS` (specified in your ino file) should be **negative** to compensate for this at decoding.
-- If you see rawData[2] it may be that the space after the initial mark is longer than [`RECORD_GAP_MICROS`](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/IRremote.h#L127). This was observed for some LG air conditioner protocols. Try again with a line e.g. `#define RECORD_GAP_MICROS 12000` before `#include <IRremote.h>` in yout ino file.
+- If you see `Protocol=UNKNOWN Hash=0x0 1 bits received` it may be that the space after the initial mark is longer than [`RECORD_GAP_MICROS`](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/IRremote.h#L124). This was observed for some LG air conditioner protocols. Try again with a line e.g. `#define RECORD_GAP_MICROS 12000` before the line `#include <IRremote.h>` in your ino file.
 - To see more info supporting you to find the reason for your UNKNOWN protocol, you must enable the line `//#define DEBUG` in IRremoteInt.h.
 
 ## How to deal with protocols not supported by IRremote
@@ -179,11 +179,11 @@ Modify it by commenting them out or in, or change the values if applicable. Or d
 |-|-|-|-|
 | `SEND_PWM_BY_TIMER` | Before `#include <IRremote.h>` | disabled | Disable carrier PWM generation in software and use (restricted) hardware PWM except for ESP32 where both modes are using the flexible `hw_timer_t`. |
 | `USE_NO_SEND_PWM` | Before `#include <IRremote.h>` | disabled | Use no carrier PWM, just simulate an active low receiver signal. Overrides `SEND_PWM_BY_TIMER` definition. |
-| `RECORD_GAP_MICROS` | Before `#include <IRremote.h>` | 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 us.<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. |
 | `NO_LEGACY_COMPATIBILITY` | IRremoteInt.h | disabled | Disables the old decoder for version 2.x compatibility, where all protocols -especially NEC, Panasonic, Sony, Samsung and JVC- were MSB first. Saves around 60 bytes program space and 14 bytes RAM. |
 | `EXCLUDE_EXOTIC_PROTOCOLS` | Before `#include <IRremote.h>` | disabled | If activated, BOSEWAVE, MAGIQUEST,WHYNTER and LEGO_PF are excluded in `decode()` and in sending with `IrSender.write()`. Saves up to 900 bytes program space. |
 | `EXCLUDE_UNIVERSAL_PROTOCOLS` | Before `#include <IRremote.h>` | 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. |
 | `MARK_EXCESS_MICROS` | Before `#include <IRremote.h>` | 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` | Before `#include <IRremote.h>` | 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 us.<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` | Before `#include <IRremote.h>` | disabled | Required on some boards (like my BluePill and my ESP8266 board), where the feedback LED is active low. |
 | `DISABLE_LED_FEEDBACK_FOR_RECEIVE` | Before `#include <IRremote.h>` | disabled | This completely disables the LED feedback code for receive, thus saving around 108 bytes program space and halving the receiver ISR processing time. |
 | `IR_INPUT_IS_ACTIVE_HIGH` | Before `#include <IRremote.h>` | disabled | Enable it if you use a RF receiver, which has an active HIGH output signal. |

examples/ReceiveDemo/ReceiveDemo.ino

@@ -54,7 +54,6 @@
 // to compensate for the signal forming of different IR receiver modules.
 #define MARK_EXCESS_MICROS    20 // 20 is recommended for the cheap VS1838 modules
 
-//#define DEBUG // Activate this for lots of lovely debug outputs.
 //#define RECORD_GAP_MICROS 12000 // Activate it for some LG air conditioner protocols
 
 /*
@@ -112,6 +111,8 @@ void setup() {
 #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"));
 }
@@ -154,13 +155,17 @@ void loop() {
         }
 
 #  if !defined(ESP32) && !defined(ESP8266) && !defined(NRF5)
-        /*
-         * Play tone, wait and restore IR timer
-         */
-        IrReceiver.stop();
-        tone(TONE_PIN, 2200, 10);
-        delay(8);
-        IrReceiver.start(8000); // to compensate for 11 ms stop of receiver. This enables a correct gap measurement.
+        if (IrReceiver.decodedIRData.protocol != UNKNOWN) {
+            /*
+             * Play tone, wait and restore IR timer, if a valid protocol was received
+             * Otherwise do not disturb the detection of the gap between transmissions. This will give
+             * the next printIRResult* call a chance to report about changing the RECORD_GAP_MICROS value.
+             */
+            IrReceiver.stop();
+            tone(TONE_PIN, 2200, 10);
+            delay(8);
+            IrReceiver.start(8000); // to compensate for 8 ms stop of receiver. This enables a correct gap measurement.
+        }
 #  endif
 #endif // FLASHEND > 0x1FFF
 

examples/ReceiveDump/ReceiveDump.ino

@@ -45,7 +45,6 @@
  */
 #define MARK_EXCESS_MICROS    20 // recommended for the cheap VS1838 modules
 
-//#define DEBUG // Activate this for lots of lovely debug outputs.
 //#define RECORD_GAP_MICROS 12000 // Activate it for some LG air conditioner protocols
 #include <IRremote.h>
 

examples/SendAndReceive/SendAndReceive.cpp renamed to examples/SendAndReceive/SendAndReceive.ino

@@ -92,6 +92,8 @@ void setup() {
     Serial.println(F(" us"));
 
     // 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"));
 #endif

examples/UnitTest/UnitTest.ino

@@ -52,14 +52,14 @@
 #define DECODE_RC5
 #define DECODE_RC6
 #define DECODE_PANASONIC    // the same as DECODE_KASEIKYO
-#define DECODE_SAMSUNG
 #define DECODE_LG
 
 #define DECODE_DISTANCE     // universal decoder for pulse width or pulse distance protocols
 #define DECODE_HASH         // special decoder for all protocols
 #endif
 
 #if FLASHEND >= 0x7FFF      // Additional code for less equal than 32k flash, like ATmega328
+#define DECODE_SAMSUNG
 
 #define DECODE_BOSEWAVE
 #define DECODE_LEGO_PF
@@ -70,7 +70,6 @@
 //#define SEND_PWM_BY_TIMER
 //#define USE_NO_SEND_PWM
 //#define IR_MEASURE_TIMING
-//#define DEBUG // Activate this for lots of lovely debug outputs.
 #define MARK_EXCESS_MICROS    10 // Adapt it to your IR receiver module. See also IRremote.h.
 #define DISABLE_LED_FEEDBACK_FOR_RECEIVE // halves ISR duration
 
@@ -132,6 +131,8 @@ void setup() {
     Serial.println(F(" us"));
 
     // 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"));
 #endif

library.json

@@ -7,7 +7,7 @@
     "type": "git",
     "url": "https://github.com/z3t0/Arduino-IRremote.git"
   },
-  "version": "3.2.0",
+  "version": "3.3.0",
   "frameworks": "arduino",
   "platforms": ["atmelavr", "atmelmegaavr", "atmelsam", "espressif8266", "espressif32", "ststm32"],
   "authors" :

src/IRProtocol.h

@@ -38,6 +38,8 @@
  */
 typedef enum {
     UNKNOWN = 0,
+    PULSE_DISTANCE,
+    PULSE_WIDTH,
     DENON,
     DISH,
     JVC,
@@ -56,8 +58,6 @@ typedef enum {
     SONY,
     ONKYO,
     APPLE,
-    PULSE_DISTANCE,
-    PULSE_WIDTH,
     BOSEWAVE,
     LEGO_PF,
     MAGIQUEST,