MS 4 Imager User's Manual Ms4manual

2010-05-18

: Microscan Ms4Manual ms4manual bfd67ff5-e080-4103-8ffb-738df1f47de2 _att

Open the PDF directly: View PDF .
Page Count: 390 [warning: Documents this large are best viewed by clicking the View PDF Link!]

MS-4 Imager User’s Manual

MS-4 Imager

User’s Manual

P/N 83-000004 Rev E

ii MS-4 Imager User’s Manual

Microscan Systems, Inc.

ISO 9001 Certified

Issued by TüV USA

of allowing customers to operate and/or service Microscan manufactured equipment and is not to be

released, reproduced, or used for any other purpose without written permission of Microscan.

Throughout this manual, trademarked names might be used. Rather than place a trademark (™) symbol

at every occurrence of a trademarked name, we state herein that we are using the names only in an editorial

fashion, and to the benefit of the trademark owner, with no intention of infringement.

Disclaimer

The information and specifications described in this manual are subject to change without notice.

Latest Manual Version

For the latest version of this manual, see the Download Center on our web site at:

www.microscan.com.

Technical Support

For technical support, e-mail: helpdesk@microscan.com.

Warranty and Terms of Sale

For Standard Warranty information, see: www.microscan.com/warranty.

Microscan Systems, Inc.

Renton Headquarters

Tel: 425.226.5700 / 800.251.7711

Fax: 425.226.8250

Nashua Office

Tel: 603.598.8400

Fax: 603.577.5818

Microscan Europe

Tel: 011 31 172 423360

Fax: 011 31 172 423366

Microscan Asia Pacific

Tel: 65 6846 1214

Fax: 65 6846 4641

MS-4 Imager User’s Manual iii

Introduction

Table of Contents

Chapter 1 Quick Start

Step 1 Check Required Hardware........................................................... 1-2

Step 2 Connect the System.....................................................................1-3

Step 3 Position Imager and Symbol ........................................................ 1-4

Step 4 Install ESP.................................................................................... 1-5

Step 5 Select Model ................................................................................ 1-6

Step 6 Select Communications Protocol ................................................. 1-7

Step 7 Locate the Symbol in the FOV ..................................................... 1-8

Step 8 Calibrate Settings....................................................................... 1-10

Step 9 Test Read Rate ..........................................................................1-11

Step 10 Configure the Imager in ESP ................................................... 1-12

Step 11 Make Menu Changes and Save in ESP................................... 1-13

Chapter 2 Using ESP

EZ Mode ..................................................................................................2-2

Application Mode ..................................................................................... 2-3

Menu Toolbar .......................................................................................... 2-4

Connecting ........................................................................................... 2-12

View...................................................................................................... 2-13

Navigating in ESP................................................................................. 2-14

Send/Receive Options.......................................................................... 2-15

Using EZ Trax........................................................................................2-17

Chapter 3 Communications

Communications by ESP......................................................................... 3-2

Communications Serial Commands ........................................................ 3-3

Host Port Connections.............................................................................3-4

Host Port Protocol ...................................................................................3-5

ACK/NAK Options ................................................................................... 3-7

Polling Mode Options ..............................................................................3-8

RS-422 Status ......................................................................................... 3-9

Auxiliary Port Connections .................................................................... 3-10

Auxiliary Port System Data Status......................................................... 3-18

Daisy Chain Autoconfigure .................................................................... 3-19

Response Timeout ................................................................................ 3-20

LRC Status ............................................................................................3-21

Protocol Configuration Examples .......................................................... 3-22

USB HID Interface .................................................................................3-23

ASCII Character Entry Modifier ............................................................. 3-32

Preamble ............................................................................................... 3-33

Postamble.............................................................................................. 3-34

Chapter 4 Calibration

Calibration Serial Commands.................................................................. 4-2

iv MS-4 Imager User’s Manual

Table of Contents

Calibration Overview ............................................................................... 4-2

Calibration Options.................................................................................. 4-3

Calibration by ESP ................................................................................ 4-10

Initiating Calibration............................................................................... 4-12

Additional Notes about Calibration ........................................................ 4-17

Chapter 5 Read Cycle

Read Cycle by ESP................................................................................. 5-2

Read Cycle Serial Commands ................................................................ 5-3

Read Cycle Setup ................................................................................... 5-4

Multisymbol ............................................................................................. 5-5

Trigger Mode and Duration ..................................................................... 5-6

External Trigger Polarity ........................................................................ 5-11

Serial Trigger......................................................................................... 5-12

Start Trigger Character (Non-Delimited)................................................ 5-13

Stop Trigger Character (Non-Delimited)................................................ 5-13

End of Read Cycle ................................................................................ 5-14

Capture Mode........................................................................................ 5-16

Capture Timing...................................................................................... 5-20

Image Processing Timeout.................................................................... 5-22

Image Storage....................................................................................... 5-23

Minimum Good Reads........................................................................... 5-25

Setting Up the Imager for EZ Trax ........................................................ 5-26

Chapter 6 Symbologies

Symbologies by ESP............................................................................... 6-2

Symbologies Serial Commands .............................................................. 6-3

Data Matrix .............................................................................................. 6-4

QR Code ................................................................................................. 6-6

Code 39................................................................................................... 6-7

Code 128 / EAN 128 ............................................................................. 6-10

BC412 ................................................................................................... 6-13

Interleaved 2 of 5................................................................................... 6-14

Code 93................................................................................................. 6-17

Codabar................................................................................................. 6-18

UPC / EAN ............................................................................................ 6-21

GS1 DataBar (RSS) .............................................................................. 6-25

PDF417 ................................................................................................. 6-27

MicroPDF417 ........................................................................................ 6-29

Composite ............................................................................................. 6-30

Narrow Margins / Symbology Identifier.................................................. 6-31

Background Color.................................................................................. 6-33

Chapter 7 I/O Parameters

I/O Parameters by ESP ........................................................................... 7-2

I/O Parameters Serial Commands .......................................................... 7-3

Symbol Data Output ................................................................................ 7-4

MS-4 Imager User’s Manual v

Introduction

No Read Message...................................................................................7-6

Bad Symbol Message.............................................................................. 7-8

No Symbol Message ............................................................................... 7-8

1D / Stacked Symbology Qualification .................................................... 7-9

2D Symbology Qualification .................................................................. 7-10

Read Duration Output............................................................................ 7-16

Output Indicators ................................................................................... 7-17

Beeper ................................................................................................... 7-21

LED Configuration .................................................................................7-22

Serial Verification...................................................................................7-23

EZ Button............................................................................................... 7-25

EZ Button Modes................................................................................... 7-27

Configurable Output 1 ...........................................................................7-29

Trend Analysis Output 1 ........................................................................7-32

ISO/IEC 16022 Symbol Quality Output 1 .............................................. 7-35

Diagnostic Output 1 ............................................................................... 7-38

Configurable Output 2 ...........................................................................7-39

Trend Analysis Output 2 ........................................................................7-39

ISO/IEC 16022 Symbol Quality Output 2 .............................................. 7-39

Diagnostic Output 2 ............................................................................... 7-39

Configurable Output 3 ...........................................................................7-40

Trend Analysis Output 3 ........................................................................7-40

ISO/IEC 16022 Symbol Quality Output 3 .............................................. 7-40

Diagnostic Output 3 ............................................................................... 7-40

Power-On/Reset Counts........................................................................ 7-41

Time Since Reset ..................................................................................7-42

Service Message ................................................................................... 7-43

Frame Information ................................................................................. 7-44

Image Output.........................................................................................7-45

Database Identifier Output..................................................................... 7-48

Quality Output........................................................................................ 7-49

Configuring EZ Trax Output...................................................................7-50

Chapter 8 Symbol Quality

Symbol Quality Serial Commands........................................................... 8-2

Overview of Symbol Quality .................................................................... 8-3

Symbol Quality by ESP ........................................................................... 8-4

Symbol Quality Separator / Data Matrix Output Mode ............................ 8-8

ISO/IEC 16022 Symbol Quality Output ................................................. 8-10

ISO/IEC 16022 Symbol Quality Output by ESP .................................... 8-12

Microscan Symbol Quality Output ......................................................... 8-13

Microscan Symbol Quality Output by ESP ............................................ 8-16

Chapter 9 Matchcode

Matchcode by ESP .................................................................................. 9-2

Matchcode Serial Commands ................................................................. 9-2

vi MS-4 Imager User’s Manual

Table of Contents

Overview of Matchcode........................................................................... 9-3

Matchcode Type...................................................................................... 9-4

Match Replace ........................................................................................ 9-9

Mismatch Replace................................................................................. 9-10

New Master Pin ..................................................................................... 9-11

Chapter 10 Camera and IP Setup

Camera and IP Setup by ESP............................................................... 10-2

Camera and IP Setup Serial Commands .............................................. 10-3

Video ..................................................................................................... 10-4

Evaluation.............................................................................................. 10-5

Calibration ............................................................................................. 10-9

Window of Interest............................................................................... 10-10

Configuration Database....................................................................... 10-13

Dynamic Setup .................................................................................... 10-14

Pixel Sub-Sampling ............................................................................. 10-15

Camera................................................................................................ 10-16

Focal Distance..................................................................................... 10-18

Focal Distance Table (Read-Only) ...................................................... 10-19

IP Threshold ........................................................................................ 10-20

Number of Symbols in Field of View ................................................... 10-22

Image Processing Timeout.................................................................. 10-23

Damaged Symbol................................................................................ 10-24

IP Mode ............................................................................................... 10-25

Hollow Mode........................................................................................ 10-26

Mirrored Image .................................................................................... 10-27

Illumination Brightness ........................................................................ 10-28

Skew Correction .................................................................................. 10-29

Chapter 11 Configuration Database

Configuration Database Serial Commands ........................................... 11-2

Number of Active Indexes ..................................................................... 11-3

Configuration Database Status ............................................................. 11-4

Database Mode ..................................................................................... 11-9

Save Current Settings to Configuration Database .............................. 11-14

Load Current Settings from Configuration Database .......................... 11-15

Request Selected Index Settings ........................................................ 11-16

Request All Configuration Database Settings ..................................... 11-17

Chapter 12 Terminal

Terminal Window................................................................................... 12-2

Find ....................................................................................................... 12-3

Send ...................................................................................................... 12-4

Macros................................................................................................... 12-5

Terminal Window Menus....................................................................... 12-6

Chapter 13 Utilities

Serial Utility Commands ........................................................................ 13-2

MS-4 Imager User’s Manual vii

Introduction

Read Rate ............................................................................................. 13-4

Counters ................................................................................................ 13-5

Device Control .......................................................................................13-7

Master Database ................................................................................... 13-8

Firmware.............................................................................................. 13-14

Bar Code Configuration .......................................................................13-17

Default / Reset / Save..........................................................................13-18

Imager Status Requests ...................................................................... 13-20

Other Operational Serial Commands .................................................. 13-22

Chapter 14 Output Format

Output Format Serial Commands.......................................................... 14-2

Output Format Status ............................................................................14-3

Format Assign ....................................................................................... 14-4

Format Extract ....................................................................................... 14-5

Format Insert ......................................................................................... 14-7

Output Filter Configuration ....................................................................14-9

Ordered Output Filter........................................................................... 14-13

Appendices

Appendix A General Specifications .........................................................A-2

Appendix B Electrical Specifications .......................................................A-5

Appendix C Serial Configuration Commands ..........................................A-6

Appendix D Communications Protocol ..................................................A-12

Appendix E ASCII Table........................................................................A-21

Appendix F Interface Standards ............................................................A-22

Appendix G Object Detector..................................................................A-23

Appendix H Operational Tips.................................................................A-24

Appendix I USB-to-Serial Virtual COM Port Driver................................A-25

Appendix J Glossary of Terms ..............................................................A-28

Index

viii MS-4 Imager User’s Manual

About the MS-4 Imager

The key features of the MS-4 are:

• A multi-function EZ button for location, calibration, and symbol reading.

• A target pattern symbol locator that identifies the center point of the field of view.

• A green flash (visible from all angles) to signal a successful read.

• Ability to read both 2D and linear symbols.

• Ability to read difficult and damaged symbols.

• USB, RS-232, RS-422 connectivity options.

• Standard Density and Low Density options.

About This Manual

This manual provides complete information on setting up, installing, and configuring the

Imager. The chapters are presented in the order in which an Imager might be set up and

made ready for operation.

Highlighting

Commands are highlighted in rust bold. Cross-references and web links are highlighted

in blue bold. References to ESP, its toolbar headings (Communications, Read Cycle,

Symbologies, etc.), menu topics, and other points of emphasis, are highlighted in Bold

Initial Caps. References to topic headings within this manual or other documents are

enclosed in quotation marks.

Host Communications

There are four ways to configure and test the MS-4:

1. EZ button.

2. Microscan’s Windows-based ESP (Easy Setup Program), which offers point-and-click

ease of use and visual responses to user adjustments.

3. Serial commands, such as <K100,1>, that can be sent from ESP’s Terminal window

or another terminal program.

4. The tree control menus and graphic interfaces in ESP’s App Mode.

MS-4 Imager User’s Manual ix

Introduction

Warning and Caution Summary

• Viewing the MS-4’s LED output with optical instruments such as magnifiers, eye loupes,

or microscopes within a distance of 100 mm could cause serious eye injury.

• Maximum LED output: .564 mW.

• Wavelength: 470 nm; 525 nm; 617 nm.

• Location of the MS-4’s LED aperture window:

CAUTION: Use of controls or adjustments or performance of procedures other than those

specified herein may result in hazardous radiation exposure.

IMPORTANT: The MS-4 is intended for connection to a UL-listed direct plug-in power unit

marked Class II and rated 5 VDC at 3 Watts, or greater if using electrical accessories.

European models must use a similarly rated Class I or Class II power supply that is certified

to comply with standard for safety EN 60950.

WARNING

LED LIGHT

DO NOT VIEW DIRECTLY WITH OPTICAL INSTRUMENTS

CLASS 1 LED PRODUCT

LED Output: .564 mW. Wavelength: 470 nm; 525 nm; 617 nm.

IEC 60825-1:1993+A1:1997+A2:2001

LED Aperture Window

xMS-4 Imager User’s Manual

Statement of Agency Compliance

The MS-4 Imager has been tested for compliance with FCC (Federal Communications

Commission) regulations and has been found to conform to all applicable FCC Rules and

Regulations.

To comply with FCC RF exposure compliance requirements, this device must not be co-located

or operate in conjunction with any other antenna or transmitter.

Changes or modifications not expressly approved by the party responsible for compliance

could void the user’s authority to operate the equipment.

The MS-4 Imager has been tested for compliance with CE (Conformité Européenne)

standards and guidelines, and has been found to conform to applicable CE standards,

specifically

the EMC requirements

EN 55024, ESD EN 61000-4-2, Radiated RF Immunity

EN 61000-4-3, ENV 50204, EFT EN

61000-4-4, Conducted RF Immunity EN 61000-4-6, EN

55022, Class B Radiated Emissions

, and Class B Conducted Emissions.

The MS-4 Imager has been tested by an independent electromagnetic compatibility laboratory

in accordance with the applicable specifications and instructions.

MS-4 Imager User’s Manual xi

Introduction

Statement of RoHS Compliance

All Microscan readers with a ‘G’ suffix in the FIS number are RoHS-Compliant. All compliant

readers were converted prior to March 1, 2007. All standard accessories in the Microscan

Product Pricing Catalog are RoHS-Compliant except 20-500013-01 and 98-000039-02.

These products meet all the requirements of the European Parliament and the Council of

the European Union for RoHS compliance. In accordance with the latest requirements, our

RoHS-compliant products and packaging do not contain intentionally added Deca-BDE,

Perfluorooctanes (PFOS) or Perfluorooctanoic Acid (PFOA) compounds above the maximum

trace levels. To view the documents stating these requirements, please visit:

http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=CELEX:32002L0095:EN:HTML

and

http://eur-lex.europa.eu/LexUriServ/LexUriServ.do?uri=OJ:L:2006:372:0032:0034:EN:PDF

Please contact your sales manager for a complete list of Microscan’s RoHS-Compliant products.

This declaration is based upon information obtained from sources which Microscan believes to be reliable, and

from random sample testing; however, the information is provided without any representation of warranty,

expressed or implied, regarding accuracy or correctness. Microscan does not specifically run any analysis on our

raw materials or end product to measure for these substances.

The information provided in this certification notice is correct to the best of Microscan’s knowledge at the date of

publication. This notice is not to be considered a warranty or quality specification. Users are responsible for

determining the applicability of any RoHS legislation or regulations based on their individual use of the product.

xii MS-4 Imager User’s Manual

Statement of RoHS Compliance

MS-4 Imager User’s Manual 1-1

1 Quick Start

Contents

This section is designed to get your MS-4 Imager up and running quickly, using the EZ

button or ESP (Easy Setup Program). Following these steps will allow you to get a sense

of the Imager’s capabilities and to test sample symbols.

Detailed setup information for installing the Imager into your actual application can be

found in the subsequent chapters.

Step 1 Check Required Hardware ................................................................................................1-2

Step 2 Connect the System ..........................................................................................................1-3

Step 3 Position Imager and Symbol..............................................................................................1-4

Step 4 Install ESP.........................................................................................................................1-5

Step 5 Select Model......................................................................................................................1-6

Step 6 Select Communications Protocol.......................................................................................1-7

Step 7 Locate the Symbol in the FOV...........................................................................................1-8

Step 8 Calibrate Settings ........................................................................................................... 1-10

Step 9 Test Read Rate .............................................................................................................. 1-11

Step 10 Configure the Imager in ESP........................................................................................ 1-12

Step 11 Make Menu Changes and Save in ESP....................................................................... 1-13

1-2 MS-4 Imager User’s Manual

Check Required Hardware

Step 1 — Check Required Hardware

Item Description Part Number

1MS-4 Imager FIS-0004-XXXXG

2IB-3PC FIS-0001-0030G

3Power Supply

97-000002-01 (90-264 VAC, +5VDC)

97-100004-15 (24VDC)

4Comm. Cable 61-000010-02

To additional imagers

or terminating resistor

To host

Hardware Required (RS-232 / RS-422)

Caution: Be sure that all cables are connected BEFORE applying power to a

system with an external power source (RS-232 / RS-422). Always power down

BEFORE disconnecting any cables.

Hardware Required (USB)

MS-4 Imager User’s Manual 1-3

Quick Start

Step 2 — Connect the System

Connecting by RS-232 / RS-422

• Connect the Imager (1) to the IB-3PC interface (2).

