homebridge-cmd4 5.1.0 → 6.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +51 -20
- package/Cmd4Accessory.js +521 -514
- package/Cmd4Platform.js +80 -65
- package/Cmd4PriorityPollingQueue.js +37 -44
- package/Extras/Cmd4Scripts/Examples/AirPurifier.js +2 -2
- package/Extras/Cmd4Scripts/Examples/AnyDevice +3 -3
- package/Extras/Cmd4Scripts/Examples/DoorLock.sh +3 -3
- package/Extras/Cmd4Scripts/Examples/ExampleJavaScript_template.js +2 -2
- package/Extras/Cmd4Scripts/Examples/ExampleShellScript_template.sh +4 -4
- package/Extras/Cmd4Scripts/Examples/SecuritySystem.js +368 -0
- package/Extras/Cmd4Scripts/State.js +301 -279
- package/Extras/config.json +735 -735
- package/Extras/config.min.json +778 -778
- package/README.md +1 -1
- package/RUNNING_CHANGELOG.md +57 -0
- package/cmd4Constants.js +139 -140
- package/docs/AdvancedTroubleShooting.md +2 -2
- package/docs/Developers.md +107 -108
- package/lib/CMD4_ACC_TYPE_ENUM.js +553 -282
- package/lib/CMD4_DEVICE_TYPE_ENUM.js +38 -12
- package/package.json +5 -2
- package/utils/Cmd4Storage.js +132 -0
- package/utils/HV.js +76 -0
- package/utils/Logger.js +1 -0
- package/utils/getAccessoryUUID.js +2 -0
- package/utils/isAccDirective.js +54 -0
- package/utils/isCmd4Directive.js +56 -0
- package/utils/isDevDirective.js +58 -0
package/Extras/config.min.json
CHANGED
|
@@ -24,24 +24,24 @@
|
|
|
24
24
|
"accessories" :
|
|
25
25
|
[
|
|
26
26
|
{
|
|
27
|
-
"
|
|
28
|
-
"
|
|
27
|
+
"type": "Fanv1",
|
|
28
|
+
"displayName": "My_v1Fan", // Not a characteristic, but a function parameter
|
|
29
29
|
|
|
30
30
|
// Required characteristics
|
|
31
|
-
"
|
|
31
|
+
"on": "FALSE", // 0 - "FALSE"
|
|
32
32
|
// 1 - "TRUE"
|
|
33
33
|
|
|
34
34
|
// Optional Characteristics
|
|
35
|
-
"
|
|
35
|
+
"name": "My_v1Fan",
|
|
36
36
|
|
|
37
|
-
"
|
|
37
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
38
38
|
|
|
39
|
-
"
|
|
39
|
+
"model": "Anything", // Available for all accessories
|
|
40
40
|
|
|
41
|
-
"
|
|
41
|
+
"serialNumber": "12345", // Available for all accessories
|
|
42
42
|
|
|
43
43
|
// Cmd4 Specific
|
|
44
|
-
"
|
|
44
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
45
45
|
|
|
46
46
|
// Paramaters to state_cmd are:
|
|
47
47
|
// Get <accessory name> <characteristic>
|
|
@@ -49,42 +49,42 @@
|
|
|
49
49
|
// "Note": There is no need for an on_cmd or off_cmd
|
|
50
50
|
// with this kind of detail.
|
|
51
51
|
|
|
52
|
-
//"
|
|
52
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
53
53
|
},
|
|
54
54
|
{
|
|
55
|
-
"
|
|
56
|
-
"
|
|
55
|
+
"type": "Fan",
|
|
56
|
+
"displayName": "My_Fan", // Not a characteristic, but a function parameter
|
|
57
57
|
|
|
58
58
|
// Required Characteristics
|
|
59
|
-
"
|
|
59
|
+
"on": "FALSE", // 0 - "FALSE"
|
|
60
60
|
// 1 - "TRUE"
|
|
61
61
|
|
|
62
62
|
// Optional Characteristics
|
|
63
|
-
"
|
|
63
|
+
"rotationDirection": "COUNTER_CLOCKWISE", // 0 - "CLOCKWISE"
|
|
64
64
|
// 1 - "COUNTER_CLOCKWISE"
|
|
65
65
|
|
|
66
66
|
|
|
67
|
-
"
|
|
67
|
+
"rotationSpeed": 100, // Range: 0-100, Step: 1
|
|
68
68
|
|
|
69
|
-
"
|
|
69
|
+
"name": "My_Fan",
|
|
70
70
|
|
|
71
|
-
"
|
|
71
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
72
72
|
|
|
73
|
-
"
|
|
73
|
+
"model": "Anything", // Available for all accessories
|
|
74
74
|
|
|
75
|
-
"
|
|
75
|
+
"serialNumber": "12345", // Available for all accessories
|
|
76
76
|
|
|
77
77
|
// Cmd4 Specific
|
|
78
|
-
"
|
|
78
|
+
"outputConstants": true, // For this accessory, output constants
|
|
79
79
|
|
|
80
80
|
// polling requires a state_cmd and state_cmd is
|
|
81
81
|
// used with your own scripts. Here for example only.
|
|
82
|
-
//"
|
|
83
|
-
// {"
|
|
84
|
-
// {"
|
|
82
|
+
//"polling": [
|
|
83
|
+
// {"characteristic": "rotationDirection", "interval": 40, "timeout": 8000},
|
|
84
|
+
// {"characteristic": "on", "interval": 40, "timeout": 8000}
|
|
85
85
|
//],
|
|
86
86
|
|
|
87
|
-
"
|
|
87
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
88
88
|
|
|
89
89
|
// Paramaters to state_cmd are:
|
|
90
90
|
// Get <accessory name> <characteristic>
|
|
@@ -92,107 +92,107 @@
|
|
|
92
92
|
// "Note": There is no need for an on_cmd or off_cmd
|
|
93
93
|
// with this kind of detail.
|
|
94
94
|
|
|
95
|
-
//"
|
|
95
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
96
96
|
},
|
|
97
97
|
{
|
|
98
|
-
"
|
|
99
|
-
"
|
|
98
|
+
"type": "Fanv2",
|
|
99
|
+
"displayName": "My_v2Fan", // Not a characteristic, but a function parameter
|
|
100
100
|
|
|
101
101
|
// Required Characteristics
|
|
102
|
-
"
|
|
102
|
+
"active": "INACTIVE", // 0 - "INACTIVE"
|
|
103
103
|
// 1 - "ACTIVE"
|
|
104
104
|
|
|
105
105
|
// Optional Characteristics
|
|
106
|
-
"
|
|
106
|
+
"currentFanState": "IDLE",
|
|
107
107
|
// 0 - "INACTIVE"
|
|
108
108
|
// 1 - "IDLE"
|
|
109
109
|
// 2 - "BLOWING_AIR"
|
|
110
110
|
|
|
111
|
-
"
|
|
111
|
+
"targetFanState": "AUTO",
|
|
112
112
|
// 0 - "MANUAL"
|
|
113
113
|
// 1 - "AUTO"
|
|
114
114
|
|
|
115
|
-
"
|
|
115
|
+
"lockPhysicalControls": "CONTROL_LOCK_DISABLED", // 0 - "CONTROL_LOCK_DISABLED"
|
|
116
116
|
// 1 - "CONTROL_LOCK_ENABLED"
|
|
117
117
|
|
|
118
|
-
"
|
|
118
|
+
"rotationDirection": "CLOCKWISE", // 0 - "COUNTER_CLOCKWISE"
|
|
119
119
|
// 1 - "CLOCKWISE"
|
|
120
120
|
|
|
121
|
-
"
|
|
121
|
+
"rotationSpeed": 100, // Range: 0-100, Step: 1
|
|
122
122
|
|
|
123
|
-
"
|
|
123
|
+
"swingMode": "SWING_ENABLED", // 0 - "SWING_DISABLED",
|
|
124
124
|
// 1 - "SWING_ENABLED"
|
|
125
125
|
|
|
126
|
-
"
|
|
126
|
+
"name": "My_v2Fan",
|
|
127
127
|
|
|
128
|
-
"
|
|
128
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
129
129
|
|
|
130
|
-
"
|
|
130
|
+
"model": "Anything", // Available for all accessories
|
|
131
131
|
|
|
132
|
-
"
|
|
132
|
+
"serialNumber": "12345", // Available for all accessories
|
|
133
133
|
|
|
134
134
|
// Cmd4 Specific
|
|
135
|
-
"
|
|
136
|
-
//"
|
|
135
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
136
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
137
137
|
},
|
|
138
138
|
{
|
|
139
|
-
"
|
|
140
|
-
"
|
|
139
|
+
"type": "GarageDoorOpener",
|
|
140
|
+
"displayName": "My_GarageDoorOpener", // Not a characteristic, but a function parameter
|
|
141
141
|
|
|
142
142
|
// Required Characteristics
|
|
143
|
-
"
|
|
143
|
+
"currentDoorState": "OPEN", // 0 - "OPEN"
|
|
144
144
|
// 1 - "CLOSED"
|
|
145
145
|
// 2 - "OPENING"
|
|
146
146
|
// 3 - "CLOSING"
|
|
147
147
|
// 4 - "STOPPED"
|
|
148
148
|
|
|
149
|
-
"
|
|
149
|
+
"targetDoorState": "OPEN", // 0 - "OPEN"
|
|
150
150
|
// 1 - "CLOSED"
|
|
151
151
|
|
|
152
|
-
"
|
|
152
|
+
"obstructionDetected": "FALSE", // 0 - "FALSE"
|
|
153
153
|
// 1 - "TRUE"
|
|
154
154
|
|
|
155
155
|
// Optional Characteristics
|
|
156
|
-
"
|
|
156
|
+
"lockCurrentState": "UNSECURED", // 0 - "UNSECURED"
|
|
157
157
|
// 1 - "SECURED"
|
|
158
158
|
// 2 - "JAMMED"
|
|
159
159
|
// 3 - "UNKNOWN"
|
|
160
160
|
|
|
161
|
-
"
|
|
161
|
+
"lockTargetState": "UNSECURED", // 0 - "UNSECURED"
|
|
162
162
|
// 1 - "SECURED"
|
|
163
163
|
|
|
164
|
-
"
|
|
164
|
+
"name": "My_GarageDoorOpener",
|
|
165
165
|
|
|
166
|
-
"
|
|
166
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
167
167
|
|
|
168
|
-
"
|
|
168
|
+
"model": "Anything", // Available for all accessories
|
|
169
169
|
|
|
170
|
-
"
|
|
170
|
+
"serialNumber": "12345", // Available for all accessories
|
|
171
171
|
|
|
172
172
|
// Cmd4 Specific - Interval is in second, Timeout in msec
|
|
173
|
-
// (
|
|
173
|
+
// (polling per characteristic)
|
|
174
174
|
// Define the characteristic, its Interval and Timeout
|
|
175
175
|
|
|
176
176
|
// polling requires a state_cmd and state_cmd is
|
|
177
177
|
// used with your own scripts. Here for example only.
|
|
178
|
-
// "
|
|
179
|
-
// {"
|
|
180
|
-
// {"
|
|
181
|
-
// {"
|
|
178
|
+
// "polling": [
|
|
179
|
+
// {"characteristic": "currentDoorState", "interval": 540, "timeout": 8000},
|
|
180
|
+
// {"characteristic": "obstructionDetected", "interval": 540, "timeout": 8000},
|
|
181
|
+
// {"characteristic": "lockCurrentState", "interval": 540, "timeout": 8000}
|
|
182
182
|
// ],
|
|
183
|
-
"
|
|
183
|
+
"stateChangeResponseTime": 10, // Default (Seconds)
|
|
184
184
|
|
|
185
185
|
// This is just a dumb example of a prefix
|
|
186
|
-
"
|
|
186
|
+
"state_cmd_prefix": "node"
|
|
187
187
|
|
|
188
|
-
//"
|
|
188
|
+
//"state_cmd": ".homebridge/< yourScriptHere >"
|
|
189
189
|
},
|
|
190
190
|
{
|
|
191
|
-
"
|
|
192
|
-
"
|
|
191
|
+
"type": "Lightbulb",
|
|
192
|
+
"displayName": "My_OnOff_Light", // Not a characteristic, but a function parameter
|
|
193
193
|
|
|
194
194
|
// Required Characteristics
|
|
195
|
-
"
|
|
195
|
+
"on": "FALSE", // 0 - "FALSE"
|
|
196
196
|
// 1 - "TRUE"
|
|
197
197
|
|
|
198
198
|
// Optional Characteristics
|
|
@@ -201,53 +201,53 @@
|
|
|
201
201
|
// "Hue":
|
|
202
202
|
// "Saturation":
|
|
203
203
|
|
|
204
|
-
"
|
|
204
|
+
"name": "My_OnOff_Light",
|
|
205
205
|
|
|
206
|
-
"
|
|
206
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
207
207
|
|
|
208
|
-
"
|
|
208
|
+
"model": "Anything", // Available for all accessories
|
|
209
209
|
|
|
210
|
-
"
|
|
210
|
+
"serialNumber": "12345", // Available for all accessories
|
|
211
211
|
|
|
212
212
|
// "ColorTemperature":
|
|
213
213
|
|
|
214
214
|
// Cmd4 Specific
|
|
215
|
-
"
|
|
216
|
-
//"
|
|
215
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
216
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
217
217
|
},
|
|
218
218
|
{
|
|
219
|
-
"
|
|
220
|
-
"
|
|
219
|
+
"type": "Lightbulb",
|
|
220
|
+
"displayName": "My_Dimmable_Light", // Not a characteristic, but a function parameter
|
|
221
221
|
|
|
222
222
|
// Required
|
|
223
|
-
"
|
|
223
|
+
"on": "FALSE", // 0 - "FALSE"
|
|
224
224
|
// 1 - "TRUE"
|
|
225
225
|
|
|
226
226
|
// Optional Characteristics
|
|
227
227
|
// Defining brightness determines that it is dimmmable
|
|
228
|
-
"
|
|
228
|
+
"brightness": 8, // Range: 0-100, Step: 1
|
|
229
229
|
|
|
230
|
-
"
|
|
230
|
+
"hue": 8, // Range: 0-360, Step: 1
|
|
231
231
|
|
|
232
|
-
"
|
|
232
|
+
"saturation": 8, // Range: 0-100, Step: 1
|
|
233
233
|
|
|
234
|
-
"
|
|
234
|
+
"colorTemperature": 8, // Range: 140-500, Step: 1
|
|
235
235
|
|
|
236
|
-
"
|
|
236
|
+
"name": "My_Dimmable_Light",
|
|
237
237
|
|
|
238
|
-
"
|
|
238
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
239
239
|
|
|
240
|
-
"
|
|
240
|
+
"model": "Anything", // Available for all accessories
|
|
241
241
|
|
|
242
|
-
"
|
|
242
|
+
"serialNumber": "12345", // Available for all accessories
|
|
243
243
|
|
|
244
244
|
// Cmd4 Specific
|
|
245
|
-
"
|
|
246
|
-
//"
|
|
245
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
246
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
247
247
|
},
|
|
248
248
|
{
|
|
249
|
-
"
|
|
250
|
-
"
|
|
249
|
+
"type": "LockManagement",
|
|
250
|
+
"displayName": "My_LockManagement", // Not a characteristic, but a function parameter
|
|
251
251
|
|
|
252
252
|
// Required Characteristics
|
|
253
253
|
|
|
@@ -255,9 +255,9 @@
|
|
|
255
255
|
// unless 'allowTLV8' is set, at your own peril.
|
|
256
256
|
// Setting most will cause Homebridge with HomeKit or Eve.
|
|
257
257
|
// to not allow you to connect.
|
|
258
|
-
// "
|
|
258
|
+
// "lockControlPoint": 0, // Format TLV8
|
|
259
259
|
|
|
260
|
-
"
|
|
260
|
+
"version": "1.2.3", // Format: String
|
|
261
261
|
|
|
262
262
|
|
|
263
263
|
// Optional Characteristics
|
|
@@ -266,20 +266,20 @@
|
|
|
266
266
|
// unless 'allowTLV8' is set, at your own peril.
|
|
267
267
|
// Setting most will cause Homebridge with HomeKit or Eve.
|
|
268
268
|
// to not allow you to connect.
|
|
269
|
-
// "
|
|
269
|
+
// "logs": 0, // Format: TLV8
|
|
270
270
|
|
|
271
|
-
"
|
|
271
|
+
"audioFeedback": "FALSE",
|
|
272
272
|
// 0 - "FALSE"
|
|
273
273
|
// 1 - "TRUE"
|
|
274
274
|
|
|
275
|
-
"
|
|
275
|
+
"lockManagementAutoSecurityTimeout":
|
|
276
276
|
20, // Format: UINT32
|
|
277
277
|
// "Units": Seconds
|
|
278
278
|
|
|
279
|
-
"
|
|
279
|
+
"administratorOnlyAccess": "FALSE", // 0 - "FALSE"
|
|
280
280
|
// 1 - "TRUE"
|
|
281
281
|
|
|
282
|
-
"
|
|
282
|
+
"lockLastKnownAction": "SECURED_PHYSICALLY_INTERIOR",
|
|
283
283
|
// 0 - "SECURED_PHYSICALLY_INTERIOR"
|
|
284
284
|
// 1 - "UNSECURED_PHYSICALLY_INTERIOR"
|
|
285
285
|
// 2 - "SECURED_PHYSICALLY_EXTERIOR"
|
|
@@ -290,146 +290,146 @@
|
|
|
290
290
|
// 7 - "UNSECURED_REMOTELY"
|
|
291
291
|
// 8 - "SECURED_BY_AUTO_SECURE_TIMEOUT"
|
|
292
292
|
|
|
293
|
-
"
|
|
293
|
+
"currentDoorState": "OPEN", // 0 - "OPEN"
|
|
294
294
|
// 1 - "CLOSED"
|
|
295
295
|
// 2 - "OPENING"
|
|
296
296
|
// 3 - "CLOSING"
|
|
297
297
|
// 4 - "STOPPED"
|
|
298
298
|
|
|
299
|
-
"
|
|
299
|
+
"motionDetected": "FALSE", // 0 - "FALSE"
|
|
300
300
|
// 1 - "TRUE"
|
|
301
301
|
|
|
302
|
-
"
|
|
302
|
+
"name": "My_LockManagement",
|
|
303
303
|
|
|
304
|
-
"
|
|
304
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
305
305
|
|
|
306
|
-
"
|
|
306
|
+
"model": "Anything", // Available for all accessories
|
|
307
307
|
|
|
308
|
-
"
|
|
308
|
+
"serialNumber": "12345", // Available for all accessories
|
|
309
309
|
|
|
310
310
|
// Cmd4 Specific
|
|
311
|
-
"
|
|
312
|
-
//"
|
|
311
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
312
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
313
313
|
},
|
|
314
314
|
{
|
|
315
|
-
"
|
|
316
|
-
"
|
|
315
|
+
"type": "LockMechanism",
|
|
316
|
+
"displayName": "My_LockMechanism", // Not a characteristic, but a function parameter
|
|
317
317
|
|
|
318
318
|
// Required Characteristics
|
|
319
|
-
"
|
|
319
|
+
"lockCurrentState": "UNSECURED", // 0 - "UNSECURED"
|
|
320
320
|
// 1 - "SECURED"
|
|
321
321
|
// 2 - "JAMMED"
|
|
322
322
|
// 3 - "UNKNOWN"
|
|
323
323
|
|
|
324
|
-
"
|
|
324
|
+
"lockTargetState": "UNSECURED", // 0 - "UNSECURED"
|
|
325
325
|
// 1 - "SECURED"
|
|
326
326
|
|
|
327
|
-
"
|
|
327
|
+
"name": "My_LockMechanism",
|
|
328
328
|
|
|
329
|
-
"
|
|
329
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
330
330
|
|
|
331
|
-
"
|
|
331
|
+
"model": "Anything", // Available for all accessories
|
|
332
332
|
|
|
333
|
-
"
|
|
333
|
+
"serialNumber": "12345", // Available for all accessories
|
|
334
334
|
|
|
335
335
|
// Cmd4 Specific
|
|
336
|
-
"
|
|
337
|
-
//"
|
|
336
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
337
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
338
338
|
},
|
|
339
339
|
{
|
|
340
|
-
"
|
|
341
|
-
"
|
|
340
|
+
"type": "Outlet",
|
|
341
|
+
"displayName": "My_Outlet", // Not a characteristic, but a function parameter
|
|
342
342
|
|
|
343
343
|
// Required Characteristics
|
|
344
|
-
"
|
|
344
|
+
"on": "FALSE", // 0 - "FALSE"
|
|
345
345
|
// 1 - "TRUE"
|
|
346
346
|
|
|
347
|
-
"
|
|
347
|
+
"outletInUse": "FALSE", // 0 - "FALSE"
|
|
348
348
|
// 1 - "TRUE"
|
|
349
349
|
|
|
350
350
|
// Optional Characteristics
|
|
351
|
-
"
|
|
351
|
+
"name": "My_Outlet",
|
|
352
352
|
|
|
353
|
-
"
|
|
353
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
354
354
|
|
|
355
|
-
"
|
|
355
|
+
"model": "Anything", // Available for all accessories
|
|
356
356
|
|
|
357
|
-
"
|
|
357
|
+
"serialNumber": "12345", // Available for all accessories
|
|
358
358
|
|
|
359
359
|
// Cmd4 Specific
|
|
360
|
-
"
|
|
361
|
-
//"
|
|
360
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
361
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
362
362
|
},
|
|
363
363
|
{
|
|
364
|
-
"
|
|
365
|
-
"
|
|
364
|
+
"type": "Switch",
|
|
365
|
+
"displayName": "My_Switch", // Not a characteristic, but a function parameter
|
|
366
366
|
|
|
367
367
|
// Required Characteristics
|
|
368
|
-
"
|
|
368
|
+
"on": "FALSE", // 0 - "FALSE"
|
|
369
369
|
// 1 - "TRUE"
|
|
370
370
|
|
|
371
371
|
// Optional Characteristics
|
|
372
|
-
"
|
|
372
|
+
"name": "My_Switch",
|
|
373
373
|
|
|
374
|
-
"
|
|
374
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
375
375
|
|
|
376
|
-
"
|
|
376
|
+
"model": "Anything", // Available for all accessories
|
|
377
377
|
|
|
378
|
-
"
|
|
378
|
+
"serialNumber": "12345", // Available for all accessories
|
|
379
379
|
|
|
380
380
|
// Cmd4 Specific
|
|
381
|
-
"
|
|
382
|
-
//"
|
|
381
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
382
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
383
383
|
},
|
|
384
384
|
{
|
|
385
|
-
"
|
|
386
|
-
"
|
|
385
|
+
"type": "Thermostat",
|
|
386
|
+
"displayName": "My_Thermostat", // Not a characteristic, but a function parameter
|
|
387
387
|
|
|
388
388
|
// Required Characteristics
|
|
389
|
-
"
|
|
389
|
+
"currentHeatingCoolingState":
|
|
390
390
|
"OFF", // 0 - "OFF"
|
|
391
391
|
// 1 - "HEAT"
|
|
392
392
|
// 2 - "COOL"
|
|
393
393
|
|
|
394
|
-
"
|
|
394
|
+
"targetHeatingCoolingState":
|
|
395
395
|
"OFF", // 0 - "OFF"
|
|
396
396
|
// 1 - "HEAT"
|
|
397
397
|
// 2 - "COOL"
|
|
398
398
|
// 3 - "AUTO"
|
|
399
399
|
|
|
400
|
-
"
|
|
400
|
+
"currentTemperature": 22.2, // Range: 0-100, Step: 0.1
|
|
401
401
|
// "Units": CELCIUS
|
|
402
402
|
|
|
403
|
-
"
|
|
403
|
+
"targetTemperature": 22.2, // Range: 10-38, Step: 0.1
|
|
404
404
|
// "Units": CELCIUS
|
|
405
405
|
|
|
406
|
-
"
|
|
406
|
+
"temperatureDisplayUnits": "CELSIUS", // 0 - "CELSIUS"
|
|
407
407
|
// 1 - "FAHRENHEIT"
|
|
408
408
|
|
|
409
409
|
// Optional Characteristics
|
|
410
|
-
"
|
|
410
|
+
"currentRelativeHumidity": 60, // Range: 0-100, Step: 1
|
|
411
411
|
// Format: float
|
|
412
412
|
// Units: Percentage
|
|
413
413
|
|
|
414
|
-
"
|
|
414
|
+
"targetRelativeHumidity": 60, // Range: 0-100, Step: 1
|
|
415
415
|
// Format: float
|
|
416
416
|
// Units: Percentage
|
|
417
417
|
|
|
418
|
-
"
|
|
418
|
+
"coolingThresholdTemperature":
|
|
419
419
|
22.2, // Range 10-35, Step: 0.1
|
|
420
420
|
// Units: CELCIUS
|
|
421
421
|
|
|
422
|
-
"
|
|
422
|
+
"heatingThresholdTemperature":
|
|
423
423
|
25.2, // Range 0-25, Step: 0.1
|
|
424
424
|
// Units: CELCIUS
|
|
425
425
|
|
|
426
|
-
"
|
|
426
|
+
"name": "My_Thermostat",
|
|
427
427
|
|
|
428
|
-
"
|
|
428
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
429
429
|
|
|
430
|
-
"
|
|
430
|
+
"model": "Anything", // Available for all accessories
|
|
431
431
|
|
|
432
|
-
"
|
|
432
|
+
"serialNumber": "12345", // Available for all accessories
|
|
433
433
|
|
|
434
434
|
// Cmd4 Specific - Interval is in second, Timeout in msec
|
|
435
435
|
// - Notice Two characteristics being polled !!!
|
|
@@ -438,15 +438,15 @@
|
|
|
438
438
|
|
|
439
439
|
// polling requires a state_cmd and state_cmd is
|
|
440
440
|
// used with your own scripts. Here for example only.
|
|
441
|
-
//"
|
|
442
|
-
// {"
|
|
443
|
-
// {"
|
|
444
|
-
// {"
|
|
441
|
+
//"polling": [
|
|
442
|
+
// {"characteristic": "currentHeatingCoolingState", "interval": 540, "timeout": 8000},
|
|
443
|
+
// {"characteristic": "currentTemperature", "interval": 60, "timeout": 8000},
|
|
444
|
+
// {"characteristic": "targetTemperature", "interval": 60, "timeout": 8000}
|
|
445
445
|
//],
|
|
446
446
|
|
|
447
447
|
// Cmd4 Specific
|
|
448
|
-
"
|
|
449
|
-
//"
|
|
448
|
+
"stateChangeResponseTime": 10 // (Seconds)
|
|
449
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >",
|
|
450
450
|
|
|
451
451
|
// Cmd4 fakegato lets you specify what type of logging and
|
|
452
452
|
// the characteristics to be logged.
|
|
@@ -457,215 +457,215 @@
|
|
|
457
457
|
// You must also define them for polling, or the value would never change.
|
|
458
458
|
// fakegato requires a state_cmd and state_cmd is
|
|
459
459
|
// used with your own scripts. Here for example only.
|
|
460
|
-
//"
|
|
461
|
-
// "
|
|
462
|
-
// "
|
|
463
|
-
// "
|
|
464
|
-
// "
|
|
465
|
-
// "
|
|
466
|
-
// "
|
|
467
|
-
// "
|
|
460
|
+
//"fakegato": {"eve": "thermo",
|
|
461
|
+
// "currentTemp": "CurrentTemperature",
|
|
462
|
+
// "setTemp": "TargetTemperature",
|
|
463
|
+
// "valvePosition": 0,
|
|
464
|
+
// "storage": "fs",
|
|
465
|
+
// "storagePath": ".homebridge/FakegatoStorage",
|
|
466
|
+
// "folder": "folderName",
|
|
467
|
+
// "keyPath": "/place/to/store/my/keys/"
|
|
468
468
|
// }
|
|
469
469
|
|
|
470
470
|
},
|
|
471
471
|
{
|
|
472
|
-
"
|
|
473
|
-
"
|
|
472
|
+
"type": "AirQualitySensor",
|
|
473
|
+
"displayName": "My_AirQualitySensor", // Not a characteristic, but a function parameter
|
|
474
474
|
|
|
475
475
|
// Required Characteristics
|
|
476
|
-
"
|
|
476
|
+
"airQuality": "EXCELLENT", // 0 - "UNKNOWN"
|
|
477
477
|
// 1 - "EXCELLENT"
|
|
478
478
|
// 2 - "GOOD"
|
|
479
479
|
// 3 - "FAIR"
|
|
480
480
|
// 4 - "INFERIOR"
|
|
481
481
|
// 5 - "POOR"
|
|
482
482
|
|
|
483
|
-
"
|
|
483
|
+
"ozoneDensity": 50, // Range 0-1000, Step 1
|
|
484
484
|
|
|
485
|
-
"
|
|
485
|
+
"nitrogenDioxideDensity": 50, // Range 0-1000, Step 1
|
|
486
486
|
|
|
487
|
-
"
|
|
487
|
+
"sulphurDioxideDensity": 50, // Range 0-1000, Step 1
|
|
488
488
|
|
|
489
|
-
"
|
|
489
|
+
"pm2_5Density": 50, // Range 0-1000, Step 1
|
|
490
490
|
|
|
491
491
|
// Optional Characteristics
|
|
492
|
-
"
|
|
492
|
+
"pm10Density": 50, // Range 0-1000, Step 1
|
|
493
493
|
|
|
494
|
-
"
|
|
494
|
+
"vocDensity": 50, // Range 0-1000, Step 1
|
|
495
495
|
|
|
496
|
-
"
|
|
496
|
+
"statusActive": "TRUE", // 0 - "FALSE"
|
|
497
497
|
// 1 - "TRUE"
|
|
498
498
|
|
|
499
|
-
"
|
|
499
|
+
"statusFault": "NO_FAULT", // 0 - "NO_FAULT"
|
|
500
500
|
// 1 - "GENERAL_FAULT"
|
|
501
501
|
|
|
502
|
-
"
|
|
502
|
+
"statusTampered": "NOT_TAMPERED", // 0 - "NOT_TAMPERED"
|
|
503
503
|
// 1 - "TAMPERED"
|
|
504
504
|
|
|
505
|
-
"
|
|
505
|
+
"statusLowBattery": "BATTERY_LEVEL_NORMAL", // 0 - "BATTERY_LEVEL_NORMAL"
|
|
506
506
|
// 1 - "BATTERY_LEVEL_LOW"
|
|
507
507
|
|
|
508
|
-
"
|
|
508
|
+
"name": "My_AirQualitySensor",
|
|
509
509
|
|
|
510
|
-
"
|
|
510
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
511
511
|
|
|
512
|
-
"
|
|
512
|
+
"model": "Anything", // Available for all accessories
|
|
513
513
|
|
|
514
|
-
"
|
|
514
|
+
"serialNumber": "12345", // Available for all accessories
|
|
515
515
|
|
|
516
516
|
// Cmd4 Specific
|
|
517
|
-
"
|
|
518
|
-
//"
|
|
517
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
518
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
519
519
|
},
|
|
520
520
|
{
|
|
521
|
-
"
|
|
522
|
-
"
|
|
521
|
+
"type": "SecuritySystem",
|
|
522
|
+
"displayName": "My_SecuritySystem", // Not a characteristic, but a function parameter
|
|
523
523
|
|
|
524
524
|
// Required Characteristics
|
|
525
|
-
"
|
|
525
|
+
"securitySystemCurrentState":
|
|
526
526
|
"DISARMED", // 0 - "STAY_ARM"
|
|
527
527
|
// 1 - "AWAY_ARM"
|
|
528
528
|
// 2 - "NIGHT_ARM"
|
|
529
529
|
// 3 - "DISARMED"
|
|
530
530
|
// 4 - "ALARM_TRIGGERED"
|
|
531
531
|
|
|
532
|
-
"
|
|
532
|
+
"securitySystemTargetState":
|
|
533
533
|
"DISARM", // 0 - "STAY_ARM"
|
|
534
534
|
// 1 - "AWAY_ARM"
|
|
535
535
|
// 2 - "NIGHT_ARM"
|
|
536
536
|
// 3 - "DISARM"
|
|
537
537
|
|
|
538
538
|
// Optional Characteristics
|
|
539
|
-
"
|
|
539
|
+
"securitySystemAlarmType": 0, // Range: 0-1, Step 1
|
|
540
540
|
// Meaning Unknown
|
|
541
541
|
|
|
542
|
-
"
|
|
542
|
+
"statusFault": "NO_FAULT", // 0 - "NO_FAULT"
|
|
543
543
|
// 1 - "GENERAL_FAULT"
|
|
544
544
|
|
|
545
|
-
"
|
|
545
|
+
"statusTampered": "NOT_TAMPERED", // 0 - "NOT_TAMPERED"
|
|
546
546
|
// 1 - "TAMPERED"
|
|
547
547
|
|
|
548
|
-
"
|
|
548
|
+
"name": "My_SecuritySystem",
|
|
549
549
|
|
|
550
|
-
"
|
|
550
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
551
551
|
|
|
552
|
-
"
|
|
552
|
+
"model": "Anything", // Available for all accessories
|
|
553
553
|
|
|
554
|
-
"
|
|
554
|
+
"serialNumber": "12345", // Available for all accessories
|
|
555
555
|
|
|
556
556
|
// Cmd4 Specific
|
|
557
|
-
"
|
|
558
|
-
//"
|
|
557
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
558
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
559
559
|
},
|
|
560
560
|
{
|
|
561
|
-
"
|
|
562
|
-
"
|
|
561
|
+
"type": "CarbonMonoxideSensor",
|
|
562
|
+
"displayName": "My_CO_Sensor", // Not a characteristic, but a function parameter
|
|
563
563
|
|
|
564
564
|
// Required Characteristics
|
|
565
|
-
"
|
|
565
|
+
"carbonMonoxideDetected": "CO_LEVELS_NORMAL", // 0 - "CO_LEVELS_NORMAL"
|
|
566
566
|
// 1 - "CO_LEVELS_ABNORMAL"
|
|
567
567
|
|
|
568
568
|
// Optional Characteristics
|
|
569
|
-
"
|
|
569
|
+
"statusActive": "TRUE", // 0 - "FALSE"
|
|
570
570
|
// 1 - "TRUE"
|
|
571
571
|
|
|
572
|
-
"
|
|
572
|
+
"statusFault": "NO_FAULT", // 0 - "NO_FAULT"
|
|
573
573
|
// 1 - "GENERAL_FAULT"
|
|
574
574
|
|
|
575
|
-
"
|
|
575
|
+
"statusTampered": "NOT_TAMPERED", // 0 - "NOT_TAMPERED"
|
|
576
576
|
// 1 - "TAMPERED"
|
|
577
577
|
|
|
578
|
-
"
|
|
578
|
+
"statusLowBattery": "BATTERY_LEVEL_NORMAL", // 0 - "BATTERY_LEVEL_NORMAL"
|
|
579
579
|
// 1 - "BATTERY_LEVEL_LOW"
|
|
580
580
|
|
|
581
|
-
"
|
|
581
|
+
"carbonMonoxideLevel": 0, // Range: 0-100,
|
|
582
582
|
// Format: float
|
|
583
583
|
|
|
584
|
-
"
|
|
584
|
+
"carbonMonoxidePeakLevel": 0, // Range: 0-100,
|
|
585
585
|
// Format: float
|
|
586
586
|
|
|
587
|
-
"
|
|
587
|
+
"name": "My_CO_Sensor",
|
|
588
588
|
|
|
589
|
-
"
|
|
589
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
590
590
|
|
|
591
|
-
"
|
|
591
|
+
"model": "Anything", // Available for all accessories
|
|
592
592
|
|
|
593
|
-
"
|
|
593
|
+
"serialNumber": "12345", // Available for all accessories
|
|
594
594
|
|
|
595
595
|
// Cmd4 Specific
|
|
596
|
-
"
|
|
597
|
-
//"
|
|
596
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
597
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
598
598
|
},
|
|
599
599
|
{
|
|
600
|
-
"
|
|
601
|
-
"
|
|
600
|
+
"type": "ContactSensor",
|
|
601
|
+
"displayName": "My_ContactSensor", // Not a characteristic, but a function parameter
|
|
602
602
|
|
|
603
603
|
// Required Characteristics
|
|
604
|
-
"
|
|
604
|
+
"contactSensorState": "CONTACT_DETECTED", // 0 - "CONTACT_DETECTED"
|
|
605
605
|
// 1 - "CONTACT_NOT_DETECTED"
|
|
606
606
|
|
|
607
607
|
// Optional Characteristics
|
|
608
|
-
"
|
|
608
|
+
"statusActive": "TRUE", // 0 - "FALSE"
|
|
609
609
|
// 1 - "TRUE"
|
|
610
610
|
|
|
611
|
-
"
|
|
611
|
+
"statusFault": "NO_FAULT", // 0 - "NO_FAULT"
|
|
612
612
|
// 1 - "GENERAL_FAULT"
|
|
613
613
|
|
|
614
|
-
"
|
|
614
|
+
"statusTampered": "NOT_TAMPERED", // 0 - "NOT_TAMPERED"
|
|
615
615
|
// 1 - "TAMPERED"
|
|
616
616
|
|
|
617
|
-
"
|
|
617
|
+
"statusLowBattery": "BATTERY_LEVEL_NORMAL", // 0 - "BATTERY_LEVEL_NORMAL"
|
|
618
618
|
// 1 - "BATTERY_LEVEL_LOW"
|
|
619
619
|
|
|
620
|
-
"
|
|
620
|
+
"name": "My_ContactSensor",
|
|
621
621
|
|
|
622
|
-
"
|
|
622
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
623
623
|
|
|
624
|
-
"
|
|
624
|
+
"model": "Anything", // Available for all accessories
|
|
625
625
|
|
|
626
|
-
"
|
|
626
|
+
"serialNumber": "12345", // Available for all accessories
|
|
627
627
|
|
|
628
628
|
// Cmd4 Specific
|
|
629
|
-
"
|
|
630
|
-
//"
|
|
629
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
630
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
631
631
|
},
|
|
632
632
|
{
|
|
633
|
-
"
|
|
634
|
-
"
|
|
633
|
+
"type": "Door",
|
|
634
|
+
"displayName": "My_Door", // Not a characteristic, but a function parameter
|
|
635
635
|
|
|
636
636
|
// Required Characteristics
|
|
637
|
-
"
|
|
637
|
+
"currentPosition": 0, // Range: 0 - 100, Step 1
|
|
638
638
|
|
|
639
|
-
"
|
|
639
|
+
"targetPosition": 0, // Range: 0 - 100, Step 1
|
|
640
640
|
|
|
641
|
-
"
|
|
641
|
+
"positionState": "STOPPED", // 0 - "DECREASING"
|
|
642
642
|
// 1 - "INCREASING"
|
|
643
643
|
// 2 - "STOPPED"
|
|
644
644
|
|
|
645
645
|
// Optional Characteristics
|
|
646
|
-
"
|
|
646
|
+
"holdPosition": "FALSE", // 0 - "FALSE"
|
|
647
647
|
// 1 - "TRUE"
|
|
648
648
|
|
|
649
|
-
"
|
|
649
|
+
"obstructionDetected": "FALSE", // 0 - "FALSE"
|
|
650
650
|
// 1 - "TRUE"
|
|
651
651
|
|
|
652
|
-
"
|
|
652
|
+
"name": "My_Door",
|
|
653
653
|
|
|
654
|
-
"
|
|
654
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
655
655
|
|
|
656
|
-
"
|
|
656
|
+
"model": "Anything", // Available for all accessories
|
|
657
657
|
|
|
658
|
-
"
|
|
658
|
+
"serialNumber": "12345", // Available for all accessories
|
|
659
659
|
|
|
660
660
|
// Cmd4 Specific - Interval is in second, Timeout in msec
|
|
661
|
-
// (
|
|
661
|
+
// (polling per characteristic)
|
|
662
662
|
// Required as fakegato option below uses them.
|
|
663
663
|
|
|
664
664
|
// polling requires a state_cmd and state_cmd is
|
|
665
665
|
// used with your own scripts. Here for example only.
|
|
666
|
-
//"
|
|
667
|
-
// {"
|
|
668
|
-
// {"
|
|
666
|
+
//"polling": [
|
|
667
|
+
// {"characteristic": "currentPosition", "interval": 80, "timeout": 8000},
|
|
668
|
+
// {"characteristic": "obstructionDetected", "interval": 50, "timeout": 8000}
|
|
669
669
|
//],
|
|
670
670
|
|
|
671
671
|
// Cmd4 fakegato lets you specify what type of logging and
|
|
@@ -674,62 +674,62 @@
|
|
|
674
674
|
// You must also define them for polling, or the value would never change.
|
|
675
675
|
// fakegato requires a state_cmd and state_cmd is
|
|
676
676
|
// used with your own scripts. Here for example only.
|
|
677
|
-
//"
|
|
678
|
-
// "
|
|
679
|
-
// "
|
|
680
|
-
// "
|
|
681
|
-
// "
|
|
682
|
-
// "
|
|
677
|
+
//"fakegato": {"eve": "door",
|
|
678
|
+
// "status": "currentPosition",
|
|
679
|
+
// "storage": "fs",
|
|
680
|
+
// "storagePath": ".homebridge/FakegatoStorage",
|
|
681
|
+
// "folder": "folderName",
|
|
682
|
+
// "keyPath": "/place/to/store/my/keys/"
|
|
683
683
|
// },
|
|
684
684
|
|
|
685
685
|
// Cmd4 Specific
|
|
686
|
-
"
|
|
687
|
-
//"
|
|
686
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
687
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
688
688
|
},
|
|
689
689
|
{
|
|
690
|
-
"
|
|
690
|
+
"type": "HumiditySensor",
|
|
691
691
|
|
|
692
|
-
"
|
|
692
|
+
"displayName": "My_HumiditySensor", // Not a characteristic, but a function parameter
|
|
693
693
|
|
|
694
694
|
// Required Characteristics
|
|
695
|
-
"
|
|
695
|
+
"currentRelativeHumidity": 1, // Range: 0-100, Step: 1
|
|
696
696
|
// Format: float
|
|
697
697
|
// Units: Percentage
|
|
698
698
|
|
|
699
699
|
// Optional Characteristics
|
|
700
|
-
"
|
|
700
|
+
"statusActive": "TRUE", // 0 - "FALSE"
|
|
701
701
|
// 1 - "TRUE"
|
|
702
702
|
|
|
703
|
-
"
|
|
703
|
+
"statusFault": "NO_FAULT", // 0 - "NO_FAULT"
|
|
704
704
|
// 1 - "GENERAL_FAULT"
|
|
705
705
|
|
|
706
|
-
"
|
|
706
|
+
"statusTampered": "NOT_TAMPERED", // 0 - "NOT_TAMPERED"
|
|
707
707
|
// 1 - "TAMPERED"
|
|
708
708
|
|
|
709
|
-
"
|
|
709
|
+
"statusLowBattery": "BATTERY_LEVEL_NORMAL", // 0 - "BATTERY_LEVEL_NORMAL"
|
|
710
710
|
// 1 - "BATTERY_LEVEL_LOW"
|
|
711
711
|
|
|
712
|
-
"
|
|
712
|
+
"name": "My_HumiditySensor",
|
|
713
713
|
|
|
714
|
-
"
|
|
714
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
715
715
|
|
|
716
|
-
"
|
|
716
|
+
"model": "Anything", // Available for all accessories
|
|
717
717
|
|
|
718
|
-
"
|
|
718
|
+
"serialNumber": "12345", // Available for all accessories
|
|
719
719
|
|
|
720
720
|
|
|
721
721
|
// Cmd4 Specific
|
|
722
|
-
"
|
|
723
|
-
//"
|
|
722
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
723
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >",
|
|
724
724
|
|
|
725
725
|
// Cmd4 Specific - Interval is in second, Timeout in msec
|
|
726
|
-
// (
|
|
726
|
+
// (polling per characteristic)
|
|
727
727
|
// Required as fakegato option below uses them.
|
|
728
728
|
|
|
729
729
|
// polling requires a state_cmd and state_cmd is
|
|
730
730
|
// used with your own scripts. Here for example only.
|
|
731
|
-
//"
|
|
732
|
-
// {"
|
|
731
|
+
//"polling": [
|
|
732
|
+
// {"characteristic": "currentRelativeHumidity", "interval": 50, "timeout": 8000}
|
|
733
733
|
//],
|
|
734
734
|
|
|
735
735
|
// Cmd4 fakegato lets you specify what type of logging and
|
|
@@ -739,693 +739,693 @@
|
|
|
739
739
|
// You must also define them for polling, or the value would never change.
|
|
740
740
|
// fakegato requires a state_cmd and state_cmd is
|
|
741
741
|
// used with your own scripts. Here for example only.
|
|
742
|
-
//"
|
|
743
|
-
// "
|
|
744
|
-
// "
|
|
745
|
-
// "
|
|
746
|
-
// "
|
|
747
|
-
// "
|
|
748
|
-
// "
|
|
749
|
-
// "
|
|
742
|
+
//"fakegato": {"eve": "room",
|
|
743
|
+
// "temp": 0,
|
|
744
|
+
// "humidity": "currentRelativeHumidity",
|
|
745
|
+
// "ppm": 0,
|
|
746
|
+
// "storage": "fs",
|
|
747
|
+
// "storagePath": ".homebridge/FakegatoStorage",
|
|
748
|
+
// "folder": "folderName",
|
|
749
|
+
// "keyPath": "/place/to/store/my/keys/"
|
|
750
750
|
// }
|
|
751
751
|
},
|
|
752
752
|
{
|
|
753
|
-
"
|
|
754
|
-
"
|
|
753
|
+
"type": "LeakSensor",
|
|
754
|
+
"displayName": "My_LeakSensor", // Not a characteristic, but a function parameter
|
|
755
755
|
|
|
756
756
|
// Required Characteristics
|
|
757
|
-
"
|
|
757
|
+
"leakDetected": "LEAK_NOT_DETECTED", // 0 - "LEAK_NOT_DETECTED"
|
|
758
758
|
// 1 - "LEAK_DETECTED"
|
|
759
759
|
|
|
760
760
|
// Optional Characteristics
|
|
761
|
-
"
|
|
761
|
+
"statusActive": "TRUE", // 0 - "FALSE"
|
|
762
762
|
// 1 - "TRUE"
|
|
763
763
|
|
|
764
|
-
"
|
|
764
|
+
"statusFault": "NO_FAULT", // 0 - "NO_FAULT"
|
|
765
765
|
// 1 - "GENERAL_FAULT"
|
|
766
766
|
|
|
767
|
-
"
|
|
767
|
+
"statusTampered": "NOT_TAMPERED", // 0 - "NOT_TAMPERED"
|
|
768
768
|
// 1 - "TAMPERED"
|
|
769
769
|
|
|
770
|
-
"
|
|
770
|
+
"statusLowBattery": "BATTERY_LEVEL_NORMAL", // 0 - "BATTERY_LEVEL_NORMAL"
|
|
771
771
|
// 1 - "BATTERY_LEVEL_LOW"
|
|
772
772
|
|
|
773
|
-
"
|
|
773
|
+
"name": "My_LeakSensor",
|
|
774
774
|
|
|
775
|
-
"
|
|
775
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
776
776
|
|
|
777
|
-
"
|
|
777
|
+
"model": "Anything", // Available for all accessories
|
|
778
778
|
|
|
779
|
-
"
|
|
779
|
+
"serialNumber": "12345", // Available for all accessories
|
|
780
780
|
|
|
781
781
|
// Cmd4 Specific
|
|
782
|
-
"
|
|
783
|
-
//"
|
|
782
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
783
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
784
784
|
},
|
|
785
785
|
{
|
|
786
|
-
"
|
|
787
|
-
"
|
|
786
|
+
"type": "LightSensor",
|
|
787
|
+
"displayName": "My_LightSensor", // Not a characteristic, but a function parameter
|
|
788
788
|
|
|
789
789
|
// Required Characteristics
|
|
790
|
-
"
|
|
790
|
+
"currentAmbientLightLevel": 1, // Range: 0.0001-100000
|
|
791
791
|
// Format: float
|
|
792
792
|
|
|
793
793
|
// Optional Characteristics
|
|
794
|
-
"
|
|
794
|
+
"statusActive": "TRUE", // 0 - "FALSE"
|
|
795
795
|
// 1 - "TRUE"
|
|
796
796
|
|
|
797
|
-
"
|
|
797
|
+
"statusFault": "NO_FAULT", // 0 - "NO_FAULT"
|
|
798
798
|
// 1 - "GENERAL_FAULT"
|
|
799
799
|
|
|
800
|
-
"
|
|
800
|
+
"statusTampered": "NOT_TAMPERED", // 0 - "NOT_TAMPERED"
|
|
801
801
|
// 1 - "TAMPERED"
|
|
802
802
|
|
|
803
|
-
"
|
|
803
|
+
"statusLowBattery": "BATTERY_LEVEL_NORMAL", // 0 - "BATTERY_LEVEL_NORMAL"
|
|
804
804
|
// 1 - "BATTERY_LEVEL_LOW"
|
|
805
805
|
|
|
806
|
-
"
|
|
806
|
+
"name": "My_LightSensor",
|
|
807
807
|
|
|
808
|
-
"
|
|
808
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
809
809
|
|
|
810
|
-
"
|
|
810
|
+
"model": "Anything", // Available for all accessories
|
|
811
811
|
|
|
812
|
-
"
|
|
812
|
+
"serialNumber": "12345", // Available for all accessories
|
|
813
813
|
|
|
814
814
|
// Cmd4 Specific
|
|
815
|
-
"
|
|
816
|
-
//"
|
|
815
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
816
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
817
817
|
},
|
|
818
818
|
{
|
|
819
|
-
"
|
|
820
|
-
"
|
|
819
|
+
"type": "MotionSensor",
|
|
820
|
+
"displayName": "My_MotionSensor", // Not a characteristic, but a function parameter
|
|
821
821
|
|
|
822
822
|
// Required Characteristics
|
|
823
|
-
"
|
|
823
|
+
"motionDetected": "FALSE", // 0 - "FALSE"
|
|
824
824
|
// 1 - "TRUE"
|
|
825
825
|
|
|
826
826
|
// Optional Characteristics
|
|
827
|
-
"
|
|
827
|
+
"statusActive": "TRUE", // 0 - "FALSE"
|
|
828
828
|
// 1 - "TRUE"
|
|
829
829
|
|
|
830
|
-
"
|
|
830
|
+
"statusFault": "NO_FAULT", // 0 - "NO_FAULT"
|
|
831
831
|
// 1 - "GENERAL_FAULT"
|
|
832
832
|
|
|
833
|
-
"
|
|
833
|
+
"statusTampered": "NOT_TAMPERED", // 0 - "NOT_TAMPERED"
|
|
834
834
|
// 1 - "TAMPERED"
|
|
835
835
|
|
|
836
|
-
"
|
|
836
|
+
"statusLowBattery": "BATTERY_LEVEL_NORMAL", // 0 - "BATTERY_LEVEL_NORMAL"
|
|
837
837
|
// 1 - "BATTERY_LEVEL_LOW"
|
|
838
838
|
|
|
839
|
-
"
|
|
839
|
+
"name": "My_MotionSensor",
|
|
840
840
|
|
|
841
|
-
"
|
|
841
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
842
842
|
|
|
843
|
-
"
|
|
843
|
+
"model": "Anything", // Available for all accessories
|
|
844
844
|
|
|
845
|
-
"
|
|
845
|
+
"serialNumber": "12345", // Available for all accessories
|
|
846
846
|
|
|
847
847
|
// Cmd4 Specific
|
|
848
|
-
"
|
|
849
|
-
//"
|
|
848
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
849
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
850
850
|
},
|
|
851
851
|
{
|
|
852
|
-
"
|
|
853
|
-
"
|
|
852
|
+
"type": "OccupancySensor",
|
|
853
|
+
"displayName": "My_OccupancySensor", // Not a characteristic, but a function parameter
|
|
854
854
|
|
|
855
855
|
// Required Characteristics
|
|
856
|
-
"
|
|
856
|
+
"occupancyDetected": "OCCUPANCY_NOT_DETECTED", // 0 - "OCCUPANCY_NOT_DETECTED"
|
|
857
857
|
// 1 - "OCCUPANCY_DETECTED"
|
|
858
858
|
|
|
859
859
|
// Optional Characteristics
|
|
860
|
-
"
|
|
860
|
+
"statusActive": "TRUE", // 0 - "FALSE"
|
|
861
861
|
// 1 - "TRUE"
|
|
862
862
|
|
|
863
|
-
"
|
|
863
|
+
"statusFault": "NO_FAULT", // 0 - "NO_FAULT"
|
|
864
864
|
// 1 - "GENERAL_FAULT"
|
|
865
865
|
|
|
866
|
-
"
|
|
866
|
+
"statusTampered": "NOT_TAMPERED", // 0 - "NOT_TAMPERED"
|
|
867
867
|
// 1 - "TAMPERED"
|
|
868
868
|
|
|
869
|
-
"
|
|
869
|
+
"statusLowBattery": "BATTERY_LEVEL_NORMAL", // 0 - "BATTERY_LEVEL_NORMAL"
|
|
870
870
|
// 1 - "BATTERY_LEVEL_LOW"
|
|
871
871
|
|
|
872
|
-
"
|
|
872
|
+
"name": "My_OccupancySensor",
|
|
873
873
|
|
|
874
|
-
"
|
|
874
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
875
875
|
|
|
876
|
-
"
|
|
876
|
+
"model": "Anything", // Available for all accessories
|
|
877
877
|
|
|
878
|
-
"
|
|
878
|
+
"serialNumber": "12345", // Available for all accessories
|
|
879
879
|
|
|
880
880
|
// Cmd4 Specific
|
|
881
|
-
"
|
|
882
|
-
//"
|
|
881
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
882
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
883
883
|
},
|
|
884
884
|
{
|
|
885
|
-
"
|
|
886
|
-
"
|
|
885
|
+
"type": "SmokeSensor",
|
|
886
|
+
"displayName": "My_SmokeSensor", // Not a characteristic, but a function parameter
|
|
887
887
|
|
|
888
888
|
// Required Characteristics
|
|
889
|
-
"
|
|
889
|
+
"smokeDetected": "SMOKE_NOT_DETECTED", // 0 - "SMOKE_NOT_DETECTED"
|
|
890
890
|
// 1 - "SMOKE_DETECTED"
|
|
891
891
|
|
|
892
892
|
// Optional Characteristics
|
|
893
|
-
"
|
|
893
|
+
"statusActive": "TRUE", // 0 - "FALSE"
|
|
894
894
|
// 1 - "TRUE"
|
|
895
895
|
|
|
896
|
-
"
|
|
896
|
+
"statusFault": "NO_FAULT", // 0 - "NO_FAULT"
|
|
897
897
|
// 1 - "GENERAL_FAULT"
|
|
898
898
|
|
|
899
|
-
"
|
|
899
|
+
"statusTampered": "NOT_TAMPERED", // 0 - "NOT_TAMPERED"
|
|
900
900
|
// 1 - "TAMPERED"
|
|
901
901
|
|
|
902
|
-
"
|
|
902
|
+
"statusLowBattery": "BATTERY_LEVEL_NORMAL", // 0 - "BATTERY_LEVEL_NORMAL"
|
|
903
903
|
// 1 - "BATTERY_LEVEL_LOW"
|
|
904
904
|
|
|
905
|
-
"
|
|
905
|
+
"name": "My_SmokeSensor",
|
|
906
906
|
|
|
907
|
-
"
|
|
907
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
908
908
|
|
|
909
|
-
"
|
|
909
|
+
"model": "Anything", // Available for all accessories
|
|
910
910
|
|
|
911
|
-
"
|
|
911
|
+
"serialNumber": "12345", // Available for all accessories
|
|
912
912
|
|
|
913
913
|
// Cmd4 Specific
|
|
914
|
-
"
|
|
915
|
-
//"
|
|
914
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
915
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
916
916
|
},
|
|
917
917
|
{
|
|
918
|
-
"
|
|
919
|
-
"
|
|
918
|
+
"type": "StatefulProgrammableSwitch",
|
|
919
|
+
"displayName": "My_StatefulProgrammableSwitch",
|
|
920
920
|
// Not a characteristic, but a function parameter
|
|
921
921
|
|
|
922
922
|
// Required Characteristics
|
|
923
|
-
"
|
|
923
|
+
"programmableSwitchEvent": "SINGLE_PRESS", // 0 - "SINGLE_PRESS"
|
|
924
924
|
// 1 - "DOUBLE_PRESS"
|
|
925
925
|
// 2 - "LONG_PRESS"
|
|
926
926
|
|
|
927
|
-
"
|
|
927
|
+
"programmableSwitchOutputState":
|
|
928
928
|
0, // Range: 0-1, Step 1
|
|
929
929
|
// "Meaning": ???
|
|
930
930
|
|
|
931
931
|
// Optional Characteristics
|
|
932
|
-
"
|
|
932
|
+
"name": "My_StatefulProgrammableSwitch",
|
|
933
933
|
|
|
934
|
-
"
|
|
934
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
935
935
|
|
|
936
|
-
"
|
|
936
|
+
"model": "Anything", // Available for all accessories
|
|
937
937
|
|
|
938
|
-
"
|
|
938
|
+
"serialNumber": "12345", // Available for all accessories
|
|
939
939
|
|
|
940
940
|
// Cmd4 Specific
|
|
941
|
-
"
|
|
942
|
-
//"
|
|
941
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
942
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
943
943
|
},
|
|
944
944
|
{
|
|
945
|
-
"
|
|
946
|
-
"
|
|
945
|
+
"type": "StatelessProgrammableSwitch",
|
|
946
|
+
"displayName": "My_StatelessProgrammableSwitch",
|
|
947
947
|
// Not a characteristic, but a function parameter
|
|
948
948
|
|
|
949
949
|
// Required Characteristics
|
|
950
|
-
"
|
|
950
|
+
"programmableSwitchEvent": "SINGLE_PRESS",
|
|
951
951
|
// 0 - "SINGLE_PRESS"
|
|
952
952
|
// 1 - "DOUBLE_PRESS"
|
|
953
953
|
// 2 - "LONG_PRESS"
|
|
954
954
|
|
|
955
955
|
// Optional Characteristics
|
|
956
|
-
"
|
|
956
|
+
"name": "My_StatelessProgrammableSwitch",
|
|
957
957
|
|
|
958
|
-
"
|
|
958
|
+
"serviceLabelIndex": 1, // Range: 1-255, Step: 1
|
|
959
959
|
|
|
960
|
-
"
|
|
960
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
961
961
|
|
|
962
|
-
"
|
|
962
|
+
"model": "Anything", // Available for all accessories
|
|
963
963
|
|
|
964
|
-
"
|
|
964
|
+
"serialNumber": "12345", // Available for all accessories
|
|
965
965
|
|
|
966
966
|
// Cmd4 Specific
|
|
967
|
-
"
|
|
968
|
-
//"
|
|
967
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
968
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
969
969
|
},
|
|
970
970
|
{
|
|
971
|
-
"
|
|
972
|
-
"
|
|
971
|
+
"type": "TemperatureSensor",
|
|
972
|
+
"displayName": "My_TemperatureSensor",
|
|
973
973
|
// Not a characteristic, but a function parameter
|
|
974
974
|
|
|
975
975
|
// Required Characteristics
|
|
976
|
-
"
|
|
976
|
+
"currentTemperature": 22.2, // Range: 0-100, Step: 0.1
|
|
977
977
|
// Format: float
|
|
978
978
|
// "Units": CELCIUS
|
|
979
979
|
|
|
980
980
|
// This characteristic is not available on a temperature sensor
|
|
981
981
|
// but configurable in homebridge-cmd4. How Homekit behaves is
|
|
982
982
|
// undeterministic. Eve however is more flexible.
|
|
983
|
-
"
|
|
983
|
+
"currentRelativeHumidity": 20, // Range: 0-100, Step: 1
|
|
984
984
|
// Format: float
|
|
985
985
|
// Units: Percentage
|
|
986
986
|
|
|
987
987
|
// Optional Characteristics
|
|
988
|
-
"
|
|
988
|
+
"statusActive": "TRUE", // 0 - "FALSE"
|
|
989
989
|
// 1 - "TRUE"
|
|
990
990
|
|
|
991
|
-
"
|
|
991
|
+
"statusFault": "NO_FAULT", // 0 - "NO_FAULT"
|
|
992
992
|
// 1 - "GENERAL_FAULT"
|
|
993
993
|
|
|
994
|
-
"
|
|
994
|
+
"statusTampered": "NOT_TAMPERED", // 0 - "NOT_TAMPERED"
|
|
995
995
|
// 1 - "TAMPERED"
|
|
996
996
|
|
|
997
|
-
"
|
|
997
|
+
"statusLowBattery": "BATTERY_LEVEL_NORMAL", // 0 - "BATTERY_LEVEL_NORMAL"
|
|
998
998
|
// 1 - "BATTERY_LEVEL_LOW"
|
|
999
999
|
|
|
1000
|
-
"
|
|
1000
|
+
"name": "My_TemperatureSensor",
|
|
1001
1001
|
|
|
1002
|
-
"
|
|
1002
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1003
1003
|
|
|
1004
|
-
"
|
|
1004
|
+
"model": "Anything", // Available for all accessories
|
|
1005
1005
|
|
|
1006
|
-
"
|
|
1006
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1007
1007
|
|
|
1008
1008
|
// Cmd4 Specific - Interval is in second, Timeout in msec
|
|
1009
|
-
// (
|
|
1009
|
+
// (polling per characteristic)
|
|
1010
1010
|
// Required as fakegato option below uses them.
|
|
1011
1011
|
|
|
1012
1012
|
// polling requires a state_cmd and state_cmd is
|
|
1013
1013
|
// used with your own scripts. Here for example only.
|
|
1014
|
-
//"
|
|
1014
|
+
//"polling":
|
|
1015
1015
|
//[
|
|
1016
|
-
// {"
|
|
1017
|
-
// {"
|
|
1016
|
+
// {"characteristic": "currentTemperature", "interval": 50, "timeout": 8000},
|
|
1017
|
+
// {"characteristic": "currentRelativeHumidity", "interval": 40, "timeout": 8000}
|
|
1018
1018
|
//],
|
|
1019
1019
|
|
|
1020
1020
|
// Cmd4 Specific (Fakegate )
|
|
1021
1021
|
// You must also define them for polling, or the value would never change.
|
|
1022
1022
|
// fakegato requires a state_cmd and state_cmd is
|
|
1023
1023
|
// used with your own scripts. Here for example only.
|
|
1024
|
-
//"
|
|
1025
|
-
// "
|
|
1026
|
-
// "
|
|
1027
|
-
// "
|
|
1028
|
-
// "
|
|
1029
|
-
// "
|
|
1030
|
-
// "
|
|
1024
|
+
//"fakegato": {"eve": "room",
|
|
1025
|
+
// "temp": "currentTemperature",
|
|
1026
|
+
// "humidity": "currentRelativeHumidity",
|
|
1027
|
+
// "storage": "fs",
|
|
1028
|
+
// "storagePath": ".homebridge/FakegatoStorage",
|
|
1029
|
+
// "folder": "folderName",
|
|
1030
|
+
// "keyPath": "/place/to/store/my/keys/"
|
|
1031
1031
|
// },
|
|
1032
1032
|
|
|
1033
1033
|
// Cmd4 Specific
|
|
1034
|
-
"
|
|
1035
|
-
//"
|
|
1034
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1035
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1036
1036
|
},
|
|
1037
1037
|
{
|
|
1038
|
-
"
|
|
1039
|
-
"
|
|
1038
|
+
"type": "Window",
|
|
1039
|
+
"displayName": "My_Window", // Not a characteristic, but a function parameter
|
|
1040
1040
|
|
|
1041
1041
|
// Required Characteristics
|
|
1042
|
-
"
|
|
1042
|
+
"currentPosition": 0, // Range: 0 - 100, Step 1
|
|
1043
1043
|
|
|
1044
|
-
"
|
|
1044
|
+
"targetPosition": 0, // Range: 0 - 100, Step 1
|
|
1045
1045
|
|
|
1046
|
-
"
|
|
1046
|
+
"positionState": "STOPPED", // 0 - "DECREASING"
|
|
1047
1047
|
// 1 - "INCREASING"
|
|
1048
1048
|
// 2 - "STOPPED"
|
|
1049
1049
|
|
|
1050
1050
|
// Optional Characteristics
|
|
1051
|
-
"
|
|
1051
|
+
"holdPosition": "FALSE", // 0 - "FALSE"
|
|
1052
1052
|
// 1 - "TRUE"
|
|
1053
1053
|
|
|
1054
|
-
"
|
|
1054
|
+
"obstructionDetected": "FALSE", // 0 - "FALSE"
|
|
1055
1055
|
// 1 - "TRUE"
|
|
1056
1056
|
|
|
1057
|
-
"
|
|
1058
|
-
"
|
|
1057
|
+
"name": "My_Window",
|
|
1058
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1059
1059
|
|
|
1060
|
-
"
|
|
1060
|
+
"model": "Anything", // Available for all accessories
|
|
1061
1061
|
|
|
1062
|
-
"
|
|
1062
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1063
1063
|
|
|
1064
1064
|
// Cmd4 Specific
|
|
1065
|
-
"
|
|
1066
|
-
//"
|
|
1065
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1066
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1067
1067
|
},
|
|
1068
1068
|
{
|
|
1069
|
-
"
|
|
1070
|
-
"
|
|
1069
|
+
"type": "WindowCovering",
|
|
1070
|
+
"displayName": "My_WindowCovering", // Not a characteristic, but a function parameter
|
|
1071
1071
|
|
|
1072
1072
|
// Required Characteristics
|
|
1073
|
-
"
|
|
1073
|
+
"currentPosition": 0, // Range: 0 - 100, Step 1
|
|
1074
1074
|
|
|
1075
|
-
"
|
|
1075
|
+
"targetPosition": 0, // Range: 0 - 100, Step 1
|
|
1076
1076
|
|
|
1077
|
-
"
|
|
1077
|
+
"positionState": "STOPPED", // 0 - "DECREASING"
|
|
1078
1078
|
// 1 - "INCREASING"
|
|
1079
1079
|
// 2 - "STOPPED"
|
|
1080
1080
|
|
|
1081
1081
|
// Optional Characteristics
|
|
1082
|
-
"
|
|
1082
|
+
"holdPosition": "FALSE", // 0 - "FALSE"
|
|
1083
1083
|
// 1 - "TRUE"
|
|
1084
1084
|
|
|
1085
|
-
"
|
|
1085
|
+
"currentHorizontalTiltAngle":0, // Range: -90 to 90, Step 1
|
|
1086
1086
|
// "Units": ARC_DEGREE
|
|
1087
1087
|
|
|
1088
|
-
"
|
|
1088
|
+
"targetHorizontalTiltAngle": 0, // Range: -90 to 90, Step 1
|
|
1089
1089
|
// "Units": ARC_DEGREE
|
|
1090
1090
|
|
|
1091
|
-
"
|
|
1091
|
+
"currentVerticalTiltAngle": 0, // Range: -90 to 90, Step 1
|
|
1092
1092
|
// "Units": ARC_DEGREE
|
|
1093
1093
|
|
|
1094
|
-
"
|
|
1094
|
+
"targetVerticalTiltAngle": 0, // Range: -90 to 90, Step 1
|
|
1095
1095
|
// "Units": ARC_DEGREE
|
|
1096
1096
|
|
|
1097
|
-
"
|
|
1097
|
+
"obstructionDetected": "FALSE", // 0 - "FALSE"
|
|
1098
1098
|
// 1 - "TRUE"
|
|
1099
1099
|
|
|
1100
|
-
"
|
|
1100
|
+
"name": "My_WindowCovering",
|
|
1101
1101
|
|
|
1102
|
-
"
|
|
1102
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1103
1103
|
|
|
1104
|
-
"
|
|
1104
|
+
"model": "Anything", // Available for all accessories
|
|
1105
1105
|
|
|
1106
|
-
"
|
|
1106
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1107
1107
|
|
|
1108
1108
|
// Cmd4 Specific
|
|
1109
|
-
"
|
|
1110
|
-
//"
|
|
1109
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1110
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1111
1111
|
},
|
|
1112
1112
|
{
|
|
1113
|
-
"
|
|
1114
|
-
"
|
|
1113
|
+
"type": "BatteryService",
|
|
1114
|
+
"displayName": "My_BatteryService", // Not a characteristic, but a function parameter
|
|
1115
1115
|
|
|
1116
1116
|
// Required Characteristics
|
|
1117
|
-
"
|
|
1117
|
+
"batteryLevel": 50, // Range: 0 - 100, Step 1
|
|
1118
1118
|
|
|
1119
|
-
"
|
|
1119
|
+
"chargingState": "NOT_CHARGING", // 0 - "NOT_CHARGING"
|
|
1120
1120
|
// 1 - "CHARGING"
|
|
1121
1121
|
// 2 - "NOT_CHARGEABLE"
|
|
1122
1122
|
|
|
1123
|
-
"
|
|
1123
|
+
"statusLowBattery": "BATTERY_LEVEL_NORMAL", // 0 - "BATTERY_LEVEL_NORMAL"
|
|
1124
1124
|
// 1 - "BATTERY_LEVEL_LOW"
|
|
1125
1125
|
|
|
1126
1126
|
// Optional Characteristics
|
|
1127
|
-
"
|
|
1127
|
+
"name": "My_BatteryService",
|
|
1128
1128
|
|
|
1129
|
-
"
|
|
1129
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1130
1130
|
|
|
1131
|
-
"
|
|
1131
|
+
"model": "Anything", // Available for all accessories
|
|
1132
1132
|
|
|
1133
|
-
"
|
|
1133
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1134
1134
|
|
|
1135
1135
|
// Cmd4 Specific
|
|
1136
|
-
"
|
|
1137
|
-
//"
|
|
1136
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1137
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1138
1138
|
},
|
|
1139
1139
|
{
|
|
1140
|
-
"
|
|
1141
|
-
"
|
|
1140
|
+
"type": "CarbonDioxideSensor",
|
|
1141
|
+
"displayName": "My_CO2_Sensor",
|
|
1142
1142
|
|
|
1143
1143
|
// Required Characteristics
|
|
1144
|
-
"
|
|
1144
|
+
"carbonDioxideDetected": "CO2_LEVELS_NORMAL", // 0 - "CO2_LEVELS_NORMAL"
|
|
1145
1145
|
// 1 - "CO2_LEVELS_ABNORMAL"
|
|
1146
1146
|
|
|
1147
1147
|
// Optional Characteristics
|
|
1148
|
-
"
|
|
1148
|
+
"statusActive": "TRUE", // 0 - "FALSE"
|
|
1149
1149
|
// 1 - "TRUE"
|
|
1150
1150
|
|
|
1151
|
-
"
|
|
1151
|
+
"statusFault": "NO_FAULT", // 0 - "NO_FAULT"
|
|
1152
1152
|
// 1 - "GENERAL_FAULT"
|
|
1153
1153
|
|
|
1154
|
-
"
|
|
1154
|
+
"statusTampered": "NOT_TAMPERED", // 0 - "NOT_TAMPERED"
|
|
1155
1155
|
// 1 - "TAMPERED"
|
|
1156
1156
|
|
|
1157
|
-
"
|
|
1157
|
+
"statusLowBattery": "BATTERY_LEVEL_NORMAL", // 0 - "BATTERY_LEVEL_NORMAL"
|
|
1158
1158
|
// 1 - "BATTERY_LEVEL_LOW"
|
|
1159
1159
|
|
|
1160
|
-
"
|
|
1160
|
+
"carbonDioxideLevel": 0, // Range: 0-100000
|
|
1161
1161
|
// "Format": float
|
|
1162
1162
|
|
|
1163
|
-
"
|
|
1163
|
+
"carbonDioxidePeakLevel": 0, // Range: 0-100000
|
|
1164
1164
|
// "Format": float
|
|
1165
1165
|
|
|
1166
|
-
"
|
|
1166
|
+
"name": "My_CO2_Sensor",
|
|
1167
1167
|
|
|
1168
|
-
"
|
|
1168
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1169
1169
|
|
|
1170
|
-
"
|
|
1170
|
+
"model": "Anything", // Available for all accessories
|
|
1171
1171
|
|
|
1172
|
-
"
|
|
1172
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1173
1173
|
|
|
1174
1174
|
// Cmd4 Specific
|
|
1175
1175
|
|
|
1176
1176
|
// polling requires a state_cmd and state_cmd is
|
|
1177
1177
|
// used with your own scripts. Here for example only.
|
|
1178
|
-
//"
|
|
1178
|
+
//"polling": false, // Default is false.
|
|
1179
1179
|
|
|
1180
|
-
"
|
|
1180
|
+
"interval": 540, // Interval is in seconds.
|
|
1181
1181
|
// Default is 10
|
|
1182
1182
|
|
|
1183
1183
|
// Cmd4 Specific
|
|
1184
|
-
"
|
|
1185
|
-
//"
|
|
1184
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1185
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1186
1186
|
},
|
|
1187
1187
|
// Not Possible in this implementation
|
|
1188
1188
|
// {
|
|
1189
|
-
// "
|
|
1190
|
-
// "
|
|
1189
|
+
// "type": "CameraRTPStreamManagement",
|
|
1190
|
+
// "name": "My_CameraRTPStreamManagement",
|
|
1191
1191
|
//
|
|
1192
1192
|
// // Cmd4 Specific
|
|
1193
|
-
// "
|
|
1194
|
-
// "
|
|
1193
|
+
// "stateChangeResponseTime": 1, // Default (Seconds)
|
|
1194
|
+
// "state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1195
1195
|
// },
|
|
1196
1196
|
{
|
|
1197
|
-
"
|
|
1198
|
-
"
|
|
1197
|
+
"type": "Microphone",
|
|
1198
|
+
"displayName": "My_Microphone", // Not a characteristic, but a function parameter
|
|
1199
1199
|
|
|
1200
1200
|
// Required Characteristics
|
|
1201
|
-
"
|
|
1201
|
+
"mute": "FALSE", // 0 - "FALSE" (Off)
|
|
1202
1202
|
// 1 - "TRUE" (On)
|
|
1203
1203
|
|
|
1204
1204
|
// Optional Characteristics
|
|
1205
|
-
"
|
|
1205
|
+
"volume": 5, // Range: 0-100, Step 1
|
|
1206
1206
|
|
|
1207
|
-
"
|
|
1207
|
+
"name": "My_Microphone",
|
|
1208
1208
|
|
|
1209
|
-
"
|
|
1209
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1210
1210
|
|
|
1211
|
-
"
|
|
1211
|
+
"model": "Anything", // Available for all accessories
|
|
1212
1212
|
|
|
1213
|
-
"
|
|
1213
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1214
1214
|
|
|
1215
1215
|
// Cmd4 Specific
|
|
1216
|
-
"
|
|
1217
|
-
// "
|
|
1216
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1217
|
+
// "state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1218
1218
|
},
|
|
1219
1219
|
{
|
|
1220
|
-
"
|
|
1221
|
-
"
|
|
1220
|
+
"type": "Speaker",
|
|
1221
|
+
"displayName": "My_Speaker",
|
|
1222
1222
|
|
|
1223
1223
|
// Required Characteristics
|
|
1224
|
-
"
|
|
1224
|
+
"mute": "FALSE", // 0 - "FALSE" (Off)
|
|
1225
1225
|
// 1 - "TRUE" (On)
|
|
1226
1226
|
|
|
1227
1227
|
// Optional Characteristics
|
|
1228
|
-
"
|
|
1228
|
+
"volume": 5, // Range: 0-100, Step 1
|
|
1229
1229
|
|
|
1230
|
-
"
|
|
1230
|
+
"name": "My_Speaker",
|
|
1231
1231
|
|
|
1232
|
-
"
|
|
1232
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1233
1233
|
|
|
1234
|
-
"
|
|
1234
|
+
"model": "Anything", // Available for all accessories
|
|
1235
1235
|
|
|
1236
|
-
"
|
|
1236
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1237
1237
|
|
|
1238
1238
|
// Cmd4 Specific
|
|
1239
|
-
"
|
|
1240
|
-
//"
|
|
1239
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1240
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1241
1241
|
},
|
|
1242
1242
|
{
|
|
1243
|
-
"
|
|
1244
|
-
"
|
|
1243
|
+
"type": "DoorBell",
|
|
1244
|
+
"displayName": "My_DoorBell", // Not a characteristic, but a function parameter
|
|
1245
1245
|
|
|
1246
1246
|
// Required Characteristics
|
|
1247
|
-
"
|
|
1247
|
+
"programmableSwitchEvent": "SINGLE_PRESS", // 0 - "SINGLE_PRESS"
|
|
1248
1248
|
// 1 - "DOUBLE_PRESS"
|
|
1249
1249
|
// 2 - "LONG_PRESS"
|
|
1250
1250
|
|
|
1251
1251
|
// Optional Characteristics
|
|
1252
|
-
"
|
|
1252
|
+
"brightness": 8, // Range: 0-100, Step: 1
|
|
1253
1253
|
|
|
1254
|
-
"
|
|
1254
|
+
"volume": 5, // Range: 0-100, Step 1
|
|
1255
1255
|
|
|
1256
|
-
"
|
|
1256
|
+
"name": "My_DoorBell",
|
|
1257
1257
|
|
|
1258
|
-
"
|
|
1258
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1259
1259
|
|
|
1260
|
-
"
|
|
1260
|
+
"model": "Anything", // Available for all accessories
|
|
1261
1261
|
|
|
1262
|
-
"
|
|
1262
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1263
1263
|
|
|
1264
1264
|
// Cmd4 Specific
|
|
1265
|
-
"
|
|
1266
|
-
//"
|
|
1265
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1266
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1267
1267
|
},
|
|
1268
1268
|
{
|
|
1269
|
-
"
|
|
1270
|
-
"
|
|
1269
|
+
"type": "Slat",
|
|
1270
|
+
"displayName": "My_Slat", // Not a characteristic, but a function parameter
|
|
1271
1271
|
|
|
1272
1272
|
// Required Characteristics
|
|
1273
|
-
"
|
|
1273
|
+
"slatType": "HORIZONTAL", // 0 - "HORIZONTAL"
|
|
1274
1274
|
// 1 - VERTICAL"
|
|
1275
1275
|
|
|
1276
|
-
"
|
|
1276
|
+
"currentSlatState": "FIXED", // 0 - "FIXED"
|
|
1277
1277
|
// 1 - "JAMMED"
|
|
1278
1278
|
// 2 - "SWINGING"
|
|
1279
1279
|
|
|
1280
1280
|
// Optional Characteristics
|
|
1281
|
-
"
|
|
1281
|
+
"name": "My_Slat",
|
|
1282
1282
|
|
|
1283
|
-
"
|
|
1283
|
+
"currentTiltAngle": 0, // Range: -90 to 90, Step 1
|
|
1284
1284
|
// "Units": ARC_DEGREE
|
|
1285
1285
|
|
|
1286
|
-
"
|
|
1286
|
+
"targetTiltAngle": 0, // Range: -90 to 90, Step 1
|
|
1287
1287
|
// "Units": ARC_DEGREE
|
|
1288
1288
|
|
|
1289
|
-
"
|
|
1289
|
+
"swingMode": "SWING_ENABLED", // 0 - "SWING_DISABLED"
|
|
1290
1290
|
// 1 - "SWING_ENABLED"
|
|
1291
1291
|
|
|
1292
|
-
"
|
|
1292
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1293
1293
|
|
|
1294
|
-
"
|
|
1294
|
+
"model": "Anything", // Available for all accessories
|
|
1295
1295
|
|
|
1296
|
-
"
|
|
1296
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1297
1297
|
|
|
1298
1298
|
// Cmd4 Specific
|
|
1299
1299
|
// polling requires a state_cmd and state_cmd is
|
|
1300
1300
|
// used with your own scripts. Here for example only.
|
|
1301
|
-
//"
|
|
1302
|
-
"
|
|
1301
|
+
//"polling": false, // Default is false.
|
|
1302
|
+
"interval": 540, // Interval is in seconds. Default is 10
|
|
1303
1303
|
|
|
1304
1304
|
// Cmd4 Specific
|
|
1305
|
-
"
|
|
1306
|
-
//"
|
|
1305
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1306
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1307
1307
|
},
|
|
1308
1308
|
{
|
|
1309
|
-
"
|
|
1310
|
-
"
|
|
1309
|
+
"type": "FilterMaintenance",
|
|
1310
|
+
"displayName": "My_FilterMaintenance", // Not a characteristic, but a function parameter
|
|
1311
1311
|
|
|
1312
1312
|
// Required Characteristics
|
|
1313
|
-
"
|
|
1313
|
+
"filterChangeIndication": "FILTER_OK",
|
|
1314
1314
|
// 0 - "FILTER_OK"
|
|
1315
1315
|
// 1 - "CHANGE_FILTER"
|
|
1316
1316
|
|
|
1317
1317
|
|
|
1318
1318
|
// Optional Characteristics
|
|
1319
|
-
"
|
|
1319
|
+
"filterLifeLevel": 50, // Range: 0-100
|
|
1320
1320
|
// "Format": float
|
|
1321
|
-
"
|
|
1321
|
+
"resetFilterIndication": 1, // Range: 1 - ???
|
|
1322
1322
|
|
|
1323
|
-
"
|
|
1323
|
+
"name": "My_FilterMaintenance",
|
|
1324
1324
|
|
|
1325
|
-
"
|
|
1325
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1326
1326
|
|
|
1327
|
-
"
|
|
1327
|
+
"model": "Anything", // Available for all accessories
|
|
1328
1328
|
|
|
1329
|
-
"
|
|
1329
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1330
1330
|
|
|
1331
1331
|
// Cmd4 Specific
|
|
1332
|
-
"
|
|
1333
|
-
//"
|
|
1332
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1333
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1334
1334
|
},
|
|
1335
1335
|
{
|
|
1336
|
-
"
|
|
1337
|
-
"
|
|
1336
|
+
"type": "AirPurifier",
|
|
1337
|
+
"displayName": "My_AirPurifier", // Not a characteristic, but a function parameter
|
|
1338
1338
|
|
|
1339
1339
|
// Required Characteristics
|
|
1340
|
-
"
|
|
1340
|
+
"active": "ACTIVE", // 0 - "INACTIVE"
|
|
1341
1341
|
// 1 - "ACTIVE"
|
|
1342
1342
|
|
|
1343
|
-
"
|
|
1343
|
+
"currentAirPurifierState": "INACTIVE", // 0 - "INACTIVE"
|
|
1344
1344
|
// 1 - "IDLE"
|
|
1345
1345
|
// 2 - "PURIFYING_AIR"
|
|
1346
1346
|
|
|
1347
|
-
"
|
|
1347
|
+
"targetAirPurifierState": "MANUAL", // 0 - "MANUAL"
|
|
1348
1348
|
// 1 - "AUTO"
|
|
1349
1349
|
|
|
1350
1350
|
|
|
1351
1351
|
// Optional Characteristics
|
|
1352
|
-
"
|
|
1352
|
+
"lockPhysicalControls": "CONTROL_LOCK_DISABLED", // 0 - "CONTROL_LOCK_DISABLED"
|
|
1353
1353
|
// 1 - "CONTROL_LOCK_ENABLED"
|
|
1354
1354
|
|
|
1355
|
-
"
|
|
1355
|
+
"name": "My_AirPurifier",
|
|
1356
1356
|
|
|
1357
|
-
"
|
|
1357
|
+
"swingMode": "SWING_DISABLED",
|
|
1358
1358
|
// 0 - "SWING_DISABLED"
|
|
1359
1359
|
// 1 - "SWING_ENABLED"
|
|
1360
1360
|
|
|
1361
|
-
"
|
|
1361
|
+
"rotationSpeed": 0, // Range: 0 - 100, Step 1
|
|
1362
1362
|
|
|
1363
|
-
"
|
|
1363
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1364
1364
|
|
|
1365
|
-
"
|
|
1365
|
+
"model": "Anything", // Available for all accessories
|
|
1366
1366
|
|
|
1367
|
-
"
|
|
1367
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1368
1368
|
|
|
1369
1369
|
// Cmd4 Specific
|
|
1370
|
-
"
|
|
1371
|
-
//"
|
|
1370
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1371
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1372
1372
|
},
|
|
1373
1373
|
{
|
|
1374
|
-
"
|
|
1375
|
-
"
|
|
1374
|
+
"type": "ServiceLabel",
|
|
1375
|
+
"displayName": "My_ServiceLabel", // Not a characteristic, but a function parameter
|
|
1376
1376
|
|
|
1377
1377
|
// Required Characteristics
|
|
1378
|
-
"
|
|
1378
|
+
"serviceLabelNamespace": "DOTS", // 0 - "DOTS"
|
|
1379
1379
|
// 1 - "ARABIC_NUMERALS"
|
|
1380
1380
|
|
|
1381
1381
|
// Optional Characteristics
|
|
1382
|
-
"
|
|
1382
|
+
"name": "My_ServiceLabel",
|
|
1383
1383
|
|
|
1384
|
-
"
|
|
1384
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1385
1385
|
|
|
1386
|
-
"
|
|
1386
|
+
"model": "Anything", // Available for all accessories
|
|
1387
1387
|
|
|
1388
|
-
"
|
|
1388
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1389
1389
|
|
|
1390
1390
|
// Cmd4 Specific
|
|
1391
|
-
"
|
|
1392
|
-
//"
|
|
1391
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1392
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1393
1393
|
},
|
|
1394
1394
|
{
|
|
1395
|
-
"
|
|
1396
|
-
"
|
|
1395
|
+
"type": "Television",
|
|
1396
|
+
"displayName": "Tv_Combo", // Not a characteristic, but a function parameter
|
|
1397
1397
|
|
|
1398
1398
|
// Televisions should be published externally to get the icon
|
|
1399
|
-
"
|
|
1400
|
-
"
|
|
1399
|
+
"publishExternally": true,
|
|
1400
|
+
"category": "TELEVISION", // The hint to Homekit of which icon to use.
|
|
1401
1401
|
|
|
1402
1402
|
// Required characteristics
|
|
1403
|
-
"
|
|
1403
|
+
"active": "ACTIVE", // 0 - "INACTIVE"
|
|
1404
1404
|
// 1 - "ACTIVE"
|
|
1405
1405
|
|
|
1406
|
-
"
|
|
1406
|
+
"activeIdentifier": 1, // This is which inputSource is active
|
|
1407
1407
|
// We gave HDMI2 the identifier of 1.
|
|
1408
1408
|
// Format: UINT32
|
|
1409
1409
|
|
|
1410
|
-
"
|
|
1410
|
+
"configuredName": "TV_Combo",
|
|
1411
1411
|
|
|
1412
|
-
"
|
|
1412
|
+
"sleepDiscoveryMode": "ALWAYS_DISCOVERABLE", // 0 - "NOT_DISCOVERABLE"
|
|
1413
1413
|
// 1 - "ALWAYS_DISCOVERABLE"
|
|
1414
1414
|
|
|
1415
|
-
"
|
|
1415
|
+
"linkedTypes":
|
|
1416
1416
|
[
|
|
1417
1417
|
{
|
|
1418
|
-
"
|
|
1419
|
-
"
|
|
1418
|
+
"type": "InputSource",
|
|
1419
|
+
"displayName": "HDMI1", // Not a characteristic, but a function parameter
|
|
1420
1420
|
|
|
1421
1421
|
// Required Characteristics
|
|
1422
|
-
"
|
|
1423
|
-
"
|
|
1424
|
-
"
|
|
1425
|
-
"
|
|
1422
|
+
"configuredName": "HDMI1",
|
|
1423
|
+
"currentVisibilityState": "SHOWN",
|
|
1424
|
+
"inputSourceType": "HDMI",
|
|
1425
|
+
"isConfigured": "CONFIGURED",
|
|
1426
1426
|
|
|
1427
1427
|
// Optional Characteristics
|
|
1428
|
-
"
|
|
1428
|
+
"identifier": 1, // Selector for activeIdentifier
|
|
1429
1429
|
// Format: UINT32
|
|
1430
1430
|
|
|
1431
1431
|
//"InputDeviceType": "TUNER", // 0 - "OTHER"
|
|
@@ -1436,33 +1436,33 @@
|
|
|
1436
1436
|
// 5 - "AUDIO_SYSTEM"
|
|
1437
1437
|
// 6 - "UNKNOWN_6" (Added in IOS 14)
|
|
1438
1438
|
|
|
1439
|
-
"
|
|
1439
|
+
"targetVisibilityState": "SHOWN", // 0 - "SHOWN"
|
|
1440
1440
|
// 1 - "HIDDEN"
|
|
1441
1441
|
// 2 - "STOP"
|
|
1442
1442
|
|
|
1443
|
-
"
|
|
1443
|
+
"name": "HDMI1",
|
|
1444
1444
|
|
|
1445
|
-
"
|
|
1445
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1446
1446
|
|
|
1447
|
-
"
|
|
1447
|
+
"model": "Anything", // Available for all accessories
|
|
1448
1448
|
|
|
1449
|
-
"
|
|
1449
|
+
"serialNumber": "12345" // Available for all accessories
|
|
1450
1450
|
|
|
1451
1451
|
},
|
|
1452
|
-
{ "
|
|
1453
|
-
"
|
|
1452
|
+
{ "type": "InputSource",
|
|
1453
|
+
"displayName": "HDMI2", // Not a characteristic, but a function parameter
|
|
1454
1454
|
|
|
1455
1455
|
// Required Characteristics
|
|
1456
|
-
"
|
|
1457
|
-
"
|
|
1458
|
-
"
|
|
1459
|
-
"
|
|
1456
|
+
"configuredName": "HDMI2",
|
|
1457
|
+
"currentVisibilityState": "SHOWN",
|
|
1458
|
+
"inputSourceType": "HDMI",
|
|
1459
|
+
"isConfigured": "CONFIGURED",
|
|
1460
1460
|
|
|
1461
1461
|
// Optional Characteristics
|
|
1462
|
-
"
|
|
1462
|
+
"identifier": 2, // Selector for activeIdentifier
|
|
1463
1463
|
// Format: UINT32
|
|
1464
1464
|
|
|
1465
|
-
//"
|
|
1465
|
+
//"inputDeviceType": // "TUNER",
|
|
1466
1466
|
// 0 - "OTHER"
|
|
1467
1467
|
// 1 - "TV"
|
|
1468
1468
|
// 2 - "RECORDING"
|
|
@@ -1470,30 +1470,30 @@
|
|
|
1470
1470
|
// 4 - "PLAYBACK"
|
|
1471
1471
|
// 5 - "AUDIO_SYSTEM"
|
|
1472
1472
|
|
|
1473
|
-
"
|
|
1473
|
+
"targetVisibilityState": "SHOWN", // 0 - "SHOWN"
|
|
1474
1474
|
// 1 - "HIDDEN"
|
|
1475
1475
|
// 2 - "STOP"
|
|
1476
1476
|
|
|
1477
|
-
"
|
|
1477
|
+
"name": "HDMI2",
|
|
1478
1478
|
|
|
1479
|
-
"
|
|
1479
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1480
1480
|
|
|
1481
|
-
"
|
|
1481
|
+
"model": "Anything", // Available for all accessories
|
|
1482
1482
|
|
|
1483
|
-
"
|
|
1483
|
+
"serialNumber": "12345" // Available for all accessories
|
|
1484
1484
|
|
|
1485
1485
|
},
|
|
1486
|
-
{ "
|
|
1487
|
-
"
|
|
1486
|
+
{ "type": "InputSource",
|
|
1487
|
+
"displayName": "HDMI3", // Not a characteristic, but a function parameter
|
|
1488
1488
|
|
|
1489
1489
|
// Required Characteristics
|
|
1490
|
-
"
|
|
1491
|
-
"
|
|
1492
|
-
"
|
|
1493
|
-
"
|
|
1490
|
+
"configuredName": "HDMI3",
|
|
1491
|
+
"currentVisibilityState": "SHOWN",
|
|
1492
|
+
"inputSourceType": "HDMI",
|
|
1493
|
+
"isConfigured": "CONFIGURED",
|
|
1494
1494
|
|
|
1495
1495
|
// Optional Characteristics
|
|
1496
|
-
"
|
|
1496
|
+
"identifier": 3, // Selector for activeIdentifier
|
|
1497
1497
|
// Format: UINT32
|
|
1498
1498
|
|
|
1499
1499
|
//"InputDeviceType": // "TUNER",
|
|
@@ -1504,121 +1504,121 @@
|
|
|
1504
1504
|
// 4 - "PLAYBACK"
|
|
1505
1505
|
// 5 - "AUDIO_SYSTEM"
|
|
1506
1506
|
|
|
1507
|
-
"
|
|
1507
|
+
"targetVisibilityState": "SHOWN", // 0 - "SHOWN"
|
|
1508
1508
|
// 1 - "HIDDEN"
|
|
1509
1509
|
// 2 - "STOP"
|
|
1510
1510
|
|
|
1511
|
-
"
|
|
1511
|
+
"name": "HDMI3",
|
|
1512
1512
|
|
|
1513
|
-
"
|
|
1513
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1514
1514
|
|
|
1515
|
-
"
|
|
1515
|
+
"model": "Anything", // Available for all accessories
|
|
1516
1516
|
|
|
1517
|
-
"
|
|
1517
|
+
"serialNumber": "12345" // Available for all accessories
|
|
1518
1518
|
|
|
1519
1519
|
},
|
|
1520
|
-
{ "
|
|
1521
|
-
"
|
|
1520
|
+
{ "type": "InputSource",
|
|
1521
|
+
"displayName": "HDMI4", // Not a characteristic, but a function parameter
|
|
1522
1522
|
|
|
1523
1523
|
// Required Characteristics
|
|
1524
|
-
"
|
|
1525
|
-
"
|
|
1526
|
-
"
|
|
1527
|
-
"
|
|
1524
|
+
"configuredName": "HDMI4",
|
|
1525
|
+
"currentVisibilityState": "SHOWN",
|
|
1526
|
+
"inputSourceType": "HDMI",
|
|
1527
|
+
"isConfigured": "CONFIGURED",
|
|
1528
1528
|
|
|
1529
1529
|
// Optional Characteristics
|
|
1530
|
-
"
|
|
1530
|
+
"identifier": 4, // Selector for activeIdentifier
|
|
1531
1531
|
// Format: UINT32
|
|
1532
1532
|
|
|
1533
|
-
//"
|
|
1533
|
+
//"inputDeviceType": "TUNER", // 0 - "OTHER"
|
|
1534
1534
|
// 1 - "TV"
|
|
1535
1535
|
// 2 - "RECORDING"
|
|
1536
1536
|
// 3 - "TUNER"
|
|
1537
1537
|
// 4 - "PLAYBACK"
|
|
1538
1538
|
// 5 - "AUDIO_SYSTEM"
|
|
1539
1539
|
|
|
1540
|
-
"
|
|
1540
|
+
"targetVisibilityState": "SHOWN", // 0 - "SHOWN"
|
|
1541
1541
|
// 1 - "HIDDEN"
|
|
1542
1542
|
// 2 - "STOP"
|
|
1543
1543
|
|
|
1544
|
-
"
|
|
1544
|
+
"name": "HDMI4",
|
|
1545
1545
|
|
|
1546
|
-
"
|
|
1546
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1547
1547
|
|
|
1548
|
-
"
|
|
1548
|
+
"model": "Anything", // Available for all accessories
|
|
1549
1549
|
|
|
1550
|
-
"
|
|
1550
|
+
"serialNumber": "12345" // Available for all accessories
|
|
1551
1551
|
|
|
1552
1552
|
},
|
|
1553
|
-
{ "
|
|
1554
|
-
"
|
|
1553
|
+
{ "type": "InputSource",
|
|
1554
|
+
"displayName": "Netflix", // Not a characteristic, but a function parameter
|
|
1555
1555
|
|
|
1556
1556
|
// Required Characteristics
|
|
1557
|
-
"
|
|
1558
|
-
"
|
|
1559
|
-
"
|
|
1560
|
-
"
|
|
1557
|
+
"configuredName": "Netflix",
|
|
1558
|
+
"currentVisibilityState": "SHOWN",
|
|
1559
|
+
"inputSourceType": "APPLICATION",
|
|
1560
|
+
"isConfigured": "CONFIGURED",
|
|
1561
1561
|
|
|
1562
1562
|
// Optional Characteristics
|
|
1563
|
-
"
|
|
1563
|
+
"identifier": 5, // Selector for activeIdentifier
|
|
1564
1564
|
// Format: UINT32
|
|
1565
1565
|
|
|
1566
|
-
// "
|
|
1566
|
+
// "inputDeviceType": "OTHER", // 0 - "OTHER"
|
|
1567
1567
|
// 1 - "TV"
|
|
1568
1568
|
// 2 - "RECORDING"
|
|
1569
1569
|
// 3 - "TUNER"
|
|
1570
1570
|
// 4 - "PLAYBACK"
|
|
1571
1571
|
// 5 - "AUDIO_SYSTEM"
|
|
1572
1572
|
|
|
1573
|
-
"
|
|
1573
|
+
"targetVisibilityState": "SHOWN", // 0 - "SHOWN"
|
|
1574
1574
|
// 1 - "HIDDEN"
|
|
1575
1575
|
// 2 - "STOP"
|
|
1576
1576
|
|
|
1577
|
-
"
|
|
1577
|
+
"name": "Netflix",
|
|
1578
1578
|
|
|
1579
|
-
"
|
|
1579
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1580
1580
|
|
|
1581
|
-
"
|
|
1581
|
+
"model": "Anything", // Available for all accessories
|
|
1582
1582
|
|
|
1583
|
-
"
|
|
1583
|
+
"serialNumber": "12345" // Available for all accessories
|
|
1584
1584
|
},
|
|
1585
|
-
{ "
|
|
1586
|
-
"
|
|
1585
|
+
{ "type": "TelevisionSpeaker",
|
|
1586
|
+
"displayName": "TVSpeaker", // Not a characteristic, but a function parameter
|
|
1587
1587
|
|
|
1588
1588
|
// Required Characteristics
|
|
1589
|
-
"
|
|
1589
|
+
"mute": "FALSE",
|
|
1590
1590
|
|
|
1591
1591
|
// Optional Characteristics
|
|
1592
|
-
"
|
|
1592
|
+
"active": "ACTIVE", // 0 - "INACTIVE"
|
|
1593
1593
|
// 1 - "ACTIVE"
|
|
1594
1594
|
|
|
1595
1595
|
|
|
1596
|
-
"
|
|
1596
|
+
"volume": 10, // Range: 0-100, Step 1
|
|
1597
1597
|
|
|
1598
|
-
"
|
|
1598
|
+
"volumeControlType": "ABSOLUTE", // 0 - "NONE"
|
|
1599
1599
|
// 1 - "RELATIVE"
|
|
1600
1600
|
// 2 - "RELATIVE_WITH_CURRENT"
|
|
1601
1601
|
// 3 - "ABSOLUTE"
|
|
1602
1602
|
|
|
1603
|
-
"
|
|
1603
|
+
"volumeSelector": "INCREMENT", // 0 - "INCREMENT"
|
|
1604
1604
|
// 1 - "DECREMENT"
|
|
1605
1605
|
|
|
1606
|
-
"
|
|
1606
|
+
"name": "TVSpeaker",
|
|
1607
1607
|
|
|
1608
|
-
"
|
|
1608
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1609
1609
|
|
|
1610
|
-
"
|
|
1610
|
+
"model": "Anything", // Available for all accessories
|
|
1611
1611
|
|
|
1612
|
-
"
|
|
1612
|
+
"serialNumber": "12345" // Available for all accessories
|
|
1613
1613
|
|
|
1614
1614
|
|
|
1615
1615
|
}
|
|
1616
1616
|
],
|
|
1617
1617
|
|
|
1618
1618
|
// Optional Characteristics
|
|
1619
|
-
"
|
|
1619
|
+
"brightness": 8, // Range: 0-100, Step: 1
|
|
1620
1620
|
|
|
1621
|
-
"
|
|
1621
|
+
"closedCaptions": "DISABLED",
|
|
1622
1622
|
// 0 - "DISABLED,
|
|
1623
1623
|
// 1 - "ENABLED
|
|
1624
1624
|
|
|
@@ -1628,17 +1628,17 @@
|
|
|
1628
1628
|
// to not allow you to connect.
|
|
1629
1629
|
// "DisplayOrder": 0, // Format: TLV8
|
|
1630
1630
|
|
|
1631
|
-
"
|
|
1631
|
+
"currentMediaState": "STOP", // 0 - "PLAY"
|
|
1632
1632
|
// 1 - "PAUSE"
|
|
1633
1633
|
// 2 - "STOP"
|
|
1634
1634
|
// 3 - ???
|
|
1635
1635
|
|
|
1636
|
-
"
|
|
1636
|
+
"targetMediaState": "STOP", // 0 - "PLAY"
|
|
1637
1637
|
// 1 - "PAUSE"
|
|
1638
1638
|
// 2 - "STOP"
|
|
1639
1639
|
// 3 - ???
|
|
1640
1640
|
|
|
1641
|
-
"
|
|
1641
|
+
"pictureMode": "STANDARD", // 0 - "OTHER"
|
|
1642
1642
|
// 1 - "STANDARD"
|
|
1643
1643
|
// 2 - "CALIBRATED"
|
|
1644
1644
|
// 3 - "CALIBRATED_DARK"
|
|
@@ -1647,7 +1647,7 @@
|
|
|
1647
1647
|
// 6 - "COMPUTER"
|
|
1648
1648
|
// 7 - "CUSTOM"
|
|
1649
1649
|
|
|
1650
|
-
"
|
|
1650
|
+
"remoteKey": "SELECT", // 0 - "REWIND,"
|
|
1651
1651
|
// 1 - "FAST_FORWARD"
|
|
1652
1652
|
// 2 - "NEXT_TRACK"
|
|
1653
1653
|
// 3 - "PREVIOUS_TRACK"
|
|
@@ -1662,77 +1662,77 @@
|
|
|
1662
1662
|
// 12 - "INFORMATION"
|
|
1663
1663
|
|
|
1664
1664
|
// Optional Characteristics
|
|
1665
|
-
"
|
|
1665
|
+
"manufacturer": "Sony",
|
|
1666
1666
|
|
|
1667
|
-
"
|
|
1667
|
+
"model": "Android TV",
|
|
1668
1668
|
|
|
1669
|
-
"
|
|
1669
|
+
"serialNumber": "12345",
|
|
1670
1670
|
|
|
1671
1671
|
// Cmd4 Specific - Interval is in second, Timeout in msec
|
|
1672
|
-
// (
|
|
1672
|
+
// (polling per characteristic)
|
|
1673
1673
|
|
|
1674
1674
|
// polling requires a state_cmd and state_cmd is
|
|
1675
1675
|
// used with your own scripts. Here for example only.
|
|
1676
|
-
//"
|
|
1677
|
-
// {"
|
|
1678
|
-
// {"
|
|
1679
|
-
// {"
|
|
1676
|
+
//"polling": [
|
|
1677
|
+
// {"characteristic": "active", "interval": 50, "timeout": 5000},
|
|
1678
|
+
// {"characteristic": "activeIdentifier", "interval": 50, "timeout": 5000},
|
|
1679
|
+
// {"characteristic": "currentMediaState", "interval": 540, "timeout": 5000}
|
|
1680
1680
|
//],
|
|
1681
1681
|
|
|
1682
|
-
"
|
|
1683
|
-
//"
|
|
1682
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1683
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1684
1684
|
},
|
|
1685
1685
|
{
|
|
1686
|
-
"
|
|
1687
|
-
"
|
|
1686
|
+
"type": "TelevisionSpeaker",
|
|
1687
|
+
"displayName": "My_TVSpeaker", // Not a characteristic, but a function parameter
|
|
1688
1688
|
|
|
1689
1689
|
// Required characteristics
|
|
1690
|
-
"
|
|
1690
|
+
"mute": "FALSE", // 0 - "FALSE"
|
|
1691
1691
|
// 1 - "TRUE"
|
|
1692
1692
|
|
|
1693
1693
|
// Optional Characteristics
|
|
1694
|
-
"
|
|
1694
|
+
"active": "ACTIVE", // 0 - "INACTIVE"
|
|
1695
1695
|
// 1 - "ACTIVE"
|
|
1696
1696
|
|
|
1697
|
-
"
|
|
1697
|
+
"volume": 5, // Range: 0-100, Step 1
|
|
1698
1698
|
|
|
1699
|
-
"
|
|
1699
|
+
"volumeControlType": "ABSOLUTE", // 0 - "NONE"
|
|
1700
1700
|
// 1 - "RELATIVE"
|
|
1701
1701
|
// 2 - "RELATIVE_WITH_CURRENT"
|
|
1702
1702
|
// 3 - "ABSOLUTE"
|
|
1703
1703
|
|
|
1704
|
-
"
|
|
1704
|
+
"volumeSelector": "INCREMENT", // 0 - "INCREMENT"
|
|
1705
1705
|
// 1 - "DECREMENT"
|
|
1706
1706
|
|
|
1707
|
-
"
|
|
1707
|
+
"name": "My_TVSpeaker",
|
|
1708
1708
|
|
|
1709
|
-
"
|
|
1709
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1710
1710
|
|
|
1711
|
-
"
|
|
1711
|
+
"model": "Anything", // Available for all accessories
|
|
1712
1712
|
|
|
1713
|
-
"
|
|
1713
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1714
1714
|
|
|
1715
1715
|
// Cmd4 Specific - Interval is in second, Timeout in msec
|
|
1716
|
-
// (
|
|
1716
|
+
// (polling per characteristic)
|
|
1717
1717
|
|
|
1718
1718
|
// polling requires a state_cmd and state_cmd is
|
|
1719
1719
|
// used with your own scripts. Here for example only.
|
|
1720
|
-
//"
|
|
1721
|
-
// {"
|
|
1722
|
-
// {"
|
|
1720
|
+
//"polling": [
|
|
1721
|
+
// {"characteristic": "active", "interval": 50, "timeout": 5000},
|
|
1722
|
+
// {"characteristic": "volume", "interval": 50, "timeout": 5000}
|
|
1723
1723
|
//],
|
|
1724
1724
|
|
|
1725
|
-
"
|
|
1726
|
-
//"
|
|
1725
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1726
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1727
1727
|
},
|
|
1728
1728
|
{
|
|
1729
|
-
"
|
|
1730
|
-
"
|
|
1729
|
+
"type": "InputSource",
|
|
1730
|
+
"displayName": "My_InputSource", // Not a characteristic, but a function parameter
|
|
1731
1731
|
|
|
1732
1732
|
// Required characteristics
|
|
1733
|
-
"
|
|
1733
|
+
"configuredName": "My_InputSource",
|
|
1734
1734
|
|
|
1735
|
-
"
|
|
1735
|
+
"inputSourceType": "HDMI", // 0 - "OTHER"
|
|
1736
1736
|
// 1 - "HOME_SCREEN"
|
|
1737
1737
|
// 2 - "TUNER"
|
|
1738
1738
|
// 3 - "HDMI"
|
|
@@ -1744,415 +1744,415 @@
|
|
|
1744
1744
|
// 9 - "USB"
|
|
1745
1745
|
// 10 - "APPLICATION"
|
|
1746
1746
|
|
|
1747
|
-
"
|
|
1747
|
+
"isConfigured": "CONFIGURED", // 0 - "NOT_CONFIGURED"
|
|
1748
1748
|
// 1 - "CONFIGURED"
|
|
1749
1749
|
|
|
1750
|
-
"
|
|
1750
|
+
"currentVisibilityState": "SHOWN", // 0 - "SHOWN"
|
|
1751
1751
|
// 1 - "HIDDEN"
|
|
1752
1752
|
|
|
1753
1753
|
// Optional Characteristics
|
|
1754
|
-
"
|
|
1754
|
+
"inputDeviceType": "TV", // 0 - "OTHER"
|
|
1755
1755
|
// 1 - "TV"
|
|
1756
1756
|
// 2 - "RECORDING"
|
|
1757
1757
|
// 3 - "TUNER"
|
|
1758
1758
|
// 4 - "PLAYBACK"
|
|
1759
1759
|
// 5 - "AUDIO_SYSTEM"
|
|
1760
1760
|
|
|
1761
|
-
"
|
|
1761
|
+
"targetVisibilityState": "SHOWN",
|
|
1762
1762
|
// 0 - "SHOWN"
|
|
1763
1763
|
// 1 - "HIDDEN"
|
|
1764
1764
|
// 2 - "STOP"
|
|
1765
1765
|
|
|
1766
|
-
"
|
|
1766
|
+
"name": "My_InputSource",
|
|
1767
1767
|
|
|
1768
|
-
"
|
|
1768
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1769
1769
|
|
|
1770
|
-
"
|
|
1770
|
+
"model": "Anything", // Available for all accessories
|
|
1771
1771
|
|
|
1772
|
-
"
|
|
1772
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1773
1773
|
|
|
1774
1774
|
// Cmd4 Specific
|
|
1775
|
-
"
|
|
1776
|
-
//"
|
|
1775
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1776
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1777
1777
|
},
|
|
1778
1778
|
{
|
|
1779
|
-
"
|
|
1780
|
-
"
|
|
1779
|
+
"type": "IrrigationSystem",
|
|
1780
|
+
"displayName": "My_IrrigationSystem", // Not a characteristic, but a function parameter
|
|
1781
1781
|
|
|
1782
1782
|
// Required characteristics
|
|
1783
|
-
"
|
|
1783
|
+
"active": "ACTIVE", // 0 - "INACTIVE"
|
|
1784
1784
|
// 1 - "ACTIVE"
|
|
1785
1785
|
|
|
1786
|
-
"
|
|
1786
|
+
"programMode": "PROGRAM_SCHEDULED", // 0 - "NO_PROGRAM_SCHEDULED"
|
|
1787
1787
|
// 1 - "PROGRAM_SCHEDULED"
|
|
1788
1788
|
// 2 - "PROGRAM_SCHEDULED_MANUAL_MODE"
|
|
1789
1789
|
|
|
1790
|
-
"
|
|
1790
|
+
"inUse": "IN_USE", // 0 - "NOT_IN_USE"
|
|
1791
1791
|
// 1 - "IN_USE"
|
|
1792
1792
|
|
|
1793
1793
|
|
|
1794
1794
|
// Optional Characteristics
|
|
1795
|
-
"
|
|
1795
|
+
"remainingDuration": 60, // Range: 0-3600, Step: 1
|
|
1796
1796
|
|
|
1797
|
-
"
|
|
1797
|
+
"statusFault": "NO_FAULT",
|
|
1798
1798
|
// 0 - "NO_FAULT"
|
|
1799
1799
|
// 1 - "GENERAL_FAULT"
|
|
1800
1800
|
|
|
1801
|
-
"
|
|
1801
|
+
"name": "My_IrrigationSystem",
|
|
1802
1802
|
|
|
1803
|
-
"
|
|
1803
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1804
1804
|
|
|
1805
|
-
"
|
|
1805
|
+
"model": "Anything", // Available for all accessories
|
|
1806
1806
|
|
|
1807
|
-
"
|
|
1807
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1808
1808
|
|
|
1809
1809
|
// Cmd4 Specific - Interval is in second, Timeout in msec
|
|
1810
|
-
// (
|
|
1810
|
+
// (polling per characteristic)
|
|
1811
1811
|
|
|
1812
1812
|
// polling requires a state_cmd and state_cmd is
|
|
1813
1813
|
// used with your own scripts. Here for example only.
|
|
1814
|
-
//"
|
|
1815
|
-
// {"
|
|
1816
|
-
// {"
|
|
1814
|
+
//"polling": [
|
|
1815
|
+
// {"characteristic": "active", "interval": 50, "timeout": 5000},
|
|
1816
|
+
// {"characteristic": "statusFault", "interval": 300, "timeout": 5000}
|
|
1817
1817
|
//],
|
|
1818
1818
|
|
|
1819
|
-
"
|
|
1820
|
-
//"
|
|
1819
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1820
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1821
1821
|
},
|
|
1822
1822
|
{
|
|
1823
|
-
"
|
|
1824
|
-
"
|
|
1823
|
+
"type": "Faucet",
|
|
1824
|
+
"displayName": "My_Faucet", // Not a characteristic, but a function parameter
|
|
1825
1825
|
|
|
1826
1826
|
// Required characteristics
|
|
1827
|
-
"
|
|
1827
|
+
"active": "ACTIVE", // 0 - "INACTIVE"
|
|
1828
1828
|
// 1 - "ACTIVE"
|
|
1829
1829
|
|
|
1830
1830
|
// Optional Characteristics
|
|
1831
|
-
"
|
|
1831
|
+
"statusFault": "NO_FAULT", // 0 - "NO_FAULT"
|
|
1832
1832
|
// 1 - "GENERAL_FAULT"
|
|
1833
1833
|
|
|
1834
|
-
"
|
|
1834
|
+
"name": "My_Faucet",
|
|
1835
1835
|
|
|
1836
|
-
"
|
|
1836
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1837
1837
|
|
|
1838
|
-
"
|
|
1838
|
+
"model": "Anything", // Available for all accessories
|
|
1839
1839
|
|
|
1840
|
-
"
|
|
1840
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1841
1841
|
|
|
1842
1842
|
// Cmd4 Specific - Interval is in second, Timeout in msec
|
|
1843
|
-
// (
|
|
1843
|
+
// (polling per characteristic)
|
|
1844
1844
|
|
|
1845
1845
|
// polling requires a state_cmd and state_cmd is
|
|
1846
1846
|
// used with your own scripts. Here for example only.
|
|
1847
|
-
//"
|
|
1848
|
-
// {"
|
|
1849
|
-
// {"
|
|
1847
|
+
//"polling": [
|
|
1848
|
+
// {"characteristic": "active", "interval": 50, "timeout": 5000},
|
|
1849
|
+
// {"characteristic": "statusFault", "interval": 300, "timeout": 5000}
|
|
1850
1850
|
//],
|
|
1851
1851
|
|
|
1852
1852
|
|
|
1853
|
-
"
|
|
1854
|
-
//"
|
|
1853
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1854
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1855
1855
|
},
|
|
1856
1856
|
{
|
|
1857
|
-
"
|
|
1858
|
-
"
|
|
1857
|
+
"type": "Relay",
|
|
1858
|
+
"displayName": "My_Relay", // Not a characteristic, but a function parameter
|
|
1859
1859
|
|
|
1860
1860
|
// Required characteristics
|
|
1861
|
-
"
|
|
1861
|
+
"relayEnabled": "FALSE",
|
|
1862
1862
|
// 0 - "FALSE"
|
|
1863
1863
|
// 1 - "TRUE"
|
|
1864
1864
|
|
|
1865
|
-
"
|
|
1865
|
+
"relayState": 0, // Format: UINT8
|
|
1866
1866
|
// Read-only
|
|
1867
1867
|
|
|
1868
1868
|
// All TLV8 Characteristics are removed by default,
|
|
1869
1869
|
// unless 'allowTLV8' is set, at your own peril.
|
|
1870
1870
|
// Setting most will cause Homebridge with HomeKit or Eve.
|
|
1871
1871
|
// to not allow you to connect.
|
|
1872
|
-
// "
|
|
1872
|
+
// "relayControlPoint": 0, // TLV8
|
|
1873
1873
|
|
|
1874
1874
|
|
|
1875
1875
|
// Optional Characteristics
|
|
1876
1876
|
// - None
|
|
1877
1877
|
|
|
1878
1878
|
// Cmd4 Specific
|
|
1879
|
-
"
|
|
1880
|
-
//"
|
|
1879
|
+
"stateChangeResponseTime": 10 // Default (Seconds)
|
|
1880
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1881
1881
|
},
|
|
1882
1882
|
{
|
|
1883
|
-
"
|
|
1884
|
-
"
|
|
1883
|
+
"type": "TimeInformation",
|
|
1884
|
+
"displayName": "My_TimeInformation", // Not a characteristic, but a function parameter
|
|
1885
1885
|
|
|
1886
1886
|
// Required characteristics
|
|
1887
|
-
"
|
|
1887
|
+
"currentTime": "11:15", // Format: string
|
|
1888
1888
|
|
|
1889
|
-
"
|
|
1889
|
+
"dayoftheWeek": 1, // Range: 1-7
|
|
1890
1890
|
|
|
1891
|
-
"
|
|
1891
|
+
"timeUpdate": "TRUE", // 0 - "FALSE"
|
|
1892
1892
|
// 1 - "TRUE"
|
|
1893
1893
|
|
|
1894
1894
|
// Optional Characteristics
|
|
1895
|
-
"
|
|
1895
|
+
"name": "My_TimeInformation",
|
|
1896
1896
|
|
|
1897
|
-
"
|
|
1897
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1898
1898
|
|
|
1899
|
-
"
|
|
1899
|
+
"model": "Anything", // Available for all accessories
|
|
1900
1900
|
|
|
1901
|
-
"
|
|
1901
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1902
1902
|
|
|
1903
1903
|
// Cmd4 Specific
|
|
1904
|
-
"
|
|
1905
|
-
//"
|
|
1904
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1905
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1906
1906
|
},
|
|
1907
1907
|
{
|
|
1908
|
-
"
|
|
1909
|
-
"
|
|
1908
|
+
"type": "Valve",
|
|
1909
|
+
"displayName": "My_Valve", // Not a characteristic, but a function parameter
|
|
1910
1910
|
|
|
1911
1911
|
// Required characteristics
|
|
1912
|
-
"
|
|
1912
|
+
"active": "ACTIVE", // 0 - "INACTIVE"
|
|
1913
1913
|
// 1 - "ACTIVE"
|
|
1914
1914
|
|
|
1915
|
-
"
|
|
1915
|
+
"inUse": "NOT_IN_USE", // 0 - "NOT_IN_USE"
|
|
1916
1916
|
// 1 - "IN_USE"
|
|
1917
1917
|
|
|
1918
|
-
"
|
|
1918
|
+
"valveType": "GENERIC_VALVE", // 0 - "GENERIC_VALVE"
|
|
1919
1919
|
// 1 - "IRRIGATION"
|
|
1920
1920
|
// 2 - "SHOWER_HEAD"
|
|
1921
1921
|
// 3 - "WATER_FAUCET"
|
|
1922
1922
|
|
|
1923
1923
|
// Optional Characteristics
|
|
1924
1924
|
|
|
1925
|
-
"
|
|
1925
|
+
"setDuration": 0, // Format: Uint32
|
|
1926
1926
|
|
|
1927
|
-
"
|
|
1927
|
+
"remainingDuration": 0, // Format: Uint32
|
|
1928
1928
|
// Range: 0 - 3600, Step: 1
|
|
1929
1929
|
|
|
1930
|
-
"
|
|
1930
|
+
"isConfigured": "CONFIGURED", // 0 - "NOT_CONFIGURED"
|
|
1931
1931
|
// 1 - "CONFIGURED"
|
|
1932
1932
|
|
|
1933
|
-
"
|
|
1933
|
+
"serviceLabelIndex": 1, // Range: 1-255, Step: 1
|
|
1934
1934
|
|
|
1935
|
-
"
|
|
1935
|
+
"statusFault": "NO_FAULT", // 0 - "NO_FAULT"
|
|
1936
1936
|
// 1 - "GENERAL_FAULT"
|
|
1937
1937
|
|
|
1938
|
-
"
|
|
1938
|
+
"name": "My_Valve",
|
|
1939
1939
|
|
|
1940
|
-
"
|
|
1940
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1941
1941
|
|
|
1942
|
-
"
|
|
1942
|
+
"model": "Anything", // Available for all accessories
|
|
1943
1943
|
|
|
1944
|
-
"
|
|
1944
|
+
"serialNumber": "12345", // Available for all accessories
|
|
1945
1945
|
|
|
1946
1946
|
// Cmd4 Specific
|
|
1947
|
-
"
|
|
1948
|
-
//"
|
|
1947
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
1948
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
1949
1949
|
},
|
|
1950
1950
|
{
|
|
1951
|
-
"
|
|
1952
|
-
"
|
|
1951
|
+
"type": "HeaterCooler",
|
|
1952
|
+
"displayName": "My_HeaterCooler", // Not a characteristic, but a function parameter
|
|
1953
1953
|
|
|
1954
1954
|
// Required characteristics
|
|
1955
|
-
"
|
|
1955
|
+
"active": "ACTIVE", // 0 - "INACTIVE"
|
|
1956
1956
|
// 1 - "ACTIVE"
|
|
1957
1957
|
|
|
1958
|
-
"
|
|
1958
|
+
"currentHeaterCoolerState": "HEATING", // 0 - "INACTIVE"
|
|
1959
1959
|
// 1 = "IDLE"
|
|
1960
1960
|
// 2 - "HEATING"
|
|
1961
1961
|
// 3 = "COOLING"
|
|
1962
1962
|
|
|
1963
|
-
"
|
|
1963
|
+
"targetHeaterCoolerState": "AUTO", // 0 - "AUTO"
|
|
1964
1964
|
// 1 - "HEAT"
|
|
1965
1965
|
// 2 - "COOL"
|
|
1966
1966
|
|
|
1967
|
-
"
|
|
1967
|
+
"currentTemperature": 37.0, // Range: 0-100, Step: 0.1
|
|
1968
1968
|
// Format: float
|
|
1969
1969
|
// "Units": CELCIUS
|
|
1970
1970
|
|
|
1971
1971
|
// Optional Characteristics
|
|
1972
|
-
"
|
|
1972
|
+
"lockPhysicalControls": "CONTROL_LOCK_DISABLED",
|
|
1973
1973
|
// 0 - "CONTROL_LOCK_DISABLED"
|
|
1974
1974
|
// 1 - "CONTROL_LOCK_ENABLED"
|
|
1975
1975
|
|
|
1976
|
-
"
|
|
1976
|
+
"name": "My_HeaterCooler",
|
|
1977
1977
|
|
|
1978
|
-
"
|
|
1978
|
+
"swingMode": "SWING_ENABLED", // 0 - "SWING_DISABLED",
|
|
1979
1979
|
// 1 - "SWING_ENABLED"
|
|
1980
1980
|
|
|
1981
|
-
"
|
|
1981
|
+
"coolingThresholdTemperature":
|
|
1982
1982
|
22.2, // Range 10-35, Step: 0.1
|
|
1983
1983
|
// Units: CELCIUS
|
|
1984
1984
|
|
|
1985
|
-
"
|
|
1985
|
+
"heatingThresholdTemperature":
|
|
1986
1986
|
25.2, // Range 0-25, Step: 0.1
|
|
1987
1987
|
// Format: float
|
|
1988
1988
|
// Units: CELCIUS
|
|
1989
1989
|
|
|
1990
|
-
"
|
|
1990
|
+
"temperatureDisplayUnits": "CELSIUS",
|
|
1991
1991
|
// 0 - "CELSIUS"
|
|
1992
1992
|
// 1 - "FAHRENHEIT"
|
|
1993
1993
|
|
|
1994
|
-
"
|
|
1994
|
+
"rotationSpeed": 100, // Range: 0-100, Step: 1
|
|
1995
1995
|
|
|
1996
|
-
"
|
|
1996
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
1997
1997
|
|
|
1998
|
-
"
|
|
1998
|
+
"model": "Anything", // Available for all accessories
|
|
1999
1999
|
|
|
2000
|
-
"
|
|
2000
|
+
"serialNumber": "12345", // Available for all accessories
|
|
2001
2001
|
|
|
2002
2002
|
// Cmd4 Specific
|
|
2003
|
-
"
|
|
2004
|
-
//"
|
|
2003
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
2004
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
2005
2005
|
},
|
|
2006
2006
|
{
|
|
2007
|
-
"
|
|
2008
|
-
"
|
|
2007
|
+
"type": "HumidifierDehumidifier",
|
|
2008
|
+
"displayName": "My_HumidifierDehumidifier", // Not a characteristic, but a function parameter
|
|
2009
2009
|
|
|
2010
2010
|
// Required characteristics
|
|
2011
|
-
"
|
|
2011
|
+
"currentRelativeHumidity": 60, // Range: 0-100, Step: 1
|
|
2012
2012
|
// Format: float
|
|
2013
2013
|
// Units: Percentage
|
|
2014
2014
|
|
|
2015
|
-
"
|
|
2015
|
+
"currentHumidifierDehumidifierState":
|
|
2016
2016
|
"HUMIDIFYING", // 0 - "INACTIVE"
|
|
2017
2017
|
// 1 - "IDLE"
|
|
2018
2018
|
// 2 - "HUMIDIFYING"
|
|
2019
2019
|
// 3 - "DEHUMIDIFYING"
|
|
2020
2020
|
|
|
2021
|
-
"
|
|
2021
|
+
"targetHumidifierDehumidifierState":
|
|
2022
2022
|
"HUMIDIFIER", // 0 - "HUMIDIFIER_OR_DEHUMIDIFIER"
|
|
2023
2023
|
// 1 - "HUMIDIFIER"
|
|
2024
2024
|
// 2 - "DEHUMIDIFIER"
|
|
2025
2025
|
|
|
2026
|
-
"
|
|
2026
|
+
"active": "ACTIVE", // 0 - "INACTIVE"
|
|
2027
2027
|
// 1 - "ACTIVE"
|
|
2028
2028
|
|
|
2029
2029
|
// Optional Characteristics
|
|
2030
|
-
"
|
|
2030
|
+
"lockPhysicalControls": "CONTROL_LOCK_DISABLED", // 0 - "CONTROL_LOCK_DISABLED"
|
|
2031
2031
|
// 1 - "CONTROL_LOCK_ENABLED"
|
|
2032
2032
|
|
|
2033
2033
|
|
|
2034
|
-
"
|
|
2034
|
+
"name": "My_HumidifierDehumidifier",
|
|
2035
2035
|
|
|
2036
|
-
"
|
|
2036
|
+
"swingMode": "SWING_DISABLED", // 0 - "SWING_DISABLED"
|
|
2037
2037
|
// 1 - "SWING_ENABLED"
|
|
2038
2038
|
|
|
2039
|
-
"
|
|
2039
|
+
"waterLevel": 0, // Range: 0 - 100
|
|
2040
2040
|
// Format: float
|
|
2041
2041
|
|
|
2042
|
-
"
|
|
2042
|
+
"relativeHumidityDehumidifierThreshold":
|
|
2043
2043
|
0, // Range: 0 - 100, Step 1
|
|
2044
2044
|
// Format: float
|
|
2045
2045
|
// Units: Percentage
|
|
2046
2046
|
|
|
2047
|
-
"
|
|
2047
|
+
"relativeHumidityHumidifierThreshold":
|
|
2048
2048
|
0, // Range: 0 - 100, Step 1
|
|
2049
2049
|
// Format: float
|
|
2050
2050
|
// Units: Percentage
|
|
2051
2051
|
|
|
2052
|
-
"
|
|
2052
|
+
"rotationSpeed": 0, // Range: 0 - 100, Step 1
|
|
2053
2053
|
|
|
2054
|
-
"
|
|
2054
|
+
"manufacturer": "Somebody", // Available for all accessories
|
|
2055
2055
|
|
|
2056
|
-
"
|
|
2056
|
+
"model": "Anything", // Available for all accessories
|
|
2057
2057
|
|
|
2058
|
-
"
|
|
2058
|
+
"serialNumber": "12345", // Available for all accessories
|
|
2059
2059
|
|
|
2060
2060
|
// Cmd4 Specific
|
|
2061
|
-
"
|
|
2062
|
-
//"
|
|
2061
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
2062
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
2063
2063
|
},
|
|
2064
2064
|
{
|
|
2065
|
-
"
|
|
2066
|
-
"
|
|
2065
|
+
"type": "AccessControl",
|
|
2066
|
+
"displayName": "My_AccessControl", // Not a characteristic, but a function parameter
|
|
2067
2067
|
|
|
2068
2068
|
// Required characteristics
|
|
2069
|
-
"
|
|
2069
|
+
"accessControlLevel": 0, // 0-2
|
|
2070
2070
|
|
|
2071
2071
|
// Cmd4 Specific
|
|
2072
|
-
"
|
|
2073
|
-
//"
|
|
2072
|
+
"stateChangeResponseTime": 3 // Default (Seconds)
|
|
2073
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
2074
2074
|
},
|
|
2075
2075
|
{
|
|
2076
|
-
"
|
|
2077
|
-
"
|
|
2076
|
+
"type": "CameraOperatingMode",
|
|
2077
|
+
"displayName": "My_CameraOperatingMode", // Not a characteristic, but a function parameter
|
|
2078
2078
|
|
|
2079
2079
|
// Required characteristics
|
|
2080
|
-
"
|
|
2080
|
+
"eventSnapshotsActive": "DISABLE", // 0 - "DISABLE"
|
|
2081
2081
|
// 1 - "ENABLE"
|
|
2082
2082
|
|
|
2083
|
-
"
|
|
2083
|
+
"homeKitCameraActive": "OFF", // 0 - "OFF"
|
|
2084
2084
|
// 1 - "ON"
|
|
2085
2085
|
|
|
2086
2086
|
// Optional Characteristics
|
|
2087
|
-
"
|
|
2087
|
+
"manuallyDisabled": "DISABLED", // 0 - "ENABLED"
|
|
2088
2088
|
// 1 - "DISABLED"
|
|
2089
2089
|
|
|
2090
|
-
"
|
|
2090
|
+
"nightVision": "FALSE", // 0 - "FALSE"
|
|
2091
2091
|
// 1 - "TRUE"
|
|
2092
2092
|
|
|
2093
|
-
"
|
|
2093
|
+
"thirdPartyCameraActive": "OFF", // 0 - "OFF"
|
|
2094
2094
|
// 1 - "ON"
|
|
2095
2095
|
|
|
2096
|
-
"
|
|
2096
|
+
"periodicSnapshotsActive": "DISABLE" // 0 - "DISABLE"
|
|
2097
2097
|
// 1 - "ENABLE"
|
|
2098
2098
|
|
|
2099
2099
|
// Cmd4 Specific
|
|
2100
|
-
//"
|
|
2100
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
2101
2101
|
},
|
|
2102
2102
|
{
|
|
2103
|
-
"
|
|
2104
|
-
"
|
|
2103
|
+
"type": "SmartSpeaker",
|
|
2104
|
+
"displayName": "My_SmartSpeaker", // Not a characteristic, but a function parameter
|
|
2105
2105
|
|
|
2106
2106
|
// Required characteristics
|
|
2107
|
-
"
|
|
2107
|
+
"currentMediaState": "STOP", // 0 - "PLAY"
|
|
2108
2108
|
// 1 - "PAUSE"
|
|
2109
2109
|
// 2 - "STOP"
|
|
2110
2110
|
// 3 - ???
|
|
2111
2111
|
|
|
2112
|
-
"
|
|
2112
|
+
"targetMediaState": "STOP", // 0 - "PLAY"
|
|
2113
2113
|
// 1 - "PAUSE"
|
|
2114
2114
|
// 2 - "STOP"
|
|
2115
2115
|
// 3 - ???
|
|
2116
2116
|
|
|
2117
2117
|
// Optional Characteristics
|
|
2118
|
-
"
|
|
2119
|
-
"
|
|
2120
|
-
"
|
|
2121
|
-
"
|
|
2118
|
+
"name": "My_SmartSpeaker",
|
|
2119
|
+
"configuredName": "My_SmartSpeaker",
|
|
2120
|
+
"volume": 5,
|
|
2121
|
+
"mute": "FALSE" // 0 - "FALSE" (Off)
|
|
2122
2122
|
// 1 - "TRUE" (On)
|
|
2123
2123
|
|
|
2124
2124
|
|
|
2125
2125
|
|
|
2126
|
-
//"
|
|
2126
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
2127
2127
|
},
|
|
2128
2128
|
{
|
|
2129
|
-
"
|
|
2130
|
-
"
|
|
2129
|
+
"type": "TargetControl",
|
|
2130
|
+
"displayName": "My_TargetControl", // Not a characteristic, but a function parameter
|
|
2131
2131
|
|
|
2132
2132
|
// Required characteristics
|
|
2133
|
-
"
|
|
2134
|
-
"
|
|
2133
|
+
"activeIdentifier": 1183,
|
|
2134
|
+
"active": "ACTIVE" // 0 - "INACTIVE"
|
|
2135
2135
|
// 1 - "ACTIVE"
|
|
2136
2136
|
|
|
2137
2137
|
// All TLV8 Characteristics are removed by default,
|
|
2138
2138
|
// unless 'allowTLV8' is set, at your own peril.
|
|
2139
2139
|
// Setting most will cause Homebridge with HomeKit or Eve.
|
|
2140
2140
|
// to not allow you to connect.
|
|
2141
|
-
//"
|
|
2141
|
+
//"buttonEvent": 0, // TLV8
|
|
2142
2142
|
|
|
2143
|
-
//"
|
|
2143
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
2144
2144
|
},
|
|
2145
2145
|
{
|
|
2146
|
-
"
|
|
2147
|
-
"
|
|
2146
|
+
"type": "WiFiSatellite",
|
|
2147
|
+
"displayName": "My_WiFiSatellite", // Not a characteristic, but a function parameter
|
|
2148
2148
|
|
|
2149
2149
|
// Required characteristics
|
|
2150
|
-
"
|
|
2150
|
+
"wifiSatelliteStatus": "NOT_CONNECTED" // 0 - UNKNOWN
|
|
2151
2151
|
// 1 - CONNECTED
|
|
2152
2152
|
// 2 - NOT_CONNECTED
|
|
2153
2153
|
|
|
2154
2154
|
// Cmd4 Specific
|
|
2155
|
-
//"
|
|
2155
|
+
//"state_cmd": "node .homebridge/< yourScriptHere >"
|
|
2156
2156
|
}
|
|
2157
2157
|
]
|
|
2158
2158
|
}
|