sendNEC() and sendNEC2() now accepts 16 bit command to better map to NEXext protocol found in IRDB databases. ir_DistanceWidthProtocol() now decodes up to 10 ms mark or spaces if RAM is bigger than 2 k.

Author: ArminJo

changelog.md

@@ -2,6 +2,10 @@
 The latest version may not be released!
 See also the commit log at github: https://github.com/Arduino-IRremote/Arduino-IRremote/commits/master
 
+# 4.3.3
+- sendNEC() and sendNEC2() now accepts 16 bit command to better map to NEXext protocol found in IRDB databases.
+- ir_DistanceWidthProtocol() now decodes up to 10 ms mark or spaces if RAM is bigger than 2 k.
+
 # 4.3.2
 - Added sendSonyMSB(unsigned long data, int nbits) as a clone of sendSony(unsigned long data, int nbits) to be more consistent.
 - Added sendSamsungMSB(unsigned long data, int nbits) as a clone of sendSAMSUNG(unsigned long data, int nbits) to be more consistent.

examples/AllProtocolsOnLCD/AllProtocolsOnLCD.ino

@@ -40,9 +40,11 @@
 #  if (defined(RAMEND) && RAMEND <= 0x4FF) || (defined(RAMSIZE) && RAMSIZE < 0x4FF)
 #define RAW_BUFFER_LENGTH  180
 #  elif (defined(RAMEND) && RAMEND <= 0x8FF) || (defined(RAMSIZE) && RAMSIZE < 0x8FF)
-#define RAW_BUFFER_LENGTH  600
+#define RAW_BUFFER_LENGTH  520
+#define DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE 200 // The decoder accepts mark or space durations up to 200 * 50 (MICROS_PER_TICK) = 10 milliseconds
 #  else
 #define RAW_BUFFER_LENGTH  750
+#define DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE 400 // The decoder accepts mark or space durations up to 400 * 50 (MICROS_PER_TICK) = 20 milliseconds
 #  endif
 #endif
 

src/IRReceive.hpp

