CommonSpeedCadence Class

This class is common to speed and cadence sensors. Combined speed and cadence sensors do not use this class.

Definition

Namespace: SmallEarthTech.AntPlus.DeviceProfiles.BikeSpeedAndCadence
Assembly: SmallEarthTech.AntPlus (in SmallEarthTech.AntPlus.dll) Version: 6.0.2+4dd3b18a61cb7a7c9070bf010b9a118f4696f0c4

C#

public abstract class CommonSpeedCadence : AntDevice

VB

Public MustInherit Class CommonSpeedCadence
	Inherits AntDevice

C++

public ref class CommonSpeedCadence abstract : public AntDevice

F#

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

Inheritance: ObservableObject AntDevice CommonSpeedCadence

Derived: SmallEarthTech.AntPlus.DeviceProfiles.BikeSpeedAndCadenceBikeCadenceSensor
SmallEarthTech.AntPlus.DeviceProfiles.BikeSpeedAndCadenceBikeSpeedSensor

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

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

Properties

BatteryStatus	Gets the battery status.
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 AntDevice)
ChannelId	Gets the channel identifier. (Inherited from AntDevice)
CumulativeOperatingTime	Gets the cumulative operating time.
DeviceImageStream	Gets the device image stream from the embedded resource image associated with the derived device class. (Inherited from AntDevice)
ManufacturerInfo	Gets the manufacturer information.
Offline	Gets a value indicating whether this AntDevice is offline. (Inherited from AntDevice)
ProductInfo	Gets the product information.
Stopped	Gets a value indicating whether this sensor has detected stopped condition.

Methods

Dispose	Releases the resources used by the current instance of the class. (Inherited from AntDevice)
Parse	Parses the specified data page. (Overrides AntDeviceParse(Byte))
RequestDataPageT	Requests the data page. (Inherited from AntDevice)
SendExtAcknowledgedMessage	Sends an acknowledged message to the ANT device. (Inherited from AntDevice)
ToString	Returns a string representation of the current derived AntDevice. (Inherited from AntDevice)

Events

DeviceWentOffline

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

Fields

_logger	The logger for derived classes to use. (Inherited from AntDevice)
isFirstDataMessage	The is first data message received.
prevEventTime	The previous event time
prevRevCount	The previous revolution count