Small Earth Technology ANT+ Class Library
Ant
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.AntUsbStick
Assembly: SmallEarthTech.AntUsbStick (in SmallEarthTech.AntUsbStick.dll) Version: 3.0.0.0+4009252dff1e4f6bcda36b6b0041486552134bc5
True on success. Note: Always returns true with a response time of 0
Assembly: SmallEarthTech.AntUsbStick (in SmallEarthTech.AntUsbStick.dll) Version: 3.0.0.0+4009252dff1e4f6bcda36b6b0041486552134bc5
C#
public bool SetProximitySearch(
byte thresholdBin,
uint responseWaitTime
)VB
Public Function SetProximitySearch (
thresholdBin As Byte,
responseWaitTime As UInteger
) As BooleanC++
public:
virtual bool SetProximitySearch(
unsigned char thresholdBin,
unsigned int responseWaitTime
) sealedF#
abstract SetProximitySearch :
thresholdBin : byte *
responseWaitTime : uint32 -> bool
override 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