Atlas Scientific Dissolved Oxygen Sensor Not Reading

Tagged: -9999.00, Atlas Scientific, Dissolved Oxygen, DO

This topic has 7 replies, 5 voices, and was last updated 2024-04-03 at 4:25 PM by Michael Daniel.

Viewing 6 reply threads

Author

Posts

2023-02-24 at 4:06 PM #17625
James T
Participant
I am working on programming a Mayfly Data Logger v1.1. I am using the Simple_Logging program in Visual Studio and the PlatformIO. I am attempting to connect an Atlas Scientific DO sensor to the logger using I2C. I already have an Atlas Scientific pH sensor connected to the Mayfly, and the pH sensor is working fine. The DO sensor is not. It will record the data correctly the first time through the cycle, but will return -9999.00 upon subsequent cycles. If I disconnect the power to the DO EZO between readings, it will run properly and give me the correct reading, but just the once. I am sure it is in the code somewhere, but I am not at all familiar with the PlatformIO programming, so I don’t even know where to start.

Has anyone come across this before? I have both the pH and the DO sensors each connected to an isolator carrier board. The lights on the DO EZO flash at each reading, suggesting the Mayfly is communicating with the DO sensor.
2023-02-24 at 4:12 PM #17628
James T
Participant
Not sure how to post the code, nor do I know which code to post.
2023-02-24 at 6:51 PM #17630
Shannon Hicks
Moderator
How are you connecting the sensor to the Mayfly (what pins for data and power and what jack), and are you putting the Mayfly to sleep between readings? Is the sensor being powered constantly or are you switching off the power to the sensor between readings?
- 2023-02-25 at 11:13 AM #17631
  James T
  Participant
  I have tried various configurations. I have connected it to the I2C Grove slot, and I have connected it to the SDA & SCL pins. As for the power, I have gotten power through the Grove connector, and I have tried giving it power through each of the 3.3v and gnd pins. It performs the same regardless of how I have it connected.
  
  I am using the Simple_logging.ino program as written, so I don’t know if it is going to sleep between readings, but the indicator light on the pH EZO is shutting off between readings, while the DO EZO mostly stays on. I don’t know if that helps. Where would I find the code that controls power?
  
  This is the first time I have used PlatformIO to program an arduino, so I am still trying to figure everything out. I have only ever used the Arduino IDE before.
  
  I really appreciate the help!
2023-02-27 at 11:10 AM #17634
Shannon Hicks
Moderator
Most I2C devices don’t like having the power to the device cut and the reapplied, which is why the Vcc pin of the Mayfly’s I2C Grove jack is constantly powered. All the other Grove jacks switch the power on or off, but the I2C jack always has 3.3v, even with the Mayfly is asleep. So if you’re powering your Atlas board from any of the switched sources, try putting it on the constant 3.3v pin. If you’ve already tried that, then it’s probably something in the code that’s causing the issue. I don’t use any of the Atlas products, but a few members here have successfully used them, so perhaps they could share what code and hardware configuration was used? @w3asa @adamgold @fionasouthwell
2023-02-28 at 11:18 AM #17642
Sara Damiano
Moderator
It’s been a long time since I played with the Atlas sensors, but from my notes, power cycling them can cause the whole logger to crash. If you want to power down Atlas sensors between readings, you need an I2C isolator. See the warning here: https://envirodiy.github.io/ModularSensors/group__atlas__group.html. The simple logging program should put the sensors to sleep and power them down between readings: https://github.com/EnviroDIY/ModularSensors/blob/master/examples/simple_logging/ReadMe.md
2024-03-21 at 1:36 PM #18390
Fiona
Participant
James,

Did you ever resolve this? I’m having the same issue.

Thanks!

2024-04-03 at 4:25 PM #18411

Michael Daniel

Participant

I have both a pH and a DO sensor working on one of my data loggers., and I’ve had up to four Atlas Scientific sensors working at once using a sensor bridge: https://atlas-scientific.com/carrier-boards/sensor-bridge/ I currently have the sensors connected through the qwiic ports, and they seem to be working fine. Here’s my code, there’s a lot of extraneous stuff that I haven’t had a chance to clean up yet, and it’s sending data to thingspeak instead of MonitorMyWatershed:

/** =========================================================================
 * @file DRWI_LTE.ino
 * @brief Example for DRWI CitSci LTE sites.
 *
 * This example shows proper settings for the following configuration:
 *
 * Mayfly v1.1 board
 * EnviroDIY sim7080 LTE module (with Hologram SIM card)
 * Hydros21 CTD sensor
 * Campbell Scientific OBS3+ Turbidity sensor
 * 
 * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
 * @copyright (c) 2017-2020 Stroud Water Research Center (SWRC)
 *                          and the EnviroDIY Development Team
 *            This example is published under the BSD-3 license.
 *
 * Build Environment: Visual Studios Code with PlatformIO
 * Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
 *
 * DISCLAIMER:
 * THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
 * ======================================================================= */

