swift-locations

A wrapper on the CoreLocation framework replacing the delegate pattern with Swift concurrency.

Overview

CoreLocation reports a device's location, altitude and orientation from on-device components.

Availability

• iOS 13.0+
• iPadOS 13.0+
• macCatalyst 15.0+
• macOS 10.15+
• watchOS 6.0+

Installation

The Swift Package Manager is a tool for managing the distribution of Swift code and is integrated into the swift compiler.

1. Add the package to the dependencies in your Package.swift file.

   let package: Package = .init(
       ...
       dependencies: [
           .package(url: "https://github.com/alexandrehsaad/swift-locations.git", branch: "main")
       ],
       ...
   )

2. Add the package as a dependency on your target in your Package.swift file.

   let package: Package = .init(
       ...
       targets: [
           .target(name: "MyTarget", dependencies: [
               .product(name: "Locations", package: "swift-locations")
           ]),
       ],
       ...
   )

Demonstration

1. Import the package in your source code.

   import Locations

2. Initiate the manager with your desired accuracy.

   let manager: LocationManager = .init(accuracy: .tenMetres)

3. Request the user’s permission to use location services and do something with the asynchronous value you receive. You can not show to the user an authorization dialog twice, but you can show the steps to change the permission from Settings.

   do {
       let status: AuthorizationStatus = try await manager.requestAlwaysAuthorization()
   	// Do something with the status.
       print(status)
   } catch let error {
       // Do something with the error.
       print(error)
   }

4. Subscribe to the locater and do something with the asynchronous stream of values you receive. The return type is CLLocation from the CoreLocation framework.

   do {
       let stream: AsyncStream = try manager.subscribeToLocater()
       for await data in stream {
           // Do something with the data.
           print(data)
       }
   } catch let error {
       // Do something with the error.
       print(error)
   }

5. Unsubscribe from the locater.

   manager.unsubscribeFromLocater()

Troubleshooting common errors

Your app must include usage description keys in its Info.plist file for the types of data it needs. Failure to include these keys cause the app to crash. To access location data specifically, it must include either NSLocationWhenInUseUsageDescription or NSLocationAlwaysAndWhenInUseUsageDescription.

Documentation

You can read more about this package by visiting the documentation page.

Roadmap

You can use this framework to track large or small changes in the user's current location with a configurable degree of accuracy. It could be extended to support region monitoring, beacon ranging and compass headings.

Contribution

Contributions are what makes the open source community such an amazing place to learn, inspire, and create. If you wish to contribute and be part of this project, please fork the repository and create a pull request.

1. Fork the repository
2. Create your feature branch git checkout -b NewFeature
3. Commit your changes git commit -m 'Added a new feature'
4. Push to your branch git push origin NewFeature
5. Open a pull request

Reporting a bug

If you find a bug, please create an issue.

Contacting the maintainers

The current code owner of this repository is Alex (@alexandrehsaad). If you want to share your thoughts or feedback on how to improve this repository, you can contact him by writing an email to alexandresaad at icloud dot com.

Supporting this repository

If this repository has been useful to you in some way, show your support by starring it.

License

Distributed under Apache License v2.0 with Runtime Library Exception. See the LICENSE.txt file for more information.