Switch Analog On_Change to adjust hysterisis as it scales up

Author: tyeth

src/components/analogIO/Wippersnapper_AnalogIO.cpp

@@ -87,7 +87,8 @@ void Wippersnapper_AnalogIO::setADCResolution(int resolution) {
   analogReadResolution(16);
   _nativeResolution = 12;
 #elif defined(ARDUINO_ARCH_ESP32)
-  scaleAnalogRead = false; // probably should be false, handled in bsp
+  scaleAnalogRead = false; // should be false, handled in bsp (analogReadResolution)
+  analogReadResolution(resolution); // 16 bit values (shifted from 12 or 13bit)
 #if defined(ESP32S3)
   _nativeResolution = 13; // S3 ADC is 13-bit, others are 12-bit
 #else
@@ -317,13 +318,17 @@ bool Wippersnapper_AnalogIO::encodePinEvent(
            The current software timer value.
     @param pin
            The desired analog pin to check
+    @param periodOffset
+           Offset to add to the pin's period (used for on_change).
     @returns True if pin's period expired, False otherwise.
 */
 /**********************************************************/
 bool Wippersnapper_AnalogIO::timerExpired(long currentTime,
-                                          analogInputPin pin) {
-  if (currentTime - pin.prvPeriod > pin.period && pin.period != 0L)
-    return true;
+                                          analogInputPin pin, long periodOffset) {
+  if (pin.period + periodOffset != 0L &&
+    currentTime - pin.prvPeriod > (pin.period + periodOffset)) {
+      return true;
+    }
   return false;
 }
 
@@ -342,9 +347,8 @@ void Wippersnapper_AnalogIO::update() {
     if (_analog_input_pins[i].enabled == true) {
 
       // Does the pin execute on-period?
-      if ((long)millis() - _analog_input_pins[i].prvPeriod >
-              _analog_input_pins[i].period &&
-          _analog_input_pins[i].period != 0L) {
+      if (_analog_input_pins[i].period != 0L &&
+        timerExpired(millis(), _analog_input_pins[i])) {
         WS_DEBUG_PRINT("Executing periodic event on A");
         WS_DEBUG_PRINTLN(_analog_input_pins[i].pinName);
 
@@ -366,22 +370,57 @@ void Wippersnapper_AnalogIO::update() {
         encodePinEvent(_analog_input_pins[i].pinName,
                        _analog_input_pins[i].readMode, pinValRaw, pinValVolts);
 
-        // IMPT - reset the digital pin
+        // mark last execution time
         _analog_input_pins[i].prvPeriod = millis();
       }
       // Does the pin execute on_change?
       else if (_analog_input_pins[i].period == 0L) {
 
+        // TODO: after testing combine these two conditionals to just send the event and not debug print.
+        if (_analog_input_pins[i].prvPeriod == 0L) {
+          // first time reading pin, no previous timestamp so send event + update prvPeriod
+          WS_DEBUG_PRINT("First time reading pin A");
+          WS_DEBUG_PRINTLN(_analog_input_pins[i].pinName);
+        }
+        else if (timerExpired(millis(), _analog_input_pins[i], 500)) {
+          // timer expired, send event + update prvPeriod
+          WS_DEBUG_PRINT("Timer passed for pin A");
+          WS_DEBUG_PRINTLN(_analog_input_pins[i].pinName);
+        }
+        else {
+          // last event was too recently, skip this one...
+          WS_DEBUG_PRINTLN("Timer has not expired, continue...");
+          continue;
+        }
+
         // note: on-change requires ADC DEFAULT_HYSTERISIS to check against prv
         // pin value
         uint16_t pinValRaw = getPinValue(_analog_input_pins[i].pinName);
 
+        // All boards ADC values scaled to 16bit, in future we may need to adjust dynamically
+        uint16_t maxDecimalValue = 65535;
+
+        // Calculate threshold values - using DEFAULT_HYSTERISIS for first third (1/3) of the range,
+        // then 2x DEFAULT_HYSTERISIS for the middle 1/3, and 4x DEFAULT_HYSTERISIS for the last 1/3.
+        // This should allow a more wifi blip tolerant threshold for the both ends of the range.
+        float CURRENT_HYSTERISIS;
+        if (pinValRaw < maxDecimalValue / 3) {
+          CURRENT_HYSTERISIS = DEFAULT_HYSTERISIS;
+        } else if (pinValRaw < (maxDecimalValue / 3) * 2) {
+          CURRENT_HYSTERISIS = DEFAULT_HYSTERISIS * 2;
+        } else {
+          CURRENT_HYSTERISIS = DEFAULT_HYSTERISIS * 4;
+        }
+
+
+
+        // get the threshold values for previous pin value
         uint16_t _pinValThreshHi =
             _analog_input_pins[i].prvPinVal +
-            (_analog_input_pins[i].prvPinVal * DEFAULT_HYSTERISIS);
+            (_analog_input_pins[i].prvPinVal * CURRENT_HYSTERISIS);
         uint16_t _pinValThreshLow =
             _analog_input_pins[i].prvPinVal -
-            (_analog_input_pins[i].prvPinVal * DEFAULT_HYSTERISIS);
+            (_analog_input_pins[i].prvPinVal * CURRENT_HYSTERISIS);
 
         if (pinValRaw > _pinValThreshHi || pinValRaw < _pinValThreshLow) {
           // Perform voltage conversion if we need to
@@ -395,8 +434,11 @@ void Wippersnapper_AnalogIO::update() {
                          _analog_input_pins[i].readMode, pinValRaw,
                          pinValVolts);
 
+          // mark last execution time
+          _analog_input_pins[i].prvPeriod = millis();
+
         } else {
-          // WS_DEBUG_PRINTLN("ADC has not changed enough, continue...");
+          WS_DEBUG_PRINTLN("ADC has not changed enough, continue...");
           continue;
         }
         // set the pin value in the digital pin object for comparison on next

src/components/analogIO/Wippersnapper_AnalogIO.h

@@ -63,7 +63,7 @@ class Wippersnapper_AnalogIO {
   void setADCResolution(int resolution);
   int getADCresolution();
   int getNativeResolution();
-  bool timerExpired(long currentTime, analogInputPin pin);
+  bool timerExpired(long currentTime, analogInputPin pin, long periodOffset = 0);
 
   void update();
   bool encodePinEvent(