Connecting SIM7080 to New Thingspeak

This topic has 7 replies, 4 voices, and was last updated 2022-01-12 at 2:03 PM by Zeke Holloman.

Viewing 7 reply threads

Author

Posts

2022-01-05 at 4:33 PM #16225
Zeke Holloman
Participant
@neilh20 @shicks @vogelrnws

Hi there! I recently received an email from Thingspeak stating that they are planning on shutting down their legacy Thingspeak server this month. I’m working to conv

@neilh20 @shicks @vogelrnws

Hi there! I recently received an email from Thingspeak stating that they are planning on shutting down their legacy Thingspeak server this month. I’m working to convert my Thingspeak channels over to from mqtt.thingspeak.com to mqtt3.thingspeak.com.

I’m using a Mayfly v1.0 alongside you all’s SIM7080 card. It publishs data to legacy ThingSpeak with no problems! I figured it would be just as simple as changing the website URL to “mqtt3.thingspeak.com”, but it’s proving more difficult than that. Have you all had any experience with this? Any suggestions are appreciated.

Thank you and have a good one!

More...

Less...
2022-01-05 at 6:18 PM #16226
Rick Vogel
Participant
Can you provide more details especially in reference to your code and how you are connecting to thingspeak?
2022-01-05 at 9:44 PM #16229
Sara Damiano
Moderator
Sorry, I coded up the ThingSpeak publisher ages ago only to prove to myself that I could get an MQTT publisher working. I’ve never used it beyond that. I don’t have a paid account so after

Sorry, I coded up the ThingSpeak publisher ages ago only to prove to myself that I could get an MQTT publisher working. I’ve never used it beyond that. I don’t have a paid account so after the trial period I was locked out and I’m not willing to do much testing on an account tied to my personal email.

Anyway, the code for ThingSpeak is in the ThingSpeak publisher in the publishers folder. It’s using PubSubClient under the hood. The outgoing message is formatted based on whatever the required structure was at the time. If that’s changed, then the whole formatting step will need to be rewritten.

I wouldn’t guess the restructuring of the json or whatever ThingSpeak wants would be too hard, but I don’t have time to look at it right now. If ThingSpeak now requires a secure connection (SSL, etc) or if they more want more metadata then there might need to be more tweaking for that.

More...

Less...
2022-01-06 at 3:16 PM #16237
neilh20
Participant
@zeke-holloman I agree with @srgdamiano, Mathworks have gone down the path of making it difficult to test a small number of devices against thingspeak, since it was added to ModularSensors publisher

@zeke-holloman I agree with @srgdamiano, Mathworks have gone down the path of making it difficult to test a small number of devices against thingspeak, since it was added to ModularSensors publishers.

A bit of shame since I’ve had some simple devices working reliably against it since 2013.

Also unfortunately, “the real world” is that testing is against a matrix – release ModularSensors xx.xx against thingspeak – so I think you are on the leading edge for ModularSensors Publisher v mqtt3.thingspeak 🙂

Taking a scan of their mqtt3, it seems like they are suggesting you create new devices when moving to their mqtt3 – so at a GUESS, that suggests they have a whole new server architecture and subscription management. So be great if you share results – stuff that doesn’t work is as valuable as stuff that does work.

When looking at a new service, its also useful to consider what it takes to prove how well it works and how far you want to go.

Typically new development goes in stages a) protoyping b) integration testing c) reliability/stability testing.

MMW has a lot of capability, and very mature, but in the “reliability testing” of Mayfly 0.5 and Digi LTE CAT-M1 modems, from a debug analysis, there is a possible timing problem with the tinyGSM device driver https://github.com/EnviroDIY/ModularSensors/issues/396 – which suggests that if the MMW servers response where a lot faster, faster than the current fastest 1.2seconds, it might break the current deployments with Digi LTE-CAT-M1 XB3-C-A2-UT-001. Its what happens in testing sometimes.

I’ve had very good experience so far with “reliability/stability testing” of ModularSensors 0.32.2/(Mayfly 0.5+ Digi LTE-CAT-M1), but the server response through the cellphone network is pretty slow, at its fastest 1.2seconds.

For mqtt3.thingspeak you are back to “a)prototyping”.

For another wireless protocol LoRa/Thingsnetwork, with max payload of 51bytes, which seems unlikely that it could work with MMW API, I’m checking out Arduino.cc mqtt/IoT or Adafruit mqtt as having plans for smaller devices. So I would describe I’m trying to figure how to prototype that interface.

I should note – https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.32.2 doesn’t identify what features work with new Mayfly 1.0A3 boards. The modem SIM7080 , isn’t identified as being supported yet, or tested with ModularSensors – though as its open source we can all see what’s in the software. I guess, user test at their own risk.

I have only done minimal testing on Mayfly 1.0A3, as its typical for organizations to announce what they support and regression testing. My testing, is with a student capstone project as a standalone sensor so far, though they should get to cellular LTE integration soon. On paper analysis I’ve identified a potential comms issues with Mayfly1.0A3 – see https://github.com/EnviroDIY/EnviroDIY_Mayfly_Logger/issues

I’m making ModularSensors detect in runtime whether its Mayfly 0.5 or 1.0 – so the user/program doesn’t have to compile for one or the other.

More...

Less...

2022-01-07 at 5:03 PM #16244

Zeke Holloman

Participant

@neilh20 @shicks @vogelrnws

Hi all! Thank you for all of your feedback and tips! I spent some time this week looking at the mqtt3.thingspeak.com server and I was able to get a channel up and running

@neilh20 @shicks @vogelrnws

Hi all! Thank you for all of your feedback and tips! I spent some time this week looking at the mqtt3.thingspeak.com server and I was able to get a channel up and running on it.

Overall, it’s not drastically different than mqtt.thingspeak.com. The main aspect being removed in the legacy Thingspeak server is the API keys. Thingspeak now relies on the Channel ID, the client ID, the username, and the password to send data to a specific channel.

There are also a few formatting changes for sending the data, which can be found on this site, under July 2021:

https://www.mathworks.com/help/thingspeak/release-notes.html#:~:text=July%25202021-,MQTT3%2520Interface,-A%2520new%2520ThingSpeak

I did end up editing the ThingSpeakPublisher library in order to get the data to upload correctly, but I don’t think I had to change the data type.

Here’s the Arduino code:

/** =========================================================================
 * @file DRWI_sim7080LTE.ino
 * @brief Example for DRWI CitSci LTE sites.
 *
 * This example shows proper settings for the following configuration:
 *
 * Mayfly v1.0 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-2021 Stroud Water Research Center (SWRC)
 *                          and the EnviroDIY Development Team
 *            This example is published under the BSD-3 license.
 *
 * 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>

// 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 = "thingspeaksingular_mayfly_1point0_GW1.ino";
// Logger ID, also becomes the prefix for the name of the data file on SD card
const char* LoggerID = "logger";
// How frequently (in minutes) to log data
const uint8_t loggingInterval = 1;
// 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 int32_t serialBaud = 115200;   // Baud rate for debugging
const int8_t  greenLED   = 8;       // Pin for the green LED
const int8_t  redLED     = 9;       // Pin for the red LED
const int8_t  buttonPin  = 21;      // Pin for debugging mode (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>

#define modemSerial Serial1

// NOTE: Extra hardware and software serial ports are created in the "Settings
// for Additional Serial Ports" section
const int32_t modemBaud =    9600;  //  SIM7080 does auto-bauding by default, but for simplicity we set 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 --- Pin 18 is the power enable pin for the bee socket on Mayfly v1.0,
                                   //  use -1 if using Mayfly 0.5b or if the bee socket is constantly powered (ie you changed SJ18 on Mayfly1.0 to 3.3v)
const int8_t modemStatusPin  = 19;  // MCU pin used to read modem status
const int8_t modemSleepRqPin = 23;  // MCU pin for modem sleep/wake request
const int8_t modemLEDPin = redLED;  // MCU pin connected an LED to show modem
                                    // status

// Network connection information
const char* apn = "hologram";  // APN connection name, typically Hologram unless you have a different provider's SIM card. Change as needed

// 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 [sim7080] */
// ==========================================================================

// ==========================================================================
//  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 = "v0.5b";  // is only used for onboard battery voltage calculation,
                                          // "v0.5b" is safe to use on Mayfly v1.0 boards because the formula is the same
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] */


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

const char*   hydrosSDI12address = "1";  // The SDI-12 Address of the Hydros 21
const uint8_t hydrosNumberReadings = 6;  // The number of readings to average
const int8_t  SDI12Power = sensorPowerPin;  // Power pin (-1 if unconnected)
const int8_t  SDI12Data  = 7;               // The SDI12 data pin

// Create a Meter Hydros 21 sensor object
MeterHydros21 hydros(*hydrosSDI12address, SDI12Power, SDI12Data,
                     hydrosNumberReadings);
/** End [hydros21] */

Variable *Hydros21_TempF = new MeterHydros21_Temp(&hydros, "12345678-abcd-1234-ef00-1234567890ab");
//Hydros temperature in degrees Fahrenheit

float calculateHydros21degF(void) {
  float MeterHydros21_TempC = Hydros21_TempF->getValue();
  float MeterHydros21_TempF = MeterHydros21_TempC*(1.8)+32;
  if (MeterHydros21_TempC == -9999) {
      MeterHydros21_TempF = -9999;
  }
  return MeterHydros21_TempF;
}

const char* Hydros21TempFVarName = "Temperature";
const char *Hydros21TempVarFUnit = "Degree";
int Hydros21TempFVarResolution = 2;
const char *Hydros21TempFUUID = "12345678-abcd-1234-ef00-1234567890ab";
const char *Hydros21TempFVarCode = "Hydros21TempF";

Variable *HydrosCalcTempF = new Variable(calculateHydros21degF, Hydros21TempFVarResolution,
  Hydros21TempFVarName, Hydros21TempVarFUnit, Hydros21TempFVarCode, Hydros21TempFUUID);




Variable *Hydros21_Depthft = new MeterHydros21_Depth(&hydros, "12345678-abcd-1234-ef00-1234567890ab");
//Hydros temperature in degrees Fahrenheit

float calculateHydros21feet(void) {
  float MeterHydros21_Depth_mm = Hydros21_Depthft->getValue();
  float MeterHydros21_Depth_ft = MeterHydros21_Depth_mm/304.8;
  if (MeterHydros21_Depth_mm == -9999) {
      MeterHydros21_Depth_ft = -9999;
  }
  return MeterHydros21_Depth_ft;
}

const char* Hydros21DepthftVarName = "Depth";
const char *Hydros21DepthftVarUnit = "Feet";
int Hydros21DepthftVarResolution = 2;
const char *Hydros21DepthftUUID = "12345678-abcd-1234-ef00-1234567890ab";
const char *Hydros21DepthftVarCode = "Hydros21Depthft";

Variable *HydrosCalcDepthft = new Variable(calculateHydros21feet, Hydros21DepthftVarResolution,
  Hydros21DepthftVarName, Hydros21DepthftVarUnit, Hydros21DepthftVarCode, Hydros21DepthftUUID);

// ==========================================================================
//  Campbell OBS 3 / OBS 3+ Analog Turbidity Sensor
// ==========================================================================
/** Start [obs3] */

// ==========================================================================
//  Creating the Variable Array[s] and Filling with Variable Objects
// ==========================================================================
/** Start [variable_arrays] */
Variable* variableList[] = {
    new MeterHydros21_Cond(&hydros),
    HydrosCalcTempF,
    HydrosCalcDepthft,
    new ProcessorStats_Battery(&mcuBoard),
};

// 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 ABOVE if necessary to match!
// Do not change the order of the variables in the section below.
// *** CAUTION --- CAUTION --- CAUTION --- CAUTION --- CAUTION ***

// Replace all of the text in the following section with the UUID array from MonitorMyWatershed

// ---------------------   Beginning of Token UUID List   ---------------------------------------



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

// Create the VariableArray object
VariableArray varArray;
/** End [variable_arrays] */


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


// ==========================================================================
//  Creating Data Publisher[s]
// ==========================================================================
// 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.

//Will be removed in a future iteration of thingspeak
const char* thingSpeakChannelID =
    "INPUT_CHANNEL_ID_HERE";  // The numeric channel id for your channel
const char* thingSpeakMQTTusername =
    "INPUT_USERNAME_HERE"; //Your MQTT username
const char* thingSpeakMQTTpassword =
    "INPUT_PASSWORD_HERE"; //Your MQTT password
const char* thingSpeakMQTTclientID =
    "INPUT_CLIENT_ID_HERE"; //Your MQTT client ID

// Create a data publisher for ThingSpeak
#include <publishers/ThingSpeakPublisher.h>
ThingSpeakPublisher TsMqtt;
/** End [loggers] */


// ==========================================================================
//  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(greenLED, OUTPUT);
    digitalWrite(greenLED, LOW);
    pinMode(redLED, OUTPUT);
    digitalWrite(redLED, LOW);
    // Blink the LEDs to show the board is on and starting up
    greenredflash();

    pinMode(20, OUTPUT);   //for proper operation of the onboard flash memory chip's ChipSelect (Mayfly v1.0 and later)

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

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

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

* @file DRWI_sim7080LTE.ino

* @brief Example for DRWI CitSci LTE sites.

* This example shows proper settings for the following configuration:

* Mayfly v1.0 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.

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

// 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 = "thingspeaksingular_mayfly_1point0_GW1.ino";

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

const char* LoggerID = "logger";

// How frequently (in minutes) to log data

const uint8_t loggingInterval = 1;

// 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 int32_t serialBaud = 115200; // Baud rate for debugging

const int8_t greenLED = 8; // Pin for the green LED

const int8_t redLED = 9; // Pin for the red LED

const int8_t buttonPin = 21; // Pin for debugging mode (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>

#define modemSerial Serial1

// NOTE: Extra hardware and software serial ports are created in the "Settings