• Connect the comm. cable (

) to the host (

) and to the host connector on the IB-3PC (

• Connect power supply (3) to the IB-3PC (2).

• Apply power to the Imager.

Connecting by USB

• Plug the MS-4 Imager’s USB cable into a host USB port. The host will power the Imager.

Hardware Configuration

(RS-232 / RS-422) Hardware Configuration

(USB)

Caution: Be sure that all cables are connected BEFORE applying power to a

system with an external power source (RS-232 / RS-422). Always power down

BEFORE disconnecting any cables.

To additional imagers

or terminating resistor

To host

1-4 MS-4 Imager User’s Manual

Position Imager and Symbol

Step 3 — Position Imager and Symbol

• Position the Imager at a distance from the symbol that matches the factory pre-set focal

distance. For example, if your MS-4 is pre-set at 4”, position the Imager’s parting line 4”

from the symbol.

• Tip the Imager relative to the symbol to avoid the glare of direct (specular) reflection. The

case parting line should be perpendicular to the plane of the symbol by either pitching the

symbol or the Imager as shown.

• Position the Imager in a place with as little ambient light as possible.

• Symbols can be rotated (tilted) at any angle; however, for best results symbols should

be aligned with the FOV (field of view).

• In the case of linear symbols, aligning the bars in the direction of their movement (“ladder”

orientation) will minimize the chances of blurring, and will produce better reads.

• Avoid excessive skew or pitch. Maximum skew is ±30°; maximum pitch is ±30°.

Note: For instant setup and validation, the MS-4 can be hand-held or placed on its side.

For accuracy, however, Microscan’s mounting arm adapter kits (P/N 98-000048-01) are

recommended.

±30°

Imager Position Relative to Symbol

MS-4 Imager User’s Manual 1-5

Quick Start

Step 4 — Install ESP

Easy Setup Program (ESP) is Microscan’s proprietary setup and testing application. The

purpose of

ESP

is to provide a quick and easy way to set up and configure Microscan readers.

When the MS-4 is connected to a host computer (Windows Vista, XP, or 2000), ESP can

be used to configure reader settings and to set up communications between the reader

and host.

If installing from the Microscan Tools CD:

1. Insert the Microscan Tools CD in your computer’s CD drive.

2. Select ESP Software from the navigation bar at the left of the screen.

3. Click on ESP Software under the Current Version heading.

4. Click the Run button and follow the prompts in the ESP Setup Wizard.

Note: During installation, you may see an Internet Explorer Security Warning that

states: “The publisher could not be verified.” If you see this warning, click Run to

continue installation.

If downloading from the web:

1. Go to the Download Center at www.microscan.com.

2. Create a new member account or, if you are already a member, enter your user name

and password.

3. Navigate to the “Microscan Software” section of the Download Center (near the top of

the page).

4. Click on the link showing the latest version of ESP. Extract the ESP installation files to

a location of your choice on the host computer. Note where your ESP.exe file is stored

on your hard drive.

5. At the end of the installation process, the following icon will appear on your desktop:

6. Click the ESP icon to start the program.

System Requirements for ESP

• 166 MHz Pentium processor (recommended)

• Windows Vista, XP, or 2000 operating system

• Internet Explorer 5.0 or higher

• 64 MB minimum RAM

• 40 MB minimum disk space

• 800 x 600 pixel minimum 256 color display

1-6 MS-4 Imager User’s Manual

Select Model

Step 5 — Select Model

When you start ESP, the following menu will appear:

1. Click the MS-4 button and then click OK. If you do not want to make this selection

every time you start ESP, uncheck “Show this window at Startup”.

2. Select the default reader name (MS-4-1), or type a name of your choice in the

Description text field and click OK.

3. Click Yes when this dialog appears:

Note: If you need to select another reader model later, click the Switch Model button

near the top of the screen.

MS-4 Imager User’s Manual 1-7

Quick Start

Step 6 —Select Communications Protocol

Important: The Imager is in Continuous Read Mode by default. For best connection

results, be sure that no symbols are within the Imager’s field of view while attempting to

connect.

• When the

Select Protocol

dialog appears, choose your connection protocol and click

• If you are using an RS-232 interface and your connection attempt fails, click the

Autoconnect

button, select a different communications port, and try again.

When you are connected, you will see the green connection indicator in the status bar

at the bottom right of your screen.

If you choose USB protocol:

If you choose RS-232 protocol:

USB:

RS-232:

• Select the

MS-4

from

the

Select

Device

and click

Finish

• Click Connect.

Note: If your RS-232 host

settings cannot be

changed to match the

Imager’s settings, check

the Force Connect box.

1-8 MS-4 Imager User’s Manual

Locate the Symbol in the FOV

Step 7 — Locate the Symbol in the FOV

• Move the symbol or the Imager so that the blue target pattern is centered over the symbol.

At 2 to 3 inches, the pattern resembles an X. At 3 to 6 inches, the pattern resembles a V.

It is important for the whole symbol to fall within the field of view (FOV) of the Imager.

The field of view is what appears in ESP’s Locate/Calibrate window.

Locate by EZ Button

If you are not connected to a host computer, the EZ button will allow you to locate a symbol

in the Imager’s FOV.

• Hold down the

button for about one second and release when you hear one short beep.

The amber

20%

LED will turn on, and you will see the blue target

pattern projected from the

front of the Imager.

• Center the target pattern on the symbol.

Note: To end all EZ button functions, press the EZ button once and quickly release.

Center on object

in field of view.

Target pattern shown as it would appear between 3 and 6 inches.

MS-4 Imager User’s Manual 1-9

Quick Start

Locate by ESP

•In ESP’s EZ Mode, click the Locate button to enable the target pattern.

You will see the blue target pattern projected from the front of the Imager.

• Center the target pattern over the symbol you wish to read.

• Click the Stop button to end the Locate function.

Center on object

in field of view.

Target pattern shown as it would appear between 3 and 6 inches.

1-10 MS-4 Imager User’s Manual

Calibrate Settings

Step 8 — Calibrate Settings

MS-4 image settings can be adjusted automatically for optimum readability by either the

EZ button or by ESP.

During the calibration routine, the reader will flash its amber read rate percent LEDs and

red illumination LEDs while searching through various focus and camera settings and

determining the best configuration for decoding symbol data. Upon successful completion

of this routine, a green LED pattern will flash brightly and illuminate the symbol. If unsuccessful

the Imager will emit 5 short beeps and stop searching.

Calibrate by EZ Button

1. Hold down the EZ button about two seconds and release when you hear two short

beeps. The 20% and 40% LEDs will illuminate.

2. The Imager will search through various camera and IP settings to determine

the best

configuration for decoding symbol data

Important: The object must be centered in the field of view for the calibration process

to be successful.

Note: To end all EZ button functions, press the EZ button once and quickly release.

Calibrate by ESP

1. Click the Calibrate button.

2. The Imager will search through various camera and IP 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’s

data and related features will be presented under the “Symbol Information” box below

the image display window.

Calibrate by Serial Command

Send <@CAL> to begin calibration.

MS-4 Imager User’s Manual 1-11

Quick Start

Step 9 — Test Read Rate

This test will let you know the percent of good reads per image captures the Imager is

producing.

Testing by EZ Button

1. To start the read rate test, hold down the EZ setup button about three seconds until you

hear three short beeps. The 20%, 40%, and 60% LEDs will illuminate.

While the symbol is being decoded, the read rate LEDs will indicate the correspond-

ing read rate percentage on the back of the unit.

2. To end the read rate test, press the EZ button and quickly release.

Testing by ESP

1. Click the Test button to start the read rate test and Stop to end it.

If your symbol has been successfully decoded, its data and related features will be

presented under “Symbol Information.” Also, while the symbol is being decoded, 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.

Testing by Serial Command

You can also start a test with the <C> or <Cp> command and end it with the <J> command.

1-12 MS-4 Imager User’s Manual

Configure the Imager in ESP

Step 10 — Configure the Imager in ESP

To make setup changes to the MS-4, click the App Mode button.

The following modes are accessible by clicking the buttons in the first row of App Mode

icons:

• Establish communications between

ESP

and the Imager by clicking the

Autoconnect

button.

• Send or receive commands by clicking the Send/Recv button.

• Make changes to Camera options by clicking the Camera button.

• Access the Terminal window, where you can see symbol data and enter serial commands,

by clicking the Terminal button.

• Review status settings or make changes to operational commands by clicking the Utilities

button.

• Format data for output by clicking the Output Format button.

Click the Configuration button to display the second row of ESP icons.

From here you can make changes in the configuration trees that can be accessed by clicking

the buttons on the second row of icons in the

ESP

window.

For further details, see ESP Help in the pulldown Help menu.

MS-4 Imager User’s Manual 1-13

Quick Start

Step 11 — Make Menu Changes and Save in ESP

To make changes to a configuration setting:

Saving Options

•Send, No Save. Changes will be lost when power is re-applied to the Imager.

•Send and Save. This activates all changes in current memory and saves to the Imager

for power-on.

1. 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.

5. Right click on the open

screen and select Save to

Reader to implement the

command in the Imager.

4. Left click again on the

open screen to complete

your selection.

3. Place your cursor in the

selection box, scroll down

to the setting you want to

change, and click once on

the setting.

1-14 MS-4 Imager User’s Manual

Make Menu Changes and Save in ESP

MS-4 Imager User’s Manual 2-1

2 Using ESP

Contents

This section is designed to help you understand the structure, elements, and application of

ESP (Easy Setup Program).

When you open ESP, unless otherwise specified in the ESP Preferences dialog accessible

from the Options heading on the menu toolbar, you will enter EZ Mode for initial setup.

From there, you can enter Application Mode (App Mode) and access several configuration

menus (Communications, Read Cycle, Symbologies, I/O Parameters, Symbol Quality,

Matchcode, and Diagnostics), a Camera setup interface, a Terminal interface, a Utilities

interface, and an Output Format interface.

ESP can be used to configure the MS-4 Imager in four different ways.

•

Control Trees:

Each configuration menu contains a list of all option settings that pertain to that

specific element of Imager operation. For example, the

Communications

menu shows a

Host Port Connections

option, and then a list of the sub-options

Baud Rate

Parity

Stop

Bits

, and

Data Bits

. Each of these sub-options is configurable by using dropdown menus.

•Graphic User Interfaces: Imager settings can be configured using such point-and-click

tools as radio buttons, zoom in/zoom out sliders, spin boxes, check boxes, and drag-

and-drop functions.

•Terminal: ESP’s Terminal interface allows you to send serial configuration and utility

commands directly to the Imager by typing them in the provided text field.

•Symbol Configuration: The Imager can be configured by reading symbols produced in

ESP’s Bar Code Dialog interface. Symbols can be created by dragging and dropping

configuration settings from the control trees to the Bar Code Value field in the Bar Code

Dialog, and then printing the new symbol.

For ESP system requirements, see Chapter 1, Quick Start.

EZ Mode........................................................................................................................................2-2

Application Mode...........................................................................................................................2-3

Menu Toolbar................................................................................................................................2-4

Connecting..................................................................................................................................2-12

View ............................................................................................................................................2-13

Navigating in ESP .......................................................................................................................2-14

Send/Receive Options ................................................................................................................2-15

Using EZ Trax .............................................................................................................................2-17

2-2 MS-4 Imager User’s Manual

EZ Mode

you are presented with the

Locate

Calibrate

, and

Test

options. After connecting

to your Imager,

EZ Mode

is the screen you will see. You will be provided with on-screen

instructions that will help you with positioning, testing, and calibration.

Test

Click the Test button to start the read rate test for a quick indication of the Imager’s read

capabilities and the limits of your application. When Decodes per Second is unchecked,

the test will count the percentage of decodes relative to the number of actual scans. Click

Stop to end the test.

Calibrate

The calibration routine that will optimize the Imager by comparing read rates at various

camera and image processing settings.

Click Calibrate to begin the initial

calibration routine. Calbration is

explained at the left of the EZ Mode

screen, and also in the “Quick Start”

chapter of this manual.

Enter App Mode to

access configuration

trees and other setup

features.

Click Locate to activate the MS-4’s blue target pattern

LEDs. Center the target pattern on the symbol. The real-time

display shows you where the symbol is located in the

Imager’s field of view.

Starts read rate test.

Ends read rate test.

Click here to change

from percentage of

good decodes to

decodes per second

while performing a

read rate test.

MS-4 Imager User’s Manual 2-3

Using ESP

Application Mode

From EZ Mode, you can click on the App Mode button to access specific configuration

menus, Utilities tools, Camera setup, Output Format options, and a Terminal window

where serial commands can be entered.

Note: The App Mode and EZ Mode buttons appear in the same position to allow easy

switching between these primary modes.

Note: For specific information on any of the icons shown above in the operations bar or

configuration bar, see the corresponding chapters in this manual.

Decoded symbol data

is shown in this table.

Click Capture and Decode to

read the symbol in the field of

view, and to see a high resolution

image capture of the symbol.

Click on icons in this row to

access configuration trees

like the one shown here.

Click the Configuration icon to return to full

App Mode view from Camera, Terminal,

Utilities, or Output Format.

Click here for

Ordered Output

and Output Format

features.

Click here to open

the Terminal view.

Camera Setup, advanced

Calibration, Configuration

Database.

Menu toolbar.

Click this icon to

return to EZ Mode.

2-4 MS-4 Imager User’s Manual

Menu Toolbar

File > New

Whenever New is selected, the default configuration of ESP is

loaded.

Open/Save

When Save or Save As is selected, the ESP configuration is

saved to the host computer’s hard drive and available whenever

the same file is selected under Open.

Important: When you save menu changes to your hard drive,

these changes are not saved to your Imager. The illustration

below shows how settings can be saved and received between

ESP and the Imager, and ESP and the host hard drive.

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.

(Save to Imager)

(Receive Imager

Settings)

MS-4 Imager User’s Manual 2-5

Using ESP

Model

In Model you can select any of the models shown in ESP’s model

menu. When you choose another model, your current connection to

your present model will be terminated.

To connect to another model, select New Model, choose a new

model from the menu, and click OK.

Note: All the models you have enabled by selecting will continue to appear in the Model

menu and that the same menu is repeated when clicking the Switch Model icon.

When you save your ESP file, you will be saving the settings of all the models defined in a

single ESP file.

2-6 MS-4 Imager User’s Manual

Menu Toolbar

Options

The Options menu allows you to save memos and set up ESP

Preferences.

Note: Preferences will be saved and loaded into ESP when

ESP is opened next, whether or not you save the ESP file.

Preferences

General Tab

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.

Skip EZ Mode

At startup, skips EZ Mode and opens directly in App Mode.

Show Connect Prompt

At startup, displays the Would you like to connect...? prompt.

Receive After Connect

At startup, loads the Imager’s settings into ESP. (This is not recommended if you want to

preserve your ESP settings for future use.)

Enable Send and Save as Customer Defaults

At startup, enables the Send and Save as Customer Defaults option in the Send/Recv

command.

MS-4 Imager User’s Manual 2-7

Using ESP

Terminal Tab

When Show Non-Printable Characters is checked, 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

In this dialog you can first select the function key and then enter your macro keystrokes in the

associated key map. For example, to make

Ctrl-F5

the keystroke to enable, send a trigger

character, select

, and then in the

Ctrl

row, enter

and click

. Then

whenever the

Ctrl-F5

keystroke is pressed, the trigger character will start the read cycle.

Change Font

Allows you to modify the font used for decode data received from the Imager on the

Terminal

screen.

Change Echo Font

Allows you to modify the font used for command characters typed into the Terminal view.

Toolbar Style

Displays user-selected toolbar buttons as icons, text only, or both (default).

2-8 MS-4 Imager User’s Manual

Menu Toolbar

Bar Code Options Tab

The Bar Code Options dialog allows you to set the size (in mils) of user-created symbols.

Sizing Information

Sets the bar width (in thousands of an inch) of user-created symbols. A bar width of 14 is

0.014 inches.

MS-4 Imager User’s Manual 2-9

Using ESP

Grade Report Options Tab

Overall Grade Based On

Allows you to choose which symbol characteristics will be considered in generating a

symbol quality grade.

Use Number Grades

Allows you to switch from the default letter grades to number grades in symbol quality

report output.

Show Report Options during ‘Generate Report’

Sets the symbol quality report output to show the complete array of report options.

Include Image

Sets the symbol quality report output to include a captured image of the symbol being

analyzed. Bitmap and JPEG image formats are both available. Bitmap images, although

higher resolution, have larger file sizes and take longer to load.

2-10 MS-4 Imager User’s Manual

Menu Toolbar

Advanced Tab

The Auto Sync dialog at the top of the Advanced tab allows you to determine whether

Auto Sync will be automatically enabled in sections of ESP where it is used, or if it will ask

you before it enables Auto Sync functions.

Always Ask Before Auto Sync Occurs

If you check this option box, you are then able to determine what specific Auto Sync

functions will be enabled. Receive Settings from the Reader will automatically send

the Imager’s settings to ESP when Auto Sync is enabled. Send ESP Settings to the

Reader will automatically send all Imager configuration settings chosen in ESP to the

Imager. Do Not Send or Receive Settings creates a condition in which Auto Sync will

not send Imager settings to ESP, or send ESP settings to the Imager.

Show Targeting Pattern During Calibrate and Locate

Allows you to determine whether the blue LED target pattern will be on or off during the

Locate and Calibrate routines.

Send XON with Autoconnect

Sends an

XON

(

Begin Transmission

) command to the Imager before starting the

Autoconnect

routine.

MS-4 Imager User’s Manual 2-11

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.

2-12 MS-4 Imager User’s Manual

Connecting

When you open ESP and the Select Protocol dialog appears, choose either RS-232 or

USB protocol and click Next.

Important: If you are using an RS-232 interface and your connection attempt fails, click

the Autoconnect button, select a different communications port, and try again.

When you are connected, you will see the green connection indicator in the status bar

at the bottom right of your screen.

Click Connect.

If you choose USB protocol:

If you choose RS-232 protocol:

USB:

RS-232:

Select the

MS-4

from the Select

Device menu and

click Finish.

The MS-4 Imager’s default trigger mode is

Continuous Read Mode

. The USB version of the MS-4 will

be in a keyboard wedge configuration, causing

ESP

to receive incoming symbol data as keyboard text.

This will interfere with the connection attempt and cause it to fail. Be sure that no symbols are within

the Imager’s field of view while connecting to

ESP

Note: If your RS-232 host

settings cannot be

changed to match the

Imager’s settings, check

the Force Connect box.

MS-4 Imager User’s Manual 2-13

Using ESP

View

The View menu allows you to move quickly between interfaces

without using the icon buttons on the App Mode toolbar. It also

allows you to access the Bar Code Dialog.

Bar Code Dialog

In the

Bar Code Dialog

you can create symbols by typing the text you

wish to encode. This is a useful tool for creating configuration symbols,

allowing you to configure your reader by reading the symbols you create.

Choose a spatial

orientation for the

new symbol.

Set a human-

readable caption

for the symbol

that matches the

encoded data, or

write your own

caption.

The symbol you create

will be displayed in the

field at the bottom of the

Bar Code Dialog.

Drag specific configuration

values from the control tree

directly into this field to

encode new symbols.

2-14 MS-4 Imager User’s Manual

Navigating in ESP

To change Imager settings, or to access the Utilities, Camera, Terminal, or Output Format

views, click the App Mode button.

To return to EZ Mode, click the EZ Mode button.

To make changes to configuration settings in the control trees:

1. Left click on the + to expand

menu items.

2. Double click the desired

parameter and single click

in the selection box to view

options.

3. Place your cursor in the

selection box, scroll down

to the setting you want to

change, and single click

the setting.

4. Left click again on the open screen to complete the

selection.

5. Right click on the open screen and select Save to

Reader to implement the command in the Imager.

You can send the command without saving it, or you

can send and save the command simultaneously.

The X denotes the

default option setting.

MS-4 Imager User’s Manual 2-15

Using ESP

Send/Receive Options

To access Receive, Save and Default options, click the Send/Recv

button. You can also access these options by right-clicking in any of the

configuration views.

Receiving

From the Send/Recv menu, select Receive Reader Settings.

Caution: Do not select this option if you do not want to upload the Imager’s settings. For

example, if your ESP file has a number of custom settings that you want to maintain and

download into the Imager, these settings would be lost by choosing Yes.

This is useful if you want to receive (upload) the Imager’s settings and save them as a file

for future use. For example, if your Imager has settings that you do not want to change,

choosing Yes would allow you to load those settings to ESP and save them in an ESP file

for later retrieval.

Receiving the Imager’s settings will also assure that you will not be subsequently saving

any unwanted changes that you or someone else has made previously in ESP.

Saving

1. Send, No Save

(<A>)

This saves ESP

settings to current

memory.

2. Send and Save

(<Z>)

This activates all changes in current memory and saves to the Imager for power-on.

3. Send and Save as Customer Defaults

(<Zc>)

Use this option to save your own default settings for quick retrieval with a <Zrc>

command.

This option will be visible only if you had checked

Enable ‘Send and Save as Customer

Defaults’ in the ESP Preferences dialog.

2-16 MS-4 Imager User’s Manual

Send/Receive Options

Defaulting

When you select Default Current Menu Settings or Default all ESP Settings, you are

only defaulting the ESP settings.

Advanced Options

Send Current View

This is the same as

Save to

Reader

Send No Save

except

that only the commands in the

current configuration tree are sent.

Send Current Command

This is the same as

Send Current

View

, except that it saves only

the command that is currently

selected.

Add / Remove Exception

After you perform a

Receive Reader Settings

command

and you click on the

Add Exception

option, you may see a list of serial commands. These are commands that may be in your

Imager’s firmware, but not included in, or different from, your current version of

ESP

You can edit these commands by double-clicking on them and changing them as needed.

It is important to note that these commands will be saved to your Imager whenever you

send a Save to Reader command, or an <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 from within the configuration trees.

MS-4 Imager User’s Manual 2-17

Using ESP

Using EZ Trax

For detailed information about using EZ Trax, refer to the Help menu in EZ Trax software,

or the EZ Trax Quick Start Guide, available on the Microscan Tools CD.

For information about how to configure the MS-4 for use with EZ Trax, see Setting Up the

Imager for EZ Trax in Chapter 5, Read Cycle.

2-18 MS-4 Imager User’s Manual

Using EZ Trax

MS-4 Imager User’s Manual 3-1

3 Communications

Contents

This section explains how to set up communications between the Imager and a host.

With Microscan’s ESP (Easy Setup Program), configuration changes can be made in the

ESP menus and then sent and saved to your Imager. The user can also send serial

commands to the Imager via ESP’s Terminal window.

Communications by ESP..............................................................................................................3-2

Communications Serial Commands..............................................................................................3-3

Host Port Connections..................................................................................................................3-4

Host Port Protocol.........................................................................................................................3-5

ACK/NAK Options.........................................................................................................................3-7

Polling Mode Options....................................................................................................................3-8

RS-422 Status...............................................................................................................................3-9

Auxiliary Port Connections..........................................................................................................3-10

Auxiliary Port System Data Status..............................................................................................3-18

Daisy Chain Autoconfigure .........................................................................................................3-19

Response Timeout......................................................................................................................3-20

LRC Status..................................................................................................................................3-21

Protocol Configuration Examples................................................................................................3-22

USB HID Interface ......................................................................................................................3-23

ASCII Character Entry Modifier...................................................................................................3-32

Preamble.....................................................................................................................................3-33

Postamble...................................................................................................................................3-34

3-2 MS-4 Imager User’s Manual

Communications by ESP

To open nested

options, single click

the +.

Click this button

to bring up the

Applications

menu.

Click this button

to bring up the

Communication

menu.

To change a setting,

double click the

setting and use your

cursor to scroll

through the options.

MS-4 Imager User’s Manual 3-3

Communications

Communications Serial Commands

Host Port Connections <K100,baud rate,parity,stop bits,data bits>

Auxiliary Port Connections <K101,aux port mode,baud rate,parity,stop bits,data

bits,daisy chain ID status,daisy chain ID>

RS-422 Status <K102,status>

Host Port Protocol <K140,protocol,address>

Preamble <K141,status,preamble characters>

Postamble <K142,status,postamble characters>

Response Timeout <K143,response timeout>

LRC <K145,status>

Auxiliary Port System Data Status <K146,aux port system data status>

ACK/NAK Options <K147,RES,REQ,STX,ETX,ACK,NAK>

Polling Mode Options <K148,RES,REQ,STX,ETX,ACK,NAK>

USB HID Reports <K149,Microscan HID IN Report status,Keyboard IN

Report status>

Autoconfiguration Daisy Chain <K150DAISY>

3-4 MS-4 Imager User’s Manual

Host Port Connections

The host port can be configured with RS-232 and RS-422 connections.

The following settings define the basic transmission speeds and digital standards that

ensure common formatting.

Baud Rate, Host Port

Parity, Host Port

Stop Bits, Host Port

Data Bits, Host Port

Note: See USB HID Interface on page 3-23 for protocol information relating to USB.

Usage: Can be used to transfer data faster or to match host port settings.

Definition: The rate at which the reader and host transfer data back and forth.

Serial Cmd: <K100,baud rate,parity,stop bits,data bits>

Default: 115.2K

Options: 0 = 600 1 = 1200 2 = 2400

3 = 4800 4 = 9600 5 = 19.2K

6 = 38.4K 7 = 57.6K 8 = 115.2K

9 = 230K

Usage: Only changed if necessary to match host setting.

Definition: 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.

Serial Cmd: <K100,baud rate,parity,stop bits,data bits>

Default: None

Options: 0 = None 1 = Even 2 = Odd

Usage: Only changed if necessary to match host setting.

Definition: One or two bits added to the end of each character to indicate the end of

the character.

Serial Cmd: <K100,baud rate,parity,stop bits,data bits>

Default: One

Options: 0 = One 1 = Two

Usage: Only changed if necessary to match host setting.

Definition: One or two bits added to the end of each character to indicate the end of

the character.

Serial Cmd: <K100,baud rate,parity,stop bits,data bits>

Default: Eight

Options: 0 = Seven 1 = Eight

MS-4 Imager User’s Manual 3-5

Communications

Host Port Protocol

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 Status (Longitudinal Redundancy Check).

Point-to-Point (Standard)

Point-to-Point with RTS/CTS

Point-to-Point with XON/XOFF

Usage:

In general, the point-to-point protocols will work well in most applications. They

require no address and use RS-232 or RS-422 communications standards.

Definition: Protocols define the sequence and format in which information is transferred

between the reader and the host, or in the case of Multidrop, between the

readers and a concentrator.

Serial Cmd: <K140,protocol,address>

Default: Point-to-Point

Options: 0 = Point-to-Point

1 = Point-to-Point with RTS/CTS

2 = Point-to-Point with XON/XOFF

3 = Point-to-Point with RTS/CTS and XON/XOFF

4 = ACK/NAK

5 = Polling Mode

Usage: Used only with RS-232 or RS-422.

Definition: 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.

Serial Cmd: <K140,0>

Usage: A reader initiates a data transfer with an RTS (request-to-send) transmission.

The host, when ready, responds with a CTS (clear-to-send) and the data is

transmitted. RTS and CTS signals are transmitted over two dedicated wires

as defined in the RS-232 standard. Used only with RS-232.

Definition: Point-to-Point with RTS/CTS (request-to-send/clear-to-send) is a simple

hardware handshake protocol that allows a reader to initiate data transfers

to the host.

Serial Cmd: <K140,1>

Usage:

If an XOFF has been received from the host, data will not be sent to the host

until the host sends an XON. During the XOFF phase, the host is free to carry

on other chores and accept data from other devices.Used only with RS-232.

Definition: This option enables the host to send the XON and XOFF command as a

single byte transmission command of start (^Q) or stop (^S).

Serial Cmd: <K140,2>

3-6 MS-4 Imager User’s Manual

Host Port Protocol

Point-to-Point with RTS/CTS and XON/XOFF

ACK/NAK

Polling Mode

Poll Address

Note: See USB HID Interface on page 3-23 for protocol information relating to USB.

Usage: Used only with RS-232.

Definition: This option is a combination of Point-to-Point with RTS/CTS and Point-

to-Point with XON/XOFF.

Serial Cmd: <K140,3>

Definition: See the ACK / NAK Options command <K147> on page 3-7.

Serial Cmd: <K140,4>

Definition: See the Polling Mode Options command <K148> on page 3-8.

Serial Cmd: <K140,5>

Serial Cmd: <K140,protocol,address>

Default: 1

Options: 1 to 50

1 = Poll address 0x1C, Select address 0x1D

2 = Poll address 0x1E, Select address 0x1F

...

50 = Poll address 0x7E, Select address 0x7F

MS-4 Imager User’s Manual 3-7

Communications

ACK / NAK Options

RES-NAK Defaults

The following are general outlines of the ACK/NAK protocol. Items that are framed by

brackets ( [ ] ) can either be disabled or enabled. LRC does not include STX, but it does

include preamble, postamble, and ETX.

Symbol Data Output

TX to host: [STX] [preamble] SYMBOL DATA [postamble] [ETX] [LRC]

Response from host: ACK/NAK. Sent when LRC, ETX, postamble, or timeout (waiting

for more data) are detected (if REQ is disabled) depending on what is enabled.

Commands from Host to Imager

TX to Imager: [STX] <command> [ETX] [LRC]

Response from Imager: ACK/NAK. Sent when LRC, ETX, or command-ending angle

bracket ‘>’ are received, depending on what is enabled.

Command Response from Imager to Host

TX to host: [STX] [preamble] COMMAND RESPONSE DATA [postamble] [ETX] [LRC]

Response from host: ACK/NAK. Sent when LRC, ETX, postamble, command-ending

angle bracket ‘>’, or timeout (waiting for more data) are detected, depending on what is

enabled.

As with Polling Mode <K140,5>, the Imager can optionally perform the REQ and RES

event sequences in ACK/NAK mode. If the sender does not receive an ACK or NAK, it will

send REQ to request such a response (if enabled). When the sender receives an ACK, too

many NAKs, or times out (if already enabled), it will send a RES (if enabled) to terminate the

transaction.

Note:

See

ACK / NAK Data Flow Examples

in Appendix D for sample ACK/NAK communications

scenarios.

Note: See USB HID Interface on page 3-23 for protocol information relating to USB.

Definition:

These parameters take effect for

ACK/NAK

<K140,4>

on the main RS-232 or

RS-422 ports (not on the Auxiliary Port), and are completely independent of

the

Polling Mode Options

<K148>

The Imager always follows the protocol in both directions (to and from the

host). There is no option to disable it from either direction.

Serial Cmd: <K147,RES,REQ,STX,ETX,ACK,NAK>

RES: (Reset) 00 (disabled)

REQ: (Request) 00 (disabled)

STX: (Start of Text) 00 (disabled)

ETX: (End of Text) 00 (disabled)

ACK: (Acknowledge) 06

NAK: (Negative Acknowledge) 15

3-8 MS-4 Imager User’s Manual

Polling Mode Options

RES-NAK Defaults

Note: See Polling Mode Data Flow Examples in Appendix D for sample Polling Mode

communications scenarios.

Note: See USB HID Interface on page 3-23 for protocol information relating to USB.

Definition: These parameters only take effect for Polling Mode <K140,5> on the main

RS-232 or RS-422 ports (not on the Auxiliary 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 on page 3-6).

To enable multidrop protocol, the RS422 port must be enabled, <K102,1>,

in order to turn the transmitter on and off. If RS-232 is enabled instead of

RS422, <K102,0>, then Polling Mode will operate as a Point-to-Point

polling protocol. This is because the RS-232 transmitter is always left on

when enabled.

Serial Cmd: <K148,RES,REQ,STX,ETX,ACK,NAK>

RES: (Reset) 04

REQ: (Request) 05

STX: (Start of Text) 02

ETX: (End of Text) 03

ACK: (Acknowledge) 06

NAK: (Negative Acknowledge) 15

MS-4 Imager User’s Manual 3-9

Communications

RS-422 Status

Note: The default setting can only be changed in readers with multiplexed RS-232 / RS-422

ports. It is forced to 1 (enabled) in readers with “dedicated” RS-422 ports.

Note: The USB version of the MS-4 does not support RS-422.

Usage: RS-232 is an industry standard. RS-422 is used when greater cable lengths

are required and/or where noise interference is an issue.

Definition: RS-422, if enabled, allows communication through RS-422 I/O lines.

When RS-422 is enabled, RS-232 is disabled.

When RS-422 is disabled, RS-232 is enabled.

Serial Cmd: <K102,status>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

3-10 MS-4 Imager User’s Manual

Auxiliary Port Connections

The auxiliary port offers an alternative port that can be configured to communicate by

RS232 in several modes, including daisy chain.

As with the host port parameters, the auxiliary port settings (baud rate, parity, stop bits,

and data bits) must be identical with those of the auxiliary device.

Auxiliary Port Mode

Baud Rate, Auxiliary Port

Parity, Auxiliary Port

Usage: An auxiliary port connects the Imager to a remote display or to other readers

that can display or transfer data.

Definition: These commands set the communication parameters with the auxiliary

port, which can be used to configure menus, send data to the host, display

data transmissions originating from the host, and relay data from other

Imagers set in tandem (daisy chained).

Usage: Can be used to transfer data faster or to match an auxiliary device.

Definition: Determines the flow of data between the auxiliary port device(s), the

Imager, and the host..

Serial Cmd: <K101,aux port mode,baud rate,parity,stop bits,data bits,daisy chain i.d.

status, daisy chain i.d.>

Default: Disabled

Options: 0 = Disabled 1 = Transparent 2 = Half duplex

3 = Full duplex 4 = Daisy chain

5 = Command Processing

Usage: Can be used to transfer data faster or to match an auxiliary device.

Definition: The rate at which the Imager and host transfer data back and forth.

Serial Cmd: <K101,aux port mode,baud rate,parity,stop bits,data bits,daisy chain i.d.

status,daisy chain i.d.>

Default: 115.2K

Options: 0 = 600 1 = 1200 2 = 2400

3 = 4800 4 = 9600 5 = 19.2K

6 = 38.4K 7 = 57.6K 8 = 115.2K

9 = 230K

Usage: Only changed if necessary to match host setting.

Definition: 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.

Serial Cmd: <K101,aux port mode,baud rate,parity,stop bits,data bits,daisy chain i.d.

status,daisy chain i.d.>

Default: None

Options: 0 = None 1 = Even 2 = Odd

MS-4 Imager User’s Manual 3-11

Communications

Stop Bits, Auxiliary Port

Data Bits, Auxiliary Port

Note: The USB version of the MS-4 does not have an Auxiliary Port.

Usage: Only changed if necessary to match host setting.

Definition: Allows the user to select the last one or two bits in each character to indicate

the end of the character.

Serial Cmd: <K101,aux port mode,baud rate,parity,stop bits,data bits,daisy chain i.d.

status,daisy chain i.d.>

Default: One

Options: 0 = One 1 = Two

Usage: Only changed if necessary to match host setting.

Definition: Number of bits in each character.

Serial Cmd: <K101,aux port mode,baud rate,parity,stop bits,data bits,daisy chain i.d.

status,daisy chain i.d.>

Default: Eight

Options: 0 = Seven 1 = Eight

3-12 MS-4 Imager User’s Manual

Auxiliary Port Connections

Transparent Mode

• Auxiliary port data is passed through to the

host whenever a return key is pressed at the

auxiliary port or whenever symbol data is

sent. If sent with symbol data, it is processed

on a first-in/first-out basis.

• Auxiliary port data to the host is always sent

with a preamble and postamble.

• If the Imager is in a polling mode with the

host, auxiliary port data will still pass

through.

Data Originating from the Imager

• Transmission to the auxiliary port occurs

immediately upon a good read.

• Data sent to the auxiliary port does not include

a preamble or a postamble.

• Communications with the auxiliary port is

always in Point-to-Point protocol, even if the

host is in a polled protocol mode.

Data Originating from the Host

• All host data is echoed to the auxiliary port in

unpolled mode.

Usage: A common application, in conjunction with handheld Imagers, is one that

employs an auxiliary readout to detect misapplied symbols.

Definition: In Transparent Mode, data is passed between the auxiliary port and the

host. The Imager buffers data from the auxiliary port and echoes the keyed

data on the auxiliary port.

Serial Cmd: <K101,aux port mode,baud rate,parity,stop bits,data bits,daisy chain i.d.

status,daisy chain i.d.>

Options: 1 = Transparent

Host Aux.

Port

Imager

Host Aux.

Port

Imager

Host Aux.

Port

Imager

MS-4 Imager User’s Manual 3-13

Communications

Half Duplex Mode

Data Originating from the Auxiliary Port

• Auxiliary port data to the host is ignored if the

Imager is in a polled mode.

• Auxiliary port data or read data is sent to the

host whenever it is received.

• Auxiliary port data is not echoed.

• Auxiliary port data to the host is always sent

without a preamble or postamble.

Data Originating from the Imager

• Data is transmitted to the auxiliary port at the

same time it is transmitted to the host.

• Data transmission conforms with all parameters

specified in the configuration menu (e.g. Preamble

Postamble, End of Read Cycle).

Data Originating from the Host

• All host data is echoed to the auxiliary port in

unpolled mode.

Usage: Useful when the user wants symbol data displayed on an auxiliary menu

close to the Imager.

Definition: In Half Duplex Mode all auxiliary port data and symbol data is sent directly

to the host. Symbol data is displayed on the auxiliary port menu at the

same time the data is sent to the host.

Serial Cmd. <K101,aux port mode,baud rate,parity,stop bits,data bits,daisy chain i.d.

status,daisy chain i.d.>

Options: 2 = Half Duplex

Host Aux.

Port

Imager

Host Aux.

Port

Imager

Host Aux.

Port

Imager

3-14 MS-4 Imager User’s Manual

Auxiliary Port Connections

Full Duplex Mode

Data Originating from the Auxiliary Port

• Auxiliary port data to the host is ignored if the

Imager is in a polled mode.

• Auxiliary port data or read data is sent to the

host whenever it is received.

• Auxiliary port data is not echoed.

•

Auxiliary port data to the host is always sent

without

a preamble or postamble.

Data Originating from the Imager

• Data is not sent to the auxiliary port.

Data Originating from the Host

• All host data is echoed to the auxiliary port in

unpolled mode.

Usage: When communication to and from the auxiliary port is required.

Definition: In Full Duplex Mode all auxiliary port data and symbol data is sent directly

to the host. Symbol data is not displayed on the auxiliary port menu.

Serial Cmd: <K101,aux port mode,baud rate,parity,stop bits,data bits,daisy chain i.d.

status,daisy chain i.d.>

Options: 3 = Full Duplex

Host Aux.

Port

Imager

Host Aux.

Port

Imager

Host Aux.

Port

Imager

MS-4 Imager User’s Manual 3-15

Communications

Daisy Chain Mode

Usage: Useful in applications where:

• More than one symbol type is present.

• A symbol may be present on multiple sides of a package.

• Symbols are presented at different depths.

Definition: In a daisy chain application, readers are connected in tandem or a “daisy

chain” and decoded data is relayed from one reader to another until the

data reaches the host.

A primary reader has its host port linked to the host computer and its auxiliary

port linked to the host port of the first secondary reader in the chain.

Thereafter, each secondary reader’s auxiliary port is linked to the host port

of the secondary reader that is farther from the host in the daisy chain.

Each reader in the chain can be assigned an ID that accompanies any data

that it sends.

Serial Cmd: <K101,aux port mode,baud rate,parity,stop bits,data bits,daisy chain i.d.

status,daisy chain i.d.>

Options: 4 = Daisy Chain

Function: Before the primary reader times out, it checks its auxiliary port for data. It

should be set to wait at least 30 mS for each secondary reader in the daisy

chain. If no data is received within the read cycle timeout, the primary

reader sends a No Read message to the host. Otherwise the complete data

is sent.

If, for example, the primary reader is set to timeout in 120 mS, the first

secondary reader reader downstream might be set to 90 mS, the next to 30

mS, and so forth, thus assuring that at least 30 mS elapses between

transmissions.a

Daisy-chained readers can send a series of symbols by enabling

Multisymbol

and a common multisymbol separator. If the primary reader does not

receive the expected number of symbols, No Read messages are

appended to the data string to make up the difference between the number

of symbols enabled in Multisymbol and the number of symbols read.

For example, a primary and two secondary readers have Number of

Symbols set to 3 and Multisymbol Separator defined as %. If the primary

and the first secondary reader do not find symbols, but the next secondary

reader registers a good read, the transmitted results would be:

symbol data % No Read % No Read

a. The above example assumes a best-case scenario. Other factors, such as baud rate, dynamic focus

timing, number of characters in a given symbol, and the number of secondary readers in the daisy chain

can affect timing and may need to be included in your calculations for complete accuracy.

3-16 MS-4 Imager User’s Manual

Auxiliary Port Connections

Command Processing Mode

Usage: Allows a user to send configuration settings from the host port to the auxiliary

port.

Definition: When enabled, Command Processing Mode allows commands to be

entered via the auxiliary port and direct externally triggered read cycle data

in one of two ways:

• Bar code data, including the serial trigger (if used), will be transmitted to

the last port from which a command was sent.

• If the last command came from the host port, then externally triggered

read cycle data will only be output to the host port.

Serial Cmd: <K101,aux port mode,baud rate,parity,stop bits,data bits,daisy chain i.d.

status,daisy chain i.d.>

Options: 5 = Command Processing

MS-4 Imager User’s Manual 3-17

Communications

Daisy Chain ID Status

Note: Enable/disable and length must be the same in all readers.

Daisy Chain ID

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K101h,,,,,,,3C>

For >: <K101h,,,,,,,3E>

For , : <K101h,,,,,,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Usage: Used in a daisy chain setup in cases where the host needs to know which

reader in the chain sent the data.

Definition: Each reader in a daisy chain can be assigned a one or two character ID

that will appear in front of decoded data and identify its source.

Serial Cmd: <K101,aux port mode,baud rate,parity,stop bits,data bits,daisy chain i.d.

status, daisy chain i.d.>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: Used in a daisy chain setup in cases where the host needs to know which

reader in the chain sent the data.

Definition: A one or two character prefix which identifies the particular daisy chain

reader from which the data is being sent to the host.

Serial Cmd: <K101,aux port mode,baud rate,parity,stop bits,data bits,daisy chain i.d.

status,daisy chain i.d.>

Default: 1/

Options: Any one or two ASCII characters.

3-18 MS-4 Imager User’s Manual

Auxiliary Port System Data Status

Note: The USB version of the MS-4 does not have an Auxiliary Port.

Definition: When enabled, system data will be routed to the Auxiliary Port. This

includes decoded data and diagnostic warning messages.

When disabled, system data will not be routed to the Auxiliary Port.

Serial Cmd: <K146,aux port system data status>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 3-19

Communications

Daisy Chain Autoconfigure

Note: All secondary readers must be set to Serial for Daisy Chain to function.

When setting up a daisy chain operation, perform the following steps:

1. Set the primary Imager (the one connected to the host) to Serial.

This sets all the Imagers in the chain to Serial when the command is executed.

Before Autoconfigure you must set the primary Imager to Serial (S):

2. Send <K150DAISY>.

3. If necessary, set the primary Imager to Edge.

After

Autoconfigure

you may set the primary Imager to

Edge

(

), but the other Imagers

must remain in

Serial

(

Note: The USB version of the MS-4 does not support this command.

Usage: For quick setup and configuration of your daisy chain network.

Definition: The command to autoconfigure the daisy chain is sent to the primary

Imager and the software responds in the following ways:

• Counts the number of secondary readers in the daisy chain.

• Assigns an internal ID number (1...n) to each secondary reader, where

the first secondary reader is number 1 (the primary reader’s ID being a 0).

• Propagates the communications settings and the relevant operating

modes of the primary Imager to the host and auxiliary ports of each

secondary reader.

• Resets each secondary reader.

• Verifies that each secondary reader has acquired the new settings.

Serial Cmd: <K150DAISY>

Host Primary

Imager Secondary

Imager

SSS

Host Primary

Imager Secondary

Imager

ESS

3-20 MS-4 Imager User’s Manual

Response Timeout

Note: See USB HID Interface on page 3-23 for protocol information relating to USB.

Usage: Only used when a response is required from the host. While in Multidrop, if

the Imager does not receive an ACK or NAK from the host after sending

polled data, it will act on a fault. The reader can be set to wait indefinitely by

setting Response Timeout to zero.

Definition: The time that the Imager will wait before timing out if ACK, NAK, and ETX

are enabled, and a host response is expected.

Serial Cmd: <K143,response timeout>

Default: 12 (in 1mS increments)

Options: 0 to 255 (A zero (0) setting causes an indefinite wait.)

MS-4 Imager User’s Manual 3-21

Communications

LRC Status

(Longitudinal Redundancy Check)

Note: The USB version of the MS-4 does not support this command.

Usage: Used when extra data integrity is required.

Definition: 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.

Serial Cmd: <K145,status>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

3-22 MS-4 Imager User’s Manual

Protocol Configuration Examples

Point-to-Point (Main Port)

Polling Mode (Main Port)

“User-Defined” Polling Mode (Main Port)

ACK / NAK (Main Port)

Auxiliary Port

Listed below are several examples of Auxiliary Port commands.

<K100,8,0,1,1> Baud Rate: 115.2K; Parity: None; Stop Bits: 2; Data Bits: 8

<K140,0> Point-to-Point

<K102,0> RS-232 enabled; <K102,1> = RS-422 enabled

<K100,4,0,1,1> Baud Rate: 9600; Parity: None; Stop Bits: 2; Data Bits: 8

<K140,5,23> Polling Mode; Address: 23

<K102,0> RS-232 Point-to-Point polling

<K143,30> 30 mS Response Timeout

<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

<K100,9,0,1,1> Baud Rate: 230K; Parity: None; Stop Bits: 2; Data Bits: 8

<K140,4> ACK/NAK

<K147,,,01,1B,2E,1F> Default RES and REQ (00, disabled); STX=0x01; ETX=0x1B;

ACK=0x2E; NAK=0x1F

<K102,1> RS-422 enabled; <K102,0> = RS-232 enabled

<K143,50> 50 mS Response Timeout

<K101,2,4,0,1,1> Half Duplex; Baud Rate: 9600; Parity: None; Stop Bits: 2; Data Bits: 8

<K101,1,5,0,1,1> Transparent; Baud Rate: 19.2K; Parity: None; Stop Bits: 2; Data Bits: 8

<K101,3,7,0,1,1> Full Duplex; Baud Rate: 57.6K; Parity: None; Stop Bits: 2; Data Bits: 8

<K101,5,6,0,1,1> Command Processing; Baud Rate: 230K; Parity: None; Stop Bits: 2;

Data Bits: 8

MS-4 Imager User’s Manual 3-23

Communications

USB HID Interface

The USB version of the MS-4 Imager operates as an HID (Human Interface Device) on the USB

bus. HID-class devices communicate via “report” packets. An HID may support multiple report

types, each of which is identified with a unique report ID. The MS-4 supports two different report

types:

•Microscan HID Report (ID = 1)

•Keyboard Report (ID = 2)

The Imager always outputs the same data for both report types. The user may enable or

disable either report type.

Regardless of the report type used by the host application, the application protocol via USB

is identical to RS-232 / RS-422 ports. HID Reports are used as a channel for standard

Microscan Imager communication, command input, and symbol data output.

Important: No matter how the Imager is configured, it is always able to receive and

respond to commands from the host application using Microscan HID Reports.

3-24 MS-4 Imager User’s Manual

USB HID Interface

Report Options

The following functionality conditions hold true regardless of how

HID Reports

are configured:

1. The host application must establish a connection with the Imager to receive Microscan

HID IN Reports (symbol data) and to send Microscan HID OUT Reports (commands,

serial triggers).

2. The Imager can always receive

Microscan HID OUT Reports

(commands, serial triggers).

3. The host application can always send commands through Microscan HID OUT

Reports. If the command requires a response (a part number, for example), the

Imager will always send the response through Microscan HID IN Reports.

4. The Imager always ignores Keyboard OUT Reports sent by the host operating system.

5. The content of both the Keyboard Reports and Microscan HID IN Reports is identical,

except for Keyboard Reports non-printable data limitations.

Microscan HID IN Reports

HID Reports are used as a channel for standard Microscan Imager communication,

command input, and symbol data output. There are two types of Microscan HID

Reports:

Note: The Imager is always able to receive commands and serial triggers from the host

through Microscan HID OUT Reports, regardless of the Microscan HID IN Report status.

If the Imager receives a command that requests a response, such as a part number query,

the Imager will send a Microscan HID IN Report regardless of the IN Report status.

Microscan HID IN Reports Enabled

When this feature is enabled, the Imager will send Microscan HID IN Reports to the host,

containing data originated by the Imager.

Microscan HID IN Reports Disabled

When this feature is disabled, the Imager will not send

Microscan HID IN Reports

to the

host, containing data originated by the Imager.

Report Type Data Content

Microscan HID IN (Imager to host)

Symbol data; No Reads; Service messages

Microscan HID OUT (host to Imager) Commands; serial triggers

Serial Cmd: <K149,Microscan HID IN Report status,Keyboard IN Report status>

Default: 1

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 3-25

Communications

Keyboard IN Reports

The host operating system will interpret

Keyboard IN Reports

from the Imager as if the

user were typing keyboard text. The host operating system sends keystrokes to the current

application. This is commonly called a

Keyboard Wedge

configuration.

There is one type of Keyboard Report used:

Note: If Keyboard IN Reports is enabled, and Microscan HID IN Reports is disabled,

the read cycle must be Continuous Read 1 Output, because there will be no External

Trigger or Serial Trigger. It is not possible to send commands to the Imager as Keyboard

OUT Reports. To send commands to the Imager via USB, the host application must

establish a connection with the Imager and send Microscan HID OUT Reports.

Keyboard IN Reports Enabled

When this feature is enabled, the Imager will send Keyboard IN Reports to the host,

containing data originated by the Imager.

Keyboard IN Reports Disabled

When this feature is disabled, the Imager will not send Keyboard IN Reports to the host,

containing data originated by the Imager.

Report Type Data Content

Keyboard IN (Imager to host)

Symbol data; No Reads; Service messages

Serial Cmd: <K149,Microscan HID IN Report status,Keyboard IN Report status>

Default: 0

Options: 0 = Disabled 1 = Enabled

3-26 MS-4 Imager User’s Manual

USB HID Interface

Microscan HID Report Format

Size: 64 bytes, fixed-length. The USB HID standard defines all reports as being fixed-length.

Structure: REPORT ID (1) LENGTH (1) DATA (62)

Values in parentheses indicate the size, in bytes, of the field.

Field Descriptions

REPORT ID

Size: 1 byte

Value: 0x01

Note: Report ID is the method employed by USB HID to allow multiple report formats to be

sent and received from the same interface.

LENGTH

Size: 1 byte

Value: 0-62

Note: Length indicates the number of valid data bytes in the fixed-length data field. This is

necessary because the USB HID standards define HID Reports as fixed-length, yet the

Imager or host may require a smaller data size in any given report.

DATA

Size: 62 bytes, fixed-length

Value: 0x00 to 0xFF

Note: The Data field is left-justified, meaning it begins immediately after the Length field.

All unused data space is NUL (0x00) padded. Data values can be “binary”, meaning that

they span the entire 8 bit range of 0x00 to 0xFF.

MS-4 Imager User’s Manual 3-27

Communications

Report Format Examples

For clarity, all report format examples are shown as follows: report fields separated by an

underscore ( _ ), REPORT ID and LENGTH fields shown as decimal values, data fields

shown as printable ASCII characters, and the number of NUL padding bytes shown as

decimal values (nn).

IN report (to host)

1_11_A]002374938 (51)

REPORT ID = 1 = Microscan HID

LENGTH = 11

DATA = ”A]02374938” = This is a Code 39 symbol.

