Small Earth Technology ANT+ Class Library
Ant
Base class for all ANT devices.
Definition
Namespace: SmallEarthTech.AntPlus
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 abstract class AntDevice : ObservableObject,
IDisposableVB
Public MustInherit Class AntDevice
Inherits ObservableObject
Implements IDisposableC++
public ref class AntDevice abstract : public ObservableObject,
IDisposableF#
[<AbstractClassAttribute>]
type AntDevice =
class
inherit ObservableObject
interface IDisposable
end- Inheritance
- Object ObservableObject AntDevice
- Derived
- Implements
- IDisposable
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
| AntDevice(ChannelId, IAntChannel, ILogger, TimeoutOptions) | Initializes a new instance of the AntDevice class. |
| AntDevice(ChannelId, IAntChannel, ILogger, Int32) | Initializes a new instance of the AntDevice class. |
Properties
| 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. |
| ChannelId | Gets the channel identifier. |
| DeviceImageStream | Gets the device image stream from the embedded resource image associated with the derived device class. |
| Offline | Gets a value indicating whether this AntDevice is offline. |
Methods
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| 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. |
| RequestDataPageT | Requests the data page. |
| SendExtAcknowledgedMessage | Sends an acknowledged message to the ANT device. |
| ToString | Returns a string that represents the current object. (Overrides ObjectToString) |
Events
| DeviceWentOffline | Occurs when no messages have been received from the device within the specified timeout duration. |
Fields
| _logger | The logger for derived classes to use. |