MicroHAWK Engine Integration Guide

MicroHAWK Engine Integration Guide
MicroHAWK Engine
Integration Guide
P/N 84-9007100-02 Rev B
Copyright and Disclaimer
Copyright ©2016
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: [email protected]
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
MicroHAWK Engine Integration Guide
Introduction
Table of Contents
Chapter 1
Quick Start
MicroHAWK Engine and WebLink Quick Start ........................................ 1-2
Step 1 Check Hardware and Connect the System .................................. 1-2
Step 2 Mount and Position the Reader.................................................... 1-3
Step 3 Install WebLink Drivers (ID-20 and ID-30) ................................... 1-4
Step 4 Connect to WebLink ..................................................................... 1-5
Step 5 Explore the Start View.................................................................. 1-6
Step 6 Create a New Setup or Load an Existing Setup........................... 1-7
Step 7 Explore the Setup View ................................................................ 1-8
Step 8 Configure Read Cycle Settings .................................................... 1-9
Step 9 Configure Acquire Settings ........................................................ 1-11
Step 10 Configure Symbology Settings ................................................. 1-13
Step 11 Format Output and Configure Match String ............................. 1-14
Step 12 Configure Output 1, 2, and 3 Settings ...................................... 1-15
Step 13 Run the Application .................................................................. 1-16
MicroHAWK Engine and ESP Software Quick Start.............................. 1-17
Step 1 Check Hardware and Connect the System ................................ 1-17
Step 2 Mount and Position the Reader.................................................. 1-18
Step 3 Install ESP.................................................................................. 1-19
Step 4 Select Model .............................................................................. 1-20
Step 5 Connect ...................................................................................... 1-21
Step 6 Locate the Symbol in the Field of View ...................................... 1-22
Step 7 Calibrate..................................................................................... 1-23
Step 8 Test Read Rate .......................................................................... 1-24
Step 9 Configure the Reader in ESP ..................................................... 1-25
Step 10 Save Configuration in ESP....................................................... 1-26
MicroHAWK Engine and AutoVISION Quick Start ................................ 1-27
AutoVISION Overview ........................................................................... 1-28
Select a Device...................................................................................... 1-39
Adjust Camera Settings ......................................................................... 1-40
Edit the Job............................................................................................ 1-42
Run the Job ........................................................................................... 1-43
Save the Job.......................................................................................... 1-44
Additional Notes: CPU Idle States (C-States) ....................................... 1-45
MicroHAWK Part Number Structure ...................................................... 1-46
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
MicroHAWK Engine Integration Guide
iii
Table of Contents
Chapter 3
Integration
MicroHAWK Engine Hardware at a Glance............................................. 3-2
Mounting Specifications .......................................................................... 3-3
Optical Requirements .............................................................................. 3-4
Viewing Port Specifications ..................................................................... 3-5
Expansion Connector (FPC) ................................................................... 3-6
Chapter 4
Communications
Communications by ESP......................................................................... 4-2
Communications Serial Commands ........................................................ 4-3
Network Interfaces .................................................................................. 4-4
Host Port Connections ............................................................................ 4-5
Host Port Protocol ................................................................................... 4-6
ACK/NAK Options ................................................................................... 4-7
Polling Mode Options .............................................................................. 4-8
Ethernet ................................................................................................... 4-9
Response Timeout ................................................................................ 4-15
LRC (Longitudinal Redundancy Check) Status ..................................... 4-16
Protocol Configuration Examples .......................................................... 4-17
Preamble ............................................................................................... 4-18
Postamble ............................................................................................. 4-19
USB HID/Keyboard ............................................................................... 4-20
EtherNet/IP Byte Swapping Enabled..................................................... 4-25
USB Mass Storage Driver ..................................................................... 4-26
Entering ASCII Characters as Hex Values ............................................ 4-27
Chapter 5
Calibration
Calibration Serial Commands.................................................................. 5-2
Calibration Overview ............................................................................... 5-2
Calibration Options .................................................................................. 5-3
Calibration by ESP .................................................................................. 5-8
Initiating Calibration ............................................................................... 5-10
Additional Notes about Calibration ........................................................ 5-11
Chapter 6
Read Cycle
Read Cycle by ESP ................................................................................. 6-2
Read Cycle Serial Commands ................................................................ 6-3
Read Cycle Setup ................................................................................... 6-4
Multisymbol ............................................................................................. 6-5
Trigger Mode and Filter Duration ............................................................ 6-6
External Trigger Polarity ........................................................................ 6-11
Serial Trigger ......................................................................................... 6-12
Serial Trigger Start Character (Non-Delimited) ..................................... 6-13
Serial Trigger Stop Character (Non-Delimited)...................................... 6-14
End of Read Cycle ................................................................................ 6-15
Capture Mode........................................................................................ 6-17
Capture Timing ...................................................................................... 6-22
Image Processing Timeout.................................................................... 6-24
Image Storage ....................................................................................... 6-25
Minimum Good Reads........................................................................... 6-27
iv
MicroHAWK Engine Integration Guide
Introduction
Chapter 7
Symbologies
Symbologies by ESP ............................................................................... 7-2
Symbologies Serial Commands .............................................................. 7-3
Data Matrix .............................................................................................. 7-4
Aztec........................................................................................................ 7-6
QR Code.................................................................................................. 7-7
Micro QR Code ........................................................................................ 7-8
Code 39 ................................................................................................... 7-9
Code 128/EAN 128................................................................................ 7-12
BC412.................................................................................................... 7-15
Interleaved 2 of 5 ................................................................................... 7-16
Code 93 ................................................................................................. 7-19
Codabar ................................................................................................. 7-20
UPC/EAN............................................................................................... 7-23
Pharmacode .......................................................................................... 7-27
Postal Symbologies ............................................................................... 7-29
GS1 DataBar ......................................................................................... 7-34
PDF417 ................................................................................................. 7-36
MicroPDF417......................................................................................... 7-37
Composite ............................................................................................. 7-38
DotCode ................................................................................................ 7-39
Chapter 8
I/O Parameters
I/O Parameters by ESP ........................................................................... 8-2
I/O Parameters Serial Commands........................................................... 8-3
Symbol Data Output ................................................................................ 8-4
No-Read Message................................................................................... 8-7
Read Duration Output.............................................................................. 8-8
Output Indicators ..................................................................................... 8-9
LED Configuration ................................................................................. 8-14
Serial Verification................................................................................... 8-15
Setup Button.......................................................................................... 8-16
Setup Button Modes .............................................................................. 8-18
Configurable Output 1 ........................................................................... 8-20
Trend Analysis Output 1 ........................................................................ 8-23
ISO/IEC 16022 Symbol Quality Output 1 .............................................. 8-26
Diagnostic Output 1 ............................................................................... 8-29
Configurable Output 2 ........................................................................... 8-30
Trend Analysis Output 2 ........................................................................ 8-30
ISO/IEC 16022 Symbol Quality Output 2 .............................................. 8-30
Diagnostic Output 2 ............................................................................... 8-30
Configurable Output 3 ........................................................................... 8-31
Trend Analysis Output 3 ........................................................................ 8-31
ISO/IEC 16022 Symbol Quality Output 3 .............................................. 8-31
Diagnostic Output 3 ............................................................................... 8-31
Power-On/Reset Counts........................................................................ 8-32
Time Since Reset .................................................................................. 8-33
Service Message ................................................................................... 8-34
MicroHAWK Engine Integration Guide
v
Table of Contents
Frame Information ................................................................................. 8-36
Image Output......................................................................................... 8-37
Database Identifier Output .................................................................... 8-40
Quality Output ....................................................................................... 8-41
EZ Trax Output ...................................................................................... 8-42
Image Push to Host ............................................................................... 8-45
Image Push to Host Detailed Setup ...................................................... 8-47
Chapter 9
Symbol Quality
Symbol Quality by ESP ........................................................................... 9-2
Symbol Quality Serial Commands........................................................... 9-3
Overview of Symbol Quality .................................................................... 9-4
Symbol Quality Separator/Data Matrix Output Mode .............................. 9-8
ISO/IEC 16022 Symbol Quality Output ................................................. 9-10
ISO/IEC 16022 Symbol Quality Output by ESP .................................... 9-12
Microscan Symbol Quality Output ......................................................... 9-13
Microscan Symbol Quality Output by ESP ............................................ 9-16
Chapter 10
Matchcode
Matchcode by ESP ................................................................................ 10-2
Matchcode Serial Commands ............................................................... 10-3
Overview of Matchcode ......................................................................... 10-4
Matchcode Type .................................................................................... 10-5
Sequence Step Interval ....................................................................... 10-10
Match Replace .................................................................................... 10-11
Mismatch Replace ............................................................................... 10-12
New Master Pin ................................................................................... 10-13
Chapter 11
Camera and IP Setup
Camera and IP Setup by ESP............................................................... 11-2
Camera and IP Setup Serial Commands .............................................. 11-3
Video ..................................................................................................... 11-4
Evaluation.............................................................................................. 11-5
Calibration ............................................................................................. 11-8
Window of Interest................................................................................. 11-9
Configuration Database....................................................................... 11-13
Dynamic Setup .................................................................................... 11-14
Pixel Binning........................................................................................ 11-15
Camera Settings.................................................................................. 11-16
White Balance Settings ....................................................................... 11-17
Color Filter ........................................................................................... 11-18
Focal Distance..................................................................................... 11-19
Illumination Brightness ........................................................................ 11-20
Morphological Pre-Processing ............................................................ 11-21
Morphological Operation and Operator Size ....................................... 11-22
Damaged Symbol ................................................................................ 11-25
Linear Security Level ........................................................................... 11-26
Set License.......................................................................................... 11-27
Chapter 12
Configuration Database
Configuration Database Serial Commands ........................................... 12-2
vi
MicroHAWK Engine Integration Guide
Introduction
Number of Active Indexes ..................................................................... 12-3
Configuration Database Status.............................................................. 12-4
Database Mode ................................................................................... 12-10
Save Current Settings to Configuration Database............................... 12-15
Load Current Settings from Configuration Database........................... 12-16
Request Selected Index Settings ........................................................ 12-17
Request All Configuration Database Settings ..................................... 12-17
Chapter 13
Terminal
Terminal................................................................................................. 13-2
Find........................................................................................................ 13-3
Send ...................................................................................................... 13-4
Macros ................................................................................................... 13-5
Terminal Menus ..................................................................................... 13-6
Chapter 14
Utilities
Operational Commands......................................................................... 14-2
Read Rate ............................................................................................. 14-4
Counters ................................................................................................ 14-6
Device Control ....................................................................................... 14-8
Differences from Default ........................................................................ 14-9
Master Database ................................................................................. 14-10
Firmware.............................................................................................. 14-16
Default/Reset/Save.............................................................................. 14-19
Reader Status Requests ..................................................................... 14-21
Other Operational Commands............................................................. 14-23
Chapter 15
Output Format
Output Format Serial Commands .......................................................... 15-2
Output Format Status ............................................................................ 15-3
Format Assign ....................................................................................... 15-4
Format Extract ....................................................................................... 15-5
Format Insert ......................................................................................... 15-7
Output Filter Configuration .................................................................... 15-9
Number of Filters ................................................................................. 15-14
Appendices
Appendix A General Specifications .........................................................A-2
Appendix B Electrical Specifications .......................................................A-7
Appendix C Quantum Efficiency Specifications.......................................A-9
Appendix C Serial Commands ..............................................................A-10
Appendix D Communications Protocol ..................................................A-12
Appendix E ASCII Table ........................................................................A-13
Appendix F Glossary of Terms ..............................................................A-14
MicroHAWK Engine Integration Guide
vii
About the MicroHAWK Engine
About the MicroHAWK Engine
The key features of the MicroHAWK Engine are:
• World’s smallest industrial scan engine
• Able to read any symbol on any surface
• Intuitive WebLink user interface
• Customizable hardware options
• Customizable software options
MicroHAWK Engine Communications
There are three ways to configure and test the MicroHAWK Engine:
• Microscan’s browser-based WebLink user interface, which enables you to access, configure,
and test the engine without having to install software or access files on a host system;
• Microscan’s ESP Software, which allows you to configure your reader using simple tree
controls and UI elements;
• Serial commands that can be sent from the Terminal in WebLink or ESP, or from
another terminal program.
About This Manual
The purpose of this user manual is to document the hardware and firmware of the MicroHAWK
Engine, as well as the software used to configure and operate the engine. The browser-based
WebLink interface is the preferred configuration tool, but ESP Software is useful for certain
operations, such as:
• Device discovery to find the reader IP address;
• If you only have an RS-232 (serial) connection;
• Updating MicroHAWK Engine firmware;
• Using the Configuration Database;
• Creating barcodes for reader configuration;
• Generating Symbol Quality reports.
Parts of this manual introduce the basic functionality of WebLink, but WebLink Help in the
WebLink user interface provides more detailed information. This manual’s primary focus is
MicroHAWK Engine hardware and firmware, and ESP Software.
Important: Some images in this manual may contain information about other MicroHAWK
products (the ID-20, ID-30, or ID-40), but only when the functions described are identical to
those of the MicroHAWK Engine.
viii
MicroHAWK Engine Integration Guide
Introduction
Statements of Compliance
FCC
The MicroHAWK Engine has been tested for compliance with FCC (Federal Communications
Commission) requirements and has been found to conform to applicable FCC standards.
To comply with FCC RF exposure compliance requirements, this device must not be co-located
with 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.
CE
The MicroHAWK Engine has been tested for compliance with EU Directive 2014/30/EU for
Electromagnetic Compatibility, and has been found to conform to applicable CE standards,
specifically the following requirements:
General Immunity for ITE Equipment: EN 55024:2010
Radiated and Conducted Emissions of ITE Equipment: EN 55022:2010.
The CE Declaration of Conformity for this product is available from Microscan upon request.
The MicroHAWK Engine has been tested by an independent electromagnetic compatibility
laboratory in accordance with the applicable specifications and instructions.
UL
The MicroHAWK Engine has been tested for compliance with UL (Underwriters Laboratories)
standards and guidelines, and has been found to conform to applicable UL standards.
Information Technology Equipment – Safety IEC/EN 60950-1
Photobiological Safety of Lamps and Lamp Systems – IEC/EN 62471
Restricted Substances
See the following link for Microscan compliance statements related to all applicable
restricted substances:
http://www.microscan.com/en-us/AboutUs/quality-environmental-management-system.aspx
MicroHAWK Engine Integration Guide
ix
Warning and Caution Summary
Warning and Caution Summary
NOTICE: The Light Emitting Diodes used in the MicroHAWK Engine are classified as exempt.
This classification is considered safe and represents no photobiological hazard. As with any
light source they should be used consistent with their intended use. Do not stare directly at
the LED output.
Location of the MicroHAWK Engine’s LEDs:
LEDs
This reader is intended for connection to a UL-listed direct plug-in power unit marked Class
II and rated 10 to 28 VDC at 5 watts or greater.
U.S. models must use a similarly-rated Class I or Class II power supply that is certified to
comply with standards for safety IEC 60950-1 Ed. 2 (2005) and IEC 60825-1 Ed. 2 (2007).
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-1 (2006) with Am. 11 (2009).
CAUTION: Contains parts
and assemblies susceptible
to damage by electrostatic
discharge (ESD).
x
MicroHAWK Engine Integration Guide
1 Quick Start
Contents
MicroHAWK Engine and WebLink Quick Start ...................................................................................... 1-2
Step 1 Check Hardware and Connect the System ................................................................................ 1-2
Step 2 Mount and Position the Reader.................................................................................................. 1-3
Step 3 Install WebLink Drivers (ID-20 and ID-30).................................................................................. 1-4
Step 4 Connect to WebLink ................................................................................................................... 1-5
Step 5 Explore the Start View................................................................................................................ 1-6
Step 6 Create a New Setup or Load an Existing Setup......................................................................... 1-7
Step 7 Explore the Setup View .............................................................................................................. 1-8
Step 8 Configure Read Cycle Settings .................................................................................................. 1-9
Step 9 Configure Acquire Settings....................................................................................................... 1-11
Step 10 Configure Symbology Settings ............................................................................................... 1-13
Step 11 Format Output and Configure Match String ........................................................................... 1-14
Step 12 Configure Output 1, 2, and 3 Settings .................................................................................... 1-15
Step 13 Run the Application ................................................................................................................ 1-16
MicroHAWK Engine and ESP Software Quick Start............................................................................ 1-17
Step 1 Check Hardware and Connect the System .............................................................................. 1-17
Step 2 Mount and Position the Reader................................................................................................ 1-18
Step 3 Install ESP................................................................................................................................ 1-19
Step 4 Select Model............................................................................................................................. 1-20
Step 5 Connect .................................................................................................................................... 1-21
Step 6 Locate the Symbol in the Field of View .................................................................................... 1-22
Step 7 Calibrate .................................................................................................................................. 1-23
Step 8 Test Read Rate ....................................................................................................................... 1-24
Step 9 Configure the Reader in ESP .................................................................................................. 1-25
Step 10 Save Configuration in ESP.................................................................................................... 1-26
MicroHAWK Engine and AutoVISION Quick Start............................................................................... 1-27
AutoVISION Overview ......................................................................................................................... 1-28
Select a Device.................................................................................................................................... 1-39
Adjust Camera Settings ...................................................................................................................... 1-40
Edit the Job.......................................................................................................................................... 1-42
Run the Job ......................................................................................................................................... 1-43
Save the Job........................................................................................................................................ 1-44
Additional Notes: CPU Idle States (C-States)...................................................................................... 1-45
MicroHAWK Part Number Structure .................................................................................................... 1-46
This section is designed to get your MicroHAWK up and running quickly with WebLink or
ESP Software for auto ID applications, or AutoVISION for machine vision applications.
MicroHAWK Engine Integration Guide
1-1
Check Hardware and Connect the System
MicroHAWK Engine and WebLink Quick Start
Step 1 — Check Hardware and Connect the System
Item
1
2
3
4
Description
MicroHAWK Engine
Micro-USB Type B Plug to USB Type A Plug, 6 ft. (High Speed USB 2.0)
Ferrite Core Snap-On Kit for USB Cable (for Class B Emissions; not shown)
Power Supply, 100-240VAC, +24VDC, M12 12-pin Socket (not shown)
Part Number
7AXY-YZZZ-LPPP
61-9000034-01
98-9000035-01
97-000012-01
2
To Host
USB Type A
Plug
Micro-USB
Type B Plug
1
MicroHAWK Engine – USB Standalone Configuration
1-2
MicroHAWK Engine Integration Guide
Quick Start
Step 2 — Mount and Position the Reader
• Position the reader several inches from the symbol. You may need to reposition the
reader a few times to find the ideal distance.
• Tip the reader relative to the symbol to avoid the glare of direct (specular) reflection.
• Symbols can be rotated (tilted) at any angle; however, for best results symbols should
be aligned with the field of view. 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 result in more consistent decodes.
Important: Avoid excessive skew or pitch. Maximum skew is ±30°; maximum pitch is
±30°. The illustration below shows approximate skew axis, pitch axis, and tilt axis.
Reader and Symbol Orientation
MicroHAWK Engine Integration Guide
1-3
Install MicroHAWK USB Drivers
Step 3 — Install MicroHAWK USB Drivers
1. Plug the reader into a USB port and wait for the AutoPlay dialog to appear.
2. Click Open folder to view files and double-click the Double-Click Here.bat batch file.
3. At the command prompt, select option 1 and then type Enter. VCOM and USBLAN
drivers are installed.
4. At the command prompt, select option 3 to install the WebLink and FTP drive shortcuts.
WebLink and MicroHAWK FTP drive shortcut icons will appear on the desktop.
5. When installation of the drivers and shortcuts is complete, unplug the reader from the
USB port.
6. Re-plug the the reader into the USB port and wait for the reader to reboot and to enter
read mode (LEDs ON).
7. Double-click the WebLink desktop shortcut. WebLink will load and start. (See Step 4 –
Connect to WebLink.)
8. Double-click the FTP drive shortcut and log in with username: target and password:
password.
9. The FTP drive is opened so you can access additional resources and installers in the
Tools and Documentation folder.
You are now ready to use the MicroHAWK with WebLink.
Step 1
1-4
Step 3
MicroHAWK Engine Integration Guide
Quick Start
Step 4 — Connect to WebLink
When you double-click the WebLink desktop shortcut or enter the reader’s IP address
directly in the address bar of your web browser, WebLink will load and start.
Note: WebLink is the preferred user interface for
MicroHAWK readers, but Microscan’s ESP can
also be used for configuration and testing. ESP is
useful in the following circumstances:
Type http://192.168.188.2
• Device discovery to find the reader IP address;
(the default IP address) in the
web browser’s address bar.
• If you only have an RS-232 (serial) connection;
The WebLink session will
• Updating MicroHAWK firmware;
begin shortly after you enter
the reader’s IP address.
• Using the Configuration Database;
• Creating barcodes for reader configuration;
• Generating Symbol Quality reports.
Static Connection
1. Navigate to Control Panel > Network and Sharing Center on your PC.
2. Click Local Area Connection 4. In the Status dialog, click Properties.
3. In the Local Area Connection Properties dialog, select Internet Protocol Version 4
(TCP/IPv4) and click Properties again. Set your PC to a 192.168.188.X IP address
(192.168.188.5, for example).
4. Click OK.
5. Open a web browser and type the reader’s default IP address (http://192.168.188.2)
in the web browser’s address bar.
The reader will connect to WebLink.
DHCP Network Connection
1. Plug your reader into the your network adapter.
2. Open ESP Software and connect to the MicroHAWK via Ethernet TCP/IP.
3. Click Search to find the reader. When the reader appears in the field below the
Search and Send buttons, select it.
4. Change the reader from Static to DHCP and click Send and Save. The camera will
reboot and ESP will search for the reader again.
5. When the ID-40 is found, note the new IP address that is generated.
6. Open a browser and type the new IP address.
WebLink will load.
MicroHAWK Engine Integration Guide
1-5
Explore the Start View
Step 5 — Explore the Start View
The Start view is the initial view you will see when the session begins. The connected
reader is shown, along with its user-defined name (19 characters or fewer), IP address,
Reader Model, Serial Number, MAC ID, Firmware Version, Sensor, Optics, Decoder,
and Speed. This view allows you to choose Assisted Setup, to Create a New Setup, or
to Load a Setup.
Click the gear icon to open the Application
Settings menu, which gives you access to
several functions: Save, New, Load,
Advanced, Language, Terminal, Beeper,
Guided Tour, Image Storage, Restore
Default Settings, Manage Login, Enable
USB Drive Mode, WebLink Branding
Utility, and About WebLink.
Note: The Enable USB Drive Mode option
only appears when you are using an ID-20
or ID-30, which support USB connectivity.
1-6
MicroHAWK Engine Integration Guide
Quick Start
Step 6 — Create a New Setup or Load an Existing Setup
Assisted Setup
When you click the Assisted Setup button in the Start view, a dialog will appear asking
you a series of application-based questions. Based on your answers, WebLink generates
your initial setup automatically. Once the setup is created, you can fine-tune its parameters
in the Setup view.
Create a New Setup
The Start view also allows you to Create a New Setup without using Assisted Setup.
When you click the Create a New Setup button, WebLink searches for any differences
from default in the reader parameters. If no differences from default are found, you will see
the Setup view. If differences from default are found, an alert will appear asking if you want
to restore default settings.
Load a Setup
Select Load a Setup to load an existing .json WebLink setup file. You can also load an
.esp or .txt file from Microscan's ESP Software.
MicroHAWK Engine Integration Guide
1-7
Explore the Setup View
Step 7 — Explore the Setup View
The Setup view allows you to configure all aspects of a setup. Multiple discrete sections of
the interface give you the ability to set Cycle, Acquire, Decode, Match String, Format
Output, Output parameters, and Favorites.
Clicking the Save icon at the upper right saves current settings to the reader’s flash
memory so the settings will be available when the reader is rebooted.
The question mark icon at the upper right opens WebLink Help.
The gear icon at the upper right brings up the Application Settings menu.
Start
and
Stop
1-8
Trigger WOI
Train Optimize
(Only
Auto
shown
Photometry
when in
Trigger
Mode)
Save full-size image
Resize
Zoom Zoom
image to In
Out
Show
All
fit image
Images from
area
Read Cycle
MicroHAWK Engine Integration Guide
Quick Start
Step 8 — Configure Read Cycle Settings
The Cycle section of the Setup view allows you to modify the trigger, determine the number
of symbols for the reader to expect, and set Read Cycle Timeout. A dropdown menu of
various Cycle types provides a variety of options, each with configurable parameters.
Presentation
This mode uses Continuous Read Auto along with Continuous Capture Mode and a
Timeout at End of Read Cycle. Green Flash Mode is set to Static Presentation and the
Green Flash Duration is set to 1 second.
Continuous
This mode allows you to set the Read Cycle Timeout and the expected Number of
Symbols from 1 to 100.
Triggered
This mode sets the read cycle to Serial Data and Edge, End of Read Cycle is set to
Timeout or New Trigger, and Capture Mode is set to Rapid Capture with 1 capture.
You can adjust the Serial Trigger, Trigger Delay, Timeout, and Number of Symbols.
MicroHAWK Engine Integration Guide
1-9
Configure Read Cycle Settings
Start / Stop
This mode uses External Level with a Read Cycle Timeout and Continuous Capture,
allowing you to set Leading Edge and Trailing Edge as well as the Serial Trigger and
the Start and Stop characters.
Serial Trigger (Non-Delimited) Off
When Serial Trigger is set to Off, the start and stop characters are set to NULL, meaning
that the trigger is disabled.
Serial Trigger (Non-Delimited) On
When Serial Trigger is set to On, the start and stop characters are set to S and E. When
the trigger button is clicked, it will use the current start and stop non-delimited triggers.
Custom
This mode allows you a wider variety of read cycle scenarios, including Continuous Read
Auto. Use this mode to select Trigger mode and to set Serial Trigger Character and
Trigger Delay; to select Capture mode and to set Number of Captures, Rapid Capture
mode, and Delay between Images; and to select the End Cycle On setting as well as
Timeout and Number of Symbols.
1-10
MicroHAWK Engine Integration Guide
Quick Start
Step 9 — Configure Acquire Settings
Acquire settings allow you to set Exposure (signified by the sun icon) and Gain (signified
by the dial and right-pointing arrow icon) in real time. Clicking any of these settings will
cause a control to appear, allowing you to modify that setting. Settings take effect immediately.
Standard
When Auto Photometry is enabled instead of Standard, Exposure and Gain are read-only.
The A shown on the sun and dial icons signifies that Auto Photometry is enabled. Auto
Photometry constantly determines the best Exposure and Gain settings during each read cycle.
Auto Photometry
MicroHAWK Engine Integration Guide
1-11
Configure Acquire Settings
Enhance
The Enhance dropdown menu at the bottom of the Acquire settings editor allows you to
select the method for processing captured images.
Grow Dark
Grow Dark increases the dark cell size of a symbol. It is useful for increasing the dark cell
size of a dark-on-light Data Matrix symbol.
Shrink Dark
Shrink Dark increases the light cell size of a symbol. It is useful for increasing the light cell
size of a light-on-dark Data Matrix symbol.
Connect Dark
Connect Dark removes minor light defects of dark cells.
Separate Dark
Separate Dark removes minor dark defects of light cells.
Operator Size
The Operator Size dropdown menu determines the size of the area or “pixel neighborhood”
in which the enhance operation is being performed.
Small
Small corresponds to an area of 3 pixels by 3 pixels.
Medium
Medium corresponds to an area of 5 pixels by 5 pixels.
Large
Large corresponds to an area of 7 pixels by 7 pixels.
1-12
MicroHAWK Engine Integration Guide
Quick Start
Step 10 — Configure Symbology Settings
Clicking the gear icon at the bottom of the Decode dialog brings up Symbology Settings.
This allows you to configure every parameter for every available code type.
Data Matrix error correction parameters are shown in this
example, but you can configure any parameter for any of
the code types supported by WebLink. All parameter
changes for all code types take effect immediately.
MicroHAWK Engine Integration Guide
1-13
Format Output and Configure Match String
Step 11 — Format Output and Configure Match String
Format Output, when enabled in the Setup view, allows you to determine the many ways
in which barcode data can be formatted and parsed before it is output as a data string. You
can also set Preamble and Postamble in this dialog.
Match Options and Match String Database, accessible by clicking the Match String
section in the Setup view, allow you to set the match code mode, text output, new master,
and match string database.
1-14
MicroHAWK Engine Integration Guide
Quick Start
Step 12 — Configure Output 1, 2, and 3 Settings
Bring up the Output 1, Output 2, and Output 3 dialogs by clicking on the Outputs section
at the lower left of the Setup view. For each output you can determine the Output On
behavior, Mode, Pulse Width, and State. Outputs 2 and 3 also allow you to determine
output behavior based on Trend Options parameters or Verification Options parameters.
This example shows the dialog that appears when you click Symbol Quality Options.
A similar dialog would appear for Trend Options under Output 2.
MicroHAWK Engine Integration Guide
1-15
Run the Application
Step 13 — Run the Application
In the Run view, you can observe the progress of the setup as it follows the parameters
you have defined. The right panel of the UI shows Counts for Cycles, Reads, No Reads,
and Mismatches, as well as Rate information for Capture, Decode, Overhead, Total
Read, and Trigger Rate, as well as Output Data. A "filmstrip" below the Image Area
shows each image capture with a green check mark for a good read and a red x for a no-read.
1-16
MicroHAWK Engine Integration Guide
Quick Start
MicroHAWK Engine and ESP Quick Start
Step 1 — Check Hardware and Connect the System
Item
1
2
3
4
Description
MicroHAWK Engine
Micro-USB Type B Plug to USB Type A Plug, 6 ft. (High Speed USB 2.0)
Ferrite Core Snap-On Kit for USB Cable (for Class B Emissions; not shown)
Power Supply, 100-240VAC, +24VDC, M12 12-pin Socket (not shown)
Part Number
7AXY-YZZZ-LPPP
61-9000034-01
98-9000035-01
97-000012-01
2
To Host
USB Type A
Plug
Micro-USB
Type B Plug
1
MicroHAWK Engine – USB Standalone Configuration
MicroHAWK Engine Integration Guide
1-17
Mount and Position the Reader
Step 2 — Mount and Position the Reader
• Position the reader several inches from the symbol. You may need to reposition the
reader a few times to find the ideal distance.
• Tip the reader relative to the symbol to avoid the glare of direct (specular) reflection.
• Symbols can be rotated (tilted) at any angle; however, for best results symbols should
be aligned with the field of view. 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 result in more consistent decodes.
Important: Avoid excessive skew or pitch. Maximum skew is ±30°; maximum pitch is
±30°. The illustration below shows approximate skew axis, pitch axis, and tilt axis.
Reader and Symbol Orientation
1-18
MicroHAWK Engine Integration Guide
Quick Start
Step 3 — Install ESP
ESP Software can be found on Microscan’s Tools Drive (37-000010-01) that is packaged
with the reader if the Drive was ordered at the time of purchase. ESP can also be installed
from the Download Center, located at: www.microscan.com.
• Follow the prompts to install ESP from the Microscan Tools Drive or Download Center.
• Click the ESP icon on your desktop to run the program.
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)
MicroHAWK Engine Integration Guide
1-19
Select Model
Step 4 — Select Model
When you start ESP, the following menu will appear:
1. Click the button showing your version of the MicroHAWK.
2. Click OK or double-click one of the MicroHAWK buttons to select your reader.
3. Depending on the MicroHAWK version you have selected, you will see the appropriate
Would you like to connect to the MicroHAWK Engine-[XX]? dialog after selecting
your reader and clicking OK.
4. Click Yes when asked if you would like to connect.
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-20
MicroHAWK Engine Integration Guide
Quick Start
Step 5 — 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: For best connection results, be sure that no decodable symbols are within
the reader’s field of view while attempting to connect.
MicroHAWK Engine Integration Guide
1-21
Locate the Symbol in the Field of View
Step 6 — Locate the Symbol in the Field of View
• 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 reader.
• Center the target pattern on the symbol.
Important: The entire symbol should fall within the field of view (FOV) of the reader. 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-22
MicroHAWK Engine Integration Guide
Quick Start
Step 7 — Calibrate
MicroHAWK Engine settings can be adjusted automatically in ESP for optimum symbol
decoding performance.
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.
Calibrate by ESP
• Click the Calibrate button.
• The reader 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.
Note: If you choose to calibrate the reader by sending a <@CAL> command, a decode is
also required for the calibration process to be completed successfully.
MicroHAWK Engine Integration Guide
1-23
Test Read Rate
Step 8 — Test Read Rate
Read Rate indicates the number of successful decodes per second achieved by the reader.
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.
1-24
MicroHAWK Engine Integration Guide
Quick Start
Step 9 — Configure the Reader in ESP
Click the App Mode button to make configuration changes to the MicroHAWK Engine.
The following modes are accessible by clicking the buttons in the first row of App Mode icons:
•
•
•
•
•
•
•
•
Click EZ Mode to return to EZ Mode from App Mode.
Click Autonnect to establish communication (appears as Connect for the ID-40).
Click Send/Recv to send or receive commands.
Click Switch Model to open the model menu, to return to a previous reader model, or to
remove a previous reader model.
Click Parameters to show the tabbed tree controls for Communication, Read Cycle,
Symbologies, I/O Parameters, Symbol Quality, Matchcode, and Diagnostics.
Click Setup to access a Camera Setup tree control and the tabbed user interfaces for
Video, Evaluation, Calibration, WOI (Window of Interest), Configuration Database,
Ordered Output, Output Format, and Dynamic Setup.
Click Terminal to display decoded symbol data and to send serial commands to the
reader using text or macros.
Click Utilities to access the tabbed user interfaces for Read Rate, Counters, Device
Control, Differences from Default, Master Database, and Firmware.
MicroHAWK Engine Integration Guide
1-25
MicroHAWK Part Number Structure
Step 10 — 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 reader.
Saving Options
• Send, No Save. Changes will be lost when power is re-applied to the reader.
• Send and Save. This activates all changes in current memory and saves to the reader
for power-on.
1-26
MicroHAWK Engine Integration Guide
Quick Start
MicroHAWK Engine and AutoVISION Quick Start
Check Hardware and Connect the System
Item
1
2
3
4
Description
MicroHAWK Engine
Micro-USB Type B Plug to USB Type A Plug, 6 ft. (High Speed USB 2.0)
Ferrite Core Snap-On Kit for USB Cable (for Class B Emissions; not shown)
Power Supply, 100-240VAC, +24VDC, M12 12-pin Socket (not shown)
Part Number
7AXY-YZZZ-LPPP
61-9000034-01
98-9000035-01
97-000012-01
2
To Host
USB Type A
Plug
Micro-USB
Type B Plug
1
MicroHAWK Engine – USB Standalone Configuration
MicroHAWK Engine Integration Guide
1-27
Save Configuration in ESP
AutoVISION Overview
Navigator Bar
The Navigator Bar allows for quick switching between views.
There are four main views within AutoVISION:
• Connect: Select a device
• Image: Adjust image settings such as Focus, Gain, and Shutter
• Edit: Build an inspection using machine vision tools and adjust job settings
• Run: Monitor the status of a running job
File Menu
The file menu allows you to create a new job or open an existing job, open a recent job,
save a job (.avp), archive a job (.avz), open the AutoVISION Options dialog, or exit AutoVISION.
The New, Open, Save, and Save As options are also available on the toolbar as icons
that match the icons shown in the dropdown menu.
•
•
•
•
•
•
New: Start a new job.
Open: Open a saved job.
Open Recent: Open a recent job.
Save: Save current job (.avp file).
Save As: Rename and save current job (.avp file).
Archive Job: Compress a job and its supporting files in an .avz archive (also saves the
job as an .avp file).
• Options: Open AutoVISION Options dialog.
• Language: Select the preferred language for the AutoVISION user interface (English,
German, Chinese).
• Exit: Exit current job or close AutoVISION.
1-28
MicroHAWK Engine Integration Guide
Quick Start
File Menu Toolbar
The available commands in the file menu toolbar include Create a New Job, Open an
Existing Job, Save Job to Disk, Save Job with a New Filename, and Save Job to
Flash. If the user selects the flash option, AutoVISION will ask if they want to download
the job to the camera before saving the job to flash.
MicroHAWK Engine Integration Guide
1-29
Save Configuration in ESP
Help Menu
The Help dropdown menu allows you to see AutoVISION Help, the About AutoVISION
dialog, a Contacting Microscan dialog, and a Check for Updates dialog.
The help documentation can be opened from the Help dropdown menu, the F1 key, or the
help icon on the right side of the application:
The help file will be closed when the application is closed or when the user closes the help file.
About AutoVISION
The About AutoVISION dialog shows the name and version of the software, as well as the
part number and copyright information. Clicking More Info takes the user to an AutoVISION
support page on the Microscan website.
1-30
MicroHAWK Engine Integration Guide
Quick Start
Contacting Microscan
The Contact Information dialog shows the primary addresses of Microscan's global
headquarters. There is also a link to the Microscan website.
MicroHAWK Engine Integration Guide
1-31
Save Configuration in ESP
Check for Updates
When you select Check for Updates from the Help dropdown, AutoVISION determines
whether or not you are running the most current version of the software. If your version of
AutoVISION is not current, the dialog below will appear.
If your version of AutoVISION is current, this dialog will be displayed:
If you check the Automatically check for updates box, AutoVISION will check for newer
versions of the software once a week. Every time you check for a newer version yourself,
AutoVISION's "check for updates" timer is reset.
1-32
MicroHAWK Engine Integration Guide
Quick Start
Status Message List
The Status Message List can be opened by clicking the Status Message List icon to the
left of the help icon in the upper right of the screen:
The Status Message List allows you to view a history of all status messages shown by
AutoVISION during the current session.
Status Bar
The status bar appears at the bottom of the main window and contains the following information:
• The currently selected device;
• Device IP address;
• The grayscale value under the cursor (when hovering over the image);
• The X,Y position of the cursor in pixel coordinates.
MicroHAWK Engine Integration Guide
1-33
Save Configuration in ESP
AutoVISION Options
The AutoVISION Options dialog allows you to control AutoVISION's startup behavior and
security settings. On the Startup tab, you can set the software to Auto Connect to a
smart camera that you select from the dropdown menu, to Auto Load the most recent job,
and to go directly to Run mode at startup. You can also password protect the user interface
from the Security tab.
Startup
Auto Connect to Device: When this option
is selected, AutoVISION will connect to the
current device automatically the next time
the software is opened.
Auto Load Last Job: When this option is
selected, AutoVISION will automatically
load the most recent job the next time the
software is opened.
Go to Run Mode: When this option is
selected, AutoVISION will skip the Connect,
Image, and Edit steps and open in Run mode.
Security
Enable Password Protection: Password
protection is disabled by default. Selecting this
option imposes four separate AutoVISION
access levels: Operator, Supervisor, Engineer,
and Administrator. Passwords can only be
changed by an Administrator, and only an
Administrator can return to the Security tab.
Revert to Operator Mode
After...: When password
protection is enabled, you
can use this dropdown menu
to specify a period of inactivity
after which AutoVISION will
revert to Operator mode,
which limits access to the
Run view.
1-34
MicroHAWK Engine Integration Guide
Quick Start
User Access Levels
When password protection is enabled, AutoVISION provides four levels of access:
Operator:
An Operator can monitor the Run view of AutoVISION, but cannot access other screens
or change settings.
Supervisor:
A Supervisor can switch to Edit mode and adjust ROI (region of interest) positions, retrain
tools, change the selected device, save the current job, or load a different job. A Supervisor
cannot modify the parameters of the current job or add or remove tools.
Engineer:
An Engineer has full access to all settings and is only restricted from changing passwords.
Administrator:
An Administrator has full access to all settings, and can change the passwords for all
access levels.
Changing the Access Level
When password protection is enabled, AutoVISION will always start with the access level set
to Operator, which blocks access to the Connect, Image, and Edit views. You can change
the access level by clicking the icon shown below and entering as an Administrator.
Your current access level is always displayed in text below the icon. Click the icon to display
the following dialog:
This dialog provides a button for each of the four access levels. The highlighted button shows
the current access level. In the example above, the current access level is Administrator.
MicroHAWK Engine Integration Guide
1-35
Save Configuration in ESP
To switch to any of the other three access levels, click the button of the desired access
level and you will be asked for the that access level’s password. To switch to Engineer, for
example, click the Engineer… button. You will then see the password field:
Enter the password and click OK. If the password is correct, the access level is changed. If the
password is incorrect, an error message is displayed and the access level remains unchanged.
The default passwords for the four access levels are:
• Operator: No password required.
• Supervisor: supervisor
• Engineer: engineer
• Administrator: administrator
Once you have entered the password for a particular level, you don’t need to enter a password
to reduce your access level. For example, if you currently have Administrator access, you
can click on the Engineer or Supervisor buttons and your access level will be reduced
instantly. You only need to enter a password when you are increasing your access level.
1-36
MicroHAWK Engine Integration Guide
Quick Start
Changing Passwords
You must be an Administrator to change the password of any access level. If you change
your access level to Administrator, the Change Password… button at the bottom of the
Select Your Security Access Level dialog will be enabled:
Clicking Change Password… brings up the Change Access Level Passwords dialog:
Click the button that corresponds to the access level whose password you wish to modify,
and the Change the Password dialog will appear:
Click the Reset All to Default button on the Change Access Level Passwords dialog to
return all passwords to default.
MicroHAWK Engine Integration Guide
1-37
Save Configuration in ESP
Minimum Access Levels
AutoVISION defines the minimum access level for the various regions of the user interface
and for several features of the software. The following tables show the securable areas of
AutoVISION and the minimum access level required for each.
Edit View
Image View
Connect View (Device Selection View)
Application-Wide Options
If You Forget the Administrator Password
If are the Administrator but have forgotten the password, you can reset it to default by
deleting the UserSettings.xml file in this folder:
C:\Users\[your user name]\AppData\Roaming\Microscan\AutoVISION
Note: The AppData folder in Windows is hidden by default. To make the AppData folder visible,
click Tools in the Windows Explorer toolbar and select Folder options... from the dropdown
menu. In the Folder Options dialog, click the View tab. Under Files and Folders > Hidden files
and folders, select Show hidden files, folders, and drives and then click the Apply and OK
buttons. The AppData folder will now be visible in C:\Users\[your user name].
1-38
MicroHAWK Engine Integration Guide
Quick Start
Select a Device
AutoVISION's Connect view allows you to select your device and configure its settings,
and to create a new job.
Cameras: Vision HAWK (standard or C-Mount), Vision MINI, or Vision MINI Xi.
Emulator: The software emulator allows you to work from saved images without hardware.
The Connect menu
provides a list of
available devices.
Hover the mouse
over a device to
see its details.
Once a device is selected, you can Create a New Job, Load a Job from a saved .avp file
on your PC, or Upload Current Job From Device (your camera).
• Job: A completed program, including image acquisition, tools, and reporting.
• Tool: A self-contained set of steps used to perform a specific task.
Note: When selecting the Emulator, there is no option to upload a job.
MicroHAWK Engine Integration Guide
1-39
Save Configuration in ESP
Adjust Camera Settings
Once you have selected your camera or the Emulator and created a new job, you will
move to the Image view. This view allows you to Auto Calibrate the camera, and to manually
adjust the camera's Exposure, Gain, and Focus, and also to set the Lighting Mode (On,
Off, or Strobe).
Note: If you load a job from your PC or upload a job from the camera, you will automatically
move to the Edit view.
1-40
MicroHAWK Engine Integration Guide
Quick Start
You can return to the Connect view and click the Modify button to adjust additional camera
settings, such as TCP/IP settings, RS-232 settings, Ethernet settings, and AutoVISION button
settings. You can also rename your camera (alphanumeric characters only - [0-9], [a-z], and
[A-Z]). Click the Apply button when you have adjusted the camera's settings as needed.
MicroHAWK Engine Integration Guide
1-41
Save Configuration in ESP
Edit the Job
After you have created a new job, loaded a job from your PC, or uploaded a job from the
camera, you will proceed to the Edit view to refine your machine vision job.
The Camera parameters allow you to set Gain, Exposure, Focus, Trigger, and Lighting.
Inspection Outputs options and Microscan Link functionality allow you to connect your
job to the outside world.
This is also the view where you can add multiple tools to the job. The tool icons are
located above the main view area.
When a tool is selected, it appears in the tool list area to the left of the main view.
1-42
MicroHAWK Engine Integration Guide
Quick Start
Run the Job
Going to the Run view will automatically download your job to the camera and start it running.
The Run view provides the following feedback:
• Image Display: Displays runtime images with Tool graphics;
• Inspection Counts: Displays the number of parts inspected, passed and rejected;
• Inspection Timing Statistics: Displays statistics on the speed of your inspection;
• Tool Results: Shows the Pass/Fail status and inspection data from each of your tools.
The following options are provided:
• Adjust the speed of the image display;
• Enable/disable graphics display;
• Save uploaded images to the PC;
• Clear the inspection counts.
MicroHAWK Engine Integration Guide
1-43
Save Configuration in ESP
Save the Job
Click the Save icon to save the job to the camera's flash memory.
Note: The Save icon shows a popup menu of jobs, allowing you to overwrite existing jobs
or to create a new job.
1. Click the Stop icon.
2. Click the Save icon.
3. Click the Run icon to start again.
Save icon
Stop icon
Run icon
Note that jobs that are configured to run on stored images, saved, and then opened on a
camera, will have their snapshot setting changed to Acquire.
1-44
MicroHAWK Engine Integration Guide
Quick Start
Additional Notes
CPU Idle States (C-States)
During AutoVISION installation, you will see the dialog shown below. The dialog allows
you to disable CPU idle states, also called C-states. The purpose of disabling C-states is
to avoid image drop errors in applications using GigE Cameras with Visionscape, which is
installed with AutoVISION.
Important: Disabling C-states helps you avoid image drop errors, but it also causes the
CPU to run at full speed at all times, significantly increasing power consumption.
MicroHAWK Engine Integration Guide
1-45
Save Configuration in ESP
MicroHAWK Part Number Structure
MicroHAWK part numbers follow the format 7ABX-YZZZ-LPPP.
7 = MicroHAWK.
Example Part Number: 7112-2102-1005
Description: MicroHAWK Engine, Auto ID, IP54 Enclosure, 5V, USB, SXGA 1.2 Megapixel, Mono, High Density,
102 mm, Red Outer LEDs, High Speed X-Mode Decoder.
(A) Model
1: Engine, No Case, USB
2: ID-20 / MV-20, IP40 Case, USB
3: ID-30 / MV-30, IP54 Case, 5V, USB
4: ID-40 / MV-40, IP65 Case, 24V, Ethernet
(B) Application Type
1: Auto ID
2: Machine Vision
(X) Sensor
1: WVGA 0.3 Megapixel, Mono
2: SXGA, 1.2 Megapixel, Mono
3: QSXGA, 5 Megapixel, Color
Sensor Table
Frames per Second
(Standard / High)
WVGA 752 x 480, 0.3 MP, Mono Global
10 fps / 60 fps
SXGA 1280 x 960, 1.2 MP, Mono Global
10 fps / 42 fps
QSXGA 2592 x 1944, 5 MP, Color Rolling
5 fps
Pixels (H x V)
Shutter
(Y) Optics
0: Custom
1: Standard Density
2: High Density
(ZZZ) Focal Distance
050: 50 mm = 1.96 in.
064: 64 mm = 2.51 in.
081: 81 mm = 3.18 in.
102: 102 mm = 4.02 in.
133: 133 mm = 5.23 in.
190: 190 mm = 7.48 in.
300: 300 mm = 11.81 in.
(L) Illumination
0: Inner LEDs Only
1: Red Outer LEDs
2: White Outer LEDs
(PPP) Speed and Decoder
000: Auto ID: Standard Speed, 1D Decoder / Machine Vision: AutoVISION Sensor
001: Auto ID: High Speed, 1D Decoder / Machine Vision: AutoVISION
002: Auto ID: Standard Speed, 1D/2D Decoder / Machine Vision: AutoVISION + Verification
003: Auto ID: Standard Speed, X-Mode Decoder / Machine Vision: AutoVISION + Visionscape
004: Auto ID: High Speed, 1D/2D Decoder / Machine Vision: AutoVISION + Verification + Visionscape
005: Auto ID: High Speed, X-Mode Decoder
Notes:
• (A) Model: The MicroHAWK Engine is available for OEM-certified partners only.
• (L) Illumination: Outer LEDs provide extra illumination. Base level illumination included with all readers.
• (PPP) Speed and Decoder: 1D omnidirectional decoding functionality is included with all readers. The 1D/2D
Decoder option is useful for printed labels. X-Mode is the full decoder package for 1D, 2D, DPM, and damaged symbols.
• Field Upgrades: Not available for optics or illumination due to factory settings for optical alignment, LED balancing,
and sealing for IP enclosure rating. However, the reader’s speed, decoder version, and software are field-upgradeable
via licenses.
1-46
MicroHAWK Engine Integration Guide
2 Using ESP
Contents
EZ Mode........................................................................................................................................2-2
App Mode......................................................................................................................................2-3
Menu Toolbar ................................................................................................................................2-4
View ............................................................................................................................................2-13
Navigating in ESP .......................................................................................................................2-14
Send/Receive Options ................................................................................................................2-15
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 App Mode, where you can access several configuration menus:
Communications, Read Cycle, Symbologies, I/O Parameters, Symbol Quality,
Matchcode, and Diagnostics, as well as a Camera Setup interface, a Terminal interface,
and a Utilities interface.
ESP can be used to configure the MicroHAWK Engine in three different ways:
• Tree Controls: Each configuration menu contains a list of all commands and command
parameters that pertain to that specific element of reader operation. For example, the I/O
Parameters menu shows a Calibration Options command (which corresponds to the
<K529> serial command), and then a list of the parameters Gain, Exposure, Symbol
Type, Window of Interest Framing, Window of Interest Margin, Linescan Height, and
Processing. Each of these parameters is configurable dropdown menus and spin boxes.
• Graphic User Interfaces: Reader settings can be configured using radio buttons, sliders,
spin boxes, check boxes, and various drag-and-drop functions.
• Terminal: ESP’s Terminal allows you to send serial commands directly to the reader by
typing them in the Send text field.
Information about using ESP in specific applications is provided in subsequent sections.
For ESP system requirements, see Minimum System Requirements in the Install ESP
step of the Quick Start section.
MicroHAWK Engine Integration Guide
2-1
EZ Mode
EZ Mode
EZ Mode allows the user to test read rate and calibrate the MicroHAWK Engine. After
connecting to the MicroHAWK Engine, the EZ Mode view will appear. On-screen instructions
assist the user with positioning, testing, and calibration.
Locate/Calibrate/Learn
The calibration routine optimizes the MicroHAWK Engine by comparing Read Rates at various
camera and image processing settings. Click Locate to find the symbol in the field of view
and display it in the video view. Then click Calibrate to begin the calibration routine. The
Learn button allows you to save information about the next Data Matrix symbol decoded,
which allows faster and more consistent processing of subsequent identical symbols.
Test
Click the Test button to start the Read Rate test for a quick indication of the MicroHAWK
Engine’s read capabilities and the limits of the 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.
Click Locate to find and display the symbol. Click Calibrate to begin the
calibration routine. Calibration is also explained in Quick Start. Click
Learn to save information about the next Data Matrix symbol decoded.
Click the App Mode button
to access configuration trees
and other setup features.
When Decodes per Second
is checked, the read rate test
displays how many decodes
the MicroHAWK Engine
achieves each second, instead
of displaying a percentage.
2-2
Click Test button to
start the Read Rate
test and click Stop
to end the test.
Symbol data is
displayed here.
Contrast brightens
the image.
MicroHAWK Engine Integration Guide
Using ESP
Application Mode
From EZ Mode, click on the App Mode button to access the tabbed tree controls in
Parameters, the intuitive user interfaces in Setup, the Terminal interface, and the Utilities
interface.
Note: The App Mode and EZ Mode buttons appear in the same position to allow easy
switching between these primary modes.
Video, Evaluation, Calibration, WOI, Configuration Database,
Ordered Output, Output Format, Dynamic Setup
Click this icon to
return to EZ Mode.
Menu toolbar
Autoconnect to the
MicroHAWK Engine,
Send and Receive
command settings,
and Switch Model.
Click here to open
the Terminal view.
Tabbed tree
controls
Read Rate,
Counters,
Device Control,
Differences
from Default,
Master Database,
Firmware
Mirror Image reverses the image.
Contrast brightens the image.
Click Capture and Decode to
decode the symbol in the field of
view, and to see a high resolution
image capture of the symbol.
Symbol data is
displayed here.
MicroHAWK Engine Integration Guide
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 reader. The illustration
below shows how settings can be saved and received between
ESP and the reader, and ESP and the host hard drive.
(Save to Reader)
(Receive Reader
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
MicroHAWK Engine Integration Guide
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 a .esp file, you are saving the settings of all models defined in that file.
MicroHAWK Engine Integration Guide
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 MicroHAWK Engine? prompt.
Receive After Connect
At startup, loads the reader’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
MicroHAWK Engine Integration Guide
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 reader 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 reader
will continue to appear in the terminal even when ESP is not the top window.
MicroHAWK Engine Integration Guide
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
MicroHAWK Engine Integration Guide
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
reader’s settings to ESP when Auto Sync is enabled. Send ESP Settings to the Reader
will automatically send all reader configuration settings chosen in ESP to the reader. Do
Not Send or Receive Settings creates a condition in which Auto Sync will not automatically
send reader settings to ESP, or send ESP settings to the reader.
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 reader before starting Autoconnect.
MicroHAWK Engine Integration Guide
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
MicroHAWK Engine Integration Guide
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.
MicroHAWK Engine Integration Guide
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 MicroHAWK Engine and the host.
2-12
MicroHAWK Engine Integration Guide
Using ESP
Autoconnect
• If the RS-232 connection attempt fails, use Autoconnect to establish a connection between
the MicroHAWK Engine and the host.
• If the communication port is not the default COM1, use the dropdown menu to change
the port.
• Once you have
chosen the
correct port,
click Start to
connect.
• When a connection is established, the green indicator in the status bar at the bottom
right of the screen will be visible.
MicroHAWK Engine Integration Guide
2-13
View
View
The View menu allows you to move quickly between Parameters, Setup, Terminal, and
Utilities 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.
2-14
MicroHAWK Engine Integration Guide
Using ESP
Navigating in ESP
Click the App Mode button to change reader settings, or to access the Utilities, Camera,
Terminal, or Output Format views.
To return to EZ Mode, click the EZ Mode button.
To make changes to configuration settings in the tree controls:
1. Left-click on the + to
expand menu items.
The X denotes the
default option setting.
2. Double-click the
desired parameter and
single-click in the
selection box to view
options.
3. Place your cursor in the
selection box, scroll
down to the setting you
want to change, and
single-click the setting.
4. Left-click again on the open screen to complete the
selection.
5. Right-click on the open screen and select Save to
Reader to implement the command in the reader.
You can send the command without saving it, or you
can send and save the command simultaneously.
MicroHAWK Engine Integration Guide
2-15
Send/Receive Options
Send/Receive Options
To access Receive, Save, and Default options, click the Send/Recv button. You can also
access these options by right-clicking in any of the configuration views.
Receiving
From the Send/Recv menu, select Receive Reader Settings.
Caution: Do not select this option if you do not want to upload the reader’s settings. For
example, if your ESP file has a number of custom settings that you want to maintain and
download into the reader, these settings would be lost by choosing Yes.
This is useful if you want to receive (upload) the reader’s settings and save them as a file
for future use. For example, if your reader 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 reader’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 reader 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.
2-16
MicroHAWK Engine Integration Guide
Using ESP
Defaulting
When you select Default Current Menu Settings or Default all ESP Settings, you are
only defaulting the ESP settings.
Advanced Options
Send Current View
This is the same as Save to Reader
> Send No Save except that only the
commands in the current configuration
tree are sent.
Send Current Command
This is the same as Send Current
View, except that it saves only the
command that is currently selected.
Add/Remove Exception
After you perform a Receive Reader Settings 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
reader’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 reader 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.
MicroHAWK Engine Integration Guide
2-17
Send/Receive Options
2-18
MicroHAWK Engine Integration Guide
3 Integration
Contents
MicroHAWK Engine Hardware at a Glance ................................................................................. 3-2
Mounting Specifications ................................................................................................................ 3-3
Optical Requirements ................................................................................................................... 3-4
Viewing Port Specifications........................................................................................................... 3-5
Expansion Connector (FPC) ......................................................................................................... 3-6
This section provides information that allows you to integrate the MicroHAWK Engine in
your application mechanically and electrically.
MicroHAWK Engine Integration Guide
3-1
MicroHAWK Engine Hardware at a Glance
MicroHAWK Engine Hardware at a Glance
Item
3-2
Description
1
Camera Imager
2
White Illumination
3
Red Illumination
4
USB, Micro B, Receptacle
5
FPC, 45-Pin, .3 mm Pitch
6
Green Flash (Good Read)
7
Blue Targeting
8
M2 Mounting
9
Keying Location
MicroHAWK Engine Integration Guide
Integration
Mounting Specifications
Front
Side
See Detail A (Base)
Base
Detail A (Base)
MicroHAWK Engine Integration Guide
3-3
Optical Requirements
Optical Requirements
Base
3-4
Side
MicroHAWK Engine Integration Guide
Integration
Viewing Port Specifications
MicroHAWK Engine Integration Guide
3-5
Expansion Connector (FPC)
Expansion Connector (FPC)
3-6
MicroHAWK Engine Integration Guide
4 Communications
Contents
Communications by ESP .............................................................................................................. 4-2
Communications Serial Commands.............................................................................................. 4-3
Network Interfaces ........................................................................................................................ 4-4
Host Port Connections .................................................................................................................. 4-5
Host Port Protocol......................................................................................................................... 4-6
ACK/NAK Options......................................................................................................................... 4-7
Polling Mode Options.................................................................................................................... 4-8
Ethernet ........................................................................................................................................ 4-9
Response Timeout...................................................................................................................... 4-15
LRC (Longitudinal Redundancy Check) Status .......................................................................... 4-16
Protocol Configuration Examples................................................................................................ 4-17
Preamble..................................................................................................................................... 4-18
Postamble ................................................................................................................................... 4-19
USB HID/Keyboard ..................................................................................................................... 4-20
EtherNet/IP Byte Swapping Enabled .......................................................................................... 4-25
USB Mass Storage Driver........................................................................................................... 4-26
Entering ASCII Characters as Hex Values ................................................................................. 4-27
This section explains how to set up communications with a host.
With Microscan’s ESP (Easy Setup Program), configuration changes can be made in the
ESP menus and then sent and saved to the reader. The user can also send serial commands
to the reader via ESP’s Terminal window.
MicroHAWK Engine Integration Guide
4-1
Communications by ESP
Communications by ESP
Click the Parameters
button and then the
Communication tab.
To open nested options,
single-click the +.
4-2
To change a setting, double-click the
setting and use your cursor to scroll
through the options.
MicroHAWK Engine Integration Guide
Communications
Communications Serial Commands
Host Port Connections
Ethernet
Ethernet TCP Ports
Search and Configure Mode
EtherNet/IP
Host Protocol
Preamble
Postamble
Response Timeout
LRC Status
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>
<K128,status,timed window>
<K129,status>
<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>
<K149,Microscan Report Enabled,Keyboard Report
USB HID/Keyboard
Enabled,Keyboard Language,USB VCOM Status,
UART Status>
EtherNet/IP Byte Swapping Enabled <K163,status>
USB Mass Storage Driver
<K900,status>
MicroHAWK Engine Integration Guide
4-3
Network Interfaces
Network Interfaces
The MicroHAWK Engine supports network connectivity over three possible interfaces:
USB1, USB2, and Ethernet. Interface configuration is controlled by system parameters.
All interfaces are enabled by default.
Note that only one of the two USB interfaces can be used at a time, but it is possible to
connect Ethernet and one of the USB interfaces concurrently. The system automatically
detects which USB interface is connected.
If multiple interfaces are active at the same time, the system selects the Ethernet interface
as the primary network communication port as it offers the best performance.
Serial Interface
The MicroHAWK Engine supports serial communications via a UART. By default, the
system command port is mapped to this device. This connection supports a wide range
of serial parameters. The default settings are 115,200 baud, no parity, eight data bits,
one stop bit, and no flow control.
4-4
MicroHAWK Engine Integration Guide
Communications
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:
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
MicroHAWK Engine Integration Guide
4-5
Host Port Protocol
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:
4-6
<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
MicroHAWK Engine Integration Guide
Communications
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 reader 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 Reader
TX to Reader: [STX] <command> [ETX] [LRC]
Response from Reader: ACK/NAK. Sent when LRC, ETX, or command-ending angle
bracket ‘>’ are received, depending on what is enabled.
Command Response from Reader 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 reader 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.
MicroHAWK Engine Integration Guide
4-7
Polling Mode Options
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.
4-8
MicroHAWK Engine Integration Guide
Communications
Ethernet
Enables or disables Ethernet connectivity in the reader. This corresponds to the <K126>
command. It requires a <Zrdall> to return to default settings.
IP Address
This is the IP address of the reader when it is in Static IP Address Mode.
MicroHAWK Engine Integration Guide
4-9
Ethernet
Subnet
This is the subnet of the reader when it is in Static IP Address Mode.
Gateway
This is the gateway IP address of the reader when it is in Static IP Address Mode.
4-10
MicroHAWK Engine Integration Guide
Communications
IP Address Mode
Determines how the reader’s IP address will be defined.
Static
In Static Mode, the reader uses the user-defined IP address entered in ESP. This is the
default state for an Ethernet-enabled MicroHAWK.
DHCP
In DHCP Mode, the reader automatically acquires the IP address, Subnet, and Gateway
addresses from a DHCP or BOOTP server. This is the default state for a USB MicroHAWK.
MicroHAWK Engine Integration Guide
4-11
Ethernet
TCP Port 1
One of two TCP ports for Ethernet communication with the reader. The default setting is 2001.
Symbol Data Output
Enables or disables decoded symbol data output from the reader.
Extra Symbol Information
Enables or disables extra symbol information output from the reader.
Diagnostics Output
Enables or disables diagnostics output from the reader.
External Source Processing Mode
Enables or disables processing of commands or data from sources external to the reader.
Command
Command enables command processing in the reader.
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.
4-12
MicroHAWK Engine Integration Guide
Communications
TCP Port 2
One of two TCP ports for Ethernet communication with the reader. The default setting is 2003.
Symbol Data Output
Enables or disables decoded symbol data output from the reader.
Extra Symbol Information
Enables or disables extra symbol information output from the reader.
Diagnostics Output
Enables or disables diagnostics output from the reader.
External Source Processing Mode
Enables or disables processing of commands or data from sources external to the reader.
Command
Command enables command processing in the reader.
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.
MicroHAWK Engine Integration Guide
4-13
Ethernet
Search and Configure Mode
Search and Configure Mode is intended primarily for initial setup of an reader in a network.
This parameter controls whether or not the reader will respond to ESP’s Search function in
the Ethernet TCP/IP connect dialog section of the Connection Wizard:
After the reader is in full use in an
application, you may want the
reader 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 reader 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 reader.
Enabled
When enabled, Search and Configure Mode will find the reader and settings can be
changed.
Timed Window
When Timed Window is selected, Search and Configure Mode will find the reader and
settings can be changed, but only 60 seconds from the last reset. After 60 seconds,
Search and Configure Mode will be disabled.
4-14
MicroHAWK Engine Integration Guide
Communications
Response Timeout
Usage:
Definition:
Serial Cmd:
Default:
Options:
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 reader 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.)
MicroHAWK Engine Integration Guide
4-15
LRC (Longitudinal Redundancy Check) Status
LRC (Longitudinal Redundancy Check) Status
Usage:
Definition:
Serial Cmd:
Default:
Options:
4-16
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
MicroHAWK Engine Integration Guide
Communications
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>
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
MicroHAWK Engine Integration Guide
4-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.
4-18
MicroHAWK Engine Integration Guide
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.
MicroHAWK Engine Integration Guide
4-19
USB HID/Keyboard
USB HID/Keyboard
Definition:
Serial Cmd:
These parameters cause the reader to reboot after a <Z> or <A> command.
The data packet is structured for input and output as follows:
Byte 1 = Report Type (Always 1)
Byte 2 = Data Length (Hex Format)
Byte 3 – 64 = Data to Command Processor
<K149,Microscan Report Enabled,Keyboard Report Enabled,Keyboard
Language,USB VCOM Status,UART Status>
Microscan Report Enabled
Serial Cmd:
Default:
Options:
<K149,Microscan Report Enabled,Keyboard Report Enabled,Keyboard
Language,USB VCOM Status,UART Status>
0 = Disabled
0 = Disabled
1 = Enabled
Keyboard Report Enabled
Serial Cmd:
Default:
Options:
<K149,Microscan Report Enabled,Keyboard Report Enabled,Keyboard
Language,USB VCOM Status,UART Status>
0 = Disabled
0 = Disabled
1 = Enabled
Keyboard Language
Definition:
Serial Cmd:
Default:
Options:
4-20
Used by the reader to help identify what keyboard layout to use when the
keyboard drive is outputting data. If the unit does not have the keyboard
layout assigned to this parameter, than it will default to the en-US keyboard
layout. On the next page is the list of acceptable languages with predefined
keyboard layouts. If they are pre-loaded into the reader’s firmware they are
shown in bold. All other languages will need to be manually loaded as a
keyboard.def file or added to the reader’s firmware.
<K149,Microscan Report Enabled,Keyboard Report Enabled,Keyboard
Language,USB VCOM Status,UART Status>
en-US
ASCII string, up to 25 characters
MicroHAWK Engine Integration Guide
Communications
Keyboard Languages
MicroHAWK Engine Integration Guide
4-21
USB HID/Keyboard
Keyboard Languages (continued)
4-22
MicroHAWK Engine Integration Guide
Communications
Keyboard Languages (continued)
MicroHAWK Engine Integration Guide
4-23
USB HID/Keyboard
USB VCOM (Virtual COM) Status
Definition:
Serial Cmd:
Options:
This command enables the USB Virtual COM Port Driver if your reader
supports the driver. The reader will reset so the driver can be used.
<K149,Microscan Report Enabled,Keyboard Report Enabled,Keyboard
Language,USB VCOM Status,UART Status>
0 = Disabled (Default for ID-40)
1 = Enabled (Default for Engine, ID-20, and ID-30)
UART Status
Definition:
Serial Cmd:
Options:
4-24
This command allows the reader to communicate on the reader’s UART if
the reader is UART-capable. The reader will reset so the UART can be used.
<K149,Microscan Report Enabled,Keyboard Report Enabled,Keyboard
Language,USB VCOM Status,UART Status>
0 = Disabled (Default for ID-20)
1 = Enabled (Default for Engine, ID-30, and ID-40)
MicroHAWK Engine Integration Guide
Communications
EtherNet/IP Byte Swapping Enabled
Definition:
Serial Cmd:
Default:
Options:
Enables or disables EtherNet/IP byte swapping for decode data.
<K163,status>
Enabled
0 = Disabled
1 = Enabled
MicroHAWK Engine Integration Guide
4-25
USB Mass Storage Driver
USB Mass Storage Driver
Definition:
Serial Cmd:
Default:
Options:
4-26
Enables USB MicroHAWK readers to display a Mass Storage device on the
host PC.
<K900,status>
Disabled
0 = Disabled
1 = Enabled
MicroHAWK Engine Integration Guide
Communications
Entering ASCII Characters as Hex Values
Commands that require ASCII text fields, such as Preamble and Postamble commands,
can be sent to the reader as hex values.
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 values. 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.)
MicroHAWK Engine Integration Guide
4-27
Entering ASCII Characters as Hex Values
4-28
MicroHAWK Engine Integration Guide
5 Calibration
Contents
Calibration Serial Commands ....................................................................................................... 5-2
Calibration Overview..................................................................................................................... 5-2
Calibration Options ....................................................................................................................... 5-3
Calibration by ESP....................................................................................................................... 5-8
Initiating Calibration ................................................................................................................... 5-10
Additional Notes about Calibration............................................................................................. 5-11
This section shows the MicroHAWK Engine’s calibration options, and explains the different
ways that those options can be configured.
MicroHAWK Engine Integration Guide
5-1
Calibration Serial Commands
Calibration Serial Commands
Calibration Options
<K529,gain,exposure,symbol type,WOI framing,WOI margin,
line scan height,processing>
Calibration Overview
Calibration is one of the most powerful features of the MicroHAWK Engine. The calibration
process can be initiated by serial command or in the ESP user interface.
When the reader enters calibration, it runs through an optimization cycle that sets the ideal
parameters for reading symbols at the highest possible level of performance. Calibration can be
specially configured to optimize specific parameters, such as gain, exposure, and symbol type.
5-2
MicroHAWK Engine Integration Guide
Calibration
Calibration Options
This command specifies the operation of the calibration feature. The default configuration
performs calibration on gain and symbol type. The calibration process optimizes the gain
setting for the configured exposure.
Gain
Definition:
When enabled, gain is calibrated to provide the best available image
quality and performance.
When disabled, gain is fixed and is not part of the calibration process.
Serial Cmd:
<K529,gain,exposure,symbol type,WOI framing,WOI margin,line scan
height,processing>
Default:
Enabled (Decode Required)
Options:
0 = Disabled
1 = Enabled (Decode Required)
2 = Quick Calibrate
Note: If you choose to calibrate the reader by sending a <@CAL> command, a decode
is also required for the calibration process to be completed successfully.
Disabled
When disabled, gain is fixed and is not part of the calibration process.
Enabled
When enabled, gain is calibrated to provide the best image quality and performance for
the symbol present in the field of view. Calibration requires that a decodable symbol be
placed in the field of view, as feedback from the symbol decoding process is used to select
the best gain setting. If a symbol is not decoded the process will result in a fail condition.
Gain is enabled by default.
Quick Calibrate
Quick Calibrate uses the automatic gain control (AGC) feature of the image sensor to
adjust the gain value such that the current image falls into a desirable region of the image
sensor’s sensitivity range, ensuring optimal image luminance. The image sensor converges
on the optimal gain value within a few image frames.
MicroHAWK Engine Integration Guide
5-3
Calibration Options
Exposure
Definition:
Unless the application is static, exposure should be configured based on
the application’s line speed. The table below is a general guideline for
exposure configurations at various line speeds.
Serial Cmd:
<K529,gain,exposure,symbol type,WOI framing,WOI margin,line scan
height,processing>
Default:
Enabled (Decode Required)
Options:
0 = Disabled
1 = Enabled (Decode Required)
2 = Quick Calibrate
Note: If you choose to calibrate the reader by sending a <@CAL> command, a decode
is also required for the calibration process to be completed successfully.
Note: This table shows guidelines for exposure settings based on various line speeds.
The settings shown depend on the reader’s optical configuration and on symbol element size.
Exposure
100,000 – 4,000
4,000 – 1,250
1,250 – 700
700 – 500
500 – 400
Line Speed
Static
5” / sec
10” / sec
15” / sec
20” / sec
Disabled
When disabled, exposure is fixed and is not part of the calibration process.
Enabled
When enabled, exposure is calibrated to provide the best image quality and performance
for the symbol present in the field of view. Calibration requires that a decodable symbol be
placed in the field of view, as feedback from the symbol decoding process is used to select
the best exposure setting. If a symbol is not decoded the process will result in a fail condition.
Exposure is enabled by default.
Quick Calibrate
Quick Calibrate uses the automatic exposure control feature of the image sensor to
adjust the exposure value such that the current image falls into a desirable region of the
image sensor’s sensitivity range, ensuring optimal image luminance. The image sensor
converges on the optimal exposure value within a few image frames.
5-4
MicroHAWK Engine Integration Guide
Calibration
Symbol Type
Serial Cmd:
Default:
Options:
<K529,gain,exposure,symbol type,WOI framing,WOI margin,line scan
height,processing>
Enabled
0 = Disabled
1 = Enabled
Disabled
When this feature is disabled, only the current enabled symbologies will be considered
during the calibration process.
Enabled
When this feature is enabled, autodiscrimination is in effect during the calibration process.
All supported symbologies except PDF417 and Pharmacode will be attempted 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 decoded during calibration, then Code 128 as well as Code 39 will be enabled.
Window of Interest (WOI) Framing
Definition:
If WOI Framing is enabled, the camera’s Window of Interest will be set 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. This is done to speed up the calibration process. When a successful
calibration is complete, the camera WOI will be adjusted according to the
mode enabled. Otherwise, the original WOI configuration will be retained.
Serial Cmd:
<K529,gain,exposure,symbol type,WOI framing,WOI margin,line scan
height,processing>
Default:
Disabled
Options:
0 = Disabled
1 = Row and Column
2 = Row
3 = Column
4 = Straight Line
5 = Straight Line Framed
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 calibration completes, the original WOI configuration
is restored.
MicroHAWK Engine Integration Guide
5-5
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.
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.
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.
Straight Line
This feature is intended for use with linear symbologies. If the calibration process is successful,
the orientation of the symbol is determined and the Window of Interest is modified according
to the symbol orientation. The scan line orientation is determined to be vertical if the
symbol tilt is between 225° and 315°, or between 45° and 135°. Otherwise, the scan line
will be horizontal.
If the symbol is vertical, the image column size will be set by the scan height parameter,
and will be configured for full row resolution. If the symbol is horizontal, the image row size
will be set by the scan height parameter, and will be configured for full column resolution.
The scan line will be centered in the middle of the symbol. If the symbol is tilted such that
the scan line will not pass completely through the symbol, the scan width will be adjusted
to include the entire symbol. Refer to the diagram below:
Straight Line Framed
This parameter is the same as “Straight Line”, except that the Window of Interest will also
frame the scan line on the symbol length as well. The scan line includes the symbol plus
an additional margin area determined by the WOI Margin parameter.
5-6
MicroHAWK Engine Integration Guide
Calibration
Window of Interest (WOI) Margin
Definition:
Serial Cmd:
Default:
Options:
Sets the margin size that is applied to the calibrated symbol. This parameter
is expressed in number of pixels. If the margin causes the image to exceed
the maximum image size, it will be reduced accordingly.
<K529,gain,exposure,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,exposure,symbol type,WOI framing,WOI margin,line scan
height,processing>
64 (pixels)
3 to 1280
Processing
Definition:
Serial Cmd:
Default:
Options:
This setting defines the amount of time and effort the reader will spend
attempting to decode a symbol for each parameter configuration.
<K529,gain,exposure,symbol type,WOI framing,WOI margin,line scan
height,processing>
Medium
0 = Low
1 = Medium
2 = High
3 = Definable
Low
The reader will spend a low amount of effort attempting to decode the given symbol for
each parameter configuration.
Medium
The reader will spend a medium amount of effort attempting to decode the given symbol
for each parameter configuration.
High
The reader 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 Image Processing Timeout.
MicroHAWK Engine Integration Guide
5-7
Calibration by ESP
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 reader
“sees” before and after the calibration routine.
Exposure, Gain, and Image
Quality values are all
tracked in real-time during
the calibration process.
Gain and Shutter Speed are configurable
in the Calibration interface.
Determines the
amount of time
and effort the
reader will spend
attempting to
decode a symbol
for each parameter
configuration.
(Low, Medium,
High, Definable).
Dropdown menu of 1D and 2D symbologies, and a check
box for enabling or disabling Composite symbologies.
Initiates the
calibration
routine.
Cancels the
calibration
process, if
necessary.
The Window of Interest section of the Calibration interface allows the user to make precise adjustments
to WOI Framing, WOI Margin (in pixels), and the scan height of the straight-line image (in pixels).
5-8
MicroHAWK Engine Integration Guide
Calibration
After Calibration
The 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.
Notice the improved image resolution after
the calibration process is complete.
Saves the optimal configuration parameters
determined by calibration results.
MicroHAWK Engine Integration Guide
5-9
Initiating Calibration
Initiating Calibration
Calibration can be initiated by serial command or from the Calibration interface in ESP.
A symbol must be in the reader’s field of view during the calibration process.
In ESP, the Calibrate button starts the calibration routine.
Note: If you choose to calibrate the reader by sending a <@CAL> command, a decode is
also required for the calibration process to be completed successfully.
5-10
MicroHAWK Engine Integration Guide
Calibration
Additional Notes about Calibration
The following conditions apply to the reader’s calibration process. Some of these items
are noted at various points throughout this section, or in other sections of the reader’s
documentation.
1. 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.
2. Image Processing Mode will not be altered during calibration.
3. Thresholding Mode will be set to Adaptive during calibration. At the completion of a
successful calibration, the threshold mode will remain set to Adaptive regardless of its
previous setting. Otherwise, the value will revert back to its original state. This is so
the reader can continue to decode after calibration is finished.
4. 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.
5. Pharmacode is not calibrated.
6. The symbol size, dimension, and orientation parameters of the No Symbol / Bad
Symbol and Symbol Qualification command <K718> will be updated if calibration is
successfully completed.
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. Calibration 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. 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.
MicroHAWK Engine Integration Guide
5-11
Additional Notes about Calibration
5-12
MicroHAWK Engine Integration Guide
6 Read Cycle
Contents
Read Cycle by ESP ...................................................................................................................... 6-2
Read Cycle Serial Commands...................................................................................................... 6-3
Read Cycle Setup......................................................................................................................... 6-4
Multisymbol................................................................................................................................... 6-5
Trigger Mode and Filter Duration.................................................................................................. 6-6
External Trigger Polarity ............................................................................................................. 6-11
Serial Trigger .............................................................................................................................. 6-12
Start Trigger Character (Non-Delimited)..................................................................................... 6-13
Stop Trigger Character (Non-Delimited) ..................................................................................... 6-14
End of Read Cycle...................................................................................................................... 6-15
Capture Mode ............................................................................................................................. 6-17
Capture Timing ........................................................................................................................... 6-22
Image Processing Timeout ......................................................................................................... 6-24
Image Storage ............................................................................................................................ 6-25
Minimum Good Reads ................................................................................................................ 6-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.
MicroHAWK Engine Integration Guide
6-1
Read Cycle by ESP
Read Cycle by ESP
Click the Parameters
button and then the
Read Cycle tab.
To open nested options,
single-click the +.
6-2
To change a setting,
double-click the
setting and use your
cursor to scroll
through the options.
MicroHAWK Engine Integration Guide
Read Cycle
Read Cycle Serial Commands
<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 mode,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>
<K241,capture mode,number of rapid captures,rapid capture
Capture Mode
mode,number of continuous captures,images per read cycle
limit,read cycle history limit>
<K242,time before first capture,time between captures 1 and
2,timebetween captures 2 and 3,time between captures 3 and
Capture Time
4,time between captures 4 and 5,time between captures 5 and
6,time between captures 6 and 7,time between captures 7 and 8
Image Storage
<K244,image storage type,image store mode>
Image Processing Timeout <K245,image processing timeout>
Trigger Mode/Filter Duration
MicroHAWK Engine Integration Guide
6-3
Read Cycle Setup
Read Cycle Setup
Setting up read cycle and triggering parameters will involve a series of decisions based on
your particular application, as follows:
1. Select the number of symbols to be read in a single cycle. The MicroHAWK Engine
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 capture rate increases as the frame size decreases.
6-4
MicroHAWK Engine Integration Guide
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 reader 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.
Note: If No-Read messages are disabled and there are No-Reads occurring, separators
will only be inserted between symbol data outputs.
MicroHAWK Engine Integration Guide
6-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 reader 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
6 = Continuous Read Auto
Continuous Read
Usage:
Definition:
Serial Cmd:
6-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 reader 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 reader 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 reader 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>
MicroHAWK Engine Integration Guide
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 reader 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 reader 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 reader will send the current
symbol data immediately, but only once. A new symbol appearing in the
reader’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 reader will behave as if
Number of Symbols were set to 1, regardless of the user-defined configuration.
MicroHAWK Engine Integration Guide
6-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 reader 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:
6-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>
MicroHAWK Engine Integration Guide
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 reader 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 reader 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.
Continuous Read Auto
Definition:
Serial Cmd:
Behaves identically to Continuous Read but maintains optimal self-adjusting
photometry parameters. As a result, the photometry parameters (Exposure
and Gain) in the <K541> command are continuously updated with the
optimal configuration. In this mode, the illumination does not strobe, but
instead is always active, as images are continuously captured.
<K200,6>
MicroHAWK Engine Integration Guide
6-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 reader 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 reader 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:
6-10
MicroHAWK Engine Integration Guide
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 reader.
<K202,active state>
Positive
0 = Negative
1 = Positive
MicroHAWK Engine Integration Guide
6-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 (0x00
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.
6-12
MicroHAWK Engine Integration Guide
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 reader 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 reader 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.
MicroHAWK Engine Integration Guide
6-13
Stop Trigger Character (Non-Delimited)
Stop Trigger Character (Non-Delimited)
Usage:
Definition:
Serial Cmd:
Default:
Options:
6-14
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 reader 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 reader 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.
MicroHAWK Engine Integration Guide
Read Cycle
End of Read Cycle
Definition:
The read cycle is the time during which the reader 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 reader 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.
MicroHAWK Engine Integration Guide
6-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:
6-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
MicroHAWK Engine Integration Guide
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,number of
continuous captures,images per read cycle limit,read cycle history>
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 reader
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
MicroHAWK Engine Integration Guide
6-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,number of
continuous captures,images per read cycle limit,read cycle history>
1
1 to 255
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:
6-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,number of
continuous captures,images per read cycle limit,read cycle history>
Timed Capture
0 = Timed Capture
1 = Triggered Capture
MicroHAWK Engine Integration Guide
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
MicroHAWK Engine Integration Guide
6-19
Capture Mode
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
6-20
MicroHAWK Engine Integration Guide
Read Cycle
Number of Continuous Captures
Definition:
Serial Cmd:
Default:
Options:
Specifies the number of captures to process in Continuous Capture mode.
<K241,capture mode,number of captures,rapid capture mode,number of
continuous captures,images per read cycle limit,read cycle history>
2
1 and 255
Images per Read Cycle Limit
Definition:
Serial Cmd:
Default:
Options:
Specifies the number of captures to process in a read cycle.
<K241,capture mode,number of captures,rapid capture mode,number of
continuous captures,images per read cycle limit,read cycle history>
10
3 and 255
Read Cycle History
Definition:
Serial Cmd:
Default:
Options:
Specifies the number of images that can be stored in read cycle history.
<K241,capture mode,number of captures,rapid capture mode,number of
continuous captures,images per read cycle limit,read cycle history>
10
0 and 255
MicroHAWK Engine Integration Guide
6-21
Capture Timing
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 reader’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
6-22
MicroHAWK Engine Integration Guide
Read Cycle
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 reader 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
1 2 3 4 5
End of
Read Cycle
Time Delay Between Captures varies.
Diagram B
MicroHAWK Engine Integration Guide
6-23
Image Processing Timeout
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.
6-24
MicroHAWK Engine Integration Guide
Read Cycle
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 reader 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 reader 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 reader will not store
images for later viewing.
Store on No-Read
This option will cause the reader 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 reader, and as long as the
reader 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 reader 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 reader to store images until the available image memory has been
filled. At that point the reader 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.
MicroHAWK Engine Integration Guide
6-25
Image Storage
Image Storage Example
The following example assumes that the reader 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
6-26
MicroHAWK Engine Integration Guide
Read Cycle
Minimum Good Reads
Definition:
Serial Cmd:
Default:
Options:
This value specifies the number of times a symbol needs to be read to
qualify as a good read.
<K221,minimum good reads>
1
1 to 255
MicroHAWK Engine Integration Guide
6-27
Minimum Good Reads
6-28
MicroHAWK Engine Integration Guide
7 Symbologies
Contents
Symbologies by ESP.................................................................................................................... 7-2
Symbologies Serial Commands ................................................................................................... 7-3
Data Matrix ................................................................................................................................... 7-4
Aztec ............................................................................................................................................ 7-6
QR Code ...................................................................................................................................... 7-7
Micro QR Code............................................................................................................................. 7-8
Code 39........................................................................................................................................ 7-9
Code 128/EAN 128 .................................................................................................................... 7-12
BC412 ........................................................................................................................................ 7-15
Interleaved 2 of 5........................................................................................................................ 7-16
Code 93...................................................................................................................................... 7-19
Codabar...................................................................................................................................... 7-20
UPC/EAN ................................................................................................................................... 7-23
Pharmacode ............................................................................................................................... 7-27
Postal Symbologies.................................................................................................................... 7-29
GS1 DataBar .............................................................................................................................. 7-34
PDF417 ...................................................................................................................................... 7-36
MicroPDF417 ............................................................................................................................. 7-37
Composite .................................................................................................................................. 7-38
DotCode ..................................................................................................................................... 7-39
This section describes the various symbologies that can be decoded by the MicroHAWK Engine.
MicroHAWK Engine Integration Guide
7-1
Symbologies by ESP
Symbologies by ESP
Click the Parameters
button and then the
Symbologies tab.
To change a setting,
double-click the
setting and use your
cursor to scroll
through the options.
To open nested options, single-click the +.
7-2
MicroHAWK Engine Integration Guide
Symbologies
Symbologies Serial Commands
Composite
Aztec
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
DataBar Limited
DataBar Expanded
MicroPDF417
DotCode
<K453,symbology status,separator status,separator character>
<K458,status>
<K459,status>
<K460,postal symbology type,POSTNET status,PLANET
status,USPS4CB status>
<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,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>
<K497,status,rotation mode>
MicroHAWK Engine Integration Guide
7-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:
7-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
MicroHAWK Engine Integration Guide
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
MicroHAWK Engine Integration Guide
7-5
Aztec
Aztec
Usage:
Definition:
Serial Cmd:
Default:
Options:
7-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 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 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
MicroHAWK Engine Integration Guide
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
MicroHAWK Engine Integration Guide
7-7
Micro QR Code
Micro QR Code
Usage:
Definition:
Serial Cmd:
Default:
Options:
7-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
MicroHAWK Engine Integration Guide
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
MicroHAWK Engine Integration Guide
7-9
Code 39
Large Intercharacter Gap (Code 39)
Usage:
Large Intercharacter Gap is helpful for reading symbols that are printed
out of specification.
Definition:
When enabled, the reader 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
Serial Cmd:
Default:
Options:
Fixed Symbol Length Status (Code 39)
Definition:
Serial Cmd:
Default:
Options:
When enabled, the reader 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:
7-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 reader will recognize (this
does not include start and stop and check character characters). The
reader 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
MicroHAWK Engine Integration Guide
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 reader 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
MicroHAWK Engine Integration Guide
7-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 reader 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:
7-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 reader will recognize
(this does not include start, stop, and check character characters). The
reader 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
MicroHAWK Engine Integration Guide
Symbologies
EAN 128 Status (Code 128/EAN 128)
Definition:
Serial Cmd:
Default:
Options:
When this field is disabled, the reader will not check any Code 128 labels
for conformance to EAN requirements, or perform any special formatting.
When enabled, the reader 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 reader 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 reader will not apply special EAN output formatting
options.
In Application, the reader 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
MicroHAWK Engine Integration Guide
7-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)
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:
7-14
This feature causes the reader 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
MicroHAWK Engine Integration Guide
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 reader 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
MicroHAWK Engine Integration Guide
7-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:
7-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
MicroHAWK Engine Integration Guide
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.
MicroHAWK Engine Integration Guide
7-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:
7-18
Useful in applications where I 2/5 symbols of a specific length are required.
When Range Mode is disabled, the reader 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
MicroHAWK Engine Integration Guide
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 reader will accept any Code 93 symbol provided is
doesn’t exceed the system’s maximum capabilities.
When enabled, the reader 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
MicroHAWK Engine Integration Guide
7-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 reader will decode Codabar symbols whether or not the
start and stop characters are the same.
When enabled, the reader 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:
7-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
MicroHAWK Engine Integration Guide
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 reader will accept any Codabar symbol provided it
doesn’t exceed the system’s maximum capabilities.
When enabled, the reader 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
MicroHAWK Engine Integration Guide
7-21
Codabar
Check Character Type (Codabar)
Definition:
Serial Cmd:
Default:
Options:
When disabled, the reader will not perform any character checking calculations
on decoded Codabar symbols.
When set to Mod 16, the reader 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 reader 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 reader 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:
7-22
When this field is disabled and a check character calculation is enabled,
the reader 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 reader 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
MicroHAWK Engine Integration Guide
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 reader 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 reader 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
MicroHAWK Engine Integration Guide
7-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 reader 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 reader 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:
7-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
MicroHAWK Engine Integration Guide
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.
MicroHAWK Engine Integration Guide
7-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:
7-26
When disabled, the reader will output the version E symbols in their
encoded 6-character format.
When enabled, the reader 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
MicroHAWK Engine Integration Guide
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 reader 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 reader 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
MicroHAWK Engine Integration Guide
7-27
Pharmacode
Bar Width Status (Pharmacode)
Definition:
Serial Cmd:
Default:
Options:
If set to Mixed, the reader 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 reader 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:
7-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
MicroHAWK Engine Integration Guide
Symbologies
Postal Symbologies
Important: Postal Symbologies must have a minimum pixels-per-element value of 4 to
be decoded reliably by the MicroHAWK Engine.
The reader must be configured to specific read range, field of view, and camera parameters
before decoding Postal Symbologies.
For optimal decode results, position the symbol as close to the center of the reader’s field
of view as possible.
Position the
postal symbol in
the center of the
reader’s field of
view.
MicroHAWK Engine Integration Guide
7-29
Postal Symbologies
Postal Symbology Type
Usage:
Definition:
Serial Cmd:
Default:
Options:
7-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 reader.
<K460,postal symbology type,POSTNET status,PLANET status,USPS4CB
status>
Disabled
0 = Disabled
1 = U.S. Post (POSTNET, PLANET, USPS4CB)
2 = Australia Post
3 = Japan Post
4 = Royal Mail
5 = KIX
6 = UPU
MicroHAWK Engine Integration Guide
Symbologies
U.S. Post (POSTNET, PLANET, USPS4CB)
When U.S. Post is enabled (<K460,1>), the reader 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 reader 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 reader.
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 reader will only decode Australia Post
symbols.
Japan Post
When Japan Post is enabled (<K460,3>), the reader will only decode Japan Post symbols.
Royal Mail
When Royal Mail is enabled (<K460,4>), the reader will only decode Royal Mail symbols.
KIX
When KIX is enabled (<K460,5>), the reader will only decode KIX symbols.
UPU
When UPU is enabled, the reader will decode UPU symbols.
For example, if Postal Symbology Type is set to UPU and POSTNET Status is enabled
and (<K460,6,1>), the reader will attempt to decode both UPU and POSTNET symbols.
MicroHAWK Engine Integration Guide
7-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 reader will
decode POSTNET symbols.
<K460,postal symbology type,POSTNET status,PLANET status,
USPS4CB status>
Enabled
0 = Disabled
1 = Enabled
PLANET Status
Usage:
Definition:
Serial Cmd:
Default:
Options:
7-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 reader will decode
PLANET symbols.
<K460,postal symbology type,POSTNET status,PLANET status,
USPS4CB status>
Enabled
0 = Disabled
1 = Enabled
MicroHAWK Engine Integration Guide
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 reader will
decode USPS4CB symbols.
<K460,postal symbology type,POSTNET status,PLANET status,USPS4CB
status>
Enabled
0 = Disabled
1 = Enabled
MicroHAWK Engine Integration Guide
7-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 reader 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:
7-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 reader will recognize
(this does not include start, stop, and check character characters). The
reader ignores any symbol not having the specified length.
<K484,status,fixed symbol length status,fixed symbol length>
14
1 to 74
MicroHAWK Engine Integration Guide
Symbologies
DataBar 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
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
MicroHAWK Engine Integration Guide
7-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
reader 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.
7-36
MicroHAWK Engine Integration Guide
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 reader 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.
MicroHAWK Engine Integration Guide
7-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 reader 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 reader 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:
Serial Cmd:
Default:
Options:
7-38
As required by the application.
Allows the user to change the separator character from a comma to a new
character.
<K453,mode,separator status,separator>
, (comma)
Any ASCII character.
MicroHAWK Engine Integration Guide
Symbologies
DotCode
Important: When DotCode is enabled, no other symbologies will be decodable. You must
disable DotCode to decode symbols of any other type.
DotCode Status
Serial Cmd:
Default:
Options:
<K497,status,rotation mode>
0 = Disabled
0 = Disabled
1 = Enabled
Disabled
The reader will not attempt to decode DotCode symbols.
Enabled
The reader will attempt to decode DotCode symbols.
Rotation Mode
Serial Cmd:
Default:
Options:
<K497,status,rotation mode>
0 = No Rotation
0 = No Rotation
1 = Low Rotation
2 = Omnidirectional
No Rotation
The reader will decode horizontal and vertical symbols (+/– approximately 3 degrees).
Low Rotation
The reader will decode +/– approximately 10 degrees from the horizontal or vertical
symbols. It is slightly slower than the No Rotation option.
OmniDirectional
The reader will support 360 degree reading. Omnidirectional is significantly slower than
the other two options.
MicroHAWK Engine Integration Guide
7-39
DotCode
7-40
MicroHAWK Engine Integration Guide
8 I/O Parameters
Contents
I/O Parameters by ESP ................................................................................................................ 8-2
I/O Parameters Serial Commands ............................................................................................... 8-3
Symbol Data Output ..................................................................................................................... 8-4
No-Read Message ....................................................................................................................... 8-8
Read Duration Output .................................................................................................................. 8-9
Output Indicators ........................................................................................................................ 8-10
LED Configuration ...................................................................................................................... 8-14
Serial Verification ....................................................................................................................... 8-15
Setup Button............................................................................................................................... 8-16
Setup Button Modes................................................................................................................... 8-18
Configurable Output 1 ................................................................................................................ 8-20
Trend Analysis Output 1............................................................................................................. 8-23
ISO/IEC 16022 Symbol Quality Output 1 ................................................................................... 8-26
Diagnostic Output 1.................................................................................................................... 8-29
Configurable Output 2 ................................................................................................................ 8-30
Trend Analysis Output 2............................................................................................................. 8-30
ISO/IEC 16022 Symbol Quality Output 2 ................................................................................... 8-30
Diagnostic Output 2.................................................................................................................... 8-30
Configurable Output 3 ................................................................................................................ 8-31
Trend Analysis Output 3............................................................................................................. 8-31
ISO/IEC 16022 Symbol Quality Output 3 ................................................................................... 8-31
Diagnostic Output 3.................................................................................................................... 8-31
Power-On/Reset Counts ............................................................................................................ 8-32
Time Since Reset ....................................................................................................................... 8-33
Service Message........................................................................................................................ 8-34
User-Assigned Name ................................................................................................................. 8-35
Frame Information ...................................................................................................................... 8-36
Image Output.............................................................................................................................. 8-37
Database Identifier Output ......................................................................................................... 8-40
Quality Output ............................................................................................................................ 8-41
EZ Trax Output........................................................................................................................... 8-42
Image Push to Host.................................................................................................................... 8-45
Image Push to Host Detailed Setup ........................................................................................... 8-47
This section includes instructions on setting up conditions for changing input/output electrical
transitions for control of the reader’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.
MicroHAWK Engine Integration Guide
8-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 +
and it will become a – as shown above.
8-2
MicroHAWK Engine Integration Guide
I/O Parameters
I/O Parameters Serial Commands
Power On/Reset Counts
Time Since Reset (Read-Only)
Service Message
User-Defined Name
Serial Verification
Quality Output Separator
Symbol Data Output
Read Duration Output
No-Read Message
Object Output Information
LED Configuration
Green Flash and Target LEDs
EZ Trax Output
Database Identifier Output
Image Push to Host
Image Push to Host Detail Setup
Setup Button
Setup Button Modes
Trend Analysis Output 1
Trend Analysis Output 2
Trend Analysis Output 3
Diagnostic Output 1
Diagnostic Output 2
Diagnostic Output 3
ISO/IEC 16022 Symbol Quality Output 1
ISO/IEC 16022 Symbol Quality Output 2
ISO/IEC 16022 Symbol Quality Output 3
Output 1 Parameters
Output 2 Parameters
Output 3 Parameters
MicroHAWK Engine Integration Guide
<K406,power-on,resets,power-on saves,customer default saves>
<K407,hours,minutes>
<K409,status,service message,threshold,resolution>
<K412,user-defined name>
<K701,serial command echo status,control/hex output>
<K704,quality output separator,decodes per trigger status>
<K705,status,when to output,symbology identifier status>
<K706,status,separator>
<K714,status,message>
<K734,output frame number status,output coordinates status>
<K737,ISO/IEC 16022 grade>
<K750,green flash LED status,target pattern LED status,green
flash duration>
<K757,EZ Trax Enable,Transfer Port,EZ Trax Image Mode,Image
Format,Image Quality,Object Info Enable,Grade Enable>
<K759,status,separator character>
<K763,Image Storage Status,Stored Image Type,Image Storage,
Image File Format,Image Quality,Image Scale,File Save Options>
<K763,Image Storage Location,FTP Host Info,Transfer Optimization,
RAM Drive Size in MB,Save Image Until,Action at Image Storage Limit>
<K770,global status,default on power-on,load configuration database,
save for power-on>
<K771,button option 1,button option 2,button option 3,button option 4>
<K780,trend analysis mode,number of triggers,number to output
on,decodes per trigger>
<K781,trend analysis mode,number of triggers,number to output
on,decodes per trigger>
<K782,trend analysis mode,number of triggers,number to output
on,decodes per trigger>
<K790,service unit message status>
<K791,service unit message status>
<K792,service unit message status>
<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 Unused ECC,Unused ECC
threshold>
<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 Unused ECC,Unused ECC
threshold>
<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 Unused ECC,Unused ECC
threshold>
<K810,output on,output state,pulse width,output mode>
<K811,output on,output state,pulse width,output mode>
<K812,output on,output state,pulse width,output mode>
8-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,symbology identifier status>
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 reader 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 reader 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 reader 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 reader transmits symbol data whenever the
symbol data information does NOT match the master symbol.
Note: A No-Read can still be transmitted if Enabled.
8-4
MicroHAWK Engine Integration Guide
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 reader transmits symbol data on any good
read regardless of Matchcode Type setting.
Note: A No-Read can still be transmitted if Enabled.
MicroHAWK Engine Integration Guide
8-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,symbology identifier status>
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
8-6
This is when host
expects output
MicroHAWK Engine Integration Guide
I/O Parameters
Symbology Identifier Status
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,symbology identifier status>
Disabled
0 = Disabled
1 = Enabled
Disabled
When set to Disabled, the symbol data output does not contain symbology information.
Enabled
When set to Enabled, the symbol data output contains a three-character symbology
identifier sequence.
MicroHAWK Engine Integration Guide
8-7
No-Read Message
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 reader 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.
8-8
MicroHAWK Engine Integration Guide
I/O Parameters
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.
MicroHAWK Engine Integration Guide
8-9
Output Indicators
Output Indicators
The MicroHAWK Engine has 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 reader.
2. An array of green LEDs projected from the front of the reader that can be programmed
to flash in response to user-defined conditions.
3. A row of five status LEDs on the side of the reader.
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 reader 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.
8-10
MicroHAWK Engine Integration Guide
I/O Parameters
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
reader 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 reader 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.
MicroHAWK Engine Integration Guide
8-11
Output Indicators
Target Pattern
Usage:
Definition:
Serial Cmd:
Default:
Options:
Assists users in positioning and locating symbols in the center of the
reader’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 an operational command.
ON Only When Not in the Read Cycle
The target pattern is always ON except during the read cycle. If the 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 operational command
overrides this setting, the target pattern will remain on at all times.
Always ON
The target pattern is always ON.
8-12
MicroHAWK Engine Integration Guide
I/O Parameters
Green Flash Duration
Usage:
Definition:
Serial Cmd:
Default:
Options:
Provides visual verification that a good read has occurred.
When a good read occurs, the green LEDs will illuminate and stay on for
the time set in the Green Flash Duration value.
<K750,green flash mode,target pattern status,green flash duration>
100 (1 second)
0 to 65535 (in 10 ms increments)
MicroHAWK Engine Integration Guide
8-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:
8-14
Provides visual grading of specific ISO/IEC 16022 parameters.
Determines which ISO/IEC 16022 parameter the reader 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
MicroHAWK Engine Integration Guide
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 reader’s interpretation
of any configuration command.
For example, if the current preamble is “SOM” and <K701,1,START> is
entered, the reader 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
Reader
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,control/hex output>
Disabled
0 = Disabled
1 = Enabled
Control/Hex Output
Usage:
Definition:
Serial Cmd:
Default:
Options:
Useful for viewing settings with binary characters when using serial commands
on a terminal.
Determines the response to a Serial Command Echo or status request
command.
When set to Control, two characters are transmitted to represent a non-displayable
character. For example, a carriage return will be shown as: ^M.
<K701,serial command echo status,control/hex output>
Control
0 = Control
1 = Hex
MicroHAWK Engine Integration Guide
8-15
Setup Button
Setup Button
The Setup button has four positions, selectable by the length of time the button is held
down. Each position can be programmed for any of eight options.
Definition:
Serial Cmd:
Default:
Options:
Serves as a master switch to enable/disable the Setup 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 Setup button does not function.
Enabled
When selected, the Setup button is enabled and the function of each button position is
selected by the Setup Button Mode command.
Trigger
When selected, the Setup 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 Setup 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
Setup 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 Setup 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.
8-16
MicroHAWK Engine Integration Guide
I/O Parameters
Default on Power-On
Definition:
Serial Cmd:
Default:
Options:
When enabled, if the Setup 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 Setup 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:
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
MicroHAWK Engine Integration Guide
8-17
Setup Button Modes
Setup Button Modes
Usage:
Definition:
Serial Cmd:
Options:
Useful for performing multiple, repetitive tasks at the work site.
The global status field for the Setup button must enabled for button processing
to start. Once you press the button the reader will sequence through each
button position. If you release the button after the button position but before
the next button option starts, the reader will execute the action programmed
for that button position. The status LEDs and the green flash will also illuminate
to signal the current position. All button positions have the same configurable
options. Also note that a quick press and release of the button before any
button position is the same as if a position selected was configured as disabled.
<K771,button option 1,button option 2,button option 3,button option 4>
Button Option 1
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.
Button Option 2
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.
Button Option 3
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.
Button Option 4
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 Setup button.
Calibrate
Calibration will be initiated when the associated button position is selected. To abort calibration,
quickly press and release the Setup 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.
8-18
MicroHAWK Engine Integration Guide
I/O Parameters
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.
Target System
Turns on the target pattern whenever the associated button position is selected. To disable,
quickly press and release the Setup button.
Note: This mode is the only one that does not require that the button be released before
taking 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 Setup button.
Setup Button Operation
To execute Setup button commands:
Position 1
Hold down button until the 20% LED illuminates.
Position 2
Hold down button until the 20% and 40% LEDs illuminate.
Position 3
Hold down button until the 20%, 40%, and 60% LEDs illuminate.
Position 4
Hold down button until the 20%, 40%, 60%, and 80% LEDs illuminate.
MicroHAWK Engine Integration Guide
8-19
Configurable Output 1
Configurable Output 1
Usage:
Definition:
Serial Cmd:
Default:
Options:
This option provides discrete signalling to host software to control external
devices such as PLCs and relays. It is useful for routing, sorting, and to
prevent mis-packaging and mis-routing.
Sets the discrete output functions for specific user-selected conditions.
Allows the user to set the conditions under which an output (or outputs) will
be activated.
<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 any mode containing Match or Mismatch, the transition
(switching) will only occur if Matchcode Type is enabled and Master Symbol(s) are
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.
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.
8-20
MicroHAWK Engine Integration Guide
I/O Parameters
Trend Analysis
Usage:
Definition:
Typically used when successful decodes are occurring but a discrete output
is needed to flag a trend in quality issues.
Activates discrete output when a trend analysis condition is met, depending
on the trend analysis option enabled.
Symbol Quality
Usage:
Definition:
Typically used when a discrete indication is needed to flag a symbol quality
condition.
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:
Activates a discrete output when the reader is in a read cycle.
MicroHAWK Engine Integration Guide
8-21
Configurable Output 1
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.
8-22
MicroHAWK Engine Integration Guide
I/O Parameters
Trend Analysis Output 1
Note: Output On under Output 1 Parameters must be set to Trend Analysis for this
output to function.
Under Output 1 Parameters, expand the Trend Analysis tree:
Usage:
Definition:
Example:
Useful in cases where the user doesn’t want to shut down for one condition
but wants to monitor quality and read conditions.
Applies Trend Analysis settings to Output 1.
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 reader will activate an output when 4 No-Reads occur
within a period of 25 triggers (read cycles).
MicroHAWK Engine Integration Guide
8-23
Configurable Output 1
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.
8-24
MicroHAWK Engine Integration Guide
I/O Parameters
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:
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 reader must be in Decodes per Trigger
mode. To put the reader 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
MicroHAWK Engine Integration Guide
8-25
ISO/IEC 16022 Symbol Quality Output 1
ISO/IEC 16022 Symbol Quality Output 1
Note: Output On under Output 1 Parameters must be set to Symbol Quality for this
output to function.
Under Output 1 Parameters, expand the Symbol Quality (ISO/IEC 16022) tree.
Output on Symbol Contrast
Usage:
Definition:
Serial Cmd:
Default:
Options:
Lets the user know if symbol quality is less than acceptable.
If enabled, toggles Output 1 to an active state when Symbol Contrast
Threshold is met.
<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:
8-26
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
MicroHAWK Engine Integration Guide
I/O Parameters
Output on Axial Non-Uniformity
Usage:
Definition:
Serial Cmd:
Default:
Options:
Lets the user know if symbol quality is less than acceptable.
If enabled, toggles Output 1 to an active state when Axial Non-Uniformity
Threshold is met.
<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:
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
MicroHAWK Engine Integration Guide
8-27
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:
8-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
MicroHAWK Engine Integration Guide
I/O Parameters
Diagnostics Output 1
Note: Output On under Output 1 Parameters must be set to Diagnostic Warning for
this output to function.
Under Output 1 Parameters, expand the Diagnostics tree.
Serial Cmd:
Default:
Options:
<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:
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 reader is in a Continuous Read
mode.
<K790,unused 1,service unit>
0
0 = Disabled
1 = Enabled
MicroHAWK Engine Integration Guide
8-29
Configurable Output 2
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:
8-30
<K791,unused 1,service unit>
MicroHAWK Engine Integration Guide
I/O Parameters
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:
<K792,unused 1,service unit>
MicroHAWK Engine Integration Guide
8-31
Power On/Reset Counts
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 reader 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 reader 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 reader 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 reader setting is
saved to the customer parameter section of flash memory with a <Zc> command.
8-32
MicroHAWK Engine Integration Guide
I/O Parameters
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.
MicroHAWK Engine Integration Guide
8-33
Service Message
Service Message
When Service Message is enabled, a message of up to 10 ASCII characters is sent
whenever the system detects that the service timer’s limit has been reached. The service
timer is reset at power-on, meaning that the service timer’s limit is the amount of time
since last reset. Service timer increments can be set in seconds or minutes.
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.
Threshold
Serial Cmd:
Default:
Options:
<K409,status,service message,threshold,resolution>
300 (5 minutes)
1 to 65535
Resolution
Serial Cmd:
Default:
Options:
8-34
<K409,status,service message,threshold,resolution>
Seconds
0 = Seconds
1 = Minutes
MicroHAWK Engine Integration Guide
I/O Parameters
User-Assigned Name
Definition:
Serial Cmd:
Default:
Options:
User-Assigned Name allows you to enter any string of ASCII characters to
help you identify your reader. The user-assigned name is saved at power-on
and custom defaults, and is stored as a “sticky” parameter so it cannot be
defaulted without a <Zrdall> or <K412d> command.
<K412,user-assigned name>
MicroHAWK
ASCII string, up to 19 characters
MicroHAWK Engine Integration Guide
8-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)
8-36
MicroHAWK Engine Integration Guide
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.
MicroHAWK Engine Integration Guide
8-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:
8-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)
MicroHAWK Engine Integration Guide
I/O Parameters
Image Output Example
The following example assumes that the reader 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
MicroHAWK Engine Integration Guide
8-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 reader 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:
8-40
The separator character separates the symbol data from the database identifier.
<K759,status,separator>
<space>
Any ASCII character.
MicroHAWK Engine Integration Guide
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.
Decodes per Trigger Status
Definition:
Serial Cmd:
Default:
Options:
When this feature is enabled, the reader 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 reader outputs any
decoded symbol data along with the decodes per trigger count.
<K704,separator,decodes per trigger status>
0
0 = Disabled
1 = Enabled
MicroHAWK Engine Integration Guide
8-41
EZ Trax Output
EZ Trax Output
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,transfer port,image mode,image format,image quality,object
info enable,grade enable>
Disabled
0 = Disabled
1 = Enabled
Transfer Port
Definition:
Serial Cmd:
Default:
Options:
Selects the communication port that will be used to transfer image files.
<K757,status,transfer port,image mode,image format,JPEG quality,object
info enable,grade enable>
RS-232
0 = RS-232
3 = Ethernet TCP Port 1
4 = Ethernet 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,transfer port,image mode,image format,image quality,object
info enable,grade enable>
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.
8-42
MicroHAWK Engine Integration Guide
I/O Parameters
No Read
Outputs the first No Read image in the read cycle. The image file will immediately follow
the symbol data.
Note: If two symbols are present in the same image capture and one of them is successfully
decoded, no image will be output.
No Read and Good Read
Outputs the first No Read or Good Read image in the read cycle.
Mismatch
Outputs the image of the first mismatch condition.
Image Format
Definition:
Serial Cmd:
Default:
Options:
Selects the format of the image output file.
<K757,status,transfer port,image mode,image format,image quality,object
info enable,grade enable>
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.
Image Quality
Definition:
Serial Cmd:
Default:
Options:
Sets the amount of 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,transfer port,image mode,image format,image quality,object
info enable,grade enable>
90
1 to 100 (percent)
MicroHAWK Engine Integration Guide
8-43
EZ Trax Output
Object Info Enable
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,status,transfer port,image mode,image format,image quality,object info
enable,grade enable>
Disabled
0 = Disabled
1 = Enabled
Grade Enable
Definition:
Serial Cmd:
Default:
Options:
8-44
Symbol quality information will be output in the form of an abbreviated
identifier for each read cycle.
<K757,status,transfer port,image mode,image format,image quality,object info
enable,grade enable>
Disabled
0 = Disabled
1 = Enabled
MicroHAWK Engine Integration Guide
I/O Parameters
Image Push to Host
Definition:
Serial Cmd:
Default:
Options:
Image Storage Status determines whether or not Image Logging is active.
Note: Only images that have been processed by the decoder will be saved.
If Image Storage Status and RAM Drive Size in MB in <K764> are
switched from Disable to Enable, a cold boot of the reader will be required
in order to create the required RAM Drive, and it will take additional time for
the reader to re-initialize. Switching from Enable to Disable does not require
a cold boot.
<K763,image storage status,stored image type,image storage,image file
format,image quality,image scale,file save options>
Disabled
0 = Disabled
1 = Enabled
Stored Image Type
Definition:
Serial Cmd:
Default:
Options:
Stored Image Type defines what kind of image you want to log in a read cycle.
<K763,image storage status,stored image type,image storage,image file
format,image quality,image scale,file save options>
No Read
1 = Good Read
2 = No Read
3 = Good Read + No Read
4 = Match
8 = Mismatch
12 = Match + Mismatch
15 = Good Read + No Read + Match + Mismatch
Image Storage
Definition:
Serial Cmd:
Default:
Options:
Image Storage defines which image will be stored within a read cycle.
• Good Read/Match/Mismatch: First qualified image or all qualified images.
• No Read: First image or all images that have an IP report.
<K763,image storage status,stored image type,image storage,image file
format,image quality,image scale,file save options>
First Image in a Read Cycle
0 = First Image in a Read Cycle
1 = All Images in a Read Cycle
MicroHAWK Engine Integration Guide
8-45
Image Push to Host
Image File Format
Definition:
Serial Cmd:
Default:
Options:
Image File Format defines the image format you want to use.
<K763,image storage status,stored image type,image storage,image file
format,image quality,image scale,file save options>
PNG
0 = PNG
1 = JPG
Image Quality
Definition:
Serial Cmd:
Default:
Options:
Image Quality defines the amount of image compression you want the image
to have.
<K763,image storage status,stored image type,image storage,image file
format,image quality,image scale,file save options>
90
1 to 100
Image Scale
Definition:
Serial Cmd:
Default:
Options:
Image Scale defines the size you want the image to be.
<K763,image storage status,stored image type,image storage,image file
format,image quality,image scale,file save options>
Full
0 = Full
1 = 1/4th
2 = 1/8th
File Save Options
Definition:
Serial Cmd:
Default:
Options:
8-46
File Save Options determines which files you want to save.
<K763,image storage status,stored image type,image storage,image file
format,image quality,image scale,file save options>
Image
1 = Image
2 = Read Cycle Report
3 = Image + Read Cycle Report
MicroHAWK Engine Integration Guide
I/O Parameters
Image Push to Host Detailed Setup
Image Storage Location
Definition:
Defines where the saved image is going to be stored.
Note: When saving images to RAM, the system is limited to the actual RAM
space available in the system. The number of images that can be saved
depends on the Max RAM Drive Size. The actual system path is /imagesd0/
Images/. When saving images to FTP, the path is <last 6 digits of device’s
MAC Address>_Images/ on the host FTP director. Note that the FTP server
needs to grant the user with create directory rights as the system will need to
create a directory on the FTP server to store all uploaded images.
File save scheme: The image file will be posted with its system reset
count, followed by its read cycle i.d., followed by its image i.d., followed by
its stored image type defined in <K763>, as follows:
<last 6 digits of device’s MAC Address>_<system total reset count>_<read
cycle id>_<image id>_<save image type>.{png, jpg}
Serial Cmd:
Default:
Options:
<last 6 digits of device’s MAC Address>_<system total reset count>_<read
cycle id>_<image id>_readreport.xml
<K764,image storage location,FTP host info,transfer optimization,RAM
drive size in MB,save image until,action at image storage limit>
RAM
0 = RAM
1 = FTP
FTP Host Info
Definition:
Serial Cmd:
Default:
Options:
mscan|[email protected]:21 signifies a the user with mscan at
192.168.188.1 FTP server on port 21 with pass as the FTP login password.
Note: If port is not defined with the FTP server address, it will default to port 21.
<K764,image storage location,FTP host info,transfer optimization,RAM
drive size in MB,save image until,action at image storage limit>
“user|[email protected]:21”
Maximum 255 characters including the characters “|”, “@”, and “:”.
MicroHAWK Engine Integration Guide
8-47
Image Push to Host Detailed Setup
Transfer Optimization
Definition:
Serial Cmd:
Default:
Options:
Transfer Optimization defines how the image is going to be stored in triggered
captured modes.
<K764,image storage location,FTP host info,transfer optimization,RAM
drive size in MB,save image until,action at image storage limit>
Speed
0 = Speed (Lossy)
1 = Accuracy (Lossless)
Speed (Lossy)
Images will be saved when possible. Some images may be dropped.
SOR = Start of Read Cycle
EOR = End of Read Cycle
Accuracy (Lossless)
Every image in read cycle is transferred. The read cycle may be delayed due to image
saving since each transfer will need to be finished before the end of the read cycle.
SOR = Start of Read Cycle
EOR = End of Read Cycle
8-48
MicroHAWK Engine Integration Guide
I/O Parameters
RAM Drive Size in MB
Definition:
Serial Cmd:
Default:
Options:
This defines the maximum RAM Drive size on the system. It is also limited to
the memory available on the system and affects the max. rapid image count in
<K241> since the onboard memory may be taken up by the RAM Drive.
Images may not be saved if the RAM Drive is not large enough to store all the
images in the current read cycle and if Image Storage Location is set to FTP
with Image Save Mode set to Speed. If Image Storage Location is set to FTP
with Image Save Mode set to Accuracy, all images in the read cycle will be
transferred to the FTP host but the read cycle may be delayed.
<K764,image storage location,FTP host info,transfer optimization,RAM
drive size in MB,save image until,action at image storage limit>
20
1 to 50
Save Image Until
Definition:
This defines how long the image will be stored in the system when the Image
Storage Location is RAM.
If set to New Read Cycle, the saved image will be erased upon entering the
next read cycle.
Serial Cmd:
Default:
Options:
If set to System Reset, the saved image will be erased upon the next system
reset.
<K764,image storage location,FTP host info,transfer optimization,RAM
drive size in MB,save image until,action at image storage limit>
New Read Cycle
0 = New Read Cycle
1 = System Reset
Action at Image Storage Limit
Definition:
Serial Cmd:
Default:
Options:
This defines what to do when Action at Storage Full is reached and when
images are saved on RAM. When this setting is set to Erase Oldest First, the
oldest images in the current read cycle will be erased.
<K764,image storage location,FTP host info,transfer optimization,RAM
drive size in MB,save image until,action at image storage limit>
Stop
0 = Stop
1 = Erase Oldest First
MicroHAWK Engine Integration Guide
8-49
Image Push to Host Detailed Setup
8-50
MicroHAWK Engine Integration Guide
9 Symbol Quality
Contents
Symbol Quality by ESP................................................................................................................. 9-2
Symbol Quality Serial Commands ................................................................................................ 9-3
Overview of Symbol Quality.......................................................................................................... 9-4
Symbol Quality Separator/Data Matrix Output Mode.................................................................... 9-8
ISO/IEC 16022 Symbol Quality Output....................................................................................... 9-10
ISO/IEC 16022 Symbol Quality Output by ESP.......................................................................... 9-12
Microscan Symbol Quality Output .............................................................................................. 9-13
Microscan Symbol Quality Output by ESP ................................................................................. 9-16
This section describes parameters that, when enabled, will output detailed symbol quality
evaluations.
MicroHAWK Engine Integration Guide
9-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 +.
9-2
To change a setting, double-click
the setting and use your cursor to
scroll through the options.
MicroHAWK Engine Integration Guide
Symbol Quality
Symbol Quality Serial Commands
Symbol Quality Separator /
<K708,symbol quality separator,Data Matrix output mode>
Output Mode
ISO/IEC 16022 Symbol Quality <K709,symbol contrast,print growth,axial non-uniformity,
Output
unused ECC>
<K710,percent cell damage,total read time,capture
Microscan Symbol Quality Output time,locate time,decode time,pixels per element,ECC
level,matrix size,quiet zone,symbol angle>
MicroHAWK Engine Integration Guide
9-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)
9-4
MicroHAWK Engine Integration Guide
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 reader’s field of view is shown here.
When grading is completed, the initial
report is also shown in this viewing area.
MicroHAWK Engine Integration Guide
9-5
Overview of Symbol Quality
Locate Tab
The Locate tab allows the user to determine the position of the symbol within the reader’s
field of view, and to optimize the reader’s camera settings for symbol quality evaluation.
Click the Locate
button to display the
symbol in the
reader’s field of view.
9-6
Click the Calibrate
button to optimize
camera settings.
MicroHAWK Engine Integration Guide
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.
MicroHAWK Engine Integration Guide
9-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.
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.
9-8
MicroHAWK Engine Integration Guide
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.
MicroHAWK Engine Integration Guide
9-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:
9-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
MicroHAWK Engine Integration Guide
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
MicroHAWK Engine Integration Guide
9-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.
9-12
MicroHAWK Engine Integration Guide
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
MicroHAWK Engine Integration Guide
9-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:
9-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
MicroHAWK Engine Integration Guide
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 reader.
<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
MicroHAWK Engine Integration Guide
9-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.
9-16
MicroHAWK Engine Integration Guide
10 Matchcode
Contents
Matchcode by ESP ..................................................................................................................... 10-2
Matchcode Serial Commands .................................................................................................... 10-3
Overview of Matchcode .............................................................................................................. 10-4
Matchcode Type ......................................................................................................................... 10-5
Sequence Step Interval ............................................................................................................ 10-10
Match Replace.......................................................................................................................... 10-11
Mismatch Replace .................................................................................................................... 10-12
New Master Pin ........................................................................................................................ 10-13
This section explains the MicroHAWK Engine’s matchcode output functions and the
master symbol database setup.
MicroHAWK Engine Integration Guide
10-1
Matchcode by ESP
Matchcode by ESP
Click the Parameters
button and then the
Matchcode tab.
To open nested options,
single-click the +.
10-2
To change a setting,
double-click the
setting and use your
cursor to scroll
through the options.
MicroHAWK Engine Integration Guide
Matchcode
Matchcode Serial Commands
Matchcode
Number of Master Symbols
New Master Pin
Sequence Step Interval
Master Symbol Data
Match Replace
Mismatch Replace
MicroHAWK Engine Integration Guide
<K223,matchcode type,sequential matching,match start
position,match length,wildcard character, sequence on
No-Read,sequence on mismatch>
<K224,number of master symbols>
<K225,status>
<K228,sequence step interval>
<K231,index,master symbol data>
<K735,status,match replacement string>
<K736,status,mismatch replacement string>
10-3
Overview of Matchcode
Overview of Matchcode
Definition:
Usage:
Matchcode allows the user to store master symbol data in the reader’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 reader 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.
10-4
MicroHAWK Engine Integration Guide
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 reader 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 reader 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 reader will behave
as if Number of Symbols were set to 1, regardless of the user-defined
configuration.
MicroHAWK Engine Integration Guide
10-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 reader 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:
10-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
MicroHAWK Engine Integration Guide
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.
MicroHAWK Engine Integration Guide
10-7
Matchcode Type
Sequence on No-Read
Usage:
Definition:
Serial Cmd:
Default:
Options:
Sequence on No-Read is useful when the reader needs to stay in
sequence even if no decode occurs.
When Sequence on No-Read is Enabled and Matchcode is set to
Sequential, the reader 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
10-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
MicroHAWK Engine Integration Guide
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 reader 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
MicroHAWK Engine Integration Guide
Master Symbol after Decode
002
003
004 (sequenced because of previous match)
005
006 (sequenced because of previous match)
006 (not sequenced)
007
10-9
Sequence Step Interval
Sequence Step Interval
Usage:
Definition:
Serial Cmd:
Default:
Options:
Useful in applications in which it is desirable to count by intervals other
than 1.
Sequencing in Matchcode operations can occur in steps from 1 to
32,768.
Sequencing performs like a mechanical counter by displaying positive
integers and a specific number of digits after roll-overs. For example, 000
– 3 = 997 (not -3) and 999 + 3 = 002 (not 1002).
<K228,sequence step interval>
1
Any number from 1 to 32768
Example: If Sequence Step is set to 3 and Sequential Matching is set to Increment:
Master Symbol
003
003
003
006
006
006
10-10
Decoded Symbol
001
002
003
004
005
006
Master Symbol after Decode
003
003
006
006
006
009
MicroHAWK Engine Integration Guide
Matchcode
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.
MicroHAWK Engine Integration Guide
10-11
Mismatch Replace
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:
10-12
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.
MicroHAWK Engine Integration Guide
Matchcode
New Master Pin
Definition:
Serial Cmd:
Default:
Options:
If Matchcode and New Master Pin are enabled and the new master pin
is momentarily activated (must be active 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.
<K225,status>
Disabled
0 = Disabled
1 = Enabled
New Master Load Status
Definition:
Serial Cmd:
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>
MicroHAWK Engine Integration Guide
10-13
New Master Pin
10-14
MicroHAWK Engine Integration Guide
11 Camera and IP Setup
Contents
Camera and IP Setup by ESP .................................................................................................... 11-2
Camera and IP Setup Serial Commands.................................................................................... 11-3
Video........................................................................................................................................... 11-4
Evaluation ................................................................................................................................... 11-5
Calibration................................................................................................................................... 11-8
Window of Interest ...................................................................................................................... 11-9
Configuration Database ............................................................................................................ 11-13
Dynamic Setup ......................................................................................................................... 11-14
Pixel Binning ............................................................................................................................. 11-15
Camera Settings ....................................................................................................................... 11-16
White Balance Settings............................................................................................................. 11-17
Color Filter ................................................................................................................................ 11-18
Focal Distance .......................................................................................................................... 11-19
Illumination Brightness.............................................................................................................. 11-20
Morphological Pre-Processing.................................................................................................. 11-21
Morphological Operation and Operator Size ............................................................................ 11-22
Damaged Symbol ..................................................................................................................... 11-25
Linear Security Level ................................................................................................................ 11-26
Set License ............................................................................................................................... 11-27
This section provides adjustment parameters for the physical controls of the camera,
image acquisition, database settings, and image diagnostics.
MicroHAWK Engine Integration Guide
11-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 +.
11-2
MicroHAWK Engine Integration Guide
Camera and IP Setup
Camera and IP Setup Serial Commands
Window of Interest
Damaged Symbol
Illumination Brightness
Camera Settings
Pixel Binning
Color Filter
White Balance
Morphological Pre-Processing
Morphological Operation
Set License
Linear Security Level
MicroHAWK Engine Integration Guide
<K516,row pointer,column pointer,row depth,column width>
<K519,damaged symbol status>
<K536,brightness,light source>
<K541,exposure,gain>
<K542,pixel binning status>
<K543,color filter>
<K544,red gain,green gain,blue gain>
<K550,status>
<K551,morphological operation,operator size>
<K556,license file name,license key>
<K560,linear security level>
11-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.
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 reader’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.
Symbol data and
Test results are
shown in this field.
11-4
Initiates the Test routine.
Allows the user to test the
reader’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.
When enabled, shows the
symbol in higher contrast
than the default contrast
value.
MicroHAWK Engine Integration Guide
Camera and IP Setup
Evaluation
In Evaluation, you can view images
currently in the reader, 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 reader.
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.
MicroHAWK Engine Integration Guide
11-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 reader, 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.
11-6
MicroHAWK Engine Integration Guide
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.
MicroHAWK Engine Integration Guide
11-7
Calibration
Calibration
The Calibration interface in ESP is a powerful and intuitive way to optimize the reader’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 the Calibration section for full documentation of this feature.
ESP’s Calibration interface shown
during a calibration routine
11-8
ESP’s Calibration interface shown
after a calibration routine
MicroHAWK Engine Integration Guide
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 in rows and columns to define the
Window of Interest.
Important: Window of Interest will shrink the field of view and therefore could cause
some symbols to be missed in dynamic applications.
MicroHAWK Engine Integration Guide
11-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 reader 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.
11-10
MicroHAWK Engine Integration Guide
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.
WOI Row Pointer
WOI Column
Pointer
WOI Row Depth
WOI Column Width
Row Pointer
Definition:
Serial Cmd:
Default:
Options:
Defines the row position of the upper-left starting point of the image window.
<K516,row pointer,column pointer,row depth,column width>
QSXGA MicroHAWK: 0
SXGA MicroHAWK: 0
WVGA MicroHAWK: 0
QSXGA MicroHAWK: 0 to (1944 – row depth)
SXGA MicroHAWK: 0 to (1024 – row depth)
WVGA MicroHAWK: 0 to (480 – row depth)
Column Pointer
Definition:
Serial Cmd:
Default:
Options:
Defines the column position of the upper-left starting point of the image window.
<K516,row pointer,column pointer,row depth,column width>
QSXGA MicroHAWK: 0
SXGA MicroHAWK: 0
WVGA MicroHAWK: 0
QSXGA MicroHAWK: 0 to (2592 – column width)
SXGA MicroHAWK: 0 to (1280 – column width)
WVGA MicroHAWK: 0 to (752 – column width)
MicroHAWK Engine Integration Guide
11-11
Window of Interest
Row Depth
Definition:
Serial Cmd:
Default:
Options:
Defines the size, in rows, of the image window. Maximum value is
defined as the maximum row size of the image sensor minus the Row
Pointer value.
<K516,row pointer,column pointer,row depth,column width>
QSXGA MicroHAWK: 1944
SXGA MicroHAWK: 1024
WVGA MicroHAWK: 480
QSXGA MicroHAWK: 3 to (1944 – row pointer)
SXGA MicroHAWK: 3 to (1024 – row pointer)
WVGA MicroHAWK: 3 to (480 – row pointer)
Column Width
Definition:
Serial Cmd:
Default:
Options:
Defines the size, in columns, of the image window. Maximum value is defined as
the maximum column size of the image sensor minus the Column Pointer value.
<K516,row pointer,column pointer,row depth,column width>
QSXGA MicroHAWK: 2592
SXGA MicroHAWK: 1280
WVGA MicroHAWK: 752
QSXGA MicroHAWK: 8 to (2592 – column pointer)
SXGA MicroHAWK: 8 to (1280 – column pointer)
WVGA MicroHAWK: 8 to (752 – column pointer)
Important Notes
• The column width value must be a modulus 8 value. Regardless of the column width
setting that is configured, the actual column width will be decreased if necessary to a
modulus 8 value. For example, a column width value of 639 would actually be 632. A
user query for the value of this setting would still return 639.
• The column pointer must be an even value. Regardless of the column pointer setting
that is configured, the actual column pointer will be decreased if necessary to an even
value. For example, a column pointer value of 101 would actually be 100. A user query
for the value of this setting would still return 101.
11-12
MicroHAWK Engine Integration Guide
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 reader configurations to be
applied sequentially, and it allows the user to perform far more complex operations than
would be possible with only one set of configuration parameters.
See Configuration Database for full documentation of this feature.
Configuration Database view, 5 Active Indexes, Capture Settings highlighted
MicroHAWK Engine Integration Guide
11-13
Dynamic Setup
Dynamic Setup
Dynamic Setup is used to calculate image capture timing during a read cycle. Without
proper timing, the reader 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.
11-14
MicroHAWK Engine Integration Guide
Camera and IP Setup
Pixel Binning
Definition:
Usage:
Default:
Options:
In addition to windowing the image sensor, smaller resolutions can be
obtained by down sampling the entire captured image by using pixel
binning. Pixel binning can increase the signal to noise ratio and produce
a more pleasing output image with reduced artifacts. It will also improve
low-light performance. It is important to note that enabling pixel binning
does not affect the sensor frame rate as the pixels still need to be processed
in order to be averaged and binned.
<K542,pixel binning>
Disabled
0 = Disabled
1 = Enabled
Disabled
Pixel-binning is disabled.
Enabled
Two column pixels and two row pixels are averaged to create a single pixel value providing
a 2:1 reduction in the vertical pixels and a 2:1 reduction in the horizontal pixels for a combined
4:1 reduction. An image with a dimension of 640 x 480 will be scaled to 320 x 240.
MicroHAWK Engine Integration Guide
11-15
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.
QSXGA, SXGA, and WVGA
Exposure
Usage:
Definition:
Serial Cmd:
Default:
Options:
Faster exposures reduce blurring in faster applications.
Slower exposures are useful in slower applications and lower contrast
applications.
This value sets the exposure or integration time (in micro-seconds) for the
image sensor pixels. The exposure setting in relation to the speed of the
object is critical. If an object is moving rapidly and too long an exposure
value is selected, blurring or smearing of the object will occur. As exposure
time is decreased the movement of the object becomes less of a factor but,
with the duration of light collection by the pixels reduced, the image sensor
gain will need to be increased to compensate.
<K541,exposure,gain>
All versions: 2,500 μs
Any number between 50 – 100,000
Note: The Exposure parameter is read-only when the reader is in Continuous
Read Auto Trigger Mode.
Gain
Usage:
Definition:
Serial Cmd:
Default:
Options:
11-16
Can be used to adjust the brightness of the image.
Sets the gain value for the image sensor and is a percentage value from
0 (lowest gain) to 100% (highest gain). This setting can be configured
through auto-calibration. A higher gain value will increase the brightness
of the image, but the noise performance of the system will be reduced.
Before configuring the gain, the required exposure should be set, and the
gain should be configured to optimize the exposure setting.
<K541,exposure,gain>
QSXGA: 33%
SXGA: 0%
WVGA: 33%
Any number between 0 – 100
MicroHAWK Engine Integration Guide
Camera and IP Setup
White Balance Settings (QSXGA Color Only)
Definition:
Default:
Options:
<K544,red gain,green gain,blue gain>
Factory-Calibrated
Any number between 0 – 100
Red Gain
Sets the gain value for the red color channel of the image sensor and is a percentage
value from 0% (lowest gain) to 100% (highest gain). The color channel parameters are
used to avoid unrealistic colors so that objects that appear white to the human eye are
rendered white in the final image. The default value for this parameter is factory-calibrated.
Green Gain
Sets the gain value for the green color channel of the image sensor and is a percentage
value from 0% (lowest gain) to 100% (highest gain). The color channel parameters are
used to avoid unrealistic colors so that objects that appear white to the human eye are
rendered white in the final image. The default value for this parameter is factory-calibrated.
Blue Gain
Sets the gain value for the blue color channel of the image sensor and is a percentage
value from 0% (lowest gain) to 100% (highest gain). The color channel parameters are
used to avoid unrealistic colors so that objects that appear white to the human eye are
rendered white in the final image. The default value for this parameter is factory-calibrated.
MicroHAWK Engine Integration Guide
11-17
Color Filter
Color Filter
Definition:
Usage:
Default:
Options:
If you are using a 5 megapixel color MicroHAWK, this filter captures an
image in color. To process the image for symbol decoding, the image
must be filtered or the R, G, and B cells need to be equalized. This can be
done by applying one of the filters available or by performing a white
balance with the current camera configuration before trying to decode a
symbol. This option specifies the filter method that is applied to the RGB
color image to produce a monochrome image.
<K543,color filter>
Disabled
0 = Disabled (Raw, No Filter)
1 = Enabled
2 = Horizontal 1D Symbols
3 = Green Interpolate
Disable
No filter is applied to image. If you are attempting to read symbols with no filter applied, a
white balance should be performed first to balance the red, blue, and green cells of the
image sensor.
General Purpose
This is a general purpose filter that is applied to the RGB image to provide a grayscale
image that can be used for most applications.
This filter should be used when reading 2D symbols, 1D symbols that are not positioned
horizontally in the field of view, or a combination of 1D and 2D symbols.
Horizontal 1D Symbols
This filter is applied to the RGB image to provide a grayscale image that is specifically
designed to provide the best suitable image for a horizontally-positioned 1D symbol.
This filter should be used when reading 1D symbols that are positioned horizontally across
the field of view.
Green Interpolate
This filter is applied to the RGB image to provide a grayscale image for decoding similar to
a luminance calculation. Unlike a luminance calculation, Green Interpolate provides an
image 1:1 resolution to the input image. This filter provides better omni-directional symbol
decode performance. Like Horizontal 1D Symbols, and unlike General Purpose, a white
balance is not necessary.
This filter is recommended for most decoding applications that can afford extra processing time.
Note: For high-resolution 1D symbols that are positioned horizontally, the Horizontal 1D
Symbols filter is preferable.
11-18
MicroHAWK Engine Integration Guide
Camera and IP Setup
Focal Distance
Options:
Example:
50 mm – 300 mm. Focal distance selected by user at time of purchase.
The focal distance is reflected in the reader’s part number.
7112-2102-1005 shows a focal distance of 102 mm.
See MicroHAWK Part Number Structure for additional details.
Contact Microscan for additional focal distance options.
050: 50 mm = 1.96 in.
064: 64 mm = 2.51 in.
081: 81 mm = 3.18 in.
102: 102 mm = 4.02 in.
133: 133 mm = 5.23 in.
190: 190 mm = 7.48 in.
300: 300 mm = 11.81 in.
MicroHAWK Engine Integration Guide
11-19
Illumination Brightness
Illumination Brightness
Definition:
Serial Cmd:
Default:
Options:
This feature allows you to adjust the brightness of the illumination LEDs.
Since the reader has control over the brightness of the illumination, it can
provide consistent brightness output between readers through a factory
calibration operation. Each of the brightness settings is calibrated to provide
the same level of intensity for each reader.
<K536,brightness,light source>
High
0 = Off
1 = Low
2 = Medium
3 = High
4 = Constant
Constant
When set to Constant, the illumination brightness is the same power level as the High
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.
Light Source
Definition:
Serial Cmd:
Options:
11-20
The setting allows the user to change the illumination light source.
<K536,brightness,light source>
1 = Embedded White Only (Default for ID-20 QSXGA)
2 = Embedded Red Only (Default for ID-20 WVGA and SXGA)
3 = External Only (Default for ID-30 and ID-40)
MicroHAWK Engine Integration Guide
Camera and IP Setup
Morphological Pre-Processing
Morphological Pre-Processing allows you 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:
<K550,morphological pre-processing>
Disabled
0 = Disabled
1 = Enabled
MicroHAWK Engine Integration Guide
11-21
Morphological Operation and Operator Size
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.
11-22
MicroHAWK Engine Integration Guide
Camera and IP Setup
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.
MicroHAWK Engine Integration Guide
11-23
Morphological Operation and Operator Size
Operator Size
Definition:
Serial Cmd:
Default:
Options:
11-24
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)
MicroHAWK Engine Integration Guide
Camera and IP Setup
Damaged Symbol
Definition:
Serial Cmd:
Default:
Options:
When Damaged Symbol is enabled, the reader will make additional
attempts to decode damaged Code 128 and Code 39 symbols. It is effective
on symbols with high noise and partial bar missing. Enabling Damaged
Symbol may significantly increase decode time.
<K519,damaged symbol status>
Disabled
0 = Disabled
1 = Enabled
MicroHAWK Engine Integration Guide
11-25
Linear Security Level
Linear Security Level
Definition:
Serial Cmd:
Default:
Options:
11-26
Linear Security Level is intended to prevent misreads. When it is set to a
higher level, it requires more scan lines to decode the same result, making
it more secure.
<K560,linear security level>
Aggressive
0 = Aggressive
1 = Normal
2 = Secure
MicroHAWK Engine Integration Guide
Camera and IP Setup
Set License
Serial Cmd:
<K556,license file name,license key>
License File Name
The License File Name is the name of the file that holds the license key. The file name
should be no longer than 32 characters including the mandatory .lic extension. By convention, the file name should begin with the first three octets of the target device’s MAC
address followed by a short key descriptor. An example filename is 17B2C3-X-Mode.lic.
License Key
The License Key field is a 29 character string representing the license key. The key is
generated by a proprietary licensing tool and the format is a sequence of five five-character
dash-separated fields. An example key is 12345-67890-ABCDE-FGHIJ-KLMNO.
MicroHAWK Engine Integration Guide
11-27
Set License
11-28
MicroHAWK Engine Integration Guide
12 Configuration
Database
Contents
Configuration Database Serial Commands ................................................................................ 12-2
Number of Active Indexes .......................................................................................................... 12-3
Configuration Database ............................................................................................................. 12-4
Database Mode ........................................................................................................................ 12-10
Save Current Settings to Configuration Database.................................................................... 12-15
Load Current Settings from Configuration Database................................................................ 12-16
Request Selected Index Settings ............................................................................................. 12-17
Request All Configuration Database Settings .......................................................................... 12-17
This section concerns the various capture settings and processing settings that can be
used to fine-tune the MicroHAWK Engine’s performance in your application.
MicroHAWK Engine Integration Guide
12-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
12-2
<K252,number of active indexes,sort database>
<K255,index,exposure,gain,pixel binning,row
pointer,column pointer,row depth,column width,
symbology,morphology operator,morphology size>
<K255+,index>
<K255-,index>
<K255?,index>
<K255?>
<K256,switch mode,frame count/time,image process
looping,image dimensions>
MicroHAWK Engine Integration Guide
Configuration Database
Number of Active Indexes
Usage:
Definition:
Serial Cmd:
Default:
Options:
Useful for applications that require several different complex reader 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 reader settings will be used, not
database entry settings.
<K252,number of active indexes,sort database>
0 (Disabled)
0 to 10
Sort Database
Definition:
Serial Cmd:
Default:
Options:
Sort Database moves the database entry that produced a successful
decode to the first position in the list of database entries.
<K252,number of active indexes,sort database>
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.
MicroHAWK Engine Integration Guide
12-3
Configuration Database Status
Configuration Database Status
Index
Usage:
Useful for applications that require several different complex reader 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,exposure,gain,pixel binning,row pointer,column pointer, row depth,
column width,symbology,morphology operator,morphology size>
Options:
1 to 10
Exposure
Serial Cmd: <K255,index,exposure,gain,pixel binning,row pointer,column pointer,row depth,
column width,symbology,morphology operator,morphology size>
Default:
10,000
Options:
50 to 100,000
Note: The Exposure parameter is read-only when the reader is in Continuous Read mode.
Gain
Serial Cmd: <K255,index,exposure,gain,pixel binning,row pointer,column pointer, row
depth,column width,symbology,morphology operator,morphology size>
Default:
25
Options:
0 to 100
Pixel Binning
Serial Cmd: <K255,index,exposure,gain,pixel binning,row pointer,column pointer,row
depth,column width,symbology,morphology operator,morphology size>
Default:
Disabled
Options:
0 = Disabled
1 = Enabled
Important: Pixel Binning 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 Binning to increase processing speed when ROI is configured,
because the frame size would need to be increased to make Pixel Binning possible.
12-4
MicroHAWK Engine Integration Guide
Configuration Database
Row Pointer
Definition:
The image dimension settings can be applied as a Window of Interest or a
Region of Interest, depending on the image dimension mode selected in the
Database Mode command.
Serial Cmd: <K255,index,exposure,gain,pixel binning,row pointer,column pointer,row depth,
column width,symbology,morphology operator,morphology size>
Default:
All models: 0
Options:
QSXGA MicroHAWK: 0 to (1944 – row depth)
SXGA MicroHAWK: 0 to (1024 – row depth)
WVGA MicroHAWK: 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,exposure,gain,pixel binning,row pointer,column pointer,row
depth,column width,symbology,morphology operator,morphology size>
Default
All models: 0
Options:
QSXGA MicroHAWK: 0 to (2592 – column width)
SXGA MicroHAWK: 0 to (1280 – column width)
WVGA MicroHAWK: 0 to (752 – column width)
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,exposure,gain,pixel binning,row pointer,column pointer, row depth,
column width,symbology,morphology operator,morphology size>
Default:
QSXGA MicroHAWK: 1944
SXGA MicroHAWK: 1024
WVGA MicroHAWK: 480
Options:
QSXGA MicroHAWK: 3 to (1944 – row pointer)
SXGA MicroHAWK: 3 to (1024 – row pointer)
WVGA MicroHAWK: 3 to (480 – row pointer)
MicroHAWK Engine Integration Guide
12-5
Configuration Database Status
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,exposure,gain,pixel binning,row pointer,column pointer, row depth,
column width,symbology,morphology operator,morphology size>
Default
QSXGA MicroHAWK: 2592
SXGA MicroHAWK: 1280
WVGA MicroHAWK: 752
Options:
QSXGA MicroHAWK: 8 to (2592 – column pointer)
SXGA MicroHAWK: 8 to (1280 – column pointer)
WVGA MicroHAWK: 8 to (752 – column pointer)
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 Interleaved 2 of 5, BC412, and DataBar Limited are required, the parameter
would be: 128 + 2048 + 16384 = 18560.
Serial Cmd: <K255,index,exposure,gain,pixel binning,row pointer,column pointer, row depth,
column width,symbology,morphology operator,morphology size>
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 reader will not decode Data Matrix symbols.
12-6
MicroHAWK Engine Integration Guide
Configuration Database
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.
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 (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 reader will only read non-stacked
DataBar-14 symbols.
DataBar Limited (Add 16384)
If enabled, DataBar Limited will be active for this database index.
MicroHAWK Engine Integration Guide
12-7
Configuration Database Status
DataBar 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 reader will only read
non-stacked DataBar Expanded symbols.
Micro QR Code (Add 65536)
If enabled, Micro QR Code will be active for this database index.
Aztec (Add 131072)
If enabled, Aztec will be active for this database index.
Postal Symbologies (Add 262144)
If enabled, Postal Symbologies will be active for this database index.
12-8
MicroHAWK Engine Integration Guide
Configuration Database
Morphology Operator
Definition:
Specifies the morphology operation (erode, dilate, open, close) used to
pre-process the WOI.
Serial Cmd: <K255,index,exposure,gain,pixel binning,row pointer,column pointer, row depth,
column width,symbology,morphology operator,morphology size>
Default:
Erode
Morphology Size
Specifies the morphology operator size to apply: Small (3 x 3), Medium (5 x 5),
and Large (7 x 7).
Serial Cmd: <K255,index,exposure,gain,pixel binning,row pointer,column pointer, row depth,
column width,symbology,morphology operator,morphology size>
Default:
Disabled
Definition:
MicroHAWK Engine Integration Guide
12-9
Database Mode
Database Mode
Switch Mode
Definition:
Selects the event that causes the reader 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 reader 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 reader 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
12-10
MicroHAWK Engine Integration Guide
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 re-processed
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.
MicroHAWK Engine Integration Guide
12-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, Exposure, Gain, Pixel Binning) located
in the left half of the highlighted area.
Image capture dimensions located in the right half of the highlighted area.
12-12
MicroHAWK Engine Integration Guide
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
IP ROI
row
size
DB 2
IP ROI
column size
DB 3
Camera WOI
IP ROI
Full Image Size (SXGA Reader: 1280 x 1024; WVGA Reader: 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.
MicroHAWK Engine Integration Guide
12-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.
Morphology Operation, Morphology Size, and Symbol Type are
Processing Settings values.
12-14
MicroHAWK Engine Integration Guide
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 reader’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 reader’s current configuration
parameters to the selected database index.
MicroHAWK Engine Integration Guide
12-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.
12-16
MicroHAWK Engine Integration Guide
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.
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.
MicroHAWK Engine Integration Guide
12-17
Request All Configuration Database Settings
12-18
MicroHAWK Engine Integration Guide
13 Terminal
Contents
Terminal ..................................................................................................................................... 13-2
Find ............................................................................................................................................ 13-3
Send ........................................................................................................................................... 13-4
Macros........................................................................................................................................ 13-5
Terminal Menus.......................................................................................................................... 13-6
This section describes the Terminal window and macro functions in ESP.
MicroHAWK Engine Integration Guide
13-1
Terminal
Terminal
Click this button to display the Terminal view.
This 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 reader 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 reader.
You can also right-click on the Terminal screen to bring up a menu of further options.
13-2
MicroHAWK Engine Integration Guide
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”.
MicroHAWK Engine Integration Guide
13-3
Send
Send
The Send function allows you to enter serial commands and then send them to the reader.
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 .
13-4
MicroHAWK Engine Integration Guide
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.
MicroHAWK Engine Integration Guide
13-5
Terminal Menus
Terminal 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.
13-6
MicroHAWK Engine Integration Guide
14 Utilities
Contents
Operational Commands.............................................................................................................. 14-2
Read Rate .................................................................................................................................. 14-4
Counters ..................................................................................................................................... 14-6
Device Control ............................................................................................................................ 14-8
Differences from Default............................................................................................................. 14-9
Master Database ...................................................................................................................... 14-10
Firmware................................................................................................................................... 14-16
Default/Reset/Save................................................................................................................... 14-19
Reader Status Requests .......................................................................................................... 14-21
Other Operational Serial Commands ....................................................................................... 14-23
Utility commands are generally commands that are performed during reader operations to
check or determine read rates, or to perform miscellaneous operations on reader 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.
MicroHAWK Engine Integration Guide
14-1
Operational Commands
Operational Commands
Note: For a list of all K commands, see Serial Configuration Commands.
Type
Command
<q>
<q0>
<$>
<$0>
<N>
<O>
<T>
<U>
<V>
<W>
<X>
<Y>
<#>
<#a>
<#b>
<!>
<!a>
<!b>
<!s>
<C>
<Cp>
<J>
<a1>
<L1>
<L2>
<L3>
<I>
<H>
<l1>1
<l0>2
Counter Request/Clear
Firmware Verification
Read Rate
Device Control
Read Cycle
Enable/Disable
<A?/1>
Parameter Reset/Save
<A?/0>
<A>
<Ard>
Resets
<Arp>
<Arc>
1<l1>
2<l0>
14-2
Name
No-Reads Per Read Cycle Counter
No-Reads Per Read Cycle Counter Reset
Mismatch Per Read Cycle Counter
Mismatch Per Read Cycle Counter Reset
No-Read Counter
No-Read Counter Reset
Trigger Counter
Trigger Counter Reset
Match Code Counter
Match Code Counter Reset
Mismatch Counter
Mismatch Counter Reset
Request All Part Numbers
Request Application Firmware Part Number
Request Boot Code Firmware Part Number
Request All Firmware Checksums
Request Application Firmware Checksum
Request Boot Code Firmware Checksum
Request Current Parameter Settings Checksum
Decodes Per Second Test
Decode Percent Test
Exit Read Rate Tests
Preface PDF417 Output with Data Attributes
Pulse Programmable Output 1
Pulse Programmable Output 2
Pulse Programmable Output 3
End Current Read Cycle until <H>
Enable Read Cycle after <I>
Activate Targeting System
Deactivate Targeting System
Complete Reset when Resets or Save for Power-On
Command Has Been Issued
Warm Reset if Power-On Command Has Been Issued
Software Reset, Current Parameters Retained
Software Reset, Recall Microscan Default Parameters
except Communication and Custom Unit Name Parameters
Software Reset, Recall Power-On Default Parameters
Software Reset, Recall Customer Default Parameters
= lowercase ‘L’, one
= lowercase ‘L’, zero
MicroHAWK Engine Integration Guide
Utilities
<Z>
<Zc>
<Zrc>
Save for Power-On
<Zrd>
<Zrdall>
Master Database
Reader Status
Train/Optimize
Barcode Configuration
<G>
<Gn>
<NEWM>
<?>
<TRAIN>
<UNTRAIN>
<TRAIN?>
<OPT>
<UNOPT>
<OPT?>
<BCCFG>
MicroHAWK Engine Integration Guide
Software Reset, Save Current Settings for Power-On
Software Reset, Save Current Settings as Customer
Default Parameters
Software Reset, Recall Customer Default Parameters
and Save for Power-On
Software Reset, Recall Microscan Default Parameters
Except Communication and Custom Unit Name Parameters
and Save for Power-On
Software Reset, Recall Microscan Default Parameters
Including Communication and Custom Unit Name
Parameters and Save for Power-On
Store Next Symbol Read to Database Index 1
Store Next Symbol Read to Database Index n
New Master Load Status
Reader Status Request
Initiate Train Operation
Initiate Untrain Operation
Train Status Request
Initiate Optimize Operation
Initiate Un-Optimize Operation
Display Optimize Status
Enter Barcode Configuration
14-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 reader from this screen.
14-4
To end a Read Rate test, click the Stop
button (the Start button becomes a Stop
button during an active Read Rate test.)
MicroHAWK Engine Integration Guide
Utilities
Read Rate Serial Utility Commands
Enter Decodes/Second Test
Sending <C> instructs the reader 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 reader
during setup.
Enter Percent Test
Sending <Cp> instructs the reader 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.
MicroHAWK Engine Integration Guide
14-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 reader 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 reader 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).
14-6
MicroHAWK Engine Integration Guide
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.
MicroHAWK Engine Integration Guide
14-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 reader OFF, end the current read cycle, and will not allow the
reader 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 reader is being configured.
Disabling the reader will not affect any commands that have already been downloaded.
Enable Reader
Sending <H> will turn the reader ON and allow it to enter read cycles.
14-8
MicroHAWK Engine Integration Guide
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 reader 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
reader 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 reader and save them, or Send to
Reader to send the settings without saving them.
Important: To use Differences from Default, connect to the reader and Receive
Reader Settings via the Send/Recv button on the toolbar.
MicroHAWK Engine Integration Guide
14-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 reader.
Loads the reader’s saved
master symbols into ESP.
Double-click a row to enter data into popup text box.
14-10
MicroHAWK Engine Integration Guide
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 number,master symbol data>
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
MicroHAWK Engine Integration Guide
Master Symbol
Number
#6
#7
#8
#9
# 10
Maximum
Characters
500
428
375
333
300
14-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 values.
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.
14-12
MicroHAWK Engine Integration Guide
Utilities
Request Master Symbol Data
Definition:
Serial Cmd:
ESP:
Returns master symbol data for any enabled master symbols from 1 to 10.
For example, to request master symbol # 5, enter <K231?,5>. The reader
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.
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?>
MicroHAWK Engine Integration Guide
14-13
Read Next Symbol as Master Symbol
Definition:
Serial Cmd:
ESP:
After you’ve set the size in the database, you can order the reader 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:
14-14
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 reader 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.)
MicroHAWK Engine Integration Guide
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 reader to delete the selected master
symbol from the database.
MicroHAWK Engine Integration Guide
14-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 reader. Consult with your sales representative
before downloading application code. If needed, an application code file will be sent to you.
To download application code:
1. First, be sure that your reader is connected to the host.
2. Apply power to the reader.
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, 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.
14-16
MicroHAWK Engine Integration Guide
Utilities
Firmware Verification
Request Part Number by ESP
You can send a request to the reader for part numbers, checksums, boot code, and
application code.
1. Click the Firmware tab.
2. From the dropdown 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 reader 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 reader returns:
<#a/APP_P/N>.
• When you send <#b> (a request for the boot code part number), the reader returns:
<#b/BOOT_P/N>.
• When you send <#p> (a request for profile module part numbers), the reader returns:
<#p/PROFILE_P/N>.
MicroHAWK Engine Integration Guide
14-17
Firmware
Request Checksum by ESP
You can send a request to the reader for part numbers, checksums, boot code, and
application code.
1. Click the Firmware tab.
2. From the dropdown 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 reader returns:
<!b/BOOT_CHECKSUM><!a/APP_CHECKSUM><!p/PROFILE_CHECKSUM>
• When you send <!a> (a request for the application code checksum), the reader returns:
<!a/APP_CHECKSUM>
• When you send <!b> (a request for the boot code checksum), the reader returns:
<!b/BOOT_CHECKSUM>
• When you send <!p> (a request for profile module checksum), the reader returns:
<!p/PROFILE_CHECKSUM>
14-18
MicroHAWK Engine Integration Guide
Utilities
Default/Reset/Save
Understanding and controlling your reader’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
Reset and Recall Microscan Defaults
Reset and Recall Power-On Parameters
Reset and Recall Customer Default
Parameters
<Ard>
<Arp>
Save to Reader,
Send No Save
No
No
<Arc>
No
Save Current Settings for Power-On
<Z>
Save Current Settings as Customer
Default Parameters for Power-On
<Zc>
Reset
Recall Microscan Default Parameters and
Save for Power-On
Recall Customer Default Parameters and
Save for Power-On
<A>
Save to Reader,
Send and Save
Save to Reader,
Send and Save Customer
Defaults for Power-Onb
<Zrd>
No
<Zrc>
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 dropdown 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 reader 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.
MicroHAWK Engine Integration Guide
14-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 a hardware default to restore the known
Microscan defaults, the user can then recall the previous customer saved 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 <Zrdall>
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 connector. (Access depends on wiring
configuration. May require an 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 the wires (or pins).
4. Within 3 seconds, disconnect and then reconnect the two wires again.
14-20
MicroHAWK Engine Integration Guide
Utilities
Reader Status Requests
<?> Status Byte
The reader 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.
Bit
0
1
2
3
4
5
Binary
0
1
0
0
0
1
Reader Status
Command error detected
Command received
Communication error detected
Flash sector unprotect failure
Host port buffer overflow
Reader 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
“Reader 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
Binary
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 reader’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.
MicroHAWK Engine Integration Guide
14-21
Reader 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.
14-22
MicroHAWK Engine Integration Guide
Utilities
Other Operational Serial Commands
The following serial utility commands can be entered from ESP’s Terminal or a PLC:
Train and Optimize
Train Symbol
Format: <TRAIN>: Initiates a Train operation.
This command will put the product into a mode of operation that will cause it to “train” the
next symbol decoded. This mode of operation will remain active until either a symbol is
decoded or the call is made to disable the mode and revert back to normal operation.
Upon decoding a symbol, the image processing will save pertinent information regarding
the target symbol to allow higher readability for the similar symbols.
The data collected by the Train operation can be saved for a power-on condition, using the
<Z> command.
Un-Train Symbol
Format: <UNTRAIN>: Initiates an Un-Train operation.
This command will cause the product to discard any information acquired during a Train operation.
The Untrained state can be saved for a power-on condition, using the <Z> command.
Train Status
Format: <TRAIN?>: Responds with Train Status
This command will return the current status of the TRAIN operation.
Response: < TRAIN,0>: Default, not trained
<TRAIN,1>: Train operation in process
<TRAIN,2>: Symbol trained
Train Persistence
The train state and parameters persist the same as ordinary parameters. Examples:
• A unit in the trained state has not been saved. A power cycle will remove any trained
state information and the unit will come up in its configured state.
• A unit is saved in a training state. The unit will come from power up in the training state
and train the first symbol read.
• A unit is saved in a trained state. The unit will come from power up in the trained state
and only read the trained symbol type.
• A trained unit is issued a reset default command <Ard>. The unit will return to an
untrained state but if power is cycled will return to its saved state.
MicroHAWK Engine Integration Guide
14-23
Other Operational Serial Commands
Optimize Symbol
Format: <OPT> Initiates an Optimize operation.
This command will put the product into a mode of operation that will cause it to “optimize”
the next symbol decoded. This mode of operation will remain active until either a symbol is
decoded or the call is made to disable the mode and revert back to normal operation.
Upon decoding a symbol, the image processing will save pertinent information regarding
the target symbol to allow it to be processed quicker and more consistently.
The data collected by the Optimize operation can be saved for a power-on condition, using
the <Z> command.
Un-Optimize Symbol
Format: <UNOPT>: Initiates an Un-Optimize operation.
This command will cause the product to discard any information acquired during a Optimize operation.
The Un-Optimized state can be saved for a power-on condition, using the <Z> command.
Optimize Status
Format: <OPT?>: Responds with Optimize Status
This command will return the current status of the OPT operation.
Response: <OPT,0>: Default, not optimized
<OPT,1>: Optimize operation in-process
<OPT,2>: Symbol optimized
Optimize Persistence
The Optimize state and parameters persist the same as ordinary parameters. Examples:
• A unit in the optimized state has not been saved. A power cycle will remove any optimized
state information and the unit will come up in its configured state.
• A unit is saved in a optimizing state. The unit will come from power up in the optimizing
state and optimize the first symbol read.
• A unit is saved in a optimized state. The unit will come from power up in the optimized
state and only read the optimized symbol type.
• A optimized unit is issued a reset default command <Ard>. The unit will return to an
un-optimized state but if power is cycled will return to its saved state.
14-24
MicroHAWK Engine Integration Guide
Utilities
Y-Modem Upload Transfer Options
<uy,path,filename>
Y-Modem Download Transfer Options
<dy,path,filename>
Image Library Request
<op,9> Manages files in a selected directory.
File Source
(Nothing)
/
/saved
*.*
/del
/saved/del
del*.*
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
MicroHAWK Engine Integration Guide
14-25
Other Operational Serial Commands
Bar Code Configuration Mode
Definition:
Serial Cmd:
Bar Code Configuration Mode is a way of programming the reader by
using ECC 200 Data Matrix symbols.
<BCCFG>
Bar Code Configuration Mode can be entered in two different ways:
1. By forcing the reader into Bar Code Configuration Mode by serial command
<BCCFG>.
2. By reading a Data Matrix symbol with a special code word used by ISO/IEC 16022
to signify reader 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 reader by printing labels in Microscan’s
serial command format. Commands are processed as if the data were streamed in through
the serial port. The reader will acknowledge the symbol with a green flash, and echo the
serial data to the host. If the command causes the reader 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>, <Z> or <J> command.
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 reader to enable Serial Trigger Mode, to program a new trigger to end
the read cycle, and to exit Bar Code Configuration Mode with <J>.
Note: When the system is in barcode configuration mode, 2D symbols are allowed to pass
through even if the reader only has a 1D license. The system outputs a Config Code
Received message when the configuration symbol is decoded instead of showing the
configuration symbol’s actual symbol data. A > character is output to the Terminal to
indicate that the system is ready for bar code configuration mode.
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 reader programming.
14-26
MicroHAWK Engine Integration Guide
15 Output Format
Contents
Output Format Serial Commands............................................................................................... 15-2
Output Format Status ................................................................................................................. 15-3
Format Assign ............................................................................................................................ 15-4
Format Extract............................................................................................................................ 15-5
Format Insert .............................................................................................................................. 15-7
Output Filter Configuration ......................................................................................................... 15-9
Number of Filters..................................................................................................................... 15-14
This section explains how to control the formatting and filtering of decoded symbol data for output.
MicroHAWK Engine Integration Guide
15-1
Output Format Serial Commands
Output Format Serial Commands
Format Extract
Format Insert
Format Assign
Format Status
Output Filter Configuration
Ordered Output Filter
15-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>
MicroHAWK Engine Integration Guide
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.
MicroHAWK Engine Integration Guide
15-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.
15-4
MicroHAWK Engine Integration Guide
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).
MicroHAWK Engine Integration Guide
15-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.
15-6
MicroHAWK Engine Integration Guide
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 values.)
MicroHAWK Engine Integration Guide
15-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.
15-8
MicroHAWK Engine Integration Guide
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.
MicroHAWK Engine Integration Guide
15-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
11 = MicroPDF417
12 = Composite
13 = BC412
14 = Data Matrix
15 = QR Code
16 = Micro QR Code
17 = Aztec
18 = Postal Symbologies
15-10
MicroHAWK Engine Integration Guide
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
MicroHAWK Engine Integration Guide
15-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
15-12
MicroHAWK Engine Integration Guide
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.
MicroHAWK Engine Integration Guide
15-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
15-14
MicroHAWK Engine Integration Guide
Appendices
Contents
Appendix A General Specifications .............................................................................................. A-2
Appendix B Electrical Specifications ............................................................................................ A-7
Appendix C Quantum Efficiency Specifications ........................................................................... A-9
Appendix D Serial Commands ................................................................................................... A-10
Appendix E Communications Protocol ....................................................................................... A-12
Appendix F ASCII Table............................................................................................................. A-13
Appendix G Glossary of Terms .................................................................................................. A-14
MicroHAWK Engine Integration Guide
A-1
General Specifications
Appendix A — General Specifications
Dimensions
Height: 19.5 mm (0.77")
Width: 28.7 mm (1.13”)
Length: 33.9 mm (1.33”)
Weight: 0.49 oz. (14 g)
Front
Environmental
Enclosure: IP40
Operating Temp: 0° to 40° C (32° to 104° F)
Storage Temp: -50° to 75° C (-58° to 167° F)
Humidity: 5% to 95% (non-condensing)
Operating Life: 50,000 hours @ 25 C
CE Standard for LED Safety: EN 60825-1:
1994+A1+A2 Class 1
Top
Emissions
EN 55022:2010 Class A Limits
Electrical
Power: 5 VDC ± 5%; 350 mA at 5 VDC (typ.)
Connector
Type: Micro-B USB socket
Second USB Port on ZIF Connector
Communication
USB 2.0 High Speed
Illumination
High-Output LEDs: 4 Red (625 nm), 4 White
Indicators
Power LED, 2 Target Pattern LEDs,
2 Good Read Green Flash LEDs
Speed
Base
Standard (up to 10 FPS)
Memory
2 GB Non-Volatile Flash, 256 MB RAM
Decoder
Standard (High-Contrast 1D);
Plus (High-Contrast 1D/2D);
X-Mode (Poor or Damaged 1D/2D)
Density
Standard or High-Density
Sensor Options
WVGA (Mono): CMOS 0.34 MP (752 x 480)
SXGA (Mono): CMOS 1.2 MP (1280 x 960)
QSXGA (Color): CMOS 5 MP (2592 x 1944)
Shutter
Global (WVGA, SXGA); Rolling (QSXGA)
Exposure
50 - 100,000; Default: 2,500 μs
Focus
Fixed (50-300 mm)
Frames Per Second
WVGA: Up to 60; SXGA: Up to 42; QSXGA: Up to 5
MicroHAWK Engine Dimensions
Note: Inches [millimeters]. Nominal dimensions shown.
Typical tolerances apply.
Symbologies
2D: Data Matrix (ECC 0-200), QR Code, Micro QR Code, Aztec Code, DotCode; Stacked: PDF417, MicroPDF417, GS1 Databar
(Composite and Stacked); Linear: Code 39, Code 128, BC412, Interleaved 2 of 5, UPC/EAN, Codabar, Code 93, Pharmacode,
PLANET, POSTNET, Japanese Postal, Australia Post, Royal Mail, Intelligent Mail, KIX
A-2
MicroHAWK Engine Integration Guide
Appendices
Read Ranges
WVGA Sensor Read Ranges
Example Read Range Diagram
Note: Minimum 1D element is typically 1/2 the size of minimum 2D element. Example: 10 mil 2D = 5 mil 1D.
MicroHAWK Engine Integration Guide
A-3
General Specifications
SXGA Sensor Read Ranges
Example Read Range Diagram
Note: Minimum 1D element is typically 1/2 the size of minimum 2D element. Example: 10 mil 2D = 5 mil 1D.
A-4
MicroHAWK Engine Integration Guide
Appendices
QSXGA Sensor Read Ranges
Example Read Range Diagram
Note: Minimum 1D element is typically 1/2 the size of minimum 2D element. Example: 10 mil 2D = 5 mil 1D.
MicroHAWK Engine Integration Guide
A-5
General Specifications
Safety Certifications
FCC, UL/cUL, CE, RoHS/WEEE
©2016 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 symbols. Performance
characteristics may vary at high temperatures or other environmental extremes.
Warranty – One year limited warranty on parts and labor. Extended warranty available.
A-6
MicroHAWK Engine Integration Guide
Appendices
Appendix B — Electrical Specifications
Power: 5 VDC ± 5%; 350 mA at 5 VDC (typ.)
Micro-USB Type B Socket Pin Assignments
Pin
1
2
3
4
5
Function
Vbus (5V)
D–
D+
N/C
Ground
MicroHAWK Engine Integration Guide
A-7
Electrical Specifications
Ribbon Cable / ZIF Connector Pin Assignments
See Electrical Specifications in Integration for additional electrical information.
Pin
1
Name
3V3 SNVS
Direction
Output
Description
3.3V IO Power
Output Indicator
ENET Link and Activity
3.3V IO Power
Output Indicator
Trigger
Digital Ground
2
LED_LINK_ACT
Output
3
3V3 SNVS
Output
4
LED_TRIG
Output
5
6
7
8
9
10
11
12
13
14
15
16
GND
SPI_CS1
GND
SPI_CLK
RESERVED
SPI_DATA
1.8V
SPI_CS
1.8V
OUT_2
BEEPER+
OUT_1
In/Out
Output
Output
Output
Output
Output
Output
17
LED_BAD_FAIL
Output
18
19
20
21
OUT_3
TRIGGER
SHUT_STRB
INPUT_2
Output
Input
Output
Input
22
BUTTON
Input
Push Button Input
Output
Output Indicator
MODE
Output
Output
Digital Ground
Serial Periperhal I/F CLK
Common with pin(s) 5,36,38
Use with pin(s) 10,12
Serial Periperhal I/F CLK
Use with pin(s) 8,12
Serial Periperhal I/F CLK
Use with pin(s) 8,10
Output Indicator
BAD READ/FAIL
23
FIFTH_LED
24
I2C3_SDA
In/Out
25
LED_GOOD_PASS
Output
26
27
28
29
30
I2C3_SCL
INPUT_1
OGD2_DN
PWM_ILLUM
OGD2_DP
Output
Input
In/Out
Output
In/Out
USB Data -
31
RX_DATA
Input
Receive DATA
32
VBUS
Input
33
TX_DATA
Output
34
35
36
37
38
39
RESERVED
RESERVED
GND
LED_SPEED
GND
ETH_TPI_N
40
+5V
41
ETH_TPI_P
42
+5V
43
ETH_TPO_N
44
+5V
45
ETH_TPO_P
A-8
Specifications
Notes
3.3V +/- xx% @ xx mA Max Common with pin 3
CPU GPIO xx VDC +/- xx
mA Max
3.3V +/- xx% @ xx mA Max Common with pin 1
CPU GPIO xx VDC +/- xx
mA Max
Common with pin(s) 7,36,38
Output Indicator
GOOD READ/PASS
USB Data +
Transmit DATA
CPU GPIO xx VDC +/- xx
mA Max
FW Funtionality of Setup
Button
CPU GPIO xx VDC +/- xx
mA Max
I2C Interface Data
CPU GPIO xx VDC +/- xx
mA Max
I2C Interface Clock
Use with pin 26
Use with pin 24
USB 2.0
USB 2.0
VDD = 3.3V (See DVGPIO I/ RS-232C Transceiver
O DC Parameters Table)
Required
VDD = 3.3V (See DVGPIO I/ RS-232C Transceiver
O DC Parameters Table)
Required
Digital Ground
Common with pin(s) 5,7,38
Digital Ground
Common with pin(s) 5,7,36
Output
Input
5VDC Main Input
5.0 +/- 5% @ 1200mA
Common with pin(s) 42,45
Input Power Dependent on
Ext Config
Input
5VDC Main Input
5.0 +/- 5% @ 1200mA
Common with pin(s) 40,45
nput Power Dependent on
Ext Config
Input
5VDC Main Input
5.0 +/- 5% @1200mA
Common with pin(s) 40,42
nput Power Dependent on
Ext Config
MicroHAWK Engine Integration Guide
Appendices
Appendix C — Quantum Efficiency Specifications
Typical quantum efficiency, monochrome sensor.
Note: Sensor only. May add IR filter depending on lens configuration.
WVGA Sensor
SXGA Sensor
MicroHAWK Engine Integration Guide
A-9
Serial Commands
Appendix D — Serial Commands
Serial Command Format
Microscan readers are controlled by two types of serial commands: configuration commands
and utility commands.
Rules that apply to both configuration and utility commands
• Less than ‘<‘ and greater than ‘>’ angle bracket characters enclose the commands.
• Commands and data are case sensitive. Characters must be entered as upper or lower
case, as specified.
Serial Utility Commands
Serial Utility Commands are sent during operations and are not followed by <A> or <Z>.
Serial Configuration Commands (K Commands)
Microscan’s serial configuration commands begin with a single “K” character followed by a
3-digit numeric character, comma-separated command fields, and an initializing command,
as follows:
<Knumeric character,data,data,...etc.><initializing command>
An initializing command <Z> or <A> may follow the command.
• <Z> initializes the MicroHAWK Engine’s memory and saves for power-on.
• <A> initializes the MicroHAWK Engine’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 command fields (except the last) must be followed by a comma (without a space).
• NULL cannot be used. The characters <, >, and , can be used, but only if entered as
hex values.
• 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>.
Concatenating Configuration Commands
Commands can be concatenated (added together) in a single string. For example,
<K145,1><K220,1><K450,1><A> enables LRC, sets End of Read Cycle mode to New
Trigger, enables Narrow Quiet Zone, and resets the data buffers without saving the
changes for power-on.
A-10
MicroHAWK Engine Integration Guide
Appendices
Serial Command Status Request
To ensure that any command was received and accepted, 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>
MicroHAWK Engine Integration Guide
A-11
Communications Protocol
Appendix E — 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
A-12
MicroHAWK Engine Integration Guide
Appendices
Appendix F — 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
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
^[
^\
^]
^^
^_
MicroHAWK Engine Integration Guide
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
A-13
Glossary of Terms
Appendix G — 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.
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.
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.
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.
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.
A-14
MicroHAWK Engine Integration Guide
Appendices
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.
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.
Dark Field 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.
Dynamic Range — The difference between the minimum and maximum thresholds of
discernible images; the amount of usable signal.
Edge Enhancement — Image processing method to strengthen high-spatial frequencies
in the image.
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.
MicroHAWK Engine Integration Guide
A-15
Glossary of Terms
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.
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.
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.
A-16
MicroHAWK Engine Integration Guide
Appendices
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.
Ladder Orientation — A linear symbol orientation in which the bars are parallel to the
symbol’s direction of travel.
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.
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.
Pixel — An individual element in a digitized image array; “picture element”.
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”.
MicroHAWK Engine Integration Guide
A-17
Glossary of Terms
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.
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.
Region — Area of an image. Also called a region of interest for image processing operations.
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.
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.
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.
Watchdog Timer — A security device that detects system crashes and attempts to reset
the imager.
A-18
MicroHAWK Engine Integration Guide
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement