Barcode Read Event

DIRECTION

Unidirectional, to RaPTr Server

INPUTS

Parameter	Definition	Example
Barcode	Barcode scanned on the pallet. Generally, this is located on the pallet tag.	ABC123
Location ID	Unique identifier for a RaPTr Scanner in a warehouse.	1
Camera ID	Unique identifier for a camera within a RaPTr Scanner.	1

OUTPUTS

Parameter	Definition	Example
Response Code	Determines if the pallet was read at the correct location.	1 = Good. 0 = Bad. 1
Response Color	Color that will highlight the message to the material handler. Most commonly red or green.	#00FF00 (Green)
Response String	Message to the material handler that corresponds to the pallet scan.	GOOD. PALLET 1/1
Audible Key	Key that defines which audible will be played. Corresponds with the Sound ID field on the RaPTr Scanner configuration.	Good
Dwell Time	How long the message should persist on the screen in milliseconds	10000

SUPPORTED OPERATIONAL INTERFACES

All

See REST API - BarcodeReadEvent (required), SAP Gateway API - BarcodeReadEvent (required)

DESCRIPTION

When RaPTr Scanner detects a barcode in an image, its contents are checked against a running list of barcodes that are maintained by the scanner. If the barcode already exists in the list, then the scanner takes no action. If the barcode does not exist, then the scanner adds the barcode to the list and triggers a Barcode Read Event, sending a message to RaPTr Server. To be removed from the list, the scanner must not detect the barcode in any image for the duration of the Block Barcode Window (see RaPTr Scanner User Guide for more details about Block Barcode Window).

The Barcode Read Event message contains the string encoded in the barcode, a Location ID of the scanner, and the camera ID of the scanner’s camera from which the image was captured. When RaPTr Server receives the Barcode Read Event message, it will use the selected operational interface to retrieve a response code, response color, and response string. The response code tells the scanner if the pallet is good or bad, allowing the scanner to play an audible sound if configured. The response color and response string combine to create a message to the material handler. The message can be as simple as, “Good”, “Bad”, “Wrong Truck”, or offer more elaborate instructions. These response strings and colors are completely customizable to the customer’s business case. The audible key corresponds to an audible file on the scanner (“Good” for good audible, “Bad” for bad audible, and customizable from there for additional sounds and alerts).