Added universal decoder for pulse width or pulse distance protocols

Author: ArminJo

.github/workflows/LibraryBuild.yml

@@ -109,23 +109,23 @@ 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 # Does not fit in FLASH or RAM, missing digitalPinToInterrupt
+            sketches-exclude: UnitTest,ControlRelay,ReceiveAndSend,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
+              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
             build-properties: # the flags were put in compiler.cpp.extra_flags
-              All: -DEXCLUDE_EXOTIC_PROTOCOLS
+              All: -DEXCLUDE_EXOTIC_PROTOCOLS -DEXCLUDE_UNIVERSAL_PROTOCOLS
 
           - arduino-boards-fqbn: ATTinyCore:avr:attinyx5:chip=85,clock=1internal
             platform-url: http://drazzy.com/package_drazzy.com_index.json
             required-libraries: ATtinySerialOut
             sketches-exclude: UnitTest,ReceiveAndSend,ReceiveDump,SendProntoDemo,SendBoseWaveDemo,MicroGirs,IRDispatcherDemo,SendLGAirConditionerDemo,ReceiverTimingAnalysis # Does not fit in FLASH or RAM
             build-properties: # the flags were put in compiler.cpp.extra_flags
-              All: -DEXCLUDE_EXOTIC_PROTOCOLS
+              All: -DEXCLUDE_EXOTIC_PROTOCOLS -DEXCLUDE_UNIVERSAL_PROTOCOLS
 
           - arduino-boards-fqbn: TinyCore:avr:tiny32
             platform-url: https://raw.githubusercontent.com/xukangmin/TinyCore/master/avr/package/package_tinycore_index.json

README.md

@@ -1,7 +1,7 @@
 # IRremote Arduino Library
 Available as Arduino library "IRremote"
 
