Replaced #define DECODE_NEC 1/0 by defining/not defining, USE_SOFT_SEND_PWM is active by default

Author: ArminJo

README.md

@@ -1,7 +1,7 @@
 # IRremote Arduino Library
 Available as Arduino library "IRremote"
 
-### [Version 3.0.2](https://github.com/z3t0/Arduino-IRremote/archive/master.zip) - work in progress
+### [Version 3.1.0](https://github.com/z3t0/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/z3t0/Arduino-IRremote/latest)](https://github.com/z3t0/Arduino-IRremote/commits/master)
@@ -18,20 +18,29 @@ Click on the LibraryManager badge above to see the [instructions](https://www.ar
 
 # Supported IR Protocols
 Denon, JVC, LG, NEC / Apple, Panasonic / Kaseikyo, RC5, RC6, Samsung, Sharp, Sony, (Pronto), BoseWave, Lego, Whynter, MagiQuest.<br/>
-Protocols can be switched off and on by changing the lines in *IRremote.h*:
+Protocols can be switched off and on by definining macros like [here]((https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/SimpleReceiver/SimpleReceiver.ino#L18):
 
 ```
-#define DECODE_<PROTOCOL_NAME> 1
-#define SEND_<PROTOCOL_NAME> 1
+#define DECODE_NEC
+//#define DECODE_DENON
+#incude <IRremote.h>
 ```
+or by activating the lines in [IRremote.h]((https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/src/IRremote.h#L54):
+
+```
+#define DECODE_<PROTOCO_NAME>
+#define SEND_<PROTOCO_NAME>
+```
+
+
 # [Wiki](https://github.com/z3t0/Arduino-IRremote/wiki)
 This is a quite old but maybe useful wiki for this library.
 
 # 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, ENABLE_LED_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().
+- ike 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().
 - 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).
@@ -84,15 +93,13 @@ Modify it by commenting them out or in, or change the values if applicable. Or d
 | `USE_OLD_DECODE` | IRremoteInt.h | disabled | Enables the old decoder in order to be version 2.x compatible, where all protocols were MSB first. |
 | `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. |
 | `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. |
+| `SEND_PWM_BY_TIMER` | Before `#include <IRremote.h>` | disabled | Disable carrier PWM generation in software and use (restricted) hardware PWM. |
 | `IR_INPUT_IS_ACTIVE_HIGH` | IRremoteInt.h | disabled | Enable it if you use a RF receiver, which has an active HIGH output signal. |
 | `DEBUG` | IRremoteInt.h | disabled | Enables lots of lovely debug output. |
-| `USE_NO_SEND_PWM` | IRremoteInt.h | disabled | Use no carrier PWM, just simulate an active low receiver signal. |
-| `USE_SOFT_SEND_PWM` | IRremoteInt.h | disabled | Use carrier PWM generation in software, instead of hardware PWM. |
-| `PULSE_CORRECTION_MICROS` | IRremoteInt.h | 3 | If USE_SOFT_SEND_PWM, this amount is subtracted from the on-time of the pulses. |
 | `RAW_BUFFER_LENGTH` | IRremoteint.h | 101 | Buffer size of raw input buffer. Must be odd! |
 | `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. |
-| `USE_CUSTOM_DELAY` | irSend.cpp | disabled | Use old custom_delay_usec() function for mark and space delays. |
 |-|-|-|-|
 | `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. |

changelog.md

@@ -1,3 +1,7 @@
+## 3.1.0
+- Replaced #define DECODE_NEC 1/0 by defining/not defining.
+- USE_SOFT_SEND_PWM is active by default.
+
 ## 3.0.2
 - Bug fix for USE_OLD_DECODE.
 - Increase RECORD_GAP_MICROS to 11000.

examples/BoseWaveSendDemo/BoseWaveSendDemo.ino

@@ -51,15 +51,15 @@ void setup() {
 
  Serial.begin(115200);
 #if defined(__AVR_ATmega32U4__) || defined(SERIAL_USB) || defined(SERIAL_PORT_USBVIRTUAL) || defined(ARDUINO_attiny3217)
- delay(2000); // To be able to connect Serial monitor after reset or power up and before first printout
+ delay(4000); // To be able to connect Serial monitor after reset or power up and before first printout
 #endif
  // Just to know which program is running on my Arduino
  Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE));
 
-#if defined(USE_SOFT_SEND_PWM) || defined(USE_NO_SEND_PWM)
- IrSender.begin(IR_SEND_PIN, true); // Specify send pin and enable feedback LED at default feedback LED pin
-#else
+#if defined(SEND_PWM_BY_TIMER) && !defined(USE_NO_SEND_PWM)
  IrSender.begin(true); // Enable feedback LED at default feedback LED pin
+#else
+ IrSender.begin(IR_SEND_PIN, true); // Specify send pin and enable feedback LED at default feedback LED pin
 #endif
 
  prompt = true;

examples/IR2Keyboard/IR2Keyboard.ino

@@ -53,7 +53,7 @@ void setup() {
 
  Serial.begin(115200);
 #if defined(__AVR_ATmega32U4__) || defined(SERIAL_USB) || defined(SERIAL_PORT_USBVIRTUAL) || defined(ARDUINO_attiny3217)
- delay(2000); // To be able to connect Serial monitor after reset or power up and before first printout
+ delay(4000); // To be able to connect Serial monitor after reset or power up and before first printout
 #endif
  // Just to know which program is running on my Arduino
  Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE));

examples/IRDispatcherDemo/IRDispatcherDemo.ino

@@ -115,7 +115,7 @@ void setup()
  pinMode(LED_BUILTIN, OUTPUT);
  Serial.begin(115200);
 #if defined(__AVR_ATmega32U4__) || defined(SERIAL_USB) || defined(SERIAL_PORT_USBVIRTUAL) || defined(ARDUINO_attiny3217)
- delay(2000); // To be able to connect Serial monitor after reset or power up and before first printout
+ delay(4000); // To be able to connect Serial monitor after reset or power up and before first printout
 #endif
 #if defined(ESP8266)
  Serial.println(); // to separate it from the internal boot output

examples/IRreceiveDump/IRreceiveDump.ino

@@ -37,7 +37,7 @@ void setup() {
 
  Serial.begin(115200); // Status message will be sent to PC at 9600 baud
 #if defined(__AVR_ATmega32U4__) || defined(SERIAL_USB) || defined(SERIAL_PORT_USBVIRTUAL) || defined(ARDUINO_attiny3217)
- delay(2000); // To be able to connect Serial monitor after reset or power up and before first printout
+ delay(4000); // To be able to connect Serial monitor after reset or power up and before first printout
 #endif
  // Just to know which program is running on my Arduino
  Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE));

examples/IRrelay/IRrelay.ino

@@ -23,15 +23,13 @@ int RELAY_PIN = 4; // is labeled D2 on the Chinese SAMD21 M0-Mini clone
 //#define LED_BUILTIN 25 // Or choose pin 25, it is the RX pin, but active low.
 #endif
 
-void dump();
-
 void setup() {
  pinMode(LED_BUILTIN, OUTPUT);
  pinMode(RELAY_PIN, OUTPUT);
 
  Serial.begin(115200);
 #if defined(__AVR_ATmega32U4__) || defined(SERIAL_USB) || defined(SERIAL_PORT_USBVIRTUAL) || defined(ARDUINO_attiny3217)
- delay(2000); // To be able to connect Serial monitor after reset or power up and before first printout
+ delay(4000); // To be able to connect Serial monitor after reset or power up and before first printout
 #endif
  // Just to know which program is running on my Arduino
  Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE));