// ==========================================================================
//  Defines for the Arduino IDE
//  NOTE:  These are ONLY needed to compile with the Arduino IDE.
//         If you use PlatformIO, you should set these build flags in your
//         platformio.ini
// ==========================================================================
/** Start [defines] */
#ifndef TINY_GSM_RX_BUFFER
#define TINY_GSM_RX_BUFFER 64
#endif
#ifndef TINY_GSM_YIELD_MS
#define TINY_GSM_YIELD_MS 2
#endif
#ifndef MQTT_MAX_PACKET_SIZE
#define MQTT_MAX_PACKET_SIZE 256
#endif
/** End [defines] */

// ==========================================================================
//  Include the libraries required for any data logger
// ==========================================================================
/** Start [includes] */
// The Arduino library is needed for every Arduino program.
#include <Arduino.h>

// EnableInterrupt is used by ModularSensors for external and pin change
// interrupts and must be explicitly included in the main program.
#include <EnableInterrupt.h>

// To get all of the base classes for ModularSensors, include LoggerBase.
// NOTE:  Individual sensor definitions must be included separately.
#include <LoggerBase.h>

// Include the main header for ModularSensors
#include <ModularSensors.h>
/** End [includes] */


// ==========================================================================
//  Data Logging Options
// ==========================================================================
/** Start [logging_options] */
// The name of this program file
const char* sketchName = "BWC_ALL_VAR_TS.ino";
// Logger ID, also becomes the prefix for the name of the data file on SD card
const char* LoggerID = "BWC";
// How frequently (in minutes) to log data
const uint8_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!

// Set the input and output pins for the logger
// NOTE:  Use -1 for pins that do not apply
const long   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 (ie, button pin)
const int8_t wakePin    = 31;      // MCU interrupt/alarm pin to wake from sleep
// Mayfly 0.x D31 = A7
// Set the wake pin to -1 if you do not want the main processor to sleep.
// In a SAMD system where you are using the built-in rtc, set wakePin to 1
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 sensorPowerPin = 22;  // MCU pin controlling main sensor power
/** End [logging_options] */


// ==========================================================================
//  Wifi/Cellular Modem Options
// ==========================================================================
/** Start [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
// for Additional Serial Ports" section
const int32_t modemBaud =
    9600;  //  SIM7080 does auto-bauding by default, but I set mine to 9600

// 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;    // MCU pin controlling modem power
const int8_t modemStatusPin = 19;    // MCU pin used to read modem status
//const bool useCTSforStatus = false;  // Flag to use the modem CTS pin for status
//const int8_t modemResetPin = 20;     // MCU pin connected to modem reset pin
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 (-1 if unconnected)

// Network connection information
const char* apn = "hologram";  // The APN for the 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 [xbee_cell_transparent] */


// ==========================================================================
//  Using the Processor as a Sensor
// ==========================================================================
/** Start [processor_sensor] */
#include <sensors/ProcessorStats.h>

// Create the main processor chip "sensor" - for general metadata
const char*    mcuBoardVersion = "v1.1b";
ProcessorStats mcuBoard(mcuBoardVersion);
/** End [processor_sensor] */


// ==========================================================================
//  Maxim DS3231 RTC (Real Time Clock)
// ==========================================================================
/** Start [ds3231] */
#include <sensors/MaximDS3231.h>

// Create a DS3231 sensor object
MaximDS3231 ds3231(1);
/** End [ds3231] */


// ==========================================================================
//  Campbell OBS 3 / OBS 3+ Analog Turbidity Sensor
// ==========================================================================

/** Start [vue10] */
#include <sensors/CampbellClariVUE10.h>

const char* ClariVUESDI12address = "2";  // The SDI-12 Address of the ClariVUE10
const int8_t ClariVUEPower = sensorPowerPin;  // Power pin (-1 if unconnected)
const int8_t ClariVUEData  = 7;               // The SDI12 data pin
// NOTE:  you should NOT take more than one readings.  THe sensor already takes
// and averages 8 by default.

// Create a Campbell ClariVUE10 sensor object
CampbellClariVUE10 clarivue(*ClariVUESDI12address, ClariVUEPower, ClariVUEData);


/** End [vue10] */


// ==========================================================================
//  Meter Hydros 21 Conductivity, Temperature, and Depth Sensor
// ==========================================================================
/** Start [hydros21] */
#include <sensors/MeterHydros21.h>

// NOTE: Use -1 for any pins that don't apply or aren't being used.
const char*   hydros21SDI12address = "1";  // The SDI-12 Address of the Hydros21
const uint8_t hydros21NumberReadings = 6;  // The number of readings to average
const int8_t  hydros21Power          = sensorPowerPin;  // Power pin
const int8_t  hydros21Data           = 7;               // The SDI12 data pin

// Create a Decagon Hydros21 sensor object
MeterHydros21 hydros21(*hydros21SDI12address, hydros21Power, hydros21Data,
                       hydros21NumberReadings);
/** End [hydros21] */