NUL padding = 51 bytes

OUT report (from host to Imager)

1_27_<K200,3><K220,0,300><K714?> (35)

REPORT ID = 1 = Microscan HID

LENGTH = 27

DATA = “<K200,3><K220,0,300><K714?>” = These commands enable External Edge, set

a 3 second timeout, and request the No Read configuration command.

NUL padding = 35 bytes

IN report (to host)

1_62_<K714,1, A LONG MESSAGE STREAMED OVER MULTIPLE MICROSCAN HID RE (0)

REPORT ID = 1 = Microscan HID

LENGTH = 62

DATA = “<K714,1, A LONG MESSAGE STREAMED OVER MULTIPLE MICROSCAN HID

RE” = This shows the response to the <714?> command. Note that the command status

response is not yet complete. See the next report example for the complete response.

NUL padding = 0 bytes

IN report (to host)

1_6_PORTS>(56)

REPORT ID = 1 = Microscan HID

LENGTH = 6

DATA = “PORTS>” = This is the end of the response to the <K714?> command from the

previous example.

The entire <K714> command response is as follows:

DATA = “K714,1, A LONG MESSAGE STREAMED OVER MULTIPLE MICROSCAN HID

REPORTS>” .

NUL padding = 56 bytes

3-28 MS-4 Imager User’s Manual

USB HID Interface

Keyboard Report Format

Size: 9 bytes, fixed-length.

Structure: REPORT ID (1) MODIFIER (1) RESERVED (1) KEYCODES (6)

Values in parentheses indicate the size, in bytes, of the field.

Important: The host application does not need to understand and process Keyboard

Reports. This task belongs to the host operating system. Keycodes are passed to the host

application as if a user were typing keyboard text. The host application must be the active

application in order to receive keystrokes.

Keyboard Reports protocol requires that two reports be sent for every keystroke. The first

report indicates which key is pressed. The second report indicates “no key pressed”, with

all keycodes NUL (0x00) to indicate that all keys have been released. In the case of the

MS-4 Imager, each byte output is equivalent to a keystroke, with a “key pressed” report

and a “no key pressed” report. For this reason, data rates are much slower when using

Keyboard Reports.

Field Descriptions

REPORT ID

Size: 1 byte

Value: 0x02

Note: Report ID is the method employed by USB HID to allow multiple report formats to be

sent and received from the same interface.

MODIFIER

Size: 1 byte

Value: 0x00 to 0xFF

Note: Modifier is an 8 bit field, corresponding to the state of the modifier keys at the time

the keycode field was generated.

Bit Key

0 LEFT CTRL

1 LEFT SHIFT

2 LEFT ALT

3LEFT GUI

4 RIGHT CTRL

5 RIGHT SHIFT

6 RIGHT ALT

7 RIGHT GUI

MS-4 Imager User’s Manual 3-29

Communications

Field Descriptions

RESERVED

Size: 1 byte

Value: 0x00

Note: This field is Reserved. Its value is always NUL (0x00).

KEYCODES

Size: 6 bytes

Value: 0x00 to 0xFF

Note:

The MS-4 Imager translates 8 bit data values into

Keycode

data in the following ways:

8 Bit Data Value Keycode Data

0x00 to 0x1F and 0x7F to 0xFF Decimal key ( . ) unless otherwise noted.

CR, 0x0D Enter key

TAB, 0x09 Tab key

ESC, 0x1B ESC key

“Printable” characters, 0x20 to 0x7E These all translate to the keystrokes that produce them.

This includes a-z, 0-9, punctuation, and SHIFT in the

Modifier field, when necessary. Only the first Keycode

in the 6 byte array will be populated.

3-30 MS-4 Imager User’s Manual

USB HID Interface

USB HID Configuration Options

The user has the following options for configuring and defaulting a USB version of the MS-4:

Configuration Symbols (Data Matrix with “Configure Reader” Flag)

Symbol configuration can be performed “out-of-the-box”, as the MS-4 is configured for

Continuous Read Mode, and Data Matrix is enabled by default. Data Matrix symbols are

used to encode configuration commands when the symbology’s “configure reader” flag is

set.

If the read cycle is changed, or if Data Matrix is disabled, another configuration/default

method must be used. This is because the USB MS-4 has no external trigger, unless the

user has configured the EZ button as a trigger.

EZ Button Configuration

By default, basic calibration can be initiated from the EZ button (3 beeps). Note that this

only changes the camera, image processing, and symbology settings of the Imager. To

default the USB MS-4, hold down the EZ button during power-on.

Note: This only overwrites Power-On settings with Custom Default settings, as when the

<Zrc> command is received. It does not overwrite Power-On settings with Factory

Defaults, as when the <Zrd> command is received. If Custom Defaults are misconfigured,

another method must be used to default the Imager.

Implementing the Host Operating System API and Establishing a

Connection with the Microscan HID Interface

When a connection is made, the host can send serial configuration/default commands. The

Imager will always be able to receive configuration commands from the host application and

send responses to those commands. However, the Imager can be configured to stop producing

IN Reports to the host from symbol data output and diagnostics (service messages).

MS-4 Imager User’s Manual 3-31

Communications

Configuration Exceptions for USB

Read Cycle Mode

By default, the Imager operates in Continuous Read Mode. If the Imager is configured

using Data Matrix symbols, the read cycle mode should be the last item changed before

saving the configuration settings and beginning operation. This is because all read cycle

modes other than Continuous Read Mode require a trigger event. In USB, a trigger event

can only be initiated by serial command. To send a trigger command the Imager, the host

application must establish a connection with the Imager’s Microscan HID interface and

send the trigger command in a Microscan HID Report.

The following read cycle conditions are required for USB MS-4:

Important:

• To use Level Mode, you must enable Undelimited Start Trigger Character <K229>

and Undelimited End Trigger Character <K230>.

• To use Edge Mode, you must enable and use the Undelimited Start Trigger Character

<K229>.

• To use Serial Mode, you must use the Delimited Trigger defined by <K201>, or enable

and use the Undelimited Start Trigger Character <K229>.

• To use Serial and Edge Mode, you must use the Delimited Trigger defined by

<K201>, or enable and use the Undelimited Start Trigger Character <K229>.

Communications

For the USB version of MS-4, no communications serial commands have any effect on the

Imager except the following:

• USB HID Report Status <K149>

• Preamble <K141>

•Postamble <K142>

EZ Button

Default on power-on cannot be disabled <K770,,default> = <K770,,1>. This ensures a

level of safety for recovering from misconfigured Power-On settings <Z>. However, it is not

foolproof, as defaulting with the EZ button only recovers Custom Default settings, which

can be misconfigured themselves. For this reason, do not save to Custom Default settings

<Zc> until the Imager’s configuration has been tested.

Symbologies

If the Imager is going to be configured with Data Matrix symbols, do not disable Data Matrix

<K479>. Disabling Data Matrix will prevent the Imager from reading configuration symbols.

Serial Cmd: <K200,read mode>

Default: Continuous

Options: 0 = Continuous Mode 1 = Coninuous Read 1 Output Mode

2 = Level Mode 3 = Edge Mode

4 = Serial Mode 5 = Serial and Edge Mode

3-32 MS-4 Imager User’s Manual

ASCII Character Entry Modifier

Commands that require ASCII text fields, such as

Preamble

and

Postamble

commands, can

be sent to the Imager as hex value pairs (see Appendix E,

ASCII Table

, for conversions).

To enter ASCII fields as hex values (00 to FF), add a lower-case

directly after the command’s

number, and then enter the hex value that corresponds with the desired ASCII character.

Example:

Consider the Postamble command:

Imagine that your application requires the ASCII character > to be the postamble in your

symbol decode output.

The ASCII characters <, >, and , can only be entered as hex pairs. So, to make > the

postamble in your symbol decode output, enter the Postamble command as follows:

<K142h,,3E>

Note that the “status” field contains only a , . This is because the only field that is being

changed is the “postamble character(s)” field. (See Serial Configuration Command

Conventions on page A-10 for a more detailed explanation of this command shortcut.)

Serial Cmd Format: <Knnnh,00-FF>

Serial Cmd: <K142,status,postamble character(s)>

MS-4 Imager User’s Manual 3-33

Communications

Preamble

Preamble Status

Preamble Characters

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K141h,,3C>

For >: <K141h,,3E>

For , : <K141h,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Usage: 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.

Definition: Defines a one to four character data string that can be added to the front of

the decoded data.

Serial Cmd: <K141,status,preamble character(s)>

Default: Disabled

Options: 0 = Disabled 1 = Enabled (within any protocol)

Serial Cmd: <K141,status,preamble character(s)>

Default: ^M corresponds to: carriage return.

Options: 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.

3-34 MS-4 Imager User’s Manual

Postamble

Postamble Status

Postamble Characters

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K142h,,3C>

For >: <K142h,,3E>

For , : <K142h,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Usage: 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.

Definition: Allows the user to enable or disable up to four postamble characters that

can be added to the end of the decoded data.

Serial Cmd: <K142,status,postamble character(s)>

Default: Enabled

Options: 0 = Disabled 1 = Enabled (within any protocol)

Serial Cmd: <K142,status,postamble character(s)>

Default: ^M^J corresponds to carriage return/line feed.

Options: 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.

MS-4 Imager User’s Manual 4-1

4 Calibration

Contents

This section shows the MS-4 Imager’s calibration options and their default settings.

Calibration Serial Commands .......................................................................................................4-2

Calibration Overview.....................................................................................................................4-2

Calibration Options .......................................................................................................................4-3

Calibration by ESP......................................................................................................................4-10

Initiating Calibration ....................................................................................................................4-12

Additional Notes about Calibration..............................................................................................4-17

4-2 MS-4 Imager User’s Manual

Calibration Serial Commands

Calibration Overview

Autocalibration is one of the most powerful features of the MS-4 Imager. The calibration

process can be initiated by serial command, EZ button, or ESP user interface.

When the Imager enters calibration, it runs through an optimization cycle that sets the ideal

parameters for reading symbols at the highest possible level of performance. Autocalibration

can be specially configured to optimize specific parameters, such as gain, shutter speed,

and symbol type.

The calibration process consists of a search pass, medium pass, and fine-tune pass. During

this process the Imager quickly locates configuration setup, defines a calibration range for

the configuration parameters, and then tunes those parameters for optimal performance.

Calibration Options <K529,gain,shutter speed,symbol type,WOI framing,WOI

margin,line scan height,processing>

Autocalibrate

@CAL

MS-4 Imager User’s Manual 4-3

Calibration

Calibration Options

This command specifies the operation of the Imager’s calibration feature. The default

configuration is set up to perform calibration on gain and symbol type. The default shutter

speed setting is disabled, because not all applications require shutter speed, and when it

is required, the application-specific settings tend to vary widely.

Note: Background Color (page 6-35) is part of the calibration process regardless of the

calibration setup. After successful completion of the calibration routine, the background

color will be set to the appropriate value, depending on the symbol in the field of view. The

Mirrored Image parameter (page 10-28) is not part of the calibration process, and it must

be configured appropriately prior to calibration.

Gain

Definition: When enabled, gain will be calibrated to provide the best available image

quality and performance.

When disabled, gain is fixed and is not part of the calibration process.

Serial Cmd: <K529,gain,shutter speed,symbol type,WOI framing,WOI margin,line

scan height,processing>

Default: Enabled

Options: 0 = Disabled 1 = Enabled

4-4 MS-4 Imager User’s Manual

Calibration Options

Shutter Speed

Note:

The following table shows general guidelines for shutter speed configurations based on

various line speeds. The configurations shown depend on the Imager’s optical configuration,

and on symbol element size.

Shutter Speed Disabled

When this feature is disabled, the shutter speed is fixed and is not part of the calibration

process.

Shutter Speed Enabled

When this feature is enabled, shutter speed will be calibrated to provide the best possible

image quality and performance.

Fast Shutter

The calibration process will concentrate on achieving the fastest possible shutter setting that

will still provide good performance. The image quality or contrast may not be as good as

what would be achieved with the Enabled setting. The calibration process is not designed to

choose the fastest shutter speed that can decode a symbol, but rather to optimize for the

fastest shutter speed that still provides good image quality.

Definition:

Unless an application is a static setup, the shutter speed setting should be

configured by the user based on the application. For dynamic applications, the

user should configure the shutter speed setting so the calibration process can

optimize the gain for that setting.

Serial Cmd: <K529,gain,shutter speed,symbol type,WOI framing,WOI margin,line

scan height,processing>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

2 = Fast Shutter

Shutter Speed Line Speed

0 - 250 static

250 - 750 5” / sec

750 - 1500 10” / sec

1500 - 2000 15” / sec

2000 - 2500 20” / sec

MS-4 Imager User’s Manual 4-5

Calibration

Symbol Type

Symbol Type Disabled

When this feature is disabled, only the currently-enabled symbologies will be considered

during the calibration process.

Symbol Type Enabled

When this feature is enabled, autodiscrimination will be in effect during the calibration

process. All symbologies that are readable by the Imager except PDF417 will be considered

during calibration. Any new symbologies successfully decoded during calibration will

remain enabled at the end of the process. All enabled symbologies will remain enabled.

For example, assume that only Code 39 is enabled at the beginning of calibration. If a

Code 128 symbol is read during calibration, then Code 128, as well as Code 39, will be

enabled after the calibration process is complete.

Serial Cmd: <K529,gain,shutter speed,symbol type,WOI framing,WOI margin,line

scan height,processing>

Default: Enabled

Options: 0 = Disabled 1 = Enabled

4-6 MS-4 Imager User’s Manual

Calibration Options

Window of Interest (WOI) Framing

If WOI framing is not enabled, the current WOI configuration will be used until a symbol

has been decoded. After a symbol is decoded, the WOI is framed exactly as it would be if

a WOI framing mode was enabled. When the calibration process is complete, the original

WOI configuration is restored. Refer to the diagram below:

Definition: If a WOI framing mode is enabled, it will set the camera WOI to a full-size

image when calibration begins. Once a symbol is decoded, the camera

WOI will be re-sized both vertically and horizontally (regardless of which

WOI mode is enabled) to include the symbol plus an additional margin

area. This is done to accelerate the calibration process.

When a successful calibration process is completed, the camera WOI

will be adjusted according to the mode enabled. Otherwise, the original

WOI configuration will be retained.

Serial Cmd: <K529,gain,shutter speed,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

Configured WOI Starting WOI After Decode Calibration Passed Calibration Failed

Configured WOI After Decode Calibration Passed Calibration Failed

MS-4 Imager User’s Manual 4-7

Calibration

Window of Interest Framing Disabled

When this feature is disabled, the Window of Interest is not modified after the calibration

process is complete.

Row and Column

If the calibration process is successful, the Window of Interest will be modified to frame the

symbol as well as an additional margin area around the symbol, determined by the WOI

Margin parameter. Refer to the diagram below:

Column

If the calibration process is successful, the Window of Interest columns will be modified to

vertically frame the symbol, plus an additional margin area around the symbol, determined

by the WOI Margin parameter. Refer to the diagram below:

Row

f the calibration process is successful, the Window of Interest rows will be modified to horizontally

frame the symbol, plus an additional margin area around the symbol, determined by the

WOI

Margin

parameter. Refer to the diagram below:

4-8 MS-4 Imager User’s Manual

Calibration Options

Straight Line

This feature is intended for use with linear symbologies. If the calibration process is successful,

the orientation of the symbol is determined and the Window of Interest is modified according

to the symbol orientation. The scan line orientation is determined to be vertical if the

symbol tilt is between 225° and 315°, or between 45° and 135°. Otherwise, the scan line

will be horizontal.

If the symbol is vertical, the image column size will be set by the scan height parameter,

and will be configured for full row resolution. If the symbol is horizontal, the image row size

will be set by the scan height parameter, and will be configured for full column resolution.

The scan line will be centered in the middle of the symbol. If the symbol is tilted such that

the scan line will not pass completely through the symbol, the scan width will be adjusted

to include the entire symbol. Refer to the diagram below:

Straight Line Framed

This parameter is the same as “Straight Line”, except that the Window of Interest will also

frame the scan line on the symbol length as well. The scan line includes the symbol plus

an additional margin area determined by the WOI Margin parameter.

MS-4 Imager User’s Manual 4-9

Calibration

Window of Interest (WOI) Margin

Line Scan Height

Processing

Low

The Imager will spend a low amount of effort attempting to decode the given symbol for

each parameter configuration.

Medium

The Imager will spend a medium amount of effort attempting to decode the given symbol

for each parameter configuration.

High

The Imager will spend a high amount of effort attempting to decode the given symbol for

each parameter configuration.

Definable

The processing time for each image frame is defined by the Image Processing Timeout

parameter <K245>.

Definition:

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.

Serial Cmd: <K529,gain,shutter speed,symbol type,WOI framing,WOI margin,line

scan height,processing>

Default: 75 (pixels)

Options: 20 to 640

Definition: 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.

Serial Cmd: <K529,gain,shutter speed,symbol type,WOI framing,WOI margin,line

scan height,processing>

Default: 64 (pixels)

Options: 3 to 480

Definition: This setting defines the amount of time and effort the Imager will spend

attempting to decode a symbol for each parameter configuration.

Serial Cmd: <K529,gain,shutter speed,symbol type,WOI framing,WOI margin,line

scan height,processing>

Default: Medium

Options: 0 = Low 1 = Medium

2 = High 3 = Definable

4-10 MS-4 Imager User’s Manual

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

Determines the

amount of time

and effort the

Imager will spend

attempting to

decode a symbol

for each parameter

configuration.

(Low, Medium,

High, Definable).

Initiates the

calibration

routine.

Shutter, Gain,

and Image

Quality values

are all tracked in

real-time during

the calibration

process.

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).

Gain and Shutter Speed

are configurable in the

Calibration interface.

Before and After tabs give the user an authentic

