Small Earth Technology ANT+ Class Library
Bike
This class supports bike cadence sensors.
Definition
Namespace: SmallEarthTech.AntPlus.DeviceProfiles.BikeSpeedAndCadence
Assembly: SmallEarthTech.AntPlus (in SmallEarthTech.AntPlus.dll) Version: 4.0.0.0+01fc5ca24e8f030354f28ec9cef320bc5cbb0ef6
Assembly: SmallEarthTech.AntPlus (in SmallEarthTech.AntPlus.dll) Version: 4.0.0.0+01fc5ca24e8f030354f28ec9cef320bc5cbb0ef6
C#
public class BikeCadenceSensor : CommonSpeedCadenceVB
Public Class BikeCadenceSensor
Inherits CommonSpeedCadenceC++
public ref class BikeCadenceSensor : public CommonSpeedCadenceF#
type BikeCadenceSensor =
class
inherit CommonSpeedCadence
end- Inheritance
- Object ObservableObject AntDevice CommonSpeedCadence BikeCadenceSensor
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
| BikeCadenceSensor(ChannelId, IAntChannel, ILoggerBikeCadenceSensor, TimeoutOptions) | Initializes a new instance of the BikeCadenceSensor class. |
| BikeCadenceSensor(ChannelId, IAntChannel, ILoggerBikeCadenceSensor, Int32) | Initializes a new instance of the BikeCadenceSensor class. |
Properties
| BatteryStatus | Gets the battery status. (Inherited from CommonSpeedCadence) |
| 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) |
| CumulativeOperatingTime | Gets the cumulative operating time. (Inherited from CommonSpeedCadence) |
| 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 rotations per minute. |
| ManufacturerInfo | Gets the manufacturer information. (Inherited from CommonSpeedCadence) |
| Offline | Gets a value indicating whether this AntDevice is offline. (Inherited from AntDevice) |
| ProductInfo | Gets the product information. (Inherited from CommonSpeedCadence) |
| Stopped | Gets a value indicating whether this sensor has detected stopped condition. (Inherited from CommonSpeedCadence) |
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 CommonSpeedCadenceParse(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. |
| isFirstDataMessage | The is first data message
received. (Inherited from CommonSpeedCadence) |
| prevEventTime | The previous event time (Inherited from CommonSpeedCadence) |
| prevRevCount | The previous revolution count (Inherited from CommonSpeedCadence) |