Update dependencies, markdown

Signed-off-by: Sara Damiano <sdamiano@stroudcenter.org>
EnviroDIY · Sep 30, 2024 · 2a31203 · 2a31203
1 parent cbbd3b4
commit 2a31203
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 16 deletions.
diff --git a/continuous_integration/dependencies.json b/continuous_integration/dependencies.json
@@ -1,12 +1,12 @@
 {
-  "action_cache_version": 21,
+  "action_cache_version": 22,
   "dependencies": [
     {
       "name": "EnviroDIY_DS3231",
       "owner": "envirodiy",
       "library id": "2079",
       "url": "https://github.com/EnviroDIY/Sodaq_DS3231",
-      "version": "~1.3.5",
+      "version": "~1.3.6",
       "note": "An Arduino library for the DS3231 RTC (Real Time Clock), based off of the Sodaq_DS3231 library.",
       "authors": [
         "Kees Bakker",
@@ -57,6 +57,7 @@
     {
       "name": "TinyGSM",
       "owner": "vshymanskyy",
+      "url": "https://github.com/vshymanskyy/TinyGSM",
       "version": "~0.12.0",
       "note": "A small Arduino library for GPRS modules.",
       "authors": [
@@ -82,7 +83,7 @@
       "owner": "adafruit",
       "library id": "6214",
       "url": "https://github.com/adafruit/Adafruit_BusIO",
-      "version": "~1.16.0",
+      "version": "~1.16.1",
       "note": "Adafruit BusIO, a dependency of other Adafruit libraries",
       "authors": [
         "Adafruit"
@@ -109,7 +110,9 @@
       "url": "https://github.com/adafruit/Adafruit_ADS1X15",
       "version": "~2.5.0",
       "note": "Driver for TI's ADS1X15: 12 and 16-bit Differential or Single-Ended ADC with PGA and Comparator.",
-      "authors": ["Adafruit"],
+      "authors": [
+        "Adafruit"
+      ],
       "frameworks": "arduino",
       "platforms": "atmelavr, atmelsam"
     },
@@ -193,7 +196,7 @@
       "owner": "adafruit",
       "library id": "11710",
       "url": "https://github.com/adafruit/Adafruit_SHT4X",
-      "version": "~1.0.4",
+      "version": "~1.0.5",
       "note": "Sensirion SHT4x Library by Adafruit",
       "authors": [
         "Adafruit"
@@ -324,7 +327,7 @@
       "name": "GroPointModbus",
       "owner": "envirodiy",
       "url": "https://github.com/EnviroDIY/GroPointModbus.git",
-      "version": "~0.1.0",
+      "version": "~0.1.1",
       "note": "A library to use an Arduino as a master to control and communicate via modbus with GroPoint soil moisture sensors. ",
       "authors": [
         "Anthony Aufdenkampe"
@@ -333,4 +336,4 @@
       "platforms": "atmelavr, atmelsam"
     }
   ]
-}
+}
diff --git a/docs/Getting-Started/Library-Dependencies.md b/docs/Getting-Started/Library-Dependencies.md
@@ -1,5 +1,8 @@
 # Library Dependencies<!-- {#page_library_dependencies} -->
 
+> [!WARNING]
+> This page is frequently out of date. Please see the library.json or dependencies.json and example_dependencies.json for the most up-to-date library references!
+
 In order to support multiple functions and sensors, there are quite a lot of sub-libraries that this library depends on.
 _Even if you do not use the modules, you must have all of the dependencies installed for the library itself to properly compile._
 Please check the [library.json](https://github.com/EnviroDIY/ModularSensors/blob/master/library.json) file for more details on the versions required of each library.
@@ -16,20 +19,28 @@ Because we use this library, _you must always add the line `#include <EnableInte
 (This library may be built in to the Arduino IDE.)
 NOTE:  If using an AVR board, you must explicitly _ignore_ this library when compiling with PlatformIO or you will have compiler errors.
 - [SdFat library](https://github.com/greiman/SdFat) - This enables communication with the SD card.
-- [EnviroDIY version of the TinyGSM library](https://github.com/EnviroDIY/TinyGSM) - This provides internet (TCP/IP) connectivity.
-- [Adafruit ADS1X15 library](https://github.com/soligen2010/Adafruit_ADS1X15/) - For high-resolution analog to digital conversion.
-Note that this is soligen2010's fork of the original Adafruit library; it corrects many problems in the Adafruit library such as a bug which gives the same output on all four inputs regardless of their values.
-Do _NOT_ use the original Adafruit version!
+- [TinyGSM library](https://github.com/vshymanskyy/TinyGSM) - This provides internet (TCP/IP) connectivity.
+- [PubSubClient](https://github.com/knolleary/pubsubclient) - For MQTT connectivity
+- [Adafruit ADS1X15 library](https://github.com/adafruit/Adafruit_ADS1X15) - For high-resolution analog to digital conversion.
+  - NOTE: As of version 0.36.0 the standard Adafruit library should be used, *NOT* the Soligen2010 fork.
 - [EnviroDIY Arduino SDI-12 library](https://github.com/EnviroDIY/Arduino-SDI-12/tree/ExtInts) - For control of SDI-12 based sensors.
 This modified version is needed so there are no pin change interrupt conflicts with the SoftwareSerial library or the software pin change interrupt library used to wake the processor.
 - [SensorModbusMaster](https://github.com/EnviroDIY/SensorModbusMaster) - for easy communication with Modbus devices.
 - [OneWire](https://github.com/PaulStoffregen/OneWire) - This enables communication with Maxim/Dallas OneWire devices.
 - [DallasTemperature](https://github.com/milesburton/Arduino-Temperature-Control-Library) - for communication with the DS18 line of Maxim/Dallas OneWire temperature probes.
-- [Adafruit Unified Sensor Driver](https://github.com/adafruit/Adafruit_Sensor) - a dependency of several other Adafruit libraries
+- [Adafruit BusIO](https://github.com/adafruit/Adafruit_BusIO) - a dependency of several other Adafruit libraries, used to unify commands for fetching data via SPI and I2C.
+- [Adafruit Unified Sensor Driver](https://github.com/adafruit/Adafruit_Sensor) - a dependency of several other Adafruit libraries, used to unify sensor data return types.
 - [Adafruit AM2315 library](https://github.com/adafruit/Adafruit_AM2315) - for the AOSong AM2315 temperature and humidity sensor.
 - [Adafruit DHT library](https://github.com/adafruit/DHT-sensor-library) - for other AOSong temperature and humidity sensors.
 - [Adafruit BME280 library](https://github.com/adafruit/Adafruit_BME280_Library) - for the Bosch BME280 environmental sensor.
+- [Adafruit INA219 library](https://github.com/adafruit/Adafruit_INA219) - for the INA219 current/voltage sensor.
 - [Adafruit MPL115A2 library](https://github.com/adafruit/Adafruit_MPL115A2) - for the Freescale Semiconductor MPL115A2 barometer.
+- [Adafruit SHT4x library](https://github.com/adafruit/Adafruit_SHT4X) - for the Senserion SHT40 temperature and humidity sensor. This sensor is built into the EnviroDIY Mayfly and Stonefly.
 - [YosemitechModbus](https://github.com/EnviroDIY/YosemitechModbus) - for all Yosemitech modbus environmental sensors.
 - [Northern Widget MS5803 Library](https://github.com/NorthernWidget/MS5803) - for the TE Connectivity MEAS MS5803 pressure sensor
 - [EnviroDIY KellerModbus Library](https://github.com/EnviroDIY/KellerModbus) - for all Keller modbus pressure and water level sensors.
+- [EnviroDIY GroPointModbus Library](https://github.com/EnviroDIY/GroPointModbus.git) - For GroPoint soil moisture probes.
+- [BMP388_DEV](https://registry.platformio.org/libraries/martinl1/BMP388_DEV) - for communication with the Bosch BMP388 barometer
+    - WARNING: The repository for this library has been removed from GitHub. The library itself is still available in the PlatformIO and Arduino library registries.
+- [Tally Library](https://github.com/EnviroDIY/Tally_Library.git#Dev_I2C) - For the Project Tally Event sensor
+    - NOTE: Use the `Dev_I2C` feature branch
diff --git a/library.json b/library.json
@@ -67,7 +67,7 @@
       "owner": "envirodiy",
       "library id": "2079",
       "url": "https://github.com/EnviroDIY/Sodaq_DS3231",
-      "version": "~1.3.5",
+      "version": "~1.3.6",
       "note": "An Arduino library for the DS3231 RTC (Real Time Clock), based off of the Sodaq_DS3231 library.",
       "authors": ["Kees Bakker", "Sara Damiano"],
       "frameworks": "arduino",
@@ -109,6 +109,7 @@
     {
       "name": "TinyGSM",
       "owner": "vshymanskyy",
+      "url": "https://github.com/vshymanskyy/TinyGSM",
       "version": "~0.12.0",
       "note": "A small Arduino library for GPRS modules.",
       "authors": ["Volodymyr Shymanskyy", "Sara Damiano"],
@@ -129,7 +130,7 @@
       "owner": "adafruit",
       "library id": "6214",
       "url": "https://github.com/adafruit/Adafruit_BusIO",
-      "version": "~1.16.0",
+      "version": "~1.16.1",
       "note": "Adafruit BusIO, a dependency of other Adafruit libraries",
       "authors": ["Adafruit"],
       "frameworks": "arduino",
@@ -224,7 +225,7 @@
       "owner": "adafruit",
       "library id": "11710",
       "url": "https://github.com/adafruit/Adafruit_SHT4X",
-      "version": "~1.0.4",
+      "version": "~1.0.5",
       "note": "Sensirion SHT4x Library by Adafruit",
       "authors": ["Adafruit"],
       "frameworks": "arduino"
@@ -333,7 +334,7 @@
       "name": "GroPointModbus",
       "owner": "envirodiy",
       "url": "https://github.com/EnviroDIY/GroPointModbus.git",
-      "version": "~0.1.0",
+      "version": "~0.1.1",
       "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",