Skip to content

Latest commit

 

History

173 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Solar

SPM compatible CI Swift Compatibility Platform Compatibility MIT licensed

A Swift micro library for generating Sunrise and Sunset times, requiring no network access.

Solar performs its calculations locally using an algorithm from the United States Naval Observatory.

Usage

Solar simply needs a date and a location specified as a latitude and longitude:

let solar = Solar(for: someDate, coordinate: CLLocationCoordinate2D(latitude: 51.528308, longitude: -0.1340267))
let sunrise = solar?.sunrise
let sunset = solar?.sunset

We can also omit providing a date if we just need the sunrise and sunset for the current date and time:

let solar = Solar(coordinate: CLLocationCoordinate2D(latitude: 51.528308, longitude: -0.1340267))
let sunrise = solar?.sunrise
let sunset = solar?.sunset

Note that all dates are UTC. Don't forget to format your date into the appropriate timezone if required.

Types of sunrise and sunset

There are several types of sunrise and sunset that Solar generates. They differ by how many degrees the sun lies below the horizon:

  • Official (~0°)

  • Civil (6° below horizon)

  • Nautical (12° below horizon)

  • Astronomical (18° below horizon)

For more information, see https://www.timeanddate.com/astronomy/different-types-twilight.html

Convenience methods

Solar also comes packaged with some convenience methods:

// Whether the location specified by the `latitude` and `longitude` is in daytime on `date`
let isDaytime = solar.isDaytime

// Whether the location specified by the `latitude` and `longitude` is in nighttime on `date`
let isNighttime = solar.isNighttime

Installation

Solar is available through the Swift Package Manager. Add it to the dependencies value of your Package.swift:

dependencies: [
    .package(url: "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/ceeK/Solar.git", .upToNextMajor(from: "4.0.0"))
]

Or in Xcode: File ▸ Add Package Dependencies… and enter https://github.com/ceeK/Solar.git as the package URL.

License

Solar is available under the MIT license. See the LICENSE file for details.

About

A Swift micro library for generating Sunrise and Sunset times on device, requiring no network access.

Topics

Resources

Stars

615 stars

Watchers

17 watching

Forks

Releases

Used by

Contributors

Languages