Reading from EEPROM error in code

This topic has 6 replies, 3 voices, and was last updated 2021-03-03 at 1:11 PM by Sara Damiano.

Viewing 6 reply threads

Author

Posts

2021-03-02 at 2:51 AM #15184

Participant

Hi,

I am trying to write some code to test some new low-cost sensors, including a DFRobot gravity conductivity sensor (https://www.dfrobot.com/product-1123.html). I have used snippets of DFRobot’s code, and built calculated variable functions in modular sensors to read data. In this case the DFRobor code uses a ‘k’ value as a crude calibration method, i.e. essentially a scaling factor. I use a separate calibration script to calculate the k value and store it in the EEPROM, which is retrieved upon initiation of the modular sensors program.

This method works if I build a script that only reads and returns the SpC value from the condy sensor. However, the same line of code returns an error when I combine it with the modular sensor code.

error: expected unqualified-id before '{' token
 #define EEPROM_read(address, p)  {int i = 0; byte *pp = (byte*)&(p);for(; i < sizeof(p); i++) pp[i]=EEPROM.read(address+i);}
                                ^

error: expected unqualified-id before '{' token

#define EEPROM_read(address, p) {int i = 0; byte *pp = (byte*)&(p);for(; i < sizeof(p); i++) pp[i]=EEPROM.read(address+i);}

If I comment out all the references to the EEPROM and use a defined k value instead (e.g. kvalue = 1), the modular sensors code compiles with no problems.

I usually like to work through coding issues myself but in this case I seem to be overlooking something seemingly simple. Can anyone see anything obvious that I am missing?

Thanks in advance for your help.

Regards,

James

My full modular sensor code (please forgive my inefficiencies, I am just learning c++) :

/*****************************************************************************
simple_logging.ino
Written By:  Sara Damiano (sdamiano@stroudcenter.org)
Development Environment: PlatformIO
Hardware Platform: EnviroDIY Mayfly Arduino Datalogger
Software License: BSD-3.
  Copyright (c) 2017, Stroud Water Research Center (SWRC)
  and the EnviroDIY Development Team

This sketch is an example of logging data to an SD card

DISCLAIMER:
THIS CODE IS PROVIDED "AS IS" - NO WARRANTY IS GIVEN.
*****************************************************************************/
// ==========================================================================
//    Defines for the Arduino IDE
//    In PlatformIO, set these build flags in your platformio.ini
// ==========================================================================
#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 240
#endif

// ==========================================================================
//    Include the base required libraries
// ==========================================================================
#include <Arduino.h>  // The base Arduino library
#include <EnableInterrupt.h>  // for external and pin change interrupts
#include <LoggerBase.h>  // The modular sensors library

#include <Adafruit_ADS1015.h>
Adafruit_ADS1115 ads;    /* Use this for the Mayfly because of the onboard 16-bit ADS1115  */

#include <EEPROM.h> // use this to get the K value from the EEPROM

//EEPROM READ KVALUE
#define EEPROM_read(address, p)  {int i = 0; byte *pp = (byte*)&(p);for(; i < sizeof(p); i++) pp[i]=EEPROM.read(address+i);}
#define KVALUEADDR 0x0F

#include <OneWire.h>
#include <DallasTemperature.h>
/********************************************************************/
// Data wire is plugged into pin 7 on the Arduino
#define ONE_WIRE_BUS 5 // For EnviroDIY Mayfly, I am using digital pin 7.
/********************************************************************/
// Setup a oneWire instance to communicate with any OneWire devices
// (not just Maxim/Dallas temperature ICs)
OneWire oneWire(ONE_WIRE_BUS);
/********************************************************************/
// Pass our oneWire reference to Dallas Temperature.
DallasTemperature sensors(&oneWire);
// ==========================================================================
//    Data Logger Settings
// ==========================================================================
// The name of this file
const char *sketchName = "Kopurererua_Taumata.ino";
// Logger ID, also becomes the prefix for the name of the data file on SD card
const char *LoggerID = "Kopurererua at Taumata Bridge";
// How frequently (in minutes) to log data
const uint8_t loggingInterval = 15;
// Your logger's timezone.
const int8_t timeZone = 12;  // Eastern Standard Time
// NOTE:  Daylight savings time will not be applied!  Please use standard time!


// ==========================================================================
//    Primary Arduino-Based Board and Processor
// ==========================================================================
#include <sensors/ProcessorStats.h>

const long serialBaud = 115200;   // Baud rate for the primary serial port for debugging
const int8_t greenLED = 8;        // MCU pin for the green LED (-1 if not applicable)
const int8_t redLED = 9;          // MCU pin for the red LED (-1 if not applicable)
const int8_t buttonPin = 21;      // MCU pin for a button to use to enter debugging mode  (-1 if not applicable)
const int8_t wakePin = A7;        // MCU interrupt/alarm pin to wake from sleep
// 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 (-1 if not applicable)
const int8_t sdCardSSPin = 12;      // MCU SD card chip select/slave select pin (must be given!)
const int8_t sensorPowerPin = 22;  // MCU pin controlling main sensor power (-1 if not applicable)

// Create the main processor chip "sensor" - for general metadata
const char *mcuBoardVersion = "v0.5b";
ProcessorStats mcuBoard(mcuBoardVersion);

// ==========================================================================
//    Wifi/Cellular Modem Settings
// ==========================================================================

// Create a reference to the serial port for the modem
HardwareSerial &modemSerial = Serial1;  // Use hardware serial if possible

// Modem Pins - Describe the physical pin connection of your modem to your board
const int8_t modemVccPin = -1;      // MCU pin controlling modem power (-1 if not applicable)
//const bool useCTSforStatus = false;  // Flag to use the XBee CTS pin for status
const int8_t modemStatusPin = 19;   // MCU pin used to read modem status (-1 if not applicable)
const int8_t modemResetPin = 20;    // MCU pin connected to modem reset pin (-1 if unconnected)
const int8_t modemSleepRqPin = 23;  // MCU pin used for modem sleep/wake request (-1 if not applicable)
const int8_t modemLEDPin = redLED;  // MCU pin connected an LED to show modem status (-1 if unconnected)

// // Network connection information

// Network connection information
const char *apn = "m2m";  // The APN for the gprs connection

// const char *wifiId = "Dare_Family";  // The WiFi access point, unnecessary for gprs
// const char *wifiPwd = "119HarveyStreet";  // The password for connecting to WiFi, unnecessary for gprs

// ==========================================================================
//    The modem object
//    Note:  Don't use more than one!
// ==========================================================================
//#elif defined MS_BUILD_TESTING && defined MS_BUILD_TEST_XBEE_LTE_B
// For the u-blox SARA R410M based Digi LTE-M XBee3
// NOTE:  According to the manual, this should be less stable than transparent
// mode, but my experience is the complete reverse.
#include <modems/DigiXBeeLTEBypass.h>
//#include <modems/SodaqDigiXBeeLTEBypass.h>

const long modemBaud = 9600;  // All XBee's use 9600 by default
const bool useCTSforStatus = false;   // Flag to use the XBee CTS pin for status
// NOTE:  If possible, use the STATUS/SLEEP_not (XBee pin 13) for status, but
// the CTS pin can also be used if necessary
DigiXBeeLTEBypass modemXBLTEB(&modemSerial,
                              modemVccPin, modemStatusPin, useCTSforStatus,
                              modemResetPin, modemSleepRqPin,
                              apn);
// Create an extra reference to the modem by a generic name (not necessary)
DigiXBeeLTEBypass modem = modemXBLTEB;
// ==========================================================================

// ==========================================================================
//    Conductvity sensor settings
// ==========================================================================
// //Cond sensor pins
const int SpCSensorPin = 3;
//const float Kvalue = -9999;//updated 05/11/2020
const float Kvalue = 1;
EEPROM_read(KVALUEADDR, Kvalue); //1.0 means no change to raw readings

 // ==========================================================================
 //    eTape sensor settings
 // ==========================================================================
 //
const int eTapeSensorPin = 1;

// ==========================================================================
//    Maxim DS3231 RTC (Real Time Clock)
// ==========================================================================
#include <sensors/MaximDS3231.h>  // Includes wrapper functions for Maxim DS3231 RTC

// Create a DS3231 sensor object, using this constructor function:
MaximDS3231 ds3231(1);

// ==========================================================================
//    pH sensor settings
// ==========================================================================
const int pHSensorPin = 3; //check pH sensor pin.

// ==========================================================================
//    Maxim DS18 One Wire Temperature Sensor
// ==========================================================================
#include <sensors/MaximDS18.h>
// OneWire Address [array of 8 hex characters]
// If only using a single sensor on the OneWire bus, you may omit the address
// DeviceAddress OneWireAddress1 = {0x28, 0xFF, 0xBD, 0xBA, 0x81, 0x16, 0x03, 0x0C};
const int8_t OneWirePower = sensorPowerPin;  // Pin to switch power on and off (-1 if unconnected)
const int8_t OneWireBus = 5;  // Pin attached to the OneWire Bus (-1 if unconnected) (D24 = A0)

// Create a Maxim DS18 sensor objects (use this form for a known address)
// MaximDS18 ds18(OneWireAddress1, OneWirePower, OneWireBus);

// Create a Maxim DS18 sensor object (use this form for a single sensor on bus with an unknown address)
MaximDS18 ds18(OneWirePower, OneWireBus);

// Create a temperature variable pointer for the DS18

//float ds18Temp = -9999;
Variable* ds18Temp =
        new MaximDS18_Temp(&ds18, "de727a28-dcf9-4502-97e1-40811172ccbf");

// ==========================================================================
//    eTape Water Level Sensor
// ==========================================================================
float getWL(int eTapePin)
{
  #define VREF 3.3      // analog reference voltage(Volt) of the ADC 3.3 or 5???
  #define SCOUNT 50           // number of sample points to collect for averaging
  float voltage;
  int analogBuffer[SCOUNT];    // store the analog value in the array, read from ADC
  int analogBufferTemp[SCOUNT];
  int analogBufferIndex = 0,  copyIndex = 0;
  digitalWrite(22, HIGH);

  while (analogBufferIndex < SCOUNT)   // read the sensor every 50 milliseconds, SCOUNT times and store in array
    {
       analogBuffer[analogBufferIndex] = ads.readADC_SingleEnded(eTapePin);    //read the analog value and store into the buffer
       analogBufferIndex++;
  //         if(analogBufferIndex == SCOUNT)
        delay(50u);  //delay 50 milliseconds between taking sample
    }
    analogBufferIndex = 0;

    for(copyIndex=0;copyIndex<SCOUNT;copyIndex++)  // for coppyIndex = 0 to SCOUNT-1
               analogBufferTemp[copyIndex]= analogBuffer[copyIndex]; // copy analogBuffer to analogBufferTemp

  voltage = (getMedianNum(analogBufferTemp,SCOUNT)*VREF)/17585.0; // read the analog value,
  //
  digitalWrite(22, LOW);
  return voltage; //this is where you would convert voltage to stage.
}

//=============================================================
// eTape as a calculated variable
//===========================================================

float calculateeTape(void)
{
float calculatedResult = -9999;  // Always safest to start with a bad value
//sensors.requestTemperatures();

//float temperature = sensors.getTempCByIndex(0);
//float temperature = MaximDS18_Temp(&ds18);
calculatedResult = getWL(eTapeSensorPin);
//alculatedResult = getSpc(Kvalue, SpCSensorPin);

  return calculatedResult;
}

// Properties of the calculated variable
const uint8_t calculatedVareTapeResolution = 2;  // The number of digits after the decimal place
const char *calculatedVareTapeName = "Gage height";  // This must be a value from http://vocabulary.odm2.org/variablename/
const char *calculatedVareTapeUnit = "cm";  // This must be a value from http://vocabulary.odm2.org/units/
const char *calculatedVareTapeCode = "WL";  // A short code for the variable
const char *calculatedVareTapeUUID = "ea95ead2-f3ff-4737-a145-cc844d2a5537";  // The (optional) universallly unique identifier

// Finally, Create a calculated variable pointer and return a variable pointer to it
Variable *eTapeVariable = new Variable(calculateeTape, calculatedVareTapeResolution,
                                       calculatedVareTapeName, calculatedVareTapeUnit,
                                       calculatedVareTapeCode, calculatedVareTapeUUID);

// ==========================================================================
//    Function for Specific Conductivity using the DFROBOT TDS sensor
// ==========================================================================
//Eventually I would like to add this to a library
// get SpC value from sensor
float getSpC(float Kvalue, int SpCSensorPin)
 {
//    --------------------------------------------------------
      #define VREF 3.3      // analog reference voltage(Volt) of the ADC
      #define SCOUNT 50           // number of sample points to collect for averaging
      int analogBuffer[SCOUNT];    // store the analog value in the array, read from ADC
      int analogBufferTemp[SCOUNT];
      int analogBufferIndex = 0,  copyIndex = 0;
      float averageVoltage = 0,  K = Kvalue;  // K is a crude calibration factor that can be used to tune the readings
      float SpC = -1.1;
      float ds18TempVal = ds18Temp ->getValue();

      digitalWrite(22, HIGH);

      while (analogBufferIndex < SCOUNT)   // read the sensor every 50 milliseconds, SCOUNT times and store in array
        {
           analogBuffer[analogBufferIndex] = ads.readADC_SingleEnded(SpCSensorPin);    //read the analog value and store into the buffer
           analogBufferIndex++;
            delay(50u);  //delay 50 milliseconds between taking sample
        }
      analogBufferIndex = 0;

      for(copyIndex=0;copyIndex<SCOUNT;copyIndex++)  // for coppyIndex = 0 to SCOUNT-1
                 analogBufferTemp[copyIndex]= analogBuffer[copyIndex]; // copy analogBuffer to analogBufferTemp
      averageVoltage = getMedianNum(analogBufferTemp,SCOUNT) * VREF /17585.0; // read the analog value,

      float compensationCoefficient=1.0+0.019*(ds18TempVal-25.0);    //temperature compensation formula: 0.019 used by YSI

            SpC= ( 133.42*averageVoltage*averageVoltage*averageVoltage
                 - 255.86*averageVoltage*averageVoltage
                 + 857.39*averageVoltage) /compensationCoefficient * K; //convert voltage value to SpC value, then correct for temp

  digitalWrite(22, LOW);
            return SpC;

}  // end of getSpC
//=============================================================
// Conductivity/TDS as a calculated variable
//===========================================================


float calculateConductivity(void)
{
float calculatedResult = -9999;  // Always safest to start with a bad value
//sensors.requestTemperatures();

calculatedResult = getSpC(Kvalue, SpCSensorPin);
//alculatedResult = getSpc(Kvalue, SpCSensorPin);

  return calculatedResult;
}

// Properties of the calculated variable
const uint8_t calculatedVarCondResolution = 2;  // The number of digits after the decimal place
const char *calculatedVarCondName = "Conductivity";  // This must be a value from http://vocabulary.odm2.org/variablename/
const char *calculatedVarCondUnit = "uS/cm";  // This must be a value from http://vocabulary.odm2.org/units/
const char *calculatedVarCondCode = "Cond";  // A short code for the variable
const char *calculatedVarCondUUID = "1c0765dd-cde9-4532-94aa-ac3596977a94";  // The (optional) universallly unique identifier

// Finally, Create a calculated variable pointer and return a variable pointer to it
Variable *ConductivityVariable = new Variable(calculateConductivity, calculatedVarCondResolution,
                                       calculatedVarCondName, calculatedVarCondUnit,
                                       calculatedVarCondCode, calculatedVarCondUUID);

// ==========================================================================
//    Function for pH
// ==========================================================================

float getpH(int pHSensorPin)
{

#define VREF 3.3      // analog reference voltage(Volt) of the ADC
#define SCOUNT 50           // number of sample points to collect for averaging
int analogBuffer[SCOUNT];    // store the analog value in the array, read from ADC
int analogBufferTemp[SCOUNT];
int analogBufferIndex = 0,  copyIndex = 0;
float averageVoltage = 0;
//int SpCSensorPin  = 3;
float pHValue = -9999;
#define Offset 0.11            //deviation compensate

digitalWrite(22, HIGH);

while (analogBufferIndex < SCOUNT)   // read the sensor every 50 milliseconds, SCOUNT times and store in array
  {
     analogBuffer[analogBufferIndex] = ads.readADC_SingleEnded(pHSensorPin);    //read the analog value and store into the buffer
     analogBufferIndex++;
      delay(50u);  //delay 50 milliseconds between taking sample
  }
analogBufferIndex = 0;

for(copyIndex=0;copyIndex<SCOUNT;copyIndex++)  // for coppyIndex = 0 to SCOUNT-1
           analogBufferTemp[copyIndex]= analogBuffer[copyIndex]; // copy analogBuffer to analogBufferTemp
averageVoltage = getMedianNum(analogBufferTemp,SCOUNT) * VREF /17585.0; // read the analog value,

pHValue = 3.5*averageVoltage+Offset;

digitalWrite(22, LOW);
return pHValue;

}

//=============================================================
// pH as a calculated variable
//===========================================================


float calculatepH(void)
{
float calculatedResult = -9999;  // Always safest to start with a bad value
calculatedResult = getpH(pHSensorPin);

  return calculatedResult;
}

// Properties of the calculated variable
const uint8_t calculatedVarpHResolution = 2;  // The number of digits after the decimal place
const char *calculatedVarpHName = "pH";  // This must be a value from http://vocabulary.odm2.org/variablename/
const char *calculatedVarpHUnit = "pH Units";  // This must be a value from http://vocabulary.odm2.org/units/
const char *calculatedVarpHCode = "pH";  // A short code for the variable
const char *calculatedVarpHUUID = "d0732a12-4201-4e7d-aa51-eef1adbc1e60";  // The (optional) universallly unique identifier

// Finally, Create a calculated variable pointer and return a variable pointer to it
Variable *pHVariable = new Variable(calculatepH, calculatedVarpHResolution,
                                       calculatedVarCondName, calculatedVarpHUnit,
                                       calculatedVarpHCode, calculatedVarpHUUID);


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

Variable *variableList[] = {
    //new ProcessorStats_SampleNumber(&mcuBoard),
    //new ProcessorStats_FreeRam(&mcuBoard),
    new ProcessorStats_Battery(&mcuBoard,"33641a78-a462-4ca1-a62c-4ea8ad4ec672"),
    //new MaximDS3231_Temp(&ds3231),
    new MaximDS18_Temp(&ds18,"de727a28-dcf9-4502-97e1-40811172ccbf"),
    ConductivityVariable,
    eTapeVariable,
    pHVariable


    // Additional sensor variables can be added here, by copying the syntax
    //   for creating the variable pointer (FORM1) from the <code>menu_a_la_carte.ino</code> example
    // The example code snippets in the wiki are primarily FORM2.
};
// Count up the number of pointers in the array
int variableCount = sizeof(variableList) / sizeof(variableList[0]);

// Create the VariableArray object
VariableArray varArray;


// ==========================================================================
//     The Logger Object[s]
// ==========================================================================

// Create a logger instance
Logger dataLogger;


// ==========================================================================
//    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);
}

