Skip to main content
Version: v3+

Workout

Start from API_LEVEL 3.0 . Please refer to API_LEVEL.

Workout Sensor.

info

permission code: data:user.hd.workout

Methods

getStatus

Get altitude value in meters

getStatus(): Status

Status

PropertyTypeDescriptionAPI_LEVEL
vo2MaxnumberVO2 Max3.0
trainingLoadnumberTraining Load3.0
fullRecoveryTimenumberFull Recovery Time3.0

getHistory

Get the duration of the workout record

getHistory(): Array<History>

History

PropertyTypeDescriptionAPI_LEVEL
startTimenumberWorkout start time3.0
durationnumberDuration of workout in seconds3.0

getUserHrZoneSettings

Start from API_LEVEL 4.2

Get user heart rate zone settings

getUserHrZoneSettings(): HrZoneSettings

HrZoneSettings

PropertyTypeDescriptionAPI_LEVEL
typenumberHeart rate zone type, 0: by heart rate reserve, 1: by maximum heart rate4.2
restnumberResting heart rate value4.2
rangenumber[]Heart rate zone value array with 6 values, corresponding to: Ligit, Intensive, Aerobic, Anaerobic, VO2 max and maximum heart rate4.2

getWorkoutTrackNavInfo

Start from API_LEVEL 4.2

Get workout track navigation information, returns navigation info object when navigation is enabled, returns undefined when navigation is not enabled

getWorkoutTrackNavInfo(): WorkoutTrackNavInfo | undefined

WorkoutTrackNavInfo

PropertyTypeDescriptionAPI_LEVEL
isYawnumberWhether off course, true: off course, false: on course4.2
yawAnglenumberYaw angle4.2
yawDistancenumberYaw distance in meters4.2
remainDistancenumberRemaining distance in meters4.2
turnDistancenumberDistance to next turn in meters4.2
turnTypenumberThe direction of the next turn, refer to TURN_TYPE for value meanings4.2

TURN_TYPE

ValueTypeDescriptionAPI_LEVEL
1numberTurn right forward4.2
2numberTurn right4.2
3numberTurn right backward4.2
4numberU-turn to the right4.2
5numberU-turn4.2
6numberU-turn to the left4.2
7numberTurn left backward4.2
8numberTurn left4.2
9numberTurn left forward4.2

Example

import { Workout } from '@zos/sensor'

const workout = new Workout()

const status = workout.getStatus()
const history = workout.getHistory()

const hrZoneSettings = workout.getUserHrZoneSettings()
// {"type":0,"rest":83,"range":[129,138,147,157,166,175]}
// {"type":1,"rest":70,"range":[90,108,126,144,162,181]}

const trackNavInfo = workout.getWorkoutTrackNavInfo()