ModularSensors
The EnviroDIY ModularSensors Library
If you're new to EnviroDIY, I suggest you check out the Just Getting Started section of the documentation!
This Arduino library gives environmental sensors a common interface of functions for use with Arduino-compatible dataloggers, such as the EnviroDIY Mayfly. The ModularSensors library is specifically designed to support wireless, solar-powered environmental data logging applications, that is, to:
- Retrieve data from many physical sensors;
- Save that data to a SD memory card;
- Transmit that data wirelessly to a web server; and
- Put the processor, sensors and all other peripherals to sleep between readings to conserve power.
The ModularSensors library coordinates these tasks by "wrapping" native sensor libraries into a common interface of functions and returns. These wrapper functions serve to harmonize and simplify the process of iterating through and logging data from a diverse set of sensors and variables. Using the common sensor and variable interface, the library attempts to optimize measurement timing as much as possible to reduce logger "on-time" and power consumption.
Although this library was written primarily for the EnviroDIY Mayfly data logger board, it is also designed to be compatible with a variety of other Arduino-based boards as well.
There is extensive documentation available in the ModularSensors github pages including details of the class structures and example code.
Supported Sensors
For some generalized information about attaching sensors to an Arduino style board, see the Sensor Notes page.
- Processor Metrics: battery voltage, free RAM, sample count
- Maxim DS3231: real time clock
- Analog Electrical Conductivity: conductivity
- AOSong AM2315: humidity & temperature
- AOSong DHT: humidity & temperature
- Apogee SQ-212: quantum light sensor, via TI ADS1115
- Atlas Scientific EZO Sensors
- Bosch BME280: barometric pressure, humidity & temperature
- Bosch BMP388 and BMP390: barometric pressure & temperature
- Campbell Scientific OBS-3+: turbidity, via TI ADS1115
- Campbell Scientific ClariVUE10: turbidity
- Decagon Devices ES-2: conductivity
- Decagon Devices CTD-10: conductivity, temperature & depth
- Everlight ALS-PT19 Analog Light Sensor (via processor ADC)
- Freescale Semiconductor MPL115A2: barometric pressure and temperature
- External Arduino I2C Rain Tipping Bucket Counter: rainfall totals
- In-Situ RDO PRO-X: dissolved oxygen
- In-Situ SDI-12 TROLLs: pressure, temperature, and depth
- Keller Submersible Level Transmitters: pressure and temperature
- MaxBotix MaxSonar: water level
- Maxim DS18: temperature
- Measurement Specialties MS5803: pressure and temperature
- Meter Environmental Soil Moisture Probes: soil Ea and volumetric water content
- Meter Environmental Hydros 21: conductivity, temperature & depth
- Northern Widget Tally Event Counter: number of events
- PaleoTerra Redox Sensor: redox potential
- Sensirion SHT40: humidity & temperature
- TI ADS1115: external voltage with support for divided current
- TI INA219: current, voltage, and power draw
- Turner Cyclops-7F: various parameters
- Yosemitech: water quality sensors
- Y502-A or Y504-A: Optical DO and Temperature
- Y510-B: Optical Turbidity and Temperature
- Y511-A: Optical Turbidity and Temperature
- Y514-A: Optical Chlorophyll and Temperature
- Y520-A: Conductivity and Temperature
- Y532-A: Digital pH and Temperature
- Y533: ORP, and Temperature
- Y551: UV254/COD, Turbidity, and Temperature
- Y560: Ammonium, Temperature, and pH
- Y4000 Multiparameter Sonde
- Zebra-Tech D-Opto: dissolved oxygen
Data Endpoints
Within ModularSensors, the "dataPublisher" objects add the functionality to send data to remote web services. The currently supported services are the Monitor My Watershed data portal, ThingSpeak, and the Ubidots IoT platform.
Supported Cellular/Wifi Modules:
For information common to all modems and for tables of the proper class, baud rate, and pins to uses, see the Modem Notes page.
- Digi XBee
- Digi XBee® 3 Cellular LTE-M/NB-IoT
- Digi XBee® 3 Cellular LTE Cat 1 (AT&T or Verizon)
- Digi XBee® Cellular 3G
- Digi XBee® Cellular LTE Cat 1 (Verizon)
- Digi XBee® Wi-Fi (S6B)
- ESP8266
- QuectelBG96
- Sequans Monarch
- SIM7080
- SIM7000
- SIM800, including the Sodaq GPRSBee
- u-blox LTE-M R4 and N4 series, including the Sodaq uBee
- u-blox 2G, 3G, and 4G, including the Sodaq 3GBee
Contributing
Open an issue to suggest and discuss potential changes/additions. Feel free to open issues about any bugs you find or any sensors you would like to have added.
If you would like to directly help with the coding development of the library, there are some tips here on how to set up PlatformIO so you can fork the library and test programs while in the library repo. Please take time to familiarize yourself with the terminology, classes and data structures this library uses. This library is built to fully take advantage of Objecting Oriented Programing (OOP) approaches and is larger and more complicated than many Arduino libraries. There is extensive documentation on our github pages and an enormous number of comments and debugging printouts in the code itself to help you get going.
License
Software sketches and code are released under the BSD 3-Clause License -- See LICENSE.md file for details.
Documentation is licensed as Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) copyright.
Hardware designs shared are released, unless otherwise indicated, under the CERN Open Hardware License 1.2 (CERN_OHL).
Acknowledgments
EnviroDIY™ is presented by the Stroud Water Research Center, with contributions from a community of enthusiasts sharing do-it-yourself ideas for environmental science and monitoring.
Sara Damiano is the primary developer of the EnviroDIY ModularSensors library, with input from many other contributors.
This project has benefited from the support from the following funders:
- William Penn Foundation
- US Environmental Protection Agency (EPA)
- National Science Foundation, awards EAR-0724971, EAR-1331856, ACI-1339834
- Stroud Water Research Center endowment