//Median Funtion
// calculate a median for set of values in buffer
int getMedianNum(int bArray[], int iFilterLen)
{     int bTab[iFilterLen];
   for (byte i = 0; i<iFilterLen; i++)
 bTab[i] = bArray[i];                  // copy input array into BTab[] array
   int i, j, bTemp;
   for (j = 0; j < iFilterLen - 1; j++)        // put array in ascending order
   {  for (i = 0; i < iFilterLen - j - 1; i++)
       {  if (bTab[i] > bTab[i + 1])
           {  bTemp = bTab[i];
              bTab[i] = bTab[i + 1];
              bTab[i + 1] = bTemp;
            }
        }
   }
if ((iFilterLen & 1) > 0)  // check to see if iFilterlen is odd or even using & (bitwise AND) i.e if length &AND 1 is TRUE (>0)
     bTemp = bTab[(iFilterLen - 1) / 2];     // then then it is odd, and should take the central value
 else
    bTemp = (bTab[iFilterLen / 2] + bTab[iFilterLen / 2 - 1]) / 2;  // if even then take aveage of two central values
return bTemp;
} //end getmedianNum


// ==========================================================================
// Main setup function
// ==========================================================================
void setup()
{
    // Start the primary serial connection
    Serial.begin(serialBaud);
    ads.begin();//check
    //sensors.begin();

    //just checking the code for this
    //float kvaluecheck = -9999;
    //EEPROM_read(KVALUEADDR, kvaluecheck);
  //  Serial.print("EEPROM KVALUE:");
    //Serial.println(kvaluecheck);

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

    // Set up pins for the LED's
    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);

    // Set information pins
    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);

    // Set up the sensors
    Serial.println(F("Setting up sensors..."));
    varArray.setupSensors();

    // 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
    dataLogger.createLogFile(true);  // true = write a new header

    // Call the processor sleep
    dataLogger.systemSleep();
}

