Datalogic Matrix N, Matrix 410N, Matrix 450N, Matrix 300N, Matrix 210N Series Manual
Datalogic S.r.l.
Via S. Vitalino 13
40012 Calderara di Reno
Italy
Matrix N Family Host Mode Programming
Ed.: 10/2017
This manual refers to software release1.5.0 or later.
© 2015 - 2017 Datalogic S.p.A. and/or its affiliates ALL RIGHTS RESERVED. Without limiting the
rights under copyright, no part of this documentation may be reproduced, stored in or introduced into a
retrieval system, or transmitted in any form or by any means, or for any purpose, without the express
written permission of Datalogic S.p.A. and/or its affiliates.
Datalogic and the Datalogic logo are registered trademarks of Datalogic S.p.A. in many countries,
including the U.S.A. and the E.U.
DL.CODE is a trademark of Datalogic S.p.A. and/or its affiliates. All other trademarks and brands are
property of their respective owners.
Datalogic shall not be liable for technical or editorial errors or omissions contained herein, nor for
incidental or consequential damages resulting from the use of this material.
16/10/17
iii
CONTENTS
Conventions ................................................................................................................. iv
1 HOST MODE PROGRAMMING ................................................................................... 1
1.1 Collecting HMP StRings from DL.CODE ...................................................................... 2
2 PROGRAMMING COMMANDS ................................................................................... 4
2.1 Connection To Device .................................................................................................. 4
3 PROGRAMMING STRINGS ......................................................................................... 5
3.1 Definitions ..................................................................................................................... 5
3.2 Programming Strings .................................................................................................... 7
3.2.1 Set Parameter Value in Current Configuration ............................................................. 7
3.2.2 Get Parameter Value in Current Configuration ............................................................. 7
3.2.3 Get Configurations List (Jobs) ...................................................................................... 8
3.2.4 Save Current Configuration (Job) ................................................................................. 8
3.2.5 Set Startup Configuration (Job) .................................................................................... 9
3.2.6 Change Current Configuration (Job) ............................................................................. 9
3.2.7 Match Code Content ................................................................................................... 10
3.2.8 Send Configuration (Upload Job) to Device ............................................................... 10
3.2.9 Get Device Information ............................................................................................... 12
3.2.10 Send Images ............................................................................................................... 12
3.2.11 Get Command Status ................................................................................................. 15
3.2.12 Set Focusing Pointer .................................................................................................. 17
3.2.13 Read Input .................................................................................................................. 18
3.2.14 Read Output ............................................................................................................... 18
3.2.15 Run X-PRESS Function .............................................................................................. 19
3.3 Examples .................................................................................................................... 21
4 MATRIX N FAMILY PARAMETERS LIST ................................................................. 23
4.1 Image Setup ............................................................................................................... 23
4.2 Code Setup ................................................................................................................. 24
4.2.1 2D Codes .................................................................................................................... 24
4.2.2 1D Codes .................................................................................................................... 28
4.2.3 Postal Codes .............................................................................................................. 36
4.2.4 Outputs ....................................................................................................................... 38
4.2.5 LEDs ........................................................................................................................... 38
A ASCII TABLE ............................................................................................................. 39
iv
CONVENTIONS
The notation in this manual uses angular brackets (< >), to represent single byte character
values which are equivalent. See ASCII Table in appendix A. For special keys or some non-
printable characters, the ASCII symbol for the character name is shown between angular
brackets.
Example:
<ESC> means the ESC key character byte
<STX> means the start transmission character byte
<space> means the whitespace character
For non-printable characters, the decimal value of the character byte is shown
between angular brackets.
Example:
<13><10> = Carriage Return character byte, Line Feed character byte
The following representations using these three methods are equivalent:
<ESC> = <27> = <1BH>
and each send character byte 0x1B to the reader
The program used to generate the strings for Host Mode Programming must be able to
manage them correctly.
HOST MODE PROGRAMMING
1
1
1 HOST MODE PROGRAMMING
Host Mode programming allows you to perform a partial configuration of your reading device
as an alternative method to configuration using DL.CODE™. It consists of substituting or
modifying the Matrix N Family device configurations by sending command strings over one of
the communication channels.
Probably the most useful command is to change configuration jobs from among those saved
in the device memory, directly from the Host.
These strings take the form of command sequences that are specific to each saved
configuration. They can be personalized to make command recognition easier. They are
transmitted from the Host system to the Matrix reader on the following interfaces:
On-board Ethernet TCP/IP interface
Main RS232/RS422 serial interface
Auxiliary RS232 serial interface
In order to send the programming strings, it is necessary to switch the reader into Host
Mode.
CAUTION: DL.CODE must be disconnected from all reader interfaces
before entering in Host Mode.
By entering in Host Mode, any DL.CODE Monitor or X-PRESS connections
to the reader will be closed.
Ethernet Interface
The programming commands and strings can be sent to the reader using the on-board
Ethernet TCP/IP interface. Connect to the device IP address, port number: 1023 (predefined).
Serial Interfaces
The programming commands and strings can be sent to the reader at the programmed baud
rate of the selected serial interface (e.g. if the baud rate of the Auxiliary interface is
programmed at 115200 bps the command must be sent at 115200 bps).
MATRIX N FAMILY HOST MODE PROGRAMMING
2
1
1.1 COLLECTING HMP STRINGS FROM DL.CODE
The first thing to do is collect the application specific Programming Strings from the
DL.CODE Configuration. Select View Configuration HMP Shortcuts from the
Device>Settings menu.
HOST MODE PROGRAMMING
3
1
This opens the Escape Sequences window.
You can view the full extension of configuration parameters by dragging the vertical slider on
the right side of the window. Otherwise by clicking on the Parameters triangle you can open
the tree to select any individual branch and view only the branch specific parameters.
Each configurable parameter is shown with its programming string name and a list of its
configuration parameter values including the default setting.
You can personalize the programming strings from any view in this window by clicking on the
string name and entering a new name (no spaces are allowed). Then click the Save button.
Click the Print button to produce an HMP reference sheet.
MATRIX N FAMILY HOST MODE PROGRAMMING
4
2
2 PROGRAMMING COMMANDS
2.1 CONNECTION TO DEVICE
DESCRIPTION
HOST COMMAND
REPLY MESSAGE
1
Enter Host Mode
<ESC> [ C
<ESC> H <CR><LF>
After entering this command, the device responds with the first reply message and
then waits for the following command.
2
Enter Programming Mode
<ESC> [ B
<ESC> S <CR><LF>
After entering this command, the device responds with the second reply message.
Now you can send one or more programming strings as shown in Chapter 3.
3
Exit Host Mode
<ESC> [ A
<ESC> [ X
This command must always be transmitted to end the programming session.
The configuration job management depends on the commands issued prior to exit
from Host Mode. See 3.2 for more details.
If the SAVE command was issued before exit from Host Mode, the job is saved
in permanent memory (Flash).
If the SAVE command was not issued before exit from Host Mode, the job is
saved in temporary memory (RAM).
PROGRAMMING STRINGS
5
3
3 PROGRAMMING STRINGS
3.1 DEFINITIONS
Common definitions for each parameter are:
Name (parameter name)
Name of the parameter available in the DL.CODE Configuration Parameters panel.
The other definitions change according to the parameter type.
Type (parameter type)
Parameter type is essential in order to decide the features of the command used to set its
new value. Types are:
Type 0:
Integer (numeric)
Type 1:
Enumerative (numeric list)
Type 2:
BOOLEAN (true, false)
Type 3
String (printable characters)
Integer (Type = 0)
Range
Minimum and maximum values allowed for the parameter.
Default
Default value (integer).
Example: Exposure Time (s) parameter
Name:
Exposure Time (s)
Type:
0
Range:
6 to 500 (depending on model)
Default:
270 (depending on model)
Enumerative (Type = 1)
Item List
List of the values allowed for the parameter.
Default
Default entry (i.e. 0 = first entry of the list, 1 = second entry of the list, etc.).
Example: Gain Multiplier parameter.
Name:
Gain Multiplier
Type:
1
Item List
X1, X2, X3, X4, X5, X6, X7, X8, X9, X10
Default:
0 (Entry 0 = X1)
MATRIX N FAMILY HOST MODE PROGRAMMING
6
3
BOOLEAN (Type = 2)
Value
true = Enabled; false = Disabled
Default
Default value (String).
Example: Identical Codes parameter.
Name:
Identical Codes
Type:
2
Value:
false, true (case sensitive)
Default:
false (Disabled)
String (Type = 3)
Length
Minimum to maximum number of characters allowed for this parameter.
Default
Default value (String).
Example: Wildcard parameter.
Name:
Wildcard
Type:
3
Length
Min to Max number of allowable characters in string
Value:
Any character from 00 to FF (hex)
Default:
*
PROGRAMMING STRINGS
7
3
3.2 PROGRAMMING STRINGS
3.2.1 Set Parameter Value in Current Configuration
The Matrix device single parameter programming string must have the following format:
SET<space>PSTR<space>VAL <LF>
where:
SET:
The programming command (all caps)
PSTR:
The unique parameter string containing no spaces
VAL:
Character or string indicating the assigned parameter value. (case sensitive)
If the command is correct, the device immediately implements the new value and confirms
with the following message:
ACK <LF>
If programming contents are wrong (i.e. a typing error in the file) or due to a transmission
error, the device replies with the following message and programming data will not be
updated in this case:
NACK <LF>
After transmitting the reply message, the device then waits for another programming string or
the exit from host mode programming command.
3.2.2 Get Parameter Value in Current Configuration
The Matrix device single parameter get string must have the following format:
GET<space>PSTR <LF>
where:
GET:
The programming command (all caps)
PSTR:
The unique parameter string containing no spaces
If the command is correct, the device replies with the value string for the current parameter:
ACK VAL <LF>
If the sequence is wrong (i.e. a typing error) or due to a transmission error, the device replies
with the following message:
NACK <LF>
After transmitting the reply message, the device then waits for another programming string or
the exit from host mode programming command.
MATRIX N FAMILY HOST MODE PROGRAMMING
8
3
3.2.3 Get Configurations List (Jobs)
The Matrix get configurations list command must have the following format:
GET_JOBS_LIST <LF>
If the command is correct, the device confirms with the following message:
ACK <LF>
Default <LF> <CR>
…. <LF> <CR>
If the command is wrong (i.e. a typing error) or due to a transmission error, the device replies
with the following message:
NACK <LF>
After transmitting the reply message, the device then waits for another programming string or
the exit from host mode programming command.
3.2.4 Save Current Configuration (Job)
The Matrix configuration saving command must have the following format:
SAVE<space>configuration_name <LF>
After making changes to a configuration, this command should always be transmitted before
exit from programming mode.
If the command is correct, the device confirms with the following message:
ACK <LF>
If the command is wrong (i.e. missing configuration_name) or due to a transmission error, the
device replies with the following message:
NACK <LF>
After transmitting the reply message, the device then waits for another programming string or
the exit from host mode programming command.
NOTE: To overwrite the current configuration, the configuration name must
exactly match the name saved on the device. Names can contain spaces and
are case sensitive!
If the name does not match, then a copy of the configuration will be saved
with the new name.
The Default configuration cannot be overwritten.
PROGRAMMING STRINGS
9
3
3.2.5 Set Startup Configuration (Job)
The Matrix startup configuration setting command must have the following format:
STARTUP_CFG<space>configuration_name <LF>
If the command is correct, the device confirms with the following message:
ACK <LF>
If the command is wrong (i.e. a typing error) or due to a transmission error, the device replies
with the following message:
NACK <LF>
After transmitting the reply message, the device then waits for another programming string or
the exit from host mode programming command.
NOTE: The configuration names must match those saved on the device.
They can contain spaces and are case sensitive.
This command does not change the current configuration. It also does not
require the SAVE command to be issued.
3.2.6 Change Current Configuration (Job)
The Matrix change configuration command must have the following format:
CHANGE_CFG<space>configuration_name <LF>
If the sequence is correct, the device confirms with the following message:
ACK <LF>
If programming contents are wrong (i.e. a typing error) or due to a transmission error, the
device replies with the following message:
NACK <LF>
After transmitting the reply message, the device then waits for another programming string or
the exit from host mode programming command.
NOTE: The configuration names must match those saved on the device.
They can contain spaces and are case sensitive.
This command does not change the Startup Configuration.
MATRIX N FAMILY HOST MODE PROGRAMMING
10
3
3.2.7 Match Code Content
The Matrix match code command must have the following format:
MATCH<space>code_content <LF>
After using this command, the SAVE configuration command should always be transmitted
before exit from programming mode.
If the command is correct, the device replies with the code_content string for the Expected
Code parameter of the current Match Code configuration:
ACK code_content <LF>
If programming contents are wrong (i.e. a typing error) or due to a transmission error, or if the
current configuration is not a Match Code data collection type, the device replies with the
following message:
NACK <LF>
After transmitting the reply message, the device then waits for another programming string or
the exit from host mode programming command.
NOTE: The configuration must be a Match Code data collection type
previously saved on the device. The code_content can contain spaces and
is case sensitive.
This command overwrites the current Expected Code parameter value.
3.2.8 Send Configuration (Upload Job) to Device
CAUTION: This command requires a dedicated program to handle file
transfer protocol (see below).
It is possible to send a .dlcfg (job) file to the Matrix device, saving it to permanent memory.
NOTE: Any Matrix configuration can be easily exported to a .dlcfg file from
DL.CODE by selecting
File > Save > Save Configuration on PC
The send configuration to matrix device command must have the following format:
SEND_CFG<space>configuration_name <LF>
Within 10 seconds of sending the SEND_CFG command, the .dlcfg configuration file
transmission must be initiated. The entire file content must be encapsulated using a CRC32
checksum control and transmitted to the device using X-Modem protocol.
Failing to initiate transmission within 10 seconds will result in the device replying with a
Timeout message and the command will be considered aborted.
Loading...