Documentation

Author: ArminJo

.github/workflows/LibraryBuild.yml

@@ -51,8 +51,8 @@ jobs:
  - 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
+ - digistump:avr:digispark-tiny:clock=clock16
+ - ATTinyCore:avr:attinyx5micr:LTO=enable,sketchclock=16pll
  - TinyCore:avr:tiny32
  - arduino:samd:arduino_zero_native
  - MegaCore:avr:128:bootloader=no_bootloader,eeprom=keep,BOD=2v7,LTO=Os_flto,clock=8MHz_internal # ATmega128
@@ -106,26 +106,20 @@ jobs:
  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
+ - arduino-boards-fqbn: digistump:avr:digispark-tiny:clock=clock16
  platform-url: https://raw.githubusercontent.com/ArminJo/DigistumpArduino/master/package_digistump_index.json
  required-libraries: ATtinySerialOut
- sketches-exclude: UnitTest,ControlRelay,ReceiveAndSend,SendAndReceive,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 -DEXCLUDE_UNIVERSAL_PROTOCOLS
+ sketch-names: MinimalReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino
 
  - 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,SendAndReceive,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 -DEXCLUDE_UNIVERSAL_PROTOCOLS
+ sketch-names: MinimalReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino
 
- - arduino-boards-fqbn: ATTinyCore:avr:attinyx5:chip=85,clock=1internal
+ - arduino-boards-fqbn: ATTinyCore:avr:attinyx5micr:LTO=enable,sketchclock=16pll
  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 -DEXCLUDE_UNIVERSAL_PROTOCOLS
+ sketch-names: MinimalReceiver.ino,IRremoteInfo.ino,SimpleReceiver.ino,ReceiveDemo.ino,ControlRelay.ino,SimpleSender.ino,SendDemo.ino,SendRawDemo.ino,SendAndReceive.ino
 
  - arduino-boards-fqbn: TinyCore:avr:tiny32
  platform-url: https://raw.githubusercontent.com/xukangmin/TinyCore/master/avr/package/package_tinycore_index.json
@@ -177,5 +171,6 @@ jobs:
  arduino-platform: ${{ matrix.arduino-platform }}
  platform-url: ${{ matrix.platform-url }}
  required-libraries: ${{ matrix.required-libraries }}
+ sketch-names: ${{ matrix.sketch-names }}
  sketches-exclude: ${{ matrix.sketches-exclude }}
  build-properties: ${{ toJson(matrix.build-properties) }}

README.md

@@ -1,7 +1,7 @@
 # IRremote Arduino Library
 Available as Arduino library "IRremote"
 
-### [Version 3.3.0](https://github.com/Arduino-IRremote/Arduino-IRremote/archive/master.zip) - work in progress
+### [Version 3.3.1](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)
@@ -180,7 +180,7 @@ 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. |
 | `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_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 650 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. |
 | `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. |

changelog.md

@@ -1,5 +1,7 @@
 # Changelog
 The latest version may not be released!
+## 3.3.1
+
 ## 3.3.0
 - Fix errors if LED_BUILTIN is not defined.
 - Fixed error for AVR timer1. Thanks to alexbarcelo.

examples/ControlRelay/ControlRelay.ino

@@ -33,6 +33,10 @@
  */
 #include <Arduino.h>
 
+#if FLASHEND <= 0x1FFF // For 8k flash or less, like ATtiny85. Exclude exotic protocols.
+#define EXCLUDE_UNIVERSAL_PROTOCOLS // Saves up to 1000 bytes program space.
+#define EXCLUDE_EXOTIC_PROTOCOLS
+#endif
 /*
  * Define macros for input and output pin etc.
  */
@@ -81,12 +85,18 @@ void loop() {
  Serial.println(F("off"));
  }
 
+#if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604
  IrReceiver.printIRResultShort(&Serial);
  Serial.println();
  if (IrReceiver.decodedIRData.protocol == UNKNOWN) {
  // We have an unknown protocol, print more info
  IrReceiver.printIRResultRawFormatted(&Serial, true);
  }