// ==========================================================================
// Main loop function
// ==========================================================================
void loop()
{
    dataLogger.logData();
}

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

/*****************************************************************************

simple_logging.ino

Written By: Sara Damiano (sdamiano@stroudcenter.org)

Development Environment: PlatformIO

Hardware Platform: EnviroDIY Mayfly Arduino Datalogger

Software License: BSD-3.

and the EnviroDIY Development Team

This sketch is an example of logging data to an SD card

DISCLAIMER:

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

*****************************************************************************/

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

// Defines for the Arduino IDE

// In PlatformIO, set these build flags in your platformio.ini

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

#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 240

#endif

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

// Include the base required libraries

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

#include <Arduino.h> // The base Arduino library

#include <EnableInterrupt.h> // for external and pin change interrupts

#include <LoggerBase.h> // The modular sensors library

#include <Adafruit_ADS1015.h>

Adafruit_ADS1115 ads; /* Use this for the Mayfly because of the onboard 16-bit ADS1115 */

#include <EEPROM.h> // use this to get the K value from the EEPROM

//EEPROM READ KVALUE

#define EEPROM_read(address, p) {int i = 0; byte *pp = (byte*)&(p);for(; i < sizeof(p); i++) pp[i]=EEPROM.read(address+i);}

#define KVALUEADDR 0x0F

