Real Time Alerts (RTA) Programmer's Guide

Highlights of Real Time Alerts Features

What are Real Time Alerts?

Many Zebra scanner devices support active monitoring of device performance over time. Such statistical data is collected and stored locally on each device. This data can be retrieved with directives from Zebra's IoT Connector utility or by sending Corescanner API commands to the scanner device using the Scanner SDK Sample Application for example.

When a notification of a critical change to a scanner device is needed, a feature called “Real Time Alerts” can be used to transmit alerts from the scanner or cradle to a host when certain requested statistic values change, or events occur.

Real Time Alerts (RTA) are preselected events that are monitored by a scanner device. When a selected statistic has reached a specified value or when a selected event occurs, it is then reported by the scanner device to the host as an Alert.

Alerts have prerequisites. The scanner device and its installed firmware must support RTA monitoring, and the data or feature being monitored must be enabled on the device before an alert can be registered. This is done by updating the device's settings with a tool like 123Scan, or by scanning parameters from its Product Reference Guide. For example, if an Alert pertains to an embedded weight scale, the Scale feature must be enabled for the alert to be Registered.

Alerts have a lifecycle. An alert begins by being registered with a command from the host using a Zebra supplied API or the SDK Sample Application. The registration specifies the statistic value or event of interest and any desired target values that would cause an alert to be fired. An alert ends when its registration is cancelled or when the host connection with the scanner is lost.

Once registered, alerts produce events that have specified start and end conditions. An alert is turned “on” when the specified event or value is seen by the device, and is turned “off” when the specified event clears or a statistic reaches a specified value. Each alert is designed to start and end on its own, without any required interaction with the host.

How to access Real Time Alerts data

Each scanner model maintains a selection of alerts that it supports, and the client's host system can register and configure the Alerts that are of concern.

Zebra provides a few ways to access scanner device attributes and statistics. These can be manually viewed using a downloadable sample application. Source code of this sample application in C# can be customized to suit your needs. Additionally, Zebra provides the IoT Connector utility that can be used to monitor changes to Statistics values on the scanner or cradle device, as well as Real Time Alert events.

Zebra provides downloadable utilities, code libraries, interfaces and services that assist in the use of the Real Time Alert features. RTA features have been added to the following Zebra host software:

  • Core Scanner API The CoreScanner service/daemon provides the APIs required to configure and receive data from a device's RTA-capable firmware.
  • IoT Connector The IoT Connector ties together the RTA messages in addition to Statistic and Event data monitoring to provide a complete solution for the customer.
  • Unified POS, OPOS, JPOS APIs The Unified POS API (UPOS) provided with the Zebra Scanner SDK can be used to exchange RTA configuration data using XML files. Similarly, there are APIs for the OPOS standard as well as the JavaPOS (JPOS) standard.
  • Simple Serial Interface Some scanner devices support the Simple Serial Interface (SSI) that has the capability to carry Zebra's Remote Scanner Management (RSM) commands necessary to configure Real Time Alerts.
  • SNAPI Interface There is a USB-SNAPI protocol supported by Zebra devices that has the capability to carry the Remote Scanner Management (RSM) commands necessary to configure Real Time Alerts.

IoT (Internet of Things) Connector

The IoT Connector is a utility that will log scanner related events to an endpoint such as a command prompt or terminal window, and/or text file, HTTP instance or Windows Event log. The events that can be logged through the IoT Connector are defined in the file IoTConnector-Config.xml and their properties can be changed depending on need.

The IoT Connector accesses scanner devices through the Zebra CoreScanner Service for Windows or Linux which must first be installed and running.

The IoT Connector allows a 3rd party management console, like Microsoft's SCCM, to track scanner information including the scanner's health by parsing an IoT Connector generated log file.

The IoT Connector will output log entries to a sink (endpoint) as defined in its IoTConnector-Config.xml file.

The IoT Connector is configurable and can document RTA Events as they happen

The IoT Connector can have its output stored locally on its host PC or output to a network shared folder, HTTP instance or Windows Event log.


List of Supported Real Time Alerts

The following table shows all of the currently supported Real Time Alerts. The list of products that support these Alerts can be found in Chapter 3.

Table 1: List of Supported Real Time Alerts

