Support for old 2.x code

ArminJo · ArminJo · commit cf374e64f368 · 2021-04-10T20:43:01.000+02:00
diff --git a/.github/workflows/LibraryBuild.yml b/.github/workflows/LibraryBuild.yml
@@ -50,6 +50,7 @@ jobs:
           - arduino:avr:uno|SEND_PWM_BY_TIMER
           - arduino:avr:leonardo
           - arduino:megaavr:nona4809:mode=off
+          - megaTinyCore:megaavr:atxy4:chip=1604,clock=16internal
           - digistump:avr:digispark-tiny:clock=clock1
           - ATTinyCore:avr:attinyx5:chip=85,clock=1internal
           - TinyCore:avr:tiny32
@@ -100,9 +101,9 @@ jobs:
           - arduino-boards-fqbn: arduino:samd:arduino_zero_native
             sketches-exclude: MinimalReceiver,IRDispatcherDemo
 
-          - arduino-boards-fqbn: SparkFun:avr:promicro
-            arduino-platform: arduino:avr,SparkFun:avr
-            platform-url: https://raw.githubusercontent.com/sparkfun/Arduino_Boards/master/IDE_Board_Manager/package_sparkfun_index.json # Arduino URL is not required here
+          - arduino-boards-fqbn: megaTinyCore:megaavr:atxy4:chip=1604,clock=16internal
+            platform-url: http://drazzy.com/package_drazzy.com_index.json
+            sketches-exclude: MinimalReceiver,IRDispatcherDemo // digitalWriteFast.h not available for this board
 
           - arduino-boards-fqbn: digistump:avr:digispark-tiny:clock=clock1
             platform-url: https://raw.githubusercontent.com/ArminJo/DigistumpArduino/master/package_digistump_index.json
@@ -150,6 +151,10 @@ jobs:
             platform-url: http://dan.drown.org/stm32duino/package_STM32duino_index.json
             sketches-exclude: IR2Keyboard,MinimalReceiver
 
+          - arduino-boards-fqbn: SparkFun:avr:promicro
+            arduino-platform: arduino:avr,SparkFun:avr
+            platform-url: https://raw.githubusercontent.com/sparkfun/Arduino_Boards/master/IDE_Board_Manager/package_sparkfun_index.json # Arduino URL is not required here
+
           - arduino-boards-fqbn: sandeepmistry:nRF5:BBCmicrobit
             platform-url: https://sandeepmistry.github.io/arduino-nRF5/package_nRF5_boards_index.json
             sketches-exclude: IR2Keyboard,IRDispatcherDemo,MicroGirs,MinimalReceiver # no tone()
diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ If you use a core that does not use the `-flto` flag for compile, you can activa
 - Seldom used: `results.rawbuf` and `results.rawlen` must be replaced by `IrReceiver.decodedIRData.rawDataPtr->rawbuf` and `IrReceiver.decodedIRData.rawDataPtr->rawlen`.
 
 # Running your 2.x program with the 3.x library version