+#else
+ // Print a minimal summary of received data
+ IrReceiver.printIRResultMinimal(&Serial);
+ Serial.println();
+#endif // FLASHEND
  }
  last = millis();
  IrReceiver.resume(); // Enable receiving of the next value

examples/ReceiveDemo/ReceiveDemo.ino

@@ -38,16 +38,19 @@
  * If no protocol is defined, all protocols are active.
  * This must be done before the #include <IRremote.h>
  */
-//#define DECODE_LG 1
-//#define DECODE_NEC 1
+//#define DECODE_LG
+//#define DECODE_NEC
 // etc. see IRremote.h
 //
 //#define DISABLE_LED_FEEDBACK_FOR_RECEIVE // saves 108 bytes program space
-#if FLASHEND <= 0x1FFF
+#if FLASHEND <= 0x1FFF // For 8k flash or less, like ATtiny85. Exclude exotic protocols.
 #define EXCLUDE_EXOTIC_PROTOCOLS
-#define EXCLUDE_UNIVERSAL_PROTOCOLS
+# if !defined(DIGISTUMPCORE) // ATTinyCore is bigger than Digispark core
+#define EXCLUDE_UNIVERSAL_PROTOCOLS // Saves up to 1000 bytes program space.
+# endif
 #endif
-//#define EXCLUDE_EXOTIC_PROTOCOLS // saves around 670 bytes program space if all other protocols are active
+//#define EXCLUDE_UNIVERSAL_PROTOCOLS // Saves up to 1000 bytes program space.
+//#define EXCLUDE_EXOTIC_PROTOCOLS // saves around 650 bytes program space if all other protocols are active
 //#define IR_MEASURE_TIMING
 
 // MARK_EXCESS_MICROS is subtracted from all marks and added to all spaces before decoding,