// ==========================================================================
//  Decagon CTD-10 Conductivity, Temperature, and Depth Sensor
// ==========================================================================
/** Start [decagon_ctd] */
#include <sensors/DecagonCTD.h>

// NOTE: Use -1 for any pins that don't apply or aren't being used.
const char*   CTDSDI12address   = "1";  // The SDI-12 Address of the CTD
const uint8_t CTDNumberReadings = 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 Decagon CTD sensor object
DecagonCTD ctd(*CTDSDI12address, SDI12Power, SDI12Data, CTDNumberReadings);
/** End [decagon_ctd] */

#include <sensors/AtlasScientificDO.h>

// NOTE: Use -1 for any pins that don't apply or aren't being used.
const int8_t AtlasDOPower    = sensorPowerPin;  // Power pin
uint8_t      AtlasDOi2c_addr = 0x61;            // Default for DO is 0x61 (97)
// All Atlas sensors have different default I2C addresses, but any of them can
// be re-addressed to any 8 bit number.  If using the default address for any
// Atlas Scientific sensor, you may omit this argument.

// Create an Atlas Scientific DO sensor object
// AtlasScientificDO atlasDO(AtlasDOPower, AtlasDOi2c_addr);
AtlasScientificDO atlasDO(AtlasDOPower);
#include <sensors/AtlasScientificEC.h>

// NOTE: Use -1 for any pins that don't apply or aren't being used.
const int8_t AtlasECPower    = sensorPowerPin;  // Power pin
uint8_t      AtlasECi2c_addr = 0x64;            // Default for pH is 0x63 (99)
// All Atlas sensors have different default I2C addresses, but any of them can
// be re-addressed to any 8 bit number.  If using the default address for any
// Atlas Scientific sensor, you may omit this argument.

// Create an Atlas Scientific pH sensor object
// AtlasScientificpH atlaspH(AtlaspHPower, AtlaspHi2c_addr);
AtlasScientificEC atlasEC(AtlasECPower, AtlasECi2c_addr);

#include <sensors/AtlasScientificpH.h>

// NOTE: Use -1 for any pins that don't apply or aren't being used.
const int8_t AtlaspHPower    = sensorPowerPin;  // Power pin
uint8_t      AtlaspHi2c_addr = 0x63;            // Default for pH is 0x63 (99)
// All Atlas sensors have different default I2C addresses, but any of them can
// be re-addressed to any 8 bit number.  If using the default address for any
// Atlas Scientific sensor, you may omit this argument.

// Create an Atlas Scientific pH sensor object
// AtlasScientificpH atlaspH(AtlaspHPower, AtlaspHi2c_addr);
AtlasScientificpH atlaspH(AtlaspHPower);

#include <sensors/AtlasScientificORP.h>

// NOTE: Use -1 for any pins that don't apply or aren't being used.
const int8_t AtlasORPPower    = sensorPowerPin;  // Power pin
uint8_t      AtlasORPi2c_addr = 0x62;            // Default for ORP is 0x62 (98)
// All Atlas sensors have different default I2C addresses, but any of them can
// be re-addressed to any 8 bit number.  If using the default address for any
// Atlas Scientific sensor, you may omit this argument.

// Create an Atlas Scientific ORP sensor object
// AtlasScientificORP atlasORP(AtlasORPPower, AtlasORPi2c_addr);
AtlasScientificORP atlasORP(AtlasORPPower);

// ==========================================================================
//  Creating the Variable Array[s] and Filling with Variable Objects
// ==========================================================================
/** Start [variable_arrays] */
Variable* variableList[] = {
    new MeterHydros21_Temp(&hydros21),
    new MeterHydros21_Depth(&hydros21),
    new MeterHydros21_Cond(&hydros21),
//    new DecagonCTD_Cond(&ctd),
//    new DecagonCTD_Depth(&ctd),
//    new DecagonCTD_Temp(&ctd),    
//    new CampbellOBS3_Turbidity(&osb3low, "", "TurbLow"),
//    new CampbellOBS3_Turbidity(&osb3high, "", "TurbHigh"),
    new ProcessorStats_Battery(&mcuBoard),
//    new Modem_SignalPercent(&modem),
    new MaximDS3231_Temp(&ds3231),    
    new CampbellClariVUE10_Turbidity(&clarivue),
    new AtlasScientificDO_DOmgL(&atlasDO),
    //new AtlasScientificDO_DOpct(&atlasDO),
//    new AtlasScientificEC_Cond(&atlasEC),
//    new AtlasScientificEC_Salinity(&atlasEC),
    //new AtlasScientificEC_SpecificGravity(&atlasEC),
    //new AtlasScientificEC_TDS(&atlasEC),
    new AtlasScientificpH_pH(&atlaspH),
    //new AtlasScientificORP_Potential(&atlasORP)
};

