/
config.schema.json
341 lines (341 loc) · 12.5 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
{
"pluginAlias": "Jablotron",
"pluginType": "platform",
"singular": true,
"headerDisplay": "This plugin works with Jablotron Alarms.\n\n1. Open the Home <img src='https://user-images.githubusercontent.com/3979615/78010622-4ea1d380-738e-11ea-8a17-e6a465eeec35.png' height='16.42px'> app on your device.\n2. Tap the Home tab, then tap <img src='https://user-images.githubusercontent.com/3979615/78010869-9aed1380-738e-11ea-9644-9f46b3633026.png' height='16.42px'>.\n3. Tap *Add Accessory*, and select *I Don't Have a Code or select More Options*.\n4. Select Accessory and Enter the Homebridge PIN, or scan the QR code in Homebridge UI.",
"footerDisplay": "Control your Jablotron alarm system from your iOS device using HomeKit and Homebridge, which is available [here](https://github.com/fdegier/homebridge-jablotron-alarm.git).",
"schema": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"default": "Jablotron",
"required": true
},
"services": {
"title": "Services",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"title": "Id",
"type": "integer",
"default": 12345,
"description": "ID of service obtained by configuration tool - https://github.com/fdegier/homebridge-jablotron-alarm#Identify-Jablotron-services-and-devices.",
"required": true
},
"name": {
"title": "Name",
"type": "string",
"default": "Home",
"description": "Defines a name of a service.",
"required": true
},
"username": {
"title": "User name",
"type": "string",
"default": "username",
"description": "Your Jablotron username, it is advised to create a new account for the sole purpose of controlling the alarm via Siri and limiting the authorization on that account.",
"required": true
},
"password": {
"title": "Password",
"type": "string",
"default": "password",
"description": "Jablotron password.",
"required": true
},
"pincode": {
"title": "Pin code",
"type": "string",
"default": "pin",
"description": "PIN code for Jablotron unit.",
"required": true
},
"autoRefresh": {
"title": "Auto refresh",
"type": "boolean",
"default": true,
"description": "Enables autorefresh mode that automatically polls the Jablotron status in interval defined using **pollInterval** attribute.",
"required": true
},
"pollInterval": {
"title": "Poll interval",
"type": "integer",
"default": 60,
"description": "Define an interval (in seconds) in which plugin periodically checks for service's and its accessories' states.",
"required": true
},
"refreshOnStateChange": {
"title": "Refresh on state change",
"type": "boolean",
"default": true,
"description": "Eenables automatic refresh upon arm/disarm. This is typically used if you have other Jablotron accessories (eg outlets) set up and configured to automatically switch on/off based on alarm state.",
"required": true
},
"debug": {
"title": "Debug",
"type": "boolean",
"default": true,
"description": "Provides more verbose and detailed logging. Set it to true in case of some issues only!",
"required": false
},
"sections": {
"title": "Sections",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"title": "House",
"type": "string",
"default": "House",
"description": "Name of the accessory (this will be shown in Homekit and typically corresponds to the name defined in Jablotron setup)",
"required": true
},
"segment_id": {
"title": "Cloud Component ID",
"type": "string",
"default": "SEC-12345678",
"description": "ID of a segment assigned in Jablotron setup.",
"required": true
},
"armedMode": {
"title": "Armed mode",
"type": "string",
"default": "Away",
"description": "Homekit mapping of armed state. Can be set to one of Home/Night/Away.",
"required": false,
"enum": [
"Home",
"Night",
"Away"
]
},
"partiallyArmedMode": {
"title": "Partially armed mode",
"type": "string",
"default": "Home",
"description": "Homekit mapping of partially armed state. Can be set to one of Home/Night/Away.",
"required": false,
"enum": [
"Home",
"Night",
"Away"
]
}
}
}
},
"switches": {
"title": "Switches",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"description": "Name of the accessory (this will be shown in Homekit and typically corresponds to the name defined in Jablotron setup)",
"required": false
},
"segment_id": {
"title": "Cloud Component ID",
"type": "string",
"description": "ID of a segment assigned in Jablotron setup.",
"required": false
}
}
}
},
"outlets": {
"title": "Outlets",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"description": "Name of the accessory (this will be shown in Homekit and typically corresponds to the name defined in Jablotron setup)",
"required": false
},
"segment_id": {
"title": "Cloud Component ID",
"type": "string",
"description": "ID of a segment assigned in Jablotron setup.",
"required": false
}
}
}
},
"contact_sensors": {
"title": "Contact Sensors",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"description": "Name of the accessory (this will be shown in Homekit and typically corresponds to the name defined in Jablotron setup)",
"required": false
},
"segment_id": {
"title": "Cloud Component ID",
"type": "string",
"description": "ID of a segment assigned in Jablotron setup.",
"required": false
},
"reversed_status": {
"title": "Reversed status",
"type": "boolean",
"description": "Reverses the logic for contact opened status. By default plugin sets contact sensor as Open when status is set",
"required": false
}
}
}
},
"thermometers": {
"title": "Thermometers",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"description": "Name of the accessory (this will be shown in Homekit and typically corresponds to the name defined in Jablotron setup)",
"required": false
},
"segment_id": {
"title": "Cloud Component ID",
"type": "string",
"description": "ID of a segment assigned in Jablotron setup.",
"required": false
},
"min_temperature": {
"title": "Min. Temperature",
"type": "number",
"description": "Min. temperature assigned in Jablotron setup.",
"required": false
},
"max_temperature": {
"title": "Max. Temperature",
"type": "number",
"description": "Max. temperature assigned in Jablotron setup.",
"required": false
}
}
}
}
}
}
}
}
},
"layout": [{
"key": "services",
"type": "tabarray",
"title": "{{ value.name || 'new service' }}",
"items": [
"services[].name",
"services[].id",
{
"key": "services[]",
"type": "section",
"title": "Sections",
"expandable": true,
"expanded": false,
"items": [{
"key": "services[].sections",
"type": "tabarray",
"title": "{{ value.name || 'new section' }}",
"items": [
"services[].sections[].name",
"services[].sections[].segment_id",
"services[].sections[].armedMode",
"services[].sections[].partiallyArmedMode"
]
}]
},
{
"key": "services[]",
"type": "section",
"title": "Switches",
"expandable": true,
"expanded": false,
"items": [{
"key": "services[].switches",
"type": "tabarray",
"title": "{{ value.name || 'new switch' }}",
"items": [
"services[].switches[].name",
"services[].switches[].segment_id"
]
}]
},
{
"key": "services[]",
"type": "section",
"title": "Outlets",
"expandable": true,
"expanded": false,
"items": [{
"key": "services[].outlets",
"type": "tabarray",
"title": "{{ value.name || 'new outlet' }}",
"items": [
"services[].outlets[].name",
"services[].outlets[].segment_id"
]
}]
},
{
"key": "services[]",
"type": "section",
"title": "Thermometers",
"expandable": true,
"expanded": false,
"items": [{
"key": "services[].thermometers",
"type": "tabarray",
"title": "{{ value.name || 'new thermometer' }}",
"items": [
"services[].thermometers[].name",
"services[].thermometers[].segment_id",
"services[].thermometers[].min_temperature",
"services[].thermometers[].max_temperature"
]
}]
},
{
"key": "services[]",
"type": "section",
"title": "Authorization",
"expandable": true,
"expanded": false,
"items": [
"services[].username",
"services[].password",
"services[].pincode"
]
},
{
"key": "services[]",
"type": "section",
"title": "Advanced Settings",
"expandable": true,
"expanded": false,
"items": [
"services[].autoRefresh",
"services[].pollInterval",
"services[].refreshOnStateChange",
"services[].debug"
]
}
]
}]
}