Implemented feedback for send. Removed decode_results results. Added unit test and fixed LG send bug. MATCH_MARK() etc. now available as matchMark(). Added PinDefinitionsAndMore.h.

Author: ArminJo

.github/workflows/LibraryBuild.yml

@@ -104,13 +104,13 @@ jobs:
 
           - arduino-boards-fqbn: digistump:avr:digispark-tiny:clock=clock1
             platform-url: https://raw.githubusercontent.com/ArminJo/DigistumpArduino/master/package_digistump_index.json
-            sketches-exclude: IR2Keyboard,IRUnitTest,IRrelay,ReceiveAndSend,IRreceiveDump,IRsendProntoDemo,MicroGirs,IRDispatcherDemo,LGAirConditionerSendDemo,ReceiverTimingAnalysis # Does not fit in FLASH or RAM, missing digitalPinToInterrupt
+            sketches-exclude: IR2Keyboard,UnitTest,ControlRelay,ReceiveAndSend,ReceiveDump,SendProntoDemo,MicroGirs,IRDispatcherDemo,SendLGAirConditionerDemo,ReceiverTimingAnalysis # Does not fit in FLASH or RAM, missing digitalPinToInterrupt
             build-properties: # the flags were put in compiler.cpp.extra_flags
               All: -DEXCLUDE_EXOTIC_PROTOCOLS
 
           - arduino-boards-fqbn: ATTinyCore:avr:attinyx5:chip=85,clock=1internal
             platform-url: http://drazzy.com/package_drazzy.com_index.json
-            sketches-exclude: IR2Keyboard,IRUnitTest,IRrelay,ReceiveAndSend,IRreceiveDump,IRsendProntoDemo,MicroGirs,IRDispatcherDemo,LGAirConditionerSendDemo,ReceiverTimingAnalysis # Does not fit in FLASH or RAM
+            sketches-exclude: IR2Keyboard,UnitTest,ReceiveAndSend,ReceiveDump,SendProntoDemo,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
 

README.md

@@ -32,13 +32,13 @@ This is a quite old but maybe useful wiki for this library.
 # Converting your program to the 3.1 version
 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, true);`.
+Therefore you must change all `IrSender.begin(true);` by `IrSender.begin(IR_SEND_PIN, ENABLE_LED_FEEDBACK);`.
 
 # 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.
 - Just remove the line `IRrecv IrReceiver(IR_RECEIVE_PIN);` and/or `IRsend IrSender;` in your program, and replace all occurrences of `IRrecv.` or `irrecv.` with `IrReceiver`.
 - Since the decoded values are now in `IrReceiver.decodedIRData` and not in `results` any more, remove the line `decode_results results` or similar.
-- Like for the Serial object, call [`IrReceiver.begin(IR_RECEIVE_PIN, ENABE_ED_FEEDBACK);`](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/IRreceiveDemo/IRreceiveDemo.ino#L38) or `IrReceiver.begin(IR_RECEIVE_PIN, DISABLE_LED_FEEDBACK);` instead of the `IrReceiver.enableIRIn();` or `irrecv.enableIRIn();` in setup().
+- Like for the Serial object, call [`IrReceiver.begin(IR_RECEIVE_PIN, ENABE_ED_FEEDBACK);`](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/ReceiveDemo/ReceiveDemo.ino#L38) or `IrReceiver.begin(IR_RECEIVE_PIN, DISABLE_LED_FEEDBACK);` instead of the `IrReceiver.enableIRIn();` or `irrecv.enableIRIn();` in setup().
 - Old `decode(decode_results *aResults)` function is replaced by simple `decode()`. So if you have a statement `if(irrecv.decode(&results))` replace it with `if (IrReceiver.decode())`.
 - The decoded result is now in in `IrReceiver.decodedIRData` and not in `results` any more, therefore replace any occurrences of `results.value`  and / or `results.decode_type` (and similar) to `IrReceiver.decodedIRData.decodedRawData` and / or `IrReceiver.decodedIRData.decodedRawData`.
 - Overflow, Repeat and other flags are now in [`IrReceiver.receivedIRData.flags`](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/IRremote.h#L126).
@@ -69,8 +69,8 @@ The main reason is, that it was designed to fit inside MCUs with relatively low
 
 ## Hints
 If you do not know which protocol your IR transmitter uses, you have several choices.
-- Use the [IRreceiveDump example](examples/IRreceiveDump) to dump out the IR timing.
- You can then reproduce/send this timing with the [IRsendRawDemo example](examples/IRsendRawDemo).
+- Use the [IRreceiveDump example](examples/ReceiveDump) to dump out the IR timing.
+ You can then reproduce/send this timing with the [SendRawDemo example](examples/SendRawDemo).
  For **long codes** with more than 48 bits like from air conditioners, you can **change the length of the input buffer** in [IRremote.h](src/IRremoteInt.h#L36).
 - The [IRMP AllProtocol example](https://github.com/ukw100/IRMP#allprotocol-example) prints the protocol and data for one of the **40 supported protocols**.
  The same library can be used to send this codes.
@@ -86,7 +86,7 @@ If you do not know which protocol your IR transmitter uses, you have several cho
 ### SimpleReceiver + SimpleSender
 This examples are a good starting point.
 
-### IRReceiveDemo + IRSendDemo 
+### ReceiveDemo + SendDemo
 More complete examples for the advanced user.
 
 ### ReceiveAndSend
@@ -95,7 +95,7 @@ Like the name states...
 ### MinimalReceiver + SmallReceiver
 If code size matters look at these examples.
 
-### DispatcherDemo
+### IRDispatcherDemo
 Framework for calling different functions for different IR codes.
 
 ### IRrelay
@@ -113,11 +113,12 @@ Modify it by commenting them out or in, or change the values if applicable. Or d
 | `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. |
 | `USE_NO_SEND_PWM` | Before `#include <IRremote.h>` | disabled | Use no carrier PWM, just simulate an active low receiver signal. |
 | `FEEDBACK_LED_IS_ACTIVE_LOW` | Before `#include <IRremote.h>` | disabled | Required on some boards (like my BluePill and my ESP8266 board), where the feedback LED is active low. |
