Merge pull request #419 from EnviroDIY/develop

Update `hmac_auth` from `develop`

Author: aufdenkampe

.clang-format

@@ -12,36 +12,39 @@ AlignTrailingComments: true
 AllowAllArgumentsOnNextLine: true
 AllowAllConstructorInitializersOnNextLine: true
 AllowAllParametersOfDeclarationOnNextLine: true
-AllowShortBlocksOnASingleLine: true
+AllowShortBlocksOnASingleLine: Always
 AllowShortCaseLabelsOnASingleLine: true
+AllowShortEnumsOnASingleLine: true
 AllowShortFunctionsOnASingleLine: Empty
-AllowShortLambdasOnASingleLine: All
 AllowShortIfStatementsOnASingleLine: WithoutElse
+AllowShortLambdasOnASingleLine: All
 AllowShortLoopsOnASingleLine: true
 AlwaysBreakAfterDefinitionReturnType: None
 AlwaysBreakAfterReturnType: None
 AlwaysBreakBeforeMultilineStrings: false
 AlwaysBreakTemplateDeclarations: Yes
 BinPackArguments: true
 BinPackParameters: true
+BreakAfterJavaFieldAnnotations: false
 BreakBeforeBinaryOperators: None
 BreakBeforeBraces: Attach
 BreakBeforeInheritanceComma: false
-BreakInheritanceList: BeforeColon
 BreakBeforeTernaryOperators: true
 BreakConstructorInitializersBeforeComma: false
 BreakConstructorInitializers: BeforeColon
-BreakAfterJavaFieldAnnotations: false
+BreakInheritanceList: BeforeColon
 BreakStringLiterals: true
 ColumnLimit: 80
-CommentPragmas: "^ IWYU pragma:"
+CommentPragmas: '^ IWYU pragma:'
 CompactNamespaces: false
 ConstructorInitializerAllOnOneLineOrOnePerLine: false
 ConstructorInitializerIndentWidth: 4
 ContinuationIndentWidth: 4
 Cpp11BracedListStyle: true
 DerivePointerAlignment: false
 DisableFormat: false
+EmptyLineAfterAccessModifier: Leave
+EmptyLineBeforeAccessModifier: Leave
 ExperimentalAutoDetectBinPacking: false
 FixNamespaceComments: true
 ForEachMacros:
@@ -50,32 +53,38 @@ ForEachMacros:
   - BOOST_FOREACH
 IncludeBlocks: Preserve
 IncludeCategories:
-  - Regex: "TinyGsmClient.h"
+  - Regex: 'TinyGsmClient.h'
     Priority: -1
-  - Regex: "VariableBase.h"
+  - Regex: 'VariableBase.h'
     Priority: -1
   - Regex: '^"(llvm|llvm-c|clang|clang-c)/'
     Priority: 2
   - Regex: '^(<|"(gtest|gmock|isl|json)/)'
     Priority: 3
-  - Regex: ".*"
+  - Regex: '.*'
     Priority: 1
 IncludeIsMainRegex: '([-_](test|unittest))?$'
+IndentAccessModifiers: false
+IndentCaseBlocks: false
 IndentCaseLabels: true
+IndentExternBlock: Indent
+IndentGotoLabels: true
 IndentPPDirectives: None
 IndentWidth: 4
 IndentWrappedFunctionNames: false
+InsertTrailingCommas: None
 JavaScriptQuotes: Leave
 JavaScriptWrapImports: true
 KeepEmptyLinesAtTheStartOfBlocks: false
-MacroBlockBegin: ""
-MacroBlockEnd: ""
+MacroBlockBegin: ''
+MacroBlockEnd: ''
 MaxEmptyLinesToKeep: 2
 NamespaceIndentation: None
 # ObjCBinPackProtocolList: Auto
 ObjCBlockIndentWidth: 2
 ObjCSpaceAfterProperty: false
 ObjCSpaceBeforeProtocolList: true
+PackConstructorInitializers: CurrentLine
 PenaltyBreakAssignment: 25
 PenaltyBreakBeforeFirstCallParameter: 19
 PenaltyBreakComment: 300
@@ -86,13 +95,17 @@ PenaltyExcessCharacter: 600
 PenaltyReturnTypeOnItsOwnLine: 50
 PointerAlignment: Left
 PointerBindsToType: true
+QualifierAlignment: Left
+ReferenceAlignment: Left
 ReflowComments: true