#include <OneWire.h>

#include <DallasTemperature.h>

/********************************************************************/

// Data wire is plugged into pin 7 on the Arduino

#define ONE_WIRE_BUS 5 // For EnviroDIY Mayfly, I am using digital pin 7.

/********************************************************************/

// Setup a oneWire instance to communicate with any OneWire devices

// (not just Maxim/Dallas temperature ICs)

OneWire oneWire(ONE_WIRE_BUS);

/********************************************************************/

// Pass our oneWire reference to Dallas Temperature.

DallasTemperature sensors(&oneWire);

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

// Data Logger Settings

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

// The name of this file

const char *sketchName = "Kopurererua_Taumata.ino";

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

const char *LoggerID = "Kopurererua at Taumata Bridge";

// How frequently (in minutes) to log data

const uint8_t loggingInterval = 15;

// Your logger's timezone.

const int8_t timeZone = 12; // Eastern Standard Time

// NOTE: Daylight savings time will not be applied! Please use standard time!

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

// Primary Arduino-Based Board and Processor

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

#include <sensors/ProcessorStats.h>

const long serialBaud = 115200; // Baud rate for the primary serial port for debugging

const int8_t greenLED = 8; // MCU pin for the green LED (-1 if not applicable)

const int8_t redLED = 9; // MCU pin for the red LED (-1 if not applicable)

