Latest 0.4.1
License Apache2
Platforms ios 10.0
Dependencies com.awareframework.ios.sensor.core
Frameworks CoreMotion

AWARE: Magnetometer

CI Status

This sensor module allows us to access the current Magnetic Fluid data. The data is provided by CMDeviceMotion in Core Motion library. Please check the link below for details.

Apple | Getting Processed Device-Motion Data

Apple | CMDeviceMotion | CMCalibratedMagneticField


iOS 10 or later


com.aware.ios.sensor.magnetometer is available through CocoaPods.

  1. To install it, simply add the following line to your Podfile:

    pod 'com.aware.ios.sensor.magnetometer'
  2. Import com.aware.ios.sensor.magnetometer library into your source code.
    import com_aware_ios_sensor_magnetometer

Public functions


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


Class to hold the configuration of the sensor.


  • sensorObserver: MagnetometerObserver: Callback for live data updates.
  • frequency: Int: Data samples to collect per second (Hz). (default = 5)
  • period: Double: Period to save data in minutes. (default = 1)
  • threshold: Double: If set, do not record consecutive points if change in value is less than the set value.
  • enabled: Boolean Sensor is enabled or not. (default = false)
  • debug: Boolean enable/disable logging to Xcode console. (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 Encryption key for the database. (default = null)
  • dbType: Engine Which db engine to use for saving data. (default = Engine.DatabaseType.NONE)
  • dbPath: String Path of the database. (default = "aware_magnetometer")
  • dbHost: String Host for syncing the database. (default = null)


Fired Broadcasts

  • MagnetometerSensor.ACTION_AWARE_GYROSCOPE fired when gyroscope saved data to db after the period ends.

Received Broadcasts

  • MagnetometerSensor.ACTION_AWARE_MAGNETOMETER_START: received broadcast to start the sensor.
  • MagnetometerSensor.ACTION_AWARE_MAGNETOMETER_STOP: received broadcast to stop the sensor.
  • MagnetometerSensor.ACTION_AWARE_MAGNETOMETER_SYNC: received broadcast to send sync attempt to the host.
  • MagnetometerSensor.ACTION_AWARE_MAGNETOMETER_SET_LABEL: received broadcast to set the data label. Label is expected in the MagnetometerSensor.EXTRA_LABEL field of the intent extras.

Data Representations

Magnetometer Data

Contains the raw sensor data.

Field Type Description
x Double value of X axis
y Double value of Y axis
z Double value of Z axis
label String Customizable label. Useful for data calibration or traceability
deviceId String AWARE device UUID
label String Customizable label. Useful for data calibration or traceability
timestamp Int64 unixtime milliseconds since 1970
timezone Int Raw timezone offset of the device
os String Operating system of the device (ex. ios)

Example usage

var magnetometer = MagnetometerSensor.init( MagnetometerSensor.Config().apply{ config in
    config.debug = true
    config.sensorObserver = Observer()
class Observer:MagnetometerObserver {
    func onDataChanged(data:MagnetometerData){
        // Your code here..


Yuuki Nishiyama, [email protected]


Copyright (c) 2018 AWARE Mobile Context Instrumentation Middleware/Framework (

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 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.

Latest podspec

    "name": "com.awareframework.ios.sensor.magnetometer",
    "version": "0.4.1",
    "summary": "A Magnetometer Sensor Module for AWARE Framework.",
    "description": "com.awareframework.ios.sensor.magnetometer (Magnetometer) is a sensor module for Aware Framework. This module provides calibrated magnetic fields. This data is provided by Core Motionu2019s sensor fusion algorithms.",
    "homepage": "",
    "license": {
        "type": "Apache2",
        "file": "LICENSE"
    "authors": {
        "tetujin": "[email protected]"
    "source": {
        "git": "",
        "tag": "0.4.1"
    "platforms": {
        "ios": "10.0"
    "swift_version": "4.2",
    "source_files": "com.awareframework.ios.sensor.magnetometer/Classes/**/*",
    "frameworks": "CoreMotion",
    "dependencies": {
        "com.awareframework.ios.sensor.core": [
            "~> 0.4.1"

Pin It on Pinterest

Share This