Welcome to EnviroDIY, a community for do-it-yourself environmental science and monitoring. EnviroDIY is part of Home › Forums › Mayfly Data Logger › Library issues › Reply To: Library issues
2026-07-30 at 2:12 PM
#19758
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 |
/** ========================================================================= * @example{lineno} EnviroDIY_Monitoring_Kit.ino * @copyright Stroud Water Research Center * @license This example is published under the BSD-3 license. * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org> * * @brief Example for DRWI CitSci LTE sites. * * Example sketch to be used with the [EnviroDIY Monitoring Station * Kit](https://www.envirodiy.org/product/envirodiy-monitoring-station-kit/). * * See [the walkthrough page](@ref example_envirodiy_monitoring_kit) for * detailed instructions. * * @m_examplenavigation{example_envirodiy_monitoring_kit,} * ======================================================================= */ // The Arduino library is needed for every Arduino program. #include <Arduino.h> // ========================================================================== // Configuration for the EnviroDIY Monitoring Station Kit // ========================================================================== /** Start [configuration] */ // Uncomment ONE of the following lines to select the "Bee" module you are // using. If you are not using a Bee module, you can skip this section and the // sections for the modems in the code below. // If you do not have a Bee module, you should comment out both. //#define USE_WIFI_BEE #define USE_CELLULAR_BEE // Add your network information here. // APN for cellular connection #define CELLULAR_APN "YourAPN" // WiFi access point name #define WIFI_ID "YourWiFiSSID" // WiFi password (WPA2) #define WIFI_PASSWD "YourWiFiPassword" /** End [configuration] */ // ========================================================================== // Data Logging Options // ========================================================================== /** Start [logging_options] */ // Logger ID, also becomes the prefix for the name of the data file on SD card const char* LoggerID = "YourLoggerID"; // How frequently (in minutes) to log data const int8_t loggingInterval = 15; // Your logger's timezone. const int8_t timeZone = -5; // Eastern Standard Time // NOTE: Daylight savings time will not be applied! Please use standard time! /** End [logging_options] */ // ========================================================================== // UUIDs and Registration Tokens for Monitor My Watershed // ========================================================================== /** Start [monitor_mw_uuids] */ // All UUIDs, device registration, and sampling feature information can be // pasted directly from Monitor My Watershed. // To get the list, click the "View token UUID list" button on the upper right // of the site page. // *** CAUTION --- CAUTION --- CAUTION --- CAUTION --- CAUTION *** // Check the order of your variables this list!!! // They MUST be in EXACTLY this order: // Specific conductance (Meter_Hydros21_Cond) // Water depth (Meter_Hydros21_Depth) // Temperature (Meter_Hydros21_Temp) // Battery voltage (EnviroDIY_Mayfly_Batt) // Percent full scale (EnviroDIY_LTEB_SignalPercent or ESP32_SignalPercent) // Relative humidity (Sensirion_SHT40_Humidity) // Temperature (Sensirion_SHT40_Temperature) // Illuminance (Everlight_AnalogALS_Illuminance) // Temperature (Maxim_DS3231_Temp) // If your variables on Monitor My Watershed are in a different order than the // variableList array, you will need to rearrange the UUIDs below to match this // order. If you don't, your data will be sent to the wrong place on Monitor My // Watershed and will be very difficult to fix after the fact. // *** CAUTION --- CAUTION --- CAUTION --- CAUTION --- CAUTION *** // Replace all of the text in the following section with the UUID array from // MonitorMyWatershed /* clang-format off */ // --------------------- Beginning of Token UUID List --------------------- const char *UUIDs[] = // UUID array for device sensors { "", // Specific conductance (Meter_Hydros21_Cond) "", // Water depth (Meter_Hydros21_Depth) "", // Temperature (Meter_Hydros21_Temp) "", // Battery voltage (EnviroDIY_Mayfly_Batt) "", // Percent full scale (EnviroDIY_LTEB_SignalPercent) "" // Temperature (Maxim_DS18B20_Temp) }; const char *registrationToken = ""; // Device registration token const char *samplingFeature = ""; // Sampling feature UUID // ----------------------- End of Token UUID List ----------------------- /* clang-format on */ /** End [monitor_mw_uuids] */ // ========================================================================== // Include the libraries required for any data logger // ========================================================================== /** Start [includes] */ // Include the main header for ModularSensors #include <ModularSensors.h> /** End [includes] */ // ========================================================================== // Logger Pins and Options // ========================================================================== /** Start [logger_pins] */ // The name of this program file - this is used only for console printouts at // start-up const char* sketchName = "EnviroDIY_Monitoring_Kit.ino"; // Set the input and output pins for the logger // NOTE: Use -1 for pins that do not apply const int32_t serialBaud = 115200; // Baud rate for debugging const int8_t greenLED = 8; // Pin for the green LED const int8_t redLED = 9; // Pin for the red LED const int8_t buttonPin = 21; // Pin for debugging mode (i.e., button pin) uint8_t buttonPinMode = INPUT; // mode for debugging pin const int8_t wakePin = 31; // MCU interrupt/alarm pin to wake from sleep uint8_t wakePinMode = INPUT_PULLUP; // mode for wake pin // Mayfly 0.x, 1.x D31 = A7 const int8_t sdCardPwrPin = -1; // MCU SD card power pin const int8_t sdCardSSPin = 12; // SD card chip select/slave select pin const int8_t flashSSPin = 20; // onboard flash chip select/slave select pin const int8_t sensorPowerPin = 22; // MCU pin controlling main sensor power /** End [logger_pins] */ // ========================================================================== // The Logger Object[s] // ========================================================================== /** Start [loggers] */ // Create a new logger instance Logger dataLogger(LoggerID, samplingFeature, loggingInterval); /** End [loggers] */ // ========================================================================== // Wifi/Cellular Modem Options // ========================================================================== #ifdef USE_WIFI_BEE /** Start [espressif_esp32] */ #include <modems/EspressifESP32.h> // Create a reference to the serial port for the modem HardwareSerial& modemSerial = Serial1; // Use hardware serial if possible int32_t modemBaud = 57600; // Communication speed of the modem // Modem Pins - Describe the physical pin connection of your modem to your board // NOTE: Use -1 for pins that do not apply // Example pins here are for a EnviroDIY ESP32 Bluetooth/Wifi Bee with // Mayfly 1.1 const int8_t modemVccPin = 18; // MCU pin controlling modem power const int8_t modemResetPin = -1; // MCU pin connected to modem reset pin const int8_t modemLEDPin = redLED; // MCU pin connected an LED to show modem // status // Network connection information const char* wifiId = WIFI_ID; // WiFi access point name const char* wifiPwd = WIFI_PASSWD; // WiFi password (WPA2) // Create the modem object EspressifESP32 modemESP(&modemSerial, modemVccPin, modemResetPin, wifiId, wifiPwd); // Create an extra reference to the modem by a generic name EspressifESP32 modem = modemESP; /** End [espressif_esp32] */ #endif #ifdef USE_CELLULAR_BEE /** Start [sim_com_sim7080] */ // For almost anything based on the SIMCom SIM7080G #include <modems/SIMComSIM7080.h> // Create a reference to the serial port for the modem HardwareSerial& modemSerial = Serial1; // Use hardware serial if possible const int32_t modemBaud = 57600; // SIM7080 does auto-bauding by default, but // for simplicity we set to 57600 // Modem Pins - Describe the physical pin connection of your modem to your board // NOTE: Use -1 for pins that do not apply const int8_t modemVccPin = 18; const int8_t modemStatusPin = 19; // MCU pin used to read modem status const int8_t modemSleepRqPin = 23; // MCU pin for modem sleep/wake request const int8_t modemLEDPin = redLED; // MCU pin connected an LED to show modem // status // Network connection information const char* apn = CELLULAR_APN; // APN for GPRS connection // Create the modem object SIMComSIM7080 modem7080(&modemSerial, modemVccPin, modemStatusPin, modemSleepRqPin, apn); // Create an extra reference to the modem by a generic name SIMComSIM7080 modem = modem7080; /** End [sim_com_sim7080] */ #endif // ========================================================================== // Using the Processor as a Sensor // ========================================================================== /** Start [processor_stats] */ #include <sensors/ProcessorStats.h> // Create the main processor chip "sensor" - for general metadata const char* mcuBoardVersion = "v1.1"; ProcessorStats mcuBoard(mcuBoardVersion, 5); /** End [processor_stats] */ // ========================================================================== // Maxim DS3231 RTC (Real Time Clock) // Built in on Mayfly 0.x and 1.x // ========================================================================== /** Start [maxim_ds3231] */ #include <sensors/MaximDS3231.h> // Create a DS3231 sensor object MaximDS3231 ds3231(1); /** End [maxim_ds3231] */ // ========================================================================== // Everlight ALS-PT19 Ambient Light Sensor // Built in on Mayfly 1.x // ========================================================================== /** Start [everlight_alspt19] */ #include <sensors/EverlightALSPT19.h> // NOTE: Use -1 for any pins that don't apply or aren't being used. const int8_t alsPower = sensorPowerPin; // Power pin const int8_t alsData = A4; // The ALS PT-19 data pin const int8_t alsSupply = 3.3; // The ALS PT-19 supply power voltage const int8_t alsResistance = 10; // The ALS PT-19 loading resistance (in kΩ) const uint8_t alsNumberReadings = 10; // Create a Everlight ALS-PT19 sensor object EverlightALSPT19 alsPt19(alsPower, alsData, alsSupply, alsResistance, alsNumberReadings); /** End [everlight_alspt19] */ // ========================================================================== // Sensirion SHT4X Digital Humidity and Temperature Sensor // Built in on Mayfly 1.x // ========================================================================== /** Start [sensirion_sht4x] */ #include <sensors/SensirionSHT4x.h> // NOTE: Use -1 for any pins that don't apply or aren't being used. const int8_t SHT4xPower = sensorPowerPin; // Power pin const bool SHT4xUseHeater = true; // Create an Sensirion SHT4X sensor object SensirionSHT4x sht4x(SHT4xPower, SHT4xUseHeater); /** End [sensirion_sht4x] */ // ========================================================================== // Meter Hydros 21 Conductivity, Temperature, and Depth Sensor // ========================================================================== /** Start [hydros21] */ #include <sensors/MeterHydros21.h> const char* hydrosSDI12address = "1"; // The SDI-12 Address of the Hydros 21 const uint8_t hydrosNumberReadings = 6; // The number of readings to average const int8_t SDI12Power = sensorPowerPin; // Power pin (-1 if unconnected) const int8_t SDI12Data = 7; // The SDI12 data pin // Create a Meter Hydros 21 sensor object MeterHydros21 hydros(*hydrosSDI12address, SDI12Power, SDI12Data, hydrosNumberReadings); /** End [hydros21] */ /* clang-format off */ // ========================================================================== // Creating the Variable Array[s] and Filling with Variable Objects // ========================================================================== /** Start [variables_separate_uuids] */ Variable* variableList[] = { new MeterHydros21_Cond(&hydros), // Specific conductance (Meter_Hydros21_Cond) new MeterHydros21_Depth(&hydros), // Water depth (Meter_Hydros21_Depth) new MeterHydros21_Temp(&hydros), // Temperature (Meter_Hydros21_Temp) new ProcessorStats_Battery(&mcuBoard), // Battery voltage (EnviroDIY_Mayfly_Batt) new Modem_SignalPercent(&modem), // Percent full scale (EnviroDIY_LTEB_SignalPercent) new MaximDS3231_Temp(&ds3231), // Temperature (Maxim_DS3231_Temp) }; /* clang-format on */ // Count up the number of pointers in the array int variableCount = sizeof(variableList) / sizeof(variableList[0]); // Create the VariableArray object and attach the UUIDs VariableArray varArray(variableCount, variableList, UUIDs); /** End [variables_separate_uuids] */ // ========================================================================== #if defined(USE_CELLULAR_BEE) || defined(USE_WIFI_BEE) // ========================================================================== // A Publisher to Monitor My Watershed // ========================================================================== /** Start [monitor_my_watershed_publisher] */ // Create a data publisher for the Monitor My Watershed POST endpoint #include <publishers/MonitorMyWatershedPublisher.h> MonitorMyWatershedPublisher MonitorMWPost(dataLogger, registrationToken); /** End [monitor_my_watershed_publisher] */ #endif // ========================================================================== // Working Functions // ========================================================================== /** Start [working_functions] */ // Flashes the LED's on the primary board void greenRedFlash(uint8_t numFlash = 4, uint8_t rate = 75) { // Set up pins for the LED's pinMode(greenLED, OUTPUT); digitalWrite(greenLED, LOW); pinMode(redLED, OUTPUT); digitalWrite(redLED, LOW); for (uint8_t i = 0; i < numFlash; i++) { digitalWrite(greenLED, HIGH); digitalWrite(redLED, LOW); delay(rate); digitalWrite(greenLED, LOW); digitalWrite(redLED, HIGH); delay(rate); } digitalWrite(redLED, LOW); } // Uses the processor sensor object to read the battery voltage // NOTE: This will actually return the battery level from the previous update! float getBatteryVoltage() { if (mcuBoard.sensorValues[PROCESSOR_BATTERY_VAR_NUM] == MS_INVALID_VALUE || mcuBoard.sensorValues[PROCESSOR_BATTERY_VAR_NUM] == 0) { mcuBoard.update(); } return mcuBoard.sensorValues[PROCESSOR_BATTERY_VAR_NUM]; } // ========================================================================== // Arduino Setup Function // ========================================================================== void setup() { /** Start [setup_flashing_led] */ // Blink the LEDs to show the board is on and starting up greenRedFlash(3, 35); /** End [setup_flashing_led] */ // Start the primary serial connection Serial.begin(serialBaud); greenRedFlash(5, 50); // Print a start-up note to the first serial port PRINTOUT("\n\n\n============================="); PRINTOUT("============================="); PRINTOUT("============================="); PRINTOUT(F("\n\nNow running"), sketchName, F("on Logger"), LoggerID, '\n'); PRINTOUT(F("Using ModularSensors Library version"), MODULAR_SENSORS_VERSION); #if defined(USE_CELLULAR_BEE) || defined(USE_WIFI_BEE) PRINTOUT(F("TinyGSM Library version"), TINYGSM_VERSION, '\n'); #endif PRINTOUT(F("Processor:"), mcuBoard.getSensorLocation()); PRINTOUT(F("The most recent reset cause was"), mcuBoard.getLastResetCode(), '(', mcuBoard.getLastResetCause(), ")\n"); /** End [setup_prints] */ /** Start [setup_serial_begins] */ // Start the serial connection with the modem #if defined(USE_CELLULAR_BEE) || defined(USE_WIFI_BEE) PRINTOUT(F("Starting modem connection at"), modemBaud, F("baud")); modemSerial.begin(modemBaud); #endif // Start the SPI library PRINTOUT(F("Starting SPI")); SPI.begin(); #if defined(EXTERNAL_FLASH_DEVICES) PRINTOUT(F("Setting onboard flash pin modes")); pinMode(flashSSPin, OUTPUT); // for proper operation of the onboard flash memory #endif PRINTOUT(F("Starting I2C (Wire)")); Wire.begin(); /** Start [setup_logger] */ // set the logger ID PRINTOUT(F("Setting logger id to"), LoggerID); dataLogger.setLoggerID(LoggerID); PRINTOUT(F("Setting the sampling feature UUID to"), LoggerID); dataLogger.setSamplingFeatureUUID(samplingFeature); // set the logging interval PRINTOUT(F("Setting logging interval to"), loggingInterval, F("minutes")); dataLogger.setLoggingInterval(loggingInterval); PRINTOUT(F("Setting number of initial 1 minute intervals to 10")); dataLogger.setStartupMeasurements(10); // Attach the variable array to the logger PRINTOUT(F("Attaching the variable array")); dataLogger.setVariableArray(&varArray); // set logger pins PRINTOUT(F("Setting logger pins")); dataLogger.setLoggerPins(wakePin, sdCardSSPin, sdCardPwrPin, buttonPin, greenLED, wakePinMode, buttonPinMode); // Set the timezones for the logger/data and the RTC // Logging in the given time zone PRINTOUT(F("Setting logger time zone")); Logger::setLoggerTimeZone(timeZone); // It is STRONGLY RECOMMENDED that you set the RTC to be in UTC (UTC+0) loggerClock::setRTCOffset(0); #if defined(USE_CELLULAR_BEE) || defined(USE_WIFI_BEE) // Attach the modem and information pins to the logger PRINTOUT(F("Attaching the modem")); dataLogger.attachModem(modem); PRINTOUT(F("Setting modem LEDs")); modem.setModemLED(modemLEDPin); #endif // Begin the logger PRINTOUT(F("Beginning the logger")); dataLogger.begin(); /** End [setup_logger] */ /** Start [setup_sensors] */ // Note: Please change these battery voltages to match your battery // Set up the sensors, except at lowest battery level if (getBatteryVoltage() > 3.4) { PRINTOUT(F("Setting up sensors...")); varArray.sensorsPowerUp(); varArray.setupSensors(); varArray.sensorsPowerDown(); } /** End [setup_sensors] */ #ifdef USE_WIFI_BEE /** Start [setup_esp] */ PRINTOUT(F("Waking the modem..")); PRINTOUT(F("Attempting to begin modem communication at"), modemBaud, F("baud. This will fail if the baud is mismatched..")); modemSerial.begin(modemBaud); modem.modemWake(); // NOTE: This will also set up the modem // WARNING: PLEASE REMOVE BAUD RATE DETECTION/FORCING FOR PRODUCTION CODE! if (!modem.gsmModem.testAT()) { // If the AT command test fails, chances are it's a baud rate issue. Try // to detect the baud rate and force the baud rate to the correct one. PRINTOUT(F("Attempting to force the modem baud rate.")); modem.gsmModem.forceModemBaud(modemSerial, static_cast<uint32_t>(modemBaud)); } /** End [setup_esp] */ #endif #ifdef USE_CELLULAR_BEE /** Start [setup_sim7080] */ modem.setModemWakeLevel(HIGH); // ModuleFun Bee inverts the signal modem.setModemResetLevel(HIGH); // ModuleFun Bee inverts the signal PRINTOUT(F("Waking modem and setting Cellular Carrier Options...")); modem.modemWake(); // NOTE: This will also set up the modem // WARNING: PLEASE REMOVE BAUD RATE DETECTION/FORCING FOR PRODUCTION CODE! if (!modem.gsmModem.testAT()) { // If the AT command test fails, chances are it's a baud rate issue. Try // to detect the baud rate and force the baud rate to the correct one. PRINTOUT(F("Attempting to force the modem baud rate.")); modem.gsmModem.forceModemBaud(modemSerial, static_cast<uint32_t>(modemBaud)); } modem.gsmModem.setNetworkMode(38); // set to LTE only // 2 Automatic // 13 GSM only // 38 LTE only // 51 GSM and LTE only modem.gsmModem.setPreferredMode(1); // set to CAT-M // 1 CAT-M // 2 NB-IoT // 3 CAT-M and NB-IoT /** End [setup_sim7080] */ #endif /** Start [setup_clock] */ // Sync the clock if it isn't valid or we have battery to spare if (getBatteryVoltage() > 3.55 || !loggerClock::isRTCSane()) { // Set up the modem, synchronize the RTC with NIST, and publish // configuration information to publishers that support it. dataLogger.makeInitialConnections(); } /** End [setup_clock] */ /** Start [setup_file] */ // Create the log file, adding the default header to it // Do this last so we have the best chance of getting the time correct and // all sensor names correct. // Writing to the SD card can be power intensive, so if we're skipping the // sensor setup we'll skip this too. if (getBatteryVoltage() > 3.4) { PRINTOUT(F("Setting up file on SD card")); dataLogger.turnOnSDcard(true); // true = wait for card to settle after power up dataLogger.createLogFile(true); // true = write a new header dataLogger.turnOffSDcard(true); // true = wait for internal housekeeping after write } /** End [setup_file] */ /** Start [setup_sleep] */ // Call the processor sleep PRINTOUT(F("Putting processor to sleep\n")); dataLogger.systemSleep(); /** End [setup_sleep] */ } // ========================================================================== // Arduino Loop Function // ========================================================================== /** Start [simple_loop] */ // Use this short loop for simple data logging and sending void loop() { // Note: Please change these battery voltages to match your battery // At very low battery, just go back to sleep if (getBatteryVoltage() < 3.4) { PRINTOUT(F("Battery too low, ("), mcuBoard.sensorValues[PROCESSOR_BATTERY_VAR_NUM], F("V) going back to sleep.")); dataLogger.systemSleep(); #if defined(USE_CELLULAR_BEE) || defined(USE_WIFI_BEE) } else if (getBatteryVoltage() < 3.55) { // At moderate voltage, log data but don't send it over the modem PRINTOUT(F("Battery at"), mcuBoard.sensorValues[PROCESSOR_BATTERY_VAR_NUM], F("V; high enough to log, but will not publish!")); dataLogger.logData(); } else { // If the battery is good, send the data to the world PRINTOUT(F("Battery at"), mcuBoard.sensorValues[PROCESSOR_BATTERY_VAR_NUM], F("V; high enough to log and publish data")); dataLogger.logDataAndPublish(); } #else } else { // If the battery is good enough to log, log the data but we have no // modem so we can't publish PRINTOUT(F("Battery at"), mcuBoard.sensorValues[PROCESSOR_BATTERY_VAR_NUM], F("V; high enough to log data")); dataLogger.logData(); } #endif } /** End [simple_loop] */ |