const int8_t buttonPin = 21; // MCU pin for a button to use to enter debugging mode (-1 if not applicable)

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

// 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 (-1 if not applicable)

const int8_t sdCardSSPin = 12; // MCU SD card chip select/slave select pin (must be given!)

const int8_t sensorPowerPin = 22; // MCU pin controlling main sensor power (-1 if not applicable)

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

const char *mcuBoardVersion = "v0.5b";

ProcessorStats mcuBoard(mcuBoardVersion);

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

// Wifi/Cellular Modem Settings

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

// Create a reference to the serial port for the modem

HardwareSerial &modemSerial = Serial1; // Use hardware serial if possible

// Modem Pins - Describe the physical pin connection of your modem to your board

const int8_t modemVccPin = -1; // MCU pin controlling modem power (-1 if not applicable)

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

const int8_t modemStatusPin = 19; // MCU pin used to read modem status (-1 if not applicable)

const int8_t modemResetPin = 20; // MCU pin connected to modem reset pin (-1 if unconnected)

const int8_t modemSleepRqPin = 23; // MCU pin used for modem sleep/wake request (-1 if not applicable)

const int8_t modemLEDPin = redLED; // MCU pin connected an LED to show modem status (-1 if unconnected)

// // Network connection information

// Network connection information

const char *apn = "m2m"; // The APN for the gprs connection

// const char *wifiId = "Dare_Family"; // The WiFi access point, unnecessary for gprs

// const char *wifiPwd = "119HarveyStreet"; // The password for connecting to WiFi, unnecessary for gprs

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

// The modem object

// Note: Don't use more than one!

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

//#elif defined MS_BUILD_TESTING && defined MS_BUILD_TEST_XBEE_LTE_B

// For the u-blox SARA R410M based Digi LTE-M XBee3

// NOTE: According to the manual, this should be less stable than transparent

// mode, but my experience is the complete reverse.

#include <modems/DigiXBeeLTEBypass.h>

//#include <modems/SodaqDigiXBeeLTEBypass.h>

const long modemBaud = 9600; // All XBee's use 9600 by default

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

// NOTE: If possible, use the STATUS/SLEEP_not (XBee pin 13) for status, but

// the CTS pin can also be used if necessary

