Skip to content

Latest commit

 

History

History
98 lines (66 loc) · 4.15 KB

README.md

File metadata and controls

98 lines (66 loc) · 4.15 KB

AWARE: Timezone

Swift Package Manager compatible

The timezone sensor keeps track of the user’s current timezone.

Requirements

iOS 13 or later

Installation

Add the package with Swift Package Manager:

  • Package URL: https://github.com/awareframework/com.awareframework.ios.sensor.timezone.git
  • Product: com.awareframework.ios.sensor.timezone
  • Module: import com_awareframework_ios_sensor_timezone

See the core package README for the Xcode, Package.swift and command-line installation steps.

Info.plist: no usage description is required.

Public Functions

TimezoneSensor

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

TimezoneSensor.Config

Class to hold the configuration of the sensor.

Fields

  • sensorObserver: TimezoneObserver: Callback for live data updates.
  • 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_timezone")
  • dbHost: String?: Host for syncing the database. (default = nil)

Broadcasts

  • TimezoneSensor.ACTION_AWARE_TIMEZONE: broadcasted when there is new timezone information. Extra includes TimezoneSensor.EXTRA_DATA for the new timezone.

Data Representations

Timezone Data

Field Type Description
timezoneId String the timezone ID string, i.e., “America/Los_Angeles, GMT-08:00”
deviceId String AWARE device UUID
label String Customizable label. Useful for data calibration or traceability
timestamp Int64 unixtime milliseconds since 1970
timezone Int Timezone of the device
os String Operating system of the device (ex. ios)
jsonVersion Int JSON schema version

Example Usage

let timezoneSensor = TimezoneSensor.init(TimezoneSensor.Config().apply { config in
    config.sensorObserver = Observer()
    config.debug = true
})
timezoneSensor?.start()
class Observer:TimezoneObserver{
    func onTimezoneChanged(data: TimezoneData) {
        // Your code here..
    }
}

Related Links

Author

Yuuki Nishiyama (The University of Tokyo), [email protected]

License

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.