-### [Version 3.2.1](https://github.com/Arduino-IRremote/Arduino-IRremote/archive/master.zip) - work in progress
+### [Version 3.3.0](https://github.com/Arduino-IRremote/Arduino-IRremote/archive/master.zip) - work in progress
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Commits since latest](https://img.shields.io/github/commits-since/Arduino-IRremote/Arduino-IRremote/latest)](https://github.com/Arduino-IRremote/Arduino-IRremote/commits/master)
@@ -122,6 +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.
 - 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
@@ -178,8 +179,10 @@ 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. |
 | `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. |

changelog.md

@@ -1,10 +1,11 @@
 # Changelog
 The latest version may not be released!
-## 3.2.1
+## 3.3.0
 - Fix errors if LED_BUILTIN is not defined.
 - Fixed error for AVR timer1. Thanks to alexbarcelo.
 - New example IRremoteExtensionTest.
 - Enabled megaAVR 0-series devices.
+- Added universal decoder for pulse width or pulse distance protocols.
 
 ## 3.2.0
 - Fix for ESP32 send Error, removed `USE_SOFT_SEND_PWM` macro.

examples/ReceiveDemo/ReceiveDemo.ino

@@ -45,6 +45,7 @@
 //#define DISABLE_LED_FEEDBACK_FOR_RECEIVE // saves 108 bytes program space
 #if FLASHEND <= 0x1FFF
 #define EXCLUDE_EXOTIC_PROTOCOLS
+#define EXCLUDE_UNIVERSAL_PROTOCOLS
 #endif
 //#define EXCLUDE_EXOTIC_PROTOCOLS // saves around 670 bytes program space if all other protocols are active
 //#define IR_MEASURE_TIMING
@@ -53,6 +54,9 @@
 // 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
+
 /*
  * First define macros for input and output pin etc.
  */

examples/ReceiveDump/ReceiveDump.ino

@@ -45,6 +45,8 @@
  */
 #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/SimpleReceiver/SimpleReceiver.ino

@@ -31,6 +31,7 @@
 //#define DECODE_MAGIQUEST
 //#define DECODE_WHYNTER
 
+//#define DECODE_DISTANCE     // universal decoder for pulse width or pulse distance protocols
 //#define DECODE_HASH         // special decoder for all protocols
 
 #include <Arduino.h>

examples/UnitTest/UnitTest.ino

@@ -55,6 +55,7 @@
 #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
 
@@ -69,6 +70,7 @@
 //#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
 

library.properties

@@ -1,9 +1,9 @@
 name=IRremote
-version=3.2.0
+version=3.3.0
 author=shirriff, z3t0 <[email protected]>, ArminJo
 maintainer=Armin Joachimsmeyer <[email protected]>
 sentence=Send and receive infrared signals with multiple protocols
-paragraph=Currently included protocols: Denon / Sharp, JVC, LG,  NEC / Onkyo / Apple, Panasonic / Kaseikyo, RC5, RC6, Samsung, Sony, (Pronto), BoseWave, Lego, Whynter, MagiQuest.<br/><br/><b>New: </b><a href="https://github.com/Arduino-IRremote/Arduino-IRremote#converting-your-program-to-the-31-version">Upgrade instructions</a><br/>Fixed ESP send bug. Added Onkyo protocol. Added ESP8266 support.<br/>Generation of PWM is now done by software by default, thus saving the hardware timer and enabling abitrary output pins. Fixed LG send bug. STM32 and ATtiny88 support added. Removed decode_results results. Renamed most irparams_struct values. The macros FEEDBACK_LED, SYSCLOCK, SENDPIN_ON and SENDPIN_OFF are not longer used / evaluated. Major refactoring of CPU dependent and feedback LED code.<br/>
+paragraph=Currently included protocols: Denon / Sharp, JVC, LG,  NEC / Onkyo / Apple, Panasonic / Kaseikyo, RC5, RC6, Samsung, Sony, (Pronto), BoseWave, Lego, Whynter, MagiQuest.<br/><br/><b>New: </b><a href="https://github.com/Arduino-IRremote/Arduino-IRremote#converting-your-program-to-the-31-version">3.x upgrade instructions</a><br/>Added universal decoder for pulse width or pulse distance protocols.<br/>For all 3.x: Generation of PWM is now done by software by default, thus saving the hardware timer and enabling abitrary output pins. Removed decode_results results. Renamed most irparams_struct values. The macros FEEDBACK_LED, SYSCLOCK, SENDPIN_ON and SENDPIN_OFF are not longer used / evaluated. Major refactoring of CPU dependent and feedback LED code.  Support for more CPU's.<br/>
 category=Communication
 url=https://github.com/Arduino-IRremote/Arduino-IRremote
 architectures=avr,megaavr,samd,esp8266,esp32,mbed,stm32,STM32F1

src/IRProtocol.h

@@ -56,6 +56,8 @@ typedef enum {
     SONY,
     ONKYO,
     APPLE,
+    PULSE_DISTANCE,
+    PULSE_WIDTH,
     BOSEWAVE,
     LEGO_PF,
     MAGIQUEST,

src/IRReceive.cpp.h

@@ -350,6 +350,16 @@ bool IRrecv::decode() {
     }
 #endif
 
+    /*
+     * Try the universal decoder for pulse width or pulse distance protocols
+     */
+#if defined(DECODE_DISTANCE)
+    TRACE_PRINTLN("Attempting universal Distance decode");
+    if (decodeDistance()) {
+        return true;
+    }
+#endif
+
     /*
      * Last resort is the universal hash decode which always return true
      */
@@ -373,7 +383,7 @@ bool IRrecv::decode() {
  * Common decode functions
  **********************************************************************************************************************/
 /**
- * Decode pulse width protocols.
+ * Decode pulse width protocols. Currently only used for sony protocol.
  * The space (pause) has constant length, the length of the mark determines the bit value.
  *      Each bit looks like: MARK_1 + SPACE -> 1 or : MARK_0 + SPACE -> 0
  *
@@ -1171,6 +1181,12 @@ const __FlashStringHelper* getProtocolString(decode_type_t aProtocol) {
     case APPLE:
         return (F("APPLE"));
         break;
+    case PULSE_DISTANCE:
+        return (F("PULSE_DISTANCE"));
+        break;
+    case PULSE_WIDTH:
+        return (F("PULSE_WIDTH"));
+        break;
 #if !defined(EXCLUDE_EXOTIC_PROTOCOLS)
     case BOSEWAVE:
         return (F("BOSEWAVE"));