@mschaeffler/node-red-hourmeter 0.2.2 → 0.2.3

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/README.md CHANGED
@@ -12,7 +12,7 @@ $ npm install @mschaeffler/node-red-hourmeter
12
12
 
13
13
  ## Usage
14
14
 
15
- The counter is started / stopped accortding to the value of the payload:
15
+ The counter is started / stopped according to the value of the payload:
16
16
 
17
17
  |type|value|counter is|
18
18
  |:---|:----|:--------------|
@@ -29,7 +29,7 @@ The counter is started / stopped accortding to the value of the payload:
29
29
  ||on|started|
30
30
  ||start|started|
31
31
 
32
- A [local filesystem context store](https://nodered.org/docs/user-guide/context#saving-context-data-to-the-file-system) called `storeInFile` is needed to store the internal data.
32
+ A [local filesystem context store](https://nodered.org/docs/user-guide/context#saving-context-data-to-the-file-system) called `storeInFile` is needed to store the internal data.
33
33
 
34
34
  ### Input
35
35
 
@@ -51,7 +51,7 @@ A [local filesystem context store](https://nodered.org/docs/user-guide/context#s
51
51
 
52
52
  |msg. | type | description |
53
53
  |:-------|:-------|:----------------------------------|
54
- |payload | number | Value of the hour counter|
54
+ |payload | number | Value of the hour counter.|
55
55
 
56
56
  ### Parameters
57
57
 
package/hourmeter.html CHANGED
@@ -39,6 +39,54 @@
39
39
 
40
40
  <script type="text/html" data-help-name="hourmeter">
41
41
  <p>A working hour meter for NodeRed.</p>
42
- <p>
43
- </p>
42
+
43
+ <p>The counter is started / stopped according to the value of the payload:</p>
44
+ <table>
45
+ <tr> <th>type</th> <th>value</th> <th>counter is</th> </tr>
46
+ <tr> <td>boolean</td> <td>false</td> <td>stopped</td> </tr>
47
+ <tr> <td></td> <td>true</td> <td>started</td> </tr>
48
+ <tr> <td>number</td> <td>0</td> <td>stopped</td> </tr>
49
+ <tr> <td></td> <td>1</td> <td>started</td> </tr>
50
+ <tr> <td>string</td> <td>false</td> <td>stopped</td> </tr>
51
+ <tr> <td></td> <td>true</td> <td>started</td> </tr>
52
+ <tr> <td></td> <td>0</td> <td>stopped</td> </tr>
53
+ <tr> <td></td> <td>1</td> <td>started</td> </tr>
54
+ <tr> <td></td> <td>off</td> <td>stopped</td> </tr>
55
+ <tr> <td></td> <td>on</td> <td>started</td> </tr>
56
+ </table>
57
+
58
+ <p>A <a href="https://nodered.org/docs/user-guide/context#saving-context-data-to-the-file-system">local filesystem context store</a>] called <code>storeInFile</code> is needed to store the internal data.</p>
59
+
60
+ <h3>Input</h3>
61
+ <dl class="message-properties">
62
+ <dt>payload <span class="property-type"></span></dt>
63
+ <dd> Starts or stopps the counting.</dd>
64
+ <dt>reset <span class="property-type">boolean</span></dt>
65
+ <dd> If true, resets the counter to 0.</dd>
66
+ <dt>querry <span class="property-type">boolean</span></dt>
67
+ <dd> If true, just querries the state of the counter.</dd>
68
+ </dl>
69
+
70
+ <h3>Outputs</h3>
71
+
72
+ <h4>boolean value</h4>
73
+ <dl class="message-properties">
74
+ <dt>payload <span class="property-type">boolean</span></dt>
75
+ <dd> Is counting active?</dd>
76
+ </dl>
77
+
78
+ <h4>hour counter</h4>
79
+ <dl class="message-properties">
80
+ <dt>payload <span class="property-type">number</span></dt>
81
+ <dd> Value of the hour counter.</dd>
82
+ </dl>
83
+
84
+ <h3>Parameters</h3>
85
+ <dl class="message-properties">
86
+ <dt>topic <span class="property-type">string</span></dt>
87
+ <dd> Topic to send output values with.</dd>
88
+ <dt>cycle <span class="property-type">number</span></dt>
89
+ <dd> Cyclic time of output; 0 is only at state change.</dd>
90
+ </dl>
91
+
44
92
  </script>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mschaeffler/node-red-hourmeter",
3
- "version": "0.2.2",
3
+ "version": "0.2.3",
4
4
  "description": "A working hour meter for NodeRed.",
5
5
  "license": "LGPL-2.1",
6
6
  "homepage": "https://github.com/m-schaeffler/node-red-my-nodes/tree/main/node-red-hourmeter",