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.
@@ -53,7 +53,6 @@
53
53
  "platform": "Cmd4",
54
54
  "debug": false,
55
55
  "outputConstants": false,
56
- "restartRecover": true,
57
56
  "accessories" :
58
57
  [
59
58
  {
@@ -67,64 +66,64 @@
67
66
  "sleepDiscoveryMode": "ALWAYS_DISCOVERABLE",
68
67
  "accessories":
69
68
  [
70
- { "Type": "televisionSpeaker",
71
- "DisplayName": "My_TelevisionSpeaker",
72
- "Name": "My_TelevisionSpeaker",
73
- "Active": "ENABLED",
74
- "VolumeSelector": 10,
75
- "VolumeControlType": "ABSOLUTE",
76
- "State_cmd": "node .homebridge/YourScriptHere.js",
77
- "Polling": [
78
- {"Characteristic": "Active", "interval": 50, "timeout": 5000},
79
- {"Characteristic": "VolumeSelector", "interval": 50, "timeout": 5000}
69
+ { "type": "TelevisionSpeaker",
70
+ "displayName": "My_TelevisionSpeaker",
71
+ "name": "My_TelevisionSpeaker",
72
+ "active": "ENABLED",
73
+ "volumeSelector": 10,
74
+ "volumeControlType": "ABSOLUTE",
75
+ "state_cmd": "node .homebridge/YourScriptHere.js",
76
+ "polling": [
77
+ {"characteristic": "active", "interval": 50, "timeout": 5000},
78
+ {"characteristic": "volumeSelector", "interval": 50, "timeout": 5000}
80
79
  ]
81
80
  }
82
81
  ],
83
82
  "LinkedTypes":
84
83
  [
85
- {"Type": "InputSource",
86
- "DisplayName": "HDMI1",
87
- "ConfiguredName": "HDMI 1",
88
- "CurrentVisibilityState": "SHOWN",
89
- "InputSourceType": "HDMI",
90
- "IsConfigured": "CONFIGURED",
91
- "Identifier": 1,
92
- "TargetVisibilityState": "SHOWN",
93
- "Name": "HDMI 1"
84
+ {"type": "InputSource",
85
+ "displayName": "HDMI1",
86
+ "configuredName": "HDMI 1",
87
+ "currentVisibilityState": "SHOWN",
88
+ "inputSourceType": "HDMI",
89
+ "isConfigured": "CONFIGURED",
90
+ "identifier": 1,
91
+ "targetVisibilityState": "SHOWN",
92
+ "name": "HDMI 1"
94
93
  },
95
- {"Type": "InputSource",
96
- "DisplayName": "HDMI 2",
97
- "ConfiguredName": "HDMI 2",
98
- "CurrentVisibilityState": "SHOWN",
99
- "InputSourceType": "HDMI",
100
- "IsConfigured": "CONFIGURED",
101
- "Identifier": 2,
102
- "TargetVisibilityState": "SHOWN",
103
- "Name": "HDMI 2"
94
+ {"type": "InputSource",
95
+ "displayName": "HDMI 2",
96
+ "configuredName": "HDMI 2",
97
+ "currentVisibilityState": "SHOWN",
98
+ "inputSourceType": "HDMI",
99
+ "isConfigured": "CONFIGURED",
100
+ "identifier": 2,
101
+ "targetVisibilityState": "SHOWN",
102
+ "name": "HDMI 2"
104
103
  },
105
- {"Type": "InputSource",
106
- "DisplayName": "Netflix",
107
- "ConfiguredName": "Netflix",
108
- "CurrentVisibilityState": "SHOWN",
109
- "InputSourceType": "HDMI",
110
- "IsConfigured": "CONFIGURED",
111
- "Identifier": 3,
112
- "TargetVisibilityState": "SHOWN",
113
- "Name": "Netflix"
104
+ {"type": "InputSource",
105
+ "displayName": "Netflix",
106
+ "configuredName": "Netflix",
107
+ "currentVisibilityState": "SHOWN",
108
+ "inputSourceType": "HDMI",
109
+ "isConfigured": "CONFIGURED",
110
+ "identifier": 3,
111
+ "targetVisibilityState": "SHOWN",
112
+ "name": "Netflix"
114
113
  }
115
114
  ],
116
- "DisplayOrder": 0,
117
- "CurrentMediaState": "STOP",
118
- "TargetMediaState": "STOP",
119
- "PictureMode": "STANDARD",
120
- "RemoteKey": "SELECT",
121
- "Polling": [
122
- {"Characteristic": "Active", "interval": 50, "timeout": 5000},
123
- {"Characteristic": "ActiveIdentifier", "interval": 50, "timeout": 5000},
124
- {"Characteristic": "CurrentMediaState", "interval": 540, "timeout": 5000}
115
+ "displayOrder": 0,
116
+ "currentMediaState": "STOP",
117
+ "targetMediaState": "STOP",
118
+ "pictureMode": "STANDARD",
119
+ "remoteKey": "SELECT",
120
+ "polling": [
121
+ {"characteristic": "active", "interval": 50, "timeout": 5000},
122
+ {"characteristic": "activeIdentifier", "interval": 50, "timeout": 5000},
123
+ {"characteristic": "currentMediaState", "interval": 540, "timeout": 5000}
125
124
  ],
126
- "StateChangeResponseTime": 3,
127
- "State_cmd": "node .homebridge/YourScriptHere.js"
125
+ "stateChangeResponseTime": 3,
126
+ "state_cmd": "node .homebridge/YourScriptHere.js"
128
127
  }
129
128
  ]
130
129
  }
@@ -138,7 +137,7 @@
138
137
  <LI> The first is "category"<BR>
139
138
 
140
139
  ```json
141
- "Category": "TELEVISION"
140
+ "category": "TELEVISION"
142
141
  ```
143
142
 
144
143
  This is the hint to homekit of which icon to use and for Televisions, a TV icon will not show without it.
@@ -146,7 +145,7 @@ This is the hint to homekit of which icon to use and for Televisions, a TV icon
146
145
  <LI>The second new designation is "publishExternally"<BR>
147
146
 
148
147
  ```json
149
- "PublishExternally": true (Default is false)
148
+ "publishExternally": true (Default is false)
150
149
  ```
151
150
  As per the Homebridge API, this allows the Platform Accessory to be published separately from the bridge and is a requirement for multiple TV's.
152
151
  </UL>
@@ -167,15 +166,15 @@ See the [Cmd4 Developers Guide](https://github.com/ztalbot2000/homebridge-cmd4/b
167
166
  "accessories": [
168
167
  {
169
168
  "accessory": "Cmd4",
170
- "Type": "Switch",
171
- "OutputConstants": false,
172
- "DisplayName": "My_Switch",
173
- "Name": "My_Switch",
174
- "On": "FALSE",
175
- "Manufacturer": "Custom Manufacturer",
176
- "Model": "Custom Model",
177
- "StateChangeResponseTime": 3,
178
- "State_cmd": "node .homebridge/YourScriptHere.js"
169
+ "type": "Switch",
170
+ "outputConstants": false,
171
+ "displayName": "My_Switch",
172
+ "name": "My_Switch",
173
+ "on": "FALSE",
174
+ "manufacturer": "Custom Manufacturer",
175
+ "model": "Custom Model",
176
+ "stateChangeResponseTime": 3,
177
+ "state_cmd": "node .homebridge/YourScriptHere.js"
179
178
  }
180
179
  ]
181
180
  }
@@ -205,65 +204,65 @@ Notice that there is no Platform definition. Otherwise everything is the same. Y
205
204
  Priority Queued Polling is only available when a queue is defined. The default "QueueType" being "WoRm". To configure Priority Queued Polling every characteristic to the device must be configured to be in the same queue. as an Example of the default WoRm is:
206
205
 
207
206
  ```json
208
- "Interval": 5,
209
- "Polling": [ { "Characteristic": "CurrentTemperature", "queue": "A" },
210
- { "Characteristic": "TargetTemperature", "Queue": "A" }
207
+ "interval": 5,
208
+ "polling": [ { "characteristic": "currentTemperature", "queue": "A" },
209
+ { "characteristic": "targetTemperature", "queue": "A" }
211
210
  ]
212
211
  ```
213
212
  The interval of the characteristic is defined through the heirarch of the Platform/Accessory and then the Characteristic, as always.<BR>
214
213
  A simpler solution would be to re-define the queues and the queue characteristics ahead of time and then just specify which accessory is going to use Priority Queue Polling. Example 2:
215
214
 
216
215
  ```json
217
- "QueueTypes: [ { "Queue": "A" : "QueueType": "WoRm" }
216
+ "queueTypes: [ { "queue": "A" : "queueType": "WoRm" }
218
217
  ],
219
- "Queue": "A",
220
- "Interval": 10,
221
- "Polling": [ { "Characteristic": "CurrentTemperature" },
222
- { "Characteristic": "TargetTemperature", "Interval": 15 }
218
+ "queue": "A",
219
+ "interval": 10,
220
+ "polling": [ { "characteristic": "currentTemperature" },
221
+ { "characteristic": "targetTemperature", "interval": 15 }
223
222
  ]
224
223
  ```
225
224
  Example 3:
226
225
 
227
226
  ```json
228
- "QueueTypes: [ { "Queue": "A" : "QueueType": "WoRm" }
227
+ "queueTypes: [ { "queue": "A" : "queueType": "WoRm" }
229
228
  "platforms":
230
229
  [ { "platform": "Cmd4",
231
230
  "interval": "10",
232
- "QueueTypes: [ { "Queue": "A" : "QueueType": "WoRm" }
233
- { "Queue": "B" : "QueueType": "Sequential" }
234
- { "Queue": "C" } // Defaults to "WoRm"
231
+ "queueTypes: [ { "queue": "A" : "queueType": "WoRm" }
232
+ { "queue": "B" : "queueType": "Sequential" }
233
+ { "queue": "C" } // Defaults to "WoRm"
235
234
  ],
236
235
 
237
236
  "accessories": [
238
237
  {
239
- "Name": "My_Thermostat",
240
- "Type": "Thermostatwitch",
241
- "Interval": 15,
242
- "Queue": "A",
243
- "Polling": [ { "Characteristic": "CurrentTemperature" },
244
- { "Characteristic": "TargetTemperature" },
245
- { "Characteristic": "CurrentHeatingCoolingState", "interval": 25 }
238
+ "name": "My_Thermostat",
239
+ "type": "Thermostatwitch",
240
+ "interval": 15,
241
+ "queue": "A",
242
+ "polling": [ { "characteristic": "currentTemperature" },
243
+ { "characteristic": "targetTemperature" },
244
+ { "characteristic": "currentHeatingCoolingState", "interval": 25 }
246
245
  ],
247
246
  ...
248
247
  },
249
248
  {
250
- "Name": "My_Switch",
251
- "Type": "Switch",
252
- "Queue": "B",
253
- "Polling": [ { "Characteristic": "On" } ],
249
+ "name": "My_Switch",
250
+ "type": "Switch",
251
+ "queue": "B",
252
+ "polling": [ { "characteristic": "On" } ],
254
253
  ...
255
254
  },
256
255
  {
257
- "Name": "My_Door",
258
- "Type": "Door",
259
- "Queue": "C",
260
- "Polling": true,
256
+ "name": "My_Door",
257
+ "type": "Door",
258
+ "queue": "C",
259
+ "polling": true,
261
260
  ...
262
261
  },
263
262
  {
264
- "Name": "Switch2",
265
- "Type": "Switch",
266
- "Polling": [ { "Characteristic": "On", "Queue": "D" } ], // Defaults to "WoRm"
263
+ "name": "Switch2",
264
+ "type": "Switch",
265
+ "polling": [ { "characteristic": "on", "queue": "D" } ], // Defaults to "WoRm"
267
266
  ...
268
267
  }
269
268
 
@@ -281,7 +280,7 @@ Example 3:
281
280
  "outputConstants": false,
282
281
  "timeout": 4000,
283
282
  "stateChangeResponseTime": 3,
284
- "QueueTypes:[ { "Queue": "A", "QueueType": "WoRm" } ],
283
+ "queueTypes:[ { "queue": "A", "queueType": "WoRm" } ],
285
284
  "accessories": [
286
285
  {
287
286
  "type": "TemperatureSensor",
@@ -290,14 +289,14 @@ Example 3:
290
289
  "name": "LRoom",
291
290
  "currentTemperature": 25,
292
291
  "statusFault": "NO_FAULT",
293
- "Manufacturer": "Advantage Air Australia",
294
- "Model": "e-zone",
295
- "SerialNumber": "Fujitsu e-zone2",
292
+ "manufacturer": "Advantage Air Australia",
293
+ "model": "e-zone",
294
+ "serialNumber": "Fujitsu e-zone2",
296
295
  "polling": [
297
296
  { "characteristic": "currentTemperature", "queue": "A" }
298
297
  ],
299
- "Props": {
300
- "CurrentTemperature": {
298
+ "props": {
299
+ "currentTemperature": {
301
300
  "maxValue": 100,
302
301
  "minValue": -100,
303
302
  "minStep": 0.1
@@ -311,9 +310,9 @@ Example 3:
311
310
  "displayName": "TSwitch",
312
311
  "name": "TSwitch",
313
312
  "on": "FALSE",
314
- "Manufacturer": "Advantage Air Australia",
315
- "Model": "e-zone",
316
- "SerialNumber": "Fujitsu e-zone2",
313
+ "manufacturer": "Advantage Air Australia",
314
+ "model": "e-zone",
315
+ "serialNumber": "Fujitsu e-zone2",
317
316
  "polling": [
318
317
  { "characteristic": "On", "queue": "A" }
319
318
  ],
@@ -325,11 +324,11 @@ Example 3:
325
324
  "on": "FALSE",
326
325
  "displayName": "Fan",
327
326
  "name": "Fan",
328
- "Manufacturer": "Advantage Air Australia",
329
- "Model": "e-zone",
330
- "SerialNumber": "Fujitsu e-zone2",
327
+ "manufacturer": "Advantage Air Australia",
328
+ "model": "e-zone",
329
+ "serialNumber": "Fujitsu e-zone2",
331
330
  "polling": [
332
- { "characteristic": "On", "queue": "A" }
331
+ { "characteristic": "on", "queue": "A" }
333
332
  ],
334
333
  "stateChangeResponseTime": 1,
335
334
  "state_cmd": "bash /home/pi/ezone.sh"
@@ -343,9 +342,9 @@ Example 3:
343
342
  "currentTemperature": 25,
344
343
  "targetTemperature": 25,
345
344
  "temperatureDisplayUnits": "CELSIUS",
346
- "Manufacturer": "Advantage Air Australia",
347
- "Model": "e-zone",
348
- "SerialNumber": "Fujitsu e-zone2",
345
+ "manufacturer": "Advantage Air Australia",
346
+ "model": "e-zone",
347
+ "serialNumber": "Fujitsu e-zone2",
349
348
  "queue": "A", // All characteristics would go to queue "A"
350
349
  "polling": [
351
350
  { "characteristic": "currentHeatingCoolingState" },
@@ -426,9 +425,9 @@ The value "0" should be used for any characteristics value which is not possible
426
425
  &nbsp;&nbsp;&nbsp; For history to be collected you will have to enable polling and interval for the accessory, and according to the fakegato-history documents it should be less than 10 minutes (600 seconds). The new polling config section allows for each characteristic to be polled at their individual times.
427
426
 
428
427
  ```json
429
- "polling": [{"Characteristic": "CurrentHeatingCoolingState",
428
+ "polling": [{"characteristic": "currentHeatingCoolingState",
430
429
  "interval": 540, "timeout": 4000},
431
- {"Characteristic": "CurrentTemperature",
430
+ {"characteristic": "currentTemperature",
432
431
  "interval": 60, "timeout": 4000}
433
432
  ],
434
433
  ```