-
Notifications
You must be signed in to change notification settings - Fork 0
/
projectcemetery.ino
505 lines (437 loc) · 16.3 KB
/
projectcemetery.ino
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
// Project Cemetery - particle_photon_lewis - rewrite 0.9.93 - recalibrate sensor values+deepsleep+multi-wifi config
// Tribute to my grandfather Ronald George Flinkerbusch (1915-1979)
//
// https://github.com/jinjirosan/project_cemetery
#include "math.h" // Library fo calculations
#include <adafruit-sht31.h> // Library for Temperature-Humidity sensor
#include <tsl2561.h> // Library for Luminosity/Lux sensor
#include <SparkFunBQ27441.h> // Library for battery - LiPo gauge
#include "HttpClient.h" // Library for dweet.io
#include "wifi_creds.h" // Library for wifi credentials
// set Photon to wait for manually provided wifi credentials and manually call Particle.connect() to connect to wifi
SYSTEM_MODE(SEMI_AUTOMATIC);
// Set BATTERY_CAPACITY of attached LiPo
const unsigned int BATTERY_CAPACITY = 2500;
// Sleep calculation multiplier. Testing purposes: 70 value + 100% batt = 5:50 mins interval
// default value for once a day is 17280, see readme.md for DeepSleep table.
int sleepCalculationMultiplier = 70;
// Battery threshold vars
const byte SOCI_SET = 20; // Interrupt set threshold at 20%
const byte SOCI_CLR = 25; // Interrupt clear threshold at 25%
const byte SOCF_SET = 5; // Final threshold set at 5%
const byte SOCF_CLR = 10; // Final threshold clear at 10%
// Photon pin connected to BQ27441's GPOUT pin
const int GPOUT_PIN = 4;
// transmit to dweet.io pre-reqs
HttpClient http;
http_request_t request;
http_response_t response;
http_header_t headers[] = { { NULL, NULL } };
// instanciate the Temperature-Humidity sensor
Adafruit_SHT31 sht31 = Adafruit_SHT31();
// instanciate a TSL2561 object with I2C address 0x39 --> TSL2561_ADDR (0x39), TSL2561_ADDR_1 (0x49), TSL2561_ADDR_0 (0x29)
TSL2561 tsl = (TSL2561_ADDR);
/*
TSL2561 sensor.
Connections:
Photon tsl2561
D1 <----> SCL
D0 <----> SDA
Not connected (floating) <----> ADDR
*/
// TSL2561 light sensor related vars
uint16_t integrationTime;
double illuminance;
uint32_t illuminance_int;
bool autoGainOn;
// TSL2561 light execution control vars
bool operational;
// TSL2561 light status vars
char tsl_status[21] = "na";
char autoGain_s[4] = "na";
uint8_t error_code;
uint8_t gain_setting;
// BQ27441 babysitter status vars
char lipo_status[42] = "na";
char lp_soc[4] ="na";
// Soil Moisture Sensor vars
int soilval = 0; // soilvalue for storing moisture soilvalue
int soilPin = A3; // Declare a variable for the soil moisture sensor (Photon A3)
int soilPower = 3; // Variable for Soil moisture Power pin (Photon D3)
int thresholdUp = 3300; // everything higher means the soil is soaked
int thresholdCenter = 3200; // between 3101-3200, everything is good
int thresholdDown = 3100; // below 3100, plants get thirsty. Everything lower needs water
String DisplayWords; // declare string to use for action
// Where to publish the data (options are: "dweet" or "particle" depending on where to send the output)
String publishMethod = "dweet";
// dweet thing name
String my_dweet_thing = "project_cemetery";
// Enable debug or not
bool debugEnabled = false;
// function to send to dweet.io , need to fix in dict/array to transmit once instead of 4 seperate times
int send_to_dweet(String thing, String key, float value) {
request.hostname = "dweet.io";
request.port = 80;
request.path = "/dweet/for/" + thing + "?" + key + "=" + value;
request.body = "";
http.post(request, response, headers);
if (debugEnabled) {
String msg = "Sent key " + key + " with value " + value + " to dweet for the " + thing + " and got response: " + response.status;
Serial.println(msg);
}
return response.status;
}
// visual notification on Photon itself: pattern
int flash_rgb(int r=0, int g=0, int b=0, long time_delay=40) {
RGB.control(true);
RGB.color(0, 0, 0);
delay(time_delay);
RGB.color(r, g, b);
delay(time_delay);
RGB.color(0, 0, 0);
delay(time_delay);
RGB.control(false);
}
// for solar/LiPo power circuit and battery save mode
int calculate_sleep(double battsoc) {
return (105 - battsoc) * sleepCalculationMultiplier;
}
// visual notification on Photon itself: flash sequence for httpStatus
int flashLedByHttpCode(long httpStatus) {
if (httpStatus == 200) {
flash_rgb(0, 255); // green for OK
} else {
flash_rgb(255, 0); // red for fail
}
}
// Get the soil moisture content. Turn power on/off to decrease chances of corrosion (increase lifespan).
int readSoil() {
digitalWrite(soilPower, HIGH); // turn pin D3 "On"
delay(10); // wait 10 milliseconds
soilval = analogRead(soilPin); // Read the SIG soilvalue form sensor
digitalWrite(soilPower, LOW); // turn pin D3 "Off"
return soilval; // send current moisture soilvalue
}
// Read battery stats from the BQ27441-G1A
void BatteryStatus()
{
unsigned int lp_soc = lipo.soc(); // Read state-of-charge (%)
unsigned int lp_volts = lipo.voltage(); // Read battery voltage (mV)
int lp_current = lipo.current(AVG); // Read average current (mA)
unsigned int lp_fullCapacity = lipo.capacity(FULL); // Read full capacity (mAh)
unsigned int lp_capacity = lipo.capacity(REMAIN); // Read remaining capacity (mAh)
int lp_power = lipo.power(); // Read average power draw (mW)
int lp_health = lipo.soh(); // Read state-of-health (%). Battery condition compared to new.
// If the GPOUT interrupt is active (low)
if (!digitalRead(GPOUT_PIN))
{
// Check which of the flags triggered the interrupt
if (lipo.socfFlag()) {
Particle.publish("lipo: status", "<!-- WARNING: Battery Dangerously low -->");
delay(1000);
}
else if (lipo.socFlag()) {
Particle.publish("lipo: status", "<!-- WARNING: Battery Low -->");
delay(1000);
}
}
Particle.publish("lipo: state-of-charge", String(lp_soc) + " %");
delay(1000);
Particle.publish("lipo: capacity remain", String(lp_capacity) + " mAh");
delay(1000);
Particle.publish("lipo: avg current", String(lp_current) + " mA");
delay(1000);
Particle.publish("lipo: state-of-health", String(lp_health) + " %");
delay(1000);
}
void setup()
{
// call the wifi setup function
setupWifi();
// initialize the BQ27441-G1A and confirm that it's connected and communicating
if (!lipo.begin()) // begin() will return true if communication is successful
{
strcpy(lipo_status,"Error: Unable to communicate with BQ27441");
Particle.publish("Battery babysitter", lipo_status);
}
else {
strcpy(lipo_status,"Connected to BQ27441!");
Particle.publish("Battery babysitter", lipo_status);
}
// set lipo.setCapacity(BATTERY_CAPACITY) based on variable
lipo.setCapacity(BATTERY_CAPACITY);
// setup babysitter threshold/low batt warning config
lipo.enterConfig(); // To configure the values below, you must be in config mode
lipo.setCapacity(BATTERY_CAPACITY); // Set the battery capacity
lipo.setGPOUTPolarity(LOW); // Set GPOUT to active-high
lipo.setGPOUTFunction(BAT_LOW); // Set GPOUT to BAT_LOW mode
lipo.setSOC1Thresholds(SOCI_SET, SOCI_CLR); // Set SOCI set and clear thresholds
lipo.setSOCFThresholds(SOCF_SET, SOCF_CLR); // Set SOCF set and clear thresholds
lipo.exitConfig();
// Use lipo.GPOUTPolarity to read from the chip and confirm the changes
if (lipo.GPOUTPolarity())
Particle.publish("lipo: lowbatt config", "GPOUT set to active-HIGH");
else
Particle.publish("lipo: lowbatt config", "GPOUT set to active-LOW");
// Use lipo.GPOUTFunction to confirm the functionality of GPOUT
if (lipo.GPOUTFunction())
Particle.publish("lipo: lowbatt config", "GPOUT function set to BAT_LOW");
else
Particle.publish("lipo: lowbatt config", "GPOUT function set to SOC_INT");
// Initialization for
error_code = 0;
operational = false;
autoGainOn = false;
// variables on the cloud
Particle.variable("lux_status", tsl_status);
Particle.variable("lipo_status", lipo_status);
Particle.variable("lipo_charge_state", lp_soc);
//Particle.variable("integ_time", integrationTime);
//Particle.variable("gain", gain_setting);
//Particle.variable("auto_gain",autoGain_s);
//Particle.variable("illuminance", illuminance);
Particle.variable("int_ill", illuminance_int);
//function on the cloud: change sensor exposure settings (mqx 4)
Particle.function("setExposure", setExposure);
//connecting to light sensor device
if (tsl.begin()) {
strcpy(tsl_status,"tsl2561 found");
Particle.publish("Temperature-Humidity sensor", tsl_status);
}
else {
strcpy(tsl_status,"tsl 2561 not found ");
Particle.publish("Temperature-Humidity sensor", tsl_status);
}
// setting the sensor: gain x1 and 101ms integration time
if(!tsl.setTiming(false,1,integrationTime)) {
error_code = tsl.getError();
strcpy(tsl_status,"setTimingError");
return;
}
if (!tsl.setPowerUp()) {
error_code = tsl.getError();
strcpy(tsl_status,"PowerUPError");
return;
}
// device initialized
operational = true;
strcpy(tsl_status,"initOK");
Particle.publish("Temperature-Humidity sensor", tsl_status);
// Initialization for temperature/humidity sensor
Serial.begin(115200);
Serial.println("SHT31 test");
if (! sht31.begin(0x44)) { // Set to 0x45 for alternate i2c addr
Serial.println("Couldn't find SHT31");
}
// Soil Moisture Sensor setup
pinMode(soilPower, OUTPUT); // Set D3 as an OUTPUT
digitalWrite(soilPower, LOW); // Set to LOW so no power is flowing through the sensor
}
void loop()
{
// call function, take measurements and transmit data to Particle
BatteryStatus();
// Loop for Lux sensor
uint16_t broadband, ir;
// update exposure settings display vars
if (tsl._gain)
gain_setting = 16;
else
gain_setting = 1;
if (autoGainOn)
strcpy(autoGain_s,"yes");
else
strcpy(autoGain_s,"no");
if (operational)
{
// device operational, update status vars
strcpy(tsl_status,"OK");
// get raw data from sensor
if(!tsl.getData(broadband,ir,autoGainOn))
{
error_code = tsl.getError();
strcpy(tsl_status,"saturated?");
operational = false;
}
// compute illuminance value in lux
if(!tsl.getLux(integrationTime,broadband,ir,illuminance))
{
error_code = tsl.getError();
strcpy(tsl_status,"getLuxError");
operational = false;
}
// try the integer based calculation
if(!tsl.getLuxInt(broadband,ir,illuminance_int))
{
error_code = tsl.getError();
strcpy(tsl_status,"getLuxIntError");
operational = false;
}
}
else
// device not set correctly
{
strcpy(tsl_status,"OperationError");
illuminance = -1.0;
// trying a fix
// power down the sensor
tsl.setPowerDown();
delay(100);
// re-init the sensor
if (tsl.begin())
{
// power up
tsl.setPowerUp();
// re-configure
tsl.setTiming(tsl._gain,1,integrationTime);
// try to go back normal again
operational = true;
}
}
delay(2000);
// ROUND loop for temperature-humidity
double t = round(sht31.readTemperature()*10)/10.0;
double hum = round(sht31.readHumidity()*10)/10.0;
double tF = round(((t* 9) /5 + 32)*10)/10.0;
double s = readSoil();
// Read battery stats from the BQ27441-G1A. Need to clean up as var is already in function.
unsigned int lp_soc = lipo.soc(); // Read state-of-charge (%)
if (! isnan(t)) { // check if 'is not a number'
//Temperature in C
Serial.print("Temp *C = "); Serial.println(t);
//Particle.variable("TempC", t);
Particle.publish("TempC", String(t));
//Temperature in F
//Serial.print("Temp *F = "); Serial.println(tF);
//Particle.variable("TempF", tF);
} else {
Serial.println("Failed to read temperature");
Particle.publish("Failed to read temperature");
}
if (! isnan(hum)) { // check if 'is not a number'
Serial.print("Hum. % = "); Serial.println(hum);
//Particle.variable("Humidity", hum);
Particle.publish("Humidity", String(hum));
} else {
Serial.println("Failed to read humidity");
Particle.publish("Failed to read humidity");
}
if (! isnan(s)) { // check if 'is not a number'
Serial.print("moisture = "); Serial.println(s);
//Particle.variable("moisture", s);
Particle.publish("Soil moisture", String(s));
} else {
Serial.println("Failed to read Soil moisture level");
Particle.publish("Failed to read Soil moisture level");
}
if (s <= thresholdDown){
DisplayWords = "Dry, needs water!!";
Particle.publish("Plant life", String(DisplayWords));
} else if ((thresholdDown < s) && (s <= thresholdCenter)){
DisplayWords = "Normal, all good!";
Particle.publish("Plant life", String(DisplayWords));
} else if ((thresholdCenter < s) && (s <= thresholdUp)){
DisplayWords = "Normal, just watered!";
Particle.publish("Plant life", String(DisplayWords));
} else if (s >= thresholdUp){
DisplayWords = "Soil soaked";
Particle.publish("Plant life", String(DisplayWords));
}
Serial.println();
delay(2000);
// Calculate sleep interval
int sleepInterval = calculate_sleep(lp_soc);
Particle.publish("sleepInterval", String(sleepInterval));
// Seperated publish methods, probably remove this "particle" section.
if (publishMethod == "particle") {
Particle.publish("temperature", String(t));
delay(2000);
Particle.publish("humidity", String(hum));
delay(2000);
Particle.publish("lightLevel", String(illuminance));
delay(2000);
}
if (publishMethod == "dweet") {
flashLedByHttpCode(send_to_dweet(my_dweet_thing, "Temperature", round(t*10)/10.0));
delay(1000); // shorter delay than 1000 does not publish all data to dweet
flashLedByHttpCode(send_to_dweet(my_dweet_thing, "Humidity", round(hum*10)/10.0));
delay(1000);
flashLedByHttpCode(send_to_dweet(my_dweet_thing, "LightLevel", round(illuminance)));
delay(1000);
flashLedByHttpCode(send_to_dweet(my_dweet_thing, "SoilMoistureLevel", s));
delay(1000);
flashLedByHttpCode(send_to_dweet(my_dweet_thing, "StateOfCharge", lp_soc));
delay(1000);
flashLedByHttpCode(send_to_dweet(my_dweet_thing, "SleepInterval", sleepInterval));
delay(1000);
}
// Deepsleep, interval depending on battery state
//System.sleep(SLEEP_MODE_DEEP, sleepInterval);
// REMOVE WHEN DONE TESTING
delay(350000);
}
// function to call the separate wifi_creds file and then connect to the cloud
void setupWifi() {
WiFi.on();
WiFi.disconnect();
WiFi.clearCredentials();
int numWifiCreds = sizeof(wifiCreds) / sizeof(*wifiCreds);
for (int i = 0; i < numWifiCreds; i++) {
credentials creds = wifiCreds[i];
WiFi.setCredentials(creds.ssid, creds.password, creds.authType, creds.cipher);
}
WiFi.connect();
waitUntil(WiFi.ready);
Particle.connect();
}
// cloud function to change exposure settings (gain and integration time)
int setExposure(String command)
//command is expected to be [gain={0,1,2},integrationTimeSwitch={0,1,2}]
// gain = 0:x1, 1: x16, 2: auto
// integrationTimeSwitch: 0: 14ms, 1: 101ms, 2:402ms
{
// private vars
char gainInput;
uint8_t itSwitchInput;
boolean _setTimingReturn = false;
// extract gain as char and integrationTime switch as byte
gainInput = command.charAt(0);//we expect 0, 1 or 2
itSwitchInput = command.charAt(2) - '0';//we expect 0,1 or 2
if (itSwitchInput >= 0 && itSwitchInput < 3){
// acceptable integration time value, now check gain value
if (gainInput=='0'){
_setTimingReturn = tsl.setTiming(false,itSwitchInput,integrationTime);
autoGainOn = false;
}
else if (gainInput=='1') {
_setTimingReturn = tsl.setTiming(true,itSwitchInput,integrationTime);
autoGainOn = false;
}
else if (gainInput=='2') {
autoGainOn = true;
// when auto gain is enabled, set starting gain to x16
_setTimingReturn = tsl.setTiming(true,itSwitchInput,integrationTime);
}
else{
// no valid settings, raise error flag
_setTimingReturn = false;
}
}
else{
_setTimingReturn = false;
}
// setTiming has an error
if(!_setTimingReturn){
// set appropriate status variables
error_code = tsl.getError();
strcpy(tsl_status,"CloudSettingsError");
//disable getting illuminance value
operational = false;
return -1;
}
else {
// all is good
operational = true;
return 0;
}
}