node-red-contrib-sunevents 2.0.3

A node for node-red that generates events based on the position of the Sun at the appropriate time of day

npm install node-red-contrib-sunevents

A node for node-red that generates events based on the location of the Sun at the appropriate time of day.

Outputs an object called msg containing the event name in msg.payload and the event date & time in msg.datetime. The msg.topic can be set in the node's configuration or it will default to the node name or "sun events". You will need to configure this node with the latitude and longitude of the location you want the events to operate in.

Calculations are performed using the excellent SunCalc module (https://github.com/mourner/suncalc) and the resulting sun events are output from this node at the appropriate time:

  • sunrise: sunrise (top edge of the sun appears on the horizon)
  • sunriseEnd: sunrise ends (bottom edge of the sun touches the horizon)
  • goldenHourEnd: morning golden hour (soft light, best time for photography) ends
  • solarNoon: solar noon (sun is in the highest position)
  • goldenHour: evening golden hour starts
  • sunsetStart: sunset starts (bottom edge of the sun touches the horizon)
  • sunset: sunset (sun disappears below the horizon, evening civil twilight starts)
  • dusk: dusk (evening nautical twilight starts)
  • nauticalDusk: nautical dusk (evening astronomical twilight starts)
  • night: night starts (dark enough for astronomical observations)
  • nightEnd: night ends (morning astronomical twilight starts)
  • nauticalDawn: nautical dawn (morning nautical twilight starts)
  • dawn: dawn (morning nautical twilight ends, morning civil twilight starts)
  • nadir: nadir (darkest moment of the night, sun is in the lowest position)

This node can be used to make something happen based on a particular period of the day, for example switching on your lights at home at dusk every day.

How does it work

When you first deploy the node (or start your node-red), this node calculates when each sun event will happen that day and schedules timer events for each sun event that has not already passed. It then schedules a job to repeat the same calculations for the next day at midnight and so on. The suncalc library this node depends on calculates all the sun events for the current day, so this node has to be triggered every day at midnight to set up the timers for the following day. If you enable the "Log event calculations?", you will be able to see all these calculations taking place each day.

Example Flow

I use this node in my own set up to turn on house lights at dusk. The whole system runs on a Raspberry Pi we have hanging on the wall. The lights are controlled by a RFXCom RFXTRX433 USB device. Sitting between the Sunevents node and the RFX node is an MQTT persistent topic to hold system state, so if the Raspberry Pi is rebooted at any point during the day the system knows exactly what state it was in before the reboot. This set up has been running with very little manual intervention for 5 or 6 years in two different homes. At Christmas time it gets extended to switch on our outdoor Christmas lights too.

Example Flow

Say Thanks

If you find this useful and you want to say thanks, feel free to buy me a coffee using the link below.

Say Thanks

History

Version Date Description
2.0.3 2020-03-03 Updated Readme and docs
2.0.2 2020-02-28 More debugging and closer attention to anywhere where timezones could cause an issue
2.0.1 2020-02-27 Improved unit testing, example flow
2.0.0 2020-02-24 Updated to run on node-red 1.0.3 and node.js 12.11
0.5 2015-03-02 Original released version

Node Info

Version: 2.0.3
Updated 8 months, 2 weeks ago
License: Apache-2.0
Rating: 4.0 1

Downloads

24 in the last day
191 in the last week
871 in the last month

Nodes

  • sun events

Keywords

  • node-red
  • suncalc
  • sunrise
  • sunset

Maintainers