The locations sensor provides the best location estimate for the users’ current location, automatically. The location data is provided by Core Location.

iOS 13 or later.

1. Open Package Manager Windows

   • Open Xcode -> Select Menu Bar -> File -> App Package Dependencies...

2. Find the package using the manager

   • Select Search Package URL and type https://github.com/awareframework/com.awareframework.ios.sensor.locations.git

3. Import the package into your target.

4. Add NSLocationAlwaysAndWhenInUseUsageDescription and NSLocationWhenInUseUsageDescription into Info.plist.

• init(config:LocationsSensor.Config?): Initializes the locations sensor with the optional configuration.
• start(): Starts the locations sensor with the optional configuration.
• stop(): Stops the service.

Class to hold the configuration of the sensor.

• sensorObserver: LocationsObserver?: Callback for live data updates. (default = nil)
• sampleIntervalSeconds: Double: How often to check the location, in seconds. By default, every 180 seconds. (default = 180)
• accuracy: Int: the minimum acceptable accuracy of GPS location, in meters. By default, 100 meters. (default = 100)
• distanceFilter: Double: The minimum distance, in meters, before Core Location sends another standard location update. Set 0 to disable distance filtering. (default = 0)
• expirationTime: Int64: the amount of elapsed time, in seconds, until the location is considered outdated. By default, 300 seconds. (default = 300)
• saveAll: Bool: Whether to save all the location updates or not. (default = true)
• statusGps: Bool: Whether to use continuous GPS location tracking via startUpdatingLocation. (default = true)
• statusSignificantLocationChanges: Bool: Whether to also use significant-location-change monitoring as a background wake-up/recovery mechanism. Standard location updates remain enabled when statusGps is true. (default = true)
• enabled: Bool: Sensor is enabled or not. (default = false)
• debug: Bool: Enable/disable logging. (default = false)
• label: String: Label for the data. (default = "")
• deviceId: String: Id of the device that will be associated with the events and the sensor. (default = "")
• dbEncryptionKey: String?: Encryption key for the database. (default = nil)
• dbType: DatabaseType: Which db engine to use for saving data. (default = .none)
• dbPath: String: Path of the database. (default = "aware_locations")
• dbHost: String?: Host for syncing the database. (default = nil)

• LocationsSensor.ACTION_AWARE_LOCATIONS: fired when new location available.
• LocationsSensor.ACTION_AWARE_GPS_LOCATION_ENABLED: fired when GPS location is active.
• LocationsSensor.ACTION_AWARE_GPS_LOCATION_DISABLED: fired when GPS location disabled.

• LocationsSensor.ACTION_AWARE_LOCATIONS_START: received broadcast to start the sensor.
• LocationsSensor.ACTION_AWARE_LOCATIONS_STOP: received broadcast to stop the sensor.
• LocationsSensor.ACTION_AWARE_LOCATIONS_SYNC: received broadcast to send sync attempt to the host.
• LocationsSensor.ACTION_AWARE_LOCATIONS_SET_LABEL: received broadcast to set the data label. Label is expected in the LocationsSensor.EXTRA_LABEL field of the intent extras.

Contains the locations profiles.

Contains compass/heading data.

Contains Core Location lifecycle events, including authorization changes, failures, and pause/resume callbacks.

// To initialize the sensor
let locationSensor = LocationsSensor.init(LocationsSensor.Config().apply { config in
    config.sensorObserver = Observer()
    config.debug = true
    config.dbType = .sqlite
    // more configuration...
})
// To start the sensor
locationSensor?.start()

// To stop the sensor
locationSensor?.stop()

class Observer:LocationsObserver {
    func onLocationChanged(data: LocationsData) {
    // your code here
    }
}

Yuuki Nishiyama (The University of Tokyo), nishiyama@csis.u-tokyo.ac.jp

• Apple | Core Location
• Apple | CLLocation

Copyright (c) 2025 AWARE Mobile Context Instrumentation Middleware/Framework (http://www.awareframework.com)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.