Category RTA Name Attribute Type Reporting Value Range Description Reported Value(s)
Config Control Configuration Name Tracking 616 2 - Any Change n/a Track change of “Configuration Name” to “Modified” or “Factory Default” because of a programming barcode being scanned. Alert Instance Count
Scanner Idle Scanner Idle above threshold for x min 38001 7 - Above Threshold 5-600 min The scanner is idle because there have been no successful decode in x min Minutes without a decode
Gifted Battery Battery charge level below minimum percentage 30012 9 - Below Threshold 1%-100% Battery charge level has fallen below a set threshold value. Charge Level of Battery
Battery charge level above maximum percentage 30012 7 - Above Threshold 1%-100% Battery charge level has been charged above a set threshold value. Charge Level of Battery
Charging Scanner is off of charger/cradle for a measured time 38004 7 - Above Threshold 5-600 min The cordless scanner was removed from its charger/cradle for an extended period Minutes off charger
Virtual Tether Virtual tether alarm was signaled 38003 13 - Event Alarm n/a The scanner's Virtual Tether alarm has been activated. Alert Instance Count
Scale Scale Display Communication Error Flag 15251 14 - Event Fault n/a The scale display is enabled but the display is not connected or there is a communication fault with the display. Alert Instance Count
Scale Needs Calibration Flag 15241 13 - Event Alarm n/a The scale's current state is that it needs calibration. Alert Instance Count
Scale Communication Error Flag 15247 14 - Event Fault n/a Communication with the scale is lost such as when the scale power cable is disconnected or there is a communications fault. Alert Instance Count
Weight Guard Weight Guard Declined Scale Reading 38007 13 - Event Alarm n/a A scale read weight was tried and it was declined because of an unstable weight or it has an item(s) hanging over one or both edges of the scale. The state of the infrared sensors must not have "Red Calibration Health". Alert Instance Count
Weight Guard Communication Error Flag 38008 14 - Event Fault n/a A communications error occurred that meets the reporting requirements of Weight Warden. The state of the infrared sensors must not have "Red Calibration Health". Alert Instance Count, and Reporting Sensors
Weight Guard Infrared Red Health Status 38009 14 - Event Fault n/a An alert is sent if the Data Health of either IR sensor reaches the Red health level. Alert Instance Count, and Reporting Sensors
Weight Guard Infrared Orange Health Status 38010 13 - Event Alarm n/a An alert is sent if the Data Health of either IR sensor reaches the Orange health level. Alert Instance Count, and Reporting Sensors
Electronic Article Surveillance Sensormatic EAS Device Detach 38015 13 - Event Alarm n/a An alert is sent if a scanner EAS device is detached. Alert Instance Count


List of Supported Products

Table 2: List of Supported Products

Category RTA Name Attribute Type MP7200 MP7 SP7200 DS8108/DS8208 CR8178/CR8288 DS8178/DS8288
Config Control Config File Name Tracking 616 2 - Any Change X X X X X
Scanner Idle Scanner Idle above threshold for x min 38001 7 - Above Threshold X X X X
Gifted Battery Battery charge level below minimum percentage 30012 9 - Below Threshold X
Battery charge level above maximum percentage 30012 7 - Above Threshold X
Charging Scanner is off charger/cradle for a measured time 38004 7 - Above Threshold X
Virtual Tether Virtual tether alarm was signaled 38003 13 - Event Alarm X
Scale Scale Display Communication Error Flag 15251 14 - Event Fault X X
Scale Needs Calibration Flag 15241 13 - Event Alarm X X
Scale Communication Error Flag 15247 14 - Event Fault X X
Weight Guard Weight Guard Declined Scale Reading 38007 13 - Event Alarm X
Weight Guard Communication Error Flag 38008 14 - Event Fault X
Weight Guard Infrared Red Health Status 38009 14 - Event Fault X
Weight Guard Infrared Orange Health Status 38010 13 - Event Alarm X
Electronic Article Surveillance Sensormatic EAS Device Detach 38015 13 - Event Alarm X


List of Supported Host Interfaces

The Real Time Alerts feature is available for products that support the Zebra Remote Scanner Management (RSM) protocol. These RTA messages are encapsulated in the protocols of the following interfaces:

  • Simple Serial Interface (SSI)
  • SNAPI
  • IBM Retail (Handheld/TableTop)

For the Real Time Alerts feature to work, the scanner device must be configured to operate in one of the following Host Protocols:

  • USB SNAPI (with or without Imaging)
  • USB SSI over CDC
  • SSI (over RS232)
  • USB IBM Retail (Handheld or Tabletop)
  • USB OPOS

How Real Time Alerts Work

The RTA feature will remain disabled until one or more RTA Alerts are registered. This registration occurs when the host system sends a message to the device telling it to enable one or more alerts.

In its simplest form, a single scanning device is connected to a host interface. Software on the host device can send RTA configuration data and commands to register for events and to receive alerts.

Some scanning devices are connected to a host via a wireless connection to a cradle, or as an auxiliary wired scanner connected to a primary scanning device. In this case, the RTA commands and data are routed to and from the scanner from one device to the next until reaching the host. Each device in the chain is automatically assigned a “context address”, and this address conveys to the host the endpoint where the RTA commands and data originate. When a scanner connects to the chain of devices, RTA will not be enabled until it is given a “Context Address”.

Once a compliant scanning device has one or more alerts registered, and it is assigned a Context Address, then the Real Time Alerts feature goes online.

The following diagram shows the states of the Real Time Alerts feature in an individual scanner or cradle device.

Figure 1: Real TIme Alerts

The Host system can look up the current state of the Real Time Alert feature. Note that if a device does not immediately have a Context Address, it usually resolves itself in a minute. The following table shows the meaning of the RTA state value returned when requested by the host.

Table 3: RTA State Values

State Name Value Description
Wait For Register 1 There are presently no alerts registered by the User.
Wait for Context 2 The scanner has not yet been assigned a Context Address for reporting.
Online 3 The Real Time Alerts feature is fully operational.
Suspend 0 The Real Time Alerts were suspended automatically or by the RTA_Suspend command.

When Real Time Alerts is Online

When the Real Time Alerts feature is online, the events registered on the scanner start monitoring the device's activities. When a reportable event or data value is seen, then an RTA Event is sent to the host - the alert is “on”. While the alert is “on”, it is not reported again until the alert is turned “off”.

Each alert has preprogrammed criteria for when an alert is turned “off”. Some alerts have a configurable limit value that specifies when the alert is turned “off”. Depending on the type of alert, On-Limit and Off-Limit values are configurable with Corescanner REGISTER_RTA_EVENTS command (Refer to the RTA tab in the Scanner SDK Sample Application). For some alerts, both the On-Limit and Off-Limit value settings must be configured for the “Measuring” status to be set. Otherwise, the “Measuring” status is cleared at initialization.

The features of RTA depend on a continuous connection between the scanning device and the host. Should a disconnect be detected between the host and the scanning device, then all the alerts registered on the scanning device are cancelled. They need to be re-registered to resume operation.

One aspect of RTA operation is that it can send an event message at any time. These asynchronous messages may present a problem to host systems that are busy with a critical operation. An example is when the firmware is being updated on the scanning device. To help prevent any problems, the host may send a request for RTA to Suspend. In this state, RTA retains all of its settings, but the detection and reporting of RTA Events is temporarily stopped. The host can later cancel the RTA Suspend and the RTA feature resumes where it left off.


Full Descriptions of Real Time Alerts

Wireless Scanner Product Alerts

Gifted Battery Percentage Below Minimum (Attribute 30012/Type 9)

This alert monitors the current battery charge level on a wireless scanner. If it reaches or goes below the On-Limit value, then an alert is sent. Once the alert is on, if the scanner is charged to the Off-Limit value, then the alert is turned off. The system is then ready to monitor this alert again.

NOTES:

  • When this alert is sent, the first value reported is the current battery charging level.
  • The second reported data value is 0 for this alert.
  • The On-Limit must be lower than the Off-Limit. If not, the values are swapped.
  • The On-Limit and Off-Limit values have an accuracy of 1 percent and they must be within the range of 1 to 100.
  • Both the On-Limit and Off-Limit value settings must be configured for the “Measuring” status to be set. Otherwise, the “Measuring” status is cleared at initialization.
  • If either the On-Limit or Off-Limit is set greater than 100, it is automatically reset to 100.
  • If either the On-Limit or Off-Limit is set to zero, it is automatically reset to 1.
  • If the On-Limit and Off-Limit values are set equal, and the On-Limit is greater than 1, then the On-Limit is automatically decreased by 1.
  • If the On-Limit is greater than the Off-Limit, the two settings are swapped.

