Awesome Open Source
Awesome Open Source

SwiftBackgroundLocation

CI Status Version License Platform

SwiftBackground is the right choice to work easily and efficiently with Location Manager when your app is terminated or killed. It's based on region monitoring. Demo how it works (blue is normal tracking, red line is region based tracking):

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Just add in your app delegate for background location:

    var backgroundLocationManager = BackgroundLocationManager()
    
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey : Any]? = nil) -> Bool {
        
         backgroundLocationManager.startBackground() { result in
                if case let .Success(location) = result {
                    LocationLogger().writeLocationToFile(location: location)
                }
        }

        return true
    }

You can set up radius for background location:

    let regionConfig = RegionConfig(regionRadius: 25.0)
    var backgroundLocationManager = BackgroundLocationManager(regionConfig: regionConfig) 
    

Getting permission (.always or .whenInUse) for location tracking:

locationManager.manager(for: .always, completion: { result in
            if case let .Success(manager) = result {
                
            }


})

Location tracking with listener:

locationManager.manager(for: .always, completion: { result in
            if case let .Success(manager) = result {
                manager.startUpdatingLocation(isHeadingEnabled: true) { [weak self] result in
                    if case let .Success(locationHeading) = result, let location = locationHeading.location {
                        self?.updateLocation(location: location)
                    }
                }
            }

})

Getting heading needs additional hardware and hence wont work on simulator.

Requirements

Installation

SwiftBackgroundLocation is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "SwiftBackgroundLocation"

You must add NSLocationAlwaysUsageDescription or NSLocationWhenInUseUsageDescription key to your project’s Info.plist containing the message to be displayed to the user at the prompt. If you need always location, you should add both.

<key>NSLocationAlwaysUsageDescription</key>
<string>$(PRODUCT_NAME) needs location always usage for recording in background.</string>
<key>NSLocationWhenInUseUsageDescription</key>
<string>$(PRODUCT_NAME) needs location when in use for recording in foreground.</string>

The user will not be prompted unless one of these are added to the Info.plist.

Author

yoman07, [email protected]

License

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

Contact & Questions

If you have any questions, fell free to send me a mail. You can also fork this project, or open an issue

Contributions

SwiftBackgroundLocation is currently lead by:

  • Roman Barzyczak (GitHub <https://github.com/yoman07__ Roman Barzyczak <https://github.com/yoman07>__)

with contributions from:

  • Andrew Sowers <https://github.com/asowers1>__

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Swift (95,583
Location (674
Background (346
Region (175
Mapkit (164
Related Projects