Class: Toybox.ActivityMonitor.Info

Inherits:
Toybox.Lang.Object show all

Overview

The ActivityMonitor.Info contains information about the user's current activity status.

The fields in this class may return null. It is recommended to null check a value before using it. If the value is not available, an error indicating that the symbol was not found will be thrown.

Note:

Unless otherwise indicated, Info data is calculated for the current day starting at midnight as provided by the device.

Since:

API Level 1.0.0

Instance Member Summary collapse

Instance Attribute Details

var activeMinutesDay as ActivityMonitor.ActiveMinutes or Null

The number of active minutes for the current day.

Contains the moderate, vigorous, and total accumulated minutes for the day. Value may be null.

Since:

API Level 2.1.0

Supported Devices:

Returns:

var activeMinutesWeek as ActivityMonitor.ActiveMinutes or Null

The number of active minutes for the current week.

Contains the moderate, vigorous, and total accumulated minutes for the week. Value may be null.

Since:

API Level 2.1.0

Supported Devices:

Returns:

var activeMinutesWeekGoal as Lang.Number or Null

The value of the active minutes goal for the current week. Value may be null.

Since:

API Level 2.1.0

Supported Devices:

Returns:

var calories as Lang.Number or Null

The calories burned so far for the current day in kilocalories (kCal). Value may be null.

Since:

API Level 1.0.0

Supported Devices:

Returns:

var distance as Lang.Number or Null

The distance since midnight for the current day in centimeters (cm). Value may be null.

Since:

API Level 1.0.0

Returns:

var floorsClimbed as Lang.Number or Null

The number of floors climbed for the current day. Value may be null.

Since:

API Level 2.1.0

Supported Devices:

Returns:

var floorsClimbedGoal as Lang.Number or Null

The current floor climb goal. Value may be null.

Since:

API Level 2.1.0

Supported Devices:

Returns:

var floorsDescended as Lang.Number or Null

The number of floors descended for the current day. Value may be null.

Since:

API Level 2.1.0

Supported Devices:

Returns:

var isSleepMode as Lang.Boolean or Null

This has been deprecated

This value may be removed after System 4.

Determine whether the device is in sleep mode. Value may be null.

Since:

API Level 1.0.0

Supported Devices:

Returns:

var metersClimbed as Lang.Float or Null

The vertical distance of floors climbed in meters (m).

This only counts the vertical distance associated with the floors climbed metric recorded by the device. Value may be null.

Since:

API Level 2.1.0

Supported Devices:

Returns:

var metersDescended as Lang.Float or Null

The vertical distance of floors descended in meters (m).

This only counts the vertical distance associated with the floors descended metric recorded by the device. Value may be null.

Since:

API Level 2.1.0

Supported Devices:

Returns:

var moveBarLevel as Lang.Number or Null

The current level of the move bar between MOVE_BAR_LEVEL_MIN and MOVE_BAR_LEVEL_MAX. Value may be null.

Since:

API Level 1.0.0

Returns:

var pushDistance as Lang.Number or Null

The wheelchair push distance for the day in centimeters (cm).

Since:

API Level 4.2.3

Supported Devices:

Returns:

var pushGoal as Lang.Number or Null

The wheelchair push goal for the day in number of pushes.

Since:

API Level 4.2.3

Supported Devices:

Returns:

var pushes as Lang.Number or Null

Wheelchair push count for the day in number of pushes.

Since:

API Level 4.2.3

Supported Devices:

Returns:

var respirationRate as Lang.Number or Null

Current respiration rate for the user, in breaths per minute Value may be null.

Since:

API Level 3.3.0

Supported Devices:

Returns:

var stepGoal as Lang.Number or Null

The step goal for the current day in number of steps. Value may be null.

Since:

API Level 1.0.0

Returns:

var steps as Lang.Number or Null

The step count since midnight for the current day in number of steps. Value may be null.

Since:

API Level 1.0.0

Returns:

var stressScore as Lang.Number or Null

The current stress score

The stress score calculated using a rolling average of the last 30 seconds of stress level readings. Value may be null.

Since:

API Level 5.0.0

Supported Devices:

Returns:

  • Lang.Number —

    Values correspond to the following scale

    • 0–25: Resting state

    • 26–50: Low stress

    • 51–75: Medium stress

    • 76–100: High stress

var timeToRecovery as Lang.Number or Null

Time to recovery from the last activity, in hours Value may be null.

Since:

API Level 3.3.0

Supported Devices:

Returns:

Generated Sep 23, 2024, 3:32:48 PM