Gifted Battery Percentage Above Maximum (Attribute 30012/Type 7)

This alert monitors the current battery charge level on a wireless scanner. If it reaches or goes above the On-Limit value, then an alert is sent. Once the alert is on, if the battery discharges and reaches below the Off-Limit value, then the alert is turned off. The system is then ready to monitor this alert again.

NOTES:

  • When this alert is sent, the first reported value is the current battery charging level.
  • The second reported data value is 0 for this alert.
  • The On-Limit must be greater than the Off-Limit. If not, the values are automatically swapped.
  • The On-Limit and Off-Limits have an accuracy of 1 percent and they must be within the range of 1 to 100.
  • Both the On-Limit and Off-Limit value settings must be configured for the “Measuring” status to be set. Otherwise, the “Measuring” status is cleared at initialization.
  • When either the On-Limit or Off-Limit value specified is set greater than 100, it is automatically reset to 100.
  • When either the On-Limit or Off-Limit is set to zero, it is automatically reset to 1.
  • If the On-Limit and Off-Limit values are set equal, and the Off-Limit is less than 100, then the Off-Limit is automatically incremented by 1.
  • If the On-Limit is set less than the Off-Limit, the two settings are automatically swapped.

Wireless Cradle Product Alerts

RTA Scanner out of Cradle/ Value Above Maximum (Attribute 38004/Type 7)

This alert watches the wireless scanner's cradle insertion status. If the scanner is removed from the cradle more than the number of minutes specified on the On-Limit, then an alert is sent. Once the alert is on, if the scanner is inserted into the cradle, then the alert is turned off. The system is then ready to monitor this alert again.

NOTES:

  • When this alert is sent, the first data value reported is the number of minutes out of the cradle.
  • The second reported data value is 0 for this alert.
  • The On-Limit value has an accuracy of 1 minute and it must be within the range of 5 to 600 minutes.
  • When the On-Limit is set below 5, then it is automatically reset to 5.
  • When the On-Limit is set above 600, then it is automatically reset to 600.
  • The scanner must be in the cradle for the “Measuring” status to be set.
  • When the scanner is removed from the cradle, the “Measuring” status and the “Reported” status is cleared.
  • When the “Measuring” status is cleared, the alert's “Reporting” status is also cleared.
  • The “Measuring” status must be set for the alert to be monitored and reported.

RTA Virtual Tether Alert/ Event Alarm (Attribute 38003/Type 13)

This alert monitors the Virtual Tether feature status. If the feature is enabled on the cradle, and an out-of-range alarm was sounded, then an alert is sent. Once the alert is on, if the alert is cancelled or stopped, then the alert is turned off. The system is ready to monitor this alert again.

NOTES:

  • When this alert is sent, the current Alert Count is the first reported data value.
  • The second reported data value is 0 for this alert.
  • There are no settings for this alert. If any setting values are sent, they are ignored.
  • When an alert is sent, the temporary loss of host connection shall not cause the RTA settings to be cleared.

Flatbed Scanner Product Alerts

Stats Scale Display Comm Error Flag/ Event Fault (Attribute 15251/Type 14)

This alert monitors for a Display Communication Error statistic being reported. If there is a communication error reported, then an alert is sent. Once the alert is on, if the display communication error no longer exists then the alert is turned off. The system is ready to monitor this alert again.

