Solar - SwiftGit

Switch Views

Solar

April 7, 2024

A Swift helper for generating Sunrise and Sunset times.

Solar performs its calculations locally using an algorithm from the United States Naval Observatory, and thus does not require the use of a network.

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 CocoaPods, Carthage, and Swift Package Manager.

CocoaPods

To include Solar in an application, add the following pod to your Podfile, then run pod install:


                                              
                                                pod “Solar-dev”, “~> 3.0”

To include Solar in another pod, add the following dependency to your podspec:


                                              
                                                s.dependency “Solar”, “~> 3.0”

Carthage

Add the ceek/Solar project to your Cartfile, then follow the rest of Carthage’s XCFramework installation instructions:


                                              
                                                github “ceeK/Solar” ~> 3.0

Swift Package Manager

To include Solar in an application in Xcode:

Go to File ‣ Swift Packages ‣ Add Package Dependency.
Enter https://github.com/ceeK/Solar.git as the package repository and click Next.
Set Rules to Version, Up to Next Major, and enter 3.0.0 as the minimum version requirement. Click Next.

To include Solar in another Swift package, add the following dependency to your Package.swift:


                                              
                                                .package(name: “Solar”, url: “https://github.com/ceeK/Solar.git”, from: “3.0.0”)

GitHub

View Github

#ios #macos #osx #swift