// All UUID's, 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 in the variable list!!!
// Be VERY certain that they match the order of your UUID's!
// Rearrange the variables in the variable list if necessary to match!
// *** CAUTION --- CAUTION --- CAUTION --- CAUTION --- CAUTION ***
                                const char *UUIDs[] =                                                      // UUID array for device sensors
                                {
                                    "abcdefgh-1234-1234-1234-abcdefghijkl",   // Electrical conductivity (Decagon_CTD-10_Cond)
                                    "abcdefgh-1234-1234-1234-abcdefghijkl",   // Water depth (Decagon_CTD-10_Depth)
                                    "abcdefgh-1234-1234-1234-abcdefghijkl",   // Temperature (Decagon_CTD-10_Temp)
                                    "abcdefgh-1234-1234-1234-abcdefghijkl",   // Battery voltage (EnviroDIY_Mayfly_Batt)
                                    "abcdefgh-1234-1234-1234-abcdefghijkl",   // Percent full scale (Digi_Cellular_SignalPercent)
                                    "abcdefgh-1234-1234-1234-abcdefghijkl",   // Temperature (Maxim_DS3231_Temp)
                                    "abcdefgh-1234-1234-1234-abcdefghijkl"    // Turbidity (Campbell_ClariVUE_Turbidity)
                                };
                                const char *registrationToken = "abcdefgh-1234-1234-1234-abcdefghijkl";   // Device registration token
                                const char *samplingFeature = "abcdefgh-1234-1234-1234-abcdefghijkl";     // Sampling feature UUID

// Count up the number of pointers in the array
int variableCount = sizeof(variableList) / sizeof(variableList[0]);

// Create the VariableArray object
VariableArray varArray(variableCount, variableList, UUIDs);
/** End [variable_arrays] */


// ==========================================================================
//  The Logger Object[s]
// ==========================================================================
/** Start [loggers] */
// Create a new logger instance
Logger dataLogger(LoggerID, loggingInterval, &varArray);
/** End [loggers] */


// ==========================================================================
//  Creating Data Publisher[s]
// ==========================================================================
/** Start [publishers] */
// Create a data publisher for the Monitor My Watershed/EnviroDIY POST endpoint
//#include <publishers/EnviroDIYPublisher.h>
//EnviroDIYPublisher EnviroDIYPOST(dataLogger, &modem.gsmClient,
//                                registrationToken, samplingFeature);
// Create a channel with fields on ThingSpeak in advance
// The fields will be sent in exactly the order they are in the variable array.
// Any custom name or identifier given to the field on ThingSpeak is irrelevant.
// No more than 8 fields of data can go to any one channel.  Any fields beyond
// the eighth in the array will be ignored.
const char* thingSpeakChannelID =
    "123456";  // The numeric channel id for your channel
const char* thingSpeakMQTTusername =
    "abcdefgh-1234-1234-1234-abcdefghijkl"; //Your MQTT username
const char* thingSpeakMQTTpassword =
    "abcdefgh-1234-1234-1234-abcdefghijkl"; //Your MQTT password
const char* thingSpeakMQTTclientID =
    "abcdefgh-1234-1234-1234-abcdefghijkl"; //Your MQTT client ID
// Create a data publisher for ThingSpeak
#include <publishers/ThingSpeakPublisher.h>
ThingSpeakPublisher TsMqtt;                                 
/** End [publishers] */


// ==========================================================================
//  Working Functions
// ==========================================================================
/** Start [working_functions] */
// Flashes the LED's on the primary board
void greenredflash(uint8_t numFlash = 4, uint8_t rate = 75) {
    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);
}

// Reads the battery voltage
// NOTE: This will actually return the battery level from the previous update!
float getBatteryVoltage() {
    if (mcuBoard.sensorValues[0] == -9999) mcuBoard.update();
    return mcuBoard.sensorValues[0];
}


