Class: Toybox.AntPlus.FitnessEquipment

Inherits:

Toybox.AntPlus.Device

• Toybox.Lang.Object
• Toybox.AntPlus.Device
• Toybox.AntPlus.FitnessEquipment

Overview

Represents a Fitness Equipment Device instance.

Example:

using Toybox.AntPlus;

// Assuming Valid FitnessEquipmentListener object "MyFitnessEquipmentListener"

// Initialize the AntPlus.FitnessEquipmentListener object
listener = new MyFitnessEquipmentListener();

// Initialize the AntPlus.BikePower object with a listener
fitnessEquipment = new AntPlus.FitnessEquipment(listener);

fitnessEquipment.setTrainerMode(TRAINER_MODE_BASIC_RESISTANCE);
fitnessEquipment.controlEquipment(TRAINER_RESISTANCE, 30); //sets basic resistance to 30% of maximum.
// ...etc

Since:

API Level 2.4.0

Supported Devices:

• Edge® 1000 / Explore
• Edge® 1030 / Bontrager
• Edge® 1030 Plus
• Edge® 1030
• Edge® 1040 / 1040 Solar
• Edge® 520 Plus
• Edge® 520
• Edge® 530
• Edge® 540 / 540 Solar
• Edge® 820 / Explore
• Edge® 830
• Edge® 840 / 840 Solar
• Edge® Explore 2

Instance Method Summary

• controlEquipment(setting as AntPlus.TrainerValue, data as Lang.Float or AntPlus.TrainerMode) as Void

  Control the fitness Equipment Note: Setting a value related to a specific training mode will cause the fitness equipment to change to that mode.

• getEquipmentData() as AntPlus.FitnessEquipmentData

  Get the current training data from the FE.

• getResistanceSettings() as AntPlus.ResistanceSettings

  Get the resistance percentage setting of the fitness equipment for basic resistance training mode.

• getSimulationSettings() as AntPlus.SimulationSettings

  Get the wind and track resistance simulation settings.

• getTargetPowerSettings() as AntPlus.TargetPowerSettings

  Get the target power setting of the fitness equipment for target power training mode.

• getTrainerMode() as AntPlus.FitnessEquipmentMode

  Get the current training mode and supported modes of the fitness equipment.

• getUserSettings() as AntPlus.UserSettings

  Get the user configuration settings of the fitness equipment for simulation training mode.

• initialize(listener as AntPlus.FitnessEquipmentListener or Null)

  Constructor.

• setTrainerMode(mode as AntPlus.TrainerMode) as Void

  Set the trainer mode.

Instance Method Details

controlEquipment(setting as AntPlus.TrainerValue, data as Lang.Float or AntPlus.TrainerMode) as Void

Control the fitness Equipment Note: Setting a value related to a specific training mode will cause the fitness equipment to change to that mode. For example, controlEquipment(TRAINER_TARGET_POWER, 100) will set the fitness equipment to target power mode with target power set to 100W if such mode is supported. Values out of range will be set to within the nearest range boundary value.

Parameters:

• setting — (Lang.Number) —

  A TRAINER_* value.

• data — (Lang.Float) —

  The value of the setting to be sent or TRAINER_MODE_* enum value if setting mode.

Since:

API Level 2.4.0

getEquipmentData() as AntPlus.FitnessEquipmentData

Get the current training data from the FE

Returns:

• AntPlus.FitnessEquipmentData —

  Fitness Equipment training data

Since:

API Level 2.4.0

getResistanceSettings() as AntPlus.ResistanceSettings

Get the resistance percentage setting of the fitness equipment for basic resistance training mode. You should set resistance values and be in basic resistance training mode before calling this method, otherwise null or default values may be returned.

Returns:

• AntPlus.ResistanceSettings —

  Fitness Equipment resistance Setting

Since:

API Level 2.4.0

getSimulationSettings() as AntPlus.SimulationSettings

Get the wind and track resistance simulation settings. You should set wind and track settings, as well as be in simulation training mode before calling this method or null or default values may be returned.

Returns:

• AntPlus.SimulationSettings —

  Fitness Equipment simulation settings

Since:

API Level 2.4.0

getTargetPowerSettings() as AntPlus.TargetPowerSettings

Get the target power setting of the fitness equipment for target power training mode. You should set the target power and be in target power training mode before calling this method, otherwise null or default values may be returned.

Returns:

• AntPlus.TargetPowerSettings —

  Fitness Equipment target power Setting

Since:

API Level 2.4.0

getTrainerMode() as AntPlus.FitnessEquipmentMode

Get the current training mode and supported modes of the fitness equipment

Returns:

• AntPlus.FitnessEquipmentMode —

  Fitness Equipment training mode

Since:

API Level 2.4.0

getUserSettings() as AntPlus.UserSettings

Get the user configuration settings of the fitness equipment for simulation training mode. You should set user settings values and be in simulation mode before calling this method, otherwise null or default values may be returned.

Returns:

• AntPlus.UserSettings —

  Fitness Equipment user profile settings

Since:

API Level 2.4.0

initialize(listener as AntPlus.FitnessEquipmentListener or Null)

Constructor

Parameters:

• listener — (AntPlus.FitnessEquipmentListener) —

  The fitness equipment instance optionally takes an extension of the FitnessEquipmentListener class as a parameter. null can be passed in instead if the user plans to only poll for data using the get* methods.

Since:

API Level 2.4.0

setTrainerMode(mode as AntPlus.TrainerMode) as Void

Set the trainer mode. You should check the capable modes of the fitness equipment, as the command will be ignored by the fitness equipment if the mode is not supported.

Parameters:

• mode — (Lang.Number) —

  The TRAINER_MODE_* enum value

Since:

API Level 2.4.0