EZ Match Imager User's Manual Ezmatchmanual
2010-05-18
: Microscan Ezmatchmanual ezmatchmanual 6cd11823-0264-48b4-9c01-a17b8b3c1f25 _att
Open the PDF directly: View PDF .
Page Count: 431
Download | ![]() |
Open PDF In Browser | View PDF |
EZ Match Imager User’s Manual P/N 83-000044 Rev C Copyright and Disclaimer Copyright ©2010 Microscan Systems, Inc. ISO 9001 Certified Issued by TüV USA 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. Rather than place a trademark (™) symbol at every occurrence of a trademarked name, we state herein that we are using the names only in an editorial fashion, and to the benefit of the trademark owner, with no intention of infringement. Disclaimer The information and specifications described in this manual are subject to change without notice. Latest Manual Version For the latest version of this manual, see the Download Center on our web site at: www.microscan.com. Technical Support For technical support, e-mail: helpdesk@microscan.com. Warranty and Terms of Sale For Standard Warranty information, see: www.microscan.com/warranty. Microscan Systems, Inc. Renton Headquarters Tel: 425.226.5700 / 800.251.7711 Fax: 425.226.8250 Nashua Office Tel: 603.598.8400 Fax: 603.577.5818 Microscan Europe Tel: 011 31 172 423360 Fax: 011 31 172 423366 Microscan Asia Pacific Tel: 65 6846 1214 Fax: 65 6846 4641 ii EZ Match User’s Manual Introduction Table of Contents Chapter 1 Quick Start Step 1 Check Hardware .......................................................................... 1-2 Step 2 Connect the System ..................................................................... 1-3 Step 3 Position the Imager ...................................................................... 1-4 Step 4 Install ESP.................................................................................... 1-5 Step 5 Select Model ................................................................................ 1-6 Step 6 Select Protocol and Connect........................................................ 1-7 Step 7 Locate the Object in the Field of View.......................................... 1-9 Step 8 Calibrate..................................................................................... 1-11 Step 9 Test Read Rate .......................................................................... 1-12 Step 10 Configure the Imager in ESP ................................................... 1-13 Step 11 Save Configuration in ESP....................................................... 1-14 Chapter 2 Using ESP EZ Mode .................................................................................................. 2-2 Application Mode ..................................................................................... 2-3 Menu Toolbar .......................................................................................... 2-4 Autoconnect.......................................................................................... 2-12 View ...................................................................................................... 2-14 Navigating in ESP................................................................................. 2-15 Send/Receive Options .......................................................................... 2-16 Chapter 3 Tube/Cap Inspection Tube/Cap Inspection Serial Commands .................................................. 3-2 Capture and Test ..................................................................................... 3-3 Multi-Operation ........................................................................................ 3-4 Multi-Operation by Serial Command ...................................................... 3-5 Tube/Cap Library .................................................................................... 3-8 Tube/Cap Information ........................................................................... 3-16 Chapter 4 Communications Communications by ESP......................................................................... 4-2 Communications Serial Commands ........................................................ 4-3 Host Port Connections............................................................................. 4-4 Host Protocol ........................................................................................... 4-5 Poll Address ............................................................................................ 4-7 ACK/NAK Options ................................................................................... 4-8 Polling Mode Options .............................................................................. 4-9 RS-422 Status ....................................................................................... 4-10 Auxiliary Port Connections .................................................................... 4-11 Auxiliary Port System Data Status......................................................... 4-19 Daisy Chain Autoconfigure .................................................................... 4-20 Response Timeout ................................................................................ 4-21 LRC Status ............................................................................................ 4-22 Protocol Configuration Examples .......................................................... 4-23 USB HID Interface ................................................................................. 4-24 EZ Match User’s Manual iii Table of Contents ASCII Character Entry Modifier ............................................................. 4-33 Preamble ............................................................................................... 4-34 Postamble ............................................................................................. 4-35 Chapter 5 Calibration Calibration Serial Commands.................................................................. 5-2 Calibration Overview ............................................................................... 5-2 Calibration Options .................................................................................. 5-3 Calibration by ESP ............................................................................... 5-10 Initiating Calibration ............................................................................... 5-12 Additional Notes about Calibration ........................................................ 5-17 Chapter 6 Read Cycle Read Cycle by ESP ................................................................................. 6-2 Read Cycle Serial Commands ................................................................ 6-3 Read Cycle Setup ................................................................................... 6-4 Multisymbol ............................................................................................. 6-5 Trigger Mode and Duration ..................................................................... 6-7 External Trigger Polarity ........................................................................ 6-12 Serial Trigger ......................................................................................... 6-13 Start Trigger Character (Non-Delimited)................................................ 6-14 Stop Trigger Character (Non-Delimited)................................................ 6-15 End of Read Cycle ................................................................................ 6-16 Capture Mode........................................................................................ 6-18 Capture Timing ...................................................................................... 6-23 Image Storage ....................................................................................... 6-25 Minimum Good Reads........................................................................... 6-28 Chapter 7 Symbologies Symbologies by ESP............................................................................... 7-2 Symbologies Serial Commands .............................................................. 7-3 Data Matrix .............................................................................................. 7-4 QR Code ................................................................................................. 7-6 Code 39 ................................................................................................... 7-7 Code 128 / EAN-128 ............................................................................. 7-10 BC412 ................................................................................................... 7-13 Interleaved 2 of 5................................................................................... 7-14 Code 93 ................................................................................................. 7-17 Codabar................................................................................................. 7-18 UPC / EAN ............................................................................................ 7-21 Pharmacode .......................................................................................... 7-25 GS1 DataBar (RSS) .............................................................................. 7-27 PDF417 ................................................................................................. 7-29 MicroPDF417 ........................................................................................ 7-31 Composite ............................................................................................. 7-32 Narrow Margins / Symbology Identifier.................................................. 7-33 Chapter 8 I/O Parameters I/O Parameters by ESP ........................................................................... 8-2 iv EZ Match User’s Manual Introduction I/O Parameters Serial Commands........................................................... 8-3 Symbol Data Output ................................................................................ 8-5 No Read Message ................................................................................... 8-8 Bad Symbol Message............................................................................ 8-10 No Symbol Message ............................................................................. 8-10 1D / Stacked Symbology Qualification .................................................. 8-11 2D Symbology Qualification .................................................................. 8-12 Read Duration Output............................................................................ 8-18 Output Indicators ................................................................................... 8-19 Beeper ................................................................................................... 8-23 LED Configuration ................................................................................. 8-24 Serial Verification................................................................................... 8-25 EZ Button............................................................................................... 8-27 EZ Button Modes ................................................................................... 8-29 Configurable Output 1 ........................................................................... 8-31 Trend Analysis Output 1 ........................................................................ 8-34 ISO/IEC 16022 Symbol Quality Output 1 .............................................. 8-37 Diagnostics Output 1 ............................................................................. 8-40 Tube/Cap Detection Output 1 ................................................................ 8-41 Configurable Output 2 ........................................................................... 8-43 Trend Analysis Output 2 ........................................................................ 8-43 ISO/IEC 16022 Symbol Quality Output 2 .............................................. 8-43 Diagnostics Output 2 ............................................................................. 8-43 Tube/Cap Detection Output 2 ................................................................ 8-44 Configurable Output 3 ........................................................................... 8-45 Trend Analysis Output 3 ........................................................................ 8-45 ISO/IEC 16022 Symbol Quality Output 3 .............................................. 8-45 Diagnostics Output 3 ............................................................................. 8-45 Tube/Cap Detection Output 3 ................................................................ 8-46 Frame Information ................................................................................. 8-47 Image Output ......................................................................................... 8-48 Database Identifier Output..................................................................... 8-51 Quality Output........................................................................................ 8-52 Power-On/Reset Counts........................................................................ 8-53 Time Since Reset .................................................................................. 8-54 Service Message ................................................................................... 8-55 EZ Trax Output ...................................................................................... 8-56 Chapter 9 Symbol Quality Symbol Quality by ESP ........................................................................... 9-2 Symbol Quality Serial Commands ........................................................... 9-3 Overview of Symbol Quality .................................................................... 9-4 Symbol Quality Separator / Data Matrix Output Mode ............................ 9-5 ISO/IEC 16022 Symbol Quality Output ................................................... 9-7 ISO/IEC 16022 Symbol Quality Output by ESP ...................................... 9-9 Microscan Symbol Quality Output ......................................................... 9-10 EZ Match User’s Manual v Table of Contents Microscan Symbol Quality Output by ESP ............................................ 9-13 Chapter 10 Matchcode Matchcode by ESP ................................................................................ 10-2 Matchcode Serial Commands ............................................................... 10-2 Overview of Matchcode ......................................................................... 10-3 Matchcode Type .................................................................................... 10-4 Match Replace ...................................................................................... 10-9 Mismatch Replace ............................................................................... 10-10 New Master Pin ................................................................................... 10-11 Chapter 11 Camera and IP Setup Camera and IP Setup by ESP............................................................... 11-2 Camera and IP Setup Serial Commands .............................................. 11-3 Video ..................................................................................................... 11-4 Evaluation.............................................................................................. 11-5 Calibration ............................................................................................. 11-9 Window of Interest............................................................................... 11-10 IP Database......................................................................................... 11-13 Dynamic Setup .................................................................................... 11-14 Camera Settings.................................................................................. 11-15 Focal Distance (Read-Only) ................................................................ 11-16 Focal Distance Table (Read-Only) ...................................................... 11-16 Pixel Sub-Sampling ............................................................................. 11-17 IP Threshold ........................................................................................ 11-18 IP Mode ............................................................................................... 11-20 Tube/Cap Mode................................................................................... 11-21 Image Processing Timeout.................................................................. 11-23 Mirrored Image .................................................................................... 11-25 Hollow Mode........................................................................................ 11-26 Number of Symbols in Field of View ................................................... 11-27 Damaged Symbol Status..................................................................... 11-28 Illumination Brightness ........................................................................ 11-29 Skew Correction .................................................................................. 11-30 Color Filter (EZ Match Color Only) ...................................................... 11-34 Color Detection (EZ Match Color Only) ............................................... 11-35 Chapter 12 IP Database IP Database Serial Commands ............................................................. 12-2 Number of Active Indexes ..................................................................... 12-3 IP Database Status ............................................................................... 12-4 Database Mode ................................................................................... 12-10 Save Current Settings to IP Database ................................................ 12-15 Load Current Settings from IP Database ............................................ 12-16 Request Selected Index Settings ........................................................ 12-17 Request All IP Database Settings ....................................................... 12-18 Chapter 13 Terminal Terminal Window................................................................................... 13-2 vi EZ Match User’s Manual Introduction Find........................................................................................................ 13-3 Send ...................................................................................................... 13-4 Macros................................................................................................... 13-5 Terminal Window Menus ....................................................................... 13-6 Chapter 14 Utilities Serial Utility Commands ........................................................................ 14-2 Read Rate ............................................................................................. 14-4 Counters ................................................................................................ 14-5 Device Control ....................................................................................... 14-8 Differences from Default ........................................................................ 14-9 Master Database ................................................................................. 14-10 Firmware.............................................................................................. 14-16 Default / Reset / Save.......................................................................... 14-19 Imager Status Requests ...................................................................... 14-21 Other Operational Serial Commands .................................................. 14-23 Chapter 15 Output Format Output Format Serial Commands .......................................................... 15-2 Output Format Status ............................................................................ 15-3 Format Assign ....................................................................................... 15-4 Format Extract ....................................................................................... 15-5 Format Insert ......................................................................................... 15-7 Output Filter Configuration .................................................................... 15-9 Ordered Output Filter........................................................................... 15-13 Appendices Appendix A General Specifications .........................................................A-2 Appendix B Electrical Specifications .......................................................A-5 Appendix C Serial Configuration Commands ..........................................A-8 Appendix D Communications Protocol ..................................................A-15 Appendix E ASCII Table ........................................................................A-24 Appendix F Interface Standards ............................................................A-25 Appendix G Using an External Trigger ..................................................A-26 Appendix H Operational Tips.................................................................A-27 Appendix I USB-to-Serial Virtual COM Port Driver ................................A-28 Appendix J Glossary of Terms ..............................................................A-31 Index EZ Match User’s Manual vii About the EZ Match Imager About the EZ Match Imager The key features of the EZ Match Imager are: • 3 megapixel sensor (color version) • 1.3 megapixel sensor (monochrome version) • High-output white LED illumination • High-speed image processing • Ability to identify a large database of tube and cap types, and to learn new tube and cap types • Support for both linear and 2D symbologies • USB, RS-232, and RS-422/485 connectivity • A multi-function EZ Button for location, calibration, and read cycle triggering • A blue target pattern that identifies the center of the field of view • A green flash (visible from all angles) to signal a tube/cap detection or successful decode • Easy customization for a variety of specific applications About This Manual This manual provides complete information on setting up, installing, and configuring the imager. The chapters are presented in the order in which an imager might be set up and made ready for operation. Highlighting Serial commands, highlighted command fields, and default command settings are highlighted in rust bold. Cross-references and web links are highlighted in blue bold. References to ESP, its toolbar headings (Communications, Read Cycle, Symbologies, etc.), menu topics, and other points of emphasis, are highlighted in Bold Initial Caps. Host Communications There are three ways to configure and test the EZ Match Imager : • Microscan’s Windows-based ESP (Easy Setup Program), which offers point-and-click ease of use and visual responses to user adjustments. • Serial commands, such as, that can be sent from ESP’s Terminal window or another terminal program. • EZ Button. viii EZ Match User’s Manual 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 EZ Match Imager’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. • Location of the EZ Match Imager’s LED aperture window: LED Aperture Window CAUTION: Use of controls or adjustments or performance of procedures other than those specified herein may result in hazardous radiation exposure. IMPORTANT: The EZ Match Imager is intended for connection to a UL-listed direct plug-in power unit marked Class II and rated 5 VDC at 3.5 Watts, or greater if using electrical accessories. European models must use a similarly rated Class I or Class II power supply that is certified to comply with standard for safety EN 60950. EZ Match User’s Manual ix Statement of Agency Compliance Statement of Agency Compliance The EZ Match Imager 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. Changes or modifications not expressly approved by the party responsible for compliance could void the user’s authority to operate the equipment. The EZ Match Imager has been tested for compliance with CE (Conformité Européenne) standards and guidelines, and has been found to conform to applicable CE standards, specifically the EMC requirements EN 55024, ESD EN 61000-4-2, Radiated RF Immunity EN 61000-4-3, ENV 50204, EFT EN 61000-4-4, Conducted RF Immunity EN 61000-4-6, EN 55022, Class B Radiated Emissions, and Class B Conducted Emissions. The EZ Match Imager has been tested by an independent electromagnetic compatibility laboratory in accordance with the applicable specifications and instructions. x EZ Match User’s Manual 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 the European Parliament and the Council of the European Union for RoHS compliance. In accordance with the latest requirements, our RoHS-compliant products and packaging do not contain intentionally added Deca-BDE, Perfluorooctanes (PFOS) or Perfluorooctanoic Acid (PFOA) compounds above the maximum trace levels. To view the documents stating these requirements, please visit: http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=CELEX:32002L0095:EN:HTML and http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=OJ:L:2006:372:0032:0034:EN:PDF Please contact your sales manager for a complete list of Microscan’s RoHS-Compliant products. This declaration is based upon information obtained from sources which Microscan believes to be reliable, and from random sample testing; however, the information is provided without any representation of warranty, expressed or implied, regarding accuracy or correctness. Microscan does not specifically run any analysis on our raw materials or end product to measure for these substances. The information provided in this certification notice is correct to the best of Microscan’s knowledge at the date of publication. This notice is not to be considered a warranty or quality specification. Users are responsible for determining the applicability of any RoHS legislation or regulations based on their individual use of the product. EZ Match User’s Manual xi Statement of RoHS Compliance xii EZ Match User’s Manual 1 Quick Start Contents Step 1 Check Hardware................................................................................................................ 1-2 Step 2 Connect the System .......................................................................................................... 1-3 Step 3 Position the Imager............................................................................................................ 1-4 Step 4 Install ESP ......................................................................................................................... 1-5 Step 5 Select Model...................................................................................................................... 1-6 Step 6 Select Protocol and Connect ............................................................................................. 1-7 Step 7 Locate the Object in the Field of View ............................................................................... 1-9 Step 8 Calibrate ......................................................................................................................... 1-11 Step 9 Test Read Rate .............................................................................................................. 1-12 Step 10 Configure the Imager in ESP........................................................................................ 1-13 Step 11 Save Configuration in ESP ........................................................................................... 1-14 This section is designed to get your EZ Match Imager up and running quickly, using the EZ Button or ESP (Easy Setup Program). Following these steps will allow you to get a sense of the imager’s capabilities and to test tube/cap detection and symbol decode performance. Detailed setup information for installing the imager in your application can be found in the subsequent sections. EZ Match User’s Manual 1-1 Check Hardware Step 1 — Check Hardware Item 1 2 3 4 5 6 Description EZ Match Imager IC-332 Adapter IB-131 Interface Box Power Supply Object Detector (optional) Host Cable Part Number FIS-0004-100XG FIS-0001-0035G 99-000018-01 97-100004-15 (90-264 VAC, 24 VDC) 99-000017-01 61-300026-03 1 2 3 6 Host 4 Network Scanner 5 Hardware Required Caution: Be sure that all cables are connected BEFORE applying power to the system. Always power down BEFORE disconnecting any cables. 1-2 EZ Match User’s Manual Quick Start Step 2 — Connect the System Caution: Be sure that all cables are connected BEFORE applying power to the system. Always power down BEFORE disconnecting any cables. Connecting by RS-232 / RS-422 / RS-485 • • • • • 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. Important: If you are using a USB model, you must connect the device to the host computer before powering-on. Otherwise the unit will not be recognized as a USB device. 1 2 3 6 Host 4 Network Scanner 5 Hardware Configuration EZ Match User’s Manual 1-3 Position the Imager Step 3 — Position the Imager • Place the imager in an area with as little ambient light as possible. • Place a black surface behind the area in which test tubes, caps, or symbols will be inspected by the imager. The black background provides the contrast necessary for the imager to detect the presence or absence of objects in its field of view. • Position the imager at a focal distance between 2 and 6 inches from a sample tube, cap, or symbol. • Position the imager relative to the object to avoid the glare of direct (specular) reflection. Important: Avoid excessive skew or pitch. Maximum skew is ±30°; maximum pitch is ±30°. The illustration below shows skew axis, pitch axis, and tilt axis. Bar code label axis Skew Tilt axis Tilt Symbol or other object of interest Scanner Pitch Pitch axis Reader Scan line • Objects can be rotated at any angle; however, for best results, objects should be aligned with the FOV (field of view). Note: Imager shown at 90° tilt. ml 10 8 6 4 2 Place a black background behind the area where test tubes, caps, or symbols will be inspected by the imager. This is important because it provides the contrast necessary for the imager to detect the presence or absence of objects in the field of view. EZ Match Imager and Object in Field of View Note: For accuracy of testing and performance, Microscan recommends using a mounting arm adapter kit. Contact your Microscan sales manager for details about mounting arm adapter kits and other accessories. 1-4 EZ Match User’s Manual Quick Start Step 4 — Install ESP ESP Software can be found on the Microscan Tools CD that is packaged with the EZ Match. 1. Follow the prompts to install ESP from the CD. 2. Click on the ESP icon to run the program. Note: ESP can also be installed from the Download Center at www.microscan.com. ESP System Requirements • • • • • • 166 MHz Pentium processor (recommended) Windows Vista, XP, or 2000 operating system Internet Explorer 5.0 or higher 64 MB minimum RAM 50 MB minimum disk space 800 x 600 pixel minimum 256 color display EZ Match User’s Manual 1-5 Select Model Step 5 — Select Model When you start ESP, the following menu will appear: Important: An EZ Match Imager must be connected to the host computer for its corresponding icon (shown at left) to appear on the model menu. The icon will always be present in subsequent ESP sessions, even when the EZ Match unit is not physically connected. 1. Click the button showing the EZ Match Imager. 2. Click OK. Note: You can also simply double-click the EZ Match 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. 1-6 EZ Match User’s Manual 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. EZ Match User’s Manual 1-7 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. 1-8 EZ Match User’s Manual Quick Start Step 7 — Locate the Object in the Field of View Locate the Object by ESP • In ESP’s EZ Mode, click the Locate button to enable the blue target pattern. The object 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 object. 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. Target pattern shown as it would appear between 3 and 6 inches. Important: The entire object of interest (tube, cap, or symbol) should fall within the field of view (FOV) of the imager. The field of view is what appears in ESP’s Locate/Calibrate window in EZ Mode. • Click the Stop button to end the Locate function. EZ Match User’s Manual 1-9 Locate the Object in the Field of View Locate the Object by EZ Button If you are not connected to a host computer, the EZ Button allows you to locate an object 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 object. Note: To end all EZ Button functions, press the EZ Button once and quickly release. 1-10 EZ Match User’s Manual Quick Start Step 8 — Calibrate EZ Match settings can be adjusted automatically for optimum tube/cap detection and 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 detecting tubes or caps, or for decoding symbol data. Upon successful completion of this routine, a green LED pattern will flash brightly and illuminate the object. If unsuccessful, the imager will emit 5 short beeps and stop searching. Calibrate by EZ Button 1. Hold down the EZ Button for about two seconds and release when you hear two short beeps. The 20% and 40% LEDs will illuminate. 2. The imager will search camera settings to determine the best configuration for detecting tubes or caps, or for decoding symbol data. Note: To end all EZ Button functions, press the EZ Button once and quickly release. Calibrate by ESP 1. Click the Calibrate button. 2. The imager will search camera settings to determine the best configuration for detecting tubes or caps, or for decoding symbol data. A successful calibration will display a green frame around the object, and the following message will appear: “Uploading all reader parameters.” After a moment the tube/cap data and/or symbol data will be presented in the field below the image display window. Calibrate by Serial Command Send <@CAL> from a terminal program to begin calibration. EZ Match User’s Manual 1-11 Test Read Rate Step 9 — Test Read Rate Read Rate indicates the number of tube/cap detections or 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 object 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%. These LEDs represent the percentage of Good Reads per images captured. 2. To end the Read Rate test, press the EZ Button and quickly release. Test Read Rate by ESP 1. Click the Test button to start the Read Rate test and Stop to end it. If a tube or cap has been successfully detected, or a symbol has been successfully decoded, the object’s data and related features will be presented in the field below the image display window. Also, while the object is being inspected, the Read Rate LEDs will indicate the corresponding Read Rate percentage on the back of the unit. 2. To end the test, click the Stop button. Note: Read Rate can also be tested using the Read Rate interface in Utilities. Test Read Rate by Serial Command You can also start a test with the or command and end it with the command. 1-12 EZ Match User’s Manual Quick Start Step 10 — Configure the Imager in ESP To make setup changes to the EZ Match Imager, 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. Click the EZ Match button to Test the imager and to configure Multi-Operation settings, tube/cap Library settings, and tube/cap detection Messages. Click the Parameters button to show the tabbed tree controls for Communication, Read Cycle, Symbologies, I/O Parameters, Symbol Quality, Matchcode, and Diagnostics. Click the Setup button to access a Camera Setup tree control and Video view, and to Evaluate image captures, Calibrate the imager, set the Window of Interest, fine-tune capture settings and processing settings in the IP Database, set up output filters and parse symbol data in Ordered Output and Output Format, and control multiple read cycle functions in Dynamic Setup. Click the Terminal button to display tube or cap detection data or decoded symbol data, and to send serial commands to the imager using text or macros. Click the Utilities button to test Read Rate, request or clear Counters, enable or disable the imager or send output pulses in Device Control, determine the Differences from Default in the current settings, add or remove master symbol data in Master Database, and verify or update the imager’s Firmware. For further details, see ESP Help in the dropdown Help menu. EZ Match User’s Manual 1-13 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. Right click on the open screen and select Save to Reader to implement the command in the imager. Saving Options • Send, No Save. Changes will be lost when power is re-applied to the imager. • Send and Save. This activates all changes in current memory and saves to the imager for power-on. 1-14 EZ Match User’s Manual 2 Using ESP Contents EZ Mode........................................................................................................................................2-2 Application Mode...........................................................................................................................2-3 Menu Toolbar ................................................................................................................................2-4 Autoconnect ................................................................................................................................2-12 View ............................................................................................................................................2-14 Navigating in ESP .......................................................................................................................2-15 Send/Receive Options ................................................................................................................2-16 This section is designed to help you understand the basic structure and elements of ESP (Easy Setup Program). When you open ESP, unless otherwise specified in the ESP Preferences dialog accessible from the Options heading on the menu toolbar, you will enter EZ Mode for initial setup. From there, you can enter Application Mode (App Mode) and access several configuration menus (Communications, Read Cycle, Symbologies, I/O Parameters, Symbol Quality, Matchcode, and Diagnostics), a Camera setup interface, a Terminal interface, a Utilities interface, and an Output Format interface. ESP can be used to configure the EZ Match Imager in three different ways: • Tree Controls: Each configuration menu contains a list of all option settings that pertain to that specific element of imager operation. For example, the Communications menu shows a Host Port Connections option, and then a list of the sub-options Baud Rate, Parity, Stop Bits, and Data Bits. Each of these sub-options is configurable by using dropdown menus. • Graphic User Interfaces: Imager settings can be configured using such point-and-click tools as radio buttons, zoom in/zoom out sliders, spin boxes, check boxes, and drag-and-drop functions. • Terminal: ESP’s Terminal allows you to send serial configuration and utility commands directly to the imager by typing them in the provided text field. Information about using ESP in specific applications is provided in subsequent sections. For ESP system requirements, see ESP System Requirements in Chapter 1, Quick Start. EZ Match User’s Manual 2-1 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. When Decodes per Second is unchecked, the test will count the percentage of decodes relative to the number of actual scans. Click Stop to end the test. Calibrate The calibration routine that will optimize the imager by comparing Read Rates at various camera and image processing settings. Enter App Mode to access configuration trees and other setup features. Click Calibrate to begin the initial calibration routine. Calbration is explained at the left of the EZ Mode screen, and also in Quick Start. Click Locate to activate the EZ Match Imager’s blue target pattern LEDs. Center the target pattern on the symbol. The real-time display shows you where the symbol is located in the imager’s field of view. Starts Read Rate test. Ends Read Rate test. 2-2 EZ Match User’s Manual 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. Test, Multi-Operation, Library, Messages Video, Evaluation, Calibration, Window of Interest, IP Database, Ordered Output, Output Format, Dynamic Setup Open the Terminal view. Read Rate, Counters, Device Control, Differences, Master Database, Firmware Click on tabs in this row to access configuration trees like the one shown here. Click Capture and Decode to read the symbol in the field of view, and to see a high resolution image capture of the symbol. Decoded symbol data is shown in this table. Note: For specific information on any of the icons shown above in the operations bar or configuration bar, see the corresponding sections of this manual. EZ Match User’s Manual 2-3 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. (Save to Imager) (Receive Imager Settings) Import/Export Import converts the ASCII settings from a text file to ESP configuration settings. Export converts the active ESP configuration settings to an ASCII text file. 2-4 EZ Match User’s Manual Using ESP Model In Model you can select any of the models shown in ESP’s model menu. When you choose another model, your current connection to your present model will be terminated. To connect to another model, select New Model, choose a new model from the menu, and click OK. Note: All the models you have enabled by selecting will continue to appear in the Model menu and that the same menu is repeated when clicking the Switch Model icon. When you save your ESP file, you will be saving the settings of all the models defined in a single ESP file. EZ Match User’s Manual 2-5 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 when 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. Show Model Prompt At startup, shows the model menu displaying all supported readers. Show Connect Prompt At startup, displays the Would you like to connect to the EZ Match? prompt. Receive After Connect At startup, loads the imager’s settings into ESP. (This is not recommended if you want to preserve your ESP settings for future use.) Skip EZ Mode At startup, skips EZ Mode and opens directly in App Mode. Enable ‘Send and Save as Customer Defaults’ At startup, enables the Send and Save as Customer Defaults option in the Send/Recv command. 2-6 EZ Match User’s Manual 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. For example, to make Ctrl-F2 the keystroke to send a trigger character, select F2, then in the Ctrl row, enter and click OK. Then whenever the Ctrl-F2 keystroke is pressed, the trigger character will start the read cycle. Note: The F1 key is reserved for opening ESP Help and the F3 key is reserved for the Find Next function. Change Font Allows you to modify the font used for decode data received from the imager on the Terminal screen. Change Echo Font Allows you to modify the font used for command characters typed into the Terminal view. Enable Echo Allows you to enter command characters in Terminal. Display Incoming Data Even When Not in Focus When Display Incoming Data Even When Not in Focus is enabled, data from the imager will continue to appear in the Terminal even when ESP is not the top window. EZ Match User’s Manual 2-7 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 14 is 0.014 inches. 2-8 EZ Match User’s Manual 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. Receive Settings from the Reader will automatically send the imager’s settings to ESP when Auto Sync is enabled. Send ESP Settings to the Reader will automatically send all imager configuration settings chosen in ESP to the imager. Do Not Send or Receive Settings creates a condition in which Auto Sync will not automatically send imager settings to ESP, or send ESP settings to the imager. Show Target Pattern During Locate Allows you to determine whether the blue LED target pattern will be on or off during the Locate routine. Show Target Pattern During Calibrate Allows you to determine whether the blue LED target pattern will be on or off during the Calibrate routine. Use Higher Quality Images Sets ESP to output images at a higher resolution than standard JPEG format. Open Image after Save When Open Image after Save is enabled, ESP automatically opens saved image captures. Images can be saved from the Evaluation tab in the Camera view, or by right clicking an image in any other image capture view and then saving. Send XON with Autoconnect Sends an XON (Begin Transmission) command to the imager before starting the Autoconnect routine. EZ Match User’s Manual 2-9 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 an Ethernet option on the connection dialog. Note: This option should only be selected if you intend to connect using an Ethernet adapter. Use Default Storage Location When enabled, automatically stores data in ESP’s Application Data folder. 2-10 EZ Match User’s Manual 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. Note: Memos must be saved in a .esp file if you want them to available in your next session. If you do not save your current session, any memos that you have entered during the session will be discarded, and will be unavailable in your next session. EZ Match User’s Manual 2-11 Autoconnect Autoconnect • If your RS-232 connection attempt fails, you can use Autoconnect to establish a connection between the imager and the host. • If your communications port is not the default COM1, use the dropdown menu to change your port. • Once you have chosen the correct port, click Start to connect. When you are connected, you will see the green connection indicator in the status bar at the bottom right of your screen: Important: If you are using a USB model, you must connect the device to the host computer before powering-on. Otherwise the unit will not be recognized as a USB device. 2-12 EZ Match User’s Manual Using ESP Autoconnect (cont.) If your RS-232 host settings cannot be changed to match the imager’s settings: • Click Connect on ESP’s menu toolbar, and then select Connection Wizard. • When the connection dialog appears, check the Force Connect box and click the Connect button. EZ Match User’s Manual 2-13 View 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. Drag specific configuration values from the tree control directly into this field to encode new symbols. Choose a spatial orientation for the new symbol. Set a human-readable caption for the symbol that matches the encoded data, or write your own caption. The symbol you create will be displayed in the field at the bottom of the Bar Code Dialog. 2-14 EZ Match User’s Manual Using 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 tree controls: 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. Place your cursor in the selection box, scroll down to the setting you want to change, and single-click the setting. 4. Left click again on the open screen to complete the selection. 5. Right click on the open screen and select Save to Reader to implement the command in the imager. You can send the command without saving it, or you can send and save the command simultaneously. EZ Match User’s Manual 2-15 Send/Receive Options 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. This is useful if you want to receive (upload) the imager’s settings and save them as a file for future use. For example, if your imager has settings that you do not want to change, choosing Yes would allow you to load those settings to ESP and save them in an ESP file for later retrieval. Receiving the imager’s settings will also assure that you will not be subsequently saving any unwanted changes that you or someone else has made previously in ESP. Saving Send, No Save () Saves ESP settings to current memory. Send and Save ( ) Activates all changes in current memory and saves to the imager for power-on. Send and Save as Customer Defaults ( or a) Saves your default settings for quick retrieval. This option will be visible only if you have checked Enable ‘Send and Save as Customer Defaults’ in ESP Preferences. 2-16 EZ Match User’s Manual Using ESP 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. Add / Remove Exception After you perform a Receive Reader Settings command and you click on the Add Exception option, you may see a list of serial commands. These are commands that may be in your imager’s firmware, but not included in, or different from, your current version of ESP. You can edit these commands by double-clicking on them and changing them as needed. It is important to note that these commands will be saved to your imager whenever you send a Save to Reader command, or an command. Also, if there is a corresponding ESP menu item, the ESP Value column for that item will be blank following a Receive Reader Settings command. EZ Match User’s Manual 2-17 Send/Receive Options 2-18 EZ Match User’s Manual 3 Tube/Cap Inspection Contents Tube/Cap Inspection Serial Commands ....................................................................................... 3-2 Capture and Test .......................................................................................................................... 3-3 Multi-Operation ............................................................................................................................. 3-4 Multi-Operation by Serial Command............................................................................................. 3-5 Tube/Cap Library .......................................................................................................................... 3-8 Tube/Cap Information ................................................................................................................. 3-16 This section explains how to configure the EZ Match Imager to identify specific tube and cap characteristics, and how to manage the data that is acquired during tube/cap detection and symbol decoding operations. EZ Match User’s Manual 3-1 Tube/Cap Inspection Serial Commands Tube/Cap Inspection Serial Commands Active Tube/Cap Library Indexes Tube/Cap Dimensions Multi-Operation Tube/Cap Information Tube/Cap Message Formatting Tube/Cap Message Editing 3-2 EZ Match User’s Manual Tube/Cap Inspection Capture and Test Click the EZ Match button and then the Test tab to display the view shown below. Captures an image of the tube, cap, and/or symbol in the field of view and tests Multi-Operation settings (“Bar Code Reader”, “Tube Detection”, and “Cap Detection”). When enabled, shows the image in higher contrast than the default contrast value. When enabled, shows the reverse of the original image capture. Tube or cap detection results are shown in this field, as well as symbol data when applicable. EZ Match User’s Manual 3-3 Multi-Operation Multi-Operation Click the EZ Match button and then the Multi-Operation tab to display the following view. Note: Default Multi-Operation configuration shown below. Each operation can be assigned a range of IP Database indexes. Click Go to IP Database to configure capture settings and processing settings for each index. Note: All functions in the above view can be set using the Multi-Operation serial command . 3-4 EZ Match User’s Manual Tube/Cap Inspection Multi-Operation by Serial Command Multi-Operation allows users to customize triggered read cycle operations, and to perform those customized operations in a specific sequence. A specific range of IP Database indexes (from 1 to 10) can be assigned to each operation. Switching from one operation to the next can be configured to occur on an image frame count (from 1 to 6) or on a user-defined timeout (1 ms to 65535 ms). The Multi-Operation read cycle is defined to work with the same features and configuration settings as a normal read cycle. Important: Multi-Operation is only active when the imager is in a triggered read cycle. Default Multi-Operation Configuration Index Frame Count (Rapid Capture Mode only) Operation Database Range Timeout Min Max 1 Bar Code Reader 1 0 1000 1 1 2 Tube/Cap Detection 4 0 1500 2 2 3 Disabled 0 0 1000 3 3 Index (Multi-Operation) Serial Cmd: Options: 1 to 3 EZ Match User’s Manual 3-5 Multi-Operation by Serial Command Operation (Multi-Operation) Definition: Serial Cmd: Options: Specifies the operational flow of the read cycle, and allows up to 3 different operations to be sequenced in a single read cycle. The operation field is a bit field, and multiple processes can be defined for a single operation. The examples below demonstrate how to configure a tube and cap detection process to be defined in a single operation. Tube and Cap Detection Operation = 2 + 4 = 6 Disabled = 0 Bar Code Reader = Add 1 Tube Detection = Add 2 Cap Detection = Add 4 Disabled When set to Disabled, no processing is specified for the operation. Bar Code Reader Read cycle operation for the duration of the specified time and number of frames will include processing of image frames for enabled symbologies. Tube Detection Read cycle operation for the duration of the specified time and number of frames will include processing of image frames for presence or absence of test tubes. Cap Detection Read cycle operation for the duration of the specified time and number of frames will include processing of image frames for presence or absence of test tube caps. Frame Count (Multi-Operation) Definition: Serial Cmd: Default: Options: 3-6 Frame Count only applies if the imager is configured in a Rapid Capture mode of operation. The frame count value indicates the number of image frames that will occur before the read cycle will switch to the next operation. 0 = Disabled 1 to 6 EZ Match User’s Manual Tube/Cap Inspection Timeout (Multi-Operation) Note: Multi-Operation Timeout applies only to the specified operation (1 through 3). Definition: Serial Cmd: Options: Timeout indicates the amount of time required before the read cycle will switch to the next operation. Timeout is configurable in 1 ms increments. 1 to 65535 (in 1 ms increments) Database Range (Multi-Operation) When Multi-Operation is active, the Configuration Datase cannot be disabled. The database range fields specify the start and end index range to be used for each operation. Minimum Definition: Serial Cmd: Options: Specifies the starting IP Database index to be used for processing during the specified operation. 1 to 10 Maximum Definition: Serial Cmd: Options: Specifies the ending IP Database index to be used for processing during the specified operation. If this value is set to less than the minimum value, the minimum value will be used for both max and min. 1 to 10 EZ Match User’s Manual 3-7 Tube/Cap Library Tube/Cap Library Active Tube/Cap Library Indexes Click the EZ Match button and then the Library tab to display the Tube/Cap Library view. Important: The default Tube/Cap Library configuration shown below is only one example of how the database can be configured. The Tube/Cap Library database can be modified to fit your specific application. Each active tube/cap library index is shown in the Tube/Cap Library view. 3-8 EZ Match User’s Manual Tube/Cap Inspection Active Tube/Cap Library Indexes by Serial Command Definition: Determines the number of active tube/cap library indexes that will be used during a tube/cap detection operation. Serial Cmd: Default: 23 Options: 1 to 100 EZ Match User’s Manual 3-9 Tube/Cap Library Tube/Cap Dimensions Double-click the desired index to bring up the Edit Tube/Cap Dimensions dialog. Edit tube or cap dimensions using the up and down arrows or typing dimension values directly in the text fields provided. Click Revert to return to the previous settings for the selected index. Click Default to return to the default settings for the selected index. 3-10 The tube or cap manufacturer’s part number can be added in the text field shown above. Save new tube or cap information to the selected index when you are finished. EZ Match User’s Manual Tube/Cap Inspection Tube/Cap Dimensions by Serial Command Index Definition: Determines the index number where tube/cap information is to be stored in the tube/cap library. Serial Cmd: Options: 1 to 100 Tube Diameter Definition: The diameter of the tube in which the cap is to be placed (millimeters/10). Serial Cmd: Options: 0-32767 (mm/10) EZ Match User’s Manual 3-11 Tube/Cap Library Cap Base Length Definition: The length of the cap base (millimeters/10). Note: If this value is 0, it will be ignored. Serial Cmd: Options: 0-32767 (mm/10) Cap Tip Length Definition: The length of the cap tip (millimeters/10). Note: If this value is 0, it will be ignored. Serial Cmd: Options: 0-32767 (mm/10) 3-12 EZ Match User’s Manual Tube/Cap Inspection Cap Base Diameter Definition: The diameter of the cap base (millimeters/10). Important: This dimension should be measured at the bottom (where the cap is inserted in the tube), because some caps are tapered. Serial Cmd: Options: 0-32767 (mm/10) Cap Tip Diameter If the cap has a tip, this value represents the diameter of the tip in millimeters/10. Note: If this value is 0, it will be ignored. Serial Cmd: Options: 0-32767 (mm/10) Definition: EZ Match User’s Manual 3-13 Tube/Cap Library Hue (EZ Match Color Only) Definition: Describes the color type (red, green, blue, etc.) and is expressed in degrees. Serial Cmd: Options: 0-360° Saturation (EZ Match Color Only) Definition: Describes the vibrancy of the color. The lower the saturation, the more “grayness” is present, causing the color to appear faded. Serial Cmd: Options: 0-1000 Value (EZ Match Color Only) Definition: Describes the brightness of the color. Serial Cmd: Options: 0-1000 3-14 EZ Match User’s Manual Tube/Cap Inspection Tube/Cap Library Default Configuration Library Index 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 Tube Cap Base Diameter Length 120 64 125 137 125 137 153 90 152 60 152 65 120 58 125 90 116 79 116 78 154 90 115 79 125 92 153 91 126 138 121 195 118 195 122 195 125 139 122 195 153 150 152 197 154 60 Cap Tip Length 0 0 0 156 0 0 0 158 136 157 160 156 158 157 0 0 0 0 0 0 0 0 0 Cap Base Cap Tip Diameter Diameter 160 0 170 0 170 0 180 90 168 0 168 0 159 0 157 85 136 102 134 85 180 85 134 85 156 85 179 85 165 0 159 0 163 0 163 0 165 0 160 0 175 0 175 0 167 0 Hue Saturation Value 9 5 4 356 10 10 9 292 356 235 25 150 240 152 5 5 265 10 6 9 5 315 10 555 661 327 462 554 551 525 263 470 232 406 213 37 194 629 589 156 551 387 543 618 335 450 423 474 466 568 490 419 462 505 533 556 588 568 623 623 529 592 400 498 486 403 513 505 392 Important: Hue, Saturation, and Value are available for EZ Match Color only. EZ Match User’s Manual 3-15 Tube/Cap Information Tube/Cap Information Click the EZ Match button and then the Messages tab to display the Select Message view. Note: Default Tube/Cap Detection messages shown below. Note: A read cycle or read operation will format the No Read, CA_, and TA_ messages in the following order of precedence: TA_ (all), CA_ (all), No Read (all) Click this button to bring up the Edit Messages dialog. Note: The functions in the above view can also be set using the and serial commands. 3-16 EZ Match User’s Manual Tube/Cap Inspection Tube/Cap Information by Serial Command Usage: Definition: Serial Cmd: Tube/Cap Information is useful in more complex applications that require information about the spatial orientation of test tubes and cap characteristics in addition to presence/absence information. In addition to Tube/Cap Message output, Tube/Cap Information settings can be configured to show a user-defined Separator, a detected tube or cap’s specific Tube/Cap Library Index, a detected test tube’s Tube Angle, and a detected test tube’s Tube/Cap Tip Position. The following example shows a Tube/Cap Information output string: 001_+001_0001_06.RED.05_c001.d001_0001_CP Tube/Cap Tube Tube/Cap Match Sep. Sep. Sep. Cap Color Sep. Library Angle Tip Pos. Status Sep. Tube Dia. Sep. Tube/Cap Message 3 digits 1 (+/–) 3 1 4 digits char. digits char. 1 mag. color 1 color.dim 1 4 digits char. category char. char. 1 Up to 15 char. char. “001” “_” “_” “_” “+001” “_” “0001” 06.RED.05 “_” cxxx.dxxx “_” “0001” “_CP” Separator Definition Serial Cmd: Default: Options: Specifies the ASCII character used to separate tube/cap information. Note: Entering NUL (00 in hex) disables separator. _ (underscore) Any ASCII character Tube/Cap Library Index Definition Serial Cmd: Default: Options: When Tube/Cap Library Index is enabled, the three-digit tube/cap library index value will be appended to tube/cap detection output as a preamble. Disabled 0 = Disabled 1 = Enabled Notes: • This value is output in Read Rate when enabled. When enabled, the library index values are required to match in order to be part of the same output. For example, if a Cap Present that matches Tube/Cap Library Index 1 is processed 80% of the time, and a Cap Present that matches Tube/Cap Library Index 2 is processed 20% of the time, the output would be: 80% 001_CP_20% 002_CP_ • The Tube/Cap Library Index value is not required to match when requiring more than one tube/cap to qualify for an output. EZ Match User’s Manual 3-17 Tube/Cap Information Tube Angle Definition Serial Cmd: Default: Options: When Tube Angle is enabled, a polarity sign (+/–) and a three-digit value representing the angle of the tube in respect to the field of view will be appended to tube/cap detection output as a preamble. A + value indicates that the tube is angled away from the center and toward the bottom of the field of view, while a – indicates that the tube is angled away from the center and toward the top of the field of view. Disabled 0 = Disabled 1 = Enabled Notes: • This value is not output in Read Rate results. • The Tube Angle value is not required to match when requiring more than one tube/cap to qualify for an output. Tube/Cap Tip Position Definition Serial Cmd: Default: Options: When Tube/Cap Tip Position is enabled, a four-digit value will be appended to tube/cap detection output as a preamble. This value represents the distance on the X-axis from the left of the captured image to the tip of the tube or cap, in millimeters x10. Example: 0835 represents 83.5 mm. Disabled 0 = Disabled 1 = Enabled Cap Color (EZ Match Color Only) Definition Serial Cmd: Default: Options: 3-18 This feature is only available for the color version of the EZ Match Imager. Disabled 0 = Disabled 1 = Color 2 = HSV EZ Match User’s Manual Tube/Cap Inspection Color (Cap Color) Cap Color is output in three parts (magnitude-color-category), separated by a “.” character. Notes: • When Cap Color is enabled, it is output in read rate. The color output string is required to match to be part of the same output. For example, a RED cap with two different Category values will be output as follows: 80% 08.RED.12_CP_ 20% 08.RED.11_CP_ • If the cap is undetermined, the color of the cap may sometimes be undetermined as well. In such a case, a CNA (Color Not Available) message will supersede the color code. The table below shows the available output options. Magnitude Color 1-30 1-30 1-30 1-30 1-30 1-30 1-30 1-30 1-30 1-30 1-30 1-30 0 0 0 RED ORANGE YELLOW Y_GRN GREEN B_GRN CYAN G_BLUE BLUE P_BLUE MAGENTA P_RED WHITE BLACK GRAY C 0 0 0 0 0 0 0 0 0 0 0 0 Category Color Match Resolution H HS 0 1-6 0 1-6 0 1-6 0 1-6 0 1-6 0 1-6 0 1-6 0 1-6 0 1-6 0 1-6 0 1-6 0 1-6 0 0 1-4 HSV 1-30 1-30 1-30 1-30 1-30 1-30 1-30 1-30 1-30 1-30 1-30 1-30 Magnitude Magnitude is a value between 1 and 30 which defines the magnitude of the hue (further divides the (H)ue value to allow more resolution). This is useful in providing a distinction between different shades of a color. For example, the color PINK will have a Color value of RED, but to define PINK further, you would look at the magnitude of the Hue to describe the shade of RED. Color Color refers to the detected color of the cap. Category Category further defines the color into categories based on saturation and brightness. EZ Match User’s Manual 3-19 Tube/Cap Information HSV (Cap Color) When HSV is enabled, cap color values will be output in the following format: (H)ue-(S)aturation-(V)alue Example: 310-450-325 Notes: • This value is not output in read rate. • This value is not required to match when requiring more than one tube/cap to qualify for an output. Match Status (EZ Match Color Only) Definition Serial Cmd: Default: Options: This feature is only available for the color version of the EZ Match Imager. Match Status is output in the following format: Format: cxxx.dxxx where “c” = cap color library match; “d” = cap dimensions library match; “xxx” = tube/cap library index (When “xxx” = “000”, no match has occurred.) While the cap library output mode will output the “best” match, the value output from this mode will offer the last matched cap library index for color and dimension. If both a color and dimension match has occurred, the last cap library index that both color and dimension matched will be output. Notes: • This value is not output in read rate. • This value is not required to match when requiring more than one tube/cap to qualify for an output. Disabled 0 = Disabled 1 = Enabled Tube Diameter Definition Serial Cmd: Default: Options: 3-20 When Tube Diameter is enabled, a four-digit value will be appended to tube/cap detection output as a preamble. This value represents the diameter of the tube in millimeters x10. Example: 0835 represents 83.5 mm. Disabled 0 = Disabled 1 = Enabled EZ Match User’s Manual Tube/Cap Inspection Tube/Cap Message Formatting by Serial Command Cap Presence Message Definition: Serial Cmd: Default: Options: Tube/Cap Detection message database index that will be used for a Cap Present condition. 1 1 to 10 Cap Absence Message Definition: Serial Cmd: Default: Options: Tube/Cap Detection message database index that will be used for a Cap Absent condition. 2 1 to 10 Cap Unknown Message Definition: Serial Cmd: Default: Options: Tube/Cap Detection message database index that will be used for a Cap Unknown condition. 3 1 to 10 Tube Presence Message Definition: Serial Cmd: Default: Options: Tube/Cap Detection message database index that will be used for a Tube Present condition. 4 1 to 10 EZ Match User’s Manual 3-21 Tube/Cap Information Tube Absence Message Definition: Serial Cmd: Default: Options: 3-22 Tube/Cap Detection message database index that will be used for a Tube Absent condition. 5 1 to 10 EZ Match User’s Manual Tube/Cap Inspection Tube/Cap Message Editing All Tube/Cap Detection messages can be modified to meet the requirements of the specific application. Note: Tube and cap detection messages can also be edited using the command. Click the Edit Messages button to bring up the following dialog: Place your cursor in the text field adjacent to the number of the Tube/Cap Detection message you wish to change. Type the ASCII characters of the new message and click Save. Click Revert to return to the most recent message settings. Click Default to return to the original default message settings. The new message will appear on the corresponding dropdown menu in the Messages view. Hint: To enter Control characters as Tube/Cap Detection messages, right-click in any of the text fields in the Edit Messages dialog and click on Expand. To return to ASCII characters, right-click again and click on Contract. EZ Match User’s Manual 3-23 Tube/Cap Information Tube/Cap Message Editing by Serial Command Default Tube/Cap Detection messages are shown in the table below. All Tube/Cap Detection messages can be modified to meet the requirements of the specific application. Serial Cmd: Options: Index 1 2 3 4 5 6 7 8 9 10 Any ASCII string up to 15 characters. Messages CP_ CA_ CU_ TP_ TA_ MSG6_ MSG7_ MSG8_ MSG9_ MSG10_ Note: A read cycle or read operation will format the No Read, CA_, and TA_ messages in the following order of precedence: TA_ (all), CA_ (all), No Read (all) 3-24 EZ Match User’s Manual 4 Communications Contents Communications by ESP .............................................................................................................. 4-2 Communications Serial Commands.............................................................................................. 4-3 Host Port Connections .................................................................................................................. 4-4 Host Protocol ................................................................................................................................ 4-5 Poll Address.................................................................................................................................. 4-7 ACK/NAK Options......................................................................................................................... 4-8 Polling Mode Options.................................................................................................................... 4-9 RS-422 Status............................................................................................................................. 4-10 Auxiliary Port Connections.......................................................................................................... 4-11 Auxiliary Port System Data Status .............................................................................................. 4-19 Daisy Chain Autoconfigure ......................................................................................................... 4-20 Response Timeout...................................................................................................................... 4-21 LRC Status.................................................................................................................................. 4-22 Protocol Configuration Examples................................................................................................ 4-23 USB HID Interface ...................................................................................................................... 4-24 ASCII Character Entry Modifier................................................................................................... 4-33 Preamble..................................................................................................................................... 4-34 Postamble ................................................................................................................................... 4-35 This section tells how to set up communications parameters with the host and an auxiliary terminal. With Microscan’s ESP (Easy Setup Program), configuration changes can be made in the ESP menus and then sent and saved to your imager. The user can also send serial commands to the imager via ESP’s Terminal window. EZ Match User’s Manual 4-1 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. 4-2 EZ Match User’s Manual 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 ACK/NAK Options Polling Mode Options Autoconfiguration Daisy Chain EZ Match User’s Manual 4-3 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.2K 0 = 600 1 = 1200 2 = 2400 3 = 4800 4 = 9600 5 = 19.2K 6 = 38.4K 7 = 57.6K 8 = 115.2K 9 = 230K Parity, Host Port Usage: Definition: Serial Cmd: Default: Options: Only changed if necessary to match host setting. An error detection routine in which one data bit per character is set to 1 or 0 so that the total number of bits in the data field is either even or odd. None 0 = None 1 = Even 2 = Odd Stop Bits, Host Port Usage: Definition: Serial Cmd: Default: Options: Only changed if necessary to match host setting. One or two bits added to the end of each character to indicate the end of the character. One 0 = One 1 = Two Data Bits, Host Port Usage: Definition: Serial Cmd: Default: Options: Only changed if necessary to match host setting. One or two bits added to the end of each character to indicate the end of the character. Eight 0 = Seven 1 = Eight Note: See USB HID Interface on page 4-24 for protocol information relating to USB. 4-4 EZ Match User’s Manual Communications Host 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. Serial Cmd: Default: Point-to-Point Options: 0 = Point-to-Point 1 = Point-to-Point with RTS/CTS 2 = Point-to-Point with XON/XOFF 3 = Point-to-Point with RTS/CTS and XON/XOFF 4 = ACK/NAK 5 = Polling Mode Note: In all protocol modes, the preamble and postamble character strings can be used to frame the decode data, and both are included in calculating the LRC (Longitudinal Redundancy Check). Point-to-Point (Standard) Usage: Definition: Serial Cmd: Used only with RS-232 or RS-422. Standard Point-to-Point requires no address and sends the data to the host whenever it is available, without a request or handshake from the host. Point-to-Point with RTS/CTS Usage: Definition: Serial Cmd: A reader initiates a data transfer with an RTS (request-to-send) transmission. The host, when ready, responds with a CTS (clear-to-send) and the data is transmitted. RTS and CTS signals are transmitted over two dedicated wires as defined in the RS-232 standard. Used only with RS-232. Point-to-Point with RTS/CTS (request-to-send/clear-to-send) is a simple hardware handshake protocol that allows a reader to initiate data transfers to the host. Point-to-Point with XON/XOFF Usage: Definition: Serial Cmd: If an XOFF has been received from the host, data will not be sent to the host until the host sends an XON. During the XOFF phase, the host is free to carry on other chores and accept data from other devices. Used only with RS-232. This option enables the host to send the XON and XOFF command as a single byte transmission command of start (^Q) or stop (^S). EZ Match User’s Manual 4-5 Host 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 Point-to-Point with XON/XOFF. ACK/NAK Definition: Serial Cmd: See the ACK / NAK Options command on page 4-8. Polling Mode Definition: Serial Cmd: 4-6 See the Polling Mode Options command on page 4-9. EZ Match User’s Manual Communications Poll Address Serial Cmd: Default: Options: 1 1 to 50 1 = Poll address 0x1C, Select address 0x1D 2 = Poll address 0x1E, Select address 0x1F ... 50 = Poll address 0x7E, Select address 0x7F Note: See USB HID Interface on page 4-24 for protocol information relating to USB. EZ Match User’s Manual 4-7 ACK / NAK Options 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. RES-NAK Defaults RES: (Reset) REQ: (Request) STX: (Start of Text) ETX: (End of Text) ACK: (Acknowledge) NAK: (Negative Acknowledge) 00 (disabled) 00 (disabled) 00 (disabled) 00 (disabled) 06 15 The following are general outlines of the ACK/NAK protocol. Items that are framed by brackets ( [ ] ) can either be disabled or enabled. LRC does not include STX, but it does include preamble, postamble, and ETX. Symbol Data Output TX to host: [STX] [preamble] SYMBOL DATA [postamble] [ETX] [LRC] Response from host: ACK/NAK. Sent when LRC, ETX, postamble, or timeout (waiting for more data) are detected (if REQ is disabled) depending on what is enabled. Commands from Host to Imager TX to Imager: [STX] [ETX] [LRC] Response from Imager: ACK/NAK. Sent when LRC, ETX, or command-ending angle bracket ‘>’ are received, depending on what is enabled. Command Response from Imager to Host TX to host: [STX] [preamble] COMMAND RESPONSE DATA [postamble] [ETX] [LRC] Response from host: ACK/NAK. Sent when LRC, ETX, postamble, command-ending angle bracket ‘>’, or timeout (waiting for more data) are detected, depending on what is enabled. As with Polling Mode , the imager can optionally perform the REQ and RES event sequences in ACK/NAK mode. If the sender does not receive an ACK or NAK, it will send REQ to request such a response (if enabled). When the sender receives an ACK, too many NAKs, or times out (if already enabled), it will send a RES (if enabled) to terminate the transaction. Note: See ACK / NAK Data Flow Examples in Appendix D for sample ACK/NAK communication scenarios. Note: See USB HID Interface on page 4-24 for protocol information relating to USB. 4-8 EZ Match User’s Manual Communications 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 on page 4-7). To enable true multidrop protocol, the RS422/485 port must be enabled, , in order to turn the transmitter on and off. If RS-232 is enabled instead of RS422/485, , then Polling Mode will operate as a Point-to-Point polling protocol. This is because the RS-232 transmitter is always left on when enabled. RES-NAK Defaults RES: (Reset) REQ: (Request) STX: (Start of Text) ETX: (End of Text) ACK: (Acknowledge) NAK: (Negative Acknowledge) 04 05 02 03 06 15 Note: See Polling Mode Data Flow Examples in Appendix D for sample Polling Mode communication scenarios. Note: See USB HID Interface on page 4-24 for protocol information relating to USB. EZ Match User’s Manual 4-9 RS-422 Status 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. It is forced to 1 (enabled) in readers with “dedicated” RS-422 ports. 4-10 EZ Match User’s Manual Communications 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. These commands set the communication parameters with the auxiliary port, which can be used to configure menus, send data to the host, display data transmissions originating from the host, and relay data from other imagers set in tandem (daisy chained). Auxiliary Port Mode Usage: Definition: Serial Cmd: Default: Options: Can be used to transfer data faster or to match an auxiliary device. Determines the flow of data between the auxiliary port device(s), the imager, and the host. Disabled 0 = Disabled 1 = Transparent 2 = Half duplex 5 = Command Processing 3 = Full duplex 4 = Daisy chain Baud Rate, Auxiliary Port Usage: Definition: Serial Cmd: Default: Options: Can be used to transfer data faster or to match an auxiliary device. The rate at which the imager and host transfer data back and forth. 115.2K 0 = 600 1 = 1200 2 = 2400 3 = 4800 4 = 9600 5 = 19.2K 6 = 38.4K 7 = 57.6K 8 = 115.2K 9 = 230K EZ Match User’s Manual 4-11 Auxiliary Port Connections 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. None 0 = None 1 = Even 2 = Odd Stop Bits, Auxiliary Port Usage: Definition: Serial Cmd: Default: Options: Only changed if necessary to match host setting. Allows the user to select the last one or two bits in each character to indicate the end of the character. One 0 = One 1 = Two Data Bits, Auxiliary Port Usage: Definition: Serial Cmd: Default: Options: 4-12 Only changed if necessary to match host setting. Number of bits in each character. Eight 0 = Seven 1 = Eight EZ Match User’s Manual Communications 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. If sent with symbol data, it is processed on a first-in/first-out basis. • Auxiliary port data to the host is always sent with a preamble and postamble. • If the imager is in a polling mode with the host, auxiliary port data will still pass through. Aux. Port Host Imager Data Originating from the Imager • Transmission to the auxiliary port occurs immediately upon a Good Read. • Data sent to the auxiliary port does not include a preamble or a postamble. • Communications with the auxiliary port is always in Point-to-Point protocol, even if the host is in a polled protocol mode. Aux. Port Host Imager Data Originating from the Host • All host data is echoed to the auxiliary port in unpolled mode. Aux. Port Host Imager Serial Cmd: Options: 1 = Transparent EZ Match User’s Manual 4-13 Auxiliary Port Connections 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 data or read data is sent to the host whenever it is received. • Auxiliary port data is not echoed. • Auxiliary port data to the host is always sent without a preamble or postamble. Aux. Port Host Imager Data Originating from the Imager • Data is transmitted to the auxiliary port at the same time it is transmitted to the host. • Data transmission conforms with all parameters specified in the configuration menu (e.g. Preamble, Postamble, End of Read Cycle). Aux. Port Host Imager Data Originating from the Host • All host data is echoed to the auxiliary port in unpolled mode. Aux. Port Host Imager Serial Cmd. Options: 4-14 2 = Half Duplex EZ Match User’s Manual Communications 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. • Auxiliary port data is not echoed. • Auxiliary port data to the host is always sent without a preamble or postamble. Aux. Port Host Imager Data Originating from the Imager • Data is not sent to the auxiliary port. Aux. Port Host Imager Data Originating from the Host • All host data is echoed to the auxiliary port in unpolled mode. Aux. Port Host Imager Serial Cmd: Options: 3 = Full Duplex EZ Match User’s Manual 4-15 Auxiliary Port Connections 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. A primary reader has its host port linked to the host computer and its auxiliary port linked to the host port of the first secondary reader in the chain. Thereafter, each secondary reader’s auxiliary port is linked to the host port of the secondary reader that is farther from the host in the daisy chain. Each reader in the chain can be assigned an ID that accompanies any data that it sends. 4 = Daisy Chain Before the primary reader times out, it checks its auxiliary port for data. It should be set to wait at least 30 ms for each secondary reader in the daisy chain. If no data is received within the read cycle timeout, the primary reader sends a No Read message to the host. Otherwise the complete data is sent. If, for example, the primary reader is set to timeout in 120 ms, the first secondary reader reader downstream might be set to 90 ms, the next to 30 ms, and so forth, thus assuring that at least 30 ms elapses between transmissions.a Daisy-chained readers can send a series of symbols by enabling Multisymbol and a common multisymbol separator. If the primary reader does not receive the expected number of symbols, No Read messages are appended to the data string to make up the difference between the number of symbols enabled in Multisymbol and the number of symbols read. For example, a primary and two secondary readers have Number of Symbols set to 3 and Multisymbol Separator defined as %. If the primary and the first secondary reader do not find symbols, but the next secondary reader registers a Good Read, the transmitted results would be: symbol data % No Read % No Read a. The above example assumes a best-case scenario. Other factors, such as baud rate, number of characters in a given symbol, and the number of secondary readers in the daisy chain can affect timing and may need to be included in your calculations for complete accuracy. 4-16 EZ Match User’s Manual Communications Command Processing Mode Usage: Definition: Serial Cmd: Options: 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. • If the last command came from the host port, then externally triggered read cycle data will only be output to the host port. 5 = Command Processing EZ Match User’s Manual 4-17 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. Disabled 0 = Disabled 1 = Enabled Note: Enable/disable and length must be the same in all readers. Daisy Chain ID 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. A one or two character prefix which identifies the particular daisy chain reader from which the data is being sent to the host. 1/ Any one or two ASCII characters. Important: The ASCII characters <, >, and , can only be entered as hex pairs: For <: For >: For , : See ASCII Character Entry Modifier on page 4-33 for a detailed explanation of how to enter ASCII characters as hex values. 4-18 EZ Match User’s Manual Communications Auxiliary Port System Data Status Definition: Serial Cmd: Default: Options: 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. Disabled 0 = Disabled 1 = Enabled EZ Match User’s Manual 4-19 Daisy Chain Autoconfigure 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). • Propagates the communications settings and the relevant operating modes of the primary imager to the host and auxiliary ports of each secondary reader. • Resets each secondary reader. • Confirms that each secondary reader has acquired the new settings. Note: All secondary readers must be set to Serial for Daisy Chain to function. When setting up a daisy chain operation, perform the following steps: 1. Set the primary imager (the one connected to the host) to Serial. This sets all the imagers in the chain to Serial when the command is executed. Before Autoconfigure you must set the primary imager to Serial (S): Host S Primary Imager S Secondary Imager S Secondary Imager 2. Send . 3. If necessary, set the primary imager to Edge. After Autoconfigure you may set the primary imager to Edge (S), but the other imagers must remain in Serial (S): Host E 4-20 Primary Imager S Secondary Imager S Secondary Imager EZ Match User’s Manual Communications 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. 12 (in 1ms increments) 0 to 255 (A zero (0) setting causes an indefinite wait.) Note: See USB HID Interface on page 4-24 for protocol information relating to USB. EZ Match User’s Manual 4-21 LRC Status LRC Status (Longitudinal Redundancy Check) Usage: Definition: Serial Cmd: Default: Options: 4-22 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). What this means is that the binary representation of all the characters in a transmission are cumulatively added in a column and each resulting odd integer is assigned a 1 and each even integer a 0 (two 1s = 0, two 0s = 0, a 1 and a 0 = 1). The extra LRC character is then appended to the transmission, and the receiver (usually the host) performs the same addition and compares the results. Disabled 0 = Disabled 1 = Enabled EZ Match User’s Manual Communications Protocol Configuration Examples Point-to-Point (Main Port) Baud Rate: 115.2K; Parity: None; Stop Bits: 2; Data Bits: 8 Point-to-Point RS-232 enabled; = RS-422 enabled Polling Mode (Main Port) Baud Rate: 9600; Parity: None; Stop Bits: 2; Data Bits: 8 Polling Mode; Address: 23 RS-232 Point-to-Point polling; = RS-422/RS-485 true multidrop (switched transmitter) 30 ms Response Timeout “User-Defined” Polling Mode (Main Port) Baud Rate: 9600; Parity: None; Stop Bits: 2; Data Bits: 8 Polling Mode; Address: 12 Default RES (0x04), REQ=0x08; EOT=0x09; STX=0x18; ETX=0x0B; ACK=0x0C; NAK=0x0D RS-232 Point-to-Point polling; = RS-485 (true multidrop with switched transmitter) 40 ms Response Timeout ACK / NAK (Main Port) Baud Rate: 230K; Parity: None; Stop Bits: 2; Data Bits: 8 ACK/NAK Default RES and REQ (00, disabled); STX=0x01; ETX=0x1B; ACK=0x2E; NAK=0x1F RS-422 enabled; = RS-232 enabled 50 ms Response Timeout Auxiliary Port Listed below are several examples of Auxiliary Port commands. EZ Match User’s Manual Half Duplex; Baud Rate: 9600; Parity: None; Stop Bits: 2; Data Bits: 8 Transparent; Baud Rate: 19.2K; Parity: None; Stop Bits: 2; Data Bits: 8 Full Duplex; Baud Rate: 57.6K; Parity: None; Stop Bits: 2; Data Bits: 8 Command Processing; Baud Rate: 230K; Parity: None; Stop Bits: 2; Data Bits: 8 4-23 USB HID Interface USB HID Interface The USB version of the EZ Match Imager 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 EZ Match 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. Regardless of the report type used by the host application, the application protocol via USB is identical to RS-232 / RS-422 ports. HID Reports are used as a channel for standard Microscan imager communication, command input, and symbol data output. Important: No matter how the imager is configured, it is always able to receive and respond to commands from the host application using Microscan HID Reports. 4-24 EZ Match User’s Manual Communications 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. If the command requires a response (a part number, for example), the imager will always send the response through Microscan HID IN Reports. 4. The imager always ignores Keyboard OUT Reports sent by the host operating system. 5. The content of both the Keyboard Reports and Microscan HID IN Reports is identical, except for Keyboard Reports non-printable data limitations. Microscan HID IN Reports HID Reports are used as a channel for standard Microscan imager communication, command input, and symbol data output. There are two types of Microscan HID Reports: Report Type Microscan HID IN (imager to host) Microscan HID OUT (host to imager) Data Content Symbol data; No Reads; Service messages Commands; serial triggers Note: The imager is always able to receive commands and serial triggers from the host through Microscan HID OUT Reports, regardless of the Microscan HID IN Report status. If the imager receives a command that requests a response, such as a part number query, the imager will send a Microscan HID IN Report regardless of the IN Report status. Serial Cmd: Default: Options: 1 0 = Disabled 1 = Enabled Microscan HID IN Reports Enabled When this feature is enabled, the imager will send Microscan HID IN Reports to the host, containing data originated by the imager. Microscan HID IN Reports Disabled When this feature is disabled, the imager will not send Microscan HID IN Reports to the host, containing data originated by the imager. EZ Match User’s Manual 4-25 USB HID Interface 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. There is one type of Keyboard Report used: Report Type Keyboard IN (imager to host) Data Content Symbol data; No Reads; Service messages Note: If Keyboard IN Reports is enabled, and Microscan HID IN Reports is disabled, the read cycle must be Continuous Read 1 Output, because there will be no External Trigger or Serial Trigger. It is not possible to send commands to the imager as Keyboard OUT Reports. To send commands to the imager via USB, the host application must establish a connection with the imager and send Microscan HID OUT Reports. Serial Cmd: Default: Options: 0 0 = Disabled 1 = Enabled Keyboard IN Reports Enabled When this feature is enabled, the imager will send Keyboard IN Reports to the host, containing data originated by the imager. Keyboard IN Reports Disabled When this feature is disabled, the imager will not send Keyboard IN Reports to the host, containing data originated by the imager. 4-26 EZ Match User’s Manual Communications 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. LENGTH Size: 1 byte Value: 0-62 Note: Length indicates the number of valid data bytes in the fixed-length data field. This is necessary because the USB HID standards define HID Reports as fixed-length, yet the imager or host may require a smaller data size in any given report. DATA Size: 62 bytes, fixed-length Value: 0x00 to 0xFF Note: The Data field is left-justified, meaning it begins immediately after the Length field. All unused data space is NUL (00 in hex) padded. Data values can be “binary”, meaning that they span the entire 8 bit range of 0x00 to 0xFF. EZ Match User’s Manual 4-27 USB HID Interface 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. NUL padding = 51 bytes OUT report (from host to imager) 1_27_ (35) REPORT ID = 1 = Microscan HID LENGTH = 27 DATA = “ ” = These commands enable External Edge, set a 3 second timeout, and request the No Read configuration command. NUL padding = 35 bytes IN report (to host) 1_62_ command. Note that the command status response is not yet complete. See the next report example for the complete response. NUL padding = 0 bytes IN report (to host) 1_6_PORTS>(56) REPORT ID = 1 = Microscan HID LENGTH = 6 DATA = “PORTS>” = This is the end of the response to the command from the previous example. The entire command response is as follows: DATA = “K714,1, A LONG MESSAGE STREAMED OVER MULTIPLE MICROSCAN HID REPORTS>” . NUL padding = 56 bytes 4-28 EZ Match User’s Manual Communications 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. Keyboard Reports protocol requires that two reports be sent for every keystroke. The first report indicates which key is pressed. The second report indicates “no key pressed”, with all keycodes NUL (00 in hex) to indicate that all keys have been released. In the case of the EZ Match, each byte output is equivalent to a keystroke, with a “key pressed” report and a “no key pressed” report. For this reason, data rates are much slower when using Keyboard Reports. Field Descriptions REPORT ID Size: 1 byte Value: 0x02 Note: Report ID is the method employed by USB HID to allow multiple report formats to be sent and received from the same interface. MODIFIER Size: 1 byte Value: 0x00 to 0xFF Note: Modifier is an 8 bit field, corresponding to the state of the modifier keys at the time the keycode field was generated. Bit Key 0 LEFT CTRL 1 LEFT SHIFT 2 LEFT ALT 3 LEFT GUI 4 RIGHT CTRL 5 RIGHT SHIFT 6 RIGHT ALT 7 RIGHT GUI EZ Match User’s Manual 4-29 USB HID Interface Field Descriptions RESERVED Size: 1 byte Value: 0x00 Note: This field is Reserved. Its value is always NUL (00 in hex). KEYCODES Size: 6 bytes Value: 0x00 to 0xFF Note: The EZ Match 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. CR, 0x0D Enter key TAB, 0x09 Tab key ESC, 0x1B ESC key “Printable” characters, 0x20 to 0x7E These all translate to the keystrokes that produce them. This includes a-z, 0-9, punctuation, and SHIFT in the Modifier field, when necessary. Only the first Keycode in the 6 byte array will be populated. 4-30 EZ Match User’s Manual Communications USB HID Configuration Options The user has the following options for configuring and defaulting a USB version of the EZ Match Imager: Configuration Symbols (Data Matrix with “Configure Reader” Flag) Symbol configuration can be performed “out-of-the-box”, as the EZ Match 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. If the read cycle is changed, or if Data Matrix is disabled, another configuration/default method must be used. This is because the USB EZ Match has no external trigger, unless the user has configured the EZ Button as a trigger. EZ Button Configuration By default, basic calibration can be initiated from the EZ Button (3 beeps). Note that this only changes the camera, image processing, and symbology settings of the imager. To default the USB EZ Match, hold down the EZ Button during power-on. Note: This only overwrites Power-On settings with Custom Default settings, as when the command is received. It does not overwrite Power-On settings with Factory Defaults, as when the command is received. If Custom Defaults are misconfigured, another method must be used to default the imager. Implementing the Host Operating System API and Establishing a Connection with the Microscan HID Interface When a connection is made, the host can send serial configuration/default commands. The imager will always be able to receive configuration commands from the host application and send responses to those commands. However, the imager can be configured to stop producing IN Reports to the host from symbol data output and diagnostics (service messages). EZ Match User’s Manual 4-31 USB HID Interface 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. To send a trigger command the imager, the host application must establish a connection with the imager’s Microscan HID interface and send the trigger command in a Microscan HID Report. The following read cycle conditions are required for the USB EZ Match: Serial Cmd: Default: Options: Continuous 0 = Continuous Mode 1 = Coninuous Read 1 Output Mode 2 = Level Mode 3 = Edge Mode 4 = Serial Mode 5 = Serial and Edge Mode Important: • To use Level Mode, you must enable Undelimited Start Trigger Character and Undelimited End Trigger Character . • To use Edge Mode, you must enable and use the Undelimited Start Trigger Character . • To use Serial Mode, you must use the Delimited Trigger defined by , or enable and use the Undelimited Start Trigger Character . • To use Serial and Edge Mode, you must use the Delimited Trigger defined by , or enable and use the Undelimited Start Trigger Character . Communications For the USB version of the EZ Match, no communications serial commands have any effect on the imager except the following: • USB HID Report Status • Preamble • Postamble EZ Button Default on power-on cannot be disabled = . This ensures a level of safety for recovering from misconfigured Power-On settings . However, it is not foolproof, as defaulting with the EZ Button only recovers Custom Default settings, which can be misconfigured themselves. For this reason, do not save to Custom Default settings until the imager’s configuration has been tested. Symbologies If the imager is going to be configured with Data Matrix symbols, do not disable Data Matrix . Disabling Data Matrix will prevent the imager from reading configuration symbols. 4-32 EZ Match User’s Manual Communications 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 Appendix E, 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. Example: Consider the Postamble command: Serial Cmd: Imagine that your application requires the ASCII character > to be the postamble in your symbol decode output. The ASCII characters <, >, and , can only be entered as hex pairs. So, to make > the postamble in your symbol decode output, enter the Postamble command as follows: Note that the “status” field contains only a , . This is because the only field that is being changed is the “postamble character(s)” field. (See Serial Configuration Command Conventions on page A-13 for a more detailed explanation of this command shortcut.) EZ Match User’s Manual 4-33 Preamble 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. Disabled 0 = Disabled 1 = Enabled (within any protocol) Preamble Characters Serial Cmd: Default: Options: ^M corresponds to: carriage return. To enter control characters within a serial command, hold down the Ctrl key while typing the desired character. Example: to enter the control character ^M. Important: The ASCII characters <, >, and , can only be entered as hex pairs: For <: For >: For , : See ASCII Character Entry Modifier on page 4-33 for a detailed explanation of how to enter ASCII characters as hex values. 4-34 EZ Match User’s Manual Communications 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. Enabled 0 = Disabled 1 = Enabled (within any protocol) Postamble Characters Serial Cmd: Default: Options: ^M^J corresponds to: carriage return/line feed. To enter control characters within a serial command, hold down the control key while typing the desired character. Example: to enter ^M^J. Important: The ASCII characters <, >, and , can only be entered as hex pairs: For <: For >: For , : See ASCII Character Entry Modifier on page 4-33 for a detailed explanation of how to enter ASCII characters as hex values. EZ Match User’s Manual 4-35 Postamble 4-36 EZ Match User’s Manual 5 Calibration Contents Calibration Serial Commands ....................................................................................................... 5-2 Calibration Overview..................................................................................................................... 5-2 Calibration Options ....................................................................................................................... 5-3 Calibration by ESP..................................................................................................................... 5-10 Initiating Calibration ................................................................................................................... 5-12 Additional Notes about Calibration............................................................................................. 5-17 This section shows the EZ Match Imager’s calibration options, and explains the different ways that those options can be configured. EZ Match User’s Manual 5-1 Calibration Serial Commands Calibration Serial Commands Calibration Options Calibration <@CAL> Calibration Overview Calibration is one of the most powerful features of the EZ Match Imager. The calibration process can be initiated by serial command, EZ Button, or ESP user interface. When the imager enters calibration, it runs through an optimization cycle that sets the ideal parameters for reading symbols at the highest possible level of performance. Calibration can be specially configured to optimize specific parameters, such as gain, shutter speed, and symbol type. The calibration process consists of five separate phases: search pass, medium pass, and fine-tune pass. During this process the imager quickly locates configuration setup, defines a calibration range for the configuration parameters, and then tunes those parameters for optimal performance. 5-2 EZ Match User’s Manual 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 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 (page 11-25) is part of the calibration process regardless of the calibration setup. After successful completion of the calibration routine, the background color will be set to the appropriate value, depending on the symbol in the field of view. The Mirrored Image parameter (page 11-26) is not part of the calibration process, and it must be configured appropriately prior to calibration. Gain Definition: Serial Cmd: Default: Options: When enabled, gain will be calibrated to provide the best available image quality and performance. When disabled, gain is fixed and is not part of the calibration process. Enabled 0 = Disabled 1 = Enabled Shutter Speed Unless an application is a static setup, the shutter speed setting should be configured by the user based on the application. For dynamic applications, the user should configure the shutter speed setting so the calibration process can optimize the gain for that setting. Serial Cmd: Default: Disabled Options: 0 = Disabled 1 = Enabled 2 = Fast Shutter Note: The following table shows general guidelines for shutter speed configurations based on various line speeds. The configurations shown depend on the imager’s optical configuration, and on symbol element size. Definition: Shutter Speed 0 - 250 250 - 750 750 - 1500 1500 - 2000 2000 - 2500 EZ Match User’s Manual Line Speed static 5” / sec 10” / sec 15” / sec 20” / sec 5-3 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. The image quality or contrast may not be as good as what would be achieved with the Enabled setting. The calibration process is not designed to choose the fastest shutter speed that can decode a symbol, but rather to optimize for the fastest shutter speed that still provides good image quality. 5-4 EZ Match User’s Manual 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. All symbologies that are readable by the imager except PDF417 and Pharmacode will be considered during calibration. Any new symbologies successfully decoded during calibration will remain enabled at the end of the process. All enabled symbologies will remain enabled. For example, assume that only Code 39 is enabled at the beginning of calibration. If a Code 128 symbol is read during calibration, then Code 128, as well as Code 39, will be enabled after the calibration process is complete. EZ Match User’s Manual 5-5 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. When a successful calibration process is completed, the camera WOI will be adjusted according to the mode enabled. Otherwise, the original WOI configuration will be retained. Disabled 0 = Disabled 1 = Row and Column 2 = Row 3 = Column 4 = Straight Line 5 = Straight Line Framed Starting WOI After Decode Calibration Passed Calibration Failed If WOI framing is not enabled, the current WOI configuration will be used until a symbol has been decoded. After a symbol is decoded, the WOI is framed exactly as it would be if a WOI framing mode was enabled. When the calibration process is complete, the original WOI configuration is restored. Refer to the diagram below: Configured WOI 5-6 After Decode Calibration Passed Calibration Failed EZ Match User’s Manual 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. Refer to the diagram below: Column If the calibration process is successful, the Window of Interest columns will be modified to vertically frame the symbol, plus an additional margin area around the symbol, determined by the WOI Margin parameter. Refer to the diagram below: Row If the calibration process is successful, the Window of Interest rows will be modified to horizontally frame the symbol, plus an additional margin area around the symbol, determined by the WOI Margin parameter. Refer to the diagram below: EZ Match User’s Manual 5-7 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. If the symbol is vertical, the image column size will be set by the scan height parameter, and will be configured for full row resolution. If the symbol is horizontal, the image row size will be set by the scan height parameter, and will be configured for full column resolution. The scan line will be centered in the middle of the symbol. If the symbol is tilted such that the scan line will not pass completely through the symbol, the scan width will be adjusted to include the entire symbol. Refer to the diagram below: Straight Line Framed This parameter is the same as “Straight Line”, except that the Window of Interest will also frame the scan line on the symbol length as well. The scan line includes the symbol plus an additional margin area determined by the WOI Margin parameter. 5-8 EZ Match User’s Manual 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. 75 (pixels) 20 to 1280 Line Scan Height Definition: Serial Cmd: Default: Options: This parameter is only used with the Straight Line modes. It sets the scan height of the straight-line image, and it is expressed in number of pixels. 64 (pixels) 3 to 1024 Processing Definition: Serial Cmd: Default: Options: This setting defines the amount of time and effort the imager will spend attempting to decode a symbol for each parameter configuration. Medium 0 = Low 1 = Medium 2 = High 3 = Definable Low The imager will spend a low amount of effort attempting to decode the given symbol for each parameter configuration. Medium The imager will spend a medium amount of effort attempting to decode the given symbol for each parameter configuration. High The imager will spend a high amount of effort attempting to decode the given symbol for each parameter configuration. Definable The processing time for each image frame is defined by the Image Processing Timeout parameter . EZ Match User’s Manual 5-9 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. Focus, Shutter, Gain, and Image Quality values are all tracked in real-time during the calibration process. Gain and Shutter Speed are configurable in the Calibration interface. Determines the amount of time and effort the imager will spend attempting to decode a symbol for each parameter configuration. (Low, Medium, High, Definable). Dropdown menu of 1D and 2D symbologies, and a check box for enabling or disabling Composite symbologies. Initiates the calibration routine. Cancels the calibration process, if necessary. The Window of Interest section of the Calibration interface allows the user to make precise adjustments to WOI Framing, WOI Margin (in pixels), and the scan height of the straight-line image (in pixels). 5-10 EZ Match User’s Manual 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. EZ Match User’s Manual 5-11 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 on page 1-11 for the EZ Button calibration procedure. 5-12 EZ Match User’s Manual 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. Read Rate LEDs When calibration is initiated through a serial command or the EZ Button, the imager’s Read Rate LEDs indicate calibration progress as follows: LEDs 20% 20%, 40%, 60% 20%, 40%, 60%, 80% 20%, 40%, 60%, 80%, 100% Calibration Progress Search Pass in progress. Medium Pass in progress. Fine-Tune Pass in progress. Calibrated Successfully (holds for green flash duration). Calibrated Successfully Fine-Tune Pass Medium Pass Search Pass Beeper / Green Flash The beeper and green LED flash are used to indicate calibration status as shown in the table below: Indicator 2 quick beeps 5 quick beeps 1 long beep 1 sec. Green Flash EZ Match User’s Manual Status Calibration has started. Calibration has failed. Calibration has been completed successfully. Calibration has been completed successfully. 5-13 Initiating Calibration Calibration Progress Output to Terminal When initiated by serial command or EZ Button, the calibration 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 calibration process can have up to 5 steps (Search Pass, Medium Pass, Fine-Tune Pass). Calibration data is shown in a simple table format under 8 category headings, each of which are defined below. Heading Prog Rating Decode Quality Shutter Gain Locate Definition Progress indicator with a range of 0 - 100. Indicates percent complete. Rating indicator; higher ratings are more favorable. Number of successful decodes for the pass. Quality indicator; higher ratings are more favorable. Shutter setting under operation. Gain setting under operation. Time required to locate symbol, expressed in milliseconds. Calibration Progress Output Examples (Terminal) Search Pass The purpose of Search Pass is to decode a symbol in as few configurations as possible during calibration. This process is designed to identify symbology type, and to identify any other image processing parameters that are already calibrated. Running Search Pass 5-14 Prog Rating Decode Quality Focus Shutter Gain Locate 12 14 16 18 0 0 0 2174 0 0 0 1 0 0 0 72 313 313 313 313 250 250 250 250 0 9 18 27 0 0 0 24 EZ Match User’s Manual Calibration Medium Pass The theory behind Medium Pass is to develop a readable range from which to dial in a decoded symbol. Running Medium Pass Prog Rating Decode Quality Focus Shutter Gain Locate 51 53 55 57 59 61 63 65 67 69 71 73 75 4216 8436 6336 8448 8456 8464 8472 8488 8504 8512 8528 8584 8644 2 4 3 4 4 4 4 4 4 4 4 4 4 8 20 24 32 40 48 56 72 88 96 112 168 228 386 386 386 386 386 386 386 386 386 386 386 386 386 250 250 250 250 250 250 250 250 250 250 250 250 250 0 4 8 12 16 20 24 28 32 36 40 44 48 5 4 4 4 5 4 5 5 5 5 6 5 5 Rating List (Best): Rating = 8606; Focus = 386; Shutter = 250; Gain = 48 Rating = 8581; Focus = 386; Shutter = 250; Gain = 44 Rating = 8553; Focus = 386; Shutter = 250; Gain = 40 Rating = 8527; Focus = 386; Shutter = 250; Gain = 36 Rating = 8505; Focus = 386; Shutter = 250; Gain = 32 Rating = 8488; Focus = 386; Shutter = 250; Gain = 28 Rating = 8476; Focus = 386; Shutter = 250; Gain = 24 EZ Match User’s Manual 5-15 Initiating 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. Running Fine Tune Pass Prog Rating Decode Quality Focus Shutter Gain Locate 77 79 81 84 86 88 90 93 95 97 100 6416 6424 6424 6432 6448 6464 6476 6488 6506 6524 6538 3 3 3 3 3 3 3 3 3 3 3 104 112 112 120 136 152 164 176 194 212 226 386 386 386 386 386 386 386 386 386 386 386 250 250 250 250 250 250 250 250 250 250 250 38 39 40 41 42 43 44 45 46 47 48 7 6 6 6 5 5 5 5 6 5 6 Rating List (Best): Rating = 6527; Focus = 386; Shutter = 250; Gain = 48 Rating = 6517; Focus = 386; Shutter = 250; Gain = 47 Rating = 6505; Focus = 386; Shutter = 250; Gain = 46 Rating = 6491; Focus = 386; Shutter = 250; Gain = 45 Rating = 6476; Focus = 386; Shutter = 250; Gain = 44 Rating = 6462; Focus = 386; Shutter = 250; Gain = 43 Rating = 6449; Focus = 386; Shutter = 250; Gain = 42 Calibration PASSED. 5-16 EZ Match User’s Manual 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. If WOI Framing is disabled, the current WOI configuration will be used for the Search Pass. 4. IP Mode will not be altered during calibration. 5. Threshold Mode will be set to Adaptive during calibration. At the end of a successful calibration, Threshold Mode will remain set to Adaptive regardless of its previous setting. Otherwise, the value will revert to its original state. 6. If Symbol Type is enabled for calibration (Autodiscriminate), then Interleaved 2 of 5 Range Mode will be enabled. This allows variable-length Interleaved 2 of 5 symbols to be decoded. If an Interleaved 2 of 5 symbol is decoded during calibration, then code length # 1 will be set to the decoded symbol length at the end of calibration. Otherwise, the symbol lengths will be restored to their original configurations. 7. Pharmacode is not calibrated. 8. The symbol size, dimension, and orientation parameters of the No Symbol / Bad Symbol and Symbol Qualification command will be updated if calibration is completed successfully. 9. All symbol types that were enabled before calibration will still be enabled after calibration. For example, if Data Matrix ECC 200 was enabled before calibration, and the calibration routine was performed on a Code 128 symbol, then after calibration is completed both Data Matrix ECC 200 and Code 128 will be enabled. 10. The calibration process does not modify the global Composite status . The global Composite status must be configured properly before calibration. 11. If the user requires calibration of a stacked symbology , , or , that symbology must be enabled and configured appropriately before calibration. 12. The Search process will use the configurable Window of Interest for image captures. However, when the search process is completed, the WOI will be reduced to include only the symbol of interest and some additional boundary area. EZ Match User’s Manual 5-17 Additional Notes about Calibration 5-18 EZ Match User’s Manual 6 Read Cycle Contents Read Cycle by ESP ...................................................................................................................... 6-2 Read Cycle Serial Commands...................................................................................................... 6-3 Read Cycle Setup......................................................................................................................... 6-4 Multisymbol................................................................................................................................... 6-5 Trigger Mode and Duration........................................................................................................... 6-7 External Trigger Polarity ............................................................................................................. 6-12 Serial Trigger .............................................................................................................................. 6-13 Start Trigger Character (Non-Delimited)..................................................................................... 6-14 Stop Trigger Character (Non-Delimited) ..................................................................................... 6-15 End of Read Cycle...................................................................................................................... 6-16 Capture Mode ............................................................................................................................. 6-18 Capture Timing ........................................................................................................................... 6-23 Image Storage ............................................................................................................................ 6-25 Minimum Good Reads ................................................................................................................ 6-28 After you’ve established communications with the imager, you will need to address the spatial and timing parameters associated with your application. This section explains those parameters. EZ Match User’s Manual 6-1 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 +. 6-2 To change a setting, double-click the setting and use your cursor to scroll through the options. EZ Match User’s Manual Read Cycle Read Cycle Serial Commands Trigger Mode/Duration Serial Trigger Character External Trigger State End of Read Cycle Minimum Good Reads Multisymbol Start Trigger Character Stop Trigger Character Capture Mode Capture Timing Image Storage EZ Match User’s Manual 6-3 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 EZ Match Imager 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. Select Capture Mode, Continuous Mode, or Rapid Capture Mode. 5. Select Number of Captures (if in Rapid Capture Mode). 6. Set the Time Before First Capture and Time Between Captures, if any. Note: The imager’s camera captures images at a rate of about 16/second (based on a full-size 1280 x 1024 monochrome image). The capture rate increases as frame sizes decrease. 6-4 EZ Match User’s Manual 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”. • The maximum number of characters in a read cycle is 3,000 for all symbols. • All No Read messages are posted at the end of the data string, unless output filtering is enabled. • If more than one symbol is within the field of view at the same time, symbol data may not be displayed in the order of appearance. • If Matchcode Type is set to Sequential or if Trigger is set to Continuous Read 1 Output, the imager will behave as if Number of Symbols were set to 1, regardless of the user-defined configuration. Number of Symbols Definition: Serial Cmd: Default: Options: This parameter has no function when a Multi-Operation read cycle is active. Each operation index (1 through 3) requires one qualified output for each active operation. Example: If tube and cap detection are both enabled for operation index 1, the required number of symbols for that index would be 2. Important: The same symbol, tube, or cap can be processed and qualified by two different operations in the same read cycle. 1 1 to 100 EZ Match User’s Manual 6-5 Multisymbol Multisymbol Separator Usage: Definition: Serial Cmd: Default: Options: Used to delimit or separate data fields with a user defined character. Any valid ASCII character, inserted between each symbol read when Multisymbol is set to any number greater than 1. , (comma) Any available ASCII character. Important: The ASCII characters <, >, and , can only be entered as hex pairs: For <: For >: For , : See ASCII Character Entry Modifier on page 4-33 for a more detailed explanation of how to enter ASCII characters as hex values. Note: If No Read messages are disabled and there are No Reads occurring, separators will only be inserted between symbol data outputs. 6-6 EZ Match User’s Manual Read Cycle Trigger Mode and Duration Trigger Definition: The event that initiates the read cycle. Note: When calibrating the imager or testing Read Rate, the current trigger setting will be disregarded. Trigger Mode Serial Cmd: Default: Options: Continuous Read 0 = Continuous Read 1 = Continuous Read 1 Output 2 = External Level 3 = External Edge 4 = Serial Data 5 = Serial Data and Edge Continuous Read Usage: Definition: Serial Cmd: Continuous Read is useful in testing symbol readability or reader functions. It is not recommended for normal operations. In Continuous Read, trigger input options are disabled, the imager is always in the read cycle, and it will attempt to decode and transmit every capture. If a single symbol stays within read range for multiple read cycles, its data will be transmitted repeatedly until it leaves the read range. The imager sends replies to serial commands that require responses when symbol data is transmitted, or read cycle timeout is enabled and a timeout occurs and at least one captured image has been processed. Depending on the combination of enabled symbologies and the Threshold Mode setting, the imager may take longer than the timeout to process a captured image. Note: When to Output and No Read options have no affect on Continuous Read. EZ Match User’s Manual 6-7 Trigger Mode and Duration 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. If End of Read Cycle is set to Timeout and the symbol doesn’t change, the output is repeated at the end of each timeout period. For example, if Timeout is set to one second, the imager sends the symbol data immediately and repeats the output at intervals of one second for as long as it continues to capture the symbol. If End of Read Cycle is set to New Trigger, the imager will send the current symbol data immediately, but only once. A new symbol appearing in the imager’s range will be read and sent immediately, provided it is not identical to the previous symbol. Caution: In automated environments, Continuous Read 1 Output is not recommended because there is typically no reliable way to verify that a symbol was missed. Note: If Trigger Mode is set to Continuous Read 1 Output, the imager will behave as if Number of Symbols were set to 1, regardless of the user-defined configuration. 6-8 EZ Match User’s Manual Read Cycle 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. Usage: Definition: Serial Cmd: This mode is effective in an application where the speeds of the conveying apparatus are variable and the time the imager spends reading each object is not predictable. It also allows the user to determine if a No Read has occurred. External Level allows the read cycle (active state) to begin when a trigger (change of state) from an external sensing device is received. The read cycle persists until the object moves out of the sensor range and the active trigger state changes again. Important: Level and Edge apply to the active logic state (Negative or Positive) that exists while the object is in a read cycle, between the rising edge and the falling edge. Rising edge is the trigger signal associated with the appearance of an object. Falling edge is the trigger signal associated with the subsequent disappearance of the object. This applies both to External Level and External Edge. External Edge Initiate Read Cycle: Object # 1, moving in front of the detector beam, causes a change in the trigger state, which initiates the read cycle. Initiate Second Read Cycle: Object # 2, moving in front of the detector beam, causes another change in the trigger state. This signal initiates a new read cycle and ends the previous read cycle unless Timeout is enabled and a Good Read or timeout has not occured. Usage: Definition: Serial Cmd: This mode is highly recommended in any application where conveying speed is constant, or if spacing, object size, or read cycle timeouts are consistent. External Edge, as with Level, allows the read cycle (active state) to begin when a trigger (change of state) from an external sensing device is received. However, the passing of an object out of sensor range does not end the read cycle. The read cycle ends with a Good Read output, or, depending on the End of Read Cycle setting, a timeout or new trigger occurs. EZ Match User’s Manual 6-9 Trigger Mode and Duration 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. Serial commands are entered inside angle brackets, as shown here: . Note: In Serial Data, sending a non-delimited start serial character will start a read cycle; however, a non-delimited stop serial character has no effect. Serial Data and Edge Usage: Definition: Serial Cmd: Serial Data and Edge is seldom used but can be useful in an application that primarily uses an external sensing device but occasionally needs to be triggered manually. An auxiliary terminal can be connected to the auxiliary port so the user can send the serial trigger character through the imager to the host. In this mode the imager accepts either a serial ASCII character or an external trigger pulse to start the read cycle. Note: In Serial Data, sending a non-delimited start serial character will start a read cycle; however, a non-delimited stop serial character has no effect. 6-10 EZ Match User’s Manual Read Cycle Trigger Filter Duration Usage: Definition: Serial Cmd: Default: Options: Trigger Filter Duration allows the imager to disregard false trigger events. When Trigger Mode is set to either External Edge or External Level, the read cycle’s active state must be delayed until the specified filter duration has elapsed. The imager will trigger at the end of that duration. 313 (in 32µs increments) 1 to 65535 (corresponding with 32µs to 2.10 seconds in 32µs steps) Note: If Trigger Mode is set to External Edge, the imager will trigger only after the active state has been delayed for the specified filter duration. Note: If Trigger Mode is set to External Level, the imager will trigger once the active state has been delayed for the specified filter duration after the appearance of an object’s active edge. In addition, the active state must be delayed for the specified filter duration after the disappearance of the object’s falling edge for the trigger to be rendered inactive. EZ Match User’s Manual 6-11 External Trigger Polarity External Trigger Polarity Usage: Definition: Serial Cmd: Default: Options: 6-12 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. Positive 0 = Negative 1 = Positive EZ Match User’s Manual Read Cycle 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. Serial Trigger Character (Delimited) Usage: Definition: Serial Cmd: Default: Options: Allows the user to define the trigger character that initiates the read cycle. A single ASCII host serial trigger character that initiates the read cycle. A delimited trigger character is one that either starts or ends the read cycle and is enclosed by delimiters such as < >. Space bar Any single ASCII character, including control characters, except NUL (00 in hex), an existing host command character, or an on-line protocol character. Control characters entered on the command line are displayed in the menu as mnemonic characters. Note: Serial Data or Serial Data and Edge triggering mode must be enabled for Serial Trigger Character to take effect. Important: The ASCII characters <, >, and , can only be entered as hex pairs: For <: For >: For , : See ASCII Character Entry Modifier on page 4-33 for a detailed explanation of how to enter ASCII characters as hex values. EZ Match User’s Manual 6-13 Start Trigger Character (Non-Delimited) 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. When defining Start trigger characters, the following rules apply: • In External Edge the imager looks only for the Start trigger character and ignores any Stop trigger character that may be defined. • In External Level the Start trigger character begins the read cycle and the Stop trigger character ends it. Note that even after a symbol has been decoded and the symbol data transmitted, the imager remains in External Level trigger read cycle until a Stop character is received. • In Serial Data and Edge trigger mode, either a Start trigger character or a hardware trigger can start an edge trigger read cycle. NUL (00 in hex; disabled) Two hex digits representing any ASCII character except XON and XOFF. Important: The ASCII characters <, >, and , can only be entered as hex pairs: For <: For >: For , : See ASCII Character Entry Modifier on page 4-33 for a detailed explanation of how to enter ASCII characters as hex values. 6-14 EZ Match User’s Manual Read Cycle 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. When defining Stop trigger characters, the following rules apply: • In External Edge the imager looks only for the Start trigger character and ignores any Stop trigger character that may be defined. • In External Level the Start trigger character begins the read cycle and the Stop trigger character ends it. Note that even after a symbol has been decoded and the symbol data transmitted, the imager remains in External Level trigger read cycle until a Stop character is received. • In Serial Data and Edge trigger mode, either a Start trigger character or a hardware trigger can start an edge trigger read cycle. NUL (00 in hex; disabled) Two hex digits representing an ASCII character. Important: The ASCII characters <, >, and , can only be entered as hex pairs: For <: For >: For , : See ASCII Character Entry Modifier on page 4-33 for a detailed explanation of how to enter ASCII characters as hex values. EZ Match User’s Manual 6-15 End of 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 or detect a tube or cap. 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. Note: End of Read Cycle settings apply to the entire read cycle, while Multi-Operation Timeout applies only to the specific operation (1 through 3) for which it is defined. End of Read Cycle Mode Note: When operating in Continuous Read or Continuous Read 1 Output, the imager is always in the read cycle. Serial Cmd: Default: Options: Timeout 0 = Timeout 1 = New Trigger 2 = Timeout and New Trigger 3 = Last Frame 4 = Last Frame and New Trigger Timeout Usage: Definition: 6-16 Typically used with Serial Data and Edge and Continuous Read 1 Output. It is effective in highly controlled applications when the maximum length of time between objects can be predicted. It assures that a read cycle ends before the next symbol appears, giving the system extra time to decode and transmit the data to the host. Timeout ends the read cycle, causing the reader to stop reading symbols and send the symbol data or No Read message when the time set in Timeout elapses (times out), if When to Output is set to End of Read Cycle. If in Continuous Read 1 Output, a timeout initiates a new read cycle and allows the same symbol to be read again. With External Edge, Serial Data, or Serial Data and Edge enabled, a timeout ends the read cycle and symbol data or a No Read message is sent to the host. With External Level enabled, the read cycle does not end until the falling edge trigger occurs or a timeout occurs. The next read cycle does not begin until the next rising edge trigger. EZ Match User’s Manual 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 and Edge enabled, an edge or serial trigger ends a read cycle and initiates the next read cycle. In the case of External Level, a falling edge trigger ends the read cycle but the next read cycle does not begin until the occurrence of the next rising edge trigger. Timeout and New Trigger Usage: Definition: Useful in applications that require an alternative way to end the read cycle. For example, if an assembly line should stop completely or the intervals between objects are highly irregular. Timeout and New Trigger is identical to Timeout except that a timeout or a new trigger (whichever occurs first) ends the read cycle. Last Frame Usage: Definition: Useful in applications in which the number of captures needed can be defined but the timeout duration varies. Last Frame only applies to Rapid Capture Mode. Last Frame and New Trigger Usage: Definition: Useful in applications in which line speeds are irregular and a new labelled object could appear before the last frame in a Rapid Capture sequence. Last Frame and New Trigger is identical to New Trigger except that a new trigger or last frame (whichever occurs first) ends the read cycle. Read Cycle Timeout Definition: Serial Cmd: Default: Options: Read Cycle Timeout is the duration of the read cycle. 250 (x10 ms or 2.5 seconds) 1 to 65535 EZ Match User’s Manual 6-17 Capture Mode 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. Continuous Capture Usage: Definition: Continuous Capture is useful in applications with slower line speeds or where symbol spacing may be random or not time-dependent. In Continuous Capture Mode, image captures are taken throughout the read cycle in a multi-buffered format (see diagram below). The imager begins processing the first captured image at the same time that it captures the second image. Captures will continue occurring throughout the read cycle until an end condition occurs, such as a timeout, a new trigger, the last frame in a capture sequence, or a combination of the above. Capture Start of Read Cycle 1 2 3 4 5 End of read cycle Processing time 6-18 EZ Match User’s Manual Read Cycle 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. 1 1 to 64 Note: The range of maximum number of captures is dynamic. This range is dependent on the maximum image size in the system. A full-size image (1280 x 1024) reduces the maximum number of images to 6. The smaller the image size, the greater the maximum number of captures. Once the image size is reduced to small enough dimensions, the maximum number of captures will be capped at 64. If a user enters a maximum capture value greater than that allowed, the value will be limited to the number of system images. This command also affects the number of stored images allowed in the system. If the maximum number of captures is selected, the number of stored images allowed will be 0. Note: Number of Captures specifies the maximum number of captures as it pertains to a Multi-Operation read cycle. When configured to switch operations on a frame count or timeout, the total number of captures cannot exceed this maximum value. When configured to switch operations on a specified frame count and the operation completes before this maximum value is reached, the image frame count will increase automatically to match the frame switch count. This maintains image frame and timeout consistency for each operation index. Rapid Capture Mode Definition: Serial Cmd: Default: Options: In 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. Timed Capture 0 = Timed Capture 1 = Triggered Capture EZ Match User’s Manual 6-19 Capture Mode 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. No Time Delay Between Captures Start of Read Cycle Diagram A n End of read cycle Time Before First Capture Time Delay Between Captures End of read cycle Diagram B Processing 6-20 EZ Match User’s Manual Read Cycle 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. Note: If End of Read Cycle is set for New Trigger and the read cycle qualifications have not been met, the read cycle will only end once it receives the first trigger after reaching the predetermined Number of Captures setting. First trigger starts the read cycle Captures on every trigger Capture Read cycle ends on New Trigger or Timeout, as configured. Processing EZ Match User’s Manual 6-21 Pre-Processing Definition: Serial Cmd: Default: Options: When enabled, this feature reduces the time between image capture and decode by beginning the processing task while an image is being captured. Enabled 0 = Disabled 1 = Enabled Disabled When Pre-Processing is disabled, the imager can process previously captured images while image capture events are taking place. The benefit of this operation is that the image capture events have minimal impact on image processing. Therefore, if the imager is configured to capture 4 consecutive frames, but it is only looking for one decode, it could process and decode a symbol on the first image frame before all 4 image frames were captured. If Pre-Processing were enabled, the imager could not start processing an image frame until all 4 image frames were captured (since they are consecutive captures). Enabled When Pre-Processing is enabled, the imager performs pre-processing tasks while an image is being captured. Since some of the processing is complete when the image has been captured, the time required to complete the processing of the image frame will be less (approx. 10 ms/frame). However, while an image is being captured, the imager is dedicated to operating on the current image being captured. This means that an image capture event will impact the processing time of previously captured image frames. The benefit of this mode is the decrease in capture-to-decode time. 6-22 EZ Match User’s Manual 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. 0 0 to 65535 (2.097 seconds, in 32 µS increments) Start of Read Cycle Time Before First Capture Processing EZ Match User’s Manual 6-23 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. Disabled/Clear 0 = Disabled/Clear 1 = Store on No Read Disabled / Clear Upon selection of this option, all saved images will be cleared and the imager will not store images for later viewing. Store on No Read This option will cause the imager to store an image upon exiting the read cycle for retrieval at a later time. If multiple captures are present during the duration of a read cycle, the stored image will be the last image processed for that read cycle. This image is stored in RAM and can be retrieved as long as power is cycled to the imager, and as long as the imager has not been reset via a reset/save sequence. Other commands that can initialize storage in RAM are ones that change capture modes or put the imager in a test capture mode. Note: A Cap Absence or Tube Absence will qualify for image storage when Store on No Read is selected. In a Multi-Operation read cycle with output set to As Soon As Possible, only the results from the last operation are retained. Therefore, if two operations are active, the first resulting in a No Read condition and the second not resulting in a No Read condition, no image will be stored. EZ Match User’s Manual 6-25 Image Storage Image Storage Mode Serial Cmd: Default: Options: First Mode 0 = First Mode 1 = Last Mode First Mode This mode allows the imager to store images until the available image memory has been filled. At that point the imager will stop saving additional images. In this mode, you will always have the first image captured, because the saving process stops once memory has been filled. Last Mode In this mode, image storage continues after available memory limits are reached. The oldest image in memory is overwritten, so you will always have the most recent stored image. 6-26 EZ Match User’s Manual Read Cycle Image Storage Example The following example assumes that the imager is in a rapid capture mode of 3 captures. Number of Symbols: Frame # 1: Frame # 2: Frame # 3: Read Cycle Result: Stored Frame: 1 No Read No Read Good Read, Symbol # 1 Good Read None Number of Symbols: Frame # 1: Frame # 2: Frame # 3: Read Cycle Result: Stored Frame: 1 No Read No Read No Read No Read Frame # 3 Number of Symbols: Frame # 1: Frame # 2: Frame # 3: Read Cycle Result: Stored Frame: 2 No Read No Read Good Read, Symbol # 1 No Read Frame # 2 EZ Match User’s Manual 6-27 Minimum Good Reads Minimum Good Reads Definition: Serial Cmd: Default: Options: 6-28 This value specifies the number of times a symbol needs to be read to qualify as a Good Read. 1 1 to 255 EZ Match User’s Manual 7 Symbologies Contents Symbologies by ESP.................................................................................................................... 7-2 Symbologies Serial Commands ................................................................................................... 7-3 Data Matrix ................................................................................................................................... 7-4 QR Code ...................................................................................................................................... 7-6 Code 39........................................................................................................................................ 7-7 Code 128 / EAN-128 .................................................................................................................. 7-10 BC412 ........................................................................................................................................ 7-13 Interleaved 2 of 5........................................................................................................................ 7-14 Code 93...................................................................................................................................... 7-17 Codabar...................................................................................................................................... 7-18 UPC/EAN ................................................................................................................................... 7-21 Pharmacode ............................................................................................................................... 7-25 GS1 DataBar (RSS) ................................................................................................................... 7-27 PDF417 ...................................................................................................................................... 7-29 MicroPDF417 ............................................................................................................................. 7-31 Composite .................................................................................................................................. 7-32 Narrow Margins / Symbology Identifier ...................................................................................... 7-33 This section describes the various symbol types that can be read and decoded by the EZ Match Imager. See the following sites for additional information about linear and 2D symbologies: http://www.aimglobal.org/standards/aimpubs.asp http://barcodes.gs1us.org/dnn_bcec/Default.aspx?tabid=82 EZ Match User’s Manual 7-1 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 +. 7-2 EZ Match User’s Manual Symbologies Symbologies Serial Commands Narrow Margins/Symbology ID Background Color Composite Code 39 Codabar Interleaved 2 of 5 UPC/EAN Code 128/EAN-128 Code 93 PDF417 Pharmacode Data Matrix QR Code BC412 DataBar-14 DataBar Limited DataBar Expanded MicroPDF417 EZ Match User’s Manual