-
Notifications
You must be signed in to change notification settings - Fork 12
/
config.schema.json
executable file
·609 lines (609 loc) · 22.9 KB
/
config.schema.json
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
{
"pluginAlias": "konnected",
"pluginType": "platform",
"singular": true,
"schema": {
"name": {
"title": "Name",
"description": "The name that will appear in your Homebridge log.",
"type": "string",
"default": "Konnected",
"required": true
},
"advanced": {
"title": "Advanced",
"type": "object",
"expandable": true,
"expanded": false,
"properties": {
"listenerIP": {
"title": "Listening IP (optional)",
"description": "If the system hosting Homebridge/HOOBS has multiple active network adapters, use this field to force the network IPv4 address that this plugin will listen for zone state changes on.",
"type": "string",
"format": "ipv4",
"placeholder": "(default: automatically selected)"
},
"listenerPort": {
"title": "Listening Port (optional)",
"description": "Use this field to force the network port that this plugin will listen for zone state changes on (between 1000 and 65535).",
"type": "number",
"step": 1,
"minimum": 1000,
"maximum": 65535,
"placeholder": "(default: randomized by availability)"
},
"discoveryTimeout": {
"title": "Discovery Timeout (seconds) (optional)",
"description": "Provide a length of time in seconds (between 1 and 300) to allow this plugin to discover all of the Konnected Alarm Panels on the network.",
"type": "number",
"step": 1,
"minimum": 1,
"maximum": 30,
"placeholder": "(default: 5)"
},
"entryDelaySettings": {
"type": "object",
"expandable": true,
"expanded": false,
"properties": {
"": {
"description": "Configurable settings for when the security system has been violated while armed to \"Away\" mode.<br>By default the beeper will have a constant sound, but if you use the example values, it will produce a long tone once every second so you know how much time you have to disarm the security system.",
"type": "object"
},
"delay": {
"title": "Delay (seconds) (optional)",
"description": "The entry delay before the security system is triggered and the siren zone is triggered.",
"type": "number",
"step": 1,
"minimum": 0,
"placeholder": "(default: 30)"
},
"pulseDuration": {
"title": "Beeper Pulse Duration (milliseconds) (optional)",
"description": "How long the pulse is maintained in the on state for.",
"type": "number",
"step": 1,
"minimum": 1,
"placeholder": "(E.g., 950)"
},
"pulsePause": {
"title": "Beeper Pause Between Pulses (milliseconds) (optional, but required if Times to Repeat exists)",
"type": "number",
"step": 1,
"minimum": 1,
"placeholder": "(E.g., 50)"
},
"pulseRepeat": {
"title": "Beeper Times to Repeat (optional, but required if Pause Between Pulses exists)",
"description": "To repeat indefinitely, use -1 as the value.",
"type": "number",
"step": 1,
"minimum": -1,
"placeholder": "(E.g., -1)"
}
}
},
"exitDelaySettings": {
"type": "object",
"expandable": true,
"expanded": false,
"properties": {
"": {
"description": "Configurable settings for the delay used before the security system has been completely armed.<br>If you don't want a delay, set this to 0.",
"type": "object"
},
"delay": {
"title": "Delay (seconds) (optional)",
"description": "The time used for the exit delay before the security system is completely armed.",
"type": "number",
"step": 1,
"minimum": 0,
"placeholder": "(default: 30)"
},
"audibleBeeperModes": {
"title": "The following selected arming modes will have an audible beeper countdown (if delay is not zero):",
"type": "array",
"uniqueItems": true,
"items": {
"title": "Mode",
"type": "string",
"enum": [
"0",
"2",
"1"
],
"enumNames": [
"Home/Stay",
"Night",
"Away (default)"
]
},
"default": [
false,
false,
"1"
]
}
}
}
}
},
"panels": {
"title": "Panels",
"description": "These are the individual Konnected Alarm Panel module boards.",
"type": "array",
"orderable": true,
"expandable": true,
"expanded": true,
"items": {
"type": "object",
"properties": {
"name": {
"title": "Panel Name",
"type": "string"
},
"uuid": {
"title": "UUID",
"type": "string",
"readonly": true
},
"ipAddress": {
"title": "IP Address (required but changeable)",
"type": "string",
"format": "ipv4"
},
"port": {
"title": "Port (required but changeable)",
"type": "number",
"step": 1,
"minimum": 1000,
"maximum": 65535
},
"blink": {
"title": "Blink panel LED when zones change/report their state.",
"type": "boolean",
"default": true
},
"zones": {
"title": "Zones",
"description": "Customize the names and types of your zones.<br><span class='primary-text'>You need to define your zones here to create sensor and actuator accessories in HomeKit.</span>",
"type": "array",
"maxItems": 15,
"expandable": true,
"expanded": false,
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"enabled": {
"title": "Enabled",
"type": "boolean"
},
"zoneNumber": {
"title": "Zone",
"type": "string",
"oneOf": [{
"title": "V1/V2 & Pro: 1",
"enum": ["1"]
},
{
"title": "V1/V2 & Pro: 2",
"enum": ["2"]
},
{
"title": "V1/V2 & Pro: 3",
"enum": ["3"]
},
{
"title": "V1/V2 & Pro: 4",
"enum": ["4"]
},
{
"title": "V1/V2 & Pro: 5",
"enum": ["5"]
},
{
"title": "V1/V2 & Pro: 6",
"enum": ["6"]
},
{
"title": "V1/V2 Only: Out or Alarm",
"enum": ["out"]
},
{
"title": "Pro Only: 7",
"enum": ["7"]
},
{
"title": "Pro Only: 8",
"enum": ["8"]
},
{
"title": "Pro Only: 9 (binary sensors only)",
"enum": ["9"]
},
{
"title": "Pro Only: 10 (binary sensors only)",
"enum": ["10"]
},
{
"title": "Pro Only: 11 (binary sensors only)",
"enum": ["11"]
},
{
"title": "Pro Only: 12 (binary sensors only)",
"enum": ["12"]
},
{
"title": "Pro Only: Alarm 1",
"enum": ["alarm1"]
},
{
"title": "Pro Only: Out1",
"enum": ["out1"]
},
{
"title": "Pro Only: Alarm 2 or Out2",
"enum": ["alarm2_out2"]
}
]
},
"zoneType": {
"title": "Type",
"type": "string",
"oneOf": [{
"title": "Sensor: Contact Sensor",
"enum": ["contact"]
},
{
"title": "Sensor: Motion Sensor",
"enum": ["motion"]
},
{
"title": "Sensor: Glass Break Sensor",
"enum": ["glass"]
},
{
"title": "Sensor: Tempurature Sensor (eg. DS18B20)",
"enum": ["temperature"]
},
{
"title": "Sensor: Temperature / Humidity Sensor (eg. DHT)",
"enum": ["humidtemp"]
},
{
"title": "Sensor: Water Leak / Rain Sensor",
"enum": ["water"]
},
{
"title": "Sensor: Smoke / CO Sensor",
"enum": ["smoke"]
},
{
"title": "Switch: Alarm Beeper Switch",
"enum": ["beeper"]
},
{
"title": "Switch: Alarm Siren Switch",
"enum": ["siren"]
},
{
"title": "Switch: Alarm Strobe Light Switch",
"enum": ["strobe"]
},
{
"title": "Switch: Generic Switch",
"enum": ["switch"]
}
]
},
"zoneLocation": {
"title": "Location",
"type": "string",
"placeholder": "(E.g., Living Room)",
"typeahead": {
"source": [
"Addition",
"Atrium",
"Attic",
"Auditorium",
"Back",
"Backyard",
"Balcony",
"Banister",
"Banquette",
"Barn",
"Basement",
"Bathroom",
"Bay Window",
"Bedroom",
"Boat House",
"Boiler Room",
"Boudoir",
"Breakfast Nook",
"Cabin",
"Cabinet",
"Ceiling",
"Cellar",
"Chapel",
"Cloakroom",
"Closet",
"Common Room",
"Computer Room",
"Conference Room",
"Conservatory",
"Control Room",
"Corridor",
"Courtyard",
"Crawlspace",
"Cubby",
"Dark Room",
"Deck",
"Den",
"Dining Room",
"Drawing Room",
"Dressing Room",
"Dungeon",
"Electrical Room",
"Entrance",
"Entryway",
"Equipment Room",
"Family Room",
"Fence",
"First Floor",
"Floor",
"Formal Dining Room",
"Formal Living Room",
"Fourth Floor",
"Foyer",
"Front",
"Front Yard",
"Furnace Room",
"Game Room",
"Garage",
"Garden",
"Great Hall",
"Great Room",
"Greenhouse",
"Grotto",
"Guest Room",
"Gym",
"Hall",
"Hallway",
"Indoor",
"Inglenook",
"Inside",
"Junk Room",
"Keep",
"Kitchen",
"Kitchenette",
"Larder",
"Laundry Room",
"Lenai",
"Library",
"Living Room",
"Lobby",
"Loft",
"Lounge",
"Machine Room",
"Man Cave",
"Master Bath",
"Master Bedroom",
"Master Closet",
"Mechanical Closet",
"Mechanical Room",
"Media Closet",
"Media Room",
"Mezanine",
"Mud Room",
"Music Room",
"Nook",
"Nursery",
"Office",
"Outdoor",
"Outside",
"Outside",
"Panic Room",
"Pantry",
"Parlour",
"Partition",
"Patio",
"Pool",
"Pool Room",
"Porch",
"Powder Room",
"Pump Room",
"Rec Room",
"Recreation Room",
"Rest Room",
"Roof",
"Root Cellar",
"Rotunda",
"Safe Room",
"Salon",
"Sauna",
"Scullery",
"Second Floor",
"Server Room",
"Server Closet",
"Shed",
"Shop",
"Shower",
"Showroom",
"Side",
"Side Yard",
"Sitting Room",
"Solarium",
"Spandrel",
"Spare room",
"Staff Quarters",
"Stairs",
"Stairway",
"State Room",
"Storage Room",
"Storm Cellar",
"Studio",
"Study",
"Suite",
"Sun Room",
"Theatre Room",
"Third Floor",
"Throne Room",
"Tree House",
"Utility Room",
"Veranda",
"Vestibule",
"Waiting Room",
"Walk-In",
"Walkway",
"Wardrobe",
"Well",
"Wine Cellar",
"Workshop",
"Yard"
]
}
},
"binarySensorSettings": {
"title": "Binary Sensor Settings",
"type": "object",
"condition": {
"functionBody": "try { return ['contact','motion','glass','water','smoke'].includes(model.panels[arrayIndices[0]].zones[arrayIndices[1]].zoneType) } catch (e) { return false }"
},
"expandable": true,
"expanded": false,
"properties": {
"invert": {
"title": "Invert the sensor zone state",
"type": "boolean"
},
"audibleBeep": {
"title": "This sensor should trigger the beeper when its state changes.",
"description": "Uses the pulse settings for zone(s) configured as a beeper switch.",
"type": "boolean"
},
"triggerableModes": {
"title": "Triggerable Modes",
"description": "Choose which modes (0 = Home/Stay, 1 = Away, 2 = Night) this sensor will trigger the security system alarm.<br>If \"Home\" and/or \"Night\" mode are deselected for all sensors and switches, then the HomeKit app will hide those two modes from the app's Security System accessory control.<br><br>NOTE: when setting up Konnected panels with most traditional security systems, the \"Home\" and/or \"Night\" modes don't operate bi-directionally and should be deselected for all sensors and switches.<br>",
"type": "array",
"uniqueItems": true,
"items": {
"title": "Mode",
"type": "string",
"enum": [
"0",
"2",
"1"
],
"enumNames": [
"Home/Stay",
"Night",
"Away"
]
}
}
}
},
"environmentalSensorSettings": {
"title": "Environmental Sensor Settings",
"type": "object",
"condition": {
"functionBody": "try { return ['humidtemp','temperature'].includes(model.panels[arrayIndices[0]].zones[arrayIndices[1]].zoneType) } catch (e) { return false }"
},
"expandable": true,
"expanded": false,
"properties": {
"pollInterval": {
"title": "Poll Interval (minutes) (optional)",
"description": "Length of time between, in minutes (between 1 and 1440), that this sensor will report its value.",
"placeholder": "(default: 3)",
"type": "number",
"step": 1,
"minimum": 1,
"maximum": 1440
}
}
},
"switchSettings": {
"title": "Switch Settings",
"type": "object",
"condition": {
"functionBody": "try { return ['beeper','siren','strobe','switch'].includes(model.panels[arrayIndices[0]].zones[arrayIndices[1]].zoneType) } catch(e){return false}"
},
"expandable": true,
"expanded": false,
"properties": {
"trigger": {
"title": "Force Trigger State (optional)",
"type": "string",
"enum": [
"high",
"low"
],
"x-schema-form": {
"type": "radios",
"titleMap": [
{
"value": "high",
"name": "High (unselected default)"
},
{
"value": "low",
"name": "Low"
}
]
}
},
"pulseDuration": {
"title": "Pulse Duration (milliseconds) (optional)",
"description": "How long the pulse is maintained in the on state for.",
"type": "number",
"step": 1,
"minimum": 1,
"placeholder": "(E.g., 100)"
},
"pulsePause": {
"title": "Pause Between Pulses (milliseconds) (optional, but required if Times to Repeat exists)",
"type": "number",
"step": 1,
"minimum": 1,
"placeholder": "(E.g., 100)"
},
"pulseRepeat": {
"title": "Times to Repeat (optional, but required if Pause Between Pulses exists)",
"description": "To repeat indefinitely, use -1 as the value.",
"type": "number",
"step": 1,
"minimum": -1,
"placeholder": "(E.g., 3)"
},
"triggerableModes": {
"title": "⚠️ Triggerable Modes",
"description": "⚠️ EXPERIMENTAL FEATURE:<br>Choose which modes this switch sensor will trigger the security system alarm.<br>This may have unexpected consequences, it is best to leave these items unchecked.<br><br>If \"Home\" and/or \"Night\" mode are deselected for all sensors and switches, then the HomeKit app will hide those two modes from the app's Security System accessory control.<br>NOTE: when setting up Konnected panels with most traditional security systems, the \"Home\" and/or \"Night\" modes don't operate bi-directionally and should be deselected for all sensors and switches.",
"type": "array",
"uniqueItems": true,
"items": {
"title": "Mode",
"type": "string",
"enum": [
"0",
"2",
"1"
],
"enumNames": [
"Home",
"Night",
"Away"
]
}
}
}
}
}
}
}
}
}
}
}
}