@@ -78,7 +81,7 @@ void setup() {
 #if defined(IR_MEASURE_TIMING) && defined(IR_TIMING_TEST_PIN)
  pinMode(IR_TIMING_TEST_PIN, OUTPUT);
 #endif
-#if FLASHEND > 0x1FFF // For more than 8k flash. Code does not fit in program space of ATtiny85 etc.
+#if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604. Code does not fit in program space of ATtiny85 etc.
  pinMode(DEBUG_BUTTON_PIN, INPUT_PULLUP);
 #endif
 
@@ -105,7 +108,7 @@ void setup() {
  Serial.println(IR_RECEIVE_PIN);
 #endif
 
-#if FLASHEND > 0x1FFF // For more than 8k flash. Code does not fit in program space of ATtiny85 etc.
+#if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604. Code does not fit in program space of ATtiny85 etc.
  Serial.print(F("Debug button pin is "));
  Serial.println(DEBUG_BUTTON_PIN);
 #endif
@@ -128,10 +131,7 @@ void loop() {
  */
  if (IrReceiver.decode()) {
  Serial.println();
-#if FLASHEND <= 0x1FFF // For less equal than 8k flash, like ATtiny85
- // Print a minimal summary of received data
- IrReceiver.printIRResultMinimal(&Serial);
-#else
+#if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604
  if (IrReceiver.decodedIRData.flags & IRDATA_FLAGS_WAS_OVERFLOW) {
  IrReceiver.decodedIRData.flags = false; // yes we have recognized the flag :-)
  Serial.println(F("Overflow detected"));
@@ -167,7 +167,10 @@ void loop() {
  IrReceiver.start(8000); // to compensate for 8 ms stop of receiver. This enables a correct gap measurement.
  }
 # endif
-#endif // FLASHEND > 0x1FFF
+#else
+ // Print a minimal summary of received data
+ IrReceiver.printIRResultMinimal(&Serial);
+#endif // FLASHEND
 
  /*
  * !!!Important!!! Enable receiving of the next value,

examples/SendAndReceive/SendAndReceive.ino

@@ -32,12 +32,21 @@
 
 #include <Arduino.h>
 
+// select only NEC and the universal decoder for pulse width or pulse distance protocols
+#define DECODE_NEC // Includes Apple and Onkyo
+#define DECODE_DISTANCE
+
 /*
  * Define macros for input and output pin etc.
  */
 #include "PinDefinitionsAndMore.h"
 
-//#define EXCLUDE_EXOTIC_PROTOCOLS // saves around 240 bytes program space if IrSender.write is used
+#if FLASHEND <= 0x1FFF // For 8k flash or less, like ATtiny85. Exclude exotic protocols.
+#define EXCLUDE_UNIVERSAL_PROTOCOLS // Saves up to 1000 bytes program space.
+#define EXCLUDE_EXOTIC_PROTOCOLS
+#endif
+//#define EXCLUDE_UNIVERSAL_PROTOCOLS // Saves up to 1000 bytes program space.
+//#define EXCLUDE_EXOTIC_PROTOCOLS
 //#define SEND_PWM_BY_TIMER
 //#define USE_NO_SEND_PWM
 
@@ -77,19 +86,21 @@ void setup() {
  Serial.println(IR_SEND_PIN);
 #endif
 
-#if FLASHEND > 0x1FFF && !defined(SEND_PWM_BY_TIMER) && !defined(USE_NO_SEND_PWM) && !defined(ESP32) // for esp32 we use PWM generation by ledcWrite() for each pin
+#if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604
+// For esp32 we use PWM generation by ledcWrite() for each pin.
+# if !defined(SEND_PWM_BY_TIMER) && !defined(USE_NO_SEND_PWM) && !defined(ESP32)
  /*
- * Print internal signal generation info
+ * Print internal software PWM generation info
  */
- IrSender.enableIROut(38);
-
+ IrSender.enableIROut(38); // Call it with 38 kHz to initialize the values printed below
  Serial.print(F("Send signal mark duration is "));
  Serial.print(IrSender.periodOnTimeMicros);
  Serial.print(F(" us, pulse correction is "));
  Serial.print(IrSender.getPulseCorrectionNanos());
  Serial.print(F(" ns, total period is "));
  Serial.print(IrSender.periodTimeMicros);
  Serial.println(F(" us"));
+# endif
 
  // infos for receive
  Serial.print(RECORD_GAP_MICROS);

examples/SendDemo/SendDemo.ino

@@ -67,8 +67,7 @@ void setup() {
  /*
  * Print internal signal generation info
  */
- IrSender.enableIROut(38);
-
+ IrSender.enableIROut(38); // Call it with 38 kHz to initialize the values printed below
  Serial.print(F("Send signal mark duration is "));
  Serial.print(IrSender.periodOnTimeMicros);
  Serial.print(F(" us, pulse correction is "));
@@ -115,7 +114,7 @@ void loop() {
  delay(DELAY_AFTER_SEND);
 
  if (sRepeats == 0) {
-#if FLASHEND > 0x1FFF // For more than 8k flash. Code does not fit in program space of ATtiny85 etc.
+#if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604. Code does not fit in program space of ATtiny85 etc.
  /*
  * Send constant values only once in this demo
  */
@@ -211,7 +210,7 @@ void loop() {
  IrSender.sendRC6(sAddress, sCommand, sRepeats, true);
  delay(DELAY_AFTER_SEND);
 
-#if FLASHEND > 0x1FFF // For more than 8k flash. Code does not fit in program space of ATtiny85 etc.
+#if FLASHEND >= 0x3FFF // For 16k flash or more, like ATtiny1604. Code does not fit in program space of ATtiny85 etc.
  /*
  * Next example how to use the IrSender.write function
  */
@@ -255,7 +254,7 @@ void loop() {
  IrSender.sendLegoPowerFunctions(sAddress, sCommand, LEGO_MODE_COMBO, true);
  delay(DELAY_AFTER_SEND);
 
-#endif // FLASHEND > 0x1FFF
+#endif // FLASHEND
  /*
  * Force buffer overflow
  */