Update copyrights, fix example docs and release

Signed-off-by: Sara Damiano <sdamiano@stroudcenter.org>

Author: SRGDamia1

.github/workflows/prepare_release.yaml

@@ -130,10 +130,9 @@ jobs:
         id: changelog_reader
         uses: mindsers/changelog-reader-action@v2
         with:
-          validation_depth: 10
-          # NOTE:  Need to add the refs/tags to work with the generate notes action
-          version: ${{ format('refs/tags/{0}', env.VERSION) }}
           path: ./CHANGELOG.md
+          version: ${{ env.VERSION }}
+          validation_depth: 10
 
       # I use the first line of the change log entry as the name, so read it here
       # - name: Get release name
@@ -149,9 +148,9 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
-          tag_name: ${{ env.VERSION }}
-          # name: ${{ format('{0} - {1}', env.VERSION, steps.get_release_name.outputs.release_name) }}
-          name: ${{ env.VERSION }}
+          tag_name: ${{ format('v{0}',env.VERSION) }}
+          # name: ${{ format('v{0} - {1}', env.VERSION, steps.get_release_name.outputs.release_name) }}
+          name: ${{ format('v{0}',env.VERSION) }}
           draft: ${{ steps.changelog_reader.outputs.status == 'unreleased' }}
           prerelease: ${{ steps.changelog_reader.outputs.status == 'prereleased' }}
           body: ${{ steps.changelog_reader.outputs.changes }}

CHANGELOG.md

@@ -9,11 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.32.0] - 2021-11-18
+## [0.32.0] - 2021-11-19
 Reinstate support for AOSong DHT
 
 ### Changed
 - **Documentation:** Restructured the changelog
+- **Documentation:** Restyled and corrected documentation links for new and renamed DRWI examples
 - **Continuous Integration:** Updated changelog reader and automated releaser
 
 ### Added
@@ -32,6 +33,9 @@ Fix build without AOSong DHT
 ## [0.31.0] - 2021-11-02
 Remove support for AOSong DHT
 
+### Added
+- **Examples:** Added a new example for the DRWI site using the new EnviroDIY bee based on the SIMCOM SIM7080G
+
 ### Removed
 - **Breaking:** Temporarily **_REMOVED_** support for AOSong DHT sensor.
   - Intend to restore this after updating to support newest Adafruit DHT library

VERSION

@@ -1 +1 @@
-v0.32.0
+0.32.0

docs/documentExamples.py

@@ -13,8 +13,9 @@
     "../examples/baro_rho_correction/ReadMe.md",
     "../examples/data_saving/ReadMe.md",
     "../examples/double_logger/ReadMe.md",
-    "../examples/DRWI_CitSci/ReadMe.md",
-    "../examples/DRWI_LTE/ReadMe.md",
+    "../examples/DRWI_2G/ReadMe.md",
+    "../examples/DRWI_DigiLTE/ReadMe.md",
+    "../examples/DRWI_SIM7080LTE/ReadMe.md",
     "../examples/DRWI_NoCellular/ReadMe.md",
     "../examples/logging_to_MMW/ReadMe.md",
     "../examples/logging_to_ThingSpeak/ReadMe.md",

examples/DRWI_2G/DRWI_2G.ino

@@ -1,9 +1,9 @@
 /** =========================================================================
- * @file DRWI_CitSci.ino
+ * @file DRWI_2G.ino
  * @brief Example for DRWI CitSci 2G sites.
  *
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
- * @copyright (c) 2017-2020 Stroud Water Research Center (SWRC)
+ * @copyright (c) 2017-2021 Stroud Water Research Center (SWRC)
  *                          and the EnviroDIY Development Team
  *            This example is published under the BSD-3 license.
  *

examples/DRWI_2G/ReadMe.md

@@ -131,6 +131,6 @@ _______
 
 [//]: # ( @section example_drwi_2g_pio_config PlatformIO Configuration )
 
-[//]: # ( @include{lineno} DRWI_CitSci/platformio.ini )
+[//]: # ( @include{lineno} DRWI_2G/platformio.ini )
 
 [//]: # ( @section example_drwi_2g_code The Complete Code )

examples/DRWI_DigiLTE/DRWI_DigiLTE.ino

@@ -3,7 +3,7 @@
  * @brief Example for DRWI CitSci LTE sites.
  *
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
- * @copyright (c) 2017-2020 Stroud Water Research Center (SWRC)
+ * @copyright (c) 2017-2021 Stroud Water Research Center (SWRC)
  *                          and the EnviroDIY Development Team
  *            This example is published under the BSD-3 license.
  *
@@ -62,10 +62,10 @@ const int8_t timeZone = -5;  // Eastern Standard Time
 // Set the input and output pins for the logger
 // NOTE:  Use -1 for pins that do not apply
 const int32_t serialBaud = 57600;  // Baud rate for debugging
-const int8_t  greenLED   = 8;       // Pin for the green LED
-const int8_t  redLED     = 9;       // Pin for the red LED
-const int8_t  buttonPin  = 21;      // Pin for debugging mode (ie, button pin)
-const int8_t  wakePin    = 31;  // MCU interrupt/alarm pin to wake from sleep
+const int8_t  greenLED   = 8;      // Pin for the green LED
+const int8_t  redLED     = 9;      // Pin for the red LED
+const int8_t  buttonPin  = 21;     // Pin for debugging mode (ie, button pin)
+const int8_t  wakePin    = 31;     // MCU interrupt/alarm pin to wake from sleep
 // Mayfly 0.x D31 = A7
 // Set the wake pin to -1 if you do not want the main processor to sleep.
 // In a SAMD system where you are using the built-in rtc, set wakePin to 1
@@ -197,8 +197,10 @@ Variable* variableList[] = {
     new Modem_SignalPercent(&modem),
 };
 
-// All UUID's, device registration, and sampling feature information can be pasted directly from Monitor My Watershed.  
-//To get the list, click the "View  token UUID list" button on the upper right of the site page.
+// All UUID's, device registration, and sampling feature information can be
+// pasted directly from Monitor My Watershed.
+// To get the list, click the "View  token UUID list" button on the upper right
+// of the site page.
 
 // *** CAUTION --- CAUTION --- CAUTION --- CAUTION --- CAUTION ***
 // Check the order of your variables in the variable list!!!
@@ -207,27 +209,40 @@ Variable* variableList[] = {
 // Do not change the order of the variables in the section below.
 // *** CAUTION --- CAUTION --- CAUTION --- CAUTION --- CAUTION ***
 
-// Replace all of the text in the following section with the UUID array from MonitorMyWatershed
-
-// ---------------------   Beginning of Token UUID List   ---------------------------------------
-
-
-const char* UUIDs[] =                                  // UUID array for device sensors
-{     
-    "12345678-abcd-1234-ef00-1234567890ab",  // Specific conductance (Meter_Hydros21_Cond)
-    "12345678-abcd-1234-ef00-1234567890ab",  // Water depth (Meter_Hydros21_Depth)
-    "12345678-abcd-1234-ef00-1234567890ab",  // Temperature (Meter_Hydros21_Temp)
-    "12345678-abcd-1234-ef00-1234567890ab",  // Turbidity (Campbell_OBS3_Turb) (Low)
-    "12345678-abcd-1234-ef00-1234567890ab",  // Turbidity (Campbell_OBS3_Turb) (High)
-    "12345678-abcd-1234-ef00-1234567890ab",  // Battery voltage (EnviroDIY_Mayfly_Batt)
-    "12345678-abcd-1234-ef00-1234567890ab",  // Temperature (Maxim_DS3231_Temp)
-    "12345678-abcd-1234-ef00-1234567890ab",  // Percent full scale (Digi_Cellular_SignalPercent)                 
+// Replace all of the text in the following section with the UUID array from
+// MonitorMyWatershed
+
+// ---------------------   Beginning of Token UUID List
+// ---------------------------------------
+
+
+const char* UUIDs[] =  // UUID array for device sensors
+    {
+        "12345678-abcd-1234-ef00-1234567890ab",  // Specific conductance
+                                                 // (Meter_Hydros21_Cond)
+        "12345678-abcd-1234-ef00-1234567890ab",  // Water depth
+                                                 // (Meter_Hydros21_Depth)
+        "12345678-abcd-1234-ef00-1234567890ab",  // Temperature
+                                                 // (Meter_Hydros21_Temp)
+        "12345678-abcd-1234-ef00-1234567890ab",  // Turbidity
+                                                 // (Campbell_OBS3_Turb) (Low)
+        "12345678-abcd-1234-ef00-1234567890ab",  // Turbidity
+                                                 // (Campbell_OBS3_Turb) (High)
+        "12345678-abcd-1234-ef00-1234567890ab",  // Battery voltage
+                                                 // (EnviroDIY_Mayfly_Batt)
+        "12345678-abcd-1234-ef00-1234567890ab",  // Temperature
+                                                 // (Maxim_DS3231_Temp)
+        "12345678-abcd-1234-ef00-1234567890ab",  // Percent full scale
+                                                 // (Digi_Cellular_SignalPercent)
 };
-const char* registrationToken = "12345678-abcd-1234-ef00-1234567890ab";  // Device registration token
-const char* samplingFeature = "12345678-abcd-1234-ef00-1234567890ab";    // Sampling feature UUID
+const char* registrationToken =
+    "12345678-abcd-1234-ef00-1234567890ab";  // Device registration token
+const char* samplingFeature =
+    "12345678-abcd-1234-ef00-1234567890ab";  // Sampling feature UUID
 
 
-// -----------------------   End of Token UUID List   ------------------------------------------
+// -----------------------   End of Token UUID List
+// ------------------------------------------
 
 // Count up the number of pointers in the array
 int variableCount = sizeof(variableList) / sizeof(variableList[0]);
@@ -314,8 +329,9 @@ void setup() {
     // Blink the LEDs to show the board is on and starting up
     greenredflash();
 
-    pinMode(20, OUTPUT);   //for proper operation of the onboard flash memory chip's ChipSelect (Mayfly v1.0 and later)
-  
+    pinMode(20, OUTPUT);  // for proper operation of the onboard flash memory
+                          // chip's ChipSelect (Mayfly v1.0 and later)
+
     // Set the timezones for the logger/data and the RTC
     // Logging in the given time zone
     Logger::setLoggerTimeZone(timeZone);

examples/DRWI_DigiLTE/ReadMe.md

@@ -1,5 +1,5 @@
-[//]: # ( @page example_drwi_lte DRWI CitSci LTE Sites )
-# Example using the Modular Sensors Library for DRWI Sites
+[//]: # ( @page example_drwi_digilte DRWI CitSci Digi LTE Sites )
+# Example using the Modular Sensors Library for DRWI Digi LTE Sites
 
 This is the code example that should be used for all groups working with the Stroud Water Research Center within the Delaware River Watershed Initiative.
 This should be used at all sites with cellular LTE service.
@@ -12,8 +12,8 @@ _______
 [//]: # ( @tableofcontents )
 
 [//]: # ( Start GitHub Only )
-- [Example using the Modular Sensors Library for DRWI Sites](#example-using-the-modular-sensors-library-for-drwi-sites)
-- [Unique Features of the DRWI LTE Example](#unique-features-of-the-drwi-lte-example)
+- [Example using the Modular Sensors Library for DRWI Digi LTE Sites](#example-using-the-modular-sensors-library-for-drwi-digi-lte-sites)
+- [Unique Features of the DRWI Digi LTE Example](#unique-features-of-the-drwi-digi-lte-example)
 - [To Use this Example:](#to-use-this-example)
   - [Prepare and set up PlatformIO](#prepare-and-set-up-platformio)
   - [Set the logger ID](#set-the-logger-id)
@@ -25,15 +25,15 @@ _______
 
 _______
 
-[//]: # ( @section example_drwi_lte_unique Unique Features of the DRWI LTE Example )
-# Unique Features of the DRWI LTE Example
+[//]: # ( @section example_drwi_digilte_unique Unique Features of the DRWI Digi LTE Example )
+# Unique Features of the DRWI Digi LTE Example
 - Specifically for sites within the Delaware River Watershed Initiative.
 - Uses a Digi XBee3 LTE-M for live data.
 
-[//]: # ( @section example_drwi_lte_using To Use this Example: )
+[//]: # ( @section example_drwi_digilte_using To Use this Example: )
 # To Use this Example:
 
-[//]: # ( @subsection example_drwi_lte_pio Prepare and set up PlatformIO )
+[//]: # ( @subsection example_drwi_digilte_pio Prepare and set up PlatformIO )
 ## Prepare and set up PlatformIO
 - Register a site and sensors at the Monitor My Watershed/EnviroDIY data portal (http://monitormywatershed.org/)
 - Create a new PlatformIO project
@@ -45,7 +45,7 @@ _______
     - Move it into the src directory of your project.
     - Delete main.cpp in that folder.
 
-[//]: # ( @subsection example_drwi_lte_logger_id Set the logger ID )
+[//]: # ( @subsection example_drwi_digilte_logger_id Set the logger ID )
 ## Set the logger ID
 - Change the "XXXX" in this section of code to the loggerID assigned by Stroud:
 
@@ -54,7 +54,7 @@ _______
 const char *LoggerID = "XXXX";
 ```
 
-[//]: # ( @subsection example_drwi_lte_obs3_calibration Set the calibration coefficients for the Campbell OBS3+ )
+[//]: # ( @subsection example_drwi_digilte_obs3_calibration Set the calibration coefficients for the Campbell OBS3+ )
 ## Set the calibration coefficients for the Campbell OBS3+
 - The OBS3+ ships with a calibration certificate; you need this sheet!
 - Change _**all**_ of the the `0.000E+00` and `1.000E+00` values in this section of code to the values on that calibration sheet.
@@ -84,7 +84,7 @@ const float OBSHigh_C = 0.000E+00;  // "C" value [*high* range]
 CampbellOBS3 osb3high(OBS3Power, OBSHighADSChannel, OBSHigh_A, OBSHigh_B, OBSHigh_C, ADSi2c_addr, OBS3numberReadings);
 ```
 
-[//]: # ( @subsection example_drwi_lte_uuids Set the universally universal identifiers (UUID) for each variable )
+[//]: # ( @subsection example_drwi_digilte_uuids Set the universally universal identifiers (UUID) for each variable )
 ## Set the universally universal identifiers (UUID) for each variable
 - Go back to the web page for your site at the Monitor My Watershed/EnviroDIY data portal (http://monitormywatershed.org/)
 - Find and click the white "View Token UUID List" button above the small map on your site page
@@ -122,15 +122,15 @@ const char* samplingFeature = "12345678-abcd-1234-ef00-1234567890ab";  // Sampli
 
 ```
 
-[//]: # ( @subsection example_drwi_lte_upload Upload! )
+[//]: # ( @subsection example_drwi_digilte_upload Upload! )
 ## Upload!
 - Test everything at home **before** deploying out in the wild!
 
 _______
 
 
-[//]: # ( @section example_drwi_lte_pio_config PlatformIO Configuration )
+[//]: # ( @section example_drwi_digilte_pio_config PlatformIO Configuration )
 
-[//]: # ( @include{lineno} DRWI_LTE/platformio.ini )
+[//]: # ( @include{lineno} DRWI_DigiLTE/platformio.ini )
 
-[//]: # ( @section example_drwi_lte_code The Complete Code )
+[//]: # ( @section example_drwi_digilte_code The Complete Code )

examples/DRWI_DigiLTE/platformio.ini

@@ -9,7 +9,7 @@
 ; http://docs.platformio.org/page/projectconf.html
 
 [platformio]
-description = ModularSensors example intended for DRWI users with CTD, turbidity, and LTE signal
+description = ModularSensors example intended for DRWI users with CTD, turbidity, and a Digi brand LTE modem
 
 [env:mayfly]
 monitor_speed = 57600

examples/DRWI_NoCellular/DRWI_NoCellular.ino

@@ -3,7 +3,7 @@
  * @brief Example for DRWI CitSci without cellular service.
  *
  * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
- * @copyright (c) 2017-2020 Stroud Water Research Center (SWRC)
+ * @copyright (c) 2017-2021 Stroud Water Research Center (SWRC)
  *                          and the EnviroDIY Development Team
  *            This example is published under the BSD-3 license.
  *