-If you program is of style:
+If you program is like:
 ```
 IRrecv irrecv(RECV_PIN);
 decode_results results;
diff --git a/examples/ControlRelay/PinDefinitionsAndMore.h b/examples/ControlRelay/PinDefinitionsAndMore.h
@@ -58,6 +58,7 @@
 #define tone(a,b,c) void()      // no tone() available on ESP32
 #define noTone(a) void()
 #define TONE_PIN            42 // Dummy for examples using it
+#define APPLICATION_PIN     16 // RX2 pin
 
 #elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1)
 // BluePill in 2 flavors
@@ -108,6 +109,7 @@
 #elif defined(__AVR_ATtiny1604__)
 #define IR_RECEIVE_PIN   2 // To be compatible with interrupt example, pin 2 is chosen here.
 #define IR_SEND_PIN      3
+#define APPLICATION_PIN  5
 #define TONE_PIN        42 // Dummy for examples using it
 #define tone(a,b,c) void() // tone() uses the same vector as receive timer
 #define noTone(a) void()
diff --git a/examples/ReceiveAndSend/PinDefinitionsAndMore.h b/examples/ReceiveAndSend/PinDefinitionsAndMore.h
@@ -58,6 +58,7 @@
 #define tone(a,b,c) void()      // no tone() available on ESP32
 #define noTone(a) void()
 #define TONE_PIN            42 // Dummy for examples using it
+#define APPLICATION_PIN     16 // RX2 pin
 
 #elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1)
 // BluePill in 2 flavors
@@ -108,6 +109,7 @@
 #elif defined(__AVR_ATtiny1604__)
 #define IR_RECEIVE_PIN   2 // To be compatible with interrupt example, pin 2 is chosen here.
 #define IR_SEND_PIN      3
+#define APPLICATION_PIN  5
 #define TONE_PIN        42 // Dummy for examples using it
 #define tone(a,b,c) void() // tone() uses the same vector as receive timer
 #define noTone(a) void()
diff --git a/examples/ReceiveAndSend/ReceiveAndSend.ino b/examples/ReceiveAndSend/ReceiveAndSend.ino
@@ -53,11 +53,7 @@
 
 #include <IRremote.h>
 
-#if defined(ESP32)
-int SEND_BUTTON_PIN = 16; // RX2 pin
-#else
-int SEND_BUTTON_PIN = 12;
-#endif
+int SEND_BUTTON_PIN = APPLICATION_PIN;
 int STATUS_PIN = LED_BUILTIN;
 
 int DELAY_BETWEEN_REPEAT = 50;
diff --git a/examples/ReceiveDemo/PinDefinitionsAndMore.h b/examples/ReceiveDemo/PinDefinitionsAndMore.h
@@ -58,6 +58,7 @@
 #define tone(a,b,c) void()      // no tone() available on ESP32
 #define noTone(a) void()
 #define TONE_PIN            42 // Dummy for examples using it
+#define APPLICATION_PIN     16 // RX2 pin
 
 #elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1)
 // BluePill in 2 flavors
@@ -108,6 +109,7 @@
 #elif defined(__AVR_ATtiny1604__)
 #define IR_RECEIVE_PIN   2 // To be compatible with interrupt example, pin 2 is chosen here.
 #define IR_SEND_PIN      3
+#define APPLICATION_PIN  5
 #define TONE_PIN        42 // Dummy for examples using it
 #define tone(a,b,c) void() // tone() uses the same vector as receive timer
 #define noTone(a) void()
diff --git a/examples/ReceiveDump/PinDefinitionsAndMore.h b/examples/ReceiveDump/PinDefinitionsAndMore.h
@@ -58,6 +58,7 @@
 #define tone(a,b,c) void()      // no tone() available on ESP32
 #define noTone(a) void()
 #define TONE_PIN            42 // Dummy for examples using it
+#define APPLICATION_PIN     16 // RX2 pin
 
 #elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1)
 // BluePill in 2 flavors
@@ -108,6 +109,7 @@
 #elif defined(__AVR_ATtiny1604__)
 #define IR_RECEIVE_PIN   2 // To be compatible with interrupt example, pin 2 is chosen here.
 #define IR_SEND_PIN      3
+#define APPLICATION_PIN  5
 #define TONE_PIN        42 // Dummy for examples using it
 #define tone(a,b,c) void() // tone() uses the same vector as receive timer
 #define noTone(a) void()
diff --git a/examples/SendBoseWaveDemo/PinDefinitionsAndMore.h b/examples/SendBoseWaveDemo/PinDefinitionsAndMore.h
@@ -58,6 +58,7 @@
 #define tone(a,b,c) void()      // no tone() available on ESP32
 #define noTone(a) void()
 #define TONE_PIN            42 // Dummy for examples using it
+#define APPLICATION_PIN     16 // RX2 pin
 
 #elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1)
 // BluePill in 2 flavors
@@ -108,6 +109,7 @@
 #elif defined(__AVR_ATtiny1604__)
 #define IR_RECEIVE_PIN   2 // To be compatible with interrupt example, pin 2 is chosen here.
 #define IR_SEND_PIN      3
+#define APPLICATION_PIN  5
 #define TONE_PIN        42 // Dummy for examples using it
 #define tone(a,b,c) void() // tone() uses the same vector as receive timer
 #define noTone(a) void()
diff --git a/examples/SendDemo/PinDefinitionsAndMore.h b/examples/SendDemo/PinDefinitionsAndMore.h
@@ -58,6 +58,7 @@
 #define tone(a,b,c) void()      // no tone() available on ESP32
 #define noTone(a) void()
 #define TONE_PIN            42 // Dummy for examples using it
+#define APPLICATION_PIN     16 // RX2 pin
 
 #elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1)
 // BluePill in 2 flavors
@@ -108,6 +109,7 @@
 #elif defined(__AVR_ATtiny1604__)
 #define IR_RECEIVE_PIN   2 // To be compatible with interrupt example, pin 2 is chosen here.
 #define IR_SEND_PIN      3
+#define APPLICATION_PIN  5
 #define TONE_PIN        42 // Dummy for examples using it
 #define tone(a,b,c) void() // tone() uses the same vector as receive timer
 #define noTone(a) void()
diff --git a/examples/SendLGAirConditionerDemo/PinDefinitionsAndMore.h b/examples/SendLGAirConditionerDemo/PinDefinitionsAndMore.h
@@ -58,6 +58,7 @@
 #define tone(a,b,c) void()      // no tone() available on ESP32
 #define noTone(a) void()
 #define TONE_PIN            42 // Dummy for examples using it
+#define APPLICATION_PIN     16 // RX2 pin
 
 #elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1)
 // BluePill in 2 flavors
@@ -108,6 +109,7 @@
 #elif defined(__AVR_ATtiny1604__)
 #define IR_RECEIVE_PIN   2 // To be compatible with interrupt example, pin 2 is chosen here.
 #define IR_SEND_PIN      3
+#define APPLICATION_PIN  5
 #define TONE_PIN        42 // Dummy for examples using it
 #define tone(a,b,c) void() // tone() uses the same vector as receive timer
 #define noTone(a) void()
diff --git a/examples/SendProntoDemo/PinDefinitionsAndMore.h b/examples/SendProntoDemo/PinDefinitionsAndMore.h
@@ -58,6 +58,7 @@
 #define tone(a,b,c) void()      // no tone() available on ESP32
 #define noTone(a) void()
 #define TONE_PIN            42 // Dummy for examples using it
+#define APPLICATION_PIN     16 // RX2 pin
 
 #elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1)
 // BluePill in 2 flavors
@@ -108,6 +109,7 @@
 #elif defined(__AVR_ATtiny1604__)
 #define IR_RECEIVE_PIN   2 // To be compatible with interrupt example, pin 2 is chosen here.
 #define IR_SEND_PIN      3
+#define APPLICATION_PIN  5
 #define TONE_PIN        42 // Dummy for examples using it
 #define tone(a,b,c) void() // tone() uses the same vector as receive timer
 #define noTone(a) void()
diff --git a/examples/SendRawDemo/PinDefinitionsAndMore.h b/examples/SendRawDemo/PinDefinitionsAndMore.h
@@ -58,6 +58,7 @@
 #define tone(a,b,c) void()      // no tone() available on ESP32
 #define noTone(a) void()
 #define TONE_PIN            42 // Dummy for examples using it
+#define APPLICATION_PIN     16 // RX2 pin
 
 #elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1)
 // BluePill in 2 flavors
@@ -108,6 +109,7 @@
 #elif defined(__AVR_ATtiny1604__)
 #define IR_RECEIVE_PIN   2 // To be compatible with interrupt example, pin 2 is chosen here.
 #define IR_SEND_PIN      3
+#define APPLICATION_PIN  5
 #define TONE_PIN        42 // Dummy for examples using it
 #define tone(a,b,c) void() // tone() uses the same vector as receive timer
 #define noTone(a) void()
diff --git a/examples/SimpleReceiver/PinDefinitionsAndMore.h b/examples/SimpleReceiver/PinDefinitionsAndMore.h
@@ -58,6 +58,7 @@
 #define tone(a,b,c) void()      // no tone() available on ESP32
 #define noTone(a) void()
 #define TONE_PIN            42 // Dummy for examples using it
+#define APPLICATION_PIN     16 // RX2 pin
 
 #elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1)
 // BluePill in 2 flavors
@@ -108,6 +109,7 @@
 #elif defined(__AVR_ATtiny1604__)
 #define IR_RECEIVE_PIN   2 // To be compatible with interrupt example, pin 2 is chosen here.
 #define IR_SEND_PIN      3
+#define APPLICATION_PIN  5
 #define TONE_PIN        42 // Dummy for examples using it
 #define tone(a,b,c) void() // tone() uses the same vector as receive timer
 #define noTone(a) void()
diff --git a/examples/SimpleSender/PinDefinitionsAndMore.h b/examples/SimpleSender/PinDefinitionsAndMore.h
@@ -58,6 +58,7 @@
 #define tone(a,b,c) void()      // no tone() available on ESP32
 #define noTone(a) void()
 #define TONE_PIN            42 // Dummy for examples using it
+#define APPLICATION_PIN     16 // RX2 pin
 
 #elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1)
 // BluePill in 2 flavors
@@ -108,6 +109,7 @@
 #elif defined(__AVR_ATtiny1604__)
 #define IR_RECEIVE_PIN   2 // To be compatible with interrupt example, pin 2 is chosen here.
 #define IR_SEND_PIN      3
+#define APPLICATION_PIN  5
 #define TONE_PIN        42 // Dummy for examples using it
 #define tone(a,b,c) void() // tone() uses the same vector as receive timer
 #define noTone(a) void()
diff --git a/examples/UnitTest/PinDefinitionsAndMore.h b/examples/UnitTest/PinDefinitionsAndMore.h
@@ -58,6 +58,7 @@
 #define tone(a,b,c) void()      // no tone() available on ESP32
 #define noTone(a) void()
 #define TONE_PIN            42 // Dummy for examples using it
+#define APPLICATION_PIN     16 // RX2 pin
 
 #elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1)
 // BluePill in 2 flavors
@@ -108,6 +109,7 @@
 #elif defined(__AVR_ATtiny1604__)
 #define IR_RECEIVE_PIN   2 // To be compatible with interrupt example, pin 2 is chosen here.
 #define IR_SEND_PIN      3
+#define APPLICATION_PIN  5
 #define TONE_PIN        42 // Dummy for examples using it
 #define tone(a,b,c) void() // tone() uses the same vector as receive timer
 #define noTone(a) void()
diff --git a/src/IRReceive.cpp.h b/src/IRReceive.cpp.h
@@ -1319,7 +1319,11 @@ ISR () // for functions definitions which are called by separate (board specific
 
 #if !defined(NO_LEGACY_COMPATIBILITY)
 /**********************************************************************************************************************
- * The DEPRECATED decode function with parameter aResults for backwards compatibility
+ * The DEPRECATED decode function with parameter aResults ONLY for backwards compatibility!
+ * This function calls the old MSB first decoders and fills only the 3 variables:
+ * aResults->value
+ * aResults->bits
+ * aResults->decode_type
  **********************************************************************************************************************/
 bool IRrecv::decode(decode_results *aResults) {
     static bool sDeprecationMessageSent = false;
diff --git a/src/IRremote.h b/src/IRremote.h
@@ -180,6 +180,13 @@
 #include "IRReceive.cpp.h"
 #include "IRSend.cpp.h"
 
+/**
+ * Macros for legacy compatibility
+ */
+#define RAWBUF  101  // Maximum length of raw duration buffer
+#define REPEAT 0xFFFFFFFF
+#define USECPERTICK MICROS_PER_TICK
+#define MARK_EXCESS MARK_EXCESS_MICROS
 #endif // IRremote_h
 
 #pragma once
diff --git a/src/IRremoteInt.h b/src/IRremoteInt.h
@@ -112,14 +112,13 @@ struct irparams_struct {
  * Activating this saves 60 bytes program space and 14 bytes RAM
  */
 //#define NO_LEGACY_COMPATIBILITY
-
 #if !defined(NO_LEGACY_COMPATIBILITY)
 /**
  * Results returned from old decoders !!!deprecated!!!
  */
 struct decode_results {
     decode_type_t decode_type;  // deprecated, moved to decodedIRData.protocol ///< UNKNOWN, NEC, SONY, RC5, ...
-//    uint16_t address;         ///< Used by Panasonic & Sharp & NEC_standard [16-bits]
+    uint16_t address;           ///< Used by Panasonic & Sharp [16-bits]
     uint32_t value;             // deprecated, moved to decodedIRData.decodedRawData ///< Decoded value / command [max 32-bits]
     uint8_t bits;               // deprecated, moved to decodedIRData.numberOfBits ///< Number of bits in decoded value
     uint16_t magnitude;         // deprecated, moved to decodedIRData.extra ///< Used by MagiQuest [16-bits]
@@ -226,8 +225,8 @@ class IRrecv {
     bool decodePulseWidthData(uint8_t aNumberOfBits, uint8_t aStartOffset, uint16_t aOneMarkMicros, uint16_t aZeroMarkMicros,
             uint16_t aBitSpaceMicros, bool aMSBfirst);
 
-    bool decodeBiPhaseData(uint_fast8_t aNumberOfBits, uint_fast8_t aStartOffset, uint_fast8_t aStartClockCount, uint_fast8_t aValueOfSpaceToMarkTransition,
-            uint16_t aBiphaseTimeUnit);
+    bool decodeBiPhaseData(uint_fast8_t aNumberOfBits, uint_fast8_t aStartOffset, uint_fast8_t aStartClockCount,
+            uint_fast8_t aValueOfSpaceToMarkTransition, uint16_t aBiphaseTimeUnit);
 
     void initBiphaselevel(uint8_t aRCDecodeRawbuffOffset, uint16_t aBiphaseTimeUnit);
     uint8_t getBiphaselevel();
@@ -267,11 +266,12 @@ class IRrecv {
     bool decodeSAMSUNG(decode_results *aResults);
     bool decodeHashOld(decode_results *aResults);
 
-    bool decode(decode_results *aResults) __attribute__ ((deprecated ("Please use IrReceiver.decode() without a parameter and IrReceiver.decodedIRData.<fieldname> ."))); // deprecated
+    bool decode(
+            decode_results *aResults)
+                    __attribute__ ((deprecated ("Please use IrReceiver.decode() without a parameter and IrReceiver.decodedIRData.<fieldname> ."))); // deprecated
 #endif
     bool decodeWhynter();
 
-
     /*
      * Internal functions
      */
@@ -319,7 +319,6 @@ void blink13(bool aEnableLEDFeedback)
         __attribute__ ((deprecated ("Please use setLEDFeedback() or enableLEDFeedback() / disableLEDFeedback."))); // deprecated
 void setBlinkPin(uint8_t aFeedbackLEDPin) __attribute__ ((deprecated ("Please use setLEDFeedback()."))); // deprecated
 
-
 /**
  * microseconds per clock interrupt tick
  */
@@ -413,11 +412,9 @@ class IRsend {
      */
     void sendBoseWave(uint8_t aCommand, uint_fast8_t aNumberOfRepeats = NO_REPEATS);
     void sendDenon(uint8_t aAddress, uint8_t aCommand, uint_fast8_t aNumberOfRepeats, bool aSendSharp = false);
-    void sendDenonRaw(uint16_t aRawData, uint_fast8_t aNumberOfRepeats = 0);
-    __attribute__ ((deprecated ("Please use sendDenon(aAddress, aCommand, aNumberOfRepeats).")));
+    void sendDenonRaw(uint16_t aRawData, uint_fast8_t aNumberOfRepeats = 0)
+            __attribute__ ((deprecated ("Please use sendDenon(aAddress, aCommand, aNumberOfRepeats).")));
     void sendJVC(uint8_t aAddress, uint8_t aCommand, uint_fast8_t aNumberOfRepeats);
-    void sendJVCRaw(uint16_t aRawData, uint_fast8_t aNumberOfRepeats = 0);
-    __attribute__ ((deprecated ("Please use sendJVC(aAddress, aCommand, aNumberOfRepeats).")));
 
     void sendLGRepeat();
     void sendLG(uint8_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats, bool aIsRepeat = false);
@@ -462,8 +459,18 @@ class IRsend {
      */
     void sendDenon(unsigned long data, int nbits);
     void sendDISH(unsigned long data, int nbits);
+    void sendJVC(unsigned long data, int nbits, bool repeat)
+            __attribute__ ((deprecated ("This old function sends MSB first! Please use sendJVC(aAddress, aCommand, aNumberOfRepeats)."))) {
+        sendJVCMSB(data, nbits, repeat);
+    }
     void sendJVCMSB(unsigned long data, int nbits, bool repeat = false);
+
     void sendLG(unsigned long data, int nbits);
+
+    void sendNEC(uint32_t aRawData, uint8_t nbits)
+    __attribute__ ((deprecated ("This old function sends MSB first! Please use sendNEC(aAddress, aCommand, aNumberOfRepeats)."))) {
+        sendNECMSB(aRawData, nbits);
+    }
     void sendNECMSB(uint32_t data, uint8_t nbits, bool repeat = false);
     void sendPanasonic(uint16_t aAddress,
             uint32_t aData)
diff --git a/src/ir_JVC.cpp b/src/ir_JVC.cpp
@@ -68,12 +68,6 @@
 // JVC does NOT repeat by sending a separate code (like NEC does).
 // The JVC protocol repeats by skipping the header.
 //
-/*
- * Only for backwards compatibility
- */
-void IRsend::sendJVCRaw(uint16_t aRawData, uint_fast8_t aNumberOfRepeats) {
-    sendJVC((uint8_t) aRawData & 0xFF, (uint8_t) (aRawData >> JVC_ADDRESS_BITS), aNumberOfRepeats);
-}
 
 void IRsend::sendJVC(uint8_t aAddress, uint8_t aCommand, uint_fast8_t aNumberOfRepeats) {
     // Set IR carrier frequency
@@ -214,10 +208,16 @@ bool IRrecv::decodeJVCMSB(decode_results *aResults) {
 
 #endif
 
-//+=============================================================================
-// JVC does NOT repeat by sending a separate code (like NEC does).
-// The JVC protocol repeats by skipping the header.
-// Old version with MSB first Data
+/**
+ * With Send sendJVCMSB() you can send your old 32 bit codes.
+ * To convert one into the other, you must reverse the byte positions and then reverse all bit positions of each byte.
+ * Or write it as one binary string and reverse/mirror it.
+ * Example:
+ * 0xCB340102 byte reverse -> 02 01 34 CB bit reverse-> 40 80 2C D3.
+ * 0xCB340102 is binary 11001011001101000000000100000010.
+ * 0x40802CD3 is binary 01000000100000000010110011010011.
+ * If you read the first binary sequence backwards (right to left), you get the second sequence.
+ */
 void IRsend::sendJVCMSB(unsigned long data, int nbits, bool repeat) {
     // Set IR carrier frequency
     enableIROut(38);
diff --git a/src/ir_Kaseikyo.cpp b/src/ir_Kaseikyo.cpp
diff --git a/src/ir_NEC.cpp b/src/ir_NEC.cpp
diff --git a/src/ir_RC5_RC6.cpp b/src/ir_RC5_RC6.cpp
diff --git a/src/ir_Sony.cpp b/src/ir_Sony.cpp