// for Additional Serial Ports" section

const int32_t modemBaud = 9600; // SIM7080 does auto-bauding by default, but for simplicity we set 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 --- Pin 18 is the power enable pin for the bee socket on Mayfly v1.0,

// use -1 if using Mayfly 0.5b or if the bee socket is constantly powered (ie you changed SJ18 on Mayfly1.0 to 3.3v)

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

const int8_t modemSleepRqPin = 23; // MCU pin for modem sleep/wake request

const int8_t modemLEDPin = redLED; // MCU pin connected an LED to show modem

// status

// Network connection information

const char* apn = "hologram"; // APN connection name, typically Hologram unless you have a different provider's SIM card. Change as needed

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

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

// 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 = "v0.5b"; // is only used for onboard battery voltage calculation,

// "v0.5b" is safe to use on Mayfly v1.0 boards because the formula is the same

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

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

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

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

/** Start [hydros21] */

#include <sensors/MeterHydros21.h>

const char* hydrosSDI12address = "1"; // The SDI-12 Address of the Hydros 21

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

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

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

// Create a Meter Hydros 21 sensor object

MeterHydros21 hydros(*hydrosSDI12address, SDI12Power, SDI12Data,

hydrosNumberReadings);

/** End [hydros21] */

Variable *Hydros21_TempF = new MeterHydros21_Temp(&hydros, "12345678-abcd-1234-ef00-1234567890ab");

//Hydros temperature in degrees Fahrenheit

float calculateHydros21degF(void) {

float MeterHydros21_TempC = Hydros21_TempF->getValue();

float MeterHydros21_TempF = MeterHydros21_TempC*(1.8)+32;

if (MeterHydros21_TempC == -9999) {

MeterHydros21_TempF = -9999;

}

return MeterHydros21_TempF;

}

const char* Hydros21TempFVarName = "Temperature";

const char *Hydros21TempVarFUnit = "Degree";

int Hydros21TempFVarResolution = 2;

const char *Hydros21TempFUUID = "12345678-abcd-1234-ef00-1234567890ab";

const char *Hydros21TempFVarCode = "Hydros21TempF";

Variable *HydrosCalcTempF = new Variable(calculateHydros21degF, Hydros21TempFVarResolution,

Hydros21TempFVarName, Hydros21TempVarFUnit, Hydros21TempFVarCode, Hydros21TempFUUID);

Variable *Hydros21_Depthft = new MeterHydros21_Depth(&hydros, "12345678-abcd-1234-ef00-1234567890ab");

//Hydros temperature in degrees Fahrenheit

float calculateHydros21feet(void) {

float MeterHydros21_Depth_mm = Hydros21_Depthft->getValue();

float MeterHydros21_Depth_ft = MeterHydros21_Depth_mm/304.8;

if (MeterHydros21_Depth_mm == -9999) {

MeterHydros21_Depth_ft = -9999;

}

return MeterHydros21_Depth_ft;

}

const char* Hydros21DepthftVarName = "Depth";

const char *Hydros21DepthftVarUnit = "Feet";

int Hydros21DepthftVarResolution = 2;

const char *Hydros21DepthftUUID = "12345678-abcd-1234-ef00-1234567890ab";

const char *Hydros21DepthftVarCode = "Hydros21Depthft";

Variable *HydrosCalcDepthft = new Variable(calculateHydros21feet, Hydros21DepthftVarResolution,

Hydros21DepthftVarName, Hydros21DepthftVarUnit, Hydros21DepthftVarCode, Hydros21DepthftUUID);

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

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

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

/** Start [obs3] */

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

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

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

/** Start [variable_arrays] */

Variable* variableList[] = {

new MeterHydros21_Cond(&hydros),

HydrosCalcTempF,

HydrosCalcDepthft,

new ProcessorStats_Battery(&mcuBoard),

};

// 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 ABOVE if necessary to match!

// Do not change the order of the variables in the section below.

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

// Replace all of the text in the following section with the UUID array from MonitorMyWatershed

// --------------------- Beginning of Token UUID List ---------------------------------------

// Count up the number of pointers in the array

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

// Create the VariableArray object

VariableArray varArray;

/** End [variable_arrays] */

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

// The Logger Object[s]

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

/** Start [loggers] */

// Create a logger instance

Logger dataLogger(LoggerID, loggingInterval, &varArray);

/** End [loggers] */

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

// Creating Data Publisher[s]

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

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

//Will be removed in a future iteration of thingspeak

const char* thingSpeakChannelID =

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

const char* thingSpeakMQTTusername =

"INPUT_USERNAME_HERE"; //Your MQTT username

const char* thingSpeakMQTTpassword =

"INPUT_PASSWORD_HERE"; //Your MQTT password

const char* thingSpeakMQTTclientID =

"INPUT_CLIENT_ID_HERE"; //Your MQTT client ID

// Create a data publisher for ThingSpeak

#include <publishers/ThingSpeakPublisher.h>

ThingSpeakPublisher TsMqtt;

/** End [loggers] */

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

// 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(greenLED, OUTPUT);

digitalWrite(greenLED, LOW);

pinMode(redLED, OUTPUT);

digitalWrite(redLED, LOW);

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

greenredflash();

pinMode(20, OUTPUT); //for proper operation of the onboard flash memory chip's ChipSelect (Mayfly v1.0 and later)

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

More...

2022-01-07 at 5:11 PM #16245

Zeke Holloman

Participant

/**
 * @file ThingSpeakPublisher.cpp
 * @copyright 2020 Stroud Water Research Center
 * Part of the EnviroDIY ModularSensors library for Arduino
 * @author Sara G

/**

* @file ThingSpeakPublisher.cpp

* Part of the EnviroDIY ModularSensors library for Arduino

* @author Sara G

/**
 * @file ThingSpeakPublisher.cpp
 * @copyright 2020 Stroud Water Research Center
 * Part of the EnviroDIY ModularSensors library for Arduino
 * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
 *
 * @brief Implements the ThingSpeakPublisher class.
 */

#include "ThingSpeakPublisher.h"


// ============================================================================
//  Functions for the EnviroDIY data portal receivers.
// ============================================================================

// Constant values for MQTT publish
// I want to refer to these more than once while ensuring there is only one copy
// in memory
const char* ThingSpeakPublisher::mqttServer     = "mqtt3.thingspeak.com";
const int   ThingSpeakPublisher::mqttPort       = 1883;
const char* ThingSpeakPublisher::mqttClientID =   THING_SPEAK_CLIENT_ID;
const char* ThingSpeakPublisher::mqttUser       = THING_SPEAK_USER_NAME;
const char* ThingSpeakPublisher::mqttPass       = THING_SPEAK_PASS_WORD;


