v0.35 release candidate: GroPoint Modbus; Xbee & Digi WiFi fixes; Prep for batch transmission

.github/workflows/build_documentation.yaml

@@ -39,11 +39,11 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.x'
 
-      # Using anwer from here to get the exit code and pass the output:  https://stackoverflow.com/questions/59191913/how-do-i-get-the-output-of-a-specific-step-in-github-actions
+      # Using answer from here to get the exit code and pass the output:  https://stackoverflow.com/questions/59191913/how-do-i-get-the-output-of-a-specific-step-in-github-actions
       - name: check for classes in the menu example
         id: check_component
         continue-on-error: true
@@ -89,12 +89,12 @@ jobs:
           path: code_docs/ModularSensors
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.x'
 
       - name: Restore Python Dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         id: cache_python
         with:
           path: ~/.cache/pip
@@ -107,7 +107,7 @@ jobs:
 
       - name: Restore Doxygen, Graphviz, and TeX Live
         id: cache_doxygen
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: |
             /usr/lib/x86_64-linux-gnu/texlive

.github/workflows/build_examples.yaml

@@ -20,7 +20,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.x'
           cache: 'pip'
@@ -126,7 +126,7 @@ jobs:
         uses: arduino/setup-arduino-cli@v1.1.2
 
       - name: Restore Arduino platforms and libraries
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         id: cache_libraries
         with:
           path: |
@@ -188,16 +188,16 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.x'
           cache: 'pip'
 
       - name: Install python dependencies, including PlatformIO
         run: pip install -r continuous_integration/requirements.txt
 
-      - name: Restore PlatformIO and Arduino platforms and libraries
-        uses: actions/cache@v3
+      - name: Restore PlatformIO platforms and libraries
+        uses: actions/cache@v4
         id: cache_libraries
         with:
           path: |

.github/workflows/prepare_release.yaml

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

.github/workflows/verify_library_structure.yaml

@@ -17,7 +17,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.x'
 

.gitignore

