solar

package

v1.3.6 Latest Latest Go to latest Published: Aug 21, 2026 License: AGPL-3.0 Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/fjaeckel/ninerlog-api

Links

Open Source Insights

Documentation ¶

Overview ¶

Package solar provides a thin wrapper around github.com/mstephenholl/go-solar for computing sunrise/sunset and determining whether a given UTC instant is during daytime or nighttime.

Index ¶

func IsNight(t time.Time, latitude, longitude float64) bool
type SunTimes
- func Calculate(date time.Time, latitude, longitude float64) SunTimes
type TwilightTimes
- func CivilTwilight(date time.Time, latitude, longitude float64) TwilightTimes

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func IsNight ¶

func IsNight(t time.Time, latitude, longitude float64) bool

IsNight returns true if the given UTC time falls in the aeronautical definition of night: before the morning civil twilight begins, or after the evening civil twilight ends, at the supplied latitude and longitude.

Types ¶

type SunTimes ¶

type SunTimes struct {
	Sunrise time.Time
	Sunset  time.Time
}

SunTimes holds sunrise and sunset times for a given date and location.

func Calculate ¶

func Calculate(date time.Time, latitude, longitude float64) SunTimes

Calculate computes sunrise and sunset UTC times for a given date, latitude, and longitude. Computation is delegated to github.com/mstephenholl/go-solar.

Edge cases:

Polar night (sun never rises): both Sunrise and Sunset are set to the start of the UTC day; the whole day counts as night.
Midnight sun (sun never sets): Sunrise is set to the start of the UTC day and Sunset to 23:59:59 UTC; the whole day counts as day.

type TwilightTimes ¶ added in v1.2.2

type TwilightTimes struct {
	Dawn time.Time // beginning of morning civil twilight (sun at -6° rising)
	Dusk time.Time // end of evening civil twilight (sun at -6° setting)
}

TwilightTimes holds the morning (Dawn) and evening (Dusk) civil twilight boundaries for a given UTC date and location.

func CivilTwilight ¶ added in v1.2.2

func CivilTwilight(date time.Time, latitude, longitude float64) TwilightTimes

CivilTwilight computes the morning-civil-twilight start (Dawn) and evening-civil-twilight end (Dusk) in UTC for the given date and location. These are the EASA "night" boundaries: any time between Dusk and the next day's Dawn is night.

Edge cases: polar night collapses the window to zero width (the entire UTC day is night); midnight sun spans the whole UTC day (the entire day is day).

Source Files ¶

View all Source files

solar.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL