forked from madmartin/Jarolift_MQTT
-
Notifications
You must be signed in to change notification settings - Fork 0
/
global.h
494 lines (445 loc) · 19.6 KB
/
global.h
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
/* Controlling Jarolift TDEF 433MHZ radio shutters via ESP8266 and CC1101 Transceiver Module in asynchronous mode.
Copyright (C) 2017-2018 Steffen Hille et al.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef GLOBAL_H
#define GLOBAL_H
#define PROGRAM_VERSION "v0.9"
#define STATIC_SSID
#define noMQTT // no MQTT code
#define noDST // no DaylightSetings
#define noDRD // no DoubleResetDetect
#define ACCESS_POINT_NAME "Jarolift-Dongle" // default SSID for Admin-Mode
#define ACCESS_POINT_PASSWORD "12345678" // default WLAN password for Admin-Mode
#define AdminTimeOut 180 // Defines the time in seconds, when the Admin-Mode will be disabled
#define MQTT_Reconnect_Interval 30000 // try connect to MQTT server very X milliseconds
#define NTP_SERVERS "0.pool.ntp.org", "1.pool.ntp.org", "2.pool.ntp.org" // List of up to 3 NTP servers
#ifdef DST
#define TIMEZONE +1 // difference localtime to UTC/GMT in hours
struct dstRule StartRule = {"CEST", Last, Sun, Mar, 2, 3600}; // Daylight time
struct dstRule EndRule = {"CET", Last, Sun, Oct, 2, 0}; // Standard time
simpleDSTadjust dstAdjusted(StartRule, EndRule); // Setup simpleDSTadjust Library rules
#endif
ESP8266WebServer server(80); // The Webserver
WiFiClient espClient;
#ifdef MQTT
PubSubClient mqtt_client(espClient); // mqtt client instance
long mqttLastConnectAttempt = 0; // timepoint of last connect attempt in milliseconds
#endif
WiFiEventHandler gotIpEventHandler, disconnectedEventHandler;
boolean AdminEnabled = false; // Admin-Mode opens AccessPoint for configuration
int AdminTimeOutCounter = 0; // Counter for Disabling the Admin-Mode
boolean wifi_disconnect_log = true; // Flag to avoid repeated logging of disconnect events
int led_pin = LED_BUILTIN; // GPIO Pin number for LED
Ticker tkHeartBeat; // Timer for HeartBeat
unsigned short devcnt = 0x0; // Initial 16Bit countervalue, stored in EEPROM and incremented once every time a command is send
int cntadr = 110; // EEPROM address where the 16Bit counter is stored.
String web_cmd = ""; // trigger to run a command whenever a action button has been pressed on the web interface
int web_cmd_channel; // keeps the respective channel ID for the web_cmd
#define NUM_WEB_LOG_MESSAGES 42 // number of messages in the web-UI log page
String web_log_message[NUM_WEB_LOG_MESSAGES];
uint16_t web_log_message_nextfree = 0;
boolean web_log_message_rotated = false;
boolean web_log_message_newline = true;
// boolean settings which will later be configurable through WebUI
boolean debug_mqtt = false;
boolean debug_webui = false;
boolean debug_log_radio_receive_all = false;
boolean mqtt_send_radio_receive_all = true;
struct strConfig {
uint16_t cfgVersion;
String ssid;
String password;
byte ip[4];
byte netmask[4];
byte gateway[4];
boolean dhcp;
byte mqtt_broker_addr[4];
String mqtt_broker_port;
String mqtt_broker_client_id;
String mqtt_broker_username;
String mqtt_broker_password;
String mqtt_devicetopic;
String master_msb;
String master_lsb;
unsigned long ulMasterMSB;
unsigned long ulMasterLSB;
boolean learn_mode; // If set to true, regular learn method is used (up+down, followed by stop).
// If set to false another method for older versions of Jarolift motors is used.
String serial; // starting serial number as string
uint32_t serial_number; // starting serial number as integer
String channel_name[16];
// temporary values, for web ui, not to store in EEPROM
String mqtt_devicetopic_new = ""; // needed to figure out if the devicetopic has been changed
String new_serial = "";
String new_devicecounter = "";
boolean set_and_generate_serial = false;
boolean set_devicecounter = false;
byte shade_value[16];
} config;
uint64_t shade_learn_time = 0; // used to determine the time to set shade position
boolean shade_learn = false; // flag to indicate the modus learn shade position
#define MAX_SHADE_TIME 50
//####################################################################
// Initalize log message array with empty strings
//####################################################################
void InitLog()
{
for ( int i = 0; i < NUM_WEB_LOG_MESSAGES; i++ ) {
web_log_message[i] = "";
}
} // void InitLog
//####################################################################
// Function to log date + time to serial
//####################################################################
void LogTime()
{
#ifdef DST
char *dstAbbrev;
time_t now = dstAdjusted.time(&dstAbbrev);
#else
time_t now;
#endif
struct tm * timeinfo = localtime(&now);
char buffer[30];
strftime (buffer, 30, "%Y-%m-%d %T", timeinfo);
Serial.print((String)buffer + " ");
} // void LogTime
//####################################################################
// Function to write Log to both, serial and Weblog
//####################################################################
void WriteLog(String msg, boolean new_line = false)
{
// web_log_message[] is an array of strings, used as a circular buffer
// web_log_message_nextfree points to the next free-to-use buffer line
// when web_log_message_nextfree becomes larger than NUM_WEB_LOG_MESSAGES,
// it is reset to 0 and web_log_message_rotated=true
// web_log_message_newline indicates whether we are at the beginning of a line or not
if (web_log_message_newline) {
#ifdef DST
char *dstAbbrev;
time_t now = dstAdjusted.time(&dstAbbrev);
#else
time_t now = time(nullptr);
#endif
struct tm * timeinfo = localtime(&now);
char buffer[30];
strftime (buffer, 30, "%Y-%m-%d %T", timeinfo);
//web_log_message[web_log_message_nextfree] = (String)buffer + " " + dstAbbrev + " " + msg;
//Serial.print((String)buffer + " " + dstAbbrev + " " + msg);
web_log_message[web_log_message_nextfree] = (String)buffer + " " + msg;
Serial.print((String)buffer + " " + msg);
web_log_message_newline = false;
} else {
web_log_message[web_log_message_nextfree] += " " + msg;
Serial.print(" " + msg);
}
if (new_line == true) {
web_log_message_nextfree++;
if (web_log_message_nextfree >= NUM_WEB_LOG_MESSAGES) {
web_log_message_nextfree = 0;
web_log_message_rotated = true;
}
Serial.println();
web_log_message_newline = true;
}
} // void WriteLog
//####################################################################
// Function to connect to Wifi
//####################################################################
void ConfigureWifi()
{
WriteLog("[INFO] - WiFi connecting to", false);
WriteLog(config.ssid, true);
WiFi.mode(WIFI_STA);
WiFi.begin (config.ssid.c_str(), config.password.c_str());
if (!config.dhcp)
{
WiFi.config(IPAddress(config.ip[0], config.ip[1], config.ip[2], config.ip[3] ), IPAddress(config.gateway[0], config.gateway[1], config.gateway[2], config.gateway[3] ) , IPAddress(config.netmask[0], config.netmask[1], config.netmask[2], config.netmask[3] ));
}
wifi_disconnect_log = true;
} // void ConfigureWifi
//################################################################
// Function to write newest version of configuration into EEPROM
//################################################################
void WriteConfig()
{
WriteLog("[INFO] - write config to EEPROM", true);
EEPROM.write(120, 'C');
EEPROM.write(121, 'f');
EEPROM.write(122, 'g');
EEPROM.put(123, config.cfgVersion);
EEPROM.write(128, config.dhcp);
EEPROM.write(144, config.ip[0]);
EEPROM.write(145, config.ip[1]);
EEPROM.write(146, config.ip[2]);
EEPROM.write(147, config.ip[3]);
EEPROM.write(148, config.netmask[0]);
EEPROM.write(149, config.netmask[1]);
EEPROM.write(150, config.netmask[2]);
EEPROM.write(151, config.netmask[3]);
EEPROM.write(152, config.gateway[0]);
EEPROM.write(153, config.gateway[1]);
EEPROM.write(154, config.gateway[2]);
EEPROM.write(155, config.gateway[3]);
EEPROM.write(156, config.mqtt_broker_addr[0]);
EEPROM.write(157, config.mqtt_broker_addr[1]);
EEPROM.write(158, config.mqtt_broker_addr[2]);
EEPROM.write(159, config.mqtt_broker_addr[3]);
WriteStringToEEPROM(164, config.ssid);
WriteStringToEEPROM(196, config.password);
WriteStringToEEPROM(262, config.mqtt_broker_port);
WriteStringToEEPROM(270, config.master_msb);
WriteStringToEEPROM(330, config.master_lsb);
EEPROM.write(350, config.learn_mode);
WriteStringToEEPROM(366, config.serial);
WriteStringToEEPROM(375, config.mqtt_broker_client_id);
WriteStringToEEPROM(400, config.mqtt_broker_username);
WriteStringToEEPROM(450, config.mqtt_broker_password);
WriteStringToEEPROM(1300, config.mqtt_devicetopic);
WriteStringToEEPROM(500, config.channel_name[0]);
WriteStringToEEPROM(550, config.channel_name[1]);
WriteStringToEEPROM(600, config.channel_name[2]);
WriteStringToEEPROM(650, config.channel_name[3]);
WriteStringToEEPROM(700, config.channel_name[4]);
WriteStringToEEPROM(750, config.channel_name[5]);
WriteStringToEEPROM(800, config.channel_name[6]);
WriteStringToEEPROM(850, config.channel_name[7]);
WriteStringToEEPROM(900, config.channel_name[8]);
WriteStringToEEPROM(950, config.channel_name[9]);
WriteStringToEEPROM(1000, config.channel_name[10]);
WriteStringToEEPROM(1050, config.channel_name[11]);
WriteStringToEEPROM(1100, config.channel_name[12]);
WriteStringToEEPROM(1150, config.channel_name[13]);
WriteStringToEEPROM(1200, config.channel_name[14]);
WriteStringToEEPROM(1250, config.channel_name[15]);
#define ShadeValueAdr 1350
EEPROM.write(1350, config.shade_value[0]);
EEPROM.write(1351, config.shade_value[1]);
EEPROM.write(1352, config.shade_value[2]);
EEPROM.write(1353, config.shade_value[3]);
EEPROM.write(1354, config.shade_value[4]);
EEPROM.write(1355, config.shade_value[5]);
EEPROM.write(1356, config.shade_value[6]);
EEPROM.write(1357, config.shade_value[7]);
EEPROM.write(1358, config.shade_value[8]);
EEPROM.write(1359, config.shade_value[9]);
EEPROM.write(1360, config.shade_value[10]);
EEPROM.write(1361, config.shade_value[11]);
EEPROM.write(1362, config.shade_value[12]);
EEPROM.write(1363, config.shade_value[13]);
EEPROM.write(1364, config.shade_value[14]);
EEPROM.write(1365, config.shade_value[15]);
EEPROM.commit();
delay(1000);
} // void WriteConfig
//####################################################################
// Function to read configuration from EEPROM
//####################################################################
boolean ReadConfig()
{
WriteLog("[INFO] - read config from EEPROM...", false);
config.cfgVersion = 0;
if (EEPROM.read(120) == 'C' && EEPROM.read(121) == 'F' && EEPROM.read(122) == 'G' )
{
WriteLog("config version 1 found", true);
config.cfgVersion = 1;
} else
{
if (EEPROM.read(120) == 'C' && EEPROM.read(121) == 'f' && EEPROM.read(122) == 'g' )
{
EEPROM.get(123, config.cfgVersion);
WriteLog("config version " + (String) config.cfgVersion + " found", true);
}
}
if (config.cfgVersion == 0)
{
WriteLog(" no configuration found in EEPROM!!!!", true);
return false;
}
if (config.cfgVersion <= 2) // read config parts up to version 2
{
config.dhcp = EEPROM.read(128);
config.ip[0] = EEPROM.read(144);
config.ip[1] = EEPROM.read(145);
config.ip[2] = EEPROM.read(146);
config.ip[3] = EEPROM.read(147);
config.netmask[0] = EEPROM.read(148);
config.netmask[1] = EEPROM.read(149);
config.netmask[2] = EEPROM.read(150);
config.netmask[3] = EEPROM.read(151);
config.gateway[0] = EEPROM.read(152);
config.gateway[1] = EEPROM.read(153);
config.gateway[2] = EEPROM.read(154);
config.gateway[3] = EEPROM.read(155);
config.mqtt_broker_addr[0] = EEPROM.read(156);
config.mqtt_broker_addr[1] = EEPROM.read(157);
config.mqtt_broker_addr[2] = EEPROM.read(158);
config.mqtt_broker_addr[3] = EEPROM.read(159);
config.ssid = ReadStringFromEEPROM(164, 32);
config.password = ReadStringFromEEPROM(196, 64);
config.mqtt_broker_port = ReadStringFromEEPROM(262, 6);
config.master_msb = ReadStringFromEEPROM(270, 10);
config.master_lsb = ReadStringFromEEPROM(330, 10);
config.learn_mode = EEPROM.read(350);
config.serial = ReadStringFromEEPROM(366, 10);
config.mqtt_broker_client_id = ReadStringFromEEPROM(375, 25);
config.mqtt_broker_username = ReadStringFromEEPROM(400, 25);
config.mqtt_broker_password = ReadStringFromEEPROM(450, 25);
config.channel_name[0] = ReadStringFromEEPROM(500, 25);
config.channel_name[1] = ReadStringFromEEPROM(550, 25);
config.channel_name[2] = ReadStringFromEEPROM(600, 25);
config.channel_name[3] = ReadStringFromEEPROM(650, 25);
config.channel_name[4] = ReadStringFromEEPROM(700, 25);
config.channel_name[5] = ReadStringFromEEPROM(750, 25);
config.channel_name[6] = ReadStringFromEEPROM(800, 25);
config.channel_name[7] = ReadStringFromEEPROM(850, 25);
config.channel_name[8] = ReadStringFromEEPROM(900, 25);
config.channel_name[9] = ReadStringFromEEPROM(950, 25);
config.channel_name[10] = ReadStringFromEEPROM(1000, 25);
config.channel_name[11] = ReadStringFromEEPROM(1050, 25);
config.channel_name[12] = ReadStringFromEEPROM(1100, 25);
config.channel_name[13] = ReadStringFromEEPROM(1150, 25);
config.channel_name[14] = ReadStringFromEEPROM(1200, 25);
config.channel_name[15] = ReadStringFromEEPROM(1250, 25);
}
if (config.cfgVersion == 2)
{ // read config parts of version 2
config.mqtt_devicetopic = ReadStringFromEEPROM(1300, 20);
config.shade_value[0] = EEPROM.read(1350);
config.shade_value[1] = EEPROM.read(1351);
config.shade_value[2] = EEPROM.read(1352);
config.shade_value[3] = EEPROM.read(1353);
config.shade_value[4] = EEPROM.read(1354);
config.shade_value[5] = EEPROM.read(1355);
config.shade_value[6] = EEPROM.read(1356);
config.shade_value[7] = EEPROM.read(1357);
config.shade_value[8] = EEPROM.read(1358);
config.shade_value[9] = EEPROM.read(1359);
config.shade_value[10] = EEPROM.read(1360);
config.shade_value[11] = EEPROM.read(1361);
config.shade_value[12] = EEPROM.read(1362);
config.shade_value[13] = EEPROM.read(1363);
config.shade_value[14] = EEPROM.read(1364);
config.shade_value[15] = EEPROM.read(1365);
} else
{ // upgrade config to version 2
config.mqtt_devicetopic = "jarolift"; // default devicetopic
config.cfgVersion = 2;
// clear EEPROM space
for (int index = 120 ; index < 4096 ; index++) {
EEPROM.write(index, 0);
}
WriteLog("[INFO] - config update to version 2 - mqtt_devicetopic set to default", true);
WriteConfig();
}
// check is config.serial is hexadecimal
// if necessary, convert decimal to hexadecimal
if ((config.serial[0] == '0') && (config.serial[1] == 'x')) {
// config.serial is hex
// Serial is 28 bits
// string serial stores only highest 24 bits,
// add lowest byte with a shift operation for config.serial_number
config.serial_number = strtol(config.serial.c_str(), NULL, 16) << 4;
} else {
// config.serial is NOT hex
config.serial_number = strtol(config.serial.c_str(), NULL, 10);
// Serial is 28 bits.
// string serial stores only highest 24 bits,
// remove lowest 4 bits with a shift operation
char serialNumBuffer[11];
snprintf(serialNumBuffer, 11, "0x%06x", (config.serial_number >> 4));
config.serial = serialNumBuffer;
Serial.printf("convert config.serial to hex: %08u = 0x%08x \n", config.serial_number, config.serial_number);
Serial.println("config.serial: " + config.serial);
WriteLog("[INFO] - config version 2 - convert serial decimal->hexadecimal", true);
WriteConfig();
}
char charBufSB[11];
config.master_msb.toCharArray(charBufSB, config.master_msb.length() + 1);
config.ulMasterMSB = (int)strtol(charBufSB, NULL, 16);
config.master_lsb.toCharArray(charBufSB, config.master_lsb.length() + 1);
config.ulMasterLSB = (int)strtol(charBufSB, NULL, 16);
return true;
} // boolean ReadConfig
//############################################################################
// Function to initialize configuration, either defaults or read from EEPROM
//############################################################################
void InitializeConfigData()
{
char chipIdString[10];
sprintf(chipIdString, "-%08x", ESP.getChipId());
// apply default config if saved configuration not yet exist
if (!ReadConfig())
{
// DEFAULT CONFIG
config.cfgVersion = 2;
config.ssid = "MYSSID";
config.password = "MYPASSWORD";
config.dhcp = true;
config.ip[0] = 192; config.ip[1] = 168; config.ip[2] = 1; config.ip[3] = 100;
config.netmask[0] = 255; config.netmask[1] = 255; config.netmask[2] = 255; config.netmask[3] = 0;
config.gateway[0] = 192; config.gateway[1] = 168; config.gateway[2] = 1; config.gateway[3] = 1;
config.mqtt_broker_addr[0] = 0; config.mqtt_broker_addr[1] = 0; config.mqtt_broker_addr[2] = 0; config.mqtt_broker_addr[3] = 0;
config.mqtt_broker_port = "1883";
config.mqtt_broker_client_id = "JaroliftDongle";
config.mqtt_broker_client_id += chipIdString;
config.mqtt_devicetopic = "jarolift";
config.master_msb = "0x12345678";
config.master_lsb = "0x12345678";
config.learn_mode = true;
config.serial = "12345600";
for ( int i = 0; i <= 15; i++ ) {
config.channel_name[i] = "";
}
for ( int i = 0; i <= 15; i++ ) {
config.shade_value[i] = 0;
}
WriteConfig();
WriteLog("[INFO] - default config applied", true);
}
// check if mqtt client-ID needs migration to new unique ID
if (config.mqtt_broker_client_id == "JaroliftDongle") {
config.mqtt_broker_client_id += chipIdString;
WriteLog("[INFO] - mqtt_broker_client_id changed to " + config.mqtt_broker_client_id, true);
WriteConfig();
}
} // void InitializeConfigData
//####################################################################
// Callback function for LED HeartBeat
//####################################################################
boolean highPulse = true;
#define HEART_BEAT_CYCLE 4 // HeartBeat cycle in seconds
void HeartBeat()
{
shade_learn_time++;
float pulse_on = 0.05; // LED on for 50 milliseconds in normal mode
float pulse_off = HEART_BEAT_CYCLE - pulse_on;
if (WiFi.status() != WL_CONNECTED)
{
pulse_on = HEART_BEAT_CYCLE / 2; // LED on for 2 seconds, 2 seconds off while waiting for WiFi connect
pulse_off = pulse_on;
}
if (AdminEnabled)
{
AdminTimeOutCounter++;
pulse_off = 0.05;
pulse_on = HEART_BEAT_CYCLE - pulse_off; // LED off for 50 milliseconds in admin mode
}
if (highPulse)
tkHeartBeat.attach(pulse_on, HeartBeat);
else
tkHeartBeat.attach(pulse_off, HeartBeat);
highPulse = !highPulse;
digitalWrite(led_pin, highPulse); // toogle LED
} // void HeartBeat
#endif