representation of the difference in what the Imager

“sees” before and after the calibration routine.

Dropdown menu of 1D and 2D symbologies, and a check

box for enabling or disabling Composite symbologies.

Cancels the

calibration

process, if

necessary.

MS-4 Imager User’s Manual 4-11

Calibration

After Calibration

Notice the improved image

resolution after the calibration

process is complete.

The calibration

progress bar

indicates that

the process has

been completed.

Saves the optimal configuration parameters

determined by calibration results.

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 parameters.

4-12 MS-4 Imager User’s Manual

Initiating Calibration

Calibration can be initiated by serial command, the EZ button, or from the Calibration

interface in ESP.

In ESP, the Calibrate button starts the calibration routine.

To initiate calibration by serial command, enter the serial command

<@CAL>

from a terminal,

such as

ESP

’s

Terminal

interface.

<@CAL>

is a calibration routine that emphasizes contrast

and readability.

See Calibrate by EZ Button on page 1-10 for the EZ button calibration procedure.

MS-4 Imager User’s Manual 4-13

Calibration

Calibration Progress Indicators

During the calibration process, the Imager has a number of ways to communicate its

progress to the user. The following three types of feedback are the primary ways that the

Imager communicates calibration progress.

Read Rate LEDs

When calibration is initiated through a serial command or the EZ button, the Imager’s read

rate LEDs indicate calibration progress as follows:

Beeper / Green Flash

The beeper and green LED flash are used to indicate calibration status as shown in the

table below:

LEDs Calibration Progress

20% Search Pass in progress.

20%, 40%, 60% Medium Pass in progress.

20%, 40%, 60%, 80% Fine-Tune Pass in progress.

20%, 40%, 60%, 80%, 100% Calibrated Successfully (holds for green flash duration).

Indicator Status

2 quick beeps Calibration has started.

5 quick beeps Calibration has failed.

1 long beep Calibration has been completed successfully.

1 sec. Green Flash Calibration has been completed successfully.

4-14 MS-4 Imager User’s Manual

Initiating Calibration

Calibration Progress Output to Terminal

When initiated by serial command or EZ button, the autocalibration operation will output

progress and process information to a terminal if the system is configured to do so.

Terminal

Depending upon how the calibration options are configured, the autocalibration process

can have up to 3 steps (Search Pass, Medium Pass, Fine-Tune Pass). Calibration data is

shown in a simple table format under 7 category headings, each of which are defined

below.

Calibration Progress Output Examples (Terminal)

Search Pass

The purpose of Search Pass is to decode a symbol in as few configurations as possible

during calibration. This process is designed to quickly identify symbology type, and any

image processing parameters that are already calibrated.

Heading Definition

Prog Progress indicator with a range of 0 - 100. Indicates percent complete.

Rating Rating indicator; higher ratings are more favorable.

Decode Number of successful decodes for the pass.

Quality Quality indicator; higher ratings are more favorable.

Shutter Shutter setting under operation.

Gain Gain setting under operation.

Locate Time required to locate symbol, expressed in milliseconds.

Running Search Pass

Prog Rating Decode Quality Shutter Gain Locate

1200025000

1400025090

16 0 0 0 250 18 0

18 2174 1 72 250 27 24

MS-4 Imager User’s Manual 4-15

Calibration

Medium Pass

The theory behind Medium Pass is to develop a readable range from which to dial in a

decoded symbol.

Running Medium Pass

Prog Rating Decode Quality Shutter Gain Locate

51 4216 2 8 250 0 5

53 8436 4 20 250 4 4

55 6336 3 24 250 8 4

57 8448 4 32 250 12 4

59 8456 4 40 250 16 5

61 8464 4 48 250 20 4

63 8472 4 56 250 24 5

65 8488 4 72 250 28 5

67 8504 4 88 250 32 5

69 8512 4 96 250 36 5

71 8528 4 112 250 40 6

73 8584 4 168 250 44 5

75 8644 4 228 250 48 5

Rating List (Best):

Rating = 8606; Shutter = 250; Gain = 48

Rating = 8581; Shutter = 250; Gain = 44

Rating = 8553; Shutter = 250; Gain = 40

Rating = 8527; Shutter = 250; Gain = 36

Rating = 8505; Shutter = 250; Gain = 32

Rating = 8488; Shutter = 250; Gain = 28

Rating = 8476; Shutter = 250; Gain = 24

4-16 MS-4 Imager User’s Manual

Initiating Calibration

Fine-Tune Pass

The theory behind Fine-Tune Pass is to dial in a decoded symbol based on the range

supplied by the Medium Pass.

Running Fine Tune Pass

Prog Rating Decode Quality Shutter Gain Locate

77 6416 3 104 250 38 7

79 6424 3 112 250 39 6

81 6424 3 112 250 40 6

84 6432 3 120 250 41 6

86 6448 3 136 250 42 5

88 6464 3 152 250 43 5

90 6476 3 164 250 44 5

93 6488 3 176 250 45 5

95 6506 3 194 250 46 6

97 6524 3 212 250 47 5

100 6538 3 226 250 48 6

Rating List (Best):

Rating = 6527; Shutter = 250; Gain = 48

Rating = 6517; Shutter = 250; Gain = 47

Rating = 6505; Shutter = 250; Gain = 46

Rating = 6491; Shutter = 250; Gain = 45

Rating = 6476; Shutter = 250; Gain = 44

Rating = 6462; Shutter = 250; Gain = 43

Rating = 6449; Shutter = 250; Gain = 42

Calibration PASSED.

MS-4 Imager User’s Manual 4-17

Calibration

Additional Notes about Calibration

The following conditions apply to the Imager’s calibration process. Some of these items

are noted at various points throughout this section, or in other sections of the Imager’s

documentation.

1. The Mirrored Image parameter <K514> is not part of the calibration process.

2. Background Color <K451> is calibrated.

3. If Window of Interest (WOI) Framing is enabled, the WOI will be set to full frame

when calibration begins. If WOI Framing is disabled, the current WOI configuration

will be used for the Search Pass.

4. IP Mode <K527> will not be altered during calibration.

Threshold Mode

<K512>

will be set to

Adaptive

during calibration. At the end of a

successful calibration,

Threshold Mode

will remain set to

Adaptive

regardless of its

previous setting. Otherwise, the value will revert to its original state.

6. If Symbol Type is enabled for calibration (Autodiscriminate), then Interleaved 2 of 5

Range Mode 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 symbol length # 1 will be set to the decoded symbol length at

the end of calibration. Otherwise, the symbol lengths will be restored to their original

configurations.

7. The symbol size, dimension, and orientation parameters of the No Symbol Message

and Bad Symbol Message, and 2D Symbology Qualification command <K718>

will be updated if calibration is completed successfully.

8. 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.

9. The calibration process does not modify the global Composite status <K453>. The

global Composite status must be configured properly before calibration.

10. If the user requires calibration of a stacked symbology <K482>, <K483>, or <K484>,

that symbology must be enabled and configured appropriately before calibration.

11. UPC Supplementals will be disabled during calibration.

12. The Search Pass process will use the configurable Window of Interest for image cap-

tures. However, when the search process is completed, the WOI will be reduced to

include only the symbol of interest and some additional boundary area.

4-18 MS-4 Imager User’s Manual

Additional Notes about Calibration

MS-4 Imager User’s Manual 5-1

5 Read Cycle

Contents

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.

Read Cycle by ESP ...................................................................................................................... 5-2

Read Cycle Serial Commands......................................................................................................5-3

Read Cycle Setup......................................................................................................................... 5-4

Multisymbol................................................................................................................................... 5-5

Trigger Mode and Duration........................................................................................................... 5-6

External Trigger Polarity ............................................................................................................. 5-11

Serial Trigger .............................................................................................................................. 5-12

Start Trigger Character (Non-Delimited)..................................................................................... 5-13

Stop Trigger Character (Non-Delimited)..................................................................................... 5-13

End of Read Cycle...................................................................................................................... 5-14

Capture Mode............................................................................................................................. 5-16

Capture Timing ........................................................................................................................... 5-20

Image Processing Timeout......................................................................................................... 5-22

Image Storage ............................................................................................................................ 5-23

Minimum Good Reads ................................................................................................................ 5-25

Setting Up the Imager for EZ Trax..............................................................................................5-26

5-2 MS-4 Imager User’s Manual

Read Cycle by ESP

Click this button

to bring up the

Read Cycle

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 +.

MS-4 Imager User’s Manual 5-3

Read Cycle

Read Cycle Serial Commands

Trigger Mode/Duration <K200,trigger mode,trigger filter duration>

Serial Trigger Character <K201,serial trigger character>

External Trigger State <K202,external trigger state>

End of Read Cycle <K220,end of read cycle,read cycle timeout>

Minimum Good Reads <K221,minimum good reads>

Multisymbol <K222,number of symbols,multisymbol separator>

Start Trigger Character <K229,start character>

Stop Trigger Character <K230,stop character>

Capture Mode <K241,capture mode,number of captures,rapid capture mode>

Capture Timing <K242,time before first capture,time between first and second

captures,,,,,,,,time between seventh and eighth captures>

Image Storage <K244,image storage type,image store mode>

IP Timeout <K245,image processing timeout>

5-4 MS-4 Imager User’s Manual

Read Cycle Setup

Setting up read cycle and triggering parameters will involve a series of decisions based on

your particular application, as follows:

1. Select the number of symbols to be read in a single cycle. The MS-4 can read multiple

symbols in a single image frame.

2. Decide on the trigger type to be used: if serial, choose a serial character; if external,

choose either Level or Edge.

3. Designate how the read cycle should end (Timeout, New Trigger, Last Frame).

4. Select Capture Mode, Continuous Mode, or Rapid Mode.

5. Select Number of Captures (if in Rapid Capture Mode).

6. Set the Time Before First Capture and Time Between Captures, if any.

Note: The Imager’s camera captures images at a rate of about 16/second (based on a

full-size 640 x 480 image). The capture rate increases as frame sizes decrease.

Note:

If you need to set up your MS-4 for use with

EZ Trax

software, see

Setting Up the

Imager for EZ Trax.

MS-4 Imager User’s Manual 5-5

Read Cycle

Multisymbol

Number of Symbols

Multisymbol Separator

Note:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K222h,,3C>

For >: <K222h,,3E>

For , : <K222h,,2C>

See ASCII Character Entry Modifier on page 3-32 for a more detailed explanation of how

to enter ASCII characters as hex values.

Note: If No Read messages are disabled and there are No Reads occurring, separators

will only be inserted between symbol data outputs.

Usage: 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.

Definition: Multisymbol allows the user to define up to 100 symbols that can be read

in a single read cycle.

Conditions: The following conditions apply:

• Each symbol must be different to be read, unless in Rapid Capture

Mode, configured for “triggered capture”.

• The maximum number of characters in a read cycle is 3,000 for all

symbols.

• All No Read messages are posted at the end of the data string, unless

output filtering is enabled.

• If more than one symbol is within the field of view at the same time,

symbol data may not be displayed in the order of appearance.

•If

Matchcode Type

is set to

Sequential

or if

Trigger

is set to

Continuous

Read 1 Output

, the Imager will behave as if

Number of Symbols

were

set to

, regardless of the user-defined configuration.

Definition: Number of Symbols is the number of different symbols that can be read in

a single read cycle.

Serial Cmd: <K222,number of symbols, multisymbol separator>

Default: 1

Options: 1 to 100

Usage: Used to delimit or separate data fields with a user defined character.

Definition:

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.

5-6 MS-4 Imager User’s Manual

Trigger Mode and Duration

Trigger

Note: When calibrating the Imager or testing read rate, the current trigger setting will be

disregarded.

Trigger Mode

Continuous Read

Definition: The event that initiates the read cycle.

Serial Cmd: <K200,trigger mode,trigger filter duration>

Default: Continuous Read

Options: 0 = Continuous Read

2 = External Level

4 = Serial Data

1 = Continuous Read 1 Output

3 = External Edge

5 = Serial Data and External Edge

Usage: Continuous Read is useful in testing symbol readability or reader functions.

It is not recommended for normal operations.

Definition: In Continuous Read, trigger input options are disabled, the Imager is

always in the read cycle, and it will attempt to decode and transmit every

capture. If a single symbol stays within read range for multiple read cycles,

its data will be transmitted repeatedly until it leaves the read range.

The Imager sends replies to serial commands that require responses when

symbol data is transmitted, or read cycle timeout is enabled and a timeout

occurs and at least one captured image has been processed. Depending

on the combination of enabled symbologies and the Threshold Mode setting,

the Imager may take longer than the timeout to process a captured image.

Note: When to Output

and

No Read

options have no affect on

Continuous

Read.

Serial Cmd: <K200,0>

MS-4 Imager User’s Manual 5-7

Read Cycle

Continuous Read 1 Output

Caution: In automated environments, Continuous Read 1 Output is not recommended

because there is typically no reliable way to verify that a symbol was missed.

Note: If Trigger Mode is set to Continuous Read 1 Output, the Imager will behave as if

Number of Symbols were set to 1, regardless of the user-defined configuration.

Usage: 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.

Definition: In Continuous Read 1 Output the Imager self-triggers whenever it

decodes a new symbol or a timeout occurs.

If End of Read Cycle is set to Timeout and the symbol doesn’t change,

the output is repeated at the end of each timeout period. For example, if

Timeout

is set to one second, the Imager sends the symbol data immediately

and repeats the output at intervals of one second for as long as it continues

to capture the symbol.

If End of Read Cycle is set to New Trigger, the Imager will send the current

symbol data immediately, but only once. A new symbol appearing in the

Imager’s range will be read and sent immediately, provided it is not identical

to the previous symbol.

Serial Cmd: <K200,1>

5-8 MS-4 Imager User’s Manual

Trigger Mode and Duration

External Level

Important: Level and Edge apply to the active logic state (Negative or Positive) that exists

while the object is in a read cycle, between the rising edge and the falling edge. Rising edge

is the trigger signal associated with the appearance of an object. Falling edge is the trigger

signal associated with the subsequent disappearance of the object. This applies both to

External Level and External Edge.

External Edge

Usage: This mode is effective in an application where the speeds of the conveying

apparatus are variable and the time the Imager spends reading each object

is not predictable. It also allows the user to determine if a No Read has

occurred.

Definition: 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.

Serial Cmd: <K200,2>

Usage: This mode is highly recommended in any application where conveying

speed is constant, or if spacing, object size, or read cycle timeouts are

consistent.

Definition: 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.

Serial Cmd: <K200,3>

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.

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 sig-

nal initiates a new read cycle and

ends the previous read cycle unless

Timeout

is enabled and a good read

or timeout has not occured.

MS-4 Imager User’s Manual 5-9

Read Cycle

Serial Data

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 or External Edge

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.

Usage: 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.

Definition: In Serial Data, the Imager accepts an ASCII character from the host or

controlling device as a trigger to start a read cycle. A Serial Data trigger

behaves the same as an External Edge trigger.

Serial commands are entered inside angle brackets, as shown here: <t>.

Serial Cmd: <K200,4>

Usage: 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.

An auxiliary terminal can be connected to the auxiliary port so the user can

send the serial trigger character through the Imager to the host.

Definition: In this mode the Imager accepts either a serial ASCII character or an external

trigger pulse to start the read cycle.

Serial Cmd: <K200,5>

5-10 MS-4 Imager User’s Manual

Trigger Mode and Duration

Trigger Filter Duration

Note: If Trigger Mode is set to External Edge, the Imager will trigger only after the active

state has been delayed for the specified filter duration.

Note: If Trigger Mode is set to External Level, the Imager will trigger once the active

state has been delayed for the specified filter duration after the appearance of an object’s

active edge.

In addition, the active state must be delayed for the specified filter duration after the disappearance

of the object’s falling edge for the trigger to be rendered inactive.

Usage: Trigger Filter Duration allows the Imager to disregard false trigger

events.

Definition: When Trigger Mode is set to either External Edge or External Level, the

read cycle’s active state must be delayed until the specified filter duration

has elapsed. The Imager will trigger at the end of that duration.

Serial Cmd: <K200,trigger mode,trigger filter duration>

Default: 313 (x 32µs = 10.24mS)

Options: 1 to 65535 (corresponding with 32µs to 2.097seconds in 32µs steps)

MS-4 Imager User’s Manual 5-11

Read Cycle

External Trigger Polarity

Usage: Allows users to select the trigger polarity that will be used in their application.

Definition: Determines the active state of the trigger signal applied to the cable input of

the Imager.

Serial Cmd: <K202,active state>

Default: Positive

Options: 0 = Negative 1 = Positive

5-12 MS-4 Imager User’s Manual

Serial Trigger

Serial Trigger Character (Delimited)

Note: Serial Data or Serial Data or External Edge triggering mode must be enabled for

Serial Trigger Character to take effect.

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K201h,3C>

For >: <K201h,3E>

For , : <K201h,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Usage: Allows the user to define the trigger character and delimiters that start

and stop the read cycle.

Definition: 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.

Usage: Allows the user to define the trigger character that initiates the read cycle.

Definition: A single ASCII host serial trigger character that initiates the read cycle.

A delimited trigger character is one that either starts or ends the read cycle

and is enclosed by delimiters such as < >.

Serial Cmd: <K201,serial trigger character>

Default: Space bar

Options: Any single ASCII character, including control characters, except NUL (00 in

hex), an existing host command character, or an on-line protocol character.

Control characters entered on the command line are displayed in the menu

as mnemonic characters.

MS-4 Imager User’s Manual 5-13

Read Cycle

Start Trigger Character (Non-Delimited)

Note: See ASCII Character Entry Modifier on page 3-32 for hex entry instructions.

Stop Trigger Character (Non-Delimited)

Note: See ASCII Character Entry Modifier on page 3-32 for hex entry instructions.

Usage: Useful in applications where different characters are required to start a

read cycle.

Definition: A single ASCII host serial trigger character that starts the read cycle and is

not enclosed by delimiters such as < and >.

Non-delimited Start characters can be defined and will function according

to the trigger event.

When defining Start trigger characters, the following rules apply:

•In External Edge the Imager looks only for the Start trigger character

and ignores any Stop trigger character that may be defined.

•In External Level the Start trigger character begins the read cycle and

the Stop trigger character ends it. Note that even after a symbol has

been decoded and the symbol data transmitted, the Imager remains in

External Level trigger read cycle until a Stop character is received.

•In Serial Data or External Edge trigger mode, either a Start trigger

character or a hardware trigger can start an edge trigger read cycle.

Serial Cmd: <K229,start character>

Default: NUL (00 in hex) (disabled)

Options:

Two hex digits representing any ASCII character.

Usage: Useful in applications where different characters are required to end a

read cycle.

Definition: A single ASCII host serial trigger character that ends the read cycle and is

not enclosed by delimiters such as < and >.

Non-delimited Stop characters can be defined and will function according

to the trigger event.

When defining Stop trigger characters, the following rules apply:

•In External Edge the Imager looks only for the Start trigger character

and ignores any Stop trigger character that may be defined.

•In External Level the Start trigger character begins the read cycle and

the Stop trigger character ends it. Note that even after a symbol has

been decoded and the symbol data transmitted, the Imager remains in

External Level trigger read cycle until a Stop character is received.

•In Serial Data or External Edge trigger mode, either a Start trigger

character or a hardware trigger can start an edge trigger read cycle.

Serial Cmd: <K230,stop character>

Default: NUL (00 in hex) (disabled)

Options:

Two hex digits representing any ASCII character.

5-14 MS-4 Imager User’s Manual

End of Read Cycle

End of Read Cycle Mode

Note: When operating in Continuous Read or Continuous Read 1 Output, the Imager is

always in the read cycle.

Timeout

Definition: The read cycle is the time during which the Imager will attempt to capture

and decode a symbol. A read cycle can be ended by a timeout, a new

trigger, or by the last frame in a capture sequence or a combination of the

above.

Serial Cmd: <K220,end of read cycle,read cycle timeout>

Default: Timeout

Options: 0 = Timeout

2 = Timeout or new Trigger

4 = Last Frame or New Trigger

1 = New Trigger

3 = Last Frame

Usage: 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.

Definition: 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.

MS-4 Imager User’s Manual 5-15

Read Cycle

New Trigger

Timeout or New Trigger

Last Frame

Last Frame or New Trigger

Read Cycle Timeout

Usage: New Trigger is an effective way to end a read cycle when objects move

past the reader at irregular intervals (not timing-dependent).

Definition: 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.

Usage: 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.

Definition: Timeout or New Trigger is identical to Timeout except that a timeout or a

new trigger (whichever occurs first) ends the read cycle.

Usage: Useful in applications in which the number of captures needed can be

defined but the timeout duration varies.

Definition: Last Frame only applies to Rapid Capture Mode.

Usage: 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.

Definition: 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.

Definition: Read Cycle Timeout is the duration of the read cycle.

Serial Cmd: <K220,end of read cycle,read cycle timeout>

Default: 200 (x10mS)

Options: 1 to 65,535

5-16 MS-4 Imager User’s Manual

Capture Mode

Rapid Capture

Continuous Capture

Definition: Capture Mode relates to the way that images are captured and processed.

Serial Cmd: <K241,capture mode,number of captures,rapid capture mode>

Default: Continuous Capture

Options: 0 = Rapid Capture 1 = Continuous 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.

Usage: Continuous Capture is useful in applications with slower line speeds or

where symbol spacing may be random or not time-dependent.

Definition: In Continuous Capture Mode, image captures are taken throughout the

read cycle in a multi-buffered format (see diagram below). The Imager

begins processing the first captured image at the same time that it captures

the second image. Captures will continue occurring throughout the read

cycle until an end condition occurs, such as a timeout, a new trigger, the

last frame in a capture sequence, or a combination of the above.

Processing time

End of

read cycle

Capture

Start of Read

Cycle 12345

MS-4 Imager User’s Manual 5-17

Read Cycle

Number of Captures

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 (640 x 480) 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 32.

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

Usage: Used to increase the opportunities for good reads and to “extend” the field

of view in dynamic applications.

Definition:

Sets the total number of captures that are processed during a read cycle in

Rapid Capture Mode

when

Switching Mode

is set to

Number of Captures

Serial Cmd: <K241,capture mode,number of captures,rapid capture mode>

Default: 1

Options:

to 32

Definition: 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.

Serial Cmd: <K241,capture mode,number of captures,rapid capture mode>

Default: Timed Capture

Options:

0 = Timed Capture

1 = Triggered Capture

5-18 MS-4 Imager User’s Manual

Timed Capture

Usage: Timed 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.

Definition: 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.

Start of Read Cycle No Time Delay Between Captures

nEnd of

read cycle

Time Delay Between Captures

Time Before First Capture

Diagram B

Diagram A

Processing

End of

read cycle

MS-4 Imager User’s Manual 5-19

Read Cycle

Triggered Capture

Usage: Useful in applications where each decode must be treated as a discrete

event, regardless of symbol data.

Definition: When Rapid Capture Mode is set to Triggered Capture, each decode is

considered a separate event, even if the current decode data is identical to

the previous decode 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.

Processing

Read cycle ends

on New Trigger

or Timeout, as

configured.

Captures on every trigger Capture

First trigger

starts the read

cycle

5-20 MS-4 Imager User’s Manual

Capture Timing

Note: Capture Timing applies only to Rapid Capture Mode.

Time Before First Capture

Usage: In almost any moving line application, a time delay is needed to ensure that

a symbol will be in the Imager’s field of view at the beginning of the capture

sequence.

Definition: Time Before First Capture in a moving line application is the time between

an external trigger event and the occurrence of the first capture.

Serial Cmd: <K242,time before 1st capture,time between capture 1 and capture

2,,,,,,,,time between capture 7 and capture 8>

Default: 0

Options:

0 to 65535 (2.097 seconds, in 32

µS increments)

Start of Read

Cycle

Time Before First Capture

Processing

MS-4 Imager User’s Manual 5-21

Read Cycle

Time Between Captures

Note: Number of Captures and number of frame delays (Time Between Captures) must

be the same.

Usage: 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.

Definition: A time delay can be inserted between individual frame captures in Rapid

Capture Mode.

Serial Cmd: <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.

Default: 0

Options:

0 to 65535 (2.097 seconds, in 32

µS increments)

Diagram A

Start of Read Cycle

End of

Read Cycle

Time Delay Between Captures varies.

Time Delay Between Captures = 0

Diagram B

32145

5-22 MS-4 Imager User’s Manual

Image Processing Timeout

Caution: Image Processing Timeout, if not properly set, can have a negative impact on

good reads.

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.

Usage: Useful in higher speed applications where image processing time is long

enough that not all captures have an opportunity to be processed.

Definition: 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.

Serial Cmd: <K245,image processing timeout>

Default: 5,000 mS (5 sec.)

Options: 1 to 65535 (in 1mS increments)

MS-4 Imager User’s Manual 5-23

Read Cycle

Image Storage

Image Storage Type

Disabled / Clear

Upon selection of this option, all saved images will be cleared and the Imager will not store

images for later viewing.

Store on No Read

This option will cause the Imager to store an image upon exiting the read cycle for retrieval

at a later time. If multiple captures are present during the duration of a read cycle, the

stored image will be the last image processed for that read cycle. This image is stored in

RAM and can be retrieved as long as power is cycled to the Imager, and as long as the

Imager has not been reset via a reset/save sequence. Other commands that can initialize

storage in RAM are ones that change capture modes or put the Imager in a test capture

mode.

Image Storage Mode

First Mode

This mode allows the Imager to store images until the available image memory has been

filled. At that point the Imager will stop saving additional images. In this mode, you will

always have the first image captured, because the saving process stops once memory

has been filled.

Last Mode

In this mode, image storage continues after available memory limits are reached. The oldest

image in memory is overwritten, so you will always have the most recent stored image.

Definition: Allows the user to store images from separate read cycles and to retrieve

them later. The number of available slots for storage depends on the mode

of operation. If the Imager is in Rapid Capture Mode, the number of

images that can be stored is equivalent to the maximum number of the

rapid count (the current rapid count setting). If the Imager is in Continuous

Capture Mode, a number of images equivalent to the maximum number of

the rapid count minus 3.

Serial Cmd: <K244,image storage type,image storage mode>

Default: Disabled/Clear

Options: 0 = Disabled/Clear 1 = Store on No Read

Serial Cmd: <K244,image storage type,image storage mode>

Default: First Mode

Options: 0 = First Mode 1 = Last Mode

5-24 MS-4 Imager User’s Manual

Image Storage

Image Storage Example

The following example assumes that the Imager is in a rapid capture mode of 3 captures.

Number of Symbols: 1

Frame # 1: No Read

Frame # 2: No Read

Frame # 3: Good Read, Symbol # 1

Read Cycle Result: Good Read

Stored Frame: None

Number of Symbols: 1

Frame # 1: No Read

Frame # 2: No Read

Frame # 3: No Read

Read Cycle Result: No Read

Stored Frame: Frame # 3

Number of Symbols: 2

Frame # 1: No Read

Frame # 2: No Read

Frame # 3: Good Read, Symbol # 1

Read Cycle Result: No Read

Stored Frame: Frame # 2

MS-4 Imager User’s Manual 5-25

Read Cycle

Minimum Good Reads

Definition: This value specifies the number of times a symbol needs to be read to

qualify as a good read.

Serial Cmd: <K221,minimum good reads>

Default: 1

Options: 1 to 255

5-26 MS-4 Imager User’s Manual

Setting Up the Imager for EZ Trax

If you are using

EZ Trax

software, it is important to set up the MS-4 correctly before beginning.

Click the Read Cycle button to display the Read Cycle tree control.

Set Trigger Mode, <K200>, to External Edge.

Set Capture Mode, <K241>, to Rapid Capture.

Once these Read Cycle parameters are set, you will be ready to connect to EZ Trax. For a

description of how to configure

EZ Trax

using serial commands or

ESP

, see

Configuring EZ

Trax Output

in Chapter 7,

I/O Parameters

For more detailed information about using EZ Trax, refer to the Help menu in EZ Trax

software, or the EZ Trax Quick Start Guide, available on the Microscan Tools CD.

MS-4 Imager User’s Manual 6-1

6 Symbologies

Contents

This section describes the various symbol types that can be read and decoded by the MS-4

Imager.

See the following sites for additional information about linear and 2D symbologies:

http://www.aimglobal.org/standards/aimpubs.asp

http://barcodes.gs1us.org/dnn_bcec/Default.aspx?tabid=82

Symbologies by ESP.................................................................................................................... 6-2

Symbologies Serial Commands ................................................................................................... 6-3

Data Matrix................................................................................................................................... 6-4

QR Code ...................................................................................................................................... 6-6

Code 39........................................................................................................................................ 6-7

Code 128 / EAN 128 .................................................................................................................. 6-10

BC412 ........................................................................................................................................ 6-13

Interleaved 2 of 5........................................................................................................................ 6-14

Code 93...................................................................................................................................... 6-17

Codabar...................................................................................................................................... 6-18

UPC / EAN ................................................................................................................................. 6-21

GS1 DataBar (RSS) ................................................................................................................... 6-25

PDF417 ...................................................................................................................................... 6-27

MicroPDF417 ............................................................................................................................. 6-29

Composite .................................................................................................................................. 6-30

Narrow Margins / Symbology Identifier ...................................................................................... 6-31

Background Color....................................................................................................................... 6-33

6-2 MS-4 Imager User’s Manual

Symbologies by ESP

Click this button

to bring up the

Symbologies

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 +.

