Class: Toybox.SensorLogging.SensorLogger

Inherits:

Toybox.Lang.Object

• Toybox.Lang.Object
• Toybox.SensorLogging.SensorLogger

Overview

Class for the SensorLogger object. This object gets passed to FIT session to start recording sensor data.

Since:

API Level 2.3.0

Instance Method Summary

• getStats() as SensorLogging.SensorLoggingStats or Null

  Get statistics for the data gathered in the current session.

• getStats2(sensor as Lang.Symbol or Null) as SensorLogging.SensorLoggingStats or { :accelerometer as SensorLogging.SensorLoggingStats, :gyroscope as SensorLogging.SensorLoggingStats, :magnetometer as SensorLogging.SensorLoggingStats }

  Get statistics for the sensor data gathered in the current session.

• initialize(options as { :accelerometer as { :enabled as Lang.Boolean }, :gyroscope as { :enabled as Lang.Boolean }, :magnetometer as { :enabled as Lang.Boolean } })

  Constructor.

Instance Method Details

getStats() as SensorLogging.SensorLoggingStats or Null

Get statistics for the data gathered in the current session.

Returns:

• SensorLogging.SensorLoggingStats —

  Returns a SensorLoggingStats object.

Since:

API Level 2.3.0

getStats2(sensor as Lang.Symbol or Null) as SensorLogging.SensorLoggingStats or { :accelerometer as SensorLogging.SensorLoggingStats, :gyroscope as SensorLogging.SensorLoggingStats, :magnetometer as SensorLogging.SensorLoggingStats }

Get statistics for the sensor data gathered in the current session.

Parameters:

• sensor —

  Symbol for the sensor type to get the logging stats for or null to get stats about all the enabled sensors.

Returns:

• SensorLogging.SensorLoggingStats, Lang.Dictionary —

  Returns a SensorLoggingStats for the requested sensor type or the Toybox::Lang::Dictionary with stats of all the enabled sensors if null is passed.

Since:

API Level 3.3.0

Throws:

• Toybox::Lang::InvalidValueException Thrown if provided argument are out of range or are of the wrong type.

initialize(options as { :accelerometer as { :enabled as Lang.Boolean }, :gyroscope as { :enabled as Lang.Boolean }, :magnetometer as { :enabled as Lang.Boolean } })

Constructor

Note:

A SensorLogger may be initialized with the same dictionary of options provided to registerSensorDataListener(), but only the options documented below will be used.

Parameters:

• options — (Lang.Dictionary) —

  A Dictionary of logging options

  • :accelerometer — (Lang.Dictionary) —

    Options for accelerometer data.

    • :enabled (Toybox::Lang::Boolean) Set to true to fetch data from the accelerometer.

  • :gyroscope — (Lang.Dictionary) —

    Options for gyroscope data.

    • :enabled (Toybox::Lang::Boolean) Set to true to fetch data from the gyroscope.

  • :magnetometer — (Lang.Dictionary) —

    Options for magnetometer data.

    • :enabled (Toybox::Lang::Boolean) Set to true to fetch data from the magnetometer.

Since:

API Level 2.3.0