restartTimer() now uses variable sMicrosAtLastStopTimer to keep track of uncounted ticks between stopTimer() and restartTimer()

Author: ArminJo

README.md

@@ -518,10 +518,10 @@ void setup() {
 }
 
 void loop() {
-    if (TinyIRReceiverData.justWritten) {
-        TinyIRReceiverData.justWritten = false;
+    if (TinyReceiverDecode()) {
         printTinyReceiverResultMinimal(&Serial);
     }
+    // No resume() required :-)
 }
 ```
 
@@ -953,8 +953,11 @@ Since the Arduino `micros()` function has a resolution of 4 µs at 16 MHz,
 ## Incompatibilities to other libraries and Arduino commands like tone() and analogWrite()
 If you use a library which requires the same timer as IRremote, you have a problem, since **the timer resource cannot be shared simultaneously** by both libraries.
 
+### Use NEC protocol and TinyReceiver
+[TinyReceiver](https://github.com/Arduino-IRremote/Arduino-IRremote?tab=readme-ov-file#tiny-nec-receiver-and-sender) does not require a timer, it relies on interrupts, thus avoiding any timer resource problems.
+
 ### Change timer
-The best approach is to change the timer used for IRremote, which can be accomplished by specifying the timer before `#include <IRremote.hpp>`.<br/>
+The best approach is to **change the timer** used for IRremote, which can be accomplished by specifying the timer before `#include <IRremote.hpp>`.<br/>
 The timer specifications available for your board can be found in [private/IRTimer.hpp](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/private/IRTimer.hpp).<br/>
 
 ```c++
@@ -971,14 +974,20 @@ The timer specifications available for your board can be found in [private/IRTim
 Here you see the Arduino Mega board and the available specifications are `IR_USE_AVR_TIMER[1,2,3,4,5]`.<br/>
 You **just have to include a line** e.g. `#define IR_USE_AVR_TIMER3` before `#include <IRremote.hpp>` to enable timer 3.
 
-But be aware that the new timer in turn might be incompatible with other libraries or commands.<br/>
-For other boards/platforms you must look for the appropriate section guarded by e.g. `#elif defined(ESP32)`.
+But be aware that the new timer in turn might be again incompatible with other libraries or Arduino functions.<br/>
+For non AVR boards/platforms you must look for the appropriate section guarded by e.g. `#elif defined(ESP32)`.
 
 ### Stop and start timer
 Another approach can be to share the timer **sequentially** if their functionality is used only for a short period of time like for the **Arduino tone() command**.
-An example can be seen [here](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/21b5747a58e9d47c9e3f1beb056d58c875a92b47/examples/ReceiveDemo/ReceiveDemo.ino#L159-L169), where the timer settings for IR receive are restored after the tone has stopped.
-For this we must call `IrReceiver.restartTimer()` or better `IrReceiver.restartTimer(microsecondsOfToneDuration)`.<br/>
-This only works since each call to` tone()` completely initializes the timer 2 used by the `tone()` command.
+An example can be seen [here](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/21b5747a58e9d47c9e3f1beb056d58c875a92b47/examples/ReceiveDemo/ReceiveDemo.ino#L159-L169), where the IR timer is restarted after the tone has stopped.
+
+```c++
+IrReceiver.stopTimer(); // Stop timer consistently before calling tone() or other functions using the timer resource.
+tone(TONE_PIN, 2200, 8);
+delay(8);
+IrReceiver.restartTimer(); // Restart IR timer after timer resource is no longer blocked.
+```
+This works on AVR boards like Uno because each call to` tone()` completely initializes the timer 2 used by the `tone()` command.
 
 ## Hardware-PWM signal generation for sending
 If you define `SEND_PWM_BY_TIMER`, the send PWM signal is forced to be generated by a hardware timer on most platforms.<br/>

changelog.md

@@ -3,6 +3,9 @@ The latest version may not be released!
 See also the commit log at github: https://github.com/Arduino-IRremote/Arduino-IRremote/commits/master
 # 4.4.1
 - Support for ESP 3.0 by akellai.
+- restartTimer() now uses variable sMicrosAtLastStopTimer to keep track of uncounted ticks between stopTimer() and restartTimer().
+- Removed functions addTicksToInternalTickCounter() and addMicrosToInternalTickCounter(), which were added in 4.1.0.
+- Version 2.2.0 of TinyIR with new TinyReceiverDecode() function to be used as drop in for IrReceiver.decode().
 
 # 4.4.0
 - Using 8 bit raw timing buffer for all timings except frame gap (former rawbuf[0]).

examples/AllProtocolsOnLCD/AllProtocolsOnLCD.ino

@@ -240,7 +240,7 @@ void loop() {
         } else {
             // play tone
             auto tStartMillis = millis();
-            IrReceiver.stopTimer();
+//            IrReceiver.stopTimer(); // Not really required for Uno, but we then should use restartTimer(aMicrosecondsToAddToGapCounter)
             tone(TONE_PIN, 2200);
 
             if ((IrReceiver.decodedIRData.protocol == UNKNOWN || digitalRead(DEBUG_BUTTON_PIN) == LOW)
@@ -259,9 +259,7 @@ void loop() {
             while ((millis() - tStartMillis) < 5)
                 ;
             noTone(TONE_PIN);
-
-            // Restore IR timer. millis() - tStartMillis to compensate for stop of receiver. This enables a correct gap measurement.
-            IrReceiver.restartTimerWithTicksToAdd((millis() - tStartMillis) * (MICROS_IN_ONE_MILLI / MICROS_PER_TICK));
+            IrReceiver.restartTimer(5000); // Restart IR timer.
 
 #if defined(USE_LCD)
             printIRResultOnLCD();
@@ -287,11 +285,11 @@ void loop() {
 #if defined(USE_LCD) && defined(ADC_UTILS_ARE_AVAILABLE)
         printsVCCVoltageMillivoltOnLCD();
 #endif
-        IrReceiver.stopTimer();
+//        IrReceiver.stopTimer(); // Not really required for Uno, but we then should use restartTimer(aMicrosecondsToAddToGapCounter)
         tone(TONE_PIN, 2200);
         delay(50);
         noTone(TONE_PIN);
-        IrReceiver.restartTimerWithTicksToAdd(50 * (MICROS_IN_ONE_MILLI / MICROS_PER_TICK));
+        IrReceiver.restartTimer(50000);
     }
 
 #if defined(USE_LCD) && defined(ADC_UTILS_ARE_AVAILABLE)

examples/ReceiveDemo/ReceiveDemo.ino

@@ -181,8 +181,7 @@ void loop() {
             /*
              * No overflow here.
              * Stop receiver, generate a single beep, print short info and send usage and start receiver again
-             *****************************************************************************************************/
-
+             */
             if ((IrReceiver.decodedIRData.protocol != SONY) && (IrReceiver.decodedIRData.protocol != PULSE_WIDTH)
                     && (IrReceiver.decodedIRData.protocol != PULSE_DISTANCE) && (IrReceiver.decodedIRData.protocol != UNKNOWN)
                     && digitalRead(DEBUG_BUTTON_PIN) != LOW) {
@@ -256,13 +255,13 @@ void loop() {
  */
 void generateTone() {
 #if !defined(ESP8266) && !defined(NRF5) // tone on esp8266 works only once, then it disables IrReceiver.restartTimer() / timerConfigForReceive().
-#  if defined(ESP32) // ESP32 uses another timer for tone()
+#  if defined(ESP32) // ESP32 uses another timer for tone(), maybe other platforms (not tested yet) too.
     tone(TONE_PIN, 2200, 8);
 #  else
-    IrReceiver.stopTimer(); // ESP32 uses another timer for tone(), maybe other platforms (not tested yet) too.
+    IrReceiver.stopTimer(); // Stop timer consistently before calling tone() or other functions using the timer resource.
     tone(TONE_PIN, 2200, 8);
     delay(8);
-    IrReceiver.restartTimer(8000); // Restart IR timer. 8000 to compensate for 8 ms stop of receiver. This enables a correct gap measurement.
+    IrReceiver.restartTimer(); // Restart IR timer after timer resource is no longer blocked.
 #  endif
 #endif
 }
@@ -286,7 +285,7 @@ void handleOverflow() {
     delay(50);
     tone(TONE_PIN, 1100, 10);
     delay(50);
-    IrReceiver.restartTimer(100000); // to compensate for 100 ms stop of receiver. This enables a correct gap measurement.
+    IrReceiver.restartTimer();
 #  endif
 #endif
 }

examples/ReceiveOneAndSendMultiple/ReceiveOneAndSendMultiple.ino

@@ -222,7 +222,7 @@ void sendSamsungSmartHubMacro(bool aDoSelect) {
     delay(200);
 
 #if !defined(ESP32)
-    IrReceiver.restartTimer(200000); // to compensate for 200 ms stop of receiver. This enables a correct gap measurement.
+    IrReceiver.restartTimer(); // Restart IR timer.
 #endif
 
     Serial.println(F("Wait for \"not supported\" to disappear"));

examples/TinyReceiver/TinyReceiver.ino

@@ -106,30 +106,37 @@ void setup() {
 }
 
 void loop() {
-    if (TinyIRReceiverData.justWritten) {
-        TinyIRReceiverData.justWritten = false;
+    if (TinyReceiverDecode()) {
+
 #if !defined(USE_FAST_PROTOCOL)
         // We have no address at FAST protocol
         Serial.print(F("Address=0x"));
         Serial.print(TinyIRReceiverData.Address, HEX);
         Serial.print(' ');
 #endif
+
         Serial.print(F("Command=0x"));
         Serial.print(TinyIRReceiverData.Command, HEX);
         if (TinyIRReceiverData.Flags == IRDATA_FLAGS_IS_REPEAT) {
             Serial.print(F(" Repeat"));
         }
         if (TinyIRReceiverData.Flags == IRDATA_FLAGS_PARITY_FAILED) {
             Serial.print(F(" Parity failed"));
+
 #if !defined(USE_EXTENDED_NEC_PROTOCOL) && !defined(USE_ONKYO_PROTOCOL)
             Serial.print(F(", try USE_EXTENDED_NEC_PROTOCOL or USE_ONKYO_PROTOCOL"));
 #endif
+
         }
         Serial.println();
     }
     /*
      * Put your code here
      */
+
+    /*
+     * No resume() required :-)
+     */
 }
 
 /*

src/IRReceive.hpp

@@ -62,6 +62,7 @@ IRrecv IrReceiver;
  * The control structure instance
  */
 struct irparams_struct irparams; // the irparams instance
+unsigned long sMicrosAtLastStopTimer = 0; // Used to adjust TickCounterForISR with uncounted ticks between stopTimer() and restartTimer()
 
 /**
  * Instantiate the IRrecv class. Multiple instantiation is not supported.
@@ -116,9 +117,9 @@ IRrecv::IRrecv(uint_fast8_t aReceivePin, uint_fast8_t aFeedbackLEDPin) {
  * => Minimal CPU frequency is 4 MHz
  *
  **********************************************************************************************************************/
+#if defined(ESP8266) || defined(ESP32)
 #pragma GCC diagnostic push
 #pragma GCC diagnostic ignored "-Wvolatile"
-#if defined(ESP8266) || defined(ESP32)
 IRAM_ATTR
 #endif
 void IRReceiveTimerInterruptHandler() {
@@ -377,6 +378,10 @@ void IRrecv::restartTimer() {
     // Setup for cyclic 50 us interrupt
     timerConfigForReceive(); // no interrupts enabled here!
     // Timer interrupt is enabled after state machine reset
+    if (sMicrosAtLastStopTimer != 0) {
+        irparams.TickCounterForISR += (micros() - sMicrosAtLastStopTimer) / MICROS_PER_TICK; // adjust TickCounterForISR for correct gap value, which is used for repeat detection
+        sMicrosAtLastStopTimer = 0;
+    }
     timerEnableReceiveInterrupt(); // Enables the receive sample timer interrupt which consumes a small amount of CPU every 50 us.
 #ifdef _IR_MEASURE_TIMING
     pinModeFast(_IR_TIMING_TEST_PIN, OUTPUT);
@@ -394,33 +399,30 @@ void IRrecv::enableIRIn() {
  * We assume, that timer interrupts are disabled here, otherwise it makes no sense to use this functions.
  * Therefore we do not need to guard the change of the volatile TickCounterForISR here :-).
  * The tick counter value is already at 100 when decode() gets true, because of the 5000 us minimal gap defined in RECORD_GAP_MICROS.
+ * If TickCounterForISR is not adjusted with the value of the microseconds, the timer was stopped,
+ * it can happen, that a new IR frame is recognized as a repeat, because the value of RECORD_GAP_MICROS
+ * was not reached by TickCounterForISR counter before receiving the new IR frame.
  * @param aMicrosecondsToAddToGapCounter To compensate for the amount of microseconds the timer was stopped / disabled.
  */
-void IRrecv::start(uint32_t aMicrosecondsToAddToGapCounter) {
-    irparams.TickCounterForISR += aMicrosecondsToAddToGapCounter / MICROS_PER_TICK;
-    start();
-}
 void IRrecv::restartTimer(uint32_t aMicrosecondsToAddToGapCounter) {
     irparams.TickCounterForISR += aMicrosecondsToAddToGapCounter / MICROS_PER_TICK;
-    restartTimer();
-}
-void IRrecv::startWithTicksToAdd(uint16_t aTicksToAddToGapCounter) {
-    irparams.TickCounterForISR += aTicksToAddToGapCounter;
-    start();
+    timerConfigForReceive(); // no interrupts enabled here!
+    timerEnableReceiveInterrupt(); // Enables the receive sample timer interrupt which consumes a small amount of CPU every 50 us.
+#ifdef _IR_MEASURE_TIMING
+    pinModeFast(_IR_TIMING_TEST_PIN, OUTPUT);
+#endif
 }
 void IRrecv::restartTimerWithTicksToAdd(uint16_t aTicksToAddToGapCounter) {
     irparams.TickCounterForISR += aTicksToAddToGapCounter;
-    restartTimer();
-}
-
-void IRrecv::addTicksToInternalTickCounter(uint16_t aTicksToAddToInternalTickCounter) {
-    irparams.TickCounterForISR += aTicksToAddToInternalTickCounter;
-}
-
-void IRrecv::addMicrosToInternalTickCounter(uint16_t aMicrosecondsToAddToInternalTickCounter) {
-    irparams.TickCounterForISR += aMicrosecondsToAddToInternalTickCounter / MICROS_PER_TICK;
-}
+    timerConfigForReceive(); // no interrupts enabled here!
+    timerEnableReceiveInterrupt(); // Enables the receive sample timer interrupt which consumes a small amount of CPU every 50 us.
+#ifdef _IR_MEASURE_TIMING
+    pinModeFast(_IR_TIMING_TEST_PIN, OUTPUT);
+#endif
+    }
+#if defined(ESP8266) || defined(ESP32)
 #pragma GCC diagnostic push
+#endif
 
 /**
  * Restarts receiver after send. Is a NOP if sending does not require a timer.
@@ -438,8 +440,12 @@ void IRrecv::stop() {
     timerDisableReceiveInterrupt();
 }
 
+/*
+ * Stores microseconds of stop, to adjust TickCounterForISR in restartTimer()
+ */
 void IRrecv::stopTimer() {
     timerDisableReceiveInterrupt();
+    sMicrosAtLastStopTimer = micros();
 }
 /**
  * Alias for stop().

src/IRremoteInt.h

@@ -113,9 +113,9 @@ typedef uint64_t IRRawDataType;
 #define BITS_IN_RAW_DATA_TYPE   64
 #endif
 
-/****************************************************
+/**********************************************************
  * Declarations for the receiver Interrupt Service Routine
- ****************************************************/
+ **********************************************************/
 // ISR State-Machine : Receiver States
 #define IR_REC_STATE_IDLE      0 // Counting the gap time and waiting for the start bit to arrive
 #define IR_REC_STATE_MARK      1 // A mark was received and we are counting the duration of it.
@@ -144,6 +144,8 @@ struct irparams_struct {
     IRRawbufType rawbuf[RAW_BUFFER_LENGTH]; ///< raw data / tick counts per mark/space. With 8 bit we can only store up to 12.7 ms. First entry is empty to be backwards compatible.
 };
 
+extern unsigned long sMicrosAtLastStopTimer; // Used to adjust TickCounterForISR with uncounted ticks between stopTimer() and restartTimer()
+
 #include "IRProtocol.h"
 
 /*
@@ -213,17 +215,13 @@ class IRrecv {
      */
     void begin(uint_fast8_t aReceivePin, bool aEnableLEDFeedback = false, uint_fast8_t aFeedbackLEDPin =
     USE_DEFAULT_FEEDBACK_LED_PIN);
-    void restartTimer();
     void start();
     void enableIRIn(); // alias for start
-    void start(uint32_t aMicrosecondsToAddToGapCounter);
+    void restartTimer();
     void restartTimer(uint32_t aMicrosecondsToAddToGapCounter);
-    void startWithTicksToAdd(uint16_t aTicksToAddToGapCounter);
     void restartTimerWithTicksToAdd(uint16_t aTicksToAddToGapCounter);
     void restartAfterSend();
 
-    void addTicksToInternalTickCounter(uint16_t aTicksToAddToInternalTickCounter);
-    void addMicrosToInternalTickCounter(uint16_t aMicrosecondsToAddToInternalTickCounter);
 
     bool available();
     IRData* read(); // returns decoded data

src/TinyIR.h

@@ -34,9 +34,9 @@
  * @{
  */
 
-#define VERSION_TINYIR "2.1.0"
+#define VERSION_TINYIR "2.2.0"
 #define VERSION_TINYIR_MAJOR 2
-#define VERSION_TINYIR_MINOR 1
+#define VERSION_TINYIR_MINOR 2
 #define VERSION_TINYIR_PATCH 0
 // The change log is at the bottom of the file
 
@@ -243,7 +243,7 @@ struct TinyIRReceiverCallbackDataStruct {
     uint8_t Command;
 #endif
     uint8_t Flags; // Bit coded flags. Can contain one of the bits: IRDATA_FLAGS_IS_REPEAT and IRDATA_FLAGS_PARITY_FAILED
-    bool justWritten; ///< Is set true if new data is available. Used by the main loop, to avoid multiple evaluations of the same IR frame.
+    bool justWritten; ///< Is set true if new data is available. Used by the main loop / TinyReceiverDecode(), to avoid multiple evaluations of the same IR frame.
 };
 extern volatile TinyIRReceiverCallbackDataStruct TinyIRReceiverData;
 
@@ -252,6 +252,7 @@ bool initPCIInterruptForTinyReceiver();
 bool enablePCIInterruptForTinyReceiver();
 void disablePCIInterruptForTinyReceiver();
 bool isTinyReceiverIdle();
+bool TinyReceiverDecode();
 void printTinyReceiverResultMinimal(Print *aSerial);
 
 void sendFAST(uint8_t aSendPin, uint16_t aCommand, uint_fast8_t aNumberOfRepeats = 0);
@@ -263,6 +264,9 @@ void sendNEC(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_
 void sendExtendedNEC(uint8_t aSendPin, uint16_t aAddress, uint16_t aCommand, uint_fast8_t aNumberOfRepeats = 0, bool aSendNEC2Repeats = false);
 
 /*
+ *  Version 2.2.0 - 7/2024
+ *  - New TinyReceiverDecode() function to be used as drop in for IrReceiver.decode().
+ *
  *  Version 2.1.0 - 2/2024
  *  - New sendExtendedNEC() function and new parameter aSendNEC2Repeats.
  *

src/TinyIRReceiver.hpp

@@ -84,7 +84,6 @@
 //#define USE_ONKYO_PROTOCOL    // Like NEC, but take the 16 bit address and command each as one 16 bit value and not as 8 bit normal and 8 bit inverted value.
 //#define USE_FAST_PROTOCOL     // Use FAST protocol instead of NEC / ONKYO.
 //#define ENABLE_NEC2_REPEATS // Instead of sending / receiving the NEC special repeat code, send / receive the original frame for repeat.
-
 #include "TinyIR.h" // If not defined, it defines IR_RECEIVE_PIN, IR_FEEDBACK_LED_PIN and TINY_RECEIVER_USE_ARDUINO_ATTACH_INTERRUPT
 
 #include "digitalWriteFast.h"
@@ -384,7 +383,7 @@ void IRPinChangeInterruptHandler(void) {
                     // Here we have 8 bit command
                     TinyIRReceiverData.Command = TinyIRReceiverControl.IRRawData.UBytes[2];
 #  else
-                            // Here we have 16 bit command
+                    // Here we have 16 bit command
                     TinyIRReceiverData.Command = TinyIRReceiverControl.IRRawData.UWord.HighWord;
 #  endif
 
@@ -426,6 +425,17 @@ bool isTinyReceiverIdle() {
     return (TinyIRReceiverControl.IRReceiverState == IR_RECEIVER_STATE_WAITING_FOR_START_MARK);
 }
 
+/*
+ * Function to be used as drop in for IrReceiver.decode()
+ */
+bool TinyReceiverDecode() {
+    bool tJustWritten = TinyIRReceiverData.justWritten;
+    if (tJustWritten) {
+        TinyIRReceiverData.justWritten = false;
+    }
+    return tJustWritten;
+}
+
 /*
  * Checks if IR_RECEIVE_PIN is connected and high
  * @return true, if IR Receiver is attached