// ==========================================================================
// Arduino Setup Function
// ==========================================================================
/** Start [setup] */
void setup() {
    // Start the primary serial connection
    Serial.begin(serialBaud);

    // Print a start-up note to the first serial port
    Serial.print(F("Now running "));
    Serial.print(sketchName);
    Serial.print(F(" on Logger "));
    Serial.println(LoggerID);
    Serial.println();

    Serial.print(F("Using ModularSensors Library version "));
    Serial.println(MODULAR_SENSORS_VERSION);
    Serial.print(F("TinyGSM Library version "));
    Serial.println(TINYGSM_VERSION);
    Serial.println();

    // Start the serial connection with the modem
    modemSerial.begin(modemBaud);

    // Set up pins for the LED's
    pinMode(22, OUTPUT);
    digitalWrite(22, HIGH);
    pinMode(greenLED, OUTPUT);
    digitalWrite(greenLED, LOW);
    pinMode(redLED, OUTPUT);
    digitalWrite(redLED, LOW);
    // Blink the LEDs to show the board is on and starting up
    greenredflash();

    // Set the timezones for the logger/data and the RTC
    // Logging in the given time zone
    Logger::setLoggerTimeZone(timeZone);
    // It is STRONGLY RECOMMENDED that you set the RTC to be in UTC (UTC+0)
    Logger::setRTCTimeZone(0);

    // Attach the modem and information pins to the logger
    dataLogger.attachModem(modem);
    modem.setModemLED(modemLEDPin);
    dataLogger.setLoggerPins(wakePin, sdCardSSPin, sdCardPwrPin, buttonPin,
                             greenLED);

    // Begin the variable array[s], logger[s], and publisher[s]
    varArray.begin(variableCount, variableList);
    dataLogger.begin(LoggerID, loggingInterval, &varArray);
    TsMqtt.begin(dataLogger, &modem.gsmClient,
                thingSpeakChannelID,
                thingSpeakMQTTusername,
              thingSpeakMQTTpassword,
              thingSpeakMQTTclientID);

    // Note:  Please change these battery voltages to match your battery
    // Set up the sensors, except at lowest battery level
    if (getBatteryVoltage() > 3.4) {
        Serial.println(F("Setting up sensors..."));
        varArray.setupSensors();
    }

/** Start [setup_sim7080] */
    modem.setModemWakeLevel(HIGH);   // ModuleFun Bee inverts the signal
    modem.setModemResetLevel(HIGH);  // ModuleFun Bee inverts the signal
    Serial.println(F("Waking modem and setting Cellular Carrier Options..."));
    modem.modemWake();  // NOTE:  This will also set up the modem
    modem.gsmModem.setBaud(modemBaud);   // Make sure we're *NOT* auto-bauding!
    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] */

    // Sync the clock if it isn't valid or we have battery to spare
    if (getBatteryVoltage() > 3.55 || !dataLogger.isRTCSane()) {
        // Synchronize the RTC with NIST
        // This will also set up the modem
        dataLogger.syncRTC();
    }

    // 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) {
        Serial.println(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
    }

    // Call the processor sleep
    Serial.println(F("Putting processor to sleep\n"));
    dataLogger.systemSleep();
}
/** End [setup] */


// ==========================================================================
//  Arduino Loop Function
// ==========================================================================
/** Start [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) {
        dataLogger.systemSleep();
    }
    // At moderate voltage, log data but don't send it over the modem
    else if (getBatteryVoltage() < 3.55) {
        dataLogger.logData();
    }
    // If the battery is good, send the data to the world
    else {
        dataLogger.logDataAndPublish();
    }
}
/** End [loop] */

//Michael Daniel
//Lynchburg Water Resources

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

/** =========================================================================

* @file DRWI_LTE.ino

* @brief Example for DRWI CitSci LTE sites.

* This example shows proper settings for the following configuration:

* Mayfly v1.1 board

* EnviroDIY sim7080 LTE module (with Hologram SIM card)

* Hydros21 CTD sensor

* Campbell Scientific OBS3+ Turbidity sensor

* @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>

* and the EnviroDIY Development Team

* This example is published under the BSD-3 license.

* Build Environment: Visual Studios Code with PlatformIO

* Hardware Platform: EnviroDIY Mayfly Arduino Datalogger

* DISCLAIMER:

* THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.

* ======================================================================= */

// ==========================================================================

// Defines for the Arduino IDE

// NOTE: These are ONLY needed to compile with the Arduino IDE.

// If you use PlatformIO, you should set these build flags in your

// platformio.ini

// ==========================================================================

/** Start [defines] */

#ifndef TINY_GSM_RX_BUFFER

#define TINY_GSM_RX_BUFFER 64

#endif

#ifndef TINY_GSM_YIELD_MS

#define TINY_GSM_YIELD_MS 2

#endif

#ifndef MQTT_MAX_PACKET_SIZE

#define MQTT_MAX_PACKET_SIZE 256

#endif

/** End [defines] */

// ==========================================================================

// Include the libraries required for any data logger

// ==========================================================================

/** Start [includes] */

// The Arduino library is needed for every Arduino program.

#include <Arduino.h>

// EnableInterrupt is used by ModularSensors for external and pin change

// interrupts and must be explicitly included in the main program.

#include <EnableInterrupt.h>

// To get all of the base classes for ModularSensors, include LoggerBase.

// NOTE: Individual sensor definitions must be included separately.

#include <LoggerBase.h>

// Include the main header for ModularSensors

#include <ModularSensors.h>

/** End [includes] */

// ==========================================================================

// Data Logging Options

// ==========================================================================

/** Start [logging_options] */

// The name of this program file

const char* sketchName = "BWC_ALL_VAR_TS.ino";

// Logger ID, also becomes the prefix for the name of the data file on SD card

const char* LoggerID = "BWC";

// How frequently (in minutes) to log data

const uint8_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!

// Set the input and output pins for the logger

// NOTE: Use -1 for pins that do not apply

const long 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 (ie, button pin)

const int8_t wakePin = 31; // MCU interrupt/alarm pin to wake from sleep

// Mayfly 0.x D31 = A7

// Set the wake pin to -1 if you do not want the main processor to sleep.

