Bump version, update changelog

Signed-off-by: Sara Damiano <sdamiano@stroudcenter.org>
EnviroDIY · Feb 10, 2021 · 253c083 · 253c083
1 parent eec1e42
commit 253c083
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 87 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -4,10 +4,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+****
+## v0.28.0 (2021-02-10) [Add Support for Turner Cyclops](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.28.0)
 
-## v0.27.8 (2021-01-19)
+### Downloads
+
+**[ModularSensors_Dependencies_0.28.0.zip](https://github.com/EnviroDIY/ModularSensors/releases/download/v0.28.0/ModularSensors_Dependencies_0.28.0.zip)**
+- contains this version of ModularSensors _and the proper versions of all of its dependencies_.
+
+### New Features
+- Add support for all standard configurations of the [Turner Cyclops-7F submersible fluorometer](https://www.turnerdesigns.com/cyclops-7f-submersible-fluorometer)
+
+### Documentation
+- 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
 
-## [Fix GitHub Action](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.27.8)
+## v0.27.8 (2021-01-19) [Fix GitHub Action](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.27.8)
 
 ### Downloads
 
@@ -17,25 +32,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Just fixes an error in the github action to post a release
 
 
-## v0.27.7 (2021-01-19)
-
-## [SDI-12 Bug Fix]
+## v0.27.7 (2021-01-19) [SDI-12 Bug Fix](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.27.7)
 
 ### Bug Fixes
 - Fixed a compiler error for non-concurrent SDI-12 sensors.
 
-## v0.27.6 (2021-01-19)
-
-## [Update Documentation]
+## v0.27.6 (2021-01-19) [Update Documentation](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.27.6)
 
 ### Improvements:
 - Update instructions for examples
 - Update developer instructions
 
 
-## v0.27.5 (2020-12-15)
-
-## [Multiple new Sensors and Workflows](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.27.5)
+## v0.27.5 (2020-12-15) [Multiple new Sensors and Workflows](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.27.5)
 
 ### Downloads
 
@@ -72,9 +81,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - The instructions for using most of the examples is out of date.
 
 
-## v0.25.0
-
-## [v0.25.0: Styling & Doxygen Code Documentation](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.25.0)
+## [v0.25.0 (2020-06-25) Styling & Doxygen Code Documentation](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.25.0)
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3908530.svg)](https://doi.org/10.5281/zenodo.3908530)
 
@@ -102,9 +109,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 For more details, see [Pull Request #309: The style sheet](https://github.com/EnviroDIY/ModularSensors/pull/309)
 
 
-## v0.24.1
-
-## [v0.24.1: Modem Restructuring](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.24.1)
+## [v0.24.1 (2020-03-02) Modem Restructuring](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.24.1)
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3693784.svg)](https://doi.org/10.5281/zenodo.3693784)
 
@@ -117,9 +122,7 @@ For more details, see [Pull Request #309: The style sheet](https://github.com/En
 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).
 
 
-## v0.23.13
-
-## [v0.23.13: More agressive attempts to set clock](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.23.13)
+## [v0.23.13 (2019-09-19) More agressive attempts to set clock](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.23.13)
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3451413.svg)](https://doi.org/10.5281/zenodo.3451413)
 
@@ -135,9 +138,7 @@ Restructured modem so that it no longer operates as a sensor.  Variables tied to
 - 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.
 
 
-## v0.23.11
-
-## [v0.23.11: Watchdogs and More](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.23.11)
+## [v0.23.11 (2019-09-11) Watchdogs and More](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.23.11)
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3405562.svg)](https://doi.org/10.5281/zenodo.3405562)
 
@@ -172,9 +173,7 @@ Extract the contents of libraries.zip to your project's 'lib' folder.
 - 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.
 
 
-## v0.22.5
-
-## [v0.22.5: Modem Simplification](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.22.5)
+## [v0.22.5 (2019-06-24) Modem Simplification](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.22.5)
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3255084.svg)](https://doi.org/10.5281/zenodo.3255084)
 
@@ -225,9 +224,7 @@ Extract the contents of libraries.zip to your project's 'lib' folder.
 - 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.
 
 
-## v0.21.4
-
-## v0.21.4:  Deep debug error
+## [v0.21.4 (2019-05-02) Deep debug error](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.21.4)
 
 ## Downloads
 
@@ -243,9 +240,7 @@ Extract the contents of libraries.zip to your project's 'lib' folder.
 - Fixed minor bug in debugging created in previous release
 
 
-## v0.21.3
-
-## v0.21.3: Minor Bugs and Simplified Debugging
+## [v0.21.3 (2019-05-02) Minor Bugs and Simplified Debugging](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.21.3)
 
 ## New Features:
  - 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.
@@ -258,17 +253,14 @@ Extract the contents of libraries.zip to your project's 'lib' folder.
 - Typo fixes in comments
 
 
-## v0.21.2
-
-## v0.21.2:  Fix write to SD card
+## [v0.21.2 (2019-03-19) Fix write to SD card](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.21.2)
 
 ### Bug Fixes
 - Fixed bug intoduced in 0.21.0 preventing writing to SD card - file must be closed (not sync'ed)
 
 
-## v0.21.0
 
-## v0.21.0: Support for all Atlas Scientific I2C sensors, compiler-safe begin functions
+## [v0.21.0 (2019-03-06) Support for all Atlas Scientific I2C sensors, compiler-safe begin functions](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.21.0)
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2586200.svg)](https://doi.org/10.5281/zenodo.2586200)
 
@@ -305,9 +297,7 @@ Extract the contents of libraries.zip to your project's 'lib' folder.
 - The sensor class and all of its subclasses still require input arguments in the constructor.
 
 
-## v0.19.6
-
-## v0.19.6: Modem Improvements & ADS1X15 Generalization
+## [v0.19.6 (2019-02-27) Modem Improvements & ADS1X15 Generalization](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.19.6)
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2579301.svg)](https://doi.org/10.5281/zenodo.2579301)
 
@@ -323,9 +313,7 @@ Extract the contents of libraries.zip to your project's 'lib' folder.
 - Fixed bug with ADS1115 for M0/SAM21
 
 
-## v0.19.3
-
-## v0.19.3: Bug fix and example re-working
+## [v0.19.3 (2019-01-15) Bug fix and example re-working](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.19.3)
 
 ### Improvements:
 - Re-works the examples to remove duplication between them.
@@ -334,9 +322,7 @@ Extract the contents of libraries.zip to your project's 'lib' folder.
 - Fixes bug in sending data to the WikiWatershed / [Monitor My Watershed](https://monitormywatershed.org/) data sharing portal.
 
 
-## v0.19.2
-
-## v0.19.2: Decreased Data Consumption
+## [v0.19.2 (2018-12-22) Decreased Data Consumption](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.19.2)
 
 ### New Features:
 - Added ThingSpeak support via MQTT (PubSubClient is now a required dependency)
@@ -348,9 +334,7 @@ Extract the contents of libraries.zip to your project's 'lib' folder.
 - Refactored data publishers as a new class rather than subclasses of loggers
 
 
-## v0.17.2
-
-## v0.17.2: Major Update!
+## [v0.17.2 (2018-11-27) Major Update!](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.17.2)
 
 ### New Features & Improvements
 - Improved power management.
@@ -362,9 +346,7 @@ Extract the contents of libraries.zip to your project's 'lib' folder.
 - All library dependencies will need to be updated to match versions in the [library.json](https://github.com/EnviroDIY/ModularSensors/blob/master/library.json) file.
 
 
-## v0.12.2
-
-## v0.12.2: Calculated variables and bug fixes
+## [v0.12.2 (2018-09-25) Calculated variables and bug fixes](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.12.2)
 
 ### New features and improvements:
 * Implemented real calculated variables, from PR #153, closing issue #127 (Create generic calculated variables).
@@ -377,9 +359,7 @@ 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.
 
 
-## v0.11.6
-
-## Fixed Longer Logger Intervals and Improved Documentation
+## [v0.11.6 (2018-05-11) Fixed Longer Logger Intervals and Improved Documentation](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.11.6)
 
 - Fixed variable type for logging interval from uint8_t to uint16_t allowing consistent logging at intervals greater than 5 minutes
 
@@ -389,9 +369,7 @@ NOTE: This **THIS RELEASE DESTROYS BACKWARDS COMPATIBILITY!!** All `.ino` files
 
 
 
-## v0.11.3
-
-## Added sensors and fixed timing bugs
+## [v0.11.3 (2018-05-03) Added sensors and fixed timing bugs](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.11.3)
 
 New sensors:
 - Added support for Freescale MPL115A2 pressure sensor
@@ -412,9 +390,7 @@ Bug Fixes and other Tweeks:
 - 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.
 
 
-## v0.9.0
-
-## Timing Improvements
+## [v0.9.0 (2018-04-17) Timing Improvements](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.9.0)
 
 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
 
@@ -425,24 +401,20 @@ Added MS5803, external voltage, and external tip counter
 Fixed bugs with modem and 5TM
 
 
-## v0.6.10
-
-## Fixes bugs in description and examples
+## [v0.6.10 (2018-02-26) Fixes bugs in description and examples](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.6.10)
 
+Small bug-fixing release
 
-## v0.6.9
 
-## Uniformity of missing values, averaging for all sensors
+## [v0.6.9 (2018-02-26) Uniformity of missing values, averaging for all sensors](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.6.9)
 
 - Allows all sensors to be averaged
 - More uniform return of -9999 for missing/bad values
 - Better time synching
 - Example platformio.ini files
 
 
-## 0.5.4-beta
-
-## 0.5.4-beta
+## [0.5.4-beta (2018-01-18) 0.5.4-beta](https://github.com/EnviroDIY/ModularSensors/releases/tag/0.5.4-beta)
 
 * Added Yosemitech brand sensors which communicate via RS485
 * Improvements to modem support and debugging
@@ -453,9 +425,7 @@ Fixed bugs with modem and 5TM
 * Inching closer to full support for SAMD21 (M0/Zero) processors, though still some bugs present.
 
 
-## v0.3.0-beta
-
-## Beta Release 0.3.0
+## [v0.3.0-beta (2017-06-07) Beta Release](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.3.0-beta)
 
 Added the Apogee SQ-212 PAR sensor.
 
@@ -466,16 +436,12 @@ Added the modem as a "sensor" which can return it's signal strength as a variabl
 Added a "debugging" mode, accessible by pushing a button while the checkForDebugMode function is running.
 
 
-## v0.2.5-beta
-
-## Impoved setup functions
+## [v0.2.5-beta (2017-05-31) Impoved setup functions](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.2.5-beta)
 
 Slight rearrangement of setup functions to improve efficiency.
 
 
-## v0.2.4-beta
-
-## Another beta release
+## [v0.2.4-beta (2017-05-17) Another beta release](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.2.4-beta)
 
 Shorted time allowed to attempt to turn Bee on/off
 
@@ -488,8 +454,6 @@ Put disconnect step within if block so it only tries to disconnect if it was con
 Fixed extra spaces in CSV
 
 
-## v0.2.2-beta
-
-## Initial release
+## [v0.2.2-beta (2017-05-09) Initial release](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.2.2-beta)
 
 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.
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-v0.27.8
+v0.28.0
diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -38,7 +38,7 @@ PROJECT_NAME           = ModularSensors
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.27.8
+PROJECT_NUMBER         = 0.28.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
   "name": "EnviroDIY_ModularSensors",
-  "version": "0.27.8",
+  "version": "0.28.0",
   "description": "A library that allows access to multiple sensors through a unified interface.  This allows the user to simply access many sensors to log the data or send the data to data repositories like the EnviroDIY data portal.",
   "keywords": "modular, sensor, sensors, datalogger, logger, low power, sleeping, EnviroDIY, ModularSensors, Mayfly, WikiWatershed, Monitor My Watershed, ThingSpeak",
   "platforms": "atmelavr, atmelsam",

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=EnviroDIY_ModularSensors
-version=0.27.8
+version=0.28.0
 author=Sara Damiano <sdamiano@stroudcenter.org>, Shannon Hicks <shicks@stroudcenter.org>
 maintainer=Sara Damiano <sdamiano@stroudcenter.org>
 sentence=A library that allows access to multiple sensors through a unified interface.
@@ -8,4 +8,4 @@ category=Sensors
 url=https://github.com/EnviroDIY/ModularSensors
 architectures=avr,samd
 includes=LoggerBase.h
-depends=EnviroDIY_DS3231@1.3.4, RTCZero@1.6.0, EnableInterrupt@1.1.0, SdFat@2.0.4, TinyGSM@0.10.8, PubSubClient@2.8, Adafruit BusIO@1.6.0, Adafruit Unified Sensor@1.1.4, Adafruit ADS1X15@1.2.0, Adafruit AM2315@2.1.0, Adafruit BME280 Library@=2.1.1, DHT sensor library@1.4.0, Adafruit INA219@1.1.0, Adafruit MPL115A2@1.1.2, OneWire@2.3.5, DallasTemperature@3.9.1, SDI-12@2.1.2, MS5803@0.1.2, SensorModbusMaster@0.6.8, KellerModbus@0.2.2, YosemitechModbus@0.2.3
+depends=EnviroDIY_DS3231, RTCZero, EnableInterrupt, SdFat, TinyGSM, PubSubClient, Adafruit BusIO, Adafruit Unified Sensor, Adafruit ADS1X15, Adafruit AM2315, Adafruit BME280 Library, DHT sensor library, Adafruit INA219, Adafruit MPL115A2, OneWire, DallasTemperature, SDI-12, MS5803, SensorModbusMaster, KellerModbus, YosemitechModbus
diff --git a/src/ModSensorDebugger.h b/src/ModSensorDebugger.h
@@ -22,7 +22,7 @@
 /**
  * @brief The current library version number
  */
-#define MODULAR_SENSORS_VERSION "0.27.8"
+#define MODULAR_SENSORS_VERSION "0.28.0"
 
 #ifndef STANDARD_SERIAL_OUTPUT
 // #if defined(ARDUINO_SAMD_ZERO) && defined(SERIAL_PORT_USBVIRTUAL)