Release 3.1.0

Author: ArminJo

README.md

@@ -18,7 +18,7 @@ A Doxygen documentation of the sources is available on the [project homepage](ht
 Click on the LibraryManager badge above to see the [instructions](https://www.ardu-badge.com/IRremote/zip).
 
 # Supported IR Protocols
-Denon, JVC, LG, NEC / Apple, Panasonic / Kaseikyo, RC5, RC6, Samsung, Sharp, Sony, (Pronto), BoseWave, Lego, Whynter, MagiQuest.<br/>
+Denon / Sharp, JVC, LG, NEC / Apple, Panasonic / Kaseikyo, RC5, RC6, Samsung, Sony, (Pronto), BoseWave, Lego, Whynter, MagiQuest.<br/>
 Protocols can be switched off and on by definining macros before the line `#incude <IRremote.h>` like [here](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/SimpleReceiver/SimpleReceiver.ino#L14):
 
 ```
@@ -34,6 +34,7 @@ This is a quite old but maybe useful wiki for this library.
 This must be done also for all versions > 3.0.1 if `USE_NO_SEND_PWM` is defined.<br/>
 Starting with this version, **the generation of PWM is done by software**, thus saving the hardware timer and **enabling abitrary output pins**.<br/>
 Therefore you must change all `IrSender.begin(true);` by `IrSender.begin(IR_SEND_PIN, ENABLE_LED_FEEDBACK);`.
+If you use a core that does not use the `-flto` flag for compile, you can activate the line `#define SUPPRESS_ERROR_MESSAGE_FOR_BEGIN` in IRRemote.h, if you get false error messages regarding begin() during compilation.
 
 # Converting your 2.x program to the 3.x version
 - Now there is an **IRreceiver** and **IRsender** object like the well known Arduino **Serial** object.
@@ -84,6 +85,7 @@ If you do not know which protocol your IR transmitter uses, you have several cho
  since one IR diode requires only 1.5 volt.
  - The line \#include "ATtinySerialOut.h" in PinDefinitionsAndMore.h (requires the library to be installed) saves 370 bytes program space and 38 bytes RAM for **Digispark boards** as well as enables serial output at 8MHz.
  - The default software generated PWM has **problems on ATtinies running with 8 MHz**. The PWM frequency is around 30 instead of 38 kHz and RC6 is not reliable. You can switch to timer PWM generation by `#define SEND_PWM_BY_TIMER`.
+ - Minimal CPU frequency for receiving is 4 MHz, sive the 50 us timer ISR takes around 12 us on a 16 MHz ATmega.
 
 # Examples
 In order to fit the examples to the 8K flash of ATtiny85 and ATtiny88, the [Arduino library ATtinySerialOut](https://github.com/ArminJo/ATtinySerialOut) is required for this CPU's.

changelog.md

@@ -2,23 +2,22 @@
 The latest version may not be released!
 
 ## 3.1.0
-- Replaced `#define DECODE_NEC 1/0` by defining/not defining.
 - USE_SOFT_SEND_PWM is active by default.
-- Refactored Board specific code.
-- Separated timer and feedback LED related code.
-- Added STM32F1 by (by Roger Clark) support.
-- Added stm32 (by ST) support. Thanks to Paolo Malaspina.
-- Refactored LED Feedback functions.
-- Renamed most irparams_struct values.
-- Implemented feedback for send.
 - Removed decode_results results.
-- Added unit test and fixed LG send bug.
-- MATCH_MARK() etc. now available as matchMark().
-- Added ATtiny88 support.
-- Use LED_BUILTIN instead of FEEDBACK_LED FeedbackLEDPin is 0.
+- Renamed most irparams_struct values.
+- Fixed LG send bug and added unit test.
+- Replaced `#define DECODE_NEC 1/0` by defining/not defining.
+- Use LED_BUILTIN instead of FEEDBACK_LED if FeedbackLEDPin is 0.
 - Use F_CPU instead of SYSCLOCK.
 - Removed SENDPIN_ON and SENDPIN_OFF macros.
 
+- Refactored board specific code for timer and feedback LED.
+- Extracted common LED feedback functions and implemented feedback for send.
+- MATCH_MARK() etc. now available as matchMark().
+- Added STM32F1 by (by Roger Clark) support.
+- Added stm32 (by ST) support. Thanks to Paolo Malaspina.
+- Added ATtiny88 support.
+
 ## 3.0.2
 - Bug fix for USE_OLD_DECODE.
 - Increase RECORD_GAP_MICROS to 11000.

library.properties

@@ -3,7 +3,7 @@ version=3.1.0
 author=shirriff, z3t0 <zetoslab@gmail.com>, ArminJo
 maintainer=Armin Joachimsmeyer <armin.arduino@gmail.com>
 sentence=Send and receive infrared signals with multiple protocols
-paragraph=Currently included protocols: Denon, JVC, LG, NEC, Panasonic / Kaseikyo, RC5, RC6, Samsung, Sharp, Sony, (Pronto), BoseWave, Lego, Whynter, MagiQuest.<br/><br/><b>New: </b><a href="https://github.com/Arduino-IRremote/Arduino-IRremote#converting-your-2x-program-to-the-3x-version">Upgrade instructions</a><br/>Generation of PWM is done by software by default, thus saving the hardware timer and enabling abitrary output pins. STM32 support added. Major refactoring of CPU dependent and feedback LED code.<br/>
+paragraph=Currently included protocols: Denon / Sharp, JVC, LG, NEC / 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/>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/>
 category=Communication
 url=https://github.com/Arduino-IRremote/Arduino-IRremote
 architectures=avr,megaavr,samd,esp32,mbed,stm32,STM32F1

src/IRReceive.cpp.h

@@ -1234,6 +1234,7 @@ const __FlashStringHelper* getProtocolString(decode_type_t aProtocol) {
  * 15 pushs, 1 in, 1 eor before start of code = 2 us @16MHz + * 7.2 us computation time (6us idle time) + * pop + reti = 2.25 us @16MHz => 10.3 to 11.5 us @16MHz
  * With portInputRegister and mask and Feedback LED code commented
  * 9 pushs, 1 in, 1 eor before start of code = 1.25 us @16MHz + * 2.25 us computation time + * pop + reti = 1.5 us @16MHz => 5 us @16MHz
+ * => Minimal CPU frequency is 4 MHz
  *
  **********************************************************************************************************************/
 //#define IR_MEASURE_TIMING

src/IRSend.cpp.h

@@ -71,9 +71,10 @@ void IRsend::begin(uint8_t aSendPin, bool aEnableLEDFeedback, uint8_t aLEDFeedba
  * @param aLEDFeedbackPin if 0, then take board specific FEEDBACK_LED_ON() and FEEDBACK_LED_OFF() functions
  */
 void IRsend::begin(bool aEnableLEDFeedback, uint8_t aLEDFeedbackPin) {
- // must exclude NRF5, SAMD and ESP32 because they do not use the -flto flag for compile
+ // must exclude MEGATINYCORE, NRF5, SAMD and ESP32 because they do not use the -flto flag for compile
 #if (defined(USE_SOFT_SEND_PWM) || defined(USE_NO_SEND_PWM)) \
- && !(defined(NRF5) || defined(ARDUINO_ARCH_NRF52840)) && !defined(ARDUINO_ARCH_SAMD) \
+ && !defined(SUPPRESS_ERROR_MESSAGE_FOR_BEGIN) \
+ && !(defined(NRF5) || defined(ARDUINO_ARCH_NRF52840)) && !defined(ARDUINO_ARCH_SAMD) \
  && !defined(ESP32) && !defined(MEGATINYCORE) \
  && !(defined(__STM32F1__) || defined(ARDUINO_ARCH_STM32F1)) && !(defined(STM32F1xx) || defined(ARDUINO_ARCH_STM32))
  UsageError("Error: You must use begin(<sendPin>, <EnableLEDFeedback>, <LEDFeedbackPin>) if USE_SOFT_SEND_PWM or USE_NO_SEND_PWM is defined!");

src/IRremote.h

@@ -47,6 +47,9 @@
 #define VERSION_IRREMOTE_MAJOR 3
 #define VERSION_IRREMOTE_MINOR 1
 
+// activate it for all cores that does not use the -flto flag, if you get false error messages regarding begin() during compilation.
+//#define SUPPRESS_ERROR_MESSAGE_FOR_BEGIN
+
 /*
  * If activated, BOSEWAVE, MAGIQUEST,WHYNTER and LEGO_PF are excluded in decoding and in sending with IrSender.write
  */

src/TinyIRReceiver.cpp.h

@@ -1,5 +1,5 @@
 /*
- * TinIRReceiver.cpp.h
+ * TinyIRReceiver.cpp.h
  *
  * Receives IR protocol data of NEC protocol using pin change interrupts.
  * NEC is the protocol of most cheap remote controls for Arduino.
@@ -42,6 +42,10 @@
 #include "TinyIRReceiver.h"
 #include "digitalWriteFast.h"
 
+//#define IR_MEASURE_TIMING
+//#define IR_TIMING_TEST_PIN 7
+//#define DO_NOT_USE_FEEDBACK_LED
+
 /** \addtogroup TinyReceiver Minimal receiver for NEC protocol
  * @{
  */
@@ -62,13 +66,17 @@ void handleReceivedIRData(uint16_t aAddress, uint8_t aCommand, bool isRepetition
 /**
  * The ISR of TinyIRRreceiver.
  * It handles the NEC protocol decoding and calls the user callback function on complete.
+ * 5 us + 3 us for push + pop for a 16MHz ATmega
  */
 #if defined(ESP8266)
 ICACHE_RAM_ATTR
 #elif defined(ESP32)
 IRAM_ATTR
 #endif
 void IRPinChangeInterruptHandler(void) {
+#if defined(IR_MEASURE_TIMING) && defined(IR_TIMING_TEST_PIN)
+ digitalWriteFast(IR_TIMING_TEST_PIN, HIGH); // 2 clock cycles
+#endif
  /*
  * Save IR input level
  * Negative logic, true / HIGH means inactive / IR space, LOW / false means IR mark.
@@ -156,7 +164,7 @@ void IRPinChangeInterruptHandler(void) {
  tState = IR_RECEIVER_STATE_WAITING_FOR_START_MARK;
  }
  } else {
- // error wrong state for the received level (should not happen!) -> reset state (2 checks costs 10 bytes programming space)
+ // error wrong state for the received level, e.g. if we missed one change interrupt -> reset state
  tState = IR_RECEIVER_STATE_WAITING_FOR_START_MARK;
  }
  }
@@ -217,18 +225,24 @@ void IRPinChangeInterruptHandler(void) {
  tState = IR_RECEIVER_STATE_WAITING_FOR_START_MARK;
  }
  } else {
- // error wrong state for the received level (should not happen!) -> reset state (2 checks costs 10 bytes programming space)
+ // error wrong state for the received level, e.g. if we missed one change interrupt -> reset state
  tState = IR_RECEIVER_STATE_WAITING_FOR_START_MARK;
  }
  }
 
  TinyIRReceiverControl.IRReceiverState = tState;
+#ifdef IR_MEASURE_TIMING
+ digitalWriteFast(IR_TIMING_TEST_PIN, LOW); // 2 clock cycles
+#endif
 }
 
 /**
  * Initializes hardware interrupt generation according to IR_INPUT_PIN or use attachInterrupt() function.
  */
 void initPCIInterruptForTinyReceiver() {
+#if defined(IR_MEASURE_TIMING) && defined(IR_TIMING_TEST_PIN)
+ pinModeFast(IR_TIMING_TEST_PIN, OUTPUT);
+#endif
  pinModeFast(IR_INPUT_PIN, INPUT_PULLUP);
 
 #if !defined(DO_NOT_USE_FEEDBACK_LED) && defined(IR_FEEDBACK_LED_PIN)