Class: Toybox.Sensor.SensorData

Inherits:
Toybox.Lang.Object show all

Overview

A class to encapsulate all high-frequency sensor data that can be retrieved.

Example:

Setting up an accel data callback

import Toybox.Sensor;
import Toybox.Lang;

// Initialize accel data variables
var mX as Array<Number> = [0];
var mY as Array<Number> = [0];
var mZ as Array<Number> = [0];

// Callback to receive accel data
function accel_callback(sensorData as Sensor.SensorData) as Void {
    if (sensorData has :accelerometerData) {
        var accelerometerData = sensorData.accelerometerData;
        if (accelerometerData != null) {
            mX = accelerometerData.x;
            mY = accelerometerData.y;
            mZ = accelerometerData.z;
        }
    }
    onAccelData();
}
// This method can now be used with registerSensorDataListener()

Since:

API Level 2.3.0

Supported Devices:

Instance Member Summary collapse

Instance Attribute Details

var accelerometerData as Sensor.AccelerometerData or Null

An AccelerometerData object.

Can be null if accelerometer data was not requested.

Since:

API Level 2.3.0

Supported Devices:

var gyroscopeData as Sensor.GyroscopeData or Null

An GyroscopeData object.

Can be null if gyroscope data was not requested.

Since:

API Level 3.3.0

Supported Devices:

Returns:

var heartRateData as Sensor.HeartRateData or Null

A HeartRateData object.

Can be null if heart rate interval data is not available.

Example:

import Toybox.Sensor;

var heartBeatIntervals as Array<Number> = [];

function heartBeatIntervalsCallback(sensorData as Sensor.SensorData) as Void {
    if (sensorData has :heartRateData) {
        var heartRateData = sensorData.heartRateData;
        if (heartRateData != null) {
            heartBeatIntervals = heartRateData.heartBeatIntervals;
        }
    }
}

Since:

API Level 3.0.0

See Also:

Supported Devices:

var magnetometerData as Sensor.MagnetometerData or Null

An MagnetometerData object.

Can be null if MagnetometerData data was not requested.

Since:

API Level 3.3.0

Supported Devices:

Returns:

Generated Oct 30, 2026, 1:07:33 PM