// In a SAMD system where you are using the built-in rtc, set wakePin to 1

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 sensorPowerPin = 22; // MCU pin controlling main sensor power

/** End [logging_options] */

// ==========================================================================

// Wifi/Cellular Modem Options

// ==========================================================================

/** Start [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

// for Additional Serial Ports" section

const int32_t modemBaud =

9600; // SIM7080 does auto-bauding by default, but I set mine to 9600

// 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; // MCU pin controlling modem power

const int8_t modemStatusPin = 19; // MCU pin used to read modem status

//const bool useCTSforStatus = false; // Flag to use the modem CTS pin for status

//const int8_t modemResetPin = 20; // MCU pin connected to modem reset pin

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 (-1 if unconnected)

// Network connection information

const char* apn = "hologram"; // The APN for the 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 [xbee_cell_transparent] */

// ==========================================================================

// Using the Processor as a Sensor

// ==========================================================================

/** Start [processor_sensor] */

#include <sensors/ProcessorStats.h>

// Create the main processor chip "sensor" - for general metadata

const char* mcuBoardVersion = "v1.1b";

ProcessorStats mcuBoard(mcuBoardVersion);

/** End [processor_sensor] */

// ==========================================================================

// Maxim DS3231 RTC (Real Time Clock)

// ==========================================================================

/** Start [ds3231] */

#include <sensors/MaximDS3231.h>

// Create a DS3231 sensor object

MaximDS3231 ds3231(1);

/** End [ds3231] */

// ==========================================================================

// Campbell OBS 3 / OBS 3+ Analog Turbidity Sensor

// ==========================================================================

/** Start [vue10] */

#include <sensors/CampbellClariVUE10.h>

const char* ClariVUESDI12address = "2"; // The SDI-12 Address of the ClariVUE10

const int8_t ClariVUEPower = sensorPowerPin; // Power pin (-1 if unconnected)

const int8_t ClariVUEData = 7; // The SDI12 data pin

// NOTE: you should NOT take more than one readings. THe sensor already takes

// and averages 8 by default.

// Create a Campbell ClariVUE10 sensor object

CampbellClariVUE10 clarivue(*ClariVUESDI12address, ClariVUEPower, ClariVUEData);

/** End [vue10] */

// ==========================================================================

// Meter Hydros 21 Conductivity, Temperature, and Depth Sensor

// ==========================================================================

/** Start [hydros21] */

#include <sensors/MeterHydros21.h>

// NOTE: Use -1 for any pins that don't apply or aren't being used.

const char* hydros21SDI12address = "1"; // The SDI-12 Address of the Hydros21

const uint8_t hydros21NumberReadings = 6; // The number of readings to average

const int8_t hydros21Power = sensorPowerPin; // Power pin

const int8_t hydros21Data = 7; // The SDI12 data pin

// Create a Decagon Hydros21 sensor object

MeterHydros21 hydros21(*hydros21SDI12address, hydros21Power, hydros21Data,

hydros21NumberReadings);

/** End [hydros21] */

// ==========================================================================

// Decagon CTD-10 Conductivity, Temperature, and Depth Sensor

// ==========================================================================

/** Start [decagon_ctd] */

#include <sensors/DecagonCTD.h>

// NOTE: Use -1 for any pins that don't apply or aren't being used.

const char* CTDSDI12address = "1"; // The SDI-12 Address of the CTD

const uint8_t CTDNumberReadings = 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 Decagon CTD sensor object

DecagonCTD ctd(*CTDSDI12address, SDI12Power, SDI12Data, CTDNumberReadings);

/** End [decagon_ctd] */

#include <sensors/AtlasScientificDO.h>

// NOTE: Use -1 for any pins that don't apply or aren't being used.

const int8_t AtlasDOPower = sensorPowerPin; // Power pin

uint8_t AtlasDOi2c_addr = 0x61; // Default for DO is 0x61 (97)

// All Atlas sensors have different default I2C addresses, but any of them can

// be re-addressed to any 8 bit number. If using the default address for any

// Atlas Scientific sensor, you may omit this argument.

// Create an Atlas Scientific DO sensor object

// AtlasScientificDO atlasDO(AtlasDOPower, AtlasDOi2c_addr);

AtlasScientificDO atlasDO(AtlasDOPower);

#include <sensors/AtlasScientificEC.h>

// NOTE: Use -1 for any pins that don't apply or aren't being used.

const int8_t AtlasECPower = sensorPowerPin; // Power pin

uint8_t AtlasECi2c_addr = 0x64; // Default for pH is 0x63 (99)

// All Atlas sensors have different default I2C addresses, but any of them can

// be re-addressed to any 8 bit number. If using the default address for any

// Atlas Scientific sensor, you may omit this argument.

// Create an Atlas Scientific pH sensor object

// AtlasScientificpH atlaspH(AtlaspHPower, AtlaspHi2c_addr);

AtlasScientificEC atlasEC(AtlasECPower, AtlasECi2c_addr);

#include <sensors/AtlasScientificpH.h>

