homebridge-cmd4 7.0.0 → 7.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.
@@ -2,8 +2,11 @@
2
2
  <base _target="_self">
3
3
  ## Homebridge UI User. Do not click on any inline links. Homebridge UI does not supprt them. Bug#1098
4
4
 
5
+
5
6
  ## ChangeLog
6
- * <a href="#Whats-new-in-6-3-1">**Whats new in 7.0.0**</a>
7
+ <a name="Whats-new-in-7-0-1">## Whats new in 7.0.0</a>
8
+ #### 7.0.0 (2023-06-11)
9
+ * <a href="#Whats-new-in-7.0.0">**Whats new in 7.0.0**</a>
7
10
  * <a href="#Whats-new-in-6-3-0">**Whats new in 6.3.0**</a>
8
11
  * <a href="#Whats-new-in-6-2-0">**Whats new in 6.2.0**</a>
9
12
  * <a href="#Whats-new-in-6-1-2">**Whats new in 6.1.2**</a>
@@ -85,7 +88,19 @@
85
88
  * <a href="#Whats-new-in-2-1">**Whats new in 2.1**</a>
86
89
  * <a href="#Whats-new-in-2-0">**Whats new in 2.0**</a>
87
90
 
88
- <a name="Whats-new-in-6-3-1">## Whats new in 6.3.1</a>
91
+ ## ChangeLog
92
+ * <a href="#Whats-new-in-7-0-1">**Whats new in 7.0.1**</a>
93
+
94
+
95
+ ##### Chores
96
+
97
+ * Correct version to 7.0.1 ([62504e68](https://github.com/ztalbot2000/homebridge-cmd4/commit/62504e689a9483a9512a414d994514b04cbadcd5))
98
+
99
+ ##### Bug Fixes
100
+
101
+ * bug[#139](https://github.com/ztalbot2000/homebridge-cmd4/pull/139), add in link checkers to documentation ([f4a1ae79](https://github.com/ztalbot2000/homebridge-cmd4/commit/f4a1ae79fd8da2e0dc80181ab98dbc4817da6e78))
102
+
103
+ <a name="Whats-new-in-7-0-0">## Whats new in 7.0.0</a>
89
104
  #### 7.0.0 (2023-03-05)
90
105
 
91
106
  * The reason for the major version numbering update was to for deprecation warnings to throw an error.
@@ -106,8 +121,18 @@
106
121
 
107
122
  * add retries. Also formatting issues ([b8ddf9ce](https://github.com/ztalbot2000/homebridge-cmd4/commit/b8ddf9ceda8ace3a6e820bfad0c4a03c656cf419))
108
123
 
124
+ ##### Documentation Changes
125
+
126
+ Beta2
127
+ * Update documentation for v7.0.0 ([12b6482a](https://github.com/ztalbot2000/homebridge-cmd4/commit/12b6482ac8e6d431e011f6f92c2d6f03a2ebe2ed))
128
+
109
129
  ##### Bug Fixes
110
130
 
131
+ Beta2
132
+ * remove unwanted debug message and test so that it cannot reoccur ([97b6b318](https://github.com/ztalbot2000/homebridge-cmd4/commit/97b6b31861ab34d04b798ec409b1f2e8c56244c2))
133
+ * Homebridge does not like underscores of accessory names. Remove from default config.json ([15f2170b](https://github.com/ztalbot2000/homebridge-cmd4/commit/15f2170be492b6dfb56e4eed5d76da0cd4d74419))
134
+
135
+ Beta1
111
136
  * retry logging starts from zero, but for user count starts from 1 ([38cdf417](https://github.com/ztalbot2000/homebridge-cmd4/commit/38cdf417feebeef2b75dcfec247e6bdfd4739604))
112
137
  * By nature retryCount should start from zero ([b8e82ffe](https://github.com/ztalbot2000/homebridge-cmd4/commit/b8e82ffe262c092a301636993544be828a7a34a4))
113
138
  * log message in wrong quotes ([6fc555b0](https://github.com/ztalbot2000/homebridge-cmd4/commit/6fc555b0d7bdc20bfc3a38310e3d4f66b968d55d))
@@ -201,30 +201,25 @@ Notice that there is no Platform definition. Otherwise everything is the same. Y
201
201
 
202
202
  &nbsp;&nbsp;&nbsp; Typically polling is pretty much a free for all. While Cmd4 tries to eleviate this with staggered polling, Cmd4 supports two kinds of Priority Queued Polling; that being "Sequential" and "WoRm" ( Write Once Read Many). If configured correctly, only one Set characteristic value can be sent or either one or multiple Gets from a device at a time. The priority given to requests from IOS first and background polling second.<BR>
203
203
  <BR>
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:
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.<BR>
205
+ The retries defaults to zero for "Get" commands from homebridge. You can alter this value as you like.<BR>
206
+ For Example of the default WoRm is:
205
207
 
206
208
  ```json
207
- "interval": 5,
208
- "polling": [ { "characteristic": "currentTemperature", "queue": "A" },
209
- { "characteristic": "targetTemperature", "queue": "A" }
210
- ]
209
+ "queueTypes": [ { "queue": "A", "queueType": "WoRm", "retries": 0 } ],
210
+ "accessories": [
211
+ {
212
+ "interval": 5,
213
+ "queue: "A",
214
+ "polling": [ { "characteristic": "currentTemperature" },
215
+ { "characteristic": "targetTemperature", "interval": 15 }
216
+ ]
217
+ }
211
218
  ```
212
219
  The interval of the characteristic is defined through the heirarch of the Platform/Accessory and then the Characteristic, as always.<BR>
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:
214
-
215
- ```json
216
- "queueTypes: [ { "queue": "A" : "queueType": "WoRm" }
217
- ],
218
- "queue": "A",
219
- "interval": 10,
220
- "polling": [ { "characteristic": "currentTemperature" },
221
- { "characteristic": "targetTemperature", "interval": 15 }
222
- ]
223
- ```
224
- Example 3:
220
+ Example 2:
225
221
 
226
222
  ```json
227
- "queueTypes: [ { "queue": "A" : "queueType": "WoRm" }
228
223
  "platforms":
229
224
  [ { "platform": "Cmd4",
230
225
  "interval": "10",
@@ -232,7 +227,6 @@ Example 3:
232
227
  { "queue": "B" : "queueType": "Sequential" }
233
228
  { "queue": "C" } // Defaults to "WoRm"
234
229
  ],
235
-
236
230
  "accessories": [
237
231
  {
238
232
  "name": "My_Thermostat",
@@ -262,7 +256,8 @@ Example 3:
262
256
  {
263
257
  "name": "Switch2",
264
258
  "type": "Switch",
265
- "polling": [ { "characteristic": "on", "queue": "D" } ], // Defaults to "WoRm"
259
+ "queue": "D", // Defaults to WoRm
260
+ "polling": [ { "characteristic": "on" } ],
266
261
  ...
267
262
  }
268
263
 
@@ -292,8 +287,9 @@ Example 3:
292
287
  "manufacturer": "Advantage Air Australia",
293
288
  "model": "e-zone",
294
289
  "serialNumber": "Fujitsu e-zone2",
290
+ "queue": "A",
295
291
  "polling": [
296
- { "characteristic": "currentTemperature", "queue": "A" }
292
+ { "characteristic": "currentTemperature" }
297
293
  ],
298
294
  "props": {
299
295
  "currentTemperature": {
@@ -313,8 +309,9 @@ Example 3:
313
309
  "manufacturer": "Advantage Air Australia",
314
310
  "model": "e-zone",
315
311
  "serialNumber": "Fujitsu e-zone2",
312
+ "queue": "A",
316
313
  "polling": [
317
- { "characteristic": "On", "queue": "A" }
314
+ { "characteristic": "On" }
318
315
  ],
319
316
  "state_cmd": "bash /home/pi/zones.sh",
320
317
  "state_cmd_suffix": "z05"
@@ -327,8 +324,9 @@ Example 3:
327
324
  "manufacturer": "Advantage Air Australia",
328
325
  "model": "e-zone",
329
326
  "serialNumber": "Fujitsu e-zone2",
327
+ "queue": "A",
330
328
  "polling": [
331
- { "characteristic": "on", "queue": "A" }
329
+ { "characteristic": "on" }
332
330
  ],
333
331
  "stateChangeResponseTime": 1,
334
332
  "state_cmd": "bash /home/pi/ezone.sh"
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "homebridge-cmd4",
3
3
  "description": "Exec Plugin for Homebridge supporting all accessorys and characteristics",
4
- "version": "7.0.0",
4
+ "version": "7.0.1",
5
5
  "license": "MIT",
6
6
  "author": {
7
7
  "name": "John Talbot"
@@ -33,6 +33,7 @@
33
33
  "eslint": "^7.17.0",
34
34
  "generate-changelog": "^1.8.0",
35
35
  "husky": "^4.3.8",
36
+ "link-checker": "^1.4.2",
36
37
  "markdown-link-check": "^3.8.6",
37
38
  "mocha": "^8.0.1",
38
39
  "node-persist": "^0.0.11",
@@ -82,7 +83,8 @@
82
83
  "allTests": "node_modules/.bin/mocha --bail --file test/mocha-setup $( cat test/allTests )",
83
84
  "sanityTests": "node_modules/.bin/mocha --bail --file test/mocha-setup $( cat test/sanityTests )",
84
85
  "_Note0": "Excluded from commit as may fail for probing GitHub to much",
85
- "testMarkDown": "markdown-link-check ./README.md && markdown-link-check ./CHANGELOG.md",
86
+ "testMarkDown": "markdown-link-check ./README.md && markdown-link-check ./CHANGELOG.md && markdown-link-check ./docs/AdvancedTroubleShooting.md && markdown-link-check ./docs/Developers.md",
87
+ "testAutoGeneratedDocLinks": "link-checker docs/autoGenerated/CMD4_AccessoryDescriptions.html",
86
88
  "commitTests": "npm run test && npm run testMarkDown",
87
89
  "_Note": "Excluded only because they sometimes fail, but pass alone. ",
88
90
  "testCmd4Accessory": "node_modules/.bin/mocha --file test/mocha-setup test/Cmd4Accessory.js",