+SeparateDefinitionBlocks: Leave
 SortIncludes: false
 SortUsingDeclarations: true
 SpaceAfterCStyleCast: false
 SpaceAfterLogicalNot: false
 SpaceAfterTemplateKeyword: true
 SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
 SpaceBeforeCpp11BracedList: false
 SpaceBeforeCtorInitializerColon: true
 SpaceBeforeInheritanceColon: true
@@ -101,9 +114,11 @@ SpaceBeforeRangeBasedForLoopColon: true
 SpaceInEmptyParentheses: false
 SpacesBeforeTrailingComments: 2
 SpacesInAngles: false
-SpacesInCStyleCastParentheses: false
 SpacesInContainerLiterals: true
 SpacesInCStyleCastParentheses: false
+SpacesInConditionalStatement: false
+SpacesInLineCommentPrefix:
+  Minimum: 1
 SpacesInParentheses: false
 SpacesInSquareBrackets: false
 Standard: Cpp11

.github/workflows/build_documentation.yaml

@@ -38,7 +38,9 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
 
       - name: check for classes in the menu example
         run: |
@@ -56,7 +58,9 @@ jobs:
           path: code_docs/ModularSensors
 
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
 
       - name: Restore Python Dependencies
         uses: actions/cache@v3

.github/workflows/build_examples_platformio.yaml

@@ -46,7 +46,9 @@ jobs:
           fi
 
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
 
       - name: Install PlatformIO
         run: |

.github/workflows/build_menu.yaml

@@ -95,6 +95,9 @@ jobs:
           - modemFlag: BUILD_MODEM_SIM_COM_SIM7080
             sensorFlag: BUILD_SENSOR_CAMPBELL_OBS3
             publisherFlag: BUILD_PUB_ENVIRO_DIY_PUBLISHER
+          - modemFlag: BUILD_MODEM_SIM_COM_SIM7080
+            sensorFlag: BUILD_SENSOR_CAMPBELL_RAINVUE10
+            publisherFlag: BUILD_PUB_ENVIRO_DIY_PUBLISHER
           - modemFlag: BUILD_MODEM_SIM_COM_SIM7080
             sensorFlag: BUILD_SENSOR_DECAGON_CTD
             publisherFlag: BUILD_PUB_ENVIRO_DIY_PUBLISHER
@@ -224,7 +227,9 @@ jobs:
           fi
 
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
 
       - name: Install PlatformIO
         run: |

.github/workflows/prepare_release.yaml

@@ -30,7 +30,9 @@ jobs:
           echo "ZIP_NAME=$ZIP_FILE" >> $GITHUB_ENV
 
       - name: Set up python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
 
       - name: Install PlatformIO
         run: |

.github/workflows/verify_library_structure.yaml

@@ -16,7 +16,9 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Set up Python
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
 
       - name: Install PlatformIO
         run: |

.gitignore

@@ -1,6 +1,7 @@
 # Windows image file caches
 Thumbs.db
 ehthumbs.db
+~*
 
 # Folder config file
 Desktop.ini
@@ -94,4 +95,5 @@ cache
 docs/output_copyFunctions.log
 docs/output_documentExamples.log
 docs/output_fixSectionsInXml.log
-*HMAC_secret_key.h
+examples/DRWI_Mayfly1_Wifi_5tm_ds18b20_1/DRWI_Mayfly1_Wifi_5tm_ds18b20_1.ino
+clang_format_all.bat

ChangeLog.md

@@ -21,6 +21,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ***
 
 
+## [0.34.0]
+
+### Changed
+- **BREAKING** - Removed support for light sleep on Espressif modules.
+**This changes the order of the constructor for the ESP32 and ESP8266!**
+  - The light sleep mode is non-functional anyway, and confusion over the sleep request pin was putting the board in a position not to sleep at all.
+- Minor tweek to clang-format
+- Moved all variable initialization to default header values and initializer lists
+- Converted all "c-style" casts to static casts
+- Switched cases of strcat and strcpy to snprintf
+- Specify python version 3.x for actions (used by PlatformIO)
+
+### Added
+
+### Removed
+
+### Fixed
+- Fixed non-concurrent data fetch for SDI-12 when *NOT* using debugging.
+- Fixed internet connection when in "testing mode"
+- Allow a non-zero wait time for SDI-12 sensors
+
+***
+
+
 ## [0.33.4]
 
 ### Fixed

