From 5043d29ae0a6eea3678f493139f5edb2e43f3946 Mon Sep 17 00:00:00 2001
From: David Conran <crankyoldgit@users.noreply.github.com>
Date: Sat, 10 Oct 2020 09:52:56 +1000
Subject: [PATCH] IRrecvDumpV2+: Add tolerance setting. (#1292)

* Add easy setting of the receiving tolerance value.
* Report the tolerance value used if changed from the default.
---
 examples/IRrecvDumpV2/IRrecvDumpV2.ino | 16 ++++++++++++++++
 examples/IRrecvDumpV3/IRrecvDumpV3.ino | 16 ++++++++++++++++
 src/locale/defaults.h                  |  3 +++
 3 files changed, 35 insertions(+)

diff --git a/examples/IRrecvDumpV2/IRrecvDumpV2.ino b/examples/IRrecvDumpV2/IRrecvDumpV2.ino
index 940566bf0..ae7e21dab 100644
--- a/examples/IRrecvDumpV2/IRrecvDumpV2.ino
+++ b/examples/IRrecvDumpV2/IRrecvDumpV2.ino
@@ -9,6 +9,8 @@
  *  https://github.com/crankyoldgit/IRremoteESP8266/wiki#ir-receiving
  *
  * Changes:
+ *   Version 1.2 October, 2020
+ *     - Enable easy setting of the decoding tolerance value.
  *   Version 1.0 October, 2019
  *     - Internationalisation (i18n) support.
  *     - Stop displaying the legacy raw timing info.
@@ -99,6 +101,16 @@ const uint8_t kTimeout = 15;
 // NOTE: Set this value very high to effectively turn off UNKNOWN detection.
 const uint16_t kMinUnknownSize = 12;
 
+// How much percentage lee way do we give to incoming signals in order to match
+// it?
+// e.g. +/- 25% (default) to an expected value of 500 would mean matching a
+//      value between 375 & 625 inclusive.
+// Note: Default is 25(%). Going to a value >= 50(%) will cause some protocols
+//       to no longer match correctly. In normal situations you probably do not
+//       need to adjust this value. Typically that's when the library detects
+//       your remote's message some of the time, but not all of the time.
+const uint8_t kTolerancePercentage = kTolerance;  // kTolerance is normally 25%
+
 // Legacy (No longer supported!)
 //
 // Change to `true` if you miss/need the old "Raw Timing[]" display.
@@ -127,6 +139,7 @@ void setup() {
   // Ignore messages with less than minimum on or off pulses.
   irrecv.setUnknownThreshold(kMinUnknownSize);
 #endif  // DECODE_HASH
+  irrecv.setTolerance(kTolerancePercentage);  // Override the default tolerance.
   irrecv.enableIRIn();  // Start the receiver
 }
 
@@ -142,6 +155,9 @@ void loop() {
       Serial.printf(D_WARN_BUFFERFULL "\n", kCaptureBufferSize);
     // Display the library version the message was captured with.
     Serial.println(D_STR_LIBRARY "   : v" _IRREMOTEESP8266_VERSION_ "\n");
+    // Display the tolerance percentage if it has been change from the default.
+    if (kTolerancePercentage != kTolerance)
+      Serial.printf(D_STR_TOLERANCE " : %d%%\n", kTolerancePercentage);
     // Display the basic output of what we found.
     Serial.print(resultToHumanReadableBasic(&results));
     // Display any extra A/C info if we have it.
diff --git a/examples/IRrecvDumpV3/IRrecvDumpV3.ino b/examples/IRrecvDumpV3/IRrecvDumpV3.ino
index b8a670e7c..fc2037368 100644
--- a/examples/IRrecvDumpV3/IRrecvDumpV3.ino
+++ b/examples/IRrecvDumpV3/IRrecvDumpV3.ino
@@ -9,6 +9,8 @@
  *  https://github.com/crankyoldgit/IRremoteESP8266/wiki#ir-receiving
  *
  * Changes:
+ *   Version 1.2 October, 2020
+ *     - Enable easy setting of the decoding tolerance value.
  *   Version 1.1 May, 2020
  *     - Create DumpV3 from DumpV2
  *     - Add OTA Base
@@ -106,6 +108,16 @@ const uint8_t kTimeout = 15;
 // NOTE: Set this value very high to effectively turn off UNKNOWN detection.
 const uint16_t kMinUnknownSize = 12;
 
+// How much percentage lee way do we give to incoming signals in order to match
+// it?
+// e.g. +/- 25% (default) to an expected value of 500 would mean matching a
+//      value between 375 & 625 inclusive.
+// Note: Default is 25(%). Going to a value >= 50(%) will cause some protocols
+//       to no longer match correctly. In normal situations you probably do not
+//       need to adjust this value. Typically that's when the library detects
+//       your remote's message some of the time, but not all of the time.
+const uint8_t kTolerancePercentage = kTolerance;  // kTolerance is normally 25%
+
 // Legacy (No longer supported!)
 //
 // Change to `true` if you miss/need the old "Raw Timing[]" display.
@@ -136,6 +148,7 @@ void setup() {
   // Ignore messages with less than minimum on or off pulses.
   irrecv.setUnknownThreshold(kMinUnknownSize);
 #endif  // DECODE_HASH
+  irrecv.setTolerance(kTolerancePercentage);  // Override the default tolerance.
   irrecv.enableIRIn();  // Start the receiver
 }
 
@@ -151,6 +164,9 @@ void loop() {
       Serial.printf(D_WARN_BUFFERFULL "\n", kCaptureBufferSize);
     // Display the library version the message was captured with.
     Serial.println(D_STR_LIBRARY "   : v" _IRREMOTEESP8266_VERSION_ "\n");
+    // Display the tolerance percentage if it has been change from the default.
+    if (kTolerancePercentage != kTolerance)
+      Serial.printf(D_STR_TOLERANCE " : %d%%\n", kTolerancePercentage);
     // Display the basic output of what we found.
     Serial.print(resultToHumanReadableBasic(&results));
     // Display any extra A/C info if we have it.
diff --git a/src/locale/defaults.h b/src/locale/defaults.h
index 5e2b3336a..7473cf14d 100644
--- a/src/locale/defaults.h
+++ b/src/locale/defaults.h
@@ -771,6 +771,9 @@
 #ifndef D_STR_MESGDESC
 #define D_STR_MESGDESC "Mesg Desc."
 #endif  // D_STR_MESGDESC
+#ifndef D_STR_TOLERANCE
+#define D_STR_TOLERANCE "Tolerance"
+#endif  // D_STR_TOLERANCE
 #ifndef D_STR_IRRECVDUMP_STARTUP
 #define D_STR_IRRECVDUMP_STARTUP \
     "IRrecvDump is now running and waiting for IR input on Pin %d"