// Constructors
ThingSpeakPublisher::ThingSpeakPublisher() : dataPublisher() {
    // MS_DBG(F("ThingSpeakPublisher object created"));
    _thingSpeakChannelID  = NULL;
    _thingSpeakUsername   = NULL;
    _thingSpeakPassword   = NULL;
    _thingSpeakClientID   = NULL;
}
ThingSpeakPublisher::ThingSpeakPublisher(Logger& baseLogger, uint8_t sendEveryX,
                                         uint8_t sendOffset)
    : dataPublisher(baseLogger, sendEveryX, sendOffset) {
    // MS_DBG(F("ThingSpeakPublisher object created"));
    _thingSpeakChannelID  = NULL;
    _thingSpeakUsername   = NULL;
    _thingSpeakPassword   = NULL;
    _thingSpeakClientID   = NULL;
}
ThingSpeakPublisher::ThingSpeakPublisher(Logger& baseLogger, Client* inClient,
                                         uint8_t sendEveryX, uint8_t sendOffset)
    : dataPublisher(baseLogger, inClient, sendEveryX, sendOffset) {
    // MS_DBG(F("ThingSpeakPublisher object created"));
    _thingSpeakChannelID  = NULL;
    _thingSpeakUsername   = NULL;
    _thingSpeakPassword   = NULL;
    _thingSpeakClientID   = NULL;
}
ThingSpeakPublisher::ThingSpeakPublisher(Logger& baseLogger,
                                         const char* thingSpeakChannelID,
                                         const char* thingSpeakUsername,
                                         const char* thingSpeakPassword,
                                         const char* thingSpeakClientID,
                                         uint8_t sendEveryX, uint8_t sendOffset)
    : dataPublisher(baseLogger, sendEveryX, sendOffset) {
    setChannelID(thingSpeakChannelID);
    setUsername(thingSpeakUsername);
    setPassword(thingSpeakPassword);
    setClientID(thingSpeakClientID);
    // MS_DBG(F("ThingSpeakPublisher object created"));
}
ThingSpeakPublisher::ThingSpeakPublisher(Logger& baseLogger, Client* inClient,
                                         const char* thingSpeakChannelID,
                                         const char* thingSpeakUsername,
                                         const char* thingSpeakPassword,
                                         const char* thingSpeakClientID,
                                         uint8_t sendEveryX, uint8_t sendOffset)
    : dataPublisher(baseLogger, inClient, sendEveryX, sendOffset) {
    setChannelID(thingSpeakChannelID);
    setUsername(thingSpeakUsername);
    setPassword(thingSpeakPassword);
    setClientID(thingSpeakClientID);
    // MS_DBG(F("ThingSpeakPublisher object created"));
}
// Destructor
ThingSpeakPublisher::~ThingSpeakPublisher() {}

void ThingSpeakPublisher::setChannelID(const char* thingSpeakChannelID) {
    _thingSpeakChannelID = thingSpeakChannelID;
    // MS_DBG(F("Channel ID set!"));
}


void ThingSpeakPublisher::setUsername(const char* thingSpeakUsername) {
    _thingSpeakUsername = thingSpeakUsername;
    // MS_DBG(F("Username set!"));
}

void ThingSpeakPublisher::setPassword(const char* thingSpeakPassword) {
    _thingSpeakPassword = thingSpeakPassword;
    // MS_DBG(F("Password set!"));
}

void ThingSpeakPublisher::setClientID(const char* thingSpeakClientID) {
    _thingSpeakClientID = thingSpeakClientID;
    // MS_DBG(F("Client ID set!"));
}


// Sets all 3 ThingSpeak parameters
void ThingSpeakPublisher::setThingSpeakParams(const char* channelID,
                                              const char* Username,
                                              const char* Password,
                                              const char* ClientID) {
    setChannelID(channelID);
    setUsername(Username);
    setPassword(Password);
    setClientID(ClientID);

}


// A way to begin with everything already set
void ThingSpeakPublisher::begin(Logger& baseLogger, Client* inClient,
                                const char* thingSpeakChannelID,
                                const char* thingSpeakUsername,
                                const char* thingSpeakPassword,
                                const char* thingSpeakClientID
                              ) {
    setChannelID(thingSpeakChannelID);
    setUsername(thingSpeakUsername);
    setPassword(thingSpeakPassword);
    setClientID(thingSpeakClientID);
    dataPublisher::begin(baseLogger, inClient);
}
void ThingSpeakPublisher::begin(Logger& baseLogger,
                                const char* thingSpeakChannelID,
                                const char* thingSpeakUsername,
                                const char* thingSpeakPassword,
                                const char* thingSpeakClientID
                              ) {
    setChannelID(thingSpeakChannelID);
    setUsername(thingSpeakUsername);
    setPassword(thingSpeakPassword);
    setClientID(thingSpeakClientID);
    dataPublisher::begin(baseLogger);
}


// This sends the data to ThingSpeak
// bool ThingSpeakPublisher::mqttThingSpeak(void)
int16_t ThingSpeakPublisher::publishData(Client* outClient) {
    bool retVal = false;

    // Make sure we don't have too many fields
    // A channel can have a max of 8 fields
    if (_baseLogger->getArrayVarCount() > 8) {
        MS_DBG(F("No more than 8 fields of data can be sent to a single "
                 "ThingSpeak channel!"));
        MS_DBG(F("Only the first 8 fields worth of data will be sent."));
    }
    uint8_t numChannels = min(_baseLogger->getArrayVarCount(), 8);
    MS_DBG(numChannels, F("fields will be sent to ThingSpeak"));

    // Create a buffer for the portions of the request and response
    char tempBuffer[26] = "";

    char topicBuffer[25] = "channels/"; //was 42
    strcat(topicBuffer, _thingSpeakChannelID);
    strcat(topicBuffer, "/publish");
    //MS_DBG(F("Topic ["), strlen(topicBuffer), F("]:"), String(topicBuffer));

    emptyTxBuffer();

    _baseLogger->formatDateTime_ISO8601(Logger::markedEpochTime)
        .toCharArray(tempBuffer, 26);
    strcat(txBuffer, "#P");
    strcat(txBuffer, "created_at=");
    strcat(txBuffer, tempBuffer);
    txBuffer[strlen(txBuffer)] = '&';

    for (uint8_t i = 0; i < numChannels; i++) {
        strcat(txBuffer, "field");
        itoa(i + 1, tempBuffer, 10);  // BASE 10
        strcat(txBuffer, tempBuffer);
        txBuffer[strlen(txBuffer)] = '=';
        _baseLogger->getValueStringAtI(i).toCharArray(tempBuffer, 26);
        strcat(txBuffer, tempBuffer);
        if (i + 1 != numChannels) { txBuffer[strlen(txBuffer)] = '&'; }
    }
    //strcat(txBuffer, "&status=MQTTPUBLISH");
    MS_DBG(F("Message ["), strlen(txBuffer), F("]:"), String(txBuffer));

    // Set the client connection parameters
    _mqttClient.setClient(*outClient);
    _mqttClient.setServer(mqttServer, mqttPort);

    // Make sure any previous TCP connections are closed
    // NOTE:  The PubSubClient library used for MQTT connect assumes that as
    // long as the client is connected, it must be connected to the right place.
    // Closing any stray client sockets here ensures that a new client socket
    // is opened to the right place.
    // client is connected when a different socket is open
    if (outClient->connected()) { outClient->stop(); }

    // Make the MQTT connection
    // Note:  the client id and the user name do not mean anything for
    // ThingSpeak
    MS_DBG(F("Opening MQTT Connection"));
    MS_START_DEBUG_TIMER;
    if (_mqttClient.connect(_thingSpeakClientID, _thingSpeakUsername, _thingSpeakPassword)) {
        MS_DBG(F("MQTT connected after"), MS_PRINT_DEBUG_TIMER, F("ms"));

        if (_mqttClient.publish(topicBuffer, txBuffer)) {
            PRINTOUT(F("ThingSpeak topic published!  Current state:"),
                     parseMQTTState(_mqttClient.state()));
            retVal = true;
        } else {
            PRINTOUT(F("MQTT publish failed with state:"),
                     parseMQTTState(_mqttClient.state()));
            retVal = false;
        }
    } else {
        PRINTOUT(F("MQTT connection failed with state:"),
                 parseMQTTState(_mqttClient.state()));
        delay(1000);
        retVal = false;
    }

    // Disconnect from MQTT
    MS_DBG(F("Disconnecting from MQTT"));
    MS_RESET_DEBUG_TIMER
    _mqttClient.disconnect();
    MS_DBG(F("Disconnected after"), MS_PRINT_DEBUG_TIMER, F("ms"));
    return retVal;
}

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

