Small Earth Technology ANT+ Class Library
Treadmill Class
This class supports the treadmill fitness equipment type.
Definition
Namespace: SmallEarthTech.AntPlus.DeviceProfiles.FitnessEquipment
Assembly: SmallEarthTech.AntPlus (in SmallEarthTech.AntPlus.dll) Version: 4.0.0.0+4009252dff1e4f6bcda36b6b0041486552134bc5
Assembly: SmallEarthTech.AntPlus (in SmallEarthTech.AntPlus.dll) Version: 4.0.0.0+4009252dff1e4f6bcda36b6b0041486552134bc5
C#
public class Treadmill : FitnessEquipmentVB
Public Class Treadmill
Inherits FitnessEquipmentC++
public ref class Treadmill : public FitnessEquipmentF#
type Treadmill =
class
inherit FitnessEquipment
end- Inheritance
- Object ObservableObject AntDevice FitnessEquipment Treadmill
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
| Treadmill(ChannelId, IAntChannel, ILoggerTreadmill, TimeoutOptions) | Initializes a new instance of the Treadmill class. |
| Treadmill(ChannelId, IAntChannel, ILoggerTreadmill, Int32) | Initializes a new instance of the Treadmill class. |
Properties
| Cadence | Gets the cadence in strides per minute. |
| Capabilities | Gets the treadmill specific capabilities. |
| 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. (Inherited from FitnessEquipment) |
| ChannelId | Gets the channel identifier. (Inherited from AntDevice) |
| CommonDataPages | Gets the common data pages. (Inherited from FitnessEquipment) |
| DeviceImageStream | Gets the device image stream from the embedded resource image associated with the derived device class. (Inherited from FitnessEquipment) |
| GeneralData | Gets the general data. (Inherited from FitnessEquipment) |
| GeneralMetabolic | Gets the general metabolic reports. (Inherited from FitnessEquipment) |
| GeneralSettings | Gets the general settings. (Inherited from FitnessEquipment) |
| MaxTrainerResistance | Gets the maximum trainer resistance. (Inherited from FitnessEquipment) |
| NegVerticalDistance | Gets the accumulated negative vertical distance traveled in meters. Note this is a negative value. |
| Offline | Gets a value indicating whether this AntDevice is offline. (Inherited from AntDevice) |
| PosVerticalDistance | Gets the accumulated positive vertical distance traveled in meters. |
| State | Gets the equipment state. (Inherited from FitnessEquipment) |
| TrainingModes | Gets the supported training modes. (Inherited from FitnessEquipment) |
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) |
| 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. (Inherited from FitnessEquipment) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Parse |
Parses the specified data page.
(Overrides FitnessEquipmentParse(Byte)) |
| RequestDataPageT | Requests the data page. (Inherited from AntDevice) |
| RequestFECapabilities | Requests the fitness equipment capabilities. (Inherited from FitnessEquipment) |
| SendExtAcknowledgedMessage | Sends an acknowledged message to the ANT device. (Inherited from AntDevice) |
| SetBasicResistance | Sets the percentage of maximum resistance resistance. (Inherited from FitnessEquipment) |
| SetTargetPower | Sets the target power in wats. (Inherited from FitnessEquipment) |
| SetTrackResistance | Sets the track resistance. (Inherited from FitnessEquipment) |
| SetUserConfiguration | Sets the user configuration. (Inherited from FitnessEquipment) |
| SetWindResistance | Sets the wind resistance. (Inherited from FitnessEquipment) |
| ToString | Returns a string that represents the current object. (Overrides AntDeviceToString) |
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. (Inherited from FitnessEquipment) |
Fields
| _logger | The logger for derived classes to use. (Inherited from AntDevice) |
| handledPage |
Flag indicating the data page was handled by Parse(Byte).
(Inherited from FitnessEquipment) |