Slight tidy of readme

This commit is contained in:
Dave Conway-Jones 2022-08-23 14:43:34 +01:00
parent bb53ef7137
commit da094fa70f
No known key found for this signature in database
GPG Key ID: 88BA2B8A411BE9FF
2 changed files with 10 additions and 6 deletions

View File

@ -7,9 +7,11 @@ simple timeswitch node to schedule daily on/off events.
Install Install
------- -------
Run the following command in your Node-RED user directory - typically `~/.node-red` You can install by using the `Menu - Manage Palette` option, or running the following command in your
Node-RED user directory - typically `~/.node-red`
npm install node-red-node-timeswitch cd ~/.node-red
npm i node-red-node-timeswitch
Usage Usage
----- -----
@ -24,9 +26,11 @@ or dusk, and negatively (-ve) for minutes before dawn or dusk..
The output emits a `msg.payload` of *1* or *0* every minute depending on The output emits a `msg.payload` of *1* or *0* every minute depending on
whether the current time is during the selected on time or off time. whether the current time is during the selected on time or off time.
If you just need the transitions from 0->1 or 1->0 then follow this node with an RBE node. If you just need the transitions from 0->1 or 1->0 then follow this node with a `filter (RBE)` node.
You may also optionally specify a `msg.topic` if required. You may also optionally specify a `msg.topic` if required.
**Note**: For a more complex version with more built-in options see Pete Scargill's **Note**: For a more complex version with more built-in options see
[node-red-contrib-bigtimer](http://flows.nodered.org/node/node-red-contrib-bigtimer) node. [node-red-contrib-bigtimer](http://flows.nodered.org/node/node-red-contrib-bigtimer) node, or
for multiple schedules and a nice visual interface to cron then use Steve's
[node-red-contrib-cron-plus](https://flows.nodered.org/node/node-red-contrib-cron-plus) node.

View File

@ -7,6 +7,6 @@
or negatively (-ve) for minutes earlier.</p> or negatively (-ve) for minutes earlier.</p>
<p>The output emits a <code>msg.payload</code> of <i>1</i> or <i>0</i> every minute depending on <p>The output emits a <code>msg.payload</code> of <i>1</i> or <i>0</i> every minute depending on
whether the current time is during the selected on time or off time.</p> whether the current time is during the selected on time or off time.</p>
<p>If you just need the transitions from 0->1 or 1->0 then follow this node with an RBE node.</p> <p>If you just need the transitions from 0->1 or 1->0 then follow this node with a filter (RBE) node.</p>
<p>You may also optionally specify a <code>msg.topic</code> if required.</p> <p>You may also optionally specify a <code>msg.topic</code> if required.</p>
</script> </script>