MS-4 Imager User’s Manual 6-3

Symbologies

Symbologies Serial Commands

Narrow Margins/Symbology ID <K450,narrow margin status,symbology identifier status>

Background Color <K451,background color>

Composite <K453,symbology status,separator status,separator>

Code 39 <K470,status,check digit status,check digit output status,large inter-

character gap,fixed symbol length status,fixed symbol length,full

ASCII set>

Codabar <K471,status,start/stop match,start/stop output,large intercharacter

gap,fixed symbol length status,symbol length,check digit type,check

digit output>

Interleaved 2 of 5 <K472,status,check digit status,check digit output status,symbol

length #1, symbol length #2, guard bar status,range mode status>

UPC/EAN <K473,UPC status,EAN status,supplemental status,separator sta-

tus,separator character,supplemental type,format UPC-E as UPC-A>

Code 128/EAN 128 <K474,status,fixed symbol length status,fixed symbol length,EAN

128 status,output format,application record separator status,applica-

tion record separator character,application record brackets,applica-

tion record padding>

Code 93 <K475,status,fixed symbol length status,symbol length>

PDF417 <K476,status,[unused],fixed symbol length status,fixed symbol

length,[unused],codeword collection>

Data Matrix <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>

QR Code <K480,status>

BC412 <K481,status,check digit output,fixed symbol length status,fixed

symbol length>

DataBar-14 <K482,status>

DataBar Limited <K483,status>

DataBar Expanded <K484,status,fixed symbol length status,fixed symbol length>

MicroPDF417

K485,

status,[unused],fixed symbol length status,fixed symbol length>

6-4 MS-4 Imager User’s Manual

Data Matrix

ECC 200

ECC 000

ECC 050

Usage: 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.

Definition: 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.

Definition: When enabled, will decode ECC 200 Data Matrix symbols.

Serial Cmd: <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>

Default: Enabled

Note: This is the only symbol type enabled by default.

Options: 0 = Disabled 1 = Enabled

Definition: When enabled, will decode ECC 000 symbols.

Serial Cmd: <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>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: When enabled, will decode ECC 050 symbols.

Serial Cmd: <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>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 6-5

Symbologies

ECC 080

ECC 100

ECC 140

ECC 120

ECC 130

Definition: When enabled, will decode ECC 080 symbols.

Serial Cmd: <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>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: When enabled, will decode ECC 100 symbols.

Serial Cmd: <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>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: When enabled, will decode ECC 140 symbols.

Serial Cmd: <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>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: When enabled, will decode ECC 120 symbols.

Serial Cmd: <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>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: When enabled, will decode ECC 130 symbols.

Serial Cmd: <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>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

6-6 MS-4 Imager User’s Manual

QR Code

Usage: Widely implemented in the automotive industry in Japan and throughout

their worldwide supply chain.

Definition: 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.

Serial Cmd: <K480,status>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 6-7

Symbologies

Code 39

Check Digit Status (Code 39)

Check Digit Output Status (Code 39)

Usage: Code 39 is considered the standard for non-retail 1D symbology.

Definition: An alphanumeric symbology with unique start/stop code patterns, composed

of 9 black and white elements per character, of which 3 are wide.

Serial Cmd: <K470,status,check digit status,check digit output status,large intercharacter

gap,fixed symbol length status,fixed symbol length,full ASCII set>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Serial Cmd:

K470,

status,

check digit status

,check digit output status,large intercharacter

gap,fixed symbol length status,fixed symbol length,full ASCII set>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: Check Digit Output Status, added to the symbol, provides additional

data security.

Definition: When enabled, the check digit character is read and compared along with

the symbol data. When disabled, symbol data is sent without the check

digit.

Note: With Check Digit Output Status and an External or Serial trigger

option enabled, an invalid check digit calculation will cause a No Read

message to be transmitted at the end of the read cycle.

Serial Cmd:

K470,

status,check digit status,

check digit output status

,large intercharacter

gap,fixed symbol length status,fixed symbol length,full ASCII set>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

6-8 MS-4 Imager User’s Manual

Code 39

Large Intercharacter Gap (Code 39)

Fixed Symbol Length Status (Code 39)

Fixed Symbol Length (Code 39)

Usage: Large Intercharacter Gap is helpful for reading symbols that are printed

out of specification.

Caution: Do not use Large Intercharacter Gap with Narrow Margins

enabled, because a large intercharacter gap (over 3x) could cause a narrow

margin (5x) to be interpreted as an intercharacter gap.

Definition: When enabled, the Imager can read symbols with gaps between symbol

characters that exceed three times (3x) the narrow element width.

Serial Cmd: <K470,status,check digit status,check digit output status,large intercharacter

gap,fixed symbol length status,fixed symbol length,full ASCII set>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: When enabled, the Imager will check the symbol length against the symbol

length field. If disabled, any length will be considered valid.

Serial Cmd: <K470,status,check digit status,check digit output status,large intercharacter

gap,fixed symbol length status,fixed symbol length,full ASCII set>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: Fixed Symbol Length helps prevent truncations and increases data integrity

by ensuring that only one symbol length will be accepted.

Definition: Specifies the exact number of characters that the Imager will recognize

(this does not include start and stop and check digit characters). The

Imager ignores any symbology that does not match the specified length.

Serial Cmd: <K470,status,check digit status,check digit output status,large intercharacter

gap,fixed symbol length status,fixed symbol length,full ASCII set>

Default: 10

Options: 1 to 64

MS-4 Imager User’s Manual 6-9

Symbologies

Full ASCII Set (Code 39)

Usage: 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.

Definition: Standard Code 39 encodes 43 characters; zero through nine, capital “A”

through capital “Z”, minus symbol, plus symbol, forward slash, space,

decimal point, dollar sign, and percent symbol. When Full ASCII Set is

enabled, the Imager can read the full ASCII character set, from 0 to 255.

Serial Cmd: <K470,status,check digit status,check digit output status,large intercharacter

gap,fixed symbol length status,fixed symbol length,full ASCII set>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

6-10 MS-4 Imager User’s Manual

Code 128 / EAN 128

Fixed Symbol Length Status (Code 128 / EAN 128)

Fixed Symbol Length (Code 128 / EAN 128)

Usage: Code 128 is a smaller symbology useful in applications with tight spots

and high security needs.

Definition: 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.

Serial Cmd:

K474,status

,fixed symbol length status,fixed symbol length,EAN 128 status

output format,application record separator status,application record separator

character,application record brackets,application record padding>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: When enabled, the Imager will check the symbol length against the symbol

length field. If disabled, any length will be considered a valid symbol.

Serial Cmd: <K474,status,fixed symbol length status,fixed symbol length,EAN 128

status,output format,application record separator status,application record

separator character,application record brackets,application record padding>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: Fixed Symbol Length helps prevent truncations and increases data

integrity by ensuring that only one symbol length will be accepted.

Definition: This specifies the exact number of characters that the Imager will recognize

(this does not include start, stop, and check digit characters). The Imager

ignores any symbol not having the specified length.

Serial Cmd: <K474,status,fixed symbol length status,fixed symbol length,EAN 128

status,output format,application record separator status,application record

separator character,application record brackets,application record padding>

Default: 10

Options: 1 to 64

MS-4 Imager User’s Manual 6-11

Symbologies

EAN 128 Status (Code 128 / EAN 128)

Output Format (Code 128 / EAN 128)

Application Record Separator Status

(Code 128 / EAN 128)

Definition: When this field is disabled, the Imager will not check any Code 128 labels

for conformance to EAN requirements, or perform any special formatting.

When enabled, the Imager can read symbols with or without a function 1

character in the first position. If a symbol has a function 1 character in the

first position, it must conform to EAN format. Symbols that conform to EAN

format will also be subject to the special output formatting options available

in this command.

Note: Code 128 status must be enabled for EAN status to be active.

If EAN status is required, the Imager will only decode symbols that have a

function 1 character in the first position and that conform to EAN format. All

symbols read will be subject to the special output formatting options available

in this command.

Note: Code 128 status must be enabled for EAN status to be active.

Serial Cmd: <K474,status,fixed symbol length status,fixed symbol length,EAN 128 status,

output format,application record separator status,application record separator

character,application record brackets,application record padding>

Default: Disabled

Options: 0 = Disabled 1 = Enabled 2 = Required

Definition: In Standard, the Imager will not apply special EAN output formatting

options.

In Application, the Imager will apply the special EAN output formatting

options to decoded EAN-conforming symbols.

Serial Cmd: <K474,status,fixed symbol length status,fixed symbol length,EAN 128 status,

output format

,application record separator status,application record separator

character,application record brackets,application record padding>

Default: Standard

Options: 0 = Standard 1 = Application

Definition: 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.

Serial Cmd: <K474,status,fixed symbol length status,fixed symbol length,EAN 128 status,

output format,application record separator status,application record

separator character,application record brackets,application record padding>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

6-12 MS-4 Imager User’s Manual

Code 128 / EAN 128

Application Record Separator Character

(Code 128 / EAN 128)

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K

474

h,,,,,,,3C>

For >: <K

474

h,,,,,,,3E>

For , : <K

474

h,,,,,,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Application Record Brackets (Code 128 / EAN 128)

Application Record Padding (Code 128 / EAN 128)

Definition: This is an ASCII character that serves as an EAN separator in formatted EAN

output.

Serial Cmd: <

K474,

status,fixed symbol length status,fixed symbol length,EAN 128 status,

output format,application record separator status,

application record separator

character

,application record brackets,application record padding>

Default:

Options: Any ASCII character (7 bit).

Definition: If an EAN-conforming symbol is decoded and EAN formatting applies, this

feature places bracket characters “( )” around the application identifiers in

the formatted output.

Serial Cmd: <K474,status,fixed symbol length status,fixed symbol length,EAN 128 status,

output format,application record separator status,application record separator

character,application record brackets,application record padding>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: This feature causes the Imager to pad variable-length application fields with

leading zeroes. This is not done for the last field of a symbol.

Serial Cmd: <K474,status,fixed symbol length status,fixed symbol length,EAN 128 status,

output format,application record separator status,application record separator

character,application record brackets,application record padding>

Default: Enabled

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 6-13

Symbologies

BC412

Check Digit Output (BC412)

Fixed Symbol Length Status (BC412)

Fixed Symbol Length (BC412)

Usage: Widely used in semiconductor manufacturing. Particularly useful where

speed, accuracy, and ease of printing are required.

Definition: 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.

Serial Cmd: <K481,status,check digit output,fixed symbol length status,fixed symbol

length>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: Check Digit Output, added to the symbol, provides additional security.

Definition: When enabled, the check digit character is read and compared along with

the symbol data. When disabled, symbol data is sent without the check

digit.

Serial Cmd: <K481,status,check digit output,fixed symbol length status,fixed symbol

length>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: When enabled, the Imager will check the symbol length against the symbol

length field. If disabled, any length will be considered valid.

Serial Cmd: <K481,status,check digit output,fixed symbol length status,fixed symbol

length>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: When enabled, the check digit character is read and compared along with

the symbol data. When disabled, symbol data is sent without the check

digit.

Serial Cmd: <K481,status,check digit output,fixed symbol length status,fixed symbol

length>

Default: 10

Options: 1 to 64

6-14 MS-4 Imager User’s Manual

Interleaved 2 of 5

Check Digit Status (Interleaved 2 of 5)

Check Digit Output Status (Interleaved 2 of 5)

Usage: I-2/5 has been popular because it is the most dense symbology for printing

numeric characters less than 10 characters in length; however, Microscan

does not recommend this symbology for any new applications because of

inherent problems such as truncation.

Definition: 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 digit is highly recommended).

Important: You must set Symbol Length in order to decode I-2/5 symbols,

unless Range Mode is enabled.

Serial Cmd: <K472,status,check digit status,check digit output status,symbol length

#1,symbol length #2,guard bar status,range mode status>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: This option is not typically used, but it can be enabled for additional security

in applications where the host requires redundant check digit verification.

Definition: An error correcting routine in which the check digit character is added.

Serial Cmd: <K472,status,check digit status,check digit output status,symbol length

#1,symbol length #2,guard bar status,range mode status>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: When enabled, a check digit character is sent along with the symbol data

for added data security.

Serial Cmd: <K472,status,check digit status,check digit output status,symbol length

#1,symbol length #2,guard bar status,range mode status>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 6-15

Symbologies

Symbol Length #1 (Interleaved 2 of 5)

Symbol Length #2 (Interleaved 2 of 5)

Usage: Useful in applications where I 2/5 symbols of a specific length are required.

Definition: 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.

Serial Cmd: <K472,status,check digit status,check digit output,symbol length #1,symbol

length #2,guard bar status,range mode status>

Default: 10

Options: 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.

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.

Usage: Useful in applications where I 2/5 symbols of a specific length are required.

Definition: 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.

Serial Cmd: <K472,status,check digit status,check digit output,symbol length #1,symbol

length #2,guard bar status,range mode status>

Default: 6

Options: 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.

Range Mode

is enabled,

Symbol Length # 2

and

Symbol Length # 1

form

a range into which the length of the symbol must fall to be considered valid.

6-16 MS-4 Imager User’s Manual

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.

Range Mode Status (Interleaved 2 of 5)

Usage: Useful when I-2/5 multisymbols are enabled to prevent false data output.

This typically occurs with highly tilted or skewed symbols.

Definition: 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.

Serial Cmd: <K472,status,check digit status,check digit output,symbol length #1,symbol

length #2,guard bar status,range mode status>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: Useful in applications where I 2/5 symbols of a specific length are required.

Definition: When Range Mode is disabled, the Imager checks the value of the symbol

length against the values set in Symbol Length # 1 and Symbol Length #

2. If the symbol length does not match either of the preset values, then it is

rejected as invalid.

When Range Mode is enabled, Symbol Length # 1 and Symbol Length #

2 are combined to form a range of valid symbol lengths. Any symbol length

that does not fall into this range is rejected as an invalid symbol. Either of

the preset symbol length values in the Symbol Length # 1 and Symbol

Length # 2 fields can form the start or end of the range.

Serial Cmd: <K472,status,check digit status,check digit output,symbol length #1,symbol

length #2,guard bar status,range mode status>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 6-17

Symbologies

Code 93

Fixed Symbol Length Status (Code 93)

Symbol Length (Code 93)

Usage: Sometimes used in clinical applications.

Definition: 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.

Serial Cmd: <K475,status,fixed symbol length status,symbol length>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: When disabled, the Imager will accept any Code 93 symbol provided is

doesn’t exceed the system’s maximum capabilities.

When enabled, the Imager will reject any Code 93 symbol that doesn’t

match the fixed symbol length.

Serial Cmd: <K475,status,fixed symbol length status,symbol length>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: This is the symbol length value against which all Code 93 symbols will be

compared.

Serial Cmd: <K475,status,fixed symbol length status,symbol length>

Default: 10

Options: 1 to 64

6-18 MS-4 Imager User’s Manual

Codabar

Start / Stop Match (Codabar)

Start / Stop Output (Codabar)

Usage: Used in photo-finishing and library applications. Previously used in medical

applications, but not typically used in newer medical applications.

Definition: 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.

Serial Cmd:

K471,status

,start/stop match,start/stop output,large intercharacter gap,fixed

symbol length status,symbol length,check digit type,check digit output>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: When disabled, the Imager will decode Codabar symbols whether or not

the start and stop characters are the same.

When enabled, the Imager will not decode Codabar symbols unless the

start and stop characters are the same.

Serial Cmd:

K471,

status,

start/stop match

,start/stop output,large intercharacter gap,fixed

symbol length status,symbol length,check digit type,check digit output>

Default: Enabled

Options: 0 = Disabled 1 = Enabled

Definition: 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.

Serial Cmd:

K471,

status,start/stop match,

start/stop output

,large intercharacter gap,fixed

symbol length status,symbol length,check digit type,check digit output>

Default: Enabled

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 6-19

Symbologies

Large Intercharacter Gap (Codabar)

Fixed Symbol Length Status (Codabar)

Symbol Length (Codabar)

Definition: When disabled, the spaces between characters, or the “inter-character

gap”, are ignored during the decode process.

Note: If the inter-character space is large enough to be considered a margin,

the symbol will not decode, regardless of this parameter’s setting.

Serial Cmd:

K471,

status,start/stop match,start/stop output,

large intercharacter gap

,fixed

symbol length status,symbol length,check digit type,check digit output>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: When disabled, the Imager will accept any Codabar symbol provided it

doesn’t exceed the system’s maximum capabilities.

When enabled, the Imager will reject any Codabar symbol that doesn’t

match the fixed length.

Serial Cmd:

K471,

status,start/stop match,start/stop output,large intercharacter gap,

fixed

symbol length status

,symbol length,check digit type,check digit output>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: This is the value against which all Codabar symbol lengths will be compared.

Serial Cmd: <K471,status,start/stop match,start/stop output,large intercharacter gap,fixed

symbol length status,symbol length,check digit type,check digit output>

Default: 10

Options: 1 to 64

6-20 MS-4 Imager User’s Manual

Codabar

Check Digit Type (Codabar)

Check Digit Output (Codabar)

Definition:

When disabled, the Imager will not perform any character checking calculations

on decoded Codabar symbols.

When set to Mod 16, the Imager will perform a modulus 16 check character

calculation on the symbol. If the symbol does not pass this calculation, it

will not be decoded.

When set to

NW7

, The Imager will perform an NW7 modulus 11 check character

calculation on the symbol. If the symbol does not pass this calculation, it will not

be decoded.

When set to

Both

, the Imager will perform both the Mod 16 and NW7 modulus

11 check character calculations on the symbol. If the symbol does not pass

either calculation, it will not be decoded.

Serial Cmd: <K471,status,start/stop match,start/stop output,large intercharacter gap,fixed

symbol length status,symbol length,check digit type,check digit output>

Default: Disabled

Options: 0 = Disabled 1 = Mod 16 2 = NW7 (Mod 11)

3 = Mod 16 and NW7

Definition: When this field is disabled and a check digit calculation is enabled, the

Imager will strip the verified check digit from the symbol data output. This

condition must be accounted for if a fixed length is also being used.

When enabled, the Imager will output the check character as part of the

symbol data. This condition must be accounted for if a fixed length is also

being used.

Serial Cmd: <K471,status,start/stop match,start/stop output,large intercharacter gap,fixed

symbol length status,symbol length,check digit type,check digit output>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 6-21

Symbologies

UPC / EAN

EAN Status

Usage: Used primarily in POS application 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.

Definition: UPC (Universal Product Code) is a fixed length, numeric, continuous

symbology. UPC can have two- or five-digit supplemental bar code data

following the normal code. The UPC Version A (UPC, A) symbol is used to

encode a 12 digit number. The first digit is the number system character,

the next five are the manufacturer number, the next five are the product

number, and the last digit is the checksum character.

When enabled, the Imager will read UPC Version A and UPC Version E

only.

Serial Cmd: <K473,UPC status,EAN status,supplementals status,separator status,

separator character,supplemental type,format UPC-E as UPC-A>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: 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.

Definition: EAN is a subset of UPC. When enabled, the Imager will read UPC Version

A, UPC Version E, EAN 13, and EAN 8. It also appends a leading zero to

UPC Version A symbol information and transmits 13 digits. If transmitting

13 digits when reading UPC Version A symbols is not desired, disable EAN.

Note: The extra character identifies the country of origin.

Serial Cmd: <K473,UPC status,EAN status,supplementals status,separator status,

separator character,supplemental type,format UPC-E as UPC-A>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

6-22 MS-4 Imager User’s Manual

UPC / EAN

Supplementals Status (UPC / EAN)

Disabled

UPC Supplementals will not be decoded.

Enabled

When enabled, the Imager will try to decode a main and a supplemental. However, if a

supplemental is not decoded, the main will be sent by itself at the end of the read cycle.

Required

When set to Required, both the main and the supplemental symbols must be read or a

single No Read condition results.

For example, if Supplementals is set to Required, Separator is enabled, and an asterisk

is defined as the UPC separator character. Then the data is displayed as:

MAIN * SUPPLEMENTAL.

Note: Under no circumstances will the supplemental symbol data be sent without a main

symbol.

Note: If additional symbols—other than the main or supplemental—will be read in the

same read cycle, Number of Symbols should be set accordingly.

Separator Status (UPC / EAN)

Usage: Reads Supplementals typically used in publications and documentation.

Definition: A supplemental is a 2 to 5 digit symbol appended to the main symbol.

When set to Enabled or Required, the Imager reads supplemental code

data that has been appended to the standard UPC or EAN codes.

Serial Cmd: <K473,UPC status,EAN status,supplementals status,separator status,

separator character,supplemental type,format UPC-E as UPC-A>

Default: Disabled

Options: 0 = Disabled 1 = Enabled 2 = Required

Usage: Allows users to distinguish between the main and Supplemental symbols.

Definition: A character can be inserted between the standard UPC or EAN symbology

and the supplemental symbology when Supplementals is set to Enabled

or Required.

Serial Cmd: <K473,UPC status,EAN status,supplementals status,separator status,

separator character,supplemental type,format UPC-E as UPC-A>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 6-23

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.

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K

473

h,,,,,3C>

For >: <K

473

h,,,,,3E>

For , : <K

473

h,,,,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

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.

Supplemental Type (UPC / EAN)

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.

Usage: As required by the application.

Definition: Allows the user to change the separator character from a comma to a new

character.

Serial Cmd: <K473,UPC status,EAN status,supplementals status,separator status,

separator character,supplemental type,format UPC-E as UPC-A>

Default: , (comma)

Options: Any ASCII character.

Usage: As required by symbology used in application.

Definition: Allows the user to select 2 character or 5 character supplements, or both.

Serial Cmd: <K473,UPC status,EAN status,supplementals status,separator status,

separator character,supplemental type,format UPC-E as UPC-A>

Default: Both

Options: 0 = Both 1 = 2 characters only 2 = 5 characters only

6-24 MS-4 Imager User’s Manual

UPC / EAN

Format UPC-E as UPC-A (UPC / EAN)

Definition: When disabled, the Imager will output the version E symbols in their

encoded 6-character format.

When enabled, the Imager will format the symbol as either a 12-character

UPC-A symbol or an EAN-13 symbol, depending on the state of the EAN

status parameter. This formatting reverses the zero suppression that is

used to generate the symbol in the UPC specification.

Serial Cmd: <K473,UPC status,EAN status,supplementals status,separator status,

separator character,supplemental type,format UPC-E as UPC-A>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 6-25

Symbologies

GS1 DataBar (RSS)

DataBar Expanded

Where appropriate, use 1 (non-stacked) for better performance over 2 (stacked and non-

stacked).

Fixed Symbol Length Status (DataBar Expanded)

Fixed Symbol Length (DataBar Expanded)

Usage: Used to encode primary and supplementary data in retail point-of-sale and

other applications.

Definition:

DataBar Expanded is a variable length symbology that can encode supple-

mentary

information in addition to the 14-digit EAN item identification num-

ber and is capable of encoding up to 74 numeric or 41 alphabetic

characters.

Serial Cmd: <K484,status,fixed symbol length status,fixed symbol length>

Default: Disabled

Options: 0 = Disabled 1 = Enabled (non-stacked) 2 = Enabled (stacked and

non-stacked)

Definition: When enabled, the Imager will check the symbol length against the symbol

length field, minus the embedded check digit. If disabled, any length

would be considered valid.

Serial Cmd: <K484,status,fixed symbol length status,fixed symbol length>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: Fixed Symbol Length helps prevent truncations and increases data

integrity by ensuring that only one symbol length will be accepted.

Definition: Specifies the exact number of characters that the Imager will recognize

(this does not include start, stop, and check digit characters). The Imager

ignores any symbol not having the specified length.

Serial Cmd: <K484,status,fixed symbol length status,fixed symbol length>

Default: 14

Options: 1 to 74

6-26 MS-4 Imager User’s Manual

GS1 DataBar (RSS)

DataBar Limited

DataBar-14

Note: Where appropriate, use 1 (non-stacked) for better performance over 2 (stacked;

decode both stacked and non-stacked).

Usage: DataBar Limited is designed to be read by laser and CCD readers. It is

not recommended for omnidirectional slot scanners.

Definition: Encodes a smaller 14-digit symbol (74 modules wide) that is not omni-

directional.

Serial Cmd: <K483,status>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: Used in the grocery, retail, and prescription drug industries where 14-digit

EAN item identification may be needed.

Definition: DataBar-14 (Reduced Space Symbology) is a fixed symbol length sym-

bology 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 omnidirec-

tionally if printed in full height, or horizontally if height-truncated for small

marking.

Serial Cmd: <K482,status>

Default: Disabled

Options: 0 = Disabled 1 = Enabled (non-stacked) 2 = Enabled (stacked;

decode both stacked

and non-stacked)

MS-4 Imager User’s Manual 6-27

Symbologies

PDF417

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)

Fixed Symbol Length (PDF417)

Note: Fixed Symbol Length Status must be enabled for Fixed Symbol Length to take

effect.

Usage:

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.

Definition:

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, 1800

printable ASCII characters, or 1100 binary characters per symbol. Each

symbol character consists of 4 bars and 4 spaces in a 17-module structure.

Serial Cmd: <K476,status,[unused],fixed symbol length status,fixed symbol

length,[unused],codeword collection>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Serial Cmd: <K476,status,[unused],fixed symbol length status,fixed symbol

length,[unused],codeword collection>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: Used to increase data integrity by ensuring that only one symbol length

will be accepted.

Definition:

When enabled, the PDF symbol must contain the same number of characters

as the symbol length setting before it can be considered a good read. The

Imager will ignore any symbol not having the specified length.

Serial Cmd: <K476,status,[unused],fixed symbol length status,fixed symbol

length,[unused],codeword collection>

Default: 10

Options: 1 to 2710

6-28 MS-4 Imager User’s Manual

PDF417

Codeword Collection (PDF417)

Usage: Multiple Codeword Collection is useful in applications where portions of

subsequent images can be read and pieced together so that no opportunity

or time is lost to assemble codewords for decoding.

Definition: When set to Multiple, PDF codewords are collected from multiple images

and assembled throughout the read cycle until the read cycle ends or the

symbol is fully decoded. It is important to note that when this feature is

enabled, only one PDF symbol should be presented to the Imager per read

cycle.

Serial Cmd: <K476,status,[unused],fixed symbol length status,fixed symbol

length,[unused],codeword collection>

Default: Single Image

Options: 0 = Single Image 1 = Multiple Image

MS-4 Imager User’s Manual 6-29

Symbologies

MicroPDF417

Fixed Symbol Length Status (MicroPDF417)

Fixed Symbol Length (MicroPDF417)

Note: Fixed Symbol Length Status must be enabled for Fixed Symbol Length to take

effect.

Usage: Used for labelling small items that need large data capacity.

Definition: 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.

Serial Cmd: <K485,status,[unused],fixed symbol length status,fixed symbol length>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Serial Cmd: <K485,status,[unused],fixed symbol length status,fixed symbol length>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: Used to increase data integrity by ensuring that only one symbol length

will be accepted.

Definition: When enabled, the MicroPDF417 symbol must contain the same number

of characters as the symbol length setting before it can be considered a

good read. The Imager will ignore any symbol not having the specified

length.

Serial Cmd: <K485,status,[unused],fixed symbol length status,fixed symbol length>

Default: 10

Options: 1 to 366

6-30 MS-4 Imager User’s Manual

Composite

When set to Enabled or Required, will attempt to decode the 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.

Enabled

If set to Enabled, the Imager only decodes the linear component, and it will only output the

linear component.

Required

If set to Required, the Imager must decode both the linear and the composite components;

otherwise it outputs a No Read.

Separator Status (Composite)

Separator Character (Composite)

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K

453

h,,,3C>

For >: <K

453

h,,,3E>

For , : <K

453

h,,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Usage: Allows reading by both linear and 2D readers.

Definition: Combines 2D and linear width modulated symbology on the same symbol

where different messages can be read by each reader type.

Serial Cmd: <K453,mode,separator status,separator>

Default: Disabled

Options: 0 = Disabled 1 = Enabled 2 = Required

Usage: Allows the user to distinguish between the main and Supplemental symbols.

Definition: Separates the linear and the composite component.

Serial Cmd: <K453,mode,separator status,separator>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: As required by the application.

Definition: Allows the user to change the separator character from a comma to a new

character.

Serial Cmd: <K453,mode,separator status,separator>

Default: , (comma)

Options: Any ASCII character.

MS-4 Imager User’s Manual 6-31

Symbologies

Narrow Margins / Symbology Identifier

Narrow Margins

Note:

Do not use

Narrow Margins

when

Large Intercharacter Gap

is enabled for Code 39.

Enabled

When Narrow Margins is set to Enabled, the imager uses a 5x margin requirement for

standard linear symbols.

2D Enhanced

2D Enhanced enables a special decode algorithm for narrow-margin 2D symbols.

Usage: Used when the leading and trailing edges of the symbols are smaller than

the standard margin or other objects encroach into the margins.

Definition: Allows the imager to read 1D symbols with quiet zones less than 8 times

the width of the narrow bar element. “Quiet zone” is the space at the leading

and trailing ends of a symbol. Each quiet zone can be as narrow as only

five times the width of the narrow bar element when Narrow Margins is

enabled.

Serial Cmd: <K450,narrow margins,symbology identifier status>

Default: 2D Enhanced

Options: 0 = Disabled 1 = Enabled 2 = 2D Enhanced

