Alarm Event

DIRECTION

Bidirectional

INPUTS

Parameter	Definition	Example
Location ID	Unique identifier for a RaPTr Scanner in a warehouse.	1
Alarm Key	Key that identifies one alarm from the next. It is used to look up an alarm to see if it is currently active.	Alarm-Key-01
Severity	A value ranging between one and four. Increasing levels of the severity forces the alarm to appear differently in the RaPTr Scanner alarm banner. 1 is yellow. 2 is orange. 3 and 4 are both red.	1
Active Status	Determines if the alarm is active	True
Ack Required	If true, it requires that the alarm be acknowledged on the scanner, even after the alarm is no longer active. Generally, this should be set to false.	False
Time	Time in which the alarm was generated 5/13/2022	10:24:45
Text	Message to be displayed on the alarm	Server Off

OUTPUTS

Parameter	Definition	Example
Location ID	Unique identifier for a RaPTr Scanner in a warehouse.	1
Response Code	Determines if the alarm was successfully acquired. 1 = Yes, 0 = No.	1

SUPPORTED OPERATIONAL INTERFACES

Plug-In, REST API, SAP Gateway API

DESCRIPTION

RaPTr Scanners and Servers can relay alarm messages back and forth. When a RaPTr Scanner experiences an alarm, it relays that information to RaPTr Server for logging and reporting purposes. If the RaPTr Sever has an error, an alarm message can be sent to one or all connected RaPTr Scanners to be displayed on its alarm banner. This offers a method of real-time visualization into the alarms and events that happen on a RaPTr Server. Once an alarm is no longer active, a second message should be sent indicating that the alarm is now inactive so that it can be removed from the scanner’s alarm banner.