node-red-contrib-eztimer - npm Package Compare versions

Comparing version 1.0.6 to 1.0.7

index.js

@@ -0,1 +1,3 @@
+const util = require('util');
+
 /* eslint-disable no-invalid-this,consistent-this */
@@ -358,3 +360,4 @@ /**
             callback(events.on, 'topic', 'ontopic', String);
-            callback(events.on, 'payload', 'onpayload', String);
+            callback(events.on, 'value', 'triggervalue', String);
+            callback(events.on, 'value', 'onvalue', String);
             callback(events.on, 'offset', 'onoffset', Number);
@@ -364,3 +367,3 @@ callback(events.on, 'randomoffset', 'onrandomoffset', toBoolean);
             callback(events.off, 'topic', 'offtopic', String);
-            callback(events.off, 'payload', 'offpayload', String);
+            callback(events.off, 'value', 'offvalue', String);
             callback(events.off, 'offset', 'offoffset', Number);
@@ -367,0 +370,0 @@ callback(events.off, 'randomoffset', 'offrandomoffset', toBoolean);

package.json

 {
     "name": "node-red-contrib-eztimer",
-    "version": "1.0.6",
+    "version": "1.0.7",
     "description": "A simple-yet-flexible timer/scheduler for node-red",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -82,3 +82,4 @@ # eztimer
 | `msg.payload.ontopic`         | String value emitted as the topic for the on event                    |
-| `msg.payload.onpayload`       | String value emitted as the payload for the on event                  |
+| `msg.payload.onvalue`         | Update output value for on event (must be same as configured type)    |
+| `msg.payload.triggervalue`    | Alias of `onvalue`                                                    |
 | `msg.payload.onoffset`        | Number value as specified above for Offset configuration              |
@@ -88,3 +89,3 @@ | `msg.payload.onrandomoffset`  | Boolean value as specified above in Randomisation of Times            |
 | `msg.payload.offtopic`        | String value emitted as the topic for the off event                   |
-| `msg.payload.offpayload`      | String value emitted as the payload for the off event                 |
+| `msg.payload.offvalue`        | Update output value for off event (must be same as configured type)   |
 | `msg.payload.offoffset`       | Number value as specified above for Offset configuration              |
@@ -100,22 +101,9 @@ | `msg.payload.offrandomoffset` | Boolean value as specified above in Randomisation of Times            |
 
-Alternatively, you can send msg.payload as a string with the following values:
+# Change Log
+## 1.0.7
+* Corrected commands to set output value for on/off events - `onvalue` and `offvalue` are more correct, as it's not necessarily the payload you're updating. 
+* Added `triggervalue` as an alias to `onvalue`.
+* Values must match the configured value type.
+* Removed the string command examples as they don't function correctly - the payload must be a JSON object to update a property value.
 
-| Example msg.payload                            | Description                                                  |
-| ---------------------------------------------- | ------------------------------------------------------------ |
-| `suspended true`                               | true will suspend scheduling, false will resume scheduling   |
-| `ontime 12:00`                                 | Time as specified in the table above for time configuration  |
-| `ontopic my_topic`                             | Sets the topic for the on event (no spaces)                  |
-| `onpayload my_payload`                         | Sets the payload for the on event (no spaces)                |
-| `onoffset 30`                                  | Sets the offset for the on event                             |
-| `onrandomoffset true`                          | Sets the random offset for the on event                      |
-| `offtime dusk`                                 | Time as specified in the table above for time configuration  |
-| `offtopic my_topic`                            | Sets the topic for the off event (no spaces)                 |
-| `offpayload my_payload`                        | Sets the payload for the off event (no spaces)               |
-| `offoffset -30`                                | Sets the offset for the off event                            |
-| `offrandomoffset false`                        | Sets the random offset for the off event                     |
-| `mon false`                                    | Disables the schedule on a Monday                            |
-| `tue true`                                     | Enables the schedule on a Tuesday                            |
-| `ontime 16:30 onoffset 60 onrandomoffset true` | Sets the time, offset and random offset for the on event     |
-
-# Change Log
 ## 1.0.6
@@ -122,0 +110,0 @@ * Enabled startup events for `trigger`, configured off by default.  Caution required due to this being on by default for exisitng nodes.

No alert changes

Improved metrics

Total package byte prevSize

4658109

increased by6937.48%

Number of package files

12

increased by33.33%

Lines of code

727

increased by0.97%

Worsened metrics

Number of lines in readme file

111

decreased by-9.76%

No dependency changes