Skip to content

Latest commit

 

History

History
130 lines (90 loc) · 6.72 KB

README.md

File metadata and controls

130 lines (90 loc) · 6.72 KB

AWARE: Accelerometer

Swift Package Manager compatible

This sensor module allows us to manage 3-axis accelerometer data which is provided by iOS CoreMotion Library. Please check the link below for details.

An accelerometer measures changes in velocity along one axis. All iOS devices have a three-axis accelerometer, which delivers acceleration values in each of the three axes. The values reported by the accelerometers are measured in increments of the gravitational acceleration, with the value 1.0 representing an acceleration of 9.8 meters per second (per second) in the given direction. Acceleration values may be positive or negative depending on the direction of the acceleration.

Apple | Getting Raw Accelerometer Events

Requirements

iOS 13 or later

Installation

Add the package with Swift Package Manager:

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

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

Info.plist: no usage description is required.

Public Functions

AccelerometerSensor

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

AccelerometerSensor.Config

Class to hold the configuration of the sensor.

Fields

  • sensorObserver: AccelerometerObserver: Callback for live data updates.
  • samplingFrequencyHz: Int: Data samples to collect per second (Hz). (default = 5)
  • saveIntervalSeconds: Double: Interval in seconds at which buffered data is saved to the database. (default = 60)
  • threshold: Double: If set, do not record consecutive points if change in value is less than the set value.
  • 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_accelerometer")
  • dbHost: String?: Host for syncing the database. (default = nil)

Broadcasts

Fired Broadcasts

  • AccelerometerSensor.ACTION_AWARE_ACCELEROMETER: fired when accelerometer saved data to db after the save interval ends.
  • AccelerometerSensor.ACTION_AWARE_ACCELEROMETER_UNAVAILABLE (.actionAwareAccelerometerUnavailable): fired by start() when the device has no accelerometer, such as the iOS Simulator. Nothing is recorded then. sensor.isAvailable tells this before start(); to test on the Simulator, save synthetic AccelerometerData through sensor.dbEngine.

Received Broadcasts

  • AccelerometerSensor.ACTION_AWARE_ACCELEROMETER_START: received broadcast to start the sensor.
  • AccelerometerSensor.ACTION_AWARE_ACCELEROMETER_STOP: received broadcast to stop the sensor.
  • AccelerometerSensor.ACTION_AWARE_ACCELEROMETER_SYNC: received broadcast to send sync attempt to the host.

sensor.sync(force:) uploads right away whatever force is, as in every sensor. wifiOnly and batteryChargingOnly are checked by DbSyncManager.sync(_:), and force: true there skips them.

  • AccelerometerSensor.ACTION_AWARE_ACCELEROMETER_SET_LABEL: received broadcast to set the data label. Label is expected in the AccelerometerSensor.EXTRA_LABEL field of the intent extras.

Data Representations

Accelerometer Data

Contains the raw sensor data.

Field Type Description
x Double the acceleration force along the x axis, including gravity, in G (G=9.8m/s²)
y Double the acceleration force along the y axis, including gravity, in G (G=9.8m/s²)
z Double the acceleration force along the z axis, including gravity, in G (G=9.8m/s²)
label String Customizable label. Useful for data calibration or traceability
deviceId String AWARE device UUID
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

Import Accelerometer sensor library (com_aware_ios_sensor_accelerometer) to your target class.

import com_awareframework_ios_sensor_accelerometer

Generate an accelerometer sensor instance and start/stop the sensor.

let accelerometer = Accelerometer.init(Accelerometer.Config().apply { config in
   config.sensorObserver = Observer()
   config.saveIntervalSeconds = 30
   config.deviceId = UUID.init().uuidString
   config.debug    = true
})

accelerometer?.start()

accelerometer?.stop()
class Observer:AccelerometerObserver{
   func onDataChanged(data: AccelerometerData){
      // Your code here...
   }
}

Author

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

Related Links

License

Copyright (c) 2018 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.