MS-4X Imager User Manual P/N 84-000444 Rev A
Copyright and Disclaimer Copyright ©2015 Microscan Systems, Inc. Tel: +1.425.226.5700 / 800.762.1149 Fax: +1.425.226.8250 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. Throughout this manual, trademarked names might be used.
Introduction Table of Contents Chapter 1 Quick Start Step 1 Check Hardware .......................................................................... 1-2 Step 2 Connect the System ..................................................................... 1-3 Step 3 Position Imager and Symbol ........................................................ 1-4 Step 4 Install ESP.................................................................................... 1-5 Step 5 Select Model .................................
Table of Contents Calibration Options .................................................................................. 4-3 Calibration by ESP ................................................................................ 4-10 Initiating Calibration ............................................................................... 4-12 Additional Notes about Calibration ........................................................ 4-18 Chapter 5 Read Cycle Read Cycle by ESP ...................................
Introduction I/O Parameters by ESP ........................................................................... 7-2 I/O Parameters Serial Commands........................................................... 7-3 Symbol Data Output ................................................................................ 7-4 No Read Message ................................................................................... 7-7 Output Indicators .............................................................................
Table of Contents Match Replace ...................................................................................... 9-10 Mismatch Replace ................................................................................. 9-11 New Master Pin ..................................................................................... 9-12 Chapter 10 Camera and IP Setup Camera and IP Setup by ESP............................................................... 10-2 Camera and IP Setup Serial Commands .............
Introduction Firmware.............................................................................................. 13-16 Default/Reset/Save.............................................................................. 13-19 Imager Status Requests ...................................................................... 13-21 Learn Operations ................................................................................. 13-23 Other Operational Serial Commands ................................................
About the MS-4X Imager About the MS-4X Imager The key features of the MS-4X Imager are: • Powerful X-Mode™ algorithm for Direct Part Mark decoding • USB (including a USB + I/O option), RS-232, and RS-422/485 connectivity • Support for both linear and 2D symbologies • High-output LED illumination • EZ Button for setup and testing • A blue target pattern that identifies the center point of the field of view • A green flash (visible from all angles) to signal a successful read • Compact size for easy integrat
Introduction Warning and Caution Summary WARNING LED LIGHT DO NOT VIEW DIRECTLY WITH OPTICAL INSTRUMENTS CLASS 1 LED PRODUCT LED Output: .564 mW. Wavelength: 470 nm; 525 nm; 617 nm. IEC 60825-1:1993+A1:1997+A2:2001 • Viewing the MS-4X’s LED output with optical instruments such as magnifiers, eye loupes, or microscopes within a distance of 100 mm could cause serious eye injury. • Maximum LED output: .564 mW. • Wavelength: 470 nm; 525 nm; 617 nm.
Statement of Agency Compliance Statement of Agency Compliance The MS-4X has been tested for compliance with FCC (Federal Communications Commission) regulations and has been found to conform to all applicable FCC Rules and Regulations. To comply with FCC RF exposure compliance requirements, this device must not be co-located or operate in conjunction with any other antenna or transmitter.
Introduction Statement of RoHS Compliance All Microscan readers with a ‘G’ suffix in the FIS number are RoHS-Compliant. All compliant readers were converted prior to March 1, 2007. All standard accessories in the Microscan Product Pricing Catalog are RoHS-Compliant except 20-500013-01 and 98-000039-02. These products meet all the requirements of “Directive 2002/95/EC” European Parliament and the Council of the European Union for RoHS compliance.
Statement of RoHS Compliance xii MS-4X Imager User Manual
1 Quick Start Contents Step 1 Check Hardware................................................................................................................ 1-2 Step 2 Connect the System .......................................................................................................... 1-3 Step 3 Position Imager and Symbol.............................................................................................. 1-4 Step 4 Install ESP ...............................................................
Check Hardware Step 1 — Check Hardware Item 1 2 3 4 5 6 Description Part Number FIS-0004-200XG FIS-0001-0035G 99-000018-01 97-100004-15 99-000017-01 61-300026-03 MS-4X Imager IC-332 Adapter IB-131 Interface Box Power Supply (90-264 VAC, 24VDC, USA/Euro plug) Object Detector Communication Cable 1 2 Host 4 3 Network Scanner 6 5 Hardware Required Caution: Be sure that all cables are connected BEFORE applying power to the system. Always power down BEFORE disconnecting any cables.
Quick Start Step 2 — Connect the System Connecting by RS-232 / RS-422 • • • • • Connect the imager (1) to the IB-131/IC-332 interface (2) and (3). Connect the host cable (6) to the host and to the host port on the IB-131 (3). Connect the object detector (5) to the IB-131 (3). Connect the power supply (4) to the IB-131 (3). Apply power to the imager. Connecting by USB • Plug the imager’s USB cable into the host’s USB port. • Apply power to the imager.
Position Imager and Symbol Step 3 — Position Imager and Symbol • Position the imager at a distance from the symbol that matches the factory pre-set focal distance. For example, if your imager is pre-set at 4”, position the parting line 4” from the symbol. • Tip the imager relative to the symbol to avoid the glare of direct (specular) reflection. The case parting line should be perpendicular to the plane of the symbol by either pitching the symbol or the imager as shown.
Quick Start Step 4 — Install ESP ESP Software can be found on the Microscan Tools Drive that is packaged with the MS-4X. 1. Follow the prompts to install ESP from the Tools Drive. 2. Click on the ESP icon to run the program. Note: ESP can also be installed from the Download Center at www.microscan.com. Minimum System Requirements • • • • • • 233 MHz Pentium PC Windows 8, 7, Vista, or XP operating system (32-bit or 64-bit) Internet Explorer 6.
Select Model Step 5 — Select Model When you start ESP, the following menu will appear: 1. Click the button showing the MS-4X. 2. Click OK. Note: You can also double-click the MS-4X 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 > New Model in the menu toolbar.
Quick Start Step 6 — Select Protocol and Connect • Choose the connection protocol you are using and click Connect. • Once you select your communications mode, follow the simple prompts to establish your connection.
Select Protocol and Connect (cont.) Step 6 — Select Protocol and Connect (cont.) When you are connected, you will see the green connection indicator in the status bar at the bottom right of your screen. RS-232: USB: • If your RS-232 connection attempt fails, click the Autoconnect button, select a different communications port, and try again. Note: If your RS-232 host settings cannot be changed to match the imager’s settings, check the Force Connect box in the RS-232 dialog and click the Connect.
Quick Start Step 7 — Locate the Symbol in the Field of View Locate by ESP • In ESP’s EZ Mode, click the Locate button to enable the blue target pattern. The symbol in the field of view will appear in the video view beneath the Locate and Calibrate buttons, and you will see the blue target pattern projected from the front of the imager. • Center the target pattern on the symbol. At 2 to 3 inches, the pattern resembles an X. At 3 to 6 inches, the pattern resembles a V. Center on object in field of view.
Locate the Symbol in the Field of View Locate by EZ Button 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. EZ Button • Hold down the EZ Button for about one second and release when you hear one short beep. The amber 20% LED will illuminate, and you will see the blue target pattern projected from the front of the imager. • Center the target pattern on the symbol.
Quick Start Step 8 — Calibrate MS-4X 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. Upon successful completion of this routine, a green LED pattern will flash brightly and illuminate the symbol.
Test Read Rate Step 9 — Test Read Rate Read Rate indicates the number of successful decodes per second achieved by the imager. Test Read Rate by EZ Button 1. To start the Read Rate test, hold down the EZ Button about three seconds until you hear three short beeps. The 20%, 40%, and 60% LEDs will illuminate. While the symbol is being inspected, the Read Rate LEDs will indicate the corresponding read rate percentage on the back of the unit. 20%, 40%, 60%, 80%, 100%.
Quick Start Step 10 — Configure the Imager in ESP To make setup changes to the MS-4X, click the App Mode button. The following modes are accessible by clicking the buttons in the first row of App Mode icons: • • • • • Click the EZ Mode button to return to EZ Mode. Click the Autoconnect button to establish communication. Click the Send/Recv button to send or receive commands. Click the Switch Model button to open the model menu, or to return to a previous model.
Save Configuration in ESP Step 11 — Save Configuration in ESP To make changes to a configuration setting: 3. Place your cursor in the selection box, scroll down to the setting you want to change, and click once on the setting. 1. Left-click on the + to expand the desired tree. 2. Double-click on the desired parameter and click once in the selection box to view options. 4. Left-click again on the open screen to complete your selection. 5.
2 Using ESP Contents EZ Mode........................................................................................................................................2-2 Application Mode...........................................................................................................................2-3 Menu Toolbar ................................................................................................................................2-4 View ...................................................
EZ Mode EZ Mode In EZ Mode you are presented with the Locate, Calibrate, and Test options. After connecting to your imager, EZ Mode is the screen you will see. You will be provided with on-screen instructions that will help you with positioning, testing, and calibration. Test Click the Test button to start the Read Rate test for a quick indication of the imager’s read capabilities and the limits of your application.
Using ESP Application Mode From EZ Mode, you can click on the App Mode button to access specific configuration menus, Utilities tools, Camera setup, Output Format options, and a Terminal window where serial commands can be entered. Note: The App Mode and EZ Mode buttons appear in the same position to allow easy switching between these primary modes. Communication, Read Cycle, Symbologies, I/O Parameters, Symbol Quality, Matchcode, Diagnostics Return to EZ Mode.
Menu Toolbar Menu Toolbar File > New Whenever New is selected, the default configuration of ESP is loaded. Open/Save When Save or Save As is selected, the ESP configuration is saved to the host computer’s hard drive and available whenever the same file is selected under Open. Important: When you save menu changes to your hard drive, these changes are not saved to your imager. The illustration below shows how settings can be saved and received between ESP and the imager, and ESP and the host hard drive.
Using ESP Model In the Model menu you can select any of the models supported by ESP. When you choose a different model, the connection to your present model will be terminated. 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.
Menu Toolbar Options The Options menu allows you to save memos and set up ESP Preferences. Note: Preferences will be saved and loaded into ESP whenever ESP is opened next, whether or not you save the ESP file. Preferences > General Tab The Toolbar Style options allow you to determine how ESP will display the mode options in the two rows at the top of the screen. Reload Last File At startup, reloads the last file saved to the host computer’s hard drive.
Using ESP Preferences > Terminal Tab Show Non-Printable Characters When Show Non-Printable Characters is enabled, characters such as “CRLF” will be displayed in the Terminal window. When Enhanced Format is checked, the characters are displayed with more detailed formatting. Change Keyboard Macros Clicking the Change Keyboard Macros button brings up the Function Keys dialog. In this dialog you can select the desired function key and then enter your macro keystrokes in the associated key map.
Menu Toolbar Preferences > Bar Code Options Tab 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.
Using ESP Preferences > Advanced Tab The Auto Sync options at the top of the Advanced tab allow you to determine whether Auto Sync will be enabled automatically in sections of ESP where it is used, or if it will ask you before it enables Auto Sync functions. Always Ask Before Auto Sync Occurs If you check this option box, you are then able to determine what specific Auto Sync functions will be enabled.
Menu Toolbar Preferences > Advanced Tab (cont.) Ask to Save ESP File when Quitting When enabled, prompts the user to save a .esp file when ending a session. 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.
Using ESP Document Memo The information you type in the Document Memo field will appear in a context-sensitive text box whenever your cursor hovers over the Document Memo item on the Options menu. Model Memo Similar to Document Memo, the information you type in the Model Memo field will appear in a context-sensitive text box whenever your cursor hovers over the Model Memo item on the Options menu. Memos created in Model Memo are specific to the model enabled when the message was created.
Menu Toolbar Connect The Connect dropdown menu allows the user to access the Connection Wizard, as well as the Autoconnect and Configure Multidrop dialogs. Connect and Disconnect can also be performed directly from the dropdown menu without opening a dialog. Connection Wizard To connect using the Connection Wizard: • Click Connect on ESP’s menu toolbar, and then select Connection Wizard. • Select RS-232 or USB to activate the appropriate display.
Using ESP View The View menu allows you to move quickly between interfaces without using the icon buttons on the App Mode toolbar. It also allows you to access the Bar Code Dialog. Bar Code Dialog In the Bar Code Dialog you can create symbols by typing the text you wish to encode. This is a useful tool for creating configuration symbols, allowing you to configure your reader by reading the symbols you create.
Navigating in ESP Navigating in ESP To change imager settings, or to access the Utilities, Camera, Terminal, or Output Format views, click the App Mode button. To return to EZ Mode, click the EZ Mode button. To make changes to configuration settings in the control trees: 1. Left click on the + to expand menu items. The X denotes the default option setting. 2. Double-click the desired parameter and single-click in the selection box to view options. 3.
Using ESP Send/Receive Options To access Receive, Save, and Default options, click the Send/Recv button. You can also access these options by right-clicking in any of the configuration views. Receiving From the Send/Recv menu, select Receive Reader Settings. Caution: Do not select this option if you do not want to upload the imager’s settings. For example, if your ESP file has a number of custom settings that you want to maintain and download into the imager, these settings would be lost by choosing Yes.
Send/Receive Options Defaulting When you select Default Current Menu Settings or Default all ESP Settings, you are only defaulting the ESP settings. Advanced Options Send Current View This is the same as Save to Reader > Send No Save except that only the commands in the current configuration tree are sent. Send Current Command This is the same as Send Current View, except that it saves only the command that is currently selected.
Using ESP Using EZ Trax 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-4X for use with EZ Trax, see Setting Up the Imager for EZ Trax in Read Cycle.
Using EZ Trax 2-18 MS-4X Imager User Manual
3 Communications Contents Communications by ESP .............................................................................................................. 3-2 Communications Serial Commands.............................................................................................. 3-3 Host Port Connections .................................................................................................................. 3-4 Host Port Protocol.............................................................
Communications by ESP Communications by ESP Click the Parameters button and then the Communication 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.
Communications Communications Serial Commands Host Port Connections Auxiliary Port Connections RS-422 Status Host Port Protocol Preamble Postamble Response Timeout LRC Auxiliary Port System Data Status
Host Port Connections Host Port Connections The host port can be configured with RS-232, RS-422, and RS-485 connections. The following settings define the basic transmission speeds and digital standards that ensure common formatting. Baud Rate, Host Port Usage: Definition: Serial Cmd: Default: Options: Can be used to transfer data faster or to match host port settings. The rate at which the reader and host transfer data back and forth. 115.
Communications Host Port Protocol Usage: In general, the point-to-point protocols will work well in most applications. They require no address and must use RS-232 or RS-422 communications standards. Definition: Protocols define the sequence and format in which information is transferred between the reader and the host, or in the case of Multidrop, between the readers and a concentrator.
Host Port Protocol Point-to-Point with RTS/CTS and XON/XOFF Usage: Definition: Serial Cmd: Used only with RS-232. This option is a combination of Point-to-Point with RTS/CTS and Pointto-Point with XON/XOFF. ACK/NAK Definition: Serial Cmd: See the ACK/NAK Options command . Polling Mode Definition: Serial Cmd: See the Polling Mode Options command .
Communications ACK/NAK Options Definition: Serial Cmd: These parameters take effect for ACK/NAK on the main RS-232 or RS-422 ports (not on the Auxiliary Port), and are completely independent of the Polling Mode Options . The imager always follows the protocol in both directions (to and from the host). There is no option to disable it from either direction.
Polling Mode Options Polling Mode Options Definition: Serial Cmd: These parameters only take effect for Polling Mode on the main RS-232 or RS-422 ports (not on the Auxiliary Port), and are completely independent of the ACK/NAK Options . The values of protocol characters can be changed, but the protocol events cannot be disabled. The polling mode address is configured in the command (see Poll Address).
Communications RS-422 Status Usage: Definition: Serial Cmd: Default: Options: RS-232 is an industry standard. RS-422 is used when greater cable lengths are required and/or where noise interference is an issue. RS-422, if enabled, allows communication through RS-422 I/O lines. When RS-422 is enabled, RS-232 is disabled. When RS-422 is disabled, RS-232 is enabled. Disabled 0 = Disabled 1 = Enabled Note: The default setting can only be changed in readers with multiplexed RS-232/RS-422 ports.
Auxiliary Port Connections Auxiliary Port Connections The auxiliary port offers an alternative port that can be configured to communicate by RS-232 in several modes, including daisy chain. As with the host port parameters, the auxiliary port settings (baud rate, parity, stop bits, and data bits) must be identical with those of the auxiliary device. Usage: Definition: An auxiliary port connects the imager to a remote display or to other readers that can display or transfer data.
Communications Parity, Auxiliary Port Usage: Definition: Serial Cmd: Default: Options: Only changed if necessary to match host setting. An error detection routine in which one data bit in each character is set to 1 or 0 so that the total number of 1 bits in the data field is even or odd.
Auxiliary Port Connections Transparent Mode Usage: Definition: A common application, in conjunction with handheld imagers, is one that employs an auxiliary readout to detect misapplied symbols. In Transparent Mode, data is passed between the auxiliary port and the host. The imager buffers data from the auxiliary port and echoes the keyed data on the auxiliary port. • Auxiliary port data is passed through to the host whenever a return key is pressed at the auxiliary port or whenever symbol data is sent.
Communications Half Duplex Mode Usage: Definition: Useful when the user wants symbol data displayed on an auxiliary menu close to the imager. In Half Duplex Mode all auxiliary port data and symbol data is sent directly to the host. Symbol data is displayed on the auxiliary port menu at the same time the data is sent to the host. Data Originating from the Auxiliary Port • Auxiliary port data to the host is ignored if the imager is in a polled mode.
Auxiliary Port Connections Full Duplex Mode Usage: Definition: When communication to and from the auxiliary port is required. In Full Duplex Mode all auxiliary port data and symbol data is sent directly to the host. Symbol data is not displayed on the auxiliary port menu. Data Originating from the Auxiliary Port • Auxiliary port data to the host is ignored if the imager is in a polled mode. • Auxiliary port data or read data is sent to the host whenever it is received.
Communications Daisy Chain Mode Usage: Definition: Serial Cmd: Options: Function: Useful in applications where: • More than one symbol type is present. • A symbol may be present on multiple sides of a package. • Symbols are presented at different depths. In a daisy chain application, readers are connected in tandem or a “daisy chain” and decoded data is relayed from one reader to another until the data reaches the host.
Auxiliary Port Connections Command Processing Mode Usage: Definition: Serial Cmd: Options: 3-16 Allows a user to send configuration settings from the host port to the auxiliary port. When enabled, Command Processing Mode allows commands to be entered via the auxiliary port and direct externally triggered read cycle data in one of two ways: • Symbol data, including the serial trigger (if used), will be transmitted to the last port from which a command was sent.
Communications Daisy Chain ID Status Usage: Definition: Serial Cmd: Default: Options: Used in a daisy chain setup in cases where the host needs to know which reader in the chain sent the data. Each reader in a daisy chain can be assigned a one or two character ID that will appear in front of decoded data and identify its source.
Auxiliary Port System Data Status Auxiliary Port System Data Status Definition: Serial Cmd: Default: Options: 3-18 When enabled, system data will be routed to the Auxiliary Port. This includes decoded data and diagnostic warning messages. When disabled, system data will not be routed to the Auxiliary Port.
Communications Daisy Chain Autoconfigure Usage: Definition: Serial Cmd: For quick setup and configuration of your daisy chain network. The command to autoconfigure the daisy chain is sent to the primary imager and the software responds in the following ways: • Counts the number of secondary readers in the daisy chain. • Assigns an internal ID number (1...n) to each secondary reader, where the first secondary reader is number 1 (the primary reader’s ID being a 0).
Response Timeout Response Timeout Usage: Definition: Serial Cmd: Default: Options: Only used when a response is required from the host. While in Multidrop, if the imager does not receive an ACK or NAK from the host after sending polled data, it will act on a fault. The reader can be set to wait indefinitely by setting Response Timeout to zero. The time that the imager will wait before timing out if ACK, NAK, and ETX are enabled, and a host response is expected.
Communications LRC Status (Longitudinal Redundancy Check) Usage: Definition: Serial Cmd: Default: Options: Used when extra data integrity is required. An error-checking routine that verifies the accuracy of transmissions. It is the exclusive OR of all characters following the STX (start of text) up to and including the ETX (end of text).
Protocol Configuration Examples Protocol Configuration Examples Point-to-Point (Main Port) Baud Rate: 115.
Communications USB HID Interface The USB version of the MS-4X operates as an HID (Human Interface Device) on the USB bus. HID-class devices communicate via “report” packets. An HID may support multiple report types, each of which is identified with a unique report ID. The MS-4X supports two different report types: • Microscan HID Report (ID = 1) • Keyboard Report (ID = 2) The imager always outputs the same data for both report types. The user may enable or disable either report type.
USB HID Interface Report Options The following functionality conditions hold true regardless of how HID Reports are configured: 1. The host application must establish a connection with the imager to receive Microscan HID IN Reports (symbol data) and to send Microscan HID OUT Reports (commands, serial triggers). 2. The imager can always receive Microscan HID OUT Reports (commands, serial triggers). 3. The host application can always send commands through Microscan HID OUT Reports.
Communications Keyboard IN Reports The host operating system will interpret Keyboard IN Reports from the imager as if the user were typing keyboard text. The host operating system sends keystrokes to the current application. This is commonly called a Keyboard Wedge configuration.
USB HID Interface Microscan HID Report Format Size: 64 bytes, fixed-length. The USB HID standard defines all reports as being fixed-length. Structure: REPORT ID (1) LENGTH (1) DATA (62) Values in parentheses indicate the size, in bytes, of the field. Field Descriptions REPORT ID Size: 1 byte Value: 0x01 Note: Report ID is the method employed by USB HID to allow multiple report formats to be sent and received from the same interface.
Communications Report Format Examples For clarity, all report format examples are shown as follows: report fields separated by an underscore ( _ ), REPORT ID and LENGTH fields shown as decimal values, data fields shown as printable ASCII characters, and the number of NUL padding bytes shown as decimal values (nn). IN report (to host) 1_11_A]002374938 (51) REPORT ID = 1 = Microscan HID LENGTH = 11 DATA = ”A]02374938” = This is a Code 39 symbol.
USB HID Interface Keyboard Report Format Size: 9 bytes, fixed-length. Structure: REPORT ID (1) MODIFIER (1) RESERVED (1) KEYCODES (6) Values in parentheses indicate the size, in bytes, of the field. Important: The host application does not need to understand and process Keyboard Reports. This task belongs to the host operating system. Keycodes are passed to the host application as if a user were typing keyboard text. The host application must be the active application in order to receive keystrokes.
Communications Field Descriptions RESERVED Size: 1 byte Value: 0x00 Note: This field is Reserved. Its value is always NUL (0x00). KEYCODES Size: 6 bytes Value: 0x00 to 0xFF Note: The MS-4X translates 8 bit data values into Keycode data in the following ways: 8 Bit Data Value Keycode Data 0x00 to 0x1F and 0x7F to 0xFF Decimal key ( . ) unless otherwise noted.
USB HID Interface USB HID Configuration Options The user has the following options for configuring and defaulting a USB version of the MS-4X: Configuration Symbols (Data Matrix with “Configure Reader” Flag) Symbol configuration can be performed “out-of-the-box”, as the MS-4X is configured for Continuous Read Mode, and Data Matrix is enabled by default. Data Matrix symbols are used to encode configuration commands when the symbology’s “configure reader” flag is set.
Communications Configuration Exceptions for USB Read Cycle Mode By default, the imager operates in Continuous Read Mode. If the imager is configured using Data Matrix symbols, the read cycle mode should be the last item changed before saving the configuration settings and beginning operation. This is because all read cycle modes other than Continuous Read Mode require a trigger event. In USB, a trigger event can only be initiated by serial command.
ASCII Character Entry Modifier ASCII Character Entry Modifier Commands that require ASCII text fields, such as Preamble and Postamble commands, can be sent to the imager as hex pairs (see ASCII Table for conversions). Serial Cmd Format: To enter ASCII fields as hex values (00 to FF), add a lower-case h directly after the command’s K number, and then enter the hex value that corresponds with the desired ASCII character.
Communications Preamble Preamble Status Usage: Definition: Serial Cmd: Default: Options: Useful for identifying and controlling incoming data. For example, defining the preamble as a carriage return and a line feed causes each decoded message to be displayed on its own line. Defines a one to four character data string that can be added to the front of the decoded data.
Postamble Postamble Postamble Status Usage: Definition: Serial Cmd: Default: Options: Useful for identifying and controlling incoming data. For example, defining the postamble as a carriage return and a line feed causes each decoded message to be displayed on its own line. Allows the user to enable or disable up to four postamble characters that can be added to the end of the decoded data.
4 Calibration Contents Calibration Serial Commands ....................................................................................................... 4-2 Calibration Overview..................................................................................................................... 4-2 Calibration Options ....................................................................................................................... 4-3 Calibration by ESP.................................................
Calibration Serial Commands Calibration Serial Commands Calibration Options Autocalibrate <@CAL> Calibration Overview Autocalibration is one of the most powerful features of the MS-4X. The calibration process can be initiated by serial command, EZ button, or ESP user interface.
Calibration Calibration Options This command specifies the operation of the imager’s calibration feature. The default configuration is set up to perform calibration on gain, focus, and symbol type. The default shutter speed setting is disabled, because not all applications require shutter speed, and when it is required, the application-specific settings tend to vary widely. Note: Background Color is part of the calibration process regardless of the calibration setup.
Calibration Options Disabled (Shutter Speed) When this feature is disabled, the shutter speed is fixed and is not part of the calibration process. Enabled (Shutter Speed) When this feature is enabled, shutter speed will be calibrated to provide the best possible image quality and performance. Fast Shutter The calibration process will concentrate on achieving the fastest possible shutter setting that will still provide good performance.
Calibration Symbol Type Serial Cmd: Default: Options: Enabled 0 = Disabled 1 = Enabled Disabled When this feature is disabled, only the currently-enabled symbologies will be considered during the calibration process. Enabled When this feature is enabled, autodiscrimination will be in effect during the calibration process.
Calibration Options Window of Interest (WOI) Framing Definition: Serial Cmd: Default: Options: Configured WOI If a WOI framing mode is enabled, it will set the camera WOI to a full-size image when calibration begins. Once a symbol is decoded, the camera WOI will be zoomed-in both vertically and horizontally (regardless of which WOI mode is enabled) to include the symbol plus an additional margin area. This is done to accelerate the calibration process.
Calibration Disabled When this feature is disabled, the Window of Interest is not modified after the calibration process is complete. Row and Column If the calibration process is successful, the Window of Interest will be modified to frame the symbol as well as an additional margin area around the symbol, determined by the WOI Margin parameter.
Calibration Options Straight Line This feature is intended for use with linear symbologies. If the calibration process is successful, the orientation of the symbol is determined and the Window of Interest is modified according to the symbol orientation. The scan line orientation is determined to be vertical if the symbol tilt is between 225° and 315°, or between 45° and 135°. Otherwise, the scan line will be horizontal.
Calibration Window of Interest (WOI) Margin Definition: Serial Cmd: Default: Options: Sets the margin size that is applied to the calibrated symbol. This parameter is expressed in number of pixels. If the margin causes the image to exceed the maximum image size, it will be reduced accordingly.
Calibration by ESP Calibration by ESP ESP’s Calibration view incorporates all the functionality of the (Calibration Options) command in a single easy-to-use, intuitive interface. This calibration process allows the user much finer control of individual parameters than the calibration routine in EZ Mode or on the Video tab. Before/During Calibration Before and After tabs give the user an authentic representation of the difference in what the imager “sees” before and after the calibration routine.
Calibration After Calibration Notice the improved image resolution after the calibration process is complete. The Focus, Shutter, Gain, and Quality indicator bars remain stationary at the end of calibration to provide a visual reference for the final values of these four parameters. The calibration progress bar indicates that the process has been completed. Saves the optimal configuration parameters determined by calibration results.
Initiating Calibration Initiating Calibration Calibration can be initiated by serial command, the EZ button, or from the Calibration interface in ESP. In ESP, the Calibrate button starts the calibration routine. 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. See Calibrate by EZ Button for the EZ button calibration procedure.
Calibration Calibration Progress Indicators During the calibration process, the imager has a number of ways to communicate its progress to the user. The following three types of feedback are the primary ways that the imager communicates calibration progress.
Initiating Calibration Calibration Progress Output to Terminal When initiated by serial command or EZ button, the autocalibration operation will output progress and process information to a terminal if the system is configured to do so. Terminal Depending upon how the calibration options are configured, the autocalibration process can have up to 5 steps (Quick Focus, Search Pass, Focus Pass, Medium Pass, Fine-Tune Pass).
Calibration Focus Pass The purpose of Focus Pass is to determine the optimal focal position of the optical system. This is accomplished by determining the inside and outside focus positions and then recording the center position as the desired focal position.
Initiating Calibration Medium Pass The theory behind Medium Pass is to develop a readable range from which to dial in a decoded symbol.
Calibration Fine-Tune Pass The theory behind Fine-Tune Pass is to dial in a decoded symbol based on the range supplied by the Medium Pass.
Additional Notes about Calibration Additional Notes about Calibration The following conditions apply to the imager’s calibration process. Some of these items are noted at various points throughout this section, or in other sections of the imager’s documentation. 1. The Mirrored Image parameter is not part of the calibration process. 2. Background Color is calibrated. 3. If Window of Interest Framing is enabled, the WOI will be set to full frame when calibration begins.
5 Read Cycle Contents Read Cycle by ESP ...................................................................................................................... 5-2 Read Cycle Serial Commands...................................................................................................... 5-3 Read Cycle Setup......................................................................................................................... 5-4 Multisymbol...............................................................
Read Cycle by ESP Read Cycle by ESP Click the Parameters button and then the Read Cycle tab. To open nested options, single-click the +. 5-2 To change a setting, double-click the setting and use your cursor to scroll through the options.
Read Cycle Read Cycle Serial Commands Trigger Mode/Filter Duration Serial Trigger Character External Trigger State End of Read Cycle Minimum Good Reads Multisymbol Start Trigger Character Stop Trigger Character
Read Cycle Setup Read Cycle Setup 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-4X can read multiple symbols in a single image frame. 2. Decide on the trigger type to be used: if serial, choose a serial character; if external, choose either Level or Edge. 3. Designate how the read cycle should end (Timeout, New Trigger, Last Frame). 4.
Read Cycle Multisymbol Usage: Definition: Conditions: Multisymbol is commonly used in shipping applications where a shipping symbol contains individual symbols for part number, quantity, etc. This feature allows on trigger to pick up all the symbols. Multisymbol allows the user to define up to 100 symbols that can be read in a single read cycle. The following conditions apply: • Each symbol must be different to be read, unless in Rapid Capture Mode, configured for “triggered capture”.
Trigger Mode and Filter Duration Trigger Mode and Filter Duration Trigger Mode Definition: Serial Cmd: Default: Options: The Trigger is the event that initiates a read cycle. Note: When calibrating the imager or testing read rate, the current trigger setting will be disregarded.
Read Cycle Continuous Read 1 Output Usage: Definition: Serial Cmd: Continuous Read 1 Output can be useful in applications where it is not feasible to use a trigger and all succeeding symbols contain different information. It is also effective in applications where the objects are presented by hand. In Continuous Read 1 Output the imager self-triggers whenever it decodes a new symbol or a timeout occurs.
Trigger Mode and Filter Duration External Level Initiate Read Cycle: Object #1, moving in front of the detector beam, causes a change in the trigger state, which initiates the read cycle. End Read Cycle: The same object, moving out of the detector beam, causes another change in the trigger state, which ends the read cycle.
Read Cycle Serial Data Usage: Definition: Serial Cmd: Serial Data is effective in a highly controlled environment where the host knows precisely when the object is in the field of view. It is also useful in determining if a No Read has occurred. In Serial Data, the imager accepts an ASCII character from the host or controlling device as a trigger to start a read cycle. A Serial Data trigger behaves the same as an External Edge trigger.
Trigger Mode and Filter Duration Leading Edge Trigger Filter Usage: Definition: Serial Cmd: Default: Options: Used to ignore spurious triggers when Trigger Mode is set to External Edge or External Level. To consider a change in state on the trigger input, the level must be stable for the trigger filter duration. In an edge mode, the imager will trigger a read cycle if the active state has been uninterrupted for the entire trigger filter duration.
Read Cycle External Trigger Polarity Usage: Definition: Serial Cmd: Default: Options: Allows users to select the trigger polarity that will be used in their application. Determines the active state of the trigger signal applied to the cable input of the imager.
Serial Trigger Serial Trigger Usage: Definition: Allows the user to define the trigger character and delimiters that start and stop the read cycle. A serial trigger is considered an online host command and requires the same command format as all host commands. It must be entered within angle bracket delimiters < > or, in the case of non-delimited triggers, it must define individual start and stop characters.
Read Cycle Start Trigger Character (Non-Delimited) Usage: Definition: Serial Cmd: Default: Options: Useful in applications where different characters are required to start a read cycle. A single ASCII host serial trigger character that starts the read cycle and is not enclosed by delimiters such as < and >. Non-delimited Start characters can be defined and will function according to the trigger event.
Stop Trigger Character (Non-Delimited) Stop Trigger Character (Non-Delimited) Usage: Definition: Serial Cmd: Default: Options: Useful in applications where different characters are required to end a read cycle. A single ASCII host serial trigger character that ends the read cycle and is not enclosed by delimiters such as < and >. Non-delimited Stop characters can be defined and will function according to the trigger event.
Read Cycle End of Read Cycle Definition: The read cycle is the time during which the imager will attempt to capture and decode a symbol. A read cycle can be ended by a timeout, a new trigger, or by the last frame in a capture sequence or a combination of the above. End of Read Cycle Mode Note: When operating in Continuous Read or Continuous Read 1 Output, the imager is always in the read cycle.
End of Read Cycle New Trigger Usage: Definition: New Trigger is an effective way to end a read cycle when objects move past the reader at irregular intervals (not timing-dependent). New Trigger ends the current read cycle and initiates a new one when a new trigger occurs. New Trigger refers only to a rising edge trigger. With External Edge, Serial Data, or Serial Data or External Edge enabled, an edge or serial trigger ends a read cycle and initiates the next read cycle.
Read Cycle Capture Mode Definition: Serial Cmd: Default: Options: Capture Mode relates to the way that images are captured and processed. Continuous Capture 0 = Rapid Capture 1 = Continuous Capture Rapid Capture Definition: In a rapid capture mode, one or multiple captures (as many as 32) can be taken at an interval specified by the time-between-captures parameter. In this mode, the only limiting time factor is integration and transfer timing.
Capture Mode Number of Captures Usage: Definition: Serial Cmd: Default: Options: Number of Captures is used to specify the number of captures to be processed in Rapid Capture Mode. Sets the total number of captures that are processed during a read cycle in Rapid Capture Mode. This feature is used in conjunction with Capture Timing parameters to specify the capture sequence of a rapid capture read cycle.
Read Cycle Timed Capture Usage: Definition: Timed Rapid Capture is useful in fast-moving applications in which symbols are only in the field of view for a short time and precise timing is required. In Timed Rapid Capture, decoding occurs independent of and simultaneous with capturing, thus allowing precise timing or no delay at all between captures. Also, consecutive captures are regarded as the same symbol if the output data is the same.
Triggered Capture Usage: Definition: Useful in applications where each decode must be treated as a discrete event, regardless of symbol data. The first trigger event starts the read cycle, and subsequent triggers will continue until the predetermined Number of Captures is met, or until the predetermined End of Read Cycle condition is met-- whichever occurs first.
Read Cycle Capture Timing Note: Capture Timing applies only to Rapid Capture Mode. Time Before First Capture Usage: Definition: Serial Cmd: Default: Options: In almost any moving line application, a time delay is needed to ensure that a symbol will be in the imager’s field of view at the beginning of the capture sequence. Time Before First Capture in a moving line application is the time between an external trigger event and the occurrence of the first capture.
Capture Timing Time Between Captures Usage: Definition: Serial Cmd: Default: Options: This is useful in applications where more than one symbol can appear during a single read cycle (multisymbol), or where line speeds are slow enough that captured frames might overlap or miss a symbol. A time delay can be inserted between individual frame captures in Rapid Capture Mode.
Read Cycle Image Processing Timeout Usage: Definition: Serial Cmd: Default: Options: Useful in higher speed applications where image processing time is long enough that not all captures have an opportunity to be processed. Specifies the maximum amount of time to process a captured image. When the timeout expires, the image processing is aborted. This timeout works in both Rapid Capture and Continuous Capture modes, as well as with the Configuration Database.
Image Storage Image Storage Image Storage Type Definition: Serial Cmd: Default: Options: Allows the user to store images from separate read cycles and to retrieve them later. The number of available slots for storage depends on the mode of operation. If the imager is in Rapid Capture Mode, the number of images that can be stored is equivalent to the maximum number of the rapid count (the current rapid count setting).
Read Cycle Image Storage Example The following example assumes that the imager is in a rapid capture mode of 3 captures.
Minimum Good Reads Minimum Good Reads Definition: Serial Cmd: Default: Options: 5-26 This value specifies the number of times a symbol needs to be read to qualify as a good read.
Read Cycle Setting Up the Imager for EZ Trax If you are using EZ Trax software, it is important to set up the MS-4X correctly before beginning. Click the Read Cycle tab to display the Read Cycle tree control. Set Trigger Mode, , to External Edge. Set Capture Mode, , to Rapid Capture. Once these Read Cycle parameters are set, you will be ready to connect to EZ Trax. For a description of how to configure EZ Trax using serial commands or ESP, see Configuring EZ Trax Output in I/O Parameters.
Setting Up the Imager for EZ Trax 5-28 MS-4X Imager User Manual
6 Symbologies Contents Symbologies by ESP.................................................................................................................... 6-2 Symbologies Serial Commands ................................................................................................... 6-3 Data Matrix ................................................................................................................................... 6-4 Aztec Code............................................................
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 +.
Symbologies Symbologies Serial Commands Narrow Margins/Symbology ID Background Color Composite Aztec Code Micro QR Code Postal Symbologies Code 39 Codabar Interleaved 2 of 5 UPC/EAN Code 128/EAN 128 Code 93 PDF417 Pharmacode Data Matrix QR Code BC412 DataBar-14 (RSS-14) DataBar Limited (RSS Limited) DataBar Expanded (RSS Expanded) MicroPDF417 MS-4X Imager User Manual
Data Matrix Data Matrix Usage: Definition: Very useful where information needs to be packed into a small area, and/or where symbols need to be applied directly to the substrate with laser etching, chemical etching, dot peen, or other methods. Data Matrix is a type of Matrix symbology and has subsets ECC 000 - ECC 200. ECC 200 symbols have an even number of rows and an even number of columns. Most of the symbols are square with sizes from 10x10 to 144x144.
Symbologies ECC 080 Definition: Serial Cmd: Default: Options: When enabled, will decode ECC 080 symbols. Disabled 0 = Disabled 1 = Enabled ECC 100 Definition: Serial Cmd: Default: Options: When enabled, will decode ECC 100 symbols.
Aztec Code Aztec Code Usage: Definition: Serial Cmd: Default: Options: 6-6 Used in document imaging, railway ticket validation, and some postal applications. A 2D matrix symbology built on a square grid with a square “bull’s-eye” pattern at the center. Aztec Code can encode up to 3,832 numeric or 3,067 alphabetical characters, or 1,914 bytes of data. The level of Reed-Solomon error correction used with Aztec Code is configurable, from 5% to 95% of the total data region.
Symbologies QR Code Usage: Definition: Serial Cmd: Default: Options: Widely implemented in the automotive industry in Japan and throughout their worldwide supply chain. QR Code is capable of handling numeric, alphanumeric, and byte data as well as kanji and kana characters. Up to 7,366 characters (numeric data) can be encoded using this symbol. Therefore, less space is required to encode the same amount of data in a QR Code symbol than in a conventional symbol, lowering the cost of labelling.
Micro QR Code Micro QR Code Usage: Definition: Serial Cmd: Default: Options: 6-8 Used in various applications that require higher data density than that provided by standard QR Code. Some application examples are automotive inventory, vehicle ID, and mobile phone URL encodation. Micro QR Code is a 2D matrix symbology that comes in 4 different symbol sizes, the largest capable of encoding 35 numeric characters.
Symbologies Code 39 Usage: Definition: Serial Cmd: Default: Options: Code 39 is considered the standard for non-retail 1D symbology. An alphanumeric symbology with unique start/stop code patterns, composed of 9 black and white elements per character, of which 3 are wide.
Code 39 Large Intercharacter Gap (Code 39) Usage: Definition: Serial Cmd: Default: Options: Large Intercharacter Gap is helpful for reading symbols that are printed out of specification. Important: Do not use Large Intercharacter Gap with Narrow Margins enabled, because a large intercharacter gap (over 3x) could cause a narrow margin (5x) to be interpreted as an intercharacter gap.
Symbologies Full ASCII Set (Code 39) Usage: Definition: Serial Cmd: Default: Options: Must be enabled when reading characters outside the standard character set (0-9, A-Z, etc.) The user must know in advance whether or not to use the Full ASCII Set option. Since Full ASCII Set requires two code words to encode one character, it is less efficient.
Code 128 Code 128 Usage: Definition: Serial Cmd: Default: Options: Code 128 is a smaller symbology useful in applications with tight spots and high security needs. A very dense alphanumeric symbology. It encodes all 128 ASCII characters, it is continuous, has variable length, and uses multiple element widths measured edge to edge.
Symbologies EAN 128 Status (Code 128) Definition: Serial Cmd: Default: Options: When this field is disabled, the imager will not check any Code 128 labels for conformance to EAN requirements, or perform any special formatting. When enabled, the imager can read symbols with or without a function 1 character in the first position. If a symbol has a function 1 character in the first position, it must conform to EAN format.
Code 128 Application Record Separator Character (Code 128) Definition: Serial Cmd: This is an ASCII character that serves as an EAN separator in formatted EAN output.
Symbologies BC412 Usage: Definition: Serial Cmd: Default: Options: Widely used in semiconductor manufacturing. Particularly useful where speed, accuracy, and ease of printing are required. BC412 (Binary Code 412), a proprietary IBM symbology since 1988, is an alphanumeric symbol with a set of 35 characters, each encoded by a set of 4 bars in 12 module positions. All bars have a single width; it is the presence (1) or absence (0) of bars in each of the twelve module positions that make BC412 binary.
Interleaved 2 of 5 Interleaved 2 of 5 Usage: Definition: Serial Cmd: Default: Options: 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. A dense, contimuous, self-checking, numeric symbology.
Symbologies Symbol Length #1 (Interleaved 2 of 5) Usage: Definition: Serial Cmd: Default: Options: Useful in applications where I 2/5 symbols of a specific length are required. The Symbol Length # 1 field is one of two fields against which the decoded symbol is compared before accepting it as valid or rejecting it.
Interleaved 2 of 5 Guard Bar Status (Interleaved 2 of 5) Note: Whenever Guard Bar is enabled, the presence of guard bars (also called “bearer bars”) is required for decoding to take place. Usage: Definition: Serial Cmd: Default: Options: Useful when I-2/5 multisymbols are enabled to prevent false data output. This typically occurs with highly tilted or skewed symbols.
Symbologies Code 93 Usage: Definition: Serial Cmd: Default: Options: Sometimes used in clinical applications. Code 93 is a variable-length, continuous symbology employing four element widths. Each Code 93 character has nine modules that may be either black or white. Each character contains three bars and three spaces.
Codabar Codabar Usage: Definition: Serial Cmd: Default: Options: Used in photo-finishing and library applications. Previously used in medical applications, but not typically used in newer medical applications. Codabar is a 16-bit character set (0 through 9, and the characters $, :, /, ., +, and –) with start/stop codes and at least two distinctly different bar widths.
Symbologies Large Intercharacter Gap (Codabar) Definition: Serial Cmd: Default: Options: When disabled, the spaces between characters, or the “intercharacter gap”, are ignored during the decode process. Note: If the intercharacter space is large enough to be considered a margin, the symbol will not decode, regardless of this parameter’s setting.
Codabar Check Character Type (Codabar) Definition: Serial Cmd: Default: Options: When disabled, the imager will not perform any character checking calculations on decoded Codabar symbols. When set to Mod 16, the imager will perform a modulus 16 check character calculation on the symbol. If the symbol does not pass this calculation, it will not be decoded. When set to NW7, The imager will perform an NW7 modulus 11 check character calculation on the symbol.
Symbologies UPC/EAN Usage: Definition: Serial Cmd: Default: Options: 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. UPC (Universal Product Code) is a fixed length, numeric, continuous symbology. UPC can have two- or five-digit supplemental bar code data following the normal code.
UPC/EAN Supplementals Status (UPC/EAN) Usage: Definition: Serial Cmd: Default: Options: Reads Supplementals typically used in publications and documentation. A supplemental is a 2 to 5 digit symbol appended to the main symbol. When set to Enabled or Required, the imager reads supplemental code data that has been appended to the standard UPC or EAN codes.
Symbologies Separator Character (UPC/EAN) Note: If Separator Character has been changed to any other character and you wish to redefine the separator as a comma, you will need to use ESP. Usage: Definition: Serial Cmd: Default: Options: As required by the application. Allows the user to change the separator character from a comma to a new character. , (comma) Any ASCII character.
UPC/EAN Supplemental Type (UPC/EAN) Usage: Definition: Serial Cmd: Default: Options: As required by symbology used in application. Allows the user to select 2 character or 5 character supplements, or both. Both 0 = Both 1 = 2 characters only 2 = 5 characters only Both Either 2 character or 5 character supplementals will be considered valid.
Symbologies Pharmacode Usage: Definition: Serial Cmd: Default: Options: Used mostly with packaging for the pharmaceuticals industry. Encodes up to five different numbers, each with its own color, which may be entered in decimal or “binary” format with a 1 represented by a thick bar and a 0 represented by a thin bar. Bar width is independent of height. In decimal format, each part can be up to 999,999. In binary format, each input can have up to 19 ones and zeros.
Pharmacode Bar Width Status (Pharmacode) Definition: Serial Cmd: Default: Options: If set to Mixed, the imager will autodiscriminate between narrow bars and wide bars. If set to All Narrow, all bars will be considered as narrow bars. If set to All Wide, all bars will be considered as wide bars. If set to Fixed Threshold, it will use the fixed threshold value to determine whether the bars are narrow or wide.
Symbologies Postal Symbologies Important: Postal Symbologies must have a minimum pixels-per-element value of 4 to be decoded reliably by the MS-4X. The imager must be configured to specific read range, field of view, and camera parameters before decoding Postal Symbologies. For optimal decode results with a Standard Density (SD) imager: • Set Focal Distance and set gain and shutter settings for a high contrast image. • Position the imager 3.
Postal Symbologies Postal Symbology Type Usage: Definition: Serial Cmd: Default: Options: 6-30 The following 1D Postal Symbologies are used in mail sortation, auditing, certified mail, registered mail, metered mail, and point-of-sale (POS) applications. Determines the postal symbology that will be decoded by the imager. Disabled 0 = Disabled 1 = U.S.
Symbologies U.S. Post (POSTNET, PLANET, USPS4CB) When U.S. Post is enabled (), the imager will only decode POSTNET, PLANET, and USPS4CB symbols. Important: POSTNET Status, PLANET Status, and USPS4CB Status are enabled by default. However, if any of the three U.S. Post symbologies is set to disabled individually, symbols of that type will not be decoded by the imager even when U.S. Post is enabled. For example, if U.S.
Postal Symbologies POSTNET Status Usage: Definition: Serial Cmd: Default: Options: POSTNET is used by the United States Postal Service to direct mail. The ZIP Code or ZIP+4 Code is encoded in the symbol. Data is encoded in half-height and full-height bars, making POSTNET a “2-state” symbology. The delivery point (usually the last two digits of the address or post office box number) is also typically encoded in POSTNET symbols. If U.S.
Symbologies USPS4CB Status Usage: Definition: Serial Cmd: Default: Options: USPS4CB, also called Intelligent Mail, is used by the United States Postal Service to sort and track individual items as well as flats of mail. USPS4CB combines the capabilities of POSTNET and PLANET, and can encode 31 digits (65 bars). USPS4CB symbols are slightly longer than POSTNET symbols, and offer additional flexibility in choosing symbol height and width.
GS1 DataBar GS1 DataBar Note: GS1 DataBar symbologies were previously known as “Reduced Space Symbology”, or “RSS”. DataBar Expanded Note: DataBar Expanded was previously known as “RSS Expanded”. Usage: Definition: Serial Cmd: Default: Options: Used to encode primary and supplementary data in retail point-of-sale and other applications.
Symbologies DataBar Limited Note: DataBar Limited was previously known as “RSS Limited”. Usage: Definition: Serial Cmd: Default: Options: DataBar Limited is designed to be read by laser and CCD readers. It is not recommended for omnidirectional slot scanners. Encodes a smaller 14-digit symbol (74 modules wide) that is not omnidirectional. Disabled 0 = Disabled 1 = Enabled DataBar-14 Note: DataBar-14 was previously known as “RSS-14”.
PDF417 PDF417 Usage: Definition: Serial Cmd: Default: Options: Used in applications where a large amount of information (over 32 characters) needs to be encoded within a symbol, typically where the symbol is transported from one facility to another. For example, an automobile assembly line might use a single symbol with multiple fields of information that will be read at several stations along the way, without reference to a database.
Symbologies MicroPDF417 Usage: Definition: Serial Cmd: Default: Options: Used for labelling small items that need large data capacity. A variant of PDF417, a very efficient and compact stacked symbology that can encode up to 250 alphanumeric characters or 366 numeric characters per symbol.
Composite Composite When set to Enabled or Required, will decode the 2D composite component of a linear symbol. The linear symbol can be DataBar-14, DataBar Expanded, DataBar Limited, EAN-128, UPC-A, EAN-13, EAN-8, and UPC-E. Usage: Definition: Serial Cmd: Default: Options: Allows reading by both linear and 2D readers. Combines 2D and linear width-modulated symbology on the same symbol where different messages can be read by each reader type.
Symbologies Narrow Margins/Symbology Identifier Narrow Margins Usage: Definition: Serial Cmd: Default: Options: Used when the leading and trailing edges of the symbols are smaller than the standard margin or other objects encroach into the margins. Allows the imager to read 1D symbols with quiet zones less than 8 times the width of the narrow bar element. “Quiet zone” is the space at the leading and trailing ends of a symbol.
Narrow Margins/Symbology Identifier Symbology Identifier Definition: Serial Cmd: Default: Options: Symbology Identifier is an ISO/IEC 16022 standard prefix set of characters that identifies the symbol type. When enabled, the imager analyzes and identifies the symbology and adds a three-character identifying prefix to the data: • ] (closed bracket character) indicating the presence of a symbology identifier.
Symbologies Background Color Note: Background Color only applies to Pharmacode. Usage: Definition: Serial Cmd: Default: Options: Symbol backgrounds are often White, or other very light colors. If the background is darker than the symbol, Black background should be enabled. Allows the user to specify the symbol background used in the application.
Background Color 6-42 MS-4X Imager User Manual
7 I/O Parameters Contents I/O Parameters by ESP ................................................................................................................ 7-2 I/O Parameters Serial Commands ............................................................................................... 7-3 Symbol Data Output ..................................................................................................................... 7-4 No Read Message............................................................
I/O Parameters by ESP 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 +.
I/O Parameters I/O Parameters Serial Commands Power On/Reset Counts Time Since Reset Service Message Serial Verification Beeper Quality Output Symbol Data Output No
Symbol Data Output Symbol Data Output Symbol Data Output Status Note: Symbol Data Output relates to data and should not be confused with Outputs 1, 2, and 3 listed in the Output Parameters which describe output states and functions. Usage: Definition: Serial Cmd: Default: Options: Useful when the host needs symbol data only under certain conditions. Defines the conditions under which decoded symbol data is transmitted to the host.
I/O Parameters Good Read Usage: Definition: Good Read is used when an application requires all symbol data to be transmitted. It’s typically used in tracking applications in which each object is uniquely identified. 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.
Symbol Data Output When to Output Symbol Data Definition: Serial Cmd: Default: Options: This command allows the user to choose when symbol data can be sent to the host. As Soon As Possible 0 = ASAP 1 = End of Read Cycle As Soon As Possible Usage: Definition: As Soon As Possible is useful in applications in which symbol data needs to be moved quickly to the host, typically when the host is making decisions based on symbol data.
I/O Parameters No Read Message Usage: Definition: Used in applications where the host needs serial verification that a symbol has not been read and especially useful in new print verification. When enabled, and if no symbol has been decoded before timeout or the end of the read cycle, the No Read message will be transmitted to the host.
Output Indicators Output Indicators The MS-4X 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. 3. A row of five status LEDs on the side of the imager.
I/O Parameters Static Presentation Mode Static Presentation Mode is used in conjunction with Continuous Read Mode: . When operating in Static Presentation Mode, the red LEDs will illuminate while the imager is searching for a symbol in Continuous Read Mode. When a symbol is placed in the field of view and a good read occurs, the green LEDs will illuminate and stay on for the duration of time set in Green Flash Duration.
Output Indicators Target Pattern Usage: Definition: Serial Cmd: Default: Options: Assists users in positioning and locating symbols in the center of the imager’s field of view. The user can control when the targeting system is ON or OFF, and can save this condition for power-on.
I/O Parameters Green Flash Duration Usage: Definition: Serial Cmd: Default: Options: Provides visual verification that a good read has occurred. When a good read occurs, the green LEDs will illuminate and stay on for the time set in the Green Flash Duration value.
Beeper Beeper Usage: Definition: Serial Cmd: Default: Options: An audible verification that either a good read or a No Read has occurred. A beep is emitted after each good read or No Read. Good Read 0 = Disabled 1 = Good Read 2 = No Read 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 , , , or command is sent.
I/O Parameters LED Configuration Usage: Definition: Serial Cmd: Default: Options: Useful as a visible indicator of read rates and symbol quality. Determines the mode in which the status LEDs operate. Standard 0 = Standard 1 = ISO/IEC 16022 grade In ISO/IEC 16022 grade mode the LEDs represent the grade of the first Data Matrix symbol decoded in the read cycle. The parameter to be graded is set in the ISO/IEC 16022 Grade options.
Serial Verification Serial Verification Allows the user to verify configuration command status. Serial Command Echo Status Usage: Definition: Function: Serial Cmd: Default: Options: This command is useful in removing any doubt about the imager’s interpretation of any configuration command. For example, if the current preamble is “SOM” and is entered, the imager will echo back since the attempted entry “START” exceeds the four character limit for that command.
I/O Parameters Control/Hex Output Usage: Definition: Serial Cmd: Default: Options: Useful for viewing settings with binary characters when using serial commands on a terminal. Determines the response to a Serial Command Echo or status request command. When set to Control, two characters are transmitted to represent a non-displayable character. For example, a carriage return will be shown as: ^M.
EZ Button EZ Button The EZ button has four positions, selectable by the length of time the button is held down, and indicated by one, two, three, and four beeps in succession. Each position can be programmed for any of eight options. Definition: Serial Cmd: Default: Options: Serves as a master switch to enable/disable the EZ button status.
I/O Parameters Default on Power-On Definition: Serial Cmd: Default: Options: When enabled, if the EZ button is held down on power-on the imager will default to customer defaults and save for power-on. This is the same as sending a command.
EZ Button Modes EZ Button Modes Usage: Definition: Serial Cmd: Options: Useful for performing multiple, repetitive tasks at the work site. Allows the user to program each of the EZ button’s 4 positions from a selection of 8 modes. 0 = Disabled 1 = Enabled Single Beep 0 = Disabled 1 = Read Rate 2 = Calibrate 3 = Save for Power-On 4 = Unused 5 = Load New Master 6 = Unused 7 = Target System 8 = Unused 9 = Bar Code Config.
I/O Parameters Target System Turns on the target pattern whenever the associated button position is selected. To disable, quickly press and release the EZ button. Note: This mode is the only one that does not require that the button be released before taking effect. Thus, as soon as the imager beeps the appropriate number of times for the position, it will take effect.
Configurable Output 1 Configurable Output 1 Usage: Definition: Serial Cmd: Default: Options: This option provides discrete signalling to host software to control external devices such as PLCs and relays. It is useful for routing, sorting, and to prevent mis-packaging and mis-routing. Sets the discrete output functions for specific user-selected conditions. Allows the user to set the conditions under which an output (or outputs) will be activated.
I/O Parameters Trend Analysis Usage: Definition: Typically used when successful decodes are occurring but a discrete output is needed to flag a trend in quality issues. Activates discrete output when a trend analysis condition is met, depending on the trend analysis option enabled. Symbol Quality Usage: Definition: Typically used when a discrete indication is needed to flag a symbol quality condition.
Configurable Output 1 Output State Definition: Serial Cmd: Default: Options: Sets the active electrical state of the discrete output. Negative 0 = Negative 1 = Positive Pulse Width Definition: Serial Cmd: Default: Options: Sets the time in 10 ms increments that the discrete output remains active. 5 (Corresponds to 50 ms) 0 to 255 (0 to 2.55 seconds).
I/O Parameters Trend Analysis Output 1 Note: Output On under Output 1 Parameters must be set to Trend Analysis for this output to function. Under Output 1 Parameters, expand the Trend Analysis tree: Usage: Definition: Example: Useful in cases where the user doesn’t want to shut down for one condition but wants to monitor quality and read conditions. Applies Trend Analysis settings to Output 1.
Configurable Output 1 Trend Analysis Mode Definition: Sets the trend condition (Mismatch, No Read, or Decodes per Trigger) that will activate the output.
I/O Parameters Trigger Evaluation Period Definition: Serial Cmd: Default: Options: The number of triggers to examine for the trend analysis condition. 0 0 to 255 Number to Output On Usage: Definition: Serial Cmd: Default: Options: Example: If Number to Output On is set to 3 and Trend Analysis Mode is set to No Read, then the output will not be activated until 3 No Reads have occurred.
ISO/IEC 16022 Symbol Quality Output 1 ISO/IEC 16022 Symbol Quality Output 1 Note: Output On under Output 1 Parameters must be set to Symbol Quality for this output to function. Under Output 1 Parameters, expand the Symbol Quality (ISO/IEC 16022) tree. Output on Symbol Contrast Usage: Definition: Serial Cmd: Default: Options: Lets the user know if symbol quality is less than acceptable. If enabled, toggles Output 1 to an active state when Symbol Contrast Threshold is met.
I/O Parameters Output on Axial Non-Uniformity Usage: Definition: Serial Cmd: Default: Options: Lets the user know if symbol quality is less than acceptable. If enabled, toggles Output 1 to an active state when Axial Non-Uniformity Threshold is met.
Print Growth Threshold Usage: Definition: Serial Cmd: Default: Options: Lets the user set the acceptable level of symbol quality. Conforms to ISO/IEC 16022 symbol quality grading (A,B,C,D).
I/O Parameters Diagnostics Output 1 Note: Output On under Output 1 Parameters must be set to Diagnostic Warning for this output to function. Under Output 1 Parameters, expand the Diagnostics tree. Serial Cmd: Default: Options: 0 0 = Disabled Service Unit When Diagnostic Warning is enabled, the Output On configuration has no effect. The output will remain active as long as one of the diagnostic warning conditions is met.
Configurable Output 2 Configurable Output 2 Note: Output 2 has the same parameters and default settings as Output 1. Serial Cmd: Trend Analysis Output 2 Note: Output On under Output 2 Parameters must be set to Trend Analysis for this output to function.
I/O Parameters Configurable Output 3 Note: Output 3 has the same parameters and default settings as Output 1 and Output 2. Serial Cmd: Trend Analysis Output 3 Note: Output On under Output 3 Parameters must be set to Trend Analysis for this output to function.
Power On/Reset Counts Power On/Reset Counts Note: Power On/Reset Counts is a read-only command. Power-On Serial Cmd: Power-On uses a 16-bit counter that increments each time the imager is powered-on. Resets Serial Cmd: Resets uses a 16-bit counter that increments each time the imager is reset. This value is reset at power-on.
I/O Parameters Time Since Reset Note: Time Since Reset is a read-only command. Hours Serial Cmd: Default: 16-bit counter (0 to 65535) Hours uses a 16-bit counter that increments every 60 minutes. Minutes Serial Cmd: 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 or command.
Service Message Service Message When Service Message is enabled, a message of up to 10 ASCII characters is sent whenever the system detects that the service timer’s limit has been reached. The service timer is reset at power-on, meaning that the service timer’s limit is the amount of time since last reset. Service timer increments can be set in seconds or minutes.
I/O Parameters Frame Information Output Frame Number Serial Cmd: Default: Disabled Options: 0 = Disabled 1 = Enabled Disabled When Output Frame Number is set to Disabled, the frame number is not output as part of the symbol data. Enabled When Output Frame Number is set to Enabled, the number of the frame in which the symbol was first decoded is attached to the symbol output information.
Image Output Image Output Usage: Definition: Serial Cmd: Default: Options: This feature allows the user to select what read cycle condition triggers the image file output. Used to output an image file when a specified read cycle condition has been met, such as No Read or Good Read. When the read cycle is complete, the normal read cycle output will occur, including any configured postamble or preamble data.
I/O Parameters Communication Port Definition: Serial Cmd: Default: Options: This setting selects the communication port through which the image file will be transferred to the host. Host 0 = Host 1 = Auxiliary 2 = USB File Format Definition: Serial Cmd: Default: Options: This setting selects the format of the image file to be output.
Image Output Image Output Example The following example assumes that the imager is set to output on No Read, and that it is in a rapid capture mode of 3 captures.
I/O Parameters Database Identifier Output Usage: Serial Cmd: Default: Options: Useful in keeping track of which database entries read which symbols. 0 0 = Disabled 1 = Enabled Output Status Disabled When this command is disabled, no database identifier information will be output. Enabled When this command is enabled, the imager will append a two-digit number and the characters “DB” to the data output following the separator for each symbol decoded using Configuration Database.
Quality Output Quality Output Separator Definition: Serial Cmd: Default: Options: The separator character separates quality output data from symbol data. , Any ASCII character. Important: The ASCII characters <, >, and , can only be entered as hex pairs: For <: For >: For , : See ASCII Character Entry Modifier for a detailed explanation of how to enter ASCII characters as hex values.
I/O Parameters Configuring EZ Trax Output After you have set up your imager for EZ Trax, you can configure the software in three different ways: using the EZ Trax interface, using the tree controls in ESP, and using serial commands. For detailed information about how to use the EZ Trax user interface for configuration, refer to the Help menu in EZ Trax software, or the EZ Trax Quick Start Guide, available on the Microscan Tools Drive.
Configuring EZ Trax Output EZ Trax Output When EZ Trax output is enabled, the imager will attempt to output all enabled EZ Trax options. EZ Trax will not function unless enabled. 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.
I/O Parameters JPEG Quality 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. Object Info Output 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.
Configuring EZ Trax Output Configuring EZ Trax Output by Serial Command Usage: Definition: Serial Cmd: Default: Options: Useful for when you want to configure EZ Trax output using serial commands instead of the EZ Trax graphic interface. When EZ Trax output is enabled, the imager will attempt to output all enabled EZ Trax options. EZ Trax will not function unless enabled.
I/O Parameters No Read Outputs the first No Read image in the read cycle. The image file will immediately follow the symbol data. Note: If two symbols are present in the same image capture and one of them is successfully decoded, no image will be output. No Read and Good Read Outputs the first No Read or Good Read image in the read cycle. Mismatch Outputs the image of the first mismatch condition. Image Format Definition: Serial Cmd: Default: Options: Selects the format of the image output file.
Configuring EZ Trax Output Object Info Output Definition: Serial Cmd: Default: Options: If a symbol is decoded during an image capture, the symbol type and other supplementary symbol information is also included. Disabled 0 = Disabled 1 = Enabled Grade Output Definition: Serial Cmd: Default: Options: 7-46 Symbol quality information will be output in the form of an abbreviated identifier for each read cycle.
8 Symbol Quality Contents Symbol Quality Serial Commands ................................................................................................ 8-2 Overview of Symbol Quality.......................................................................................................... 8-3 Symbol Quality by ESP................................................................................................................. 8-4 Symbol Quality Separator/Data Matrix Output Mode..............................
Symbol Quality Serial Commands Symbol Quality Serial Commands Symbol Quality Separator/ Data Matrix Output Mode ISO/IEC 16022 Symbol Quality Output Microscan Symbol Quality Output Static Validation Report 8-2 MS-4X Imager User Manua
Symbol Quality Overview of Symbol Quality Information about symbol quality and timing can be appended to symbol data by enabling specific evaluation parameters. The order in which these values are appended corresponds directly to the order in which they appear in ESP‘s Symbol Quality tree control. Symbol Quality parameters are separated into ISO/IEC 16022 Symbol Quality Output and Microscan Symbol Quality Output.
Symbol Quality by ESP Symbol Quality by ESP To open nested options, single-click the +. Click the Parameters button and then the Symbol Quality tab. To change a setting, double-click the setting and use your cursor to scroll through the options.
Symbol Quality Report Tab The Report tab allows the user to initiate Data Matrix Grading and to generate and save grading reports. To save the report as a PDF file, an HTML file, a CSV file, or an RTF file, click the Save Report button. Reports appear in the viewing area underneath the Data Matrix Grading and Save Report buttons. The Symbol Quality interface is divided into three sections: Report, Locate, and Preferences. The imager’s field of view is shown here.
Symbol Quality by ESP Locate Tab The Locate tab allows the user to determine the position of the symbol within the imager’s field of view, and to optimize the imager’s camera settings for symbol quality evaluation. Click the Locate button to display the symbol in the imager’s field of view. 8-6 Click the Calibrate button to optimize camera settings.
Symbol Quality Preferences Tab The Preferences tab allows the user to set defaults that are automatically activated when grading is completed. For this reason, the user is advised to set preferences before performing grading. This information is appended at the bottom of the report. Choose the default report type to be generated when you click Save Report on the Report tab. Check Autofit Content to ensure that saved PDF report content will fit on a single page.
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: Serial Cmd: Default: Options: Inserts a separator between each enabled field of the symbol quality output. (space character) Any ASCII character.
Symbol Quality Data Matrix Output Mode Note: Output Mode applies to ISO/IEC 16022 symbol quality parameters. Definition: Serial Cmd: Default: Options: Output Mode specifies how the four output parameters, if enabled, are formatted. Grade 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.
ISO/IEC 16022 Symbol Quality Output ISO/IEC 16022 Symbol Quality Output Symbol Quality Parameters for Data Matrix symbols specified by ISO/IEC 16022. Symbol Contrast Usage: Definition: Serial Cmd: Default: Options: Lets the user know if contrast settings are less than acceptable. All the pixels that fall within the area of the test symbol, including its required zone, will be sorted by their reflectance values to select the darkest 10% and the lightest 10% of the pixels.
Symbol Quality Axial Non-Uniformity (Data Matrix Only) Definition: Serial Cmd: Default: Options: Axial non-uniformity is a measure of how much the sampling point spacing differs from one axis to another, namely AN = abs (XAVG YAVG) / ((XAVG + YAVG)/2) where abs () yields the absolute value. If a symbology has more than two major axes, then AN is computed for those two average spacings which differ the most. (ANSI) axial non-uniformity grading is defined this way: A (4.0) if AN < .06 B (2.0) if AN < .
ISO/IEC 16022 Symbol Quality Output by ESP ISO/IEC 16022 Symbol Quality Output by ESP ESP’s Symbol Quality interface allows you to evaluate Data Matrix symbols for compliance with ISO/IEC 16022 requirements. First, determine which ISO/IEC 16022 Parameters you need to evaluate, using the Symbol Quality tree control. Once you have set these Data Matrix evaluation parameters, go to the Preferences Tab and set your Data Matrix Grading Report output preferences.
Symbol Quality Microscan Symbol Quality Output Percent Cell Damage (Data Matrix Only) Definition: Serial Cmd: Default: Options: When this feature is enabled, the cell damage percentage is appended to data output.
Microscan Symbol Quality Output Decode Time Definition: Serial Cmd: Default: Options: The time in milliseconds required to decode a symbol. When enabled, the decode time is appended to the symbol data.
Symbol Quality Quiet Zone (Data Matrix Only) Definition: Serial Cmd: Default: Options: When this feature is enabled, the size of the quiet zone is evaluated and a PASS or FAIL message is appended to the symbol data.
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. First, determine which parameters you want to evaluate, using the Symbol Quality tree control. Once you have set these Data Matrix evaluation parameters, go to the Preferences Tab and set your Data Matrix Grading Report output preferences.
9 Matchcode Contents Matchcode by ESP ....................................................................................................................... 9-2 Matchcode Serial Commands ...................................................................................................... 9-3 Overview of Matchcode ................................................................................................................ 9-4 Matchcode Type ...............................................................
Matchcode by ESP Matchcode by ESP Click the Parameters button and then the Matchcode tab. To open nested options, single-click the +. 9-2 To change a setting, double-click the setting and use your cursor to scroll through the options.
Matchcode Matchcode Serial Commands Matchcode Type Number of Master Symbols New Master Pin Enter Master Symbol Data Request Master Symbol Data Delete Master Symbol Data Match Replace Mismatch Replace MS-4X Imager User Manual [for all] or
Overview of Matchcode Overview of Matchcode Definition: Usage: Matchcode allows the user to store master symbol data in the imager’s memory, compare that data against other symbol data, and define how symbol data and/or discrete signal output will be directed. A master symbol database can be set up for up to 10 master symbols.
Matchcode Matchcode Type Definition: Allows the user to choose the way that master symbols will be compared with subsequently read symbols. Note: First set Triggering Mode to External or Serial. ESP: Serial Cmd: Default: Options: Disabled: Enabled: Wild Card: Sequential: Disabled 0 = Disabled 1 = Enabled 2 = Wild Card 3 = Sequential Has no effect on operations.
Matchcode Type Sequential Matching Usage: Definition: Serial Cmd: Default: Options: Useful in tracking product serial numbers that increment or decrement sequentially. With Sequential enabled, Sequential Matching determines if a count is in ascending (incremental) or descending (decremental) order.
Matchcode Wild Card Character Usage: Definition: Serial Cmd: Default: Options: Example: With Wild Card Character defined as the default asterisk, defining CR*34 as the master symbol will result in matches for CR134 and CR234, but not CR2345. Entering URGENT** as your master symbol will result in matches for URGENT, URGENT1, and URGENT12 but not for URGENT123.
Matchcode Type Sequence on No Read Usage: Definition: Serial Cmd: Default: Options: Sequence on No Read is useful when the imager needs to stay in sequence even if no decode occurs. When Sequence on No Read is Enabled and Matchcode is set to Sequential, the imager sequences the master symbol on every match or No Read. When disabled, it does not sequence on a No Read.
Matchcode Sequence on Mismatch Note: Matchcode must be set to Sequential for this command to function. Usage: Definition: Serial Cmd: Default: Options: Enable this parameter if every trigger event should have a decode and more than one consecutive mismatch may occur. Disable this parameter if every trigger event should have a decode but no more than one consecutive mismatch may occur. When set to Enabled, the master symbol sequences on every decode, match, or mismatch.
Match Replace Match Replace Usage: Definition: Serial Cmd: Default: Options: Provides a convenient shortcut for applications that need to output a predefined text string whenever a symbol matches a master symbol. Outputs a user-defined data string whenever a match occurs and Matchcode is enabled.
Matchcode Mismatch Replace Usage: Definition: Serial Cmd: Default: Options: Provides a convenient shortcut for applications that need to output a predefined text string whenever a symbol does not match a master symbol. Outputs a user-defined data string whenever a mismatch occurs and Matchcode is enabled.
New Master Pin New Master Pin Definition: Serial Cmd: Default: Options: If Matchcode and New Master Pin are enabled and the new master pin is momentarily connected to ground (must be held low for a minimum of 10 ms) master symbol information will be loaded into the database based on the next read cycle that achieves a Good Read, starting with Index 1. The Master Symbol Database will be loaded with all symbols decoded in the read cycle as long as it does not exceed the Number of Master Symbols parameter.
10 Camera and IP Setup Contents Camera and IP Setup by ESP .................................................................................................... 10-2 Camera and IP Setup Serial Commands.................................................................................... 10-3 Video........................................................................................................................................... 10-4 Evaluation .............................................................
Camera and IP Setup by ESP 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 +.
Camera and IP Setup Camera and IP Setup Serial Commands Mirrored Image Window of Interest Focal Distance Focal Distance Table (Read-Only) Illumination Brightness Skew Correction Camera Pixel Sub-Sampling Morphological Pre-Processing Morphological Operation MS-4X Imager User Manual
Video Video The Video view is similar to the EZ Mode interface, in that the user has the ability to perform the same Locate, Calibrate, and Test routines. There is also a focal distance adjustment tool to the right of the video view. Video also features Capture and Decode functionality, which is similar to the Configuration interfaces (Communication, Read Cycle, Symbologies, I/O, Matchcode, and Diagnostics). Initiates Calibration routine.
Camera and IP Setup Evaluation In Evaluation, you can view images currently in the imager, capture and decode a symbol, save it as a digital file, and perform histogram and line scan evaluations. When you click on the Evaluation tab, you will see the images that are currently stored in the imager. Click Receive to refresh this view. Click Capture/Decode to display the current stored image. Only one capture and decode event will occur, regardless of read cycle settings. Click Read to trigger a read cycle.
Evaluation Histogram Usage: Definition: Useful in determining quality and contrast of symbols. A histogram is a graphic representation of the numeric count of the occurrence of each intensity (gray level) in an image. The horizontal axis represents the values of gray levels, and the vertical axis represents the number of pixels for each gray level. Note: Since histograms are performed in the imager, the results will be saved regardless of whether the image was uploaded as a JPEG (.jpg) or a bitmap (.
Camera and IP Setup Line Scan 1. From the Evaluation tab, click the Line Scan button. A window like that shown below will appear. 2. Drag your cursor horizontally across the image. This will create a dashed horizontal line. Pixel information and a visual representation of the dark and light pixels will be displayed below the image. When you center your cursor over the dashed line, it becomes a double arrow cross. This allows you to move the line anywhere in the window.
Calibration Calibration The Calibration interface in ESP is a powerful and intuitive way to optimize the imager’s performance. It allows the user to control several complex, simultaneous calibration operations, and to follow the progress of those operations using cues such as progress bars, real-time representations of calibration values, and other dynamic user feedback. See Calibration for full documentation of this feature.
Camera and IP Setup Window of Interest The active pixel area of the image sensor is called the Window of Interest (WOI). The WOI allows the user to select an area of the field of view in which the desired symbol is located. The programmable window of interest increases decode speed, improves threshold, and makes it easy to select specific symbols from among several in the field of view. The user provides the upper-left pixel location and the size of the window to define the Window of Interest.
Window of Interest Window of Interest by ESP 1. From the Camera menu, click the WOI tab to bring up Window of Interest. If you haven’t already captured an image, click the Capture and Decode button to decode the present image. If successful, the Good Read indicator on the WOI tab will be green and the symbol will appear in the pane below. Note: You can resize the image by clicking and dragging the ESP window from the lower right corner. This is useful where very small symbols are being read. 2.
Camera and IP Setup Window of Interest by Serial Command The figure shows where to locate the start position of the row and column pointers and how to measure the column depth and row width dimensions. Top (Row Pointer) Definition: Defines the row position of the upper-left starting point of the window.
Configuration Database Configuration Database The Configuration Database allows the user to manage multiple configuration profiles. It is a useful tool in applications that require several different imager configurations to be applied sequentially, and it allows the user to perform far more complex operations than would be possible with only one set of configuration parameters. See Configuration Database for full documentation of this feature.
Camera and IP Setup Dynamic Setup Dynamic Setup is used to calculate image capture timing during a read cycle. Without proper timing, the imager will not be able to decode all symbols in a read cycle. An external trigger is used to activate image captures so the user can make timing adjustments as capture events occur.
X-Mode™ X-Mode™ The MS-4X 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.
Camera and IP Setup Pixel Sub-Sampling Definition: Usage: Default: Options: Pixel Sub-Sampling shows an entire captured image by averaging signals from adjacent pixels. Disabled 0 = Disabled 1 = 4:1 2 = 16:1 4:1 At 4:1, 4 pixel signals from 2 adjacent rows and columns are combined so that only 1 pixel is output for every 4 pixels sampled. An image with the dimensions 640 x 480 is scaled to 320 x 240.
Pixel Sub-Sampling AEC/AGC Mode Note: AEC/AGC Mode is only applicable to the High Speed version of the MS-4X. Definition: Usage: Default: Options: 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 and IP Setup Camera Settings Camera Settings are typically obtained during the calibration process, and do not necessarily need to be modified directly by the user. Optics The MS-4X 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. Standard Density (HD 1.
Camera Settings MS-4 Low Density (SD Optics), 4” Focal Distance Shutter Speed Usage: Definition: Serial Cmd: Default: Options: Faster shutter speeds reduce blurring in faster applications. Slower shutter speeds are useful in slower applications and lower contrast applications. This value sets the exposure or integration time for the image sensor pixels. The shutter speed setting in relation to the speed of the object is critical.
Camera and IP Setup Focal Distance Definition: Serial Cmd: Default: Options: This command returns the Imager’s factory preset focal distance.
Focal Distance Table (Read-Only) Focal Distance Table (Read-Only) Number of Focal Distances Definition: Serial Cmd: Default: Options: Specifies the number of focal distances supported by the imager (1). 1 N/A (Focal Distance is factory preset.) Focal Distance Definition: Serial Cmd: Default: Options: 10-20 Returns the imager’s factory preset focal distance.
Camera and IP Setup Mirrored Image Usage: Definition: Serial Cmd: Default: Options: Enable this setting when the Imager is viewing a mirrored image (as when it is being used with a right-angle mirror attachment). When enabled, outputs a mirrored image of the symbol. Both 0 = Regular Image 1 = Mirrored Image 2 = Both (auto-detect normal/mirrored) Regular Image When Regular Image is enabled, images will be processed as they appear upon capture.
Illumination Brightness Illumination Brightness Definition: Serial Cmd: Default: Options: This feature allows the user to adjust the brightness of the illumination LEDs. Since the imager has control over the brightness of the illumination, it can provide consistent brightness output between imagers through a factory calibration operation. Each of the brightness settings is calibrated to provide the same level of intensity for each imager.
Camera and IP Setup Skew Correction Note: Skew Correction does not apply to the High Speed version of the MS-4X, which has a global shutter. The MS-4X’s CMOS image sensor has a “rolling shutter” mechanism that controls pixel integration row-by-row, unlike a global shutter, Full Image Height which performs light integration of all pixels at once. When a row of pixels has integrated light for the amount of time specified by the Full Image Width user-defined shutter speed, that row will be read out.
Skew Correction Line Speed Definition: Serial Cmd: Default: Options: Line Speed 10” / sec 20” / sec 30” / sec 40” / sec 60” / sec 80” / sec This feature is used to specify the line speed of the application, and it determines how much distortion correction to apply. When enabled, this feature will cause the overall decode rate to increase significantly. The timing information in the table below is for a full megapixel image (1280 x 1024). Note: Processing time decreases with larger image sizes.
Camera and IP Setup Symbol Direction Definition: Serial Cmd: Default: Options: This feature specifies the direction the symbol is moving through the imager’s field of view, or which side of the field of view the symbol will enter first. Note: Image captures of symbols entering the field of view from above or below cannot be skew-corrected. Right 0 = Right 1 = Left If a symbol enters the field of view from the left, it will be skewed as shown in the image below.
Morphological Pre-Processing Morphological Pre-Processing Morphological Pre-Processing allows the user to select the method for processing images, and to choose the operator size for that method. Important: This command must be set to Enabled for Morphological Operation to function.
Camera and IP Setup Morphological Operation and Operator Size Morphological Operation Definition: Serial Cmd: Default: Options: Morphological Operation allows the user to select the method for processing captured images. Erode 0 = Erode 1 = Dilate 2 = Open 3 = Close Erode 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.
Morphological Operation and Operator Size Open 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.
Camera and IP Setup Operator Size Definition: Serial Cmd: Default: Options: Operator Size determines the size of the area or “pixel neighborhood” (measured in pixels) in which the morphological operation is being performed.
Morphological Operation and Operator Size 10-30 MS-4X Imager User Manual
11 Configuration Database Contents Configuration Database Serial Commands ................................................................................ 11-2 Number of Active Indexes .......................................................................................................... 11-3 Configuration Database Status................................................................................................... 11-4 Database Mode ...................................................................
Configuration Database Serial Commands Configuration Database Serial Commands Number of Active Indexes Configuration Database Status Save Current Settings to Database Load Current Settings from Database Request Selected Index Settings Request All Database Settings Database Mode 11-2
Configuration Database Number of Active Indexes Usage: Definition: Serial Cmd: Default: Options: Useful for applications that require several different complex imager configurations to be applied sequentially. Multiple database indexes allow you to concatenate configuration profiles, and to perform more complex operations than would be possible with only one set of configuration parameters.
Configuration Database Status Configuration Database Status Index Usage: Useful for applications that require several different complex Imager configurations to be applied sequentially. Multiple database indexes allow you to concatenate configuration profiles, and to perform more complex operations than would be possible with only one set of configuration parameters. Definition: Determines the specific database index that will be used.
Configuration Database Row Pointer Definition: The image dimension settings can be applied as a Window of Interest or a Region of Interest, depending on the image dimension mode selected in the Database Mode command.
Configuration Database Status Threshold Mode Serial Cmd: Default: Adaptive Options: 0 = Adaptive 1 = Fixed Fixed Threshold Value Serial Cmd:
Configuration Database Symbology Definition: This field allows the user to configure the database to enable specific symbologies for selected database indexes. Symbology-specific parameters must be configured with the appropriate symbology command. For example, if fixed length Code 128 is required, it must first be set up with the Code 128 command: . To select a particular symbology, add the number value associated with that symbology.
Configuration Database Status Code 39 (Add 16) If enabled, Code 39 will be active for this database index. Codabar (Add 32) If enabled, Codabar will be active for this database index. Code 93 (Add 64) If enabled, Code 93 will be active for this database index. Interleaved 2 of 5 (Add 128) If enabled, Interleaved 2 of 5 will be active for this database index. UPC/EAN (Add 256) If enabled, UPC/EAN will be active for this database index.
Configuration Database Micro QR Code (Add 65536) 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.
Database Mode Database Mode Switch Mode Definition: Selects the event that causes the imager to load the next database entry to current, active settings. When Frame Count/Time expires and Image Process Looping is enabled, the next database entry with modifications to camera settings will be used. Note: The image capture event always occurs when the first database entry is used.
Configuration Database Image Process Looping Usage: Useful in applications where it is necessary to process a single captured image multiple times using different IP and decode parameters. Serial Cmd: Default: Disabled Options: 0 = Disabled 1 = Enabled Disabled When Image Process Looping is set to Disabled, an image is captured for every database configuration, whether or not any camera settings have been modified.
Database Mode Image Dimensions Definition: Serial Cmd: Default: Options: Determines how the image dimension parameters will be implemented. 0 0 = Window of Interest 1 = Region of Interest Window of Interest (WOI) by ESP When Image Dimensions is set to Window of Interest, the database image dimension parameters are camera settings, and they determine the size of the image to be captured.
Configuration Database Region of Interest (ROI) When Image Dimensions is set to Region of Interest, the database image dimension parameters are IP and decode settings, and they determine the region or area of the captured image to be processed. ROI coordinate data is based on the full image size. The WOI of the captured image will be configured to cover all the ROI settings in the current, active database entry.
Database Mode Region of Interest (ROI) by ESP When Image Dimensions is set to Region of Interest, the database image dimension parameters are 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.
Configuration Database Save Current Settings to Configuration Database Definition: Serial Cmd: Allows current, active configuration settings to be saved to a selected database index. Example: 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.
Load Current Settings from Configuration Database Load Current Settings from Configuration Database Definition: Serial Cmd: Allows the configuration settings contained in a selected database index to be loaded to current, active configuration settings. Example: This command phrase loads the configuration settings contained in database index 5 to current, active configuration settings.
Configuration Database Request Selected Index Settings Definition: Serial Cmd: Returns configuration settings for the selected database index. Example: This command phrase returns the configuration settings for database index 5.
Request All Configuration Database Settings Request All Configuration Database Settings Definition: Serial Cmd: Returns configuration settings for all indexes in the Configuration Database. Example: This command phrase returns the configuration settings for all 10 database indexes.
12 Terminal Contents Terminal Window........................................................................................................................ 12-2 Find ............................................................................................................................................ 12-3 Send ........................................................................................................................................... 12-4 Macros...........................................
Terminal Window Terminal Window Click this button to display the Terminal view. The following view will appear: Copy, paste, save Clear screen Type text here to find matching text in the Terminal window. Terminal screen Macros listed on this bar Type serial commands here. Click on desired Macro to run. Click on Macros arrow to Add Macro, Remove Macro, or Edit Macro.
Terminal Find The Find function allows you to enter text strings to be searched for in the Terminal window. For example, a series of symbols have been scanned into the Terminal view and you want to determine if a particular symbol whose data begins with “ABC” has been read. 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”.
Send Send 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 .
Terminal Macros Macros can be stored in a macro selection bar, edited in a separate window, and executed by clicking on the macro name. Click on Next Row to see the next row of macros Click on the first arrow here to see Add Macro or Default Macros. When macros are defaulted, the entire macro set is restored to the original macro commands. Click on subsequent arrows to edit macros. When you click on the macro name, the macro is executed in the Terminal window.
Terminal Window Menus Terminal Window Menus Right-click on the Terminal window to display the following menu: • • • • • • • • • • • • Copy selected text to clipboard. Paste from Terminal or other text. Clear all text in Terminal window. Select All text in the Terminal window. Save... brings up a Save As dialog. Change Font... of text in Terminal; brings up a Font dialog. Change Echo Font... to change typed text; brings up a Font dialog. Enable Echo enables Echo text (typed by user).
13 Utilities Contents Serial Utility Commands ............................................................................................................. 13-2 Read Rate .................................................................................................................................. 13-4 Counters ..................................................................................................................................... 13-6 Device Control ..........................................
Serial Utility Commands Serial Utility Commands Note: For a list of all K commands, see Serial Configuration Commands.
Utilities Default/Reset/Save Imager Status Request Commands Learn Other Operational Commands MS-4X Imager User Manual <@CAL> Save Current Settings as Customer Default Parameters for Power-On Recall Microscan Default Parameters and Save for Power-On Recall Customer Default Parameters and Save for Power-On Imager Status Byte All Status Request All Descrip
Read Rate Read Rate Click the Utilities button and then the Read Rate tab to display the Read Rate view. To see the number of decodes per second, click the Decodes/sec radio button and then the Start button. To see the percentage of decodes, click the Percent radio button and then the Start button. Read Rate information is displayed in the lower portion of the Utilities view. Serial commands can also be sent to the imager from this screen.
Utilities Read Rate Serial Utility Commands Enter Decodes/Second Test Sending instructs the imager to transmit the decodes per second and symbol data (if any). The decode rate can vary dramatically due to the angle and location of the symbol in relation to the field of view. This test is very useful in aligning and positioning the imager during setup. Enter Percent Test Sending instructs the imager to transmit the percentage of decodes and any decoded symbol data.
Counters Counters Click the Utilities button and then the Counters tab to display the Counters view. Counter commands can be a numeric value from 00000 to 65535. After reaching the maximum numeric limit of 65535, an error message will be displayed and the counter will automatically roll over and start counting again at 00000.
Utilities Counters by Serial Command No Read Counter Sending displays the total number of No Reads that have occurred since the last reset. No Read Counter Reset Sending sets the No Read Counter to 00000. Trigger Counter Sending displays the total number of triggers since the last reset. Trigger Counter Reset Sending sets the trigger counter to 00000.
Device Control Device Control Click the Utilities button and then the Device Control tab to display the Device Control view. The Output 1 Pulse, Output 2 Pulse, and Output 3 Pulse buttons activate the link between the + and – of the host connector. The buttons in the Extras section Disable or Enable the reader. Device Control by Serial Command Output 1 Pulse Sending activates the link between Output 1 (+) and Output 1 (–) of the host connector (regardless of Master Symbol or Output 1 status).
Utilities Differences from Default Click the Utilities button and then the Differences tab to display the Differences from Default view. Clicking the Differences from Default button will cause ESP to check all stored configuration settings and compare them to default settings. All settings that are different than default will appear in the left column (shown below), and descriptions of those settings will appear in the right column.
Master Database Master Database Click the Utilities button and then the Master Database tab to display the Master Database view. Important: The Master Database is used for all Matchcode modes except Sequential and Wild Card, both of which use Master Database Index # 1. Master Database Overview Used where more than one master symbol is required, as in a Multisymbol setup, for matching and other Matchcode operations.
Utilities Master Symbol Database Size Definition: Serial Cmd: Default: Options: Number of Master Symbols allows you to select 1 to 10 master symbols for the master symbol database. Note: You must follow this command with a save command or . 1 1 to 10 Set Master Symbol Database Size here.
Master Database Enter Master Symbol Data Usage: Allows you to enter master symbol data for any enabled master symbol index number (1 to 10), provided the total number of characters does not exceed the maximum allowed. Serial Cmd: Options: Enter data for 1 to 10 symbols (any combination of ASCII text up to the maximum allowed.
Utilities Request Master Symbol Data Definition: Serial Cmd: Returns master symbol data for any enabled master symbols from 1 to 10. For example, to request master symbol # 5, enter . The imager transmits master symbol # 5 data in brackets in the following format: <5/>. If no master symbol data is available, the output will be: <5/>. Caution: Be sure to add the ? or you will delete the master symbol.
Read Next Symbol as Master Symbol Definition: Serial Cmd: ESP: After you’ve set the size in the database, you can order the imager to read the next symbol as the master symbol for any given master symbol number. To store the next symbol decoded as master symbol # 1, send: or . To store the next symbol decoded as the master symbol for any other master symbol database number, send: .
Utilities Delete Master Symbol Data Definition: ESP: You can directly delete the master symbol data by serial command or by ESP. 1. Click the Utilities button to access the master symbol. 2. Click the Master Database tab and double-click the symbol number you want to delete. 3. Delete text and click OK. Serial Cmd: To delete a master symbol, enter the database number and a comma, but leave the data field empty.
Firmware Firmware Click the Utilities button and then the Firmware tab to display the Firmware view. Firmware Update Application code versions are specific to your imager. Consult with your sales representative before downloading application code. If needed, an application code will be sent to you in the form of a *.mot file. To download application code: 1. First, be sure that your imager is connected to the host. 2. Apply power to the imager. 3. Before updating, you should verify the current firmware.
Utilities Firmware Verification Request Part Number by ESP You can send a request to the imager for part numbers, checksums, boot code, and application code. 1. Click the Firmware tab. 2. From the pulldown selection box to the left of the Request Part No. button, make your selection. 3. Select the code type to see its part number displayed in the text field to the right of the Request Part No. button.
Firmware Request Checksum by ESP You can send a request to the imager for part numbers, checksums, boot code, and application code. 1. Click the Firmware tab. 2. From the pulldown selection box to the left of the Request Checksum button, make your selection. 3. Select the code type to see its checksum displayed in the text field to the right of the Request Checksum button.
Utilities Default/Reset/Save Understanding and controlling your imager’s active, saved, and default settings is critical to its successful operation.
Default/Reset/Save Customer Default Parameters Customer default parameters (saved by ) are the same set of parameters as power-on parameters but are saved in a different, isolated section of NOVRAM. This allows a user essentially to create a backup set of parameters that can be recalled in the event that the current parameters or power-on parameters have been accidentally changed or are no longer desired. It is important to note that a hardware default does not affect customer default parameters.
Utilities Imager Status Requests Status Byte The imager responds to a status request with a two character hex value, such as . To determine status: 1. Look up the binary conversion in the table below. For example, the first hex 2 would be 0 0 1 0 in binary, as read from binary digits 3 through 0; the second hex 2 is also 0 0 1 0 as read from binary digits 7 through 4. 2. Next, enter your binary values from the table below in the “Binary” column next to the appropriate bit.
Imager Status Requests Single Status Request This request will return the value of the variables associated with the requested K command. The request of a single entry of a database command cannot exceed the number of database slots for the specific command. Single Descriptor Status Request This request returns the basic functional description of all fields in the requested K command.
Utilities Learn Operations Learn Sending the command from ESP’s Terminal will put the imager into a mode of operation that will cause it to “learn” the next Data Matrix symbol decoded. This mode of operation will remain active until either a Data Matrix symbol is decoded or the call is made to disable the mode and revert back to normal operation.
Other Operational Serial Commands Other Operational Serial Commands The following serial utility commands can be entered from ESP’s Terminal or a PLC: Y-Modem Upload Transfer Options Y-Modem Download Transfer Options See MS-4X Image Output for an explanation of how to use this feature. Image Library Request Manages files in a selected directory. File Source (Nothing) / /saved *.* /del /saved/del del*.
Utilities Bar Code Configuration Mode Definition: Serial Cmd: Bar Code Configuration Mode is a way of programming the imager by using ECC 200 Data Matrix symbols. Bar Code Configuration Mode can be entered three different ways: 1. By forcing the imager into Bar Code Configuration Mode by serial command . 2. By configuring one of the 4 EZ Button positions to Bar Code Configuration Mode. 3.
Other Operational Serial Commands 13-26 MS-4X Imager User Manual
14 Output Format Contents Output Format Serial Commands............................................................................................... 14-2 Output Format Status ................................................................................................................. 14-3 Format Assign ............................................................................................................................ 14-4 Format Extract..........................................................
Output Format Serial Commands Output Format Serial Commands Format Extract Format Insert Format Assign Format Status Output Filter Configuration Ordered Output Filter 14-2 MS-4X Imager User Manual
Output Format Output Format Status Definition: This is a global enable/disable parameter. In order to use formatting you must set up the format using the insert and extract commands, and you must also assign a symbol to format using the Format Assign command. Serial Cmd: Default: Disabled Options: 0 = Disabled 1 = Enabled Output Format Status Disabled When Output Format Status is set to Disabled, output formatting is globally disabled.
Format Assign Format Assign Symbol Number Definition: Symbol Number refers to the number of the symbol to which output formatting will apply. For example, if you wish to enable user-defined formatting to symbol # 2 in a multisymbol read cycle, you would send the command . Note that the number of symbols may exceed the format capabilities. Serial Cmd: Options: 1 to 10 1 = Formatted output status for symbol # 1. 2 = Formatted output status for symbol # 2. ...
Output Format Format Extract Output Index Definition: Output Index refers to the database entry you wish to modify with this command. A formatted output is built by extracting data from a symbol’s original data output and/or inserting user-defined characters. It may be helpful to think of individual indexes as positions in the final formatted output you wish to build. Starting with index # 1, enter either an extract or insert command to begin building your desired output string.
Format Assign Format Extract by ESP The Extract Range function corresponds to the Start Location and Length parameters in the Format Extract serial command. Multiple character sequences can be extracted and inserted using Symbol Parse. In this example, the selected extraction range is characters 2-4. The “Sample Symbol” example on the Symbol Parse dialog shows the selected character positions extracted and output as desired.
Output Format Format Insert Output Index Definition: Output Index refers to the database entry you wish to modify with this command. A formatted output is built by extracting data from a symbol’s original data output and/or inserting user-defined characters. It may be helpful to think of individual indexes as positions in the final formatted output you wish to build. Starting with index # 1, enter either an extract or insert command to begin building your desired output string.
Format Insert Format Insert by ESP 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.
Output Format Output Filter Configuration Definition: Output filtering is a method of providing a set of good read qualifiers and also providing ordered output. There is a filter for up to the first 10 positions in a multisymbol output. The first filter corresponds to the first symbol output at the end of the read cycle. Each filter has has settings for the following four parameters: Symbology, Symbol Length, Data, and Configuration Database Number.
Output Filter Configuration Filter Number Definition: This is the filter index number that represents the position of the symbol in the data output at the end of the read cycle. This index number should be entered along with the following filter settings for the predetermined symbol position.
Output Format Length Definition: Specifies the length of the decoded symbol allowed to occupy this location in multisymbol output. Note: To filter or order a symbol, the symbol must meet all requirements of the selected filter index. Serial Cmd: Default: 0 Options: 0 to 64 Wildcard Definition: This is the character to be used in the data output field when performing a data filter comparison.
Output Filter Configuration Data Definition: This is the data string to be used when comparing symbol data for output filtering and ordering. This data string may also contain wildcard and placeholder characters to facilitate matching. Remember that in order to filter or order symbol data, it must meet all the requirements of the selected filter index. Examples: • Filter data = “123*”. This will match data strings of “123”, “123456”, and “123ABC”, but not “12”. • Filter data = “123*AB?C”.
Output Format Ordered Output Filter Configuration by ESP Double-clicking on a row in the Ordered Output table brings up the Ordered Output Filter Settings dialog. 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.
Number of Filters Number of Filters Definition: Number of Filters refers to the number of active output filters. 0 disables all output filters. Any non-zero numeral will enable filtering to be performed using the filter indexes covered by this value. 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.
Appendices Contents Appendix A General Specifications .............................................................................................. A-2 Appendix B Electrical Specifications ............................................................................................ A-5 Appendix C Serial Configuration Commands............................................................................... A-9 Appendix D Communications Protocol...................................................................
General Specifications Appendix A — General Specifications Mechanical Height: 1" (25.4 mm) Width: 1.8" (45.7 mm) Depth: 2.10" (53.3 mm) Weight: 2 oz. (57 g) Note: Nominal dimensions shown. Typical tolerances apply.
Appendices Read Ranges Low Density in. mm 6 152 5 127 4 102 3 76 2 51 1 25 Standard Density (inches/mm) 20 mil 2D | 15 mil 1D 15 mil 2D | 10 mil 1D 10 mil 2D | 7.5 mil 1D 51 25 0 3 2 25 1 1 51 76 mm 2 3 in. Distance Distance Standard Density Low Density (inches/mm) in. mm 7 178 6 152 30 mil 2D | 20 mil 1D 20 mil 2D | 15 mil 1D 5 127 4 102 3 76 2 51 1 25 15 mil 2D | 10 mil 1D 76 51 25 25 51 76 3 2 1 1 2 3 0 4 Wide Axis (H = 3/4 W) 102 mm 4 in.
General Specifications FIS Options MS-4X Imager MS-4X IMAGER, SD, X-MODE, RS-232, 5VDC MS-4X IMAGER, LD, X-MODE, RS-232, 5VDC MS-4X IMAGER, SD, X-MODE, USB, 5VDC MS-4X IMAGER, LD, X-MODE, USB, 5VDC MS-4X IMAGER, SD, X-MODE, USB+I/O, 5VDC MS-4X IMAGER, LD, X-MODE, USB+I/O, 5VDC FIS-0004-2001G FIS-0004-2002G FIS-0004-2003G FIS-0004-2004G FIS-0004-2005G FIS-0004-2006G Safety Certifications FCC, UL/cUL, CE, CB, RoHS/WEEE RoHS/WEEE Compliant ©2015 Microscan Systems, Inc. All rights reserved.
Appendices Appendix B — Electrical Specifications Power: 4.0 Watts (max.) 5VDC +/– 5%, 200 mV p-p max. ripple, 554 mA @ 5VDC (typ.
Electrical Specifications Optoisolator Trigger Inputs for IC-332 A-6 MS-4X Imager User Manual
Appendices MS-4X Imager User Manual A-7
Electrical Specifications New Master Pin A-8 MS-4X Imager User Manual
Appendices Appendix C — Serial Configuration Commands Note: For a list of utility commands such as read rate requests, device control options, and imager status requests, see Serial Utility Commands.
Communication Protocol Commands Micro QR Code Postal Symbologies Code 39 Codabar Interleaved 2 of 5 UPC/EAN Code 128/EAN 128 Code 93 PDF417 Pharmacode Data Matrix QR Code BC412 DataBar-14 (RSS-14) DataBar Limited (RSS Limited) DataBar Expanded (RSS Expanded) MicroPDF417 I/O Parameters Power On/Reset Counts Time Since Reset Service Message Serial Verification Beeper Quality Output Symbol Data Output No Read Message Frame Information LED Configuration A-10
Appendices Image Output Target/Flood LEDs Database Identifier Output EZ Button EZ Button Modes Trend
Serial Configuration Commands Delete Master Symbol Data Match Replace Mismatch Replace Camera and IP Setup Mirrored Image Window of Interest Focal Distance Focal Distance Table (Read-Only) Illumination Brightness Camera Pixel Sub-Sampling Morphological Pre-Processing Morphological Operation Configuration Database Number of Active Indexes Configuration Database Status Save Current Settings to Database Load Current Settings from Database Request Selected Index Settings Request All Database Settings Database M
Appendices Serial Command Format Serial commands are of two types: utility and configuration. Rules that apply to both utility and configuration commands • A less than < and greater than > character enclose the commands. • Commands and data are “case sensitive.” That is, characters must be entered as upper or lower case, as specified. Serial Utility Commands These are sent during operations and are not followed by or .
Serial Configuration Commands Concatenating Configuration Commands Commands can be concatenated (added together) in a single string or data block. For example, enables LRC, sets End of Read Cycle mode to New Trigger, enables Narrow Margins, and resets the data buffers (without saving the changes for power-on). Serial Command Status Request To ensure that any command was received and accepted, you can send the Show Reader Status command: .
Appendices Appendix D — Communications Protocol Communications Protocol Command Table Protocol Command (Mnemonic displayed on menu) Control Characters (Entered in menu or serial command) Hex Value Effect of Command RES ^D 04 Reset REQ ^E 05 Request EOT ^D 04 Reset STX ^B 02 Start of Text ETX ^C 03 End of Text ACK ^F 06 Acknowledge NAK ^U 15 Negative Acknowledge XON ^Q 11 Begin Transmission XOFF ^S 13 Stop Transmission MS-4X Imager User Manual A-15
Communications Protocol ACK/NAK Data Flow Examples Setup 1 RES REQ STX ETX ACK NAK LRC 0x00 (disabled) 0x00 (disabled) 0x00 (disabled) 0x00 (disabled) 0x06 0x15 disabled Transfer 1 HOST_TX IMAGER_TX ‘ACK’ Transfer 2 HOST_TX IMAGER_TX IMAGER_TX HOST_TX ‘ACK’ ‘ACK’ Error Condition Transfer 1 IMAGER_TX HOST_TX IMAGER_TX HOST_TX symbol data ‘NAK’ (host rejects) symbol data (resend data) ‘ACK’ (transaction complete) Transfer 2 HOST_TX IMAGER_TX ‘ACK’ IMAGER_TX
Appendices Setup 2 RES REQ STX ETX ACK NAK LRC 0x00 (disabled) 0x00 (disabled) 0x00 (disabled) 0x00 (disabled) 0x06 0x15 enabled Transfer 1 HOST_TX IMAGER_TX a ‘ACK’ Transfer 2 HOST_TX IMAGER_TX IMAGER_TX HOST_TX B ‘ACK’ a ‘ACK’ Error Condition Transfer 1 HOST_TX IMAGER_TX HOST_TX IMAGER_TX x (BAD LRC) ‘NAK’ a (GOOD LRC) ‘ACK’ MS-4X Imager User Manual A-17
Communications Protocol Setup 3 RES REQ STX ETX ACK NAK LRC 0x00 (disabled) 0x00 (disabled) 0x28 ‘(‘ 0x29 ‘)’ 0x06 0x15 enabled Transfer 1 HOST_TX IMAGER_TX ()H ‘ACK’ Transfer 2 HOST_TX IMAGER_TX IMAGER_TX HOST_TX A-18 ()k ‘ACK’ ()w ‘ACK’ MS-4X Imager User Manual
Appendices Setup 4 RES REQ STX ETX ACK NAK LRC 0x21 ‘!’ 0x3D ‘=’ 0x28 ‘(‘ 0x29 ‘)’ 0x06 0x15 enabled Transfer 1 HOST_TX IMAGER_TX ()H ‘ACK’ Transfer 2 HOST_TX IMAGER_TX HOST_TX IMAGER_TX HOST_TX IMAGER_TX ()n ‘ACK’ ‘!’ ()X ‘ACK’ ‘!’ Error Condition Transfer 1 HOST_TX ()H IMAGER_TX ‘ACK’ HOST_TX ()n IMAGER_TX ‘ACK’ HOST_TX ‘!’ IMAGER_TX ()X timeout reached... IMAGER_TX ‘=’ timeout reached... IMAGER_TX ‘=’ timeout reached...
Communications Protocol Polling Mode Data Flow Examples Setup 1 Address RES REQ STX ETX ACK NAK LRC 0x01 (translates to) Poll Req @ ‘0x1C’, Unit Select @ ‘0x1D’ 0x04 0x05 0x02 0x03 0x06 0x15 disabled Transfer 1 HOST_TX IMAGER_TX HOST_TX IMAGER_TX HOST_TX ‘RES’ ‘0x1D’ ‘REQ’ (Select Unit 1 to receive data) ‘0x1D’ ‘ACK’ (Unit responds with its address) ‘STX’ ‘ETX’ ‘0x1D’ ‘ACK’ (Unit responds with its address) ‘RES’ (Terminate Transfer 2) Transfer 2 HOST_TX IMAGER_TX HOST_TX IMAGER_TX ‘RES’ ‘0x1C’ ‘RE
Appendices Error Condition 2 HOST_TX ‘RES’ ‘0x1C’ ‘REQ’ (Poll Unit 1 for data) IMAGER_TX ‘0x1C’ ‘STX’ ‘ETX’ HOST_TX ‘Nothing’ (Host should ‘ACK’ here) timeout reached... IMAGER_TX ‘REQ’ (Unit requests an ‘ACK’ again) HOST_TX ‘NAK’ (Host rejects data frame) (Retry Event) IMAGER_TX ‘0x1C’ ‘STX’ ‘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.
Communications Protocol Setup 2 Address RES REQ STX ETX ACK NAK LRC 0x01 (translates to) Poll Req @ ‘0x1C’, Unit Select @ ‘0x1D’ 0x04 0x05 0x02 0x03 0x06 0x15 enabled Transfer 1 HOST_TX IMAGER_TX HOST_TX IMAGER_TX HOST_TX ‘RES’ ‘0x1D’ ‘REQ’ (Select Unit 1 to receive data) ‘0x1D’ ‘ACK’ (Unit responds with its address) ‘STX’ ‘ETX’ ‘LRC’ ‘0x1D’ ‘ACK’ (Unit responds with its address) ‘RES’ (Terminate Transfer 2) Transfer 2 HOST_TX IMAGER_TX IMAGER_TX HOST_TX ‘RES’ ‘0x1C’ ‘REQ’ (Poll Unit 1 for data) ‘
Appendices Error Condition 2 HOST_TX ‘RES’ ‘0x1C’ ‘REQ’ (Poll Unit 1 for data) IMAGER_TX ‘0x1C’ ‘STX’ ‘ETX’ ‘LRC’ HOST_TX ‘Nothing’ (Host should ‘ACK’ here) timeout reached...
ASCII Table Appendix E — ASCII Table Dec 00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 A-24 Hex 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F 10 11 12 13 14 15 16 17 18 19 1A 1B 1C 1D 1E 1F Mne NUL SOH STX ETX EOT ENQ ACK BEL BS HT LF VT FF CR SO SI DLE DC1 DC2 DC3 DC4 NAK SYN ETB CAN EM SUB ESC FS GS RS US Ctrl ^@ ^A ^B ^C ^D ^E ^F ^G ^H ^I ^J ^K ^L ^M ^N ^O ^P ^Q ^R ^S ^T ^U ^V ^W ^X ^Y ^Z ^[ ^\ ^] ^^ ^_ Dec 32 33 34 35 36 37 38 39 40 41 42 43 44 4
Appendices Appendix F — Interface Standards Interface Standards, established by the Electronic Industries Association (EIA), specify such things as the signaling voltage levels, maximum cable lengths, and number of drivers. In the MS-4X, selection of interface is made by pin assignment and, in the case of host communications, by software switching between RS-232 and RS-422/RS-485. RS-232 RS-232 defines an interface between two devices such as, for example, the reader and host.
Operational Tips Appendix G — Operational Tips Cleaning The MS-4X has a hard-coated window that should only be cleaned with alcohol (100% isopropyl). Mounting When mounting the MS-4X, 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.
Appendices Appendix H — 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. If a 5 volt device is used in combination with an IC-332, it must be connected as a 10-28 volt device.
USB-to-Serial Virtual COM Port Driver Appendix I — USB-to-Serial Virtual COM Port Driver (For use with Windows® 7 (32-bit), Vista (32-bit), XP (32-bit), and 2000 Operating Systems) Microscan’s USB-to-Serial Virtual COM Port Driver allows you to send serial data using a USB MS-4X. Installing the USB-to-Serial Virtual COM Port Driver 1. Download the driver files from the Microscan website or Microscan Tools Drive. If the driver files are in a .
Appendices 4. Read the License Agreement shown below. If you accept the terms of the agreement, click the radio button next to the statement “I accept this agreement”, and click Next. Important: After accepting the license agreement and clicking Next, you may see a Windows Security warning that states “Windows can’t verify the publisher of this driver software”. If you receive this warning, choose the “Install this driver software anyway” option. 5. The driver files will begin installing.
USB-to-Serial Virtual COM Port Driver Uninstalling the USB-to-Serial Virtual COM Port Driver Important: You must uninstall the USB-to-Serial Virtual COM Port Driver any time you require high-speed USB connectivity (to upload images using EZ Trax, for example). Find the driver on the list of programs, select it, then click Uninstall/Change. To use the Virtual COM Port again, follow the steps above to re-install the driver. Changing the COM Port Follow these steps to change the reader’s COM Port: 1.
Appendices Appendix J — MS-4X Image Output This section explains how to extract (download) a video-captured image from a MS-4X. Y-Modem Method The easiest download method is to issue the command to get a list of available images, then initiate a download sequence using a Y-Modem utility or protocol sequence. The user will need to issue the first to get an image list response from the imager.
MS-4X Image Output Upload Image Select a file from the file list above, and then send the command: . Now initiate the Y-modem transfer and save the file. Y-modem uploads will vary depending on the program or language. See the HyperTerminal example below. Image Upload Using HyperTerminal • Open the HyperTerminal application by clicking Start, Programs, Accessories, Communication, and then HyperTerminal. • Enter a name, and select an icon, then select OK.
Appendices Bit Stream Method A more difficult method is to parse and decode the bit stream data. The bit stream is a mix of EXIF format & TIFF format. You will need to use the command. To load a bitmap, send and the entire grayscale image will load. To load a JPEG, set arg for the full-size JPEG image, with adjustable quality: There is only one variable: nnn is a number from 1 to 100, and it represents the image quality.
Glossary of Terms Appendix K — Glossary of Terms Aberration — The failure of an optical lens to produce an exact point-to-point correspondence between the object and its resulting image. Various types are chromatic, spherical, coma, astigmatism and distortion. Absorption — The loss of light of certain wavelengths as it passes through a material and is converted to heat or other forms of energy. (–) Active Illumination — Lighting an area with a light source coordinated with the acquisition of an image.
Appendices Charge-Coupled Device (CCD) — A semiconductor device with an array of light-sensitive elements that converts light images into electrical signals. Check Character — A Modulus 43 or Modulus 10 character that is added to encoded symbol data for additional data integrity. CMOS — See Complementary Metal Oxide Semiconductor. Complementary Metal Oxide Semiconductor (CMOS) — Like CCDs, CMOS imagers include an array of photo-sensitive diodes, one diode within each pixel.
Glossary of Terms Edge Enhancement — Image processing method to strengthen high-spatial frequencies in the image. EPROM — See Erasable Programmable Read-Only Memory. Embedded Memory — Onboard memory device such as EPROM or flash. End of Read Cycle — The time or condition at which the imager stops expecting symbol information to decode. Erasable Programmable Read-Only Memory (EPROM) — A memory chip that retains data when its power supply is turned off; “non-volatile memory”.
Appendices Half Duplex — A communications system in which signals can travel between devices in both directions, but not simultaneously. Histogram — A graphical representation of the frequency of occurrence of each intensity or range of intensities (gray levels) of pixels in an image. The height represents the number of observations occurring in each interval. Host — A computer, PLC, or other device that is used to execute commands and process data and discrete signals.
Glossary of Terms Output — A channel or communications line. Data or discrete signals that are transmitted or displayed by a device. Parity — An error detection routine in which one data bit in each character is set to 1 or 0 so that the total number of 1 bits in the data field is even or odd. Picket Fence Orientation — A linear symbol orientation in which the bars are perpendicular to the symbol’s direction of travel.
Appendices Region — Area of an image. Also called a region of interest for image processing operations. ROM — See Read-Only Memory. Saturation — The degree to which a color is free of white. One of the three properties of color perception, along with hue and value. Scattering — Redirection of light reflecting off a surface or through an object. Skew — Rotation of a linear or 2D symbol around an axis parallel to the symbol height on the substrate. See the illustration under the definition of Pitch.
Glossary of Terms A-40 MS-4X Imager User Manual
