Extended DEBUG output

Author: ArminJo

README.md

@@ -95,7 +95,7 @@ The new decoders for **NEC, Panasonic, Sony, Samsung and JVC** `IrReceiver.decod
  If you read the first binary sequence backwards (right to left), you get the second sequence.
 
 # FAQ
-- IR does not work right when I use Neopixels (aka WS2811/WS2812/WS2812B) or other libraries blocking interrupts for a longer time (> 50 us).<br/>
+- IR does not work right when I use **Neopixels** (aka WS2811/WS2812/WS2812B) or other libraries blocking interrupts for a longer time (> 50 us).<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. There are some solutions to this on some 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)
@@ -105,6 +105,7 @@ If you can live with the NEC protocol, you can try the MinimalReceiver example,
 - 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 us timer ISR takes around 12 us on a 16 MHz ATmega.
 
 # Minimal version
 For applications only requiring NEC protocol, there is a receiver which has very **small codesize of 500 bytes and does NOT require any timer**. See the MinimalReceiver and IRDispatcherDemo example how to use it. Mapping of pins to interrupts can be found [here](https://github.com/Arduino-IRremote/Arduino-IRremote/tree/master/src/TinyIRReceiver.cpp.h#L307).
@@ -115,7 +116,14 @@ This library was never designed to handle long codes like the ones used by air c
 See [Recording long Infrared Remote control signals with Arduino](https://www.analysir.com/blog/2014/03/19/air-conditioners-problems-recording-long-infrared-remote-control-signals-arduino).<br/>
 The main reason is, that it was designed to fit inside MCUs with relatively low levels of resources and was intended to work as a library together with other applications which also require some resources of the MCU to operate.
 
-## Hints
+## Protocol=UNKNOWN
+If you see something like `Protocol=UNKNOWN Hash=0x13BD886C 35 bits received` as output of e.g. the ReceiveDemo example, you either have a problem with decoding a protocol, or an unsupported protocol.
+
+- If you have an **odd number of bits** received, it is likely, that your receiver circuit has problems. Maybe because the IR signal is too weak.
+- If you see timings like `+ 600,- 600 + 550,- 150 + 200,- 100 + 750,- 550` then one 450 µs space was split into two 150 and 100 µs spaces with a spike / error signal of 200 µs between. Maybe because of a defective receiver or a weak signal in conjunction with another light emitting source nearby.
+- To see more info supporting you to find the reason for your UNKNOWN protocol, you must enable the line `//#define DEBUG` in IRremoteInt.h.
+
+## How to deal with protocols not supported by IRremote
 If you do not know which protocol your IR transmitter uses, you have several choices.
 - 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).