/**

* @file ThingSpeakPublisher.cpp

* Part of the EnviroDIY ModularSensors library for Arduino

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

* @brief Implements the ThingSpeakPublisher class.

#include "ThingSpeakPublisher.h"

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

// Functions for the EnviroDIY data portal receivers.

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

// Constant values for MQTT publish

// I want to refer to these more than once while ensuring there is only one copy

// in memory

const char* ThingSpeakPublisher::mqttServer = "mqtt3.thingspeak.com";

const int ThingSpeakPublisher::mqttPort = 1883;

const char* ThingSpeakPublisher::mqttClientID = THING_SPEAK_CLIENT_ID;

const char* ThingSpeakPublisher::mqttUser = THING_SPEAK_USER_NAME;

const char* ThingSpeakPublisher::mqttPass = THING_SPEAK_PASS_WORD;

// Constructors

ThingSpeakPublisher::ThingSpeakPublisher() : dataPublisher() {

// MS_DBG(F("ThingSpeakPublisher object created"));

_thingSpeakChannelID = NULL;

_thingSpeakUsername = NULL;

_thingSpeakPassword = NULL;

_thingSpeakClientID = NULL;

}

ThingSpeakPublisher::ThingSpeakPublisher(Logger& baseLogger, uint8_t sendEveryX,

uint8_t sendOffset)

: dataPublisher(baseLogger, sendEveryX, sendOffset) {

// MS_DBG(F("ThingSpeakPublisher object created"));

_thingSpeakChannelID = NULL;

_thingSpeakUsername = NULL;

_thingSpeakPassword = NULL;

_thingSpeakClientID = NULL;

}

ThingSpeakPublisher::ThingSpeakPublisher(Logger& baseLogger, Client* inClient,

uint8_t sendEveryX, uint8_t sendOffset)

: dataPublisher(baseLogger, inClient, sendEveryX, sendOffset) {

// MS_DBG(F("ThingSpeakPublisher object created"));

_thingSpeakChannelID = NULL;

_thingSpeakUsername = NULL;

_thingSpeakPassword = NULL;

_thingSpeakClientID = NULL;

}

ThingSpeakPublisher::ThingSpeakPublisher(Logger& baseLogger,

const char* thingSpeakChannelID,

const char* thingSpeakUsername,

const char* thingSpeakPassword,

const char* thingSpeakClientID,

uint8_t sendEveryX, uint8_t sendOffset)

: dataPublisher(baseLogger, sendEveryX, sendOffset) {

setChannelID(thingSpeakChannelID);

setUsername(thingSpeakUsername);

setPassword(thingSpeakPassword);

setClientID(thingSpeakClientID);

// MS_DBG(F("ThingSpeakPublisher object created"));

}

ThingSpeakPublisher::ThingSpeakPublisher(Logger& baseLogger, Client* inClient,

const char* thingSpeakChannelID,

const char* thingSpeakUsername,

const char* thingSpeakPassword,

const char* thingSpeakClientID,

uint8_t sendEveryX, uint8_t sendOffset)

: dataPublisher(baseLogger, inClient, sendEveryX, sendOffset) {

setChannelID(thingSpeakChannelID);

setUsername(thingSpeakUsername);

setPassword(thingSpeakPassword);

setClientID(thingSpeakClientID);

// MS_DBG(F("ThingSpeakPublisher object created"));

}

// Destructor

ThingSpeakPublisher::~ThingSpeakPublisher() {}

void ThingSpeakPublisher::setChannelID(const char* thingSpeakChannelID) {

_thingSpeakChannelID = thingSpeakChannelID;

// MS_DBG(F("Channel ID set!"));

}

void ThingSpeakPublisher::setUsername(const char* thingSpeakUsername) {

_thingSpeakUsername = thingSpeakUsername;

// MS_DBG(F("Username set!"));

}

void ThingSpeakPublisher::setPassword(const char* thingSpeakPassword) {

_thingSpeakPassword = thingSpeakPassword;

// MS_DBG(F("Password set!"));

}

void ThingSpeakPublisher::setClientID(const char* thingSpeakClientID) {

_thingSpeakClientID = thingSpeakClientID;

// MS_DBG(F("Client ID set!"));

}

// Sets all 3 ThingSpeak parameters

void ThingSpeakPublisher::setThingSpeakParams(const char* channelID,

const char* Username,

const char* Password,

const char* ClientID) {

setChannelID(channelID);

setUsername(Username);

setPassword(Password);

setClientID(ClientID);

}

// A way to begin with everything already set

void ThingSpeakPublisher::begin(Logger& baseLogger, Client* inClient,

const char* thingSpeakChannelID,

const char* thingSpeakUsername,

const char* thingSpeakPassword,

const char* thingSpeakClientID

) {

setChannelID(thingSpeakChannelID);

setUsername(thingSpeakUsername);

setPassword(thingSpeakPassword);

setClientID(thingSpeakClientID);

dataPublisher::begin(baseLogger, inClient);

}

void ThingSpeakPublisher::begin(Logger& baseLogger,

const char* thingSpeakChannelID,

const char* thingSpeakUsername,

const char* thingSpeakPassword,

const char* thingSpeakClientID

) {

setChannelID(thingSpeakChannelID);

setUsername(thingSpeakUsername);

setPassword(thingSpeakPassword);

setClientID(thingSpeakClientID);

dataPublisher::begin(baseLogger);

}

// This sends the data to ThingSpeak

// bool ThingSpeakPublisher::mqttThingSpeak(void)

int16_t ThingSpeakPublisher::publishData(Client* outClient) {

bool retVal = false;

// Make sure we don't have too many fields

// A channel can have a max of 8 fields

if (_baseLogger->getArrayVarCount() > 8) {

MS_DBG(F("No more than 8 fields of data can be sent to a single "

"ThingSpeak channel!"));

MS_DBG(F("Only the first 8 fields worth of data will be sent."));

}

uint8_t numChannels = min(_baseLogger->getArrayVarCount(), 8);

MS_DBG(numChannels, F("fields will be sent to ThingSpeak"));

// Create a buffer for the portions of the request and response

char tempBuffer[26] = "";

char topicBuffer[25] = "channels/"; //was 42

strcat(topicBuffer, _thingSpeakChannelID);

strcat(topicBuffer, "/publish");

//MS_DBG(F("Topic ["), strlen(topicBuffer), F("]:"), String(topicBuffer));

emptyTxBuffer();

_baseLogger->formatDateTime_ISO8601(Logger::markedEpochTime)

.toCharArray(tempBuffer, 26);

strcat(txBuffer, "#P");

strcat(txBuffer, "created_at=");

strcat(txBuffer, tempBuffer);

txBuffer[strlen(txBuffer)] = '&';

for (uint8_t i = 0; i < numChannels; i++) {

strcat(txBuffer, "field");

itoa(i + 1, tempBuffer, 10); // BASE 10

strcat(txBuffer, tempBuffer);

txBuffer[strlen(txBuffer)] = '=';

_baseLogger->getValueStringAtI(i).toCharArray(tempBuffer, 26);

strcat(txBuffer, tempBuffer);

if (i + 1 != numChannels) { txBuffer[strlen(txBuffer)] = '&'; }

}

//strcat(txBuffer, "&status=MQTTPUBLISH");

MS_DBG(F("Message ["), strlen(txBuffer), F("]:"), String(txBuffer));

// Set the client connection parameters

_mqttClient.setClient(*outClient);

_mqttClient.setServer(mqttServer, mqttPort);

// Make sure any previous TCP connections are closed

// NOTE: The PubSubClient library used for MQTT connect assumes that as

// long as the client is connected, it must be connected to the right place.

// Closing any stray client sockets here ensures that a new client socket

// is opened to the right place.

// client is connected when a different socket is open

if (outClient->connected()) { outClient->stop(); }

// Make the MQTT connection

// Note: the client id and the user name do not mean anything for

// ThingSpeak

MS_DBG(F("Opening MQTT Connection"));

MS_START_DEBUG_TIMER;

if (_mqttClient.connect(_thingSpeakClientID, _thingSpeakUsername, _thingSpeakPassword)) {

MS_DBG(F("MQTT connected after"), MS_PRINT_DEBUG_TIMER, F("ms"));

if (_mqttClient.publish(topicBuffer, txBuffer)) {

PRINTOUT(F("ThingSpeak topic published! Current state:"),

parseMQTTState(_mqttClient.state()));

retVal = true;

} else {

PRINTOUT(F("MQTT publish failed with state:"),

parseMQTTState(_mqttClient.state()));

retVal = false;

}

} else {

PRINTOUT(F("MQTT connection failed with state:"),

parseMQTTState(_mqttClient.state()));

delay(1000);

retVal = false;

}

// Disconnect from MQTT

MS_DBG(F("Disconnecting from MQTT"));

MS_RESET_DEBUG_TIMER

_mqttClient.disconnect();

MS_DBG(F("Disconnected after"), MS_PRINT_DEBUG_TIMER, F("ms"));

return retVal;

}

^^ Here’s the edited cpp for the publisher

/**
 * @file ThingSpeakPublisher.h
 * @copyright 2020 Stroud Water Research Center
 * Part of the EnviroDIY ModularSensors library for Arduino
 * @author Sara Geleskie Damiano <sdamiano@stroudcenter.org>
 *
 * @brief Contains the ThingSpeakPublisher subclass of dataPublisher for
 * publishing data to ThingSpeak using the MQTT protocol.
 */

