Geocache Class

This class supports geocaches. This is specified in ANT+ Managed Network Document – Geocache Device Profile.

Definition

Namespace: SmallEarthTech.AntPlus.DeviceProfiles
Assembly: SmallEarthTech.AntPlus (in SmallEarthTech.AntPlus.dll) Version: 6.0.2+92d79d127283ce9ab80906ab6fb15f5ffa8ae8ac

C#

public class Geocache : AntDevice

VB

Public Class Geocache
	Inherits AntDevice

C++

public ref class Geocache : public AntDevice

F#

type Geocache = 
    class
        inherit AntDevice
    end

Inheritance: ObservableObject AntDevice Geocache

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

Geocache(ChannelId, IAntChannel, ILoggerGeocache, TimeoutOptions)	Initializes a new instance of the Geocache class.
Geocache(ChannelId, IAntChannel, ILoggerGeocache, Int32)	Initializes a new instance of the Geocache class.

Properties

AuthenticationToken	Gets the authentication token.
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)
CommonDataPages	Gets the common data pages.
DeviceImageStream	Gets the device image stream from the embedded resource image associated with the derived device class. (Overrides AntDeviceDeviceImageStream)
Hint	Gets a message from the geocache device, or a next stage hint.
LastVisitTimestamp	Gets the last visit timestamp.
NextStageLatitude	Gets the next stage latitude in decimal degrees. North is positive, south is negative.
NextStageLongitude	Gets the next stage longitude in decimal degrees. East is positive, west is negative.
NumberOfVisits	Gets the number of visits logged.
Offline	Gets a value indicating whether this AntDevice is offline. (Inherited from AntDevice)
ProgrammingPIN	Gets the programming PIN.
TotalPagesProgrammed	Gets the total pages programmed.
TrackableId	Gets the trackable identifier.

Methods

Dispose	Releases the resources used by the current instance of the class. (Inherited from AntDevice)
EraseGeocache	Erases the geocache.
Parse	Parses the specified data page. (Overrides AntDeviceParse(Byte))
ProgramGeocache	Programs the geocache.
RequestAuthentication	Requests the authentication token from the geocache.
RequestDataPageT	Requests the data page. (Inherited from AntDevice)
RequestPinPage	Requests the PIN page. Do this first before performing any other operations on the geocache.
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)
UpdateLoggedVisits	Updates the logged visits count and last visit timestamp.

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.