// NOTE: Use -1 for any pins that don't apply or aren't being used.

const int8_t AtlaspHPower = sensorPowerPin; // Power pin

uint8_t AtlaspHi2c_addr = 0x63; // Default for pH is 0x63 (99)

// All Atlas sensors have different default I2C addresses, but any of them can

// be re-addressed to any 8 bit number. If using the default address for any

// Atlas Scientific sensor, you may omit this argument.

// Create an Atlas Scientific pH sensor object

// AtlasScientificpH atlaspH(AtlaspHPower, AtlaspHi2c_addr);

AtlasScientificpH atlaspH(AtlaspHPower);

#include <sensors/AtlasScientificORP.h>

// NOTE: Use -1 for any pins that don't apply or aren't being used.

const int8_t AtlasORPPower = sensorPowerPin; // Power pin

uint8_t AtlasORPi2c_addr = 0x62; // Default for ORP is 0x62 (98)

// All Atlas sensors have different default I2C addresses, but any of them can

// be re-addressed to any 8 bit number. If using the default address for any

// Atlas Scientific sensor, you may omit this argument.

// Create an Atlas Scientific ORP sensor object

// AtlasScientificORP atlasORP(AtlasORPPower, AtlasORPi2c_addr);

AtlasScientificORP atlasORP(AtlasORPPower);

// ==========================================================================

// Creating the Variable Array[s] and Filling with Variable Objects

// ==========================================================================

/** Start [variable_arrays] */

Variable* variableList[] = {

new MeterHydros21_Temp(&hydros21),

new MeterHydros21_Depth(&hydros21),

new MeterHydros21_Cond(&hydros21),

// new DecagonCTD_Cond(&ctd),

// new DecagonCTD_Depth(&ctd),

// new DecagonCTD_Temp(&ctd),

// new CampbellOBS3_Turbidity(&osb3low, "", "TurbLow"),

// new CampbellOBS3_Turbidity(&osb3high, "", "TurbHigh"),

new ProcessorStats_Battery(&mcuBoard),

// new Modem_SignalPercent(&modem),

new MaximDS3231_Temp(&ds3231),

new CampbellClariVUE10_Turbidity(&clarivue),

new AtlasScientificDO_DOmgL(&atlasDO),

//new AtlasScientificDO_DOpct(&atlasDO),

// new AtlasScientificEC_Cond(&atlasEC),

// new AtlasScientificEC_Salinity(&atlasEC),

//new AtlasScientificEC_SpecificGravity(&atlasEC),

//new AtlasScientificEC_TDS(&atlasEC),

new AtlasScientificpH_pH(&atlaspH),

//new AtlasScientificORP_Potential(&atlasORP)

};

// All UUID's, 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 in the variable list!!!

// Be VERY certain that they match the order of your UUID's!

// Rearrange the variables in the variable list if necessary to match!

// *** CAUTION --- CAUTION --- CAUTION --- CAUTION --- CAUTION ***

const char *UUIDs[] = // UUID array for device sensors

{

"abcdefgh-1234-1234-1234-abcdefghijkl", // Electrical conductivity (Decagon_CTD-10_Cond)

"abcdefgh-1234-1234-1234-abcdefghijkl", // Water depth (Decagon_CTD-10_Depth)

"abcdefgh-1234-1234-1234-abcdefghijkl", // Temperature (Decagon_CTD-10_Temp)

"abcdefgh-1234-1234-1234-abcdefghijkl", // Battery voltage (EnviroDIY_Mayfly_Batt)

"abcdefgh-1234-1234-1234-abcdefghijkl", // Percent full scale (Digi_Cellular_SignalPercent)

"abcdefgh-1234-1234-1234-abcdefghijkl", // Temperature (Maxim_DS3231_Temp)

"abcdefgh-1234-1234-1234-abcdefghijkl" // Turbidity (Campbell_ClariVUE_Turbidity)

};

const char *registrationToken = "abcdefgh-1234-1234-1234-abcdefghijkl"; // Device registration token

const char *samplingFeature = "abcdefgh-1234-1234-1234-abcdefghijkl"; // Sampling feature UUID

// Count up the number of pointers in the array

int variableCount = sizeof(variableList) / sizeof(variableList[0]);

// Create the VariableArray object

VariableArray varArray(variableCount, variableList, UUIDs);

/** End [variable_arrays] */

// ==========================================================================

// The Logger Object[s]

// ==========================================================================

/** Start [loggers] */

// Create a new logger instance

Logger dataLogger(LoggerID, loggingInterval, &varArray);

/** End [loggers] */

// ==========================================================================

// Creating Data Publisher[s]

// ==========================================================================

/** Start [publishers] */

// Create a data publisher for the Monitor My Watershed/EnviroDIY POST endpoint

//#include <publishers/EnviroDIYPublisher.h>

//EnviroDIYPublisher EnviroDIYPOST(dataLogger, &modem.gsmClient,

// registrationToken, samplingFeature);