// Header Guards
#ifndef SRC_PUBLISHERS_THINGSPEAKPUBLISHER_H_
#define SRC_PUBLISHERS_THINGSPEAKPUBLISHER_H_

// Debugging Statement
// #define MS_THINGSPEAKPUBLISHER_DEBUG

#ifdef MS_THINGSPEAKPUBLISHER_DEBUG
#define MS_DEBUGGING_STD "ThingSpeakPublisher"
#endif

/**
 * @brief The MQTT User Name
 *
 * @note The user name doesn't actually mean anything for ThingSpeak
 */
 //edited, defines username, password, and client ID
#define THING_SPEAK_USER_NAME ""
#define THING_SPEAK_PASS_WORD ""
#define THING_SPEAK_CLIENT_ID ""

//edited for mqtt3
//#define USESECUREMQTT
// Included Dependencies
#include "ModSensorDebugger.h"
#undef MS_DEBUGGING_STD
#include "dataPublisherBase.h"
#include <PubSubClient.h>


// ============================================================================
//  Functions for the EnviroDIY data portal receivers.
// ============================================================================
/**
 * @brief The ThingSpeakPublisher subclass of dataPublisher for publishing data
 * to ThingSpeak using the MQTT protocol.
 *
 * When sending data to ThingSpeak the order of the variables in the variable
 * array attached to your logger is __crucial__.  The results from the variables
 * in the VariableArray will be sent to ThingSpeak in the order they are in the
 * array; that is, the first variable in the array will be sent as Field1, the
 * second as Field2, etc.  Any UUID's or custom variable codes are ignored for
 * ThingSpeak.  They will only appear in the header of your file on the SD card.
 * Giving a variable a custom variable code like "Field3" will **NOT** make that
 * variable field 3 on ThingSpeak.  The third variable in the array will always
 * be "Field3".  Any text names you have given to your fields in ThingSpeak are
 * also irrelevant.
 *
 * @ingroup the_publishers
 */