NOTES:

  • When this alert is sent, the current Alert Count is the first reported data value.
  • The second reported data value is 0 for this alert.
  • There are no settings for this alert. If any setting values are sent, they are ignored.
  • Both the Scale Display Configuration (#986) and Scale Enable (#1197) parameters must be enabled for the “Measuring” status to be set. Otherwise, the “Measuring” status is cleared.
  • When the “Measuring” status is cleared, the alert's “Reporting” status is also cleared.
  • The “Measuring” status must be set for the Alert to be monitored and reported.

Stats Scale Needs to be Calibrated Flag/ Event Alarm (Attribute 15241/Type 13)

This alert monitors for the Scale Calibration statistic to be reported as False. If there is a need for calibration, an alert is sent. When the calibration process is completed, the scanner is restarted. This will cause the RTA component to restart. So, following Calibration of the scale, all alerts are unregistered.

NOTES:

  • When this alert is sent, the current Alert Count is reported. This count will reset to 0 when Calibration is performed.
  • The supplementary data is 0 for this alert
  • There are no settings for this alert. If any setting value is sent, they are ignored.

RTA Weight Guard Declined Scale Request/ Event Alarm (Attribute 38007/Type 13)

This alert monitors for when a Read Weight request is made and is declined because the Weight Guard software detected a Beam Break. When this occurs, an alert is sent. Once the alert is on, if a non-zero Read Weight request is successfully made, then the alert is turned off. The system is ready to monitor this alert again.

NOTES:

  • When this alert is sent, the current Alert Count is the first reported data value.
  • The second reported data value is 0 for this alert.
  • There are no settings for this alert. If any setting values are sent, they are ignored.
  • Both the Weight Guard Enable (#2427) and Scale Enable (#1197) parameters must be enabled for the “Measuring” status to be set. Otherwise, the “Measuring” status is cleared.
  • When the “Measuring” status is cleared, the alert's “Reporting” status is also cleared.
  • The “Measuring” status must be set for the Alert to be monitored and reported.

RTA Weight Guard IR Sensor Red Health/ Event Fault (Attribute 38009/Type 14)

This alert monitors the Weight Guard subsystem to report a Red health level over UIF (Red LED) and also checks if one or both IR sensors report the Red health status. If this occurs, an alert is sent. Once the alert is on, if the Red LED UIF indication is cancelled, and both IR sensors no longer have the Red Health status, then the alert is turned off. The system is then ready to monitor this alert again.

NOTES:

  • When this alert is sent, the current Alert Count is the first reported data value.
  • The second reported data value is the current states of the A and B IR sensors: 1 = Sensor A is Red, 2 = Sensor B is Red, 3 = Both Sensors are Red.
  • There are no settings for this alert. If any setting values are sent, they are ignored.
  • Both the Weight Guard Enable (#2427) and Scale Enable (#1197) parameters must be enabled for the “Measuring” status to be set. Otherwise, the “Measuring” status is cleared.
  • When the “Measuring” status is cleared, the alert's “Reporting” status is also cleared.
  • The “Measuring” status must be set for the Alert to be monitored and reported.

RTA Weight Guard IR Sensor Orange Health/ Event Alarm (Attribute 38010/Type13)

This alert monitors if the Weight Guard subsystem reports a message that one or both of the IR sensors have the Orange health status. When this occurs, an alert is sent. Once the alert is on, if both IR sensors no longer have the Orange Health status, then the alert is turned off. The system is then ready to monitor this alert again.

NOTES:

  • When this alert is sent, the current Alert Count is the first reported data value.
  • The second reported data value is the current states of the A and B IR sensors: 1 = Sensor A is Orange, 2 = Sensor B is Orange, 3 - Both Sensors are Orange.
  • There are no settings for this alert. If any setting values are sent, they are ignored.
  • Both the Weight Guard Enable (#2427) and Scale Enable (#1197) parameters must be enabled for the “Measuring” status to be set. Otherwise, the “Measuring” status is cleared.
  • When the “Measuring” status is cleared, the alert's “Reporting” status is also cleared.
  • The “Measuring” status must be set for the Alert to be monitored and reported.

RTA Weight Guard Communication Error Flag/ Event Fault (Attribute 38008/Type14)

This alert monitors if the Weight Guard subsystem reports a communication error. When this occurs, n alert is sent. Once the alert is on, if Weight Guard reports no communication error, then the alert is turned off. The system is then ready to monitor this alert again.

NOTES:

  • When this alert is sent, the current Alert Count is the first reported data value.
  • The second reported data value is 0 for this alert.
  • There are no settings for this alert. If any setting values are sent, they are ignored.
  • Both the Weight Guard Enable (#2427) and Scale Enable (#1197) parameters must be enabled for the “Measuring” status to be set. Otherwise, the “Measuring” status is cleared.
  • When the “Measuring” status is cleared, the alert's “Reporting” status is also cleared.
  • The “Measuring” status must be set for the Alert to be monitored and reported.

Stats Scale Communication Error Flag/ Event Fault (Attribute 15247/Type 14)

This alert monitors the scale's UART driver for a communication error. When this occurs, an alert is sent. Once the alert is on, if the communication rrror is cleared, the alert is turned off. The system is rhen ready to monitor this alert again.

Notes:

  • When this alert is sent, the current Alert Count is the first reported data value.
  • The second reported data value is 0 for this alert.
  • There are no settings for this alert. If any setting values are sent, they are ignored.
  • The Scale Enable (#1197) parameter must be enabled for the “Measuring” status to be set. Otherwise, the “Measuring” status is cleared.
  • When the “Measuring” status is cleared, the alert's “Reporting” status is also cleared.
  • The “Measuring” status must be set for the Alert to be monitored and reported.

RTA Sensormatic EAS Detach/ Event Alarm (Attribute 38015/Type 13)

This alert monitors communication with the Sensormatic external device. When in the Measuring state, the alert code will monitor the current status of the external Sensormatic device. If the Sensormatic device is found to be unresponsive or unattached, an alert is sent. Once the alert is on, if the Sensormatic external device is communicating, the alert is turned off. The system is then ready to monitor this alert again.

Notes:

  • When this alert is sent, the current Alert Count is the first reported data value.
  • The second reported data value is 0 for this alert.
  • There are no settings for this alert. If any setting values are sent, they are ignored.
  • This alert enters the measuring state when a Sensormatic EAS operating mode (Parameter #977) is enabled:
    • Sensormatic Auto Mode (0)
    • Sensormatic Always Enable Deactivation Mode (1)
    • Sensormatic Barcode Interlock Mode (2)
    • Sensormatic Barcode Auto Interlock Mode (3)
    • Sensormatic Self Service Mode (4)
    • Sensormatic Scan Enable Interlock Mode (5)
  • If any other EAS Operating mode is selected, the “Measuring” status and the “Reported” status are cleared.
  • An alert is raised when there is a communication error with the external Sensormatic device.
  • An alert is raised when there is no response to a “Check Connection”.
  • This alert ends when a command is processed by the external EAS device.
  • This alert ends when a message is received from the external EAS device.

All Product (including Corded Scanner) Alerts

RTA Scanner Idle/ Value Above Maximum (Attribute 38001/Type 7)

This alert monitors the timing between successful decodes. If the scanner (the attached wireless scanner) does not have a successful decode in a time interval more than the number of minutes specified on the On-Limit, an alert is sent. Once the alert is on, if the scanner successfully decodes a barcode, the alert is turned off. The system is then ready to monitor this alert again.

Notes:

  • When this alert is sent, the first reported data value s the number of minutes since the last successful decode.
  • The second reported data value is 0 for this alert.
  • The On-Limit has an accuracy of 1 minute and must be within the range of 5 to 600 minutes.
  • If the On-Limit is set below 5, it is automatically reset to 5.
  • If the On-Limit is set above 600, it is automatically reset to 600.

Configuration Name/ Event Alarm (Attribute 616/Type 13)

This alert monitors the value of the scanner device's last loaded Configuration Name. If the Configuration Name (#616) is changed to “Modified” or “Factory Defaults”, an alert is sent. Once the alert is on, if the Configuration Name is updated to a string other than “Modified” or “Factory Defaults”, the alert is turned off. The system is then ready to monitor this alert again.

Notes:

  • When this alert is sent, the first reported data value is the current AlertCount.
  • The second reported data value is 0 for this alert.
  • There are no settings for this alert. If any setting values are sent, they are ignored.

CoreScanner API

The CoreScanner API is used to both configure the Real Time Alerts feature in the scanner or cradle device, and also used to receive notifications when an RTA Event is sent by the scanner.

Register for Events

To receive ScannerNotificationEvents, an application needs to execute the REGISTER_FOR_EVENTS method with the SUBSCRIBE_OTHER event type. When an RTA event is sent by the device, a Notification Event Type of 2000 is sent by the CoreScanner API.

Table 4: Notification Event Types

Event Type Value Description
DECODE_MODE 1 Triggered when a scanner changes its operation mode to decode.
SNAPSHOT_MODE 2 Triggered when a scanner changes its operation mode to image mode.
VIDEO_MODE 3 Triggered when a scanner changes its operation mode to video mode.
DEVICE_ENABLED 13 Triggered when the scanner is enabled.
DEVICE_DISABLED 14 Triggered when the scanner is disabled.
RTA_EVENT 2000 Triggered when RTA event is received.

The RTA_EVENT message contains the following information:


<?xml version="1.0" encoding="UTF-8"?>
<outArgs>
    <scannerID>2</scannerID>
    <arg-xml>
        <modelnumber>DS8178-SR0F007ZZWW</modelnumber>
        <serialnumber>99887766556655  </serialnumber>
        <GUID></GUID>
        <rta>
            <id>30012</id>
            <type>12</type>
            <data-1>99</data-1>
            <data-2>0</data-2>
            <raw-data>0x75 0x3C 0x00 0x0C 0x00 0x63 0x00 0x00 0x00 0x00 </raw-data>
        </rta>
    </arg-xml>
</outArgs>

  1. The <scannerID> tag is the Corescanner-assigned ID number of the scanner device that originated the RTA event.
  2. The <modelnumber> and <serialnumber> tags indicate the asset info of the device that originated the RTA event.
  3. Under the <rta> tag:
    1. The <id> tag represents the RTA event attribute ID (see the “Attribute” column in Chapter 2 of this document).
    2. The <type> tag represents the Stat type of the event. (see the “Type” column in Chapter 2 of this document).
    3. The <data-1> and <data-2> tags show the RTA event data received with the RTA event raised from the scanner.
    4. The <raw-data> tag includes the following data structure.
      Byte Description
      1 - 2 RTA event attribute
      3 - 4 RTA Stat type
      5 - 6 RTA event data 1
      7 - 8 RTA event data 2 (optional)
      9 - 10 Future use

For more information, please refer to Scanner Notification Events

Using the Methods to configure RTA (Examples)

  1. GET SUPPORTED RTA EVENTS (OPCODE - 5500): Gets supported RTA events of the device.
  2. REGISTER_RTA_EVENTS (OPCODE - 5501): Register for selected RTA events. RTA event ID and Stat with on limit and off limit as "Not set" should be entered with values acceptable for each event.
  3. UNREGISTER_RTA_EVENTS (OPCODE - 5502): Unregister for selected RTA events using RTA event ID and type.
  4. GET_RTA_ALERT_STATUS (OPCODE - 5503): Retrieve the RTA event's alert status. This contains information about individual status events (i.e. whether registered, reported, measured, initialized etc.)
    • Registered: Whether the event is registered or not.
    • Reported: An alert has reported associated to the event.
    • Measuring: Device has started measuring of the event.
    • Initialized: Device has initialized the event.
  5. SET_RTA_ALERT_STATUS (OPCODE - 5504): Set RTA event's reported state.
    NOTE: <reported> can only be set from true (1) to false (0). If set otherwise, it will be automatically overwritten by 0.
  6. RTA_SUSPEND (OPCODE - 5505): Toggle RTA alert notification reporting to the host.
  7. RTA_STATE (OPCODE - 5506): Retrieve the current operational state of RTAs. State will have 4 values as follows.
    • State 0: RTA Suspended.
    • State 1: RTA Awaiting Registration.
    • State 2: RTA Awaiting Context Address.
    • State 3: RTA Fully Operational.

For more information, please refer to Using the Methods - RTA Events

OPOS Standard API

The OPOS driver uses Direct IO commands to configure the Real Time Alerts feature in the scanner or cradle device, and it uses Direct IO events to receive notifications when an RTA event is sent by the scanner.

For more information, please refer to DirectIO for OPOS

JPOS Standard API

The JPOS driver uses DirectIO commands to configure the Real Time Alerts feature in the scanner or cradle device, and it uses DirectIO events to receive notifications when an RTA event is sent by the scanner.

For more information, please refer to DirectIO for JPOS