+| `DISABLE_LED_FEEDBACK_FOR_RECEIVE` | Before `#include <IRremote.h>` | disabled | This disables the LED feedback code for receive, thus saving around 108 bytes program space and halving the receiver ISR processing time. |
 | `IR_INPUT_IS_ACTIVE_HIGH` | IRremoteInt.h | disabled | Enable it if you use a RF receiver, which has an active HIGH output signal. |
 | `RAW_BUFFER_LENGTH` | IRremoteint.h | 101 | Buffer size of raw input buffer. Must be odd! |
 | `DEBUG` | IRremoteInt.h | disabled | Enables lots of lovely debug output. |
-| `IR_SEND_DUTY_CYCLE` | IRremoteBoardDefs.h | 30 | Duty cycle of IR send signal. |
-| `MICROS_PER_TICK` | IRremoteBoardDefs.h | 50 | Resolution of the raw input buffer data. |
+| `IR_SEND_DUTY_CYCLE` | IRBoardDefs.h | 30 | Duty cycle of IR send signal. |
+| `MICROS_PER_TICK` | IRBoardDefs.h | 50 | Resolution of the raw input buffer data. |
 |-|-|-|-|
 | `IR_INPUT_PIN` | TinyIRReceiver.h | 2 | The pin number for TinyIRReceiver IR input, which gets compiled in. |
 | `IR_FEEDBACK_LED_PIN` | TinyIRReceiver.h | `LED_BUILTIN` | The pin number for TinyIRReceiver feedback LED, which gets compiled in. |
@@ -158,7 +159,7 @@ The send PWM signal is by default generated by software. **Therefore every pin c
 ## Hardware-PWM signal generation for sending
 If you define `SEND_PWM_BY_TIMER`, the send PWM signal is generated by a hardware timer. The same timer as for the receiver is used.
 Since each hardware timer has its dedicated output pins, you must change timer to change PWN output.<br/>
-The timer and the pin usage can be adjusted in [IRremoteBoardDefs.h](src/private/IRremoteBoardDefs.h)
+The timer and the pin usage can be adjusted in [IRBoardDefs.h](src/private/IRBoardDefs.h)
 
 | Board/CPU                                                                | Hardware-PWM Pin    | Timers            |
 |--------------------------------------------------------------------------|---------------------|-------------------|

changelog.md

@@ -9,6 +9,8 @@
 - 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().
 
 ## 3.0.2
 - Bug fix for USE_OLD_DECODE.

examples/IRrelay/IRrelay.ino renamed to examples/ControlRelay/ControlRelay.ino

