cal_factor must be 1 when absent

README.md

@@ -3,3 +3,33 @@
 Code fuer den LoraWAN Node
 
 Autor: Joerg Lehmann, nbit Informatik GmbH
+
+| Parameter         | Value                       |
+| ----------------- | --------------------------- |
+| Board             | MCCI Catena 4610            |
+| LoraWAN Subband   | "Default, works everywhere" |
+| Serial interface  | Generic Serial              | 
+| LoraWAN Network   | Swisscom                    |
+| System Clock      | 24 MHz                      |
+| LoraWAN Region    | Europe 868 MHz              |
+| Optimize          | Smallest (-Os default)      |
+
+Das sind die verwendeten Libraries [1]:
+
+| URL | Commit | Commit Date |
+| --- | -----  | ----------- |
+| https://github.com/mcci-catena/Adafruit_BME280_Library.git  | 3dafbe1 | Wed, 13 Dec 2017 13:56:30 -0500  |
+| https://github.com/mcci-catena/Adafruit_Sensor.git  | f2af6f4 | Tue, 1 Sep 2015 15:57:59 +0200  |
+| https://github.com/mcci-catena/arduino-lmic.git  | f67121c | Mon, 10 Feb 2020 10:57:04 -0500  |
+| https://github.com/mcci-catena/arduino-lorawan.git  | a0577e1 | Mon, 10 Feb 2020 13:21:30 -0500  |
+| https://github.com/mcci-catena/Catena-Arduino-Platform.git  | 85c010c | Tue, 11 Feb 2020 19:58:25 -0500  |
+| https://github.com/mcci-catena/Catena-mcciadk.git  | a428006 | Sat, 21 Dec 2019 20:45:26 -0500  |
+| https://github.com/mcci-catena/MCCI_FRAM_I2C.git  | f0a5ea5 | Sat, 21 Dec 2019 16:17:01 -0500  |
+| https://github.com/tatobari/Q2-HX711-Arduino-Library.git  | ccda8d8 | Wed, 13 Mar 2019 12:41:44 -0300  |
+| https://github.com/mcci-catena/OneWire.git  | d814a7b | Thu, 26 Apr 2018 03:45:27 +0800  |
+| https://github.com/mcci-catena/SHT1x.git  | be7042c | Tue, 20 Sep 2011 13:56:23 +1000  |
+
+
+
+`[1]:
+[joerg@cinnamon libraries]$ for i in Adafruit_BME280_Library Adafruit_Sensor arduino-lmic arduino-lorawan Catena-Arduino-Platform Catena-mcciadk MCCI_FRAM_I2C Q2-HX711-Arduino-Library OneWire SHT1x ; do cd $i; echo "| $(git remote -v |grep fetch |awk '{print $2}' |tr '\n' ' ') | $(git log --pretty=format:'%h | %cD ' -n 1) |" ; cd ..; done`

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;
@@ -132,7 +132,7 @@ Catena_Mx25v8035f gFlash;
 bool fFlash;
 
 // Scales
-HX711 LoadCell;
+Q2HX711 hx711(A1, A0);
 
 //  USB power
 bool fUsbPower;
@@ -144,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();
@@ -176,7 +181,7 @@ void setup_platform(void)
   if (config_data.debug_level > 0) {
     gCatena.SafePrintf("%010d - Reading Calibration Config from FRAM...\n", millis());
   }
-  gCatena.getFram()->getField(cFramStorage::kBme680Cal, (uint8_t *)&config_data, sizeof(config_data));
+  gCatena.getFram()->getField(cFramStorage::kAppConf, (uint8_t *)&config_data, sizeof(config_data));
 
   if (config_data.debug_level > 0) {
     gCatena.SafePrintf("%010d - setup_platform, this is the configuration\n", millis());
@@ -302,18 +307,8 @@ bool setup_scales(void)
   // Enable Power
   digitalWrite(D10, HIGH);
 
-  // Initialize library with data output pin, clock input pin and gain factor.
-  // Channel selection is made by passing the appropriate gain:
-  // - 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;
-  }
+  // we wait 400ms (settling time according HX711 datasheet @ 10 SPS
+  delay(400);
 
   if (config_data.debug_level > 0) {
     gCatena.SafePrintf("%010d - setup_scale done\n", millis());
@@ -351,7 +346,7 @@ void setup_uplink(void)
     gCatena.SafePrintf("%010d - setup_uplink\n", millis());
   }
 
