Elyctis

91 rue Benjamin Franklin

84120 Pertuis – FRANCE
support@elyctis.com

Scanner Command Set

Version 1.7
September 14, 2020

IDBOX One – Scanner Command Set – v1.7 Page 1

Inquire command
The Inquire command returns the MRZ information decoded by the scanner.

Inquire command:
0x49 | 0x00 | 0x00
Inquire response:
0x49 | L1 | L2 | MRZ data
L1 is the MSB and L2 is the LSB of the MRZ data length
MRZ data contains ASCII characters

Inquire 1 Line command

The Inquire 1 Line command returns the MRZ information decoded from the 1 Line MRZ area.

Inquire 1 Line command:

0x4C | 0x00 | 0x00
Inquire response:
0x4C | L1 | L2 | MRZ data
L1 is the MSB and L2 is the LSB of the MRZ data length
MRZ data contains ASCII characters

IDBOX One – Scanner Command Set – v1.7 Page 2

Active Continuous Reading command
The Active Continuous Reading command enable or disable the Continuous Reading mode. In
this mode the scanner automatically-detects a new document and send the decoded MRZ data.
Note: After a successful reading this mode is automatically deactivated, so a new command need
to be send to re-activate it. If the current document remains in the slot, it will not be read
twice. To process again the inserted document, a reset of the Continuous Read mode is required.

Active Continuous Read command:

0x43 | 0x00 | 0x01 | State
Active Continuous Read response:
0x43 | 0x00 | 0x01 | State
State is set to 0x01 to activate the reading and set to 0x00 to deactivate it

Active Presence Detection command

The Active Presence Detection command enable or disable the Presence Detection mode. In
this mode the scanner detects the document insertion and removal, and provides current
availability of the cards through Card State messages.
Note: After the document removal this mode is automatically deactivated, so a new command
need to be send to re-activate it.
Note: Continuous Reading mode and Presence Detection mode are exclusive, only one mode is
activated at a time.

Active Presence Detection command:

0x50 | 0x00 | 0x01 | State
Active Presence Detection response:
0x50 | 0x00 | 0x01 | State
State is set to 0x01 to activate the reading and set to 0x00 to deactivate it

Card State message:

0x50 | 0x00 | 0x01 | CardState
CardState can take two values STATE_PRESENT(0x20) or STATE_EMPTY(0x10)

IDBOX One – Scanner Command Set – v1.7 Page 3

Get Version Command
The Get Version command returns the firmware version number.

Get Version command:

0x56 | 0x00 | 0x00
Get Version response:
0x56 | 0x00 | Le | Version
Le is the string length of the firmware version
Version contains the firmware version

Get OCR Version Command

The Get OCR Version command returns the OCR version number.

Get OCR Version command:

0x57 | 0x00 | 0x00
Get OCR Version response:
0x57 | 0x00 | Le | Version
Le is the string length of the OCR version
Version contains the OCR version

IDBOX One – Scanner Command Set – v1.7 Page 4

Get Product Information Command
The Get Product Info command returns the product information.

Get Product Information command:

0x54 | 0x00 | 0x00
Get Product Information response:
0x54 | 0x00 | 0x05 | Product Info
Product Info contains the product information (5 bytes long)

Get Serial Number Command

The Get Serial Number command returns the device serial number.

Get Serial Number command:

0x52 | 0x00 | 0x00
Get Serial Number response:
0x52 | 0x00 | 0x08 | SN
SN contains the device serial number (8 bytes long)

Read/Write User Information Command

The Read/write User Information command allows to read and write user information in the
device EEPROM memory,

Read User Information command:

0x55 | 0x00 | 0x00
Write User Information command:
0x55 | 0x00 | 0x08 | Info
Info contains the information to write (8 bytes long)
Read/Write User Information response:
0x55 | 0x00 | 0x08 | Info
Info contains the user information (8 bytes long)

IDBOX One – Scanner Command Set – v1.7 Page 5

Annexure A

Set Communication Mode Command

By default the MRZ Scanner emulates a serial port through the USB-CDC interface. The Set
Communication Mode command allows to switch the communication mode to UART or HID
interface or back to CDC interface again.
Note: After sending the command, a reset of the device is required to switch the
communication mode.
Set Communication Mode command for switching to UART interface:

Important note before using this command:

 Changing the communication mode to UART requires a specific cable to

communicate further with the device.

 The command can be used only on ID BOX One 011 & 211

 Never use the command on any other ID BOX One, since it cannot be reverted.

 Please refer to the ID BOX One 011 Integration Manual for more detailed
information about the pin-out and the signal levels of the UART TTL connector in
the PCB.

0x4D | 0x00 | 0x04 | Mode | Protocol | AutoRST | CTRL

Mode is set to 0x00 by default,
0x00 to activate USB-CDC
0x01 to activate UART interface at 9600bps
0x03 to activate UART interface at 115200bps
Protocol is set to 0x00 by default,
0x00 to use default framing,
0x01 to use <STX>DATA<CR><LF><ETX> framing and
0x02 to remove <CR> separator in the MRZ
0x08 to add <CR> in the MRZ trailer
AutoRST is set to 0x81 to activate the Continuous Reading mode permanently
CTRL is set to 0x00 by default,
0x00 to disable MRZ control and
0x01 to remove MRZ consistency filter

IDBOX One – Scanner Command Set – v1.7 Page 6

 Here are the command examples for reference:

 To set the communication mode to UART-9600

0x4D | 0x00 | 0x04 | 0x01 | 0x00 | 0x00 | 0x00

 To set the communication mode to USB-115200

0x4D | 0x00 | 0x04 | 0x03 | 0x00 | 0x00 | 0x00

Set Communication Mode command for switching to CDC interface:

0x4D | 0x00 | 0x04 | 0x00 | 0x00 | 0x00 | 0x00

Set Communication Mode command for switching to HID interface:

0x4D | 0x00 | 0x05 | Mode | 0x00 | SubMode | 0x00 | Layout
Mode is set to 0x10 to activate HID interface
SubMode is set to 0x10 to activate Keyboard wedge
Layout is set to
0x00 for FRENCH keyboard (default)
0x01 for ENGLISH keyboard

Note: Layout parameter has to match the system level keyboard configuration of the
host OS, in order to emulate proper key-codes. i.e,

 If the host OS is configured for FRENCH keyboard, the Layout parameter has to
be set as 0x00. The command to be used is:
0x4D | 0x00 | 0x05 | 0x10 | 0x00 | 0x10 | 0x00 | 0x00

 If the host OS is configured for ENGLISH keyboard, the Layout parameter has
to be set as 0x01. The command to be used is:
0x4D | 0x00 | 0x05 | 0x10 | 0x00 | 0x10 | 0x00 | 0x01

Set Communication Mode response:

0x4D | 0x00 | 0x00

IDBOX One – Scanner Command Set – v1.7 Page 7