@@ -856,7 +856,7 @@ bool IRrecv::decodePulseDistanceWidthData(PulseDistanceWidthProtocolConstants *a
  * Static variables for the getBiphaselevel function
  */
 uint_fast8_t sBiphaseDecodeRawbuffOffset;   // Index into raw timing array
-uint16_t sBiphaseCurrentTimingIntervals;    // 1, 2 or 3. Number of aBiphaseTimeUnit intervals of the current rawbuf[sBiphaseDecodeRawbuffOffset] timing.
+uint16_t sBiphaseCurrentTimingIntervals; // 1, 2 or 3. Number of aBiphaseTimeUnit intervals of the current rawbuf[sBiphaseDecodeRawbuffOffset] timing.
 uint_fast8_t sBiphaseUsedTimingIntervals;   // Number of already used intervals of sCurrentTimingIntervals.
 uint16_t sBiphaseTimeUnit;
 
@@ -1276,6 +1276,51 @@ void IRrecv::printDistanceWidthTimingInfo(Print *aSerial, DistanceWidthTimingInf
     aSerial->print(aDistanceWidthTimingInfo->ZeroSpaceMicros);
 }
 
+/*
+ * Get maximum of mark ticks in rawDataPtr.
+ * Skip leading start and trailing stop bit.
+ */
+uint8_t IRrecv::getMaximumMarkTicksFromRawData() {
+    uint8_t tMaximumTick = 0;
+    for (IRRawlenType i = 3; i < decodedIRData.rawlen - 2; i += 2) { // Skip leading start and trailing stop bit.
+        auto tTick = decodedIRData.rawDataPtr->rawbuf[i];
+        if (tMaximumTick < tTick) {
+            tMaximumTick = tTick;
+        }
+    }
+    return tMaximumTick;
+}
+uint8_t IRrecv::getMaximumSpaceTicksFromRawData() {
+    uint8_t tMaximumTick = 0;
+    for (IRRawlenType i = 4; i < decodedIRData.rawlen - 2; i += 2) { // Skip leading start and trailing stop bit.
+        auto tTick = decodedIRData.rawDataPtr->rawbuf[i];
+        if (tMaximumTick < tTick) {
+            tMaximumTick = tTick;
+        }
+    }
+    return tMaximumTick;
+}
+
+/*
+ * The optimizing compiler internally generates this function, if getMaximumMarkTicksFromRawData() and getMaximumSpaceTicksFromRawData() is used.
+ */
+uint8_t IRrecv::getMaximumTicksFromRawData(bool aSearchSpaceInsteadOfMark) {
+    uint8_t tMaximumTick = 0;
+    IRRawlenType i;
+    if (aSearchSpaceInsteadOfMark) {
+        i = 4;
+    } else {
+        i = 3;
+    }
+    for (; i < decodedIRData.rawlen - 2; i += 2) { // Skip leading start and trailing stop bit.
+        auto tTick = decodedIRData.rawDataPtr->rawbuf[i];
+        if (tMaximumTick < tTick) {
+            tMaximumTick = tTick;
+        }
+    }
+    return tMaximumTick;
+}
+
 uint32_t IRrecv::getTotalDurationOfRawData() {
     uint16_t tSumOfDurationTicks = 0;
 

src/IRremoteInt.h

@@ -225,6 +225,9 @@ class IRrecv {
     void printIRResultMinimal(Print *aSerial);
     void printIRResultRawFormatted(Print *aSerial, bool aOutputMicrosecondsInsteadOfTicks = true);
     void printIRResultAsCVariables(Print *aSerial);
+    uint8_t getMaximumMarkTicksFromRawData();
+    uint8_t getMaximumSpaceTicksFromRawData();
+    uint8_t getMaximumTicksFromRawData(bool aSearchSpaceInsteadOfMark);
     uint32_t getTotalDurationOfRawData();
 
     /*
@@ -524,8 +527,8 @@ class IRsend {
 
     void sendNECRepeat();
     uint32_t computeNECRawDataAndChecksum(uint16_t aAddress, uint16_t aCommand);
-    void sendNEC(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats);
-    void sendNEC2(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats);
+    void sendNEC(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats);
+    void sendNEC2(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats);
     void sendNECRaw(uint32_t aRawData, int_fast8_t aNumberOfRepeats = NO_REPEATS);
     // NEC variants
     void sendOnkyo(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats);

src/ir_DistanceWidthProtocol.hpp

@@ -2,7 +2,10 @@
  * ir_DistanceWidthProtocol.hpp
  *
  * Contains only the decoder functions for universal pulse width or pulse distance protocols!
- * The send functions are used by almost all protocols and therefore in IRSend.hh.
+ * The send functions are used by almost all protocols and are therefore located in IRSend.hpp.
+ *
+ * If RAM is not more than 2k, the decoder only accepts mark or space durations up to 50 * 50 (MICROS_PER_TICK) = 2500 microseconds
+ * to save RAM space, otherwise it accepts durations up to 10 ms.
  *
  * This decoder tries to decode a pulse distance or pulse distance width with constant period (or pulse width - not enabled yet) protocol.
  * 1. Analyze all space and mark length
@@ -31,7 +34,7 @@
  ************************************************************************************
  * MIT License
  *
- * Copyright (c) 2022-2023 Armin Joachimsmeyer
+ * Copyright (c) 2022-2024 Armin Joachimsmeyer
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -65,8 +68,13 @@
 //#define LOCAL_DEBUG // This enables debug output only for this file
 #endif
 
-// accept durations up to 50 * 50 (MICROS_PER_TICK) 2500 microseconds
-#define DURATION_ARRAY_SIZE 50
+#if !defined(DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE)
+#  if (defined(RAMEND) && RAMEND <= 0x8FF) || (defined(RAMSIZE) && RAMSIZE < 0x8FF)
+#define DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE 50 // To save program space, the decoder only accepts mark or space durations up to 50 * 50 (MICROS_PER_TICK) = 2500 microseconds
+#  else
+#define DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE 200 // The decoder accepts mark or space durations up to 200 * 50 (MICROS_PER_TICK) = 10 milliseconds
+#  endif
+#endif
 
 // Switch the decoding according to your needs
 //#define USE_MSB_DECODING_FOR_DISTANCE_DECODER // If active, it resembles LG, otherwise LSB first as most other protocols e.g. NEC and Kaseikyo/Panasonic
@@ -148,9 +156,15 @@ bool aggregateArrayCounts(uint8_t aArray[], uint8_t aMaxIndex, uint8_t *aShortIn
  * 2. Decide if we have an pulse width or distance protocol
  * 3. Try to decode with the mark and space data found in step 1
  * No data and address decoding, only raw data as result.
+ *
+ * calloc() version is 700 bytes larger :-(
  */
 bool IRrecv::decodeDistanceWidth() {
-    uint8_t tDurationArray[DURATION_ARRAY_SIZE]; // For up to 49 ticks / 2450 us
+    /*
+     * Array for up to 49 ticks / 2500 us (or 199  ticks / 10 ms us if RAM > 2k)
+     * 0 tick covers mark or space durations from 0 to 49 us, and 49 ticks from 2450 to 2499 us
+     */
+    uint8_t tDurationArray[DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE];
 
     /*
      * Accept only protocols with at least 8 bits
@@ -164,16 +178,16 @@ bool IRrecv::decodeDistanceWidth() {
     }
 
     // Reset duration array
-    memset(tDurationArray, 0, DURATION_ARRAY_SIZE);
+    memset(tDurationArray, 0, DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE);
 
     uint8_t tIndexOfMaxDuration = 0;
     /*
-     * Count number of mark durations up to 49 ticks. Skip leading start and trailing stop bit.
+     * Count number of mark durations. Skip leading start and trailing stop bit.
      */
     for (IRRawlenType i = 3; i < decodedIRData.rawlen - 2; i += 2) {
         auto tDurationTicks = decodedIRData.rawDataPtr->rawbuf[i];
-        if (tDurationTicks < DURATION_ARRAY_SIZE) {
-            tDurationArray[tDurationTicks]++; // count duration if less than DURATION_ARRAY_SIZE (50)
+        if (tDurationTicks < DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE) {
+            tDurationArray[tDurationTicks]++; // count duration if less than DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE
             if (tIndexOfMaxDuration < tDurationTicks) {
                 tIndexOfMaxDuration = tDurationTicks;
             }
@@ -183,7 +197,7 @@ bool IRrecv::decodeDistanceWidth() {
             Serial.print(F("Mark "));
             Serial.print(tDurationTicks * MICROS_PER_TICK);
             Serial.print(F(" is longer than maximum "));
-            Serial.print(DURATION_ARRAY_SIZE * MICROS_PER_TICK);
+            Serial.print(DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE * MICROS_PER_TICK);
             Serial.print(F(" us. Index="));
             Serial.println(i);
 #endif
@@ -211,15 +225,15 @@ bool IRrecv::decodeDistanceWidth() {
     }
 
     // Reset duration array
-    memset(tDurationArray, 0, DURATION_ARRAY_SIZE);
+    memset(tDurationArray, 0, DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE);
 
     /*
      * Count number of space durations. Skip leading start and trailing stop bit.
      */
     tIndexOfMaxDuration = 0;
     for (IRRawlenType i = 4; i < decodedIRData.rawlen - 2; i += 2) {
         auto tDurationTicks = decodedIRData.rawDataPtr->rawbuf[i];
-        if (tDurationTicks < DURATION_ARRAY_SIZE) {
+        if (tDurationTicks < DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE) {
             tDurationArray[tDurationTicks]++;
             if (tIndexOfMaxDuration < tDurationTicks) {
                 tIndexOfMaxDuration = tDurationTicks;
@@ -230,7 +244,7 @@ bool IRrecv::decodeDistanceWidth() {
             Serial.print(F("Space "));
             Serial.print(tDurationTicks * MICROS_PER_TICK);
             Serial.print(F(" is longer than maximum "));
-            Serial.print(DURATION_ARRAY_SIZE * MICROS_PER_TICK);
+            Serial.print(DISTANCE_WIDTH_DECODER_DURATION_ARRAY_SIZE * MICROS_PER_TICK);
             Serial.print(F(" us. Index="));
             Serial.println(i);
 #endif

src/ir_NEC.hpp

@@ -71,10 +71,10 @@
  */
 // http://www.hifi-remote.com/wiki/index.php/NEC
 // https://www.sbprojects.net/knowledge/ir/nec.php
-// NEC: LSB first, <start bit><address:16> (or <address:8><inverted address:8>) <command:8><inverted command:8><stop bit>.
-// ONKYO like NEC but 16 independent address and command bits: <start bit><address:16><command:16><stop bit>
+// NEC: LSB first, <start bit><address:16> (or <address:8><inverted address:8>) <command:16><command:8><inverted command:8><stop bit>.
+// ONKYO: like NEC but force to 16 independent address and 16 bit command bits: <start bit><address:16><command:16><stop bit>
 // Standard NEC sends a special fixed repeat frame.
-// NEC2 sends the same full frame after the 110 ms. I have a DVD remote with NEC2.
+// NEC2: like NEC, but for repeat, the same full frame is sent after the 110 ms. I have a DVD remote with NEC2.
 // NEC and NEC 2 only differ in the repeat frames, so the protocol can only be detected correctly after the first repeat.
 // PIONEER (not implemented) is NEC2 with 40 kHz
 //
@@ -150,6 +150,13 @@ void sendNECSpecialRepeat() {
     IrSender.mark(NEC_BIT_MARK);             // + 560
 }
 
+/**
+ * Convert 16 bit address and 16 bit command to 32 bit NECRaw data
+ * If we get a command < 0x100, we send command and then ~command
+ * If we get an address < 0x100, we send 8 bit address and then ~address
+ * !!! Be aware, that this is flexible, but makes it impossible to send e.g. 0x0042 as 16 bit value!!!
+ * To force send 16 bit address, use: sendOnkyo().
+ */
 uint32_t IRsend::computeNECRawDataAndChecksum(uint16_t aAddress, uint16_t aCommand) {
     LongUnion tRawData;
 
@@ -173,21 +180,11 @@ uint32_t IRsend::computeNECRawDataAndChecksum(uint16_t aAddress, uint16_t aComma
  * There is NO delay after the last sent repeat!
  * @param aNumberOfRepeats  If < 0 then only a special NEC repeat frame will be sent by calling NECProtocolConstants.SpecialSendRepeatFunction().
  */
-void IRsend::sendNEC(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats) {
+void IRsend::sendNEC(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats) {
     sendPulseDistanceWidth(&NECProtocolConstants, computeNECRawDataAndChecksum(aAddress, aCommand), NEC_BITS, aNumberOfRepeats);
 }
 
-/*
- * NEC2 Send frame and repeat the frame for each requested repeat
- * There is NO delay after the last sent repeat!
- * @param aNumberOfRepeats  If < 0 then nothing is sent.
- */
-void IRsend::sendNEC2(uint16_t aAddress, uint8_t aCommand, int_fast8_t aNumberOfRepeats) {
-    sendPulseDistanceWidth(&NEC2ProtocolConstants, computeNECRawDataAndChecksum(aAddress, aCommand), NEC_BITS, aNumberOfRepeats);
-}
-
-/*
- * Repeat commands should be sent in a 110 ms raster.
+/**
  * There is NO delay after the last sent repeat!
  * @param aNumberOfRepeats  If < 0 then only a special repeat frame without leading and trailing space
  *                          will be sent by calling NECProtocolConstants.SpecialSendRepeatFunction().
@@ -196,8 +193,17 @@ void IRsend::sendOnkyo(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumber
     sendPulseDistanceWidth(&NECProtocolConstants, (uint32_t) aCommand << 16 | aAddress, NEC_BITS, aNumberOfRepeats);
 }
 
-/*
- * Repeat commands should be sent in a 110 ms raster.
+/**
+ * NEC2 Send frame !!! and repeat the frame for each requested repeat !!!
+ * There is NO delay after the last sent repeat!
+ * @param aNumberOfRepeats  If < 0 then nothing is sent.
+ */
+void IRsend::sendNEC2(uint16_t aAddress, uint16_t aCommand, int_fast8_t aNumberOfRepeats) {
+    sendPulseDistanceWidth(&NEC2ProtocolConstants, computeNECRawDataAndChecksum(aAddress, aCommand), NEC_BITS, aNumberOfRepeats);
+}
+
+/**
+ * Apple: Send NEC with fixed 16 bit Apple address 0x87EE.
  * There is NO delay after the last sent repeat!
  * https://en.wikipedia.org/wiki/Apple_Remote
  * https://gist.github.com/darconeous/4437f79a34e3b6441628
@@ -217,7 +223,7 @@ void IRsend::sendApple(uint8_t aDeviceId, uint8_t aCommand, int_fast8_t aNumberO
     sendPulseDistanceWidth(&NECProtocolConstants, tRawData.ULong, NEC_BITS, aNumberOfRepeats);
 }
 
-/*
+/**
  * Sends NEC protocol
  * @param aNumberOfRepeats  If < 0 then only a special repeat frame without leading and trailing space
  *                          will be sent by calling NECProtocolConstants.SpecialSendRepeatFunction().