CombinedSpeedAndCadenceSensor Class

This class supports combined speed and cadence sensors.

Definition

Namespace: SmallEarthTech.AntPlus.DeviceProfiles.BikeSpeedAndCadence
Assembly: SmallEarthTech.AntPlus (in SmallEarthTech.AntPlus.dll) Version: 6.0.2+4dd3b18a61cb7a7c9070bf010b9a118f4696f0c4
C#
public class CombinedSpeedAndCadenceSensor : AntDevice
Inheritance
ObservableObject    AntDevice    CombinedSpeedAndCadenceSensor

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 and Asset Tracker. 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

CombinedSpeedAndCadenceSensor(ChannelId, IAntChannel, ILoggerCombinedSpeedAndCadenceSensor, TimeoutOptions) Initializes a new instance of the CombinedSpeedAndCadenceSensor class.
CombinedSpeedAndCadenceSensor(ChannelId, IAntChannel, ILoggerCombinedSpeedAndCadenceSensor, Int32) Initializes a new instance of the CombinedSpeedAndCadenceSensor class.

Properties

AccumulatedDistanceGets the accumulated distance in meters.
ChannelCountThis 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)
ChannelIdGets the channel identifier.
(Inherited from AntDevice)
DeviceImageStreamGets the device image stream from the embedded resource image associated with the derived device class.
(Overrides AntDeviceDeviceImageStream)
InstantaneousCadenceGets the instantaneous cadence in revolutions per minute.
InstantaneousSpeedGets the instantaneous speed in meters per second.
OfflineGets a value indicating whether this AntDevice is offline.
(Inherited from AntDevice)
WheelCircumferenceThe wheel circumference in meters. The default is 2.2 meters.

Methods

Dispose Releases the resources used by the current instance of the class.
(Inherited from AntDevice)
ParseParses the specified data page.
(Overrides AntDeviceParse(Byte))
RequestDataPageTRequests the data page.
(Inherited from AntDevice)
SendExtAcknowledgedMessageSends an acknowledged message to the ANT device.
(Inherited from AntDevice)
ToString Returns a string representation of the current derived AntDevice.
(Overrides AntDeviceToString)

Events

DeviceWentOfflineOccurs when no messages have been received from the device within the specified timeout duration.
(Inherited from AntDevice)

Fields

_loggerThe logger for derived classes to use.
(Inherited from AntDevice)
DeviceClass The device type value transmitted in the channel ID.

See Also