FitnessEquipment Class

This is the primary support class for fitness equipment sensors.

Definition

Namespace: SmallEarthTech.AntPlus.DeviceProfiles.FitnessEquipment
Assembly: SmallEarthTech.AntPlus (in SmallEarthTech.AntPlus.dll) Version: 4.0.0.0+4009252dff1e4f6bcda36b6b0041486552134bc5

public abstract class FitnessEquipment : AntDevice

Public MustInherit Class FitnessEquipment
	Inherits AntDevice

C++

public ref class FitnessEquipment abstract : public AntDevice

[<AbstractClassAttribute>]
type FitnessEquipment = 
    class
        inherit AntDevice
    end

Inheritance: Object ObservableObject AntDevice FitnessEquipment

Derived: SmallEarthTech.AntPlus.DeviceProfiles.FitnessEquipmentClimber
SmallEarthTech.AntPlus.DeviceProfiles.FitnessEquipmentElliptical
SmallEarthTech.AntPlus.DeviceProfiles.FitnessEquipmentNordicSkier
SmallEarthTech.AntPlus.DeviceProfiles.FitnessEquipmentRower
SmallEarthTech.AntPlus.DeviceProfiles.FitnessEquipmentTrainerStationaryBike
SmallEarthTech.AntPlus.DeviceProfiles.FitnessEquipmentTreadmill
More Less

Remarks

An important consideration is an appropriate timeout to determine if a device has gone offline - battery has died, device has been turned off, device is out of range of receiver, ane/or the RF environment the device and receiver are operating in. Most devices broadcast at 4Hz, with the notable exception of Geocache. A reasonable rule of thumb is to set the timeout at 8 messages times the channel period per second; typically 2 seconds. Consult the device profile documentation at https://www.thisisant.com for a device and consult the channel period defined for master devices.

Constructors

FitnessEquipment(ChannelId, IAntChannel, ILogger, TimeoutOptions)	Initializes a new instance of the FitnessEquipment class.
FitnessEquipment(ChannelId, IAntChannel, ILogger, Int32)	Initializes a new instance of the FitnessEquipment class.

Properties

ChannelCount	This is a multiple of the base transmission frequency. All derived classes must implement this property. See the master Channel Period specified in the specific ANT device specification for the count value. (Overrides AntDeviceChannelCount)
ChannelId	Gets the channel identifier. (Inherited from AntDevice)
CommonDataPages	Gets the common data pages.
DeviceImageStream	Gets the device image stream from the embedded resource image associated with the derived device class. (Overrides AntDeviceDeviceImageStream)
GeneralData	Gets the general data.
GeneralMetabolic	Gets the general metabolic reports.
GeneralSettings	Gets the general settings.
MaxTrainerResistance	Gets the maximum trainer resistance.
Offline	Gets a value indicating whether this AntDevice is offline. (Inherited from AntDevice)
State	Gets the equipment state.
TrainingModes	Gets the supported training modes.

Methods

Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from AntDevice)
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GetFitnessEquipment	Gets the fitness equipment if the equipment type is known.
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
HandleFEState	Handles the state of the fitness equipment.
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
Parse	Parses the specified data page. (Overrides AntDeviceParse(Byte))
RequestDataPageT	Requests the data page. (Inherited from AntDevice)
RequestFECapabilities	Requests the fitness equipment capabilities.
SendExtAcknowledgedMessage	Sends an acknowledged message to the ANT device. (Inherited from AntDevice)
SetBasicResistance	Sets the percentage of maximum resistance resistance.
SetTargetPower	Sets the target power in wats.
SetTrackResistance	Sets the track resistance.
SetUserConfiguration	Sets the user configuration.
SetWindResistance	Sets the wind resistance.
ToString	Returns a string that represents the current object. (Inherited from AntDevice)

Events

DeviceWentOffline	Occurs when no messages have been received from the device within the specified timeout duration. (Inherited from AntDevice)
LapToggled	Occurs when a lap toggle is signaled by the device.

Fields

_logger	The logger for derived classes to use. (Inherited from AntDevice)
DeviceClass	The device type value transmitted in the channel ID.
handledPage	Flag indicating the data page was handled by Parse(Byte).