6-32 MS-4 Imager User’s Manual

Narrow Margins / Symbology Identifier

Symbology Identifier

Explanation of Modifiers for Code 39, Codabar, and I-2/5

• For Code 39, Codabar, and I-2/5, the modifier indicates Check Character and Check

Character Output status.

• For Code 39 only, Full ASCII must be enabled to see modifiers 4, 5, and 7.

Example: ]A5 indicates a Code 39 symbol with Check Character and Check Character

Output enabled and Full ASCII conversion performed.

Explanation of Modifiers for Other Symbologies

• For Code 128, a 1 indicates EAN 128; otherwise the modifier is 0.

• For all other symbologies, the modifier is 0.

Definition: Symbology Identifier is an ISO/IEC 16022 standard prefix set of characters

that identifies the symbol type.

When enabled, the imager analyzes and identifies the symbology and adds

a three-character identifying prefix to the data:

•

]

(closed bracket character) indicating the presence of a symbology identifier.

• A, C, E, F, G, I, L, Q, Y, b, d, e, p, z

• (A = Code 39; C = Code 128; E = UPC/EAN; F = Codabar; G = Code

93; I = I-2/5; L = PDF417 and MicroPDF417; b = BC412; d = Data

Matrix; e = GS1 DataBar (RSS)

• Modifier

Example: ]d indicates a Data Matrix symbol.

Serial Cmd: <K450, narrow margins,symbology identifier status>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Modifier Check Character Check Character

Output Full ASCII conversion performed

(Code 39 only)

0Disabled N/A No

1Enabled Enabled No

3Enabled Disabled No

4Disabled N/A Yes

5Enabled Enabled Yes

7Enabled Disabled Yes

MS-4 Imager User’s Manual 6-33

Symbologies

Background Color

White

When White background is enabled, the bars of linear symbols and the elements of 2D

symbols are recognized as dark on a light background.

Black

When Black background is enabled, the bars of linear symbols and the elements of 2D

symbols are recognized as light on a dark background.

Both

When Both is enabled, the imager will attempt to decode for white background first, and if

there is no decode, will then attempt to decode for black background.

Usage: Symbol backgrounds are often White, or other very light colors. If the

background is darker than the symbol,

Black

background should be enabled.

Definition: Allows the user to specify the symbol background used in the application.

Serial Cmd: <K451,background color>

Default: Both

Options: 0 = White 1 = Black 2 = Both

6-34 MS-4 Imager User’s Manual

Background Color

MS-4 Imager User’s Manual 7-1

7 I/O Parameters

Contents

This section includes instructions on setting up conditions for changing input/output electrical

transitions for control of the Imager’s internal and external devices. A discrete I/O (in/out) signal

is an electrical transition from one voltage level to another so that digital switching can occur.

I/O Parameters by ESP................................................................................................................ 7-2

I/O Parameters Serial Commands ............................................................................................... 7-3

Symbol Data Output..................................................................................................................... 7-4

No Read Message........................................................................................................................ 7-6

Bad Symbol Message .................................................................................................................. 7-8

No Symbol Message .................................................................................................................... 7-8

1D / Stacked Symbology Qualification ......................................................................................... 7-9

2D Symbology Qualification ....................................................................................................... 7-10

Read Duration Output ................................................................................................................ 7-16

Output Indicators........................................................................................................................ 7-17

Beeper........................................................................................................................................ 7-21

LED Configuration...................................................................................................................... 7-22

Serial Verification ....................................................................................................................... 7-23

EZ Button ................................................................................................................................... 7-25

EZ Button Modes........................................................................................................................ 7-27

Configurable Output 1 ................................................................................................................ 7-29

Trend Analysis Output 1............................................................................................................. 7-32

ISO/IEC 16022 Symbol Quality Output 1 ................................................................................... 7-35

Diagnostic Output 1.................................................................................................................... 7-38

Configurable Output 2 ................................................................................................................ 7-39

Trend Analysis Output 2............................................................................................................. 7-39

ISO/IEC 16022 Symbol Quality Output 2 ................................................................................... 7-39

Diagnostic Output 2.................................................................................................................... 7-39

Configurable Output 3 ................................................................................................................ 7-40

Trend Analysis Output 3............................................................................................................. 7-40

ISO/IEC 16022 Symbol Quality Output 3 ................................................................................... 7-40

Diagnostic Output 3.................................................................................................................... 7-40

Power-On/Reset Counts ............................................................................................................ 7-41

Time Since Reset....................................................................................................................... 7-42

Service Message........................................................................................................................ 7-43

Frame Information...................................................................................................................... 7-44

Image Output.............................................................................................................................. 7-45

Database Identifier Output ......................................................................................................... 7-48

Quality Output ............................................................................................................................ 7-49

Configuring EZ Trax Output ....................................................................................................... 7-50

7-2 MS-4 Imager User’s Manual

I/O Parameters by ESP

Click this button to

bring up the I/O

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 +.

MS-4 Imager User’s Manual 7-3

I/O Parameters

I/O Parameters Serial Commands

Power On/Reset Counts <K406,power-on,resets,power-on saves,power-on flash saves>

Time Since Reset <K407,hours,minutes>

Service Message <K409,status,service message,threshold,resolution>

Serial Verification <K701,serial command echo status,serial command beep status,con-

trol/hex output>

Beeper <K702,status>

Quality Output <K704,decodes/trigger separator,decodes/trigger status>

Symbol Data Output <K705,symbol data output status,when to output>

Read Duration Output <K706,status,separator>

No Read Message <K714,status,message>

Bad Symbol Message <K715,[unused],message>

No Symbol Message <K716,[unused],message>

1D/Stacked Symbology Qualification <K717,minimum number of bars,minimum number of qualified scan

lines,start/stop status>

2D Symbology Qualification <K718,finder pattern status,symbol size status,symbol size 1,symbol

size 2,symbol size tolerance,dimension status,dimension 1,dimension

2,dimension tolerance,orientation status,orientation value>

Frame Information <K734,output frame number,output coordinates>

LED Configuration <K737,LED mode,ISO/IEC 16022 grade>

Image Output <K739,image output mode,communication port,file format,jpeg quality>

Target/Flood LEDs <K750,green flash LED status,target pattern LED status,green flash

duration>

EZ Trax Output <K757,comm port,image mode,image format,jpeg quality,object info

output,grade output>

Database Identifier Output <K759,status,separator>

EZ Button <K770,global status,default on power-on,load configuration data-

base,save for power-on>

EZ Button Modes <K771,single beep,two beeps,three beeps,four beeps>

Trend Analysis Output 1

K780,

trend analysis mode,trigger evaluation period,number to output on>

Trend Analysis Output 2

K781,

trend analysis mode,trigger evaluation period,number to output on>

Trend Analysis Output 3

K782,

trend analysis mode,trigger evaluation period,number to output on>

Diagnostic Output 1 <K790,unused 1,servuce unit>

Diagnostic Output 2 <K791,unused 1,servuce unit>

Diagnostic Output 3 <K792,unused 1,servuce unit>

ISO/IEC 16022 Symbol Quality Output 1

K800,

output on symbol contrast,symbol contrast threshold,output on

print growth,print growth threshold,output on axial non-uniformity,axial

non-uniformity threshold,output on UEC,UEC threshold>

ISO/IEC 16022 Symbol Quality Output 2

K801,

output on symbol contrast,symbol contrast threshold,output on

print growth,print growth threshold,output on axial non-uniformity,axial

non-uniformity threshold,output on UEC,UEC threshold>

ISO/IEC 16022 Symbol Quality Output 3

K802,

output on symbol contrast,symbol contrast threshold,output on

print growth,print growth threshold,output on axial non-uniformity,axial

non-uniformity threshold,output on UEC,UEC threshold>

Configurable Output 1 <K810,output on,output state,pulse width,output mode>

Configurable Output 2 <K811,output on,output state,pulse width,output mode>

Configurable Output 3 <K812,output on,output state,pulse width,output mode>

7-4 MS-4 Imager User’s Manual

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.

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

Match

Note: A No Read can still be transmitted if Enabled.

Mismatch

Note: A No Read can still be transmitted if Enabled.

Usage: Useful when the host needs symbol data only under certain conditions.

Definition: Defines the conditions under which decoded symbol data is transmitted

to the host.

Serial Cmd: <K705,symbol data output status,when to output>

Default: Good Read

Options: 0 = Disabled

2 = Mismatch

1 = Match

3 = Good Read

Usage: It is useful when an application only needs to use the discrete outputs

and can allow the Imager to do the decision-making. When Disabled, the

host does not need the symbol data and the communication lines are

used only for setup and status checks.

Definition:

When set to

Disabled

, the Imager will not transmit any data that is gener-

ated

during a read cycle (symbols, No Reads, etc.)

Usage: 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.

Definition: When set to Match, the Imager transmits symbol data whenever a symbol

matches a master symbol. However, if Matchcode Type is Disabled, it

transmits on any good read.

Usage: Mismatch is typically used as a flag within the host system to prevent an

item from being routed in the wrong container.

Definition: With Mismatch enabled, the Imager transmits symbol data whenever the

symbol data information does NOT match the master symbol.

MS-4 Imager User’s Manual 7-5

I/O Parameters

Good Read

Note: A No Read can still be transmitted if Enabled.

When to Output Symbol Data

As Soon As Possible

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: 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.

Definition: With Good Read enabled, the Imager transmits symbol data on any good

read regardless of Matchcode Type setting.

Definition: This command allows the user to choose when symbol data can be sent

to the host.

Serial Cmd: <K705,symbol data output status,when to output>

Default: As Soon As Possible

Options: 0 = ASAP 1 = End of Read Cycle

Usage: 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.

Definition: Enabling As Soon As Possible causes symbol data to be sent to the

host immediately after a symbol has been successfully decoded.

Usage: 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.

Definition: 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.

Read cycle duration

Start of read cycle End of read cycle

This is when host

expects output

Host

activates trigger

7-6 MS-4 Imager User’s Manual

No Read Message

No Read Message Mode

Disabled

No message is output when a No Read condition occurs.

Enabled

The user defined No Read message is output whenever a No Read condition occurs.

Detailed No Read Message

Important: In the case where the conditions set in Bad Symbol/No Symbol Qualification

are met, then the Bad Symbol or No Symbol message output will override the No Read

Message or the Detailed No Read Message, if either is enabled.

For example, in the following output: “No Read d_1, E_2”, d and E are symbology IDs for

Data Matrix and UPC respectively. The message means that Data Matrix and UPC are

enabled (and other symbologies are not), and that both failed to decode. The reason for

the failing Data Matrix is 1 and the reason for the failing UPC is 2. The first part of these

numbers (preceding the dot) is the relevant number and is interpreted here:

2D Symbols:

1. Failed to locate symbol (no finder pattern).

2. Failed to locate four corners or failed to qualify user defined dimensions (in pixels).

3. Failed to locate clock patterns or failed to qualify user defined orientation (0-359

degree).

4. Failed to validate clock patterns or failed to qualify user defined symbol size (clock

element count).

5. Failed to decode symbol.

Usage: Used in applications where the host needs serial verification that a symbol

has not been read and especially useful in new print verification.

Definition: 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.

Serial Cmd: <K714,No Read message status,No Read message>

Default: Enabled

Options: 0 = Disabled 1 = Enabled

2 = Detailed No Read Message

Usage: Use this option to cover more detailed reasons for decode failures.

Definition: Outputs a No Read message followed by an additional message (an

Image Processing Results Code) indicating the reason a symbol failed to

decode.

MS-4 Imager User’s Manual 7-7

I/O Parameters

Linear Symbols:

1. Failed user defined minimum number of bars.

2. Failed to decode start/stop character (doesn’t apply to UPC, GS1 DataBar, or

MicroPDF417).

3. Failed user defined minimum number of scan lines that qualify for the minimum

number of bars.

4. Failed to decode.

5. Failed to decode UPC supplemental.

No Read Message

Note: No Read Message will only be transmitted if Symbol Data Output is set to Match,

Mismatch, or Good Read.

No Read Message can be set to any ASCII character.

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K714h,,3C>

For >: <K714h,,3E>

For , : <K714h,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Definition: Any combination of ASCII characters can be defined as the No Read

message.

Serial Cmd: <K714,No Read message status,No Read message>

Default: No Read

Options: A string of up to 64 ASCII characters.

7-8 MS-4 Imager User’s Manual

Bad Symbol Message

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K715h,,3C>

For >: <K715h,,3E>

For , : <K715h,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

No Symbol Message

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K716h,,3C>

For >: <K716h,,3E>

For , : <K716h,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Usage:

Useful in determining if a symbol is present and if user defined requirements

for that symbol are met. Can tell the user if a qualified symbol is present

but not decodable.

Definition: Sets the requirements that will qualify an object or a symbol before outputting

a decode or message. When enabled, sends a message to the host

whenever an object meets the qualifications setup but is not decoded.

Serial Cmd: <K715,[unused],message>

Default: BAD_SYMBOL

Options: Up to 64 ASCII characters.

Usage:

Useful in determining if a symbol is present and if user defined requirements

for that symbol are met. Can tell the user if an object does not qualify as a

symbol.

Definition: Sets the requirements that will qualify an object or a symbol before outputting

a decode or message. When enabled, sends a message to the host

whenever an object meets the qualifications setup but is not decoded.

Serial Cmd: <K716,[unused],message>

Default: NO_SYMBOL

Options: Up to 64 ASCII characters.

MS-4 Imager User’s Manual 7-9

I/O Parameters

1D / Stacked Symbology Qualification

Minimum Number of Bars

Minimum Number of Qualified Scan Lines

Start/Stop Status

Definition: Sets the minimum number of bars to qualify linear symbols.

Serial Cmd: <K717,minimum number of bars,minimum number of qualified scan

lines,start/stop status>

Default: 0

Options: 0 to 255 (0 is disabled)

Definition: Sets the minimum number of scans that have the required number of

bars set in Minimum Number of Bars.

Important: This is a percentage value, from 0 to 100.

Serial Cmd: <K717,minimum number of bars,minimum number of qualified scan

lines,start/stop status>

Default: Disabled

Options: Any number from 0 to 100 (0 disables this feature).

Definition: When enabled, both Start and Stop characters need to be present to

qualify as a decodable symbol. In the case of PDF417, only a Stop needs

to be present.

Serial Cmd: <K717,minimum number of bars,minimum number of qualified scan

lines,start/stop status>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

7-10 MS-4 Imager User’s Manual

2D Symbology Qualification

Note: In the cases where Symbol Size Status, Dimension Status, or Orientation Status

is enabled, the Imager will always check the finder pattern regardless of Finder Patter

Status setting.

Finder Pattern Status

Symbol Size Mode (2D Symbology Qualification)

Note: If Symbol Size 1 is larger than Symbol Size 2, it will be automatically reversed in

the algorithm.

Disabled

Decoded messages are output, but no attempt to qualify symbols or output Bad or No

Symbol messages is undertaken.

Bad/No Symbol Output

Checks first for decodes. If no symbol is decoded, checks for symbol size. If both Symbol

Size 1 and Symbol Size 2 requirements are met, a Bad Symbol message is output. If

neither are met, a No Symbol message is output.

Object Qualification

Checks first for matches to symbol size. If qualified, attempts to decode. If no decodes are

found within the specified read cycle parameters, outputs a No Read message.

Enable Both

Same as Object Qualification, except that if no objects qualify, then a No Symbol message

is output; if at least one object qualifies, then a Bad Symbol message is output.

Definition: Checks for the presence of a finder pattern.

Serial Cmd: <K718,finder pattern status,symbol size mode,symbol size 1,symbol

size 2,symbol size tolerance,dimension mode,dimension 1,dimension

2,dimension tolerance,orientation mode,orientation value>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: Specifies the outputs resulting from the searches for Symbol Size 1 and

Symbol Size 2.

Serial Cmd: <K718,finder pattern status,symbol size mode,symbol size 1,symbol

size 2,symbol size tolerance,dimension mode,dimension 1,dimension

2,dimension tolerance,orientation mode,orientation value>

Default: Disabled

Options: 0 = Disabled

3 = Enable Both 1 = Bad/No Symbol Output 2 = Object Qualification

MS-4 Imager User’s Manual 7-11

I/O Parameters

Symbol Size 1

Symbol Size 2

Symbol Size Tolerance

Definition: Checks for symbol sizes for a specified number of elements. In the case

of rectangular symbols, checks the longer side.

Serial Cmd: <K718,finder pattern status,symbol size mode,symbol size 1,symbol

size 2,symbol size tolerance,dimension mode,dimension 1,dimension

2,dimension tolerance,orientation mode,orientation value>

Default: 10

Options: 8 to 88 elements

Definition: Checks for symbol sizes for a specified number of elements. In the case

of rectangular symbols, checks the shorter side.

Serial Cmd: <K718,finder pattern status,symbol size mode,symbol size 1,symbol

size 2,symbol size tolerance,dimension mode,dimension 1,dimension

2,dimension tolerance,orientation mode,orientation value>

Default: 10

Options: 8 to 88 elements

Definition: Sets the allowable deviation, up or down, for symbol sizes specified in

Symbol Size 1 and Symbol Size 2.

Serial Cmd: <K718,finder pattern status,symbol size mode,symbol size 1,symbol size

2,symbol size tolerance,dimension mode,dimension 1,dimension

2,dimension tolerance,orientation mode,orientation value>

Default: 2

Options: 0 to 10

7-12 MS-4 Imager User’s Manual

2D Symbology Qualification

Dimension Mode

Disabled

Decoded messages are output, but no attempt to qualify symbols or output Bad Symbol

or No Symbol messages is undertaken.

Bad/No Symbol Output

Checks first for decodes. If no symbol is decoded, checks for symbol dimension. If both

Dimension 1 and Dimension 2 requirements are met, a Bad Symbol message is output.

If neither are met, a No Symbol message is output.

Object Qualification

Checks first for matches to symbol dimension. If qualified, attempts to decode. If no

decodes are found within the specified read cycle parameters, outputs a No Read message.

Enable Both

Same as Object Qualification, except that if neither Dimension 1 nor Dimension 2

qualifies, then a No Symbol message is output; if either Dimension 1 or Dimension 2

qualifies, then a Bad Symbol message is output.

Definition: Enables searches for symbol Dimension 1 and Dimension 2.

Serial Cmd: <K718,finder pattern status,symbol size mode,symbol size 1,symbol size

2,symbol size tolerance,dimension mode,dimension 1,dimension

2,dimension tolerance,orientation mode,orientation value>

Default: Disabled

Options: 0 = Disabled

3 = Enable Both 1 = Bad/No Symbol Output 2 = Object Qualification

MS-4 Imager User’s Manual 7-13

I/O Parameters

Dimension 1

Dimension 2

Dimension Tolerance

Definition: Checks symbol dimension for a specified number of pixels. In the case of

rectangular symbols, checks the longer side.

Serial Cmd: <K718,finder pattern status,symbol size mode,symbol size 1,symbol size

2,symbol size tolerance,dimension mode,dimension 1,dimension

2,dimension tolerance,orientation mode,orientation value>

Default: 0

Options: 0 to 640 pixels

Definition: Checks symbol dimension for a specified number of pixels. In the case of

rectangular symbols, checks the shorter side.

Serial Cmd: <K718,finder pattern status,symbol size mode,symbol size 1,symbol size

2,symbol size tolerance,dimension mode,dimension 1,dimension

2,dimension tolerance,orientation mode,orientation value>

Default: 0

Options: 0 to 480 pixels

Definition: Sets the allowable deviation, in percentage, for symbol sizes specified in

Dimension 1 and Dimension 2.

Serial Cmd: <K718,finder pattern status,symbol size mode,symbol size 1,symbol size

2,symbol size tolerance,dimension mode,dimension 1,dimension

2,dimension tolerance,orientation mode,orientation value>

Default: 10

Options: 0 to 100

7-14 MS-4 Imager User’s Manual

2D Symbology Qualification

Orientation Mode

Disabled

Decoded messages are output, but no attempt is made to qualify symbols or to output

Bad Symbol or No Symbol messages.

Bad/No Symbol Output

Checks first for decodes. If no symbol is decoded, checks for symbol orientation. If

Orientation

Value is satisfied, a Bad Symbol message is output. If not satisfied, a No Symbol message

is output.

Object Qualification

Checks first for matches to symbol Orientation Value. If qualified, attempts to decode. If no

decodes are found within the specified read cycle parameters, outputs a

No Read

message.

Enable Both

Same as Object Qualification, except that if Orientation Value is satisfied but the symbol

is not decoded, then a Bad Symbol message is output; if not satisfied, a Bad Symbol

message is still output.

Definition: Sets the orientation value.

Serial Cmd: <K718,finder pattern status,symbol size mode,symbol size 1,symbol size

2,symbol size tolerance,dimension mode,dimension 1,dimension 2,dimension

tolerance,orientation mode,orientation value>

Default: Disabled

Options: 0 = Disabled

3 = Enable Both 1 = Bad/No Symbol Output 2 = Object Qualification

MS-4 Imager User’s Manual 7-15

I/O Parameters

Orientation Value

Note: A symbol’s orientation can miss the precise Orientation Value by several degrees

and still be qualified. To be certain of the extent of the allowable tolerance, you should

experiment with symbols in various orientations. In no case can they be more than 45°

from the assigned orientation value and still be qualified.

Usage: Instructs the Imager to ignore symbols not in the specified orientation.

Definition: Sets the orientation of the symbol,

in degrees clockwise from the

default 0 orientation.

For Data Matrix symbols, sets the

finder “L” pattern, with the example

to the right showing the default 0

orientation.

For QR Code, sets the locator

pattern (three squares), with the

example to the right showing the

default 0 orientation.

The other position settings will

rotate clockwise from the defaults

shown above.

Serial Cmd: <K718,finder pattern status,symbol size mode,symbol size 1,symbol size

2,symbol size tolerance,dimension mode,dimension 1,dimension

2,dimension tolerance,orientation mode,orientation value>

Default: 0

Options: 0 to 359

“L” finder pattern

(Data Matrix)

Three-square

finder pattern

(QR Code)

7-16 MS-4 Imager User’s Manual

Read Duration Output

Read Duration Output Mode

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

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K706h,,3C>

For >: <K706h,,3E>

For , : <K706h,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Usage: 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.)

Definition: 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.

Serial Cmd: <K706,status,separator>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: User defined character that separates the symbol information from the

Read Duration Output.

Serial Cmd: <K706,status,separator>

Default: [space character]

Options: Any ASCII character.

MS-4 Imager User’s Manual 7-17

I/O Parameters

Output Indicators

The MS-4 Imager has a beeper and three LED arrays, as follows:

1. A target pattern of blue LEDs for centering the field of view, which is projected from

the front of the Imager .

2. An array of green LEDs projected from the front of the Imager that can be programmed

to flash in response to user-defined conditions.

3. A row of five status LEDs on the side of the Imager.

Green Flash Mode

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.

Usage: Used as a visual verification that a good read has occurred.

Definition: An array of green LEDs in the front of the Imager can be programmed to

flash in response to user-defined conditions.

Serial Cmd: <K750,green flash mode,target pattern status,green flash duration>

Default: Good Read

Options: 0 = Disabled

1 = Good Read

2 = Static Presentation

3 = Match

4 = Mismatch

5 = Strobe

7-18 MS-4 Imager User’s Manual

Output Indicators

Static Presentation Mode

Static Presentation Mode is used in conjunction with Continuous Read Mode: <K200,0>.

When operating in Static Presentation Mode, the red LEDs will illuminate while the

Imager is searching for a symbol in Continuous Read Mode. When a symbol is placed in

the field of view and a good read occurs, the green LEDs will illuminate and stay on for the

duration of time set in Green Flash Duration. Only one read will occur during that time

unless more than one symbol is enabled in Number of Symbols.

Note: If Static Presentation Mode is selected but the Imager is not in Continuous Read,

the Green Flash will not occur.

To use Static Presentation:

1. Enable Continuous Read.

2. Select the number of symbols.

3. Enable Static Presentation in Green Flash Mode.

4. Select the read time in Green Flash Duration.

Match

The green LEDs will flash when a match condition is met. If multisymbol is enabled, then

green flash LEDs will illuminate only if all symbols qualify as a match. If matchcode is

disabled, then this mode will activate the LEDs on a good read.

Mismatch

Same as Match, except that LEDs will illuminate on a mismatch.

Strobe

Green flash LEDs will act as an illumination strobe for image capture. If it is required that the

green flash LEDs be the only illumination for image capture, then the internal illumination

LEDs can be disabled.

MS-4 Imager User’s Manual 7-19

I/O Parameters

Target Pattern

Important:

The targeting system actuated by the EZ button or operational command overrides

this setting.

Always OFF

The target pattern will remain OFF at all times unless overridden by the EZ button or

operational command.

ON When Not in the Read Cycle

The target pattern is always ON except during the read cycle. If the EZ button or operational

command overrides this setting, the target pattern will remain on at all times.

ON When in the Read Cycle

The target pattern will remain OFF except during the read cycle. If the EZ button or operational

command overrides this setting, the target pattern will remain on at all times.

Always ON

The target pattern is always ON.

Usage: Assists users in positioning and locating symbols in the center of the

Imager’s field of view.

Definition: The user can control when the targeting system is ON or OFF, and can

save this condition for power-on.

Serial Cmd: <K750,green flash mode,target pattern status,green flash duration>

Default: Always ON

Options: 0 = Always OFF

1 = ON only when not in the read cycle

2 = ON only when in the read cycle

3 = Always ON

7-20 MS-4 Imager User’s Manual

Output Indicators

Green Flash Duration

Usage: Provides visual verification that a good read has occurred.

Definition: When a good read occurs, the green LEDs will illuminate and stay on for

the time set in the Green Flash Duration value.

Serial Cmd: <K750,green flash mode,target pattern status,green flash duration>

Default: 100 (1 second)

Options: 0 to 65535 (in 10mS increments)

MS-4 Imager User’s Manual 7-21

I/O Parameters

Beeper

Note: The beeper will also sound at any of the following times:

• When the Imager is defaulted.

• When a send/save command is sent from ESP.

• At the conclusion of a calibration procedure.

• When a <Z>, <Zp>, <Zrd>, or <K701,,1> command is sent.

Usage: An audible verification that either a good read or a No Read has

occurred.

Definition: A beep is emitted after each good read or No Read.

Serial Cmd: <K702,beeper status>

Default: Good Read

Options: 0 = Disabled 1 = Good Read 2 = No Read

7-22 MS-4 Imager User’s Manual

LED Configuration

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% were illuminated, the read result would be a grade A; if only

the 20% LED were illuminated, the result would be 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: Useful as a visible verification of read rates and symbol quality.

Definition: Determines the mode in which the status LEDs operate.

Serial Cmd: <K737,LED mode,ISO/IEC 16022 grade>

Default: Standard

Options: 0 = Standard 1 = ISO/IEC 16022 grade

Usage: Provides visual grading of specific ISO/IEC 16022-related features.

Definition: Determines which ISO/IEC 16022 feature the Imager will grade via the

LEDs.

Serial Cmd: <K737,LED mode,ISO/IEC 16022 grade>

Default: Final Grade

Options: 0 = Final Grade

3 = Unused ECC 1 = Symbol Contrast 2 = Print Growth

MS-4 Imager User’s Manual 7-23

I/O Parameters

Serial Verification

Allows the user to verify configuration command status.

Serial Command Echo Status

Serial Command Beep Status

Usage:

This command is useful in removing any doubt about the Imager’s interpretation

of any configuration command.

For example, if the current preamble is “SOM” and <K701,1,START> is

entered, the Imager will echo back <K701,SOM> since the attempted

entry “START” exceeds the four character limit for that command.

Therefore, it is rejected and the existing “SOM” message is echoed back

and remains the preamble message.

Definition:

When enabled, a configuration command

received from the host is echoed back to the

host with the resultant settings.

Function: 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.

Serial Cmd: <K701,serial command echo status,serial command beep status,

control/hex output>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: Used to audibly verify the acceptance and validity of a command.

Definition: Causes the Imager to beep once whenever a K command is entered to

indicate that the command was accepted and processed.

Function: If an invalid command is entered, the Imager beeps 5 times to indicate an

invalid entry. However, this does not necessarily mean that all data fields

have been entered incorrectly. Only one bad field needs to be found in

order to activate the 5 beep response.

Serial Cmd: <K701,serial command echo status,serial command beep status,

control/hex output>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Imager

Host

7-24 MS-4 Imager User’s Manual

Serial Verification

Control/Hex Output

Usage: Useful for viewing settings with binary characters when using serial

commands on a terminal.

Definition: 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.

Serial Cmd: <K701,serial command echo status,serial command beep status,control/

hex output>

Default: Control

Options: 0 = Control 1 = Hex

MS-4 Imager User’s Manual 7-25

I/O Parameters

EZ Button

The EZ button has four positions, selectable by the length of time the button is held down,

and indicated by one, two, three, and four beeps in succession. Each position can be

programmed for any of eight options.

Disabled

When set to Disabled, the EZ button does not function.

Enabled

When selected, the EZ button is enabled and the function of each button position is

selected by the EZ Button Mode command.

Trigger

When selected, the EZ button acts as a trigger for the Imager to start and end read cycles.

All other button operations are inactive.

Unlatch Outputs

In this configuration, the EZ button will unlatch any logic outputs that have been latched.

Parameter Switch

The parameter switch toggles between custom defaults and power-on settings. The condition