docs/Modem-Notes.md

@@ -29,7 +29,7 @@ If you are having trouble, please see the pages for the specific modems and the
 | Digi XBee3 LTE Cat 1 AT&T (Telit LE866A1-NA)  |           DigiXBeeCellularTransparent            |
 |              Digi XBee S6B WiFi               |                   DigiXBeeWifi                   |
 |               Espressif ESP8266               |                 EspressifESP8266                 |
-|                Espressif ESP32                |                 EspressifESP8266                 |
+|                Espressif ESP32                |                 EspressifESP32                 |
 |                 Quectel BG96                  |                   QuectelBG96                    |
 |       Mikroe LTE IOT 2 Click (_BG96_)¹        |                   QuectelBG96                    |
 |         Dragino NB IOT Bee (_BG96_)¹          |                   QuectelBG96                    |
@@ -139,7 +139,7 @@ Here are the pin numbers to use for modules that can be attached directly to an
 |      Digi XBee/XBee3, all variants (direct connection)¹      |       -1       |      19²       |       -1       |       23       |
 | Digi XBee/XBee3, all variants (with LTE adapter<sup>8</sup>) | -1<sup>3</sup> | 19<sup>4</sup> |       20       |       23       |
 |               Itead Wee (ESP8266)<sup>8</sup>                |       -1       |       -1       | -1<sup>5</sup> |       -1       |
-|                  DFRobot WiFi Bee (ESP8266)                  |       -1       |       -1       |       -1       | 19<sup>6</sup> |
+|                  DFRobot WiFi Bee (ESP8266)                  |       -1       |       -1       |       -1       |      N/A       |
 |                  Dragino NB IOT Bee (BG96)                   |       -1       |       -1       | -1<sup>7</sup> | -1<sup>7</sup> |
 |                  Sodaq GPRSBee R4 (SIM900)                   |       -1       |       19       |       -1       |       23       |
 |               Sodaq GPRSBee R6 or R7 (SIM800H)               |       23       |       19       |      N/A       |      N/A       |
@@ -163,8 +163,6 @@ You should set the argument `useCTSforStatus` to `false` in the bee constructor
 <sup>5</sup> I *strongly* recommend running a new wire along the back of the Mayfly to connect pin 5 of the XBee socket to pin A4.
    This will enable you to use A4 as the reset pin which allows you to use deep sleep.
 
-<sup>6</sup> Use 13 as the `espSleepRqPin` for light sleep.
-
 <sup>7</sup> I *strongly* recommend running two new wires along the back of the Mayfly to connect pin 5 of the XBee socket to pin A4 and pin 18 of the XBee socket to A3.
 This will enable you to use A4 as the reset pin and A3 as the sleep request pin.
 With those connections made, the Dragino BG96 becomes the _**only**_ LTE module that can be run using only the 500mA regulator on the Mayfly (ie, without a separate battery connection for the modem).

examples/DRWI_Mayfly1_WiFi/DRWI_Mayfly1_WiFi.ino

@@ -4,8 +4,8 @@
  *
  * This example shows proper settings for the following configuration:
  *
- * Mayfly v1.0 board
- * EnviroDIY SIM7080 LTE module (with Hologram SIM card)
+ * Mayfly v1.x board
+ * EnviroDIY ESP32 Wifi Bee module
  * Hydros21 CTD sensor
  *
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
@@ -95,19 +95,18 @@ const int32_t   modemBaud   = 115200;   // Communication speed of the modem
 // NOTE:  Use -1 for pins that do not apply
 // Example pins here are for a EnviroDIY ESP32 Bluetooth/Wifi Bee with
 // Mayfly 1.1
-const int8_t modemVccPin    = 18;      // MCU pin controlling modem power
-const int8_t modemStatusPin = -1;      // MCU pin used to read modem status
-const int8_t modemResetPin  = A5;      // MCU pin connected to modem reset pin
-const int8_t modemLEDPin    = redLED;  // MCU pin connected an LED to show modem
-                                       // status
+const int8_t modemVccPin   = 18;      // MCU pin controlling modem power
+const int8_t modemResetPin = -1;      // MCU pin connected to modem reset pin
+const int8_t modemLEDPin   = redLED;  // MCU pin connected an LED to show modem
+                                      // status
 
 // Network connection information
 const char* wifiId  = "xxxxx";  // WiFi access point name
 const char* wifiPwd = "xxxxx";  // WiFi password (WPA2)
 
 // Create the modem object
