Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
node-red-contrib-sun-position
Advanced tools
This is a ultimate Node-Red Timer based flow control with dusk, dawn (and variations) and much more. Addidional you can get sun and moon position or to control a flow by sun or moon position. It is ideal for usage of control smart home, but also for all other time based flow control.
This is still in development! This is not fully tested and documentation are missing!
npm install node-red-contrib-sun-position
tbd
The nodes are designed to do not calculate time events with every arriving message or with an interval every x time. This is to be able to handle a huge amount of messages also on even on computers with low resources.
The nodes are designed to be accurate to seconds. This means it was designed to turn on/off at exact given second. Other timers often work using intervals where they check your schedule only once a minute or even less. This means when you want something to come on at 08:00am, it may actually not come on until 30 seconds later. This nodes does not have this problem, it will come on at exactly 08:00:00am.
The node calculates the current sun position on any input message.
[{"id":"fc962ea1.197a3","type":"inject","z":"de4e9c38.0d942","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":120,"y":300,"wires":[["56265aeb.99f034"]]},{"id":"a0d0e562.7ad1d8","type":"debug","z":"de4e9c38.0d942","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","x":570,"y":300,"wires":[]},{"id":"56265aeb.99f034","type":"sun-position","z":"de4e9c38.0d942","name":"","positionConfig":"2831ba70.55a636","rules":[{"valueLow":"10","valueLowType":"num","valueHigh":"100","valueHighType":"num"}],"onlyOnChange":"true","topic":"","outputs":2,"x":330,"y":300,"wires":[["a0d0e562.7ad1d8","9cc2d51.4ac0828","28e91.9d63d16f6"],["e921e01a.a0fa3"]]},{"id":"9cc2d51.4ac0828","type":"change","z":"de4e9c38.0d942","name":"azimuth","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload.azimuth","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":560,"y":340,"wires":[["e866e950.a7f798"]]},{"id":"28e91.9d63d16f6","type":"change","z":"de4e9c38.0d942","name":"altitude","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload.altitude","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":560,"y":380,"wires":[["5b085e1b.4ec8a"]]},{"id":"e921e01a.a0fa3","type":"debug","z":"de4e9c38.0d942","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","x":550,"y":420,"wires":[]},{"id":"e866e950.a7f798","type":"debug","z":"de4e9c38.0d942","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","x":750,"y":340,"wires":[]},{"id":"5b085e1b.4ec8a","type":"debug","z":"de4e9c38.0d942","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","x":750,"y":380,"wires":[]},{"id":"2831ba70.55a636","type":"position-config","z":"","name":"Kap-Halbinsel","longitude":"-34.357051","latitude":"18.473782","angleType":"deg"}]
The Input is for triggering the calculation. If limits are defined the input message will send to the output associated to the limit.
msg.payload.azimuth
the azimuth of the sun position relative to the given coordinates.msg.payload.altitude
the altitude/elevation of the sun position relative to the given coordinates.msg.payload.times
the sun times as object.
msg.payload.times.astronomicalDawn
night ends (morning astronomical twilight starts)msg.payload.times.amateurDawn
amateur astronomical dawn (sun at 12° before sunrise)msg.payload.times.nauticalDawn
nautical dawn (morning nautical twilight starts)msg.payload.times.blueHourDawnStart
blue Hour start (time for special photography photos starts)msg.payload.times.civilDawn
dawn (morning nautical twilight ends, morning civil twilight starts)msg.payload.times.blueHourDawnEnd
blue Hour end (time for special photography photos starts)msg.payload.times.sunrise
sunrise (top edge of the sun appears on the horizon)msg.payload.times.sunriseEnd
sunrise ends (bottom edge of the sun touches the horizon)msg.payload.times.goldenHourEnd
morning golden hour (soft light, best time for photography) endsmsg.payload.times.solarNoon
solar noon (sun is in the highest position)msg.payload.times.goldenHourStart
evening golden hour startsmsg.payload.times.sunsetStart
sunset starts (bottom edge of the sun touches the horizon)msg.payload.times.sunset
sunset (sun disappears below the horizon, evening civil twilight starts)msg.payload.times.blueHourDuskStart
nautical dusk start (evening astronomical twilight starts)msg.payload.times.civilDusk
dusk (evening nautical twilight starts)msg.payload.times.blueHourDuskEnd
nautical dusk end (evening astronomical twilight starts)msg.payload.times.amateurDusk
amateur astronomical dusk (sun at 12° after sunrise)msg.payload.times.astronomicalDusk
night starts (dark enough for astronomical observations)msg.payload.times.nadir
nadir (darkest moment of the night, sun is in the lowest position)msg.payload.pos
array with a boolean of every defined limit of the azimuth, which is true if the azimuth is inside the limit.msg.payload.posChanged
boolean which is true if any of the defined limit of the azimuth has changed to the last calculation. {
"lastUpdate": "2018-11-11T11:11:11.111Z",
"latitude": "18.473782",
"longitude": "-34.357051",
"angleType": "deg",
"azimuth": 117.72942647370792,
"altitude": 20.984193272523992,
"times": {
"solarNoon":"2018-12-10T10:59:14.814Z",
"nadir":"2018-12-10T22:59:14.814Z",
"sunrise":"2018-12-10T06:58:55.584Z",
"sunset":"2018-12-10T14:59:34.044Z",
"sunriseEnd":"2018-12-10T07:03:12.232Z",
"sunsetStart":"2018-12-10T14:55:17.395Z",
"blueHourDawnEnd":"2018-12-10T06:34:22.885Z",
"blueHourDuskStart":"2018-12-10T15:24:06.743Z",
"civilDawn":"2018-12-10T06:19:31.249Z",
"civilDusk":"2018-12-10T15:38:58.379Z",
"blueHourDawnStart":"2018-12-10T06:05:03.443Z",
"blueHourDuskEnd":"2018-12-10T15:53:26.185Z",
"nauticalDawn":"2018-12-10T05:37:04.859Z",
"nauticalDusk":"2018-12-10T16:21:24.768Z",
"amateurDawn":"2018-12-10T05:16:44.832Z",
"amateurDusk":"2018-12-10T16:41:44.795Z",
"astronomicalDawn":"2018-12-10T04:56:49.931Z",
"astronomicalDusk":"2018-12-10T17:01:39.696Z",
"goldenHourEnd":"2018-12-10T07:58:28.541Z",
"goldenHourStart":"2018-12-10T14:00:01.086Z",
"dawn":"2018-12-10T06:19:31.249Z",
"dusk":"2018-12-10T15:38:58.379Z",
"nightEnd":"2018-12-10T04:56:49.931Z",
"night":"2018-12-10T17:01:39.696Z",
"nightStart":"2018-12-10T17:01:39.696Z",
"goldenHour":"2018-12-10T14:00:01.086Z"
},
"pos": [],
"posChanged": false
}
msg.posChanged
property of type boolean which is true if in the previous calculation no message was send to this output.The node calculates the current sun position on any input message.
[{"id":"d99ac08d.fdb94","type":"moon-position","z":"de4e9c38.0d942","name":"","positionConfig":"2831ba70.55a636","rules":[],"outputs":1,"topic":"","x":340,"y":520,"wires":[["e5e8e9a1.6080e8","e9ec273d.d90168","45563d84.0c4bf4","cce94ccc.b2dd2","65c76f28.3dd49","ac44c210.86465","f2deae49.60015","a9e0a2d1.0633a","948f6e2.8a4a39","cc85e458.447ba8","bff5a621.3fb498"]]},{"id":"124bfd72.dcb2f3","type":"inject","z":"de4e9c38.0d942","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":120,"y":520,"wires":[["d99ac08d.fdb94"]]},{"id":"e5e8e9a1.6080e8","type":"debug","z":"de4e9c38.0d942","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","x":590,"y":520,"wires":[]},{"id":"e9ec273d.d90168","type":"change","z":"de4e9c38.0d942","name":"azimuth","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload.azimuth","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":580,"y":560,"wires":[[]]},{"id":"45563d84.0c4bf4","type":"change","z":"de4e9c38.0d942","name":"altitude","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload.altitude","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":580,"y":600,"wires":[[]]},{"id":"cce94ccc.b2dd2","type":"change","z":"de4e9c38.0d942","name":"distance","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload.distance","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":580,"y":640,"wires":[[]]},{"id":"65c76f28.3dd49","type":"change","z":"de4e9c38.0d942","name":"parallacticAngle","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload.parallacticAngle","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":600,"y":680,"wires":[[]]},{"id":"ac44c210.86465","type":"change","z":"de4e9c38.0d942","name":"illumination angle","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload.illumination.angle","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":610,"y":720,"wires":[[]]},{"id":"f2deae49.60015","type":"change","z":"de4e9c38.0d942","name":"illumination fraction","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload.illumination.fraction","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":610,"y":760,"wires":[[]]},{"id":"a9e0a2d1.0633a","type":"change","z":"de4e9c38.0d942","name":"illumination phase","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload.illumination.phase.value","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":610,"y":800,"wires":[[]]},{"id":"948f6e2.8a4a39","type":"change","z":"de4e9c38.0d942","name":"illumination phase angle","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload.illumination.phase.angle","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":630,"y":840,"wires":[[]]},{"id":"bff5a621.3fb498","type":"change","z":"de4e9c38.0d942","name":"illumination zenithAngle","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload.illumination.zenithAngle","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":630,"y":920,"wires":[[]]},{"id":"cc85e458.447ba8","type":"change","z":"de4e9c38.0d942","name":"illumination phase name","rules":[{"t":"set","p":"payload","pt":"msg","to":"payload.illumination.phase.name","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":630,"y":880,"wires":[[]]},{"id":"2831ba70.55a636","type":"position-config","z":"","name":"Kap-Halbinsel","longitude":"-34.357051","latitude":"18.473782","angleType":"deg"}]
msg.payload.azimuth
the azimuth of the moon position relative to the given coordinates.msg.payload.altitude
the altitude/elevation of the moon position relative to the given coordinates.msg.payload.distance
the distance of the moon.msg.payload.parallacticAngle
the parallacticAngle of the moon.msg.payload.illumination
the illumination of the moon as object.
msg.payload.illumination.angle
the illumination angle of the moon.msg.payload.illumination.fraction
the illumination fraction angle of the moon.msg.payload.illumination.zenithAngle
the illumination zenith angle of the moon.msg.payload.illumination.phase
the illumination phase of the moon as object.
msg.payload.illumination.phase.value
the current phase of the moon in percent, where 0%/100% is New Moon, from 0% to 50% is growing, 50% is Full Moon and >50% is decreasing.msg.payload.illumination.phase.angle
the current phase angle of the moon.msg.payload.illumination.phase.emoji
the emoji of the current phase of the moon.msg.payload.illumination.phase.code
the code of the emoji for the current phase of the moon.msg.payload.illumination.phase.name
the name of the current phase of the moon.msg.payload.times
the moon times as object.
msg.payload.times.rise
the moon rise time.msg.payload.times.set
the moon set time.msg.payload.times.alwaysUp
boolean which is true if the moon never rises/sets and is always above the horizon during the day.msg.payload.times.alwaysDown
boolean which is true if the moon is always below the horizon.msg.payload.pos
array with a boolean of every defined limit of the azimuth, which is true if the azimuth is inside the limit.msg.payload.posChanged
boolean which is true if any of the defined limit of the azimuth has changed to the last calculation. {
"lastUpdate": "2018-11-11T11:11:11.111Z",
"latitude": "18.473782",
"longitude": "-34.357051",
"angleType": "deg",
"azimuth": 108.71205459404247,
"altitude": -9.578482237780767,
"distance": 400811.8001636167,
"parallacticAngle": -73.92702172116152,
"illumination": {
"angle": -94.27663428960696,
"fraction": 0.14981886026806135,
"phase": {
"emoji": "🌒",
"code": ":waxing_crescent_moon:",
"name": "Waxing Crescent",
"weight": 6.3825,
"value": 0.12651089732280724,
"angle": 45.54392303621061
},
"zenithAngle": -20.349612568445437
},
"times": {
"rise": "2018-11-11T11:44:22.877Z",
"set": "2018-11-11T23:10:07.389Z",
"alwaysUp": false,
"alwaysDown": false
},
"pos": [],
"posChanged": false
}
msg.payload.posChanged
property of type boolean which is true if the limit has changed since the last azimuth calculation.Injects a message into a flow either manually or at timestamps which can also depending on the sunset, sunrise, or moon set and rise. The message payload can be a variety of types, including strings, JavaScript objects, the current time or the cuttent sun or moon position.
[{"id":"d3c04d4e.ce3e3","type":"debug","z":"de4e9c38.0d942","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","x":570,"y":2100,"wires":[]},{"id":"586e4ae2.5b4f14","type":"debug","z":"de4e9c38.0d942","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","x":570,"y":2160,"wires":[]},{"id":"1b71d0e5.35b02f","type":"debug","z":"de4e9c38.0d942","name":"","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","x":570,"y":2220,"wires":[]},{"id":"3e4d36c0.620e7a","type":"time-inject","z":"de4e9c38.0d942","name":"","positionConfig":"bdf7c4a.9ca6c38","time":"nadir","timeType":"pdsTime","timeDays":"*","offset":0,"offsetMultiplier":60,"payload":"","payloadType":"date","topic":"","x":320,"y":2100,"wires":[["d3c04d4e.ce3e3"]]},{"id":"c11713e.db07ef","type":"time-inject","z":"de4e9c38.0d942","name":"","positionConfig":"bdf7c4a.9ca6c38","time":"dawn","timeType":"pdsTime","timeDays":"*","offset":0,"offsetMultiplier":60,"payload":"","payloadType":"date","topic":"","x":320,"y":2160,"wires":[["586e4ae2.5b4f14"]]},{"id":"b227cadc.dcf8c8","type":"time-inject","z":"de4e9c38.0d942","name":"","positionConfig":"bdf7c4a.9ca6c38","time":"rise","timeType":"pdmTime","timeDays":"1,4,0","offset":0,"offsetMultiplier":60,"payload":"{\"bool\":true}","payloadType":"json","topic":"","x":340,"y":2220,"wires":[["1b71d0e5.35b02f"]]},{"id":"bdf7c4a.9ca6c38","type":"position-config","z":"","name":"","longitude":"13.71587","latitude":"51.01732","angleType":"deg"}]
Position defines the current position
Payload defines the payload of the message object send to the output
Topic defines the topic of the send message
Time An optional property that can be configured when the inject node should emit a message on that timestamp.
Offset An optional property which is only available if an time is choosen. The offset can be a positive or negative and defines a time offset to the choosen time.
Days An optional property which is only available if an time is choosen. There can be defined on which days a msg should be emited.
Property optional here can be defined a context property which must be of tyxpe boolean. If this property is true alternate time will be used.
Alternate time optional defines an alternate start time which will be used if the property is true. This can be used for different times for example of holidays/weekend.
Additional Inject on Start If this checkbox is set the inject node dcan emit the message on Node-Red Start or on any deploy of this node. There can be defined a delay after the emit should be done. This can be usefull for initializing any flow.
Set additional With this selection you can
time-inject-settings-addProp1
If this checkbox is set the inject node
It has only a button as input, where the massage could injected into a flow manually.
The output is a message with the defined payload and topic in the settings.
[{"id":"bd9bd279.302eb","type":"inject","z":"de4e9c38.0d942","name":"","topic":"","payload":"","payloadType":"date","repeat":"","crontab":"","once":false,"onceDelay":0.1,"x":120,"y":1180,"wires":[["b5c283be.eb945"]]},{"id":"273eb4cb.2715fc","type":"debug","z":"de4e9c38.0d942","name":"out1","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","x":590,"y":1180,"wires":[]},{"id":"78f068d6.2fe9f8","type":"debug","z":"de4e9c38.0d942","name":"out2","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","x":590,"y":1220,"wires":[]},{"id":"b5c283be.eb945","type":"within-time-switch","z":"de4e9c38.0d942","name":"","positionConfig":"bdf7c4a.9ca6c38","startTime":"7:00","startTimeType":"entered","startOffset":0,"startOffsetMultiplier":"60","endTime":"9:00","endTimeType":"entered","endOffset":0,"endOffsetMultiplier":"60","property":"","propertyType":"none","startTimeAlt":"","startTimeAltType":"none","startOffsetAlt":0,"startOffsetAltMultiplier":"60","endTimeAlt":"","endTimeAltType":"none","endOffsetAlt":0,"endOffsetAltMultiplier":"60","x":330,"y":1180,"wires":[["273eb4cb.2715fc"],["78f068d6.2fe9f8"]]},{"id":"bdf7c4a.9ca6c38","type":"position-config","z":"","name":"","longitude":"13.71587","latitude":"51.01732","angleType":"deg"}]
A simple node that routes messages depending on the time. If the current time falls within the range specified in the node configuration, the message is routed to output 1. Otherwise the message is routed to output 2.
⎇
sign after a time will show that an alternate time is used.
⎇
sign after a time will show that an alternate time is used.
if the message was pass throught the timestamp of this message will be shown.
time limits
options, otherwise the last message
status display.The time definitions of the nodes has different configuration possibilities
manual timestamps can be entered as one of the following formats:
00:00 ... 23:59
24h Format00:00:00 ... 23:59:00
24h Format with seconds00:00pm ... 12:59pm
12h Format00:00:00pm ... 12:59:00pm
12h Format with secondsfollowing Sun times can be choosen:
Time | Description | SunBH |
---|---|---|
astronomicalDawn | night ends (morning astronomical twilight starts) | 18 |
amateurDawn | amateur astronomical dawn (sun at 12° before sunrise) | 15 |
nauticalDawn | nautical dawn (morning nautical twilight starts) | 12 |
blueHourDawnStart | blue Hour start (time for special photography photos starts) | 8 |
civilDawn | dawn (morning nautical twilight ends, morning civil twilight starts) | 6 |
blueHourDawnEnd | blue Hour end (time for special photography photos end) | 4 |
sunrise | sunrise (top edge of the sun appears on the horizon) | 0.833 |
sunriseEnd | sunrise ends (bottom edge of the sun touches the horizon) | 0.3 |
goldenHourEnd | morning golden hour (soft light, best time for photography) ends | -6 |
solarNoon | solar noon (sun is in the highest position) | |
goldenHourStart | evening golden hour starts | -6 |
sunsetStart | sunset starts (bottom edge of the sun touches the horizon) | 0.3 |
sunset | sunset (sun disappears below the horizon, evening civil twilight starts) | 0.833 |
blueHourDuskStart | blue Hour start (time for special photography photos starts) | 4 |
civilDusk | dusk (evening nautical twilight starts) | 6 |
blueHourDuskEnd | blue Hour end (time for special photography photos end) | 8 |
nauticalDusk | nautical dusk end (evening astronomical twilight starts) | 12 |
amateurDusk | amateur astronomical dusk (sun at 12° after sunrise) | 15 |
astronomicalDusk | night starts (dark enough for astronomical observations) | 18 |
nadir | nadir (darkest moment of the night, sun is in the lowest position) |
SunBH is the angle of the sun below the horizon
Although the blue hour does not have an official definition, the blue color spectrum is most prominent when the Sun is between 4° and 8° below the horizon.
This is not an official definition, this is happend when the Sun is 15° below the horizon
The following time parameters are exists in the output for backwart compatibility. These are equal to parameters in the table above:
time parameter | is equal to |
---|---|
dawn | civilDawn |
dusk | civilDusk |
nightEnd | astronomicalDawn |
night | astronomicalDusk |
nightStart | astronomicalDusk |
goldenHour | goldenHourStart |
moon rise and moon set can be used
any message, flow or global property which contain any of the following types:
String as one of the following formats:
00:00 ... 23:59
24h Format00:00:00 ... 23:59:00
24h Format with seconds00:00pm ... 12:59pm
12h Format00:00:00pm ... 12:59:00pm
12h Format with secondsOffsets: The start and end time can have an offset. This is specified in seconds,minutes or hours:
For bugs, questions and discussions please use the GitHub Issues.
Even for those that don't have the technical knowhow to help developing on there are ways to support development. So if you want to donate some money please feel free to send money via PayPal.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
this node is published also here:
FAQs
NodeRED nodes to get sun and moon position
The npm package node-red-contrib-sun-position receives a total of 260 weekly downloads. As such, node-red-contrib-sun-position popularity was classified as not popular.
We found that node-red-contrib-sun-position demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.