diff --git a/.github/workflows/build_examples.yaml b/.github/workflows/build_examples.yaml index 78921a6a8..a459e8908 100644 --- a/.github/workflows/build_examples.yaml +++ b/.github/workflows/build_examples.yaml @@ -123,7 +123,7 @@ jobs: # We use the `arduino/setup-arduino-cli` action to install and # configure the Arduino CLI on the system. - name: Setup Arduino CLI - uses: arduino/setup-arduino-cli@v1.1.1 + uses: arduino/setup-arduino-cli@v1.1.2 - name: Restore Arduino platforms and libraries uses: actions/cache@v3 diff --git a/examples/DRWI_2G/ReadMe.md b/examples/DRWI_2G/ReadMe.md index 80beb5146..38ad72709 100644 --- a/examples/DRWI_2G/ReadMe.md +++ b/examples/DRWI_2G/ReadMe.md @@ -1,10 +1,13 @@ # DRWI 2G 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 2G service. +This code was used for DRWI monitoring stations in 2016-2022. The 2G GPRSbee cellular boards no longer function in the USA, so this code should not be used and is only provided to archival and reference purposes. + +The exact hardware configuration used in this example: + * Mayfly v0.5b board + * SODAQ GPRSbee 2G cell module (with Hologram SIM card) + * Hydros21 CTD sensor + * Campbell OBS3+ turbidity sensor -Before programming your board with this example, you must register your site and sensors at http://data.envirodiy.org/. -Stroud can provide directions for registering your site if you need assistance. _______ diff --git a/examples/DRWI_DigiLTE/ReadMe.md b/examples/DRWI_DigiLTE/ReadMe.md index 50cae9dfa..f7393cd92 100644 --- a/examples/DRWI_DigiLTE/ReadMe.md +++ b/examples/DRWI_DigiLTE/ReadMe.md @@ -1,10 +1,13 @@ # 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. +This example uses the sensors and equipment common to older stations (2016-2020) deployed by groups participating in the DRWI Citizen Science project with the Stroud Water Research Center. It includes a Meter Hydros21 CTD (formerly know as a Decagon), a Campbell OBS3+ (Turbidity), and a Digi XBee3 LTE-M cellular board for communication. The Digi LTE module also required the use of a EnviroDIY LTEbee Adapter board (discontinued in 2021). The Digi LTE modules are no longer recommended for use and have been replace by the EnviroDIY LTEbee in all DRWI-SWRC-managed stations. + +The exact hardware configuration used in this example: + * Mayfly v0.5b board + * Digi Xbee LTE module (with Hologram SIM card and EnviroDIY bee adapter) + * Hydros21 CTD sensor + * Campbell OBS3+ turbidity sensor -Before programming your board with this example, you must register your site and sensors at http://data.envirodiy.org/. -Stroud can provide directions for registering your site if you need assistance. _______ diff --git a/examples/DRWI_Mayfly1/ReadMe.md b/examples/DRWI_Mayfly1/ReadMe.md index 3dc22cae4..6afa25eed 100644 --- a/examples/DRWI_Mayfly1/ReadMe.md +++ b/examples/DRWI_Mayfly1/ReadMe.md @@ -1,8 +1,10 @@ # DRWI Sites with a Mayfly 1.x and EnviroDIY LTE Bees Example sketch for using the EnviroDIY SIM7080G LTE cellular module with an EnviroDIY Mayfly Data Logger. +This example uses the sensors and equipment used by most groups participating in the DRWI (Delaware River Watershed Initiative) Citizen Science project with the Stroud Water Research Center. It includes a Meter Hydros 21 (CTD) and a SIM7080G-based EnviroDIY LTEbee for communication. This examples also makes use of the on-board light, temperature, and humidity sensors on the Mayfly 1.x. The results are saved to the SD card and posted to the Monitor My Watershed data portal. Only to be used with newer Mayfly v1.0 and v1.1 boards. + The exact hardware configuration used in this example: - * Mayfly v1.1 board + * Mayfly v1.x board * EnviroDIY SIM7080 LTE module (with Hologram SIM card) * Hydros21 CTD sensor @@ -15,6 +17,7 @@ The EnviroDIY LTE SIM7080 module includes 2 antennas in the package. The small The included cell antenna works best in high-signal-strength areas. For most remote areas and logger deployments, we suggest a larger LTE antenna, like the W3907B0100 from PulseLarsen (Digikey 1837-1003-ND or Mouser 673-W3907B0100) +Users purchasing a new Hydros21 CTD sensor will need to change the SDI-12 address of the sensor in order to use this sketch. Full instructions for using this sketch as part of a monitoring station can be found in the EnviroDIY Monitoring Station Manual. _______ [//]: # ( @tableofcontents ) diff --git a/examples/DRWI_Mayfly1_WiFi/ReadMe.md b/examples/DRWI_Mayfly1_WiFi/ReadMe.md index b870bba2f..511a36e48 100644 --- a/examples/DRWI_Mayfly1_WiFi/ReadMe.md +++ b/examples/DRWI_Mayfly1_WiFi/ReadMe.md @@ -6,12 +6,14 @@ The exact hardware configuration used in this example: * EnviroDIY ESP32 WiFi module * Hydros21 CTD sensor -An EnviroDIY ESP32 WiFi module can be used with the older Mayfly v0.5b boards if you change line 101 (for modemVccPin) from 18 to -1. +An EnviroDIY ESP32 WiFi module can also be used with the older Mayfly v0.5b boards if you change line 95 (for modemVccPin) from 18 to -1. This is because the Mayfly v1.x board has a separate 3.3v regulator to power the Bee socket and is controlled by turning pin 18 on or off. -Mayfly v0.5b has the Bee socket constantly powered, therefore using "-1" is the proper setting for that line of code. +Mayfly v0.5b has the Bee socket constantly powered, therefore using "-1" is the proper setting for that line of code. Leave the modemVccPin as 18 for Mayfly version 1.0 and 1.1. The WiFi antenna is built into the ESP32 Bee - no external antenna is needed +Be sure to edit lines 101 and 102 to enter your Wifi access point name and password, and edit the UUID section beginning at line 200 with the correct UUIDs from your specific site on MonitorMyWatershed. + _______ [//]: # ( @tableofcontents ) diff --git a/examples/DRWI_NoCellular/ReadMe.md b/examples/DRWI_NoCellular/ReadMe.md index 5905fbbcd..1ebd61948 100644 --- a/examples/DRWI_NoCellular/ReadMe.md +++ b/examples/DRWI_NoCellular/ReadMe.md @@ -3,6 +3,12 @@ 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 example should be used in cases where no cellular service of any kind is available and the data will only be logged on the SD card. +The exact hardware configuration used in this example: + * Mayfly v1.x board + * Hydros21 CTD sensor + * Campbell OBS3+ turbidity sensor + + Before using this example, you must register a site and sensors at the data portal (http://data.envirodiy.org/). After you have registered the site and sensors, the portal will generate a registration token and universally unique identifier (UUID) for each site and further UUID's for each variable. You will need to copy all of those UUID values into your sketch to replace the `12345678-abcd-1234-ef00-1234567890ab` place holders in this example. diff --git a/examples/DRWI_SIM7080LTE/ReadMe.md b/examples/DRWI_SIM7080LTE/ReadMe.md index 0f9e164c2..2b3e0237f 100644 --- a/examples/DRWI_SIM7080LTE/ReadMe.md +++ b/examples/DRWI_SIM7080LTE/ReadMe.md @@ -1,8 +1,9 @@ # DRWI Sites with EnviroDIY LTE Bees -Example sketch for using the EnviroDIY SIM7080G LTE cellular module with an EnviroDIY Mayfly Data Logger. + +The DRWI EnviroDIY LTEbee example uses the sensors and equipment common to older stations (2016-2020) deployed by groups participating in the DRWI Citizen Science project with the Stroud Water Research Center. It includes a Meter Hydros 21 (CTD), a Campbell OBS3+, (Turbidity) and a SIM7080G-based EnviroDIY LTEbee for communication. The exact hardware configuration used in this example: - * Mayfly v1.0 board + * Mayfly v1.x board * EnviroDIY SIM7080 LTE module (with Hologram SIM card) * Hydros21 CTD sensor * Campbell Scientific OBS3+ Turbidity sensor diff --git a/examples/ReadMe.md b/examples/ReadMe.md index 40f283178..59808ebe4 100644 --- a/examples/ReadMe.md +++ b/examples/ReadMe.md @@ -120,30 +120,30 @@ ___ ### DRWI Mayfly 1.x LTE -The DRWI Mayfly 1.x LTE example uses the sensors and equipment standard groups participating in the DRWI Citizen Science project with the Stroud Water Research Center. -It includes a Meter Hydros 21 and a SIM7080G-based EnviroDIY Bee for communication. +The DRWI Mayfly 1.x LTE example uses the sensors and equipment used by most groups participating in the DRWI (Delaware River Watershed Initiative) Citizen Science project with the Stroud Water Research Center. +It includes a Meter Hydros 21 (CTD) and a SIM7080G-based EnviroDIY LTEbee for communication. This examples also makes use of the on-board light, temperature, and humidity sensors on the Mayfly 1.x. -The results are saved to the SD card and posted to the Monitor My Watershed data portal. +The results are saved to the SD card and posted to the Monitor My Watershed data portal. Only to be used with newer Mayfly v1.0 and v1.1 boards. - [Instructions for the Mayfly 1.x LTE DRWI Citizen Science example](https://envirodiy.github.io/ModularSensors/example_drwi_mayfly1.html) - [The LTEG DRWI Citizen Science example on GitHub](https://github.com/EnviroDIY/ModularSensors/tree/master/examples/DRWI_Mayfly1) -### DRWI EnviroDIY Bee LTE +### DRWI EnviroDIY LTEbee -The DRWI EnviroDIY Bee LTE example uses the sensors and equipment standard groups participating in the DRWI Citizen Science project with the Stroud Water Research Center. -It includes a Meter Hydros 21, a Campbell OBS3+, and a SIM7080G-based EnviroDIY Bee for communication. +The DRWI EnviroDIY LTEbee example uses the sensors and equipment common to older stations (2016-2020) deployed by groups participating in the DRWI Citizen Science project with the Stroud Water Research Center. +It includes a Meter Hydros 21 (CTD), a Campbell OBS3+, (Turbidity) and a SIM7080G-based EnviroDIY LTEbee for communication. The results are saved to the SD card and posted to the Monitor My Watershed data portal. -The only difference between this and the other cellular DRWI examples is the type of modem used. +The only difference between this and the other cellular DRWI examples below is the type of modem used. -- [Instructions for the EnviroDIY LTE DRWI Citizen Science example](https://envirodiy.github.io/ModularSensors/example_drwi_ediylte.html) +- [Instructions for the EnviroDIY LTEbee DRWI Citizen Science example](https://envirodiy.github.io/ModularSensors/example_drwi_ediylte.html) - [The EnviroDIY LTE DRWI Citizen Science example on GitHub](https://github.com/EnviroDIY/ModularSensors/tree/master/examples/DRWI_DigiLTE) ### DRWI Digi LTE -The DRWI Digi LTE example uses the sensors and equipment standard groups participating in the DRWI Citizen Science project with the Stroud Water Research Center. +The DRWI Digi LTE example uses the sensors and equipment common to older stations (2016-2020) deployed by groups participating in the DRWI Citizen Science project with the Stroud Water Research Center. It includes a Meter Hydros 21 (formerly know as a Decagon CTD), a Campbell OBS3+, and a Digi XBee3 LTE-M for communication. The results are saved to the SD card and posted to the Monitor My Watershed data portal. -The only difference between this and the other cellular DRWI examples is the type of modem used. +The only difference between this and the other cellular DRWI examples is the type of modem used. - [Instructions for the Digi LTE DRWI Citizen Science example](https://envirodiy.github.io/ModularSensors/example_drwi_digilte.html) - [The Digi LTE DRWI Citizen Science example on GitHub](https://github.com/EnviroDIY/ModularSensors/tree/master/examples/DRWI_DigiLTE) @@ -151,7 +151,7 @@ The only difference between this and the other cellular DRWI examples is the typ ### DRWI CitSci (2G) -The 2G DRWI Citizen Science example uses the sensors and equipment standard groups participating in the DRWI Citizen Science project with the Stroud Water Research Center. +The 2G DRWI Citizen Science example uses the sensors and equipment found on older stations used in the DRWI Citizen Science project prior to 2020. The 2G GPRSbee boards no longer function in the USA, so this code should not be used and is only provided to archival and reference purposes. It includes a Meter Hydros 21 (formerly know as a Decagon CTD), a Campbell OBS3+, and a Sodaq GPRSBee for communication. The results are saved to the SD card and posted to the Monitor My Watershed data portal. The only difference between this and the other cellular DRWI examples is the type of modem used. @@ -162,7 +162,8 @@ The only difference between this and the other cellular DRWI examples is the typ ### DRWI CitSci No Cellular -The DRWI no cellular example uses the sensors and equipment standard to the DRWI Citizen Science grant but omits the data publisher for circumstances where there is no cellular signal. +The DRWI no cellular example uses the sensors and equipment standard to the DRWI Citizen Science project but omits the data publisher for circumstances where there is no cellular signal. +It includes a Meter Hydros 21 (CTD) and a Campbell OBS3+ (Turbidity). The exclusion of the modem and publisher simplifies the code from the other DRWI examples and uses less power than running one of cellular versions without attaching the modem. - [Instructions for the no-cellular DRWI Citizen Science example](https://envirodiy.github.io/ModularSensors/example_drwi_no_cell.html)