User Manual

PLUS System Manual Location Software Library 71
Proprietary Information: Do not disclose unless authorized under a Nondisclosure Agreement and the Partner Agreement.
bestReaderIdLow, bestReaderIdHi The best Reader is the first TOA of the last bundle used to produce a solution. It
is provided primarily as an aid in debugging.
4.5.1.6 TrackerAlarm Event
public virtual void TrackerAlarm( int alarmType
int alarmParm1,
int alarmParm2,
int alarmParm3,
int alarmParm4 )
This event is fired for various alarm conditions: Reader alarm (a Reader sent a TOA packet with the alarm bit set),
Reader timeout (a Reader was not heard within a certain time span), and Tag timeout (a Tag was not heard within
a certain time span).
alarmType Reader timeout =2
Reader alarm =3
Tag timeout = 4
Other alarm types may be defined in the future. Applications should ignore unknown alarms.
The alarm parameters vary depending on the type of alarm:
Reader Timeout:
alarmParm1 is the timestamp when the alarm occurred
alarmParm2 is the lower four bytes of the Reader MAC address that has timed out
alarmParm3 is the upper two bytes of the Reader MAC address that has timed out
alarmParm4 is unused
Reader alarm:
alarmParm1 is the timestamp when the alarm occurred
alarmParm2 is the lower portion of the Reader ID that has an alarm
alarmParm3 is the upper portion of the Reader ID that has an alarm
alarmParm4 is unused
Tag timeout:
alarmParm1 is the timestamp when the alarm occurred
alarmParm2 is the Tag ID that has timed out
alarmParm3 is unused
alarmParm4 is unused
4.5.2 Advanced API Features
This section describes the advanced features of the Location Software API. These features are not used
by most applications. However, they are discussed here for completeness.
4.5.2.1 Alarms
The Location Software can send alarm events as an aid in monitoring system health and status. Three
types of alarms are: Reader timeout, Reader Alarm, and Tag timeout. A Reader timeout alarm is fired
when the Location Software has received no data (neither TOA nor discovery packets) from a Reader in
a configurable amount of time. A Reader alarm is fired when a TOA packet with the alarm bit set is