@@ -109,3 +109,4 @@ continuous_integration_artifacts/*
 arduino_cli.log
 **/sensor_tests/*
 docs/Doxyfile.bak
+continuous_integration/output_check_component_inclusion.log

ChangeLog.md

@@ -17,11 +17,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 
 ### Fixed
-- Fixed GitHub actions for pull requests from forks.
 
 ***
 
 
+## [0.35.0]
+
+### Changed
+- **BREAKING** Refactored how the publisher transmit buffer works. This will require adjustment to custom data publishers.
+
+### Added
+- Support [GroPoint Profile GPLP-8 Eight-Segment Soil Moisture and Temperature Profiling Probe](https://www.gropoint.com/products/soil-sensors/gropoint-profile)
+- Support [Vega Puls 21 Radar](https://www.vega.com/en-us/products/product-catalog/level/radar/vegapuls-21)
+
+## [0.34.1]
+
+### Changed
+- Incorporated improvements to the XBee Wifi - from [neilh10](https://github.com/EnviroDIY/ModularSensors/commits?author=neilh10)
+  - #347 -WiFi S6B stability - tears dwon TCP/IP before going to sleep, doesn't automatically poll for meta data
+
+### Added
+- Added the ability to enable or disable polling of modem attached variables.
+By default, all polling is off, but polling is enabled for a modem sensor when a sensor is created and attached to a modem.
+This functionailty is inspired from [neilh10](https://github.com/EnviroDIY/ModularSensors/commits?author=neilh10).
+
+### Fixed
+- Fixed GitHub actions for pull requests from forks.
+
 ## [0.34.0]
 
 ### Changed

LICENSE.md

@@ -1,6 +1,6 @@
 # Software License Agreement (BSD-3 License)
 
-**Copyright (c) 2010-2017, Stroud Water Research Center (SWRC) and the EnviroDIY Development Team.**
+**Copyright (c) 2010-2024, Stroud Water Research Center (SWRC) and the EnviroDIY Development Team.**
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

README.md

@@ -62,8 +62,9 @@ For some generalized information about attaching sensors to an Arduino style boa
 - [Decagon Devices ES-2: conductivity ](https://envirodiy.github.io/ModularSensors/group__sensor__es2.html)
 - [Decagon Devices CTD-10: conductivity, temperature & depth ](https://envirodiy.github.io/ModularSensors/group__sensor__decagon__ctd.html)
 - [Everlight ALS-PT19 Analog Light Sensor (via processor ADC)](https://envirodiy.github.io/ModularSensors/group__sensor__alspt19.html)
-- [Freescale Semiconductor MPL115A2: barometric pressure and temperature](https://envirodiy.github.io/ModularSensors/group__sensor__mpl115a2.html)
 - [External Arduino I2C Rain Tipping Bucket Counter: rainfall totals](https://envirodiy.github.io/ModularSensors/group__sensor__i2c__rain.html)
+- [Freescale Semiconductor MPL115A2: barometric pressure and temperature](https://envirodiy.github.io/ModularSensors/group__sensor__mpl115a2.html)
+- [GroPoint Profile GPLP-8 Eight-Segment Soil Moisture and Temperature Profiling Probe](https://envirodiy.github.io/ModularSensors/group__sensor__gplp8.html)
 - [In-Situ RDO PRO-X: dissolved oxygen](https://envirodiy.github.io/ModularSensors/group__sensor__insitu__rdo.html)
 - [In-Situ SDI-12 TROLLs: pressure, temperature, and depth](https://envirodiy.github.io/ModularSensors/group__sensor__insitu__troll.html)
 - [Keller Submersible Level Transmitters: pressure and temperature](https://envirodiy.github.io/ModularSensors/group__keller__group.html)
@@ -82,6 +83,7 @@ For some generalized information about attaching sensors to an Arduino style boa
 - [TI ADS1115: external voltage with support for divided current](https://envirodiy.github.io/ModularSensors/group__sensor__ads1x15.html)
 - [TI INA219: current, voltage, and power draw](https://envirodiy.github.io/ModularSensors/group__sensor__ina219.html)
 - [Turner Cyclops-7F: various parameters](https://envirodiy.github.io/ModularSensors/group__sensor__cyclops.html)
+- [Vega Puls 21: radar distance](https://envirodiy.github.io/ModularSensors/group__sensor__vega__puls21.html)
 - [Yosemitech: water quality sensors](https://envirodiy.github.io/ModularSensors/group__yosemitech__group.html)
     - [Y502-A or Y504-A: Optical DO and Temperature](https://envirodiy.github.io/ModularSensors/group__sensor__y504.html)
     - [Y510-B: Optical Turbidity and Temperature](https://envirodiy.github.io/ModularSensors/group__sensor__y510.html)

VERSION

@@ -1 +1 @@
-0.34.0
+0.35.0

continuous_integration/check_component_inclusion.py

@@ -65,7 +65,7 @@ def camel_to_snake(name, lower_case=True):
 
 #%%
 # make sure class names match file names
-class_pattern = re.compile("^\s*class[\s\n]+(\w+)[\s\n]", re.MULTILINE)
+class_pattern = re.compile(r"^\s*class[\s\n]+(\w+)[\s\n]", re.MULTILINE)
 
 for header_file in header_files:
     textfile = open(header_file, mode="r", encoding="utf-8")

continuous_integration/dependencies.json

@@ -1,5 +1,5 @@
 {
-  "action_cache_version": 16,
+  "action_cache_version": 17,
   "dependencies": [
     {
       "name": "EnviroDIY_DS3231",
@@ -57,7 +57,7 @@
     {
       "name": "TinyGSM",
       "owner": "vshymanskyy",
-      "version": "~0.11.5",
+      "version": "~0.11.7",
       "note": "A small Arduino library for GPRS modules.",
       "authors": [
         "Volodymyr Shymanskyy",
@@ -95,7 +95,7 @@
       "owner": "adafruit",
       "library id": "31",
       "url": "https://github.com/adafruit/Adafruit_Sensor",
-      "version": "~1.1.9",
+      "version": "~1.1.13",
       "note": "Adafruit's unified sensor library is used by their other libraries",
       "authors": [
         "Adafruit"
@@ -195,7 +195,7 @@
       "owner": "adafruit",
       "library id": "11710",
       "url": "https://github.com/adafruit/Adafruit_SHT4X",
-      "version": "~1.0.2",
+      "version": "~1.0.4",
       "note": "Sensirion SHT4x Library by Adafruit",
       "authors": [
         "Adafruit"
@@ -321,6 +321,16 @@
       ],
       "frameworks": "arduino",
       "platforms": "atmelavr, atmelsam"
+    },
+    {
+      "name": "GroPointModbus",
+      "owner": "envirodiy",
+      "url": "https://github.com/EnviroDIY/GroPointModbus.git",
+      "version": "~0.1.0",
+      "note": "A library to use an Arduino as a master to control and communicate via modbus with GroPoint soil moisture sensors. ",
+      "authors": ["Anthony Aufdenkampe"],
+      "frameworks": "arduino",
+      "platforms": "atmelavr, atmelsam"
     }
   ]
 }

continuous_integration/generate_job_matrix.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-#%%
+# %%
 import json
 import shutil
 import re
@@ -9,7 +9,7 @@
 import os
 import copy
 
-#%%
+# %%
 # Some working directories
 # The workspace directory
 if "GITHUB_WORKSPACE" in os.environ.keys():
@@ -37,7 +37,7 @@
     os.makedirs(artifact_dir)
 
 compilers = ["Arduino CLI", "PlatformIO"]
-#%%
+# %%
 # The locations of some important files
 
 # The massive "menu" example
@@ -72,6 +72,8 @@
     "megaatmega2560": {"fqbn": "arduino:avr:mega"},
     "zeroUSB": {"fqbn": "arduino:samd:mzero_bl"},
     "adafruit_feather_m0": {"fqbn": "adafruit:samd:adafruit_feather_m0"},
+    "adafruit_feather_m4": {"fqbn": "adafruit:samd:adafruit_feather_m4"},
+    "adafruit_grandcentral_m4": {"fqbn": "adafruit:samd:adafruit_grandcentral_m4"},
 }
 
 
@@ -183,14 +185,14 @@ def snake_to_camel(snake_str):
         return camel_str
 
 
-#%%
+# %%
 # set up outputs
 arduino_job_matrix = []
 pio_job_matrix = []
 start_job_commands = "status=0"
 end_job_commands = "\n\nexit $status"
 
-#%%
+# %%
 # Create job info for the basic examples
 # Use one job per board with one command per example
 for pio_env in pio_config.envs():
@@ -234,7 +236,7 @@ def snake_to_camel(snake_str):
     )
 
 
-#%%
+# %%
 # Helper functions for preparing the menu-a-la-carte example for building
 def modify_example_filename(example_subfolder, in_file_defines):
 
@@ -309,7 +311,7 @@ def extend_pio_config(added_envs):
     return new_config_path
 
 
-#%% read build flags out of the menu-a-la-cart example
+# %% read build flags out of the menu-a-la-cart example
 # Pattern for flags in the menu-a-la-cart example
 pattern = re.compile(
     "^(?:#if|#elif) defined[\s\(](?P<flag1>BUILD_\w+)((?:[\s\n\\\)]*?\|\|[\s\n\\]*defined[\s\n\\\(]*?)(?P<flag_last>BUILD_\w+))*",
@@ -350,7 +352,7 @@ def extend_pio_config(added_envs):
         all_publisher_flags.append(match.group("flag1"))
 
 
-#%%
+# %%
 # Create jobs for all of the modems together
 for pio_env in pio_config.envs():
     arduino_modem_commands = [
@@ -396,7 +398,7 @@ def extend_pio_config(added_envs):
         }
     )
 
-#%%
+# %%
 # Create jobs for all of the publishers together
 for pio_env in pio_config.envs():
     arduino_pub_commands = [
@@ -442,7 +444,7 @@ def extend_pio_config(added_envs):
         }
     )
 
-#%%
+# %%
 # Create jobs for all of the sensors together
 # The sensors are a bit different because we run extra PlatformIO enviroments for some of the sensors
 for pio_env in pio_config.envs():
@@ -540,7 +542,7 @@ def extend_pio_config(added_envs):
         }
     )
 
-#%%
+# %%
 # Tack on a few extra build configurations for the menu example
 for pio_env in pio_config.envs():
     arduino_loop_commands = [
@@ -596,7 +598,7 @@ def extend_pio_config(added_envs):
         }
     )
 
-#%%
+# %%
 # Tack on a few more extra build configurations for the software serial libraries
 for pio_env in ["Mayfly"]:
     arduino_serial_commands = [
@@ -654,7 +656,7 @@ def extend_pio_config(added_envs):
     )
 
 
-#%%
+# %%
 # Convert commands in the matrix into bash scripts
 for matrix_job in arduino_job_matrix + pio_job_matrix:
     bash_file_name = matrix_job["job_name"].replace(" ", "") + ".sh"
@@ -676,7 +678,7 @@ def extend_pio_config(added_envs):
         del items["command"]
 
 
-#%%
+# %%
 # Write out output
 print(
     'echo "arduino_job_matrix={}" >> $GITHUB_OUTPUT'.format(
@@ -694,14 +696,14 @@ def extend_pio_config(added_envs):
 json_out.close()
 
 
-#%%
+# %%
 # different attempt to save output
 with open(os.environ["GITHUB_OUTPUT"], "a") as fh:
     print("arduino_job_matrix={}".format(json.dumps(arduino_job_matrix)), file=fh)
     print("pio_job_matrix={}".format(json.dumps(pio_job_matrix)), file=fh)
 
 
-#%%
+# %%
 if "GITHUB_WORKSPACE" not in os.environ.keys():
     try:
         shutil.rmtree(artifact_dir)

continuous_integration/install-deps-arduino-cli.sh

@@ -132,6 +132,9 @@ arduino-cli --config-file continuous_integration/arduino_cli.yaml lib install Ke
 echo "\n\e[32mInstalling EnviroDIY YosemitechModbus library from Arduino library index\e[0m"
 arduino-cli --config-file continuous_integration/arduino_cli.yaml lib install YosemitechModbus
 
+echo "\n\e[32mInstalling EnviroDIY GropointModbus library from Arduino library index\e[0m"
+arduino-cli --config-file continuous_integration/arduino_cli.yaml lib install GropointModbus
+
 echo "\n\e[32mInstalling StreamDebugger library from Arduino library index\e[0m"
 arduino-cli --config-file continuous_integration/arduino_cli.yaml lib install StreamDebugger
 

continuous_integration/install-deps-platformio.sh

@@ -107,6 +107,9 @@ pio pkg install -g --library envirodiy/KellerModbus
 echo "\e[32mInstalling envirodiy/YosemitechModbus\e[0m"
 pio pkg install -g --library envirodiy/YosemitechModbus
 
+echo "\e[32mInstalling envirodiy/GroPointModbus\e[0m"
+pio pkg install -g --library envirodiy/GroPointModbus
+
 echo "\e[32mInstalling vshymanskyy/StreamDebugger\e[0m"
 pio pkg install -g --library vshymanskyy/StreamDebugger