add sleep mode code

mini-beieli-node.ino

@@ -25,7 +25,7 @@
 #include <cmath>
 #include <type_traits>
 
-#include <HX711.h>
+#include <Q2HX711.h>
 #include "mini_beieli_node.h"
 
 using namespace McciCatena;
@@ -99,6 +99,7 @@ long package_counter = 0; // sent package counter
 bool send_in_progress = false;
 bool stop_iterations = false;
 bool next_package_is_init_package = true;
+uint32_t gRebootMs;
 
 // generic timer
 long t_cur;
@@ -131,7 +132,7 @@ Catena_Mx25v8035f gFlash;
 bool fFlash;
 
 // Scales
-HX711 LoadCell;
+Q2HX711 hx711(A1, A0);
 
 //  USB power
 bool fUsbPower;
@@ -143,6 +144,11 @@ bool g_fPrintedSleeping = false;
 static osjob_t iterationJob;
 static osjob_t sendJob;
 
+// the cycle time to use
+unsigned gTxCycle;
+// remaining before we reset to default
+unsigned gTxCycleCount;
+
 void setup(void)
 {
   gCatena.begin();
@@ -301,18 +307,8 @@ bool setup_scales(void)
   // Enable Power
   digitalWrite(D10, HIGH);
 
-  // Initialize library with data output pin, clock input pin and gain factor.
+  // we wait 400ms (settling time according HX711 datasheet @ 10 SPS
-  // Channel selection is made by passing the appropriate gain:
+  delay(400);
-  // - With a gain factor of 64 or 128, channel A is selected
-  // - With a gain factor of 32, channel B is selected
-  // By omitting the gain factor parameter, the library
-  // default "128" (Channel A) is used here.
-  LoadCell.begin(A1, A0, 32);
-
-  if (!(LoadCell.wait_ready_timeout(2000))) {
-    gCatena.SafePrintf("%010d - Scale not ready after Init.\n");
-    res = false;
-  }
 
   if (config_data.debug_level > 0) {
     gCatena.SafePrintf("%010d - setup_scale done\n", millis());
@@ -350,12 +346,11 @@ void setup_uplink(void)
     gCatena.SafePrintf("%010d - setup_uplink\n", millis());
   }
 
-#if defined(_mcci_arduino_version) && _mcci_arduino_version >= _mcci_arduino_version_calc(2,4,0,90) && \
+  LMIC_setClockError(1 * 65536 / 100);
-    defined(CATENA_ARDUINO_PLATFORM_VERSION_CALC) && CATENA_ARDUINO_PLATFORM_VERSION >= CATENA_ARDUINO_PLATFORM_VERSION_CALC(0,17,0,10)
+
-  LMIC_setClockError(5 * 65536 / 100);
+  /* figure out when to reboot */
-#else
+  gRebootMs = (CATCFG_T_REBOOT + os_getRndU2() - 32768) * 1000;
-  LMIC_setClockError(10 * 65536 / 100);
+
-#endif
 
   // Do an unjoin, so every reboot will trigger a join
   if (config_data.debug_level > 0) {
@@ -536,37 +531,65 @@ void DoDeepSleep(uint32_t sleep_time)
   }
 }
 
+//Following functions are based on "https://github.com/dndubins/QuickStats", by David Dubins
+
+long median(long samples[], int m) //calculate the median
+{
+  //First bubble sort the values: https://en.wikipedia.org/wiki/Bubble_sort
+  long sorted[m];   // Define and initialize sorted array.
+  long temp = 0;    // Temporary float for swapping elements
+
+  for (int i = 0; i < m; i++) {
+    sorted[i] = samples[i];
+  }
+  bubbleSort(sorted, m); // Sort the values
+
+  if (bitRead(m, 0) == 1) { //If the last bit of a number is 1, it's odd. This is equivalent to "TRUE". Also use if m%2!=0.
+    return sorted[m / 2]; //If the number of data points is odd, return middle number.
+  } else {
+    return (sorted[(m / 2) - 1] + sorted[m / 2]) / 2; //If the number of data points is even, return avg of the middle two numbers.
+  }
+}
+
+void bubbleSort(long A[], int len) {
+  unsigned long newn;
+  unsigned long n = len;
+  long temp = 0;
+  do {
+    newn = 1;
+    for (int p = 1; p < len; p++) {
+      if (A[p - 1] > A[p]) {
+        temp = A[p];         //swap places in array
+        A[p] = A[p - 1];
+        A[p - 1] = temp;
+        newn = p;
+      } //end if
+    } //end for
+    n = newn;
+  } while (n > 1);
+}
+
 long my_read_average(byte gain, byte times) {
-  // highest and lowest value will be ignored
-  long sum = 0;
-  long v = 0;
-  long L = 2147483647;
-  long H = -2147483648;
   long res;
+  int const num_scale_readings = 50; // number of instantaneous scale readings to calculate the median
+
+  // we use the median, not the average, see https://community.particle.io/t/boron-gpio-provides-less-current-than-electrons-gpio/46647/13
+  long readings[num_scale_readings];  // create arry to hold readings
+
   if (config_data.debug_level > 0) {
     gCatena.SafePrintf("%010d - my_read_average, measurements: ", millis());
   }
 
-  LoadCell.set_gain(gain);
+  hx711.setGain(gain);
-  // we wait 400ms (settling time according HX711 datasheet @ 10 SPS
-  delay(400);
 
-  for (byte i = 0; i < times; i++) {
+  for (int i = 0; i < num_scale_readings; i++) {
-    // we wait 400ms (settling time according HX711 datasheet @ 10 SPS)
+    readings[i] = hx711.read();  // fill the array with instantaneous readings from the scale
-    v = LoadCell.read();
+  }
+
+  res = median(readings, num_scale_readings); // calculate median
 
-    if (L > v) L = v; // find lowest value
-    if (H < v) H = v; // find highest value
-    sum += v;
   if (config_data.debug_level > 0) {
-      gCatena.SafePrintf("%d ", v);
+    gCatena.SafePrintf("; median of %d samples: %d\n", num_scale_readings, res);
-    }
-    gCatena.poll();
-    delay(WAITTIMELOADSAMPLES);
-  }
-  res = (sum - L - H) / (times - 2);
-  if (config_data.debug_level > 0) {
-    gCatena.SafePrintf("; average (without highest [%d] and lowest [%d] value): %d\n", H, L, res);
   }
 
   return res;
@@ -615,7 +638,9 @@ void ReadSensors(SENSOR_data &sensor_data) {
   if (weight_current32 < 0) {
     weight_current32 = 0;
   } else if (weight_current32 > UINT16_MAX) {
-    weight_current32 = UINT16_MAX;
+    //weight_current32 = UINT16_MAX;
+    // we set the weight to 0, as such high values are not realistic and probably a sign for bad calibration...
+    weight_current32 = 0;
   }
   res.weight = (uint16_t)weight_current32;
 
@@ -874,6 +899,8 @@ static void txNotProvisionedCb(
 static void settleDoneCb(
   osjob_t* pSendJob)
 {
+  const bool fDeepSleep = checkDeepSleep();
+
   if (config_data.debug_level > 0) {
     gCatena.SafePrintf("%010d - settleDoneCb\n", millis());
   }
@@ -889,7 +916,191 @@ static void settleDoneCb(
     // Terry ^^
   }
 
-  sleepDoneCb(pSendJob);
+  if (uint32_t(millis()) > gRebootMs) {
+    // time to reboot
+    NVIC_SystemReset();
+  }
+
+  if (! g_fPrintedSleeping)
+    doSleepAlert(fDeepSleep);
+
+  /* count what we're up to */
+  updateSleepCounters();
+
+  if (fDeepSleep)
+    doDeepSleep(pSendJob);
+  else
+    doLightSleep(pSendJob);
+}
+
+bool checkDeepSleep(void)
+{
+  bool const fDeepSleepTest = gCatena.GetOperatingFlags() &
+                              static_cast<uint32_t>(gCatena.OPERATING_FLAGS::fDeepSleepTest);
+  bool fDeepSleep;
+
+  if (fDeepSleepTest)
+  {
+    fDeepSleep = true;
+  }
+#ifdef USBCON
+  else if (Serial.dtr())
+  {
+    fDeepSleep = false;
+  }
+#endif
+  else if (gCatena.GetOperatingFlags() &
+           static_cast<uint32_t>(gCatena.OPERATING_FLAGS::fDisableDeepSleep))
+  {
+    fDeepSleep = false;
+  }
+  else if ((gCatena.GetOperatingFlags() &
+            static_cast<uint32_t>(gCatena.OPERATING_FLAGS::fUnattended)) != 0)
+  {
+    fDeepSleep = true;
+  }
+  else
+  {
+    fDeepSleep = false;
+  }
+
+  return fDeepSleep;
+}
+
+void doSleepAlert(const bool fDeepSleep)
+{
+  g_fPrintedSleeping = true;
+
+  if (fDeepSleep)
+  {
+    bool const fDeepSleepTest = gCatena.GetOperatingFlags() &
+                                static_cast<uint32_t>(gCatena.OPERATING_FLAGS::fDeepSleepTest);
+    const uint32_t deepSleepDelay = fDeepSleepTest ? 10 : 30;
+    if (config_data.debug_level > 2) {
+      gCatena.SafePrintf("using deep sleep in %u secs"
+#ifdef USBCON
+                         " (USB will disconnect while asleep)"
+#endif
+                         ": ",
+                         deepSleepDelay
+                        );
+
+    }
+    // sleep and print
+    if (config_data.debug_level > 2) {
+      gLed.Set(LedPattern::TwoShort);
+    }
+
+    for (auto n = deepSleepDelay; n > 0; --n)
+    {
+      uint32_t tNow = millis();
+
+      while (uint32_t(millis() - tNow) < 1000)
+      {
+        gCatena.poll();
+        yield();
+      }
+      if (config_data.debug_level > 2) {
+        gCatena.SafePrintf(".");
+      }
+    }
+    if (config_data.debug_level > 2) {
+      gCatena.SafePrintf("\nStarting deep sleep.\n");
+    }
+    uint32_t tNow = millis();
+    while (uint32_t(millis() - tNow) < 100)
+    {
+      gCatena.poll();
+      yield();
+    }
+  }
+  else if (config_data.debug_level > 2) {
+    gCatena.SafePrintf("using light sleep\n");
+  }
+}
+
+void updateSleepCounters(void)
+{
+  // update the sleep parameters
+  if (gTxCycleCount > 1)
+  {
+    // values greater than one are decremented and ultimately reset to default.
+    --gTxCycleCount;
+  }
+  else if (gTxCycleCount == 1)
+  {
+    // it's now one (otherwise we couldn't be here.)
+    if (config_data.debug_level > 2) {
+      gCatena.SafePrintf("resetting tx cycle to default: %u\n", CATCFG_T_CYCLE);
+    }
+
+    gTxCycleCount = 0;
+    gTxCycle = CATCFG_T_CYCLE;
+  }
+  else
+  {
+    // it's zero. Leave it alone.
+  }
+}
+
+void doDeepSleep(osjob_t *pJob)
+{
+  bool const fDeepSleepTest = gCatena.GetOperatingFlags() &
+                              static_cast<uint32_t>(gCatena.OPERATING_FLAGS::fDeepSleepTest);
+  uint32_t const sleepInterval = CATCFG_GetInterval(
+                                   fDeepSleepTest ? CATCFG_T_CYCLE_TEST : gTxCycle
+                                 );
+
+  /* ok... now it's time for a deep sleep */
+  gLed.Set(LedPattern::Off);
+  deepSleepPrepare();
+
+  /* sleep */
+  gCatena.Sleep(sleepInterval);
+
+  /* recover from sleep */
+  deepSleepRecovery();
+
+  /* and now... we're awake again. trigger another measurement */
+  sleepDoneCb(pJob);
+}
+
+void deepSleepPrepare(void)
+{
+  Serial.end();
+  Wire.end();
+  SPI.end();
+  if (fFlash)
+    gSPI2.end();
+}
+
+void deepSleepRecovery(void)
+{
+  Serial.begin();
+  Wire.begin();
+  SPI.begin();
+  if (fFlash)
+    gSPI2.begin();
+}
+
+void doLightSleep(osjob_t *pJob)
+{
+  uint32_t interval = sec2osticks(CATCFG_GetInterval(gTxCycle));
+
+  gLed.Set(LedPattern::Sleeping);
+
+  if (gCatena.GetOperatingFlags() &
+      static_cast<uint32_t>(gCatena.OPERATING_FLAGS::fQuickLightSleep))
+  {
+    interval = 1;
+  }
+
+  gLed.Set(LedPattern::Sleeping);
+  os_setTimedCallback(
+    &iterationJob,
+    os_getTime() + interval,
+    sleepDoneCb
+  );
 }
 
 static void sleepDoneCb(osjob_t* pJob)

mini_beieli_node.h

@@ -19,6 +19,7 @@ enum {
   CATCFG_T_CYCLE_TEST = 30, // every 10 seconds
   CATCFG_T_CYCLE_INITIAL = 30,    // every 30 seconds initially
   CATCFG_INTERVAL_COUNT_INITIAL = 30,     // repeat for 15 minutes
+  CATCFG_T_REBOOT = 30 * 24 * 60 * 60,    // reboot every 30 days
 };
 
 /* additional timing parameters; ususually you don't change these. */
@@ -55,10 +56,7 @@ enum {
   |
   \****************************************************************************/
 
-static const int32_t fwVersion = 20200109;
+static const int32_t fwVersion = 20200211;
-
-// wait between samples in milliseconds
-const int WAITTIMELOADSAMPLES = 100;
 
 static const byte INIT_PACKAGE_INTERVAL = 100;  // send an init package every 100 packages;
 static const byte MAX_VALUES_TO_SEND = 8;