Documentation

Author: ArminJo

README.md

@@ -27,6 +27,11 @@ Available as [Arduino library "IRremote"](https://www.arduinolibraries.info/libr
 - [Sending IR codes](https://github.com/Arduino-IRremote/Arduino-IRremote#sending-ir-codes)
     + [List of public IR code databases](https://github.com/Arduino-IRremote/Arduino-IRremote#list-of-public-ir-code-databases)
 - [FAQ and hints](https://github.com/Arduino-IRremote/Arduino-IRremote#faq-and-hints)
+  * [Problems with Neopixels, FastLed etc.](https://github.com/Arduino-IRremote/Arduino-IRremote#problems-with-neopixels-fastled-etc)
+  * [Does not work/compile with another library](https://github.com/Arduino-IRremote/Arduino-IRremote#does-not-workcompile-with-another-library)
+  * [Multiple IR receiver](https://github.com/Arduino-IRremote/Arduino-IRremote#multiple-ir-receiver)
+  * [Increase strength of sent output signal](https://github.com/Arduino-IRremote/Arduino-IRremote#increase-strength-of-sent-output-signal)
+  * [Minimal CPU frequency](https://github.com/Arduino-IRremote/Arduino-IRremote#minimal-cpu-frequency)
 - [Handling unknown Protocols](https://github.com/Arduino-IRremote/Arduino-IRremote#handling-unknown-protocols)
   * [Disclaimer](https://github.com/Arduino-IRremote/Arduino-IRremote#disclaimer)
   * [Protocol=PULSE_DISTANCE](https://github.com/Arduino-IRremote/Arduino-IRremote#protocolpulse_distance)
@@ -226,22 +231,31 @@ You will discover that **the address is a constant** and the commands sometimes
 http://www.harctoolbox.org/IR-resources.html
 
 # FAQ and hints
-- IR does not work right when I use **Neopixels** (aka WS2811/WS2812/WS2812B) or other libraries blocking interrupts for a longer time (> 50 µs).<br/>
- Whether you use the Adafruit Neopixel lib, or FastLED, interrupts get disabled on many lower end CPUs like the basic Arduinos for longer than 50 µs.
+
+## Problems with Neopixels, FastLed etc.
+IR will not work right when you use **Neopixels** (aka WS2811/WS2812/WS2812B) or other libraries blocking interrupts for a longer time (> 50 µs).<br/>
+Whether you use the Adafruit Neopixel lib, or FastLED, interrupts get disabled on many lower end CPUs like the basic Arduinos for longer than 50 µs.
 In turn, this stops the IR interrupt handler from running when it needs to.<br/>
 You can try to wait for the IR receiver to be idle before you send the Neopixel data with `if (IrReceiver.isIdle()) { strip.show();}`. This prevents at least breaking a running IR transmission and -depending of the update rate of the Neopixel- may work quite well.<br/>
 There are some other solutions to this on more powerful processors,
- [see this page from Marc MERLIN](http://marc.merlins.org/perso/arduino/post_2017-04-03_Arduino-328P-Uno-Teensy3_1-ESP8266-ESP32-IR-and-Neopixels.html)
-- **Another library** is only working if I deactivate the line `IrReceiver.begin(IR_RECEIVE_PIN, ENABLE_LED_FEEDBACK);`. Please see [below](https://github.com/Arduino-IRremote/Arduino-IRremote#timer-and-pin-usage).
-- You can use **multiple IR receiver** by just connecting the output pins of several IR receivers together.
- The IR receivers use an NPN transistor as output device with just a 30k resistor to VCC.
- This is almost "open collector" and allows connecting of several output pins to one Arduino input pin.
-- The **minimal CPU frequency** for receiving is 4 MHz, since the 50 µs timer ISR takes around 12 µs on a 16 MHz ATmega.
-- To **increase strength of sent output signal** you can increase the current through the send diode, and/or use 2 diodes in series,
+[see this page from Marc MERLIN](http://marc.merlins.org/perso/arduino/post_2017-04-03_Arduino-328P-Uno-Teensy3_1-ESP8266-ESP32-IR-and-Neopixels.html)
+
+## Does not work/compile with another library
+**Another library** is only working if you deactivate the line `IrReceiver.begin(IR_RECEIVE_PIN, ENABLE_LED_FEEDBACK);`. 
+This is often due to resource conflicts with the other library. Please see [below](https://github.com/Arduino-IRremote/Arduino-IRremote#timer-and-pin-usage).
+
+## Multiple IR receiver
+You can use **multiple IR receiver** by just connecting the output pins of several IR receivers together.
+The IR receivers use an NPN transistor as output device with just a 30k resistor to VCC.
+This is almost "open collector" and allows connecting of several output pins to one Arduino input pin.
+
+## Increase strength of sent output signal
+To **increase strength of sent output signal** you can increase the current through the send diode, and/or use 2 diodes in series,
  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 memory and 38 bytes RAM for **Digispark boards** as well as enables serial output at 8MHz.
- - The default software generated PWM has **problems on AVR 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, the **minimal CPU frequency is 4 MHz**, since the 50 µs timer ISR takes around 12 µs on a 16 MHz ATmega.<br/>
+For sending, the **default software generated PWM has problems on AVR 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`.
 
 # Handling unknown Protocols
 ## Disclaimer
@@ -290,7 +304,7 @@ In order to fit the examples to the 8K flash of ATtiny85 and ATtiny88, the [Ardu
 This examples are a good starting point.
 
 ### ReceiveDemo
-Receives all protocols and play a beep on each packet received. By connecting pin 5 to ground, you can see the raw values for each packet.
+Receives all protocols and **generates a beep with the Arduino tone() function** on each packet received. By connecting pin 5 to ground, you can see the raw values for each packet. **Example how to use IRremote and tone() together**.
 
 ### ReceiveDump
 Receives all protocols and dumps the received signal in different flavors. Since the printing takes so much time, repeat signals may be skipped or interpreted as UNKNOWN.

examples/ControlRelay/PinDefinitionsAndMore.h

@@ -236,7 +236,7 @@ void noTone(uint8_t _pin){
 #define Serial SerialUSB
 
 // Definitions for the Chinese SAMD21 M0-Mini clone, which has no led connected to D13/PA17.
-// Attention!!! D2 and D4 are switched on these boards!!!
+// Attention!!! D2 and D4 are swapped on these boards!!!
 // If you connect the LED, it is on pin 24/PB11. In this case activate the next two lines.
 //#undef LED_BUILTIN
 //#define LED_BUILTIN 24 // PB11

examples/IRDispatcherDemo/IRCommandDispatcher.h

@@ -56,7 +56,7 @@ struct IRDataForCommandDispatcherStruct {
     uint16_t address;           // to distinguish between multiple senders
     uint16_t command;
     bool isRepeat;
-    uint32_t MillisOfLastCode;  // millis() of last IR command received - for timeouts etc.
+    uint32_t MillisOfLastCode;  // millis() of last IR command -including repeats!- received - for timeouts etc.
     volatile bool isAvailable;  // flag for a polling interpreting function, that a new command has arrived.
 };
 
@@ -75,7 +75,7 @@ class IRCommandDispatcher {
     void init();
 
     bool checkAndRunNonBlockingCommands();
-    void checkAndRunSuspendedBlockingCommands();
+    bool checkAndRunSuspendedBlockingCommands();
     bool delayAndCheckForStop(uint16_t aDelayMillis);
 
     // The main dispatcher function
@@ -90,6 +90,7 @@ class IRCommandDispatcher {
     uint8_t BlockingCommandToRunNext = COMMAND_INVALID; // Storage for command currently suspended to allow the current command to end, before it is called by main loop
     /*
      * Flag for running blocking commands to terminate. To check, you can use "if (requestToStopReceived) return;" (available as macro RETURN_IF_STOP).
+     * Is reset by next IR command received. Can be reset by main loop, if command has stopped.
      */
     volatile bool requestToStopReceived;
     /*

examples/IRDispatcherDemo/IRCommandDispatcher.hpp

@@ -38,11 +38,21 @@
 
 #include "IRCommandDispatcher.h"
 
-//#define INFO // activate this out to see serial info output
-//#define DEBUG // activate this out to see serial info output
-#if defined(DEBUG) && !defined(INFO)
-// Propagate level
-#define INFO
+/*
+ * Enable this to see information on each call.
+ * Since there should be no library which uses Serial, it should only be enabled for development purposes.
+ */
+#if defined(INFO)
+#define LOCAL_INFO
+#else
+//#define LOCAL_INFO // This enables info output only for this file
+#endif
+#if defined(DEBUG)
+#define LOCAL_DEBUG
+// Propagate debug level
+#define LOCAL_INFO
+#else
+//#define LOCAL_DEBUG // This enables debug output only for this file
 #endif
 
 IRCommandDispatcher IRDispatcher;
@@ -277,10 +287,11 @@ bool IRCommandDispatcher::delayAndCheckForStop(uint16_t aDelayMillis) {
 
 /*
  * Intended to be called from main loop
+ * @return true, if command was called
  */
-void IRCommandDispatcher::checkAndRunSuspendedBlockingCommands() {
+bool IRCommandDispatcher::checkAndRunSuspendedBlockingCommands() {
     /*
-     * search IR code or take last rejected command and call associated function
+     * Take last rejected command and call associated function
      */
     if (BlockingCommandToRunNext != COMMAND_INVALID) {
 
@@ -291,7 +302,9 @@ void IRCommandDispatcher::checkAndRunSuspendedBlockingCommands() {
         BlockingCommandToRunNext = COMMAND_INVALID;
         IRReceivedData.isRepeat = false;
         checkAndCallCommand(true);
+        return true;
     }
+    return false;
 }
 
 void IRCommandDispatcher::printIRCommandString(Print *aSerial) {
@@ -309,5 +322,10 @@ void IRCommandDispatcher::setRequestToStopReceived() {
     requestToStopReceived = true;
 }
 
+#if defined(LOCAL_DEBUG)
+#undef LOCAL_DEBUG
+#endif
+#if defined(LOCAL_INFO)
+#undef LOCAL_INFO
+#endif
 #endif // _IR_COMMAND_DISPATCHER_HPP
-#pragma once

examples/IRDispatcherDemo/IRCommandMapping.h

@@ -192,4 +192,3 @@ const struct IRToCommandMappingStruct IRMapping[] =
 { COMMAND_DECREASE_BLINK, IR_COMMAND_FLAG_REPEATABLE_NON_BLOCKING, &doDecreaseBlinkFrequency, decreaseBlink } };
 
 #endif / _IR_COMMAND_MAPPING_H
-#pragma once

examples/IRDispatcherDemo/PinDefinitionsAndMore.h

@@ -236,7 +236,7 @@ void noTone(uint8_t _pin){
 #define Serial SerialUSB
 
 // Definitions for the Chinese SAMD21 M0-Mini clone, which has no led connected to D13/PA17.
-// Attention!!! D2 and D4 are switched on these boards!!!
+// Attention!!! D2 and D4 are swapped on these boards!!!
 // If you connect the LED, it is on pin 24/PB11. In this case activate the next two lines.
 //#undef LED_BUILTIN
 //#define LED_BUILTIN 24 // PB11

examples/IRremoteExtensionTest/PinDefinitionsAndMore.h

@@ -236,7 +236,7 @@ void noTone(uint8_t _pin){
 #define Serial SerialUSB
 
 // Definitions for the Chinese SAMD21 M0-Mini clone, which has no led connected to D13/PA17.
-// Attention!!! D2 and D4 are switched on these boards!!!
+// Attention!!! D2 and D4 are swapped on these boards!!!
 // If you connect the LED, it is on pin 24/PB11. In this case activate the next two lines.
 //#undef LED_BUILTIN
 //#define LED_BUILTIN 24 // PB11

examples/MicroGirs/PinDefinitionsAndMore.h

@@ -236,7 +236,7 @@ void noTone(uint8_t _pin){
 #define Serial SerialUSB
 
 // Definitions for the Chinese SAMD21 M0-Mini clone, which has no led connected to D13/PA17.
-// Attention!!! D2 and D4 are switched on these boards!!!
+// Attention!!! D2 and D4 are swapped on these boards!!!
 // If you connect the LED, it is on pin 24/PB11. In this case activate the next two lines.
 //#undef LED_BUILTIN
 //#define LED_BUILTIN 24 // PB11

examples/ReceiveAndSend/PinDefinitionsAndMore.h

@@ -236,7 +236,7 @@ void noTone(uint8_t _pin){
 #define Serial SerialUSB
 
 // Definitions for the Chinese SAMD21 M0-Mini clone, which has no led connected to D13/PA17.
-// Attention!!! D2 and D4 are switched on these boards!!!
+// Attention!!! D2 and D4 are swapped on these boards!!!
 // If you connect the LED, it is on pin 24/PB11. In this case activate the next two lines.
 //#undef LED_BUILTIN
 //#define LED_BUILTIN 24 // PB11

examples/ReceiveDemo/PinDefinitionsAndMore.h

@@ -236,7 +236,7 @@ void noTone(uint8_t _pin){
 #define Serial SerialUSB
 
 // Definitions for the Chinese SAMD21 M0-Mini clone, which has no led connected to D13/PA17.
-// Attention!!! D2 and D4 are switched on these boards!!!
+// Attention!!! D2 and D4 are swapped on these boards!!!
 // If you connect the LED, it is on pin 24/PB11. In this case activate the next two lines.
 //#undef LED_BUILTIN
 //#define LED_BUILTIN 24 // PB11