Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/batoulapps/adhan-swift

High precision Islamic prayer time library for Swift
https://github.com/batoulapps/adhan-swift

Last synced: about 2 months ago
JSON representation

High precision Islamic prayer time library for Swift

Awesome Lists containing this project

README 

        
# Adhan Swift



![badge-languages][] ![badge-pms][] ![badge-platforms][]



[![badge-pod][]][cocoapods] [![badge-travis][]][travis] [![badge-cov][]][codecov]



Adhan Swift is a well tested and well documented library for calculating Islamic prayer times. Adhan Swift supports Swift 4.0, Swift 4.2, Swift 5.0 and Objective-C.



All astronomical calculations are high precision equations directly from the book [“Astronomical Algorithms” by Jean Meeus](http://www.willbell.com/math/mc1.htm). This book is recommended by the Astronomical Applications Department of the U.S. Naval Observatory and the Earth System Research Laboratory of the National Oceanic and Atmospheric Administration.



Implementations of Adhan in other languages can be found in the parent repo [Adhan](https://github.com/batoulapps/Adhan).



## Installation



### CocoaPods



For [CocoaPods](https://cocoapods.org/) add the following to your [Podfile](https://guides.cocoapods.org/syntax/podfile.html):



```ruby

pod 'Adhan'

```



### Carthage



For [Carthage](https://github.com/Carthage/Carthage) add the following to your [Cartfile](https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md#cartfile):



```ruby

github "batoulapps/adhan-swift" "main"

```



### Swift Package Manager



For [SPM](https://swift.org/package-manager/) add the following to your `Package.swift` file:



```swift

// swift-tools-version:4.2

dependencies: [

    .package(url: "https://github.com/batoulapps/adhan-swift", .branch("main")),

]

```



### Manually



You can also manually add Adhan.



- Download the source.

- Add Adhan.xcodeproj as a subproject in your app's project.

- Drag Adhan.framework to "Linked Frameworks and Libraries" in your app's target.



## Usage



To get prayer times initialize the `PrayerTimes` struct passing in coordinates,

date, and calculation parameters.



```swift

let prayers = PrayerTimes(coordinates: coordinates, date: date, calculationParameters: params)

```



### Initialization parameters



#### Coordinates



Create a `Coordinates` struct with the latitude and longitude for the location

you want prayer times for.



```swift

let coordinates = Coordinates(latitude: 35.78056, longitude: -78.6389)

```



#### Date



To avoid confusion with timezones the date parameter passed in should be an instance of

`DateComponents`. The year, month, and day components need to be populated. All other

components will be ignored. The year, month and day values should be for the local date

that you want prayer times for. These date components are expected to be for the Gregorian calendar.



```swift

let cal = Calendar(identifier: Calendar.Identifier.gregorian)

let date = cal.dateComponents([.year, .month, .day], from: Date())

```



### Calculation parameters & Calculation Methods



The rest of the needed information is contained within the `CalculationParameters` struct.



[Calculation Parameters & Methods Guide](METHODS.md)



### Prayer Times



Once the `PrayerTimes` struct has been initialized it will contain members

for all five prayer times and the time for sunrise. The prayer times will be instances

of NSDate and as such will refer to a fixed point in universal time. To display these

times for the local timezone you will need to create a date formatter and set

the appropriate timezone.



```swift

let formatter = DateFormatter()

formatter.timeStyle = .medium

formatter.timeZone = TimeZone(identifier: "America/New_York")!



print("fajr \(formatter.string(from: prayers.fajr))")

```



## Full Example



```swift

let cal = Calendar(identifier: Calendar.Identifier.gregorian)

let date = cal.dateComponents([.year, .month, .day], from: Date())

let coordinates = Coordinates(latitude: 35.78056, longitude: -78.6389)

var params = CalculationMethod.moonsightingCommittee.params

params.madhab = .hanafi

if let prayers = PrayerTimes(coordinates: coordinates, date: date, calculationParameters: params) {

    let formatter = DateFormatter()

    formatter.timeStyle = .medium

    formatter.timeZone = TimeZone(identifier: "America/New_York")!



    print("fajr \(formatter.string(from: prayers.fajr))")

    print("sunrise \(formatter.string(from: prayers.sunrise))")

    print("dhuhr \(formatter.string(from: prayers.dhuhr))")

    print("asr \(formatter.string(from: prayers.asr))")

    print("maghrib \(formatter.string(from: prayers.maghrib))")

    print("isha \(formatter.string(from: prayers.isha))")

}

```



## Convenience Utilities



The `PrayerTimes` struct has functions for getting the current prayer and the next prayer. You can also get the time for a specified prayer, making it

easier to dynamically show countdowns until the next prayer.



```swift

let prayerTimes = PrayerTimes(coordinates: coordinates, date: date, calculationParameters: params)



let current = prayerTimes.currentPrayer()

let next = prayerTimes.nextPrayer()

let countdown = prayerTimes.time(for: next)

```



## Sunnah Times



The Adhan library can also calulate Sunnah times. Given an instance of `PrayerTimes`, you can get a `SunnahTimes` struct with the times for Qiyam.



```swift

if let sunnahTimes = SunnahTimes(from: todayPrayers) {

	print(dateFormatter.string(from: sunnahTimes.lastThirdOfTheNight)

	print(dateFormatter.string(from: sunnahTimes.middleOfTheNight)

}

```



## Qibla Direction



Get the direction, in degrees from North, of the Qibla from a given set of coordinates.



```swift

let nyc = Coordinates(latitude: 40.7128, longitude: -74.0059)

let qiblaDirection = Qibla(coordinates: nyc).direction

```



## Contributing



Adhan is made publicly available to provide a well tested and well documented library for Islamic prayer times to all

developers. We accept feature contributions provided that they are properly documented and include the appropriate

unit tests. We are also looking for contributions in the form of unit tests of of prayer times for different

locations, we do ask that the source of the comparison values be properly documented. For all pull requests, 

use `develop` as the base branch.



## License



Adhan is available under the MIT license. See the LICENSE file for more info.



[badge-pod]: https://img.shields.io/cocoapods/v/Adhan.svg?label=version

[badge-pms]: https://img.shields.io/badge/supports-CocoaPods%20%7C%20Carthage%20%7C%20SwiftPM-green.svg

[badge-languages]: https://img.shields.io/badge/languages-Swift%20%7C%20ObjC-orange.svg

[badge-platforms]: https://img.shields.io/badge/platforms-macOS%20%7C%20iOS%20%7C%20watchOS%20%7C%20tvOS-lightgrey.svg

[badge-travis]: https://travis-ci.org/batoulapps/adhan-swift.svg?branch=master

[badge-cov]: https://codecov.io/gh/batoulapps/adhan-swift/branch/master/graph/badge.svg

[travis]: https://travis-ci.org/batoulapps/adhan-swift

[cocoapods]: https://cocoapods.org/pods/Adhan

[codecov]: https://codecov.io/gh/batoulapps/adhan-swift