-EspressifESP32 modemESP(&modemSerial, modemVccPin, modemStatusPin,
-                        modemResetPin, wifiId, wifiPwd);
+EspressifESP32 modemESP(&modemSerial, modemVccPin, modemResetPin, wifiId,
+                        wifiPwd);
 // Create an extra reference to the modem by a generic name
 EspressifESP32 modem = modemESP;
 /** End [espressif_esp32] */
@@ -137,20 +136,6 @@ MaximDS3231 ds3231(1);
 /** End [ds3231] */
 
 
-// ==========================================================================
-//  Everlight ALS-PT19 Ambient Light Sensor
-//  Built in on Mayfly 1.x
-// ==========================================================================
-/** Start [everlight_alspt19] */
-#include <sensors/EverlightALSPT19.h>
-
-// Create a Everlight ALS-PT19 sensor object
-// For an EnviroDIY Mayfly, you can use the abbreviated version
-const uint8_t    alsNumberReadings = 10;
-EverlightALSPT19 alsPt19(alsNumberReadings);
-/** End [everlight_alspt19] */
-
-
 // ==========================================================================
 //  Sensirion SHT4X Digital Humidity and Temperature Sensor
 //  Built in on Mayfly 1.x
@@ -195,8 +180,6 @@ Variable* variableList[] = {
     new MeterHydros21_Temp(&hydros),             // Temperature (Meter_Hydros21_Temp)
     new SensirionSHT4x_Humidity(&sht4x),         // Relative humidity (Sensirion_SHT40_Humidity)
     new SensirionSHT4x_Temp(&sht4x),             // Temperature (Sensirion_SHT40_Temperature)
-    new EverlightALSPT19_Illuminance(&alsPt19),  // Illuminance (Everlight_AnalogALS_Illuminance)
-    new MaximDS3231_Temp(&ds3231),               // Temperature (Maxim_DS3231_Temp)
     new ProcessorStats_Battery(&mcuBoard),       // Battery voltage (EnviroDIY_Mayfly_Batt)
     new Modem_SignalPercent(&modem),             // Percent full scale (EnviroDIY_LTEB_SignalPercent)
 };
@@ -225,8 +208,6 @@ const char* UUIDs[] =  // UUID array for device sensors
         "12345678-abcd-1234-ef00-1234567890ab",  // Temperature (Meter_Hydros21_Temp)
         "12345678-abcd-1234-ef00-1234567890ab",  // Relative humidity (Sensirion_SHT40_Humidity)
         "12345678-abcd-1234-ef00-1234567890ab",  // Temperature (Sensirion_SHT40_Temperature)
-        "12345678-abcd-1234-ef00-1234567890ab",  // Illuminance (Everlight_AnalogALS_Illuminance)
-        "12345678-abcd-1234-ef00-1234567890ab",  // Temperature (Maxim_DS3231_Temp)
         "12345678-abcd-1234-ef00-1234567890ab",  // Battery voltage (EnviroDIY_Mayfly_Batt)
         "12345678-abcd-1234-ef00-1234567890ab",  // Percent full scale (EnviroDIY_LTEB_SignalPercent)
 };

examples/data_saving/data_saving.ino

@@ -404,7 +404,9 @@ void setup() {
 // NOTE:  Only use this when debugging - if not connected to a PC, this
 // could prevent the script from starting
 #if defined SERIAL_PORT_USBVIRTUAL
-    while (!SERIAL_PORT_USBVIRTUAL && (millis() < 10000)) {}
+    while (!SERIAL_PORT_USBVIRTUAL && (millis() < 10000)) {
+        // wait
+    }
 #endif
 
     // Start the primary serial connection
@@ -622,4 +624,5 @@ void loop() {
     // Only need to do this for one of the loggers
     loggerAllVars.systemSleep();
 }
+
 /** End [loop] */

examples/logging_to_MMW/logging_to_MMW.ino

@@ -264,7 +264,9 @@ void setup() {
 // NOTE:  Only use this when debugging - if not connected to a PC, this
 // could prevent the script from starting
 #if defined SERIAL_PORT_USBVIRTUAL
-    while (!SERIAL_PORT_USBVIRTUAL && (millis() < 10000)) {}
+    while (!SERIAL_PORT_USBVIRTUAL && (millis() < 10000)) {
+        // wait
+    }
 #endif
 
     // Start the primary serial connection