@@ -1,5 +1,6 @@
 /*
- * IRremote: IRrelay - demonstrates receiving IR codes with IRrecv
+ * ControlRelay.cpp
+ *
  * Toggles an output pin at each command received
  * An IR detector/demodulator must be connected to the input RECV_PIN.
  * Initially coded 2009 Ken Shirriff http://www.righto.com
@@ -9,7 +10,7 @@
  ************************************************************************************
  * MIT License
  *
- * Copyright (c) 2020-2021 Armin Joachimsmeyer
+ * Copyright (c) 2009-2021 Ken Shirriff, 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
@@ -39,7 +40,11 @@
 
 #include <IRremote.h>
 
-int RELAY_PIN = 4; // is labeled D2 on the Chinese SAMD21 M0-Mini clone
+#if defined(APPLICATION_PIN)
+#define RELAY_PIN   APPLICATION_PIN
+#else
+#define RELAY_PIN   5
+#endif
 
 void setup() {
     pinMode(LED_BUILTIN, OUTPUT);

examples/IRreceiveDump/PinDefinitionsAndMore.h renamed to examples/ControlRelay/PinDefinitionsAndMore.h

@@ -9,7 +9,7 @@
  *
  *  This file is part of IRMP https://github.com/Arduino-IRremote/Arduino-IRremote.
  *
- *  IRMP is free software: you can redistribute it and/or modify
+ *  Arduino-IRremote is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *  the Free Software Foundation, either version 3 of the License, or
  *  (at your option) any later version.
@@ -44,19 +44,19 @@
 //
 #if defined(ESP8266)
 #define FEEDBACK_LED_IS_ACTIVE_LOW // The LED on my board is active LOW
-#define IR_RECEIVE_PIN  14 // D5
-#define IR_SEND_PIN     12 // D6 - D4/2 is internal LED
-#define tone(a,b) void() // tone() inhibits receive timer
+#define IR_RECEIVE_PIN      14 // D5
+#define IR_SEND_PIN         12 // D6 - D4/2 is internal LED
+#define tone(a,b) void()        // tone() inhibits receive timer
 #define noTone(a) void()
-#define TONE_PIN        42 // Dummy for examples using it
-#define IR_TIMING_TEST_PIN 13 // D7
+#define TONE_PIN            42 // Dummy for examples using it
+#define IR_TIMING_TEST_PIN  13 // D7
 
 #elif defined(ESP32)
-#define IR_RECEIVE_PIN  15  // D15
-#define IR_SEND_PIN      4  // D4
-#define tone(a,b) void() // no tone() available on ESP32
+#define IR_RECEIVE_PIN      15  // D15
+#define IR_SEND_PIN          4  // D4
+#define tone(a,b) void()        // no tone() available on ESP32
 #define noTone(a) void()
-#define TONE_PIN        42 // Dummy for examples using it
+#define TONE_PIN            42 // Dummy for examples using it
 
 #elif defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_STM32F1)
 // BluePill in 2 flavors
@@ -101,34 +101,58 @@
 #define IR_SEND_PIN     11
 #define TONE_PIN         3
 
+#  elif defined(__AVR_ATmega1284__) || defined(__AVR_ATmega1284P__) \
+|| defined(__AVR_ATmega644__) || defined(__AVR_ATmega644P__) \
+|| defined(__AVR_ATmega324P__) || defined(__AVR_ATmega324A__) \
+|| defined(__AVR_ATmega324PA__) || defined(__AVR_ATmega164A__) \
+|| defined(__AVR_ATmega164P__) || defined(__AVR_ATmega32__) \
+|| defined(__AVR_ATmega16__) || defined(__AVR_ATmega8535__) \
+|| defined(__AVR_ATmega64__) || defined(__AVR_ATmega128__) \
+|| defined(__AVR_ATmega1281__) || defined(__AVR_ATmega2561__) \
+|| defined(__AVR_ATmega8515__) || defined(__AVR_ATmega162__)
+#define IR_RECEIVE_PIN      2
+#define IR_SEND_PIN        13
+#define TONE_PIN            4
+#define APPLICATION_PIN     5
+#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output.
+#define IR_TIMING_TEST_PIN  7
+
 #elif defined(ARDUINO_ARCH_APOLLO3)
 #define IR_RECEIVE_PIN  11
 #define IR_SEND_PIN     12
 #define TONE_PIN         5
 
 #elif defined(ARDUINO_ARCH_MBED) // Arduino Nano 33 BLE
-#define IR_RECEIVE_PIN  3
-#define IR_SEND_PIN     4
-#define TONE_PIN        5
-#define IR_TIMING_TEST_PIN 6
+#define IR_RECEIVE_PIN      2
+#define IR_SEND_PIN         3
+#define TONE_PIN            4
+#define APPLICATION_PIN     5
+#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output.
+#define IR_TIMING_TEST_PIN  7
 
 #elif defined(TEENSYDUINO)
-#define IR_RECEIVE_PIN  3
-#define IR_SEND_PIN     4
-#define TONE_PIN        5
-#define IR_TIMING_TEST_PIN 6
+#define IR_RECEIVE_PIN      2
+#define IR_SEND_PIN         3
+#define TONE_PIN            4
+#define APPLICATION_PIN     5
+#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output.
+#define IR_TIMING_TEST_PIN  7
 
 #elif defined(__AVR__)
-#define IR_RECEIVE_PIN  2 // To be compatible with interrupt example, pin 2 is chosen here.
-#define IR_SEND_PIN     3
-#define TONE_PIN        4
-#define IR_TIMING_TEST_PIN 6
+#define IR_RECEIVE_PIN      2 // To be compatible with interrupt example, pin 2 is chosen here.
+#define IR_SEND_PIN         3
+#define TONE_PIN            4
+#define APPLICATION_PIN     5
+#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output.
+#define IR_TIMING_TEST_PIN  7
 
 #elif defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_SAM)
-#define IR_RECEIVE_PIN  2 // To be compatible with interrupt example, pin 2 is chosen here.
-#define IR_SEND_PIN     3
-#define TONE_PIN        4
-#define IR_TIMING_TEST_PIN 6
+#define IR_RECEIVE_PIN      2
+#define IR_SEND_PIN         3
+#define TONE_PIN            4
+#define APPLICATION_PIN     5
+#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output.
+#define IR_TIMING_TEST_PIN  7
 
 // On the Zero and others we switch explicitly to SerialUSB
 #define Serial SerialUSB
@@ -146,10 +170,12 @@
 #else
 #warning Board / CPU is not detected using pre-processor symbols -> using default values, which may not fit. Please extend PinDefinitionsAndMore.h.
 // Default valued for unidentified boards
-#define IR_RECEIVE_PIN  2
-#define IR_SEND_PIN     3
-#define TONE_PIN        4
-#define IR_TIMING_TEST_PIN 6
+#define IR_RECEIVE_PIN      2
+#define IR_SEND_PIN         3
+#define TONE_PIN            4
+#define APPLICATION_PIN     5
+#define ALTERNATIVE_IR_FEEDBACK_LED_PIN 6 // E.g. used for examples which use LED_BUILDIN for example output.
+#define IR_TIMING_TEST_PIN  7
 #endif // defined(ESP8266)
 
 /*

examples/IRDispatcherDemo/IRDispatcherDemo.ino

@@ -64,8 +64,8 @@
 
 #include "PinDefinitionsAndMore.h"
 #define IR_RECEIVER_PIN     IRMP_INPUT_PIN
-#if defined(ALTERNATIVE_IRMP_FEEDBACK_LED_PIN)
-#define FEEDBACK_LED_PIN    ALTERNATIVE_IRMP_FEEDBACK_LED_PIN
+#if defined(ALTERNATIVE_IR_FEEDBACK_LED_PIN)
+#define FEEDBACK_LED_PIN    ALTERNATIVE_IR_FEEDBACK_LED_PIN
 #endif
 
 //#define IRMP_ENABLE_PIN_CHANGE_INTERRUPT   // Enable interrupt functionality - requires around 376 additional bytes of program space
@@ -76,8 +76,8 @@
 
 #define IRMP_SUPPORT_NEC_PROTOCOL        1 // this enables only one protocol
 
-#  ifdef ALTERNATIVE_IRMP_FEEDBACK_LED_PIN
-#define IRMP_FEEDBACK_LED_PIN   ALTERNATIVE_IRMP_FEEDBACK_LED_PIN
+#  ifdef ALTERNATIVE_IR_FEEDBACK_LED_PIN
+#define IRMP_FEEDBACK_LED_PIN   ALTERNATIVE_IR_FEEDBACK_LED_PIN
 #  endif
 /*
  * After setting the definitions we can include the code and compile it.
@@ -149,9 +149,9 @@ void setup()
     Serial.println(F("at pin " STR(IRMP_INPUT_PIN)));
 #  endif
 
-#  ifdef ALTERNATIVE_IRMP_FEEDBACK_LED_PIN
-    irmp_irsnd_LEDFeedback(true); // Enable receive signal feedback at ALTERNATIVE_IRMP_FEEDBACK_LED_PIN
-    Serial.print(F("IR feedback pin is " STR(ALTERNATIVE_IRMP_FEEDBACK_LED_PIN)));
+#  ifdef ALTERNATIVE_IR_FEEDBACK_LED_PIN
+    irmp_irsnd_LEDFeedback(true); // Enable receive signal feedback at ALTERNATIVE_IR_FEEDBACK_LED_PIN
+    Serial.print(F("IR feedback pin is " STR(ALTERNATIVE_IR_FEEDBACK_LED_PIN)));
 #  endif
 #endif