CombinedSpeedAndCadenceSensor Class

This class supports combined speed and cadence sensors.

Definition

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

C#

public class CombinedSpeedAndCadenceSensor : AntDevice

VB

Public Class CombinedSpeedAndCadenceSensor
	Inherits AntDevice

C++

public ref class CombinedSpeedAndCadenceSensor : public AntDevice

F#

type CombinedSpeedAndCadenceSensor = 
    class
        inherit AntDevice
    end

Inheritance: Object 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. 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

AccumulatedDistance	Gets the accumulated distance in meters.
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)
DeviceImageStream	Gets the device image stream from the embedded resource image associated with the derived device class. (Overrides AntDeviceDeviceImageStream)
InstantaneousCadence	Gets the instantaneous cadence in revolutions per minute.
InstantaneousSpeed	Gets the instantaneous speed in meters per second.
Offline	Gets a value indicating whether this AntDevice is offline. (Inherited from AntDevice)
WheelCircumference	The wheel circumference in meters. The default is 2.2 meters.

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)
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)
SendExtAcknowledgedMessage	Sends an acknowledged message to the ANT device. (Inherited from AntDevice)
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)

Fields

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