Contents

skedgo/geomonitor

A battery-efficient and privacy-friendly mini framework for monitoring the user's

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.

Package Metadata

Repository: skedgo/geomonitor

Default branch: main

README: README.md