For the complete documentation index, see llms.txt. This page is also available as Markdown.

Read Barcode (BCR Only)

Command 0x1804 - Read Barcode (BCR Only)

The host uses this command to direct the device to arm or disarm the barcode reader for reading a barcode outside the scope of a transaction. This is an immediate directive. To read barcodes within the scope of a transaction, use Command 0x1001 - Start Transaction and its barcode reader parameters instead.

The sequence of events is as follows:

1

The host ensures the device is not currently running another command, for example, that it is not running a transaction using Command 0x1001 - Start Transaction.

2

The host composes a command request in the format below and sends it to the device.

3

If the device has a display, it shows a prompt SCAN BARCODE.

4

The device enables the barcode reader.

If the Timeout parameter is set to Infinite:

  • The device returns a command response message with Response Status, Operation Status Summary byte set to 0x00 (OK, Done) after which the host is free to send further commands.

  • The host may end the barcode reading session by calling this command again with the Enable parameter set to Disable.

If the Timeout parameter is set to a value other than Infinite:

  • The device returns a command response message with its Response Status, Operation Status Summary byte set to 0x01 (OK, Started / Running).

  • While the host is waiting for the timeout to expire, it should not send any commands to the device, because the device is busy processing the current command.

  • After the device reads a barcode or the timeout period expires, the device sends Notification 0x1805 - User Interface Operation Complete to report Barcode Reader / Read Barcode Result and additional supporting information.

Table - Request Data for Command 0x1804 - Read Barcode (BCR Only)

Tag
Len
Value / Description
Typ
Req
Default

Beginning of any wrappers, at minimum including Request Message

1804 = Command 0x1804 - Read Barcode (BCR Only)

81

01

Enable - 0x00 = Disable. The device disables the barcode reader. In this case, the device ignores all other parameters. - 0x01 = Enable. The device enables the barcode reader.

B

R

0x00

82

01

Timeout - 0x00 = Infinite. The device leaves the barcode reader enabled until it reads a barcode, or until the host sends this command again to disable the barcode reader. - All other values = Timeout in seconds for the device to leave the barcode reader enabled without reading a barcode.

B

O

0x00

83

01

Encrypt Barcode Data - 0x00 = Do Not Encrypt. The device does not encrypt the barcode data when it sends Notification 0x1805 - User Interface Operation Complete. - 0x01 = Encrypt. The device encrypts the barcode data when it sends Notification 0x1805 - User Interface Operation Complete.

B

O

0x00

End of any wrappers, at minimum including Request Message

Table - Response Data for Command 0x1804 - Read Barcode (BCR Only)

Tag
Len
Value / Description
Typ
Req
Default

Beginning of any wrappers, at minimum including Response Message

1804 = Command 0x1804 - Read Barcode (BCR Only)

No parameters.

End of any wrappers, at minimum including Response Message

Table - Request Example

Table - Response Example

Last updated