Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Node-RED BigTimer Outputs Documentation

BigTimer Outputs Documentation

Sample Node Configuration

Node Property Value Node Property Value
Name Big Timer
Comment empty
On Time Dusk Off Time 23:45
On Time2 13:00 Off Time2 13:15
On Offset 0 Off Offset 0
On Offset2 -10 Off Offset2 -14
Latitude XX.XXX Longitude -XX.XXX
Topic Msg mqtt_topic Man UTC 0
ON Msg mqtt_payload_on OFF Msg mqtt_payload_off
ON Text text_on
OFF Text text_off
Timeout 1440

Output1

This output is not yet documented.


Output2

Output2 is useful for getting the current status of the BigTimer node.


msg.payload

Current state of the BigTimer node.

Value Description
0 OFF
1 ON as a result of On Time
2 ON as a result of On Time2

msg.reference

πŸ•“

A colon (:) delimited string containing the properties Topic Msg, ON Msg and OFF Msg, as well as the current number of minutes past midnight (see also msg.now).

<Topic Msg>:<ON Msg>:<OFF Msg>:<msg.now>

Example: mqtt_topic:mqtt_payload_on:mqtt_payload_off:767


msg.topic

The literal string status.


msg.state

A string representation of the current state.

Value Description
OFF Auto OFF as a result of Off Time or Off Time2
OFF Override OFF as a result of manual override from input/injection
ON Auto ON as a result of On Time or On Time2
ON Override ON as a result of manual override from input/injection

msg.time

A string representation of the time remaining until the next scheduled trigger.

Example: 08hrs 23mins


msg.name

The Name property from the BigTimer node configuration.

Example: Big Timer


msg.start

πŸ•“

Time (in number of minutes past midnight) at which the BigTimer node will turn ON.

Example: 1270 = 21:10 (9:10pm)


msg.end

πŸ•“

Time (in number of minutes past midnight) at which the BigTimer node will turn OFF.

Example: 1425 = 23:45 (11:45pm)


msg.dusk

πŸ•“ 🌐

Time (in number of minutes past midnight) at which dusk occurs.

Example: 1270 = 21:10 (9:10pm)


msg.dawn

πŸ•“ 🌐

Time (in number of minutes past midnight) at which dawn occurs.

Example: 355 = 05:55 (5:55am)


msg.solarNoon

πŸ•“ 🌐

Time (in number of minutes past midnight) at which the sun reaches its highest position in the sky.

Example: 813 = 13:33 (1:33pm)


msg.sunrise

πŸ•“ 🌐

Time (in number of minutes past midnight) at which the sun crosses above the horizon.

Example: 384 = 06:24 (6:24am)


msg.sunset

πŸ•“ 🌐

Time (in number of minutes past midnight) at which the sun crosses below the horizon.

Example: 1241 = 20:41 (8:41pm)


msg.night

πŸ•“ 🌐

This value is not yet documented.

Example: 1343 = 22:23 (10:23pm)


msg.nightEnd

πŸ•“ 🌐

This value is not yet documented.

Example: 282 = 04:42 (4:42am)


msg.moonrise

πŸ•“ 🌐

Time (in number of minutes past midnight) at which the moon crosses above the horizon.

Example: 132 = 02:12 (2:12am)


msg.moonset

πŸ•“ 🌐

Time (in number of minutes past midnight) at which the moon crosses below the horizon.

Example: 888 = 14:48 (2:48pm)


msg.now

πŸ•“

The current time, represented as the number of minutes past midnight.

Example: 767 = 12:47 (12:47pm)


msg.timer

This value is not yet documented.

Example: 0


msg.duration

This value is not yet documented.

Example: 503


msg.onOverride

This value is not yet documented.

Example: -1


msg.offOverride

This value is not yet documented.

Example: -1


msg.stamp

The current time, represented as the number of milliseconds that have elapsed since 1970-01-01 00:00:00.000 UTC.

Example: 1561571252819 = 2019-06-26 17:47:32.819 UTC


msg.extState

This value is not yet documented.

Example: Off for 08hrs 23mins


msg._msgid

A unique ID assigned to this particular set of messages.

Example: 4edf841c.31301c


Output3

This output is not yet documented.


Footnotes

🌐 This value is based on the Latitude and Longitude properties.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment