All rights reserved. The information contained herein is proprietary and is provided solely for the purpose of allowing customers to operate and/or service Microscan manufactured equipment and is not to be released, reproduced, or used for any other purpose without written permission of Microscan.
Page 4
PDF417 ....................6-36 MicroPDF417 ..................6-37 Composite ..................... 6-38 Narrow Margins/Symbology Identifier............ 6-39 Background Color.................. 6-41 Chapter 7 I/O Parameters I/O Parameters by ESP ................7-2 I/O Parameters Serial Commands ............7-3 Symbol Data Output ................7-4 MS-4Xi Imager User’s Manual...
Page 5
Symbol Quality Separator/Data Matrix Output Mode ......8-8 ISO/IEC 16022 Symbol Quality Output ..........8-10 ISO/IEC 16022 Symbol Quality Output by ESP ........8-12 Microscan Symbol Quality Output ............8-13 Microscan Symbol Quality Output by ESP ..........8-16 Chapter 9 Matchcode Matchcode by ESP .................. 9-2 Matchcode Serial Commands ..............
Page 6
Utilities Serial Utility Commands ................ 13-2 Read Rate ..................... 13-4 Counters ....................13-6 Device Control ..................13-8 Differences from Default................ 13-9 Master Database ................. 13-10 Firmware ..................... 13-16 Default/Reset/Save ................13-19 Imager Status Requests ..............13-21 MS-4Xi Imager User’s Manual...
Page 7
Appendix C Serial Configuration Commands ........A-15 Appendix D Communications Protocol ..........A-20 Appendix E ASCII Table ................A-29 Appendix F Operational Tips ..............A-30 Appendix G Using an External Trigger ..........A-31 Appendix H MS-4Xi Image Output ............A-32 Appendix I Glossary of Terms ...............A-35 MS-4Xi Imager User’s Manual...
Page 8
• Compact size for easy integration into a wide variety of applications MS-4Xi Communications There are three ways to configure and test the MS-4Xi: • Microscan’s Windows-based ESP (Easy Setup Program), which offers point-and-click ease of use and visual responses to user adjustments.
Page 9
CAUTION: Use of controls or adjustments or performance of procedures other than those specified herein may result in hazardous radiation exposure. IMPORTANT: The MS-4Xi is intended for connection to a UL-listed direct plug-in power unit marked Class II and rated 24 VDC at 5 Watts, or greater if using electrical accessories.
Changes or modifications not expressly approved by the party responsible for compliance could void the user’s authority to operate the equipment. The MS-4Xi has been tested for compliance with CE (Conformité Européenne) standards and guidelines, and has been found to conform to applicable CE standards, specifically the...
Page 11
The information provided in this certification notice is correct to the best of Microscan’s knowledge at the date of publication. This notice is not to be considered a warranty or quality specification. Users are responsible for determining the applicability of any RoHS legislation or regulations based on their individual use of the product.
Page 12
Statement of RoHS Compliance MS-4Xi Imager User’s Manual...
Step 11 Save Configuration in ESP ................... 1-13 This section is designed to get your MS-4Xi up and running quickly, using the EZ button or ESP (Easy Setup Program). Following these steps will allow you to get a sense of the imager’s capabilities and to test sample symbols.
Photo Sensor, M12 4-pin Plug, NPN, Dark On, 2 m 99-000020-02 Ethernet Standalone without QX-1 Ethernet Standalone with QX-1 Caution: Be sure that all cables are connected BEFORE applying power to the system. Always power down BEFORE disconnecting any cables. MS-4Xi Imager User’s Manual...
• Plug in the power supply to apply power to the imager. Ethernet Standalone without QX-1 Ethernet Standalone with QX-1 Caution: Be sure that all cables are connected BEFORE applying power to the system. Always power down BEFORE disconnecting any cables. MS-4Xi Imager User’s Manual...
Scan line Imager and Symbol Orientation Note: For accuracy of testing and performance, Microscan recommends using a mounting arm adapter kit. Contact your Microscan sales manager for details about mounting arm adapter kits and other accessories. MS-4Xi Imager User’s Manual...
Quick Start Step 4 — Install ESP ESP Software can be found on the Microscan Tools Drive that is packaged with the MS-4Xi. 1. Follow the prompts to install ESP from the Tools Drive. 2. Click on the ESP icon to run the program.
1. Click the button showing the MS-4Xi. 2. Click OK. Note: You can also double-click the MS-4Xi button to make your selection. 3. Click Yes when this dialog appears: Note: If you need to select another model later, click the Switch Model button near the top of the screen or use Model >...
Important: The imager is in Continuous Read Mode by default. For best connection results, be sure that no decodable symbols are within the imager’s field of view while attempting to connect. MS-4Xi Imager User’s Manual...
Important: The entire symbol should fall within the field of view (FOV) of the imager. The field of view is what appears in ESP’s Locate/Calibrate window in EZ Mode. • Click the Stop button to end the Locate function. MS-4Xi Imager User’s Manual...
Page 21
If you are not connected to a host computer, the EZ Button allows you to locate a symbol in the imager’s field of view. MS-4Xi Read Rate LEDs and EZ Button • Hold down the EZ Button for about one second and release when you hear one short beep.
Calibrate Step 8 — Calibrate MS-4Xi settings can be adjusted automatically for optimum symbol decoding performance by either the EZ Button or by ESP. During the calibration routine, the reader will flash its amber Read Rate percent LEDs and red illumination LEDs while searching camera settings and determining the best configuration for decoding symbol data.
Note: Read Rate can also be tested using the Read Rate interface in Utilities. Test Read Rate by Serial Command You can also start a test with the <C> <Cp> command and end it with the <J> command. 1-11 MS-4Xi Imager User’s Manual...
Configure the Imager in ESP Step 10 — Configure the Imager in ESP To make setup changes to the MS-4Xi, click the App Mode button. The following modes are accessible by clicking the buttons in the first row of App Mode icons: •...
Saving Options • Send, No Save. Changes will be lost when power is re-applied to the imager. • Send and Save. This activates all changes in current memory and saves to the imager for power-on. 1-13 MS-4Xi Imager User’s Manual...
Page 26
Save Configuration in ESP 1-14 MS-4Xi Imager User’s Manual...
Matchcode, and Diagnostics), a Camera setup interface, a Terminal interface, a Utilities interface, and an Output Format interface. ESP can be used to configure the MS-4Xi in three different ways: • Tree Controls: Each configuration menu contains a list of all option settings that pertain to that specific element of imager operation.
EZ Mode screen, and also in Quick Start. Click Locate to activate the MS-4Xi’s blue target pattern LEDs. Center the target pattern on the symbol. The display shows you where the symbol is located in the imager’s field of view.
Decoded symbol data is shown in this table. Note: For specific information on any of the icons shown above in the operations bar or configuration bar, see the corresponding sections of this manual. MS-4Xi Imager User’s Manual...
ESP and the imager, and ESP and the host hard drive. (Save to Imager) (Receive Imager Settings) Import/Export Import converts the ASCII settings from a text file to ESP configuration settings. Export converts the active ESP configuration settings to an ASCII text file. MS-4Xi Imager User’s Manual...
Page 31
To connect to another model, select New Model, choose a new model from the menu that appears, and click OK. Note: When you save an ESP file, you are saving the settings of all the models defined in that file. MS-4Xi Imager User’s Manual...
Page 32
At startup, shows the model menu displaying all supported readers. Show Connect Prompt At startup, displays the Would you like to connect to the MS-4Xi? prompt. Receive After Connect At startup, loads the imager’s settings into ESP. (This is not recommended if you want to preserve your ESP settings for future use.)
Page 33
Display Incoming Data Even When Not in Focus When Display Incoming Data Even When Not in Focus is enabled, data from the imager will continue to appear in the terminal even when ESP is not the top window. MS-4Xi Imager User’s Manual...
Page 34
The Bar Code Options dialog allows you to set the size of user-created symbols. Sizing Information Sets the bar width or module width (in mils, or thousandths of an inch) of user-created symbols. Example: A bar width of 18 is 0.018 inches. MS-4Xi Imager User’s Manual...
Page 35
Images can be saved from the Evaluation tab in the Camera view, or by right clicking an image in any other image capture view and then saving. Send XON with Autoconnect Sends an XON (Begin Transmission) command to the imager before starting the Autoconnect routine. MS-4Xi Imager User’s Manual...
Page 36
The .esp file will be saved in the location of your choice. Connect to Readers via TCP/IP When enabled, shows a TCP/IP option on the Connection Wizard. Use Default Storage Location When enabled, automatically stores data in ESP’s Application Data folder. 2-10 MS-4Xi Imager User’s Manual...
Page 37
Note: Memos must be saved in a .esp file if you want them to available in your next session. If you do not save your current session, any memos that you have entered during the session will be discarded, and will be unavailable in your next session. 2-11 MS-4Xi Imager User’s Manual...
Page 38
• When a connection is established, the green indicator in the status bar at the bottom right of the screen will be visible. • If your RS-232 connection attempt fails, click the Auto Connect button to establish a connection between the MS-4Xi and the host. 2-12 MS-4Xi Imager User’s Manual...
Create a caption for the symbol that matches the encoded data, or write your own caption. The symbol you create will be displayed in the field at the bottom of the Bar Code Dialog. 2-13 MS-4Xi Imager User’s Manual...
5. Right click on the open screen and select Save to Reader to implement the command in the imager. You can send the command without saving it, or you can send and save the command simultaneously. 2-14 MS-4Xi Imager User’s Manual...
Send and Save as Customer Defaults (<Zc>) Saves your default settings for quick retrieval. This option will be visible only if you have checked Enable ‘Send and Save as Customer Defaults’ in ESP Preferences. 2-15 MS-4Xi Imager User’s Manual...
Page 42
Also, if there is a corresponding ESP menu item, the ESP Value column for that item will be blank following a Receive Reader Settings command. 1. From the Send/Recv button or by right-clicking in any blank section of a tree control view. 2-16 MS-4Xi Imager User’s Manual...
For detailed information about using EZ Trax, refer to the Help menu in EZ Trax software, or the EZ Trax Quick Start Guide, available on the Microscan Tools Drive. For information about how to configure the MS-4Xi for use with EZ Trax, see Setting Up the...
Page 44
Using EZ Trax 2-18 MS-4Xi Imager User’s Manual...
This section explains how to set up communications parameters with the host. With Microscan’s ESP (Easy Setup Program), configuration changes can be made in the ESP menus and then sent and saved to the imager. The user can also send serial commands to the imager via ESP’s Terminal window.
Communications by ESP Communications by ESP Click the Parameters button and then the Communication tab. To open nested options, To change a setting, double-click the single-click the +. setting and use your cursor to scroll through the options. MS-4Xi Imager User’s Manual...
Only changed if necessary to match host setting. Definition: One or two bits added to the end of each character to indicate the end of the character. Serial Cmd: <K100,baud rate,parity,stop bits,data bits> Default: Eight Options: 0 = Seven 1 = Eight MS-4Xi Imager User’s Manual...
REQ to request such a response (if enabled). When the sender receives an ACK, too many NAKs, or times out (if already enabled), it will send a RES (if enabled) to terminate the transaction. Note: See ACK/NAK Data Flow Examples for sample ACK/NAK communication scenarios. MS-4Xi Imager User’s Manual...
Ethernet Ethernet Enables or disables Ethernet connectivity in the imager. IP Address Enter the IP address of the imager in this field. MS-4Xi Imager User’s Manual...
Page 53
Communications Subnet Enter the Subnet address of the imager in this field. Gateway Enter the Gateway address of the imager in this field. MS-4Xi Imager User’s Manual...
Static In Static Mode, the imager uses the user-defined IP address entered in ESP. DHCP In DHCP Mode, the imager automatically acquires the IP address, Subnet, and Gateway addresses from a DHCP or BOOTP server. 3-10 MS-4Xi Imager User’s Manual...
Page 55
Note: The data path between in the source port and out the source port is always two-way. Data is copied from source data ports and all those source ports’ data is transmitted to the destination port, and from the destination port to the source port. 3-11 MS-4Xi Imager User’s Manual...
Page 56
Note: The data path between in the source port and out the source port is always two-way. Data is copied from source data ports and all those source ports’ data is transmitted to the destination port, and from the destination port to the source port. 3-12 MS-4Xi Imager User’s Manual...
Page 57
When Timed Window is selected, Search and Configure Mode will find the imager and settings can be changed, but only 60 seconds from the last reset. After 60 seconds, Search and Configure Mode will be disabled. 3-13 MS-4Xi Imager User’s Manual...
The time that the imager will wait before timing out if ACK, NAK, and ETX are enabled, and a host response is expected. Serial Cmd: <K143,response timeout> Default: (in 1 ms increments) Options: 0 to 255 (A zero (0) setting causes an indefinite wait.) 3-14 MS-4Xi Imager User’s Manual...
(two 1s = 0, two 0s = 0, a 1 and a 0 = 1). The extra LRC character is then appended to the transmission, and the receiver (usually the host) performs the same addition and compares the results. Serial Cmd: <K145,status> Default: Disabled Options: 0 = Disabled 1 = Enabled 3-15 MS-4Xi Imager User’s Manual...
Note that the “status” field contains only a . This is because the only field that is being changed is the “postamble character(s)” field. (See Serial Configuration Command Conventions for a more detailed explanation of this command shortcut.) 3-17 MS-4Xi Imager User’s Manual...
Example: <K141,1,CNTL-m> to enter the control character ^M. Important: The ASCII characters <, >, and can only be entered as hex pairs: For <: <K141h,,3C> For >: <K141h,,3E> <K141h,,2C> 3-18 MS-4Xi Imager User’s Manual...
To enter control characters within a serial command, hold down the control key while typing the desired character. Example: <K142,1,CNTL-m CNTL-j> to enter ^M^J. Important: The ASCII characters <, >, and can only be entered as hex pairs: For <: <K142h,,3C> For >: <K142h,,3E> <K142h,,2C> 3-19 MS-4Xi Imager User’s Manual...
Calibration Overview........................4-2 Calibration Options ........................4-3 Calibration by ESP........................4-10 Initiating Calibration ........................4-12 Additional Notes about Calibration..................... 4-18 This section shows the MS-4Xi’s calibration options, and explains the different ways that those options can be configured. MS-4Xi Imager User’s Manual...
<@CAL> Calibration Overview Autocalibration is one of the most powerful features of the MS-4Xi. The calibration process can be initiated by serial command, EZ button, or ESP user interface. When the imager enters calibration, it runs through an optimization cycle that sets the ideal parameters for reading symbols at the highest possible level of performance.
Page 68
Enabled setting. The calibration process is not designed to choose the fastest shutter speed that can decode a symbol, but rather to optimize for the fastest shutter speed that still provides good image quality. MS-4Xi Imager User’s Manual...
Page 69
For example, assume that only Code 39 is enabled at the beginning of calibration. If a Code 128 symbol is read during calibration, then Code 128, as well as Code 39, will be enabled after the calibration process is complete. MS-4Xi Imager User’s Manual...
Page 70
After a symbol is decoded, the WOI is framed exactly as it would be if a WOI framing mode was enabled. When the calibration process is complete, the original WOI configuration is restored. Refer to the diagram below: Calibration Passed Calibration Failed After Decode Configured WOI MS-4Xi Imager User’s Manual...
Page 71
If the calibration process is successful, the Window of Interest rows will be modified to horizontally frame the symbol, plus an additional margin area around the symbol, determined by the WOI Margin parameter. Refer to the diagram below: MS-4Xi Imager User’s Manual...
Page 72
This parameter is the same as “Straight Line”, except that the Window of Interest will also frame the scan line on the symbol length as well. The scan line includes the symbol plus an additional margin area determined by the WOI Margin parameter. MS-4Xi Imager User’s Manual...
Page 73
The imager will spend a high amount of effort attempting to decode the given symbol for each parameter configuration. Definable The processing time for each image frame is defined by the Image Processing Timeout parameter <K245>. MS-4Xi Imager User’s Manual...
The Window of Interest section of the Calibration interface allows the user to make precise adjustments to WOI Framing, WOI Margin (in pixels), and the scan height of the straight-line image (in pixels). 4-10 MS-4Xi Imager User’s Manual...
Page 75
The calibration progress bar indicates that the process has been completed. Saves the optimal configuration parameters determined by calibration results. 4-11 MS-4Xi Imager User’s Manual...
To initiate calibration by serial command, enter the serial command <@CAL> from a terminal, such as ESP’s Terminal interface. <@CAL> is a calibration routine that emphasizes contrast and readability. Calibrate by EZ Button for the EZ button calibration procedure. 4-12 MS-4Xi Imager User’s Manual...
Page 77
The beeper and green LED flash are used to indicate calibration status as shown in the table below: Indicator Status 2 quick beeps Calibration has started. 5 quick beeps Calibration has failed. 1 long beep Calibration has been completed successfully. 1 sec. Green Flash Calibration has been completed successfully. 4-13 MS-4Xi Imager User’s Manual...
Page 78
This process is designed to quickly identify symbology type, and any image processing parameters that are already calibrated, as well as determining focus position. Running Search Pass Prog Rating Decode Quality Focus Shutter Gain Locate 2174 4-14 MS-4Xi Imager User’s Manual...
11. The Search process will use the configurable Window of Interest for image captures. However, when the search process is completed, the WOI will be reduced to include only the symbol of interest and some additional boundary area. 4-18 MS-4Xi Imager User’s Manual...
Setting Up the Imager for EZ Trax....................5-27 After you’ve established communications and completed basic read rate testing, you will need to address the spatial and timing parameters associated with your application. This section explains those parameters. MS-4Xi Imager User’s Manual...
Read Cycle by ESP Click the Parameters button and then the Read Cycle tab. To change a setting, double-click the To open nested options, setting and use your single-click the +. cursor to scroll through the options. MS-4Xi Imager User’s Manual...
<K229,start character> Stop Trigger Character <K230,stop character> Capture Timing <K242,time before first capture,time between first and second captures,,,,,,,,time between seventh and eighth captures> Image Storage <K244,image storage type,image store mode> Image Processing Timeout <K245,image processing timeout> MS-4Xi Imager User’s Manual...
Setting up read cycle and triggering parameters will involve a series of decisions based on your particular application, as follows: 1. Select the number of symbols to be read in a single cycle. The MS-4Xi can read multiple symbols in a single image frame.
For <: <K222h,,3C> For >: <K222h,,3E> <K222h,,2C> Note: If No Read messages are disabled and there are No Reads occurring, separators will only be inserted between symbol data outputs. MS-4Xi Imager User’s Manual...
Note: If Trigger Mode is set to Continuous Read 1 Output, the imager will behave as if Number of Symbols were set to 1, regardless of the user-defined configuration. MS-4Xi Imager User’s Manual...
Page 90
However, the passing of an object out of sensor range does not end the read cycle. The read cycle ends with a good read output, or, depending on the End of Read Cycle setting, a timeout or new trigger occurs. Serial Cmd: <K200,3> MS-4Xi Imager User’s Manual...
In this mode the imager accepts either a serial ASCII character or an external trigger pulse to start the read cycle. Serial Cmd: <K200,5> Note: In Serial Data, sending a non-delimited start serial character will start a read cycle; however, a non-delimited stop serial character has no effect. MS-4Xi Imager User’s Manual...
Allows users to select the trigger polarity that will be used in their application. Definition: Determines the active state of the trigger signal applied to the cable input of the imager. Serial Cmd: <K202,active state> Default: Positive Options: 0 = Negative 1 = Positive 5-11 MS-4Xi Imager User’s Manual...
Note: Serial Data or Serial Data or External Edge triggering mode must be enabled for Serial Trigger Character to take effect. Important: The ASCII characters <, >, and can only be entered as hex pairs: For <: <K201h,3C> For >: <K201h,3E> <K201h,2C> 5-12 MS-4Xi Imager User’s Manual...
(00 in hex) (disabled) Options: Two hex digits representing any ASCII character except XON and XOFF. Important: The ASCII characters <, >, and can only be entered as hex pairs: For <: <K229h,3C> For >: <K229h,3E> <K229h,2C> 5-13 MS-4Xi Imager User’s Manual...
Default: (00 in hex) (disabled) Options: Two hex digits representing an ASCII character. Important: The ASCII characters <, >, and can only be entered as hex pairs: For <: <K230h,3C> For >: <K230h,3E> <K230h,2C> 5-14 MS-4Xi Imager User’s Manual...
With External Level enabled, the read cycle does not end until the falling edge trigger occurs or a timeout occurs. The next read cycle does not begin until the next rising edge trigger. 5-15 MS-4Xi Imager User’s Manual...
Capture Start of Read End of 1 2 3 Cycle read cycle Processing time 5-17 MS-4Xi Imager User’s Manual...
Page 100
In this mode, the only limiting time factor is integration and transfer timing. Serial Cmd: <K241,capture mode,number of captures,rapid capture mode> Default: Timed Capture Options: 0 = Timed Capture 1 = Triggered Capture 5-18 MS-4Xi Imager User’s Manual...
Also, consecutive captures are regarded as the same symbol if the output data is the same. No Time Delay Between Captures Start of Read Cycle End of Diagram A read cycle Time Before First Capture Time Delay Between Captures End of Diagram B read cycle Processing 5-19 MS-4Xi Imager User’s Manual...
Number of Captures setting. First trigger Capture starts the read Captures on every trigger cycle Read cycle ends on New Trigger or Timeout, as configured. Processing 5-20 MS-4Xi Imager User’s Manual...
<K242,time before 1st capture,time between capture 1 and capture 2,,,,,,,,time between capture 7 and capture 8> Default: Options: 0 to 65535 (2.097 seconds, in 32 µS increments) Start of Read Cycle Time Before First Capture Processing 5-21 MS-4Xi Imager User’s Manual...
Note: Number of Captures and number of frame delays (Time Between Captures) must be the same. Start of Read Cycle Time Delay Between Captures = 0 Diagram A End of Read Cycle Time Delay Between Captures varies. Diagram B 5-22 MS-4Xi Imager User’s Manual...
• If a timeout occurs during processing and no symbols in the field of view have been decoded, the image will be recorded as a No Read. For this reason, a longer timeout should be tried to ensure that the symbol is decoded successfully. 5-23 MS-4Xi Imager User’s Manual...
Last Mode In this mode, image storage continues after available memory limits are reached. The oldest image in memory is overwritten, so you will always have the most recent stored image. 5-24 MS-4Xi Imager User’s Manual...
Page 107
Stored Frame: Frame # 3 Number of Symbols: Frame # 1: No Read Frame # 2: No Read Frame # 3: Good Read, Symbol # 1 Read Cycle Result: No Read Stored Frame: Frame # 2 5-25 MS-4Xi Imager User’s Manual...
Minimum Good Reads Minimum Good Reads Definition: This value specifies the number of times a symbol needs to be read to qualify as a good read. Serial Cmd: <K221,minimum good reads> Default: Options: 1 to 255 5-26 MS-4Xi Imager User’s Manual...
Read Cycle Setting Up the Imager for EZ Trax If you are using EZ Trax software, it is important to set up the MS-4Xi correctly before beginning. Click the Read Cycle tab to display the Read Cycle tree control. Set Trigger Mode, <K200>, to External Edge.
Page 110
Setting Up the Imager for EZ Trax 5-28 MS-4Xi Imager User’s Manual...
GS1 DataBar ..........................6-34 PDF417 ............................6-36 MicroPDF417 ..........................6-37 Composite ..........................6-38 Narrow Margins/Symbology Identifier ..................6-39 Background Color........................6-41 This section describes the various symbol types that can be read and decoded by the MS-4Xi. MS-4Xi Imager User’s Manual...
Symbologies by ESP Symbologies by ESP Click the Parameters button and then the Symbologies tab. To change a setting, double-click the setting and use your cursor to scroll through the options. To open nested options, single-click the +. MS-4Xi Imager User’s Manual...
The level of Reed-Solomon error correction used with Aztec Code is configurable, from 5% to 95% of the total data region. The recommended error correction level is 23% of symbol capacity plus codewords. Serial Cmd: <K458,status> Default: Disabled Options: 0 = Disabled 1 = Enabled MS-4Xi Imager User’s Manual...
QR Code has error protection capability. Data can often be restored even if a part of the symbol has become dirty or damaged. Serial Cmd: <K480,status> Default: Disabled Options: 0 = Disabled 1 = Enabled MS-4Xi Imager User’s Manual...
Definition: Micro QR Code is a 2D matrix symbology that comes in 4 different symbol sizes, the largest capable of encoding 35 numeric characters. Serial Cmd: <K459,status> Default: Disabled Options: 0 = Disabled 1 = Enabled MS-4Xi Imager User’s Manual...
No Read message to be transmitted at the end of the read cycle. Serial Cmd: <K470,status,check character status,check character output status,large intercharacter gap,fixed symbol length status,fixed symbol length,full ASCII set> Default: Disabled Options: 0 = Disabled 1 = Enabled MS-4Xi Imager User’s Manual...
Page 120
(this does not include start and stop and check character characters). The imager ignores any symbology that does not match the specified length. Serial Cmd: <K470,status,check character status,check character output status,large intercharacter gap,fixed symbol length status,fixed symbol length,full ASCII set> Default: Options: 1 to 64 6-10 MS-4Xi Imager User’s Manual...
Page 121
ASCII character set, from 0 to 255. Serial Cmd: <K470,status,check character status,check character output status,large intercharacter gap,fixed symbol length status,fixed symbol length,full ASCII set> Default: Disabled Options: 0 = Disabled 1 = Enabled 6-11 MS-4Xi Imager User’s Manual...
Serial Cmd: <K474,status,fixed symbol length status,fixed symbol length,EAN 128 status,output format,application record separator status,application record separator character,application record brackets,application record padding> Default: Options: 1 to 64 6-12 MS-4Xi Imager User’s Manual...
Page 123
EAN-conforming symbol is decoded and EAN output formatting applies. Serial Cmd: <K474,status,fixed symbol length status,fixed symbol length,EAN 128 status, output format,application record separator status,application record separator character,application record brackets,application record padding> Default: Disabled Options: 0 = Disabled 1 = Enabled 6-13 MS-4Xi Imager User’s Manual...
Page 124
This is not done for the last field of a symbol. Serial Cmd: <K474,status,fixed symbol length status,fixed symbol length,EAN 128 status, output format,application record separator status,application record separator character,application record brackets,application record padding> Default: Enabled Options: 0 = Disabled 1 = Enabled 6-14 MS-4Xi Imager User’s Manual...
When enabled, the check character character is read and compared along with the symbol data. When disabled, symbol data is sent without the check character. Serial Cmd: <K481,status,check character output,fixed symbol length status,fixed symbol length> Default: Options: 1 to 64 6-15 MS-4Xi Imager User’s Manual...
Usage: I-2/5 has been popular because it is the most dense symbology for printing numeric characters less than 10 characters in length; however, Microscan does not recommend this symbology for any new applications because of inherent problems such as truncation.
Page 127
Symbol Length # 2 or Symbol Length # 1 to be considered a valid symbol. If Range Mode is enabled, Symbol Length # 2 and Symbol Length # 1 form a range into which the length of the symbol must fall to be considered valid. 6-17 MS-4Xi Imager User’s Manual...
Page 128
Length # 2 fields can form the start or end of the range. Serial Cmd: <K472,status,check character status,check character output,symbol length #1,symbol length #2,guard bar status,range mode status> Default: Enabled Options: 0 = Disabled 1 = Enabled 6-18 MS-4Xi Imager User’s Manual...
1 = Enabled Symbol Length (Code 93) Definition: This is the symbol length value against which all Code 93 symbols will be compared. Serial Cmd: <K475,status,fixed symbol length status,symbol length> Default: Options: 1 to 64 6-19 MS-4Xi Imager User’s Manual...
Serial Cmd: <K471,status,start/stop match,start/stop output,large intercharacter gap,fixed symbol length status,symbol length,check character type,check character output> Default: Enabled Options: 0 = Disabled 1 = Enabled 6-20 MS-4Xi Imager User’s Manual...
Page 131
Symbol Length (Codabar) Definition: This is the value against which all Codabar symbol lengths will be compared. Serial Cmd: <K471,status,start/stop match,start/stop output,large intercharacter gap,fixed symbol length status,symbol length,check character type,check character output> Default: Options: 1 to 64 6-21 MS-4Xi Imager User’s Manual...
Page 132
This condition must be accounted for if a fixed length is also being used. Serial Cmd: <K471,status,start/stop match,start/stop output,large intercharacter gap,fixed symbol length status,symbol length,check character type,check character output> Default: Disabled Options: 0 = Disabled 1 = Enabled 6-22 MS-4Xi Imager User’s Manual...
Usage: Used primarily in point-of-sale applications in the retail industry. It is commonly used with Microscan readers in applications in combination with Matchcode when there is a need to verify that the right product is being placed in the right packaging.
Page 134
A character can be inserted between the standard UPC or EAN symbology and the supplemental symbology when Supplementals is set to Enabled or Required. Serial Cmd: <K473,UPC status,EAN status,supplementals status,separator status, separator character,supplemental type,format UPC-E as UPC-A> Default: Disabled Options: 0 = Disabled 1 = Enabled 6-24 MS-4Xi Imager User’s Manual...
Page 135
Important: The ASCII characters <, >, and can only be entered as hex pairs: For <: <K473h,,,,,3C> For >: <K473h,,,,,3E> <K473h,,,,,2C> 6-25 MS-4Xi Imager User’s Manual...
Page 136
This formatting reverses the zero suppression that is used to generate the symbol in the UPC specification. Serial Cmd: <K473,UPC status,EAN status,supplementals status,separator status, separator character,supplemental type,format UPC-E as UPC-A> Default: Disabled Options: 0 = Disabled 1 = Enabled 6-26 MS-4Xi Imager User’s Manual...
Sets the minimum number of bars that a Pharmacode symbol must have to be considered valid. Serial Cmd: <K477,status,fixed symbol length status,fixed symbol length,minimum number of bars,bar width status,direction,fixed threshold value> Default: Options: 1 to 16 6-27 MS-4Xi Imager User’s Manual...
Page 138
Used when Bar Width Status is set to Fixed Threshold. Defines the minimum difference in pixels that will distinguish a narrow bar from a wide bar. Serial Cmd: <K477,status,fixed symbol length status,fixed symbol length,minimum number of bars,bar width status,direction,fixed threshold value> Default: Options: 1 to 65535 6-28 MS-4Xi Imager User’s Manual...
Symbologies Postal Symbologies Important: Postal Symbologies must have a minimum pixels-per-element value of 4 to be decoded reliably by the MS-4Xi. The imager must be configured to specific read range, field of view, and camera parameters before decoding Postal Symbologies.
Page 140
B and B’ fields,Australia Post allow 0 FCC> Default: Disabled Options: 0 = Disabled 1 = U.S. Post (POSTNET, PLANET, USPS4CB) 2 = Australia Post 3 = Japan Post 4 = Royal Mail 5 = KIX 6 = UPU 6-30 MS-4Xi Imager User’s Manual...
When UPU is enabled, the imager will decode UPU symbols. For example, if Postal Symbology Type is set to UPU and POSTNET Status is enabled and (<K460,6,1>), the imager will attempt to decode both UPU and POSTNET symbols. 6-31 MS-4Xi Imager User’s Manual...
Page 142
If U.S. Post and PLANET Status are both enabled, the imager will decode PLANET symbols. Serial Cmd: <K460,postal symbology type,POSTNET status,PLANET status, USPS4CB status,POSTNET allow B and B’ fields,Australia Post allow 0 FCC> Default: Enabled Options: 0 = Disabled 1 = Enabled 6-32 MS-4Xi Imager User’s Manual...
Page 143
0 FCC in Australia Post symbols. Serial Cmd: <K460,postal symbology type,POSTNET status,PLANET status,USPS4CB status,POSTNET allow B and B’ fields,Australia Post allow 0 FCC> Default: Disabled Options: 0 = Disabled 1 = Enabled 6-33 MS-4Xi Imager User’s Manual...
Specifies the exact number of characters that the imager will recognize (this does not include start, stop, and check character characters). The imager ignores any symbol not having the specified length. Serial Cmd: <K484,status,fixed symbol length status,fixed symbol length> Default: Options: 1 to 74 6-34 MS-4Xi Imager User’s Manual...
Page 145
1-digit indicator. DataBar-14 is 96 modules wide. It can be stacked in two rows, it can read omnidirectionally if printed in full height, or horizontally if height-truncated for small marking. Serial Cmd: <K482,status> Default: Disabled Options: 0 = Disabled 1 = Enabled 6-35 MS-4Xi Imager User’s Manual...
Serial Cmd: <K476,status,[unused],fixed symbol length status,fixed symbol length> Default: Options: 1 to 2710 Note: Fixed Symbol Length Status must be enabled for Fixed Symbol Length to take effect. 6-36 MS-4Xi Imager User’s Manual...
The imager will ignore any symbol not having the specified length. Serial Cmd: <K485,status,[unused],fixed symbol length status,fixed symbol length> Default: Options: 1 to 366 Note: Fixed Symbol Length Status must be enabled for Fixed Symbol Length to take effect. 6-37 MS-4Xi Imager User’s Manual...
Allows the user to change the separator character from a comma to a new character. Serial Cmd: <K453,mode,separator status,separator> Default: (comma) Options: Any ASCII character. Important: The ASCII characters <, >, and can only be entered as hex pairs: For <: <K453h,,,3C> For >: <K453h,,,3E> <K453h,,,2C> 6-38 MS-4Xi Imager User’s Manual...
Serial Cmd: <K450,narrow margins,symbology identifier status> Default: Enabled Options: 0 = Disabled 1 = Enabled Enabled When Narrow Margins is set to Enabled, the imager uses a 5x margin requirement for standard linear symbols. 6-39 MS-4Xi Imager User’s Manual...
Australia Post; a 3 indicates PLANET; a 4 indicates Royal Mail; a 5 indicates KIX; a 6 indicates UPU (56-bar); a 7 indicates UPU (75-bar); and an 8 indicates USPS4CB. Example: ]Y0 indicates a POSTNET symbol. • For all other symbologies, the modifier is 0. 6-40 MS-4Xi Imager User’s Manual...
When Black background is enabled, the bars of the symbol are recognized as light on a dark background. Both When Both is enabled, the imager will attempt to decode for white background first, and if there is no decode, will then attempt to decode for black background. 6-41 MS-4Xi Imager User’s Manual...
Page 152
Background Color 6-42 MS-4Xi Imager User’s Manual...
Page 153
This section includes instructions on setting up conditions for changing input/output electrical transitions for control of the imager’s internal and external devices. A discrete I/O (in/out) signal is an electrical transition from one voltage level to another so that digital switching can occur. MS-4Xi Imager User’s Manual...
I/O Parameters by ESP Click the Parameters button and then the I/O tab. To change a setting, double-click the setting and use your cursor to scroll through the options. To open nested options, single-click the +. MS-4Xi Imager User’s Manual...
Definition: With Mismatch enabled, the imager transmits symbol data whenever the symbol data information does NOT match the master symbol. Note: A No Read can still be transmitted if Enabled. MS-4Xi Imager User’s Manual...
Page 157
It’s typically used in tracking applications in which each object is uniquely identified. Definition: With Good Read enabled, the imager transmits symbol data on any good read regardless of Matchcode Type setting. Note: A No Read can still be transmitted if Enabled. MS-4Xi Imager User’s Manual...
Enabling End of Read Cycle means that symbol data does not get sent to the host until the read cycle ends with a timeout or new trigger. End of read cycle Start of read cycle Read cycle duration Host This is when host activates trigger expects output MS-4Xi Imager User’s Manual...
Note: No Read Message will only be transmitted if Symbol Data Output is set to Match, Mismatch, or Good Read. No Read Message can be set to any ASCII character. Important: The ASCII characters <, >, and can only be entered as hex pairs: For <: <K714h,,3C> For >: <K714h,,3E> <K714h,,2C> MS-4Xi Imager User’s Manual...
Output Indicators Output Indicators The MS-4Xi has a beeper and three LED arrays, as follows: 1. A target pattern of blue LEDs for centering the field of view, which is projected from the front of the imager . 2. An array of green LEDs projected from the front of the imager that can be programmed to flash in response to user-defined conditions.
Page 161
Green flash LEDs will act as an illumination strobe for image capture. If it is required that the green flash LEDs be the only illumination for image capture, then the internal illumination LEDs can be disabled. MS-4Xi Imager User’s Manual...
Page 162
The target pattern will remain OFF except during the read cycle. If the EZ button or operational command overrides this setting, the target pattern will remain on at all times. Always ON The target pattern is always ON. 7-10 MS-4Xi Imager User’s Manual...
When a good read occurs, the green LEDs will illuminate and stay on for the time set in the Green Flash Duration value. Serial Cmd: <K750,green flash mode,target pattern status,green flash duration> Default: (1 second) Options: 0 to 65535 (in 10 ms increments) 7-11 MS-4Xi Imager User’s Manual...
Note: The beeper will also sound at any of the following times: • When the imager is defaulted. • When a send/save command is sent from ESP. • At the conclusion of a calibration procedure. • When a <Z>, <Zp>, <Zrd>, or <K701,,1> command is sent. 7-12 MS-4Xi Imager User’s Manual...
Only one bad field needs to be found in order to activate the 5 beep response. Serial Cmd: <K701,serial command echo status,serial command beep status, control/hex output> Default: Disabled Options: 0 = Disabled 1 = Enabled 7-14 MS-4Xi Imager User’s Manual...
Page 167
When set to Control, two characters are transmitted to represent a non-displayable character. For example, a carriage return will be shown as: ^M. Serial Cmd: <K701,serial command echo status,serial command beep status,control/hex output> Default: Control Options: 0 = Control 1 = Hex 7-15 MS-4Xi Imager User’s Manual...
In this configuration, the EZ button will unlatch any logic outputs that have been latched. Parameter Switch The parameter switch toggles between custom defaults and power-on settings. The condition is the same as that achieved by sending the <Arc> <Arp> commands consecutively. 7-16 MS-4Xi Imager User’s Manual...
Page 169
Save for Power-On Definition: If enabled, after calibration is complete, all parameters will be saved for power-on. Serial Cmd: <K770,global status,default on power-on,load Configuration Database, save for power-on> Default: Disabled Options: 0 = Disabled 1 = Enabled 7-17 MS-4Xi Imager User’s Manual...
Load New Master Functions in the same way as new master pin input whenever the associated button position is selected. The new master pin’s Consecutive Decode requirement holds true for this function. 7-18 MS-4Xi Imager User’s Manual...
Hold down button until three quick beeps are heard (and the 20%, 40%, and 60% LEDs illuminate). Four Beeps (Position #4) Hold down button until four quick beeps are heard (and the 20%, 40%, 60%, and 80% LEDs illuminate). 7-19 MS-4Xi Imager User’s Manual...
Activates a discrete output whenever the symbol data does not match that of the master symbol. No Read Activates a discrete output whenever the symbol data is not decoded before the end of the read cycle. 7-20 MS-4Xi Imager User’s Manual...
Page 173
Typically used when a discrete indication of a diagnostic condition is needed. Definition: Activates discrete output when a diagnostic warning condition is met, depending on the diagnostic option enabled. In Read Cycle Definition: Activates a discrete output when the imager is in a read cycle. 7-21 MS-4Xi Imager User’s Manual...
The programmable output is active when the Output On condition has been met and is held active until a new read cycle begins. Note: All of the Output On modes are inhibited when any Output on Warning is active for Output 1. 7-22 MS-4Xi Imager User’s Manual...
Trigger Evaluation Period= 25 triggers (read cycles) Number to Output On = 4 In this example, the imager will activate an output when 4 No Reads occur within a period of 25 triggers (read cycles). 7-23 MS-4Xi Imager User’s Manual...
Number to Output On within the trigger window selected in Number of Triggers. Decodes per Trigger Output will be activated when the number of decodes equals the value entered for Number to Output On within the trigger window selected in Number of Triggers. 7-24 MS-4Xi Imager User’s Manual...
Enabling this setting will also append the decode count to the symbol data. Serial Cmd: <K780,trend analysis mode,trigger evaluation period,number to output on, decodes per trigger threshold> Default: Options: 0 to 65535 7-25 MS-4Xi Imager User’s Manual...
If enabled, toggles Output 1 to an active state when Print Growth Threshold is met. Serial Cmd: <K800,output on symbol contrast,symbol contrast threshold,output on print growth,print growth threshold,output on axial non-uniformity,axial non-uniformity threshold,output on UEC,UEC threshold> Default: Disabled Options: 0 = Disabled 1 = Enabled 7-26 MS-4Xi Imager User’s Manual...
<K800,output on symbol contrast,symbol contrast threshold,output on print growth,print growth threshold,output on axial non-uniformity,axial non-uniformity threshold,output on UEC,UEC threshold> Default: Grade C Options: 0 = Grade A 1 = Grade B 2 = Grade C 3 = Grade D 7-28 MS-4Xi Imager User’s Manual...
This condition will only be held for one service timer click. Note: This feature cannot be used if the imager is in a Continuous Read mode. Serial Cmd: <K790,unused 1,service unit> Default: Options: 0 = Disabled 1 = Enabled 7-29 MS-4Xi Imager User’s Manual...
UEC,UEC threshold> Diagnostics Output 2 Note: Output On under Output 2 Parameters must be set to Diagnostic Warning for this output to function. Serial Cmd: <K791,unused 1,service unit> 7-30 MS-4Xi Imager User’s Manual...
UEC,UEC threshold> Diagnostics Output 3 Note: Output On under Output 3 Parameters must be set to Diagnostic Warning for this output to function. Serial Cmd: <K792,unused 1,service unit> 7-31 MS-4Xi Imager User’s Manual...
Power-On Flash Saves Serial Cmd: <K406,power-on,resets,power-on saves,power-on flash saves> Power-On Flash Saves uses a 16-bit counter that increments each time an imager setting is saved to the customer parameter section of flash memory with a <Zc> command. 7-32 MS-4Xi Imager User’s Manual...
Hours uses a 16-bit counter that increments every 60 minutes. Minutes Serial Cmd: <K407,hours,minutes> Default: 16-bit counter (0 to 60) Minutes uses a 16-bit counter that increments every 60 seconds. Note: Time counts are reset at power-on, but not with an <A> <Z> command. 7-33 MS-4Xi Imager User’s Manual...
The validation separator is located between the end of the already formatted data and the first coordinate point. The point with the lowest X + Y sum will be output first, followed by the next three points in a clockwise direction. Example: (032,040)(287,056)(287,279)(048,271) 7-35 MS-4Xi Imager User’s Manual...
If a No Read condition or a Good Read condition occurs, the first image of either kind will be output. Mismatch If a Good Read occurs during the read cycle but the image is a Mismatch condition, the first Mismatch image will be output. 7-36 MS-4Xi Imager User’s Manual...
This setting determines the quality of JPEG image compression. The user may select a value from 1 (lowest) to 100 (highest). Serial Cmd: <K739,image output mode,communication port,file format,JPEG quality> Default: Options: 1 to 100 (percent) 7-37 MS-4Xi Imager User’s Manual...
Page 190
Good Read Output Frame: None Number of Symbols: Frame # 1: No Read Frame # 2: No Read Frame # 3: Good Read, Symbol # 1 Read Cycle Result: No Read Output Frame: Frame # 1 7-38 MS-4Xi Imager User’s Manual...
The separator character separates the symbol data from the database identifier. Usage: Serial Cmd: <K759,status,separator> Default: <space> Options: Any ASCII character. Important: The ASCII characters <, >, and can only be entered as hex pairs: For <: <K759h,,3C> For >: <K759h,,3E> <K759h,,2C> 7-39 MS-4Xi Imager User’s Manual...
When the read cycle ends, the imager outputs any decoded symbol data along with the decodes per trigger count. Serial Cmd: <K704,separator,decodes per trigger status> Default: Options: 0 = Disabled 1 = Enabled 7-40 MS-4Xi Imager User’s Manual...
Help menu in EZ Trax software, or the EZ Trax Quick Start Guide, available on the Microscan Tools Drive. Configuring EZ Trax Output by ESP To configure EZ Trax using ESP, first click the I/O tab in App Mode to display the I/O Parameters tree control. 7-41 MS-4Xi Imager User’s Manual...
Comm Port Selects the communication port that will be used to transfer image files. Image Mode Determines which read cycle condition triggers image file output. Image Format Selects the format of the image output file. 7-42 MS-4Xi Imager User’s Manual...
Page 195
If a symbol is decoded during an image capture, the symbol type and other supplementary symbol information is also included. Grade Output Symbol quality information will be output in the form of an abbreviated identifier for each read cycle. 7-43 MS-4Xi Imager User’s Manual...
Page 196
2 = No Read 3 = No Read and Good Read 4 = Mismatch Good Read Outputs the first Good Read image in the read cycle. The image file will immediately follow the symbol data. 7-44 MS-4Xi Imager User’s Manual...
Page 197
Sets the amount of JPEG image compression. A value of 1 represents the highest compression and lowest image quality, and 100 represents the lowest compression and highest image quality. Serial Cmd: <K757,status,comm port,image mode,image format,JPEG quality,object info output, grade output> Default: Options: 1 to 100 (percent) 7-45 MS-4Xi Imager User’s Manual...
Page 198
Symbol quality information will be output in the form of an abbreviated identifier for each read cycle. Serial Cmd: <K757,comm port,image mode,image format,JPEG quality,object info output, grade output> Default: Disabled Options: 0 = Disabled 1 = Enabled 7-46 MS-4Xi Imager User’s Manual...
Page 199
ISO/IEC 16022 Symbol Quality Output..................8-10 ISO/IEC 16022 Symbol Quality Output by ESP................8-12 Microscan Symbol Quality Output ....................8-13 Microscan Symbol Quality Output by ESP ................. 8-16 This section describes parameters that, when enabled, will output detailed symbol quality evaluations.
Symbol Quality by ESP Click the Parameters button and then the Symbol Quality tab. To open nested options, single-click the +. To change a setting, double-click the setting and use your cursor to scroll through the options. MS-4Xi Imager User’s Manual...
Symbol Quality parameters are separated into ISO/IEC 16022 Symbol Quality Output and Microscan Symbol Quality Output. Total Read Time, Symbol Quality Separator, and Output Mode are common to both ISO/IEC 16022 and Microscan Grading Parameters. The enabled Symbol Quality parameters are...
Page 203
Report buttons. The Symbol Quality interface is divided into three sections: Report, Locate, and Preferences. The imager’s field of view is shown here. When grading is completed, the initial report is also shown in this viewing area. MS-4Xi Imager User’s Manual...
Page 204
Click the Calibrate Click the Locate button to optimize button to display the camera settings. symbol in the imager’s field of view. MS-4Xi Imager User’s Manual...
Page 205
Bitmap or JPEG image file. Enables ESP to parse UII symbol data into the correct fields and output order defined by the U.S. Department of Defense IUID initiative. Returns all settings to Returns all settings to default. most recent. MS-4Xi Imager User’s Manual...
Symbol Quality Separator/Data Matrix Output Mode Symbol Quality Separator/Data Matrix Output Mode Symbol Quality Separator applies to both Symbol Quality groups: ISO/IEC 16022 Symbol Quality Output and Microscan Symbol Quality Output. Symbol Quality Separator Definition: Inserts a separator between each enabled field of the symbol quality output.
Page 207
0 = Grade 1 = Value Grade If in Grade Mode, a grade (A,B,C,D) is appended to the symbol data. Value If in Value Mode, the calculated value for the given parameter is appended to the symbol data. MS-4Xi Imager User’s Manual...
If enabled, the print growth is appended to the symbol data according to the ISO/IEC 16022 Symbol Quality Output Mode setting. Serial Cmd: <K709,symbol contrast,print growth,axial non-uniformity,UEC> Default: Disabled Options: 0 = Disabled 1 = Enabled 8-10 MS-4Xi Imager User’s Manual...
Page 209
If enabled, the UEC is appended to the symbol data according to the ISO/IEC 16022 Symbol Quality Output Mode setting. Serial Cmd: <K709,symbol contrast,print growth,axial non-uniformity,UEC> Default: Disabled Options: 0 = Disabled 1 = Enabled 8-11 MS-4Xi Imager User’s Manual...
Symbol Quality view, in a format similar to the one shown below. If you want to view the results in a report format, click the Save Report button. The report will be output in the format you chose in the Preferences dialog. 8-12 MS-4Xi Imager User’s Manual...
When enabled, the locate time is appended to the symbol data. Serial Cmd: <K710,percent cell damage,total read time,capture time,locate time,decode time,pixels per element,ECC level,matrix size,quiet zone,symbol angle> Default: Disabled Options: 0 = Disabled 1 = Enabled 8-13 MS-4Xi Imager User’s Manual...
When enabled, the matrix size value is appended to the symbol data. Serial Cmd: <K710,percent cell damage,total read time,capture time,locate time,decode time,pixels per element,ECC level,matrix size,quiet zone,symbol angle> Default: Disabled Options: 0 = Disabled 1 = Enabled 8-14 MS-4Xi Imager User’s Manual...
Page 213
Data Matrix symbol’s L-shaped finder pattern relative to the imager. Serial Cmd: <K710,percent cell damage,total read time,capture time,locate time,decode time,pixels per element,ECC level,matrix size,quiet zone,symbol angle> Default: Disabled Options: 0 = Disabled 1 = Enabled 8-15 MS-4Xi Imager User’s Manual...
Microscan Symbol Quality Output by ESP Microscan Symbol Quality Output by ESP ESP’s Symbol Quality interface allows you to evaluate Data Matrix symbols for compliance with a rigorous set of standards, such as Locate Time, Capture Time, and Decode Time.
Page 215
Matchcode Serial Commands ...................... 9-3 Overview of Matchcode ........................ 9-4 Matchcode Type ........................... 9-5 Match Replace..........................9-10 Mismatch Replace ........................9-11 New Master Pin .......................... 9-12 This section explains the MS-4Xi’s matchcode output functions and the master symbol database setup. MS-4Xi Imager User’s Manual...
Matchcode by ESP Matchcode by ESP Click the Parameters button and then the Matchcode tab. To open nested options, single-click the +. To change a setting, double-click the setting and use your cursor to scroll through the options. MS-4Xi Imager User’s Manual...
Enter Master Symbol Data <K231,master symbol number,master symbol data> Request Master Symbol Data <K231?,>[for all] or <K231?,master symbol number> Delete Master Symbol Data <K231,master symbol number,> Match Replace <K735,status,match replacement string> Mismatch Replace <K736,status,mismatch replacement string> MS-4Xi Imager User’s Manual...
<M231,master symbol#, data>. c. Send a <G> (Read Next Symbol as Master Symbol) command. d. Enable the New Master Pin command and activate the discrete input to store the next symbol read as the master symbol. MS-4Xi Imager User’s Manual...
Instructs the imager to sequence after each match (numeric only) and compare symbols or portions of symbols for sequential numbers. Note: If Matchcode Type is set to Sequential, the imager will behave as if Number of Symbols were set to 1, regardless of the user-defined configuration. MS-4Xi Imager User’s Manual...
Match Start Position is set to 1 or greater. When Match Start Position is set to 0, no comparison will occur. Serial Cmd: <K223,matchcode type,sequential matching,match start position,match length,wild card character,sequence on No Read,sequence on mismatch> Default: Options: 1 to 3000 MS-4Xi Imager User’s Manual...
<K223,matchcode type,sequential matching,match start position,match length,wild card character,sequence on No Read,sequence on mismatch> Default: (asterisk) Options: Any ASCII character. Important: The ASCII characters <, >, and can only be entered as hex pairs: For <: <K223h,,,,,3C> For >: <K223h,,,,,3E> <K223h,,,,,2C> MS-4Xi Imager User’s Manual...
Page 222
As an example of Sequence on No Read Disabled, consider the following series of decodes: Master Symbol Decoded Symbol Master Symbol after Decode No Read 003 (not sequenced) No Read 004 (not sequenced) No Read 004 (not sequenced) MS-4Xi Imager User’s Manual...
007 (sequenced on mismatch) As an example of Sequence on Mismatch Disabled, consider the following decodes: Master Symbol Decoded Symbol Master Symbol after Decode 004 (sequenced because of previous match) 006 (sequenced because of previous match) 006 (not sequenced) MS-4Xi Imager User’s Manual...
Serial Cmd: <K735,status,replacement string> Default: MATCH Options: An ASCII string up to 64 characters. Important: The ASCII characters <, >, and can only be entered as hex pairs: For <: <K735h,,3C> For >: <K735h,,3E> <K735h,,2C> 9-10 MS-4Xi Imager User’s Manual...
Serial Cmd: <K736,status,replacement string> Default: MISMATCH Options: An ASCII string up to 64 characters. Important: The ASCII characters <, >, and can only be entered as hex pairs: For <: <K736h,,3C> For >: <K736h,,3E> <K736h,,2C> 9-11 MS-4Xi Imager User’s Manual...
1, and prior to reading and effectively loading position 1, the response to <NEWM> would be <NEWM/1>. Once a symbol has been read and loaded, the status will be cleared: <NEWM/0>. Serial Cmd: <NEWM> 9-12 MS-4Xi Imager User’s Manual...
Camera and IP Setup by ESP Click the Setup button to bring up the Camera Setup menu. To change a setting, double-click the setting and use your cursor to scroll through the options. To open nested options, single-click the +. 10-2 MS-4Xi Imager User’s Manual...
The focal distance value is displayed just below the icon. When enabled, shows the Symbol data and symbol in higher contrast Test results are than the default contrast shown in this field. value. 10-4 MS-4Xi Imager User’s Manual...
1 and 100, 1 being the lowest quality and 100 being the highest. When possible, use the highest quality; when image transfer speed must be increased, use a lower image quality setting. Adjustments for this setting will depend on your specific hardware and software limitations. 10-5 MS-4Xi Imager User’s Manual...
Page 232
The image will be surrounded by an “area of interest box”, a dashed blue line with red anchor points that can be selected and moved by placing a cursor inside the box, and can be resized by clicking and dragging the anchor points. 10-6 MS-4Xi Imager User’s Manual...
(in terms of black-to-white) are updated in the Pixel Info table to the left of the graph (237 in this example). In addition, a horizontal dashed red line is displayed that indicates the average value. 10-7 MS-4Xi Imager User’s Manual...
Calibration for full documentation of this feature. ESP’s Calibration interface shown ESP’s Calibration interface shown during a calibration routine after a calibration routine 10-8 MS-4Xi Imager User’s Manual...
Window of Interest. Caution: Window of Interest will shrink the field of view and therefore could cause symbols to be missed in dynamic applications. 10-9 MS-4Xi Imager User’s Manual...
Page 236
One possible downside is that the chance of missing a symbol increases with the smaller window. Always verify that your WOI will be large enough to allow for any random movement of symbols in your field of view. 10-10 MS-4Xi Imager User’s Manual...
Page 237
3 to (480 - row pointer) Width (Column Width) Definition: Defines the column position of the upper-left starting point of the window. Serial Cmd: <K516,row pointer,column pointer,row depth,column width> Default: Options: 8 to (640 - column pointer) 10-11 MS-4Xi Imager User’s Manual...
Configuration Database for full documentation of this feature. Configuration Database view, set for 5 Active Indexes, with Capture Settings highlighted 10-12 MS-4Xi Imager User’s Manual...
An external trigger is used to activate image captures so the user can make timing adjustments as capture events occur. 10-13 MS-4Xi Imager User’s Manual...
X-Mode™ X-Mode™ The MS-4Xi is equipped with powerful X-Mode™ technology, which provides industry-leading decode performance on both printed and direct part mark symbols, with minimum configuration required out of the box. The X-Mode algorithm identifies symbol candidates within the imager’s field of view and uses sophisticated image processing to decode valid symbols.
Since the resolution of the output image is reduced, the frame rate will increase, but not by the factor of the image reduction. This is due to the overhead time of digital pixel data processing and minimum row time requirements of the image sensor. 10-15 MS-4Xi Imager User’s Manual...
Page 242
Pixel Sub-Sampling AEC/AGC Mode Note: AEC/AGC Mode is only applicable to the High Speed version of the MS-4Xi. Definition: AEC/AGC Mode (Automatic Exposure Control/Automatic Gain Control Mode) maintains optimal self-adjusting exposure and gain settings. This ensures that acquired images fall in a desirable region of the camera’s sensitivity range for optimal image luminance.
Camera Settings are typically obtained during the calibration process, and do not necessarily need to be modified directly by the user. Optics The MS-4Xi Imager has two different optical configurations available: Standard Density and Low Density. Determine the optics of your Imager and find the corresponding camera values in the following sections.
Page 244
Camera Settings MS-4Xi Low Density (SD Optics), 4” Focal Distance Shutter Speed Usage: Faster shutter speeds reduce blurring in faster applications. Slower shutter speeds are useful in slower applications and lower contrast applications. Definition: This value sets the exposure or integration time for the image sensor pixels.
Camera and IP Setup Focal Distance Definition: This command returns the Imager’s factory preset focal distance. Serial Cmd: <K525,focal distance (read only)> Default: Standard Density = (3”) Low Density = (4”) Options: 10-19 MS-4Xi Imager User’s Manual...
When Regular Image is enabled, images will be processed as they appear upon capture. Mirrored Image When Mirrored Image is enabled, images will be processed as a reverse of the captured image. Both When Both is enabled, regular and mirrored images will be processed. 10-21 MS-4Xi Imager User’s Manual...
When set to Constant, the illumination is the same as the Medium setting. However, the LEDs will always be on during a read cycle and will only be off between read cycles. This cuts down on perceptible LED flashing. 10-22 MS-4Xi Imager User’s Manual...
Camera and IP Setup Skew Correction Note: Skew Correction does not apply to the High Speed version of the MS-4Xi, which has a global shutter. The MS-4Xi’s CMOS image sensor has a “rolling shutter” mechanism that controls pixel integration row-by-row, unlike a global shutter,...
Page 250
Note that the amount of distortion will not be changed, because the object will have traveled the same distance during the read-out of the target area. 10-24 MS-4Xi Imager User’s Manual...
Page 251
• Images are corrected before they are processed. Therefore, if an image is still pending at the end of the read cycle, it will not have been skew-corrected. 10-25 MS-4Xi Imager User’s Manual...
Important: This command must be set to Enabled for Morphological Operation to function. Serial Cmd: <K550,morphological pre-processing> Default: Disabled Options: 0 = Disabled 1 = Enabled 10-26 MS-4Xi Imager User’s Manual...
Erode increases the dark cell size of a symbol. Useful for increasing the dark cell size of a dark-on-light Data Matrix symbol. Dilate Dilate increases the light cell size of a symbol. Useful for increasing the light cell size of a light-on-dark Data Matrix symbol. 10-27 MS-4Xi Imager User’s Manual...
Page 254
Open removes minor light defects of dark cells by performing a Dilate function followed by an Erode function. Close Close removed minor dark defects of light cells by performing an Erode function followed by a Dilate function. 10-28 MS-4Xi Imager User’s Manual...
Page 255
(measured in pixels) in which the morphological operation is being performed. Serial Cmd: <K551,0,morphological operation,operator size> Default: Small Options: 3 = Small (3 pixels by 3 pixels) 5 = Medium (5 pixels by 5 pixels) 7 = Large (7 pixels by 7 pixels) 10-29 MS-4Xi Imager User’s Manual...
Page 257
Request Selected Index Settings ..................... 11-17 Request All Configuration Database Settings ................11-18 This section concerns the various capture settings and processing settings that can be used to fine-tune the MS-4Xi’s performance in your application. 11-1 MS-4Xi Imager User’s Manual...
Configuration Database Status depth,column width,narrow margins,background color,symbology> Save Current Settings to Database <K255+,index> Load Current Settings from Database <K255-,index> Request Selected Index Settings <K255?,index> Request All Database Settings <K255?> <K256,switch mode,frame count/time,image process Database Mode looping,image dimensions> 11-2 MS-4Xi Imager User’s Manual...
(0 to 10). Sort Index Positions on Good Reads moves the database entry that produces the first successful decode to the top of the list. 11-3 MS-4Xi Imager User’s Manual...
Region of Interest setup. There is no benefit to sub-sampling to increase processing speed when ROI is configured, because the frame size would need to be increased to make sub-sampling possible. 11-4 MS-4Xi Imager User’s Manual...
Page 261
Region of Interest, depending on the image dimension mode selected in the Database Mode command. Serial Cmd: <K255,index,shutter speed,gain,sub-sampling,row pointer,column pointer,row depth,column width,threshold mode,fixed threshold value,processing mode,narrow margins,background color,symbology type> Default Options: 8 to (640-column pointer) 11-5 MS-4Xi Imager User’s Manual...
Page 262
1 = Enabled 2 = 2D Enhanced Background Color Serial Cmd: <K255,index,shutter speed,gain,sub-sampling,row pointer,column pointer,row depth,column width,threshold mode,fixed threshold value,processing mode, narrow margins,background color,symbology type> Default: Both Options: 0 = White 1 = Black 2 = Both 11-6 MS-4Xi Imager User’s Manual...
Page 263
ECC level has been configured, the imager will not decode Data Matrix symbols. QR Code (Add 4) If enabled, QR Code will be active for this database index. Code 128 (Add 8) If enabled, Code 128 will be active for this database index. 11-7 MS-4Xi Imager User’s Manual...
Page 264
Important: If the stacked and non-stacked operation is required, the DataBar Expanded command must be configured as follows: <K484,2>. If the DataBar Expanded status parameter in the <K484> command is set to either DISABLED or ENABLED, the imager will only read non-stacked DataBar Expanded symbols. 11-8 MS-4Xi Imager User’s Manual...
Page 265
If enabled, Micro QR Code will be active for this database index. Aztec Code (Add 131072) If enabled, Aztec Code will be active for this database index. Postal Symbologies (Add 262144) If enabled, Postal Symbologies will be active for this database index. 11-9 MS-4Xi Imager User’s Manual...
Indicates the Number of Image Frames that must be captured or the amount of Time that must transpire before the imager will load the next database index entry. Serial Cmd: <K256,switch mode,frame count/time,image process looping,image dimensions> Default: (frames/ms) Options: 1 to 65535 11-10 MS-4Xi Imager User’s Manual...
Page 267
For example, if all database entries contained the same camera setting values but had different IP and decode parameters, an image frame would only be captured when the first database configuration was used. 11-11 MS-4Xi Imager User’s Manual...
Page 268
Camera settings (Capture Index, Shutter Speed, Gain, Sub-Sampling) located in the left half of the highlighted area. Image capture dimensions (Row Pointer, Column Pointer, Row Depth, Column Width) located in the right half of the highlighted area. 11-12 MS-4Xi Imager User’s Manual...
Page 269
IP and decode settings. Also, if this feature is used in conjunction with Output Filtering, multiple decoded symbols in a captured image frame can be output according to their location in the field of view. 11-13 MS-4Xi Imager User’s Manual...
Page 270
IP and decode settings, and they determine the region or area of the captured image to be processed. Threshold Mode, Fixed Threshold Value, Processing Mode, Narrow Margins, Background, and Code Type are all Processing Settings values. 11-14 MS-4Xi Imager User’s Manual...
This command phrase saves the imager’s current, active configuration settings to database index 5. Save Current Settings to Configuration Database by ESP Click the Load Current to Index button to save the Imager’s current configuration parameters to the selected database index. 11-15 MS-4Xi Imager User’s Manual...
• Data Matrix ECC level is determined by the current settings and not by database settings. Therefore, the database does not know which ECC level to enable, and has no effect on current Data Matrix ECC settings. 11-16 MS-4Xi Imager User’s Manual...
Configuration Database Request Selected Index Settings Definition: Returns configuration settings for the selected database index. Serial Cmd: <K255?,index> Example: <K255?,5> This command phrase returns the configuration settings for database index 5. 11-17 MS-4Xi Imager User’s Manual...
Request All Configuration Database Settings Request All Configuration Database Settings Definition: Returns configuration settings for all indexes in the Configuration Database. Serial Cmd: <K255?> Example: <K255?> This command phrase returns the configuration settings for all 10 database indexes. 11-18 MS-4Xi Imager User’s Manual...
Page 275
12 Terminal Contents Terminal Window........................12-2 Find ............................12-3 Send ............................12-4 Macros............................12-5 Terminal Window Menus......................12-6 This section describes the Terminal window and macro functions in ESP. 12-1 MS-4Xi Imager User’s Manual...
Send text field. The Terminal screen also displays symbol data or information from the imager. You can also right-click on the Terminal screen to bring up a menu of further options. 12-2 MS-4Xi Imager User’s Manual...
1. Type “ABC” into the Find box. 2. Press Enter. The first instance of “ABC” will be highlighted in the Terminal window. 3. Click the Find button to the left of the text field to locate additional instances of “ABC”. 12-3 MS-4Xi Imager User’s Manual...
The Send function allows you to enter serial commands and then send them to the imager. 1. Type the command into the Send box. 2. Press Enter. 3. Click the Send button to the left of the text field to send . 12-4 MS-4Xi Imager User’s Manual...
When you click the arrow next to any macro and select Edit, the following appears: You can edit an existing macro or type in the Macro Name text field and define it in the Macro Value text field. Click OK. 12-5 MS-4Xi Imager User’s Manual...
• Find Next searches for a user-defined section of text in the Terminal. • Find Previous operates in the same way as Find Next, but searches backward through Terminal text. 12-6 MS-4Xi Imager User’s Manual...
Page 281
Serial utility commands are not prefaced with a “K” and a numeric code, nor do they require an initialization command (<A> and <Z>). They can be entered from within any terminal program or from ESP’s Terminal or Utilities windows. 13-1 MS-4Xi Imager User’s Manual...
<H> Enable Imager <a1> Include PDF Information in Preamble (PDF417) <A> Reset (does not save for power-on) <Ard> Reset and Recall Microscan Defaults Default/Reset/Save <Arp> Reset and Recall Power-On Parameters <Arc> Reset and Recall Customer Default Parameters <Z> Save Current Settings for Power-On 13-2 MS-4Xi Imager User’s Manual...
Page 283
Utilities Save Current Settings as Customer Default <Zc> Parameters for Power-On Recall Microscan Default Parameters and Save Default/Reset/Save <Zrd> for Power-On Recall Customer Default Parameters and Save <Zrc> for Power-On <?> Imager Status Byte <K?> All Status Request <K??> All Descriptor Status Request...
(the Start button becomes a Stop Read Rate information is displayed in button during an active Read Rate test.) the lower portion of the Utilities view. Serial commands can also be sent to the imager from this screen. 13-4 MS-4Xi Imager User’s Manual...
Page 285
Enter Percent Test Sending <Cp> instructs the imager to transmit the percentage of decodes and any decoded symbol data. End Read Rate Test Sending <J> ends both the Percent test and the Decodes/Second test. 13-5 MS-4Xi Imager User’s Manual...
Click the Request button to display the appropriate count or Clear to set the counter to zero. Trigger, Good Read, No Read, and Mismatch counters can be requested and cleared simultaneously (Request All and Clear All buttons) or individually (Request and Clear buttons to the left of each item). 13-6 MS-4Xi Imager User’s Manual...
Match Counter to 00000. Mismatch Counter Sending <X> displays the number of decoded symbols since the last reset that do not match the master symbol. Mismatch Counter Reset Sending <Y> sets the Mismatch Counter to zero. 13-7 MS-4Xi Imager User’s Manual...
Disabling the imager will not affect any commands that have already been downloaded. Enable Reader Sending <H> will turn the imager ON and allow it to enter read cycles. 13-8 MS-4Xi Imager User’s Manual...
• Click Send and Save to send the settings to the imager and save them, or Send to Reader to send the settings without saving them. Important: To use Differences from Default, connect to the imager and Receive Reader Settings via the Send/Recv button on the toolbar. 13-9 MS-4Xi Imager User’s Manual...
Loads the next symbol decoded Set Master Symbol into the selected index. Database Size here. Saves the database to the imager. Loads the imager’s saved master symbols into ESP. Double-click a row to enter data into popup text box. 13-10 MS-4Xi Imager User’s Manual...
The table below specifies the maximum number of characters available to each symbol according the number of master symbols defined, from 1 to 10. Master Symbol Maximum Master Symbol Maximum Number Characters Number Characters 3000 1500 1000 # 10 13-11 MS-4Xi Imager User’s Manual...
3. Double-click on each symbol number you want to set up and copy, or type your data in the popup dialog and click OK. 4. When all your data has been entered, click the Send Database to the Reader button. 13-12 MS-4Xi Imager User’s Manual...
1. Click the Utilities button and the Master Database tab. 2. Click the Receive Reader’s Database button. Request All Master Symbol Data Definition: This command will return master symbol data for all symbols enabled (up to 10). Serial Cmd: <K231?> 13-13 MS-4Xi Imager User’s Manual...
Serial Cmd: <NEWM> The imager returns: <NEWM/next master to load> Once a symbol has been read and loaded, the status will be cleared and the response will be <NEWM/0>. (See also New Master Pin in Matchcode.) 13-14 MS-4Xi Imager User’s Manual...
For example, to delete master symbol # 5, send the following: <K231,5,>. The command is entered with a blank master symbol data field, which tells the imager to delete the selected master symbol from the database. 13-15 MS-4Xi Imager User’s Manual...
Caution: Do not interrupt power or disconnect the host cable while download is in prog- ress. Be sure that each download is complete before moving on to the next. Important: When updating firmware, be sure that the application code and boot code versions are mutually compatible. 13-16 MS-4Xi Imager User’s Manual...
(a request for the application code part number), the imager returns: <#a/APP_P/N>. • When you send <#b> (a request for the boot code part number), the imager returns: <#b/BOOT_P/N>. • When you send <#p> (a request for profile module part numbers), the imager returns: <#p/PROFILE_P/N>. 13-17 MS-4Xi Imager User’s Manual...
Page 298
(a request for the application code checksum), the imager returns: <!a/APP_CHECKSUM> • When you send <!b> (a request for the boot code checksum), the imager returns: <!b/BOOT_CHECKSUM> • When you send <!p> (a request for profile module checksum), the imager returns: <!p/PROFILE_CHECKSUM> 13-18 MS-4Xi Imager User’s Manual...
<Arp> command is issued. Defaults Defaults are Microscan firmware settings or saved customer settings that can be recalled, either by software or hardware reset. 13-19 MS-4Xi Imager User’s Manual...
Page 300
By first doing an EZ button default or hardware default to restore the known Microscan defaults, the user can then recall the previous customer- saved settings with an <Arc>...
All Range Status Request This request will return the current settings of all commands within the user-defined range, starting with the lowest user-defined K command value and ending with the highest user-defined K command value. 13-21 MS-4Xi Imager User’s Manual...
This request will return the value range and storage type description of all fields in the requested K command. <Knnn?*> Display Command Wildcard This request will return the individual K command status, description, and range for each parameter. 13-22 MS-4Xi Imager User’s Manual...
• A MS-4Xi in a Learned state has not been saved. Cycling power will remove any Learned state information and the imager will power-on in its configured state. • A MS-4Xi is saved in a Learning state. The imager will power-on in the Learning state and will learn the first Data Matrix symbol decoded.
All files in “root” directory /saved All files in “saved” directory All files in all directories /del Deletes all files in the root director /saved/del Deletes all files in the saved directory del*.* Deletes files in all directories 13-24 MS-4Xi Imager User’s Manual...
Once Bar Code Configuration Mode has been entered, the Data Matrix symbols can be thought of as serial data. You can configure the imager by printing labels in Microscan’s serial command format. Commands are processed as if the data were streamed in through the serial port.
Page 306
Other Operational Serial Commands 13-26 MS-4Xi Imager User’s Manual...
Format Assign ..........................14-4 Format Extract..........................14-5 Format Insert ..........................14-7 Output Filter Configuration ......................14-9 Number of Filters........................14-14 This section explains how to control the formatting and filtering of decoded symbol data for output. 14-1 MS-4Xi Imager User’s Manual...
Output Format Serial Commands Format Extract <K740,output index,start location,length> Format Insert <K741,output index,length,hex string> Format Assign <K742,symbol number,status> Format Status <K743,output format status> <K744,filter number,symbology,length,wildcard,placeholder Output Filter Configuration data,unused,database index> Ordered Output Filter <K745,number of filters> 14-2 MS-4Xi Imager User’s Manual...
When Output Format Status is set to Enabled, output formatting is enabled. However, Format Assign, Format Insert, and Format Extract must be properly set up as well. Output Format Status by ESP On the Output Format tab, check the Enable Output Format box. 14-3 MS-4Xi Imager User’s Manual...
Use the Set Number of Symbols spin box to determine the number of symbols to be included in the output phrase. Then check the Parse boxes beneath the symbols that you wish to format for user-defined output. 14-4 MS-4Xi Imager User’s Manual...
Defines the length (in consecutive characters) that will be extracted and placed in user-defined output. Serial Cmd: <K740,output index,start location,length> Default: (disabled; end of format cell array) Options: 1 to n (maximum number of characters in the symbol data). 14-5 MS-4Xi Imager User’s Manual...
Parse dialog shows the selected character positions extracted and output as desired. Simultaneously, the data string from the selected symbol is displayed at the bottom left of the Parse Table, followed by the user-defined extracted output. 14-6 MS-4Xi Imager User’s Manual...
8 hex characters per insertion per database entry. Serial Cmd: <K741,output index,length,hex string> Default: (00 in hex) Options: 00 to FF (As many as 4 bytes, or hex pairs.) 14-7 MS-4Xi Imager User’s Manual...
The Insert process is very similar to the Extract process, except that Insert allows the user to enter characters using the Insert calculator (shown above). Notice that Extract and Insert share the same Parse Table. 14-8 MS-4Xi Imager User’s Manual...
No Read message will be output in place of the symbol (assuming the No Read message is enabled). For example, if there is not a symbol that meets filter 3’s requirements, then a No Read message will be output in the third output position. 14-9 MS-4Xi Imager User’s Manual...
Page 317
Serial Cmd: <K744,filter number,symbology,length,wildcard,placeholder,data, unused,database index> Default: “ ” = (hex) Options: Any ASCII input in the form of a pair of hex characters. Example: 3F = ? 00 = disabled 14-11 MS-4Xi Imager User’s Manual...
The index of the database entry that decodes a given symbol must equal this setting for filtering to occur. A setting of 0 allows any database index for this filter entry. Serial Cmd: <K744,filter number,symbology,length,wildcard,placeholder,data, unused,database index> Default: (any index) Options: 0 to 10 14-12 MS-4Xi Imager User’s Manual...
Page 319
Use these settings to determine Symbology Type, Length of the symbol, a user-defined Matching String, ASCII Lookup, Wildcard Character, Placeholder Character, and Database Number. Click Apply to save the settings to the corresponding filter. 14-13 MS-4Xi Imager User’s Manual...
For example, if the number of filters is 1, then only filter index # 1 will be applied. If the number of filters is 2, then only filter index # 1 and filter index # 2 will be applied, etc. Serial Cmd: <K745,number of filters> Default: Options: 0 to 10 14-14 MS-4Xi Imager User’s Manual...
Appendix D Communications Protocol..................A-20 Appendix E ASCII Table......................A-29 Appendix F Operational Tips...................... A-30 Appendix G Using an External Trigger..................A-31 Appendix H MS-4Xi Image Output ..................... A-32 Appendix I Glossary of Terms ....................A-35 MS-4Xi Imager User’s Manual...
Standard Interfaces: RS-232 and Ethernet TCP/IP Discrete I/O Trigger Input, New Master: Bi-directional, optoisolated, 4.5-28V rated (10 mA @ 28 VDC) Outputs (1, 2, 3): Bi-directional, optoisolated, 1-28V rated, (I < 100 mA at 24 VDC, current limited by user) MS-4Xi Imager User’s Manual...
Page 323
3.5 to 4.5" (89 mm to 114 mm) .015" (0.38 mm) .020” (0.51 mm) 4.5” (114 mm) 2.7 to 5.0” (69 mm to 127 mm) .020" (0.51 mm) .030” (0.76 mm) 5.5” (140 mm) 2.0 to 6.0” (51 mm to 152 mm) MS-4Xi Imager User’s Manual...
Page 324
Product specifications are given for typical performance at 25°C (77°F) using grade A labels. Performance characteristics may vary at high temperatures or other environmental extremes. Warranty–One year limited warranty on parts and labor. Extended warranty available. MS-4Xi Imager User’s Manual...
Page 325
Appendices FIS Options MS-4Xi Imager MS-4Xi, Low Density, Ethernet, 24VDC (LD = SD Lens) FIS-1004-1110G MS-4Xi, Standard Density, Ethernet, 24VDC (SD = 1.0 mm HD Lens) FIS-1004-1210G Accessories Power Supply Power Supply, M12 12-pin Socket, 1.3 m (Screw-On) 97-000003-03 Communication Devices and Cables...
Brown TX (–) Default Green RX (+) New Master Yellow Output 1 Gray Output 3 Pink RX (–) Ground Blue Input Common RS-232 (Host) RxD Black RS-232 (Host) TxD Violet Output 2 Gray/Pink Output Common Red/Blue MS-4Xi Imager User’s Manual...
Page 327
Connector 2 and Connectors 1, 3, and T. The Trigger signal between Connector 2 and Connectors 1, 3, and T can be broken using the Trigger switch. This isolates trigger signals as required. MS-4Xi Imager User’s Manual...
Page 328
Outputs can be configured as either NPN or PNP, but NPN and PNP cannot be mixed in a system, because the output common is shared by all outputs. NPN Output for Host Input NPN Output for External Load MS-4Xi Imager User’s Manual...
Page 330
Communication Protocol Commands PNP Output for External Load A-10 MS-4Xi Imager User’s Manual...
Page 331
Optoisolated Inputs All discrete inputs are optoisolated. Inputs can be configured as either NPN or PNP, but NPN and PNP cannot be mixed in a system, because the input common is shared by all inputs. A-11 MS-4Xi Imager User’s Manual...
Page 335
Beeper <K702,status> Quality Output <K704,quality output separator,decodes per trigger status> Symbol Data Output <K705,symbol data output status,when to output> No Read Message <K714,status,message> Frame Information <K734,output frame number,output coordinates> LED Configuration <K737,LED mode,ISO/IEC 16022 grade> A-15 MS-4Xi Imager User’s Manual...
Page 336
No Read,sequence on mismatch> Number of Master Symbols <K224,number of master symbols> New Master Pin <K225,status> Enter Master Symbol Data <K231,master symbol number,master symbol data> Request Master Symbol Data <K231?,>[for all] or <K231?,master symbol number> A-16 MS-4Xi Imager User’s Manual...
Page 337
Output Format Format Extract <K740,output index,start location,length> Format Insert <K741,output index,length,hex string> Format Assign <K742,symbol number,status> Format Status <K743,output format status> Output Filter Configuration <K744,filter number,symbology,length,wildcard,placeholder, data,unused,database index> Ordered Output Filter <K745,number of filters> A-17 MS-4Xi Imager User’s Manual...
Page 338
For example, if only the last field in the following command is changing, <K100,4,1,0,0> can be entered as <K100,,,,0>. • All fields following a modified field can be omitted. For example, to change Baud Rate only, send <K100,3>. A-18 MS-4Xi Imager User’s Manual...
Page 339
Entering Control Characters in Serial Commands To enter control characters within a serial command, hold down the Ctrl key while typing the desired character. Example: To enter a carriage return and line feed (^M^J), enter <K141,1,CNTL-m CNTL-j>. A-19 MS-4Xi Imager User’s Manual...
Control Characters Protocol Command (Entered in menu or Effect of Command (Mnemonic displayed on menu) Value serial command) Reset Request Reset Start of Text End of Text Acknowledge Negative Acknowledge Begin Transmission XOFF Stop Transmission A-20 MS-4Xi Imager User’s Manual...
Page 341
HOST_TX ‘NAK’ (host rejects) IMAGER_TX symbol data (resend data) HOST_TX ‘ACK’ (transaction complete) Transfer 2 HOST_TX <K141?> IMAGER_TX ‘ACK’ IMAGER_TX <K141,0> timeout reached... timeout reached... timeout reached... Timeout Reached transaction aborted, data is flushed A-21 MS-4Xi Imager User’s Manual...
Page 345
IMAGER_TX ‘REQ’ (Unit requests an ‘ACK’ again) timeout reached... IMAGER_TX ‘REQ’ (Unit requests an ‘ACK’ again) timeout reached... IMAGER_TX ‘REQ’ (Unit requests an ‘ACK’ again) timeout reached... IMAGER_TX ‘RES’ (Terminate Transfer 1, data is flushed) A-25 MS-4Xi Imager User’s Manual...
Page 346
‘NAK’ (Host rejects data frame) (Retry Event) IMAGER_TX ‘0x1C’ ‘STX’ <T/00000> ‘ETX’ (Unit sends again) HOST_TX ‘ACK’ (Host receives data) IMAGER_TX ‘RES’ (Terminate Transfer 1) The protocol makes 3 retry attempts before data is flushed and transfer is aborted. A-26 MS-4Xi Imager User’s Manual...
Page 347
IMAGER_TX ‘REQ’ (Unit requests an ‘ACK’ again) timeout reached... IMAGER_TX ‘REQ’ (Unit requests an ‘ACK’ again) timeout reached... IMAGER_TX ‘REQ’ (Unit requests an ‘ACK’ again) timeout reached... IMAGER_TX ‘RES’ (Terminate Transfer 1, data is flushed) A-27 MS-4Xi Imager User’s Manual...
Page 348
(Retry Event) IMAGER_TX ‘0x1C’ ‘STX’ <T/00000> ‘ETX’ ‘GOOD LRC’ (Unit sends again) HOST_TX ‘ACK’ (Host receives data) IMAGER_TX ‘RES’ Terminate Transfer 1) The protocol makes 3 retry attempts before data is flushed and transfer is aborted. A-28 MS-4Xi Imager User’s Manual...
The MS-4Xi has a hard-coated window that should only be cleaned with alcohol (100% isopropyl). Mounting When mounting the MS-4Xi, do not insulate the stand mount. The bottom panel is the hottest part of the imager and metal-to-metal contact is necessary for heat dissipation. A-30...
Appendices Appendix G — Using an External Trigger Two types of inputs are used on Microscan readers. 5 volt devices have NPN trigger inputs. 10-28 volt devices have optoisolated inputs and outputs. 5 Volt Devices To trigger a 5 volt device, the input has to be pulled down to “signal ground” (NPN). This can be done by relays or by a transistor-sourced signal.
MS-4Xi Image Output Appendix H — MS-4Xi Image Output This section explains how to extract (download) a video-captured image from a MS-4Xi. Y-Modem Method The easiest download method is to issue the <op,9> command to get a list of available images, then initiate a download sequence using a Y-Modem utility or protocol sequence.
Page 353
• From the menu bar, select Transfer, Receive File… • Select a file storage location, and then select ‘Y-modem’, click Receive. • HyperTerminal will upload the image and save the file to the directory specified. A-33 MS-4Xi Imager User’s Manual...
Page 354
= the length of data to follow, 32 bit integer from ‘00000000’ to ‘FFFFFFFF’ FRAMETYPE SCHEMA DATA = image data = CRC16 check digit at the end includes SOH, and everything after, except the CRC More information on these formats is available at: http://partners.adobe.com/public/developer/en/tiff/TIFF6.pdf http://www.exif.org/specifications.html A-34 MS-4Xi Imager User’s Manual...
Baud Rate — The number of discrete signal events per second; bits per second. Capture — The act of acquiring and storing video images in an imager or host computer. Also, the image captured. CCD — See Charge-Coupled Device. A-35 MS-4Xi Imager User’s Manual...
Page 356
DMA — See Direct Memory Access. DSP — See Digital Signal Processor. Dynamic Range — The difference between the minimum and maximum thresholds of discernible images; the amount of usable signal. A-36 MS-4Xi Imager User’s Manual...
Page 357
Gradient — The rate of change of pixel intensity (first derivative). Gray Scale — Variations of values from white, through shades of gray, to black in a digitized image with black assigned the value of zero and white the value of one. A-37 MS-4Xi Imager User’s Manual...
Page 358
Normally Open — A discrete output state that is only active when closed. Object Plane — An imaginary plane in the field of view, focused by an imager’s optical system at the corresponding image plane on the sensor. A-38 MS-4Xi Imager User’s Manual...
Page 359
Firmware. Real-Time Processing — In machine vision, the ability of a system to perform a complete analysis and take action on one part before the next one arrives for inspection. A-39 MS-4Xi Imager User’s Manual...
Page 360
Very Large-Scale Integration (VLSI) — The creation of integrated circuits by combining thousands of transistor-based circuits on a single chip. VLSI — See Very Large-Scale Integration. Watchdog Timer — A security device that detects system crashes and attempts to reset the imager. A-40 MS-4Xi Imager User’s Manual...
Need help?
Do you have a question about the MS-4Xi and is the answer not in the manual?
Questions and answers