1
0
mirror of https://github.com/node-red/node-red-nodes.git synced 2023-10-10 13:36:58 +02:00
node-red-nodes/time/timeswitch/README.md

37 lines
1.3 KiB
Markdown
Raw Normal View History

2015-11-02 18:24:27 +01:00
node-red-node-timeswitch
========================
A <a href="http://nodered.org" target="_new">Node-RED</a> node to provide a
simple timeswitch node to schedule daily on/off events.
Install
-------
2022-08-23 15:43:34 +02:00
You can install by using the `Menu - Manage Palette` option, or running the following command in your
Node-RED user directory - typically `~/.node-red`
2015-11-02 18:24:27 +01:00
2022-08-23 15:43:34 +02:00
cd ~/.node-red
npm i node-red-node-timeswitch
2015-11-02 18:24:27 +01:00
Usage
-----
Sets `msg.payload` to *1* during on times, and *0* during off times.
2015-11-02 18:24:27 +01:00
Also uses the suncalc module to allow use of dawn and dusk.
Dawn and dusk times can be offset both positively (+ve) for minutes after dawn
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
2015-11-02 18:24:27 +01:00
whether the current time is during the selected on time or off time.
2022-08-23 15:43:34 +02:00
If you just need the transitions from 0->1 or 1->0 then follow this node with a `filter (RBE)` node.
2015-11-02 18:24:27 +01:00
You may also optionally specify a `msg.topic` if required.
2015-11-02 18:24:27 +01:00
2022-08-23 15:43:34 +02:00
**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, 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.