Microscan MINI Hawk Xi User manual

MINI Hawk Xi
High Performance Imager
User Manual
P/N 84-006304 Rev A
Copyright and Disclaimer
Copyright ©2015
Microscan Systems, Inc.
Tel: +1.425.226.5700 / 800.762.1149
Fax: +1.425.226.8250
All rights reserved. The information contained herein is proprietary and is provided solely for the purpose of allowing customers to operate and/or service Microscan manufactured equipment and is not to be
released, reproduced, or used for any other purpose without written permission of Microscan.
Throughout this manual, trademarked names might be used. We state herein that we are using the names
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
For current warranty information, see: www.microscan.com/warranty.
Microscan Systems, Inc.
United States Corporate Headquarters
+1.425.226.5700 / 800.762.1149
United States Northeast Technology Center
+1.603.598.8400 / 800.468.9503
European Headquarters
+31.172.423360
Asia Pacific Headquarters
+65.6846.1214
ii
MINI Hawk Xi High Performance Imager User 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 Imager and Symbol ........................................................ 1-4
Step 4 Install ESP.................................................................................... 1-5
Step 5 Select Model ................................................................................ 1-6
Step 6 Connect ........................................................................................ 1-7
Step 7 Locate the Symbol in the Field of View ........................................ 1-8
Step 8 Calibrate..................................................................................... 1-10
Step 9 Test Read Rate .......................................................................... 1-11
Step 10 Configure the Imager in ESP ................................................... 1-12
Step 11 Save Configuration in ESP....................................................... 1-13
Chapter 2
Using ESP
EZ Mode .................................................................................................. 2-2
Application Mode ..................................................................................... 2-3
Menu Toolbar .......................................................................................... 2-4
View ...................................................................................................... 2-13
Navigating in ESP................................................................................. 2-14
Send/Receive Options .......................................................................... 2-15
Using EZ Trax........................................................................................ 2-17
Chapter 3
Communications
Communications by ESP......................................................................... 3-2
Communications Serial Commands ........................................................ 3-3
Host Port Connections............................................................................. 3-4
Host Port Protocol ................................................................................... 3-5
ACK/NAK Options ................................................................................... 3-6
Polling Mode Options .............................................................................. 3-7
Ethernet ................................................................................................... 3-8
Response Timeout ................................................................................ 3-14
LRC Status ............................................................................................ 3-15
Protocol Configuration Examples .......................................................... 3-16
ASCII Character Entry Modifier ............................................................. 3-17
Preamble ............................................................................................... 3-18
Postamble.............................................................................................. 3-19
Chapter 4
Calibration
Calibration Serial Commands .................................................................. 4-2
Calibration Overview ............................................................................... 4-2
Calibration Options .................................................................................. 4-3
Calibration by ESP ................................................................................ 4-11
Initiating Calibration ............................................................................... 4-13
MINI Hawk Xi High Performance Imager User Manual
iii
Table of Contents
Additional Notes about Calibration ........................................................ 4-19
Chapter 5
Read Cycle
Read Cycle by ESP ................................................................................. 5-2
Read Cycle Serial Commands ................................................................ 5-3
Read Cycle Setup ................................................................................... 5-4
Multisymbol ............................................................................................. 5-5
Trigger Mode and Filter Duration ............................................................ 5-6
External Trigger Polarity ........................................................................ 5-11
Serial Trigger ......................................................................................... 5-12
Start Trigger Character (Non-Delimited)................................................ 5-13
Stop Trigger Character (Non-Delimited)................................................ 5-14
End of Read Cycle ................................................................................ 5-15
Capture Mode........................................................................................ 5-17
Capture Timing ...................................................................................... 5-21
Image Processing Timeout.................................................................... 5-23
Image Storage ....................................................................................... 5-24
Decodes Before Output ......................................................................... 5-26
Setting Up the Imager for EZ Trax ........................................................ 5-28
Chapter 6
Symbologies
Symbologies by ESP............................................................................... 6-2
Symbologies Serial Commands .............................................................. 6-3
Data Matrix .............................................................................................. 6-4
Aztec Code .............................................................................................. 6-6
QR Code ................................................................................................. 6-7
Micro QR Code........................................................................................ 6-8
Code 39 ................................................................................................... 6-9
Code 128/EAN 128 ............................................................................... 6-12
BC412 ................................................................................................... 6-15
Interleaved 2 of 5................................................................................... 6-16
Code 93 ................................................................................................. 6-19
Codabar................................................................................................. 6-20
UPC/EAN .............................................................................................. 6-23
Pharmacode .......................................................................................... 6-27
Postal Symbologies ............................................................................... 6-29
GS1 DataBar ......................................................................................... 6-34
PDF417 ................................................................................................. 6-36
MicroPDF417 ........................................................................................ 6-37
Composite ............................................................................................. 6-38
Narrow Margins/Symbology Identifier.................................................... 6-39
Background Color.................................................................................. 6-41
Chapter 7
I/O Parameters
I/O Parameters by ESP ........................................................................... 7-2
I/O Parameters Serial Commands .......................................................... 7-3
iv
MINI Hawk Xi High Performance Imager User Manual
Introduction
Symbol Data Output ................................................................................ 7-4
No Read Message ................................................................................... 7-7
Read Duration Output.............................................................................. 7-8
Output Indicators ..................................................................................... 7-9
Beeper ................................................................................................... 7-13
LED Configuration ................................................................................. 7-14
Serial Verification................................................................................... 7-15
EZ Button............................................................................................... 7-17
EZ Button Modes ................................................................................... 7-19
Configurable Output 1 ........................................................................... 7-21
Trend Analysis Output 1 ........................................................................ 7-24
ISO/IEC 16022 Symbol Quality Output 1 .............................................. 7-27
Diagnostic Output 1 ............................................................................... 7-30
Configurable Output 2 ........................................................................... 7-31
Trend Analysis Output 2 ........................................................................ 7-31
ISO/IEC 16022 Symbol Quality Output 2 .............................................. 7-31
Diagnostic Output 2 ............................................................................... 7-31
Configurable Output 3 ........................................................................... 7-32
Trend Analysis Output 3 ........................................................................ 7-32
ISO/IEC 16022 Symbol Quality Output 3 .............................................. 7-32
Diagnostic Output 3 ............................................................................... 7-32
Power-On/Reset Counts........................................................................ 7-33
Time Since Reset .................................................................................. 7-34
Service Message ................................................................................... 7-35
Frame Information ................................................................................. 7-36
Image Output ......................................................................................... 7-37
Database Identifier Output..................................................................... 7-40
Quality Output........................................................................................ 7-41
Configuring EZ Trax Output................................................................... 7-42
Chapter 8
Symbol Quality
Symbol Quality by ESP ........................................................................... 8-2
Symbol Quality Serial Commands ........................................................... 8-3
Overview of Symbol Quality .................................................................... 8-4
Symbol Quality Separator/Data Matrix Output Mode .............................. 8-8
ISO/IEC 16022 Symbol Quality Output ................................................. 8-10
ISO/IEC 16022 Symbol Quality Output by ESP .................................... 8-12
Microscan Symbol Quality Output ......................................................... 8-13
Microscan Symbol Quality Output by ESP ............................................ 8-16
Chapter 9
Matchcode
Matchcode by ESP .................................................................................. 9-2
Matchcode Serial Commands ................................................................. 9-3
Overview of Matchcode ........................................................................... 9-4
Matchcode Type ...................................................................................... 9-5
Match Replace....................................................................................... 9-10
MINI Hawk Xi High Performance Imager User Manual
v
Table of Contents
Mismatch Replace ................................................................................. 9-11
New Master Pin ..................................................................................... 9-12
Chapter 10
Camera and IP Setup
Camera and IP Setup by ESP............................................................... 10-2
Camera and IP Setup Serial Commands .............................................. 10-3
Video ..................................................................................................... 10-4
Evaluation.............................................................................................. 10-5
Calibration ............................................................................................. 10-8
Window of Interest................................................................................. 10-9
Configuration Database....................................................................... 10-13
Dynamic Setup .................................................................................... 10-14
X-Mode™ ............................................................................................ 10-15
Pixel Sub-Sampling ............................................................................. 10-16
Camera Settings.................................................................................. 10-18
Focal Distance..................................................................................... 10-19
Focal Distance Table (Read-Only) ...................................................... 10-20
Increment Focus Position .................................................................... 10-21
Decrement Focus Position .................................................................. 10-21
Illumination Brightness ........................................................................ 10-22
Skew Correction .................................................................................. 10-23
Morphological Pre-Processing ............................................................ 10-26
Morphological Operation and Operator Size ....................................... 10-27
Chapter 11
Configuration Database
Configuration Database Serial Commands ........................................... 11-2
Number of Active Indexes ..................................................................... 11-3
Configuration Database Status ............................................................. 11-4
Database Mode ................................................................................... 11-10
Save Current Settings to Configuration Database .............................. 11-15
Load Current Settings from Configuration Database .......................... 11-16
Request Selected Index Settings ........................................................ 11-17
Request All Configuration Database Settings ..................................... 11-18
Chapter 12
Terminal
Terminal Window................................................................................... 12-2
Find ....................................................................................................... 12-3
Send ...................................................................................................... 12-4
Macros................................................................................................... 12-5
Terminal Window Menus ....................................................................... 12-6
Chapter 13
Utilities
Serial Utility Commands ........................................................................ 13-2
Read Rate ............................................................................................. 13-4
Counters ................................................................................................ 13-6
Device Control ....................................................................................... 13-8
Differences from Default........................................................................ 13-9
Master Database ................................................................................. 13-10
vi
MINI Hawk Xi High Performance Imager User Manual
Introduction
Firmware.............................................................................................. 13-16
Default/Reset/Save.............................................................................. 13-19
Imager Status Requests ...................................................................... 13-21
Learn Operations ................................................................................. 13-23
Other Operational Serial Commands .................................................. 13-24
Chapter 14
Output Format
Output Format Serial Commands .......................................................... 14-2
Output Format Status ............................................................................ 14-3
Format Assign ....................................................................................... 14-4
Format Extract ....................................................................................... 14-5
Format Insert ......................................................................................... 14-7
Output Filter Configuration .................................................................... 14-9
Number of Filters ................................................................................. 14-14
Appendices
Appendix A General Specifications .........................................................A-2
Appendix B Electrical Specifications .......................................................A-9
Appendix C Serial Configuration Commands ........................................A-17
Appendix D Communications Protocol ..................................................A-23
Appendix E ASCII Table ........................................................................A-32
Appendix F Operational Tips .................................................................A-33
Appendix G Using an External Trigger ..................................................A-34
Appendix H MINI Hawk Xi Image Output ..............................................A-35
Appendix I Using EtherNet/IP ................................................................A-38
Appendix J Allen-Bradley Version 20 PLC Setup, Trigger and Read ....A-47
Appendix K Glossary of Terms ..............................................................A-59
MINI Hawk Xi High Performance Imager User Manual
vii
About the MINI Hawk High Performance Imager
About the MINI Hawk Xi High Performance Imager
The key features of the MINI Hawk Xi High Performance Imager are:
• Powerful X-Mode™ decoding technology
• Standard Density, High Density, and Ultra High Density options
• Ethernet TCP/IP connectivity
• Compatible with industrial M12 cabling
• Software-adjustable focus
• Support for both linear and 2D symbologies
• High-output LED illumination
• 10-30 VDC
• Optoisolated I/O
• EZ Button for setup and testing
• A blue target pattern that identifies the center point of the field of view
• A green flash (visible from all angles) to signal a successful read
• Compact size for easy integration into a wide variety of applications
MINI Hawk Xi Communications
There are three ways to configure and test the MINI Hawk Xi:
• 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 <K100,1>, that can be sent from ESP’s Terminal or another
terminal program.
• The EZ Button at the back of the imager.
viii
MINI Hawk Xi High Performance Imager User 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 MINI Hawk Xi’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 MINI Hawk Xi’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 MINI Hawk Xi is intended for connection to a UL-listed direct plug-in power
unit marked Class II and rated 24 VDC at 5 Watts, or greater if using electrical accessories.
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.
WARNING: Baseplate temperature may exceed 70° C at maximum operating
temperature and may cause burns. Use caution when handling.
MINI Hawk Xi High Performance Imager User Manual
ix
Statement of Agency Compliance
Statement of Agency Compliance
The MINI Hawk Xi 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 MINI Hawk Xi 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:1998+A1:2001+A2:2003, 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:1998+A1:2000+A2:2003 for Class A products, Class A Radiated
Emissions, and Class A Conducted Emissions.
The MINI Hawk Xi has been tested by an independent electromagnetic compatibility laboratory
in accordance with the applicable specifications and instructions.
x
MINI Hawk Xi High Performance Imager User 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 “Directive 2002/95/EC” 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 Perfluorooctanic Acid (PFOA) compounds above the maximum
trace levels. To view the document 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.
In regards to “RoHS Directive 2011_65_EU” Microscan produces Monitoring and Control Instruments as well as
Industrial Monitoring & Control Instruments as defined within the directive. Microscan has developed and is
implementing a RoHS2 compliance plan with the intention of bringing all active products listed in our current
marketing literature within full compliance as per the directive deadlines.
Key milestones for the transition plan are as follows:
• Complete internal product audit by July 2014.
• Initial “Monitoring and Control Instruments” RoHS2 compliant products available by December 2014
• Initial “Industrial Monitoring & Control Instruments” RoHS2 compliant products available by July 2015
• All new products introduced in 2015 are expected to be WEEE & RoHS2 compliant.
Microscan will mark the products with the ‘CE’ marking that complies with the RoHS2 process to acquire ‘CE’ certification
per the example given: Example >> Machinery directive + EMC directive + RoHS2 = Declaration of Conformity.
MINI Hawk Xi High Performance Imager User Manual
xi
Statement of RoHS Compliance
xii
MINI Hawk Xi High Performance Imager User Manual
1 Quick Start
Contents
Step 1 Check Hardware................................................................................................................ 1-2
Step 2 Connect the System .......................................................................................................... 1-3
Step 3 Position Imager and Symbol.............................................................................................. 1-4
Step 4 Install ESP ......................................................................................................................... 1-5
Step 5 Select Model...................................................................................................................... 1-6
Step 6 Connect ............................................................................................................................. 1-7
Step 7 Locate the Symbol in the Field of View ............................................................................. 1-8
Step 8 Calibrate ......................................................................................................................... 1-10
Step 9 Test Read Rate .............................................................................................................. 1-11
Step 10 Configure the Imager in ESP........................................................................................ 1-12
Step 11 Save Configuration in ESP ........................................................................................... 1-13
This chapter is designed to get your MINI Hawk Xi up and running quickly, using the EZ
button or ESP (Easy Setup Program). Following these steps will allow you to get a sense
of the imager’s capabilities and to test sample symbols.
Detailed setup information for installing the imager into your actual application can be
found in the subsequent chapters.
MINI Hawk Xi High Performance Imager User Manual
1-1
Check Hardware
Step 1 — Check Hardware
Item
1
2
3
4
Description
Part Number
FIS-6310-CLSOG
MINI Hawk Xi
(C)ommunication: 1 (Ethernet)
(L)ens: 1 = Standard Density; 2 = High Density; 3 = Ultra High Density
(S)ensor: 0 = WVGA; 1 = SXGA
(O)ption: 0 = Standard; 1 = Custom
QX-1 Interface Device
98-000103-02
Power Supply, M12 12-pin Socket, 1.3 m (Screw-On)
97-000003-03
Photo Sensor, M12 4-pin Plug, NPN, Dark On, 2 m
99-000020-02
1
1
2
3
3
Ethernet Standalone without QX-1
4
Ethernet Standalone with QX-1
Caution: Be sure that all cables are connected BEFORE applying power to the
system. Always power down BEFORE disconnecting any cables.
1-2
MINI Hawk Xi High Performance Imager User Manual
Quick Start
Step 2 — Connect the System
Ethernet Standalone without QX-1
• Connect the M12 (power and I/O) end of the imager’s cable to the power supply (3).
• Connect the RJ45 (Ethernet) end of the imager’s cable to the host.
• Plug in the power supply to apply power to the imager.
Ethernet Standalone with QX-1
•
•
•
•
•
Connect the M12 (power and I/O) end of the imager’s cable to “2” on the QX-1 (2).
Connect the RJ45 (Ethernet) end of the imager’s cable to the host.
Connect the power supply (3) to “3” on the QX-1.
Connect the photo sensor (4) to “T” on the QX-1.
Plug in the power supply to apply power to the imager.
1
1
2
3
3
Ethernet Standalone without QX-1
4
Ethernet Standalone with QX-1
Caution: Be sure that all cables are connected BEFORE applying power to the
system. Always power down BEFORE disconnecting any cables.
MINI Hawk Xi High Performance Imager User Manual
1-3
Position Imager and Symbol
Step 3 — Position Imager and Symbol
• Position the imager at a focal distance between 2 and 6 inches from the symbol.
• Tip the imager relative to the symbol to avoid the glare of direct (specular) reflection. The
case parting line should be perpendicular to the plane of the symbol by either pitching the
symbol or the imager as shown.
• Position the imager in a place with as little ambient light as possible.
• Symbols can be rotated (tilted) at any angle; however, for best results symbols should
be aligned with the FOV (field of view).
Imager and Symbol Orientation
• In the case of linear symbols, aligning the bars in the direction of their movement (“ladder”
orientation) will minimize the chances of blurring, and will produce better reads.
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.
Skew axis
Tilt
axis
Pitch
axis
Scan line
Imager and Symbol Orientation
Note: For accuracy of testing and performance, Microscan recommends using a mounting
arm adapter kit. Contact your Microscan sales manager for details about mounting arm
adapter kits and other accessories.
1-4
MINI Hawk Xi High Performance Imager User Manual
Quick Start
Step 4 — Install ESP
ESP Software can be found on the Microscan Tools Drive that is packaged with the MINI
Hawk Xi.
1. Follow the prompts to install ESP from the Tools Drive.
2. Click on the ESP icon to run the program.
Note: ESP can also be installed from the Download Center at
www.microscan.com.
Minimum System Requirements
•
•
•
•
•
•
233 MHz Pentium PC
Windows 8, 7, Vista, or XP operating system (32-bit or 64-bit)
Internet Explorer 6.0 or higher
128 MB RAM or greater
160 MB free disk space
800 x 600 256 color display (1024 x 768 32-bit color recommended)
MINI Hawk Xi High Performance Imager User Manual
1-5
Select Model
Step 5 — Select Model
When you start ESP, the following menu will appear:
1. Click the button showing the MINI Hawk Xi.
2. Click OK.
Note: You can also double-click the MINI Hawk Xi 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
MINI Hawk Xi High Performance Imager User Manual
Quick Start
Step 6 — Connect
• Click Connect on the menu toolbar, and then select Connection Wizard.
• Select the communication interface required by your application.
• Configure settings as required by the application, and click Connect.
• When a connection is established, the green indicator in the status bar at the bottom
right of the screen will be visible:
Important: The imager is in Continuous Read Mode by default. For best connection
results, be sure that no decodable symbols are within the imager’s field of view while
attempting to connect.
MINI Hawk Xi High Performance Imager User Manual
1-7
Locate the Symbol in the Field of View
Step 7 — Locate the Symbol in the Field of View
Locate by ESP
• In ESP’s EZ Mode, click the Locate button to enable the blue target pattern.
The symbol in the field of view will appear in the video view beneath the Locate and
Calibrate buttons, and you will see the blue target pattern projected from the front of the
imager.
• Center the target pattern on the symbol.
At 2 to 3 inches, the pattern resembles an X. At 3 to 6 inches, the pattern resembles a V.
Center on object
in field of view.
Target pattern shown as it would appear between 3 and 6 inches.
Important: The entire symbol should fall within the field of view (FOV) of the imager. The
field of view is what appears in ESP’s Locate/Calibrate window in EZ Mode.
• Click the Stop button to end the Locate function.
1-8
MINI Hawk Xi High Performance Imager User Manual
Quick Start
Locate by EZ Button
If you are not connected to a host computer, the EZ Button allows you to locate a symbol
in the imager’s field of view.
MINI Hawk Xi Read Rate LEDs
and EZ Button
• Hold down the EZ Button for about one second and release when you hear one short
beep. The amber 20% LED will illuminate, and you will see the blue target pattern projected
from the front of the imager.
• Center the target pattern on the symbol.
Note: To end all EZ Button functions, press the EZ Button once and quickly release.
MINI Hawk Xi High Performance Imager User Manual
1-9
Calibrate
Step 8 — Calibrate
MINI Hawk Xi settings can be adjusted automatically for optimum symbol decoding performance
by either the EZ Button or by ESP.
During the calibration routine, the reader will flash its amber Read Rate percent LEDs and
red illumination LEDs while searching camera settings and determining the best configuration
for decoding symbol data. Upon successful completion of this routine, a green LED pattern
will flash brightly and illuminate the symbol. 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 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 decoding
symbol data.
A successful calibration will display a green frame around the symbol, and the following
message will appear: “Uploading all reader parameters.” After a moment the 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.
1-10
MINI Hawk Xi High Performance Imager User Manual
Quick Start
Step 9 — Test Read Rate
Read Rate indicates the number of successful decodes per second achieved by the imager.
Test Read Rate by EZ Button
1. To start the Read Rate test, hold
down the EZ Button about three
seconds until you hear three
short beeps. The 20%, 40%, and
60% LEDs will illuminate.
While the symbol is being
inspected, the Read Rate LEDs
will indicate the corresponding
read rate percentage on the back
of the unit.
20%, 40%, 60%, 80%, 100%.
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 symbol has been successfully decoded, the symbol’s data and related features will
be presented in the field below the image display window. Also, while the symbol 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 <C> or <Cp> command and end it with the <J> command.
MINI Hawk Xi High Performance Imager User Manual
1-11
Configure the Imager in ESP
Step 10 — Configure the Imager in ESP
To make setup changes to the MINI Hawk Xi, 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 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 Configuration 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.
1-12
MINI Hawk Xi High Performance Imager User Manual
Quick Start
Step 11 — Save Configuration in ESP
To make changes to a configuration 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.
3. Place your cursor in the
selection box, scroll down to
the setting you want to
change, and click once on
the setting.
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.
MINI Hawk Xi High Performance Imager User Manual
1-13
Save Configuration in ESP
1-14
MINI Hawk Xi High Performance Imager User Manual
2 Using ESP
Contents
EZ Mode........................................................................................................................................2-2
Application Mode...........................................................................................................................2-3
Menu Toolbar ................................................................................................................................2-4
View ............................................................................................................................................2-13
Navigating in ESP .......................................................................................................................2-14
Send/Receive Options ................................................................................................................2-15
Using EZ Trax .............................................................................................................................2-17
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 MINI Hawk Xi 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 Minimum System Requirements in Chapter 1, Quick Start.
MINI Hawk Xi High Performance Imager User 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 MINI Hawk Xi’s blue target
pattern LEDs. Center the target pattern on the symbol.
The display shows you where the symbol is located in
the imager’s field of view.
Starts Read Rate test.
Ends Read Rate test.
2-2
MINI Hawk Xi High Performance Imager User 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.
Video, Evaluation, Calibration, Window of
Interest, Configuration 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.
MINI Hawk Xi High Performance Imager User 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
MINI Hawk Xi High Performance Imager User Manual
Using ESP
Model
In the Model menu you can select any of the models supported by ESP. When you choose
a different model, the connection to your present model will be terminated.
To connect to another model, select New Model, choose a new model from the pop-up
menu that appears, and click OK.
Note: When you save an ESP file, you are saving the settings of all the models defined in
that file.
MINI Hawk Xi High Performance Imager User 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 whenever ESP
is opened next, whether or not you save the ESP file.
Preferences > General Tab
The Toolbar Style
options allow you to
determine how ESP
will display the mode
options in the two rows
at the top of the screen.
Reload Last File
At startup, reloads the last file saved to the host computer’s hard drive.
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 MINI Hawk Xi? 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
MINI Hawk Xi High Performance Imager User 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 <trigger character> 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.
MINI Hawk Xi High Performance Imager User 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 18 is 0.018 inches.
2-8
MINI Hawk Xi High Performance Imager User 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.
MINI Hawk Xi High Performance Imager User 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 a TCP/IP option on the Connection Wizard.
Use Default Storage Location
When enabled, automatically stores data in ESP’s Application Data folder.
2-10
MINI Hawk Xi High Performance Imager User 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.
MINI Hawk Xi High Performance Imager User Manual
2-11
Menu Toolbar
Connect
The Connect dropdown menu allows the user to access the Connection Wizard, as well
as the Autoconnect dialog. Connect and Disconnect can also be performed directly
from the dropdown menu without opening a dialog.
Connection Wizard
To connect using the Connection Wizard:
• Click Connect on ESP’s menu toolbar, and then select Connection Wizard.
• Select the communication interface required by your application.
• Configure settings as required by the application, and click Connect.
• When a connection is established, the green indicator in the status bar at the bottom
right of the screen will be visible.
• If your RS-232 connection attempt fails, click the Auto Connect button to establish a
connection between the MINI Hawk Xi and the host.
2-12
MINI Hawk Xi High Performance Imager User Manual
Using ESP
View
The View menu allows you to move quickly between interfaces without using the icon
buttons on the App Mode toolbar. It also allows you to access the Bar Code Dialog.
Bar Code Dialog
In the Bar Code Dialog you can create symbols by typing the text you wish to encode. This is a
useful tool for creating configuration symbols, allowing you to configure your reader by reading
the symbols you create.
Drag specific configuration
values from the control tree
directly into this field to
encode new symbols.
Choose a spatial
orientation for the
new symbol.
Create a caption
for the symbol
that matches the
encoded data, or
write your own
caption.
The symbol you create
will be displayed in the
field at the bottom of the
Bar Code Dialog.
MINI Hawk Xi High Performance Imager User Manual
2-13
Navigating in ESP
Navigating in ESP
To change imager settings, or to access the Utilities, Camera, Terminal, or Output Format
views, click the App Mode button.
To return to EZ Mode, click the EZ Mode button.
To make changes to configuration settings in the control trees:
1. Left click on the + to
expand menu items.
The X denotes the
default option setting.
2. Double-click the
desired parameter and
single-click in the
selection box to view
options.
3. 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.
2-14
MINI Hawk Xi High Performance Imager User Manual
Using ESP
Send/Receive Options
To access Receive, Save, and Default options, click the Send/Recv button. You can also
access these options by right-clicking in any of the configuration views.
Receiving
From the Send/Recv menu, select Receive Reader Settings.
Caution: Do not select this option if you do not want to upload the imager’s settings. For
example, if your ESP file has a number of custom settings that you want to maintain and
download into the imager, these settings would be lost by choosing Yes.
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 (<A>)
Saves ESP settings to current
memory.
Send and Save (<Z>)
Activates all changes in
current memory and saves
to the imager for power-on.
Send and Save as Customer Defaults (<Zc>)
Saves your default settings for quick retrieval.
This option will be visible only if you have checked Enable ‘Send and Save as Customer
Defaults’ in ESP Preferences.
MINI Hawk Xi High Performance Imager User Manual
2-15
Send/Receive Options
Defaulting
When you select Default Current Menu Settings or Default all ESP Settings, you are
only defaulting the ESP settings.
Advanced Options
Send Current View
This is the same as Save to Reader
> Send No Save except that only the
commands in the current configuration
tree are sent.
Send Current Command
This is the same as Send Current
View, except that it saves only the
command that is currently selected.
Add/Remove Exception
After you perform a Receive Reader Settings command1 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 <A> or a <Z> 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.
1. From the Send/Recv button or by right-clicking in any blank section of a tree control view.
2-16
MINI Hawk Xi High Performance Imager User Manual
Using ESP
Using EZ Trax
For detailed information about using EZ Trax, refer to the Help menu in EZ Trax software,
or the EZ Trax Quick Start Guide, available on the Microscan Tools Drive.
For information about how to configure the MINI Hawk Xi for use with EZ Trax, see Setting
Up the Imager for EZ Trax in Chapter 5, Read Cycle.
MINI Hawk Xi High Performance Imager User Manual
2-17
Using EZ Trax
2-18
MINI Hawk Xi High Performance Imager User Manual
3 Communications
Contents
Communications by ESP .............................................................................................................. 3-2
Communications Serial Commands.............................................................................................. 3-3
Host Port Connections .................................................................................................................. 3-4
Host Port Protocol......................................................................................................................... 3-5
ACK/NAK Options......................................................................................................................... 3-6
Polling Mode Options.................................................................................................................... 3-7
Ethernet ........................................................................................................................................ 3-8
Response Timeout...................................................................................................................... 3-14
LRC Status.................................................................................................................................. 3-15
Protocol Configuration Examples................................................................................................ 3-16
ASCII Character Entry Modifier................................................................................................... 3-17
Preamble..................................................................................................................................... 3-18
Postamble ................................................................................................................................... 3-19
This section explains how to set up communications parameters with the host.
With Microscan’s ESP (Easy Setup Program), configuration changes can be made in the
ESP menus and then sent and saved to the imager. The user can also send serial commands
to the imager via ESP’s Terminal window.
MINI Hawk Xi High Performance Imager User Manual
3-1
Communications by ESP
Communications by ESP
Click the Parameters
button and then the
Communication tab.
To open nested options,
single-click the +.
3-2
To change a setting, double-click the
setting and use your cursor to scroll
through the options.
MINI Hawk Xi High Performance Imager User Manual
Communications
Communications Serial Commands
Host Port Connections
Ethernet
Ethernet TCP Ports
Host Port Protocol
Preamble
Postamble
Response Timeout
LRC
ACK/NAK Options
Polling Mode Options
<K100,baud rate,parity,stop bits,data bits>
<K126,status,IP address,subnet,gateway,IP address mode>
<K127,TCP Port 1,TCP Port 2>
<K140,protocol,address>
<K141,status,preamble characters>
<K142,status,postamble characters>
<K143,response timeout>
<K145,status>
<K147,RES,REQ,STX,ETX,ACK,NAK>
<K148,RES,REQ,STX,ETX,ACK,NAK>
MINI Hawk Xi High Performance Imager User Manual
3-3
Host Port Connections
Host Port Connections
The host port can be configured with RS-232 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.
<K100,baud rate,parity,stop bits,data bits>
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.
<K100,baud rate,parity,stop bits,data bits>
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.
<K100,baud rate,parity,stop bits,data bits>
One
0 = One
1 = Two
Data Bits, Host Port
Usage:
Definition:
Serial Cmd:
Default:
Options:
3-4
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.
<K100,baud rate,parity,stop bits,data bits>
Eight
0 = Seven
1 = Eight
MINI Hawk Xi High Performance Imager User Manual
Communications
Host Port Protocol
Usage:
In general, the point-to-point protocols will work well in most applications.
They require no address and must use RS-232 communications standards.
Definition:
Protocols define the sequence and format in which information is transferred
between the reader and the host.
Serial Cmd: <K140,protocol,address>
Default:
Point-to-Point
Options:
0 = Point-to-Point
4 = ACK/NAK
5 = Polling Mode
Note: In all protocol modes, the preamble <K141> and postamble <K142> 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.
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.
<K140,0>
ACK/NAK
Definition:
Serial Cmd:
See the ACK/NAK Options command <K147>.
<K140,4>
Polling Mode
Definition:
Serial Cmd:
See the Polling Mode Options command <K148>.
<K140,5>
Poll Address
Serial Cmd:
Default:
Options:
<K140,protocol,address>
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
MINI Hawk Xi High Performance Imager User Manual
3-5
ACK/NAK Options
ACK/NAK Options
Definition:
Serial Cmd:
These parameters take effect for ACK/NAK <K140,4> on the main RS-232
port and are completely independent of the Polling Mode Options <K148>.
The imager always follows the protocol in both directions (to and from the
host). There is no option to disable it from either direction.
<K147,RES,REQ,STX,ETX,ACK,NAK>
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] <command> [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 <K140,5>, 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 for sample ACK/NAK communication scenarios.
3-6
MINI Hawk Xi High Performance Imager User Manual
Communications
Polling Mode Options
Definition:
Serial Cmd:
These parameters only take effect for Polling Mode <K140,5> on the main
RS-232 port and are completely independent of the ACK/NAK Options
<K147>.
The values of protocol characters can be changed, but the protocol events
cannot be disabled. The polling mode address is configured in the <K140>
command (see Poll Address).
If RS-232 is enabled, <K102,0>, Polling Mode will operate as a Point-toPoint polling protocol. This is because the RS-232 transmitter is always left
on when enabled.
<K148,RES,REQ,STX,ETX,ACK,NAK>
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 for sample Polling Mode communication
scenarios.
MINI Hawk Xi High Performance Imager User Manual
3-7
Ethernet
Ethernet
Enables or disables Ethernet connectivity in the imager.
IP Address
Enter the IP address of the imager in this field.
3-8
MINI Hawk Xi High Performance Imager User Manual
Communications
Subnet
Enter the Subnet address of the imager in this field.
Gateway
Enter the Gateway address of the imager in this field.
MINI Hawk Xi High Performance Imager User Manual
3-9
Ethernet
IP Address Mode
Determines how the imager’s IP address will be defined.
Static
In Static Mode, the imager uses the user-defined IP address entered in ESP.
DHCP
In DHCP Mode, the imager automatically acquires the IP address, Subnet, and Gateway
addresses from a DHCP or BOOTP server.
3-10
MINI Hawk Xi High Performance Imager User Manual
Communications
TCP Port 1
One of two TCP ports for Ethernet communication with the imager. The default setting is 2001.
Symbol Data Output
Enables or disables decoded symbol data output from the imager.
Extra Symbol Information
Enables or disables extra symbol information output from the imager.
Diagnostics Output
Enables or disables diagnostics output from the imager.
External Source Processing Mode
Enables or disables processing of commands or data from sources external to the imager.
Command
Command enables command processing in the imager.
Data
Data enables Ethernet TCP Port 1 as a data source port.
Note: The data path between in the source port and out the source port is always two-way.
Data is copied from source data ports and all those source ports’ data is transmitted to the
destination port, and from the destination port to the source port.
MINI Hawk Xi High Performance Imager User Manual
3-11
Ethernet
TCP Port 2
One of two TCP ports for Ethernet communication with the imager. The default setting is 2003.
Symbol Data Output
Enables or disables decoded symbol data output from the imager.
Extra Symbol Information
Enables or disables extra symbol information output from the imager.
Diagnostics Output
Enables or disables diagnostics output from the imager.
External Source Processing Mode
Enables or disables processing of commands or data from sources external to the imager.
Command
Command enables command processing in the imager.
Data
Data enables Ethernet TCP Port 2 as a data source port.
Note: The data path between in the source port and out the source port is always two-way.
Data is copied from source data ports and all those source ports’ data is transmitted to the
destination port, and from the destination port to the source port.
3-12
MINI Hawk Xi High Performance Imager User Manual
Communications
Search and Configure Mode
Search and Configure Mode is intended primarily for initial setup of an imager in a network.
This parameter controls whether or not the imager will respond to ESP’s Search function in
the Ethernet TCP/IP connect dialog section of the Connection Wizard:
After the imager is in full use in an
application, you may want the
imager to continue to appear in
the Search response list for future
searches. This can help prevent
disruption of the system that may
occur is ESP were to show only
unconfigured units.
Changes to this parameter are saved to NOVRAM and are set to default on power on.
A Reset <A> is required for settings to take effect.
Important: Once this setting is Disabled, ESP will only be able to connect to the imager if
you know the IP address and enter it in the IP Address field of the Ethernet TCP/IP connect
dialog. Search and Configure Mode can be re-enabled by defaulting the imager.
Enabled
When enabled, Search and Configure Mode will find the imager and settings can be
changed.
Timed Window
When Timed Window is selected, Search and Configure Mode will find the imager and
settings can be changed, but only 60 seconds from the last reset. After 60 seconds,
Search and Configure Mode will be disabled.
MINI Hawk Xi High Performance Imager User Manual
3-13
Response Timeout
Response Timeout
Usage:
Definition:
Serial Cmd:
Default:
Options:
3-14
Only used when a response is required from the host. 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.
<K143,response timeout>
12 (in 1 ms increments)
0 to 255 (A zero (0) setting causes an indefinite wait.)
MINI Hawk Xi High Performance Imager User Manual
Communications
LRC Status
(Longitudinal Redundancy Check)
Usage:
Definition:
Serial Cmd:
Default:
Options:
Used when extra data integrity is required.
An error-checking routine that verifies the accuracy of transmissions. It is
the exclusive OR of all characters following the STX (start of text) up to and
including the ETX (end of text). 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.
<K145,status>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
3-15
Protocol Configuration Examples
Protocol Configuration Examples
Point-to-Point (Main Port)
<K100,8,0,1,1>
<K140,0>
<K102,0>
Baud Rate: 115.2K; Parity: None; Stop Bits: 2; Data Bits: 8
Point-to-Point
RS-232 enabled
Polling Mode (Main Port)
<K100,4,0,1,1>
<K140,5,23>
<K102,0>
<K143,30>
Baud Rate: 9600; Parity: None; Stop Bits: 2; Data Bits: 8
Polling Mode; Address: 23
RS-232 Point-to-Point polling
30 ms Response Timeout
“User-Defined” Polling Mode (Main Port)
<K100,4,0,1,1>
Baud Rate: 9600; Parity: None; Stop Bits: 2; Data Bits: 8
<K140,5,12>
Polling Mode; Address: 12
<K148,,08,09,18,0B,0C,0D> Default RES (0x04), REQ=0x08; EOT=0x09; STX=0x18;
ETX=0x0B; ACK=0x0C; NAK=0x0D
<K102,0>
RS-232 Point-to-Point polling
<K143,40>
40 ms Response Timeout
ACK/NAK (Main Port)
<K100,9,0,1,1>
<K140,4>
<K147,,,01,1B,2E,1F>
<K102,0>
<K143,50>
3-16
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-232 enabled
50 ms Response Timeout
MINI Hawk Xi High Performance Imager User 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.
Serial Cmd Format: <Knnnh,00-FF>
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:
<K142,status,postamble character(s)>
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:
<K142h,,3E>
Note that the “status” field contains only a , . This is because the only field that is being
changed is the “postamble character(s)” field. (See Serial Configuration Command
Conventions for a more detailed explanation of this command shortcut.)
MINI Hawk Xi High Performance Imager User Manual
3-17
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.
<K141,status,preamble character(s)>
Disabled
0 = Disabled
1 = Enabled (within any protocol)
Preamble Characters
Serial Cmd:
Default:
Options:
<K141,status,preamble character(s)>
^M corresponds to: carriage return.
To enter control characters within a serial command, hold down the Ctrl
key while typing the desired character.
Example: <K141,1,CNTL-m> to enter the control character ^M.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K141h,,3C>
For >: <K141h,,3E>
For , : <K141h,,2C>
3-18
MINI Hawk Xi High Performance Imager User 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.
<K142,status,postamble character(s)>
Enabled
0 = Disabled
1 = Enabled (within any protocol)
Postamble Characters
Serial Cmd:
Default:
Options:
<K142,status,postamble character(s)>
^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: <K142,1,CNTL-m CNTL-j> to enter ^M^J.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K142h,,3C>
For >: <K142h,,3E>
For , : <K142h,,2C>
MINI Hawk Xi High Performance Imager User Manual
3-19
Postamble
3-20
MINI Hawk Xi High Performance Imager User Manual
4 Calibration
Contents
Calibration Serial Commands ....................................................................................................... 4-2
Calibration Overview..................................................................................................................... 4-2
Calibration Options ....................................................................................................................... 4-3
Calibration by ESP..................................................................................................................... 4-11
Initiating Calibration ................................................................................................................... 4-13
Additional Notes about Calibration............................................................................................. 4-19
This section shows the MINI Hawk Xi’s calibration options, and explains the different ways
that those options can be configured.
MINI Hawk Xi High Performance Imager User Manual
4-1
Calibration Serial Commands
Calibration Serial Commands
Calibration Options
Autocalibrate
<K529,gain,shutter speed,focus position,symbol type,WOI
framing,WOI margin,line scan height,processing>
<@CAL>
Calibration Overview
Autocalibration is one of the most powerful features of the MINI Hawk Xi. 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. Autocalibration
can be specially configured to optimize specific parameters, such as focus, gain, shutter
speed, and symbol type.
The calibration process consists of five separate phases: quick focus, search pass, focus
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.
4-2
MINI Hawk Xi High Performance Imager User 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, focus, and symbol type. The
default shutter speed setting is disabled, because not all applications require shutter
speed, and when it is required, the application-specific settings tend to vary widely.
Note: Background Color is part of the calibration process regardless of the calibration
setup. 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 Illumination
Brightness parameter 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.
<K529,gain,shutter speed,focus position,symbol type,WOI framing,WOI
margin,line scan height,processing>
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:
<K529,gain,shutter speed,focus position,symbol type,WOI framing,WOI
margin,line scan height,processing>
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
Line Speed
static
5” / sec
10” / sec
15” / sec
20” / sec
MINI Hawk Xi High Performance Imager User Manual
4-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.
4-4
MINI Hawk Xi High Performance Imager User Manual
Calibration
Focus Position
Definition:
Serial Cmd:
Default:
Options:
Since focus can be configured by entering the target distance from the
imager’s parting line, the user will normally configure the focus setting
without needing to calibrate. However, if it is necessary to calibrate the
focus distance, there are two methods for doing so: the standard “Search
Method”, or a “Quick Focus” method, both of which are defined below.
<K529,gain,shutter speed,focus position,symbol type,WOI framing,
WOI margin,line scan height,processing>
Quick Focus
0 = Disabled
1 = Enabled
2 = Quick Focus
Disabled
When this feature is disabled, the focus position is fixed and is not part of the calibration
process.
Enabled (Search Method)
When this feature is enabled, the focus position will be calibrated to provide the best possible
image quality and performance. This method is essentially a search method that attempts to
identify the desired focus using a search algorithm that cycles through focus settings to try
and locate the desired focus as quickly as possible. This is accomplished when the given
symbol in the field of view is decoded. Once a focus distance that will decode the given
symbol has been located, the search algorithm will fine-tune the search to locate the
“inside” and “outside” focal distances. The final focus distance will be between the “inside”
and “outside” values.
Note: This method can be time-consuming if the focus is not found on the first pass.
Quick Focus
Quick Focus is designed to quickly locate the focus setting for an object in the field of view.
This is accomplished with minimal processing of the image by analyzing a histogram of
the image frame. Before performing the focus calibration, a value for shutter speed and
gain is determined and then the calibration process will step through the focus range of the
system, capturing the required number of image frames for each focal position. A histogram
is performed on each image frame and the histogram results for each focus position are
averaged. When this process is completed, the data is analyzed and the optimal focus position
is determined.
Note: Quick Focus may not work well for all applications. It is not recommended for
applications that use very small symbols.
MINI Hawk Xi High Performance Imager User Manual
4-5
Calibration Options
Symbol Type
Serial Cmd:
Default:
Options:
<K529,gain,shutter speed,focus position,symbol type,WOI framing,WOI
margin,line scan height,processing>
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.
4-6
MINI Hawk Xi High Performance Imager User Manual
Calibration
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.
<K529,gain,shutter speed,focus position,symbol type,WOI framing,WOI
margin,line scan height,processing>
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
After Decode
Calibration Passed
MINI Hawk Xi High Performance Imager User Manual
Calibration Failed
4-7
Calibration Options
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:
4-8
MINI Hawk Xi High Performance Imager User Manual
Calibration
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.
MINI Hawk Xi High Performance Imager User Manual
4-9
Calibration Options
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.
<K529,gain,shutter speed,focus position,symbol type,WOI framing,WOI
margin,line scan height,processing>
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.
<K529,gain,shutter speed,focus position,symbol type,WOI framing,WOI
margin,line scan height,processing>
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.
<K529,gain,shutter speed,focus position,symbol type,WOI framing,WOI
margin,line scan height,processing>
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 <K245>.
4-10
MINI Hawk Xi High Performance Imager User Manual
Calibration
Calibration by ESP
ESP’s Calibration view incorporates all the functionality of the <K529> (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, Shutter Speed, and
Focal Distance (Capture
Settings) are all 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).
MINI Hawk Xi High Performance Imager User Manual
4-11
Calibration by ESP
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.
4-12
MINI Hawk Xi High Performance Imager User Manual
Calibration
Initiating Calibration
Calibration can be initiated by serial command, the EZ button, or from the Calibration
interface in ESP. A symbol must be in the imager’s field of view during the calibration process.
In ESP, the Calibrate button starts the calibration routine.
To initiate calibration by serial command, enter the serial command <@CAL> from a terminal,
such as ESP’s Terminal interface. <@CAL> is a calibration routine that emphasizes contrast
and readability.
See Calibrate by EZ Button for the EZ button calibration procedure.
MINI Hawk Xi High Performance Imager User Manual
4-13
Initiating 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%
20%, 40%, 60%
20%, 40%, 60%, 80%
20%, 40%, 60%, 80%, 100%
Calibration Progress
Search Pass in progress.
Focus 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
Focus 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
4-14
Status
Calibration has started.
Calibration has failed.
Calibration has been completed successfully.
Calibration has been completed successfully.
MINI Hawk Xi High Performance Imager User Manual
Calibration
Calibration Progress Output to Terminal
When initiated by serial command or EZ button, the autocalibration operation will output
progress and process information to a terminal if the system is configured to do so.
Terminal
Depending upon how the calibration options are configured, the autocalibration process
can have up to 5 steps (Quick Focus, Search Pass, Focus Pass, Medium Pass, Fine-Tune
Pass). Calibration data is shown in a simple table format under 8 category headings, each
of which are defined below.
Heading
Prog
Rating
Decode
Quality
Focus
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.
Focus position under operation.
Shutter setting under operation.
Gain setting under operation.
Time required to locate symbol, expressed in milliseconds.
Calibration Progress Output Examples (Terminal)
Quick Focus
This mode is only run if Quick Focus calibration mode is enabled (see Focus Position).
Quick Focus calibration mode is designed to quickly locate the focus setting for an object
at the center of the imager’s field of view. There is no terminal output for this operation.
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 quickly identify symbology type, and any
image processing parameters that are already calibrated, as well as determining focus
position.
Running Search Pass
Prog
Rating
Decode
Quality
Focus
Shutter
Gain
Locate
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
MINI Hawk Xi High Performance Imager User Manual
4-15
Initiating Calibration
Focus Pass
The purpose of Focus Pass is to determine the optimal focal position of the optical system.
This is accomplished by determining the inside and outside focus positions and then recording
the center position as the desired focal position.
Running Focus Pass
Prog
Rating
Decode
Quality
Focus
Shutter
Gain
Locate
38
38
38
38
38
38
38
38
38
38
38
38
38
38
38
38
38
38
38
38
42
42
42
42
42
42
42
42
42
42
46
0
0
4256
0
4236
0
4236
0
4232
0
2128
0
0
2144
0
0
0
0
0
0
4280
4280
4280
4280
4280
4280
4280
4280
4280
4280
0
0
0
2
0
2
0
2
0
2
0
1
0
0
1
0
0
0
0
0
0
2
2
2
2
2
2
2
2
2
2
0
0
0
48
0
28
0
28
0
24
0
24
0
0
40
0
0
0
0
0
0
72
72
72
72
72
72
72
72
72
72
0
353
353
353
409
409
447
447
492
492
536
536
572
572
572
601
601
601
601
601
601
297
283
270
258
247
236
227
217
209
200
601
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
250
0
9
18
0
9
0
9
0
9
0
9
0
9
18
27
36
45
45
45
45
45
45
45
45
45
45
45
45
45
45
45
0
0
5
0
5
0
4
0
4
0
5
0
0
4
0
0
0
0
0
0
6
5
5
5
5
6
5
5
6
6
0
Inside Focus = 200; Outside Focus = 572; Center Focus = 386
4-16
MINI Hawk Xi High Performance Imager User 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
MINI Hawk Xi High Performance Imager User Manual
4-17
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.
4-18
MINI Hawk Xi High Performance Imager User 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. A symbol must be in the imager’s field of view during the calibration process.
2. The Illumination Brightness parameter <K514> is not part of the calibration process.
3. Background Color <K451> is calibrated.
4. 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.
5. If Symbol Type is enabled for calibration (Autodiscriminate), then Interleaved 2 of 5
Range Mode Status (Interleaved 2 of 5) <K472> 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.
6. Pharmacode is not calibrated.
7. 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.
8. The calibration process does not modify the global Composite status <K453>. The
global Composite status must be configured properly before calibration.
9. If the user requires calibration of a stacked symbology <K482>, <K483>, or <K484>,
that symbology must be enabled and configured appropriately before calibration.
10. UPC Supplementals will be disabled during calibration.
11. The Search process will use the configurable Window of Interest for image captures.
However, when the search process is completed, the WOI will be reduced to include
only the symbol of interest and some additional boundary area.
MINI Hawk Xi High Performance Imager User Manual
4-19
Additional Notes about Calibration
4-20
MINI Hawk Xi High Performance Imager User Manual
5 Read Cycle
Contents
Read Cycle by ESP ...................................................................................................................... 5-2
Read Cycle Serial Commands...................................................................................................... 5-3
Read Cycle Setup......................................................................................................................... 5-4
Multisymbol................................................................................................................................... 5-5
Trigger Mode and Filter Duration.................................................................................................. 5-6
External Trigger Polarity ............................................................................................................. 5-11
Serial Trigger .............................................................................................................................. 5-12
Start Trigger Character (Non-Delimited)..................................................................................... 5-13
Stop Trigger Character (Non-Delimited) ..................................................................................... 5-14
End of Read Cycle...................................................................................................................... 5-15
Capture Mode ............................................................................................................................. 5-17
Capture Timing ........................................................................................................................... 5-21
Image Processing Timeout ......................................................................................................... 5-23
Image Storage ............................................................................................................................ 5-24
Decodes Before Output .............................................................................................................. 5-26
Setting Up the Imager for EZ Trax.............................................................................................. 5-27
After you’ve established communications and completed basic read rate testing, you will
need to address the spatial and timing parameters associated with your application. This
section explains those parameters.
MINI Hawk Xi High Performance Imager User Manual
5-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 +.
5-2
To change a setting,
double-click the
setting and use your
cursor to scroll
through the options.
MINI Hawk Xi High Performance Imager User Manual
Read Cycle
Read Cycle Serial Commands
Trigger Mode/Filter Duration <K200,trigger mode,leading edge trigger filter,trailing edge
trigger filter>
Serial Trigger Character
<K201,serial trigger character>
External Trigger State
<K202,external trigger state>
End of Read Cycle
<K220,end of read cycle,read cycle timeout>
Decodes Before Output
<K221,decodes before output>
Multisymbol
<K222,number of symbols,multisymbol separator>
Start Trigger Character
<K229,start character>
Stop Trigger Character
<K230,stop character>
Capture Mode
<K241,capture mode,number of captures,rapid capture mode>
Capture Timing
<K242,time before first capture,time between first and second
captures,,,,,,,,time between seventh and eighth captures>
Image Storage
<K244,image storage type,image store mode>
IP Timeout
<K245,image processing timeout>
MINI Hawk Xi High Performance Imager User Manual
5-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 MINI Hawk Xi 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 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
1280 x 1024 image). The capture rate increases as frame sizes decrease.
Note: If you need to set up your MINI Hawk Xi for use with EZ Trax software, see Setting
Up the Imager for EZ Trax.
5-4
MINI Hawk Xi High Performance Imager User 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:
Number of Symbols is the number of different symbols that can be read in
a single read cycle.
<K222,number of symbols, multisymbol separator>
1
1 to 100
Multisymbol Separator
Usage:
Definition:
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.
Serial Cmd: <K222,number of symbols,multisymbol separator>
Default:
, (comma)
Options:
Any available ASCII character.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K222h,,3C>
For >: <K222h,,3E>
For , : <K222h,,2C>
Note: If No Read messages are disabled and there are No Reads occurring, separators
will only be inserted between symbol data outputs.
MINI Hawk Xi High Performance Imager User Manual
5-5
Trigger Mode and Filter Duration
Trigger Mode and Filter Duration
Trigger Mode
Definition:
Serial Cmd:
Default:
Options:
The Trigger is the event that initiates a read cycle.
Note: When calibrating the imager or testing read rate, the current trigger
setting will be disregarded.
<K200,trigger mode,leading edge trigger filter,trailing edge trigger filter>
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:
5-6
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, 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.
<K200,0>
MINI Hawk Xi High Performance Imager User Manual
Read Cycle
Continuous Read 1 Output
Usage:
Definition:
Serial Cmd:
Continuous Read 1 Output can be useful in applications where it is not
feasible to use a trigger and all succeeding symbols contain different
information. It is also effective in applications where the objects are presented
by hand.
In Continuous Read 1 Output the imager self-triggers whenever it
decodes a new symbol or a timeout occurs.
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.
<K200,1>
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.
MINI Hawk Xi High Performance Imager User Manual
5-7
Trigger Mode and Filter Duration
External Level
Initiate Read Cycle:
Object #1, moving in front of the
detector beam, causes a
change in the trigger state,
which initiates the read cycle.
End Read Cycle:
The same object, moving out of
the detector beam, causes
another change in the trigger
state, which ends the read cycle.
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.
<K200,2>
Important: Level and Edge apply to the active logic state (Active Open or Active Closed)
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:
5-8
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.
<K200,3>
MINI Hawk Xi High Performance Imager User Manual
Read Cycle
Serial Data
Usage:
Definition:
Serial Cmd:
Serial Data is effective in a highly controlled environment where the host
knows precisely when the object is in the field of view. It is also useful in
determining if a No Read has occurred.
In Serial Data, the imager accepts an ASCII character from the host or
controlling device as a trigger to start a read cycle. A Serial Data trigger
behaves the same as an External Edge trigger.
Serial commands are entered inside angle brackets, as shown here: <t>.
<K200,4>
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 or External 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.
In this mode the imager accepts either a serial ASCII character or an external
trigger pulse to start the read cycle.
<K200,5>
Note: In Serial Data, sending a non-delimited start serial character will start a read cycle;
however, a non-delimited stop serial character has no effect.
MINI Hawk Xi High Performance Imager User Manual
5-9
Trigger Mode and Filter Duration
Leading Edge Trigger Filter
Usage:
Definition:
Serial Cmd:
Default:
Options:
Used to ignore spurious triggers when Trigger Mode is set to External
Edge or External Level.
To consider a change in state on the trigger input, the level must be stable
for the trigger filter duration. In an edge mode, the imager will trigger a read
cycle if the active state has been uninterrupted for the entire trigger filter
duration. In a level mode, the leading edge is filtered such that on an active
edge, the state must be held interrupted for the trigger filter duration before
a trigger will occur.
<K200,trigger mode,leading edge trigger filter,trailing edge trigger filter>
313 (~10 ms)
1 to 65535 (Trigger filter range: 32.0 µs to 2.10 seconds)
Trailing Edge Trigger Filter
Usage:
Used to ignore spurious triggers when Trigger Mode is set to External
Edge or External Level.
Definition:
To consider a change in state on the trigger input, the level must be stable
for the trigger filter duration. In an edge mode, the imager will trigger a read
cycle if the active state has been uninterrupted for the entire trigger filter
duration. In a level mode, the trailing edge is filtered such that on the falling
edge, the state must be held for the trigger filter duration before the trigger
will be deemed inactive.
<K200,trigger mode,leading edge trigger filter,trailing edge trigger filter>
313 (~10 ms)
1 to 65535 (Trigger filter range: 32.0 µs to 2.10 seconds)
Serial Cmd:
Default:
Options:
5-10
MINI Hawk Xi High Performance Imager User Manual
Read Cycle
External Trigger Polarity
Usage:
Definition:
Serial Cmd:
Default:
Options:
Allows users to select the trigger polarity that will be used in their application.
Determines the active state of the trigger signal applied to the cable input of
the imager.
<K202,active state>
Positive
0 = Negative
1 = Positive
MINI Hawk Xi High Performance Imager User Manual
5-11
Serial Trigger
Serial Trigger
Usage:
Definition:
Allows the user to define the trigger character and delimiters that start
and stop the read cycle.
A serial trigger is considered an online host command and requires the
same command format as all host commands. It must be entered within
angle bracket delimiters < > or, in the case of non-delimited triggers, it must
define individual start and stop characters.
Serial Trigger Character (Delimited)
Usage:
Definition:
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 < >.
Serial Cmd: <K201,serial trigger character>
Default:
Space bar
Options:
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 or External Edge triggering mode must be enabled for
Serial Trigger Character to take effect.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K201h,3C>
For >: <K201h,3E>
For , : <K201h,2C>
5-12
MINI Hawk Xi High Performance Imager User Manual
Read Cycle
Start Trigger Character (Non-Delimited)
Usage:
Definition:
Serial Cmd:
Default:
Options:
Useful in applications where different characters are required to start a
read cycle.
A single ASCII host serial trigger character that starts the read cycle and is
not enclosed by delimiters such as < and >.
Non-delimited Start characters can be defined and will function according
to the trigger event.
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 or External Edge trigger mode, either a Start trigger
character or a hardware trigger can start an edge trigger read cycle.
<K229,start character>
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 <: <K229h,3C>
For >: <K229h,3E>
For , : <K229h,2C>
MINI Hawk Xi High Performance Imager User Manual
5-13
Stop Trigger Character (Non-Delimited)
Stop Trigger Character (Non-Delimited)
Usage:
Definition:
Serial Cmd:
Default:
Options:
Useful in applications where different characters are required to end a
read cycle.
A single ASCII host serial trigger character that ends the read cycle and is
not enclosed by delimiters such as < and >.
Non-delimited Stop characters can be defined and will function according
to the trigger event.
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 or External Edge trigger mode, either a Start trigger
character or a hardware trigger can start an edge trigger read cycle.
<K230,stop character>
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 <: <K230h,3C>
For >: <K230h,3E>
For , : <K230h,2C>
5-14
MINI Hawk Xi High Performance Imager User Manual
Read Cycle
End of Read Cycle
Definition:
The read cycle is the time during which the imager will attempt to capture
and decode a symbol. A read cycle can be ended by a timeout, a new
trigger, or by the last frame in a capture sequence or a combination of the
above.
End of Read Cycle Mode
Note: When operating in Continuous Read or Continuous Read 1 Output, the imager is
always in the read cycle.
Serial Cmd:
Default:
Options:
<K220,end of read cycle,read cycle timeout>
Timeout
0 = Timeout
1 = New Trigger
2 = Timeout or new Trigger
3 = Last Frame
4 = Last Frame or New Trigger
Timeout
Usage:
Definition:
Typically used with Serial Data or External 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 or External 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.
MINI Hawk Xi High Performance Imager User Manual
5-15
End of Read Cycle
New Trigger
Usage:
Definition:
New Trigger is an effective way to end a read cycle when objects move
past the reader at irregular intervals (not timing-dependent).
New Trigger ends the current read cycle and initiates a new one when a
new trigger occurs. New Trigger refers only to a rising edge trigger.
With External Edge, Serial Data, or Serial Data or External Edge
enabled, an edge or serial trigger ends a read cycle and initiates the next
read cycle.
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 or 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 or 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 or 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 or 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:
5-16
Read Cycle Timeout is the duration of the read cycle.
<K220,end of read cycle,read cycle timeout>
200 (x10 ms)
1 to 65535
MINI Hawk Xi High Performance Imager User Manual
Read Cycle
Capture Mode
Definition:
Serial Cmd:
Default:
Options:
Capture Mode relates to the way that images are captured and processed.
<K241,capture mode,number of captures,rapid capture mode>
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
MINI Hawk Xi High Performance Imager User Manual
5-17
Capture Mode
Number of Captures
Usage:
Definition:
Serial Cmd:
Default:
Options:
Number of Captures is used to specify the number of captures to be processed
in Rapid Capture Mode.
Sets the total number of captures that are processed during a read cycle in
Rapid Capture Mode. This feature is used in conjunction with Capture Timing
parameters to specify the capture sequence of a rapid capture read cycle.
<K241,capture mode,number of captures,rapid capture mode>
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.
Rapid Capture Mode
Definition:
Serial Cmd:
Default:
Options:
5-18
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.
<K241,capture mode,number of captures,rapid capture mode>
Timed Capture
0 = Timed Capture
1 = Triggered Capture
MINI Hawk Xi High Performance Imager User Manual
Read Cycle
Timed Capture
Usage:
Definition:
Timed Rapid Capture is useful in fast-moving applications in which symbols
are only in the field of view for a short time and precise timing is required.
In Timed Rapid Capture, decoding occurs independent of and simultaneous
with capturing, thus allowing precise timing or no delay at all between
captures.
Also, consecutive captures are regarded as the same symbol if the output
data is the same.
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
MINI Hawk Xi High Performance Imager User Manual
5-19
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
5-20
MINI Hawk Xi High Performance Imager User 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.
<K242,time before 1st capture,time between capture 1 and capture
2,,,,,,,,time between capture 7 and capture 8>
0
0 to 65535 (2.097 seconds, in 32 µS increments)
Start of
Read Cycle
Time Before First Capture
Processing
MINI Hawk Xi High Performance Imager User Manual
5-21
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.
<K242,time before 1st capture,time between captures [time 1,time
2,...time7]
Entering 0s will result in no time between captures.
Entering a different value in each field will vary the time delays accordingly.
Note: You must enter time values along with comma separators for each
field you want to change. If you omit fields, or enter only commas, the fields
will remain as previously set.
Important: If the imager is configured to capture more than 8 images, the
last (or 8th) delay value will be repeated for the remaining captures.
0
0 to 65535 (2.097 seconds, in 32 µS increments)
Note: Number of Captures and number of frame delays (Time Between Captures) must
be the same.
Start of Read Cycle
Diagram A
Time Delay Between Captures = 0
End of
Read Cycle
1 2 3 4 5
Time Delay Between Captures varies.
Diagram B
5-22
MINI Hawk Xi High Performance Imager User Manual
Read Cycle
Image Processing Timeout
Usage:
Definition:
Serial Cmd:
Default:
Options:
Useful in higher speed applications where image processing time is long
enough that not all captures have an opportunity to be processed.
Specifies the maximum amount of time to process a captured image.
When the timeout expires, the image processing is aborted. This timeout
works in both Rapid Capture and Continuous Capture modes, as well
as with the Configuration Database.
<K245,image processing timeout>
5000 ms (5 sec.)
1 to 65535 (in 1 ms increments)
Notes:
• The timeout period does not include capture time.
• If a timeout occurs during processing and no symbols in the field of view have been
decoded, the image will be recorded as a No Read. For this reason, a longer timeout
should be tried to ensure that the symbol is decoded successfully.
MINI Hawk Xi High Performance Imager User Manual
5-23
Image Storage
Image Storage
Image Storage Type
Definition:
Serial Cmd:
Default:
Options:
Allows the user to store images from separate read cycles and to retrieve
them later. The number of available slots for storage depends on the mode
of operation. If the imager is in Rapid Capture Mode, the number of
images that can be stored is equivalent to the maximum number of the
rapid count (the current rapid count setting). If the imager is in Continuous
Capture Mode, a number of images equivalent to the maximum number of
the rapid count minus 3.
<K244,image storage type,image storage 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.
Image Storage Mode
Serial Cmd:
Default:
Options:
<K244,image storage type,image storage mode>
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.
5-24
MINI Hawk Xi High Performance Imager User 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
MINI Hawk Xi High Performance Imager User Manual
5-25
Decodes Before Output
Decodes Before Output
Definition:
Serial Cmd:
Default:
Options:
5-26
This value specifies the number of times a symbol needs to be read to
qualify as a good read.
<K221,decodes before output>
1
1 to 255
MINI Hawk Xi High Performance Imager User Manual
Read Cycle
Setting Up the Imager for EZ Trax
If you are using EZ Trax software, it is important to set up the MINI Hawk Xi correctly
before beginning.
Click the Read Cycle tab to display the Read Cycle tree control.
Set Trigger Mode, <K200>, to External Edge.
Set Capture Mode, <K241>, to Rapid Capture.
Once these Read Cycle parameters are set, you will be ready to connect to EZ Trax. For a
description of how to configure EZ Trax using serial commands or ESP, see Configuring EZ
Trax Output in Chapter 7, I/O Parameters.
For more detailed information about using EZ Trax, refer to the Help menu in EZ Trax
software, or the EZ Trax Quick Start Guide, available on the Microscan Tools Drive.
MINI Hawk Xi High Performance Imager User Manual
5-27
Setting Up the Imager for EZ Trax
5-28
MINI Hawk Xi High Performance Imager User Manual
6 Symbologies
Contents
Symbologies by ESP.................................................................................................................... 6-2
Symbologies Serial Commands ................................................................................................... 6-3
Data Matrix ................................................................................................................................... 6-4
Aztec Code................................................................................................................................... 6-6
QR Code ...................................................................................................................................... 6-7
Micro QR Code............................................................................................................................. 6-8
Code 39........................................................................................................................................ 6-9
Code 128/EAN 128 .................................................................................................................... 6-12
BC412 ........................................................................................................................................ 6-15
Interleaved 2 of 5........................................................................................................................ 6-16
Code 93...................................................................................................................................... 6-19
Codabar...................................................................................................................................... 6-20
UPC/EAN ................................................................................................................................... 6-23
Pharmacode ............................................................................................................................... 6-27
Postal Symbologies.................................................................................................................... 6-29
GS1 DataBar .............................................................................................................................. 6-34
PDF417 ...................................................................................................................................... 6-36
MicroPDF417 ............................................................................................................................. 6-37
Composite .................................................................................................................................. 6-38
Narrow Margins/Symbology Identifier ........................................................................................ 6-39
Background Color....................................................................................................................... 6-41
This section describes the various symbol types that can be read and decoded by the
MINI Hawk Xi.
MINI Hawk Xi High Performance Imager User Manual
6-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 +.
6-2
MINI Hawk Xi High Performance Imager User Manual
Symbologies
Symbologies Serial Commands
Narrow Margins/Symbology ID
Background Color
Composite
Aztec Code
Micro QR Code
Postal Symbologies
Code 39
Codabar
Interleaved 2 of 5
UPC/EAN
Code 128/EAN 128
Code 93
PDF417
Pharmacode
Data Matrix
QR Code
BC412
DataBar-14 (RSS-14)
DataBar Limited
(RSS Limited)
DataBar Expanded
(RSS Expanded)
MicroPDF417
<K450,narrow margin status,symbology identifier status>
<K451,background color>
<K453,symbology status,separator status,separator>
<K458,status>
<K459,status>
<K460,postal symbology type,POSTNET status,PLANET status,
USPS4CB status,POSTNET allow B and B’ fields,Australia Post
allow 0 FCC>
<K470,status,check character status,check character output status,
large intercharacter gap,fixed symbol length status,fixed symbol
length,full ASCII set>
<K471,status,start/stop match,start/stop output,large intercharacter
gap,fixed symbol length status,symbol length,check character
type,check character output>
<K472,status,check character status,check character output status,
symbol length #1, symbol length #2, guard bar status,range mode
status>
<K473,UPC status,EAN status,supplemental status,separator status,
separator character,supplemental type,format UPC-E as UPC-A>
<K474,status,fixed symbol length status,fixed symbol length,EAN
128 status,output format,application record separator status,application
record separator character,application record brackets,application
record padding>
<K475,status,fixed symbol length status,symbol length>
<K476,status,[unused],fixed symbol length status,fixed symbol
length,[unused],codeword collection>
<K477,status,fixed bar count status,fixed bar count,minimum bar
count,bar width mode,direction,fixed threshold value>
<K479,ECC 200 status, ECC 000 status,ECC 050 status, ECC 080
status,ECC 100 status,ECC 140 status,ECC 120 status,ECC 130
status>
<K480,status>
<K481,status,check character output,fixed symbol length status,
fixed symbol length>
<K482,status>
<K483,status>
<K484,status,fixed symbol length status,fixed symbol length>
<K485,status,[unused],fixed symbol length status,fixed symbol
length>
MINI Hawk Xi High Performance Imager User Manual
6-3
Data Matrix
Data Matrix
Usage:
Definition:
Very useful where information needs to be packed into a small area, and/or
where symbols need to be applied directly to the substrate with laser
etching, chemical etching, dot peen, or other methods.
Data Matrix is a type of Matrix symbology and has subsets ECC 000 - ECC 200.
ECC 200 symbols have an even number of rows and an even number of
columns. Most of the symbols are square with sizes from 10x10 to
144x144. Some symbols, however, are rectangular, with sizes from 8x18 to
16x48. All ECC 200 symbols can be recognized by the upper right corner
module being light (binary 0) instead of dark.
ECC 200
Definition:
Serial Cmd:
Default:
Options:
When enabled, will decode ECC 200 Data Matrix symbols.
<K479,ECC 200 status,ECC 000 status,ECC 050 status,ECC 080 status,
ECC 100 status,ECC 140 status,ECC 120 status,ECC 130 status>
Enabled
Note: This is the only symbol type enabled by default.
0 = Disabled
1 = Enabled
ECC 000
Definition:
Serial Cmd:
Default:
Options:
When enabled, will decode ECC 000 symbols.
<K479,ECC 200 status,ECC 000 status,ECC 050 status,ECC 080 status,
ECC 100 status,ECC 140 status,ECC 120 status,ECC 130 status>
Disabled
0 = Disabled
1 = Enabled
ECC 050
Definition:
Serial Cmd:
Default:
Options:
6-4
When enabled, will decode ECC 050 symbols.
<K479,ECC 200 status,ECC 000 status,ECC 050 status,ECC 080 status,
ECC 100 status,ECC 140 status,ECC 120 status,ECC 130 status>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
Symbologies
ECC 080
Definition:
Serial Cmd:
Default:
Options:
When enabled, will decode ECC 080 symbols.
<K479,ECC 200 status,ECC 000 status,ECC 050 status,ECC 080 status,
ECC 100 status,ECC 140 status,ECC 120 status,ECC 130 status>
Disabled
0 = Disabled
1 = Enabled
ECC 100
Definition:
Serial Cmd:
Default:
Options:
When enabled, will decode ECC 100 symbols.
<K479,ECC 200 status,ECC 000 status,ECC 050 status,ECC 080 status,
ECC 100 status,ECC 140 status,ECC 120 status,ECC 130 status>
Disabled
0 = Disabled
1 = Enabled
ECC 140
Definition:
Serial Cmd:
Default:
Options:
When enabled, will decode ECC 140 symbols.
<K479,ECC 200 status,ECC 000 status,ECC 050 status,ECC 080 status,
ECC 100 status,ECC 140 status,ECC 120 status,ECC 130 status>
Disabled
0 = Disabled
1 = Enabled
ECC 120
Definition:
Serial Cmd:
Default:
Options:
When enabled, will decode ECC 120 symbols.
<K479,ECC 200 status,ECC 000 status,ECC 050 status,ECC 080 status,
ECC 100 status,ECC 140 status,ECC 120 status,ECC 130 status>
Disabled
0 = Disabled
1 = Enabled
ECC 130
Definition:
Serial Cmd:
Default:
Options:
When enabled, will decode ECC 130 symbols.
<K479,ECC 200 status,ECC 000 status,ECC 050 status,ECC 080 status,
ECC 100 status,ECC 140 status,ECC 120 status,ECC 130 status>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
6-5
Aztec Code
Aztec Code
Usage:
Definition:
Serial Cmd:
Default:
Options:
6-6
Used in document imaging, railway ticket validation, and some postal
applications.
A 2D matrix symbology built on a square grid with a square “bull’s-eye”
pattern at the center. Aztec Code can encode up to 3,832 numeric or 3,067
alphabetical characters, or 1,914 bytes of data.
The level of Reed-Solomon error correction used with Aztec Code is configurable,
from 5% to 95% of the total data region. The recommended error correction
level is 23% of symbol capacity plus codewords.
<K458,status>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
Symbologies
QR Code
Usage:
Definition:
Serial Cmd:
Default:
Options:
Widely implemented in the automotive industry in Japan and throughout
their worldwide supply chain.
QR Code is capable of handling numeric, alphanumeric, and byte data as
well as kanji and kana characters. Up to 7,366 characters (numeric data)
can be encoded using this symbol. Therefore, less space is required to
encode the same amount of data in a QR Code symbol than in a conventional
symbol, lowering the cost of labelling.
Three Position Detection Patterns in the symbol make omnidirectional,
ultra-fast reading possible.
QR Code has error protection capability. Data can often be restored even if
a part of the symbol has become dirty or damaged.
<K480,status>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
6-7
Micro QR Code
Micro QR Code
Usage:
Definition:
Serial Cmd:
Default:
Options:
6-8
Used in various applications that require higher data density than that
provided by standard QR Code. Some application examples are automotive
inventory, vehicle ID, and mobile phone URL encodation.
Micro QR Code is a 2D matrix symbology that comes in 4 different symbol
sizes, the largest capable of encoding 35 numeric characters.
<K459,status>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
Symbologies
Code 39
Usage:
Definition:
Serial Cmd:
Default:
Options:
Code 39 is considered the standard for non-retail 1D symbology.
An alphanumeric symbology with unique start/stop code patterns, composed
of 9 black and white elements per character, of which 3 are wide.
<K470,status,check character status,check character output status,large
intercharacter gap,fixed symbol length status,fixed symbol length,full ASCII
set>
Enabled
0 = Disabled
1 = Enabled
Check Character Status (Code 39)
Serial Cmd:
Default:
Options:
<K470,status,check character status,check character output status,large
intercharacter gap,fixed symbol length status,fixed symbol length,full ASCII
set>
Disabled
0 = Disabled
1 = Enabled
Check Character Output Status (Code 39)
Usage:
Definition:
Serial Cmd:
Default:
Options:
Check Character Output Status, added to the symbol, provides additional data security.
When enabled, the check character character is read and compared along
with the symbol data. When disabled, symbol data is sent without the check
character.
Note: With Check Character Output Status and an External or Serial
trigger option enabled, an invalid check character calculation will cause a
No Read message to be transmitted at the end of the read cycle.
<K470,status,check character status,check character output status,large
intercharacter gap,fixed symbol length status,fixed symbol length,full ASCII
set>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
6-9
Code 39
Large Intercharacter Gap (Code 39)
Usage:
Definition:
Serial Cmd:
Default:
Options:
Large Intercharacter Gap is helpful for reading symbols that are printed
out of specification.
Important: Do not use Large Intercharacter Gap with Narrow Margins
enabled, because a large intercharacter gap (over 3x) could cause a narrow
margin (5x) to be interpreted as an intercharacter gap.
When enabled, the imager can read symbols with gaps between symbol
characters that exceed three times (3x) the narrow element width.
<K470,status,check character status,check character output status,large
intercharacter gap,fixed symbol length status,fixed symbol length,full
ASCII set>
Disabled
0 = Disabled
1 = Enabled
Fixed Symbol Length Status (Code 39)
Definition:
Serial Cmd:
Default:
Options:
When enabled, the imager will check the symbol length against the symbol
length field. If disabled, any length will be considered valid.
<K470,status,check character status,check character output status,large
intercharacter gap,fixed symbol length status,fixed symbol length,full
ASCII set>
Disabled
0 = Disabled
1 = Enabled
Fixed Symbol Length (Code 39)
Usage:
Definition:
Serial Cmd:
Default:
Options:
6-10
Fixed Symbol Length helps prevent truncations and increases data integrity
by ensuring that only one symbol length will be accepted.
Specifies the exact number of characters that the imager will recognize
(this does not include start and stop and check character characters). The
imager ignores any symbology that does not match the specified length.
<K470,status,check character status,check character output status,large
intercharacter gap,fixed symbol length status,fixed symbol length,full
ASCII set>
10
1 to 64
MINI Hawk Xi High Performance Imager User Manual
Symbologies
Full ASCII Set (Code 39)
Usage:
Definition:
Serial Cmd:
Default:
Options:
Must be enabled when reading characters outside the standard character
set (0-9, A-Z, etc.)
The user must know in advance whether or not to use the Full ASCII Set
option. Since Full ASCII Set requires two code words to encode one
character, it is less efficient.
Standard Code 39 encodes 43 characters; zero through nine, capital “A”
through capital “Z”, minus symbol, plus symbol, forward slash, space,
decimal point, dollar sign, and percent symbol. When Full ASCII Set is
enabled, the imager can read the full ASCII character set, from 0 to 255.
<K470,status,check character status,check character output status,large
intercharacter gap,fixed symbol length status,fixed symbol length,full ASCII
set>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
6-11
Code 128/EAN 128
Code 128/EAN 128
Usage:
Definition:
Serial Cmd:
Default:
Options:
Code 128 is a smaller symbology useful in applications with tight spots
and high security needs.
A very dense alphanumeric symbology. It encodes all 128 ASCII characters,
it is continuous, has variable length, and uses multiple element widths
measured edge to edge.
<K474,status,fixed symbol length status,fixed symbol length,EAN 128 status,
output format,application record separator status,application record separator
character,application record brackets,application record padding>
Enabled
0 = Disabled
1 = Enabled
Fixed Symbol Length Status (Code 128/EAN 128)
Definition:
Serial Cmd:
Default:
Options:
When enabled, the imager will check the symbol length against the symbol
length field. If disabled, any length will be considered a valid symbol.
<K474,status,fixed symbol length status,fixed symbol length,EAN 128 status,
output format,application record separator status,application record separator
character,application record brackets,application record padding>
Disabled
0 = Disabled
1 = Enabled
Fixed Symbol Length (Code 128/EAN 128)
Usage:
Definition:
Serial Cmd:
Default:
Options:
6-12
Fixed Symbol Length helps prevent truncations and increases data
integrity by ensuring that only one symbol length will be accepted.
This specifies the exact number of characters that the imager will recognize
(this does not include start, stop, and check character characters). The
imager ignores any symbol not having the specified length.
<K474,status,fixed symbol length status,fixed symbol length,EAN 128
status,output format,application record separator status,application record
separator character,application record brackets,application record padding>
10
1 to 64
MINI Hawk Xi High Performance Imager User Manual
Symbologies
EAN 128 Status (Code 128/EAN 128)
Definition:
Serial Cmd:
Default:
Options:
When this field is disabled, the imager will not check any Code 128 labels
for conformance to EAN requirements, or perform any special formatting.
When enabled, the imager can read symbols with or without a function 1
character in the first position. If a symbol has a function 1 character in the
first position, it must conform to EAN format. Symbols that conform to EAN
format will also be subject to the special output formatting options available
in this command.
Note: Code 128 status must be enabled for EAN status to be active.
If EAN status is required, the imager will only decode symbols that have a
function 1 character in the first position and that conform to EAN format. All
symbols read will be subject to the special output formatting options available
in this command.
Note: Code 128 status must be enabled for EAN status to be active.
<K474,status,fixed symbol length status,fixed symbol length,EAN 128 status,
output format,application record separator status,application record separator
character,application record brackets,application record padding>
Disabled
0 = Disabled
1 = Enabled
2 = Required
Output Format (Code 128/EAN 128)
Definition:
Serial Cmd:
Default:
Options:
In Standard, the imager will not apply special EAN output formatting
options.
In Application, the imager will apply the special EAN output formatting
options to decoded EAN-conforming symbols.
<K474,status,fixed symbol length status,fixed symbol length,EAN 128 status,
output format,application record separator status,application record separator
character,application record brackets,application record padding>
Standard
0 = Standard
1 = Application
Application Record Separator Status (Code 128/EAN 128)
Definition:
Serial Cmd:
Default:
Options:
When enabled, an EAN separator will be inserted into the output between
fields whenever an EAN-conforming symbol is decoded and EAN output
formatting applies.
<K474,status,fixed symbol length status,fixed symbol length,EAN 128 status,
output format,application record separator status,application record separator
character,application record brackets,application record padding>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
6-13
Code 128/EAN 128
Application Record Separator Character (Code 128/EAN 128)
Definition:
Serial Cmd:
This is an ASCII character that serves as an EAN separator in formatted EAN
output.
<K474,status,fixed symbol length status,fixed symbol length,EAN 128 status,
output format,application record separator status,application record separator
character,application record brackets,application record padding>
Default:
,
Options:
Any ASCII character (7 bit)
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K474h,,,,,,,3C>
For >: <K474h,,,,,,,3E>
For , : <K474h,,,,,,,2C>
Application Record Brackets (Code 128/EAN 128)
Definition:
Serial Cmd:
Default:
Options:
If an EAN-conforming symbol is decoded and EAN formatting applies, this
feature places bracket characters around the application identifiers in the
formatted output.
<K474,status,fixed symbol length status,fixed symbol length,EAN 128 status,
output format,application record separator status,application record separator
character,application record brackets,application record padding>
Disabled
0 = Disabled
1 = Enabled
Application Record Padding (Code 128/EAN 128)
Definition:
Serial Cmd:
Default:
Options:
6-14
This feature causes the imager to pad variable-length application fields with
leading zeroes. This is not done for the last field of a symbol.
<K474,status,fixed symbol length status,fixed symbol length,EAN 128 status,
output format,application record separator status,application record separator
character,application record brackets,application record padding>
Enabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
Symbologies
BC412
Usage:
Definition:
Serial Cmd:
Default:
Options:
Widely used in semiconductor manufacturing. Particularly useful where
speed, accuracy, and ease of printing are required.
BC412 (Binary Code 412), a proprietary IBM symbology since 1988, is an
alphanumeric symbol with a set of 35 characters, each encoded by a set of
4 bars in 12 module positions. All bars have a single width; it is the presence
(1) or absence (0) of bars in each of the twelve module positions that make
BC412 binary.
This symbology is also bi-directional and self-clocking, with a start character
and a stop character.
<K481,status,check character output,fixed symbol length status,fixed symbol
length>
Disabled
0 = Disabled
1 = Enabled
Check Character Output (BC412)
Usage:
Definition:
Serial Cmd:
Default:
Options:
Check Character Output, added to the symbol, provides additional
security.
When enabled, the check character character is read and compared along
with the symbol data. When disabled, symbol data is sent without the check
character.
<K481,status,check character output,fixed symbol length status,fixed
symbol length>
Disabled
0 = Disabled
1 = Enabled
Fixed Symbol Length Status (BC412)
Definition:
Serial Cmd:
Default:
Options:
When enabled, the imager will check the symbol length against the symbol
length field. If disabled, any length will be considered valid.
<K481,status,check character output,fixed symbol length status,fixed
symbol length>
Disabled
0 = Disabled
1 = Enabled
Fixed Symbol Length (BC412)
Definition:
Serial Cmd:
Default:
Options:
When enabled, the check character character is read and compared along
with the symbol data. When disabled, symbol data is sent without the check
character.
<K481,status,check character output,fixed symbol length status,fixed
symbol length>
10
1 to 64
MINI Hawk Xi High Performance Imager User Manual
6-15
Interleaved 2 of 5
Interleaved 2 of 5
Usage:
Definition:
Serial Cmd:
Default:
Options:
I-2/5 has been popular because it is the most dense symbology for printing
numeric characters less than 10 characters in length; however, Microscan
does not recommend this symbology for any new applications because of
inherent problems such as truncation.
A dense, contimuous, self-checking, numeric symbology. Characters are
paired together so that each character has five elements, two wide and
three narrow, representing numbers 0 through 9, with the bars representing
the first character and the interleaved spaces representing the second
character. (A check character is highly recommended).
Important: You must set Symbol Length in order to decode I-2/5 symbols,
unless Range Mode is enabled.
<K472,status,check character status,check character output status,symbol
length #1,symbol length #2,guard bar status,range mode status>
Enabled
0 = Disabled
1 = Enabled
Check Character Status (Interleaved 2 of 5)
Usage:
Definition:
Serial Cmd:
Default:
Options:
This option is not typically used, but it can be enabled for additional security
in applications where the host requires redundant check character verification.
An error correcting routine in which the check character character is added.
<K472,status,check character status,check character output status,symbol
length #1,symbol length #2,guard bar status,range mode status>
Disabled
0 = Disabled
1 = Enabled
Check Character Output Status (Interleaved 2 of 5)
Definition:
Serial Cmd:
Default:
Options:
6-16
When enabled, a check character character is sent along with the symbol
data for added data security.
<K472,status,check character status,check character output status,symbol length #1,symbol length #2,guard bar status,range mode status>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
Symbologies
Symbol Length #1 (Interleaved 2 of 5)
Usage:
Definition:
Serial Cmd:
Default:
Options:
Useful in applications where I 2/5 symbols of a specific length are
required.
The Symbol Length # 1 field is one of two fields against which the
decoded symbol is compared before accepting it as valid or rejecting it.
<K472,status,check character status,check character output,symbol length
#1,symbol length #2,guard bar status,range mode status>
16
0 to 64, even only
Important: If Range Mode is disabled, the length of the symbol must
match either Symbol Length # 1 or Symbol Length # 2 to be considered
a valid symbol.
If Range Mode is enabled, Symbol Length # 1 and Symbol Length # 2
form a range into which the length of the symbol must fall to be considered
valid.
Symbol Length #2 (Interleaved 2 of 5)
Usage:
Definition:
Serial Cmd:
Default:
Options:
Useful in applications where I 2/5 symbols of a specific length are
required.
The Symbol Length # 2 field is one of two fields against which the
decoded symbol is compared before accepting it as valid or rejecting it.
<K472,status,check character status,check character output,symbol length
#1,symbol length #2,guard bar status,range mode status>
6
0 to 64, even only
Important: If Range Mode is disabled, the length of the symbol must
match either Symbol Length # 2 or Symbol Length # 1 to be considered
a valid symbol.
If Range Mode is enabled, Symbol Length # 2 and Symbol Length # 1
form a range into which the length of the symbol must fall to be considered
valid.
MINI Hawk Xi High Performance Imager User Manual
6-17
Interleaved 2 of 5
Guard Bar Status (Interleaved 2 of 5)
Note: Whenever Guard Bar is enabled, the presence of guard bars (also called “bearer
bars”) is required for decoding to take place.
Usage:
Definition:
Serial Cmd:
Default:
Options:
Useful when I-2/5 multisymbols are enabled to prevent false data output.
This typically occurs with highly tilted or skewed symbols.
A guard bar is a heavy bar, at least twice the width of the wide bar, surrounding
the printed I-2/5 symbol and helping to prevent false reads.
<K472,status,check character status,check character output,symbol length
#1,symbol length #2,guard bar status,range mode status>
Disabled
0 = Disabled
1 = Enabled
Range Mode Status (Interleaved 2 of 5)
Usage:
Definition:
Serial Cmd:
Default:
Options:
6-18
Useful in applications where I 2/5 symbols of a specific length are required.
When Range Mode is disabled, the imager checks the value of the symbol
length against the values set in Symbol Length # 1 and Symbol Length #
2. If the symbol length does not match either of the preset values, then it is
rejected as invalid.
When Range Mode is enabled, Symbol Length # 1 and Symbol Length #
2 are combined to form a range of valid symbol lengths. Any symbol length
that does not fall into this range is rejected as an invalid symbol. Either of
the preset symbol length values in the Symbol Length # 1 and Symbol
Length # 2 fields can form the start or end of the range.
<K472,status,check character status,check character output,symbol length
#1,symbol length #2,guard bar status,range mode status>
Enabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
Symbologies
Code 93
Usage:
Definition:
Serial Cmd:
Default:
Options:
Sometimes used in clinical applications.
Code 93 is a variable-length, continuous symbology employing four element
widths. Each Code 93 character has nine modules that may be either black
or white. Each character contains three bars and three spaces.
<K475,status,fixed symbol length status,symbol length>
Disabled
0 = Disabled
1 = Enabled
Fixed Symbol Length Status (Code 93)
Definition:
Serial Cmd:
Default:
Options:
When disabled, the imager will accept any Code 93 symbol provided is
doesn’t exceed the system’s maximum capabilities.
When enabled, the imager will reject any Code 93 symbol that doesn’t
match the fixed symbol length.
<K475,status,fixed symbol length status,symbol length>
Disabled
0 = Disabled
1 = Enabled
Symbol Length (Code 93)
Definition:
Serial Cmd:
Default:
Options:
This is the symbol length value against which all Code 93 symbols will be
compared.
<K475,status,fixed symbol length status,symbol length>
10
1 to 64
MINI Hawk Xi High Performance Imager User Manual
6-19
Codabar
Codabar
Usage:
Definition:
Serial Cmd:
Default:
Options:
Used in photo-finishing and library applications. Previously used in medical
applications, but not typically used in newer medical applications.
Codabar is a 16-bit character set (0 through 9, and the characters $, :, /, .,
+, and –) with start/stop codes and at least two distinctly different bar
widths.
<K471,status,start/stop match,start/stop output,large intercharacter gap,fixed
symbol length status,symbol length,check character type,check character
output>
Disabled
0 = Disabled
1 = Enabled
Start/Stop Match (Codabar)
Definition:
Serial Cmd:
Default:
Options:
When disabled, the imager will decode Codabar symbols whether or not
the start and stop characters are the same.
When enabled, the imager will not decode Codabar symbols unless the
start and stop characters are the same.
<K471,status,start/stop match,start/stop output,large intercharacter gap,fixed
symbol length status,symbol length,check character type,check character
output>
Enabled
0 = Disabled
1 = Enabled
Start/Stop Output (Codabar)
Definition:
Serial Cmd:
Default:
Options:
6-20
When disabled, the start and stop characters will not be present in the data
output of the decoded symbol.
When enabled, the start and stop characters will be present in the data output
of the decoded symbol.
Note: Because the start and stop characters are included as part of the
data, the characters must be included as part of the length in a fixed length
mode of operation.
<K471,status,start/stop match,start/stop output,large intercharacter gap,fixed
symbol length status,symbol length,check character type,check character
output>
Enabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
Symbologies
Large Intercharacter Gap (Codabar)
Definition:
Serial Cmd:
Default:
Options:
When disabled, the spaces between characters, or the “intercharacter
gap”, are ignored during the decode process.
Note: If the intercharacter space is large enough to be considered a margin,
the symbol will not decode, regardless of this parameter’s setting.
<K471,status,start/stop match,start/stop output,large intercharacter
gap,fixed symbol length status,symbol length,check character type,check
character output>
Disabled
0 = Disabled
1 = Enabled
Fixed Symbol Length Status (Codabar)
Definition:
Serial Cmd:
Default:
Options:
When disabled, the imager will accept any Codabar symbol provided it
doesn’t exceed the system’s maximum capabilities.
When enabled, the imager will reject any Codabar symbol that doesn’t
match the fixed length.
<K471,status,start/stop match,start/stop output,large intercharacter gap,fixed
symbol length status,symbol length,check character type,check character
output>
Disabled
0 = Disabled
1 = Enabled
Symbol Length (Codabar)
Definition:
Serial Cmd:
Default:
Options:
This is the value against which all Codabar symbol lengths will be compared.
<K471,status,start/stop match,start/stop output,large intercharacter gap,fixed
symbol length status,symbol length,check character type,check character
output>
10
1 to 64
MINI Hawk Xi High Performance Imager User Manual
6-21
Codabar
Check Character Type (Codabar)
Definition:
Serial Cmd:
Default:
Options:
When disabled, the imager will not perform any character checking calculations
on decoded Codabar symbols.
When set to Mod 16, the imager will perform a modulus 16 check character
calculation on the symbol. If the symbol does not pass this calculation, it
will not be decoded.
When set to NW7, The imager will perform an NW7 modulus 11 check character
calculation on the symbol. If the symbol does not pass this calculation, it will not
be decoded.
When set to Both, the imager will perform both the Mod 16 and NW7 modulus
11 check character calculations on the symbol. If the symbol does not pass
either calculation, it will not be decoded.
<K471,status,start/stop match,start/stop output,large intercharacter gap,fixed
symbol length status,symbol length,check character type,check character
output>
Disabled
0 = Disabled
1 = Mod 16
2 = NW7 (Mod 11)
3 = Mod 16 and NW7
Check Character Output (Codabar)
Definition:
Serial Cmd:
Default:
Options:
6-22
When this field is disabled and a check character calculation is enabled,
the imager will strip the verified check character from the symbol data output. This condition must be accounted for if a fixed length is also being
used.
When enabled, the imager will output the check character as part of the
symbol data. This condition must be accounted for if a fixed length is also
being used.
<K471,status,start/stop match,start/stop output,large intercharacter gap,fixed
symbol length status,symbol length,check character type,check character
output>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
Symbologies
UPC/EAN
Usage:
Definition:
Serial Cmd:
Default:
Options:
Used primarily in point-of-sale applications in the retail industry. It is commonly
used with Microscan readers in applications in combination with Matchcode
when there is a need to verify that the right product is being placed in the
right packaging.
UPC (Universal Product Code) is a fixed length, numeric, continuous
symbology. UPC can have two- or five-digit supplemental bar code data
following the normal code. The UPC Version A (UPC, A) symbol is used to
encode a 12 digit number. The first digit is the number system character,
the next five are the manufacturer number, the next five are the product
number, and the last digit is the checksum character.
When enabled, the imager will read UPC Version A and UPC Version E
only.
<K473,UPC status,EAN status,supplementals status,separator status,
separator character,supplemental type,format UPC-E as UPC-A>
Enabled
0 = Disabled
1 = Enabled
EAN Status
Usage:
Definition:
Serial Cmd:
Default:
Options:
EAN is the European version of the UPC symbology and is used in European
market applications.
Note: UPC must be enabled for EAN to take effect.
EAN is a subset of UPC. When enabled, the imager will read UPC Version
A, UPC Version E, EAN 13, and EAN 8. It also appends a leading zero to
UPC Version A symbol information and transmits 13 digits. If transmitting
13 digits when reading UPC Version A symbols is not desired, disable EAN.
Note: The extra character identifies the country of origin.
<K473,UPC status,EAN status,supplementals status,separator status,
separator character,supplemental type,format UPC-E as UPC-A>
Enabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
6-23
UPC/EAN
Supplementals Status (UPC/EAN)
Usage:
Definition:
Serial Cmd:
Default:
Options:
Reads Supplementals typically used in publications and documentation.
A supplemental is a 2 to 5 digit symbol appended to the main symbol.
When set to Enabled or Required, the imager reads supplemental code
data that has been appended to the standard UPC or EAN codes.
<K473,UPC status,EAN status,supplementals status,separator status,
separator character,supplemental type,format UPC-E as UPC-A>
Disabled
0 = Disabled
1 = Enabled
2 = Required
Disabled
UPC Supplementals will not be decoded.
Enabled
When enabled, the imager will try to decode a main and a supplemental. However, if a
supplemental is not decoded, the main will be sent by itself at the end of the read cycle.
Required
When set to Required, both the main and the supplemental symbols must be read or a
single No Read condition results.
For example, if Supplementals is set to Required, Separator is enabled, and an asterisk
is defined as the UPC separator character. Then the data is displayed as:
MAIN * SUPPLEMENTAL.
Note: Under no circumstances will the supplemental symbol data be sent without a main
symbol.
Note: If additional symbols—other than the main or supplemental—will be read in the
same read cycle, Number of Symbols should be set accordingly.
Separator Status (UPC/EAN)
Usage:
Definition:
Serial Cmd:
Default:
Options:
6-24
Allows users to distinguish between the main and Supplemental symbols.
A character can be inserted between the standard UPC or EAN symbology
and the supplemental symbology when Supplementals is set to Enabled
or Required.
<K473,UPC status,EAN status,supplementals status,separator status,
separator character,supplemental type,format UPC-E as UPC-A>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
Symbologies
Separator Character (UPC/EAN)
Note: If Separator Character has been changed to any other character and you wish to
redefine the separator as a comma, you will need to use ESP.
Usage:
Definition:
Serial Cmd:
Default:
Options:
As required by the application.
Allows the user to change the separator character from a comma to a new
character.
<K473,UPC status,EAN status,supplementals status,separator status,
separator character,supplemental type,format UPC-E as UPC-A>
, (comma)
Any ASCII character.
Note: Whenever Separator Character is defined as a comma ( , ) sending a <K473,s?>
command will return the current settings, including the separator character comma which
appears after the separator status comma.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K473h,,,,,3C>
For >: <K473h,,,,,3E>
For , : <K473h,,,,,2C>
MINI Hawk Xi High Performance Imager User Manual
6-25
UPC/EAN
Supplemental Type (UPC/EAN)
Usage:
Definition:
Serial Cmd:
Default:
Options:
As required by symbology used in application.
Allows the user to select 2 character or 5 character supplements, or both.
<K473,UPC status,EAN status,supplementals status,separator status,
separator character,supplemental type,format UPC-E as UPC-A>
Both
0 = Both
1 = 2 characters only
2 = 5 characters only
Both
Either 2 character or 5 character supplementals will be considered valid.
2 Characters Only
Only two character supplementals will be considered valid.
5 Characters Only
Only five character supplementals will be considered valid.
Format UPC-E as UPC-A (UPC/EAN)
Definition:
Serial Cmd:
Default:
Options:
6-26
When disabled, the imager will output the version E symbols in their
encoded 6-character format.
When enabled, the imager will format the symbol as either a 12-character
UPC-A symbol or an EAN-13 symbol, depending on the state of the EAN
status parameter. This formatting reverses the zero suppression that is
used to generate the symbol in the UPC specification.
<K473,UPC status,EAN status,supplementals status,separator status,
separator character,supplemental type,format UPC-E as UPC-A>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
Symbologies
Pharmacode
Usage:
Definition:
Serial Cmd:
Default:
Options:
Used mostly with packaging for the pharmaceuticals industry.
Encodes up to five different numbers, each with its own color, which may
be entered in decimal or “binary” format with a 1 represented by a thick bar
and a 0 represented by a thin bar. Bar width is independent of height.
In decimal format, each part can be up to 999,999.
In binary format, each input can have up to 19 ones and zeros.
Important: When Pharmacode is enabled, other linear symbologies will not
decode properly. Disable Pharmacode before reading other linear symbologies.
<K477,status,fixed symbol length status,fixed symbol length,minimum
number of bars,bar width status,direction,fixed threshold value>
Disabled
0 = Disabled
1 = Enabled
Fixed Symbol Length Status (Pharmacode)
Definition:
Serial Cmd:
Default:
Options:
When enabled, the imager will check the symbol length against the symbol
length field. If disabled, any length will be considered valid.
<K477,status,fixed symbol length status,fixed symbol length,minimum
number of bars,bar width status,direction,fixed threshold value>
Disabled
0 = Disabled
1 = Enabled
Fixed Symbol Length (Pharmacode)
Definition:
Serial Cmd:
Default:
Options:
Specifies the exact number of bars that must be present for the imager to
recognize and decode the Pharmacode symbol.
<K477,status,fixed symbol length status,fixed symbol length,minimum
number of bars,bar width status,direction,fixed threshold value>
5
1 to 16
Minimum Number of Bars (Pharmacode)
Definition:
Serial Cmd:
Default:
Options:
Sets the minimum number of bars that a Pharmacode symbol must have to
be considered valid.
<K477,status,fixed symbol length status,fixed symbol length,minimum
number of bars,bar width status,direction,fixed threshold value>
2
1 to 16
MINI Hawk Xi High Performance Imager User Manual
6-27
Pharmacode
Bar Width Status (Pharmacode)
Definition:
Serial Cmd:
Default:
Options:
If set to Mixed, the imager will autodiscriminate between narrow bars and
wide bars. If set to All Narrow, all bars will be considered as narrow bars. If
set to All Wide, all bars will be considered as wide bars. If set to Fixed
Threshold, it will use the fixed threshold value to determine whether the
bars are narrow or wide. The Bar Width Status setting will be ignored
when the imager is able to tell the difference between the narrow and the
wide bars.
<K477,status,fixed symbol length status,fixed symbol length,minimum
number of bars,bar width status,direction,fixed threshold value>
Mixed
0 = Mixed
1 = All Narrow
2 = All Wide
3 = Fixed Threshold
Direction (Pharmacode)
Definition:
Serial Cmd:
Default:
Options:
Specifies the direction in which a symbol can be read.
<K477,status,fixed symbol length status,fixed symbol length,minimum
number of bars,bar width status,direction,fixed threshold value>
Forward
0 = Forward
1 = Reverse
Fixed Threshold Value (Pharmacode)
Definition:
Serial Cmd:
Default:
Options:
6-28
Used when Bar Width Status is set to Fixed Threshold. Defines the
minimum difference in pixels that will distinguish a narrow bar from a wide
bar.
<K477,status,fixed symbol length status,fixed symbol length,minimum
number of bars,bar width status,direction,fixed threshold value>
10
1 to 65535
MINI Hawk Xi High Performance Imager User Manual
Symbologies
Postal Symbologies
Important: Postal Symbologies must have a minimum pixels-per-element value of 4 to
be decoded reliably by the MINI Hawk Xi.
The imager must be configured to specific read range, field of view, and camera parameters
before decoding Postal Symbologies.
For optimal decode results with a Standard Density (SD) imager:
• Set Focal Distance to 6” and set gain and shutter settings for a high contrast image.
• Position the imager 3.5” to 6” from the symbol (5-10” if Pixel Sub-Sampling is disabled).
• Position the symbol as close to the center of the imager’s field of view as possible.
Note: Measurements based on a 16 mil (60 dpi) POSTNET symbol.
Position the
postal symbol in
the center of the
imager’s field of
view.
MINI Hawk Xi High Performance Imager User Manual
6-29
Postal Symbologies
Postal Symbology Type
Usage:
Definition:
Serial Cmd:
Default:
Options:
6-30
The following 1D Postal Symbologies are used in mail sortation, auditing,
certified mail, registered mail, metered mail, and point-of-sale (POS) applications.
Determines the postal symbology that will be decoded by the imager.
<K460,postal symbology type,POSTNET status,PLANET status,USPS4CB
status,POSTNET allow B and B’ fields,Australia Post allow 0 FCC>
Disabled
0 = Disabled
1 = U.S. Post (POSTNET, PLANET, USPS4CB)
2 = Australia Post
3 = Japan Post
4 = Royal Mail
5 = KIX
6 = UPU
MINI Hawk Xi High Performance Imager User Manual
Symbologies
U.S. Post (POSTNET, PLANET, USPS4CB)
When U.S. Post is enabled (<K460,1>), the imager will only decode POSTNET, PLANET,
and USPS4CB symbols.
Important: POSTNET Status, PLANET Status, and USPS4CB Status are enabled by
default. However, if any of the three U.S. Post symbologies is set to disabled individually,
symbols of that type will not be decoded by the imager even when U.S. Post is enabled.
For example, if U.S. Post is enabled but POSTNET Status is disabled (<K460,1,0>),
POSTNET symbols will not be decoded by the imager.
See POSTNET Status, PLANET Status, and GS1 DataBar for more detail about U.S.
Post symbologies.
Australia Post
When Australia Post is enabled (<K460,2>), the imager will only decode Australia Post
symbols.
Japan Post
When Japan Post is enabled (<K460,3>), the imager will only decode Japan Post symbols.
Royal Mail
When Royal Mail is enabled (<K460,4>), the imager will only decode Royal Mail symbols.
KIX
When KIX is enabled (<K460,5>), the imager will only decode KIX symbols.
UPU
When UPU is enabled, the imager will decode UPU symbols.
For example, if Postal Symbology Type is set to UPU and POSTNET Status is enabled
and (<K460,6,1>), the imager will attempt to decode both UPU and POSTNET symbols.
MINI Hawk Xi High Performance Imager User Manual
6-31
Postal Symbologies
POSTNET Status
Usage:
Definition:
Serial Cmd:
Default:
Options:
POSTNET is used by the United States Postal Service to direct mail. The
ZIP Code or ZIP+4 Code is encoded in the symbol. Data is encoded in
half-height and full-height bars, making POSTNET a “2-state” symbology.
The delivery point (usually the last two digits of the address or post office
box number) is also typically encoded in POSTNET symbols.
If U.S. Post and POSTNET Status are both enabled, the imager will
decode POSTNET symbols.
<K460,postal symbology type,POSTNET status,PLANET status,
USPS4CB status,POSTNET allow B and B’ fields,Australia Post allow 0
FCC>
Enabled
0 = Disabled
1 = Enabled
PLANET Status
Usage:
Definition:
Serial Cmd:
Default:
Options:
6-32
PLANET (Postal Alphanumeric Encoding Technique) is a symbology
used by the United States Postal Service to track and identify items during
delivery. Each PLANET symbol is either 12 or 14 digits long, and encodes
data in half-height and full-height bars, making PLANET a “2-state” symbology.
The symbol always starts and ends with a full-height bar, or “guard rail”,
and each individual digit is represented by a set of five bars in which two of
the bars are always short.
If U.S. Post and PLANET Status are both enabled, the imager will decode
PLANET symbols.
<K460,postal symbology type,POSTNET status,PLANET status,
USPS4CB status,POSTNET allow B and B’ fields,Australia Post allow 0
FCC>
Enabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
Symbologies
USPS4CB Status
Usage:
Definition:
Serial Cmd:
Default:
Options:
USPS4CB, also called Intelligent Mail, is used by the United States Postal
Service to sort and track individual items as well as flats of mail. USPS4CB
combines the capabilities of POSTNET and PLANET, and can encode 31
digits (65 bars). USPS4CB symbols are slightly longer than POSTNET
symbols, and offer additional flexibility in choosing symbol height and width.
Data is encoded in four types of bars (“states”), each of which is identified
by a name and a value. This type of postal symbol is known as “4-state”.
Each bar has a “tracker”, or middle section, to which an “ascender” (top
section) or “descender” (bottom section) may be added. The 4-state format
allows the symbol to contain more information, and makes it easier to
decode. 4-state symbols can also be printed easily in a variety of media,
including dot matrix, inkjet, and laser.
If U.S. Post and USPS4CB Status are both enabled, the imager will
decode USPS4CB symbols.
<K460,postal symbology type,POSTNET status,PLANET status,USPS4CB
status,POSTNET allow B and B’ fields,Australia Post allow 0 FCC>
Enabled
0 = Disabled
1 = Enabled
POSTNET Allow B and B’ Fields
Definition:
Serial Cmd:
Default:
Options:
If U.S. Post and POSTNET are enabled, and POSTNET Allow B and B’
Fields is enabled, the imager will allow B and B’ fields in POSTNET symbols.
<K460,postal symbology type,POSTNET status,PLANET status,USPS4CB
status,POSTNET allow B and B’ fields,Australia Post allow 0 FCC>
Disabled
0 = Disabled
1 = Enabled
Australia Post Allow 0 FCC
Definition:
Serial Cmd:
Default:
Options:
If Australia Post is enabled, and Australia Post Allow 0 FCC is enabled,
the imager will allow 0 FCC in Australia Post symbols.
<K460,postal symbology type,POSTNET status,PLANET status,USPS4CB
status,POSTNET allow B and B’ fields,Australia Post allow 0 FCC>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
6-33
GS1 DataBar
GS1 DataBar
DataBar Expanded
Usage:
Definition:
Serial Cmd:
Default:
Options:
Used to encode primary and supplementary data in retail point-of-sale and
other applications.
DataBar Expanded is a variable length symbology that can encode supplementary
information in addition to the 14-digit EAN item identification number and is
capable of encoding up to 74 numeric or 41 alphabetic characters.
<K484,status,fixed symbol length status,fixed symbol length>
Disabled
0 = Disabled
1 = Enabled
Where appropriate, use 1 (non-stacked) for better performance over 2 (stacked and non-stacked).
Fixed Symbol Length Status (DataBar Expanded)
Definition:
Serial Cmd:
Default:
Options:
When enabled, the imager will check the symbol length against the
symbol length field, minus the embedded check character. If disabled,
any length would be considered valid.
<K484,status,fixed symbol length status,fixed symbol length>
Disabled
0 = Disabled
1 = Enabled
Fixed Symbol Length (DataBar Expanded)
Usage:
Definition:
Serial Cmd:
Default:
Options:
6-34
Fixed Symbol Length helps prevent truncations and increases data
integrity by ensuring that only one symbol length will be accepted.
Specifies the exact number of characters that the imager will recognize
(this does not include start, stop, and check character characters). The
imager ignores any symbol not having the specified length.
<K484,status,fixed symbol length status,fixed symbol length>
14
1 to 74
MINI Hawk Xi High Performance Imager User Manual
Symbologies
DataBar Limited (RSS Limited)
Usage:
Definition:
Serial Cmd:
Default:
Options:
DataBar Limited is designed to be read by laser and CCD readers. It is
not recommended for omnidirectional slot scanners.
Encodes a smaller 14-digit symbol (74 modules wide) that is not omnidirectional.
<K483,status>
Disabled
0 = Disabled
1 = Enabled
DataBar-14 (RSS-14)
Usage:
Definition:
Serial Cmd:
Default:
Options:
Used in the grocery, retail, and prescription drug industries where 14-digit
EAN item identification may be needed.
DataBar-14 is a fixed symbol length symbology that encodes 14 digits,
including a 1-digit indicator. DataBar-14 is 96 modules wide. It can be
stacked in two rows, it can read omnidirectionally if printed in full height, or
horizontally if height-truncated for small marking.
<K482,status>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
6-35
PDF417
PDF417
Usage:
Definition:
Serial Cmd:
Default:
Options:
Used in applications where a large amount of information (over 32 characters)
needs to be encoded within a symbol, typically where the symbol is transported
from one facility to another. For example, an automobile assembly line
might use a single symbol with multiple fields of information that will be
read at several stations along the way, without reference to a database.
A two-dimensional, multi-row (3 to 90), continuous, variable length symbology
that has high data capacity for storing up to 2,700 numeric characters,
1,800 printable ASCII characters, or 1,100 binary characters per symbol.
Each symbol character consists of 4 bars and 4 spaces in a 17-module
structure.
<K476,status,[unused],fixed symbol length status,fixed symbol length>
Enabled
0 = Disabled
1 = Enabled
Note: Sending <a1> will cause PDF417 data to be prefaced with information consisting of
error correction level (ECC Level n), number of rows (n Rows), number of columns (n
Columns), number of informative code words (n Info Code Words) and the number of data
characters (n Data Characters). This feature can be disabled by re-sending <a1>.
Fixed Symbol Length Status (PDF417)
Serial Cmd:
Default:
Options:
<K476,status,[unused],fixed symbol length status,fixed symbol length>
Disabled
0 = Disabled
1 = Enabled
Fixed Symbol Length (PDF417)
Usage:
Definition:
Serial Cmd:
Default:
Options:
Used to increase data integrity by ensuring that only one symbol length
will be accepted.
When enabled, the PDF symbol must contain the same number of characters
as the symbol length setting before it can be considered a good read. The
imager will ignore any symbol not having the specified length.
<K476,status,[unused],fixed symbol length status,fixed symbol length>
10
1 to 2710
Note: Fixed Symbol Length Status must be enabled for Fixed Symbol Length to take effect.
6-36
MINI Hawk Xi High Performance Imager User Manual
Symbologies
MicroPDF417
Usage:
Definition:
Serial Cmd:
Default:
Options:
Used for labelling small items that need large data capacity.
A variant of PDF417, a very efficient and compact stacked symbology
that can encode up to 250 alphanumeric characters or 366 numeric
characters per symbol.
<K485,status,[unused],fixed symbol length status,fixed symbol length>
Disabled
0 = Disabled
1 = Enabled
Fixed Symbol Length Status (MicroPDF417)
Serial Cmd:
Default:
Options:
<K485,status,[unused],fixed symbol length status,fixed symbol length>
Disabled
0 = Disabled
1 = Enabled
Fixed Symbol Length (MicroPDF417)
Usage:
Definition:
Serial Cmd:
Default:
Options:
Used to increase data integrity by ensuring that only one symbol length
will be accepted.
When enabled, the MicroPDF417 symbol must contain the same number
of characters as the symbol length setting before it can be considered a
good read. The imager will ignore any symbol not having the specified
length.
<K485,status,[unused],fixed symbol length status,fixed symbol length>
10
1 to 366
Note: Fixed Symbol Length Status must be enabled for Fixed Symbol Length to take
effect.
MINI Hawk Xi High Performance Imager User Manual
6-37
Composite
Composite
When set to Enabled or Required, will decode the 2D composite component of a linear
symbol. The linear symbol can be DataBar-14, DataBar Expanded, DataBar Limited,
EAN-128, UPC-A, EAN-13, EAN-8, and UPC-E.
Usage:
Definition:
Serial Cmd:
Default:
Options:
Allows reading by both linear and 2D readers.
Combines 2D and linear width-modulated symbology on the same symbol
where different messages can be read by each reader type.
<K453,mode,separator status,separator>
Disabled
0 = Disabled
1 = Enabled
2 = Required
Enabled
If Composite is set to Enabled, the imager will decode both the 2D composite and linear
components. However, if the 2D composite component is not decoded, the linear data will
be sent by itself at the end of the read cycle.
Required
If set to Required, the imager must decode both components, or a No Read will occur.
Separator Status (Composite)
Usage:
Definition:
Serial Cmd:
Default:
Options:
Allows the user to distinguish between the main and Supplemental symbols.
Separates the linear and the composite component.
<K453,mode,separator status,separator>
Disabled
0 = Disabled
1 = Enabled
Separator Character (Composite)
Note: The Separator Character will be the same as the character defined in the Multisymbol
Separator field of the <K222> command.
Usage:
Definition:
As required by the application.
Allows the user to change the separator character from a comma to a new
character.
Serial Cmd: <K453,mode,separator status,separator>
Default:
, (comma)
Options:
Any ASCII character.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K453h,,,3C>
For >: <K453h,,,3E>
For , : <K453h,,,2C>
6-38
MINI Hawk Xi High Performance Imager User Manual
Symbologies
Narrow Margins/Symbology Identifier
Narrow Margins
Usage:
Definition:
Serial Cmd:
Default:
Options:
Used when the leading and trailing edges of the symbols are smaller than
the standard margin or other objects encroach into the margins.
Allows the imager to read 1D symbols with quiet zones less than 8 times
the width of the narrow bar element. “Quiet zone” is the space at the leading
and trailing ends of a symbol. Each quiet zone can be as narrow as only
five times the width of the narrow bar element when Narrow Margins is
enabled.
<K450,narrow margins,symbology identifier status>
Enabled
0 = Disabled
1 = Enabled
Enabled
When Narrow Margins is set to Enabled, the imager uses a 5x margin requirement for
standard linear symbols.
MINI Hawk Xi High Performance Imager User Manual
6-39
Narrow Margins/Symbology Identifier
Symbology Identifier
Definition:
Serial Cmd:
Default:
Options:
Symbology Identifier is an ISO/IEC 16022 standard prefix set of characters
that identifies the symbol type.
When enabled, the imager analyzes and identifies the symbology and adds
a three-character identifying prefix to the data:
• ] (closed bracket character) indicating the presence of a symbology identifier.
• A, C, E, F, G, I, L, Q, Y, b, d, e, p, z
• (A = Code 39; C = Code 128; E = UPC/EAN; F = Codabar; G = Code
93; I = I-2/5; L = PDF417 and MicroPDF417; Q = QR Code and Micro
QR Code; Y = Postal Symbologies; b = BC412; d = Data Matrix; e = GS1
DataBar (RSS); p = Pharmacode; z = Aztec; Z = Non-Bar Code)
• Modifier
Example: ]d indicates a Data Matrix symbol.
<K450,narrow margins,symbology identifier status>
Disabled
0 = Disabled
1 = Enabled
Explanation of Modifiers for Code 39 and Interleaved 2 of 5
• For Code 39 and Interleaved 2 of 5, the modifier indicates Check Character and Check
Character Output status.
• For Code 39 only, Full ASCII must be enabled to see modifiers 4, 5, and 7.
Modifier
Check Character
0
1
3
4
5
7
Disabled
Enabled
Enabled
Disabled
Enabled
Enabled
Check Character
Output
N/A
Enabled
Disabled
N/A
Enabled
Disabled
Full ASCII conversion performed
(Code 39 only)
No
No
No
Yes
Yes
Yes
Example: ]A5 indicates a Code 39 symbol with Check Character and Check Character
Output enabled and Full ASCII conversion performed.
Explanation of Modifiers for Other Symbologies
• For Code 128, a 1 indicates EAN 128; otherwise the modifier is 0.
• For QR Code and Micro QR Code, a 0 indicates QR Code; a 1 indicates Micro QR Code.
• For Postal Symbologies, a 0 indicates POSTNET; a 1 indicates Japan Post; a 2 indicates
Australia Post; a 3 indicates PLANET; a 4 indicates Royal Mail; a 5 indicates KIX; a 6
indicates UPU (56-bar); a 7 indicates UPU (75-bar); and an 8 indicates USPS4CB.
Example: ]Y0 indicates a POSTNET symbol.
• For all other symbologies, the modifier is 0.
6-40
MINI Hawk Xi High Performance Imager User Manual
Symbologies
Background Color
Note: Background Color only applies to Pharmacode.
Usage:
Definition:
Serial Cmd:
Default:
Options:
Symbol backgrounds are often White, or other very light colors. If the
background is darker than the symbol, Black background should be
enabled.
Allows the user to specify the symbol background used in the application.
<K451,background color>
Both
0 = White
1 = Black
2 = Both
White
When White background is enabled, the bars of the symbol are recognized as dark on a
light background.
Black
When Black background is enabled, the bars of the symbol are recognized as light on a
dark background.
Both
When Both is enabled, the imager will attempt to decode for white background first, and if
there is no decode, will then attempt to decode for black background.
MINI Hawk Xi High Performance Imager User Manual
6-41
Background Color
6-42
MINI Hawk Xi High Performance Imager User Manual
7 I/O Parameters
Contents
I/O Parameters by ESP ................................................................................................................ 7-2
I/O Parameters Serial Commands ............................................................................................... 7-3
Symbol Data Output ..................................................................................................................... 7-4
No Read Message........................................................................................................................ 7-7
Read Duration Output .................................................................................................................. 7-8
Output Indicators .......................................................................................................................... 7-9
Beeper........................................................................................................................................ 7-13
LED Configuration ...................................................................................................................... 7-14
Serial Verification ....................................................................................................................... 7-15
EZ Button ................................................................................................................................... 7-17
EZ Button Modes........................................................................................................................ 7-19
Configurable Output 1 ................................................................................................................ 7-21
Trend Analysis Output 1............................................................................................................. 7-24
ISO/IEC 16022 Symbol Quality Output 1 ................................................................................... 7-27
Diagnostic Output 1.................................................................................................................... 7-30
Configurable Output 2 ................................................................................................................ 7-31
Trend Analysis Output 2............................................................................................................. 7-31
ISO/IEC 16022 Symbol Quality Output 2 ................................................................................... 7-31
Diagnostic Output 2.................................................................................................................... 7-31
Configurable Output 3 ................................................................................................................ 7-32
Trend Analysis Output 3............................................................................................................. 7-32
ISO/IEC 16022 Symbol Quality Output 3 ................................................................................... 7-32
Diagnostic Output 3.................................................................................................................... 7-32
Power-On/Reset Counts ............................................................................................................ 7-33
Time Since Reset ....................................................................................................................... 7-34
Service Message........................................................................................................................ 7-35
Frame Information ...................................................................................................................... 7-36
Image Output.............................................................................................................................. 7-37
Database Identifier Output ......................................................................................................... 7-40
Quality Output ............................................................................................................................ 7-41
Configuring EZ Trax Output ....................................................................................................... 7-42
This section includes instructions on setting up conditions for changing input/output electrical
transitions for control of the imager’s internal and external devices. A discrete I/O (in/out) signal
is an electrical transition from one voltage level to another so that digital switching can occur.
MINI Hawk Xi High Performance Imager User Manual
7-1
I/O Parameters by ESP
I/O Parameters by ESP
Click the Parameters
button and then the I/O tab.
To change a setting,
double-click the
setting and use your
cursor to scroll
through the options.
To open nested options,
single-click the +.
7-2
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
I/O Parameters Serial Commands
Power On/Reset Counts
<K406,power-on,resets,power-on saves,power-on flash saves>
Time Since Reset
<K407,hours,minutes>
Service Message
<K409,status,service message,threshold,resolution>
Serial Verification
<K701,serial command echo status,serial command beep status,control/hex
output>
Beeper
<K702,status>
Quality Output
<K704,quality output separator,decodes per trigger status>
Symbol Data Output
<K705,symbol data output status,when to output>
Read Duration Output
<K706,status,separator>
No Read Message
<K714,status,message>
Frame Information
<K734,output frame number,output coordinates>
LED Configuration
<K737,LED mode,ISO/IEC 16022 grade>
Image Output
<K739,image output mode,communication port,file format,JPEG quality>
Target/Flood LEDs
<K750,green flash LED status,target pattern LED status,green flash
duration>
EZ Trax Output
<K757,comm port,image mode,image format,JPEG quality,object info
output,grade output>
Database Identifier Output
<K759,status,separator>
EZ Button
<K770,global status,default on power-on,load Configuration Database,
save for power-on>
EZ Button Modes
<K771,single beep,two beeps,three beeps,four beeps>
Trend Analysis Output 1
<K780,trend analysis mode,trigger evaluation period,number to output
on,decodes per trigger threshold>
Trend Analysis Output 2
<K781,trend analysis mode,trigger evaluation period,number to output
on,decodes per trigger threshold>
Trend Analysis Output 3
<K782,trend analysis mode,trigger evaluation period,number to output
on,decodes per trigger threshold>
Diagnostic Output 1
<K790,unused 1,service unit>
Diagnostic Output 2
<K791,unused 1,service unit>
Diagnostic Output 3
<K792,unused 1,service unit>
ISO/IEC 16022 Symbol Quality Output 1
<K800,output on symbol contrast,symbol contrast threshold,output on
print growth,print growth threshold,output on axial non-uniformity,axial
non-uniformity threshold,output on UEC,UEC threshold>
ISO/IEC 16022 Symbol Quality Output 2
<K801,output on symbol contrast,symbol contrast threshold,output on
print growth,print growth threshold,output on axial non-uniformity,axial
non-uniformity threshold,output on UEC,UEC threshold>
ISO/IEC 16022 Symbol Quality Output 3
<K802,output on symbol contrast,symbol contrast threshold,output on
print growth,print growth threshold,output on axial non-uniformity,axial
non-uniformity threshold,output on UEC,UEC threshold>
Configurable Output 1
<K810,output on,output state,pulse width,output mode>
Configurable Output 2
<K811,output on,output state,pulse width,output mode>
Configurable Output 3
<K812,output on,output state,pulse width,output mode>
MINI Hawk Xi High Performance Imager User Manual
7-3
Symbol Data Output
Symbol Data Output
Symbol Data Output Status
Note: Symbol Data Output relates to data and should not be confused with Outputs 1, 2,
and 3 listed in the Output Parameters which describe output states and functions.
Usage:
Definition:
Serial Cmd:
Default:
Options:
Useful when the host needs symbol data only under certain conditions.
Defines the conditions under which decoded symbol data is transmitted
to the host.
<K705,symbol data output status,when to output>
Good Read
0 = Disabled
1 = Match
2 = Mismatch
3 = Good Read
Note: Symbol Data Output Status, if set to Match or Mismatch, will not
take effect unless Matchcode Type is enabled and a master symbol is
loaded into memory.
Disabled
Usage:
Definition:
It is useful when an application only needs to use the discrete outputs
and can allow the imager to do the decision-making. When Disabled, the
host does not need the symbol data and the communication lines are
used only for setup and status checks.
When set to Disabled, the imager will not transmit any data that is generated
during a read cycle (symbols, No Reads, etc.)
Match
Usage:
Definition:
Match is used in an application that requires specific symbol information
and needs to sort, route, or verify based on matching the specific symbol
data.
When set to Match, the imager transmits symbol data whenever a symbol
matches a master symbol. However, if Matchcode Type is Disabled, it
transmits on any good read.
Note: A No Read can still be transmitted if Enabled.
Mismatch
Usage:
Definition:
Mismatch is typically used as a flag within the host system to prevent an
item from being routed in the wrong container.
With Mismatch enabled, the imager transmits symbol data whenever the
symbol data information does NOT match the master symbol.
Note: A No Read can still be transmitted if Enabled.
7-4
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Good Read
Usage:
Definition:
Good Read is used when an application requires all symbol data to be
transmitted. It’s typically used in tracking applications in which each
object is uniquely identified.
With Good Read enabled, the imager transmits symbol data on any good
read regardless of Matchcode Type setting.
Note: A No Read can still be transmitted if Enabled.
MINI Hawk Xi High Performance Imager User Manual
7-5
Symbol Data Output
When to Output Symbol Data
Definition:
Serial Cmd:
Default:
Options:
This command allows the user to choose when symbol data can be sent
to the host.
<K705,symbol data output status,when to output>
As Soon As Possible
0 = ASAP
1 = End of Read Cycle
As Soon As Possible
Usage:
Definition:
As Soon As Possible is useful in applications in which symbol data
needs to be moved quickly to the host, typically when the host is making
decisions based on symbol data.
Enabling As Soon As Possible causes symbol data to be sent to the
host immediately after a symbol has been successfully decoded.
Note: More than one decode might in fact be required to qualify as a good read, depending
on how Decodes Before Output is set.
End of Read Cycle
Usage:
Definition:
End of Read Cycle is useful in timing-based systems in which the host is
not ready to accept data at the time that it is decoded.
Enabling End of Read Cycle means that symbol data does not get sent
to the host until the read cycle ends with a timeout or new trigger.
End of read cycle
Start of read cycle
Read cycle duration
Host
activates trigger
7-6
This is when host
expects output
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
No Read Message
Usage:
Definition:
Used in applications where the host needs serial verification that a symbol
has not been read and especially useful in new print verification.
When enabled, and if no symbol has been decoded before timeout or the
end of the read cycle, the No Read message will be transmitted to the host.
No Read Message Mode
Serial Cmd:
Default:
Options:
<K714,No Read message status,No Read message>
Enabled
0 = Disabled
1 = Enabled
Disabled
Only symbol data is output after a read cycle.
Enabled
When the imager is in a triggered mode, a No Read message will be appended for each
failed read attempt.
No Read Message
Definition:
Serial Cmd:
Default:
Options:
Any combination of ASCII characters can be defined as the No Read
message.
<K714,No Read message status,No Read message>
NOREAD
A string of up to 64 characters.
Note: No Read Message will only be transmitted if Symbol Data Output is set to Match,
Mismatch, or Good Read.
No Read Message can be set to any ASCII character.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K714h,,3C>
For >: <K714h,,3E>
For , : <K714h,,2C>
MINI Hawk Xi High Performance Imager User Manual
7-7
Read Duration Output
Read Duration Output
Usage:
Definition:
Useful in evaluating actual read cycle timing results, especially when
initially setting up an application to determine maximum line speed
(obtainable based on spacing between symbols.)
When enabled the duration of the read cycle (in milliseconds) is
appended to the symbol data.
The read duration is the time from the beginning of the read cycle until
data is output.
Read Duration Output Mode
Serial Cmd:
Default:
Options:
<K706,status,separator>
Disabled
0 = Disabled
1 = Enabled
Important: To measure the entire read cycle when in External Level trigger mode, set
When to Output Symbol Data to End of Read Cycle.
This output can measure over 49 days’ worth of duration; if exceeded, the “OVERFLOW”
message will be output in place of the duration.
Read Duration Output Separator
Definition:
Serial Cmd:
Default:
Options:
User defined character that separates the symbol information from the
Read Duration Output.
<K706,status,separator>
[space character]
Any ASCII character.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K706h,,3C>
For >: <K706h,,3E>
For , : <K706h,,2C>
7-8
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Output Indicators
The MINI Hawk Xi has a beeper and three LED arrays, as follows:
1. A target pattern of blue LEDs for centering the field of view, which is projected from
the front of the imager .
2. An array of green LEDs projected from the front of the imager that can be programmed
to flash in response to user-defined conditions.
3. A row of five status LEDs on the side of the imager.
Green Flash Mode
Usage:
Definition:
Serial Cmd:
Default:
Options:
Used as a visual verification that a good read has occurred.
An array of green LEDs in the front of the imager can be programmed to
flash in response to user-defined conditions.
<K750,green flash mode,target pattern status,green flash duration>
Good Read
0 = Disabled
1 = Good Read
2 = Static Presentation
3 = Match
4 = Mismatch
5 = Strobe
Disabled
Green flash LEDs are disabled.
Good Read
Green flash LEDs will flash when a good read condition is met or when Matchcode is
enabled and a match occurs.
MINI Hawk Xi High Performance Imager User Manual
7-9
Output Indicators
Static Presentation Mode
Static Presentation Mode is used in conjunction with Continuous Read Mode: <K200,0>.
When operating in Static Presentation Mode, the red LEDs will illuminate while the
imager is searching for a symbol in Continuous Read Mode. When a symbol is placed in
the field of view and a good read occurs, the green LEDs will illuminate and stay on for the
duration of time set in Green Flash Duration. Only one read will occur during that time
unless more than one symbol is enabled in Number of Symbols.
Note: If Static Presentation Mode is selected but the imager is not in Continuous Read,
the Green Flash will not occur.
To use Static Presentation:
1. Enable Continuous Read.
2. Select the number of symbols.
3. Enable Static Presentation in Green Flash Mode.
4. Select the read time in Green Flash Duration.
Match
The green LEDs will flash when a match condition is met. If multisymbol is enabled, then
green flash LEDs will illuminate only if all symbols qualify as a match. If matchcode is
disabled, then this mode will activate the LEDs on a good read.
Mismatch
Same as Match, except that LEDs will illuminate on a mismatch.
Strobe
Green flash LEDs will act as an illumination strobe for image capture. If it is required that the
green flash LEDs be the only illumination for image capture, then the internal illumination
LEDs can be disabled.
7-10
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Target Pattern
Usage:
Definition:
Serial Cmd:
Default:
Options:
Assists users in positioning and locating symbols in the center of the
imager’s field of view.
The user can control when the targeting system is ON or OFF, and can
save this condition for power-on.
<K750,green flash mode,target pattern status,green flash duration>
Always ON
0 = Always OFF
1 = ON only when not in the read cycle
2 = ON only when in the read cycle
3 = Always ON
Always OFF
The target pattern will remain OFF at all times unless overridden by the EZ button or
operational command.
ON Only When Not in the Read Cycle
The target pattern is always ON except during the read cycle. If the EZ button or operational
command overrides this setting, the target pattern will remain on at all times.
ON Only When in the Read Cycle
The target pattern will remain OFF except during the read cycle. If the EZ button or operational
command overrides this setting, the target pattern will remain on at all times.
Always ON
The target pattern is always ON.
MINI Hawk Xi High Performance Imager User Manual
7-11
Output Indicators
Green Flash Duration
Usage:
Definition:
Serial Cmd:
Default:
Options:
7-12
Provides visual verification that a good read has occurred.
When a good read occurs, the green LEDs will illuminate and stay on for
the time set in the Green Flash Duration value.
<K750,green flash mode,target pattern status,green flash duration>
100 (1 second)
0 to 65535 (in 10 ms increments)
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Beeper
Usage:
Definition:
Serial Cmd:
Default:
Options:
An audible verification that either a good read or a No Read has
occurred.
A beep is emitted after each good read or No Read.
<K702,beeper status>
Good Read
0 = Disabled
1 = Good Read
2 = No Read
Note: The beeper will also sound at any of the following times:
• When the imager is defaulted.
• When a send/save command is sent from ESP.
• At the conclusion of a calibration procedure.
• When a <Z>, <Zp>, <Zrd>, or <K701,,1> command is sent.
MINI Hawk Xi High Performance Imager User Manual
7-13
LED Configuration
LED Configuration
Usage:
Definition:
Serial Cmd:
Default:
Options:
Useful as a visible indicator of read rates and symbol quality.
Determines the mode in which the status LEDs operate.
<K737,LED mode,ISO/IEC 16022 grade>
Standard
0 = Standard
1 = ISO/IEC 16022 grade
In ISO/IEC 16022 grade mode the LEDs represent the grade of the first Data Matrix
symbol decoded in the read cycle.
The parameter to be graded is set in the ISO/IEC 16022 Grade options.
For example, to program the LEDs to indicate the ISO/IEC 16022 print growth grade, set
LED Mode to ISO/IEC 16022 Grade and set ISO/IEC 16022 Grade to Print Growth. If all
the LEDs from 20% to 100% are illuminated, the read result is a grade A; if only the 20%
LED is illuminated, the result is a grade F.
Standard
In Standard Mode, the STATUS LED indicates read cycle status and the GOOD READ
LED illuminates upon a good read at the end of a read cycle. In a read rate test, these
LEDs represent the percentage of good reads per images captured.
ISO/IEC 16022 Grade
Usage:
Definition:
Serial Cmd:
Default:
Options:
7-14
Provides visual grading of specific ISO/IEC 16022 parameters.
Determines which ISO/IEC 16022 parameter the imager will grade via the
LEDs.
<K737,LED mode,ISO/IEC 16022 grade>
Final Grade
0 = Final Grade
1 = Symbol Contrast
2 = Print Growth
3 = Axial Non-Uniformity
4 = Unused ECC
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Serial Verification
Allows the user to verify configuration command status.
Serial Command Echo Status
Usage:
Definition:
Function:
Serial Cmd:
Default:
Options:
This command is useful in removing any doubt about the imager’s interpretation
of any configuration command.
For example, if the current preamble is “SOM” and <K701,1,START> is
entered, the imager will echo back <K701,SOM> since the attempted
entry “START” exceeds the four character limit for that command.
Therefore, it is rejected and the existing “SOM” message is echoed back
and remains the preamble message.
When enabled, a configuration command
received from the host is echoed back to the
Host
Imager
host with the resultant settings.
If a command with multiple fields is processed, some of the fields may
have been processed properly while others were not. The changes will
appear in the string echoed back so that the user will know which fields
did or did not change.
<K701,serial command echo status,serial command beep status,
control/hex output>
Disabled
0 = Disabled
1 = Enabled
Serial Command Beep Status
Usage:
Definition:
Function:
Serial Cmd:
Default:
Options:
Used to audibly verify the acceptance and validity of a command.
Causes the imager to beep once whenever a K command is entered to
indicate that the command was accepted and processed.
If an invalid command is entered, the imager beeps 5 times to indicate an
invalid entry. However, this does not necessarily mean that all data fields
have been entered incorrectly. Only one bad field needs to be found in
order to activate the 5 beep response.
<K701,serial command echo status,serial command beep status,
control/hex output>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
7-15
Serial Verification
Control/Hex Output
Usage:
Definition:
Serial Cmd:
Default:
Options:
7-16
Useful for viewing settings with binary characters when using serial commands
on a terminal.
Determines the response to a Serial Command Echo or status request
command.
When set to Control, two characters are transmitted to represent a non-displayable
character. For example, a carriage return will be shown as: ^M.
<K701,serial command echo status,serial command beep status,control/hex
output>
Control
0 = Control
1 = Hex
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
EZ Button
The EZ button has four positions, selectable by the length of time the button is held down,
and indicated by one, two, three, and four beeps in succession. Each position can be
programmed for any of eight options.
Definition:
Serial Cmd:
Default:
Options:
Serves as a master switch to enable/disable the EZ button status.
<K770,global status,default on power-on,load Configuration Database,
save for power-on>
Enabled
0 = Disabled
1 = Enabled
2 = Trigger
3 = Unlatch Outputs
4 = Parameter Switch
Global Status
Disabled
When set to Disabled, the EZ button does not function.
Enabled
When selected, the EZ button is enabled and the function of each button position is
selected by the EZ Button Mode command.
Trigger
When selected, the EZ button acts as a trigger for the imager to start and end read cycles.
All other button operations are inactive.
In External
Level:
In External
Edge:
The read cycle endures for as long as the EZ button is pressed, unless a
timeout occurs and Timeout is enabled for End of Read Cycle.
As with Level, Edge allows a read cycle to be initiated by pressing the EZ
button, but unlike Level, the read cycle ends with a good read output, a
timeout, or a new trigger.
Unlatch Outputs
In this configuration, the EZ button will unlatch any logic outputs that have been latched.
Parameter Switch
The parameter switch toggles between custom defaults and power-on settings. The condition
is the same as that achieved by sending the <Arc> and <Arp> commands consecutively.
MINI Hawk Xi High Performance Imager User Manual
7-17
EZ Button
Default on Power-On
Definition:
Serial Cmd:
Default:
Options:
When enabled, if the EZ button is held down on power-on the imager will
default to customer defaults and save for power-on. This is the same as
sending a <Zrc> command.
<K770,global status,default on power-on,load Configuration Database,
save for power-on>
Enabled
0 = Disabled
1 = Enabled
Load Configuration Database
Definition:
Serial Cmd:
Default:
Options:
Allows the user to load the Configuration Database with calibration results.
When the user performs a calibration using the EZ button, all the database
entries are moved down one index and the results of the calibration are
saved to index 1. The results will be saved as current settings as well.
<K770,global status,default on power-on,load Configuration Database,
save for power-on>
Enabled
0 = Disabled
1 = Enabled
Save for Power-On
Definition:
Serial Cmd:
Default:
Options:
7-18
If enabled, after calibration is complete, all parameters will be saved for
power-on.
<K770,global status,default on power-on,load Configuration Database,
save for power-on>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
EZ Button Modes
Usage:
Definition:
Serial Cmd:
Options:
Useful for performing multiple, repetitive tasks at the work site.
Allows the user to program each of the EZ button’s 4 positions from a selection
of 8 modes.
<K771,position 1 mode,position 2 mode,position 3 mode,position 4 mode>
0 = Disabled
1 = Enabled
Single Beep
0 = Disabled
1 = Read Rate
2 = Calibrate
3 = Save for Power-On
4 = Unused
5 = Load New Master
6 = Unused
7 = Target System
8 = Unused
9 = Bar Code Config.
Two Beeps
0 = Disabled
1 = Read Rate
2 = Calibrate
3 = Save for Power-On
4 = Unused
5 = Load New Master
6 = Unused
7 = Target System
8 = Unused
9 = Bar Code Config.
Three Beeps
0 = Disabled
1 = Read Rate
2 = Calibrate
3 = Save for Power-On
4 = Unused
5 = Load New Master
6 = Unused
7 = Target System
8 = Unused
9 = Bar Code Config.
Four Beeps
0 = Disabled
1 = Read Rate
2 = Calibrate
3 = Save for Power-On
4 = Unused
5 = Load New Master
6 = Unused
7 = Target System
8 = Unused
9 = Bar Code Config.
Disabled
When set to disabled, the associated button position will have no function associated with
it, and the position will be skipped over.
Read Rate
Read Rate will be initiated when the associated button position is selected. Read Rate will
perform decodes/second and is the same as sending a <C> from the terminal. To exit
Read Rate Mode quickly press and release the EZ button.
Calibrate
Calibration will be initiated when the associated button position is selected. To abort calibration,
quickly press and release the EZ button.
Save for Power-On
All imager settings will be saved to non-volatile memory to be recalled on power-on
whenever the associated button position is selected. This is the same as sending a <Z>
from the terminal.
Load New Master
Functions in the same way as new master pin input whenever the associated button
position is selected. The new master pin’s Consecutive Decode requirement holds true
for this function.
MINI Hawk Xi High Performance Imager User Manual
7-19
EZ Button Modes
Target System
Turns on the target pattern whenever the associated button position is selected. To disable,
quickly press and release the EZ button.
Note: This mode is the only one that does not require that the button be released before
taking effect. Thus, as soon as the imager beeps the appropriate number of times for the
position, it will take effect. If it is necessary to have the target system on before another
operation such as calibration or read rate is performed, ensure that the target system
mode is assigned a lower position so that it will be activated first.
Bar Code Configuration
Enables bar code configuration mode whenever the associated button position is
selected. When enabled, the imager can accept configuration commands from symbols.
To disable, quickly press and release the EZ button.
EZ Button Operation
To execute EZ button commands:
Single Beep (Position #1)
Hold down button until a single beep is heard (and the 20% LED illuminates).
Two Beeps (Position #2)
Hold down button until two quick beeps are heard (and the 20% and 40% LEDs illuminate.)
Three Beeps (Position #3)
Hold down button until three quick beeps are heard (and the 20%, 40%, and 60% LEDs
illuminate).
Four Beeps (Position #4)
Hold down button until four quick beeps are heard (and the 20%, 40%, 60%, and 80%
LEDs illuminate).
7-20
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Configurable Output 1
Usage:
Definition:
Serial Cmd:
Default:
Options:
This option provides discrete signalling to host software to control external
devices such as PLCs and relays. It is useful for routing, sorting, and to
prevent mis-packaging and mis-routing.
Sets the discrete output functions for specific user-selected conditions.
Allows the user to set the conditions under which an output (or outputs) will
be activated.
<K810,output on,output state,pulse width,output mode>
Mismatch or No Read
0 = Mismatch or No Read
1 = Match (or Good Read)
2 = Mismatch
3 = No Read
4 = Trend Analysis
5 = Symbol Quality
6 = Diagnostic Warning
7 = In Read Cycle
Note: If Output On is set to Match or Mismatch, a transition (switching) will not occur
unless Matchcode Type is enabled and a master symbol is loaded into memory.
Mismatch or No Read
Activates discrete output when the data does not match that of the master symbol or the
symbol has not been decoded before the end of the read cycle.
Match (or Good Read)
Activates a discrete output when the symbol data matches the master symbol.
Note: If you want to output for a good read and Matchcode is not enabled, you can
enable any output for Match.
Mismatch
Activates a discrete output whenever the symbol data does not match that of the master
symbol.
No Read
Activates a discrete output whenever the symbol data is not decoded before the end of the
read cycle.
MINI Hawk Xi High Performance Imager User Manual
7-21
Configurable Output 1
Trend Analysis
Usage:
Definition:
Typically used when successful decodes are occurring but a discrete output
is needed to flag a trend in quality issues.
Activates discrete output when a trend analysis condition is met, depending
on the trend analysis option enabled.
Symbol Quality
Usage:
Definition:
Typically used when a discrete indication is needed to flag a symbol quality
condition.
Activates discrete output when a symbol quality condition is met, depending
on the symbol quality option enabled.
Diagnostic Warning
Usage:
Definition:
Typically used when a discrete indication of a diagnostic condition is
needed.
Activates discrete output when a diagnostic warning condition is met,
depending on the diagnostic option enabled.
In Read Cycle
Definition:
7-22
Activates a discrete output when the imager is in a read cycle.
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Output State
Definition:
Serial Cmd:
Default:
Options:
Sets the active electrical state of the discrete output.
<K810,output on,output state,pulse width,output mode>
Negative
0 = Normally Open
1 = Normally Closed
Pulse Width
Definition:
Serial Cmd:
Default:
Options:
Sets the time in 10 ms increments that the discrete output remains active.
<K810,output on,output state,pulse width,output mode>
5 (Corresponds to 50 ms)
0 to 255 (0 to 2.55 seconds). Divide the number entered on the command
line by 100 for time in seconds.
Output Mode
Definition:
Serial Cmd:
Default:
Options:
Sets the condition in which the discrete output is de-activated.
<K810,output on,output state,pulse width,output mode>
Pulse
0 = Pulse
2 = Latch Mode 2
3 = Latch Mode 3
Pulse
This is the default mode of operation in which the programmable output is activated when
the Output On condition has been met and held active for the duration of the selected
pulse width.
Latch Mode 2 (Unlatch Opposite Condition)
The programmable output is activated when the Output On condition has been met and
held active until the opposite condition selected under Output On has been met.
For example, if No Read is enabled under Output On, the programmable output will go
active on a No Read and remain active until the opposite condition, a good read, occurs.
Latch Mode 3 (Unlatch Re-enter Read Cycle)
The programmable output is active when the Output On condition has been met and is
held active until a new read cycle begins.
Note: All of the Output On modes are inhibited when any Output on Warning is active
for Output 1.
MINI Hawk Xi High Performance Imager User Manual
7-23
Configurable Output 1
Trend Analysis Output 1
Note: Output On under Output 1 Parameters must be set to Trend Analysis for this
output to function.
Under Output 1 Parameters, expand the Trend Analysis tree:
Usage:
Definition:
Example:
7-24
Useful in cases where the user doesn’t want to shut down for one condition
but wants to monitor quality and read conditions.
Applies Trend Analysis settings to Output 1.
With Trend Analysis, the user can track the occurrences and frequency of
mismatches, No Reads, and the number of reads per trigger, and output the
results to any of three outputs.
Trend Analysis Mode = No Read
Trigger Evaluation Period= 25 triggers (read cycles)
Number to Output On = 4
In this example, the imager will activate an output when 4 No Reads occur
within a period of 25 triggers (read cycles).
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Trend Analysis Mode
Definition:
Sets the trend condition (Mismatch, No Read, or Decodes per Trigger)
that will activate the output.
Serial Cmd:
<K780,trend analysis mode,trigger evaluation period,number to output on,
decodes per trigger threshold>
No Read
0 = Mismatch
1 = No Read
2 = Decodes per Trigger
Default:
Options:
Mismatch
Output will be activated when the number of mismatches equals the value entered for
Number to Output On within the trigger window selected in Number of Triggers.
No Read
Output will be activated when the number of No Reads equals the value entered for
Number to Output On within the trigger window selected in Number of Triggers.
Decodes per Trigger
Output will be activated when the number of decodes equals the value entered for Number to
Output On within the trigger window selected in Number of Triggers.
MINI Hawk Xi High Performance Imager User Manual
7-25
Configurable Output 1
Trigger Evaluation Period
Definition:
Serial Cmd:
Default:
Options:
The number of triggers to examine for the trend analysis condition.
<K780,trend analysis mode,trigger evaluation period,number to output on,
decodes per trigger threshold>
0
0 to 255
Number to Output On
Usage:
Definition:
Serial Cmd:
Default:
Options:
Example: If Number to Output On is set to 3 and Trend Analysis Mode is
set to No Read, then the output will not be activated until 3 No Reads have
occurred.
Sets the number of Trend Analysis Mode events (mismatches, No Reads,
or reads/trigger as configured by Trend Analysis Mode) to occur within the
trigger evaluation period before activating the associated output.
<K780,trend analysis mode,trigger evaluation period,number to output on,
decodes per trigger threshold>
0
0 to 255
Decodes per Trigger Threshold
Definition:
Serial Cmd:
Default:
Options:
7-26
The appropriate output will be activated if, at the end of the read cycle, the
symbol decode count is below this setting.
Note: To activate this feature the imager must be in Decodes per Trigger
mode. To put the imager in this mode during the read cycle and the Trend
Analysis operation, the Decodes per Trigger status in the quality settings
must be enabled. Enabling this setting will also append the decode count to
the symbol data.
<K780,trend analysis mode,trigger evaluation period,number to output on,
decodes per trigger threshold>
0
0 to 65535
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
ISO/IEC 16022 Symbol Quality Output 1
Note: Output On under Output 1 Parameters must be set to Symbol Quality for this
output to function.
Under Output 1 Parameters, expand the Symbol Quality (ISO/IEC 16022) tree.
Output on Symbol Contrast
Usage:
Definition:
Serial Cmd:
Default:
Options:
Lets the user know if symbol quality is less than acceptable.
If enabled, toggles Output 1 to an active state when Symbol Contrast
Threshold is met.
<K800,output on symbol contrast,symbol contrast threshold,output on print
growth,print growth threshold,output on axial non-uniformity,axial non-uniformity
threshold,output on UEC,UEC threshold>
Disabled
0 = Disabled
1 = Enabled
Output on Print Growth
Usage:
Definition:
Serial Cmd:
Default:
Options:
Lets the user know if symbol quality is less than acceptable.
If enabled, toggles Output 1 to an active state when Print Growth Threshold
is met.
<K800,output on symbol contrast,symbol contrast threshold,output on print
growth,print growth threshold,output on axial non-uniformity,axial non-uniformity
threshold,output on UEC,UEC threshold>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
7-27
ISO/IEC 16022 Symbol Quality Output 1
Output on Axial Non-Uniformity
Usage:
Definition:
Serial Cmd:
Default:
Options:
Lets the user know if symbol quality is less than acceptable.
If enabled, toggles Output 1 to an active state when Axial Non-Uniformity
Threshold is met.
<K800,output on symbol contrast,symbol contrast threshold,output on print
growth,print growth threshold,output on axial non-uniformity,axial non-uniformity
threshold,output on UEC,UEC threshold>
Disabled
0 = Disabled
1 = Enabled
Output on Unused Error Correction
Usage:
Definition:
Serial Cmd:
Default:
Options:
Lets the user know if symbol quality is less than acceptable.
If enabled, toggles Output 1 to an active state when UEC Threshold is
met.
<K800,output on symbol contrast,symbol contrast threshold,output on print
growth,print growth threshold,output on axial non-uniformity,axial non-uniformity
threshold,output on UEC,UEC threshold>
Disabled
0 = Disabled
1 = Enabled
Symbol Contrast Threshold
Usage:
Definition:
Serial Cmd:
Default:
Options:
7-28
Lets the user set the acceptable level of symbol quality.
Conforms to ISO/IEC 16022 symbol quality grading (A,B,C,D).
<K800,output on symbol contrast,symbol contrast threshold,output on print
growth,print growth threshold,output on axial non-uniformity,axial non-uniformity
threshold,output on UEC,UEC threshold>
Grade C
0 = Grade A
1 = Grade B
2 = Grade C
3 = Grade D
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Print Growth Threshold
Usage:
Definition:
Serial Cmd:
Default:
Options:
Lets the user set the acceptable level of symbol quality.
Conforms to ISO/IEC 16022 symbol quality grading (A,B,C,D).
<K800,output on symbol contrast,symbol contrast threshold,output on print
growth,print growth threshold,output on axial non-uniformity,axial non-uniformity
threshold,output on UEC,UEC threshold>
Grade C
0 = Grade A
1 = Grade B
2 = Grade C
3 = Grade D
Axial Non-Uniformity Threshold
Usage:
Definition:
Serial Cmd:
Default:
Options:
Lets the user set the acceptable level of symbol quality.
Conforms to ISO/IEC 16022 symbol quality grading (A,B,C,D).
<K800,output on symbol contrast,symbol contrast threshold,output on print
growth,print growth threshold,output on axial non-uniformity,axial non-uniformity
threshold,output on UEC,UEC threshold>
Grade C
0 = Grade A
1 = Grade B
2 = Grade C
3 = Grade D
Unused Error Correction Threshold
Usage:
Definition:
Serial Cmd:
Default:
Options:
Lets the user set the acceptable level of symbol quality.
Conforms to ISO/IEC 16022 symbol quality grading (A,B,C,D).
<K800,output on symbol contrast,symbol contrast threshold,output on print
growth,print growth threshold,output on axial non-uniformity,axial non-uniformity
threshold,output on UEC,UEC threshold>
Grade C
0 = Grade A
1 = Grade B
2 = Grade C
3 = Grade D
MINI Hawk Xi High Performance Imager User Manual
7-29
Diagnostics Output 1
Diagnostics Output 1
Note: Output On under Output 1 Parameters must be set to Diagnostic Warning for
this output to function.
Under Output 1 Parameters, expand the Diagnostics tree.
Serial Cmd:
Default:
Options:
<K790,unused 1,service unit>
0
0 = Disabled
Service Unit
When Diagnostic Warning is enabled, the Output On configuration has no effect. The
output will remain active as long as one of the diagnostic warning conditions is met. The
output will become inactive once it detects that there are no diagnostic warning conditions.
Definition:
Serial Cmd:
Default:
Options:
7-30
Allows the user to set up the output to toggle to active when the service
timer has expired. This condition will only be held for one service timer
click.
Note: This feature cannot be used if the imager is in a Continuous Read
mode.
<K790,unused 1,service unit>
0
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Configurable Output 2
Note: Output 2 has the same parameters and default settings as Output 1.
Serial Cmd:
<K811,output on,output state,pulse width,output mode>
Trend Analysis Output 2
Note: Output On under Output 2 Parameters must be set to Trend Analysis for this output
to function.
Serial Cmd:
<K781,trend analysis mode,trigger evaluation period,number to output on>
ISO/IEC 16022 Symbol Quality Output 2
Note: Output On under Output 2 Parameters must be set to Symbol Quality for this
output to function.
Serial Cmd:
<K801,output on symbol contrast,symbol contrast threshold,output on print
growth,print growth threshold,output on axial non-uniformity,axial non- uniformity
threshold,output on UEC,UEC threshold>
Diagnostics Output 2
Note: Output On under Output 2 Parameters must be set to Diagnostic Warning for
this output to function.
Serial Cmd:
<K791,unused 1,service unit>
MINI Hawk Xi High Performance Imager User Manual
7-31
Configurable Output 3
Configurable Output 3
Note: Output 3 has the same parameters and default settings as Output 1 and Output 2.
Serial Cmd:
<K812,output on,output state,pulse width,output mode>
Trend Analysis Output 3
Note: Output On under Output 3 Parameters must be set to Trend Analysis for this output
to function.
Serial Cmd:
<K782,trend analysis mode,trigger evaluation period,number to output on>
ISO/IEC 16022 Symbol Quality Output 3
Note: Output On under Output 3 Parameters must be set to Symbol Quality for this
output to function.
Serial Cmd:
<K802,output on symbol contrast,symbol contrast threshold,output on print
growth,print growth threshold,output on axial non-uniformity,axial non-uniformity
threshold,output on UEC,UEC threshold>
Diagnostics Output 3
Note: Output On under Output 3 Parameters must be set to Diagnostic Warning for
this output to function.
Serial Cmd:
7-32
<K792,unused 1,service unit>
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Power On/Reset Counts
Note: Power On/Reset Counts is a read-only command.
Power-On
Serial Cmd:
<K406,power-on,resets,power-on saves,power-on flash saves>
Power-On uses a 16-bit counter that increments each time the imager is powered-on.
Resets
Serial Cmd:
<K406,power-on,resets,power-on saves,power-on flash saves>
Resets uses a 16-bit counter that increments each time the imager is reset. This value is
reset at power-on.
Power-On Saves
Serial Cmd:
<K406,power-on,resets,power-on saves,power-on flash saves>
Power-On Saves uses a 16-bit counter that increments each time an imager setting is
saved for power-on with a <Z> command.
Power-On Flash Saves
Serial Cmd:
<K406,power-on,resets,power-on saves,power-on flash saves>
Power-On Flash Saves uses a 16-bit counter that increments each time an imager setting
is saved to the customer parameter section of flash memory with a <Zc> command.
MINI Hawk Xi High Performance Imager User Manual
7-33
Time Since Reset
Time Since Reset
Note: Time Since Reset is a read-only command.
Hours
Serial Cmd:
Default:
<K407,hours,minutes>
16-bit counter (0 to 65535)
Hours uses a 16-bit counter that increments every 60 minutes.
Minutes
Serial Cmd:
Default:
<K407,hours,minutes>
16-bit counter (0 to 60)
Minutes uses a 16-bit counter that increments every 60 seconds.
Note: Time counts are reset at power-on, but not with an <A> or <Z> command.
7-34
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Service Message
When Service Message is enabled, a message of up to 10 ASCII characters is sent
whenever the system detects that the service timer’s limit has been reached. The service
timer is reset at power-on, meaning that the service timer’s limit is the amount of time
since last reset. Service timer increments can be set in seconds or minutes.
Serial Cmd:
Default:
Options:
<K409,status,service message,threshold,resolution>
0
0 = Disabled
1 = Enabled
Service Message
Serial Cmd:
Default:
Options:
<K409,status,service message,threshold,resolution>
SERVICE
An ASCII string between 1 and 10 characters.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K409h,,3C>
For >: <K409h,,3E>
For , : <K409h,,2C>
Threshold
Serial Cmd:
Default:
Options:
<K409,status,service message,threshold,resolution>
300 (5 minutes)
1 to 65535
Resolution
Serial Cmd:
Default:
Options:
<K409,status,service message,threshold,resolution>
Seconds
0 = Seconds
1 = Minutes
MINI Hawk Xi High Performance Imager User Manual
7-35
Frame Information
Frame Information
Output Frame Number
Serial Cmd: <K734,output frame number,output coordinates>
Default:
Disabled
Options:
0 = Disabled
1 = Enabled
Disabled
When Output Frame Number is set to Disabled, the frame number is not output as part
of the symbol data.
Enabled
When Output Frame Number is set to Enabled, the number of the frame in which the
symbol was first decoded is attached to the symbol output information. The output format
is “Fnnn”, where “nnn” is a 3-digit decimal value from 0 to 255. The frame number rolls
over to 0 once it passes 255.
If this feature is enabled, the frame information will follow the symbol data, and it will precede
any symbol quality data (if symbol quality settings are enabled—see Symbol Quality
Separator). The symbol quality separator is located between the end of the already-formatted data and the “F” that precedes the frame number.
Output Coordinates
Serial Cmd: <K734,output frame number,output coordinates>
Default:
Disabled
Options:
0 = Disabled
1 = Enabled
Disabled
When Output Coordinates is set to Disabled, the coordinates are not output as part of
the symbol data.
Enabled
When Output Coordinates is set to Enabled, the four sets of object coordinates for the
first successfully decoded symbol are attached to the symbol data output in the following
format:
“(nnn,mmm)”, where “nnn” is a 3-digit X-coordinate and “mmm” is a 3-digit Y-coordinate.
The validation separator is located between the end of the already formatted data and the
first coordinate point. The point with the lowest X + Y sum will be output first, followed by
the next three points in a clockwise direction.
Example:
(032,040)(287,056)(287,279)(048,271)
7-36
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Image Output
Usage:
Definition:
Serial Cmd:
Default:
Options:
This feature allows the user to select what read cycle condition triggers the
image file output.
Used to output an image file when a specified read cycle condition has been met,
such as No Read or Good Read. When the read cycle is complete, the normal
read cycle output will occur, including any configured postamble or preamble
data. The read cycle will the check if image output is enabled, and if the specified
read cycle condition has been met. If both these conditions are true, the image
file will be output to the user-specified communication port in the user-specified
image file format.
<K739,image output mode,communication port,file format,JPEG quality>
Disabled
0 = Disabled
1 = Good Read
2 = No Read
3 = No Read or Good Read
4 = Mismatch
Good Read
If a Good Read condition is met during the read cycle, the image file corresponding with
the first Good Read will be output. The image file will immediately follow the read cycle
output and postambles. For a Good Read condition to occur, all symbols in the read cycle
must qualify.
No Read
If a No Read condition occurs during the read cycle, the image file corresponding with the
first No Read will output. The image file will immediately follow the read cycle output and
postambles. There are conditions in which the read cycle may have a No Read condition
but the image will not be output. For example, if the read cycle is looking for two No Read
symbols in the same image capture but one is a Good Read, the image will not be output,
because it is not considered a No Read image.
No Read or Good Read
If a No Read condition or a Good Read condition occurs, the first image of either kind will
be output.
Mismatch
If a Good Read occurs during the read cycle but the image is a Mismatch condition, the
first Mismatch image will be output.
MINI Hawk Xi High Performance Imager User Manual
7-37
Image Output
Communication Port
Definition:
Serial Cmd:
Default:
Options:
This setting selects the communication port through which the image file
will be transferred to the host.
<K739,image output mode,communication port,file format,JPEG quality>
Host
0 = Host
1 = TCP Port 1
2 = TCP Port 2
File Format
Definition:
Serial Cmd:
Default:
Options:
This setting selects the format of the image file to be output.
Note: If JPEG is the chosen image file format, the resolution of the image
will be determined by the setting in the JPEG Quality field.
<K739,image output mode,communication port,file format,JPEG quality>
JPEG
0 = Bitmap
1 = JPEG
2 = Binary
JPEG Quality
Definition:
Serial Cmd:
Default:
Options:
7-38
This setting determines the quality of JPEG image compression. The user
may select a value from 1 (lowest) to 100 (highest).
<K739,image output mode,communication port,file format,JPEG quality>
90
1 to 100 (percent)
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Image Output Example
The following example assumes that the imager is set to output on No Read, and that it is
in a rapid capture mode of 3 captures.
Number of Symbols:
Frame # 1:
Frame # 2:
Frame # 3:
Read Cycle Result:
Output Frame:
1
No Read
No Read
No Read
No Read
Frame # 1
Number of Symbols:
Frame # 1:
Frame # 2:
Frame # 3:
Read Cycle Result:
Output Frame:
1
No Read
No Read
Good Read
Good Read
None
Number of Symbols:
Frame # 1:
Frame # 2:
Frame # 3:
Read Cycle Result:
Output Frame:
2
No Read
No Read
Good Read, Symbol # 1
No Read
Frame # 1
MINI Hawk Xi High Performance Imager User Manual
7-39
Database Identifier Output
Database Identifier Output
Usage:
Serial Cmd:
Default:
Options:
Useful in keeping track of which database entries read which symbols.
<K759,status,separator>
0
0 = Disabled
1 = Enabled
Output Status
Disabled
When this command is disabled, no database identifier information will be output.
Enabled
When this command is enabled, the imager will append a two-digit number and the characters
“DB” to the data output following the separator for each symbol decoded using Configuration
Database. For example, if the separator is an underscore character and the second database
entry reads a symbol encoded with “data capture” during the read cycle, the symbol data
output will be “data capture_DB02”. If the database is not active, no identifiers will be
attached to output.
Separator
Usage:
Serial Cmd:
Default:
Options:
The separator character separates the symbol data from the database identifier.
<K759,status,separator>
<space>
Any ASCII character.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K759h,,3C>
For >: <K759h,,3E>
For , : <K759h,,2C>
7-40
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Quality Output
Separator
Definition:
Serial Cmd:
Default:
Options:
The separator character separates quality output data from symbol data.
<K704,separator,decodes per trigger status>
,
Any ASCII character.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K704h,3C>
For >: <K704h,3E>
For , : <K704h,2C>
Decodes per Trigger Status
Definition:
Serial Cmd:
Default:
Options:
When this feature is enabled, the imager enters a state where it processes
frames as configured until the end of a read cycle, with or without a successful
symbol decode. When the read cycle ends, the imager outputs any
decoded symbol data along with the decodes per trigger count.
<K704,separator,decodes per trigger status>
0
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
7-41
Configuring EZ Trax Output
Configuring EZ Trax Output
After you have set up your imager for EZ Trax, you can configure the software in three
different ways: using the EZ Trax interface, using the tree controls in ESP, and using serial
commands.
For detailed information about how to use the EZ Trax user interface for configuration,
refer to the Help menu in EZ Trax software, or the EZ Trax Quick Start Guide, available on the
Microscan Tools Drive.
Configuring EZ Trax Output by ESP
To configure EZ Trax using ESP, first click the I/O tab in App Mode to display the I/O
Parameters tree control.
7-42
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
EZ Trax Output
When EZ Trax output is
enabled, the imager will attempt
to output all enabled EZ Trax
options. EZ Trax will not function
unless enabled.
Comm Port
Selects the communication port
that will be used to transfer
image files.
Image Mode
Determines which
read cycle condition
triggers image file
output.
Image Format
Selects the format of the image
output file.
MINI Hawk Xi High Performance Imager User Manual
7-43
Configuring EZ Trax Output
JPEG Quality
Sets the amount of JPEG image
compression. A value of 1 represents
the highest compression and lowest
image quality, and 100 represents
the lowest compression and highest
image quality.
Object Info Output
If a symbol is decoded during
an image capture, the symbol
type and other supplementary
symbol information is also
included.
Grade Output
Symbol quality information
will be output in the form of an
abbreviated identifier for each
read cycle.
7-44
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Configuring EZ Trax Output by Serial Command
Usage:
Definition:
Serial Cmd:
Default:
Options:
Useful for when you want to configure EZ Trax output using serial commands
instead of the EZ Trax graphic interface.
When EZ Trax output is enabled, the imager will attempt to output all
enabled EZ Trax options. EZ Trax will not function unless enabled.
<K757,status,comm port,image mode,image format,JPEG quality,object info
output, grade output>
Disabled
0 = Disabled
1 = Enabled
Comm Port
Definition:
Serial Cmd:
Default:
Options:
Selects the communication port that will be used to transfer image files.
<K757,status,comm port,image mode,image format,JPEG quality,object info
output, grade output>
Host
0 = Host
1 = TCP Port 1
2 = TCP Port 2
Host Port
Sends output using the current Host Port.
Image Mode
Definition:
Serial Cmd:
Default:
Options:
Determines which read cycle condition triggers image file output.
<K757,status,comm port,image mode,image format,JPEG quality,object
info output, grade output>
Disabled
0 = Disabled
1 = Good Read
2 = No Read
3 = No Read and Good Read
4 = Mismatch
Good Read
Outputs the first Good Read image in the read cycle. The image file will immediately follow
the symbol data.
MINI Hawk Xi High Performance Imager User Manual
7-45
Configuring EZ Trax Output
No Read
Outputs the first No Read image in the read cycle. The image file will immediately follow
the symbol data.
Note: If two symbols are present in the same image capture and one of them is successfully
decoded, no image will be output.
No Read and Good Read
Outputs the first No Read or Good Read image in the read cycle.
Mismatch
Outputs the image of the first mismatch condition.
Image Format
Definition:
Serial Cmd:
Default:
Options:
Selects the format of the image output file.
<K757,status,comm port,image mode,image format,JPEG quality,object info
output, grade output>
Compressed
0 = Lossless
1 = Compressed
Lossless
A “lossless” image is one that is in a high resolution format, and that will not lose resolution
even when manipulated and saved multiple times. When Lossless is enabled, the JPEG
Quality setting has no effect.
Compressed
Outputs the image in JPEG format. Image quality is determined by the JPEG Quality
setting.
JPEG Quality
Definition:
Serial Cmd:
Default:
Options:
7-46
Sets the amount of JPEG image compression. A value of 1 represents the
highest compression and lowest image quality, and 100 represents the
lowest compression and highest image quality.
<K757,status,comm port,image mode,image format,JPEG quality,object info
output, grade output>
90
1 to 100 (percent)
MINI Hawk Xi High Performance Imager User Manual
I/O Parameters
Object Info Output
Definition:
Serial Cmd:
Default:
Options:
If a symbol is decoded during an image capture, the symbol type and other
supplementary symbol information is also included.
<K757,comm port,image mode,image format,JPEG quality,object info output,
grade output>
Disabled
0 = Disabled
1 = Enabled
Grade Output
Definition:
Serial Cmd:
Default:
Options:
Symbol quality information will be output in the form of an abbreviated
identifier for each read cycle.
<K757,comm port,image mode,image format,JPEG quality,object info output,
grade output>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
7-47
Configuring EZ Trax Output
7-48
MINI Hawk Xi High Performance Imager User Manual
8 Symbol Quality
Contents
Symbol Quality by ESP................................................................................................................. 8-2
Symbol Quality Serial Commands ................................................................................................ 8-3
Overview of Symbol Quality.......................................................................................................... 8-4
Symbol Quality Separator/Data Matrix Output Mode.................................................................... 8-8
ISO/IEC 16022 Symbol Quality Output....................................................................................... 8-10
ISO/IEC 16022 Symbol Quality Output by ESP.......................................................................... 8-12
Microscan Symbol Quality Output .............................................................................................. 8-13
Microscan Symbol Quality Output by ESP ................................................................................. 8-16
This section describes parameters that, when enabled, will output detailed symbol quality
evaluations.
MINI Hawk Xi High Performance Imager User Manual
8-1
Symbol Quality by ESP
Symbol Quality by ESP
Click the Parameters
button and then the
Symbol Quality tab.
To open nested options,
single-click the +.
8-2
To change a setting, double-click
the setting and use your cursor to
scroll through the options.
MINI Hawk Xi High Performance Imager User Manual
Symbol Quality
Symbol Quality Serial Commands
Symbol Quality Separator/ Data
Matrix Output Mode
ISO/IEC 16022 Symbol Quality
Output
Microscan Symbol Quality Output
Static Validation Report
<K708,symbol quality separator,data matrix output mode>
<K709,symbol contrast,print growth,axial non-uniformity,
unused ECC>
<K710,percent cell damage,total read time,capture
time,locate time,decode time,pixels per element,ECC
level,matrix size,quiet zone,symbol angle>
<VAL>
MINI Hawk Xi High Performance Imager User Manual
8-3
Overview of Symbol Quality
Overview of Symbol Quality
Information about symbol quality and timing can be appended to symbol data by enabling
specific evaluation parameters. The order in which these values are appended corresponds
directly to the order in which they appear in ESP‘s Symbol Quality tree control.
Symbol Quality parameters are separated into ISO/IEC 16022 Symbol Quality Output and
Microscan Symbol Quality Output.
Total Read Time, Symbol Quality Separator, and Output Mode are common to both
ISO/IEC 16022 and Microscan Grading Parameters.
The enabled Symbol
Quality parameters are
appended to symbol data
output in the order that they
appear in the tree control.
If you enable the outputs shown above, they will be returned
in this order:
Symbol
Data
Locate Time
(Microscan Grading)
Symbol Contrast
(ISO/IEC 16022)
Decode Time
(Microscan Grading)
0123456789abcdefghijklmnopqrstuv 256 A 30 210 3 17
Total
Read Time
Pixels Per Element
(Microscan Grading)
Capture Time
(Microscan Grading)
8-4
MINI Hawk Xi High Performance Imager User Manual
Symbol Quality
Report Tab
The Report tab allows the user to initiate Data Matrix Grading and to generate and save
grading reports.
To save the report as a PDF file, an HTML file, a CSV file, or an RTF file, click the Save
Report button.
Reports appear in the viewing area underneath the Data Matrix Grading and Save
Report buttons.
The Symbol Quality
interface is divided
into three sections:
Report, Locate, and
Preferences.
The imager’s field of view is shown here.
When grading is completed, the initial
report is also shown in this viewing area.
MINI Hawk Xi High Performance Imager User Manual
8-5
Overview of Symbol Quality
Locate Tab
The Locate tab allows the user to determine the position of the symbol within the imager’s
field of view, and to optimize the imager’s camera settings for symbol quality evaluation.
Click the Locate
button to display the
symbol in the
imager’s field of view.
8-6
Click the Calibrate
button to optimize
camera settings.
MINI Hawk Xi High Performance Imager User Manual
Symbol Quality
Preferences Tab
The Preferences tab allows the user to set defaults that are automatically activated when
grading is completed. For this reason, the user is advised to set preferences before performing
grading.
This information is
appended at the
bottom of the report.
Choose the default report type to be generated when you click Save Report on the Report tab.
Check Autofit Content to ensure that saved PDF report content will fit on a single page.
Typically you will be asked
where you wish to store
your report.
If you do not want to be
prompted to choose a file
path, click Store Report
without file path prompt.
Click the Include Image
check box to output the
captured symbol image
with your saved report as a
Bitmap or JPEG image file.
Enables ESP to parse UII
symbol data into the correct
fields and output order defined
by the U.S. Department of
Defense IUID initiative.
Returns all settings to
default.
Returns all settings to
most recent.
MINI Hawk Xi High Performance Imager User Manual
8-7
Symbol Quality Separator/Data Matrix Output Mode
Symbol Quality Separator/Data Matrix Output Mode
Symbol Quality Separator applies to both Symbol Quality groups: ISO/IEC 16022 Symbol
Quality Output and Microscan Symbol Quality Output.
Symbol Quality Separator
Definition:
Serial Cmd:
Default:
Options:
Inserts a separator between each enabled field of the symbol quality output.
<K708,symbol quality separator,output mode>
<SP> (space character)
Any ASCII character.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K708h,3C>
For >: <K708h,3E>
For , : <K708h,2C>
Symbol Quality Separator by ESP
When you double-click on the
default separator SP, the Symbol
Quality Separator Calculator
appears. Use the calculator keypad
for one-click separator configuration.
8-8
MINI Hawk Xi High Performance Imager User Manual
Symbol Quality
Data Matrix Output Mode
Note: Output Mode applies to ISO/IEC 16022 symbol quality parameters.
Definition:
Serial Cmd:
Default:
Options:
Output Mode specifies how the four output parameters, if enabled, are
formatted.
<K708,symbol quality separator,output mode>
Grade
0 = Grade
1 = Value
Grade
If in Grade Mode, a grade (A,B,C,D) is appended to the symbol data.
Value
If in Value Mode, the calculated value for the given parameter is appended to the symbol
data.
MINI Hawk Xi High Performance Imager User Manual
8-9
ISO/IEC 16022 Symbol Quality Output
ISO/IEC 16022 Symbol Quality Output
Symbol Quality Parameters for Data Matrix symbols specified by ISO/IEC 16022.
Symbol Contrast
Usage:
Definition:
Serial Cmd:
Default:
Options:
Lets the user know if contrast settings are less than acceptable.
All the pixels that fall within the area of the test symbol, including its
required zone, will be sorted by their reflectance values to select the
darkest 10% and the lightest 10% of the pixels. The arithmetic mean of
the darkest and the lightest pixels is calculated and the difference of the
two means is the Symbol Contrast.
(ANSI) Symbol Contrast grading is defined this way:
A (4.0) if SC > 70%
B (3.0) if SC > 55%
C (2.0) if SC > 40%
D (1.0) if SC > 20%
F (0.0) if SC < 20%
If enabled, the symbol contrast is appended to the symbol data according
to the ISO/IEC 16022 Symbol Quality Output Mode setting.
<K709,symbol contrast,print growth,axial non-uniformity,UEC>
Disabled
0 = Disabled
1 = Enabled
Print Growth
Definition:
Serial Cmd:
Default:
Options:
8-10
The extent to which dark or light markings appropriately fill or exceed
their module boundaries. These values are determined by counting pixels
in the clock pattern of the binary digitized image, then comparing it to a
nominal value and minimum and maximum values. The print growth
grade is defined in this way:
A (4.0) if -.050 < PG < 0.50
B (3.0) if -.070 < PG < 0.70
C (2.0) if -.085 < PG < 0.85
D (1.0) if -.10 < PG < 1.00
F (0.0) if PG < -1.00 or PG > 1.00
If enabled, the print growth is appended to the symbol data according to
the ISO/IEC 16022 Symbol Quality Output Mode setting.
<K709,symbol contrast,print growth,axial non-uniformity,UEC>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
Symbol Quality
Axial Non-Uniformity (Data Matrix Only)
Definition:
Serial Cmd:
Default:
Options:
Axial non-uniformity is a measure of how much the sampling point
spacing differs from one axis to another, namely AN = abs (XAVG YAVG) / ((XAVG + YAVG)/2) where abs () yields the absolute value. If a
symbology has more than two major axes, then AN is computed for those
two average spacings which differ the most. (ANSI) axial non-uniformity
grading is defined this way:
A (4.0) if AN < .06
B (2.0) if AN < .08
C (2.0) if AN < .10
D (1.0) if AN < .12
F (0.0) if AN > .12
If enabled, the axial non-uniformity is appended to the symbol data
according the ISO/IEC 16022 Symbol Quality Output Mode setting.
<K709,symbol contrast,print growth,axial non-uniformity,UEC>
Disabled
0 = Disabled
1 = Enabled
Unused Error Correction (Data Matrix Only)
Definition:
Serial Cmd:
Default:
Options:
The correction capacity of Reed-Solomon decoding is expressed in the
equation: e + 2d < d - p, where e is the number of erasures, d is the number
of error correction code words, and p is the number of code words reserved
for error detection.
A (4.0) if UEC > .62
B (3.0) if UEC > .50
C (2.0) if UEC > .37
D (1.0) if UEC > .25
F (0.0) if UEC < .25
If enabled, the UEC is appended to the symbol data according to the
ISO/IEC 16022 Symbol Quality Output Mode setting.
<K709,symbol contrast,print growth,axial non-uniformity,UEC>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
8-11
ISO/IEC 16022 Symbol Quality Output by ESP
ISO/IEC 16022 Symbol Quality Output by ESP
ESP’s Symbol Quality interface allows you to evaluate Data Matrix symbols for compliance
with ISO/IEC 16022 requirements.
First, determine which ISO/IEC 16022 Parameters you need to evaluate, using the Symbol
Quality tree control.
Once you have set these Data Matrix evaluation parameters, go to the Preferences Tab
and set your Data Matrix Grading Report output preferences.
After your output preferences are set, click the Data Matrix Grading button.
There will be a wait of a few seconds, and then the evaluation results will appear in the
Symbol Quality view, in a format similar to the one shown below.
If you want to view the results in a report format, click the Save Report button. The report
will be output in the format you chose in the Preferences dialog.
8-12
MINI Hawk Xi High Performance Imager User Manual
Symbol Quality
Microscan Symbol Quality Output
Percent Cell Damage (Data Matrix Only)
Definition:
Serial Cmd:
Default:
Options:
When this feature is enabled, the cell damage percentage is appended to
data output.
<K710,percent cell damage,total read time,capture time,locate
time,decode time,pixels per element,ECC level,matrix size,quiet
zone,symbol angle>
Disabled
0 = Disabled
1 = Enabled
Total Read Time
Definition:
Serial Cmd:
Default:
Options:
The time that transpires between the image capture and the output of the
decoded data, including locate time.
When enabled, the total read time is appended to the symbol data.
<K710,percent cell damage,total read timea,capture time,locate
time,decode time,pixels per element,ECC level,matrix size,quiet
zone,symbol angle>
Disabled
0 = Disabled
1 = Enabled
a. Total Read Time applies globally to all three Symbol Quality standards.
Capture Time
Definition:
Serial Cmd:
Default:
Options:
Capture time (in milliseconds) is a fixed “overhead” that includes the time
of capture and transfer of the image.
When enabled, the capture time is appended to the symbol data.
<K710,percent cell damage,total read time,capture time,locate
time,decode time,pixels per element,ECC level,matrix size,quiet
zone,symbol angle>
Disabled
0 = Disabled
1 = Enabled
Locate Time
Definition:
Serial Cmd:
Default:
Options:
The time in milliseconds from the start of image processing until the
symbol has been located and is ready to be decoded.
When enabled, the locate time is appended to the symbol data.
<K710,percent cell damage,total read time,capture time,locate
time,decode time,pixels per element,ECC level,matrix size,quiet
zone,symbol angle>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
8-13
Microscan Symbol Quality Output
Decode Time
Definition:
Serial Cmd:
Default:
Options:
The time in milliseconds required to decode a symbol.
When enabled, the decode time is appended to the symbol data.
<K710,percent cell damage,total read time,capture time,locate
time,decode time,pixels per element,ECC level,matrix size,quiet
zone,symbol angle>
Disabled
0 = Disabled
1 = Enabled
Pixels Per Element (Data Matrix Only)
Definition:
Serial Cmd:
Default:
Options:
The number of pixels for each element, either dark or light for both x and
y directions.
When enabled, the pixels per element value is appended to the symbol
data.
<K710,percent cell damage,total read time,capture time,locate
time,decode time,pixels per element,ECC level,matrix size,quiet
zone,symbol angle>
Disabled
0 = Disabled
1 = Enabled
Error Correction Level (Data Matrix Only)
Definition:
Serial Cmd:
Default:
Options:
Outputs the Data Matrix ECC level.
When enabled, the ECC level is appended to the symbol data.
<K710,percent cell damage,total read time,capture time,locate
time,decode time,pixels per element,ECC level,matrix size,quiet
zone,symbol angle>
Disabled
0 = Disabled
1 = Enabled
Matrix Size (Data Matrix Only)
Definition:
Serial Cmd:
Default:
Options:
8-14
Defines the symbol matrix size, in number of pixels in both the x and y
axis.
When enabled, the matrix size value is appended to the symbol data.
<K710,percent cell damage,total read time,capture time,locate
time,decode time,pixels per element,ECC level,matrix size,quiet
zone,symbol angle>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
Symbol Quality
Quiet Zone (Data Matrix Only)
Definition:
Serial Cmd:
Default:
Options:
When this feature is enabled, the size of the quiet zone is evaluated and
a PASS or FAIL message is appended to the symbol data.
<K710,percent cell damage,total read time,capture time,locate
time,decode time,pixels per element,ECC level,matrix size,quiet
zone,symbol angle>
Disabled
0 = Disabled
1 = Enabled
Symbol Angle (Data Matrix Only)
Definition:
Serial Cmd:
Default:
Options:
When this feature is enabled, the symbol orientation is appended to
data output as a degree value representing the angle of the Data Matrix
symbol’s L-shaped finder pattern relative to the imager.
<K710,percent cell damage,total read time,capture time,locate
time,decode time,pixels per element,ECC level,matrix size,quiet
zone,symbol angle>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
8-15
Microscan Symbol Quality Output by ESP
Microscan Symbol Quality Output by ESP
ESP’s Symbol Quality interface allows you to evaluate Data Matrix symbols for compliance
with a rigorous set of standards, such as Locate Time, Capture Time, and Decode Time.
First, determine which parameters you want to evaluate, using the Symbol Quality tree control.
Once you have set these Data Matrix evaluation parameters, go to the Preferences Tab
and set your Data Matrix Grading Report output preferences.
After your output preferences are set, click the Data Matrix Grading button.
There will be a wait of a few seconds, and then the evaluation results will appear in the
Symbol Quality view, in a format similar to the one shown below.
If you want to view the results in a report format, click the Save Report button. The report
will be output in the format you chose in the Preferences dialog.
8-16
MINI Hawk Xi High Performance Imager User Manual
9 Matchcode
Contents
Matchcode by ESP ....................................................................................................................... 9-2
Matchcode Serial Commands ...................................................................................................... 9-3
Overview of Matchcode ................................................................................................................ 9-4
Matchcode Type ........................................................................................................................... 9-5
Match Replace............................................................................................................................ 9-10
Mismatch Replace ...................................................................................................................... 9-11
New Master Pin .......................................................................................................................... 9-12
This section explains the MINI Hawk Xi’s matchcode output functions and the master
symbol database setup.
MINI Hawk Xi High Performance Imager User Manual
9-1
Matchcode by ESP
Matchcode by ESP
Click the Parameters
button and then the
Matchcode tab.
To open nested options,
single-click the +.
9-2
To change a setting,
double-click the
setting and use your
cursor to scroll
through the options.
MINI Hawk Xi High Performance Imager User Manual
Matchcode
Matchcode Serial Commands
Matchcode Type
Number of Master Symbols
New Master Pin
Enter Master Symbol Data
Request Master Symbol Data
Delete Master Symbol Data
Match Replace
Mismatch Replace
<K223,matchcode type,sequential matching,match start
position,match length,wild card character,sequence on
No Read,sequence on mismatch>
<K224,number of master symbols>
<K225,status>
<K231,master symbol number,master symbol data>
<K231?,>[for all] or <K231?,master symbol number>
<K231,master symbol number,>
<K735,status,match replacement string>
<K736,status,mismatch replacement string>
MINI Hawk Xi High Performance Imager User Manual
9-3
Overview of Matchcode
Overview of Matchcode
Definition:
Usage:
Matchcode allows the user to store master symbol data in the imager’s
memory, compare that data against other symbol data, and define how
symbol data and/or discrete signal output will be directed.
A master symbol database can be set up for up to 10 master symbols.
Note: Matchcode will function with multiple symbols; however, if Matchcode
Type is set to Sequential or if Triggering 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.
Matchcode is used in applications to sort, route, or verify data based on
matching the specific symbol in a variety of ways as defined in this section.
For example, a manufacturer might sort a product based on dates that
are embedded in the symbol.
Steps for Entering and Using Master Symbols
1. Set Triggering Mode to External or Serial.
2. Choose the method of symbol comparison that fits your application.
3. Define the output you want to achieve with your matchcode setup:
a. Symbol data output
b. Discrete output
4. Select the number of master symbols you want to create.
5. Decide which of 4 ways you want to enter your master symbol(s):
a. Use ESP to type master symbol data directly.
b. Send a serial command with symbol data in the form of <M231,master symbol#,
data>.
c. Send a <G> (Read Next Symbol as Master Symbol) command.
d. Enable the New Master Pin command and activate the discrete input to store the
next symbol read as the master symbol.
9-4
MINI Hawk Xi High Performance Imager User Manual
Matchcode
Matchcode Type
Definition:
Allows the user to choose the way that master symbols will be compared
with subsequently read symbols.
Note: First set Triggering Mode to External or Serial.
ESP:
Serial Cmd:
Default:
Options:
Disabled:
Enabled:
Wild Card:
Sequential:
<K223,matchcode type,sequential matching,match start position,
match length,wild card character,sequence on No Read,sequence on
mismatch>
Disabled
0 = Disabled
1 = Enabled
2 = Wild Card
3 = Sequential
Has no effect on operations.
Instructs the imager to compare symbols or portions of symbols with the
master symbol.
Allows the user to enter user-defined wild card characters in the master
symbol.
Instructs the imager to sequence after each match (numeric only) and
compare symbols or portions of symbols for sequential numbers.
Note: If Matchcode Type is set to Sequential, the imager will behave
as if Number of Symbols were set to 1, regardless of the user-defined
configuration.
MINI Hawk Xi High Performance Imager User Manual
9-5
Matchcode Type
Sequential Matching
Usage:
Definition:
Serial Cmd:
Default:
Options:
Useful in tracking product serial numbers that increment or decrement
sequentially.
With Sequential enabled, Sequential Matching determines if a count is in
ascending (incremental) or descending (decremental) order.
<K223,matchcode type,sequential matching,match start position,match
length,wild card character,sequence on No Read,sequence on mismatch>
Increment
0 = Increment
1 = Decrement
Match Start Position
Usage:
Match Start Position is useful in defining specific portions of a symbol
for comparison. For example, if a symbol contains a part number, manufacturing
date, and lot code info, but you are only interested in the part number
information, you can set the imager to sort only the part number and
ignore the other characters.
Definition:
Match Start Position determines the portions of symbols that will be
matched by defining the first character in the symbol (from left to right)
that will be compared with those of the master symbol, when Matchcode
Type is set to Enabled or Sequential.
Function:
For example, if Match Start Position is set to 3, the first 2 characters
read in the symbol will be ignored and only the 3rd and subsequent
characters to the right will be compared, up to the number of characters
specified by Match Length.
Serial Cmd:
<K223,matchcode type,sequential matching,match start position,
match length,wild card character,sequence on No Read,sequence on
mismatch>
Default:
0
Options:
0 to 3000
Note: Match Start Position must be set to 1 or greater to enable this feature. A 0 setting
will disable this feature.
Match Length
Usage:
Definition:
Serial Cmd:
Default:
Options:
9-6
Example: If Match Length is set to 6 in a 10-character symbol, and
Match Start Position is set to 2, only the 2nd through 7th characters
(from left to right) will be compared.
Defines the length of the character string that will be compared with that
of the master symbol when Match Start Position is set to 1 or greater.
When Match Start Position is set to 0, no comparison will occur.
<K223,matchcode type,sequential matching,match start position,match
length,wild card character,sequence on No Read,sequence on mismatch>
1
1 to 3000
MINI Hawk Xi High Performance Imager User Manual
Matchcode
Wild Card Character
Usage:
Definition:
Serial Cmd:
Default:
Options:
Example: With Wild Card Character defined as the default asterisk,
defining CR*34 as the master symbol will result in matches for CR134
and CR234, but not CR2345. Entering URGENT** as your master symbol
will result in matches for URGENT, URGENT1, and URGENT12 but not
for URGENT123. This means any wild cards appended to the master
symbol data will result in matches of symbols in variable lengths up to the
master symbol lengths but not over. However, wild cards in the beginning
or center of a symbol (e.g., UR**NT) do not allow for variable symbol lengths.
Wild Card Character allows a user to define a wild card character as part
of the master symbol.
<K223,matchcode type,sequential matching,match start position,match
length,wild card character,sequence on No Read,sequence on mismatch>
* (asterisk)
Any ASCII character.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K223h,,,,,3C>
For >: <K223h,,,,,3E>
For , : <K223h,,,,,2C>
MINI Hawk Xi High Performance Imager User Manual
9-7
Matchcode Type
Sequence on No Read
Usage:
Definition:
Serial Cmd:
Default:
Options:
Sequence on No Read is useful when the imager needs to stay in
sequence even if no decode occurs.
When Sequence on No Read is Enabled and Matchcode is set to
Sequential, the imager sequences the master symbol on every match or
No Read. When disabled, it does not sequence on a No Read.
<K223,matchcode type,sequential matching,match start position,match
length,wild card character,sequence on No Read,sequence on mismatch>
Enabled
0 = Disabled
1 = Enabled
As an example of Sequence on No Read Enabled, consider the following decodes:
Master Symbol
001
002
003
004
005
006
007
Decoded Symbol
001
002
No Read
004
No Read
No Read
007
Master Symbol after Decode
002
003
004 (sequenced on No Read)
005
006 (sequenced on No Read)
007 (sequenced on No Read)
008
As an example of Sequence on No Read Disabled, consider the following series of
decodes:
Master Symbol
001
002
003
003
004
004
004
9-8
Decoded Symbol
001
002
No Read
003
No Read
No Read
004
Master Symbol after Decode
002
003
003 (not sequenced)
004
004 (not sequenced)
004 (not sequenced)
005
MINI Hawk Xi High Performance Imager User Manual
Matchcode
Sequence on Mismatch
Note: Matchcode must be set to Sequential for this command to function.
Usage:
Definition:
Serial Cmd:
Default:
Options:
Enable this parameter if every trigger event should have a decode and
more than one consecutive mismatch may occur.
Disable this parameter if every trigger event should have a decode but
no more than one consecutive mismatch may occur.
When set to Enabled, the master symbol sequences on every decode,
match, or mismatch.
When set to Disabled, the master symbol will not sequence whenever
consecutive mismatches occur.
<K223,matchcode type,sequential matching,match start position,match
length,wild card character,sequence on No Read,sequence on mismatch>
Disabled
0 = Disabled
1 = Enabled
The imager will sequence the master to one more or one less than the decoded symbol.
As an example of Sequence on Mismatch Enabled, consider the following decodes:
Master Symbol
001
002
003
004
005
006
007
Decoded Symbol
001
002
abc
004
def
ghi
007
Master Symbol after Decode
002
003
004 (sequenced on mismatch)
005
006 (sequenced on mismatch)
007 (sequenced on mismatch)
008
As an example of Sequence on Mismatch Disabled, consider the following decodes:
Master Symbol
001
002
003
004
005
006
006
Decoded Symbol
001
002
abc
004
def
ghi
006
MINI Hawk Xi High Performance Imager User Manual
Master Symbol after Decode
002
003
004 (sequenced because of previous match)
005
006 (sequenced because of previous match)
006 (not sequenced)
007
9-9
Match Replace
Match Replace
Usage:
Definition:
Serial Cmd:
Default:
Options:
Provides a convenient shortcut for applications that need to output a
predefined text string whenever a symbol matches a master symbol.
Outputs a user-defined data string whenever a match occurs and
Matchcode is enabled.
<K735,status,replacement string>
Disabled
0 = Disabled
1 = Enabled
Replacement String
Definition:
Serial Cmd:
Default:
Options:
User-defined data string that, when enabled, replaces symbol data
whenever a match occurs.
<K735,status,replacement string>
MATCH
An ASCII string up to 64 characters.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K735h,,3C>
For >: <K735h,,3E>
For , : <K735h,,2C>
9-10
MINI Hawk Xi High Performance Imager User Manual
Matchcode
Mismatch Replace
Usage:
Definition:
Serial Cmd:
Default:
Options:
Provides a convenient shortcut for applications that need to output a
predefined text string whenever a symbol does not match a master
symbol.
Outputs a user-defined data string whenever a mismatch occurs and
Matchcode is enabled.
<K736,status,replacement string>
Disabled
0 = Disabled
1 = Enabled
Replacement String
Definition:
Serial Cmd:
Default:
Options:
User-defined data string that, when enabled, replaces symbol data
whenever a mismatch occurs.
<K736,status,replacement string>
MISMATCH
An ASCII string up to 64 characters.
Important: The ASCII characters <, >, and , can only be entered as hex pairs:
For <: <K736h,,3C>
For >: <K736h,,3E>
For , : <K736h,,2C>
MINI Hawk Xi High Performance Imager User Manual
9-11
New Master Pin
New Master Pin
Definition:
Serial Cmd:
Default:
Options:
If Matchcode and New Master Pin are enabled and the new master pin
is momentarily connected to ground (must be held low for a minimum of
10 ms) master symbol information will be loaded into the database based
on the next read cycle that achieves a Good Read, starting with Index 1.
The Master Symbol Database will be loaded with all symbols decoded
in the read cycle as long as it does not exceed the Number of Master
Symbols parameter.
<K225,status>
Disabled
0 = Disabled
1 = Enabled
New Master Load Status
Definition:
Serial Cmd:
9-12
The new master status responds with the number of the next master
position to be loaded, where 0 represents “idle” or “no master to be
loaded.”
Example: If the user has the Number of Master Symbols set to 1, and
then either sends a <G> or toggles an active New Master Pin, the state
will be 1, and prior to reading and effectively loading position 1, the
response to <NEWM> would be <NEWM/1>. Once a symbol has been
read and loaded, the status will be cleared: <NEWM/0>.
<NEWM>
MINI Hawk Xi High Performance Imager User Manual
10 Camera and IP Setup
Contents
Camera and IP Setup by ESP .................................................................................................... 10-2
Camera and IP Setup Serial Commands.................................................................................... 10-3
Video........................................................................................................................................... 10-4
Evaluation ................................................................................................................................... 10-5
Calibration................................................................................................................................... 10-8
Window of Interest ...................................................................................................................... 10-9
Configuration Database ............................................................................................................ 10-13
Dynamic Setup ......................................................................................................................... 10-14
X-Mode™.................................................................................................................................. 10-15
Pixel Sub-Sampling .................................................................................................................. 10-16
Camera Settings ....................................................................................................................... 10-18
Focal Distance .......................................................................................................................... 10-19
Focal Distance Table (Read-Only) ........................................................................................... 10-20
Increment Focus Position ......................................................................................................... 10-21
Decrement Focus Position........................................................................................................ 10-21
Illumination Brightness.............................................................................................................. 10-22
Skew Correction ....................................................................................................................... 10-23
Morphological Pre-Processing.................................................................................................. 10-26
Morphological Operation and Operator Size ............................................................................ 10-27
This section provides adjustment parameters for the physical controls of the camera,
image acquisition, database settings, and image diagnostics.
MINI Hawk Xi High Performance Imager User Manual
10-1
Camera and IP Setup by ESP
Camera and IP Setup by ESP
Click the Setup button to bring up the Camera Setup menu.
To change a setting,
double-click the
setting and use your
cursor to scroll
through the options.
To open nested options, single-click the +.
10-2
MINI Hawk Xi High Performance Imager User Manual
Camera and IP Setup
Camera and IP Setup Serial Commands
Window of Interest
Focal Distance
Increment Focus Position
Decrement Focus Position
Focal Distance Table (Read-Only)
Illumination Brightness
Skew Correction
Camera
Pixel Sub-Sampling
Morphological Pre-Processing
Morphological Operation
<K516,row pointer,column pointer,row depth,column
width>
<K525,focal distance>
<K525+>
<K525–>
<K526,number of focal distances,focal distance>
<K536,brightness>
<K537,line speed,symbol direction>
<K541,shutter speed,gain>
<K542,pixel sub-sampling,AEC/AGC mode,AEC/AGC
brightness>
<K550,morphological pre-processing>
<K551,0,morphological operation,operator size>
MINI Hawk Xi High Performance Imager User Manual
10-3
Video
Video
The Video view is similar to the EZ Mode interface, in that the user has the ability to perform
the same Locate, Calibrate, and Test routines. There is also a focal distance adjustment
tool to the right of the video view.
Video also features Capture and Decode functionality, which is similar to the Configuration
interfaces (Communication, Read Cycle, Symbologies, I/O, Matchcode, and Diagnostics).
Initiates Calibration routine.
Activates the imager’s target
pattern and initiates live
video display of the symbol
in the field of view.
Allows the user to take an
image capture of the
symbol in the field of view
at any time, and to
decode the symbol data.
Similar to the Capture
and Decode function in
the Configuration views.
Initiates the Test routine.
Allows the user to test the
imager’s read rate and
decodes per second, and also
displays decoded symbol data
in the field at the bottom of the
screen, Click Stop to end the
Test routine.
Clicking this icon enables the
focal distance slide control to
the right of the video view.
The focal distance value is
displayed just below the icon.
Symbol data and
Test results are
shown in this field.
10-4
When enabled, shows the
symbol in higher contrast
than the default contrast
value.
MINI Hawk Xi High Performance Imager User Manual
Camera and IP Setup
Evaluation
In Evaluation, you can view images
currently in the imager, capture and
decode a symbol, save it as a digital
file, and perform histogram and line
scan evaluations.
When you click on the Evaluation tab,
you will see the images that are currently
stored in the imager.
Click Receive to refresh this view.
Click Capture/Decode to display the
current stored image. Only one capture
and decode event will occur, regardless
of read cycle settings.
Click Read to trigger a read cycle. If
there is enough time in the read cycle,
up to 32 good reads (or 6 full-scale
images) can be captured and displayed,
depending on the size of the images,
and depending on the number enabled
in Number of Captures under Capture
Mode in the Camera Setup menu tree
to the left of the tabs.
If you click Save, the current image will
be saved to the location of your choice.
Note: An image can only be saved in
the format in which it was uploaded to
ESP. JPEG images will be saved as
.jpg, and bitmaps will be saved as
.bmp.
When you click the JPEG Image box, notice that the Line Scan button is grayed out.
The JPEG option allows faster captures and transfers, but since the JPEG standard compresses
image data, it is not suitable for the more rigorous demands of line scan evaluation.
JPEG also allows you to adjust the image quality (resolution) by adjusting the sliding tab
between 1 and 100, 1 being the lowest quality and 100 being the highest.
When possible, use the highest quality; when image transfer speed must be increased,
use a lower image quality setting. Adjustments for this setting will depend on your specific
hardware and software limitations.
MINI Hawk Xi High Performance Imager User Manual
10-5
Evaluation
Histogram
Usage:
Definition:
Useful in determining quality and contrast of symbols.
A histogram is a graphic representation of the numeric count of the
occurrence of each intensity (gray level) in an image. The horizontal axis
represents the values of gray levels, and the vertical axis represents the
number of pixels for each gray level.
Note: Since histograms are performed in the imager, the results will be saved regardless
of whether the image was uploaded as a JPEG (.jpg) or a bitmap (.bmp).
1. From the Evaluation window, click the Histogram button.
The current image is transferred into the histogram operation. This may take a
moment, since all the relevant pixels are being evaluated intensively.
2. When the Histogram window opens, you may need to expand the window and/or
adjust the scroll bars in order to bring the image into view.
3. To generate a histogram, click and drag your cursor diagonally across the symbol or
a portion of the symbol.
The image will be surrounded by an “area of interest box”, a dashed blue line with red
anchor points that can be selected and moved by placing a cursor inside the box, and
can be resized by clicking and dragging the anchor points.
10-6
MINI Hawk Xi High Performance Imager User Manual
Camera and IP Setup
Line Scan
1. From the Evaluation tab, click the Line Scan button. A window like that shown
below will appear.
2. Drag your cursor horizontally across the image.
This will create a dashed horizontal line. Pixel information and a visual representation
of the dark and light pixels will be displayed below the image.
When you center your cursor over the dashed line, it becomes a double arrow cross.
This allows you to move the line anywhere in the window. You can also use your
keyboard arrows to move the line incrementally in any direction.
As with the histogram, the line scan compares light and dark pixels, but in a spatial
distribution. On the Y axis of the graph below, 0 is black and 255 is white; the X axis
represents the horizontal axis of the symbol as described by the line scan.
When you click anywhere on the graph, a vertical red line appears at that point and its
position and value (in terms of black-to-white) are updated in the Pixel Info table to
the left of the graph (237 in this example). In addition, a horizontal dashed red line is
displayed that indicates the average value.
MINI Hawk Xi High Performance Imager User Manual
10-7
Calibration
Calibration
The Calibration interface in ESP is a powerful and intuitive way to optimize the imager’s
performance. It allows the user to control several complex, simultaneous calibration
operations, and to follow the progress of those operations using cues such as progress
bars, real-time representations of calibration values, and other dynamic user feedback.
See Chapter 4, Calibration, for full documentation of this feature.
ESP’s Calibration interface shown
during a calibration routine
10-8
ESP’s Calibration interface shown
after a calibration routine
MINI Hawk Xi High Performance Imager User Manual
Camera and IP Setup
Window of Interest
The active pixel area of the image sensor is called the Window of Interest (WOI). The WOI
allows the user to select an area of the field of view in which the desired symbol is located.
The programmable window of interest increases decode speed, improves threshold, and
makes it easy to select specific symbols from among several in the field of view. The user
provides the upper-left pixel location and the size of the window to define the Window of
Interest.
MINI Hawk Xi High Resolution (SXGA)
MINI Hawk Xi High Speed (WVGA)
Caution: Window of Interest will shrink the field of view and therefore could cause symbols
to be missed in dynamic applications.
MINI Hawk Xi High Performance Imager User Manual
10-9
Window of Interest
Window of Interest by ESP
1. From the Camera menu, click the WOI tab to bring up Window of Interest.
If you haven’t already captured an image, click the Capture and Decode button to
decode the present image. If successful, the Good Read indicator on the WOI tab will
be green and the symbol will appear in the pane below.
Note: You can resize the image by clicking and dragging the ESP window from the
lower right corner. This is useful where very small symbols are being read.
2. Click and drag your cursor over the symbol that you want to isolate for reading.
Notice that the surrounding area goes black.
You can use the handles on the image area that you have just drawn to resize the
region of interest. You can also click on the center of the window of interest and move it.
3. Test the new settings in Read Rate Mode.
Note: To remove the window of interest, click the Reset button or click anywhere in
the WOI pane.
Note that all pixels not in the WOI are defined as black.
Because the imager has far less processing to do in a smaller window, read rates
typically increase dramatically. One possible downside is that the chance of missing
a symbol increases with the smaller window. Always verify that your WOI will be
large enough to allow for any random movement of symbols in your field of view.
10-10
MINI Hawk Xi High Performance Imager User Manual
Camera and IP Setup
Window of Interest by Serial Command
The figure shows where to locate the start
position of the row and column pointers and
how to measure the column depth and row
width dimensions.
Top (Row Pointer)
Definition: Defines the row position of the
upper-left starting point of the
window.
Serial
<K516,row pointer,column
Cmd:
pointer,row depth,column width>
Default: 0
Options: High Resolution MINI Hawk Xi:
0 to (1024 – row depth)
High Speed MINI Hawk Xi:
0 to (480 – row depth)
WOI Row Pointer
WOI Column
Pointer
WOI Row Depth
WOI Column Width
Left (Column Pointer)
Definition:
Serial Cmd:
Default:
Options:
Defines the column position of the upper-left starting point of the window.
<K516,row pointer,column pointer,row depth,column width>
0
High Resolution MINI Hawk Xi: 0 to (1280 – column width)
High Speed MINI Hawk Xi: 0 to (752 – column width)
Important: The column pointer setting must be an even value.
Height (Row Depth)
Definition:
Serial Cmd:
Default:
Options:
Defines the size, in rows, of the window. Maximum value is defined
as the maximum row size of the image sensor minus the Top value.
<K516,row pointer,column pointer,row depth,column width>
High Resolution MINI Hawk Xi: 1024
High Speed MINI Hawk Xi: 480
High Resolution MINI Hawk Xi: 3 to (1024 – row pointer)
High Speed MINI Hawk Xi: 3 to (480 – row pointer)
MINI Hawk Xi High Performance Imager User Manual
10-11
Window of Interest
Width (Column Width)
Definition:
Serial Cmd:
Default:
Options:
10-12
Defines the column position of the upper-left starting point of the
window.
<K516,row pointer,column pointer,row depth,column width>
High Resolution MINI Hawk Xi: 1280
High Speed MINI Hawk Xi: 752
High Resolution MINI Hawk Xi: 8 to (1280 – column pointer)
High Speed MINI Hawk Xi: 8 to (752 – column pointer)
MINI Hawk Xi High Performance Imager User Manual
Camera and IP Setup
Configuration Database
The Configuration Database allows the user to manage multiple configuration profiles. It is
a useful tool in applications that require several different imager configurations to be
applied sequentially, and it allows the user to perform far more complex operations than
would be possible with only one set of configuration parameters.
See Chapter 11, Configuration Database, for full documentation of this feature.
Configuration Database view, set for 5 Active Indexes, with Capture Settings highlighted
MINI Hawk Xi High Performance Imager User Manual
10-13
Dynamic Setup
Dynamic Setup
Dynamic Setup is used to calculate image capture timing during a read cycle. Without proper
timing, the imager will not be able to decode all symbols in a read cycle. An external trigger is
used to activate image captures so the user can make timing adjustments as capture events
occur.
10-14
MINI Hawk Xi High Performance Imager User Manual
Camera and IP Setup
X-Mode™
The MINI Hawk Xi is equipped with powerful X-Mode™ technology, which provides industry-leading
decode performance on both printed and direct part mark symbols, with minimum configuration
required out of the box. The X-Mode algorithm identifies symbol candidates within the
imager’s field of view and uses sophisticated image processing to decode valid symbols.
In each of the examples below, the X-Mode technique locates a symbol, analyzes the
image gradient to detect areas with changes in reflectivity, grid-maps the image, and ultimately
produces an ideal, reliably decodable Data Matrix.
Dot Peen on Curved Surface
Comparison of direct part mark
and Data Matrix after processing
Laser Etch
Comparison of direct part mark
and Data Matrix after processing
Laser Etch
Comparison of direct part mark
and Data Matrix after processing
Ink Jet
Comparison of direct part mark
and Data Matrix after processing
MINI Hawk Xi High Performance Imager User Manual
10-15
Pixel Sub-Sampling
Pixel Sub-Sampling
Definition:
Usage:
Default:
Options:
Pixel Sub-Sampling shows an entire captured image by averaging signals
from adjacent pixels.
<K542,pixel sub-sampling,AEC/AGC mode,AEC/AGC brightness>
Disabled
0 = Disabled
1 = 4:1
2 = 16:1
4:1
At 4:1, 4 pixel signals from 2 adjacent rows and columns are combined so that only 1 pixel
is output for every 4 pixels sampled. An image with the dimensions 640 x 480 is scaled to
320 x 240.
Since the resolution of the output image is reduced, the frame rate will increase, but not by
the factor of the image reduction. This is due to the overhead time of digital pixel data
processing and minimum row time requirements of the image sensor.
16:1
At 16:1, 16 pixel signals from 4 adjacent rows and columns are combined so that only 1
pixel is output for every 16 pixels sampled. An image with the dimensions 640 x 480 will be
scaled to 160 x 120.
Since the resolution of the output image is reduced, the frame rate will increase, but not by
the factor of the image reduction. This is due to the overhead time of digital pixel data
processing and minimum row time requirements of the image sensor.
10-16
MINI Hawk Xi High Performance Imager User Manual
Camera and IP Setup
AEC/AGC Mode
Note: AEC/AGC Mode is only applicable to the High Speed version of the MINI Hawk Xi.
Definition:
Usage:
Default:
Options:
AEC/AGC Mode (Automatic Exposure Control/Automatic Gain Control
Mode) maintains optimal self-adjusting exposure and gain settings. This
ensures that acquired images fall in a desirable region of the camera’s
sensitivity range for optimal image luminance.
<K542,pixel sub-sampling,AEC/AGC mode,AEC/AGC brightness>
Disabled
0 = Disabled
1 = AEC
2 = AGC
3 = AEC/AGC
AEC
AEC enables Automatic Exposure Control. In this mode, the optimal setting for exposure
(shutter) is computed and updated for every frame. It may take several frames to adjust
the shutter value to the correct setting. The current camera shutter parameter is updated
at the end of the read cycle (see Camera Settings).
Note: The minimum (slowest) shutter setting will not exceed the frame read-out time of the
current image dimension. For example, a full-size image has a minimum frame read-out
time of 15 ms. Therefore, the slowest shutter that can be achieved is 15 ms, or 1/67.
AGC
AGC enables Automatic Gain Control. In this mode, the optimal setting for gain is
computed and updated for every frame. It may take several frames to adjust the gain
value to the correct setting. The current camera gain parameter is updated at the end of
the read cycle (see Camera Settings).
AEC/AGC
AEC/AGC enables both Automatic Exposure Control and Automatic Gain Control. In
this mode, the optimal settings for exposure (shutter) and gain are computed and updated
for every frame. It may take several frames to adjust the shutter and gain values to the
correct settings.
Important: In this mode, only the Automatic Exposure Control (AEC) is active while the
gain value remains fixed at its minimum setting. The Automatic Gain Control (AGC) only
becomes active if the AEC has driven the shutter value to its minimum (slowest) setting
and the desired image brightness has still not been obtained. When this occurs, the shutter
value will remain fixed while gain is adjusted. The current camera shutter and camera gain
parameters are then updated at the end of the read cycle (see Camera Settings).
AEC/AGC Brightness
Note: AEC/AGC Brightness is only applicable to the High Speed version of the MINI Hawk Xi.
Definition:
Usage:
Default:
Options:
AEC/AGC Brightness allows the desired image luminance to be
adjusted within the range of 1 (darkest) to 56 (brightest).
<K542,pixel sub-sampling,AEC/AGC mode,AEC/AGC brightness>
30
1 to 56
MINI Hawk Xi High Performance Imager User Manual
10-17
Camera Settings
Camera Settings
Camera Settings are typically obtained during the calibration process, and do not necessarily
need to be modified directly by the user.
Optics
The MINI Hawk Xi has three different optical configurations available: Standard Density,
High Density, and Ultra High Density. Determine the optics of your imager and find the
corresponding camera values in the following sections.
Standard Density, High Density, and Ultra High Density Optics
Shutter Speed
Usage:
Definition:
Serial Cmd:
Default:
Options:
Faster shutter speeds reduce blurring in faster applications.
Slower shutter speeds are useful in slower applications and lower contrast
applications.
This value sets the exposure or integration time for the image sensor pixels.
The shutter speed setting in relation to the speed of the object is critical. If a
slow shutter speed is selected to capture fast-moving objects, blurring or
smearing of the image will occur. As shutter speed is increased, more light
and gain become necessary, because the pixels’ exposure time has
decreased.
<K541,shutter speed,gain>
250 (SD)
30 (HD)
300 (UHD)
15 to 12,500
Gain
Usage:
Definition:
Serial Cmd:
Default:
Options:
10-18
Can be used to adjust the brightness of the image.
Sets the gain value for the image sensor. This setting can be configured
through calibration, which is the recommended method. A higher gain
value will increase the brightness of the image, but the visual noise
reduction performance of the system is reduced. Before configuring gain
settings, the desired shutter speed should already be set and the gain
should be configured to optimize the shutter speed setting.
<K541,shutter speed,gain>
20
0 to 33
MINI Hawk Xi High Performance Imager User Manual
Camera and IP Setup
Focal Distance
Definition:
Serial Cmd:
Default:
Options:
This setting provides a means for configuring the focal distance of the
imager. The input value is in terms of inches and is divided by 100 internally.
For example, 400 sets the imager to a focal distance of 4 inches. It is
important to note that the imager may not have an exact match for the
focal position requested. The imager has a range of steps that are calibrated
and mapped to focal positions. This input value is matched to the closest
focal position step that the system supports. It is also important to keep in
mind that the resolution of the system is not linear. As the imager’s focal
distance setting increases, the resolution decreases. This effect is offset
somewhat by the fact that the depth of field increases at greater focal
distances.
<K525,focal distance>
Standard Density = 400 (4”)
High Density = 400 (4”)
Ultra High Density = 300 (3”)
200 (2”) to 600 (6”)
Note: In the factory, the imager calibrates its focus curve and matches the focus motor
steps to various focal positions. Therefore, each imager has a slightly different focus map
of stepper motor positions vs. focal positions. This allows the user to enter a focal distance
that causes the imager to select the closest stepper motor position required to obtain the
user-defined setting. In this way, there is consistency between imagers for any given focal
distance input.
Note: To view a list of focal distances supported by your imager, use the <K526> command.
MINI Hawk Xi High Performance Imager User Manual
10-19
Focal Distance Table (Read-Only)
Focal Distance Table (Read-Only)
Number of Focal Distances
Definition:
Serial Cmd:
Options:
Specifies the number of focal distances supported by the imager.
<K526,number of focal distances,focal distance>
1 to 255
Focal Distance
Definition:
Serial Cmd:
Options:
10-20
Each (x) output represents a focal distance that is supported by the
imager. The values are specified in 1/100ths of an inch, but the focal
distance increments and decrements are not that fine. The focal distance
is defined from a curve equation whose constants are calibrated during
factory setup. The output value is in terms of inches, and it is multiplied
by 100 to remove the decimal place. For example, an output of 375
would signify a focal distance of 3.75”.
<K526,number of focal distances,focal distance>
200 (2”) to 600 (6”)
MINI Hawk Xi High Performance Imager User Manual
Camera and IP Setup
Increment Focus Position
Definition:
Serial Cmd:
Options:
Increments the imager’s focus setting to the next focal distance supported
by the imager.
Note: Use the Focus Distance Table command <K526> to find the focal
distance settings supported by your imager.
<K525+>
200 (2”) to 600 (6”)
The following example assumes a focus position setting of 400 (4”), with access to the
focus distance values shown in the imager response.
Send: <K526?>
Response: <K526,30,202,212,225,241,264,410,447,466,481,492,502,511,519,526,533,
539,545,550,556,561,565,570,574,578,582,586,590,594,597,601>
The current focus position would be 410 (4.1”).
Send: <K525+>
Send: <K525?>
Response: <K525,447>
Decrement Focus Position
Definition:
Serial Cmd:
Options:
Decrements the imager’s focus setting to the next focal distance supported
by the imager.
Note: Use the Focus Distance Table command <K526> to find the focal
distance settings supported by your imager.
<K525->
200 (2”) to 600 (6”)
The following example assumes a focus position setting of 400 (4”), with access to the
focus distance values shown in the imager response.
Send: <K526?>
Response: <K526,30,202,212,225,241,264,410,447,466,481,492,502,511,519,526,533,
539,545,550,556,561,565,570,574,578,582,586,590,594,597,601>
The current focus position would be 410 (4.1”).
Send: <K525->
Send: <K525?>
Response: <K525,264>
MINI Hawk Xi High Performance Imager User Manual
10-21
Illumination Brightness
Illumination Brightness
Definition:
Serial Cmd:
Default:
Options:
This feature allows the user to adjust the brightness of the illumination
LEDs. Since the imager has control over the brightness of the illumination,
it can provide consistent brightness output between imagers through a
factory calibration operation. Each of the brightness settings is calibrated
to provide the same level of intensity for each imager.
<K536,brightness>
High
0 = Off
1 = Low
2 = Medium
3 = High
4 = Constant
Constant
When set to Constant, the illumination is the same as the Medium setting. However, the
LEDs will always be on during a read cycle and will only be off between read cycles. This
cuts down on perceptible LED flashing.
10-22
MINI Hawk Xi High Performance Imager User Manual
Camera and IP Setup
Skew Correction
Note: Skew Correction does not apply to the High Speed version of the MINI Hawk Xi,
which has a global shutter.
The MINI Hawk Xi’s CMOS image sensor has
a “rolling shutter” mechanism that controls
pixel integration row-by-row, unlike a global
Full Image Height
shutter, which performs light integration of all
pixels at once. When a row of pixels has
integrated light for the amount of time specified
Full Image Width
by the user-defined shutter speed, that row
will be read out. The rows of the image are exposed individually in rapid sequence. As a
symbol moves through the field of view, it is in a different position at each row read-out. This
creates distortion, or “skew”, as in the image shown below. In this image, the symbol is
moving from left to right at a line speed of 40 inches per second. The bottom of the symbol
is read out first while the upper portion is still being integrated, causing distortion along the symbol’s
x-axis.
Note: The amount of blur in the image is an effect of shutter speed, and is not a factor in
rolling shutter distortion.
If the symbol enters the imager’s field of view from the top or bottom, distortion will occur
on the y-axis. The image below shows two symbols entering the field of view from the top
at different line speeds. As you can see, this causes the image to shrink along the y-axis.
This is because the symbol is moving perpendicular to the CMOS sensor’s row read-out.
In other words, the bottom of the symbol is read out first, and as the symbol moves information
is lost (the symbol enters pixel rows that have already been processed). This causes the
symbol to appear to shrink vertically.
Note: If the symbol were to enter the field of view from the bottom, the captured image
would be stretched along the y-axis.
10” / sec
16” / sec
Direction of
symbol
movement
Full Image Width
The amount of rolling shutter distortion depends upon the amount of time it takes to read
out an image row, and the line speed at which the target object is traveling. Therefore, one
way to reduce skew is to speed up the read-out time per pixel row. This can be accomplished
by reducing the column size of the image sensor.
For example, if the column size is reduced from 640 to 320, the time it takes to read out a
row of pixels from the sensor is reduced by half, and image skew will be reduced by a factor
of 2. As the column dimension of the image is reduced, the effect of rolling shutter distortion
is reduced by the same factor.
Important: Reducing the row size of the image has no effect, because it does not change
the row read-out time. Skew will remain the same regardless of row size.
10-23
MINI Hawk Xi High Performance Imager User Manual
Skew Correction
Line Speed
Definition:
Serial Cmd:
Default:
Options:
Line Speed
10” / sec
20” / sec
30” / sec
40” / sec
60” / sec
80” / sec
This feature is used to specify the line speed of the application, and it
determines how much distortion correction to apply. When enabled, this
feature will cause the overall decode rate to increase significantly. The timing
information in the table below is for a full megapixel image (1280 x 1024).
Note: Processing time decreases with larger image sizes.
<K537,line speed,symbol direction>
0 (Disabled)
0 to 80 (inches per second)
Additional Processing Time
69.5 ms
65.0 ms
62.5 ms
58.0 ms
55.0 ms
45.5 ms
Distortion is corrected by shifting image rows in the direction opposite the symbol’s
movement on the line. The shift value of subsequent image rows is then increased. These
shift values depend on the speed of the line. The faster the line speed, the greater the
required shift values. More data loss is incurred at faster line speeds.
The image shown below was captured at a line speed of 40 inches per second, and it
shows virtually no inherent skew. The black area of the image is unusable, since the
information was lost as the symbol moved through the imager’s field of view.
The amount of data loss can be reduced by decreasing the image height or the row size of
the image, which reduces the amount of travel represented during the image frame
read-out. Note that the amount of distortion will not be changed, because the object will
have traveled the same distance during the read-out of the target area.
10-24
MINI Hawk Xi High Performance Imager User Manual
Camera and IP Setup
Symbol Direction
Definition:
Serial Cmd:
Default:
Options:
This feature specifies the direction the symbol is moving through the
imager’s field of view, or which side of the field of view the symbol will enter
first.
Note: Image captures of symbols entering the field of view from above or
below cannot be skew-corrected.
<K537,line speed,symbol direction>
Right
0 = Right
1 = Left
If a symbol enters the field of view from the left, it will be skewed as shown in the image
below. The image is processed from top to bottom, meaning that the top of the symbol is
captured first. The amount of skew is dependent on the speed at which the symbol moves
through the imager’s field of view. The symbol below was captured at a line speed of 40
inches per second.
Additional Notes on Skew Correction
• Autocalibration does not perform skew correction. It is assumed that during autocalibration
the symbol is stationary, so skew correction is not required.
• Images are corrected before they are processed. Therefore, if an image is still pending
at the end of the read cycle, it will not have been skew-corrected.
MINI Hawk Xi High Performance Imager User Manual
10-25
Morphological Pre-Processing
Morphological Pre-Processing
Morphological Pre-Processing allows the user to select the method for processing
images, and to choose the operator size for that method.
Important: This command must be set to Enabled for Morphological Operation to function.
Serial Cmd:
Default:
Options:
10-26
<K550,morphological pre-processing>
Disabled
0 = Disabled
1 = Enabled
MINI Hawk Xi High Performance Imager User Manual
Camera and IP Setup
Morphological Operation and Operator Size
Morphological Operation
Definition:
Serial Cmd:
Default:
Options:
Morphological Operation allows the user to select the method for processing
captured images.
<K551,0,morphological operation,operator size>
Erode
0 = Erode
1 = Dilate
2 = Open
3 = Close
Erode
Erode increases the dark cell size of a symbol. Useful for increasing the dark cell size of a
dark-on-light Data Matrix symbol.
Dilate
Dilate increases the light cell size of a symbol. Useful for increasing the light cell size of a
light-on-dark Data Matrix symbol.
MINI Hawk Xi High Performance Imager User Manual
10-27
Morphological Operation and Operator Size
Open
Open removes minor light defects of dark cells by performing a Dilate function followed by
an Erode function.
Close
Close removed minor dark defects of light cells by performing an Erode function followed
by a Dilate function.
10-28
MINI Hawk Xi High Performance Imager User Manual
Camera and IP Setup
Operator Size
Definition:
Serial Cmd:
Default:
Options:
Operator Size determines the size of the area or “pixel neighborhood”
(measured in pixels) in which the morphological operation is being performed.
<K551,0,morphological operation,operator size>
Small
3 = Small (3 pixels by 3 pixels)
5 = Medium (5 pixels by 5 pixels)
7 = Large (7 pixels by 7 pixels)
MINI Hawk Xi High Performance Imager User Manual
10-29
Morphological Operation and Operator Size
10-30
MINI Hawk Xi High Performance Imager User Manual
11 Configuration
Database
Contents
Configuration Database Serial Commands ................................................................................ 11-2
Number of Active Indexes .......................................................................................................... 11-3
Configuration Database Status................................................................................................... 11-4
Database Mode ........................................................................................................................ 11-10
Save Current Settings to Configuration Database.................................................................... 11-15
Load Current Settings from Configuration Database................................................................ 11-16
Request Selected Index Settings ............................................................................................. 11-17
Request All Configuration Database Settings .......................................................................... 11-18
This section concerns the various capture settings and processing settings that can be
used to fine-tune the MINI Hawk Xi’s performance in your application.
MINI Hawk Xi High Performance Imager User Manual
11-1
Configuration Database Serial Commands
Configuration Database Serial Commands
Number of Active Indexes
Configuration Database Status
Save Current Settings to Database
Load Current Settings from Database
Request Selected Index Settings
Request All Database Settings
Database Mode
11-2
<K252,number of active database settings,database
sort>
<K255,index,shutter speed,gain,focal distance,
pixel sub-sampling,row pointer,column pointer,row
depth,column width,narrow margins,background
color,symbology>
<K255+,index>
<K255-,index>
<K255?,index>
<K255?>
<K256,switch mode,frame count/time,image process
looping,image dimensions>
MINI Hawk Xi High Performance Imager User Manual
Configuration Database
Number of Active Indexes
Usage:
Definition:
Serial Cmd:
Default:
Options:
Useful for applications that require several different complex imager configurations
to be applied sequentially. Multiple database indexes allow you to concatenate
configuration profiles, and to perform more complex operations than would
be possible with only one set of configuration parameters.
This feature allows you to set the number of database records (groups of
settings) that will be used automatically during the read cycle. If Number of
Active Indexes is set to 0, only the current imager settings will be used,
not database entry settings.
<K252,number of active indexes,database sort>
0 (disabled)
0 to 10
Database Sort
Definition:
Serial Cmd:
Default:
Options:
Database Sort moves the database entry that produced a successful
decode to the first position in the list of database entries.
<K252,number of active indexes,database sort>
Disabled
0 = Disabled
1 = Enabled
Number of Active Indexes by ESP
Click the arrow on the Active
Indexes dropdown menu and
select how many database
indexes will be used during
the read cycle. (0 to 10).
Sort Index Positions on Good Reads moves the
database entry that produces the first successful
decode to the top of the list.
MINI Hawk Xi High Performance Imager User Manual
11-3
Configuration Database Status
Configuration Database Status
Index
Usage:
Useful for applications that require several different complex imager configurations
to be applied sequentially. Multiple database indexes allow you to concatenate
configuration profiles, and to perform more complex operations than would
be possible with only one set of configuration parameters.
Definition: Determines the specific database index that will be used.
Serial Cmd: <K255,index,shutter speed,gain,focal distance,pixel sub-sampling,row
pointer,column pointer,row depth,column width,narrow margins,background
color,symbology>
Options:
1 to 10
Shutter Speed
Serial Cmd: <K255,index,shutter speed,gain,focal distance,pixel sub-sampling,row
pointer,column pointer,row depth,column width,narrow margins,background
color,symbology>
Default:
250
Options:
15 to 12,500
Gain
Serial Cmd: <K255,index,shutter speed,gain,focal distance,pixel sub-sampling,row
pointer,column pointer,row depth,column width,narrow margins,background
color,symbology>
Default:
20
Options:
0 to 33
Focal Distance
Serial Cmd: <K255,index,shutter speed,gain,focal distance,pixel sub-sampling,row
pointer,column pointer,row depth,column width,narrow margins,background
color,symbology>
Default:
400 (4”)
Options:
200 to 600
11-4
MINI Hawk Xi High Performance Imager User Manual
Configuration Database
Pixel Sub-Sampling
Serial Cmd: <K255,index,shutter speed,gain,focal distance,pixel sub-sampling,row
pointer,column pointer,row depth,column width,narrow margins,background
color,symbology>
Default:
Disabled
Options:
0 = Disabled
1 = 4:1
2 = 16:1
Important: Pixel Sub-Sampling has no effect when the Image Dimension mode is configured
as Region of Interest in the Database Mode command. This is because the Window of
Interest camera settings are determined by the software based on the Region of Interest
setup. There is no benefit to Pixel Sub-Sampling to increase processing speed when
ROI is configured, because the frame size would need to be increased to make Pixel Sub-Sampling
possible.
Row Pointer
Definition:
The image dimension settings can be applied as a Window of Interest or a
Region of Interest, depending on the image dimension mode selected in the
Database Mode command.
Serial Cmd: <K255,index,shutter speed,gain,focal distance,pixel sub-sampling,row
pointer,column pointer,row depth,column width,narrow margins,background
color,symbology>
Default:
0
Options:
High Resolution MINI Hawk Xi: 0 to (1024 – row depth)
High Speed MINI Hawk Xi: 0 to (480 – row depth)
Column Pointer
Definition:
The image dimension settings can be applied as a Window of Interest or a
Region of Interest, depending on the image dimension mode selected in the
Database Mode command.
Serial Cmd: <K255,index,shutter speed,gain,focal distance,pixel sub-sampling,row
pointer,column pointer,row depth,column width,narrow margins,background
color,symbology>
Default
0
Options:
High Resolution MINI Hawk Xi: 0 to (1280 – column width)
High Speed MINI Hawk Xi: 0 to (752 – column width)
MINI Hawk Xi High Performance Imager User Manual
11-5
Configuration Database Status
Row Depth
Definition:
The image dimension settings can be applied as a Window of Interest or a
Region of Interest, depending on the image dimension mode selected in the
Database Mode command.
Serial Cmd: <K255,index,shutter speed,gain,focal distance,pixel sub-sampling,row
pointer, column pointer,row depth,column width,narrow margins,background
color, symbology>
Default:
High Resolution MINI Hawk Xi: 1024
High Speed MINI Hawk Xi: 480
Options:
High Resolution MINI Hawk Xi: 3 to (1024 – row pointer)
High Speed MINI Hawk Xi: 3 to (480 – row pointer)
Column Width
Definition:
The image dimension settings can be applied as a Window of Interest or a
Region of Interest, depending on the image dimension mode selected in the
Database Mode command.
Serial Cmd: <K255,index,shutter speed,gain,focal distance,pixel sub-sampling,row
pointer,column pointer,row depth,column width,narrow margins,background
color,symbology>
Default
High Resolution MINI Hawk Xi: 1280
High Speed MINI Hawk Xi: 752
Options:
High Resolution MINI Hawk Xi: 8 to (1280 – column pointer)
High Speed MINI Hawk Xi: 8 to (752 – column pointer)
Narrow Margins
Serial Cmd: <K255,index,shutter speed,gain,focal distance,pixel sub-sampling,row
pointer,column pointer,row depth,column width,narrow margins,background
color,symbology>
Default:
Disabled
Options:
0 = Disabled
1 = Enabled
11-6
MINI Hawk Xi High Performance Imager User Manual
Configuration Database
Background Color
Serial Cmd: <K255,index,shutter speed,gain,focal distance,pixel sub-sampling,row
pointer,column pointer,row depth,column width,narrow margins,background
color,symbology>
Default:
Both
Options:
0 = White
1 = Black
2 = Both
Symbology
Definition:
This field allows the user to configure the database to enable specific symbologies
for selected database indexes. Symbology-specific parameters must be
configured with the appropriate symbology command.
For example, if fixed length Code 128 is required, it must first be set up with
the Code 128 command: <K474>.
To select a particular symbology, add the number value associated with that
symbology.
Examples:
If Data Matrix and Code 39 are required, the paramater would be: 2 + 16 = 18.
If I 2/5, BC412, and DataBar Limited (RSS Limited) are required, the
parameter would be: 128 + 2048 + 16384 = 18560.
Serial Cmd: <K255,index,shutter speed,gain,focal distance,pixel sub-sampling,row
pointer,column pointer,row depth,column width,narrow margins,background
color,symbology>
Default:
Disabled
Disabled
When Symbology is disabled, the database uses the current Symbology setup to
determine active symbologies.
Any Symbology (Add 1)
All symbologies except Pharmacode are enabled while this database index is being
used.
Data Matrix (Add 2)
If enabled, Data Matrix will be active for this database index.
Important: The ECC level must be configured using the Data Matrix command <K479>. If
no ECC level has been configured, the imager will not decode Data Matrix symbols.
QR Code (Add 4)
If enabled, QR Code will be active for this database index.
Code 128 (Add 8)
If enabled, Code 128 will be active for this database index.
MINI Hawk Xi High Performance Imager User Manual
11-7
Configuration Database Status
Code 39 (Add 16)
If enabled, Code 39 will be active for this database index.
Codabar (Add 32)
If enabled, Codabar will be active for this database index.
Code 93 (Add 64)
If enabled, Code 93 will be active for this database index.
Interleaved 2 of 5 (Add 128)
If enabled, Interleaved 2 of 5 will be active for this database index.
UPC/EAN (Add 256)
If enabled, UPC/EAN will be active for this database index.
PDF417 (Add 512)
If enabled, PDF417 will be active for this database index.
MicroPDF417 (Add 1024)
If enabled, MicroPDF417 will be active for this database index.
BC412 (Add 2048)
If enabled, BC412 will be active for this database index.
Pharmacode (Add 4096)
If enabled, Pharmacode will be active for this database index.
DataBar-14 (RSS-14) (Add 8192)
If enabled, DataBar-14 will be active for this database index.
Important: If the stacked and non-stacked operation is required, the DataBar-14 command
must be configured as follows: <K482,2>. If the DataBar-14 status parameter in the
<K482> command is set to either DISABLED or ENABLED, the imager will only read
non-stacked DataBar-14 symbols.
DataBar Limited (RSS Limited) (Add 16384)
If enabled, DataBar Limited will be active for this database index.
DataBar Expanded (RSS Expanded) (Add 32768)
If enabled, DataBar Expanded will be active for this database index.
Important: If the stacked and non-stacked operation is required, the DataBar Expanded
command must be configured as follows: <K484,2>. If the DataBar Expanded status parameter
in the <K484> command is set to either DISABLED or ENABLED, the imager will only
read non-stacked DataBar Expanded symbols.
11-8
MINI Hawk Xi High Performance Imager User Manual
Configuration Database
Micro QR Code (Add 65536)
If enabled, Micro QR Code will be active for this database index.
Aztec Code (Add 131072)
If enabled, Aztec Code will be active for this database index.
Postal Symbologies (Add 262144)
If enabled, Postal Symbologies will be active for this database index.
MINI Hawk Xi High Performance Imager User Manual
11-9
Database Mode
Database Mode
Switch Mode
Definition:
Selects the event that causes the imager to load the next database entry to
current, active settings. When Frame Count/Time expires and Image Process
Looping is enabled, the next database entry with modifications to camera
settings will be used.
Note: The image capture event always occurs when the first database entry
is used.
Note: The Switch Mode setting has no effect on Rapid Capture Mode,
which always operates in Number of Image Frames mode with a frame
count of 1.
Serial Cmd: <K256,switch mode,frame count/time,image process looping,image dimensions>
Default:
1
Options:
0 = Time
1 = Number of Image Frames
Time
When Switch Mode is set to Time, the imager will load the next database entry to current,
active settings after a predefined time interval. The timer will start upon use of a database
entry. If the timer expires during an image capture event, the timer will not start again until
that database entry has been incremented and the new database entry has been loaded
to current, active settings.
Number of Image Frames
When Switch Mode is set to Number of Image Frames, the database entry is incremented
after the predetermined number of image capture events has occurred.
Frame Count/Time
Definition:
Indicates the Number of Image Frames that must be captured or the
amount of Time that must transpire before the imager will load the next
database index entry.
Serial Cmd: <K256,switch mode,frame count/time,image process looping,image dimensions>
Default:
1 (frames/ms)
Options:
1 to 65535
11-10
MINI Hawk Xi High Performance Imager User Manual
Configuration Database
Image Process Looping
Usage:
Useful in applications where it is necessary to process a single captured
image multiple times using different IP and decode parameters.
Serial Cmd: <K256,switch mode,frame count/time,image process looping,image dimensions>
Default:
Disabled
Options:
0 = Disabled
1 = Enabled
Disabled
When Image Process Looping is set to Disabled, an image is captured for every database
configuration, whether or not any camera settings have been modified.
Enabled
When Image Process Looping is set to Enabled, the last captured image frame is reprocessed with the new IP and decode parameters. If camera settings have not been
changed from the last capture event, and when a database configuration is loaded to
current, active settings, no new image is captured.
Note: An exception to this is the first database index: a new image is always captured
when the first database index is used. When a camera setting has been modified from one
database setting to the next, a new image is captured. For example, if all database entries
contained the same camera setting values but had different IP and decode parameters, an
image frame would only be captured when the first database configuration was used.
MINI Hawk Xi High Performance Imager User Manual
11-11
Database Mode
Image Dimensions
Definition:
Serial Cmd:
Default:
Options:
Determines how the image dimension parameters will be implemented.
<K256,switch mode,frame count/time,image process looping,image dimensions>
0
0 = Window of Interest
1 = Region of Interest
Window of Interest (WOI) by ESP
When Image Dimensions is set to Window of Interest, the database image dimension
parameters are camera settings, and they determine the size of the image to be captured.
Camera settings (Capture Index, Shutter Speed, Gain, Focal Distance,
Sub-Sampling) located in the left half of the highlighted area.
Image capture dimensions (Top, Left, Height, Width) located in the right
half of the highlighted area.
11-12
MINI Hawk Xi High Performance Imager User Manual
Configuration Database
Region of Interest (ROI)
When Image Dimensions is set to Region of Interest, the database image dimension
parameters are IP and decode settings, and they determine the region or area of the
captured image to be processed.
ROI coordinate data is based on the full image size. The WOI of the captured image will be
configured to cover all the ROI settings in the current, active database entry. In the following
example, there are three active database settings, each with a different ROI configuration.
Their coordinates are based at point 0,0 of the full scale image. In this example, DB1 and
DB3 determine the size of the captured image WOI, while DB2 has no impact. The image
WOI is not configurable. It is automatically set up by the database according to the ROI
settings.
row
pointer
column
pointer
DB 1
row
size
IP ROI
DB 2
IP ROI
column size
DB 3
Camera WOI
IP ROI
Full Image Size (High Resolution Imager: 1280 x 1024; High Speed Imager: 752 x 480)
Note: Since the ROI parameters are not a camera setting, a change in ROI parameters
from one index to another does not indicate an image capture event.
This feature is intended to be used in conjunction with Image Process Looping, to
allow different regions of a captured image to be processed using different IP and
decode settings.
Also, if this feature is used in conjunction with Output Filtering, multiple decoded symbols
in a captured image frame can be output according to their location in the field of view.
MINI Hawk Xi High Performance Imager User Manual
11-13
Database Mode
Region of Interest (ROI) by ESP
When Image Dimensions is set to Region of Interest, the database image dimension
parameters are IP and decode settings, and they determine the region or area of the
captured image to be processed.
Narrow Margins, Background, and Symbol Type are all Processing Settings values.
11-14
MINI Hawk Xi High Performance Imager User Manual
Configuration Database
Save Current Settings to Configuration Database
Definition:
Serial Cmd:
Allows current, active configuration settings to be saved to a selected
database index.
<K255+,index>
Example:
<K255+,5>
This command phrase saves the imager’s current, active configuration settings to database
index 5.
Save Current Settings to Configuration Database by ESP
Click the Load Current to Index button to
save the imager’s current configuration
parameters to the selected database index.
MINI Hawk Xi High Performance Imager User Manual
11-15
Load Current Settings from Configuration Database
Load Current Settings from Configuration Database
Definition:
Serial Cmd:
Allows the configuration settings contained in a selected database index to
be loaded to current, active configuration settings.
<K255-,index>
Example:
<K255-,5>
This command phrase loads the configuration settings contained in database index 5 to
current, active configuration settings.
Load Current Settings from Configuration Database by ESP
Click the Load Index to
Current button to load
configuration settings
from the selected index
to current, active settings.
Notes on Symbol Type
• The current DataBar Expanded status does not change if it is configured as Enabled
(Stacked) and the database DataBar Expanded status is Enabled.
• The current DataBar-14 status does not change if it is configured as Enabled (Stacked)
and the database DataBar Expanded status is Enabled.
• Data Matrix ECC level is determined by the current settings and not by database settings.
Therefore, the database does not know which ECC level to enable, and has no effect on
current Data Matrix ECC settings.
11-16
MINI Hawk Xi High Performance Imager User Manual
Configuration Database
Request Selected Index Settings
Definition:
Serial Cmd:
Returns configuration settings for the selected database index.
<K255?,index>
Example:
<K255?,5>
This command phrase returns the configuration settings for database index 5.
MINI Hawk Xi High Performance Imager User Manual
11-17
Request All Configuration Database Settings
Request All Configuration Database Settings
Definition:
Serial Cmd:
Returns configuration settings for all indexes in the Configuration Database.
<K255?>
Example:
<K255?>
This command phrase returns the configuration settings for all 10 database indexes.
11-18
MINI Hawk Xi High Performance Imager User Manual
12 Terminal
Contents
Terminal Window........................................................................................................................ 12-2
Find ............................................................................................................................................ 12-3
Send ........................................................................................................................................... 12-4
Macros........................................................................................................................................ 12-5
Terminal Window Menus............................................................................................................ 12-6
This section describes the Terminal window and macro functions in ESP.
MINI Hawk Xi High Performance Imager User Manual
12-1
Terminal Window
Terminal Window
Click this button to display the Terminal view.
The following view will appear:
Copy, paste, save
Clear screen
Type text here to
find matching text
in the Terminal
window.
Terminal
screen
Macros listed
on this bar
Type serial
commands
here.
Click on desired
Macro to run.
Click on Macros arrow to Add Macro,
Remove Macro, or Edit Macro.
The Terminal screen allows you to send serial commands to the imager by using Macros,
by copying and pasting, or by typing commands in the Send text field.
The Terminal screen also displays symbol data or information from the imager.
You can also right-click on the Terminal screen to bring up a menu of further options.
12-2
MINI Hawk Xi High Performance Imager User Manual
Terminal
Find
The Find function allows you to enter text strings to be searched for in the Terminal window.
For example, a series of symbols have been scanned into the Terminal view and you
want to determine if a particular symbol whose data begins with “ABC” has been read.
1. Type “ABC” into the Find box.
2. Press Enter.
The first instance of “ABC” will be highlighted in the Terminal window.
3. Click the Find button to the left of the text field to locate additional instances of
“ABC”.
MINI Hawk Xi High Performance Imager User Manual
12-3
Send
Send
The Send function allows you to enter serial commands and then send them to the imager.
1. Type the command into the Send box.
2. Press Enter.
3. Click the Send button to the left of the text field to send .
12-4
MINI Hawk Xi High Performance Imager User Manual
Terminal
Macros
Macros can be stored in a macro selection bar, edited in a separate window, and executed
by clicking on the macro name.
Click on Next
Row to see
the next row
of macros
Click on the first arrow here to see Add
Macro or Default Macros.
When macros are defaulted, the entire
macro set is restored to the original macro
commands.
Click on subsequent
arrows to edit macros.
When you click on the macro name, the macro is executed in the Terminal window.
If this is a command, it is sent to the reader at the same time that it is displayed.
Editing a Macro
When you click the arrow next to any macro and select Edit, the following appears:
You can edit an existing macro or type in the Macro Name text field and define it in the
Macro Value text field. Click OK.
MINI Hawk Xi High Performance Imager User Manual
12-5
Terminal Window Menus
Terminal Window Menus
Right-click on the Terminal window to display the following menu:
•
•
•
•
•
•
•
•
•
•
•
•
Copy selected text to clipboard.
Paste from Terminal or other text.
Clear all text in Terminal window.
Select All text in the Terminal window.
Save... brings up a Save As dialog.
Change Font... of text in Terminal; brings up a Font dialog.
Change Echo Font... to change typed text; brings up a Font
dialog.
Enable Echo enables Echo text (typed by user).
Change Background Color of Terminal window.
Non-Printable Characters allows you to hide non-printable
characters, or to show them in Standard or Enhanced format.
Default Settings returns all the above settings to default.
Keyboard Macros allows you to create new keyboard macro
commands that can be sent from function keys (F2, F4, F5, etc.)
Terminal Dropdown Menu
The dropdown Terminal menu has Capture Text, Save Current Text, Send File, Find
Next, and Find Previous functions, as well as the same functions defined above.
• Capture Text... lets you append data in real time to a
text file of your choice. While in operation, the text file
cannot be opened. You can select Pause to interrupt
the capture flow or Stop to end the flow and open the
file.
• Save Current Text... saves all text in the Terminal
window to a text file.
• Send File allows you to browse for specific files and
send them to the reader.
• Find Next searches for a user-defined section of text
in the Terminal.
• Find Previous operates in the same way as Find
Next, but searches backward through Terminal text.
12-6
MINI Hawk Xi High Performance Imager User Manual
13 Utilities
Contents
Serial Utility Commands ............................................................................................................. 13-2
Read Rate .................................................................................................................................. 13-4
Counters ..................................................................................................................................... 13-6
Device Control ............................................................................................................................ 13-8
Differences from Default............................................................................................................. 13-9
Master Database ...................................................................................................................... 13-10
Firmware................................................................................................................................... 13-16
Default/Reset/Save................................................................................................................... 13-19
Imager Status Requests ........................................................................................................... 13-21
Learn Operations...................................................................................................................... 13-23
Other Operational Serial Commands ....................................................................................... 13-24
Utility commands are generally commands that are performed during imager operations to
check or determine read rates, or to perform miscellaneous operations on imager hardware.
Serial utility commands are not prefaced with a “K” and a numeric code, nor do they require an
initialization command (<A> and <Z>). They can be entered from within any terminal program
or from ESP’s Terminal or Utilities windows.
MINI Hawk Xi High Performance Imager User Manual
13-1
Serial Utility Commands
Serial Utility Commands
Note: For a list of all K commands, see Serial Configuration Commands.
Type
Read Rate
Counter Request
and Clear
Master Database
Part Number /
Checksum
Device Control
Default/Reset/Save
13-2
Command
<C>
<Cp>
<J>
<N>
<O>
<T>
<U>
<V>
<W>
<X>
<Y>
<G>
<Gn>
<NEWM>
<#>
<#a>
<#b>
<#p>
<!>
<!a>
<!b>
<!p>
<L1>
<L2>
<L3>
<I1>
<I0>
<I>
<H>
<a1>
<A>
<Ard>
<Arp>
<Arc>
<Z>
Name
Enter Decode Rate Test
Enter Percent Rate Test
Exit Decode Rate and Percent Rate Test
No Read Counter
No Read Counter Reset
Trigger Counter
Trigger Counter Reset
Good Read/Match Counter
Good Read/Match Counter Reset
Mismatch Counter
Mismatch Counter Reset
Store Next Symbol Read to Database Index 1
Store Next Symbol Read to Database Index n
New Master Load Status
Display All Firmware Part Numbers
Display Application Code Part Number
Display Boot Code Part Number
Display Profile Module Part Numbers
Display All Available Firmware Checksums
Display Application Code Code Checksum
Display Boot Code Checksum
Display Profile Module Checksum
Programmable Output 1
Programmable Output 2
Programmable Output 3
Targeting System On
Targeting System Off
Disable Imager
Enable Imager
Include PDF Information in Preamble (PDF417)
Reset (does not save for power-on)
Reset and Recall Microscan Defaults
Reset and Recall Power-On Parameters
Reset and Recall Customer Default Parameters
Save Current Settings for Power-On
MINI Hawk Xi High Performance Imager User Manual
Utilities
<Zc>
Default/Reset/Save
<Zrd>
<Zrc>
Imager Status
Request Commands
Learn
Other Operational
Commands
<?>
<K?>
<K??>
<K?#>
<Knnn?>
<Knnn??>
<Knnn?#>
<LEARN>
<UNLEARN>
<LEARN?>
<uy,path,filename>
<dy,path,filename>
<op,9>
<@CAL>
<BCCFG>
<VAL>
MINI Hawk Xi High Performance Imager User Manual
Save Current Settings as Customer Default
Parameters for Power-On
Recall Microscan Default Parameters and Save
for Power-On
Recall Customer Default Parameters and Save
for Power-On
Imager Status Byte
All Status Request
All Descriptor Status Request
All Range Status Request
Single Status Request
Single Descriptor Status Request
Single Range Status Request
Initiate Learn Operation
Initiate Unlearn Operation
Display Learn Status
Y-Modem Upload Transfer Options
Y-Modem Download Transfer Options
Image Library Request
Autocalibrate
Enter Bar Code Configuration
Static Validation
13-3
Read Rate
Read Rate
Click the Utilities button and then the Read Rate tab to
display the Read Rate view.
To see the number of decodes per second,
click the Decodes/sec radio button and
then the Start button.
To see the percentage of decodes, click
the Percent radio button and then the Start
button.
Read Rate information is displayed in
the lower portion of the Utilities view.
Serial commands can also be sent to
the imager from this screen.
13-4
To end a Read Rate test, click the Stop
button (the Start button becomes a Stop
button during an active Read Rate test.)
MINI Hawk Xi High Performance Imager User Manual
Utilities
Read Rate Serial Utility Commands
Enter Decodes/Second Test
Sending <C> instructs the imager to transmit the decodes per second and symbol data
(if any). The decode rate can vary dramatically due to the angle and location of the symbol
in relation to the field of view. This test is very useful in aligning and positioning the imager
during setup.
Enter Percent Test
Sending <Cp> instructs the imager to transmit the percentage of decodes and any
decoded symbol data.
End Read Rate Test
Sending <J> ends both the Percent test and the Decodes/Second test.
MINI Hawk Xi High Performance Imager User Manual
13-5
Counters
Counters
Click the Utilities button and then the Counters tab to
display the Counters view.
Counter commands can be a numeric value from 00000 to 65535. After reaching the
maximum numeric limit of 65535, an error message will be displayed and the counter will
automatically roll over and start counting again at 00000. To obtain the cumulative total of
counts after the rollover has occurred, add 65536 per each rollover (the imager does not
keep track of the number of rollovers) to the current count.
Note: All counter values will be lost if power is cycled, or if the imager receives a Reset or
Save command.
Click the Request button to display the appropriate count or Clear to set the counter to zero.
Trigger, Good Read, No
Read, and Mismatch
counters can be
requested and cleared
simultaneously (Request
All and Clear All buttons)
or individually (Request
and Clear buttons to the
left of each item).
13-6
MINI Hawk Xi High Performance Imager User Manual
Utilities
Counters by Serial Command
No Read Counter
Sending <N> displays the total number of No Reads that have occurred since the last
reset.
No Read Counter Reset
Sending <O> sets the No Read Counter to 00000.
Trigger Counter
Sending <T> displays the total number of triggers since the last reset.
Trigger Counter Reset
Sending <U> sets the trigger counter to 00000.
Good Read/Match Counter (or Good Read Counter)
Sending <V> displays the total number of good reads matching the master symbol, or, if
Master Symbol is not enabled, the number of good reads since the last reset. This counter is always enabled, but will only work as a match count when Master Symbol is
enabled. If Master Symbol is not enabled, this counter records the number of good reads.
This count can be requested at any time.
Good Read/Match Counter Reset
Sending <W> sets the Match Counter to 00000.
Mismatch Counter
Sending <X> displays the number of decoded symbols since the last reset that do not
match the master symbol.
Mismatch Counter Reset
Sending <Y> sets the Mismatch Counter to zero.
MINI Hawk Xi High Performance Imager User Manual
13-7
Device Control
Device Control
Click the Utilities button and then the Device Control
tab to display the Device Control view.
The Output 1 Pulse, Output 2
Pulse, and Output 3 Pulse buttons
activate the link between the + and –
of the host connector. The buttons in
the Extras section Disable or Enable
the reader.
Device Control by Serial Command
Output 1 Pulse
Sending <L1> activates the link between Output 1 (+) and Output 1 (–) of the host connector
(regardless of Master Symbol or Output 1 status).
Output 2 Pulse
Sending <L2> activates the link between Output 2 (+) and Output 2 (–) of the host connector
(regardless of Master Symbol or Output 2 status).
Output 3 Pulse
Sending <L3> activates the link between Output 3 (+) and Output 3 (–) of the host connector
(regardless of Master Symbol or Output 3 status).
Disable Reader
Sending <I> will turn the imager OFF, end the current read cycle, and will not allow the
imager to enter another read cycle until turned ON. This feature is useful during extended
periods of time when no symbols are being decoded, or the imager is being configured.
Disabling the imager will not affect any commands that have already been downloaded.
Enable Reader
Sending <H> will turn the imager ON and allow it to enter read cycles.
13-8
MINI Hawk Xi High Performance Imager User Manual
Utilities
Differences from Default
Click the Utilities button and then the Differences tab to
display the Differences from Default view.
Clicking the Differences from Default button will cause ESP to check all stored configuration
settings and compare them to default settings. All settings that are different than default
will appear in the left column (shown below), and descriptions of those settings will appear
in the right column.
Click this button for a list of ESP
configuration settings that are
different than default settings.
Click Generate Barcode to display the Bar Code
Dialog. Then create configuration symbols containing
the required configuration commands.
Send configuration settings to
the imager without saving by
clicking Send to Reader.
Click Save As to save the
report as plain text or a
tab-delimited text file.
Send configuration settings to the
imager and save in ESP by clicking
Send and Save.
• To create a symbol containing any of the command settings in the table, click Generate
Barcode.
• To save the Differences from Default report, either as plain text or as a tab-delimited
text file, click Save As.
• Click Send and Save to send the settings to the imager and save them, or Send to
Reader to send the settings without saving them.
Important: To use Differences from Default, connect to the imager and Receive
Reader Settings via the Send/Recv button on the toolbar.
MINI Hawk Xi High Performance Imager User Manual
13-9
Master Database
Master Database
Click the Utilities button and then the Master Database
tab to display the Master Database view.
Important: The Master Database is used for all Matchcode modes except Sequential
and Wild Card, both of which use Master Database Index # 1.
Master Database Overview
Used where more than one master symbol is required, as in a Multisymbol setup, for
matching and other Matchcode operations.
Allows the user to define up to 10 master symbols as the master symbol database, which
can be entered by keyboard, scanned in, displayed, or deleted by serial or ESP commands.
1. Click the Master Database tab.
2. Enable Matchcode Type.
3. Set the Master Symbol Database Size.
4. Select the database index in which the master symbol will be entered.
5. Do one of the following to enter master symbol data:
a. Double-click the index row to type data directly into the index.
b. Click the Read Symbol into Selected Index to enter the next decoded symbol.
Set Master Symbol
Database Size here.
Loads the next symbol decoded
into the selected index.
Saves the
database to
the imager.
Loads the imager’s saved
master symbols into ESP.
Double-click a row to enter data into popup text box.
13-10
MINI Hawk Xi High Performance Imager User Manual
Utilities
Master Symbol Database Size
Definition:
Serial Cmd:
Default:
Options:
Number of Master Symbols allows you to select 1 to 10 master symbols
for the master symbol database.
<K231,master symbol database size>
Note: You must follow this command with a save command <A> or <Z>.
1
1 to 10
Set Master Symbol
Database Size here.
Caution: Since the total number of characters available for the master symbol database is
3000, changes to the Master Symbol Database Size will re-allocate the number of
characters available for each master symbol and could cause existing master symbols to
be deleted (except master symbol #1, unless it also exceeds the size limitation).
The table below specifies the maximum number of characters available to each symbol
according the number of master symbols defined, from 1 to 10.
Master Symbol
Number
#1
#2
#3
#4
#5
Maximum
Characters
3000
1500
1000
750
600
MINI Hawk Xi High Performance Imager User Manual
Master Symbol
Number
#6
#7
#8
#9
# 10
Maximum
Characters
500
428
375
333
300
13-11
Master Database
Enter Master Symbol Data
Usage:
Allows you to enter master symbol data for any enabled master symbol index
number (1 to 10), provided the total number of characters does not exceed
the maximum allowed.
Serial Cmd: <K231,master symbol number,master symbol data>
Options:
Enter data for 1 to 10 symbols (any combination of ASCII text up to the
maximum allowed.
For example, to enter data for master symbol 9, after making certain that
master symbol database size is enabled for 9 or more symbols, send
<K231,9,data>.
Important: The ASCII characters <, >, and , can only be entered as hex pairs.
ESP:
Caution: If no data is entered, the existing data will be deleted.
1. Open the Utilities menu.
2. Set the number of master symbols you want to create in Master Symbol
Database Size.
3. Double-click on each symbol number you want to set up and copy, or type
your data in the popup dialog and click OK.
4. When all your data has been entered, click the Send Database to the
Reader button.
13-12
MINI Hawk Xi High Performance Imager User Manual
Utilities
Request Master Symbol Data
Definition:
Serial Cmd:
Returns master symbol data for any enabled master symbols from 1 to 10.
For example, to request master symbol # 5, enter <K231?,5>. The imager
transmits master symbol # 5 data in brackets in the following format: <5/>.
If no master symbol data is available, the output will be: <5/>.
<K231?,master symbol number>
Caution: Be sure to add the ? or you will delete the master symbol.
Note: This command returns the number of master symbols if no number is
included.
ESP:
1. Click the Utilities button and the Master Database tab.
2. Click the Receive Reader’s Database button.
Request All Master Symbol Data
Definition:
Serial Cmd:
This command will return master symbol data for all symbols enabled (up to 10).
<K231?>
MINI Hawk Xi High Performance Imager User Manual
13-13
Read Next Symbol as Master Symbol
Definition:
Serial Cmd:
ESP:
After you’ve set the size in the database, you can order the imager to read
the next symbol as the master symbol for any given master symbol number.
<Gmaster symbol number>
To store the next symbol decoded as master symbol # 1, send:
<G> or <G1>.
To store the next symbol decoded as the master symbol for any other
master symbol database number, send:
<Gmaster symbol number [1-10]>.
For example, <G5> will cause the next symbol read to be entered as master
symbol # 5.
In the Master Database tab under the Output Format menu,
1. Select the master symbol index number in which you want to store the
symbol data.
2. Click the Read Symbol into Selected Index button.
Caution: If you’ve selected an index which already has existing data, that
data will be copied over by new decoded data when you use this command.
Request New Master Status
Usage:
Definition:
Serial Cmd:
Informs the user when a new master symbol is pending and which position
it is in.
Returns the position in the master symbol database that will be loaded on
the next read.
<NEWM>
The imager returns: <NEWM/next master to load>
Once a symbol has been read and loaded, the status will be cleared and the
response will be <NEWM/0>.
(See also New Master Pin in Matchcode.)
13-14
MINI Hawk Xi High Performance Imager User Manual
Utilities
Delete Master Symbol Data
Definition:
ESP:
You can directly delete the master symbol data by serial command or by ESP.
1. Click the Utilities button to access the master symbol.
2. Click the Master Database tab and double-click the symbol number
you want to delete.
3. Delete text and click OK.
Serial Cmd:
<K231,master symbol number,>
To delete a master symbol, enter the database number and a comma, but
leave the data field empty. For example, to delete master symbol # 5, send
the following: <K231,5,>. The command is entered with a blank master
symbol data field, which tells the imager to delete the selected master
symbol from the database.
MINI Hawk Xi High Performance Imager User Manual
13-15
Firmware
Firmware
Click the Utilities button and then the Firmware tab to
display the Firmware view.
Firmware Update
Application code versions are specific to your imager. Consult with your sales representative
before downloading application code. If needed, an application code will be sent to you in
the form of a *.mot file.
To download application code:
1. First, be sure that your imager is connected to the host.
2. Apply power to the imager.
3. Before updating, you should verify the current firmware.
4. Click in the Firmware Update text box and select the file type you want to download.
This will open a file locator box.
5. Navigate to the appropriate file (it will be a *.mot file), open the file and click Start.
Caution: Do not interrupt power or disconnect the host cable while download is in progress.
Be sure that each download is complete before moving on to the next.
Important: When updating firmware, be sure that the application code and boot code
versions are mutually compatible.
13-16
MINI Hawk Xi High Performance Imager User Manual
Utilities
Firmware Verification
Request Part Number by ESP
You can send a request to the imager for part numbers, checksums, boot code, and
application code.
1. Click the Firmware tab.
2. From the pulldown selection box to the left of the Request Part No. button, make
your selection.
3. Select the code type to see its part number displayed in the text field to the right of
the Request Part No. button.
Request Part Number by Serial Command
• When you send <#> (a request for all product part numbers), the imager returns:
<#b/BOOT_P/N><#a/APP_P/N><#p/PROFILE_P/N>.
• When you send <#a> (a request for the application code part number), the imager returns:
<#a/APP_P/N>.
• When you send <#b> (a request for the boot code part number), the imager returns:
<#b/BOOT_P/N>.
• When you send <#p> (a request for profile module part numbers), the imager returns:
<#p/PROFILE_P/N>.
MINI Hawk Xi High Performance Imager User Manual
13-17
Firmware
Request Checksum by ESP
You can send a request to the imager for part numbers, checksums, boot code, and
application code.
1. Click the Firmware tab.
2. From the pulldown selection box to the left of the Request Checksum button, make
your selection.
3. Select the code type to see its checksum displayed in the text field to the right of the
Request Checksum button.
Request Checksum by Serial Command
• When you send <!> (a request for all available firmware checksums), the imager returns:
<!b/BOOT_CHECKSUM><!a/APP_CHECKSUM><!p/PROFILE_CHECKSUM>
• When you send <!a> (a request for the application code checksum), the imager returns:
<!a/APP_CHECKSUM>
• When you send <!b> (a request for the boot code checksum), the imager returns:
<!b/BOOT_CHECKSUM>
• When you send <!p> (a request for profile module checksum), the imager returns:
<!p/PROFILE_CHECKSUM>
13-18
MINI Hawk Xi High Performance Imager User Manual
Utilities
Default/Reset/Save
Understanding and controlling your imager’s active, saved, and default settings is critical
to its successful operation.
Saved for Power-on
Resets
(not saved
for power-on)
Function
Serial
Cmd
ESP (first, right-click in
any menu tree)a
EZ Button
<A>
Save to Reader,
Send No Save
No
<Ard>
No
No
<Arp>
No
No
<Arc>
No
No
Reset
Reset and Recall Microscan
Defaults
Reset and Recall Power-On Parameters
Reset and Recall Customer Default
Parameters
Save to Reader,
Send and Save
Save to Reader,
Send and Save Customer
Defaults for Power-Onb
Save Current Settings for Power-On
<Z>
Save Current Settings as Customer
Default Parameters for Power-On
<Zc>
Recall Microscan Default Parameters
and Save for Power-On
<Zrd>
No
No
Recall Customer Default Parameters
and Save for Power-On
<Zrc>
No
Press and
hold while
powering on
imager
No
No
a. When you right-click in a menu tree and select Default Current Menu Settings or Default All ESP
Settings, it is important to note that only ESP settings are defaulted. To save these defaults to the
reader itself, you need to follow up with a Save to Reader, Send and Save command.
b. Only available in ESP if enabled under the Options pulldown menu.
Resets
Resets (“A” commands) affect only the current settings (active memory) and are not saved
for power-on.
Saved for Power-on
Power-on parameters (“Z” commands) are saved to NOVRAM and recalled and loaded
into current parameters when power is cycled to the imager or the <Arp> command is
issued.
Defaults
Defaults are Microscan firmware settings or saved customer settings that can be recalled,
either by software or hardware reset.
MINI Hawk Xi High Performance Imager User Manual
13-19
Default/Reset/Save
Customer Default Parameters
Customer default parameters (saved by <Zc>) are the same set of parameters as power-on
parameters but are saved in a different, isolated section of NOVRAM. This allows a user
essentially to create a backup set of parameters that can be recalled in the event that the
current parameters or power-on parameters have been accidentally changed or are no
longer desired.
It is important to note that a hardware default does not affect customer default parameters.
For example, a user that has inadvertently changed communication settings and saved
them with a <Z> command, may not know the correct settings or have the capability to
communicate within those settings. By first doing an EZ button default or hardware default
to restore the known Microscan defaults, the user can then recall the previous customersaved settings with an <Arc> or <Zrc> command.
Microscan Default Parameters
Microscan default parameters are contained in the firmware and cannot be changed.
Software Defaults
Microscan default parameters can be recalled (loaded into current settings) with <Ard>
command or recalled and saved for power-on with the <Zrd> command.
Hardware Default
If a software default and reset is not possible, it may be necessary to reset the reader by
shorting (connecting) specific pins. This procedure has the same effect as the <Zrd>
software command.
Important: For this reset to occur, this command must be executed within 60 seconds of a
power-on or a reset.
1. Apply power to the reader.
2. Locate Pin 3 (Default) and Pin 7 (Ground) on the M12 connector. (Access depends on
wiring configuration. May require a QX-1 and accessory cable).
Caution: Be certain that the correct pins are located. Connecting the wrong pins could
cause serious damage to the unit.
3. Momentarily connect these wires (or pins) and listen for a series of short beeps.
4. Within 3 seconds, connect them again. A longer beep should be heard. If not, repeat
the process.
Default on Power-On
You can also use the EZ button to default the reader by holding it down while applying
power to the reader, provided that this feature is enabled.
13-20
MINI Hawk Xi High Performance Imager User Manual
Utilities
Imager Status Requests
<?> Status Byte
The imager responds to a status request <?> with a two character hex value, such as <?/22>.
To determine status:
1. Look up the binary conversion in the table below.
For example, the first hex 2 would be 0 0 1 0 in binary, as read from binary digits 3
through 0; the second hex 2 is also 0 0 1 0 as read from binary digits 7 through 4.
2. Next, enter your binary values from the table below in the
“Binary” column next to the appropriate bit.
Binary
Bit
0
1
2
3
4
5
Binary
0
1
0
0
0
1
Imager Status
Command error detected
Command received
Communication error detected
Flash sector unprotect failure
Host port buffer overflow
Imager is in a read cycle
3. Under “Binary,” interpret 1s as true and 0s as not true. For
example, bit 1 has a 1 in the “Binary” column, indicating
“Command Received”. Bit 5 is also a 1, indicating that the
“Imager is in a read cycle”.
<K?> All Status Request
Hex
Value
0
1
2
3
4
5
6
7
8
9
A
B
C
D
E
F
Bit Digits
7
6
5
4
3
2
1
0
0
0
0
0
0
0
0
0
1
1
1
1
1
1
1
1
0
0
0
0
1
1
1
1
0
0
0
0
1
1
1
1
0
0
1
1
0
0
1
1
0
0
1
1
0
0
1
1
0
1
0
1
0
1
0
1
0
1
0
1
0
1
0
1
This is the fastest way to learn the imager’s current configuration. Sending this request will
return the current settings of all commands, starting with the lowest K command value and
ending with the highest K command value.
<K??> All Descriptor Status Request
This request will return all current descriptors for every K command, starting with the lowest
K command value and ending with the highest K command value.
<K?#> All Range Status Request
This request will return the current settings of all commands within the user-defined range,
starting with the lowest user-defined K command value and ending with the highest
user-defined K command value.
MINI Hawk Xi High Performance Imager User Manual
13-21
Imager Status Requests
<Knnn?> Single Status Request
This request will return the value of the variables associated with the requested K command.
The request of a single entry of a database command cannot exceed the number of database
slots for the specific command.
<Knnn??> Single Descriptor Status Request
This request returns the basic functional description of all fields in the requested K command.
<Knnn?#> Single Range Status Request
This request will return the value range and storage type description of all fields in the
requested K command.
<Knnn?*> Display Command Wildcard
This request will return the individual K command status, description, and range for each
parameter.
13-22
MINI Hawk Xi High Performance Imager User Manual
Utilities
Learn Operations
Learn
Sending the <LEARN> command from ESP’s Terminal will put the imager into a mode of
operation that will cause it to “learn” the next Data Matrix symbol decoded. This mode of
operation will remain active until either a Data Matrix symbol is decoded or the call is
made to disable the mode and revert back to normal operation. Upon decoding a Data
Matrix symbol, the image processing will save pertinent information regarding the target
symbol to allow it to be processed more quickly and consistently.
The data collected by the Learn operation can be saved for a Power-On condition by
sending the <Z> command.
Unlearn
Sending the <UNLEARN> command will cause the imager to discard any information
acquired during a Learn operation.
The Unlearn state can be saved for a Power-On condition by sending the <Z> command.
Learn Status
Sending the <LEARN?> request will return the current status of Learn operations.
Responses are sent in this format:
<LEARN,0> (Default; symbol has not been learned.)
<LEARN,1> (Learn operation in progress.)
<LEARN,2> (Symbol has been learned.)
Learn Persistence
The learn state and parameters persist in the same way as ordinary parameters.
Examples:
• A MINI Hawk Xi in a Learned state has not been saved. Cycling power will remove any
Learned state information and the imager will power-on in its configured state.
• A MINI Hawk Xi is saved in a Learning state. The imager will power-on in the Learning
state and will learn the first Data Matrix symbol decoded.
• A MINI Hawk Xi is saved in a Learned state. The imager will power-on in the Learned
state and will only decode the learned symbol type.
• A MINI Hawk Xi in a Learned state is issued a reset default command <Ard>. The unit
will return to an Unlearned state but if power is cycled it will return to its saved state.
MINI Hawk Xi High Performance Imager User Manual
13-23
Other Operational Serial Commands
Other Operational Serial Commands
The following serial utility commands can be entered from ESP’s Terminal or a PLC:
Y-Modem Upload Transfer Options
<uy,path,filename>
Y-Modem Download Transfer Options
See MINI Hawk Xi Image Output for an explanation of how to use this feature.
<dy,path,filename>
Image Library Request
<op,9> Manages files in a selected directory.
File Source
(Nothing)
/
/saved
*.*
/del
/saved/del
del*.*
13-24
Explanation
All files in “root” directory
All files in “root” directory
All files in “saved” directory
All files in all directories
Deletes all files in the root director
Deletes all files in the saved directory
Deletes files in all directories
MINI Hawk Xi High Performance Imager User Manual
Utilities
Bar Code Configuration Mode
Definition:
Serial Cmd:
Bar Code Configuration Mode is a way of programming the imager by
using ECC 200 Data Matrix symbols.
<BCCFG>
Bar Code Configuration Mode can be entered three different ways:
1. By forcing the imager into Bar Code Configuration Mode by serial command
<BCCFG>.
2. By configuring one of the 4 EZ Button positions to Bar Code Configuration Mode.
3. By reading a Data Matrix symbol with a special code word used by ISO/IEC 16022
to signify imager programming. This can be either in a regular read cycle or during a
read rate test. Reading this symbol in the calibration routine will have no effect.1
Once Bar Code Configuration Mode has been entered, the Data Matrix symbols can be
thought of as serial data. You can configure the imager by printing labels in Microscan’s
serial command format. Commands are processed as if the data were streamed in
through the serial port. The imager will acknowledge the symbol with a beep, green flash,
and echo the serial data to the host. If the command causes the imager to produce more
serial output, such as serial verification or counter requests, the data will be routed to the
host port.
Bar Code Configuration Mode can be exited by any reset <A> or <Z> command as well
as a <J> or a quick press and release of the EZ Button.
The command to exit Bar Code Configuration Mode can be included as part of the Data
Matrix symbol. For example, try encoding <K200,4><K220,1><J> into a Data Matrix symbol.
This configures the imager to enable Serial Trigger Mode, to program a new trigger to end
the read cycle, and to exit Bar Code Configuration Mode with <J>.
To end all EZ Button functions, press the EZ Button once and quickly release.
1. In normal reading modes, it is required to read a special Data Matrix symbol with a special codeword used by
ISO/IEC 16022 to signify imager programming.
MINI Hawk Xi High Performance Imager User Manual
13-25
Other Operational Serial Commands
13-26
MINI Hawk Xi High Performance Imager User Manual
14 Output Format
Contents
Output Format Serial Commands............................................................................................... 14-2
Output Format Status ................................................................................................................. 14-3
Format Assign ............................................................................................................................ 14-4
Format Extract............................................................................................................................ 14-5
Format Insert .............................................................................................................................. 14-7
Output Filter Configuration ......................................................................................................... 14-9
Number of Filters..................................................................................................................... 14-14
This section explains how to control the formatting and filtering of decoded symbol data for output.
MINI Hawk Xi High Performance Imager User Manual
14-1
Output Format Serial Commands
Output Format Serial Commands
Format Extract
Format Insert
Format Assign
Format Status
Output Filter Configuration
Ordered Output Filter
14-2
<K740,output index,start location,length>
<K741,output index,length,hex string>
<K742,symbol number,status>
<K743,output format status>
<K744,filter number,symbology,length,wildcard,placeholder
data,unused,database index>
<K745,number of filters>
MINI Hawk Xi High Performance Imager User Manual
Output Format
Output Format Status
Definition:
This is a global enable/disable parameter. In order to use formatting you
must set up the format using the insert and extract commands, and you
must also assign a symbol to format using the Format Assign command.
Serial Cmd:
<K743,output format status>
Default:
Disabled
Options:
0 = Disabled
1 = Enabled
Output Format Status Disabled
When Output Format Status is set to Disabled, output formatting is globally disabled.
Output Format Status Enabled
When Output Format Status is set to Enabled, output formatting is enabled. However,
Format Assign, Format Insert, and Format Extract must be properly set up as well.
Output Format Status by ESP
On the Output Format tab, check the Enable Output Format box.
MINI Hawk Xi High Performance Imager User Manual
14-3
Format Assign
Format Assign
Symbol Number
Definition:
Symbol Number refers to the number of the symbol to which output formatting
will apply. For example, if you wish to enable user-defined formatting to
symbol # 2 in a multisymbol read cycle, you would send the command
<K742,2,1>.
Note that the number of symbols may exceed the format capabilities.
Serial Cmd: <K742,symbol number,status>
Options:
1 to 10
1 = Formatted output status for symbol # 1.
2 = Formatted output status for symbol # 2.
...
10 = Formatted output status for symbol # 10.
Status
Definition:
Status refers to the user-defined formatting of a selected symbol position in
the read cycle result. Note that there is also a global formatting “enable”
command that must be set for the formatting to be applied.
Serial Cmd: <K742,symbol number,status>
Default:
Disabled
Options:
0 = Disabled
1 = Enabled (Assign parameters to specified symbol.)
Format Assign by ESP
Use the Set Number of Symbols spin box to
determine the number of symbols to be included
in the output phrase.
Then check the Parse boxes beneath
the symbols that you wish to format
for user-defined output.
14-4
MINI Hawk Xi High Performance Imager User Manual
Output Format
Format Extract
Output Index
Definition:
Output Index refers to the database entry you wish to modify with this command.
A formatted output is built by extracting data from a symbol’s original data
output and/or inserting user-defined characters.
It may be helpful to think of individual indexes as positions in the final formatted
output you wish to build. Starting with index # 1, enter either an extract or
insert command to begin building your desired output string. Then, with the
next index number, enter either an extract or insert command to continue
building the output string. Continue this process until you are finished building
the string.
Serial Cmd: <K740,output index,start location,length>
Options:
1 to 100
Start Location
Definition:
Defines the location within the symbol data where the character extraction will
begin. The first character extracted will also be the first character in the
sequence displayed in user-defined output.
Serial Cmd: <K740,output index,start location,length>
Default:
0
Options:
1 to n (maximum number of characters in the symbol data).
Length
Definition:
Defines the length (in consecutive characters) that will be extracted and
placed in user-defined output.
Serial Cmd: <K740,output index,start location,length>
Default:
0 (disabled; end of format cell array)
Options:
1 to n (maximum number of characters in the symbol data).
MINI Hawk Xi High Performance Imager User Manual
14-5
Format Assign
Format Extract by ESP
The Extract Range
function corresponds to
the Start Location and
Length parameters in
the Format Extract
serial command.
Multiple character sequences can be extracted and inserted using Symbol Parse. In this example,
the selected extraction range is characters 2-4. The “Sample Symbol” example on the Symbol
Parse dialog shows the selected character positions extracted and output as desired. Simultaneously,
the data string from the selected symbol is displayed at the bottom left of the Parse Table, followed
by the user-defined extracted output.
14-6
MINI Hawk Xi High Performance Imager User Manual
Output Format
Format Insert
Output Index
Definition:
Output Index refers to the database entry you wish to modify with this command.
A formatted output is built by extracting data from a symbol’s original data
output and/or inserting user-defined characters.
It may be helpful to think of individual indexes as positions in the final formatted
output you wish to build. Starting with index # 1, enter either an extract or
insert command to begin building your desired output string. Then, with the
next index number, enter either an extract or insert command to continue
building the output string. Continue this process until you are finished building
the string.
Serial Cmd: <K741,output index,length,hex string>
Options:
1 to 100
Length
Definition:
Specifies the length of the user-defined character string that will be inserted.
This function is limited to 4 characters per output index, so multiple indexes
must be entered in order to insert longer character sequences.
For example, if you wish to insert a 10 character sequence in user-defined
output, you would need three commands with consecutive index numbers,
where the first two character sequence lengths were 4 and the third was 2.
Serial Cmd: <K741,output index,length,hex string>
Default:
0 (disabled; end of format cell array)
Options:
1 to 4
Hex String
Definition:
Specifies a character string that represents ASCII characters to be inserted in
the database entry. Two hex characters are required for every ASCII character
to be inserted in the user-defined output string. These two characters comprise
the hex (base 16) value of the ASCII character.
For example, if you wanted to enter the three-character sequence “Hi!” you
would enter 3 for the length of the string, and a hex sequence of 486921 for
the ASCII sequence to be inserted. (48 = H; 69 = i; 21 = !)
Important: Each pair of hex characters represents one ASCII character. Hex
character pairs range from 00 to FF. Since you are limited to 4 ASCII characters
per insertion per database entry, you are likewise limited to 8 hex characters
per insertion per database entry.
Serial Cmd: <K741,output index,length,hex string>
Default:
NUL (00 in hex)
Options:
00 to FF (As many as 4 bytes, or hex pairs.)
MINI Hawk Xi High Performance Imager User Manual
14-7
Format Insert
Format Insert by ESP
The Insert process is very similar to the
Extract process, except that Insert
allows the user to enter characters using
the Insert calculator (shown above).
Notice that Extract
and Insert share the
same Parse Table.
14-8
MINI Hawk Xi High Performance Imager User Manual
Output Format
Output Filter Configuration
Definition:
Output filtering is a method of providing a set of good read qualifiers and also
providing ordered output. There is a filter for up to the first 10 positions in a
multisymbol output. The first filter corresponds to the first symbol output at the
end of the read cycle. Each filter has has settings for the following four
parameters: Symbology, Symbol Length, Data, and Configuration Database
Number.
Serial Cmd: <K744,filter number,symbology,length,wildcard,placeholder,data,
unused,database index>
Rules for Output Filter Configuration
Output Filter Configuration Rule # 1
Each symbol that is decoded must match one of the filters before it can be saved to a read
cycle record. There is an exception to this rule, however, when the number of symbols
required for a read cycle exceeds the number of active filters. In such a case, unfiltered
symbols can be placed into unfiltered output positions.
For example, if the number of symbols required is 6 but there are only 4 active filters, the
last 2 positions can be filled by any (unfiltered) qualified symbol.
Output Filter Configuration Rule # 2
The same filter setup can be used multiple times.
For example, filters 1, 2, and 3 can be set up to filter Data Matrix symbols, and the output
will occur in the order the symbols are decoded.
Output Filter Configuration Rule # 3
All qualified symbols will be sorted and output in the matching filter position. If a symbol
matches filter 3, it will be output as the third symbol. If a filter does not have a matching
qualified symbol, a No Read message will be output in place of the symbol (assuming the
No Read message is enabled).
For example, if there is not a symbol that meets filter 3’s requirements, then a No Read
message will be output in the third output position.
MINI Hawk Xi High Performance Imager User Manual
14-9
Output Filter Configuration
Filter Number
Definition:
This is the filter index number that represents the position of the symbol in the
data output at the end of the read cycle. This index number should be entered
along with the following filter settings for the predetermined symbol position.
Serial Cmd: <K744,filter number,symbology,length,wildcard,placeholder,data,
unused,database index>
Options:
1 to 10
Symbology
Definition:
Specifies the symbology allowed to occupy this location in multisymbol output.
Note: To filter or order a symbol, the symbol must meet all the requirements
of the selected filter index.
Serial Cmd: <K744,filter number,symbology,length,wildcard,placeholder,data,
unused,database index>
Default:
0 (any symbology)
Options:
0 = Any type
1 = Interleaved 2 of 5
2 = Code 39
3 = Code 128
4 = Codabar
5 = UPC
6 = PDF417
7 = EAN 128
8 = Code 93
9 = Pharmacode
10 = GS1 DataBar (RSS)
11 = MicroPDF417
12 = Composite
13 = BC412
14 = Data Matrix
15 = QR Code
16 = Micro QR Code
17 = Aztec Code
18 = Postal Symbologies
14-10
MINI Hawk Xi High Performance Imager User Manual
Output Format
Length
Definition:
Specifies the length of the decoded symbol allowed to occupy this location in
multisymbol output.
Note: To filter or order a symbol, the symbol must meet all requirements of
the selected filter index.
Serial Cmd: <K744,filter number,symbology,length,wildcard,placeholder,data,
unused,database index>
Default:
0
Options:
0 to 64
Wildcard
Definition:
This is the character to be used in the data output field when performing a
data filter comparison. The wildcard character represents the end of matching,
and allows for variable lengths of symbol output.
Serial Cmd: <K744,filter number,symbology,length,wildcard,placeholder,data,
unused,database index>
Default:
“ * “ = 2A (hex)
Options:
Any ASCII input in the form of a pair of hex characters.
Example:
2A = *
00 = disabled
Placeholder
Definition:
The placeholder character requires a character to be present, but does not
compare the data value.
Serial Cmd: <K744,filter number,symbology,length,wildcard,placeholder,data,
unused,database index>
Default:
“ ? ” = 3F (hex)
Options:
Any ASCII input in the form of a pair of hex characters.
Example:
3F = ?
00 = disabled
MINI Hawk Xi High Performance Imager User Manual
14-11
Output Filter Configuration
Data
Definition:
This is the data string to be used when comparing symbol data for output filtering
and ordering. This data string may also contain wildcard and placeholder
characters to facilitate matching. Remember that in order to filter or order
symbol data, it must meet all the requirements of the selected filter index.
Examples:
• Filter data = “123*”. This will match data strings of “123”, “123456”, and
“123ABC”, but not “12”.
• Filter data = “123*AB?C”. This will be interpreted as “123*”.
• Filter data = “123?”. This will match “1234” and “123A”, but not “123”,
“12345”, or “1234C”.
• Filter data = “123?A”. This will match “1234A” and “123BA”, but not
“123”, “1234C”, or “1234ABCD”.
• Filter data = “123?A?”. This will match “1234AB” and “123BAT”, but not
“1234A” or “123BATS”.
• Filter data = “12??*”. This will match “1234”, “123456”, and “123ABC”,
but not “12” or “123”.
• Filter data = “123?A*”. This will match “1234A”, “123BA”, and
“123BATS”, but not “1234” or “1234C”.
Serial Cmd: <K744,filter number,symbology,length,wildcard,placeholder,data,
unused,database index>
Default:
00 (NUL)
Options:
Any ASCII input in the form of a pair of hex characters.
Maximum length: 63 bytes defined.
Examples:
41422A = AB*
Data [0] = NUL represents string matching disabled.
Database Index
Definition:
The index of the database entry that decodes a given symbol must equal this
setting for filtering to occur. A setting of 0 allows any database index for this
filter entry.
Serial Cmd: <K744,filter number,symbology,length,wildcard,placeholder,data,
unused,database index>
Default:
0 (any index)
Options:
0 to 10
14-12
MINI Hawk Xi High Performance Imager User Manual
Output Format
Ordered Output Filter Configuration by ESP
Double-clicking on a row in the
Ordered Output table brings up the
Ordered Output Filter Settings
dialog.
Use these settings to determine
Symbology Type, Length of the
symbol, a user-defined Matching
String, ASCII Lookup, Wildcard
Character, Placeholder Character,
and Database Number. Click
Apply to save the settings to the
corresponding filter.
MINI Hawk Xi High Performance Imager User Manual
14-13
Number of Filters
Number of Filters
Definition:
Number of Filters refers to the number of active output filters. 0 disables all
output filters. Any non-zero numeral will enable filtering to be performed
using the filter indexes covered by this value.
For example, if the number of filters is 1, then only filter index # 1 will be
applied. If the number of filters is 2, then only filter index # 1 and filter index # 2
will be applied, etc.
Serial Cmd: <K745,number of filters>
Default:
0
Options:
0 to 10
14-14
MINI Hawk Xi High Performance Imager User Manual
Appendices
Contents
Appendix A General Specifications .............................................................................................. A-2
Appendix B Electrical Specifications ............................................................................................ A-9
Appendix C Serial Configuration Commands............................................................................. A-17
Appendix D Communications Protocol....................................................................................... A-23
Appendix E ASCII Table............................................................................................................. A-32
Appendix F Operational Tips...................................................................................................... A-33
Appendix G Using an External Trigger....................................................................................... A-34
Appendix H MINI Hawk Xi Image Output ................................................................................... A-35
Appendix I Using EtherNet/IP..................................................................................................... A-38
Appendix J Allen-Bradley Version 20 PLC Setup, Trigger and Read......................................... A-47
Appendix K Glossary of Terms................................................................................................... A-59
MINI Hawk Xi High Performance Imager User Manual
A-1
General Specifications
Appendix A — General Specifications
Mechanical
Height: 1" (25.4 mm)
Width: 1.8" (45.7 mm)
Depth: 2.1" (53.3 mm)
Weight: 3.2 oz. (91 g)
Note: Nominal dimensions shown.
Typical tolerances apply.
Environmental
Enclosure: IP54, category 2
Humidity: Up to 90% (non-condensing)
Operating Tempurature: 0° to 40°C (32° to 104°F)
Storage Tempurature: -50° to 75° C (-58 to 167°F)
CE Mark
EN 55024:1998 ITE Immunity Standard
EN 55022:98 ITE Disturbances
Light Source
Type: High output LEDs
Light Collection Options
Progressive scan, square pixel; Software-adjustable
shutter speed, electronic shutter
SXGA: 1280 by 1024 pixels
WVGA: 752 by 480 pixels
Symbologies
2D Symbologies: Data Matrix (ECC 0-200), QR
Code, Micro QR Code, Aztec Code
Stacked Symbologies: PDF417, MicroPDF417,
GS1 DataBar (Composite and Stacked)
Linear Symbologies: Code 39, Code 128,
BC412, Interleaved 2 of 5, UPC/EAN, Codabar,
Code 93, Pharmacode, PLANET, PostNet, Japanese
Post, Australian Post, Royal Mail, Intelligent Mail, KIX
Read Parameters
Pitch: ±30° Skew: ±30° Tilt: 360°
Decode Rate: Up to 60 decodes per second (HS model)
Focal Range: 1.3 to 9.3” (33 to 236 mm) (autofocus)
MINI Hawk Xi Dimensions
Connector
Dual Cable: 6 ft. industrial Ethernet cable with RJ45 plug and 3 ft. cable with M12 plug
Indicators
LEDS: Read Performance, Power, Read Status
Green Flash: Good Read
Blue Target Pattern: Symbol locator
Beeper: Good Read, match/mismatch, No Read, serial command confirmation, on/off
Communication Interface
Standard Interfaces: RS-232 and Ethernet TCP/IP
Discrete I/O
Trigger Input, New Master: Bi-directional, optoisolated, 4.5-28V rated (10 mA @ 28 VDC)
Outputs (1, 2, 3): Bi-directional, optoisolated, 1-28V rated, (ICE < 100 mA at 24 VDC, current limited by user)
A-2
MINI Hawk Xi High Performance Imager User Manual
Appendices
Read Ranges
Ultra High Density
High Density
Standard Density
MINI Hawk Xi High Performance Imager User Manual
A-3
General Specifications
Read Ranges (cont.)
MINI Hawk Xi WVGA
Narrow-bar-width
1D
2D
Field of View
(maximum)
Read Range
(with autofocus)
Ultra High Density
.0033" (.08 mm)
.005" (.13 mm)
1.6" (40 mm)
1.9 to 4.4" (47 mm to 110 mm)
.0075" (.19 mm)
.010" (.25 mm)
2.5" (64 mm)
1.7 to 6.7" (42 mm to 170 mm)
.015" (.38 mm)
.020" (.51 mm)
2.9" (74 mm)
1.5 to 8.0" (38 mm to 203 mm)
Standard Density
.005" (.13 mm)
.0075" (.19 mm)
2.8" (72 mm)
.0075" (.19 mm)
.010" (.25 mm)
3.8" (97 mm)
1.6 to 4.4" (41 mm to 112 mm)
1.5 to 6.2" (38 mm to 157 mm)
.010" (.25 mm)
.015" (.38 mm)
4.7" (118 mm)
1.4 to 7.6" (36 mm to 193 mm)
.020" (.51 mm)
.030" (.76 mm)
6.2" (158 mm)
1.3 to 10.0" (33 mm to 254 mm)
MINI Hawk Xi SXGA
Narrow-bar-width
1D
2D
Field of View
(maximum)
Read Range
(with autofocus)
Ultra High Density
.0033" (0.08 mm)
.005” (0.13 mm)
2.2” (56 mm)
2.0 to 4.4” (51 mm to 112 mm)
.0075" (0.19 mm)
.010” (0.25 mm)
3.6” (91 mm)
1.9 to 6.7” (48 mm to 170 mm)
.015" (0.38 mm)
.020" (0.51 mm)
4.0” (102 mm)
1.9 to 7.7” (48 mm to 196 mm)
High Density
.005" (0.13 mm)
.0075" (0.19 mm)
3.1" (79 mm)
1.5 to 6.0" (38 mm to 152 mm)
.0075" (0.19 mm)
.010" (0.25 mm)
4.2" (107 mm)
1.2 to 8.0" (30 mm to 203 mm)
.015" (0.38 mm)
.020" (0.51 mm)
5.6" (142 mm)
0.9 to 10.5" (23 mm to 267 mm)
Standard Density
.005" (0.13 mm)
.0075" (0.19 mm)
3.2" (81 mm)
1.8 to 3.5" (46 mm to 89 mm)
.0075" (0.19 mm)
.010" (0.25 mm)
4.2" (107 mm)
1.6 to 5.0" (41 mm to 127 mm)
.010" (0.25 mm)
.015" (0.38 mm)
6.8" (173 mm)
1.4 to 7.5" (36 mm to 191 mm)
.020" (0.51 mm)
.030" (0.76 mm)
9.5" (241 mm)
1.0 to 11.0” (25 mm to 279 mm)
Subject to change.
A-4
MINI Hawk Xi High Performance Imager User Manual
Appendices
Safety Certifications
FCC, UL/cUL, CE, CB Class A, RoHS/WEEE
©2015 Microscan Systems, Inc.
All rights reserved. Specifications subject to change.
Product specifications are given for typical performance at 25°C (77°F) using grade A labels. Performance
characteristics may vary at high temperatures or other environmental extremes. Warranty–One year limited
warranty on parts and labor. Extended warranty available.
MINI Hawk Xi High Performance Imager User Manual
A-5
General Specifications
QX-1 Interface Device
Mechanical
Height: .75" (19.1 mm)
Width: 2.50" (83.5 mm)
Depth: 3.15" (80 mm)
Weight: 7 oz. (200 g)
QX-1 Dimensions
A-6
MINI Hawk Xi High Performance Imager User Manual
Appendices
FIS Options
MINI Hawk Xi High Performance Imager
Standard Density
MINI Hawk Xi, WVGA, Standard Density, Ethernet, 24VDC
MINI Hawk Xi, SXGA, Standard Density, Ethernet, 24VDC
High Density
MINI Hawk Xi, SXGA, High Density, Ethernet, 24VDC
Ultra-High Density
MINI Hawk Xi, WVGA, Ultra-High Density, Ethernet, 24VDC
MINI Hawk Xi, SXGA, Ultra-High Density, Ethernet, 24VDC
FIS-6310-1100G
FIS-6310-1110G
FIS-6310-1210G
FIS-6310-1300G
FIS-6310-1310G
Accessories
Power Suppy
Power Supply, M12 12-pin Socket, 1.3 m (Screw-On)
Communication Devices and Cables
QX-1 Interface Device
Host Cable, MS-Connect 210 to Host, User-Stripped to 9-pin
Host Cable, 9-pin to RJ12, 6’ (1,829 mm)
Cordset, Common, M12 12 Pin, Socket (Screw-on) to M12 12 Pin Plug (Screw-on), 3M
Cordset, Common, M12 12 Pin, Socket (Screw-on) to M12 12 Pin Plug (Screw-on), 1M
Cordset, Host, Serial M12 12 pin Socket (Screw-on) to DB9 Socket, 1M
Cordset, Host, Serial, M12 12 pin Socket (Screw-on) to DB9 Socket, 3M
Cordset, M12 12 Pin Socket (Screw-on) to Flying Leads, 3M
MS-Connect 210, Connectivity Box with Display
MS-Connect 210, Connectivity Box
MS-Connect 210, Connectivity Box with Display and Ethernet
MS-Connect 210, Connectivity Box with Ethernet
Relay Module, 120VAC, 3 Amp Output, Series 70, Type SM for MS-Connect 210
Relay Module, 240VAC, 3 Amp Output, Series 70, Type SM for MS-Connect 210
Relay Module, 24VDC, 3 Amp Output, Series 70, Type SM for MS-Connect 210
Other Accessories
Trigger Connector, 4-pin Plug (screw terminal and field-wireable) (for self-wiring)
Object Detectors
Photo Sensor, Visible, NPN, Dark On
Photo Sensor, Visible, NPN, Light On
Photo Sensor, M12 4pin Plug, NPN, Dark Off, 2m
Photo Sensor, M12 4-pin Plug, NPN, Dark On, 2 m
Mounting Options
Mounting Arm Kit: An adjustable mounting arm with ball and socket connections that allow
the arm to be positioned in almost any orientation.
Extension Joint Kit: Allows the mounting arm to be extended. Kit includes extension joint
and mounting arm.
Base Plate Kit: Plate for desktop presentation, 6” x 6” (152.4 mm x 152.4 mm).
MINI Hawk Xi High Performance Imager User Manual
97-000003-03
98-000103-02
61-000105-01
61-000108-01
61-000148-02
61-000162-02
61-000153-02
61-000164-02
61-000167-02
FIS-0210-0001G
FIS-0210-0002G
FIS-0210-0003G
FIS-0210-0004G
98-000013-04
98-000013-05
98-000013-06
20-610024-01
99-000017-01
99-000017-02
99-000020-01
99-000020-02
98-000048-01
98-000053-01 (4”)
98-000053-02 (3”)
98-000054-01
A-7
General Specifications
Through-Hole Mount Bracket: Allows the reader to be mounted to various surfaces.
Side Mount Bracket: Allows the reader to be mounted at a 90º angle.
Right Angle Mirror Kit: Changes field of view direction by 90º.
Diffuser Kit: Improves readability of direct part marks.
Documentation
Microscan Tools Drive (Software, User Manuals, Quick Start Guides, Configuration
Guides, links to other documents on Microscan website
Note: Additional accessories are available in the Microscan Product Pricing Catalog.
A-8
98-000057-02
98-000060-01
98-000088-01
98-000098-01
37-000010-01
MINI Hawk Xi High Performance Imager User Manual
Appendices
Appendix B — Electrical Specifications
Power: 10-30 VDC, 200 mV p-p max ripple, 132 mA @ 24 VDC (typ.)
MINI Hawk Xi Connectors
Output 2
New Master
Default
Power
Output 1
RS-232
(Host) TxD
Output 3
Trigger
Ground
RS-232 (Host) RxD
Input Common
Output Common
M12 12-pin Plug
Pin
1
2
3
4
5
6
7
8
9
10
11
12
Function
Trigger
Power
Default
New Master
Output 1
Output 3
Ground
Input Common
RS-232 (Host) RxD
RS-232 (Host) TxD
Output 2
Output Common
RJ45 Plug
Wire Color
White
Brown
Green
Yellow
Gray
Pink
Blue
Red
Black
Violet
Gray/Pink
Red/Blue
MINI Hawk Xi High Performance Imager User Manual
Pin
1
2
3
4
5
6
7
8
Function
TX (+)
TX (–)
RX (+)
NC
NC
RX (–)
NC
NC
A-9
Electrical Specifications
QX-1 Connectors
Connector T on the QX-1 Interface Device is the Trigger connector.
Connectors 1, 2, and 3 can be used to bus power and data as required by the application.
The connectors on the QX-1 interface device physically mirror those on the imager, but they
do not have explicit pin assignments. The QX-1 connectors take on the communications and
power roles that are assigned to them.
Trigger
Ground
+10-28V
Trigger/New Master / Input 1 Common
QX-1 Trigger Connector
4-pin Socket
1 +10-28V
2 Trigger / New Master /
Input 1 Common
3 Ground
4 Trigger
Power Switch
Trigger Switch
QX-1 Wiring Diagram
Connectors 1 and 3 are 12-pin plugs, and Connector 2 is a 12-pin socket. All three
connectors can be assigned to bus power and data.
The two switches at the center of the device allow the user to route signals as needed.
The simple diagram above (also shown on the base of the QX-1) illustrates how power,
communications, I/O, and trigger signal can be routed through the QX-1 device.
Power can be bussed between imagers and interface devices. At each location on a
network where a new power supply is added, the Power switch on the QX-1 can be
used to break power between Connector 2 and Connectors 1, 3, and T.
The Trigger signal between Connector 2 and Connectors 1, 3, and T can be broken
using the Trigger switch. This isolates trigger signals as required.
A-10
MINI Hawk Xi High Performance Imager User Manual
Appendices
Optoisolated Outputs
The reader has optoisolated outputs that can transfer signals from the reader to peripherals.
Outputs can be configured as either NPN or PNP, but NPN and PNP cannot be mixed in a
system, because the output common is shared by all outputs.
NPN Output for Host Input
NPN Output for External Load
MINI Hawk Xi High Performance Imager User Manual
A-11
Electrical Specifications
PNP Output for Host Input
A-12
MINI Hawk Xi High Performance Imager User Manual
Appendices
PNP Output for External Load
MINI Hawk Xi High Performance Imager User Manual
A-13
Electrical Specifications
Optoisolated Inputs
All discrete inputs are optoisolated. Inputs can be configured as either NPN or PNP, but NPN
and PNP cannot be mixed in a system, because the input common is shared by all inputs.
NPN
A-14
MINI Hawk Xi High Performance Imager User Manual
Appendices
PNP
MINI Hawk Xi High Performance Imager User Manual
A-15
Electrical Specifications
Output Wiring
A-16
MINI Hawk Xi High Performance Imager User Manual
Appendices
Appendix C — Serial Configuration Commands
Note: For a list of utility commands such as read rate requests, device control options, and
imager status requests, see Serial Utility Commands.
Communications
Host Port Connections
Ethernet
Ethernet TCP Ports
Host Port Protocol
Preamble
Postamble
Response Timeout
LRC
ACK/NAK Options
Polling Mode Options
Calibration
Calibration Options
Autocalibrate
Read Cycle
Trigger Mode/Filter Duration
Serial Trigger Character
External Trigger State
End of Read Cycle
Decodes Before Output
Multisymbol
Start Trigger Character
Stop Trigger Character
Capture Mode
Capture Timing
Image Storage
IP Timeout
Symbologies
Narrow Margins/Symbology ID
Background Color
Composite
Aztec Code
<K100,baud rate,parity,stop bits,data bits>
<K126,status,IP address,subnet,gateway,IP address mode>
<K127,TCP Port 1,TCP Port 2>
<K140,protocol,address>
<K141,status,preamble characters>
<K142,status,postamble characters>
<K143,response timeout>
<K145,status>
<K147,RES,REQ,STX,ETX,ACK,NAK>
<K148,RES,REQ,STX,ETX,ACK,NAK>
<K529,gain,shutter speed,focus position,symbol type,WOI framing,
WOI margin,line scan height>
<@CAL>
<K200,trigger mode,leading edge trigger filter,trailing edge trigger
filter>
<K201,serial trigger character>
<K202,external trigger state>
<K220,end of read cycle,read cycle timeout>
<K221,decodes before output>
<K222,number of symbols,multisymbol separator>
<K229,start character>
<K230,stop character>
<K241,capture mode,number of captures,rapid capture mode>
<K242,time before first capture,time between first and second
captures,,,,,,,,time between seventh and eighth captures>
<K244,image storage type,image store mode>
<K245,image processing timeout>
<K450,narrow margin status,symbology identifier status>
<K451,background color>
<K453,symbology status,separator status,separator>
<K458,status>
MINI Hawk Xi High Performance Imager User Manual
A-17
Serial Configuration Commands
Micro QR Code
Postal Symbologies
Code 39
Codabar
Interleaved 2 of 5
UPC/EAN
Code 128/EAN 128
Code 93
PDF417
Pharmacode
Data Matrix
QR Code
BC412
DataBar-14 (RSS-14)
DataBar Limited (RSS Limited)
DataBar Expanded (RSS Expanded)
MicroPDF417
I/O Parameters
Power On/Reset Counts
Time Since Reset
Service Message
Serial Verification
Beeper
Quality Output
Symbol Data Output
Read Duration Output
No Read Message
Frame Information
LED Configuration
A-18
<K459,status>
<K460,postal symbology type,POSTNET status,PLANET status,
USPS4CB status,POSTNET allow B and B’ fields,Australia Post
allow 0 FCC>
<K470,status,check character status,check character output status,
large intercharacter gap,fixed symbol length status,fixed symbol
length,full ASCII set>
<K471,status,start/stop match,start/stop output,large intercharacter
gap,fixed symbol length status,symbol length,check character
type,check character output>
<K472,status,check character status,check character output status,
symbol length #1, symbol length #2, guard bar status,range mode
status>
<K473,UPC status,EAN status,supplemental status,separator status,
separator character,supplemental type,format UPC-E as UPC-A>
<K474,status,fixed symbol length status,fixed symbol
length,EAN 128 status,output format,application record separator
status,application record separator character,application record
brackets,application record padding>
<K475,status,fixed symbol length status,symbol length>
<K476,status,[unused],fixed symbol length status,fixed symbol
length>
<K477,status,fixed bar count status,fixed bar count,minimum bar
count,bar width mode,direction,fixed threshold value>
<K479,ECC 200 status, ECC 000 status,ECC 050 status, ECC
080 status,ECC 100 status,ECC 140 status,ECC 120 status,ECC
130 status>
<K480,status>
<K481,status,check character output,fixed symbol length status,
fixed symbol length>
<K482,status>
<K483,status>
<K484,status,fixed symbol length status,fixed symbol length>
<K485,status,[unused],fixed symbol length status,fixed symbol
length>
<K406,power-on,resets,power-on saves,power-on flash saves>
<K407,hours,minutes>
<K409,status,service message,threshold,resolution>
<K701,serial command echo status,serial command beep status,
control/hex output>
<K702,status>
<K704,quality output separator,decodes per trigger status>
<K705,symbol data output status,when to output>
<K706,status,separator>
<K714,status,message>
<K734,output frame number,output coordinates>
<K737,LED mode,ISO/IEC 16022 grade>
MINI Hawk Xi High Performance Imager User Manual
Appendices
Image Output
<K739,image output mode,communication port,file format,JPEG
quality>
Target/Flood LEDs
<K750,green flash LED status,target pattern LED status,green
flash duration>
<K757,comm port,image mode,image format,JPEG quality,
EZ Trax Output
object info output,grade output>
Database Identifier Output
<K759,status,separator>
EZ Button
<K770,global status,default on power-on,load Configuration
Database,save for power-on>
EZ Button Modes
<K771,single beep,two beeps,three beeps,four beeps>
Trend Analysis Output 1
<K780,trend analysis mode,trigger evaluation period,number to
output on,decodes per trigger threshold>
Trend Analysis Output 2
<K781,trend analysis mode,trigger evaluation period,number to
output on,decodes per trigger threshold>
Trend Analysis Output 3
<K782,trend analysis mode,trigger evaluation period,number to
output on,decodes per trigger threshold>
Diagnostic Output 1
<K790,unused 1,service unit>
Diagnostic Output 2
<K791,unused 1,service unit>
Diagnostic Output 3
<K792,unused 1,service unit>
ISO/IEC 16022 Symbol Quality Output 1 <K800,output on symbol contrast,symbol contrast threshold,output
on print growth,print growth threshold,output on axial non-uniformity,
axial non-uniformity threshold,output on UEC,UEC threshold>
ISO/IEC 16022 Symbol Quality Output 2 <K801,output on symbol contrast,symbol contrast threshold,output
on print growth,print growth threshold,output on axial non-uniformity,
axial non-uniformity threshold,output on UEC,UEC threshold>
ISO/IEC 16022 Symbol Quality Output 3 <K802,output on symbol contrast,symbol contrast threshold,output
on print growth,print growth threshold,output on axial non-uniformity,
axial non-uniformity threshold,output on UEC,UEC threshold>
Configurable Output 1
<K810,output on,output state,pulse width,output mode>
Configurable Output 2
<K811,output on,output state,pulse width,output mode>
Configurable Output 3
<K812,output on,output state,pulse width,output mode>
Symbol Quality
Symbol Quality Separator/ Data Matrix
<K708,symbol quality separator,data matrix output mode>
Output Mode
<K709,symbol contrast,print growth,axial non-uniformity,UEC>
ISO/IEC 16022 Symbol Quality Output
<K710,percent cell damage,total read time,capture time,locate
Microscan Symbol Quality Output
time,decode time,pixels per element,ECC level,matrix size,quiet
zone>
Static Validation Report
<VAL>
Matchcode
<K223,matchcode type,sequential matching,match start position,match
Matchcode Type
length,wild card character,sequence on No Read,sequence on
mismatch>
Number of Master Symbols
<K224,number of master symbols>
New Master Pin
<K225,status>
Enter Master Symbol Data
<K231,master symbol number,master symbol data>
<K231?,>[for all] or <K231?,master symbol number>
Request Master Symbol Data
MINI Hawk Xi High Performance Imager User Manual
A-19
Serial Configuration Commands
Delete Master Symbol Data
Match Replace
Mismatch Replace
Camera and IP Setup
Mirrored Image
Window of Interest
Focal Distance
Increment Focus Position
Decrement Focus Position
Focal Distance Table (Read-Only)
Illumination Brightness
Camera
Pixel Sub-Sampling
Morphological Pre-Processing
Morphological Operation
Configuration Database
Number of Active Indexes
Configuration Database Status
Save Current Settings to Database
Load Current Settings from Database
Request Selected Index Settings
Request All Database Settings
Database Mode
Output Format
Format Extract
Format Insert
Format Assign
Format Status
Output Filter Configuration
Ordered Output Filter
A-20
<K231,master symbol number,>
<K735,status,match replacement string>
<K736,status,mismatch replacement string>
<K514,mirrored image>
<K516,row pointer,column pointer,row depth,column width>
<K525,focal distance>
<525+>
<525–>
<K526,number of focal distances,focal distance>
<K536,brightness>
<K541,shutter speed,gain>
<K542,pixel sub-sampling,AEC/AGC mode,AEC/AGC brightness>
<K550,morphological pre-processing>
<K551,0,morphological operation,operator size>
<K252,number of active database settings,database sort>
<K255,index,shutter speed,gain,focal distance,pixel sub-sampling,
row pointer, column pointer,row depth,column width,narrow margins,
background color,symbology>
<K255+,index>
<K255-,index>
<K255?,index>
<K255?>
<K256,switch mode,frame count/time,image process looping,image
dimensions>
<K740,output index,start location,length>
<K741,output index,length,hex string>
<K742,symbol number,status>
<K743,output format status>
<K744,filter number,symbology,length,wildcard,placeholder,
data,unused,database index>
<K745,number of filters>
MINI Hawk Xi High Performance Imager User Manual
Appendices
Serial Command Format
Serial commands are of two types: utility and configuration.
Rules that apply to both utility and configuration commands
• A less than < and greater than > character enclose the commands.
• Commands and data are “case sensitive.” That is, characters must be entered as upper
or lower case, as specified.
Serial Utility Commands
These are sent during operations and are not followed by <A> or <Z>.
Serial Configuration “K” Commands
These begin with a single “K” character followed by a 3-digit numeric character, data
fields, and an initializing command, as follows:
<Knumeric parameter,data,data,...etc.><initializing command>
An initializing command <A> or <Z> may follow the command. A <Z> initializes the
imager’s memory and saves for power-on; an <A> initializes the imager’s memory but
does not save for power-on.
For example, to enable UPC and save the change for power-on, send <K473,1><Z>.
To change Baud Rate and reset without saving changes for power-on, send
<K100,3><A>.
Serial Configuration Command Conventions
• All data fields (except the last) must be followed by a comma (without a space).
• NUL cannot be used. The characters <, >, and , can be used, but only if entered as hex
pairs (see ASCII Character Entry Modifier).
• All fields preceding a modified field must be included.
• If there is no change in preceding fields, then commas alone can be entered in these
fields. For example, if only the last field in the following command is changing,
<K100,4,1,0,0> can be entered as <K100,,,,0>.
• All fields following a modified field can be omitted. For example, to change Baud Rate
only, send <K100,3>.
MINI Hawk Xi High Performance Imager User Manual
A-21
Serial Configuration Commands
Concatenating Configuration Commands
Commands can be concatenated (added together) in a single string or data block. For
example, <K145,1><K220,1><K450,1><A> enables LRC, sets End of Read Cycle mode
to New Trigger, enables Narrow Margins, and resets the data buffers (without saving the
changes for power-on).
Serial Command Status Request
To ensure that any command was received and accepted, you can send the Show Reader
Status command: <?>.
The status of a specific serial command can be requested by entering the command followed
by a question mark. For example, send <K142?> to request the status of Postamble.
Entering Control Characters in Serial Commands
To enter control characters within a serial command, hold down the Ctrl key while typing the
desired character.
Example: To enter a carriage return and line feed (^M^J), enter <K141,1,CNTL-m CNTL-j>.
A-22
MINI Hawk Xi High Performance Imager User Manual
Appendices
Appendix D — Communications Protocol
Communications Protocol Command Table
Protocol Command
(Mnemonic displayed on menu)
Control Characters
(Entered in menu or
serial command)
Hex
Value
Effect of Command
RES
^D
04
Reset
REQ
^E
05
Request
EOT
^D
04
Reset
STX
^B
02
Start of Text
ETX
^C
03
End of Text
ACK
^F
06
Acknowledge
NAK
^U
15
Negative Acknowledge
XON
^Q
11
Begin Transmission
XOFF
^S
13
Stop Transmission
MINI Hawk Xi High Performance Imager User Manual
A-23
Communications Protocol
ACK/NAK Data Flow Examples
Setup 1
RES
REQ
STX
ETX
ACK
NAK
LRC
0x00 (disabled)
0x00 (disabled)
0x00 (disabled)
0x00 (disabled)
0x06
0x15
disabled
Transfer 1
HOST_TX
IMAGER_TX
<K141,0>
‘ACK’
Transfer 2
HOST_TX
IMAGER_TX
IMAGER_TX
HOST_TX
<K141?>
‘ACK’
<K141,0>
‘ACK’
Error Condition
Transfer 1
IMAGER_TX
HOST_TX
IMAGER_TX
HOST_TX
symbol data
‘NAK’ (host rejects)
symbol data (resend data)
‘ACK’ (transaction complete)
Transfer 2
HOST_TX
<K141?>
IMAGER_TX
‘ACK’
IMAGER_TX
<K141,0>
timeout reached...
timeout reached...
timeout reached...
Timeout Reached transaction aborted, data is flushed
A-24
MINI Hawk Xi High Performance Imager User Manual
Appendices
Setup 2
RES
REQ
STX
ETX
ACK
NAK
LRC
0x00 (disabled)
0x00 (disabled)
0x00 (disabled)
0x00 (disabled)
0x06
0x15
enabled
Transfer 1
HOST_TX
IMAGER_TX
<K141,0>a
‘ACK’
Transfer 2
HOST_TX
IMAGER_TX
IMAGER_TX
HOST_TX
<K141?>B
‘ACK’
<K141,0>a
‘ACK’
Error Condition
Transfer 1
HOST_TX
IMAGER_TX
HOST_TX
IMAGER_TX
<k141,0>x (BAD LRC)
‘NAK’
<K141,0>a (GOOD LRC)
‘ACK’
MINI Hawk Xi High Performance Imager User Manual
A-25
Communications Protocol
Setup 3
RES
REQ
STX
ETX
ACK
NAK
LRC
0x00 (disabled)
0x00 (disabled)
0x28 ‘(‘
0x29 ‘)’
0x06
0x15
enabled
Transfer 1
HOST_TX
IMAGER_TX
(<K141,0>)H
‘ACK’
Transfer 2
HOST_TX
IMAGER_TX
IMAGER_TX
HOST_TX
A-26
(<K141?>)k
‘ACK’
(<K141,^M>)w
‘ACK’
MINI Hawk Xi High Performance Imager User Manual
Appendices
Setup 4
RES
REQ
STX
ETX
ACK
NAK
LRC
0x21 ‘!’
0x3D ‘=’
0x28 ‘(‘
0x29 ‘)’
0x06
0x15
enabled
Transfer 1
HOST_TX
IMAGER_TX
(<K141,0>)H
‘ACK’
Transfer 2
HOST_TX
IMAGER_TX
HOST_TX
IMAGER_TX
HOST_TX
IMAGER_TX
(<K100?>)n
‘ACK’
‘!’
(<K100,8,0,0,1>)X
‘ACK’
‘!’
Error Condition
Transfer 1
HOST_TX
(<K141,0>)H
IMAGER_TX
‘ACK’
HOST_TX
(<K100?>)n
IMAGER_TX
‘ACK’
HOST_TX
‘!’
IMAGER_TX
(<K100,8,0,0,1>)X
timeout reached...
IMAGER_TX
‘=’
timeout reached...
IMAGER_TX
‘=’
timeout reached...
IMAGER_TX
‘=’
timeout reached...
IMAGER_TX
‘!’
MINI Hawk Xi High Performance Imager User Manual
A-27
Communications Protocol
Polling Mode Data Flow Examples
Setup 1
Address
RES
REQ
STX
ETX
ACK
NAK
LRC
0x01 (translates to) Poll Req @ ‘0x1C’, Unit Select @ ‘0x1D’
0x04
0x05
0x02
0x03
0x06
0x15
disabled
Transfer 1
HOST_TX
IMAGER_TX
HOST_TX
IMAGER_TX
HOST_TX
‘RES’ ‘0x1D’ ‘REQ’ (Select Unit 1 to receive data)
‘0x1D’ ‘ACK’ (Unit responds with its address)
‘STX’ <T> ‘ETX’
‘0x1D’ ‘ACK’ (Unit responds with its address)
‘RES’ (Terminate Transfer 2)
Transfer 2
HOST_TX
IMAGER_TX
HOST_TX
IMAGER_TX
‘RES’ ‘0x1C’ ‘REQ’ (Poll Unit 1 for data)
‘0x1C’ ‘STX’ <T/00000> ‘ETX’
‘ACK’
‘RES’ (Terminate Transfer 1)
Starting with a ‘RES’ ensures a clean transaction, without “leftovers” from the previous
transaction.
Error Condition 1
HOST_TX
‘RES’ ‘0x1C’ ‘REQ’ (Poll Unit 1 for data)
IMAGER_TX
‘0x1C’ ‘STX’ <T/00000> ‘ETX’
HOST_TX
‘Nothing’ (Host should ‘ACK’ here)
timeout reached...
IMAGER_TX
‘REQ’ (Unit requests an ‘ACK’ again)
timeout reached...
IMAGER_TX
‘REQ’ (Unit requests an ‘ACK’ again)
timeout reached...
IMAGER_TX
‘REQ’ (Unit requests an ‘ACK’ again)
timeout reached...
IMAGER_TX
‘RES’ (Terminate Transfer 1, data is flushed)
A-28
MINI Hawk Xi High Performance Imager User Manual
Appendices
Error Condition 2
HOST_TX
‘RES’ ‘0x1C’ ‘REQ’ (Poll Unit 1 for data)
IMAGER_TX
‘0x1C’ ‘STX’ <T/00000> ‘ETX’
HOST_TX
‘Nothing’ (Host should ‘ACK’ here)
timeout reached...
IMAGER_TX
‘REQ’ (Unit requests an ‘ACK’ again)
HOST_TX
‘NAK’ (Host rejects data frame)
(Retry Event)
IMAGER_TX
‘0x1C’ ‘STX’ <T/00000> ‘ETX’ (Unit sends again)
HOST_TX
‘ACK’ (Host receives data)
IMAGER_TX
‘RES’ (Terminate Transfer 1)
The protocol makes 3 retry attempts before data is flushed and transfer is aborted.
MINI Hawk Xi High Performance Imager User Manual
A-29
Communications Protocol
Setup 2
Address
RES
REQ
STX
ETX
ACK
NAK
LRC
0x01 (translates to) Poll Req @ ‘0x1C’, Unit Select @ ‘0x1D’
0x04
0x05
0x02
0x03
0x06
0x15
enabled
Transfer 1
HOST_TX
IMAGER_TX
HOST_TX
IMAGER_TX
HOST_TX
‘RES’ ‘0x1D’ ‘REQ’ (Select Unit 1 to receive data)
‘0x1D’ ‘ACK’ (Unit responds with its address)
‘STX’ <T> ‘ETX’ ‘LRC’
‘0x1D’ ‘ACK’ (Unit responds with its address)
‘RES’ (Terminate Transfer 2)
Transfer 2
HOST_TX
IMAGER_TX
IMAGER_TX
HOST_TX
‘RES’ ‘0x1C’ ‘REQ’ (Poll Unit 1 for data)
‘0x1C’ ‘STX’ <T/00000> ‘ETX’ ‘LRC’
‘ACK’
‘RES’ (Terminate Transfer 1)
Starting with a ‘RES’ ensures a clean transaction, without “leftovers” from the previous
transaction.
Error Condition 1
HOST_TX
‘RES’ ‘0x1C’ ‘REQ’ (Poll Unit 1 for data)
IMAGER_TX
‘0x1C’ ‘STX’ <T/00000> ‘ETX’ ‘LRC’
HOST_TX
‘Nothing’ (Host should ‘ACK’ here)
timeout reached...
IMAGER_TX
‘REQ’ (Unit requests an ‘ACK’ again)
timeout reached...
IMAGER_TX
‘REQ’ (Unit requests an ‘ACK’ again)
timeout reached...
IMAGER_TX
‘REQ’ (Unit requests an ‘ACK’ again)
timeout reached...
IMAGER_TX
‘RES’ (Terminate Transfer 1, data is flushed)
A-30
MINI Hawk Xi High Performance Imager User Manual
Appendices
Error Condition 2
HOST_TX
‘RES’ ‘0x1C’ ‘REQ’ (Poll Unit 1 for data)
IMAGER_TX
‘0x1C’ ‘STX’ <T/00000> ‘ETX’ ‘LRC’
HOST_TX
‘Nothing’ (Host should ‘ACK’ here)
timeout reached...
IMAGER_TX
‘REQ’ (Unit requests an ‘ACK’ again)
HOST_TX
‘NAK’ (Host rejects data frame)
(Retry Event)
IMAGER_TX
‘0x1C’ ‘STX’ <T/00000> ‘ETX’ ‘LRC’ (Unit sends again)
HOST_TX
‘ACK’ (Host receives data)
IMAGER_TX
‘RES’ (Terminate Transfer 1)
Error Condition 3
HOST_TX
IMAGER_TX
HOST_TX
(Retry Event)
IMAGER_TX
HOST_TX
IMAGER_TX
‘RES’ ‘0x1C’ ‘REQ’ (Poll Unit 1 for data)
‘0x1C’ ‘STX’ <T/00000> ‘ETX’ ‘BAD LRC’
‘NAK’ (Host rejects bad LRC data)
‘0x1C’ ‘STX’ <T/00000> ‘ETX’ ‘GOOD LRC’ (Unit sends again)
‘ACK’ (Host receives data)
‘RES’ Terminate Transfer 1)
The protocol makes 3 retry attempts before data is flushed and transfer is aborted.
MINI Hawk Xi High Performance Imager User Manual
A-31
ASCII Table
Appendix E — ASCII Table
Dec
00
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
A-32
Hex
00
01
02
03
04
05
06
07
08
09
0A
0B
0C
0D
0E
0F
10
11
12
13
14
15
16
17
18
19
1A
1B
1C
1D
1E
1F
Mne
NUL
SOH
STX
ETX
EOT
ENQ
ACK
BEL
BS
HT
LF
VT
FF
CR
SO
SI
DLE
DC1
DC2
DC3
DC4
NAK
SYN
ETB
CAN
EM
SUB
ESC
FS
GS
RS
US
Ctrl
^@
^A
^B
^C
^D
^E
^F
^G
^H
^I
^J
^K
^L
^M
^N
^O
^P
^Q
^R
^S
^T
^U
^V
^W
^X
^Y
^Z
^[
^\
^]
^^
^_
Dec
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
Hex
20
21
22
23
24
25
26
27
28
29
2A
2B
2C
2D
2E
2F
30
31
32
33
34
35
36
37
38
39
3A
3B
3C
3D
3E
3F
Ch
SP
!
“
#
$
%
&
'
(
)
*
+
,
.
/
0
1
2
3
4
5
6
7
8
9
:
;
<
=
>
?
Dec
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
Hex
40
41
42
43
44
45
46
47
48
49
4A
4B
4C
4D
4E
4F
50
51
52
53
54
55
56
57
58
59
5A
5B
5C
5D
5E
5F
Ch
@
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
[
\
]
^
_
Dec
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
Hex
60
61
62
63
64
65
66
67
68
69
6A
6B
6C
6D
6E
6F
70
71
72
73
74
75
76
77
78
79
7A
7B
7C
7D
7E
7F
Ch
`
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
{
|
}
~
D
MINI Hawk Xi High Performance Imager User Manual
Appendices
Appendix F — Operational Tips
Cleaning
The MINI Hawk Xi has a hard-coated window that should only be cleaned with alcohol
(100% isopropyl).
Mounting
When mounting the MINI Hawk Xi, do not insulate the stand mount. The bottom panel is
the hottest part of the imager and metal-to-metal contact is necessary for heat dissipation.
MINI Hawk Xi High Performance Imager User Manual
A-33
Using an External Trigger
Appendix G — Using an External Trigger
Two types of inputs are used on Microscan readers. 5 volt devices have NPN trigger
inputs. 10-28 volt devices have optoisolated inputs and outputs.
5 Volt Devices
To trigger a 5 volt device, the input has to be pulled down to “signal ground” (NPN). This
can be done by relays or by a transistor-sourced signal. If a 5 volt device is used in combination
with an IC-332, it must be connected as a 10-28 volt device.
Reader
Reader
Sensor
Sensor
10-28 Volt Devices
To trigger a 10-28 volt device, a small amount of current needs to flow from “Trigger +” to
“Trigger –”. If a PNP source is used, “Trigger –” must be connected to “signal ground”. If an
NPN source is used, “Trigger +” must be connected to the supply voltage.
Reader
Reader
Sensor
Reader
Sensor
Sensor
PNP
A-34
NPN
MINI Hawk Xi High Performance Imager User Manual
Appendices
Appendix H — MINI Hawk Xi Image Output
This section explains how to extract (download) a video-captured image from a MINI Hawk Xi.
Y-Modem Method
The easiest download method is to issue the <op,9> command to get a list of available
images, then initiate a download sequence using a Y-Modem utility or protocol sequence.
The user will need to issue the <op,9> first to get an image list response from the imager.
Then initiate the Y-modem download sequence with the <uy,"path\filename"> command,
where: [path\filename] is one listed from the <op,9> response.
Retrieve File List
To receive a file list of all images stored in the reader, send the command: <op,9,*.*>
The reader will respond with a list similar to the one below:
<op,009,0,/good/0/640x480_gs.bmp 00003 00090,/pending/1/640x480_gs.bmp 00003
00057,/pending/2/640x480_gs.bmp 00003 00057,/pending/3/640x480_gs.bmp 00003
00058,/pending/4/640x480_gs.bmp 00003 00057>
In this example, there are 5 images in memory:
/good/0/640x480_gs.bmp
/pending/1/640x480_gs.bmp
/pending/2/640x480_gs.bmp
/pending/3/640x480_gs.bmp
/pending/4/640x480_gs.bmp
• The image will be stored in a directory describing the result of the image.
None assumes root.
/
Root Directory.
/saved
Saved Directory.
Good/
Symbol was decoded and good.
noread/
No symbol was decoded in this image.
Mismatch/
Symbol was decoded, but did not match.
pending
No attempt was made to decode this image.
• The image may be in a numbered sub-folder 0-9 indicating age; 0 = older, 9 = newer.
• The filename will describe the resolution and file type. Valid file types are: .jpg and .bmp.
• The directory locations, file names and file types will vary, depending on reader configuration.
MINI Hawk Xi High Performance Imager User Manual
A-35
MINI Hawk Xi Image Output
Upload Image
Select a file from the file list above, and then send the command:
<uy,path/filename.extension>.
Now initiate the Y-modem transfer and save the file. Y-modem uploads will vary depending
on the program or language. See the HyperTerminal example below.
Image Upload Using HyperTerminal
• Open the HyperTerminal application by clicking Start, Programs, Accessories, Communication,
and then HyperTerminal.
• Enter a name, and select an icon, then select OK.
• In the connection window, select the COM port, and then click OK.
• Adjust ‘COM Properties’ settings to match the reader (reader defaults shown below).
• Click OK and you will see the HyperTerminal screen.
• Retrieve an image list by sending <op,9>.
<op,9>
<op,009,0,/good/0/1280x1024_gs.bmp 00003 00064,/pending/1/1280x1024_gs.bmp
00003 00061,/pending/2/1280x1024_gs.bmp 00003 00061,/pending/3/
1280x1024_gs.bmp 00003 00061,/pending/4/1280x1024_gs.bmp 00003 00061>
• Request an image upload of the desired file.
<uy,/good/0/1280x1024_gs.bmp>
• From the menu bar, select Transfer, Receive File…
• Select a file storage location, and then select ‘Y-modem’, click Receive.
• HyperTerminal will upload the image and save the file to the directory specified.
A-36
MINI Hawk Xi High Performance Imager User Manual
Appendices
Bit Stream Method
A more difficult method is to parse and decode the bit stream data. The bit stream is a mix
of EXIF format & TIFF format. You will need to use the <op,4> command.
<op,4,arg>
To load a bitmap, send <op,4> and the entire grayscale image will load.
To load a JPEG, set arg for the full-size JPEG image, with adjustable quality:
<op,4,1280x1024_qnnn.jpg>
There is only one variable: nnn is a number from 1 to 100, and it represents the image
quality. 1 will load fastest, but will be extremely low-quality. 100 will load slowly, but will be
highest-quality.
<op,4,1280x1024_q1.jpg> = low-quality image, short load time
<op,4,1280x1024_q100.jpg> = high-quality image, long load time
Response Format
The user will need to write an application that can receive the image (8-bit format – 7 data
bit communication will not work), split up the data, and write the file. The data is format info
and then image data, so an ASCII terminal will not work.
The format of the data will be (_ added for readability):
SOH_DATALEN_FRAMETYPE_SCHEMA_DATA_CRC
SOH
= SOH character
DATALEN
= the length of data to follow, 32 bit integer from ‘00000000’ to ‘FFFFFFFF’
FRAMETYPE
=1
SCHEMA
=2
DATA
= image data
CRC
= CRC16 check digit at the end includes SOH, and everything after,
except the CRC
More information on these formats is available at:
http://partners.adobe.com/public/developer/en/tiff/TIFF6.pdf
and
http://www.exif.org/specifications.html
MINI Hawk Xi High Performance Imager User Manual
A-37
Using EtherNet/IP
Appendix I — Using EtherNet/IP
Overview
The EIP interface will be identified as a Generic Device (0x00). The interface is designed
to support remote serial transmit and receive using explicit unconnected messaging.
Necessary Tools
The following tools are helpful for configuring the EIP:
• EtherNet/IP Messaging Tool – can be a PLC or Software Tool, must be capable of sending
explicit messages and establishing Class 1 connections. EIPScan is an example of
such a tool.
• Terminal emulation or serial communication tool that can connect to a TCP socket, such
as HyperTerminal.
• ESP – Microscan’s Easy Setup Program. This tool has the ability to find Microscan products
on the network, configure their ip address, then configure all application parameters.
EtherNet/IP Terms of Use
EtherNet/IP Technology is governed by the Open DeviceNet Vendor Association, Inc.
(ODVA). Any person or entity that makes and sells products that implement EtherNet/IP
Technology must agree to the Terms of Usage Agreement issued by ODVA. See
www.odva.org for details.
Device Type
The EtherNet/IP device type is 0x00, Generic Device.
Vendor ID
Microscan’s Vendor ID is 1095.
Product Code
The Product Code is 6310.
MINI Hawk Xi EtherNet/IP Object Model
MINI Hawk Xi uses Class 1 connected messaging to communicate most data in three
different IO assemblies. The user chooses one of two input assemblies, plus the output
assembly, to create a Class 1 connection.
A-38
MINI Hawk Xi High Performance Imager User Manual
Appendices
Connection properties supported:
Class: 1
Trigger Mode: Cyclic and Change of State
Cyclic Rate: Greater than 20 ms recommended. 10 ms minimum.
Size: Fixed
Type: Point-to-Point (PLC OUT, O->T), Point-to-Point and Multicast (PLC IN, T->O)
Priority: Low, High, and Scheduled
Data Types
MINI Hawk Xi Small IN Assembly 0x64, 100 decimal (IN = MINI Hawk
Xi -> PLC)
MINI Hawk Xi High Performance Imager User Manual
A-39
Using EtherNet/IP
This is a small, lightweight input assembly. It is a subset of the Big IN Assembly 0x65. It
provides feedback of the output assembly, and the text of any bar codes decoded by the
reader.
See Big IN Assembly 0x65 for a description of the data fields.
MINI Hawk Xi Big IN Assembly 0x65, 101 decimal (IN = MINI Hawk
Xi -> PLC)
This contains more status information, and a longer barcode string, than the Small IN
Assembly 0x64. This gives the PLC visibility of the device’s discrete IO, current operational
status, and read cycle counters.
A-40
MINI Hawk Xi High Performance Imager User Manual
Appendices
User Defined Tag Echo, Command Echo, Output Control Echo
These are a direct echo of the equivalent fields in the OUT assembly. They provide the
PLC programmer with a method of verifying that the OUT data has been received by MINI
Hawk Xi.
External Input Status (Physical Pin State)
0 = no current sensed on input
1 = current sensed on input
External Output Status (Physical Pin State)
0 = output contact is open
1 = output contact is closed
Device Status
Note the following details with In Read Cycle and Actively Scanning signals:
• They may be very short-lived. It is possible for the reader to begin and end a read cycle
without these signals being seen in active state.
• They are only valid for normal read cycle operation: continuous, serial, and triggered.
• They do not reflect operation during bar code configuration, read rate, auto-calibration,
or ESP Setup mode.
MINI Hawk Xi High Performance Imager User Manual
A-41
Using EtherNet/IP
Read Cycle Sequence Counter
When this value changes, it indicates a new read cycle report is present.
Read cycle report data is only valid when Sequence is not 0.
Read cycle reports are only output during normal read cycles: continuous, serial, and
triggered. Read cycle reports are not output during bar code configuration, read rate,
auto-calibration, or ESP Setup mode.
Read Cycle Report: Trigger, Decode/Match, Mismatch, No Read Count
These are the historical read cycle result counters. By comparing the values to a previous
report, the number of decodes, mismatches and noreads in the current read cycle can be
determined.
Read Cycle Report: Decode Data
This string has the same format that would be output a serial port or tcp connection, with
one difference: preamble and postamble are not added.
MINI Hawk Xi OUT Assembly 0xC6, 198 decimal: Command (OUT =
PLC -> MINI Hawk Xi)
User Defined Tag
This provides the PLC programmer a method of uniquely identifying multiple readers in the
system. This field serves no functional purpose in the MINI Hawk Xi. The value sent by the
PLC for this field is echoed back to the input assemblies.
Command
A-42
MINI Hawk Xi High Performance Imager User Manual
Appendices
The PLC programmer should verify that a Command has been received by MINI Hawk Xi
by observing the equivalent “echo” field in the IN assemblies.
Trigger (0)
Edge event-driven. Takes effect when read mode is Serial, Edge, or Level. A transition
from 0 to 1 is a rising edge trigger event. A transition from 1 to 0 is a falling edge trigger
event. The following sources all induce trigger events in the reader, including:
• A serial command from a serial com port
• EZ button
• External Trigger input signal on connector A
• Command:Trigger bit in the OUT assembly
If the reader is to be exclusively triggered by the PLC, then all other trigger sources must
be kept idle.
New Master (1)
Edge-event driven. A transition from 0 to 1 is a command to the unit similar to sending the <G>
serial command, or activating the New Master input on connector A. When activated, the New
Master function instructs the reader to store the next decode in the master symbol database.
Disable Scanning (8)
Operates the same as the <H> and <I> commands. A transition from 0 to 1 is the same as
sending an <I> command, which issues a “disable” event. A transition from 1 to 0 is the
same thing as sending an <H> command, which issues an “enable” event. Note that the
most recent command, either <H> or <I> serial commands or the Camera Action:DisableScanning command will always override the previous “scanning disable” state. To verify
scanning status, observe the DeviceStatus field in asm 0x65.
Clear Read Cycle Report and Counters (16)
Trigger, Decode/Match, Mismatch, Noread, Decoded Data string, and Sequence. A transition
from 0 to 1 is similar to sending the commands <U><W><Y><O>, which clear the historical
read cycle counters. Also, the Sequence counter and Decoded Data string will go to 0.
Note that if this command is received while a read cycle is active, execution of the command
will be delayed until the read cycle has ended, and the read cycle’s information will probably
be lost.
Unlatch Outputs (17)
If any outputs are configured for Unlatch on Input1, a transition from 0 to 1 will unlatch
the output. See configuration commands K810-812. It is not necessary for Input 1 to be
enabled.
MINI Hawk Xi High Performance Imager User Manual
A-43
Using EtherNet/IP
External Output Control
0 = open the output contact
1 = close the output contact
Note: Not operational with the current version of this product.
MINI Hawk Xi OUT Assembly 0xC7, 199 decimal: Serial Command
(OUT: PLC -> MINI Hawk Xi)
Accessible only by unconnected explicit message.
This assembly enables the PLC to send serial commands to the device, similar to a serial port.
Known Issues and Limitations
• External Output Control has not been implemented yet.
• There is currently no way to receive serial command responses back from the MINI
Hawk Xi.
A-44
MINI Hawk Xi High Performance Imager User Manual
Appendices
Programming Flow Charts
Triggered by PLC, symbol data required, timeout or decode ends read cycle.
Setup:
Read Cycle Trigger Mode = External Edge or External Level.
Symbol Data Output = Enabled globally and for EtherNet/IP.
When to Output = As Soon As Possible.
End of Read Cycle = Timeout.
No Read message = Enabled.
MINI Hawk Xi High Performance Imager User Manual
A-45
Using EtherNet/IP
MOD and NET LED Indicators
MOD (Module)
NET (Network)
A-46
MINI Hawk Xi High Performance Imager User Manual
Appendices
Appendix J — Allen-Bradley Version 20 PLC
Setup, Trigger and Read
• To add a new EDS file to RSLogix 5000 Version 20 select the EDS Hardware Installation
Tool from the menu item under Tools.
• Click the Next button.
MINI Hawk Xi High Performance Imager User Manual
A-47
Allen-Bradley Version 20 PLC Setup, Trigger and Read
• Make sure the Register an EDS File(s) radio button is selected, then click Next.
• Click the Browse button to locate the new EDS file on your PC. Then click Next.
A-48
MINI Hawk Xi High Performance Imager User Manual
Appendices
• Click the Next button.
• Click the Next button.
MINI Hawk Xi High Performance Imager User Manual
A-49
Allen-Bradley Version 20 PLC Setup, Trigger and Read
• Click the Next button.
• Click the Finish button.
A-50
MINI Hawk Xi High Performance Imager User Manual
Appendices
• Now the EDS file has been loaded into RSLogix’s database. Right-click the Ethernet
menu item and select New Module.
• To find your camera in the list, type “fis” and the dialog will show only devices with the
letters FIS in the name. Either double-click the camera you want or highlight it and click
the Create button.
MINI Hawk Xi High Performance Imager User Manual
A-51
Allen-Bradley Version 20 PLC Setup, Trigger and Read
• Enter the name of the device used in the PLC program and the IP address of the camera.
• After the new device has been added to the project, the default assembly data will be
the small size. You can change it to large by double-clicking the camera menu item in
the tree control and clicking the Change button on the dialog.
A-52
MINI Hawk Xi High Performance Imager User Manual
Appendices
• Select the big assembly size if desired and click the OK button.
• Right-click the Add-On Instructions node in the tree view and select Import Add-On
Instruction.
MINI Hawk Xi High Performance Imager User Manual
A-53
Allen-Bradley Version 20 PLC Setup, Trigger and Read
• Locate the AOI file on the PC. AOIs can be downloaded from the Microscan website.
Choose the appropriate file based on the assembly size selected in the module definition.
• The next dialog will show the details of the AOI. Click the OK button to finish the import process.
A-54
MINI Hawk Xi High Performance Imager User Manual
Appendices
• Expand the MainProgram node under Tasks->MainTask. Double-click the MainRoutine
node to open the ladder logic editor. Select the Add-On tab to add the new Add-On
item. Click the AOI button and the new AOI will be added to the first rung.
• The first three elements of the AOI then need to be created. The last two need to be
linked. Right-click in the first element and select New Tag on the popup menu.
MINI Hawk Xi High Performance Imager User Manual
A-55
Allen-Bradley Version 20 PLC Setup, Trigger and Read
• Enter a specific name for the AOI element and click the Create button when done.
Repeat this step for the Assembly_Input and Assembly_Output.
• To link the connection input and outputs double-click the element and select the drop
down button. Locate the device and expand :I for inputs. Double-click :I:Data to complete
the link. Double-click the output connection and expand :O for outputs. Double-click
:I:Data to complete the link.
A-56
MINI Hawk Xi High Performance Imager User Manual
Appendices
• Download the new changes and set the PLC to Run Mode. Double-click the Program
Tags node to open the tag dialog. Select the Monitor Tags tab to view and set the data.
Expand the input assembly to view the data from the camera. The big assembly contains
more information on the read cycles.
• The status bits are defined below.
MINI Hawk Xi High Performance Imager User Manual
A-57
Allen-Bradley Version 20 PLC Setup, Trigger and Read
• To make control changes like triggers and resets, expand the output assembly node.
• If the camera is not set to continuous read, the PLC can trigger a read. To trigger a read,
expand the Command element. Select bit 0 and set to 1. Hit the enter key to set the bit
high. The command bits are defined below.
A-58
MINI Hawk Xi High Performance Imager User Manual
Appendices
Appendix K — Glossary of Terms
Aberration — The failure of an optical lens to produce an exact point-to-point correspondence
between the object and its resulting image. Various types are chromatic, spherical, coma,
astigmatism and distortion.
Absorption — The loss of light of certain wavelengths as it passes through a material and
is converted to heat or other forms of energy. (–)
Active Illumination — Lighting an area with a light source coordinated with the acquisition
of an image. Strobed flash tubes and pulsed lasers are examples.
ADC — See Analog-to-Digital Converter.
A/D Converter — See Analog-to-Digital Converter.
AGC — See Automatic Gain Control.
Ambient Light — Light which is present in the environment of the imaging front end of a
vision system and generated from outside sources. This light, unless used for actual illumination,
will be treated as background Noise by the vision system.
Analog — A smooth, continuous voltage or current signal or function whose magnitude
(value) is the information.
Analog-to-Digital Converter (A/D Converter or ADC) — A device that converts an
analog voltage or current signal to a discrete series of digitally encoded numbers (signal)
for computer processing.
Application-Specific Integrated Circuit (ASIC) — An integrated circuit that is customized
for a particular kind of use, rather than general use. All vision system elements including
firmware can be integrated into one ASIC.
Architecture — The hardware organization of a vision system designed for high speed
image analysis.
ASIC — See Application-Specific Integrated Circuit.
Aspect Ratio — The ratio between the height and width of a sensor or display. Found by
dividing the vertical number of pixels (height) by the horizontal number of pixels (width)
leaving it in fractional format.
Automatic Gain Control (AGC) — Adjustment to signal strength that seeks to maintain a
constant level regardless of the distance between a reader and symbol.
Auxiliary Port — RS-232 connection to an auxiliary terminal or device for remote viewing.
Blooming — A situation in which too many photons are being produced to be received by
a pixel. The pixel overflows and causes the photons to go to adjacent pixels. Blooming is
similar to overexposure in film photography, except that in digital imaging, the result is a
number of vertical and/or horizontal streaks appearing from the light source in the picture.
Baud Rate — The number of discrete signal events per second; bits per second.
Capture — The act of acquiring and storing video images in an imager or host computer.
Also, the image captured.
CCD — See Charge-Coupled Device.
MINI Hawk Xi High Performance Imager User Manual
A-59
Glossary of Terms
Charge-Coupled Device (CCD) — A semiconductor device with an array of light-sensitive
elements that converts light images into electrical signals.
Check Character — A Modulus 43 or Modulus 10 character that is added to encoded
symbol data for additional data integrity.
CMOS — See Complementary Metal Oxide Semiconductor.
Complementary Metal Oxide Semiconductor (CMOS) — Like CCDs, CMOS imagers
include an array of photo-sensitive diodes, one diode within each pixel. Unlike CCDs, however,
each pixel in a CMOS imager has its own individual amplifier integrated inside.
Connector — A plug or socket on a device or cable providing in/out connectivity for various
circuits and pins.
Concentrator — Intermediary device that relays data from imagers to a host and commands
from the host to the imagers or other devices.
Counter — Memory space allocated to keep track of imager events.
DAC — See Digital-to-Analog Converter.
Daisy Chain — Linkage of primary and secondary imagers allowing data to be relayed up
to the host via auxiliary port connections.
Decode — A Good Read. The successful interpretation and output of the information
encoded in a symbol.
Default — Restores ROM or flash settings, initializes serial commands and resets all
counters.
Delimited — A delimited command or field is bracketed by predefined characters.
Decode Rate — The number of good reads per second ahieved by an imager.
Darkfield Illumination — Lighting of objects, surfaces, or particles at very shallow or low
angles, so that light does not directly enter a reader’s optical hardware.
Depth-of-Field — The in-focus range of an imaging system. Measured from the distance
behind an object to the distance in front of the object with all objects appearing in focus.
Diffused Lighting — Scattered soft lighting from a wide variety of angles used to eliminate
shadows and specular glints from profiled, highly reflective surfaces.
Digital-to-Analog Converter (DAC) — A VLSI circuit used to convert digitally processed
images to analog for display on a monitor.
Digital Imaging — Conversion of an image into pixels by means of an Analog-to-Digital
Converter where the level of each pixel can be stored digitally.
Digital Signal Processor (DSP) — A VLSI chip designed for ultra-high-speed arithmetic
processing. Often imbedded in a vision engine.
Discrete I/O — Inputs and outputs characterized by discrete signal transitions from one
voltage level to another so that digital switching can occur.
Direct Memory Access (DMA) — A capability provided by some computer bus architectures
that allows data to be sent directly to memory from an attached device.
DMA — See Direct Memory Access.
DSP — See Digital Signal Processor.
Dynamic Range — The difference between the minimum and maximum thresholds of
discernible images; the amount of usable signal.
A-60
MINI Hawk Xi High Performance Imager User Manual
Appendices
Edge Enhancement — Image processing method to strengthen high-spatial frequencies
in the image.
EPROM — See Erasable Programmable Read-Only Memory.
Embedded Memory — Onboard memory device such as EPROM or flash.
End of Read Cycle — The time or condition at which the imager stops expecting symbol
information to decode.
Erasable Programmable Read-Only Memory (EPROM) — A memory chip that retains
data when its power supply is turned off; “non-volatile memory”.
External Edge — Allows a read cycle to be initiated by a trigger signal from an object
detector when it detects the appearance of an object (rising edge). The read cycle ends
with a good read, a timeout, or a new trigger.
External Level — Allows a read cycle to be initiated by a trigger signal from an object
detector. The read cycle ends when the object moves out of the detector’s range.
Falling Edge — A change of state (to inactive) associated with a level trigger.
Field-Programmable Gate Array (FPGA) — A semiconductor device containing programmable
interconnects and logic components.
Fill Factor — Percentage of pixel area used for light collection.
Firmware — Software hard-coded in non-volatile memory (ROM), and closely tied to
specific pieces of hardware.
Fixed Symbol Length — Increases data integrity by ensuring that only one symbol length
will be accepted.
Focal Distance — In camera-based vision, the distance from the front of the camera to
the object being viewed. (In optics, the distance from the lens to the focal plane.)
Focal Plane — Usually found at the image sensor, it is a plane perpendicular to the lens
axis at the point of focus (–).
Focus — Any given point in an image at which light converges; the focal point.
FPGA — See Field-Programmable Gate Array.
Frame — The total area captured in an image sensor while the video signal is not blanked.
Frame Grabber — A device that interfaces with a camera and, on command, samples the
video, converts the sample to a digital value and stores that in a computer's memory.
Front End System — The object, illumination, optics and imager blocks of a vision system.
Includes all components useful to acquire a good image for subsequent processing.
Full Duplex — A communications system in which signals can travel simultaneously
between devices.
Gain — The amount of energy applied to pixel gray scale values prior to output, expressed
in dB; optimal signal strength.
Good Read — A decode. The successful scanning and decoding of the information
encoded in a bar code symbol.
Gradient — The rate of change of pixel intensity (first derivative).
Gray Scale — Variations of values from white, through shades of gray, to black in a digitized
image with black assigned the value of zero and white the value of one.
MINI Hawk Xi High Performance Imager User Manual
A-61
Glossary of Terms
Half Duplex — A communications system in which signals can travel between devices in
both directions, but not simultaneously.
Histogram — A graphical representation of the frequency of occurrence of each intensity
or range of intensities (gray levels) of pixels in an image. The height represents the number
of observations occurring in each interval.
Host — A computer, PLC, or other device that is used to execute commands and process
data and discrete signals.
Image — Projection of an object or scene onto a plane (i.e. screen or image sensor).
Image Processing (IP) — Transformation of an input image into an output image with
desired properties.
Image Resolution — The number of rows and columns of pixels in an image. A higher
resolution means that more pixels are available per element of the symbol being read.
Examples: 640 x 480 (VGA); 854 x 480 (WVGA); 1280 x 1024 (SXGA); 2048 x 1536
(QXGA).
Image Sensor — A device that converts a visual image to an electrical signal; a CCD or
CMOS array.
Initialize — Implement serial configuration commands into the imager’s active memory.
Input — A channel or communications line. Decoded data or a discrete signal that is
received by a device.
Integration — Exposure of pixels on a CMOS sensor.
IP — See Image Processing.
Ladder Orientation — A linear symbol orientation in which the bars are parallel to the
symbol’s direction of travel.
LED — See Light-Emitting Diode.
Light-Emitting Diode (LED) — A semiconductor device that emits light when conducting
current.
Lens — A transparent piece of material with curved surfaces which either converge or
diverge light rays.
Machine Vision — The automatic acquisition and analysis of images to obtain desired
data for controlling a specific activity.
Multidrop — A communications protocol for networking two or more imagers or other
devices with a concentrator (or controller) and characterized by the use of individual
device addresses and the RS-485 standard.
Noise — The same as static in a phone line or “snow” in a television picture, noise is any
unwanted electrical signal that interferes with the image being read and transferred by the
imager.
Normally Closed — A discrete output state that is only active when open.
Normally Open — A discrete output state that is only active when closed.
Object Plane — An imaginary plane in the field of view, focused by an imager’s optical
system at the corresponding image plane on the sensor.
A-62
MINI Hawk Xi High Performance Imager User Manual
Appendices
Output — A channel or communications line. Data or discrete signals that are transmitted
or displayed by a device.
Parity — An error detection routine in which one data bit in each character is set to 1 or 0
so that the total number of 1 bits in the data field is even or odd.
Picket Fence Orientation — A linear symbol orientation in which the bars are perpendicular
to the symbol’s direction of travel.
Pitch — Rotation of a linear or 2D symbol around an axis parallel to the symbol length on
the Substrate. See the illustration below.
Skew axis
Tilt
axis
Pitch
axis
Scan line
Pixel — An individual element in a digitized image array; “picture element”.
PLC — See Programmable Logic Controller.
Port — Logical circuit for data entry and exit. (One or more ports may be included within a
single connector.)
Processing Time — The time used by a vision system to receive, analyze and interpret
image information. Often expressed in “parts per minute”.
Programmable Logic Controller (PLC) — An electronic device used in industrial automation
environments such as factory assembly lines and automotive manufacturing facilities.
Progressive Scan — A non-interlaced scan that doubles the number of visible picture
lines per field by displaying all picture lines at once.
Protocol — The rules for communication between devices, providing a means to control
the orderly flow of information between linked devices.
RAM — See Random Access Memory.
Random Access Memory (RAM) — A data storage system used in computers, composed
of integrated circuits that allow access to stored data in any sequence without movement
of physical parts.
Read Cycle — A programmed period of time or condition during which a reader will accept
symbol input.
Read-Only Memory (ROM) — A data storage medium used in computers and other
electronics, primarily used to distribute Firmware.
Real-Time Processing — In machine vision, the ability of a system to perform a complete
analysis and take action on one part before the next one arrives for inspection.
MINI Hawk Xi High Performance Imager User Manual
A-63
Glossary of Terms
Region — Area of an image. Also called a region of interest for image processing operations.
ROM — See Read-Only Memory.
Saturation — The degree to which a color is free of white. One of the three properties of
color perception, along with hue and value.
Scattering — Redirection of light reflecting off a surface or through an object.
Skew — Rotation of a linear or 2D symbol around an axis parallel to the symbol height on
the substrate. See the illustration under the definition of Pitch.
Substrate — The surface upon which a linear or 2D symbol is printed, stamped, or etched.
Symbol Transitions — The transition of bars and spaces on a symbol, used to detect the
presence of a symbol on an object.
Symbology — A symbol type, such as Code 39 or Code 128, with special rules to define
the widths and positions of bars and spaces to represent specific numeric or alphanumeric
information.
Tilt — Rotation of a linear or 2D symbol around an axis perpendicular to the substrate.
See the illustration under the definition of Pitch.
Trigger — A signal, transition, or character string that initiates a read cycle.
Very Large-Scale Integration (VLSI) — The creation of integrated circuits by combining
thousands of transistor-based circuits on a single chip.
VLSI — See Very Large-Scale Integration.
Watchdog Timer — A security device that detects system crashes and attempts to reset
the imager.
A-64
MINI Hawk Xi High Performance Imager User Manual