@mschaeffler/node-red-bthome 1.9.0 → 1.9.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.
Files changed (3) hide show
  1. package/README.md +8 -8
  2. package/bthome.html +11 -6
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -90,7 +90,7 @@ There are two output ports:
90
90
 
91
91
  |config | type | description |
92
92
  |:------------|:-------|:----------------------------------|
93
- |Devices | JSON | configuration of the BT-Home devices |
93
+ |Devices | object | configuration of the BT-Home devices |
94
94
  |counter is time|Boolean| the counter in encrypted messages is checked again the actual time |
95
95
  |Status-Prefix| string | prefix for the topic for state output |
96
96
  |Event-Prefix | string | prefix for the topic for event output |
@@ -99,12 +99,12 @@ There are two output ports:
99
99
 
100
100
  #### Device-Configuration
101
101
 
102
- With this JSON string the installed [BT-Home](https://bthome.io) devices are configured:
103
- ```
104
- {
105
- "<mac address of the device in lower case>": { "topic": "<name of the device>", "key": "<encryption key, if device is encrypted>" }
106
- }
107
- ```
102
+ The installed [BT-Home](https://bthome.io) devices are configured with:
103
+ |config | type | description |
104
+ |:--------|:---------|:----------------------------------|
105
+ |mac |hex string| mac address of the device in lower case.|
106
+ |name |string | name of the device.|
107
+ |key |hex string| encryption key, if device is encrypted.|
108
108
 
109
109
  An example for such a config from the unit tests:
110
110
  ```
@@ -174,7 +174,7 @@ This is an example of such a message payload:
174
174
  "precipitation": 121.5
175
175
  }
176
176
  ```
177
-
177
+
178
178
  ### Outputs
179
179
 
180
180
  There are 12 output ports:
package/bthome.html CHANGED
@@ -238,7 +238,7 @@
238
238
 
239
239
  <h3>Parameters</h3>
240
240
  <dl class="message-properties">
241
- <dt>Devices <span class="property-type">JSON</span></dt>
241
+ <dt>Devices <span class="property-type">object</span></dt>
242
242
  <dd> configuration of the BT-Home devices.</dd>
243
243
  <dt>counter is times <span class="property-type">Boolean</span></dt>
244
244
  <dd> the counter in encrypted messages is checked again the actual time.</dd>
@@ -251,14 +251,19 @@
251
251
  <dt>Contextstore <span class="property-type">string</span></dt>
252
252
  <dd> context store to be used.</dd>
253
253
  <dt>battery is state <span class="property-type">Boolean</span></dt>
254
- <dd> battery level is included in state mesage.</dt>
254
+ <dd> battery level is included in state mesage.</dd>
255
255
  </dl>
256
256
 
257
257
  <h4>Device-Configuration</h4>
258
- <p>With this JSON string the installed <a href="https://bthome.io">BT-Home</a> devices are configured:</p>
259
- <pre><code>{
260
- "<mac address of the device in lower case>": { "topic": "<name of the device>", "key": "<encryption key, if device is encrypted>" }
261
- }</code></pre>
258
+ <p>The installed <a href="https://bthome.io">BT-Home</a> devices are configured with:</p>
259
+ <dl class="message-properties">
260
+ <dt>mac <span class="property-type">hex string</span></dt>
261
+ <dd> mac address of the device in lower case.</dd>
262
+ <dt>name <span class="property-type">string</span></dt>
263
+ <dd> name of the device.</dd>
264
+ <dt>key <span class="property-type">hex string</span></dt>
265
+ <dd> encryption key, if device is encrypted.</dd>
266
+ </dl>
262
267
 
263
268
  <p>An example for such a config from the unit tests:</p>
264
269
  <pre><code>{
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mschaeffler/node-red-bthome",
3
- "version": "1.9.0",
3
+ "version": "1.9.1",
4
4
  "description": "A Node Red node to decrypt and decode BT-Home frames",
5
5
  "author": {
6
6
  "name": "Mathias Schäffler",