DigiXBeeLTEBypass modemXBLTEB(&modemSerial,

modemVccPin, modemStatusPin, useCTSforStatus,

modemResetPin, modemSleepRqPin,

apn);

// Create an extra reference to the modem by a generic name (not necessary)

DigiXBeeLTEBypass modem = modemXBLTEB;

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

// Conductvity sensor settings

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

// //Cond sensor pins

const int SpCSensorPin = 3;

//const float Kvalue = -9999;//updated 05/11/2020

const float Kvalue = 1;

EEPROM_read(KVALUEADDR, Kvalue); //1.0 means no change to raw readings

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

// eTape sensor settings

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

const int eTapeSensorPin = 1;

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

// Maxim DS3231 RTC (Real Time Clock)

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

#include <sensors/MaximDS3231.h> // Includes wrapper functions for Maxim DS3231 RTC

// Create a DS3231 sensor object, using this constructor function:

MaximDS3231 ds3231(1);

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

// pH sensor settings

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

const int pHSensorPin = 3; //check pH sensor pin.

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

// Maxim DS18 One Wire Temperature Sensor

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

#include <sensors/MaximDS18.h>

// OneWire Address [array of 8 hex characters]

// If only using a single sensor on the OneWire bus, you may omit the address

// DeviceAddress OneWireAddress1 = {0x28, 0xFF, 0xBD, 0xBA, 0x81, 0x16, 0x03, 0x0C};

const int8_t OneWirePower = sensorPowerPin; // Pin to switch power on and off (-1 if unconnected)

const int8_t OneWireBus = 5; // Pin attached to the OneWire Bus (-1 if unconnected) (D24 = A0)

// Create a Maxim DS18 sensor objects (use this form for a known address)

// MaximDS18 ds18(OneWireAddress1, OneWirePower, OneWireBus);

// Create a Maxim DS18 sensor object (use this form for a single sensor on bus with an unknown address)

MaximDS18 ds18(OneWirePower, OneWireBus);

// Create a temperature variable pointer for the DS18

//float ds18Temp = -9999;

Variable* ds18Temp =

new MaximDS18_Temp(&ds18, "de727a28-dcf9-4502-97e1-40811172ccbf");

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

// eTape Water Level Sensor

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

float getWL(int eTapePin)

{

#define VREF 3.3 // analog reference voltage(Volt) of the ADC 3.3 or 5???

#define SCOUNT 50 // number of sample points to collect for averaging

float voltage;

int analogBuffer[SCOUNT]; // store the analog value in the array, read from ADC

int analogBufferTemp[SCOUNT];

int analogBufferIndex = 0, copyIndex = 0;

digitalWrite(22, HIGH);

while (analogBufferIndex < SCOUNT) // read the sensor every 50 milliseconds, SCOUNT times and store in array

{

analogBuffer[analogBufferIndex] = ads.readADC_SingleEnded(eTapePin); //read the analog value and store into the buffer

analogBufferIndex++;

// if(analogBufferIndex == SCOUNT)

delay(50u); //delay 50 milliseconds between taking sample

}

analogBufferIndex = 0;

for(copyIndex=0;copyIndex<SCOUNT;copyIndex++) // for coppyIndex = 0 to SCOUNT-1

analogBufferTemp[copyIndex]= analogBuffer[copyIndex]; // copy analogBuffer to analogBufferTemp

voltage = (getMedianNum(analogBufferTemp,SCOUNT)*VREF)/17585.0; // read the analog value,

digitalWrite(22, LOW);

return voltage; //this is where you would convert voltage to stage.

}

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

// eTape as a calculated variable

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

float calculateeTape(void)

{

float calculatedResult = -9999; // Always safest to start with a bad value

//sensors.requestTemperatures();

//float temperature = sensors.getTempCByIndex(0);

//float temperature = MaximDS18_Temp(&ds18);

calculatedResult = getWL(eTapeSensorPin);

//alculatedResult = getSpc(Kvalue, SpCSensorPin);

return calculatedResult;

}

// Properties of the calculated variable

const uint8_t calculatedVareTapeResolution = 2; // The number of digits after the decimal place

const char *calculatedVareTapeName = "Gage height"; // This must be a value from http://vocabulary.odm2.org/variablename/

const char *calculatedVareTapeUnit = "cm"; // This must be a value from http://vocabulary.odm2.org/units/

const char *calculatedVareTapeCode = "WL"; // A short code for the variable

const char *calculatedVareTapeUUID = "ea95ead2-f3ff-4737-a145-cc844d2a5537"; // The (optional) universallly unique identifier

// Finally, Create a calculated variable pointer and return a variable pointer to it

Variable *eTapeVariable = new Variable(calculateeTape, calculatedVareTapeResolution,

calculatedVareTapeName, calculatedVareTapeUnit,

calculatedVareTapeCode, calculatedVareTapeUUID);

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

// Function for Specific Conductivity using the DFROBOT TDS sensor

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

//Eventually I would like to add this to a library

// get SpC value from sensor

float getSpC(float Kvalue, int SpCSensorPin)