// Create a channel with fields on ThingSpeak in advance

// The fields will be sent in exactly the order they are in the variable array.

// Any custom name or identifier given to the field on ThingSpeak is irrelevant.

// No more than 8 fields of data can go to any one channel. Any fields beyond

// the eighth in the array will be ignored.

const char* thingSpeakChannelID =

"123456"; // The numeric channel id for your channel

const char* thingSpeakMQTTusername =

"abcdefgh-1234-1234-1234-abcdefghijkl"; //Your MQTT username

const char* thingSpeakMQTTpassword =

"abcdefgh-1234-1234-1234-abcdefghijkl"; //Your MQTT password

const char* thingSpeakMQTTclientID =

"abcdefgh-1234-1234-1234-abcdefghijkl"; //Your MQTT client ID

// Create a data publisher for ThingSpeak

#include <publishers/ThingSpeakPublisher.h>

ThingSpeakPublisher TsMqtt;

/** End [publishers] */

// ==========================================================================

// Working Functions

// ==========================================================================

/** Start [working_functions] */

// Flashes the LED's on the primary board

void greenredflash(uint8_t numFlash = 4, uint8_t rate = 75) {

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);

}

// Reads the battery voltage

// NOTE: This will actually return the battery level from the previous update!

float getBatteryVoltage() {

if (mcuBoard.sensorValues[0] == -9999) mcuBoard.update();

return mcuBoard.sensorValues[0];

}

// ==========================================================================

// Arduino Setup Function

// ==========================================================================

/** Start [setup] */

void setup() {

// Start the primary serial connection

Serial.begin(serialBaud);

// Print a start-up note to the first serial port

Serial.print(F("Now running "));

Serial.print(sketchName);

Serial.print(F(" on Logger "));

Serial.println(LoggerID);

Serial.println();

Serial.print(F("Using ModularSensors Library version "));

Serial.println(MODULAR_SENSORS_VERSION);

Serial.print(F("TinyGSM Library version "));

Serial.println(TINYGSM_VERSION);

Serial.println();

// Start the serial connection with the modem

modemSerial.begin(modemBaud);

// Set up pins for the LED's

pinMode(22, OUTPUT);

digitalWrite(22, HIGH);

pinMode(greenLED, OUTPUT);

digitalWrite(greenLED, LOW);

pinMode(redLED, OUTPUT);

digitalWrite(redLED, LOW);

// Blink the LEDs to show the board is on and starting up

greenredflash();

// Set the timezones for the logger/data and the RTC

// Logging in the given time zone

Logger::setLoggerTimeZone(timeZone);

// It is STRONGLY RECOMMENDED that you set the RTC to be in UTC (UTC+0)

Logger::setRTCTimeZone(0);

// Attach the modem and information pins to the logger

dataLogger.attachModem(modem);

modem.setModemLED(modemLEDPin);

dataLogger.setLoggerPins(wakePin, sdCardSSPin, sdCardPwrPin, buttonPin,

greenLED);

// Begin the variable array[s], logger[s], and publisher[s]

varArray.begin(variableCount, variableList);

dataLogger.begin(LoggerID, loggingInterval, &varArray);

TsMqtt.begin(dataLogger, &modem.gsmClient,

thingSpeakChannelID,

thingSpeakMQTTusername,

thingSpeakMQTTpassword,

thingSpeakMQTTclientID);

// Note: Please change these battery voltages to match your battery

// Set up the sensors, except at lowest battery level

if (getBatteryVoltage() > 3.4) {

Serial.println(F("Setting up sensors..."));

varArray.setupSensors();

}

/** Start [setup_sim7080] */

modem.setModemWakeLevel(HIGH); // ModuleFun Bee inverts the signal

modem.setModemResetLevel(HIGH); // ModuleFun Bee inverts the signal

Serial.println(F("Waking modem and setting Cellular Carrier Options..."));

modem.modemWake(); // NOTE: This will also set up the modem

modem.gsmModem.setBaud(modemBaud); // Make sure we're *NOT* auto-bauding!

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] */

// Sync the clock if it isn't valid or we have battery to spare

if (getBatteryVoltage() > 3.55 || !dataLogger.isRTCSane()) {

// Synchronize the RTC with NIST

// This will also set up the modem

dataLogger.syncRTC();

}

// 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) {

Serial.println(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

}

// Call the processor sleep

Serial.println(F("Putting processor to sleep\n"));

dataLogger.systemSleep();

}

/** End [setup] */

// ==========================================================================

// Arduino Loop Function

// ==========================================================================

/** Start [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) {

dataLogger.systemSleep();

}

// At moderate voltage, log data but don't send it over the modem

else if (getBatteryVoltage() < 3.55) {

dataLogger.logData();

}

// If the battery is good, send the data to the world

else {

dataLogger.logDataAndPublish();

}

/** End [loop] */

//Michael Daniel

//Lynchburg Water Resources

Author

Posts

Viewing 6 reply threads

You must be logged in to reply to this topic.