← All modules

Sun

BuiltConfigurable

Sunrise, sunset, golden hour, solar position, and day/night progress. Offline NOAA algorithm.

Module typesun
Default expression IDsun
Refresh rateTimes once/day, position per tick
Required configlatitudelongitude

Declaration

<module type="sun" id="sun" />

Properties

Reference any of these from a template via{sun:propertyName}.

NameDescriptionExampleFormat arg
sunriseSunrise time06:15Yes
sunsetSunset time20:45Yes
daylightTotal daylight duration14h 30m
goldenHourStartGolden hour start time19:50Yes
goldenHourEndGolden hour end time20:45Yes
solarNoonSolar noon time13:30Yes
elevationSun elevation in degrees45
azimuthSun azimuth in degrees180
isDaytimeWhether the sun is above the horizontrue
dayProgressProgress through daylight (0-100)65
nightProgressProgress through night (0-100)0
riseGlyphSunrise icon font glyph
setGlyphSunset icon font glyph
bodyGlyphSun/moon glyph based on time

Events

TriggerDescription
On sunriseSun crosses above the horizon
On sunsetSun crosses below the horizon
On golden hourGolden hour begins