-  LMIC_setClockError(1*65536/100);  
+  LMIC_setClockError(1 * 65536 / 100);
 
   /* figure out when to reboot */
   gRebootMs = (CATCFG_T_REBOOT + os_getRndU2() - 32768) * 1000;
@@ -585,12 +580,10 @@ long my_read_average(byte gain, byte times) {
     gCatena.SafePrintf("%010d - my_read_average, measurements: ", millis());
   }
 
-  LoadCell.set_gain(gain);
-  // we wait 400ms (settling time according HX711 datasheet @ 10 SPS
-  delay(400);
+  hx711.setGain(gain);
 
   for (int i = 0; i < num_scale_readings; i++) {
-    readings[i] = LoadCell.read();  // fill the array with instantaneous readings from the scale
+    readings[i] = hx711.read();  // fill the array with instantaneous readings from the scale
   }
 
   res = median(readings, num_scale_readings); // calculate median
@@ -605,6 +598,8 @@ long my_read_average(byte gain, byte times) {
 void ReadSensors(SENSOR_data &sensor_data) {
   SENSOR_data res;
   int32_t weight_current32;
+  long w1_0_real;
+  long w2_0_real;
 
   // vBat
   gCatena.poll();
@@ -615,20 +610,38 @@ void ReadSensors(SENSOR_data &sensor_data) {
   }
 
   // Read Scales
+  w1_0_real = config_data.cal_w1_0;
+  w2_0_real = config_data.cal_w2_0;
   if (setup_scales()) {
     if (config_data.debug_level > 0) {
       gCatena.SafePrintf("%010d - HX711 LoadCell is ready.\n", millis());
     }
     gCatena.poll();
+    if (config_data.cal_w1_0 != NOT_ATTACHED) {
       res.weight1 = (int32_t)my_read_average(32, 7);
       if (config_data.debug_level > 0) {
         gCatena.SafePrintf("%010d - Load_cell 1 weight1_current: %ld\n", millis(), res.weight1);
       }
+    } else {
+      res.weight1 = 0;
+      w1_0_real = 0;
+      if (config_data.debug_level > 0) {
+        gCatena.SafePrintf("%010d - Load_cell 1 is disabled\n", millis());
+      }
+    }
     gCatena.poll();
+    if (config_data.cal_w2_0 != NOT_ATTACHED) {
       res.weight2 = (int32_t)my_read_average(128, 7);
       if (config_data.debug_level > 0) {
         gCatena.SafePrintf("%010d - Load_cell 2 weight2_current: %ld\n", millis(), res.weight2);
       }
+    } else {
+      res.weight2 = 0;
+      w2_0_real = 0;
+      if (config_data.debug_level > 0) {
+        gCatena.SafePrintf("%010d - Load_cell 2 is disabled\n", millis());
+      }
+    }
   }
   else {
     if (config_data.debug_level > 0) {
@@ -641,7 +654,8 @@ void ReadSensors(SENSOR_data &sensor_data) {
   digitalWrite(D10, LOW);
 
   // Gewicht berechnen
-  weight_current32 = (int32_t)((((res.weight1 - config_data.cal_w1_0) / config_data.cal_w1_factor) + ((res.weight2 - config_data.cal_w2_0) / config_data.cal_w2_factor)) / 5.0);
+  weight_current32 = (int32_t)((((res.weight1 - w1_0_real) / config_data.cal_w1_factor) + ((res.weight2 - w2_0_real) / config_data.cal_w2_factor)) / 5.0);
+
   if (weight_current32 < 0) {
     weight_current32 = 0;
   } else if (weight_current32 > UINT16_MAX) {
@@ -649,6 +663,10 @@ void ReadSensors(SENSOR_data &sensor_data) {
     // we set the weight to 0, as such high values are not realistic and probably a sign for bad calibration...
     weight_current32 = 0;
   }
+  if (config_data.cal_w1_0 == NOT_ATTACHED || config_data.cal_w2_0 == NOT_ATTACHED) {
+    // when at least one load cell is disabled, we multiply the measured weight by 2
+    weight_current32 = weight_current32 * 2;
+  }
   res.weight = (uint16_t)weight_current32;
 
   if (fBme) {
@@ -906,6 +924,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());
   }
@@ -926,7 +946,186 @@ static void settleDoneCb(
     NVIC_SystemReset();
   }
 
-  sleepDoneCb(pSendJob);
+  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)
@@ -1057,7 +1256,7 @@ static void receiveMessage(void *pContext, uint8_t port, const uint8_t *pMessage
 
       config_data.cal_w1_0 = cal_w1_0;
       config_data.cal_w2_0 = cal_w2_0;
-      gCatena.getFram()->saveField(cFramStorage::kBme680Cal, (const uint8_t *)&config_data, sizeof(config_data));
+      gCatena.getFram()->saveField(cFramStorage::kAppConf, (const uint8_t *)&config_data, sizeof(config_data));
       lora_data_first.cal_w1_0 = config_data.cal_w1_0;
       lora_data_first.cal_w2_0 = config_data.cal_w2_0;
     }
@@ -1073,7 +1272,7 @@ static void receiveMessage(void *pContext, uint8_t port, const uint8_t *pMessage
       config_data.cal_w2_0 = cal_w2_0;
       config_data.cal_w1_factor = cal_w1_factor;
       config_data.cal_w2_factor = cal_w2_factor;
-      gCatena.getFram()->saveField(cFramStorage::kBme680Cal, (const uint8_t *)&config_data, sizeof(config_data));
+      gCatena.getFram()->saveField(cFramStorage::kAppConf, (const uint8_t *)&config_data, sizeof(config_data));
 
       lora_data_first.cal_w1_0 = config_data.cal_w1_0;
       lora_data_first.cal_w2_0 = config_data.cal_w2_0;
@@ -1142,7 +1341,7 @@ cCommandStream::CommandStatus cmdCalibrateZeroScaleA(cCommandStream *pThis, void
 {
   setup_scales();
   config_data.cal_w1_0 = (int32_t)my_read_average(32, 10);
-  gCatena.getFram()->saveField(cFramStorage::kBme680Cal, (const uint8_t *)&config_data, sizeof(config_data));
+  gCatena.getFram()->saveField(cFramStorage::kAppConf, (const uint8_t *)&config_data, sizeof(config_data));
   pThis->printf("{ \"msg\": \"calibrate_zero_scale_a was successful\" }\n");
 
   return cCommandStream::CommandStatus::kSuccess;
@@ -1152,7 +1351,7 @@ cCommandStream::CommandStatus cmdCalibrateZeroScaleB(cCommandStream *pThis, void
 {
   setup_scales();
   config_data.cal_w2_0 = (int32_t)my_read_average(128, 10);
-  gCatena.getFram()->saveField(cFramStorage::kBme680Cal, (const uint8_t *)&config_data, sizeof(config_data));
+  gCatena.getFram()->saveField(cFramStorage::kAppConf, (const uint8_t *)&config_data, sizeof(config_data));
   pThis->printf("{ \"msg\": \"calibrate_zero_scale_b was successful\" }\n");
 
   return cCommandStream::CommandStatus::kSuccess;
@@ -1162,11 +1361,18 @@ cCommandStream::CommandStatus cmdCalibrateScaleA(cCommandStream *pThis, void *pC
 {
   String w1_gramm(argv[1]);
   long weight1;
+
+  if (w1_gramm == "NA") {
+    // scale a is not connected
+    config_data.cal_w1_factor = 1.0;
+    config_data.cal_w1_0 = NOT_ATTACHED;
+  } else {
     setup_scales();
     weight1 = my_read_average(32, 10);
     config_data.cal_w1_factor = (float)((weight1 - config_data.cal_w1_0) / w1_gramm.toFloat());
+  }
 
-  gCatena.getFram()->saveField(cFramStorage::kBme680Cal, (const uint8_t *)&config_data, sizeof(config_data));
+  gCatena.getFram()->saveField(cFramStorage::kAppConf, (const uint8_t *)&config_data, sizeof(config_data));
 
   pThis->printf("{ \"msg\": \"calibrate_scale_a was successful\" }\n");
 
@@ -1177,11 +1383,18 @@ cCommandStream::CommandStatus cmdCalibrateScaleB(cCommandStream *pThis, void *pC
 {
   String w2_gramm(argv[1]);
   long weight2;
+
+  if (w2_gramm == "NA") {
+    // scale b is not connected
+    config_data.cal_w2_factor = 1.0;
+    config_data.cal_w2_0 = NOT_ATTACHED;
+  } else {
     setup_scales();
     weight2 = my_read_average(128, 10);
     config_data.cal_w2_factor = (float)((weight2 - config_data.cal_w2_0) / w2_gramm.toFloat());
+  }
 
-  gCatena.getFram()->saveField(cFramStorage::kBme680Cal, (const uint8_t *)&config_data, sizeof(config_data));
+  gCatena.getFram()->saveField(cFramStorage::kAppConf, (const uint8_t *)&config_data, sizeof(config_data));
 
   pThis->printf("{ \"msg\": \"calibrate_scale_b was successful\" }\n");
 
@@ -1192,7 +1405,7 @@ cCommandStream::CommandStatus cmdSetDebugLevel(cCommandStream *pThis, void *pCon
 {
   String s_debug_level(argv[1]);
   config_data.debug_level = s_debug_level.toInt();
-  gCatena.getFram()->saveField(cFramStorage::kBme680Cal, (const uint8_t *)&config_data, sizeof(config_data));
+  gCatena.getFram()->saveField(cFramStorage::kAppConf, (const uint8_t *)&config_data, sizeof(config_data));
 
   pThis->printf("{ \"msg\": \"set_debug_level was successful\" }\n");
 
@@ -1201,7 +1414,7 @@ cCommandStream::CommandStatus cmdSetDebugLevel(cCommandStream *pThis, void *pCon
 
 cCommandStream::CommandStatus cmdGetDebugLevel(cCommandStream *pThis, void *pContext, int argc, char **argv)
 {
-  gCatena.getFram()->saveField(cFramStorage::kBme680Cal, (const uint8_t *)&config_data, sizeof(config_data));
+  gCatena.getFram()->saveField(cFramStorage::kAppConf, (const uint8_t *)&config_data, sizeof(config_data));
 
   pThis->printf("{ \"msg\": \"debug_level is %d\" }\n", config_data.debug_level);
 

mini_beieli_node.h

@@ -56,7 +56,7 @@ enum {
   |
   \****************************************************************************/
 
-static const int32_t fwVersion = 20200207;
+static const int32_t fwVersion = 20200229;
 
 static const byte INIT_PACKAGE_INTERVAL = 100;  // send an init package every 100 packages;
 static const byte MAX_VALUES_TO_SEND = 8;
@@ -65,15 +65,16 @@ static const uint8_t LORA_DATA_VERSION = 1;
 static const uint8_t LORA_DATA_VERSION_FIRST_PACKAGE = 128;
 static const uint32_t PRESSURE_OFFSET = 825;
 static const uint16_t SEND_DIFF_THRESHOLD_5GRAMS = 10;   // when weight value drops by 50g, then send data
+static const long NOT_ATTACHED = -2147483648;
 
-// must be 139 bytes long (size of kBme680Cal)
+// must be 64 bytes long (size of kAppConf)
 typedef struct {
-  long cal_w1_0;                                     // 4 Bytes, Wert Waegezelle 1 ohne Gewicht
-  long cal_w2_0;                                     // 4 Bytes, Wert Waegezelle 2 ohne Gewicht
+  long cal_w1_0;                                     // 4 Bytes, Wert Waegezelle 1 ohne Gewicht, LONG_MIN when not connected
+  long cal_w2_0;                                     // 4 Bytes, Wert Waegezelle 2 ohne Gewicht, LONG_MIN when not connected
   float cal_w1_factor;                               // 4 Bytes, Kalibrationsfaktor Waegezelle 1
   float cal_w2_factor;                               // 4 Bytes, Kalibrationsfaktor Waegezelle 2
   byte debug_level;                                  // 0 => no debugging, no led, 1 => infos, no led, 2 => infos, 3 => error, 4 => highest level
-  byte fill[122];
+  byte fill[47];
 } __attribute__((packed)) CONFIG_data;
 
 typedef struct {