@@ -127,11 +135,12 @@ If you do not know which protocol your IR transmitter uses, you have several cho
 - Use [IrScrutinizer](http://www.harctoolbox.org/IrScrutinizer.html).
  It can automatically generate a send sketch for your protocol by exporting as "Arduino Raw". It supports IRremote,
  the old [IRLib](https://github.com/cyborg5/IRLib) and [Infrared4Arduino](https://github.com/bengtmartensson/Infrared4Arduino).
+ 
+# Hints
 - 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 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, since 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.
@@ -143,7 +152,7 @@ This examples are a good starting point.
 More complete examples for the advanced user.
 
 ### UnitTest
-ReceiveDemo + SendDemo in one program. Receiving while sending.
+ReceiveDemo + SendDemo in one program. **Receiving while sending**.
 
 ### ReceiveAndSend
 Record and play back last received IR signal at button press.

examples/ReceiveDemo/ReceiveDemo.ino

@@ -121,6 +121,7 @@ void loop() {
  * and up to 32 bit raw data in IrReceiver.decodedIRData.decodedRawData
  */
  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);
@@ -158,7 +159,6 @@ void loop() {
 # endif
 #endif // FLASHEND > 0x1FFF
 
- Serial.println();
  /*
  * !!!Important!!! Enable receiving of the next value,
  * since receiving has stopped after the end of the current received data packet.

examples/SendDemo/SendDemo.ino

@@ -59,7 +59,7 @@ void setup() {
 #if defined(ARDUINO_ARCH_STM32) || defined(ESP8266)
  Serial.println(IR_SEND_PIN_STRING);
 #else
- Serial.print(IR_SEND_PIN);
+ Serial.println(IR_SEND_PIN);
 #endif
 
 #if !defined(SEND_PWM_BY_TIMER) && !defined(USE_NO_SEND_PWM) && !defined(ESP32) // for esp32 we use PWM generation by ledcWrite() for each pin

examples/UnitTest/UnitTest.ino

@@ -110,7 +110,7 @@ void setup() {
 #if defined(ARDUINO_ARCH_STM32) || defined(ESP8266)
  Serial.println(IR_SEND_PIN_STRING);
 #else
- Serial.print(IR_SEND_PIN);
+ 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

src/ir_Denon.cpp

@@ -135,6 +135,10 @@ bool IRrecv::decodeDenon() {
  // we have no start bit, so check for the exact amount of data bits
  // Check we have the right amount of data (32). The + 2 is for initial gap + stop bit mark
  if (decodedIRData.rawDataPtr->rawlen != (2 * DENON_BITS) + 2) {
+ DBG_PRINT(F("Denon: "));
+ DBG_PRINT("Data length=");
+ DBG_PRINT(decodedIRData.rawDataPtr->rawlen);
+ DBG_PRINTLN(" is not 32");
  return false;
  }
 

src/ir_JVC.cpp

@@ -100,9 +100,12 @@ void IRsend::sendJVC(uint8_t aAddress, uint8_t aCommand, uint_fast8_t aNumberOfR
  */
 bool IRrecv::decodeJVC() {
 
- // Check we have the right amount of data (36 or 34). The +4 is for initial gap, start bit mark and space + stop bit mark.
+ // Check we have the right amount of data (36 or 34). The +4 is for initial gap, start bit mark and space + stop bit mark. +2 is for repeats
  if (decodedIRData.rawDataPtr->rawlen != ((2 * JVC_BITS) + 4) && decodedIRData.rawDataPtr->rawlen != ((2 * JVC_BITS) + 2)) {
- // no debug output, since this check is mainly to determine the received protocol
+ DBG_PRINT(F("JVC: "));
+ DBG_PRINT("Data length=");
+ DBG_PRINT(decodedIRData.rawDataPtr->rawlen);
+ DBG_PRINTLN(" is not 34 or 36");
  return false;
  }
 
@@ -127,8 +130,8 @@ bool IRrecv::decodeJVC() {
  // Check header "mark" and "space"
  if (!matchMark(decodedIRData.rawDataPtr->rawbuf[1], JVC_HEADER_MARK)
  || !matchSpace(decodedIRData.rawDataPtr->rawbuf[2], JVC_HEADER_SPACE)) {
-// DBG_PRINT("JVC: ");
-// DBG_PRINTLN("Header mark or space length is wrong");
+ DBG_PRINT("JVC: ");
+ DBG_PRINTLN("Header mark or space length is wrong");
  return false;
  }
 

src/ir_Kaseikyo.cpp

@@ -138,6 +138,10 @@ bool IRrecv::decodeKaseikyo() {
  decode_type_t tProtocol;
  // Check we have enough data (100)- +4 for initial gap, start bit mark and space + stop bit mark
  if (decodedIRData.rawDataPtr->rawlen != ((2 * KASEIKYO_BITS) + 4)) {
+ DBG_PRINT(F("Kaseikyo: "));
+ DBG_PRINT("Data length=");
+ DBG_PRINT(decodedIRData.rawDataPtr->rawlen);
+ DBG_PRINTLN(" is not 100");
  return false;
  }
 

src/ir_LG.cpp

@@ -146,7 +146,10 @@ bool IRrecv::decodeLG() {
 
  // Check we have the right amount of data (60). The +4 is for initial gap, start bit mark and space + stop bit mark.
  if (decodedIRData.rawDataPtr->rawlen != ((2 * LG_BITS) + 4) && (decodedIRData.rawDataPtr->rawlen != 4)) {
- // no debug output, since this check is mainly to determine the received protocol
+ DBG_PRINT(F("LG: "));
+ DBG_PRINT("Data length=");
+ DBG_PRINT(decodedIRData.rawDataPtr->rawlen);
+ DBG_PRINTLN(" is not 60 or 4");
  return false;
  }
 

src/ir_NEC.cpp

@@ -190,7 +190,10 @@ bool IRrecv::decodeNEC() {
 
  // Check we have the right amount of data (68). The +4 is for initial gap, start bit mark and space + stop bit mark.
  if (decodedIRData.rawDataPtr->rawlen != ((2 * NEC_BITS) + 4) && (decodedIRData.rawDataPtr->rawlen != 4)) {
- // no debug output, since this check is mainly to determine the received protocol
+ DBG_PRINT(F("NEC: "));
+ DBG_PRINT("Data length=");
+ DBG_PRINT(decodedIRData.rawDataPtr->rawlen);
+ DBG_PRINTLN(" is not 68 or 4");
  return false;
  }
 

src/ir_RC5_RC6.cpp

@@ -136,17 +136,17 @@ bool IRrecv::decodeRC5() {
  // Check we have the right amount of data (11 to 26). The +2 is for initial gap and start bit mark.
  if (decodedIRData.rawDataPtr->rawlen < MIN_RC5_MARKS + 2 && decodedIRData.rawDataPtr->rawlen > ((2 * RC5_BITS) + 2)) {
  // no debug output, since this check is mainly to determine the received protocol
- TRACE_PRINT(F("RC5: "));
- TRACE_PRINT("Data length=");
- TRACE_PRINT(decodedIRData.rawDataPtr->rawlen);
- TRACE_PRINTLN(" is not between 11 and 26");
+ DBG_PRINT(F("RC5: "));
+ DBG_PRINT("Data length=");
+ DBG_PRINT(decodedIRData.rawDataPtr->rawlen);
+ DBG_PRINTLN(" is not between 11 and 26");
  return false;
  }
 
 // Check start bit, the first space is included in the gap
  if (getBiphaselevel() != MARK) {
- TRACE_PRINT(F("RC5: "));
- TRACE_PRINTLN("first getBiphaselevel() is not MARK");
+ DBG_PRINT(F("RC5: "));
+ DBG_PRINTLN("first getBiphaselevel() is not MARK");
  return false;
  }
 
@@ -165,8 +165,8 @@ bool IRrecv::decodeRC5() {
  tDecodedRawData = (tDecodedRawData << 1) | 0;
  } else {
  // TRACE_PRINT since I saw this too often
- TRACE_PRINT(F("RC5: "));
- TRACE_PRINTLN(F("Decode failed"));
+ DBG_PRINT(F("RC5: "));
+ DBG_PRINTLN(F("Decode failed"));
  return false;
  }
  }
@@ -349,16 +349,19 @@ bool IRrecv::decodeRC6() {
 
  // Check we have the right amount of data (). The +3 for initial gap, start bit mark and space
  if (decodedIRData.rawDataPtr->rawlen < MIN_RC6_MARKS + 3 && decodedIRData.rawDataPtr->rawlen > ((2 * RC6_BITS) + 3)) {
- // no debug output, since this check is mainly to determine the received protocol
+ DBG_PRINT(F("RC6: "));
+ DBG_PRINT("Data length=");
+ DBG_PRINT(decodedIRData.rawDataPtr->rawlen);
+ DBG_PRINTLN(" is not between 15 and 45");
  return false;
  }
 
  // Check header "mark" and "space", this must be done for repeat and data
  if (!matchMark(decodedIRData.rawDataPtr->rawbuf[1], RC6_HEADER_MARK)
  || !matchSpace(decodedIRData.rawDataPtr->rawbuf[2], RC6_HEADER_SPACE)) {
  // no debug output, since this check is mainly to determine the received protocol
- TRACE_PRINT(F("RC6: "));
- TRACE_PRINTLN("Header mark or space length is wrong");
+ DBG_PRINT(F("RC6: "));
+ DBG_PRINTLN("Header mark or space length is wrong");
  return false;
  }
 
@@ -367,13 +370,13 @@ bool IRrecv::decodeRC6() {
 
 // Process first bit, which is known to be a 1 (mark->space)
  if (getBiphaselevel() != MARK) {
- TRACE_PRINT(F("RC6: "));
- TRACE_PRINTLN("first getBiphaselevel() is not MARK");
+ DBG_PRINT(F("RC6: "));
+ DBG_PRINTLN("first getBiphaselevel() is not MARK");
  return false;
  }
  if (getBiphaselevel() != SPACE) {
- TRACE_PRINT(F("RC6: "));
- TRACE_PRINTLN("second getBiphaselevel() is not SPACE");
+ DBG_PRINT(F("RC6: "));
+ DBG_PRINTLN("second getBiphaselevel() is not SPACE");
  return false;
  }