-
Notifications
You must be signed in to change notification settings - Fork 134
/
Copy pathVirtualKeypad-Web.ino
1616 lines (1451 loc) · 57.9 KB
/
VirtualKeypad-Web.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
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* VirtualKeypad-Web 1.3 (esp8266)
*
* Provides a virtual keypad web interface using the esp8266 as a standalone web server, including
* alarm memory, programming zone lights, and viewing the event buffer. To access the event buffer,
* enter *6, enter an access code, then press the keypad "Enter" button.
*
* Usage:
* 1. Install the following libraries directly from each Github repository:
* ESPAsyncWebServer: https://github.com/me-no-dev/ESPAsyncWebServer
* ESPAsyncTCP: https://github.com/me-no-dev/ESPAsyncTCP
*
* 2. Install ESP8266FS to enable uploading web server files to the esp8266:
* https://arduino-esp8266.readthedocs.io/en/latest/filesystem.html#uploading-files-to-file-system
*
* 3. Install the following libraries, available in the Arduino IDE Library Manager and
* the Platform.io Library Registry:
* ArduinoJson: https://github.com/bblanchon/ArduinoJson
* Chrono: https://github.com/SofaPirate/Chrono
*
* 4. Set the WiFi SSID and password in the sketch.
* 5. If desired, update the DNS hostname in the sketch. By default, this is set to
* "dsc" and the web interface will be accessible at: http://dsc.local
* 6. Set the esp8266 flash size to use 1M SPIFFS.
* Arduino IDE: Tools > Flash Size > 4M (1M SPIFFS)
* 7. Upload the sketch.
* 8. Upload the SPIFFS data containing the web server files:
* Arduino IDE: Tools > ESP8266 Sketch Data Upload
* 9. Access the virtual keypad web interface by the IP address displayed through
* the serial output or http://dsc.local (for clients and networks that support mDNS).
*
* Release notes:
* 1.3 - Add event buffer display
* Display zone lights in alarm memory and programming
* Added AC power status, reset, quick exit
* Removed UI <> buttons, backlight icon, PGM
* 1.2 - Updated esp8266 wiring diagram for 33k/10k resistors
* 1.1 - New: Fire, alarm, panic, stay arm, away arm, door chime buttons are now functional
* Bugfix: Set mDNS to update in loop()
* Updated: ArduinoOTA no longer included by default
* 1.0 - Initial release
*
* Wiring:
* DSC Aux(+) --- 5v voltage regulator --- esp8266 development board 5v pin (NodeMCU, Wemos)
*
* DSC Aux(-) --- esp8266 Ground
*
* +--- dscClockPin (esp8266: D1, D2, D8)
* DSC Yellow --- 33k ohm resistor ---|
* +--- 10k ohm resistor --- Ground
*
* +--- dscReadPin (esp8266: D1, D2, D8)
* DSC Green ---- 33k ohm resistor ---|
* +--- 10k ohm resistor --- Ground
*
* Virtual keypad (optional):
* DSC Green ---- NPN collector --\
* |-- NPN base --- 1k ohm resistor --- dscWritePin (esp8266: D1, D2, D8)
* Ground --- NPN emitter --/
*
* Virtual keypad uses an NPN transistor to pull the data line low - most small signal NPN transistors should
* be suitable, for example:
* -- 2N3904
* -- BC547, BC548, BC549
*
* Issues and (especially) pull requests are welcome:
* https://github.com/taligentx/dscKeybusInterface
*
* Many thanks to Elektrik1 for contributing this example: https://github.com/Elektrik1
*
* This example code is in the public domain.
*/
#include <ESP8266WiFi.h>
#include <ESP8266mDNS.h>
#include <dscKeybusInterface.h>
#include <ESPAsyncWebServer.h>
#include <ESPAsyncTCP.h>
#include <FS.h>
#include <ArduinoJson.h>
#include <Chrono.h>
// Settings
const char* wifiSSID = "";
const char* wifiPassword = "";
const char* dnsHostname = "dsc"; // Sets the domain name - if set to "dsc", access via: http://dsc.local
const byte dscPartition = 1; // Set the partition for the keypad
// Configures the Keybus interface with the specified pins
#define dscClockPin D1 // esp8266: D1, D2, D8 (GPIO 5, 4, 15)
#define dscReadPin D2 // esp8266: D1, D2, D8 (GPIO 5, 4, 15)
#define dscWritePin D8 // esp8266: D1, D2, D8 (GPIO 5, 4, 15)
// Initialize components
dscKeybusInterface dsc(dscClockPin, dscReadPin, dscWritePin);
AsyncWebServer server(80);
AsyncWebSocket ws("/ws");
Chrono ws_ping_pong(Chrono::SECONDS);
bool partitionChanged, pausedZones, extendedBuffer;
byte systemZones[dscZones], programZones[dscZones];
byte partition = dscPartition - 1;
bool forceUpdate = false;
void setup() {
Serial.begin(115200);
delay(1000);
Serial.println();
Serial.println();
Serial.print(F("WiFi..."));
WiFi.mode(WIFI_STA);
WiFi.begin(wifiSSID, wifiPassword);
while (WiFi.status() != WL_CONNECTED) {
Serial.print(".");
delay(500);
}
Serial.print(F("connected: "));
Serial.println(WiFi.localIP());
if (!MDNS.begin(dnsHostname)) {
Serial.println("Error setting up MDNS responder.");
while (1) {
delay(1000);
}
}
SPIFFS.begin();
ws.onEvent(onWsEvent);
server.addHandler(&ws);
server.serveStatic("/", SPIFFS, "/").setDefaultFile("index.html");
server.begin();
MDNS.addService("http", "tcp", 80);
Serial.print(F("Web server started: http://"));
Serial.print(dnsHostname);
Serial.println(F(".local"));
dsc.begin();
dsc.writePartition = dscPartition;
ws_ping_pong.stop();
Serial.println(F("DSC Keybus Interface is online."));
}
void loop() {
MDNS.update();
//ping-pong WebSocket to keep connection open
if (ws_ping_pong.isRunning() && ws_ping_pong.elapsed() > 5 * 60) {
ws.pingAll();
ws_ping_pong.restart();
}
bool validCommand = false;
if (dsc.loop()) {
validCommand = true;
processStatus(); // Processes status data that is not handled natively by the library
}
if (validCommand && (dsc.statusChanged || forceUpdate)) { // Processes data only when a valid Keybus command has been read
dsc.statusChanged = false; // Resets the status flag
// If the Keybus data buffer is exceeded, the sketch is too busy to process all Keybus commands. Call
// loop() more often, or increase dscBufferSize in the library: src/dscKeybusInterface.h
if (dsc.bufferOverflow) {
Serial.println(F("Keybus buffer overflow"));
dsc.bufferOverflow = false;
}
setLights(partition);
setStatus(partition);
// Zone status is stored in the openZones[] and openZonesChanged[] arrays using 1 bit per zone, up to 64 zones
// openZones[0] and openZonesChanged[0]: Bit 0 = Zone 1 ... Bit 7 = Zone 8
// openZones[1] and openZonesChanged[1]: Bit 0 = Zone 9 ... Bit 7 = Zone 16
// ...
// openZones[7] and openZonesChanged[7]: Bit 0 = Zone 57 ... Bit 7 = Zone 64
if ((dsc.openZonesStatusChanged && !pausedZones) || forceUpdate) {
dsc.openZonesStatusChanged = false; // Resets the open zones status flag
for (byte zoneGroup = 0; zoneGroup < dscZones; zoneGroup++) {
dsc.openZonesChanged[zoneGroup] = 0;
systemZones[zoneGroup] = dsc.openZones[zoneGroup];
}
if (ws.count()) {
char outas[512];
StaticJsonDocument<200> doc;
JsonObject root = doc.to<JsonObject>();
root["open_zone_0"] = dsc.openZones[0];
root["open_zone_1"] = dsc.openZones[1];
root["open_zone_2"] = dsc.openZones[2];
root["open_zone_3"] = dsc.openZones[3];
root["open_zone_4"] = dsc.openZones[4];
root["open_zone_5"] = dsc.openZones[5];
root["open_zone_6"] = dsc.openZones[6];
root["open_zone_7"] = dsc.openZones[7];
serializeJson(root, outas);
ws.textAll(outas);
}
}
// Zone alarm status is stored in the alarmZones[] and alarmZonesChanged[] arrays using 1 bit per zone, up to 64 zones
// alarmZones[0] and alarmZonesChanged[0]: Bit 0 = Zone 1 ... Bit 7 = Zone 8
// alarmZones[1] and alarmZonesChanged[1]: Bit 0 = Zone 9 ... Bit 7 = Zone 16
// ...
// alarmZones[7] and alarmZonesChanged[7]: Bit 0 = Zone 57 ... Bit 7 = Zone 64
if (dsc.alarmZonesStatusChanged || forceUpdate) {
dsc.alarmZonesStatusChanged = false; // Resets the alarm zones status flag
for (byte zoneGroup = 0; zoneGroup < dscZones; zoneGroup++) {
dsc.alarmZonesChanged[zoneGroup] = 0;
}
if (ws.count()) {
char outas[512];
StaticJsonDocument<200> doc;
JsonObject root = doc.to<JsonObject>();
root["alarm_zone_0"] = dsc.alarmZones[0];
root["alarm_zone_1"] = dsc.alarmZones[1];
root["alarm_zone_2"] = dsc.alarmZones[2];
root["alarm_zone_3"] = dsc.alarmZones[3];
root["alarm_zone_4"] = dsc.alarmZones[4];
root["alarm_zone_5"] = dsc.alarmZones[5];
root["alarm_zone_6"] = dsc.alarmZones[6];
root["alarm_zone_7"] = dsc.alarmZones[7];
serializeJson(root, outas);
ws.textAll(outas);
}
}
if (dsc.powerChanged || forceUpdate) {
dsc.powerChanged = false; // Resets the power trouble status flag
if (dsc.powerTrouble) {
if (ws.count()) {
char outas[128];
StaticJsonDocument<200> doc;
JsonObject root = doc.to<JsonObject>();
root["power_status"] = 0;
serializeJson(root, outas);
ws.textAll(outas);
}
}
else {
if (ws.count()) {
char outas[128];
StaticJsonDocument<200> doc;
JsonObject root = doc.to<JsonObject>();
root["power_status"] = 1;
serializeJson(root, outas);
ws.textAll(outas);
}
}
}
if (forceUpdate) {
forceUpdate = false;
}
}
}
void setStatus(byte partition) {
static byte lastStatus[8];
if (!partitionChanged && dsc.status[partition] == lastStatus[partition] && !forceUpdate) return;
lastStatus[partition] = dsc.status[partition];
if (ws.count()) {
char outas[128];
StaticJsonDocument<200> doc;
JsonObject root = doc.to<JsonObject>();
switch (dsc.status[partition]) {
case 0x01: root["lcd_upper"] = "Partition ";
root["lcd_lower"] = "ready ";
if (pausedZones) resetZones(); break;
case 0x02: root["lcd_upper"] = "Stay ";
root["lcd_lower"] = "zones open ";
if (pausedZones) resetZones(); break;
case 0x03: root["lcd_upper"] = "Zones open ";
root["lcd_lower"] = " ";
if (pausedZones) resetZones(); break;
case 0x04: root["lcd_upper"] = "Armed: ";
root["lcd_lower"] = "Stay ";
if (pausedZones) resetZones(); break;
case 0x05: root["lcd_upper"] = "Armed: ";
root["lcd_lower"] = "Away ";
if (pausedZones) resetZones(); break;
case 0x06: root["lcd_upper"] = "Armed: ";
root["lcd_lower"] = "No entry delay ";
if (pausedZones) resetZones(); break;
case 0x07: root["lcd_upper"] = "Failed ";
root["lcd_lower"] = "to arm "; break;
case 0x08: root["lcd_upper"] = "Exit delay ";
root["lcd_lower"] = "in progress ";
if (pausedZones) resetZones(); break;
case 0x09: root["lcd_upper"] = "Arming: ";
root["lcd_lower"] = "No entry delay "; break;
case 0x0B: root["lcd_upper"] = "Quick exit ";
root["lcd_lower"] = "in progress "; break;
case 0x0C: root["lcd_upper"] = "Entry delay ";
root["lcd_lower"] = "in progress "; break;
case 0x0D: root["lcd_upper"] = "Entry delay ";
root["lcd_lower"] = "after alarm "; break;
case 0x0E: root["lcd_upper"] = "Not ";
root["lcd_lower"] = "available "; break;
case 0x10: root["lcd_upper"] = "Keypad ";
root["lcd_lower"] = "lockout "; break;
case 0x11: root["lcd_upper"] = "Partition ";
root["lcd_lower"] = "in alarm "; break;
case 0x12: root["lcd_upper"] = "Battery check";
root["lcd_lower"] = "in progress "; break;
case 0x14: root["lcd_upper"] = "Auto-arm ";
root["lcd_lower"] = "in progress "; break;
case 0x15: root["lcd_upper"] = "Arming with ";
root["lcd_lower"] = "bypass zones "; break;
case 0x16: root["lcd_upper"] = "Armed: ";
root["lcd_lower"] = "No entry delay ";
if (pausedZones) resetZones(); break;
case 0x17: root["lcd_upper"] = "Power saving ";
root["lcd_lower"] = "Keypad blanked "; break;
case 0x19: root["lcd_upper"] = "Alarm ";
root["lcd_lower"] = "occurred "; break;
case 0x22: root["lcd_upper"] = "Recent ";
root["lcd_lower"] = "closing "; break;
case 0x2F: root["lcd_upper"] = "Keypad LCD ";
root["lcd_lower"] = "test "; break;
case 0x33: root["lcd_upper"] = "Command ";
root["lcd_lower"] = "output active "; break;
case 0x3D: root["lcd_upper"] = "Alarm ";
root["lcd_lower"] = "occurred "; break;
case 0x3E: root["lcd_upper"] = "Disarmed ";
root["lcd_lower"] = " "; break;
case 0x40: root["lcd_upper"] = "Keypad ";
root["lcd_lower"] = "blanked "; break;
case 0x8A: root["lcd_upper"] = "Activate ";
root["lcd_lower"] = "stay/away zones "; break;
case 0x8B: root["lcd_upper"] = "Quick exit ";
root["lcd_lower"] = " "; break;
case 0x8E: root["lcd_upper"] = "Invalid ";
root["lcd_lower"] = "option "; break;
case 0x8F: root["lcd_upper"] = "Invalid ";
root["lcd_lower"] = "access code "; break;
case 0x9E: root["lcd_upper"] = "Enter * ";
root["lcd_lower"] = "function code "; break;
case 0x9F: root["lcd_upper"] = "Enter ";
root["lcd_lower"] = "access code "; break;
case 0xA0: root["lcd_upper"] = "*1: ";
root["lcd_lower"] = "Zone bypass "; break;
case 0xA1: root["lcd_upper"] = "*2: ";
root["lcd_lower"] = "Trouble menu "; break;
case 0xA2: root["lcd_upper"] = "*3: ";
root["lcd_lower"] = "Alarm memory "; break;
case 0xA3: root["lcd_upper"] = "Door ";
root["lcd_lower"] = "chime enabled "; break;
case 0xA4: root["lcd_upper"] = "Door ";
root["lcd_lower"] = "chime disabled "; break;
case 0xA5: root["lcd_upper"] = "Enter ";
root["lcd_lower"] = "master code "; break;
case 0xA6: root["lcd_upper"] = "*5: ";
root["lcd_lower"] = "Access codes "; break;
case 0xA7: root["lcd_upper"] = "*5 Enter new ";
root["lcd_lower"] = "4-digit code "; break;
case 0xA9: root["lcd_upper"] = "*6: ";
root["lcd_lower"] = "User functions "; break;
case 0xAA: root["lcd_upper"] = "*6: ";
root["lcd_lower"] = "Time and date "; break;
case 0xAB: root["lcd_upper"] = "*6: ";
root["lcd_lower"] = "Auto-arm time "; break;
case 0xAC: root["lcd_upper"] = "*6: ";
root["lcd_lower"] = "Auto-arm on "; break;
case 0xAD: root["lcd_upper"] = "*6: ";
root["lcd_lower"] = "Auto-arm off "; break;
case 0xAF: root["lcd_upper"] = "*6: ";
root["lcd_lower"] = "System test "; break;
case 0xB0: root["lcd_upper"] = "*6: ";
root["lcd_lower"] = "Enable DLS "; break;
case 0xB2: root["lcd_upper"] = "*7: ";
root["lcd_lower"] = "Command output "; break;
case 0xB7: root["lcd_upper"] = "Enter ";
root["lcd_lower"] = "installer code "; break;
case 0xB8: root["lcd_upper"] = "Enter * ";
root["lcd_lower"] = "function code "; break;
case 0xB9: root["lcd_upper"] = "*2: ";
root["lcd_lower"] = "Zone tamper menu"; break;
case 0xBA: root["lcd_upper"] = "*2: Zones ";
root["lcd_lower"] = "low battery "; break;
case 0xBC: root["lcd_upper"] = "*5 Enter new ";
root["lcd_lower"] = "6-digit code "; break;
case 0xC6: root["lcd_upper"] = "*2: ";
root["lcd_lower"] = "Zone fault menu "; break;
case 0xC7: root["lcd_upper"] = "Partition ";
root["lcd_lower"] = "disabled "; break;
case 0xC8: root["lcd_upper"] = "*2: ";
root["lcd_lower"] = "Service required"; break;
case 0xCE: root["lcd_upper"] = "Active camera";
root["lcd_lower"] = "monitor select. "; break;
case 0xD0: root["lcd_upper"] = "*2: Keypads ";
root["lcd_lower"] = "low battery "; break;
case 0xD1: root["lcd_upper"] = "*2: Keyfobs ";
root["lcd_lower"] = "low battery "; break;
case 0xD4: root["lcd_upper"] = "*2: Sensors ";
root["lcd_lower"] = "RF Delinquency "; break;
case 0xE4: root["lcd_upper"] = "*8: Installer";
root["lcd_lower"] = "menu, 3 digits "; break;
case 0xE5: root["lcd_upper"] = "Keypad ";
root["lcd_lower"] = "slot assignment "; break;
case 0xE6: root["lcd_upper"] = "Input: ";
root["lcd_lower"] = "2 digits "; break;
case 0xE7: root["lcd_upper"] = "Input: ";
root["lcd_lower"] = "3 digits "; break;
case 0xE8: root["lcd_upper"] = "Input: ";
root["lcd_lower"] = "4 digits "; break;
case 0xE9: root["lcd_upper"] = "Input: ";
root["lcd_lower"] = "5 digits "; break;
case 0xEA: root["lcd_upper"] = "Input HEX: ";
root["lcd_lower"] = "2 digits "; break;
case 0xEB: root["lcd_upper"] = "Input HEX: ";
root["lcd_lower"] = "4 digits "; break;
case 0xEC: root["lcd_upper"] = "Input HEX: ";
root["lcd_lower"] = "6 digits "; break;
case 0xED: root["lcd_upper"] = "Input HEX: ";
root["lcd_lower"] = "32 digits "; break;
case 0xEE: root["lcd_upper"] = "Input: 1 ";
root["lcd_lower"] = "option per zone "; break;
case 0xEF: root["lcd_upper"] = "Module ";
root["lcd_lower"] = "supervision "; break;
case 0xF0: root["lcd_upper"] = "Function ";
root["lcd_lower"] = "key 1 "; break;
case 0xF1: root["lcd_upper"] = "Function ";
root["lcd_lower"] = "key 2 "; break;
case 0xF2: root["lcd_upper"] = "Function ";
root["lcd_lower"] = "key 3 "; break;
case 0xF3: root["lcd_upper"] = "Function ";
root["lcd_lower"] = "key 4 "; break;
case 0xF4: root["lcd_upper"] = "Function ";
root["lcd_lower"] = "key 5 "; break;
case 0xF5: root["lcd_upper"] = "Wireless mod.";
root["lcd_lower"] = "placement test "; break;
case 0xF6: root["lcd_upper"] = "Activate ";
root["lcd_lower"] = "device for test "; break;
case 0xF7: root["lcd_upper"] = "*8: Installer";
root["lcd_lower"] = "menu, 2 digits "; break;
case 0xF8: root["lcd_upper"] = "Keypad ";
root["lcd_lower"] = "programming "; break;
case 0xFA: root["lcd_upper"] = "Input: ";
root["lcd_lower"] = "6 digits "; break;
default: root["lcd_lower"] = dsc.status[partition];
}
serializeJson(root, outas);
ws.textAll(outas);
}
}
void setLights(byte partition) {
static byte previousLights = 0;
if ((dsc.lights[partition] != previousLights || forceUpdate) && ws.count()) {
char outas[128];
StaticJsonDocument<200> doc;
JsonObject root = doc.to<JsonObject>();
root["status_lights"] = dsc.lights[partition];
serializeJson(root, outas);
ws.textAll(outas);
previousLights = dsc.lights[partition];
}
}
// Processes status data not natively handled within the library
void processStatus() {
switch (dsc.panelData[0]) {
case 0x05:
if ((dsc.panelData[3] == 0x9E || dsc.panelData[3] == 0xB8) && !pausedZones) {
pauseZones();
}
break;
case 0x0A:
if ((dsc.panelData[3] == 0x9E || dsc.panelData[3] == 0xB8) && !pausedZones) {
pauseZones();
}
if (pausedZones) processProgramZones(4);
break;
case 0x5D:
if ((dsc.panelData[2] & 0x04) == 0x04) { // Alarm memory zones 1-32
if (pausedZones) processProgramZones(3);
}
break;
case 0xAA: if (pausedZones) processEventBufferAA(); break;
case 0xE6:
switch (dsc.panelData[2]) {
case 0x01:
case 0x02:
case 0x03:
case 0x04:
case 0x05:
case 0x06:
case 0x20:
case 0x21: if (pausedZones) processProgramZones(5); break; // Programming zone lights 33-64
case 0x18: if (pausedZones && (dsc.panelData[4] & 0x04) == 0x04) processProgramZones(5); break; // Alarm memory zones 33-64
}
break;
case 0xEC: if (pausedZones) processEventBufferEC(); break;
}
}
void processProgramZones(byte startByte) {
byte byteCount = 0;
byte zoneStart = 0;
if (startByte == 5) zoneStart = 4;
for (byte zoneGroup = zoneStart; zoneGroup < zoneStart + 4; zoneGroup++) {
programZones[zoneGroup] = dsc.panelData[startByte + byteCount];
byteCount++;
}
if (ws.count()) {
char outas[512];
StaticJsonDocument<200> doc;
JsonObject root = doc.to<JsonObject>();
root["program_zone_0"] = programZones[0];
root["program_zone_1"] = programZones[1];
root["program_zone_2"] = programZones[2];
root["program_zone_3"] = programZones[3];
root["program_zone_4"] = programZones[4];
root["program_zone_5"] = programZones[5];
root["program_zone_6"] = programZones[6];
root["program_zone_7"] = programZones[7];
serializeJson(root, outas);
ws.textAll(outas);
}
}
void processEventBufferAA() {
if (extendedBuffer) return; // Skips 0xAA data when 0xEC extended event buffer data is available
char eventInfo[45] = "Event: ";
char charBuffer[4];
itoa(dsc.panelData[7], charBuffer, 10);
if (dsc.panelData[7] < 10) strcat(eventInfo, "00");
else if (dsc.panelData[7] < 100) strcat(eventInfo, "0");
strcat(eventInfo, charBuffer);
strcat(eventInfo, " | ");
byte dscYear3 = dsc.panelData[2] >> 4;
byte dscYear4 = dsc.panelData[2] & 0x0F;
byte dscMonth = dsc.panelData[2 + 1] << 2; dscMonth >>= 4;
byte dscDay1 = dsc.panelData[2 + 1] << 6; dscDay1 >>= 3;
byte dscDay2 = dsc.panelData[2 + 2] >> 5;
byte dscDay = dscDay1 | dscDay2;
byte dscHour = dsc.panelData[2 + 2] & 0x1F;
byte dscMinute = dsc.panelData[2 + 3] >> 2;
if (dscYear3 >= 7) strcat(eventInfo, "19");
else strcat(eventInfo, "20");
itoa(dscYear3, charBuffer, 10);
strcat(eventInfo, charBuffer);
itoa(dscYear4, charBuffer, 10);
strcat(eventInfo, charBuffer);
strcat(eventInfo, ".");
if (dscMonth < 10) strcat(eventInfo, "0");
itoa(dscMonth, charBuffer, 10);
strcat(eventInfo, charBuffer);
strcat(eventInfo, ".");
if (dscDay < 10) strcat(eventInfo, "0");
itoa(dscDay, charBuffer, 10);
strcat(eventInfo, charBuffer);
strcat(eventInfo, " ");
if (dscHour < 10) strcat(eventInfo, "0");
itoa(dscHour, charBuffer, 10);
strcat(eventInfo, charBuffer);
strcat(eventInfo, ":");
if (dscMinute < 10) strcat(eventInfo, "0");
itoa(dscMinute, charBuffer, 10);
strcat(eventInfo, charBuffer);
strcat(eventInfo, " | Partition ");
itoa(dsc.panelData[3] >> 6, charBuffer, 10);
strcat(eventInfo, charBuffer);
if (ws.count()) {
char outas[128];
StaticJsonDocument<200> doc;
JsonObject root = doc.to<JsonObject>();
root["event_info"] = eventInfo;
serializeJson(root, outas);
ws.textAll(outas);
}
switch (dsc.panelData[5] & 0x03) {
case 0x00: printPanelStatus0(6); break;
case 0x01: printPanelStatus1(6); break;
case 0x02: printPanelStatus2(6); break;
case 0x03: printPanelStatus3(6); break;
}
}
void processEventBufferEC() {
if (!extendedBuffer) extendedBuffer = true;
char eventInfo[45] = "Event: ";
char charBuffer[4];
int eventNumber = dsc.panelData[9] + ((dsc.panelData[4] >> 6) * 256);
itoa(eventNumber, charBuffer, 10);
if (eventNumber < 10) strcat(eventInfo, "00");
else if (eventNumber < 100) strcat(eventInfo, "0");
strcat(eventInfo, charBuffer);
strcat(eventInfo, " | ");
byte dscYear3 = dsc.panelData[3] >> 4;
byte dscYear4 = dsc.panelData[3] & 0x0F;
byte dscMonth = dsc.panelData[4] << 2; dscMonth >>= 4;
byte dscDay1 = dsc.panelData[4] << 6; dscDay1 >>= 3;
byte dscDay2 = dsc.panelData[5] >> 5;
byte dscDay = dscDay1 | dscDay2;
byte dscHour = dsc.panelData[5] & 0x1F;
byte dscMinute = dsc.panelData[6] >> 2;
if (dscYear3 >= 7) strcat(eventInfo, "19");
else strcat(eventInfo, "20");
itoa(dscYear3, charBuffer, 10);
strcat(eventInfo, charBuffer);
itoa(dscYear4, charBuffer, 10);
strcat(eventInfo, charBuffer);
strcat(eventInfo, ".");
if (dscMonth < 10) strcat(eventInfo, "0");
itoa(dscMonth, charBuffer, 10);
strcat(eventInfo, charBuffer);
strcat(eventInfo, ".");
if (dscDay < 10) strcat(eventInfo, "0");
itoa(dscDay, charBuffer, 10);
strcat(eventInfo, charBuffer);
strcat(eventInfo, " ");
if (dscHour < 10) strcat(eventInfo, "0");
itoa(dscHour, charBuffer, 10);
strcat(eventInfo, charBuffer);
strcat(eventInfo, ":");
if (dscMinute < 10) strcat(eventInfo, "0");
itoa(dscMinute, charBuffer, 10);
strcat(eventInfo, charBuffer);
if (dsc.panelData[2] != 0) {
strcat(eventInfo, " | Partition ");
byte bitCount = 0;
for (byte bit = 0; bit <= 7; bit++) {
if (bitRead(dsc.panelData[2], bit)) {
itoa((bitCount + 1), charBuffer, 10);
}
bitCount++;
}
strcat(eventInfo, charBuffer);
}
if (ws.count()) {
char outas[128];
StaticJsonDocument<200> doc;
JsonObject root = doc.to<JsonObject>();
root["event_info"] = eventInfo;
serializeJson(root, outas);
ws.textAll(outas);
}
switch (dsc.panelData[7]) {
case 0x00: printPanelStatus0(8); break;
case 0x01: printPanelStatus1(8); break;
case 0x02: printPanelStatus2(8); break;
case 0x03: printPanelStatus3(8); break;
case 0x04: printPanelStatus4(8); break;
case 0x05: printPanelStatus5(8); break;
case 0x14: printPanelStatus14(8); break;
case 0x16: printPanelStatus16(8); break;
case 0x17: printPanelStatus17(8); break;
case 0x18: printPanelStatus18(8); break;
case 0x1B: printPanelStatus1B(8); break;
}
}
void printPanelStatus0(byte panelByte) {
bool decoded = true;
if (!ws.count()) return;
char outas[128];
StaticJsonDocument<200> doc;
JsonObject root = doc.to<JsonObject>();
switch (dsc.panelData[panelByte]) {
case 0x49: root["lcd_upper"] = "Duress alarm";
root["lcd_lower"] = " "; break;
case 0x4A: root["lcd_upper"] = "Disarmed:";
root["lcd_lower"] = "Alarm memory"; break;
case 0x4B: root["lcd_upper"] = "Recent";
root["lcd_lower"] = "closing alarm"; break;
case 0x4C: root["lcd_upper"] = "Zone expander";
root["lcd_lower"] = "suprvis. alarm"; break;
case 0x4D: root["lcd_upper"] = "Zone expander";
root["lcd_lower"] = "suprvis. restore"; break;
case 0x4E: root["lcd_upper"] = "Keypad Fire";
root["lcd_lower"] = "alarm"; break;
case 0x4F: root["lcd_upper"] = "Keypad Aux";
root["lcd_lower"] = "alarm"; break;
case 0x50: root["lcd_upper"] = "Keypad Panic";
root["lcd_lower"] = "alarm"; break;
case 0x51: root["lcd_upper"] = "Auxiliary input";
root["lcd_lower"] = "alarm"; break;
case 0x52: root["lcd_upper"] = "Keypad Fire";
root["lcd_lower"] = "alarm restored"; break;
case 0x53: root["lcd_upper"] = "Keypad Aux";
root["lcd_lower"] = "alarm restored"; break;
case 0x54: root["lcd_upper"] = "Keypad Panic";
root["lcd_lower"] = "alarm restored"; break;
case 0x55: root["lcd_upper"] = "Auxiliary input";
root["lcd_lower"] = "alarm restored"; break;
case 0x98: root["lcd_upper"] = "Keypad";
root["lcd_lower"] = "lockout"; break;
case 0xBE: root["lcd_upper"] = "Armed:";
root["lcd_lower"] = "Partial"; break;
case 0xBF: root["lcd_upper"] = "Armed:";
root["lcd_lower"] = "Special"; break;
case 0xE5: root["lcd_upper"] = "Auto-arm";
root["lcd_lower"] = "cancelled"; break;
case 0xE6: root["lcd_upper"] = "Disarmed:";
root["lcd_lower"] = "Special"; break;
case 0xE7: root["lcd_upper"] = "Panel battery";
root["lcd_lower"] = "trouble"; break;
case 0xE8: root["lcd_upper"] = "Panel AC power";
root["lcd_lower"] = "trouble"; break;
case 0xE9: root["lcd_upper"] = "Bell trouble";
root["lcd_lower"] = " "; break;
case 0xEA: root["lcd_upper"] = "Fire zone";
root["lcd_lower"] = "trouble"; break;
case 0xEB: root["lcd_upper"] = "Panel aux supply";
root["lcd_lower"] = "trouble"; break;
case 0xEC: root["lcd_upper"] = "Telephone line";
root["lcd_lower"] = "trouble"; break;
case 0xEF: root["lcd_upper"] = "Panel battery";
root["lcd_lower"] = "restored"; break;
case 0xF0: root["lcd_upper"] = "Panel AC power";
root["lcd_lower"] = "restored"; break;
case 0xF1: root["lcd_upper"] = "Bell restored";
root["lcd_lower"] = " "; break;
case 0xF2: root["lcd_upper"] = "Fire zone";
root["lcd_lower"] = "trouble restored"; break;
case 0xF3: root["lcd_upper"] = "Panel aux supply";
root["lcd_lower"] = "restored"; break;
case 0xF4: root["lcd_upper"] = "Telephone line";
root["lcd_lower"] = "restored"; break;
case 0xF7: root["lcd_upper"] = "Phone 1 FTC";
root["lcd_lower"] = " "; break;
case 0xF8: root["lcd_upper"] = "Phone 2 FTC";
root["lcd_lower"] = " "; break;
case 0xF9: root["lcd_upper"] = "Event buffer";
root["lcd_lower"] = "threshold"; break;
case 0xFA: root["lcd_upper"] = "DLS lead-in";
root["lcd_lower"] = " "; break;
case 0xFB: root["lcd_upper"] = "DLS lead-out";
root["lcd_lower"] = " "; break;
case 0xFE: root["lcd_upper"] = "Periodic test";
root["lcd_lower"] = "transmission"; break;
case 0xFF: root["lcd_upper"] = "System test";
root["lcd_lower"] = " "; break;
default: decoded = false;
}
char lcdMessage[20];
char charBuffer[4];
if (dsc.panelData[panelByte] >= 0x09 && dsc.panelData[panelByte] <= 0x28) {
strcpy(lcdMessage, "Zone alarm: ");
itoa(dsc.panelData[panelByte] - 8, charBuffer, 10);
strcat(lcdMessage, charBuffer);
root["lcd_upper"] = lcdMessage;
root["lcd_lower"] = " ";
decoded = true;
}
if (dsc.panelData[panelByte] >= 0x29 && dsc.panelData[panelByte] <= 0x48) {
root["lcd_upper"] = "Zone alarm";
strcpy(lcdMessage, "restored: ");
itoa(dsc.panelData[panelByte] - 40, charBuffer, 10);
strcat(lcdMessage, charBuffer);
root["lcd_lower"] = lcdMessage;
decoded = true;
}
if (dsc.panelData[panelByte] >= 0x56 && dsc.panelData[panelByte] <= 0x75) {
strcpy(lcdMessage, "Zone tamper: ");
itoa(dsc.panelData[panelByte] - 85, charBuffer, 10);
strcat(lcdMessage, charBuffer);
root["lcd_upper"] = lcdMessage;
root["lcd_lower"] = " ";
decoded = true;
}
if (dsc.panelData[panelByte] >= 0x76 && dsc.panelData[panelByte] <= 0x95) {
root["lcd_upper"] = "Zone tamper";
strcpy(lcdMessage, "restored: ");
itoa(dsc.panelData[panelByte] - 117, charBuffer, 10);
strcat(lcdMessage, charBuffer);
root["lcd_lower"] = lcdMessage;
decoded = true;
}
if (dsc.panelData[panelByte] >= 0x99 && dsc.panelData[panelByte] <= 0xBD) {
root["lcd_upper"] = "Armed:";
byte dscCode = dsc.panelData[panelByte] - 0x98;
if (dscCode >= 35) dscCode += 5;
if (dscCode == 40) strcpy(lcdMessage, "Master code ");
else strcpy(lcdMessage, "Access code ");
itoa(dscCode, charBuffer, 10);
strcat(lcdMessage, charBuffer);
root["lcd_lower"] = lcdMessage;
decoded = true;
}
if (dsc.panelData[panelByte] >= 0xC0 && dsc.panelData[panelByte] <= 0xE4) {
root["lcd_upper"] = "Disarmed:";
byte dscCode = dsc.panelData[panelByte] - 0xBF;
if (dscCode >= 35) dscCode += 5;
if (dscCode == 40) strcpy(lcdMessage, "Master code ");
else strcpy(lcdMessage, "Access code ");
itoa(dscCode, charBuffer, 10);
strcat(lcdMessage, charBuffer);
root["lcd_lower"] = lcdMessage;
decoded = true;
}
if (!decoded) {
root["lcd_upper"] = "Unknown data";
root["lcd_lower"] = " ";
}
serializeJson(root, outas);
ws.textAll(outas);
}
void printPanelStatus1(byte panelByte) {
bool decoded = true;
if (!ws.count()) return;
char outas[128];
StaticJsonDocument<200> doc;
JsonObject root = doc.to<JsonObject>();
switch (dsc.panelData[panelByte]) {
case 0x03: root["lcd_upper"] = "Cross zone";
root["lcd_lower"] = "alarm"; break;
case 0x04: root["lcd_upper"] = "Delinquency";
root["lcd_lower"] = "alarm"; break;
case 0x05: root["lcd_upper"] = "Late to close";
root["lcd_lower"] = " "; break;
case 0x29: root["lcd_upper"] = "Downloading";
root["lcd_lower"] = "forced answer"; break;
case 0x2B: root["lcd_upper"] = "Armed:";
root["lcd_lower"] = "Auto-arm"; break;
case 0xAC: root["lcd_upper"] = "Exit installer";
root["lcd_lower"] = "programming"; break;
case 0xAD: root["lcd_upper"] = "Enter installer";
root["lcd_lower"] = "programming"; break;
case 0xAE: root["lcd_upper"] = "Walk test";
root["lcd_lower"] = "end"; break;
case 0xAF: root["lcd_upper"] = "Walk test";
root["lcd_lower"] = "begin"; break;
case 0xD0: root["lcd_upper"] = "Command";
root["lcd_lower"] = "output 4"; break;
case 0xD1: root["lcd_upper"] = "Exit fault";
root["lcd_lower"] = "pre-alert"; break;
case 0xD2: root["lcd_upper"] = "Armed:";
root["lcd_lower"] = "Entry delay"; break;
case 0xD3: root["lcd_upper"] = "Downlook remote";
root["lcd_lower"] = "trigger"; break;
default: decoded = false;
}
char lcdMessage[20];
char charBuffer[4];
if (dsc.panelData[panelByte] >= 0x24 && dsc.panelData[panelByte] <= 0x28) {
byte dscCode = dsc.panelData[panelByte] - 0x03;
if (dscCode >= 35) dscCode += 5;
if (dscCode == 40) strcpy(lcdMessage, "Master code ");
else strcpy(lcdMessage, "Access code ");
itoa(dscCode, charBuffer, 10);
strcat(lcdMessage, charBuffer);
root["lcd_upper"] = lcdMessage;
root["lcd_lower"] = " ";
decoded = true;
}
if (dsc.panelData[panelByte] >= 0x2C && dsc.panelData[panelByte] <= 0x4B) {
root["lcd_upper"] = "Zone battery";
strcpy(lcdMessage, "restored: ");
itoa(dsc.panelData[panelByte] - 43, charBuffer, 10);
strcat(lcdMessage, charBuffer);
root["lcd_lower"] = lcdMessage;
decoded = true;
}
if (dsc.panelData[panelByte] >= 0x4C && dsc.panelData[panelByte] <= 0x6B) {
root["lcd_upper"] = "Zone battery";
strcpy(lcdMessage, "low: ");
itoa(dsc.panelData[panelByte] - 75, charBuffer, 10);
strcat(lcdMessage, charBuffer);
root["lcd_lower"] = lcdMessage;
decoded = true;
}
if (dsc.panelData[panelByte] >= 0x6C && dsc.panelData[panelByte] <= 0x8B) {
root["lcd_upper"] = "Zone fault";
strcpy(lcdMessage, "restored: ");
itoa(dsc.panelData[panelByte] - 107, charBuffer, 10);
strcat(lcdMessage, charBuffer);
root["lcd_lower"] = lcdMessage;
decoded = true;
}
if (dsc.panelData[panelByte] >= 0x8C && dsc.panelData[panelByte] <= 0xAB) {
strcpy(lcdMessage, "Zone fault: ");
itoa(dsc.panelData[panelByte] - 139, charBuffer, 10);
strcat(lcdMessage, charBuffer);
root["lcd_upper"] = lcdMessage;
root["lcd_lower"] = " ";
decoded = true;
}
if (dsc.panelData[panelByte] >= 0xB0 && dsc.panelData[panelByte] <= 0xCF) {
strcpy(lcdMessage, "Zone bypass: ");
itoa(dsc.panelData[panelByte] - 175, charBuffer, 10);
strcat(lcdMessage, charBuffer);
root["lcd_upper"] = lcdMessage;
root["lcd_lower"] = " ";
decoded = true;
}
if (!decoded) {
root["lcd_upper"] = "Unknown data";
root["lcd_lower"] = " ";
}
serializeJson(root, outas);
ws.textAll(outas);
}
void printPanelStatus2(byte panelByte) {
bool decoded = true;
if (!ws.count()) return;
char outas[128];
StaticJsonDocument<200> doc;
JsonObject root = doc.to<JsonObject>();
switch (dsc.panelData[panelByte]) {
case 0x2A: root["lcd_upper"] = "Quick exit";
root["lcd_lower"] = " "; break;
case 0x63: root["lcd_upper"] = "Keybus fault";
root["lcd_lower"] = "restored"; break;
case 0x64: root["lcd_upper"] = "Keybus fault";
root["lcd_lower"] = " "; break;
case 0x66: root["lcd_upper"] = "*1: Zone bypass";
root["lcd_lower"] = "programming"; break;
case 0x67: root["lcd_upper"] = "Command";
root["lcd_lower"] = "output 1"; break;
case 0x68: root["lcd_upper"] = "Command";
root["lcd_lower"] = "output 2"; break;
case 0x69: root["lcd_upper"] = "Command";
root["lcd_lower"] = "output 3"; break;
case 0x8C: root["lcd_upper"] = "Cold start";
root["lcd_lower"] = " "; break;
case 0x8D: root["lcd_upper"] = "Warm start";
root["lcd_lower"] = " "; break;
case 0x8E: root["lcd_upper"] = "Panel factory";
root["lcd_lower"] = "default"; break;
case 0x91: root["lcd_upper"] = "Swinger shutdown";
root["lcd_lower"] = " "; break;
case 0x93: root["lcd_upper"] = "Disarmed:";
root["lcd_lower"] = "Keyswitch"; break;
case 0x96: root["lcd_upper"] = "Armed:";
root["lcd_lower"] = "Keyswitch"; break;
case 0x97: root["lcd_upper"] = "Armed:";
root["lcd_lower"] = "Keypad away"; break;
case 0x98: root["lcd_upper"] = "Armed:";
root["lcd_lower"] = "Quick-arm"; break;
case 0x99: root["lcd_upper"] = "Activate";
root["lcd_lower"] = "stay/away zones"; break;
case 0x9A: root["lcd_upper"] = "Armed:";
root["lcd_lower"] = "Stay"; break;
case 0x9B: root["lcd_upper"] = "Armed:";
root["lcd_lower"] = "Away"; break;
case 0x9C: root["lcd_upper"] = "Armed:";
root["lcd_lower"] = "No entry delay"; break;
case 0xFF: root["lcd_upper"] = "Zone expander";
root["lcd_lower"] = "trouble: 1"; break;
default: decoded = false;
}
char lcdMessage[20];
char charBuffer[4];