{

// --------------------------------------------------------

#define VREF 3.3 // analog reference voltage(Volt) of the ADC

#define SCOUNT 50 // number of sample points to collect for averaging

int analogBuffer[SCOUNT]; // store the analog value in the array, read from ADC

int analogBufferTemp[SCOUNT];

int analogBufferIndex = 0, copyIndex = 0;

float averageVoltage = 0, K = Kvalue; // K is a crude calibration factor that can be used to tune the readings

float SpC = -1.1;

float ds18TempVal = ds18Temp ->getValue();

digitalWrite(22, HIGH);

while (analogBufferIndex < SCOUNT) // read the sensor every 50 milliseconds, SCOUNT times and store in array

{

analogBuffer[analogBufferIndex] = ads.readADC_SingleEnded(SpCSensorPin); //read the analog value and store into the buffer

analogBufferIndex++;

delay(50u); //delay 50 milliseconds between taking sample

}

analogBufferIndex = 0;

for(copyIndex=0;copyIndex<SCOUNT;copyIndex++) // for coppyIndex = 0 to SCOUNT-1

analogBufferTemp[copyIndex]= analogBuffer[copyIndex]; // copy analogBuffer to analogBufferTemp

averageVoltage = getMedianNum(analogBufferTemp,SCOUNT) * VREF /17585.0; // read the analog value,

float compensationCoefficient=1.0+0.019*(ds18TempVal-25.0); //temperature compensation formula: 0.019 used by YSI

SpC= ( 133.42*averageVoltage*averageVoltage*averageVoltage

- 255.86*averageVoltage*averageVoltage

+ 857.39*averageVoltage) /compensationCoefficient * K; //convert voltage value to SpC value, then correct for temp

digitalWrite(22, LOW);

return SpC;

} // end of getSpC

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

// Conductivity/TDS as a calculated variable

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

float calculateConductivity(void)

{

float calculatedResult = -9999; // Always safest to start with a bad value

//sensors.requestTemperatures();

calculatedResult = getSpC(Kvalue, SpCSensorPin);

//alculatedResult = getSpc(Kvalue, SpCSensorPin);

return calculatedResult;

}

// Properties of the calculated variable

const uint8_t calculatedVarCondResolution = 2; // The number of digits after the decimal place

const char *calculatedVarCondName = "Conductivity"; // This must be a value from http://vocabulary.odm2.org/variablename/

const char *calculatedVarCondUnit = "uS/cm"; // This must be a value from http://vocabulary.odm2.org/units/

const char *calculatedVarCondCode = "Cond"; // A short code for the variable

const char *calculatedVarCondUUID = "1c0765dd-cde9-4532-94aa-ac3596977a94"; // The (optional) universallly unique identifier

// Finally, Create a calculated variable pointer and return a variable pointer to it

Variable *ConductivityVariable = new Variable(calculateConductivity, calculatedVarCondResolution,

calculatedVarCondName, calculatedVarCondUnit,

calculatedVarCondCode, calculatedVarCondUUID);

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

// Function for pH

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

float getpH(int pHSensorPin)

{

#define VREF 3.3 // analog reference voltage(Volt) of the ADC

#define SCOUNT 50 // number of sample points to collect for averaging

int analogBuffer[SCOUNT]; // store the analog value in the array, read from ADC

int analogBufferTemp[SCOUNT];

int analogBufferIndex = 0, copyIndex = 0;

float averageVoltage = 0;

//int SpCSensorPin = 3;

float pHValue = -9999;

#define Offset 0.11 //deviation compensate

digitalWrite(22, HIGH);

while (analogBufferIndex < SCOUNT) // read the sensor every 50 milliseconds, SCOUNT times and store in array

{

analogBuffer[analogBufferIndex] = ads.readADC_SingleEnded(pHSensorPin); //read the analog value and store into the buffer

analogBufferIndex++;

delay(50u); //delay 50 milliseconds between taking sample

}

analogBufferIndex = 0;

for(copyIndex=0;copyIndex<SCOUNT;copyIndex++) // for coppyIndex = 0 to SCOUNT-1

analogBufferTemp[copyIndex]= analogBuffer[copyIndex]; // copy analogBuffer to analogBufferTemp

averageVoltage = getMedianNum(analogBufferTemp,SCOUNT) * VREF /17585.0; // read the analog value,

pHValue = 3.5*averageVoltage+Offset;

digitalWrite(22, LOW);

return pHValue;

}

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

// pH as a calculated variable

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

float calculatepH(void)

{

float calculatedResult = -9999; // Always safest to start with a bad value

calculatedResult = getpH(pHSensorPin);

return calculatedResult;

}

// Properties of the calculated variable

const uint8_t calculatedVarpHResolution = 2; // The number of digits after the decimal place

const char *calculatedVarpHName = "pH"; // This must be a value from http://vocabulary.odm2.org/variablename/

const char *calculatedVarpHUnit = "pH Units"; // This must be a value from http://vocabulary.odm2.org/units/

const char *calculatedVarpHCode = "pH"; // A short code for the variable

const char *calculatedVarpHUUID = "d0732a12-4201-4e7d-aa51-eef1adbc1e60"; // The (optional) universallly unique identifier

// Finally, Create a calculated variable pointer and return a variable pointer to it

Variable *pHVariable = new Variable(calculatepH, calculatedVarpHResolution,

calculatedVarCondName, calculatedVarpHUnit,

calculatedVarpHCode, calculatedVarpHUUID);

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

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

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

