All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
v0.28.3 (2021-03-24) Valid version number
ModularSensors_Dependencies_v0.28.3.zip
- contains this version of ModularSensors and the proper versions of all of its dependencies.
- Use a valid semantic version number
v0.28.01 (2021-02-10) Gigantic SDI-12 bug
ModularSensors_Dependencies_v0.28.01.zip
- contains this version of ModularSensors and the proper versions of all of its dependencies.
- Fixes an EGREGIOUS error in the SDI-12 code causing the code to lock up if debugging was off (but always work with it on)
- Issue #346
- This was first introduced in 0.27.5
- Fix GitHub action for pull requests.
- Add support for all standard configurations of the Turner Cyclops-7F submersible fluorometer
- Fix some minor Doxygen warnings
- Small grammar fixes
- Changes in the EnviroDIY fork of m.css:
- Added extra navigation hints to classes leading back to the containing module
- Correctly included script for the to-top element
v0.27.8 (2021-01-19) Fix GitHub Action
ModularSensors_Dependencies_v0.27.8.zip contains this version of ModularSensors and the proper versions of all of its dependencies.
- Just fixes an error in the github action to post a release
v0.27.7 (2021-01-19) SDI-12 Bug Fix
- Fixed a compiler error for non-concurrent SDI-12 sensors.
v0.27.6 (2021-01-19) Update Documentation
- Update instructions for examples
- Update developer instructions
v0.27.5 (2020-12-15) Multiple new Sensors and Workflows
ModularSensors_Dependencies_0.27.5.zip contains this version of ModularSensors and the proper versions of all of its dependencies.
- PaleoTerra Redox sensors
- Northern Widget Tally Counters
- simple analog electrical conductance sensors
- InSitu RDO PRO-X rugged dissolved oxygen sensors
- Add Soracom/Ubidots as a data publisher
- Migrated from Travis CI to Github Actions for continuous integration
- Deprecated wiki, moving contents to docs folder where needed
- Add static variable for marked time in UTC
- Add user name and password for GSM/SIM for XBee Cellular
- Support software I2C or secondary hardware I2C for all sensors possible
- Complete re-styling of the Doxygen output to be similar to envirodiy.org
- Add enourmous amounts of documentation
- Improved explanations and added walkthrough of menu a la carte example
- Added example calculating specific conductance where applicable
- For SDI-12 sensors, added calls to additional data commands (D1-D9) if full number of expected results are not returned by D0.
- For SDI-12 sensors, added ability to disable concurrent measurements using the build flag
MS_SDI12_NON_CONCURRENT.- NOTE: Setting the build flag disables concurrent measurements for ALL SDI-12 sensors!
- The instructions for using most of the examples is out of date.
libraries_v0.25.0.zip contains this version of ModularSensors and the proper versions of all of its dependencies.
- Automated code documentation using Doxygen, now available at https://envirodiy.github.io/ModularSensors/
- Improved C++ code styling elements in every file in the library, to:
- Better take advantage of the Clang compiler and code error linter tool;
- Generally follow Clang Format and Google's coding style guides used with cpplint linter, which:
- includes massive white space changes to improve readability while not changing how the code is executed
- Support Doxygen documentation.
- Encapsulated modem wake check logic into a function and checking for status using a quick AT ping if no other option is available.
- This will only affect modems/breakouts that depend on a pulse on their wake pin to turn on or off but for whatever reason don't have a separate status pin connected to the mcu. I do not recommend this configuration.
- Always re-set the pin mode of a sensor power pin before attempting to turn it on.
- This could come into play when first attempting to power on a sensor before the initial setup if the pin mode on the sensor power pin was set to input by whatever program the mcu had run prior to running ModularSensors code.
- Fixed issue where the Digi XBee LTE-M modem did not wake during normal logging mode to transmit data to the publisher. See EnviroDIY#309 (comment)
For more details, see Pull Request #309: The style sheet
libraries_v0.24.1.zip contains this version of ModularSensors and the proper versions of all of its dependencies.
Restructured modem so that it no longer operates as a sensor. Variables tied to the modem are now effectively calculated variables and all values from the modem will be offset by 1 sending cycle (ie, the signal strength posted will always be the strength from the prior send, not the current one).
libraries_v0.23.13.zip contains this version of ModularSensors and the proper versions of all of its dependencies.
- Much more aggressive attempts to set the clock if the time is not reasonable - before 01Sep2019 or after 01Jan2025.
- The LED will flicker and warnings will be sent over the serial port for invalid times at every check.
- The logDataAndPublish function will attempt to synchronize the clock at every measurement until a valid time is received.
- The NIST sync will attempt to open the socket to the daytime server up to 12 times trying to get a valid response.
- Using automatic network technology and carrier profile for Digi LTE-M XBee3's - with the current firmware there is not a significant time savings in manually selecting the carrier and manually selecting the carrier gives no options when the relative signal strength of the carriers changes.
libraries_v0.23.11.zip contains this version of ModularSensors and the proper versions of all of its dependencies.
In your the Arduino Software (IDE), import the libraries.zip file following the instructions for "Manual Installation" from https://www.arduino.cc/en/Guide/Libraries#toc5. You cannot directly import the zip using the Arduino Library Manager because it contains multiple libraries.
Extract the contents of libraries.zip to your project's 'lib' folder.
- A watch-dog timer has been implemented for both the AVR and SAMD21 (and 51) boards to restart the boards in case of failure during logging
- The watch-dog is turned off during sleep to save power, so recovery is only possible if the failure is while the processor is awake.
- Added support for Meter Terros 11 soil moisture and temperature sensor
- Implemented a function to verify that UUID's are at least correctly formed and unique - though it does not verify that they are valid.
- Pushing to the master branch of this repo will now also cause a re-run of the travis script that updates the EnviroDIY "Libraries" repository.
- Added debugging variables to modems to track how long they are powered/active.
- Added extra compile tests in the menu a la carte example.
- Improvements made to nearly all modem modules
- Restore XBee access to resets by TinyGSM
- Fixed all compiler warnings seen with the -Wextra flag (mostly by adding technically-unnecessary-but-visually-helpful braces)
- Fixed issue with creating a calculated variable without a UUID
- polling the AM2315 more frequently than every 2 seconds will now return a bad value (-9999) rather than returning the same value multiple times. This is a reflection of a change in the Adafruit library. The measurement time set for the sensor has always been this long so this issue should never be seen unless you attempt to call get measurement results from the AM2315 without first waiting for the measurement completion. The update function and all variable array functions should behave properly.
- All code must be updated to the current format for modems and time zones to work with this version of the library.
libraries.zip contains this version of ModularSensors and the proper versions of all of its dependencies.
In your the Arduino Software (IDE), import the libraries.zip file following the instructions for "Manual Installation" from https://www.arduino.cc/en/Guide/Libraries#toc5. You cannot directly import the zip using the Arduino Library Manager because it contains multiple libraries.
Extract the contents of libraries.zip to your project's 'lib' folder.
- LoggerModem has become a parent class. All modems now exist as separate subclass objects.
- This should greatly simplify creating a modem object in code.
- Currently supported modems:
- Digi XBee and XBee3 cellular modems of all types running in transparent mode
- Digi XBee3 cellular LTE-M modems in bypass mode (this is in addition to transparent mode)
- Digi XBee cellular 3G global modems in bypass mode (this is in addition to transparent mode)
- Digi XBee Wifi S6B modules
- Sodaq UBee LTE-M (SARA R410M)
- Sodaq UBee 3G (SARA U201)
- Sodaq 2GBee R6/R7
- Sodaq 2GBee R4, Adafruit Fona, and other SIMComm SIM800 modules
- Botletics and other SIMCom SIM7000 modules
- Dragino, Nimbelink, and other Quectel BG96 modules
- Nimbelink LTE-M Verizon
- Espressif ESP8266 based modules
- The older way of creating a modem object and feeding it wake/sleep functions is no longer supported.
- The real time clock's timezone can now be explicit set (as opposed to setting the logger timezone and the offset between the RTC and the logger)
- The function to set the logger timezone has been renamed from setTimeZone to setLoggerTimeZone.
- Daily clock synchronization has been moved from midnight to noon. For loggers with solar charging, this should place the extra draw of the modem to do the synchronization to a time of peak charging.
- All "send" data functions have been renamed to "publish" to line up with module names.
- Updated AM2315 to use most current Adafruit library (2.0.0)
- Fixed #259 where time zones offset by more than 9 hours from UTC would not work correctly.
- Fixed #183 where enabling debugging would cause non AVR boards to crash.
- Adjusted some timing parameters for the SIM800 based on testing.
- polling the AM2315 more frequently than every 2 seconds will now return a bad value (-9999) rather than returning the same value multiple times. This is a reflection of a change in the Adafruit library. The measurement time set for the sensor has always been this long so this issue should never be seen unless you attempt to call get measurement results from the AM2315 without first waiting for the measurement completion. The update function and all variable array functions should behave properly.
libraries.zip contains this version of ModularSensors and the proper versions of all of its dependencies.
In your the Arduino Software (IDE), import the libraries.zip file following the instructions for "Manual Installation" from https://www.arduino.cc/en/Guide/Libraries#toc5. You cannot directly import the zip using the Arduino Library Manager because it contains multiple libraries.
Extract the contents of libraries.zip to your project's 'lib' folder.
- Fixed minor bug in debugging created in previous release
- Gave every header file a unique debugging define statement so each file can be debugged individually by building with the build flag -DMS_xxx_DEBUG where xxx is the file name in upper case.
- Some files also have a "deep" debugging option with -DMS_xxx_DEBUG_DEEP
- Created examples for LearnEnviroDIYCode
- Fixed a bug causing modem to not be turned because the processor thought it was on already
- Corrected warm-up timing for Yosemitech Sonde
- Typo fixes in comments
- Fixed bug intoduced in 0.21.0 preventing writing to SD card - file must be closed (not sync'ed)
- Added full support for all Atlas Scientific EZO curcuits and sensors that support I2C
- CO2
- DO (dissolved oxygen)
- EC (conductivity)
- ORP (oxidation/reduction potential)
- pH
- RTD (temperature
- Created empty constructors for the logger, publisher, variable array, and variable classes and all of their subclasses. For all classes created a corresponding "begin" function to set internal class object values.
- See note for more details: https://github.com/EnviroDIY/ModularSensors/commit/b1a619ed74bc790743bce35b3a4e78a2d2237b22
- The order of input arguments for all variable objects has changed. For variable subclasses (ie, variables from sensors), there is no change to the user. For calculated variable objects, all code must be updated! Please check the structure in the examples! Older code will compile without error but the variable metadata fields will be incorrectly populated.
- Very preliminary support for SD cards with switchable power
- Eliminated any time-out waits on libraries using the Wire class
- Simplified the logger begin function - the removed functionality should be called in individual program setup functions
- Removed clock sync
- Removed logger file creation
- Removed sensor setup
- Moved the check for setup from the wake function to the startSingleMeasurement function for all sensors
- Previously, the first time the wake was called for a function, the status bit for setup was checked and if the sensor had not been setup, the setup function was called. This will no longer happen the first time the wake function is called, but instead the first time the startSingleMeasurement function is called. The main motivator for the change was the modem which could end up behaving strangely because the setup function actually called the wake function internally.
- Improved example coding for SARA R410 cellular modules
- Fixed call to a null pointer causing the array's completeUpdate to crash with calculated variables
- Fixed source of ADS1x15 dependency
- Removed "default" wake/sleep functions from modem. These were non-working skeleton functions.
- Running some I2C sensors on switched power will cause unrecoverable hangs at the first call to any other I2C peripheral (ie, the DS3231 RTC) after sensor power is turned off. This is a hardware problem and is un-fixable within this library.
- The sensor class and all of its subclasses still require input arguments in the constructor.
- Added ADS1015 as an optional analog to digital converter (ADC) for boards other than the Mayfly
- Modem waits for signal strength return before sending data
- Other modem tweaks
- Restructuring of data publishers
- Fixed bug with ADS1115 for M0/SAM21
- Re-works the examples to remove duplication between them.
- Fixes bug in sending data to the WikiWatershed / Monitor My Watershed data sharing portal.
- Added ThingSpeak support via MQTT (PubSubClient is now a required dependency)
- Added support for TI INA219 thanks to @neilh21 (Adafruit INA219 library is now a required dependency)
- Reduced telemetry data consumption (by half in one test) and therefore overall power use, by creating an outgoing text buffer.
- Note : the default buffer size is quite large, decrease it to decrease program memory size.
- Refactored data publishers as a new class rather than subclasses of loggers
- Improved power management.
- Improved stability.
- A huge number of other changes, with most of them are documented here: EnviroDIY#173
- All
.inosketch files will need to be updated to follow the updated examples. - All library dependencies will need to be updated to match versions in the library.json file.
- Implemented real calculated variables, from PR #153, closing issue #127 (Create generic calculated variables).
- Fixes issue with MaxSonar giving weird readings, due to buffer not being cleared between readings, as described in https://www.envirodiy.org/topic/minor-glitch-reading-maxbotix-mb7389-with-mayfly/
See PR #160 for a full list of improvements and fixes.
NOTE: This THIS RELEASE DESTROYS BACKWARDS COMPATIBILITY!! All .ino files will need to be updated to follow the updated examples.
-
Fixed variable type for logging interval from uint8_t to uint16_t allowing consistent logging at intervals greater than 5 minutes
-
Improved documentation for examples
-
Applying "sensor testing mode" more consistently in examples
-
Made variables necessary for sensor testing mode with custom loops public
New sensors:
- Added support for Freescale MPL115A2 pressure sensor
- Added support for Keller Acculevel
- Added support for Yosemitech Y4000 multi-parameter sonde
- Added support for a generic "voltage" measurement on an ADS1115 with and without a voltage divider
- Added support for an external rain tipping bucket counter deployed using the EnviroDIY TippingBucketRainGauge library and communicating with the main logger via I2C
New examples and documentation:
- Added some helpful details on the default I2C addresses of several sensors
- Expanded explanations of sensor and variable terminology in ReadMe
- Added 2 new examples of creating a calculated variable from those variables directly measured by multiple sensors
- Minor corrections to Yosemitech sensor resolution and accuracy.
Bug Fixes and other Tweeks:
- Fixed major bug causing sensors with long stabilization times to not be updated
- Tweeked code generating csv's and json outputs to allow a modified csv or json to be written to the SD card or posted to data.EnviroDIY.org
- Removed the "checkForUpdate()" function. When asking for a value from a variable, you now must explicitly state whether you want the variable to ask its parent sensor for an updated value or not. By default, it will not ask the parent sensor to update, but only return the last value received or -9999 if a value has never been received.
Major restructuring of sensor status and internal sensor time stamps to improve efficiency when using variables/sensors in arrays - this makes sensor/variable order much less important
Restructured Zebra Tech D-Opto
Added MS5803, external voltage, and external tip counter
Fixed bugs with modem and 5TM
Small bug-fixing release
- Allows all sensors to be averaged
- More uniform return of -9999 for missing/bad values
- Better time synching
- Example platformio.ini files
- Added Yosemitech brand sensors which communicate via RS485
- Improvements to modem support and debugging
- Clock synchronization fixes
- Improved examples
- Renaming of a large number of internal variables
- Library metadata and dependency fixes
- Inching closer to full support for SAMD21 (M0/Zero) processors, though still some bugs present.
Added the Apogee SQ-212 PAR sensor.
Changed the interrupt library to EnableInterrupt, which now controls all interrupts.
Added the modem as a "sensor" which can return it's signal strength as a variable.
Added a "debugging" mode, accessible by pushing a button while the checkForDebugMode function is running.
Slight rearrangement of setup functions to improve efficiency.
Shorted time allowed to attempt to turn Bee on/off
Added a check that Bee is on before trying to connect to network
Shorted wait for network time to 55 sec (from 60)
Put disconnect step within if block so it only tries to disconnect if it was connected in the first place
Fixed extra spaces in CSV
Our first release of the modular sensors library to support easily logging data from a variety of environmental sensors and sending that data to the EnviroDIY data portal.