examples/IRremoteInfo/IRremoteInfo.ino

@@ -25,12 +25,11 @@ void dumpArduinoIDE();
 void dumpDebugMode();
 void dumpProtocols();
 void dumpFooter();
-void printDecodeEnabled(int flag);
 
 void setup() {
  Serial.begin(115200);
 #if defined(__AVR_ATmega32U4__) || defined(SERIAL_USB) || defined(SERIAL_PORT_USBVIRTUAL) || defined(ARDUINO_attiny3217)
- delay(2000); // To be able to connect Serial monitor after reset or power up and before first printout
+ delay(4000); // To be able to connect Serial monitor after reset or power up and before first printout
 #endif
  // Just to know which program is running on my Arduino
  Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE));
@@ -223,42 +222,91 @@ void dumpProtocols() {
  Serial.print(F("======== "));
  Serial.println(F("========"));
  Serial.print(F("RC5: "));
- printDecodeEnabled(DECODE_RC6);
+#if defined(DECODE_RC5)
+ Serial.println(F("Enabled"));
+#else
+ Serial.println(F("Disabled"));
+#endif
 
  Serial.print(F("RC6: "));
- printDecodeEnabled(DECODE_RC5);
+#if defined(DECODE_RC6)
+ Serial.println(F("Enabled"));
+#else
+ Serial.println(F("Disabled"));
+#endif
 
  Serial.print(F("NEC: "));
- printDecodeEnabled(DECODE_NEC);
+#if defined(DECODE_NEC)
+ Serial.println(F("Enabled"));
+#else
+ Serial.println(F("Disabled"));
+#endif
 
  Serial.print(F("SONY: "));
- printDecodeEnabled(DECODE_SONY);
+#if defined(DECODE_SONY)
+ Serial.println(F("Enabled"));
+#else
+ Serial.println(F("Disabled"));
+#endif
 
  Serial.print(F("PANASONIC: "));
- printDecodeEnabled(DECODE_PANASONIC);
+#if defined(DECODE_PANASONIC)
+ Serial.println(F("Enabled"));
+#else
+ Serial.println(F("Disabled"));
+#endif
 
  Serial.print(F("JVC: "));
- printDecodeEnabled(DECODE_JVC);
+#if defined(DECODE_JVC)
+ Serial.println(F("Enabled"));
+#else
+ Serial.println(F("Disabled"));
+#endif
 
  Serial.print(F("SAMSUNG: "));
- printDecodeEnabled(DECODE_SAMSUNG);
+#if defined(DECODE_SAMSUNG)
+ Serial.println(F("Enabled"));
+#else
+ Serial.println(F("Disabled"));
+#endif
 
  Serial.print(F("LG: "));
- printDecodeEnabled(DECODE_LG);
+#if defined(DECODE_LG)
+ Serial.println(F("Enabled"));
+#else
+ Serial.println(F("Disabled"));
+#endif
 
  Serial.print(F("SHARP: "));
- printDecodeEnabled(DECODE_SHARP);
+#if defined(DECODE_SHARP)
+ Serial.println(F("Enabled"));
+#else
+ Serial.println(F("Disabled"));
+#endif
 
  Serial.print(F("DENON: "));
- printDecodeEnabled(DECODE_DENON);
+#if defined(DECODE_DENON)
+ Serial.println(F("Enabled"));
+#else
+ Serial.println(F("Disabled"));
+#endif
 
 #if !defined(EXCLUDE_EXOTIC_PROTOCOLS) // saves around 2000 bytes program space
 
  Serial.print(F("BOSEWAVE: "));
- printDecodeEnabled(DECODE_BOSEWAVE);
+#if defined(DECODE_BOSEWAVE)
+ Serial.println(F("Enabled"));
+#else
+ Serial.println(F("Disabled"));
+#endif
 
  Serial.print(F("WHYNTER: "));
- printDecodeEnabled(DECODE_WHYNTER);
+#if defined(DECODE_WHYNTER)
+ Serial.println(F("Enabled"));
+#else
+ Serial.println(F("Disabled"));
+#endif
+
 #endif
 }
 

