CONTENTS Conventions ......................... iv HOST MODE PROGRAMMING ................... 1 Collecting HMP StRings from DL.CODE ..............2 PROGRAMMING COMMANDS ................... 4 Connection To Device ....................4 PROGRAMMING STRINGS ..................5 Definitions ........................5 Programming Strings ....................7 3.2.1 Set Parameter Value in Current Configuration ............. 7 3.2.2 Get Parameter Value in Current Configuration .............
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.
HOST MODE PROGRAMMING 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.
MATRIX N FAMILY HOST MODE PROGRAMMING 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 Shortcuts from Device>Settings menu.
Page 7
HOST MODE PROGRAMMING 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.
MATRIX N FAMILY HOST MODE PROGRAMMING 2 PROGRAMMING COMMANDS 2.1 CONNECTION TO DEVICE DESCRIPTION HOST COMMAND REPLY MESSAGE 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.
PROGRAMMING STRINGS 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.
Page 10
MATRIX N FAMILY HOST MODE PROGRAMMING BOOLEAN (Type = 2) Value true = Enabled; false = Disabled Default Default value (String). Example: Identical Codes parameter. Name: Identical Codes Type: Value: false, true (case sensitive) Default: false (Disabled) String (Type = 3) Length Minimum to maximum number of characters allowed for this parameter.
PROGRAMMING STRINGS 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 ...
MATRIX N FAMILY HOST MODE PROGRAMMING 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> ….
PROGRAMMING STRINGS 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>...
MATRIX N FAMILY HOST MODE PROGRAMMING 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>...
Page 15
PROGRAMMING STRINGS The byte stream containing the configuration that is sent to the device is structured with a 4-byte header containing the total stream length, followed by a data_buffer section containing the whole .dlcfg byte sequence, followed by a 4-byte CRC32 terminator storing the value computed on the previous length + data_buffer sections content.
MATRIX N FAMILY HOST MODE PROGRAMMING 3.2.9 Get Device Information The Matrix get device information command must have the following format: GET_INFO <LF> If the sequence is correct, the device confirms with the following message: ACK Device Information <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>...
Page 17
PROGRAMMING STRINGS PRE-REQUISISTES: The device configuration runs in Phase Mode, Packtrack or OneShot An FTP Server is available and configured to allow uploads on the same TCP/IP network After entering the host programming sequence, wait at least 50 ms for the device to correctly setup internal data structures before issuing SEND_IMAGES commands ...
Page 18
MATRIX N FAMILY HOST MODE PROGRAMMING NOTE: The transferred images come from device internal circular buffer which is used for this specific purpose. The buffer size depends on the complexity of the configuration as it is allocated during runtime. The buffer is managed in a round-robin fashion, therefore requesting of packs/phases that are “too old”...
PROGRAMMING STRINGS 3.2.11 Get Command Status This command generically returns information about the last command executed on the device. It is currently used after a Send Images command to monitor the downloading progress. NOTE: Take into account that as the device continues to capture images, the circular image buffer changes and may be overwritten.
Page 20
MATRIX N FAMILY HOST MODE PROGRAMMING Example Get Command Status responses: Host <> Device Meaning SEND_IMAGES * 3 10 > Host requests device to send images from phase #3 to phase #10. < Device accepts command. GET_CMD_STATUS > Host requests last command status info.
PROGRAMMING STRINGS 3.2.12 Set Focusing Pointer This command can be used only if the device has its Focusing Pointer Status set to HMP enabled in the DL.CODE Device Environment settings. The Matrix device set pointer command must have the following format: SET_POINTER<space><ON|OFF>...
MATRIX N FAMILY HOST MODE PROGRAMMING 3.2.13 Read Input The Matrix read input command must have the following format: READ_INPUT<space><Input1|Input2> <LF> If the sequence is correct, the device confirms with the following message: ACK Input n state <LF> Input n state depends on the configured active state. if Active Closed (default): 0 (open - no current flow);...
PROGRAMMING STRINGS 3.2.15 Run X-PRESS Function The Matrix xpress command must have the following format: XPRESS<space><1|2|3|4> <LF> If the sequence is correct, the device immediately executes the X-PRESS function associated with the selected number and confirms with the following message: ACK <LF>...
Page 24
MATRIX N FAMILY HOST MODE PROGRAMMING HOST DEVICE ESC [ C ESC H <CR><LF> ESC [ B ESC S <CR><LF> COMMAND 1 ACK <LF> or NACK <LF> COMMAND n ACK <LF> or NACK <LF> (SAVE COMMAND) ACK <LF> ESC [ A ESC [ X Figure 1 –...
PROGRAMMING STRINGS 3.3 EXAMPLES - 1- Set Image Setting 2 Exposure Time parameter to 400 Type: Range: 6 to 500 Data: The programming string is: SET<space>EXPOSURE_TIME1<space>400 <CR><LF> - 2 - Set GainMultiplier parameter to X3: Type: List: X1, X2, X3, X4, X5, X6, X7, X8, X9, X10 Data: The programming string is: SET<space>GAINMULTIPLIER<space>2 <CR><LF>...
Page 26
MATRIX N FAMILY HOST MODE PROGRAMMING - 5 - Get Matrix 410N Device Information: The programming string is: GET_INFO<CR><LF> Device Response: ACKModel name: M410N:700-010 MAC address: 00:07:BE:01:2B:56 Serial number: C14P00584 Device name: Matrix Application version: 1.4.0.1073 Current Job: Phase Mode - 6 - Transfer all pending images from all devices in the cluster: The programming string is:...
MATRIX N FAMILY PARAMETERS LIST 4 MATRIX N FAMILY PARAMETERS LIST The following tables present a complete list of parameters that can be modified using Host Mode Programming. The parameter strings shown here are the default ones. The strings can be modified (personalized) through DL.CODE so it is advised to print them out from DL.CODE for your specific configuration.
MATRIX N FAMILY HOST MODE PROGRAMMING PARAMETER TYPE STRING DATA EXPOSURE_TIMEx M120-3xx-xxx (continued) Disabled 1 to 15000 Very High-Power Strobed 1 to 1000 NOTE: The Exposure Time parameter is measured in s and range of valid values depends on the Matrix model and the Internal Lighting setting. Gain GAINx Range: 4 to 32...
Page 29
MATRIX N FAMILY PARAMETERS LIST PARAMETER TYPE STRING DATA Code Color 2D_CODE_COLORx 0 = Black 1 = White 2 = Both Colors Code Contrast 2D_CODE_CONTRASTx 0 = High 1 = Standard 2 = Low 3 = Very Low 4 = Automatic Decoding Complexity 2D_DECODING_COMPLEXITYx 0 = Low...
Page 30
MATRIX N FAMILY HOST MODE PROGRAMMING PARAMETER TYPE STRING DATA AZTEC Identical Codes 2D_ID_CODESx false = Disabled true = Enabled Image Mirroring 2D_IMAGE_MIRRORINGx false = Disabled true = Enabled Grey Level Calibration 2 2D_GREY_LEVEL_CALIBRATIONx false = Disabled true = Enabled Code Color 2D_CODE_COLORx 0 = Black...
Page 31
MATRIX N FAMILY PARAMETERS LIST PARAMETER TYPE STRING DATA Min Pixel per Module 2D_MIN_DOT_DIAMETERx Range: 0 to 48 Max Pixel per Module 2D_MAX_DOT_DIAMETERx Range: 0 to 48 Fixed Code Position 2D_CONSTANT_POSITIONx false = Disabled true = Enabled PARAMETER TYPE STRING DATA 2D CODE FILTER Wildcard...
MATRIX N FAMILY HOST MODE PROGRAMMING 4.2.2 1D Codes PARAMETER TYPE STRING DATA PDF417 Identical Codes 1D_ID_CODESx false = Disabled true = Enabled Grey Level Calibration 2 1D_GREY_LEVEL_CALIBRATIONx false = Disabled true = Enabled Code Orientation 1D_CODE_ORIENTATIONx 0 = Horizontal 1 = Vertical 2 = Both Advanced Box...
Page 33
MATRIX N FAMILY PARAMETERS LIST PARAMETER TYPE STRING DATA GS1-128 Identical Codes 1D_ID_CODESx false = Disabled true = Enabled Grey Level Calibration 2 1D_GREY_LEVEL_CALIBRATIONx false = Disabled true = Enabled Code Orientation 1D_CODE_ORIENTATIONx 0 = Horizontal 1 = Vertical 2 = Both Advanced Box 1D_ADV_BOX_IMPROVEMENTx false = Disabled...
Page 34
MATRIX N FAMILY HOST MODE PROGRAMMING PARAMETER TYPE STRING DATA Narrow Quiet Zone 1D_NARROW_MARGINSx false = Disabled true = Enabled Min Accepted Code 1D_INT25_MIN_ENABLED_LENx Range 2 to 60 Length PARAMETER TYPE STRING DATA PHARMA Identical Codes 1D_ID_CODESx false = Disabled true = Enabled Grey Level Calibration 2 1D_GREY_LEVEL_CALIBRATIONx...
Page 35
MATRIX N FAMILY PARAMETERS LIST PARAMETER TYPE STRING DATA Subpixel Decoding 1D_SUBPIXEL_IMPROVEMENTx false = Disabled Improvement true = Enabled Narrow Quiet Zone 1D_NARROW_MARGINSx false = Disabled true = Enabled PARAMETER TYPE STRING DATA STANDARD 2 OF 5 Identical Codes 1D_ID_CODESx false = Disabled true = Enabled Grey Level Calibration 2...
Page 36
MATRIX N FAMILY HOST MODE PROGRAMMING PARAMETER TYPE STRING DATA Start/Stop Characters 1D_STARTSTOP_CHAR_TXx false = Disabled true = Enabled PARAMETER TYPE STRING DATA GS1 DATABAR EXPANDED Identical Codes 1D_ID_CODESx false = Disabled true = Enabled Grey Level Calibration 2 1D_GREY_LEVEL_CALIBRATIONx false = Disabled true = Enabled Code Orientation...
Page 37
MATRIX N FAMILY PARAMETERS LIST PARAMETER TYPE STRING DATA Grey Level Calibration 2 1D_GREY_LEVEL_CALIBRATIONx false = Disabled true = Enabled Code Orientation 1D_CODE_ORIENTATIONx 0 = Horizontal 1 = Vertical 2 = Both Advanced Box 1D_ADV_BOX_IMPROVEMENTx false = Disabled Improvement true = Enabled Subpixel Decoding 1D_SUBPIXEL_IMPROVEMENTx false = Disabled...
Page 38
MATRIX N FAMILY HOST MODE PROGRAMMING PARAMETER TYPE STRING DATA Code Orientation 1D_CODE_ORIENTATIONx 0 = Horizontal 1 = Vertical 2 = Both Advanced Box 1D_ADV_BOX_IMPROVEMENTx false = Disabled Improvement true = Enabled Subpixel Decoding 1D_SUBPIXEL_IMPROVEMENTx false = Disabled Improvement true = Enabled Narrow Quiet Zone 1D_NARROW_MARGINSx false = Disabled...
Page 39
MATRIX N FAMILY PARAMETERS LIST PARAMETER TYPE STRING DATA Code Quality 1D_CODE_QUALITY_STx 0 = Overall 1 = Decode Standard 2 = Contrast 3 = Modulation 4 = Decodability 5 = Minimum Edge Contrast 6 = Axial Non Uniformity 7 = Unused Error Correction 9 = Minimum Reflectance 10 = Defects 11 = Fixed Pattern Damage...
MATRIX N FAMILY HOST MODE PROGRAMMING 4.2.4 Outputs PARAMETER TYPE STRING DATA OUTPUTS Active State LOCOUT_ACTIVE_STATE_x 0 = Active Closed 1 = Active Open Line Function LOCOUT_MODE_x 0 = General Purpose 2 = External Ill – Always On 3 = External Ill – Strobed Number of Events LOCOUT_NUM_OF_EVENTS_x Range 1 to 255...