Merge pull request #463 from EnviroDIY/develop

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'
@@ -34,7 +34,7 @@ jobs:
           python continuous_integration/generate_job_matrix.py
 
       - name: Store generated examples
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: generated_examples
           path: |
@@ -83,7 +83,7 @@ jobs:
         run: |
           echo "Pull Request from the fork ${{ github.event.pull_request.head.repo.full_name }} at ${{ github.event.pull_request.head.ref }}"
           echo "LIBRARY_INSTALL_ZIP=https://github.com/${{ github.event.pull_request.head.repo.full_name }}/archive/${{ github.event.pull_request.head.ref }}.zip" >> $GITHUB_ENV
-          echo "LIBRARY_INSTALL_GIT=https://github.com${{ github.event.pull_request.head.repo.full_name }}.git#${{ github.event.pull_request.head.ref }}" >> $GITHUB_ENV
+          echo "LIBRARY_INSTALL_GIT=https://github.com/${{ github.event.pull_request.head.repo.full_name }}.git#${{ github.event.pull_request.head.ref }}" >> $GITHUB_ENV
 
       - name: store enviroment variables as output
         id: store_vars
@@ -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: |
@@ -150,7 +150,7 @@ jobs:
           sh continuous_integration/install-test-version-arduino-cli.sh
 
       - name: Download the prepared examples
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: generated_examples
           path: |
@@ -179,7 +179,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: [generate_matrix, determine_library_source]
     env:
-      LIBRARY_INSTALL_GIT: ${{ needs.determine_library_source.outputs.library_install_zip }}
+      LIBRARY_INSTALL_GIT: ${{ needs.determine_library_source.outputs.library_install_git }}
     strategy:
       matrix:
         job_info: ${{ fromJSON(needs.generate_matrix.outputs.pio_job_matrix) }}
@@ -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: |
@@ -222,7 +222,7 @@ jobs:
           pio pkg install -g --library ${{ env.LIBRARY_INSTALL_GIT }}
 
       - name: Download the prepared examples
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: generated_examples
           path: |

.github/workflows/changelog_reminder.yaml

@@ -15,4 +15,4 @@ jobs:
           changelog_regex: '/CHANGELOG\/.*\/*.md'
           customPrMessage: 'Please add your changes to the change log!'
         env:
-          GITHUB_TOKEN: ${{ secrets.SARA_PUSH_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.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,6 @@ continuous_integration_artifacts/*
 arduino_cli.log
 **/sensor_tests/*
 docs/Doxyfile.bak
+continuous_integration/output_check_component_inclusion.log
+continuous_integration/platformio_ci_local.ini
+pioScripts/install_shared_deps.py

ChangeLog.md

@@ -17,11 +17,57 @@ 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.
+- Update GitHub actions
+- Remove date from copyright for easier tracking
+- Turn modem off at end of setup, regardless of time
+- Clean function to set file timestamp on SD card
+- Use equation rather than table for CSQ
+- Only polling modem for enabled parameters
+- INCREASED THE MAXIMUM NUMBER OF VARIABLES FROM A SINGLE SENSOR and implemented an option to set this by build flag.
+  - This will increase memory use for the entire library.
+If you are not using the GroPoint sensors which require many variables, I recommend you change this value via the build flag `-D MAX_NUMBER_VARS=8`
+- Allow all WiFi modems to first attempt to connect using existing on-modem saved credentials rather than immediately sending new credentials.
+- Add further debug printouts to the processor stats
+
+### 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)
+- Functions to enable and disable modem metadata polling by bitmask
+
+### Removed
+- Removed the (unused) sendOffset parameter from dataPublisherBase.
+
+### Fixed
+- Minor bug fixes for XBee Wifi
+- Handle no SIM card response from SIM7080G (EnviroDIY LTE Bee)
+- Fixed Keller debugging output.
+- Fixed file reference for SDFat 2.2.3
+
+### Known Issues
+- The modem hardware, firmware, and serial number is only implemented for the Digi XBee WiFi.
+
+## [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")