examples/IRsendDemo/IRsendDemo.ino

@@ -13,7 +13,10 @@
  */
 
 //#define EXCLUDE_EXOTIC_PROTOCOLS // saves around 240 bytes program space if IrSender.write is used
+//#define SEND_PWM_BY_TIMER
+
 #include <IRremote.h>
+
 #if defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__) || defined(__AVR_ATtiny87__) || defined(__AVR_ATtiny167__)
 #include "ATtinySerialOut.h"
 #endif
@@ -35,10 +38,10 @@ void setup() {
  Serial.print(F("Ready to send IR signals at pin "));
  Serial.println(IR_SEND_PIN);
 
-#if defined(USE_SOFT_SEND_PWM) || defined(USE_NO_SEND_PWM)
- IrSender.begin(IR_SEND_PIN, true); // Specify send pin and enable feedback LED at default feedback LED pin
-#else
+#if defined(SEND_PWM_BY_TIMER) && !defined(USE_NO_SEND_PWM)
  IrSender.begin(true); // Enable feedback LED at default feedback LED pin
+#else
+ IrSender.begin(IR_SEND_PIN, true); // Specify send pin and enable feedback LED at default feedback LED pin
 #endif
 }
 

examples/IRsendProntoDemo/IRsendProntoDemo.ino

@@ -19,9 +19,16 @@ void setup() {
 
  // Just to know which program is running on my Arduino
  Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE));
-
- Serial.print(F("Will send IR signals at pin "));
+ Serial.print(F("Ready to send IR signals at pin "));
  Serial.println(IR_SEND_PIN);
+
+#if defined(SEND_PWM_BY_TIMER) && !defined(USE_NO_SEND_PWM)
+ IrSender.begin(true); // Enable feedback LED at default feedback LED pin
+#else
+ IrSender.begin(IR_SEND_PIN, true); // Specify send pin and enable feedback LED at default feedback LED pin
+#endif
+
+
 }
 
 void loop() {