Introduction
The alarm management feature of Eliko RTLS allows to activate alarm patterns on the RTLS tags, thus notifying or warning the user about some special events. There are currently 13 predefined alarm patters, which involve activities on the tag’s internal RGB LED, driving the vibro-motor and an external device.
Note that this feature requires:
-
RTLS Server software version 2.5.4 or higher.
-
RTLS Tag and Anchor firmware version 3.0.0 or higher.
-
Driving the tag’s internal RGB LED works on any tag’s hardware revision. To use the vibro-motor and driving the external device, the tag’s hardware revision 5.9 or higher is required. These are tags with serial number 0x0009EF and upwards.
SET_TAG_ALARM
This request can be used to activate or deactivate a tag’s alarm.
Client sends:
$PEKIO,SET_TAG_ALARM,<parameter list>
<parameter list> is a comma-separated list with the following fields:
|
Field name |
Explanation |
Example |
|
Tag’s Serial Number OR Tag group ID OR The keyword “ALL” |
May be one of the following:
|
0x123464 TG;1 ALL |
|
ON/OFF/ONCE |
A keyword with the following meaning:
|
ONCE |
|
Alarm Pattern ID |
A decimal number from 0 to 12, which identifies the alarm pattern to be used. The list of possible alarm patterns is given in the next table. Note that this parameter is meaningful only if the previous parameter is “ON” or “ONCE”. It has no meaning and can be omitted when switching the alarm “OFF”. If this parameter is omitted for “ON” or “ONCE” mode, a default value of 0 is used. |
12 |
|
Alarm Duration |
Alarm duration in seconds for “ONCE” mode. Should be an integer from 1 to 14. It has no meaning for the “ON” and “OFF” mode and can be omitted. If this parameter is omitted for “ONCE” mode, a default value of 3 is used. |
4 |
<Alarm Pattern ID> can have values from 0 to 12:
|
Alarm Pattern ID |
LED Behavior |
Vibro-motor Behavior |
External Device Behavior |
|
0 |
250ms Blue -> 250ms OFF -> Repeat |
400ms ON -> 400ms OFF -> Repeat |
400ms ON -> 400ms OFF -> Repeat |
|
1 |
OFF |
400ms ON -> 400ms OFF -> Repeat |
400ms ON -> 400ms OFF -> Repeat |
|
2 |
OFF |
200ms ON -> 200ms OFF -> Repeat |
200ms ON -> 200ms OFF -> Repeat |
|
3 |
250ms Red -> 250ms OFF -> Repeat |
OFF |
400ms ON -> 400ms OFF -> Repeat |
|
4 |
250ms White -> 250ms OFF -> Repeat |
OFF |
200ms ON -> 200ms OFF -> Repeat |
|
5 |
250ms Yellow -> 250ms OFF -> Repeat |
400ms ON -> 400ms OFF -> Repeat |
OFF |
|
6 |
250ms Magenta -> 250ms OFF -> Repeat |
200ms ON -> 200ms OFF -> Repeat |
OFF |
|
7 |
OFF |
200ms ON -> 200ms OFF -> Repeat |
OFF |
|
8 |
OFF |
400ms ON -> 200ms OFF -> Repeat |
OFF |
|
9 |
250ms Cyan -> 250ms OFF -> Repeat |
OFF |
OFF |
|
10 |
250ms Red -> 250ms Yellow -> Repeat |
OFF |
OFF |
|
11 |
OFF |
OFF |
400ms ON -> 400ms OFF -> Repeat |
|
12 |
OFF |
OFF |
400ms ON -> 200ms OFF -> Repeat |
|
13-15 |
RESERVED |
RESERVED |
RESERVED |
Some full examples of client’s request would be:
$PEKIO,SET_TAG_ALARM,ALL,ON,5
$PEKIO,SET_TAG_ALARM,0x0012A6,ONCE,0,4
$PEKIO,SET_TAG_ALARM,0x0012A6,OFF
$PEKIO,SET_TAG_ALARM,TG;2,ON,6
If the request was successful, the system responds:
$PEKIO,OK
If the system encountered an error when processing the request, the following response will be sent:
$PEKIO,NOT_GOOD,<error ID>
<error ID> can be one of the following:
|
Error ID |
Explanation |
|
WRONG_ALARM_STATE_VALUE |
The alarm mode specifier could not be parsed as “ON”, “OFF” or “ONCE”. |
|
WRONG_PATTERN_ID_VALUE |
The Alarm Pattern ID parameter was present, but could not be parsed as an integer from 0 to 15. |
|
WRONG_DURATION_VALUE |
The Alarm Duration parameter was present, but could not be parsed as an integer from 1 to 14. |
|
<tag addressing errors> |
If there was a problem with tag addressing, the common error messages described in chapter “Tag Addressing” may also appear. |