is the same as that achieved by sending the

<Arc>

and

<Arp>

commands consecutively.

Definition: Serves as a master switch to enable/disable the EZ button status.

Serial Cmd: <K770,global status,default on power-on,load configuration database,

save for power-on>

Default: Enabled

Options: 0 = Disabled 1 = Enabled 2 = Trigger

3 = Unlatch Outputs 4 = Parameter Switch

In External

Level: The read cycle endures for as long as the EZ button is pressed, unless a

timeout occurs and Timeout is enabled for End of Read Cycle.

In External

Edge: As with Level, Edge allows a read cycle to be initiated by pressing the EZ

button, but unlike Level, the read cycle ends with a good read output, a

timeout, or a new trigger.

7-26 MS-4 Imager User’s Manual

EZ Button

Default on Power-On

Load Configuration Database

Save for Power-On

Definition: When enabled, if the EZ button is held down on power-on the Imager will

default to customer defaults and save for power-on. This is the same as

sending a <Zrc> command.

Serial Cmd: <K770,global status,default on power-on,load configuration data-

base,save for power-on>

Default: Enabled

Options: 0 = Disabled 1 = Enabled

Definition: Allows the user to load the Configuration Database with calibration results.

When the user performs a calibration using the EZ button, all the database

entries are moved down one index and the results of the calibration are

saved to index 0. The results will be saved as current settings as well.

Serial Cmd: <K770,global status,default on power-on,load configuration data-

base,save for power-on>

Default: Enabled

Options: 0 = Disabled 1 = Enabled

Definition: If enabled, after calibration is complete, all parameters will be saved for

power-on.

Serial Cmd: <K770,global status,default on power-on,load configuration database,

save for power-on>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 7-27

I/O Parameters

EZ Button Modes

Disabled

When set to disabled, the associated button position will have no function associated with

it, and the position will be skipped over.

Read Rate

Read Rate will be initiated when the associated button position is selected. Read Rate will

perform decodes/second and is the same as sending a <C> from the Terminal. To exit

Read Rate Mode quickly press and release the EZ button.

Calibrate

Calibration will be initiated when the associated button position is selected. To abort calibration

quickly press and release the EZ button.

Save for Power-On

All Imager settings will be saved to non-volatile memory to be recalled on power-on

whenever the associated button position is selected. This is the same as sending a <Z>

from the terminal.

Load New Master

Functions in the same way as new master pin input whenever the associated button

position is selected. The new master pin’s Consecutive Decode requirement holds true

for this function.

Usage: Useful for performing multiple, repetitive tasks at the work site.

Definition:

Allows the user to program each of the EZ button’s 4 positions from a selection

of 8 modes.

Serial Cmd: <K771,position 1 mode,position 2 mode,position 3 mode,position 4 mode>

Options: 0 = Disabled 1 = Enabled

Single Beep Two Beeps Three Beeps Four Beeps

0 = Disabled 0 = Disabled 0 = Disabled 0 = Disabled

1 = Read Rate 1 = Read Rate 1 = Read Rate 1 = Read Rate

2 = Calibrate 2 = Calibrate 2 = Calibrate 2 = Calibrate

3 = Save for Power-On 3 = Save for Power-On 3 = Save for Power-On 3 = Save for Power-On

4 = Unused 4 = Unused 4 = Unused 4 = Unused

5 = Load New Master 5 = Load New Master 5 = Load New Master 5 = Load New Master

6 = Unused 6 = Unused 6 = Unused 6 = Unused

7 = Target System 7 = Target System 7 = Target System 7 = Target System

8 = Bar Code Config. 8 = Bar Code Config. 8 = Bar Code Config. 8 = Bar Code Config.

7-28 MS-4 Imager User’s Manual

EZ Button Modes

Target System

Turns on the target pattern whenever the associated button position is selected. To disable,

quickly press and release the EZ button.

Note: This mode is the only one that does not require that the button be released before

taking effect. Thus, as soon as the Imager beeps the appropriate number of times for the

position, it will take effect. If it is necessary to have the target system on before another

operation such as calibration or read rate is performed, ensure that the target system

mode is assigned a lower position so that it will be activated first.

Bar Code Configuration

Enables bar code configuration mode whenever the associated button position is

selected. When enabled, the Imager can accept configuration commands from bar codes

without first reading a special, coded Data Matrix ISO/IEC 16022 symbol. To disable,

quickly press and release the EZ button.

EZ Button Operation

To execute EZ button commands,

