SwiftySuncalc

[]() []() []() []()

Per the original suncalc project README,

SunCalc is a tiny BSD-licensed JavaScript library for calculating sun position, sunlight phases
(times for sunrise, sunset, dusk, etc.), moon position and lunar phase for the given location
and time, created by Vladimir Agafonkin (@mourner) as a part of the SunCalc.net project.

Most calculations are based on the formulas given in the excellent Astronomy Answers articles
about position of the sun and the planets. You can read about different twilight phases calculated
by SunCalc in the Twilight article on Wikipedia.

That Wikipedia article can be found here. This Swift library is a port of the original suncalc.js library, as created by Vladimir Agafonkin (@mourner). All information on this README is taken from the original suncalc.js library's README.

Usage

// Declare a new SwiftySuncalc object
var suncalc: SwiftySuncalc! = SwiftySuncalc()
// Get moon illumination times for today
var moonIllumination = suncalc.getMoonIllumination(date: Date())
// Get the angle of the moon from the dictionary, `moonIllumination`
var moonAngle = moonIllumination["angle"]
// Find out the times for today (e.g. sunset or sunrise)
var times = suncalc.getTimes(date: Date(), lat: 51.5, lng: -0.5);
// Find out the time for nadir today
var nadir: Double = times["nadir"]

Installation

Currently, SwiftySuncalc is only available through CocoaPods for Swift 4.x. Add the following to your Podfile:

target 'YourTargetApp' do
  pod 'SwiftySuncalc', '~> 1.0'
end

Then run a pod install inside your terminal, or from CocoaPods.app. Alternatively to give it a test run, run the command:

pod try SwiftySuncalc

Reference

Sunlight times

func getTimes(date: Date, lat: Double, lng: Double) -> Dictionary<String, Date>

This method call returns an object with the following properties, returning a Date() object

func addTime(angle: Double, riseName: String, setName: String)

Adds a custom time with the angle of degrees, the rise name, and the set name.

Sun position

func getPosition(date: Date, lat: Double, lng: Double) -> Dictionary<String, Double>

Returns a dictionary with the following keys:

• altitude: moon altitude above the horizon in radians
• azimuth: moon azimuth in radians
• distance: distance to moon in kilometers
• parallacticAngle: parallactic angle of the moon in radians

Moon illumination

func getMoonIllumination(date: Date) -> Dictionary<String, Double>

Returns a dictionary with the following keys:

• fraction: illuminated fraction of the moon; varies from 0.0 (new moon) to 1.0 (full moon)
• phase: moon phase; varies from 0.0 to 1.0, described below
• angle: midpoint angle in radians of the illuminated limb of the moon reckoned eastward from the north point of the disk; the moon is waxing if the angle is negative, and waning if positive

Moon phase value should be interpreted like this:

By subtracting the parallacticAngle from the angle one can get the zenith angle of the moons bright limb (anticlockwise). The zenith angle can be used do draw the moon shape from the observers perspective (e.g. moon lying on its back).

Moon rise and set times

func getMoonTimes(date: Date, lat: Double, lng: Double) -> Dictionary<String, Date?>

Returns an object with the following properties:

• rise: moonrise time as Date
• set: moonset time as Date
• alwaysUp: true if the moon never rises/sets and is always above the horizon during the day
• alwaysDown: true if the moon is always below the horizon

By default, it will search for moon rise and set during local user's day (from 0 to 24 hours).