class ThingSpeakPublisher : public dataPublisher {
 public:
    // Constructors
    /**
     * @brief Construct a new ThingSpeak Publisher object with no members
     * initialized.
     */
    ThingSpeakPublisher();
    /**
     * @brief Construct a new ThingSpeak Publisher object
     *
     * @note If a client is never specified, the publisher will attempt to
     * create and use a client on a LoggerModem instance tied to the attached
     * logger.
     *
     * @param baseLogger The logger supplying the data to be published
     * @param sendEveryX Currently unimplemented, intended for future use to
     * enable caching and bulk publishing
     * @param sendOffset Currently unimplemented, intended for future use to
     * enable publishing data at a time slightly delayed from when it is
     * collected
     *
     * @note It is possible (though very unlikey) that using this constructor
     * could cause errors if the compiler attempts to initialize the publisher
     * instance before the logger instance.  If you suspect you are seeing that
     * issue, use the null constructor and a populated begin(...) within your
     * set-up function.
     */
    explicit ThingSpeakPublisher(Logger& baseLogger, uint8_t sendEveryX = 1,
                                 uint8_t sendOffset = 0);
    /**
     * @brief Construct a new ThingSpeak Publisher object
     *
     * @param baseLogger The logger supplying the data to be published
     * @param inClient An Arduino client instance to use to print data to.
     * Allows the use of any type of client and multiple clients tied to a
     * single TinyGSM modem instance
     * @param sendEveryX Currently unimplemented, intended for future use to
     * enable caching and bulk publishing
     * @param sendOffset Currently unimplemented, intended for future use to
     * enable publishing data at a time slightly delayed from when it is
     * collected
     *
     * @note It is possible (though very unlikey) that using this constructor
     * could cause errors if the compiler attempts to initialize the publisher
     * instance before the logger instance.  If you suspect you are seeing that
     * issue, use the null constructor and a populated begin(...) within your
     * set-up function.
     */
    ThingSpeakPublisher(Logger& baseLogger, Client* inClient,
                        uint8_t sendEveryX = 1, uint8_t sendOffset = 0);
    /**
     * @brief Construct a new ThingSpeak Publisher object
     *
     * @param baseLogger The logger supplying the data to be published
     * @param thingSpeakChannelID The numeric channel id for your channel
     * @param sendEveryX Currently unimplemented, intended for future use to
     * enable caching and bulk publishing
     * @param sendOffset Currently unimplemented, intended for future use to
     * enable publishing data at a time slightly delayed from when it is
     */
    ThingSpeakPublisher(Logger& baseLogger,
                        const char* thingSpeakChannelID,
                        const char* thingSpeakUsername,
                        const char* thingSpeakPassword,
                        const char* thingSpeakClientID,
                        uint8_t sendEveryX = 1, uint8_t sendOffset = 0);
    /**
     * @brief Construct a new ThingSpeak Publisher object
     *
     * @param baseLogger The logger supplying the data to be published
     * @param inClient An Arduino client instance to use to print data to.
     * Allows the use of any type of client and multiple clients tied to a
     * single TinyGSM modem instance
     * @param thingSpeakChannelID The numeric channel id for your channel
     * @param sendEveryX Currently unimplemented, intended for future use to
     * enable caching and bulk publishing
     * @param sendOffset Currently unimplemented, intended for future use to
     * enable publishing data at a time slightly delayed from when it is
     * collected
     */
    ThingSpeakPublisher(Logger& baseLogger, Client* inClient,
                        const char* thingSpeakChannelID,
                        const char* thingSpeakUsername,
                        const char* thingSpeakPassword,
                        const char* thingSpeakClientID,
                        uint8_t sendEveryX = 1, uint8_t sendOffset = 0);
    /**
     * @brief Destroy the ThingSpeak Publisher object
     */
    virtual ~ThingSpeakPublisher();

    // Returns the data destination
    String getEndpoint(void) override {
        return String(mqttServer);
    }

    /**
     * @brief Set the ThingSpeak channel ID
     *
     * @param thingSpeakChannelID The numeric channel id for your channel
     */
    void setChannelID(const char* thingSpeakChannelID);



    //edited
    void setUsername(const char* thingSpeakUsername);

    void setPassword(const char* thingSpeakPassword);

    void setClientID(const char* thingSpeakClientID);


    void setThingSpeakParams(const char* channelID,
                             const char* Username,
                           const char* Password, const char* ClientID);

    // A way to begin with everything already set
    /**
     * @copydoc dataPublisher::begin(Logger& baseLogger, Client* inClient)
     * @param thingSpeakChannelID The numeric channel id for your channel
     */
    void begin(Logger& baseLogger, Client* inClient,
               const char* thingSpeakChannelID,
               const char* thingSpeakUsername,
               const char* thingSpeakPassword,
               const char* thingSpeakClientID);
    /**
     * @copydoc dataPublisher::begin(Logger& baseLogger)
     * @param thingSpeakChannelID The numeric channel id for your channel
     */
    void begin(Logger& baseLogger,
               const char* thingSpeakChannelID,
               const char* thingSpeakUsername,
               const char* thingSpeakPassword,
               const char* thingSpeakClientID);

    // This sends the data to ThingSpeak
    // bool mqttThingSpeak(void);
    int16_t publishData(Client* outClient) override;

 protected:
    /**
     * @anchor ts_mqqt_vars
     * @name Portions of the MQTT data publication
     *
     * @{
     */
    static const char* mqttServer;      ///< The MQTT server
    static const int   mqttPort;        ///< The MQTT port
    static const char* mqttClientName;  ///< The MQTT client name
    static const char* mqttChannelID;   ///< The MQTT channel ID
    static const char* mqttUser;        ///< The MQTT user name
    static const char* mqttPass;        ///< The MQTT password
    static const char* mqttClientID;
                                        /**@}*/

 private:
    // Keys for ThingSpeak
    const char*  _thingSpeakChannelID;
    const char*  _thingSpeakUsername;
    const char*  _thingSpeakPassword;
    const char*  _thingSpeakClientID;
    PubSubClient _mqttClient;
};

#endif  // SRC_PUBLISHERS_THINGSPEAKPUBLISHER_H_

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