Variable *variableList[] = {

//new ProcessorStats_SampleNumber(&mcuBoard),

//new ProcessorStats_FreeRam(&mcuBoard),

new ProcessorStats_Battery(&mcuBoard,"33641a78-a462-4ca1-a62c-4ea8ad4ec672"),

//new MaximDS3231_Temp(&ds3231),

new MaximDS18_Temp(&ds18,"de727a28-dcf9-4502-97e1-40811172ccbf"),

ConductivityVariable,

eTapeVariable,

pHVariable

// Additional sensor variables can be added here, by copying the syntax

// for creating the variable pointer (FORM1) from the <code>menu_a_la_carte.ino</code> example

// The example code snippets in the wiki are primarily FORM2.

};

// Count up the number of pointers in the array

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

// Create the VariableArray object

VariableArray varArray;

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

// The Logger Object[s]

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

// Create a logger instance

Logger dataLogger;

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

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

}

//Median Funtion

// calculate a median for set of values in buffer

int getMedianNum(int bArray[], int iFilterLen)

{ int bTab[iFilterLen];

for (byte i = 0; i<iFilterLen; i++)

bTab[i] = bArray[i]; // copy input array into BTab[] array

int i, j, bTemp;

for (j = 0; j < iFilterLen - 1; j++) // put array in ascending order

{ for (i = 0; i < iFilterLen - j - 1; i++)

{ if (bTab[i] > bTab[i + 1])

{ bTemp = bTab[i];

bTab[i] = bTab[i + 1];

bTab[i + 1] = bTemp;

}

if ((iFilterLen & 1) > 0) // check to see if iFilterlen is odd or even using & (bitwise AND) i.e if length &AND 1 is TRUE (>0)

bTemp = bTab[(iFilterLen - 1) / 2]; // then then it is odd, and should take the central value

else

bTemp = (bTab[iFilterLen / 2] + bTab[iFilterLen / 2 - 1]) / 2; // if even then take aveage of two central values

return bTemp;

} //end getmedianNum

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

// Main setup function

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

void setup()

{

// Start the primary serial connection

Serial.begin(serialBaud);

ads.begin();//check

//sensors.begin();

//just checking the code for this

//float kvaluecheck = -9999;

//EEPROM_read(KVALUEADDR, kvaluecheck);

// Serial.print("EEPROM KVALUE:");

//Serial.println(kvaluecheck);

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

// Set up pins for the LED's

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

// Set information pins

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

// Set up the sensors

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

varArray.setupSensors();

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

dataLogger.createLogFile(true); // true = write a new header

// Call the processor sleep

dataLogger.systemSleep();

}

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

// Main loop function

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

void loop()

{

dataLogger.logData();

}

2021-03-02 at 10:17 AM #15185
Sara Damiano
Moderator
I think you just missed commenting out one more reference to the EEPROM in line 144: EEPROM_read(KVALUEADDR, Kvalue); //1.0 means no change to raw readings. Just commenting or deleting that line should fix the compiler error. I would also suggest you delete lines 38-43 so you’re not even trying to include the unused EEPROM library.

If you wanted to, you could use the “extVoltage” sensor in ModularSensors with >1 reading to simplify all your code for reading the analog values. You would still need to create a calculated variable for the pH, conductivity, and eTape calculated from the voltage. There’s nothing wrong, though, with reading the value and doing the calculations just as you are.
2021-03-02 at 10:30 AM #15186
Sara Damiano
Moderator
If you’re still using the Arduino IDE, you might consider switching to VSCode (or Atom) with PlatformIO. I know VSCode seems very scary to start with, but if you’re writing new code or even just copy-pasting chunks the linting tools it provides are invaluable. When I created a project for your code in VSCode, it immediately highlighted the errant EEPROM line. I know when I try write code of any type without the linter, I always screw up and miss semicolons or other small errors that are really hard to find with your eyes reading the code but which the linter flags right away.
2021-03-02 at 3:08 PM #15187
James_NZ
Participant
Thanks @srgdamiano! I will try again when I get home from work.

I am using Atom with PlatformIO. How do I turn the linter tools on? thanks also for the tip on ‘extVoltage’. I was going to write a function that did the same thing as the unnecessary repetition was starting to bug me!

James
2021-03-03 at 2:47 AM #15190
James_NZ
Participant
Hi Sara,

I worked through this and everything compiles correctly now! Thanks for your help.

I did wonder about the linter in Atom. From what I have read there seems to be an issue with linters working with .ino files in Atom. Have you guys found anything that works?

James
2021-03-03 at 1:01 PM #15191
neilh20
Participant
In case its of interest, I’m using the EEPROMClass from EEPROM.h

\.platformio\packages\framework-arduino-avr\libraries\EEPROM\src

EEPROM.put(EP_PERSISTENT_STORE_ADDR, epc.app); where epc.app is a typedef containing all the values to be stored/read from persistent EEPROM.

and similarly

EEPROM.get(EP_PERSISTENT_STORE_ADDR, epc.app);
2021-03-03 at 1:11 PM #15192
Sara Damiano
Moderator
I’ve been using primarily VSCode for a while because it loads faster on my computer, but I believe I set Atom up to force ino’s as cpp’s: https://docs.platformio.org/en/latest/integration/ide/atom.html#force-arduino-file-as-c