Single Beep (Position #1)

Hold down button until a single beep is heard (and the 20% LED illuminates).

Two Beeps (Position #2)

Hold down button until two quick beeps are heard (and the 20% and 40% LEDs illumi-

nate.)

Three Beeps (Position #3)

Hold down button until three quick beeps are heard (and the 20%, 40%, and 60% LEDs

illuminate).

Four Beeps (Position #4)

Hold down button until four quick beeps are heard (and the 20%, 40%, 60%, and 80%

LEDs illuminate).

MS-4 Imager User’s Manual 7-29

I/O Parameters

Configurable Output 1

Note: If Output On is set to Match or Mismatch, a transition (switching) will not occur

unless Matchcode Type is enabled and a master symbol is loaded into memory.

Mismatch or No Read

Activates discrete output when the data does not match that of the master symbol or the

symbol has not been decoded before the end of the read cycle.

Match or Good Read

Activates a discrete output when the symbol data matches the master symbol.

Note: If you want to output for a good read and Matchcode is not enabled, you can

enable any output for Match.

Mismatch

Activates a discrete output whenever the symbol data does not match that of the master

symbol.

No Read

Activates a discrete output whenever the symbol data is not decoded before the end of the

read cycle.

Usage: 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.

Definition: 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.

Serial Cmd:

K810,output on

,output state,pulse width,output mode>

Default: Mismatch or No Read

Options: 0 = Mismatch or No Read

3 = No Read

6 = Diagnostic Warning

1 = Match (or good read)

4 = Trend Analysis

7 = In Read Cycle

2 = Mismatch

5 = Symbol Quality

7-30 MS-4 Imager User’s Manual

Configurable Output 1

Trend Analysis

Symbol Quality

Diagnostic Warning

In Read Cycle

Usage: Typically used when successful decodes are occurring but a discrete output

is needed to flag a trend in quality issues.

Definition: Activates discrete output when a trend analysis condition is met, depending

on the trend analysis option enabled.

Usage: Typically used when a discrete indication is needed to flag a symbol quality

condition.

Definition: Activates discrete output when a symbol quality condition is met, depending

on the symbol quality option enabled.

Usage: Typically used when a discrete indication of a diagnostic condition is

needed.

Definition: Activates discrete output when a diagnostic warning condition is met,

depending on the diagnostic option enabled.

Definition: Activates a discrete output when the Imager is in a read cycle.

MS-4 Imager User’s Manual 7-31

I/O Parameters

Output State

Pulse Width

Output Mode

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.

Definition: Sets the active electrical state of the discrete output.

Serial Cmd:

K810,

output on,

output state

,pulse width,output mode>

Default: Negative

Options: 0 = Negative 1 = Positive

Definition: Sets the time in 10mS increments that the discrete output remains active.

Serial Cmd:

K810,

output on,output state,

pulse width

,output mode>

Default: 5 (Corresponds to 50 mS)

Options: 0 to 255 (0 to 2.55 seconds). Divide the number entered on the command

line by 100 for time in seconds.

Definition: Sets the condition in which the discrete output is de-activated.

Serial Cmd:

K810,

output on,output state,pulse width,

output mode

Default: Pulse

Options:

0 = Pulse

2 = Latch Mode 2

3 = Latch Mode 3

7-32 MS-4 Imager User’s Manual

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: Useful in cases where the user doesn’t want to shut down for one condition

but wants to monitor quality and read conditions.

Definition: 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.

Example: Trend Analysis Mode = No Read

Trigger Evaluation Period= 25 triggers (read cycles)

Number to Output On = 4

In this example, the Imager will activate an output when 4 No Reads occur

within a period of 25 triggers (read cycles).

MS-4 Imager User’s Manual 7-33

I/O Parameters

Trend Analysis Mode

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/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

Bad Symbol

Output will be activated when the number of

Bad Symbol

occurrences equals the value

entered for

Number to Output On

within the trigger window selected in

Number of Triggers

No Symbol

Output will be activated when the number of

No Symbol

occurrences equals the value

entered for

Number to Output On

within the trigger window selected in

Number of Triggers

Definition: Sets the trend condition (Mismatch, No Read, or Decodes/Trigger) that

will activate the output.

Serial Cmd:

K780,trend analysis mode

,trigger evaluation period,number to output on,

decodes/trigger threshold>

Default: No Read

Options: 0 = Mismatch

3 = Bad Symbol 1 = No Read

4 = No Symbol 2 = Decodes/Trigger

7-34 MS-4 Imager User’s Manual

Trend Analysis Output 1

Trigger Evaluation Period

Number to Output On

Decodes/Trigger Threshold

Definition: The number of triggers to examine for the trend analysis condition.

Serial Cmd:

K780,

trend analysis mode,

trigger evaluation period

,number to output on,

decodes/trigger threshold>

Default: 0

Options: 0 to 255

Usage: 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.

Definition: 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.

Serial Cmd:

K780,

trend analysis mode,trigger evaluation period,

number to output on

decodes/trigger threshold>

Default: 0

Options: 0 to 255

Definition: When set to this mode, and when the appropriate output is set to output on

trend analysis, the Imager will function in a Decodes per Trigger mode

during the read cycle and the trend analysis operation. Output will be acti-

vated based on whether or not the symbol decode count at the end of the

read cycle crosses the decodes per trigger threshold.

Note: Although this setup causes the Imager to function in a Decodes per

Trigger mode, the decode count will only be appended to the symbol data if

the status of the Decodes per Trigger command is enabled.

Serial Cmd:

K780,

trend analysis mode,trigger evaluation period,number to output on,

decodes/trigger threshold

Default: 0

Options: 0 to 65535

MS-4 Imager User’s Manual 7-35

I/O Parameters

ISO/IEC 16022 Symbol Quality Output 1

Note: Output On under Output 1 Parameters must be set to Symbol Quality for this

output to function.

Under Output 1 Parameters, expand the Symbol Quality (ISO/IEC 16022) tree.

Output on Symbol Contrast

Output on Print Growth

Usage: Lets the user know if symbol quality is less than acceptable.

Definition: If enabled, toggles Output 1 to an active state when Symbol Contrast

Threshold is met.

Serial Cmd:

K800,output on symbol contrast

,symbol contrast threshold,output on print

growth,print growth threshold,output on axial non-uniformity,axial non-

uniformity

threshold,output on UEC,UEC threshold>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: Lets the user know if symbol quality is less than acceptable.

Definition:

If enabled, toggles

Output 1

to an active state when

Print Growth Threshold

is met.

Serial Cmd:

K800,

output on symbol contrast,symbol contrast threshold,

output on print

growth,print growth threshold,output on axial non-uniformity,axial non-

uniformity

threshold,output on UEC,UEC threshold>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

7-36 MS-4 Imager User’s Manual

ISO/IEC 16022 Symbol Quality Output 1

Output on Axial Non-Uniformity

Output on Unused Error Correction

Symbol Contrast Threshold

Usage: Lets the user know if symbol quality is less than acceptable.

Definition: If enabled, toggles Output 1 to an active state when Axial Non-Uniformity

Threshold is met.

Serial Cmd:

K800,

output on symbol contrast,symbol contrast threshold,output on print

growth,print growth threshold,

output on axial non-uniformity

,axial non-

uniformity threshold,output on UEC,UEC threshold>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: Lets the user know if symbol quality is less than acceptable.

Definition:

If enabled, toggles

Output 1

to an active state when

UEC Threshold

is met.

Serial Cmd:

K800,

output on symbol contrast,symbol contrast threshold,output on print

growth,print growth threshold,output on axial non-uniformity,axial non-

uniformity

threshold,

output on UEC

,UEC threshold>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Usage: Lets the user set the acceptable level of symbol quality.

Definition: Conforms to ISO/IEC 16022 symbol quality grading (A,B,C,D).

Serial Cmd:

K800,

output on symbol contrast,

symbol contrast threshold

,output on print

growth,print growth threshold,output on axial non-uniformity,axial non-

uniformity

threshold,output on UEC,UEC threshold>

Default: Grade C

Options: 0 = Grade A

3 = Grade D 1 = Grade B 2 = Grade C

MS-4 Imager User’s Manual 7-37

I/O Parameters

Print Growth Threshold

Axial Non-Uniformity Threshold

Unused Error Correction Threshold

Usage: Lets the user set the acceptable level of symbol quality.

Definition: Conforms to ISO/IEC 16022 symbol quality grading (A,B,C,D).

Serial Cmd:

K800,

output on symbol contrast,symbol contrast threshold,output on print

growth,print growth threshold,output on axial non-uniformity,axial non-

uniformity

threshold,output on UEC,UEC threshold>

Default: Grade C

Options: 0 = Grade A

3 = Grade D 1 = Grade B 2 = Grade C

Usage: Lets the user set the acceptable level of symbol quality.

Definition: Conforms to ISO/IEC 16022 symbol quality grading (A,B,C,D).

Serial Cmd:

K800,

output on symbol contrast,symbol contrast threshold,output on print

growth,print growth threshold,output on axial non-uniformity,axial non-

uniformity

threshold

,output on UEC,UEC threshold>

Default: Grade C

Options: 0 = Grade A

3 = Grade D 1 = Grade B 2 = Grade C

Usage: Lets the user set the acceptable level of symbol quality.

Definition: Conforms to ISO/IEC 16022 symbol quality grading (A,B,C,D).

Serial Cmd:

K800,

output on symbol contrast,symbol contrast threshold,output on print

growth,print growth threshold,output on axial non-uniformity,axial non-

uniformity

threshold,output on UEC,

UEC threshold

Default: Grade C

Options: 0 = Grade A

3 = Grade D 1 = Grade B 2 = Grade C

7-38 MS-4 Imager User’s Manual

Diagnostic 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.

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.

Serial Cmd: <K790,unused 1,service unit>

Default: 0

Options: Disabled

Definition: Allows the user to set up the output to toggle to active when the service

timer has expired. This condition will only be held for one service timer

click.

Note: This feature cannot be used if the Imager is in a Continuous Read

mode.

Serial Cmd: <K790,unused 1,service unit>

Default: 0

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 7-39

I/O Parameters

Configurable Output 2

Note: Output 2 has the same parameters and default settings as Output 1.

Trend Analysis Output 2

Note: Output On

under

Output 2 Parameters

must be set to

Trend Analysis

for this output

to function.

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.

Diagnostic Output 2

Note: Output On under Output 2 Parameters must be set to Diagnostic Warning for

this output to function.

Serial Cmd:

K811,

output on,output state,pulse width,output mode>

Serial Cmd:

K781,

trend analysis mode,trigger evaluation period,number to output on>

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>

Serial Cmd: <K791,unused 1,service unit>

7-40 MS-4 Imager User’s Manual

Configurable Output 3

Note: Output 3 has the same parameters and default settings as Output 1 and Output 2.

Trend Analysis Output 3

Note: Output On

under

Output 3 Parameters

must be set to

Trend Analysis

for this output

to function.

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.

Diagnostic Output 3

Note: Output On under Output 3 Parameters must be set to Diagnostic Warning for

this output to function.

Serial Cmd:

K812,

output on,output state,pulse width,output mode>

Serial Cmd:

K782,

trend analysis mode,trigger evaluation period,number to output on>

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>

Serial Cmd: <K792,unused 1,service unit>

MS-4 Imager User’s Manual 7-41

I/O Parameters

Power-On / Reset Counts

Note: Power On / Reset Counts is a read only command.

Power-On

uses a 16-bit counter that increments each time the Imager is powered-on.

Resets

Resets uses a 16-bit counter that increments each time the Imager is reset. This value is

reset at power-on.

Power-On Saves

Power-On Saves uses a 16-bit counter that increments each time an Imager setting is

saved for power-on with a <Z> command.

Power-On Flash Saves

Power-On Flash Saves uses a 16-bit counter that increments each time an Imager setting

is saved to the customer parameter section of flash memory with a <Zc> command.

Serial Cmd: <K406,power-on,resets,power-on saves,power-on flash saves>

7-42 MS-4 Imager User’s Manual

Time Since Reset

Note: Time Since Reset is a read only command.

Hours

Hours uses a 16-bit counter that increments every 60 minutes.

Minutes

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.

Serial Cmd: <K407,hours,minutes>

Default: 16-bit counter (0 to 65535)

Serial Cmd: <K407,hours,minutes>

Default: 16-bit counter (0 to 60)

MS-4 Imager User’s Manual 7-43

I/O Parameters

Service Message

When Service Message is enabled, a message of up to 10 ASCII characters is sent

whenever the system detects that the service timer’s limit has been reached. The service

timer is reset at power-on, meaning that the service timer’s limit is the amount of time

since last reset. Service timer increments can be set in seconds or minutes.

Service Message

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K409h,,3C>

For >: <K409h,,3E>

For , : <K409h,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Threshold

Resolution

Serial Cmd: <K409,status,service message,threshold,resolution>

Default: 0

Options: 0 = Disabled 1 = Enabled

Serial Cmd: <K409,status,service message,threshold,resolution>

Default: SERVICE

Options: An ASCII string between 1 and 10 characters.

Serial Cmd: <K409,status,service message,threshold,resolution>

Default: 300 (5 minutes)

Options: 1 to 65535

Serial Cmd: <K409,status,service message,threshold,resolution>

Default: Seconds

Options: 0 = Seconds 1 = Minutes

7-44 MS-4 Imager User’s Manual

Frame Information

Output Frame Number

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 pre-

cede any symbol quality data (if symbol quality settings are enabled-- see Symbol Quality

Separator on page 8-5). The symbol quality separator is located between the end of the

already-formatted data and the “F” that precedes the frame number.

Output Coordinates

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)

Serial Cmd: <K734,output frame number,output coordinates>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Serial Cmd: <K734,output frame number,output coordinates>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 7-45

I/O Parameters

Image Output

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.

Usage: This feature allows the user to select what read cycle condition triggers

the image file output.

Definition:

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.

Serial Cmd: <K739,image output mode,communication port,file format,jpeg quality>

Default: Disabled

Options: 0 = Disabled 1 = Good Read 2 = No Read

3 = No Read or Good Read 4 = Mismatch

7-46 MS-4 Imager User’s Manual

Image Output

Communication Port

File Format

JPEG Quality

Definition: This setting selects the communication port through which the image file

will be transferred to the host.

Serial Cmd: <K739,image output mode,communication port,file format,jpeg quality>

Default: Host

Options: 0 = Host 1 = Auxiliary 2 = USB

Definition: 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.

Serial Cmd: <K739,image output mode,communication port,file format,jpeg quality>

Default: JPEG

Options: 0 = Bitmap 1 = JPEG 2 = Binary

Definition: This setting determines the quality of JPEG image compression. The user

may select a value from 1 (lowest) to 100 (highest).

Serial Cmd: <K739,image output mode,communication port,file format,jpeg quality>

Default: 90

Options: 1 to 100 (percent)

MS-4 Imager User’s Manual 7-47

I/O Parameters

Image Output Example

The following example assumes that the Imager is set to output on No Read, and that it is

in a rapid capture mode of 3 captures.

Number of Symbols: 1

Frame # 1: No Read

Frame # 2: No Read

Frame # 3: No Read

Read Cycle Result: No Read

Output Frame: Frame # 1

Number of Symbols: 1

Frame # 1: No Read

Frame # 2: No Read

Frame # 3: Good Read

Read Cycle Result: Good Read

Output Frame: None

Number of Symbols: 2

Frame # 1: No Read

Frame # 2: No Read

Frame # 3: Good Read, Symbol # 1

Read Cycle Result: No Read

Output Frame: Frame # 1

7-48 MS-4 Imager User’s Manual

Database Identifier Output

Disabled

When this command is disabled, no database identifier information will be output.

Enabled

When this command is enabled, the Imager will append a two-digit number and the characters

“DB” to the data output following the separator for each symbol decoded using

Configuration

Database

. For example, if the separator is an underscore character and the second database

entry reads a symbol encoded with “data capture” during the read cycle, the symbol data output

will be “data capture_DB02”. If the database is not active, no identifiers will be attached to output.

Separator

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K759h,,3C>

For >: <K759h,,3E>

For , : <K759h,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Usage: Useful in keeping track of which database entries read which symbols.

Serial Cmd: <K759,status,separator>

Default: 0

Options: 0 = Disabled

Usage:

The separator character separates the symbol data from the database identifier.

Serial Cmd: <K759,status,separator>

Default: <space>

Options: Any ASCII character.

MS-4 Imager User’s Manual 7-49

I/O Parameters

Quality Output

Separator

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K704h,3C>

For >: <K704h,3E>

For , : <K704h,2C>

See ASCII Character Entry Modifier on page 3-23 for a detailed explanation of how to

enter ASCII characters as hex values.

Decodes per Trigger Status

Definition: The separator character separates quality output data from symbol data.

Serial Cmd: <K704,separator,decodes/trigger status>

Default: ,

Options: Any ASCII character.

Definition: When this feature is enabled, the Imager enters a state where it processes

frames as configured until the end of a read cycle, with or without a successful

symbol decode. When the read cycle ends, the Imager outputs any

decoded symbol data along with the decodes per trigger count.

Serial Cmd: <K704,separator,decodes/trigger status>

Default: 0

Options: 0 = Disabled 1 = Enabled

7-50 MS-4 Imager User’s Manual

Configuring EZ Trax Output

After you have set up your Imager for EZ Trax, you can configure the software in three

different ways: using the EZ Trax interface, using the tree controls in ESP, and using serial

commands.

For detailed information about how to use the EZ Trax user interface for configuration,

refer to the Help menu in EZ Trax software, or the EZ Trax Quick Start Guide, available

on the

Microscan Tools CD.

Configuring EZ Trax Output by ESP

To configure EZ Trax using ESP, first click the I/O button in App Mode to display the I/O

Parameters tree control.

MS-4 Imager User’s Manual 7-51

I/O Parameters

EZ Trax Output

Comm Port

Image Mode

Image Format

When EZ Trax output is

enabled, the Imager will attempt

to output all enabled EZ Trax

options. EZ Trax will not function

unless enabled.

Selects the communication port

that will be used to transfer

image files.

Determines which

read cycle condition

triggers image file

output.

Selects the format of the image

output file.

7-52 MS-4 Imager User’s Manual

Configuring EZ Trax Output

JPEG Quality

Object Info Output

Grade Output

Sets the amount of JPEG image

compression. A value of 1 represents

the highest compression and lowest

image quality, and 100 represents

the lowest compression and highest

image quality.

If a symbol is decoded during

an image capture, the symbol

type and other supplementary

symbol information is also

included.

Symbol quality information

will be output in the form of an

abbreviated identifier for each

read cycle.

MS-4 Imager User’s Manual 7-53

I/O Parameters

Configuring EZ Trax Output by Serial Command

Comm Port

Host Port

Sends output using the current Host Port.

Aux Port

Sends output using the Auxiliary Port.

USB

Sends output using a USB connection.

Image Mode

Good Read

Outputs the first Good Read image in the read cycle. The image file will immediately follow

the symbol data.

Usage: Useful for when you want to configure EZ Trax output using serial commands

instead of the EZ Trax graphic interface.

Definition: When EZ Trax output is enabled, the Imager will attempt to output all

enabled EZ Trax options. EZ Trax will not function unless enabled.

Serial Cmd:

K757,status

,comm port,image mode,image format,jpeg quality,object info

output

, grade output

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: Selects the communication port that will be used to transfer image files.

Serial Cmd:

K757,

status,

comm port

,image mode,image format,jpeg quality,object info

output

, grade output

Default: Host

Options: 0 = Host 1 = Aux 2 = USB

Definition: Determines which read cycle condition triggers image file output.

Serial Cmd:

K757,

status,comm port,

image mode

,image format,jpeg quality,object info

output

, grade output

Default: Disabled

Options: 0 = Disabled 1 = Good Read 2 = No Read

3 = No Read and Good Read 4 = Mismatch

7-54 MS-4 Imager User’s Manual

Configuring EZ Trax Output

No Read

Outputs the first No Read image in the read cycle. The image file will immediately follow

the symbol data.

Note: If two symbols are present in the same image capture and one of them is successfully

decoded, no image will be output.

No Read and Good Read

Outputs the first No Read or Good Read image in the read cycle.

Mismatch

Outputs the image of the first mismatch condition.

Image Format

Lossless

A “lossless” image is one that is in a high resolution format, and that will not lose resolution

even when manipulated and saved multiple times. When Lossless is enabled, the JPEG

Quality setting has no effect.

Compressed

Outputs the image in JPEG format. Image quality is determined by the JPEG Quality

setting.

JPEG Quality

Definition: Selects the format of the image output file.

Serial Cmd:

K757,

status,

comm port,image mode,

image format

,jpeg quality,object info

output

, grade output

Default: Compressed

Options: 0 = Lossless 1 = Compressed

Definition: Sets the amount of JPEG image compression. A value of 1 represents the

highest compression and lowest image quality, and 100 represents the

lowest compression and highest image quality.

Serial Cmd:

K757,

status,comm port,image mode,image format,

jpeg quality

,object info

output

, grade output

Default: 90

Options: 1 to 100 (percent)

MS-4 Imager User’s Manual 7-55

I/O Parameters

Object Info Output

Grade Output

Definition: If a symbol is decoded during an image capture, the symbol type and other

supplementary symbol information is also included.

Serial Cmd:

K757,

comm port,image mode,image format,jpeg quality,

object info output

grade output

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: Symbol quality information will be output in the form of an abbreviated

identifier for each read cycle.

Serial Cmd:

K757,

comm port

,image mode,image format,jpeg quality,object info output,

grade output

Default: Disabled

Options: 0 = Disabled 1 = Enabled

7-56 MS-4 Imager User’s Manual

Configuring EZ Trax Output

MS-4 Imager User’s Manual 8-1

8 Symbol Quality

Contents

This section describes parameters that, when enabled, will output detailed symbol quality

evaluations.

Symbol Quality Serial Commands................................................................................................ 8-2

Overview of Symbol Quality.......................................................................................................... 8-3

Symbol Quality by ESP................................................................................................................. 8-4

Symbol Quality Separator / Data Matrix Output Mode.................................................................. 8-8

ISO/IEC 16022 Symbol Quality Output....................................................................................... 8-10

ISO/IEC 16022 Symbol Quality Output by ESP.......................................................................... 8-12

Microscan Symbol Quality Output .............................................................................................. 8-13

Microscan Symbol Quality Output by ESP ................................................................................. 8-16

8-2 MS-4 Imager User’s Manual

Symbol Quality Serial Commands

Symbol Quality Separator/ Data

Matrix Output Mode <K708,symbol quality separator,Data Matrix output mode>

ISO/IEC 16022 Symbol Quality

Output <K709,symbol contrast,print growth,axial non-uniformity,

UEC>

Microscan Symbol Quality 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>

Static Validation Report <VAL>

MS-4 Imager User’s Manual 8-3

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.

0123456789abcdefghijklmnopqrstuv 256 A 30 210 3 17

Symbol

Data Symbol Contrast

(ISO/IEC 16022)

Capture Time

(Microscan Grading)

Locate Time

(Microscan Grading)

Total

Read Time

Decode Time

(Microscan Grading)

Pixels Per Element

(Microscan Grading)

If you enable the outputs shown above, they will be returned

in this order:

8-4 MS-4 Imager User’s Manual

Symbol Quality by ESP

Tree Control

Click this button

to bring up the

Symbol Quality

tree control.

To change a setting, double-click the setting

and use your cursor to scroll through the options.

To open nested options, single-click the +.

Click this button

to bring up the

App Mode view.

MS-4 Imager User’s Manual 8-5

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 imager’s field of view is shown here.

When grading is completed, the initial

report is also shown in this viewing area.

The Symbol Quality

interface is divided

into three sections:

Report, Locate, and

Preferences.

8-6 MS-4 Imager User’s Manual

Locate Tab

The Locate tab allows the user to determine the position of the symbol within the imager’s

field of view, and to optimize the imager’s camera settings for symbol quality evaluation.

Click the Calibrate

button to optimize

camera settings.

Click the Locate

button to display the

symbol in the

imager’s field of view.

MS-4 Imager User’s Manual 8-7

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.

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.

Returns all settings to

default.

Click the Include Image

check box to output the

captured symbol image

with your saved report as a

Bitmap or JPEG image file.

This information is

appended at the

bottom of the report.

Returns all settings to

most recent.

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.

Enables ESP to parse UII

symbol data into the correct

fields and output order defined

by the U.S. Department of

Defense IUID initiative.

8-8 MS-4 Imager User’s Manual

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

Important:

The ASCII characters

, and

can only be entered as hex pairs:

For <: <K708h,3C>

For >: <K708h,3E>

For , : <K708h,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Symbol Quality Separator by ESP

Definition: Inserts a separator between each enabled field of the symbol quality

output.

Serial Cmd: <K708,symbol quality separator,output mode>

Default: <SP> (space character)

Options: Any ASCII character.

When you double-click on the

default separator SP, the Symbol

Quality Separator Calculator

appears. Use the calculator keypad

for one-click separator configuration.

MS-4 Imager User’s Manual 8-9

Symbol Quality

Data Matrix Output Mode

Note: Output Mode applies to ISO/IEC 16022 symbol quality parameters.

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.

Definition: Output Mode specifies how the four output parameters, if enabled, are

formatted.

Serial Cmd: <K708,symbol quality separator,output mode>

Default: Grade

Options: 0 = Grade 1 = Value

8-10 MS-4 Imager User’s Manual

ISO/IEC 16022 Symbol Quality Output

Symbol Quality Parameters for Data Matrix symbols specified by ISO/IEC 16022.

Symbol Contrast

Print Growth

Usage: Lets the user know if contrast settings are less than acceptable.

Definition: 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%

C (2.0) if SC > 40%

F (0.0) if SC < 20%

B (3.0) if SC > 55%

D (1.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.

Serial Cmd: <K709,symbol contrast,print growth,axial non-uniformity,UEC>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: 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.

Serial Cmd: <K709,symbol contrast,print growth,axial non-uniformity,UEC>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 8-11

Symbol Quality

Axial Non-Uniformity (Data Matrix Only)

Unused Error Correction (Data Matrix Only)

Definition: 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.

Serial Cmd: <K709,symbol contrast,print growth,axial non-uniformity,UEC>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition:

The correction capacity of Reed-Solomon decoding is expressed in the

equation: e + 2d < d - p, where

is the number of erasures,

is the number

of error correction code words, and

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.

Serial Cmd: <K709,symbol contrast,print growth,axial non-uniformity,UEC>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

8-12 MS-4 Imager User’s Manual

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.

MS-4 Imager User’s Manual 8-13

Symbol Quality

Microscan Symbol Quality Output

Percent Cell Damage (Data Matrix Only)

Total Read Time

Capture Time

Locate Time

Definition: When this feature is enabled, the cell damage percentage is appended to

data output.

Serial Cmd: <K710,percent cell damage,total read time,capture time,locate

time,decode time,pixels per element,EC level,matrix size,quiet

zone,symbol angle>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: 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.

Serial Cmd: <K710,percent cell damage,total read timea,capture time,locate

time,decode time,pixels per element,EC level,matrix size,quiet

zone,symbol angle>

a. Total Read Time applies globally to all three Symbol Quality standards.

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: 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.

Serial Cmd: <K710,percent cell damage,total read time,capture time,locate

time,decode time,pixels per element,EC level,matrix size,quiet

zone,symbol angle>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: 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.

Serial Cmd: <K710,percent cell damage,total read time,capture time,locate

time,decode time,pixels per element,EC level,matrix size,quiet

zone,symbol angle>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

8-14 MS-4 Imager User’s Manual

Microscan Symbol Quality Output

Decode Time

Pixels Per Element (Data Matrix Only)

Error Correction Level (Data Matrix Only)

Matrix Size (Data Matrix Only)

Definition: The time in milliseconds required to decode a symbol.

When enabled, the decode time is appended to the symbol data.

Serial Cmd: <K710,percent cell damage,total read time,capture time,locate

time,decode time,pixels per element,EC level,matrix size,quiet

zone,symbol angle>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: 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.

Serial Cmd: <K710,percent cell damage,total read time,capture time,locate

time,decode time,pixels per element,EC level,matrix size,quiet

zone,symbol angle>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: Outputs the Data Matrix ECC level.

When enabled, the ECC level is appended to the symbol data.

Serial Cmd: <K710,percent cell damage,total read time,capture time,locate

time,decode time,pixels per element,EC level,matrix size,quiet

zone,symbol angle>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: 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.

Serial Cmd: <K710,percent cell damage,total read time,capture time,locate

time,decode time,pixels per element,EC level,matrix size,quiet

zone,symbol angle>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

MS-4 Imager User’s Manual 8-15

Symbol Quality

Quiet Zone (Data Matrix Only)

Symbol Angle (Data Matrix Only)

Definition: 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.

Serial Cmd: <K710,percent cell damage,total read time,capture time,locate

time,decode time,pixels per element,EC level,matrix size,quiet

zone,symbol angle>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: When this feature is enabled, the symbol orientation is appended to

data output as a degree value representing the angle of the Data Matrix

symbol’s L-shaped finder pattern relative to the Imager.

Serial Cmd: <K710,percent cell damage,total read time,capture time,locate

time,decode time,pixels per element,ECC level,matrix size,quiet

zone,symbol angle>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

8-16 MS-4 Imager User’s Manual

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.

MS-4 Imager User’s Manual 9-1

9 Matchcode

Contents

This section explains the MS-4’s matchcode output functions and the master symbol

database setup.

Matchcode by ESP....................................................................................................................... 9-2

Matchcode Serial Commands ...................................................................................................... 9-2

Overview of Matchcode................................................................................................................ 9-3

Matchcode Type........................................................................................................................... 9-4

Match Replace.............................................................................................................................. 9-9

Mismatch Replace...................................................................................................................... 9-10

New Master Pin.......................................................................................................................... 9-11

9-2 MS-4 Imager User’s Manual

Matchcode by ESP

Matchcode Serial Commands

Matchcode Type

K223,

matchcode type,sequential matching,match start

position,match length,wild card character,sequence on

No Read,sequence on mismatch>

Number of Master Symbols <K224,number of master symbols>

New Master Pin <K225,status>

Enter Master Symbol Data <K231,master symbol number,master symbol data>

Request Master Symbol Data

K231?,

>[for all]

K231?,

master symbol number>

Delete Master Symbol Data <K231,master symbol number,>

Match Replace <K735,status,match replacement string>

Mismatch Replace <K736,status,mismatch replacement string>

Click this button to

bring up the

Matchcode 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 +.

MS-4 Imager User’s Manual 9-3

Matchcode

Overview of Matchcode

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.

Definition: Matchcode allows the user to store master symbol data in the Imager’s

memory, compare that data against other symbol data, and define how

symbol data and/or discrete signal output will be directed.

A master symbol database can be set up for up to 10 master symbols.

Note: Matchcode

will function with multiple symbols; however, if

Matchcode

Type

is set to

Sequential

or if

Triggering Mode

is set to

Continuous Read 1

Output

, the Imager will behave as if

Number of Symbols

were set to

regardless of the user-defined configuration.

Usage: 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.

9-4 MS-4 Imager User’s Manual

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: <K223,matchcode type,sequential matching,match start position,

match length,wild card character,sequence on No Read,sequence on

mismatch>

Default: Disabled

Options: 0 = Disabled

2 = Wild Card

1 = Enabled

3 = Sequential

Disabled: Has no effect on operations.

Enabled: Instructs the Imager to compare symbols or portions of symbols with the

master symbol.

Wild Card: Allows the user to enter user-defined wild card characters in the master

symbol.

Sequential: Instructs the Imager to sequence after each match (numeric only) and

compare symbols or portions of symbols for sequential numbers.

Note: If Matchcode Type is set to Sequential, the Imager will behave

as if Number of Symbols were set to 1, regardless of the user-defined

configuration.

MS-4 Imager User’s Manual 9-5

Matchcode

Sequential Matching

Match Start Position

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: Useful in tracking product serial numbers that increment or decrement

sequentially.

Definition: With Sequential enabled, Sequential Matching determines if a count is in

ascending (incremental) or descending (decremental) order.

Serial Cmd: <K223,matchcode type,sequential matching,match start position,match

length,wild card character,sequence on No Read,sequence on mismatch>

Default: Increment

Options: 0 = Increment 1 = Decrement

Usage: Match Start Position is useful in defining specific portions of a symbol

for comparison. For example, if a symbol contains a part number, manufacturing

date, and lot code info, but you are only interested in the part number

information, you can set the Imager to sort only the part number and

ignore the other characters.

Definition: Match Start Position determines the portions of symbols that will be

matched by defining the first character in the symbol (from left to right)

that will be compared with those of the master symbol, when Matchcode

Type is set to Enabled or Sequential.

Function: For example, if Match Start Position is set to 3, the first 2 characters

read in the symbol will be ignored and only the 3rd and subsequent

characters to the right will be compared, up to the number of characters

specified by Match Length.

Serial Cmd: <K223,matchcode type,sequential matching,match start position,

match length,wild card character,sequence on No Read,sequence on

mismatch>

Default: 0

Options: 0 to 3000

Usage: 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.

Definition: 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.

Serial Cmd: <K223,matchcode type,sequential matching,match start position,match

length,wild card character,sequence on No Read,sequence on mis-

match>

Default: 1

Options: 1 to 3000

9-6 MS-4 Imager User’s Manual

Matchcode Type

Wild Card Character

Important: The ASCII characters <, >, and , can only be entered as hex pairs:

For <: <K223h,,,,,3C>

For >: <K223h,,,,,3E>

For , : <K223h,,,,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Usage: 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 the wild card at the end of the

master symbol, as in CR*, will result in matches for variable symbol

lengths such as CR1, CR23, CR358, etc.

Definition: Wild Card Character allows a user to define a wild card character as part

of the master symbol.

Serial Cmd: <K223,matchcode type,sequential matching,match start position,match

ength,

wild card character

,sequence on No Read,sequence on mismatch>

Default: * (asterisk)

Options: Any ASCII character.

MS-4 Imager User’s Manual 9-7

Matchcode

Sequence on No Read

As an example of Sequence on No Read Enabled, consider the following decodes:

As an example of Sequence on No Read Disabled, consider the following series of

decodes:

Usage: Sequence on No Read is useful when the Imager needs to stay in

sequence even if no decode occurs.

Definition: When Sequence on No Read is Enabled and Matchcode is set to

Sequential, the Imager sequences the master symbol on every match or

No Read. When disabled, it does not sequence on a No Read.

Serial Cmd: <K223,matchcode type,sequential matching,match start position,match

length,wild card character,

sequence on No Read

,sequence on mismatch>

Default: Enabled

Options: 0 = Disabled 1 = Enabled

Master Symbol Decoded Symbol Master Symbol after Decode

001 001 002

002 002 003

003 No Read 004 (sequenced on No Read)

004 004 005

005 No Read 006 (sequenced on No Read)

006 No Read 007 (sequenced on No Read)

007 007 008

Master Symbol Decoded Symbol Master Symbol after Decode

001 001 002

002 002 003

003 No Read 003 (not sequenced)

003 003 004

004 No Read 004 (not sequenced)

004 004 005

9-8 MS-4 Imager User’s Manual

Sequence on Mismatch

Note: Matchcode must be set to Sequential for this command to function.

The Imager will sequence the master to one more or one less than the decoded symbol.

As an example of Sequence on Mismatch Enabled, consider the following decodes:

As an example of Sequence on Mismatch Disabled, consider the following decodes:

Usage: 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.

Definition: 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.

Serial Cmd: <K223,matchcode type,sequential matching,match start position,match

length,wild card character,sequence on No Read,

sequence on mismatch

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Master Symbol Decoded Symbol Master Symbol after Decode

001 001 002

002 002 003

003 abc 004 (sequenced on mismatch)

004 004 005

005 def 006 (sequenced on mismatch)

006 ghi 007 (sequenced on mismatch)

007 007 008

Master Symbol Decoded Symbol Master Symbol after Decode

001 001 002

002 002 003

003 abc 004 (sequenced because of previous match)

004 004 005

005 def 006 (sequenced because of previous match)

006 ghi 006 (not sequenced)

006 006 007

MS-4 Imager User’s Manual 9-9

Matchcode

Match Replace

Replacement String

Important: The ASCII characters <, >, and , can only be entered as hex pairs:

For <: <K735h,,3C>

For >: <K735h,,3E>

For , : <K735h,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Usage: Provides a convenient shortcut for applications that need to output a

predefined text string whenever a symbol matches a master symbol.

Definition: Outputs a user-defined data string whenever a match occurs and

Matchcode is enabled.

Serial Cmd: <K735,status,replacement string>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: User-defined data string that, when enabled, replaces symbol data

whenever a match occurs.

Serial Cmd: <K735,status,replacement string>

Default: MATCH

Options: An ASCII string up to 64 characters.

9-10 MS-4 Imager User’s Manual

Mismatch Replace

Replacement String

Important: The ASCII characters <, >, and , can only be entered as hex pairs:

For <: <K736h,,3C>

For >: <K736h,,3E>

For , : <K736h,,2C>

See ASCII Character Entry Modifier on page 3-32 for a detailed explanation of how to

enter ASCII characters as hex values.

Usage: Provides a convenient shortcut for applications that need to output a

predefined text string whenever a symbol does not match a master

symbol.

Definition: Outputs a user-defined data string whenever a mismatch occurs and

Matchcode is enabled.

Serial Cmd: <K736,status,replacement string>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: User-defined data string that, when enabled, replaces symbol data

whenever a mismatch occurs.

Serial Cmd: <K736,status,replacement string>

Default: MISMATCH

Options: An ASCII string up to 64 characters.

MS-4 Imager User’s Manual 9-11

Matchcode

New Master Pin

New Master Load Status

Definition: If Matchcode and New Master Pin are enabled and the new master pin

is momentarily connected to ground (must be held low for a minimum of

10 mS) master symbol information will be loaded into the database

based on the next read cycle that achieves a Good Read, starting with

Index 1. The Master Symbol Database will be loaded with all symbols

decoded in the read cycle as long as it does not exceed the Number of

Master Symbols parameter.

Serial Cmd: <K225,status>

Default: Disabled

Options: 0 = Disabled 1 = Enabled

Definition: 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>.

Serial Cmd: <NEWM>

9-12 MS-4 Imager User’s Manual

MS-4 Imager User’s Manual 10-1

Camera and IP Setup

Contents

This section provides adjustment parameters for the physical controls of the camera, image

acquisition, database settings, and image diagnostics.

Camera and IP Setup by ESP ....................................................................................................10-2

Camera and IP Setup Serial Commands.................................................................................... 10-3

Video........................................................................................................................................... 10-4

Evaluation................................................................................................................................... 10-5

Calibration................................................................................................................................... 10-9

Window of Interest.................................................................................................................... 10-10

Configuration Database............................................................................................................ 10-13

Dynamic Setup .........................................................................................................................10-14

Pixel Sub-Sampling .................................................................................................................. 10-15

Camera..................................................................................................................................... 10-16

Focal Distance.......................................................................................................................... 10-18

Focal Distance Table (Read-Only) ...........................................................................................10-19

IP Threshold ............................................................................................................................. 10-20

Number of Symbols in Field of View......................................................................................... 10-22

Image Processing Timeout.......................................................................................................10-23

Damaged Symbol ..................................................................................................................... 10-24

IP Mode .................................................................................................................................... 10-25

Hollow Mode............................................................................................................................. 10-26

Mirrored Image ......................................................................................................................... 10-27

Illumination Brightness.............................................................................................................. 10-28

Skew Correction ....................................................................................................................... 10-29

10-2 MS-4 Imager User’s Manual

Camera and IP Setup by ESP

Click this 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 +.

MS-4 Imager User’s Manual 10-3

Camera and IP Setup

Camera and IP Setup Serial Commands

IP Threshold <K512,threshold mode,fixed threshold value>

Mirrored Image <K514,mirrored image>

Window of Interest <K516,row pointer,column pointer,row depth,column width>

Hollow Mode <K517,hollow mode status>

Number of Symbols in Field of View

<K518,number of symbols in field of view>

Damaged Symbol

<K519,damaged symbol status>

Focal Distance

<K525,focal distance (read only)>

Focal Distance Table

<K526,number of focal distances,focal distance>

IP Mode <K527,IP Mode,FLM direction>

Illumination Brightness <K536,brightness>

Skew Correction <K537,line speed,symbol direction>

Camera <K541,shutter speed,gain>

Pixel Sub-Sampling <K542,sub-sampling>

10-4 MS-4 Imager User’s Manual

Video

The Video view is similar to the EZ Mode interface, in that the user has the ability to perform

the same Locate, Calibrate, and Test routines. There is also a focal distance adjustment

tool to the right of the video view.

Video

also features

Capture and Decode

functionality, which is similar to the

Configuration

interfaces (

Communication

Read Cycle

Symbologies

I/O

Matchcode

, and

Diagnostics

Activates the Imager’s target

pattern and initiates live

video display of the symbol

in the field of view.

Initiates Calibration routine.

Symbol data and

Test results are

shown in this field.

When enabled, shows the

symbol in higher contrast

than the default contrast

value.

Allows the user to take an

image capture of the

symbol in the field of view

at any time, and to

decode the symbol data.

Similar to the Capture

and Decode function in

the Configuration views.

Initiates the Test routine.

Allows the user to test the

Imager’s read rate and

decodes per second, and also

displays decoded symbol data

in the field at the bottom of the

screen, Click Stop to end the

Test routine.

MS-4 Imager User’s Manual 10-5

Camera and IP Setup

Evaluation

In Evaluation, you can view images

currently in the Imager, capture and

decode a symbol, save it as a digital

file, and perform histogram and line

scan evaluations.

When you click on the Evaluation

tab, you will see the images that are

currently stored in the Imager.

Click Receive to refresh this view.

Click Capture/Decode to display the

current stored image. Only one capture

and decode event will occur, regardless

of read cycle settings.

Click Read to trigger a read cycle. If

there is enough time in the read cycle,

up to 32 good reads (or 6 full-scale

images) can be captured and displayed,

depending on the size of

the images, and

depending on the number enabled

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.

10-6 MS-4 Imager User’s Manual

Evaluation

Histogram

Note: Since histograms are performed in the Imager, the results will be saved regardless

of whether the image was uploaded as a JPEG (.jpg) or a bitmap (.bmp).

1. From the Evaluation window, click the Histogram button.

The current image is transferred into the histogram operation. This may take a

moment, since all the relevant pixels are being evaluated intensively.

2. When the Histogram window opens, you may need to expand the window and/or

adjust the scroll bars in order to bring the image into view.

3. To generate a histogram, click and drag your cursor diagonally across the symbol or

a portion of the symbol.

The image will be surrounded by an “area of interest box”, a dashed blue line with red

anchor points that can be selected and moved by placing a cursor inside the box, and

can be resized by clicking and dragging the anchor points.

Usage: Useful in determining quality and contrast of symbols.

Definition: 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.

MS-4 Imager User’s Manual 10-7

Camera and IP Setup

Threshold (Histogram)

Enable Autothreshold is checked by default.

To adjust the threshold manually,

1. Uncheck the Enable Autothreshold box.

2. Move the threshold marker (vertical green dashed line) in the Histogram chart.

Hint: This should be midway between the maximum and minimum curves.

3. Click on the Send Threshold button to adopt the new threshold position.

10-8 MS-4 Imager User’s Manual

Evaluation

Line Scan

1. From the Evaluation tab, click the Line Scan button.

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.

MS-4 Imager User’s Manual 10-9

Camera and IP Setup

Calibration

The Calibration interface in ESP is a powerful and intuitive way to optimize the Imager’s

performance. It allows the user to control several complex, simultaneous calibration

operations, and to follow the progress of those operations using cues such as progress

bars, real-time representations of calibration values, and other dynamic user feedback.

See Chapter 4, Calibration, for full documentation of this feature.

ESP’s Calibration interface shown

during a calibration routine ESP’s Calibration interface shown

after a calibration routine

10-10 MS-4 Imager User’s Manual

Window of Interest

The active pixel area of the image sensor is called the Window of Interest (WOI). The WOI

allows the user to select an area of the field of view in which the desired symbol is located.

The programmable window of interest increases decode speed, improves threshold, and

makes it easy to select specific symbols from among several in the field of view. The user

provides the upper-left pixel location and the size of the window to define the Window of

Interest.

Caution: Window of Interest will shrink the field of view and therefore could cause symbols

to be missed in dynamic applications.

MS-4 Imager User’s Manual 10-11

Camera and IP Setup

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 just click anywhere

in the WOI pane.

Note that all pixels not in the WOI are defined as black.

Because the Imager has far less processing to do in a smaller window, read rates

typically increase dramatically. One possible downside is that the chance of missing

a symbol increases with the smaller window. Always verify that your WOI will be

large enough to allow for any random movement of symbols in your field of view.

10-12 MS-4 Imager User’s Manual

Window of Interest

Window of Interest by Serial Command

The exact size and position of the WOI within

the image area can be defined numerically in

terms of pixels.

The figure to the right shows where to locate

the start position of the row and column pointers

and how to measure the column depth and

row width dimensions.

Top (Row Pointer)

Left (Column Pointer)

Height (Row Depth)

Width (Column Width)

Definition: Defines the row position of the upper-left starting point of the window.

Serial Cmd: <K516,row pointer,column pointer,row depth,column width>

Default: 0

Options: 0 to 480

Definition: Defines the column position of the upper-left starting point of the window.

Serial Cmd: <K516,row pointer,column pointer,row depth,column width>

Default: 0

Options: 0 to 640

Definition: Defines the size, in rows, of the window. Maximum value is defined as

the maximum row size of the image sensor minus the Top value.

Serial Cmd: <K516,row pointer,column pointer,row depth,column width>

Default: 0

Options: 3 to (480 - row pointer)

Definition: Defines the column position of the upper-left starting point of the window.

Serial Cmd: <K516,row pointer,column pointer,row depth,column width>

Default: 0

Options: 8 to (640 - column pointer)

WOI Column

Pointer

WOI Row Pointer

WOI Column Width

WOI Row Depth

MS-4 Imager User’s Manual 10-13

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 complex Imager configurations to

be applied sequentially, and it allows the user to perform far more complex operations

than would be possible with only one set of configuration parameters.

See Chapter 11, Configuration Database, for full documentation of this feature.

Configuration Database view, set for 5 Active Indexes, with Capture Settings highlighted.

10-14 MS-4 Imager User’s Manual

Dynamic Setup

Dynamic Setup is used to calculate image capture timing during a read cycle. Without proper

timing, the Imager will not be able to decode all symbols in a read cycle. An external trigger is

used to activate image captures so the user can make timing adjustments as capture events

occur.

The user can control Capture #, Number of Captures,

and Number of Symbols using these spin boxes.

Read Rate is

represented

graphically in

real-time as the

user makes

adjustments to

the time delay

between image

captures.

The user can control Capture

#, Number of Captures, and

Number of Symbols using

these controls.

The Delay Adjustment slider allows the

user extremely precise control of the time

delays between image captures in a read

cycle. Delay values are shown in seconds

in the field above the slider. The Coarse

and Fine Delay Adjustment options

determine whether larger or smaller

adjustment increments will be used.

MS-4 Imager User’s Manual 10-15

Camera and IP Setup

Pixel Sub-Sampling

4:1

At this sampling rate, 1 pixel is output for every 4 pixels sampled. The image will be sampled

2:1 vertically and 2:1 horizontally, for a combined 4:1 ratio. An image with dimensions of 640

x 480 will be scaled to 320 x 240.

16:1

At this sampling rate, 1 pixel is output for every 16 pixels sampled. The image will be sampled

4:1 vertically and 4:1 horizontally, for a combined 16:1 ratio. An image with dimensions of 640

x 480 will be scaled to 160 x 120.

Definition: The camera can be enabled to sub-sample pixels in the specified image

frame. Sub-sampling can be set to either 4:1 or 16:1. These ratios signify

the sampling rate.

Usage: <K542,sub-sampling>

Default: Disabled

Options: 0 = Disabled 1 = 4:1

2 = 16:1

10-16 MS-4 Imager User’s Manual

Camera

Camera parameters are typically obtained during the calibration process, and do not

necessarily need to be modified directly by the user.

Optics

The MS-4 Imager has two different optical configurations available:

Standard Density

and

Low Density

. Determine the optics of your Imager and find the corresponding camera values

in the following sections.

MS-4 Standard Density (HD 1.0 mm Optics), 3” Focal Distance

Shutter Speed

Gain

Usage: Faster shutter speeds reduce blurring in faster applications.

Slower shutter speeds are useful in slower applications and lower contrast

applications.

Definition:

This value sets the exposure or integration time for the image sensor pixels.

The shutter speed setting in relation to the speed of the object is critical. If a

slow shutter speed is selected to capture fast-moving objects, blurring or

smearing of the image will occur. As shutter speed is increased, more light

and gain become necessary, because the pixels’ exposure time has

decreased.

Serial Cmd: <K541,shutter speed,gain>

Default: 30 (1/30 second)

Options: 15 to 12,500

Usage: Can be used to adjust pixel grayscale values for readability.

Definition: Sets the gain value for the image sensor. This setting can be configured

through autocalibration, which is the recommended method. A higher

gain value will increase the brightness of the image, but the visual noise

reduction performance of the system is reduced. Before configuring gain

settings, the desired shutter speed should already be set and the gain

should be configured to optimize the shutter speed setting.

Serial Cmd: <K541,shutter speed,gain>

Default: 20

Options: 0 to 48

MS-4 Imager User’s Manual 10-17

Camera and IP Setup

MS-4 Low Density (SD Optics), 4” Focal Distance

Shutter Speed

Gain

Usage: Faster shutter speeds reduce blurring in faster applications.

Slower shutter speeds are useful in slower applications and lower contrast

applications.

Definition:

This value sets the exposure or integration time for the image sensor pixels.

The shutter speed setting in relation to the speed of the object is critical. If a

slow shutter speed is selected to capture fast-moving objects, blurring or

smearing of the image will occur. As shutter speed is increased, more light

and gain become necessary, because the pixels’ exposure time has

decreased.

Serial Cmd: <K541,shutter speed,gain>

Default: 150 (1/150 second)

Options: 15 to 12,500

Usage: Can be used to adjust pixel grayscale values for readability.

Definition: Sets the gain value for the image sensor. This setting can be configured

through autocalibration, which is the recommended method. A higher

gain value will increase the brightness of the image, but the visual noise

reduction performance of the system is reduced. Before configuring gain

settings, the desired shutter speed should already be set and the gain

should be configured to optimize the shutter speed setting.

Serial Cmd: <K541,shutter speed,gain>

Default: 20

Options: 0 to 48

10-18 MS-4 Imager User’s Manual

Focal Distance

Definition: This command returns the Imager’s factory preset focal distance.

Serial Cmd: <K525,focal distance (read only)>

Default: Standard Density = 300 (3”)

Low Density = 400 (4”)

Options: N/A

MS-4 Imager User’s Manual 10-19

Camera and IP Setup

Focal Distance Table (Read-Only)

Number of Focal Distances

Focal Distance

Definition: Specifies the number of focal distances supported by the Imager (1).

Serial Cmd: <K526,number of focal distances,focal distance>

Default: 1

Options: N/A (Focal Distance is factory preset.)

Definition: Returns the Imager’s factory preset focal distance.

Serial Cmd: <K526,number of focal distances,focal distance>

Default: Returns the Imager’s factory preset Focal Distance value.

Options: N/A

10-20 MS-4 Imager User’s Manual

IP Threshold

Threshold Mode

Threshold Value

Cycle Min

Usage: Fixed Mode works best when decode time must be as short as possible

and the reflectance and illumination of the symbol area is uniform and

unchanging. Cycle Fixed Mode is useful in applications where decode

time can be slightly longer, and reflectance and illumination of the symbol

area is uniform and unchanging. Otherwise,

Adaptive Mode

is the preferred

mode.

Definition: This value switches the image processing threshold mode between the

Adaptive, Fixed, and Cycle Fixed modes.

An adaptive routine sets the light/dark threshold using data acquired from

the current read. A fixed routine applies the same gray scale threshold

value to each and every symbol. A cycle fixed routine loops through a

pre-defined range of values (Cycle Min to Cycle Max) by pre-defined

increments (Cycle Step).

Serial Cmd: <K512,threshold mode,threshold value,cycle min,cycle max,cycle step>

Default: Adaptive

Options: 0 = Adaptive 1 = Fixed

2 = Cycle Fixed

Usage: A higher value will increase the threshold for distinguishing between light

and dark elements.

Definition: Determines how the Imager will distinguish light pixels from dark pixels.

This value is used for Fixed Mode only. When Adaptive Mode is set,

this value is ignored.

Serial Cmd: <K512,threshold mode,threshold value,cycle min,cycle max,cycle step>

Default: 128

Options: 0 to 255

Definition: Starting value of the cycle mode.

Serial Cmd: <K512,threshold mode,threshold value,cycle min,cycle max,cycle step>

Default: 0

Options: 0 to 255

Important: Cycle Min must be a smaller numerical value than Cycle Max.

MS-4 Imager User’s Manual 10-21

Camera and IP Setup

Cycle Max

Cycle Step

Definition: Ending value of the cycle mode.

Serial Cmd: <K512,threshold mode,threshold value,cycle min,cycle max,cycle step>

Default: 255

Options: 0 to 255

Important: Cycle Max must be a greater numerical value than Cycle Min.

Definition: The numerical value of a single cycle mode increment.

Serial Cmd: <K512,threshold mode,threshold value,cycle min,cycle max,cycle step>

Default: 10

Options: 0 to 255

10-22 MS-4 Imager User’s Manual

Number of Symbols in Field of View

Note: When the number of symbols in the field of view is set to 1, codeword stitching from

all scaled image processes is allowed for PDF417 and MicroPDF417.

Note: This variable is used in Fast Linear Mode. FLM usually considers the whole image

as one candidate, but when Number of Symbols in Field of View is set to 2, FLM will try

to locate the candidates first and then decode. The symbols cannot be side-by-side--they

must be parallel.

Definition:

This command allows the user to determine how

FLM

will behave in relation

to the candidate symbols in the field of view.

Serial Cmd: <K518,number of symbols in field of view>

Default: 0

Options: 0 = Any number of symbols

1 = One symbol

2 = More than one symbol

MS-4 Imager User’s Manual 10-23