/**

* @file ThingSpeakPublisher.h

* Part of the EnviroDIY ModularSensors library for Arduino

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

* @brief Contains the ThingSpeakPublisher subclass of dataPublisher for

* publishing data to ThingSpeak using the MQTT protocol.

// Header Guards

#ifndef SRC_PUBLISHERS_THINGSPEAKPUBLISHER_H_

#define SRC_PUBLISHERS_THINGSPEAKPUBLISHER_H_

// Debugging Statement

// #define MS_THINGSPEAKPUBLISHER_DEBUG

#ifdef MS_THINGSPEAKPUBLISHER_DEBUG

#define MS_DEBUGGING_STD "ThingSpeakPublisher"

#endif

/**

* @brief The MQTT User Name

* @note The user name doesn't actually mean anything for ThingSpeak

//edited, defines username, password, and client ID

#define THING_SPEAK_USER_NAME ""

#define THING_SPEAK_PASS_WORD ""

#define THING_SPEAK_CLIENT_ID ""

//edited for mqtt3

//#define USESECUREMQTT

// Included Dependencies

#include "ModSensorDebugger.h"

#undef MS_DEBUGGING_STD

#include "dataPublisherBase.h"

#include <PubSubClient.h>

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

// Functions for the EnviroDIY data portal receivers.

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

/**

* @brief The ThingSpeakPublisher subclass of dataPublisher for publishing data

* to ThingSpeak using the MQTT protocol.

* When sending data to ThingSpeak the order of the variables in the variable

* array attached to your logger is __crucial__. The results from the variables

* in the VariableArray will be sent to ThingSpeak in the order they are in the

* array; that is, the first variable in the array will be sent as Field1, the

* second as Field2, etc. Any UUID's or custom variable codes are ignored for

* ThingSpeak. They will only appear in the header of your file on the SD card.

* Giving a variable a custom variable code like "Field3" will **NOT** make that

* variable field 3 on ThingSpeak. The third variable in the array will always

* be "Field3". Any text names you have given to your fields in ThingSpeak are

* also irrelevant.

* @ingroup the_publishers

class ThingSpeakPublisher : public dataPublisher {

public:

// Constructors

/**

* @brief Construct a new ThingSpeak Publisher object with no members

* initialized.

ThingSpeakPublisher();

/**

* @brief Construct a new ThingSpeak Publisher object

* @note If a client is never specified, the publisher will attempt to

* create and use a client on a LoggerModem instance tied to the attached

* logger.

* @param baseLogger The logger supplying the data to be published

* @param sendEveryX Currently unimplemented, intended for future use to

* enable caching and bulk publishing

* @param sendOffset Currently unimplemented, intended for future use to

* enable publishing data at a time slightly delayed from when it is

* collected

* @note It is possible (though very unlikey) that using this constructor

* could cause errors if the compiler attempts to initialize the publisher

* instance before the logger instance. If you suspect you are seeing that

* issue, use the null constructor and a populated begin(...) within your

* set-up function.

explicit ThingSpeakPublisher(Logger& baseLogger, uint8_t sendEveryX = 1,

uint8_t sendOffset = 0);

/**

* @brief Construct a new ThingSpeak Publisher object

* @param baseLogger The logger supplying the data to be published

* @param inClient An Arduino client instance to use to print data to.

* Allows the use of any type of client and multiple clients tied to a

* single TinyGSM modem instance

* @param sendEveryX Currently unimplemented, intended for future use to

* enable caching and bulk publishing

* @param sendOffset Currently unimplemented, intended for future use to

* enable publishing data at a time slightly delayed from when it is

* collected

* @note It is possible (though very unlikey) that using this constructor

* could cause errors if the compiler attempts to initialize the publisher

* instance before the logger instance. If you suspect you are seeing that

* issue, use the null constructor and a populated begin(...) within your

* set-up function.

ThingSpeakPublisher(Logger& baseLogger, Client* inClient,

uint8_t sendEveryX = 1, uint8_t sendOffset = 0);

/**

* @brief Construct a new ThingSpeak Publisher object

* @param baseLogger The logger supplying the data to be published

* @param thingSpeakChannelID The numeric channel id for your channel

* @param sendEveryX Currently unimplemented, intended for future use to

* enable caching and bulk publishing

* @param sendOffset Currently unimplemented, intended for future use to

* enable publishing data at a time slightly delayed from when it is

ThingSpeakPublisher(Logger& baseLogger,

const char* thingSpeakChannelID,

const char* thingSpeakUsername,

const char* thingSpeakPassword,

const char* thingSpeakClientID,

uint8_t sendEveryX = 1, uint8_t sendOffset = 0);

/**

* @brief Construct a new ThingSpeak Publisher object

* @param baseLogger The logger supplying the data to be published

* @param inClient An Arduino client instance to use to print data to.

* Allows the use of any type of client and multiple clients tied to a

* single TinyGSM modem instance

* @param thingSpeakChannelID The numeric channel id for your channel

* @param sendEveryX Currently unimplemented, intended for future use to

* enable caching and bulk publishing

* @param sendOffset Currently unimplemented, intended for future use to

* enable publishing data at a time slightly delayed from when it is

* collected

ThingSpeakPublisher(Logger& baseLogger, Client* inClient,

const char* thingSpeakChannelID,

const char* thingSpeakUsername,

const char* thingSpeakPassword,

const char* thingSpeakClientID,

uint8_t sendEveryX = 1, uint8_t sendOffset = 0);

/**

* @brief Destroy the ThingSpeak Publisher object

virtual ~ThingSpeakPublisher();

// Returns the data destination

String getEndpoint(void) override {

return String(mqttServer);

}

/**

* @brief Set the ThingSpeak channel ID

* @param thingSpeakChannelID The numeric channel id for your channel

void setChannelID(const char* thingSpeakChannelID);

//edited

void setUsername(const char* thingSpeakUsername);

void setPassword(const char* thingSpeakPassword);

void setClientID(const char* thingSpeakClientID);

void setThingSpeakParams(const char* channelID,

const char* Username,

const char* Password, const char* ClientID);

// A way to begin with everything already set

/**

* @copydoc dataPublisher::begin(Logger& baseLogger, Client* inClient)

* @param thingSpeakChannelID The numeric channel id for your channel

void begin(Logger& baseLogger, Client* inClient,

const char* thingSpeakChannelID,

const char* thingSpeakUsername,

const char* thingSpeakPassword,

const char* thingSpeakClientID);

/**

* @copydoc dataPublisher::begin(Logger& baseLogger)

* @param thingSpeakChannelID The numeric channel id for your channel

void begin(Logger& baseLogger,

const char* thingSpeakChannelID,

const char* thingSpeakUsername,

const char* thingSpeakPassword,

const char* thingSpeakClientID);

// This sends the data to ThingSpeak

// bool mqttThingSpeak(void);

int16_t publishData(Client* outClient) override;

protected:

/**

* @anchor ts_mqqt_vars

* @name Portions of the MQTT data publication

* @{

static const char* mqttServer; ///< The MQTT server

static const int mqttPort; ///< The MQTT port

static const char* mqttClientName; ///< The MQTT client name

static const char* mqttChannelID; ///< The MQTT channel ID

static const char* mqttUser; ///< The MQTT user name

static const char* mqttPass; ///< The MQTT password

static const char* mqttClientID;

/**@}*/

private:

// Keys for ThingSpeak

const char* _thingSpeakChannelID;

const char* _thingSpeakUsername;

const char* _thingSpeakPassword;

const char* _thingSpeakClientID;

PubSubClient _mqttClient;

};

#endif // SRC_PUBLISHERS_THINGSPEAKPUBLISHER_H_

^^ Here’s the edited code for the header file.

More...

2022-01-07 at 7:47 PM #16247
neilh20
Participant
@zeke-holloman hey congrats,!!! Thanks for the posting and analysis, I could also build from that.

Wow… the power of open source

@zeke-holloman hey congrats,!!! Thanks for the posting and analysis, I could also build from that.

Wow… the power of open source that you can dive in and tweak it, so you can make it work. Go @zeke-holloman !!!

Just an FYI, what I do to facilitate easy maintenance, and easy future merges, I rename my customizations to a “unique name space” eg ThingSpeakPublisher3a.h/.cpp and then also the classes ThingSpeakPublisher3a.

Then if you come to do an update “git pull” and there are updates in the main line “master” ThinkSpeakPublisher.h/cpp you’ll have a smoother ride with being able to track the updates, and either adopt them or stay with your customizations.

More...

Less...
2022-01-12 at 2:03 PM #16252
Zeke Holloman
Participant
@neilh20 Hey, thanks! WOW! That’s awesome it worked for you as well. Hope it ends up being helpful!

I will say, it wasn’t a quick process. It was a lot of jumping back and forth between T

@neilh20 Hey, thanks! WOW! That’s awesome it worked for you as well. Hope it ends up being helpful!

I will say, it wasn’t a quick process. It was a lot of jumping back and forth between ThingSpeak documentation and code, but I was SUPER excited when it finally uploaded.

Aaaah, ok, that makes sense. Thank you!

More...

Less...

Author

Posts

Viewing 7 reply threads

You must be logged in to reply to this topic.