GeoMonitor

0.1.2

iOS library for background monitoring of a user's movement
skedgo/GeoMonitor

What's New

0.1.2

2023-01-26T22:31:31Z

What's Changed

  • Allow adding to iOS 13 project (though GeoMonitor remains iOS 14+) by @nighthawk in #4

Full Changelog: 0.1.1...0.1.2

GeoMonitor

A battery-efficient and privacy-friendly mini framework for monitoring the user's location, triggering callbacks when the user starts moving and monitoring whether the user approaches specified regions.

Relies on a mixture of techniques, such as:

  • Region-monitoring for detecting when the user leaves their current location
  • Region-monitoring for detecting when the user approaches pre-defined locations
  • Visit-monitoring for detecting when the user has arrived somewhere

Setup

  1. Configure your Target:
  • Go to Signing & Capabilities, Background Modes and make sure Location updates is ticket.
  • Go to Info, and make sure you have usage descriptions for "Privacy - Location Always", "Privacy - Location Always and When in Use", and "Privacy - Location When In Use" set.

Usage

GeoMonitor requires iOS 14+

self.monitor = GeoMonitor {
  // Fetch the latest regions; also called when entering one.
  // Make sure `region.identifier` is stable.
  let regions = await ...
  return circles = regions.map { CLCircularRegion(...) }
} onEvent: { event, currentLocation in
  switch event {
  case .departed(visit):
    // Called when a previously-visited location was left
  case .entered(region):
    // Called when entering a defined region.
    let notification = MyNotification(for: region)
    notification.fire()
  case .arrived(visit):
    // Called when a visit was registered
  }
}
monitor.enableVisitMonitoring = true
monitor.start()

Considerations

Regular iOS restrictions apply, such as:

[...] When Background App Refresh is disabled, either for your app or for all apps, the user must explicitly launch your app to resume the delivery of all location-related events.

Description

  • Swift Tools 5.5.0
View More Packages from this Author

Dependencies

  • None
Last updated: Thu Feb 02 2023 19:26:38 GMT-0500 (GMT-05:00)