Small Earth Technology ANT+ Class Library
IAnt
Enables a one time proximity requirement for searching. Only ANT devices within the set proximity bin can be acquired.
Search threshold values are not correlated to specific distances as this will be dependent on the system design.
This feature is not available on all ANT devices.
Throws exception if given bin value is > 10.
Definition
Namespace: SmallEarthTech.AntRadioInterface
Assembly: SmallEarthTech.AntRadioInterface (in SmallEarthTech.AntRadioInterface.dll) Version: 4.1.0+506fd73c3b72ad19a414fa5c6d86694cac54d86e
True on success. Note: Always returns true with a response time of 0
Assembly: SmallEarthTech.AntRadioInterface (in SmallEarthTech.AntRadioInterface.dll) Version: 4.1.0+506fd73c3b72ad19a414fa5c6d86694cac54d86e
C#
bool SetProximitySearch(
byte thresholdBin,
uint responseWaitTime
)VB
Function SetProximitySearch (
thresholdBin As Byte,
responseWaitTime As UInteger
) As BooleanC++
bool SetProximitySearch(
unsigned char thresholdBin,
unsigned int responseWaitTime
)F#
abstract SetProximitySearch :
thresholdBin : byte *
responseWaitTime : uint32 -> bool Parameters
- thresholdBin Byte
- Threshold bin. Value from 0-10 (0= disabled). A search threshold value of 1 (i.e. bin 1) will yield the smallest radius search and is generally recommended as there is less chance of connecting to the wrong device.
- responseWaitTime UInt32
- Time to wait for device success response
Return Value
BooleanTrue on success. Note: Always returns true with a response time of 0