MS4717
Fixed Mount Imager
Integration Guide
MN-003432-04EN Rev. A
Copyright
ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies Corporation, registered in many
jurisdictions worldwide. All other trademarks are the property of their respective owners.
©2021 Zebra Technologies Corporation and/or its affiliates. All rights reserved.
COPYRIGHTS & TRADEMARKS: For complete copyright and trademark information, go to www.zebra.com/
copyright.
WARRANTY: For complete warranty information, go to www.zebra.com/warranty.
END USER LICENSE AGREEMENT: For complete EULA information, go to www.zebra.com/eula.
Terms of Use
• Proprietary Statement
This manual contains proprietary information of Zebra Technologies Corporation and its subsidiaries
(“Zebra Technologies”). It is intended solely for the information and use of parties operating and
maintaining the equipment described herein. Such proprietary information may not be used, reproduced,
or disclosed to any other parties for any other purpose without the express, written permission of Zebra
Technologies.
• Product Improvements
Continuous improvement of products is a policy of Zebra Technologies. All specifications and designs are
subject to change without notice.
• Liability Disclaimer
Zebra Technologies takes steps to ensure that its published Engineering specifications and manuals are
correct; however, errors do occur. Zebra Technologies reserves the right to correct any such errors and
disclaims liability resulting therefrom.
• Limitation of Liability
In no event shall Zebra Technologies or anyone else involved in the creation, production, or delivery of the
accompanying product (including hardware and software) be liable for any damages whatsoever
(including, without limitation, consequential damages including loss of business profits, business
interruption, or loss of business information) arising out of the use of, the results of use of, or inability to
use such product, even if Zebra Technologies has been advised of the possibility of such damages. Some
jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so the above
limitation or exclusion may not apply to you.
2
Revision History
Changes to the original guide are listed below:
Change Date Description
-04EN Rev A 7/2021 Removed:
-03 Rev A 5/2020 Updated Release:
-02 Rev A 4/2020 Updated Release:
- Provide Documentation Feedback
Added:
- Digimarc
- A note in Mirrored Image
- DotCode
- DotCode Inverse
- DotCode Mirrored
- DotCode Prioritize
- DotCode Erasure Limit.
Split ADF section from 123Scan chapter and created new Data Formatting chapter.
- Added Mirrored Image Parameter
- Mounting instructions for Cone included
- Decode Ranges to include Cone
- Added Driver’s License Parsing Chapter
-01 Rev A 4/2019 Initial Release
3
Contents
Copyright ............................................................................................................................... 2
Terms of Use ......................................................................................................................... 2
Revision History .................................................................................................................... 3
About This Guide
Introduction ......................................................................................................................... 15
Configurations ..................................................................................................................... 15
Chapter Descriptions ........................................................................................................... 15
Notational Conventions ....................................................................................................... 17
Related Documents ............................................................................................................. 17
Service Information ............................................................................................................. 17
Getting Started
Introduction ......................................................................................................................... 18
MS4717 Features ............................................................................................................. 18
Theory of Operation ............................................................................................................ 19
MS4717 Block Diagram Descriptions ............................................................................... 19
MS4717 Decoder/Interface Board .................................................................................... 20
123Scan
Introduction ......................................................................................................................... 21
123Scan .............................................................................................................................. 21
Communication with 123Scan .......................................................................................... 22
123Scan Requirements .................................................................................................... 22
123Scan Information ......................................................................................................... 22
Imager SDK, Other Software Tools, and Videos .............................................................. 23
Installation
Introduction ......................................................................................................................... 24
Mounting ............................................................................................................................. 24
MS4717 Mounting Dimensions ......................................................................................... 24
Connecting the MS4717 ...................................................................................................... 26
Accessories ......................................................................................................................... 27
Location and Positioning ..................................................................................................... 27
4
Contents
Window Material ............................................................................................................... 28
Cell Cast Acrylic (ASTM: PMMA) ...................................................................................... 28
Cell Cast ADC (ASTM: ADC) ............................................................................................ 28
Chemically Tempered Glass ............................................................................................. 28
Commercially Available Coatings ........................................................................................ 28
Anti-Reflection Coatings ................................................................................................... 28
Polysiloxane Coating ........................................................................................................ 29
A Word About Coatings .................................................................................................... 29
Embedded Window Angle and Position ............................................................................ 30
MS4717 Optical Path .......................................................................................................... 31
MS4717 Recommended Exit Window Information .............................................................. 32
Exit Window Notes ............................................................................................................ 32
MS4717 Cone Optical Path ................................................................................................. 33
MS4717 Cone Exit Window Field of View ......................................................................... 35
Zebra SNAPI Software Developer's Kit ............................................................................... 36
Scanning
Introduction ......................................................................................................................... 37
Imaging System .................................................................................................................. 37
Aiming System .................................................................................................................. 37
Aiming with MS4717 ......................................................................................................... 37
Aiming Error ...................................................................................................................... 38
Aiming Control .................................................................................................................. 38
Illumination System ........................................................................................................... 38
Illumination Control ........................................................................................................... 38
Supported Symbologies ...................................................................................................... 38
Operating Modes ................................................................................................................. 39
Specifications
Introduction ......................................................................................................................... 40
MS4717 Technical Specifications ...................................................................................... 40
Skew, Pitch and Roll ......................................................................................................... 42
Decode Zones ..................................................................................................................... 43
Maintenance and Troubleshooting
Introduction ......................................................................................................................... 44
Maintenance ........................................................................................................................ 44
Troubleshooting .................................................................................................................. 44
User Preferences
Introduction ......................................................................................................................... 46
Scanning Sequence Examples ........................................................................................... 47
Errors While Scanning ........................................................................................................ 47
User Preferences Parameter Defaults ................................................................................ 47
User Preferences ................................................................................................................ 49
Default Parameters ........................................................................................................... 49
5
Contents
Parameter Barcode Scanning ........................................................................................... 50
Beep After Good Decode .................................................................................................. 51
Beep on <BEL> ................................................................................................................ 51
Lock/Unlock Parameter Scanning ..................................................................................... 52
Beeper Volume ................................................................................................................. 53
Beeper Tone ..................................................................................................................... 54
Beeper Duration ................................................................................................................ 55
Suppress Power Up Beeps ............................................................................................... 55
Trigger Mode .................................................................................................................... 56
Presentation Decode Aiming Pattern ................................................................................ 57
Picklist Mode ..................................................................................................................... 58
Decode Session Timeout .................................................................................................. 59
Hands-Free Decode Session Timeout .............................................................................. 59
Timeout Between Decodes, Same Symbol ...................................................................... 61
Timeout Between Decodes, Different Symbols ................................................................ 61
Mobile Phone/Display Mode ............................................................................................. 62
PDF Prioritization .............................................................................................................. 63
PDF Prioritization Timeout ................................................................................................ 64
Low Light Assist Scene Detection ..................................................................................... 65
Presentation Mode Field of View ...................................................................................... 66
Scene Detect Sensitivity ................................................................................................... 67
Mirrored Image .................................................................................................................. 67
Decoding Illumination ........................................................................................................ 68
Add an Enter Key .............................................................................................................. 68
Transmit Code ID Character ............................................................................................. 69
Prefix/Suffix Values ........................................................................................................... 70
Scan Data Transmission Format ...................................................................................... 71
FN1 Substitution Values ................................................................................................... 72
Transmit “No Read” Message ........................................................................................... 73
Unsolicited Heartbeat Interval ........................................................................................... 74
Product ID Type (PID) ....................................................................................................... 75
Report Version .................................................................................................................. 75
Report Decoder Manufacturing Information ...................................................................... 76
Report Engine Manufacturing Information ........................................................................ 76
Imager Preferences
Introduction ......................................................................................................................... 77
Scanning Sequence Examples ........................................................................................... 78
Errors While Scanning ........................................................................................................ 78
Imaging Preferences Parameter Defaults ........................................................................... 78
Imager Preferences ............................................................................................................. 80
Operational Modes ........................................................................................................... 80
Image Capture Illumination ............................................................................................... 82
Image Capture Autoexposure ........................................................................................... 82
Fixed Exposure ................................................................................................................. 83
Gain/Exposure Priority for Snapshot Mode ....................................................................... 84
Snapshot Mode Timeout ................................................................................................... 85
Snapshot Aiming Pattern .................................................................................................. 86
Silence Operational Mode Changes ................................................................................. 86
Image Cropping ................................................................................................................ 87
6
Contents
Crop to Pixel Addresses ................................................................................................... 88
Image Size (Number of Pixels) ......................................................................................... 89
Image Brightness (Target White) ...................................................................................... 90
JPEG Image Options ........................................................................................................ 90
JPEG Target File Size ...................................................................................................... 91
JPEG Quality .................................................................................................................... 91
Image Enhancement ......................................................................................................... 92
Image File Format Selector ............................................................................................... 93
Image Rotation ................................................................................................................. 94
Bits Per Pixel (BPP) .......................................................................................................... 95
Signature Capture ............................................................................................................. 96
Signature Capture Image File Format Selection ............................................................... 97
Signature Capture Bits Per Pixel ...................................................................................... 98
Signature Capture Width ................................................................................................... 99
Signature Capture Height ................................................................................................. 99
Signature Capture JPEG Quality ...................................................................................... 99
Video View Finder Image Size ........................................................................................ 100
Video View Finder ........................................................................................................... 101
USB Interface
Introduction ....................................................................................................................... 102
Connecting a USB Interface .............................................................................................. 102
USB Parameter Defaults ................................................................................................... 103
USB Host Parameter ......................................................................................................... 104
USB Device Type ............................................................................................................ 104
Symbol Native API (SNAPI) Status Handshaking ........................................................... 106
USB Keystroke Delay ..................................................................................................... 107
USB CAPS Lock Override .............................................................................................. 107
USB Ignore Unknown Characters ................................................................................... 108
USB Convert Unknown to Code 39 ................................................................................ 108
Emulate Keypad ............................................................................................................. 109
Emulate Keypad with Leading Zero ................................................................................ 109
Quick Keypad Emulation ................................................................................................. 110
USB Keyboard FN 1 Substitution .................................................................................... 110
Function Key Mapping .................................................................................................... 111
Simulated Caps Lock ...................................................................................................... 111
Convert Case .................................................................................................................. 112
USB Static CDC .............................................................................................................. 112
Optional USB Parameters ................................................................................................. 113
Ignore Beep Directive ..................................................................................................... 113
Ignore Barcode Configuration ......................................................................................... 113
USB Polling Interval ........................................................................................................ 114
USB Fast HID ................................................................................................................. 116
IBM Specification Version ............................................................................................... 116
ASCII Character Set for USB ............................................................................................ 116
SSI Interface
Introduction ....................................................................................................................... 117
7
Contents
Communications ............................................................................................................... 117
SSI Transactions ............................................................................................................... 119
General Data Transactions ............................................................................................. 119
Transfer of Decode Data ................................................................................................. 120
Communication Summary ................................................................................................. 121
ACK/NAK Option ............................................................................................................ 121
Number of Data Bits ........................................................................................................ 121
Serial Response Time-out .............................................................................................. 121
Retries ............................................................................................................................ 122
Response Time-out and ACK/NAK Handshake .............................................................. 122
Errors .............................................................................................................................. 122
Things to Remember When Using SSI Communication ................................................... 122
Encapsulation of RSM Commands/Responses over SSI ................................................. 123
Command Structure ........................................................................................................ 123
Response Structure ........................................................................................................ 123
Example Transaction ...................................................................................................... 124
Simple Serial Interface Default Parameters ...................................................................... 125
SSI Host Parameters ........................................................................................................ 126
Decode Data Packet Format ........................................................................................... 127
Host Serial Response Time-out ...................................................................................... 128
Host Character Time-out ................................................................................................. 129
Multipacket Option .......................................................................................................... 130
Interpacket Delay ............................................................................................................ 131
Event Reporting ................................................................................................................ 132
Decode Event ................................................................................................................. 132
Boot Up Event ................................................................................................................. 133
Parameter Event ............................................................................................................. 133
Symbologies
Introduction ....................................................................................................................... 134
Scanning Sequence Examples ......................................................................................... 134
Errors While Scanning ...................................................................................................... 134
Symbology Parameter Defaults ........................................................................................ 135
Enable/Disable All Code Types ......................................................................................... 141
UPC/EAN .......................................................................................................................... 142
Enable/Disable UPC-A .................................................................................................... 142
Enable/Disable UPC-E .................................................................................................... 142
Enable/Disable UPC-E1 .................................................................................................. 143
Enable/Disable EAN-8/JAN-8 ......................................................................................... 143
Enable/Disable EAN-13/JAN-13 ..................................................................................... 144
Enable/Disable Bookland EAN ....................................................................................... 144
Decode UPC/EAN/JAN Supplementals .......................................................................... 145
User-Programmable Supplementals ............................................................................... 148
UPC/EAN/JAN Supplemental Redundancy .................................................................... 148
UPC/EAN/JAN Supplemental AIM ID Format ................................................................. 149
UPC Reduced Quiet Zone .............................................................................................. 150
Transmit UPC-A Check Digit .......................................................................................... 150
Transmit UPC-E Check Digit .......................................................................................... 151
Transmit UPC-E1 Check Digit ........................................................................................ 151
UPC-A Preamble ............................................................................................................ 152
8
Contents
UPC-E Preamble ............................................................................................................ 153
UPC-E1 Preamble .......................................................................................................... 154
Convert UPC-E to UPC-A ............................................................................................... 155
Convert UPC-E1 to UPC-A ............................................................................................. 155
EAN-8/JAN-8 Extend ...................................................................................................... 156
Bookland ISBN Format ................................................................................................... 156
UCC Coupon Extended Code ......................................................................................... 157
Coupon Report ............................................................................................................... 158
ISSN EAN ....................................................................................................................... 158
Code 128 ........................................................................................................................... 159
Enable/Disable Code 128 ............................................................................................... 159
Set Lengths for Code 128 ............................................................................................... 160
Enable/Disable GS1-128 (formerly UCC/EAN-128) ........................................................ 161
Enable/Disable ISBT 128 ................................................................................................ 161
ISBT Concatenation ........................................................................................................ 162
Check ISBT Table ........................................................................................................... 163
ISBT Concatenation Redundancy ................................................................................... 163
Code 128 Security Level ................................................................................................. 164
Code 128 Reduced Quiet Zone ...................................................................................... 165
Ignore Code 128 <FNC4> .............................................................................................. 165
Code 39 ............................................................................................................................. 166
Enable/Disable Code 39 ................................................................................................. 166
Enable/Disable Trioptic Code 39 .................................................................................... 166
Convert Code 39 to Code 32 .......................................................................................... 167
Code 32 Prefix ................................................................................................................ 167
Set Lengths for Code 39 ................................................................................................. 168
Code 39 Check Digit Verification .................................................................................... 169
Transmit Code 39 Check Digit ........................................................................................ 169
Code 39 Full ASCII Conversion ...................................................................................... 170
Code 39 Security Level ................................................................................................... 171
Code 39 Reduced Quiet Zone ........................................................................................ 172
Code 93 ............................................................................................................................. 172
Enable/Disable Code 93 ................................................................................................. 172
Set Lengths for Code 93 ................................................................................................. 173
Code 11 ............................................................................................................................. 174
Code 11 .......................................................................................................................... 174
Set Lengths for Code 11 ................................................................................................. 175
Code 11 Check Digit Verification .................................................................................... 176
Transmit Code 11 Check Digit(s) .................................................................................... 177
Interleaved 2 of 5 (ITF) ...................................................................................................... 177
Enable/Disable Interleaved 2 of 5 ................................................................................... 177
Set Lengths for Interleaved 2 of 5 ................................................................................... 178
I 2 of 5 Check Digit Verification ....................................................................................... 179
Transmit I 2 of 5 Check Digit ........................................................................................... 180
Convert I 2 of 5 to EAN-13 .............................................................................................. 180
I 2 of 5 Security Level ..................................................................................................... 181
I 2 of 5 Reduced Quiet Zone ........................................................................................... 182
Discrete 2 of 5 (DTF) ......................................................................................................... 182
Enable/Disable Discrete 2 of 5 ........................................................................................ 182
Set Lengths for Discrete 2 of 5 ....................................................................................... 183
Codabar (NW - 7) .............................................................................................................. 184
9
Contents
Enable/Disable Codabar ................................................................................................. 184
Set Lengths for Codabar ................................................................................................. 185
CLSI Editing .................................................................................................................... 186
NOTIS Editing ................................................................................................................. 186
Codabar Upper or Lower Case Start/Stop Characters Detection ................................... 187
MSI .................................................................................................................................... 187
Enable/Disable MSI ........................................................................................................ 187
Set Lengths for MSI ........................................................................................................ 188
MSI Check Digits ............................................................................................................ 189
Transmit MSI Check Digit(s) ........................................................................................... 189
MSI Check Digit Algorithm .............................................................................................. 190
Chinese 2 of 5 ................................................................................................................... 190
Enable/Disable Chinese 2 of 5 ........................................................................................ 190
Matrix 2 of 5 ...................................................................................................................... 191
Enable/Disable Matrix 2 of 5 ........................................................................................... 191
Set Lengths for Matrix 2 of 5 ........................................................................................... 192
Matrix 2 of 5 Check Digit ................................................................................................. 193
Transmit Matrix 2 of 5 Check Digit .................................................................................. 193
Korean 3 of 5 ..................................................................................................................... 194
Enable/Disable Korean 3 of 5 ......................................................................................... 194
Inverse 1D ......................................................................................................................... 195
GS1 DataBar ..................................................................................................................... 196
GS1 DataBar-14 ............................................................................................................. 196
GS1 DataBar Limited ...................................................................................................... 196
GS1 DataBar Expanded ................................................................................................. 197
Convert GS1 DataBar to UPC/EAN ................................................................................ 197
GS1 DataBar Limited Security Level .............................................................................. 198
Composite ......................................................................................................................... 199
Composite CC-C ............................................................................................................. 199
Composite CC-A/B .......................................................................................................... 199
Composite TLC-39 .......................................................................................................... 200
UPC Composite Mode .................................................................................................... 200
Composite Beep Mode ................................................................................................... 201
GS1-128 Emulation Mode for UCC/EAN Composite Codes ........................................... 201
2D Symbologies ................................................................................................................ 202
Enable/Disable PDF417 .................................................................................................. 202
Enable/Disable MicroPDF417 ......................................................................................... 202
Code 128 Emulation ....................................................................................................... 203
Data Matrix ..................................................................................................................... 204
GS1 Data Matrix ............................................................................................................. 204
Data Matrix Inverse ......................................................................................................... 205
Maxicode ........................................................................................................................ 205
QR Code ......................................................................................................................... 206
GS1 QR .......................................................................................................................... 206
MicroQR .......................................................................................................................... 207
Aztec ............................................................................................................................... 207
Aztec Inverse .................................................................................................................. 208
Han Xin ........................................................................................................................... 209
Han Xin Inverse .............................................................................................................. 209
DotCode .......................................................................................................................... 210
DotCode Inverse ............................................................................................................. 210
10
Contents
DotCode Mirrored ........................................................................................................... 211
DotCode Prioritize ........................................................................................................... 211
DotCode Erasure Limit .................................................................................................... 212
Postal Codes ..................................................................................................................... 213
US Postnet ...................................................................................................................... 213
US Planet ........................................................................................................................ 213
Transmit US Postal Check Digit ...................................................................................... 214
UK Postal ........................................................................................................................ 214
Transmit UK Postal Check Digit ...................................................................................... 215
Japan Postal ................................................................................................................... 215
Australia Post .................................................................................................................. 216
Australia Post Format ..................................................................................................... 217
Netherlands KIX Code ................................................................................................... 218
USPS 4CB/One Code/Intelligent Mail ............................................................................. 218
UPU FICS Postal ............................................................................................................ 219
Mailmark ......................................................................................................................... 219
Symbology-Specific Security Levels ................................................................................. 220
Redundancy Level .......................................................................................................... 220
Security Level ................................................................................................................. 222
1D Quiet Zone Level ....................................................................................................... 223
Intercharacter Gap Size .................................................................................................. 224
Report Version .................................................................................................................. 224
Macro PDF Features ......................................................................................................... 225
Flush Macro Buffer .......................................................................................................... 225
Abort Macro PDF Entry ................................................................................................... 225
Digimarc
Introduction ....................................................................................................................... 226
Digimarc Symbology Selection ......................................................................................... 226
Picklist ............................................................................................................................. 226
Digimarc Digital Watermarks ............................................................................................. 227
Data Formatting
Introduction ....................................................................................................................... 228
Advanced Data Formatting (ADF) ..................................................................................... 228
Multicode Data Formatting ................................................................................................ 228
MDF in Hands-Free Mode .............................................................................................. 229
MDF Best Practices ........................................................................................................ 230
Preferred Symbol .............................................................................................................. 231
Data Parsing (UDI Scan+, Label Parse+ and Blood Bag Parse+) .................................... 231
Scan a UDI Label using UDI Scan+ ................................................................................ 231
Scan a GS1 Label using Label Parse+ ........................................................................... 232
Scan a Blood Bag Label using Blood Bag Parse+ .......................................................... 232
OCR Programming
Introduction ....................................................................................................................... 233
OCR Programming Parameters ........................................................................................ 235
11
Contents
Enable/Disable OCR-A ................................................................................................... 235
OCR-A Variant ................................................................................................................ 235
Enable/Disable OCR-B ................................................................................................... 237
OCR-B Variant ................................................................................................................ 238
Enable/Disable MICR E13B ............................................................................................ 241
Enable/Disable US Currency Serial Number .................................................................. 242
OCR Orientation ............................................................................................................. 242
OCR Lines ...................................................................................................................... 244
OCR Minimum Characters .............................................................................................. 244
OCR Maximum Characters ............................................................................................. 245
OCR Subset .................................................................................................................... 245
OCR Quiet Zone ............................................................................................................. 246
OCR Template ................................................................................................................ 247
OCR Check Digit Modulus .............................................................................................. 257
OCR Check Digit Multiplier ............................................................................................. 258
OCR Check Digit Validation ............................................................................................ 259
Inverse OCR ................................................................................................................... 264
OCR Redundancy ........................................................................................................... 265
Driver’s License Set Up
Introduction ....................................................................................................................... 266
Driver’s License Parsing ................................................................................................... 267
Parsing Driver’s License Data Fields (Embedded Driver's License Parsing) .................... 268
Embedded Driver's License Parsing Criteria - Code Type ............................................. 268
Driver’s License Parse Field Barcodes ........................................................................... 269
AAMVA Parse Field Barcodes ........................................................................................ 271
User Preferences .............................................................................................................. 281
Set Default Parameter .................................................................................................... 281
Output Gender as M or F ................................................................................................ 281
Date Format .................................................................................................................... 282
Send Keystroke (Control Characters and Keyboard Characters) ................................... 284
Parsing Rule Example ....................................................................................................... 302
Embedded Driver's License Parsing ADF Example ........................................................ 306
Standard Default Parameters
Country Codes
Introduction ....................................................................................................................... 319
USB Country Keyboard Types (Country Codes) ............................................................... 320
Country Code Pages
Introduction ....................................................................................................................... 335
Country Code Page Defaults ............................................................................................ 335
Country Code Page Barcodes .......................................................................................... 339
12
Contents
CJK Decode Control
Introduction ....................................................................................................................... 348
CJK Control Parameters ................................................................................................... 349
Unicode Output Control .................................................................................................. 349
CJK Output Method to Windows Host ............................................................................ 350
Non-CJK UTF Barcode Output ....................................................................................... 352
Unicode/CJK Decode Setup with Windows Host .............................................................. 354
Setting Up the Windows Registry Table for Unicode Universal Output .......................... 354
Adding CJK IME on Windows ......................................................................................... 354
Selecting the Simplified Chinese Input Method on the Host ........................................... 355
Selecting the Traditional Chinese Input Method on the Host .......................................... 356
Programming Reference
Symbol Code Identifiers .................................................................................................... 357
AIM Code Identifiers .......................................................................................................... 359
Sample Barcodes
Code 39 ............................................................................................................................. 364
UPC/EAN .......................................................................................................................... 364
UPC-A, 100% ................................................................................................................. 364
EAN-13, 100% ................................................................................................................ 364
Code 128 ........................................................................................................................... 365
Interleaved 2 of 5 .............................................................................................................. 365
GS1 DataBar-14 ................................................................................................................ 366
PDF417 ............................................................................................................................. 366
Data Matrix ........................................................................................................................ 366
Maxicode ........................................................................................................................... 366
QR Code ........................................................................................................................... 367
US Postnet ........................................................................................................................ 367
UK Postal .......................................................................................................................... 367
Alphanumeric Barcodes
Alphanumeric Barcodes .................................................................................................... 368
Numeric Barcodes
Numeric Barcodes ............................................................................................................. 385
Cancel ............................................................................................................................... 386
ASCII Character Sets
Communication Protocol Functionality
Functionality Supported via Communication (Cable) Interface ......................................... 399
13
Contents
Signature Capture Code
Introduction ....................................................................................................................... 400
Code Structure .................................................................................................................. 400
Signature Capture Area .................................................................................................. 400
CapCode Pattern Structure ............................................................................................. 401
Start / Stop Patterns .......................................................................................................... 401
Dimensions ....................................................................................................................... 402
Data Format ...................................................................................................................... 402
Additional Capabilities ....................................................................................................... 403
Signature Boxes ................................................................................................................ 403
Non-Parameter Attributes
Introduction ....................................................................................................................... 404
Attributes ........................................................................................................................... 404
Model Number ................................................................................................................ 404
Serial Number ................................................................................................................. 404
Date of Manufacture ....................................................................................................... 404
Date of First Programming .............................................................................................. 405
Configuration Filename ................................................................................................... 405
Beeper/LED .................................................................................................................... 406
Parameter Defaults ......................................................................................................... 407
Reboot ............................................................................................................................ 407
Host Trigger Session ...................................................................................................... 407
Firmware Version ............................................................................................................ 407
Scankit Version ............................................................................................................... 408
ImageKit Version ............................................................................................................ 408
14
About This Guide
Introduction
The MS4717 Fixed Mount Imager Integration Guide provides general instructions for mounting, installation,
scanning, and programming.
Configurations
Configuration Description
MS4717-LU0C0R Standard, Cone, Worldwide
MS4717-LU0C0Y Standard, Cone, India
MS4717-LU1C0R DL Parse, Cone, Worldwide
MS4717-LU1C0Y DL Parse, Cone, India
Chapter Descriptions
Topics covered in this guide are as follows:
• Getting Started provides general information about the imager, including its features and theory of
operation.
• 123Scan describes the Zebra software tools available for customizing imager operation.
• Installation provides information on mounting and installing the fixed mount engine.
• Scanning provides information on aiming, illumination, data capture, beeper and decode LED feedback,
supported symbologies, and operating modes.
• Specifications provides specification details and decode ranges.
• Maintenance and Troubleshooting provides information on maintenance and troubleshooting.
• User Preferences describes each user preference feature and provides the programming barcodes
necessary for selecting these features.
• Imager Preferences describes scanner preference features and provides the programming barcodes for
selecting these features.
• USB Interface provides instructions for programming the imager to interface with a USB host.
15
About This Guide
• SSI Interface describes how to set up the decoder with a Simple Serial Interface (SSI) host. Use SSI to
program the decoder via barcode menu or SSI hosts commands.
• Symbologies describes symbology features and provides the programming barcodes for selecting these
features.
• Digimarc provides barcodes to either enable or disable Digimarc Barcode, a machine-readable code that is
invisible to people.
• Data Formatting briefly describes the Zebra features available for customizing scanner operation.
• OCR Programming describes how to set up the MS4717 for OCR programming.
• Driver’s License Set Up describes how the imager can parse out information from standard US driver's
licenses and certain other American Association of Motor Vehicle Administrators (AAMVA) compliant ID
cards.
• Standard Default Parameters provides a table of all host devices and miscellaneous scanner defaults.
• Country Codes provides barcodes for programming the country keyboard type for the USB keyboard (HID)
device.
• Country Code Pages provides barcodes for selecting code pages for the country keyboard type.
• CJK Decode Control describes control parameters for Unicode/CJK (Chinese, Japanese, Korean) barcode
decode through USB HID Keyboard Emulation mode.
• Programming Reference provides a table of AIM code identifiers, ASCII character conversions, and
keyboard maps.
• Sample Barcodes includes sample barcodes of various code types.
• Alphanumeric Barcodes includes the alphanumeric barcodes to scan for parameters requiring specific
alphanumeric values.
• Numeric Barcodes includes the numeric barcodes to scan for parameters requiring specific numeric
values.
• ASCII Character Sets provides ASCII character value tables.
• Communication Protocol Functionality lists supported scanner functionality by communication protocol.
• Signature Capture Code describes CapCode, a special pattern that encloses a signature area on a
document and allows the scanner to capture a signature.
• Non-Parameter Attributes defines non-parameter attributes.
16
Notational Conventions
The following conventions are used in this document:
• “Imager” refers to the MS4717 fixed mount imager.
• Bullets (•) indicate:
• Action items
• Lists of alternatives
• Lists of required steps that are not necessarily sequential.
• Sequential lists (e.g., those that describe step-by-step procedures) appear as numbered lists.
Related Documents
The following documents provide more information about the imager.
• MS4717 Fixed Mount Imager Quick Reference Guide (p/n MN-003368-xx).
About This Guide
For the latest version of these guides and software, visit: www.zebra.com/support
Service Information
If you have a problem using the equipment, contact your facility's technical or systems support. If there is a
problem with the equipment, they will contact the Zebra Global Customer Support Center at:
www.zebra.com/support
When contacting Zebra support, please have the following information available:
• Serial number of the unit
• Model number or product name
• Software type and version number.
Zebra responds to calls by e-mail, telephone or fax within the time limits set forth in support agreements.
If your problem cannot be solved by Zebra support, you may need to return your equipment for servicing and will
be given specific directions. Zebra is not responsible for any damages incurred during shipment if the approved
shipping container is not used. Shipping the units improperly can possibly void the warranty. If you purchased your
business product from a Zebra business partner, contact that business partner for support.
.
.
17
Getting Started
Imager Window
Indicator LED
Beeper
Introduction
The MS4717 fixed mount imager is specifically designed to be mounted into various enclosures such as a food
ordering kiosk in a quick-serve restaurant or a ticketing kiosk at the airport. The imager provides an easy and
flexible integration into most USB host devices and offers high performance scanning on both 1D and 2D
barcodes.
This section describes the imager’s features, theory of operation, and includes a block diagram illustrating
functional relationships of the imager’s components.
Figure 1 MS4717 Fixed Mount Imager Features
MS4717 Features
• Quick and easy integration for OEM devices
• Excellent imaging performance on all 1D and 2D barcodes
• USB interface
• LEDs indicating power status and successful decodes
• Easy programming and configuration
• Flexible mounting options
18
Theory of Operation
USB_VBUS
USB
VCC_5P0
I2C1
1.1V 3.3V 1.2V 2. 5V
QSPI x6
3.3V
BEEPER
RED_LED*
GREEN_LED*
GREEN U/I LED
RED U/I LED
RESET*
ENG_PWR_EN
ENG_ILLUM_SEL
VENG_VCC VENG_ILLUM
EXT_ILLUM
I2C0
MIPI x4
1.8V
PWRCTRL_0.3
Micro
USB
USB Soft Start
and Active Rail
Discharge
PMIC and
Power
Sequencing
QSPI
FLASH
Engine Decoder
Microprocessor
with RAM
Engine Power:
Load Switch for VENG_VCC
Buck/Boost for VENG_ILLUM
Undecoded
Scan Engine
Beeper
Drive
Global Reset
Circuit
BEEPER
During image capture:
1. The image sensor array in the embedded imaging engine captures an image of the barcode through the
engine’s optical lens. If necessary, the engine automatically adjusts illumination, exposure, and other
parameters to obtain the best quality image.
2. The imaging engine sends the image to the MS4717 CPU.
3. The MS4717 CPU processes the image to identify the target barcode(s), decodes them, and transmits the
decoded data to the host.
Set various parameters provided in this guide to adjust the performance of the MS4717 to match the application or
desired usage profile.
Block Diagram
The MS4717 scanner block diagram illustrates the functional relationship of the MS4717 components. This section
also provides a description of each component in the block diagrams.
Getting Started
Figure 2 MS4717 Block Diagram
MS4717 Block Diagram Descriptions
Scan Engine - The imaging engine captures 8-bit gray scale WVGA images at up to 30 fps, which are sent
uncompressed to a companion board for processing. The engine uses a red LED for intuitive aiming and features
LED illumination.
Decoder Interface - The decoder board is a companion decoder module for the imaging engine, which controls the
engine, receives images, decodes 1D and 2D symbologies, and performs various image processing tasks. The
board controls red and green LEDs for visual feedback, and supports SNAPI (Symbol Native API) as well as USB
19
Getting Started
HID Keyboard through a micro USB connector. The micro USB connector provides an outlet for the various interface
signals used between the MS4717 and the host.
MS4717 Decoder/Interface Board
Power Management
• USB Host Interface - The MS4717 automatically manages its power usage, including USB suspend
mode. Additionally, when drawing power from the USB bus, the MS4717 does not exceed the USB limit of
500 mA.
20
123Scan
Introduction
This chapter briefly describes the Zebra software tools available for customizing imager operation.
123Scan
123Scan is a software tool that simplifies imager setup and more.
Intuitive enough for first time users, the 123Scan wizard guides users through a streamlined setup process.
Settings are saved in a configuration file that can be printed as a single programming barcode for scanning,
emailed to a smart phone for scanning from its screen, or downloaded to the imager using a USB cable.
Through 123Scan a user can:
• Configure a imager using a wizard.
• Program the following imager settings.
• Beeper tone / volume settings.
• Enable / disable symbologies.
• Communication settings.
• Modify data before transmission to a host using Advanced Data Formatting (ADF).
• Load parameter settings to a imager via the following.
• Barcode scanning.
• Scan a paper barcode.
• Scan a barcode from a PC screen.
• Scan a barcode from a smart phone screen.
• Download over a USB cable.
• Load settings to one imager.
• Stage up to 10 imagers simultaneously (Powered USB Hub recommended with 0.5 amp / port).
• Validate imager setup.
• View scanned data within the utility's Data view screen.
• Capture an image and save to a PC within the utility's Data view screen.
• Review settings using the Parameter Report.
• Clone settings from an already deployed scanner from the Start screen.
21
123Scan
• Upgrade scanner firmware.
• Load settings to one imager.
• Stage up to 10 imagers simultaneously (Powered USB Hub recommended with 0.5 amp / port).
• View statistics such as:
• Asset tracking information.
• Time and usage information.
• Barcodes scanned by symbology.
• Battery diagnostics (select scanners).
• Generate the following reports.
• Barcode Report - Programming barcode, included parameter settings, and supported imager models.
• Parameter Report - Parameters programmed within a configuration file.
• Inventory Report - Scanner asset tracking information.
• Validation Report - Scanned data from the Data view.
• Statistics Report - All statistics retrieved from the imager.
For more information go to: www.zebra.com/123Scan
.
Communication with 123Scan
Use a USB cable to connect the scanner to a Windows host computer running 123Scan.
123Scan Requirements
• Host computer running Windows 7, 8, and 10
• Imager
• USB cable
123Scan Information
For more information on123Scan, go to: www.zebra.com/123Scan
For a 1 minute tour of 123Scan, go to: www.zebra.com/ScannerHowToVideos
To see a list of all of our software tools, go to: www.zebra.com/scannersoftware
22
123Scan
Imager SDK, Other Software Tools, and Videos
Tackle all your imager programming needs with our diversified set of software tools. Whether you need to simply
stage a device, or develop a fully featured application with image and data capture as well as asset management,
these tools help you every step of the way.
To download any of the following free tools, go to: www.zebra.com/scannersoftware
• 123Scan configuration utility
• SDKs
• Imager SDK for Windows
• Imager SDK for Linux
• Imager SDK for Android
• Imager SDK for iOS
• Drivers (select scanners)
• OPOS driver
• JPOS driver
• USB CDC driver
• TWAIN driver
• Scanner Management Service (SMS) for Remote Management
• Windows
• Linux
• Mobile Apps
• Scanner Control App
•Android
•iOS
• Zebra AppGallery
• Scan-To-Connect Utility (select scanners)
•Android
• Windows
• How-To-Videos
.
23
Installation
Introduction
This chapter provides information on mounting, installing, and connecting the imager with compatible accessories.
This chapter also provides window information; such as material, coatings. Lastly, this section illustrates the
imager’s optical path and includes recommended exit window information.
Mounting
The following figures provide the mounting dimensions.
NOTE: Do not use screws that penetrate more than 5 mm into the bottom mousing of the MS4717 since this
is the maximum depth of the useful thread.
MS4717 Mounting Dimensions
Figure 3 Mounting Dimensions (Left Side View)
24
Figure 4 Mounting Dimensions
Installation
25
Connecting the MS4717
USB Cable Retention Clip
USB Cable
Mounting Bracket
Mounting Holes
M4x25 Studs
1. Unpack the imager. Remove cable retention clip by pinching the top edges of the clip and sliding away from the
imager.
2. Insert USB cable. Attach cable retention clip back onto the imager with the arrows on the clip pointing towards
the device.
Figure 5 Installation Procedure
Installation
3. To mount the device, refer to the EVA specification for minimum space requirements:
www.wrzutnik.com/wp-content/uploads/eva_eps_v1_1.pdf
Figure 6 Mounting MS4717 Cone
4. Mount the device by aligning the four mounting holes on the device housing with the four M4x25 studs on the
mounting bracket.
5. Fasten the four mounting nuts to the M4x25 studs to secure the device
NOTE: It is recommended that a Zebra USB cable is used for installation (p/n = 25-124330-01R). If other USB
cables are used, they must be compatible with current USB.org requirements.
Please refer to USB.org connectors and compliance documentation for more information found here:
www.usb.org/documents
26
Accessories
Zebra offers additional accessories for the MS4717 through Solution Builder (ordering guide), it is recommended
that this tool is used to order any accessories.
NOTE: To ensure that the USB cable will fit properly with the cable retention clip, it is recommended that the
connector shell size does not exceed 11.5 mm (w) and 8.7 mm (thickness). The width cannot exceed
12.5 w and 10.5 thickness. The cable connector shell length cannot exceed 17 mm.
Location and Positioning
The location and positioning guidelines do not consider unique application characteristics. Zebra recommends that
an opto-mechanical engineer perform an opto-mechanical analysis prior to integration.
NOTE: Integrate the imager in an environment that is not more extreme than the product’s specification, where
the imager will not exceed its temperature range. For instance, do not mount the scanner onto or next to
a large heat source. When integrating the imager within another device, ensure there is proper
convection or venting for heat. Follow these suggestions to ensure product longevity, warranty, and
overall satisfaction with the scanner.
Installation
Embedded Applications Requiring a Window
Use the following guidelines for applications that require a window in front of the imager.
NOTE: Zebra does not recommend placing an exit window in front of the imager; however, the following
information is provided for applications that require such a window.
27
Installation
Window Material
Many window materials that look clear can contain stresses and distortions that reduce performance. For this
reason, use only cell-cast plastics or optical glass (with or without an anti reflection coating, depending on the
application). Following are descriptions of three popular window materials: PMMA, ADC (CR-39
chemically tempered glass. Table 1 outlines the suggested window properties.
Table 1 Suggested Window Properties
Property Description
Thickness Typically 0.03 - 0.06 in. (0.7 - 1.5 mm)
Wavefront Distortion (transmission) 0.2 wavelengths peak-to-valley maximum and 0.04 maximum rms over any 0.08
in. diameter within the clear aperture
Clear Aperture To extend to within 0.04 in. of the edges all around
Surface Quality 60-20 scratch/dig
When using plastic materials pay extra attention to the wavefront distortion recommendation specified above.
Plastic materials are not recommended for tilted windows since surface scratches cause image artifacts. Colored
windows are not recommended if motion detection mode is required since it reduces engine sensitivity to the
moving target.
TM
), and
Cell Cast Acrylic (ASTM: PMMA)
Cell Cast Acrylic, or Poly-methyl Methacrylic (PMMA) is fabricated by casting acrylic between two precision sheets
of glass. This material has very good optical quality, reasonably good impact resistance and low initial cost, but is
relatively soft and susceptible to attack by chemicals, mechanical stresses, and UV light. Therefore polysiloxane
coating is strongly recommended. Acrylic can be laser cut into odd shapes and ultrasonically welded.
Cell Cast ADC (ASTM: ADC)
Also known as CR-39TM, Allyl Diglycol Carbonate (ADC) is a thermal-setting plastic produced by cell-casting. Most
plastic eyeglasses sold today are uncoated, cell-cast CR-39. This material has excellent chemical and
environmental resistance, and reasonably good impact resistance. It also has quite good surface hardness, and
therefore does not have to be hard-coated, but may be coated for severe environments. This material cannot be
ultrasonically welded.
Chemically Tempered Glass
Glass is a hard material that provides excellent scratch and abrasion resistance. However, unannealed glass is
brittle. Increasing flexibility strength with minimal optical distortion requires chemical tempering. Glass cannot be
ultrasonically welded and is difficult to cut into odd shapes.
Commercially Available Coatings
Anti-Reflection Coatings
Anti-reflection coatings can be used for stray light control or to achieve maximum working range, and can be
applied to the inside and/or outside of the window to reduce the amount of light reflected off the window back into
the engine. However, they are expensive and have very poor abrasion and scratch resistance.
28
Installation
Polysiloxane Coating
Polysiloxane type coatings are applied to plastic surfaces to improve the surface resistance to both scratch and
abrasion. To apply, dip and air dry in an oven with filtered hot air.
To gauge a window's durability, use ASTM standard D1044, Standard Test Method for Resistance of Transparent
Plastics to Surface Abrasion (the Taber Test), which quantifies abrasion resistance as a percent increase in haze
after a specified number of cycles and load. Lower values of the increase in haze correspond to better abrasion
and scratch resistance. See Table 2.
Table 2 Taber Test Results on Common Exit Window Materials
Sample
Chemically Tempered Glass 1.20% 1.50% Best
PMMA with Polysiloxane Hardcoat 3% 10%
ADC 5% 30%
PMMA 30% Worst
* All measurements use a 100 gram load and CS-10F Abraser.
Haze 100
cycles
Haze 500
cycles
Abrasion
Resistance
A Word About Coatings
If using an anti-reflective (AR) coating, the specifications in Table 3 apply. Polysiloxane coating is not required.
Recess the exit window to minimize scratches and digs.
Table 3 AR Coatings Specifications
Specification Description
Material Both tempered glass and plastic (e.g., CR-39 or hard coated acrylic) exit
windows can be AR coated. AR coated glass is easier and more durable
because of a better adhesion property on the glass structure. In addition, it can
be more cost effective to put an AR coating on the glass substrate rather than
on the plastic.
AR Coating Specification
• Single side AR-coating: 92% minimum transmittance within spectrum
range from 420 nm to 730 nm.
• Double side AR-coating: 97% minimum transmittance within spectrum
range from 420 nm to 730 nm.
• For parallel windows, see Figure 8 on page 32.
29
Installation
Embedded Window Angle and Position
If you are placing a window between the imager and the target, observe the following guidelines:
• Window Clear Opening - Make the clear opening of the window large enough so that the entire imager
clear aperture passes through the window. Cutting off any part of the clear aperture can degrade decode
range performance. Ensure that window placement relative to the imager accounts for tolerances on all
parts involved in that assembly.
• Window Angle - Minimum window tilt is indicated in Table 4. Further tilting the window is acceptable and
decreases the possibility of a secondary reflection from that window degrading the scanner's performance.
• Minimum Window Distance - See Table 4.
• Optical Working Range - Adding a window can reduce the working range of the scanner since there is a
signal loss when passing through window material. To minimize this reduction, use a special coating
described in A Word About Coatings on page 29. To understand the difference, test the scanner in the
desired orientation and see if the difference affects scanner performance.
30
MS4717 Optical Path
Notes:
1. Imaging axis pointing tolerance vs. datums ABC:
± 3º horizontal; ± 3.2º vertical
2. Clipping the scanner clear aperture is not permitted.
3. Dimensions are in mm.
Figure 7 MS4717 Optical Path and Exit Window
Installation
31
Installation
MS4717 Recommended Exit Window Information
Figure 8 Exit Window Distance Information
Table 4 Recommended Exit Window Information - Tilted Window
Distance from Engine Front Surface (b) in
Minimum Angle for Tilted Window
5mm 10mm 15mm 20mm 25 mm
Non-coated, minimum window positive tilt (+c) - 50º 50º 50º 50º
Non-coated, minimum window negative tilt (-c) - 50º 50º 50º 50º
AR coated, one side, minimum window positive tilt (+c) - 45º 45º 45º 45º
AR coated, one side, minimum window negative tilt (-c) - 45º 45º 45º 45º
AR coated, two sides, minimum window positive tilt (+c) 40º 40º 40º 40º 35º
AR coated, two sides, minimum window negative tilt (-c) 40º 40º 40º 40º 35º
mm
Exit Window Notes
• Integration tolerances are not included.
• Ensure the window size is large enough to cover the engine clear aperture plus mounting tolerances of the
window relative to the engine.
32
MS4717 Cone Optical Path
Figure 9 MS4717 Cone Optical Path - Horizontal
Installation
33
Installation
Figure 10 MS4717 Cone Optical Path - Vertical
34
Installation
MS4717 Cone Exit Window Field of View
Figure 11 MS4717 Cone Imaging Field of View at Exit Window
35
Installation
Zebra SNAPI Software Developer's Kit
The Symbol Native Application Programming Interface Software Development Kit (SNAPI SDK) facilitates
communication with SNAPI-based Zebra scanners over USB, providing the following features:
• Barcode capture and decode
• Image and video capture
• Electronic scanner configuration and software update
• Reference sample application in Microsoft Visual C#
To download the SDK, go to: www.zebra.com/support.
®
.NET.
36
Scanning
012345
012345
012345
012345
Introduction
This chapter provides information on aiming, illumination, data capture, beeper and decode LED feedback,
supported symbologies, and operating modes.
Imaging System
Aiming System
A 610 nm LED is used to generate a circular aiming pattern which indicates the center of the imager’s field of view.
Aiming with MS4717
When scanning, the device projects an orange LED dot, which allows positioning the barcode within its field of
view. If necessary, the imager turns on its red LEDs to illuminate the target barcode.
To scan a barcode, center the symbol and ensure the entire symbol is within the rectangular area formed by the
illumination LEDs. The imager can also read a barcode presented within the aiming dot not centered. The figure
below illustrates proper LED placement to produce a successful decode.
Figure 12 MS4717 Aiming Pattern
37
Scanning
Aiming Error
The aiming pattern is rotated by 2º relative to the imaging axis in the horizontal plane to minimize parallax between
the aiming axis and the imaging axis at 190.45 mm (7.5 in.) from the front of the MS4717.
Aiming Control
The MS4717 can capture images with both the aiming subsystem turned on during exposure (the image of the
aiming pattern is visible in the digital image) or off. If the aiming system is turned off during exposure, brightness of
the aiming pattern decreases as exposure increases.
The aiming subsystem can also be turned off completely. Zebra recommends shutting aiming off three frames prior
to capturing documents to prevent the aiming pattern from appearing faintly in captured images. Note that this is
not necessary for barcode decoding.
Illumination System
The illumination system consists of one red LED and a sophisticated drive system that allows image capture and
decoding throughout a full range of lighting conditions (total darkness to full sunlight).
Illumination Control
The MS4717 can capture images with the illumination subsystem turned on or off. LED illumination can be turned
off when taking images of documents printed on semi-glossy or glossy paper or on a substrate with security marks.
In this case, ensure ambient illumination provides a minimum of 30 fcd on the document surface.
Supported Symbologies
The following barcode types are supported and can be individually enabled or disabled:
1D Symbologies 2D Symbologies
UPC/EAN PDF417
Bookland EAN MicroPDF417
UCC Coupon Code Data Matrix, Data Matrix Inverse
ISSN EAN GS1 Data Matrix
Code 128 Maxicode
GS1-128 QR Code
ISBT 128 GS1 QR
Code 39 MicroQR
Trioptic Code 39 Aztec, Aztec Inverse
Code 32 Han Xin, Han Xin Inverse
Code 93 Grid Matrix, Grid Matrix Inverse, Grid Matrix Mirrored
Code 11
Interleaved 2 of 5 Postal Codes
Discrete 2 of 5 US Postnet
Codabar US Planet
MSI UK Postal
Chinese 2 of 5 Japan Postal
Matrix 2 of 5 Australia Post
Korean 3 of 5 Netherlands KIX Code
38
Inverse 1D USPS 4CB/One Code/Intelligent Mail
GS1 DataBar UPU FICS Postal
Composite Codes
Operating Modes
The MS4717 supports the following operating modes.
• Decode (default mode) - for decoding a barcode.
• Snapshot - for capturing an image.
• Snapshot with Viewfinder Mode - provides a video of the subject until a snapshot of the image is captured.
• Video - provides a video of the subject.
Scanning
Mailmark
39
Specifications
Introduction
This chapter provides information regarding the imager’s technical specifications, as well as skew, pitch, and roll
information, and decode zones.
MS4717 Technical Specifications
Table 5 MS4717 Technical Specifications
Item Description
Performance Characteristics
Sensor Resolution 1280 x 800 pixels
Field of View 42º horizontal, 28º vertical
Pitch/Skew/Roll Tolerance ± 60º / ± 60º / 360º
Aiming Element (LED) 610 nm ± 10 nm
Illumination Element 660 nm ± 5 nm (LED)
Minimum Print Contrast 20% absolute dark/light reflectance
User Environment
Power Requirements
Supply Voltage
Low Power / Suspend Current
Draw
Idle Current
Operating Current
(scan/decode session)
Peak Current
Ambient Light Immunity Total darkness to 10,000 ft. candles (107,369 lux)
Humidity
Operating
Storage
5.00 V ± 0.5 V
2.5 mA (max)
125 mA RMS (typ ical)
265 mA RMS (typ ical)
480 mA
95% RH, non-condensing at 50º C
85% RH, non-condensing at 70º C
40
Specifications
Table 5 MS4717 Technical Specifications (Continued)
Item Description
Sealing IP54
Electrical Safety IEC/EN 60950-1, IEC/EN 62368-1
EMC (Medical Electrical Equipment) EN 60601-1-2:2015, IEC 60601-1-2:2014
ESD
Drop Rating Unit functions normally after multiple 5 ft (152 cm) drops to concrete at
Temperature
Operating
Storage
Dimensions 1.10 in. (2.8 cm) H x 1.89 in. (4.8 cm) L x 2.17 in. (5.5 cm) W
Weight 4.13 oz. (117 g)
Supported Interfaces USB - USB (full speed)
USB Certification USB 2.0 Full Speed Compliant, visit USB.org
NOTE: Environmental and/or tolerance parameters are not cumulative. Zebra recommends a thermal analysis if
the application is subject to an extreme temperature environment.
+/- 15KV air, +/-8KV indirect. Class B
room temperature.
-4º to 122º F (-20º to 50º C)
-40º to 158º F (-40º to 70º C)
for more details
41
Specifications
Skew
Pitch
Roll
+ 60° from normal
+ 60° from normal
360°
Skew, Pitch and Roll
Measured on a 20 mil Code 39 symbol at a distance of 10 inches. Tolerance is reduced at extreme ends of the
working range.
Figure 13 Skew, Pitch and Roll
42
Decode Zones
Table 6 MS4717 Decode Ranges
Symbol Density/
Barcode Type
Specifications
Typical Working Range for
MS4717
Near Far Near Far
Typical Working Range for
MS4717 with Cone
4 mil
Code 39
5 mil
Code 128
5 mil
Code 39
5 mil
PDF417
10 mil
Data Matrix
100% UPCA
Data Matrix
20 mil
Code 39
20 mil
QR Code
Notes:
Near distances are field-of-view (FOV) limited.
3.1 in / 7.8 cm
2.6 in / 6.6 cm
1.8 in / 4.6 cm
2.9 in / 7.4 cm
2.7 in / 6.9 cm
1.6 in / 4.1 cm
2.2 in / 5.6 cm
3.0 in / 7.6 cm
8.6 in / 21.8 cm 0.2 in / .50 cm 5.5 in / 13.9 cm
8.0 in / 20.3 cm 0 in / 0 cm 9.3 in / 23.6 cm
12.4 in / 31.5 cm 0 in / 0 cm 19.1 in / 48.5 cm
8.2 in / 20.2 cm 0 in / 0 cm 5 in / 12.7 cm
9.9 in / 25.1 cm 0 in / 0 cm 17 in / 43.1 cm
25.8 in / 65.5 cm 0.1 in / .25 cm 4.7 in / 11.9 cm
29.8 in / 75.7 cm 0 in / 0 cm 6.7 in / 17 cm
15.6 in / 39.6 cm 0 in / 0 cm 12.4 in / 31.5 cm
43
Maintenance and Troubleshooting
Introduction
The chapter provides information on maintenance and troubleshooting, as well as beeper and LED indications.
Maintenance
Clean the imager housing and exit window with a damp cloth and, if necessary, a non-ammonia based detergent.
Do not allow any abrasive material to touch the exit window.
Troubleshooting
Table 7 Troubleshooting
Problem Possible Cause Possible Solutions
No gr ee n L ED or no th in g
happens during a
capture attempt.
Imager cannot read the
barcode.
Aiming pattern does not
appear.
LED activates, followed
by a beep sequence.
No power to the imager. Check the system power.
Confirm that the correct host interface cable is
used.
Re-connect loose cables.
Imager is not programmed for
the correct barcode type.
Barcode symbol is
unreadable.
Hot environment. Remove the imager from the hot environment,
Beeper is configured. See Supported Symbologies on page 38 for
Program the scanner to read the type of barcode
to be decoded.
Ensure the symbol is not defaced.
Try capturing similar symbols of the same code
type.
and allow it to cool down.
beeper indication descriptions.
44
Maintenance and Troubleshooting
Beeper and LED Indication
Table 8 LED Indications
Indication Beeper LED
Reader is on.
A barcode was successfully
decoded.
A programming parameter was
entered successfully.
N/A Green
1 beep Green flash.
Fast warble Green flash.
45
User Preferences
* High Volume
(0)
Feature/Option
* Indicates Default
Option Value
Introduction
This chapter describes each user preference feature and provides the programming barcodes necessary for
selecting these features.
You can program the imager to perform various functions, or activate different features. This chapter describes
each user preference feature and provides programming barcodes for selecting these features.
The imager ships with the settings shown in Table 9 (also see Standard Default Parameters for all defaults). If the
default values suit requirements, programming is not necessary.
To set feature values, scan a single barcode or a short barcode sequence. The settings are stored in non-volatile
memory and are preserved even when the digital scanner is powered down.
NOTE: Most computer monitors allow scanning the barcodes directly on the screen. When scanning from the
screen, be sure to set the document magnification to a level where you can see the barcode clearly, and
bars and/or spaces are not merging.
If not using a USB cable, select a host type (see each host chapter for specific host information) after the power-up
beeps sound. This is only necessary upon the first power-up when connected to a new host.
To return all features to default values, see Default Parameters on page 49. Throughout the programming barcode
menus, asterisks indicate (
*) default values.
46
User Preferences
Scanning Sequence Examples
In most cases, scanning one barcode sets the parameter value. The imager issues a fast warble beep and the LED
turns green, signifying a successful parameter entry.
Other parameters require scanning several barcodes. See these parameter descriptions for this procedure.
Errors While Scanning
Unless otherwise specified, to correct an error during a scanning sequence, just re-scan the correct parameter.
User Preferences Parameter Defaults
Table 9 lists defaults for user preferences parameters. To change the default values:
• Scan the appropriate barcodes in this guide. These new values replace the standard default values in
memory.
• Configure the imager using the 123Scan
2
configuration program.
NOTE: See Standard Default Parameters for all user preferences, hosts, symbologies, and default parameters.
Table 9 User Preferences Parameter Defaults
Parameter
User Preferences
Set Default Parameter N/A N/A Restore Defaults 49
Parameter Barcode Scanning 236 ECh Enable 50
Beep After Good Decode 56 38h Enable 51
Beep on <BEL> 150 96h Enable 51
Lock/Unlock 802/803 F2h 22h/ F2h
Beeper Volume 140 8Ch High 53
Beeper Tone 145 91h Medium 54
Beeper Duration 628 F1h 74h Medium 55
Suppress Power Up Beeps 721 F1h D1h Do Not Suppress 55
Parameter
Number
1
SSI Number
23h
2
N/A 52
Default
Page
Number
Trigger Mode 138 8Ah Presentation Mode 56
Presentation Decode Aiming Pattern 590 F1h 4Eh Enable 57
Picklist Mode 402 F0h 92h Disabled Always 58
1. Parameter number decimal values are used for programming via RSM commands.
2. SSI number hex values are used for programming via SSI commands.
47
User Preferences
Table 9 User Preferences Parameter Defaults (Continued)
Parameter
Decode Session Timeout 136 88h 9.9 Seconds 59
Hands-Free Decode Session Timeout 400 F0h 90h 15 59
Timeout Between Decodes, Same
Symbol
Timeout Between Decodes, Different
Symbols
Mobile Phone/Display Mode 716 F1h CCh Disable 62
PDF Prioritization 719 F1h CFh Disable 63
PDF Prioritization Timeout 720 F1h D0h 200 msec 64
Low Light Assist Scene Detection 810 F2h 2Ah No Low Light Assist
Presentation Mode Field of View 609 F1h 61h Full 66
Scene Detect Sensitivity 1943 F8h 97h Medium
Mirrored Image 624 F1h 70h Disable
Decoding Illumination 298 F0h 2Ah Enable 68
Parameter
Number
137 89h 0.5 Seconds 61
144 90h 0.1 Seconds 61
SSI Number
1
2
Scene Detection
Default
Number
65
67
67
Page
Add an Enter Key N/A N/A N/A 68
Transmit Code ID Character 45 2Dh None 69
Prefix Value 99, 105 63h, 69h 7013 <CR><LF> 70
Suffix 1 Value
Suffix 2 Value
Scan Data Transmission Format 235 EBh Data as is 71
FN1 Substitution Values 103, 109 67h, 6Dh 7013 <CR><LF> 72
Transmit “No Read” Message 94 5E Disable 73
Unsolicited Heartbeat Interval 1118 F8h 04h 5Eh Disable 74
Product ID (PID) Type 1281 F8h 05h 01h Host Type Unique
Report Version N/A N/A N/A
Report Decoder Manufacturing
Information
Report Engine Manufacturing Information N/A N/A N/A
1. Parameter number decimal values are used for programming via RSM commands.
2. SSI number hex values are used for programming via SSI commands.
98, 104
100, 106
N/A N/A N/A
62h, 68h
64h, 6Ah
7013 <CR><LF> 70
75
75
76
76
48
User Preferences
Default Parameters
The imager can be reset to two types of defaults: factory defaults or custom defaults. Scan the appropriate barcode
below to reset the imager to its default settings and/or set the imager’s current settings as the custom default.
• Restore Defaults - Resets all default parameters as follows:
• If custom default values were configured (see Write to Custom Defaults), the custom default values are
set for all parameters each time the Restore Defaults barcode below is scanned.
• If no custom default values were configured, the factory default values are set for all parameters each time
the Restore Defaults barcode below is scanned. (For factory default values, see Standard Default
Parameters.
• Set Factory Defaults - Scan the Set Factory Defaults barcode below to eliminate all custom default values
and set the imager to factory default values (For factory default values, see Standard Default Parameters
• Write to Custom Defaults - Custom default parameters can be configured to set unique default values for all
parameters. After changing all parameters to the desired default values, scan the Write to Custom Defaults
barcode below to configure custom defaults.
User Preferences
* Restore Defaults
Write to Custom Defaults
Set Factory Defaults
49
User Preferences
Parameter Barcode Scanning
Parameter # 236 (SSI # ECh)
To disable the decoding of parameter barcodes, including the Set Defaults parameter barcodes, scan the Disable
Parameter Scanning barcode below. To enable decoding of parameter barcodes, scan Enable Parameter
Scanning.
* Enable Parameter Barcode Scanning
(1)
Disable Parameter Barcode Scanning
(0)
50
User Preferences
Beep After Good Decode
Parameter # 56 (SSI # 38h)
Scan a barcode below to select whether or not the imager beeps after a good decode. If selecting Do Not Beep
After Good Decode, the beeper still operates during parameter menu scanning and to indicate error conditions.
* Beep After Good Decode (Enable)
(1)
Do Not Beep After Good Decode (Disable)
(0)
Beep on <BEL>
Parameter #150 (SSI # 96h)
NOTE: This parameter only applies to USB CDC Host.
When this parameter is enabled, the imager issues a beep when it detects a <BEL> character. <BEL> indicates an
illegal entry or other important event.
* Beep on <BEL> Character (Enable)
(1)
Do Not Beep on <BEL> Character (Disable)
(0)
51
User Preferences
Lock/Unlock Parameter Scanning
Lock:
Parameter # 802
SSI # F2h 22h
Unlock:
Parameter # 803
SSI # F2h 23h
This feature locks parameter settings with a 4-digit code to prevent the user from changing parameter values by
scanning parameter barcodes. This provides an added level of security not offered via Disable Parameter
Scanning.
After locking parameter settings, the only parameter barcode that is accepted is Unlock with the correct code.
NOTE: Parameter Barcode Scanning must be enabled in order to scan the Lock parameter barcode. Once
parameter scanning is locked, scanning the Enable or Disable Parameter Scanning barcode results in
a parameter error beep.
To lock parameter scanning:
1. Scan the Lock barcode.
2. Scan four barcodes from Numeric Barcodes that represent the desired code. Enter leading zeros for numbers
below 1000, e.g., to program a code of 29, enter 0, 0, 2, 9. A "lock" beep sounds (two long high beeps) in
addition to the parameter entry beep.
To unlock parameter scanning:
1. Scan the Unlock barcode.
2. Scan four barcodes from Numeric Barcodes that represent the correct code. An "unlock" beep sounds (two
long low beeps) in addition to the parameter entry beep. Entering an incorrect code results in a parameter error
beep.
Lock
Unlock
52
User Preferences
Beeper Volume
Parameter # 140 (SSI # 8Ch)
To select a beeper volume, scan the Low Volume, Medium Volume, or High Volume barcode.
Low Volume
(2)
Medium Volume
(1)
* High Volume
(0)
53
User Preferences
Beeper Tone
Parameter # 145 (SSI # 91h)
To select a beeper tone, scan one of the following barcodes.
Off
(3)
Low Tone
(2)
* Medium Tone
(1)
Medium to High Tone (2-tone)
(4)
High Tone
(0)
54
User Preferences
Beeper Duration
Parameter # 628 (SSI # F1h 74h)
To select the duration for the beeper, scan one of the following barcodes.
Short
(0)
* Medium
(1)
Long
(2)
Suppress Power Up Beeps
Parameter # 721 (SSI # F1h D1h)
Scan a barcode below to select whether or not to suppress the imager’s power-up beeps.
* Do Not Suppress Power Up Beeps
(0)
Suppress Power Up Beeps
(1)
55
User Preferences
Trigger Mode
Parameter # 138 (SSI # 8Ah)
NOTE: 1. Before selecting Host trigger mode, see the USB CDC Host and HID Keyboard Emulation notes
warning in USB Device Type on page 104.
Select one of the following trigger modes for the digital scanner.
• Host - A start decode command from the host activates decode processing. Decode processing continues
until barcode decodes, receipt of a stop decode command, or the Decode Session Timeout on page 59
occurs.
• Presentation Mode - when the device detects an object in its field of view, it triggers and decodes.
Host
(0) Note 1
*Presentation Mode
(7)
56
User Preferences
Presentation Decode Aiming Pattern
Parameter # 590 (SSI # F1h 4Eh)
Select Enable Hands-free Decode Aiming Pattern to project the aiming dot during barcode capture, Disable
Hands-free Decode Aiming Pattern to turn the aiming dot off, or Enable Hands-free Decode Aiming Pattern on
PDF to project the aiming dot when the imager detects a 2D barcode.
NOTE: With Picklist Mode on page 58 enabled, the decode aiming dot flashes even when the Decode Aiming
Pattern is disabled.
* Enable Hands-free Decode Aiming Pattern
(1)
Enable Hands-free Decode Aiming Pattern on PDF
(2)
Disable Hands-free Decode Aiming Pattern
(0)
57
User Preferences
Picklist Mode
Parameter # 402 (SSI # F0h 92h)
Picklist mode enables the imager to decode only barcodes that are aligned under the LED aiming dot. Select one
of the following picklist modes for the digital scanner:
• Disabled Always - Picklist mode is always disabled.
• Enable Always - Picklist mode is always enabled.
* Disabled Always
(0)
Enabled Always
(2)
NOTE: Picklist Mode temporarily overrides the Disable Decode Aiming Pattern parameter. You can not disable
the decode aiming pattern when Picklist Mode is enabled.
58
User Preferences
Decode Session Timeout
Parameter # 136 (SSI # 88h)
This parameter sets the maximum time decode processing continues during a scan attempt. It is programmable in
0.1 second increments from 0.5 to 9.9 seconds. The default timeout is 9.9 seconds.
To set a Decode Session Timeout, scan the barcode below. Next, scan two numeric barcodes from Numeric
Barcodes that correspond to the desired on time. Enter a leading zero for single digit numbers. For example, to set
a Decode Session Timeout of 0.5 seconds, scan the barcode below, then scan the 0 and 5 barcodes. To correct an
error or change the selection, scan Cancel on page 386
Decode Session Timeout
.
Hands-Free Decode Session Timeout
Parameter # 400 (SSI # F0h 90h)
This parameter is the Hands-free compliment to the Decode Session Timeout. It configures the minimum and
maximum decode processing time during a Hands-free scan attempt. It only applies to the Hands-free trigger
mode.
The minimum decode processing time is defined as the time in which the scanner stops decoding when an object
is removed or left stationary in the imaging field of view.
The maximum decode processing time is defined as the time in which the scanner stops decoding when an object
is left in or is moving in the field of view.
Both the maximum and minimum times are configured using a single setting. The relationship of this setting is as
follows:
Table 10 Hands-free Decode Session Time
Setting Value Minimum Time Maximum Time
X < 25
X >= 25 X * 10 msec X * 100 msec
For example, a setting value of 100 results in the scanner turning off approximately 1 second after an object is
removed from the field of view or 10 seconds while an object is in the field of view moving.
The default value of the setting is 15 which results in a Minimum time of 250 msec and Maximum time of 1.5
seconds.
250 msec 2.5 Seconds
59
User Preferences
Adjust this setting based on your requirements. For example, when doing prioritization, this parameter should be
set to a value where the maximum time is above the PDF prioritization timeout.
Hands-free Decode Session Timeout
60
User Preferences
Timeout Between Decodes, Same Symbol
Parameter # 137 (SSI # 89h)
Use this option in presentation mode to prevent the beeper from continuously beeping when a symbol is left in the
imager’s field of view. The barcode must be out of the field of view for the timeout period before the imager reads
the same consecutive symbol. It is programmable in 0.1 second increments from 0.0 to 9.9 seconds. The default
interval is 0.5 seconds.
To select the timeout between decodes for the same symbol, scan the barcode below, then scan two numeric
barcodes from Numeric Barcodes that correspond to the desired interval, in 0.1 second increments.
Timeout Between Decodes, Same Symbol
Timeout Between Decodes, Different Symbols
Parameter # 144 (SSI # 90h)
Use this option in presentation mode to control the time the imager is inactive between decoding different symbols.
It is programmable in 0.1 second increments from 0.1 to 9.9 seconds. The default is 0.1 seconds.
To select the timeout between decodes for different symbols, scan the barcode below, then scan two numeric
barcodes from Numeric Barcodes that correspond to the desired interval, in 0.1 second increments.
NOTE: Timeout Between Decodes, Different Symbols cannot be greater than or equal to the Decode Session
Timeout.
Timeout Between Decodes, Different Symbols
61
User Preferences
Mobile Phone/Display Mode
Parameter # 716 (SSI # F1h CCh)
This mode improves barcode reading performance off mobile phones and electronic displays. Select disable or
enable Mobile Phone/Display Mode.
* Disable Mobile Phone/Display Mode
(0)
Enable Mobile Phone/Display Mode (3)
62
User Preferences
PDF Prioritization
Parameter # 719 (SSI # F1h CFh)
Enable this feature to delay decoding a 1D barcode (Code 128) by the value specified in PDF Prioritization
Timeout. During that time the imager attempts to decode a PDF417 symbol (e.g., on a US driver's license), and if
successful, reports this only. If it does not decode (can not find) a PDF417 symbol, it reports the 1D symbol after
the timeout. The 1D symbol must be in the imager’s field of view for the imager to report it. This parameter does not
affect decoding other symbologies.
NOTE: The 1D Code 128 barcode lengths include the following:
• 7 to 10 characters
• 14 to 22 characters
• 27 to 28 characters
In addition, a Code 39 barcode with the following lengths are considered to potentially be part of a US
driver’s license:
• 8 characters
• 12 characters
* Disable PDF Prioritization
(0)
Enable PDF Prioritization
(1)
63
User Preferences
PDF Prioritization Timeout
Parameter # 720 (SSI # F1h D0h)
NOTE: The Hands-Free Decode Session Timeout on page 59 should be set to a longer duration than PDF
Prioritization Timeout when configured.
When PDF Prioritization on page 63 is enabled, this timeout specifies how long the imager attempts to decode a
PDF417 symbol before reporting the 1D barcode in the field of view.
Scan the following barcode, then scan four digits from Numeric Barcodes that specify the timeout in milliseconds.
For example, to enter 400 msec, scan the following barcode, then scan 0400. The range is 0 to 5000 msec, and
the default is 200 msec.
PDF Prioritization Timeout
64
User Preferences
Low Light Assist Scene Detection
Parameter # 810 (SSI # F2h 2Ah)
Scan one of the following barcodes to allow the engine to detect motion in dim to dark illumination environments
when in presentation mode:
• No Low Light Assist Scene Detection - The engine attempts to detect motion as best it can with the aim
pattern and illumination turned off when the engine is idle.
• Dim Illumination Low Light Assist Scene Detection - The aim pattern is off, but illumination is on at a dim
level to assist in scene detection.
*No Low Light Assist Scene Detection
(0)
Dim Illumination Low Light Assist Scene Detection
(2)
65
User Preferences
Presentation Mode Field of View
Parameter # 609 (SSI # F1h 61h)
In presentation mode, by default the imager searches the larger area of the aiming pattern (Full Field of View).
To search for a barcode in a smaller region around the aiming dot’s center in order to speed search time, select
Small Field of View or Medium Field of View.
Small Field of View
(0)
Medium Field of View
(1)
* Full Field of View
(2)
66
User Preferences
Scene Detect Sensitivity
Parameter # 1943 (SSI # F8h 97h)
This parameter sets the illumination range sensitivity when motion is detected.
Low
(10)
*Medium
(128)
High
(190)
Mirrored Image
Parameter # 624
SSI # F1h 70h
Enable this to scan images in reverse, or mirrored, as if seen through a mirror. This mode is useful in applications
requiring scanning through a mirror and using symbologies that do not decode in reverse.
Enabling this mode when using snapshot, video, or video viewfinder mode transmits images as mirrored images.
NOTE: This parameter is enabled by default for the MS4717 with Cone.
*Disable Mirrored Image
(00h)
67
Enable Mirrored Image
(01h)
User Preferences
Decoding Illumination
Parameter # 298 (SSI # F0h 2Ah)
Selecting Enable Decoding Illumination causes the imager to flash illumination to aid decoding. Select Disable
Decoding Illumination to prevent the imager from using decoding illumination.
Enabling illumination usually results in superior images. The effectiveness of the illumination decreases as the
distance to the target increases.
* Enable Decoding Illumination
(1)
Disable Decoding Illumination
(0)
Add an Enter Key
To add an Enter key (carriage return/line feed) after scanned data, scan the following barcode.
To program other prefixes and/or suffixes, see Prefix/Suffix Values on page 70.
Add Enter Key (Carriage Return/Line Feed)
68
User Preferences
Transmit Code ID Character
Parameter # 45 (SSI # 2Dh)
A Code ID character identifies the code type of a scanned barcode. This is useful when decoding more than one
code type. In addition to any single character prefix already selected, the Code ID character is inserted between
the prefix and the decoded symbol.
Select no Code ID character, a Symbol Code ID character, or an AIM Code ID character.
NOTE: If you enable Symbol Code ID Character or AIM Code ID Character, and enable Transmit “No Read”
Message on page 73, the imager appends the code ID for Code 39 to the NR message.
Symbol Code ID Character
(2)
* None
(0)
AIM Code ID Character
(1)
69
User Preferences
Prefix/Suffix Values
Key Category Parameter # P = 99, S1 = 98, S2 = 100 (SSI # P = 63h, S1 = 62h, S2 = 64h)
Decimal Value Parameter # P = 105, S1 = 104, S2 = 106 (SSI # P = 69h, S1 = 68h, S2 = 6Ah)
You can append a prefix and/or one or two suffixes to scan data for use in data editing. To set a value for a prefix
or suffix, scan a four-digit number (i.e., four barcodes from Numeric Barcodes) that corresponds to that value. See
ASCII Character Sets for the four-digit codes.
When using host commands to set the prefix or suffix, set the key category parameter to 1, then set the 3-digit
decimal value. See ASCII Character Sets for the four-digit codes.
The default prefix and suffix value is 7013 <CR><LF> (the Enter key). To correct an error or change a
selection, scan Cancel on page 386
NOTE: To use Prefix/Suffix values, first set the Scan Data Transmission Format on page 71.
.
Scan Prefix
(7)
Scan Suffix 2
(8)
Scan Suffix 1
(6)
Data Format Cancel
70
User Preferences
Scan Data Transmission Format
Parameter # 235 (SSI # EBh)
To change the scan data format, scan one of the following eight barcodes corresponding to the desired format.
NOTE: If using this parameter do not use ADF rules to set the prefix/suffix.
To set values for the prefix and/or suffix, see ASCII Character Sets
* Data As Is
(0)
<DATA> <SUFFIX 2>
(2)
<PREFIX> <DATA >
(4)
<DATA> <SUFFIX 1>
(1)
<DATA> <SUFFIX 1> <SUFFIX 2>
(3)
71
User Preferences
Scan Data Transmission Format (continued)
<PREFIX> <DATA> <SUFFIX 2>
(6)
<PREFIX> <DATA> <SUFFIX 1>
(5)
<PREFIX> <DATA> <SUFFIX 1> <SUFFIX 2>
(7)
FN1 Substitution Values
Key Category Parameter # 103 (SSI # 67h)
Decimal Value Parameter # 109 (SSI # 6Dh)
The USB HID keyboard hosts support a FN1 Substitution feature. Enabling this substitutes any FN1 character
(0x1b) in an EAN128 barcode with a value. This value defaults to 7013 (Enter Key).
When using host commands to set the FN1 substitution value, set the key category parameter to 1, then set the
3-digit keystroke value. See the ASCII Character Set table for the current host interface for the desired value.
To select a FN1 substitution value via barcode menus:
1. Scan the barcode below.
Set FN1 Substitution Value
2. Locate the keystroke desired for FN1 Substitution in the ASCII Character Set table for the current host
interface. Enter the 4-digit ASCII Value by scanning each digit in Numeric Barcodes.
To correct an error or change the selection, scan Cancel.
To enable FN1 substitution for USB HID keyboard, scan the Enable FN1 Substitution barcode on page 72.
72
Transmit “No Read” Message
User Preferences
Parameter # 94 (SSI #
Scan a barcode below to select whether or not to transmit a No Read message. Enable this to transmit the
characters NR when a successful decode does not occur before trigger release or the Decode Session Timeout
expires. See Decode Session Timeout on page 59. Disable this to send nothing to the host if a symbol does not
decode.
NOTE: If you enable Transmit No Read, and also enable Symbol Code ID Character or AIM Code ID
Character for Transmit Code ID Character on page 69, the digital scanner appends the code ID for Code
39 to the NR message.
Enable No Read
(1)
5Eh)
* Disable No Read
(0)
73
User Preferences
Unsolicited Heartbeat Interval
Parameter # 1118 (SSI # F8h 04h 5Eh)
The imager supports sending
set the desired unsolicited heartbeat interval, scan one of the time interval barcodes below, or scan Set Another
Interval followed by four numeric barcodes from Numeric Barcodes (scan sequential numbers that correspond to
the desired number of seconds). The range is 0 - 9999.
Scan Disable Unsolicited Heartbeat Interval to turn off the feature.
The heartbeat event is sent as decode data (with no decode beep) in the form of:
MOTEVTHB:nnn
where
nnn
is a three-digit sequence number starting at 001 and wrapping after 100.
10 Seconds
(10)
Unsolicited Heartbeat Messages
to assist in diagnostics. To enable this feature and
Set Another Interval
1 Minute
(60)
* Disable Unsolicited Heartbeat Interval
(0)
74
User Preferences
Product ID Type (PID)
Parameter # 1281 (SSI # F8h 05h 01h)
Scan one of the following barcodes to define the PID value reported in USB enumeration.
*Host Type Unique
(0)
Product Unique
(1)
IBM Unique
(2)
Report Version
Parameter # 94 (SSI # 5Eh)
Scan a barcode below to report the version of software currently installed on the imager.
Report Software Version
75
User Preferences
Report Decoder Manufacturing Information
Parameter # 94 (SSI # 5Eh)
Scan a barcode below to report the part numb er, serial number, and manufacture date of the decoder..
Report Decoder Manufacturing Information
Report Engine Manufacturing Information
Parameter # 94 (SSI # 5Eh)
Scan the barcode below to report the part number, serial number, and manufacture date of the scan engine.
Report Engine Manufacturing Information
76
Imager Preferences
Feature/Option
* Indicates Default
* Enable Image Capture Illumination
(2)
Option Value
Introduction
Users can program the device to perform various functions, or activate different features. This chapter describes
imaging preference features and provides programming barcodes for selecting these features.
NOTE: Only the Symbol Native API (SNAPI) with Imaging interface supports image capture. See USB Device
Type on page 104 to enable this host.
The imager ships with the settings in Imaging Preferences Parameter Defaults on page 78 (also see Standard
Default Parameters for all host device and defaults). If the default values suit requirements, programming is not
necessary.
To set feature values, scan a single barcode or a short barcode sequence. The settings are stored in non-volatile
memory and are preserved even when you power down the digital scanner.
NOTE: Most computer monitors allow scanning the barcodes directly on the screen. When scanning from the
screen, be sure to set the document magnification to a level where you can see the barcode clearly, and
bars and/or spaces are not merging.
To return all features to default values, scan the Default Parameters on page 49. Throughout the programming
barcode menus, asterisks (
*) indicate default values.
77
Imager Preferences
Scanning Sequence Examples
In most cases scanning one barcode sets the parameter value. For example, to disable image capture illumination,
scan the Disable Image Capture Illumination barcode under Image Capture Illumination on page 82. The imager
issues a fast warble beep and the LED turns green, signifying a successful parameter entry.
Other parameters require scanning several barcodes. See these parameter descriptions for this procedure.
Errors While Scanning
Unless otherwise specified, to correct an error during a scanning sequence, just re-scan the correct parameter.
Imaging Preferences Parameter Defaults
Table 11 lists the defaults for imaging preferences parameters. To change the default values, scan the appropriate
barcodes in this guide. These new values replace the standard default values in memory..
NOTE: See Standard Default Parameters for all user preferences, hosts, symbologies, and default parameters.
Table 11 Imaging Preferences Parameter Defaults
Parameter
Imaging Preferences
Operational Modes N/A N/A N/A 80
Image Capture Illumination 361 F0h 69h Enable 82
Image Capture Autoexposure 360 F0h 68h Enable 82
Fixed Exposure 567 F4h F1h 37h 100 83
Gain / Exposure Priority for Snapshot
Mode
Snapshot Mode Timeout 323 F0h 43h 0 (30 Seconds) 85
Snapshot Aiming Pattern 300 F0h 2Ch Enable 86
Silence Operational Mode Changes 1293 F8h 05h 0Dh Do Not Silence
Image Cropping 301 F0h 2Dh Disable 87
Crop to Pixel Addresses 315
Parameter
Number
562 F1h 32h Autodetect 84
316
317
318
SSI Number Default
(Disable)
F4h F0h 3Bh
F4h F0h 3Ch
F4h F0h 3Dh
F4h F0h 3Eh
0 top
0 left
799 bottom
1279 right
Page
Number
86
88
Image Size (Number of Pixels) 302 F0h 2Eh Full 89
Image Brightness (Target White) 390 F0h 86h 180 90
78
Imager Preferences
Table 11 Imaging Preferences Parameter Defaults (Continued)
Parameter
JPEG Image Options 299 F0h 2Bh Quality 90
JPEG Target File Size 561 F1h 31h 160 kB 91
JPEG Quality 305 F0h 31h 65 91
Image Enhancement 564 F1h 34h 1 (Low) 92
Image File Format Selector 304 F0h 30h JPEG 93
Image Rotation 665 F1h 99h
Bits per Pixel (BPP) 303 F0h 2Fh 8 BPP 95
Signature Capture
Signature Capture Image File Format
Selection
Signature Capture Bits Per Pixel
Signature Capture Width
Signature Capture Height
Signature Capture JPEG Quality
Parameter
Number
93 5Dh Disable
313 F0h 39h JPEG
314 F0h 3Ah 8 BPP
366 F4h F0h 6Eh 400
367 F4h F0h 6Fh 100
421 F0h A5h 65
SSI Number Default
o
0
Number
94
96
97
98
99
99
99
Page
Video View Finder
Video View Finder Image Size
324 F0h 44h Disable
329 F0h 49h 1700 bytes
100
100
79
Imager Preferences
The parameters in this chapter control image capture characteristics. Image capture occurs in all modes of
operation, including decode, video, and snapshot.
Operational Modes
The imager has three modes of operation:
• Decode Mode
• Snapshot Mode
• Snapshot with Viewfinder Mode
• Video Mode.
Decode Mode
By default, upon a trigger event, the imager attempts to locate and decode barcodes within its field of view. The
imager remains in this mode as long as the trigger is active, until it decodes a barcode, or it reaches the Decode
Session Timeout on page 59.
Imager Preferences
Snapshot Mode
Use Snapshot Mode to capture a high-quality image and transmit it to the host. To temporarily enter this mode
scan the Snapshot Mode barcode. While in this mode the imager blinks the green LED at 1-second intervals to
indicate it is not in standard operating (decode) mode.
In Snapshot Mode, the imager turns on its aiming pattern to highlight the area to capture in the image. The next
trigger event instructs the imager to capture a high quality image and transmit it to the host. A short time may pass
(less than 2 seconds) between trigger activation and image capture as the imager adjusts to the lighting conditions.
Hold the imager steady until image capture, denoted by a single beep.
If a trigger event does not occur within the Snapshot Mode Timeout period, the imager returns to Decode Mode.
Use Snapshot Mode Timeout on page 85 to adjust this timeout period. The default timeout period is 30 seconds.
To disable the laser aiming pattern during Snapshot Mode, see Snapshot Aiming Pattern on page 86.
Use Video View Finder on page 101 to enable Snapshot with Viewfinder Mode. In this mode the imager behaves
as a video camera until the trigger activates, at which time a Snapshot occurs as described above.
80
Imager Preferences
Video Mode
In this mode the imager behaves as a video camera as long as the trigger is active. Upon trigger release, the
imager returns to Decode Mode. Scan the Video Mode barcode to temporarily enter Video Capture Mode.
Snapshot Mode
Video Mode
81
Imager Preferences
Image Capture Illumination
Parameter # 361 (SSI # F0h 69h)
Selecting Enable Image Capture Illumination causes illumination to turn on during every image capture. Disable
illumination to prevent the imager from using illumination.
Enabling illumination usually results in superior images. The effectiveness of illumination decreases as the
distance to the target increases.
* Enable Image Capture Illumination
(1)
Disable Image Capture Illumination
(0)
Image Capture Autoexposure
Parameter # 360 (SSI # F0h 68h)
Select Enable Image Capture Autoexposure to allow the imager to control gain settings and exposure
(integration) time to best capture an image for the selected operation mode.
Select Disable Image Capture Autoexposure to manually adjust the gain and exposure time (see the following
pages). This option is only recommended for advanced users with difficult image capture situations.
* Enable Image Capture Autoexposure
(1)
82
Disable Image Capture Autoexposure
(0)
Imager Preferences
Fixed Exposure
Parameter # 567 (SSI # F4h F1h 37h)
This parameter configures the exposure used in manual mode for Snapshot.
Each integer value represents 100 ms worth of exposure. The default value is 100 which results in an exposure
setting of 10 msec.
To set the Fixed Exposure parameter, scan Fixed Exposure followed by four numeric barcodes representing the
value. Leading zeros are required. For example, to set a Fixed Exposure value of 99, scan 0, 0, 9, 9. See Numeric
Barcodes for numeric barcodes.
Fixed Exposure
(4 digits)
83
Imager Preferences
Gain/Exposure Priority for Snapshot Mode
Parameter # 562 (SSI # F1h 32h)
This parameter alters the imager’s gain exposure priority when it acquires an image in Snapshot Mode in auto
exposure mode.
• Scan Low Exposure Priority to set a mode in which the imager favors higher gain over exposure to capture
an image. This results in an image that is less susceptible to motion blur at the expense of noise artifacts.
However, for most applications, the amount of noise is acceptable.
• Scan Low Gain Priority to set a mode in which the imager favors longer exposure time rather than higher
gain to capture an image. This ensures that the image is less noisy and produces fewer artifacts during post
processing activities like image enhancement (sharpening). The mode is recommended for fixed mount /
fixed object image capture since the image acquired is susceptible to motion blur.
• Scan Autodetect (default) to set a mode in which the imager automatically selects Gain Priority or Low
Exposure Priority mode for Snapshot Mode. If the imager is in a magnetic reed switch enabled stand (or it is
configured in Blink Mode), it uses Low Gain Priority mode. Otherwise, it uses the Low Exposure Priority
mode.
Low Gain Priority
(0)
* Autodetect
(2)
Low Exposure Priority
(1)
84
Imager Preferences
Snapshot Mode Timeout
Parameter # 323 (SSI # F0h 43h)
This parameter sets the amount of time the imager remains in Snapshot Mode. The imager exits Snapshot Mode
when you pull the trigger, or when the Snapshot Mode Timeout elapses. To set this timeout value, scan the Set
Snapshot Mode Timeout barcode below followed by a barcode from Numeric Barcodes. The default value is 0
which represents 30 seconds; values increment by 30. For example, 1 = 60 seconds, 2 = 90 seconds, etc.
To quickly re-set the default timeout to 30 seconds, scan the 30 Seconds barcode below.
If you select No Timeout, the imager remains in Snapshot Mode until you pull the trigger.
Set Snapshot Mode Timeout
No Timeout
(255)
* 30 Seconds
(0)
85
Imager Preferences
Snapshot Aiming Pattern
Parameter # 300 (SSI # F0h 2Ch)
Select Enable Snapshot Aiming Pattern to project the aiming pattern when in Snapshot Mode, or Disable
Snapshot Aiming Pattern to turn the aiming pattern off.
* Enable Snapshot Aiming Pattern
(1)
Disable Snapshot Aiming Pattern
(0)
Silence Operational Mode Changes
Parameter # 1293 (SSI # F8h 05h 0Dh)
Enable this feature to silence the beeper when switching between operational modes (e.g., from Decode Mode to
Snapshot Mode).
Silence Operational Mode Changes (Enable)
(1)
* Do Not Silence Operational Mode Changes (Disable)
(0)
86
Imager Preferences
Image Cropping
Parameter # 301 (SSI # F0h 2Dh)
This parameter crops a captured image. Select Disable Image Cropping to present the full 1200 x 800 pixels.
Select Enable Image Cropping to crop the image to the pixel addresses set in Crop to Pixel Addresses on page
88.
Enable Image Cropping
(1)
* Disable Image Cropping
(Use Full 1200 x 800 Pixels)
(0)
87
Imager Preferences
Crop to Pixel Addresses
Parameter # 315 (SSI # F4h F0h 3Bh) (Top)
Parameter # 316 (SSI # F4h F0h 3Ch) (Left)
Parameter # 317 (SSI # F4h F0h 3Dh) (Bottom)
Parameter # 318 (SSI # F4h F0h 3Eh) (Right)
If you selected Enable Image Cropping, set the pixel addresses from (0,0) to (1279 x 799) to crop to.
Columns are numbered from 0 to 1279, rows from 0 to 799. Specify four values for Top, Left, Bottom, and Right,
where Top and Bottom correspond to row pixel addresses, and Left and Right correspond to column pixel
addresses. For example, for a 4 row x 8 column image in the extreme bottom-right section of the image set the
following values:
Top = 799, Bottom = 799, Left = 1272, Right = 1279
To set the crop to pixel address, scan each pixel address barcode below followed by four numeric barcodes
representing the value. Leading zeros are required. For example, to crop the top pixel address to 3, scan 0, 0, 0, 3.
See Numeric Barcodes for numeric barcodes. The defaults are:
Top = 0, Bottom = 799, Left = 0, Right = 1279
NOTE: The imager has a cropping resolution of 4 pixels. Setting the cropping area to less than 4 pixels (after
resolution adjustment, see Image Size (Number of Pixels) on page 89) transfers the entire image.
Top Pixel Address
(0 - 799 Decimal)
Bottom Pixel Address
(0 - 799 Decimal)
Left Pixel Address
(0 - 1279 Decimal)
Right Pixel Address
(0 - 1279 Decimal)
88
Imager Preferences
Image Size (Number of Pixels)
Parameter # 302 (SSI # F0h 2Eh)
This option alters image resolution before compression. Multiple pixels are combined to one pixel, resulting in a
smaller image containing the original content with reduced resolution.
Select one of the following values:
Table 12 Image Size
Resolution Value Uncropped Image Size
Full 1280 x 800
1/2 640 x 400
1/4 320 x 200
* Full Resolution
(0)
1/4 Resolution
(3)
1/2 Resolution
(1)
89
Imager Preferences
Image Brightness (Target White)
Parameter # 390 (SSI # F0h 86h)
This parameter sets the Target White value used in Snapshot mode when using auto exposure. White and black
are defined as 240 decimal and 1, respectively. Setting the value to the factory default of 180 sets the white level of
the image to ~180.
To set the Image Brightness parameter, scan Image Brightness below followed by three numeric barcodes
representing the value. Leading zeros are required. For example, to set an Image Brightness value of 99, scan 0,
9, 9. See Numeric Barcodes for numeric barcodes.
* 180
Image Brightness
(3 digits)
JPEG Image Options
Parameter # 299 (SSI # F0h 2Bh)
Select an option to optimize JPEG images for either size or for quality. Scan the JPEG Quality Selector barcode
to use a quality value; the imager then selects the corresponding image size. Scan the JPEG Size Selector
barcode to use a size value; the imager then selects the best image quality.
* JPEG Quality Selector
(1)
JPEG Size Selector
(0)
90
Imager Preferences
JPEG Target File Size
Parameter # 561 (SSI # F1h 31h)
This parameter defines the target JPEG file size in terms 1 Kilobytes (1024 bytes). The default value is 160 kB
which represents 160 Kilobytes.
CAUTION JPEG compress may take 10 to 15 seconds based on the amount of information in the target image.
Scanning JPEG Quality Selector (default setting) produces a compressed image that is consistent in
quality and compression time.
To set the JPEG Target File Size parameter, scan JPEG Target File Size below followed by three numeric
barcodes representing the value. Leading zeros are required. For example, to set an image file size value of 99,
scan 0, 9, 9 in Numeric Barcodes.
JPEG Target File Size
(3 digits)
JPEG Quality
Parameter # 305 (SSI # F0h 31h)
If you selected JPEG Quality Selector, scan the JPEG Quality Value barcode followed by 3 barcodes from
Numeric Barcodes corresponding to a value from 5 to 100, where 100 represents the highest quality image.
JPEG Quality Value
(Default: 065)
(5 - 100 Decimal)
91
Imager Preferences
Image Enhancement
Parameter # 564 (SSI # F1h 34h)
This parameter configures the imager's Image Enhance feature. This feature uses a combination of edge
sharpening and contrast enhancement to produce an image that is visually pleasing.
The levels of image enhancement are:
• Off (0)
• Low (1) - Default
• Med (2)
• High (3)
Off
(0)
Medium
(2)
* Low
(1)
High
(3)
92
Imager Preferences
Image File Format Selector
Parameter # 304 (SSI # F0h 30h)
Select an image format appropriate for the system (BMP, TIFF, or JPEG). The imager stores captured images in
the selected format.
BMP File Format
(3)
* JPEG File Format
(1)
TIFF File Format
(4)
93
Imager Preferences
Image Rotation
Parameter # 665 (SSI # F1h 99h)
This parameter controls the rotation of the image by 0, 90,180, or 270º.
* Rotate 0
(0)
Rotate 180
(2)
o
Rotate 90
o
Rotate 270
o
(1)
o
(3)
94
Imager Preferences
Bits Per Pixel (BPP)
Parameter # 303 (SSI # F0h 2Fh)
Select the number of significant bits per pixel (BPP) to use when capturing an image. Select 1 BPP for a black and
white image, 4 BPP to assign 1 of 16 levels of grey to each pixel, or 8 BPP to assign 1 of 256 levels of grey to each
pixel.
NOTE The digital scanner ignores these settings for JPEG file formats, which only support 8 BPP.
The digital scanner ignores 1 BPP for TIFF file formats, which only support 4 BPP and
8 BPP. 1 BPP is coerced to 4 BPP for TIFF file formats.
1 BPP
(0)
* 8 BPP
(2)
4 BPP
(1)
95
Imager Preferences
Signature Capture
Parameter # 93 (SSI # 5Dh)
A signature capture barcode is a special-purpose symbology which delineates a signature capture area in a
document with a machine-readable format. The recognition pattern is variable so it can optionally provide an index
to various signatures. The region inside the barcode pattern is considered the signature capture area. See
Signature Capture Code for more information.
Output File Format
Decoding a signature capture barcode de-skews the signature image and converts the image to a BMP, JPEG, or
TIFF file format. The output data includes the file descriptor followed by the formatted signature image.
Table 13 Output File Format
File Descriptor
Output Format
(1 byte)
JPEG - 1
BMP - 3
TIFF - 4
To enable or disable Signature Capture, scan the appropriate barcode below.
Enable Signature Capture
(1)
Signature Type (1
byte)
1-8 0x00000400 0x00010203….
Signature Image Size
(4 bytes)
(BIG Endian)
* Disable Signature Capture
Signature Image
(0)
96
Imager Preferences
Signature Capture Image File Format Selection
Parameter # 313 (SSI # F0h 39h)
Select a signature file format appropriate for the system (BMP, TIFF, or JPEG). The digital scanner stores captured
signatures in the selected format.
BMP Signature Format
(3)
* JPEG Signature Format
(1)
TIFF Signature Format
(4)
97
Imager Preferences
Signature Capture Bits Per Pixel
Parameter # 314 (SSI # F0h 3Ah)
Select the number of significant bits per pixel (BPP) to use when capturing a signature. Select 1 BPP for a black
and white image, 4 BPP to assign 1 of 16 levels of grey to each pixel, or 8 BPP to assign 1 of 256 levels of grey to
each pixel.
NOTE The digital scanner ignores these settings for JPEG file formats, which only support 8 BPP.
1 BPP
(0)
* 8 BPP
(2)
4 BPP
(1)
98
Imager Preferences
Signature Capture Width
Parameter # 366 (SSI # F4h F0h 6Eh)
The aspect ratio of the Signature Capture Width and Signature Capture Height parameters must match that of the
signature capture area. For example, a 4 x 1 inch signature capture area would require a 4 to 1 aspect ratio of
width to height.
To set the width of the signature capture box, scan the Signature Capture Width barcode, followed by 3 barcodes
from Numeric Barcodes corresponding to a value in the range of 016 to 640 decimal.
Signature Capture Width
(Default: 400)
(016 - 640 Decimal)
Signature Capture Height
Parameter # 367 (SSI # F4h F0h 6Fh)
To set the height of the signature capture box, scan the Signature Capture Height barcode, followed by 3
barcodes from Numeric Barcodes corresponding to a value in the range of 016 to 480 decimal.
Signature Capture Height (Default: 100)
(016 - 480 Decimal)
Signature Capture JPEG Quality
Parameter # 421 (SSI # F0h A5h)
Scan the JPEG Quality Value barcode followed by 3 barcodes from Numeric Barcodes corresponding to a value
from 005 to 100, where 100 represents the highest quality image.
JPEG Quality Value (Default: 065)
(5 - 100 Decimal)
99
Imager Preferences
Video View Finder Image Size
Parameter # 329 (SSI # F0h 49h)
Select the number of 100-byte blocks. Values range from 800 to 12,000 bytes. Selecting a smaller value transmits
more frames per second; selecting a larger value increases video quality.
To set the Video View Finder Image Size, scan the barcode below followed by three barcodes from Numeric
Barcodes corresponding to the 100-byte value from 800 to 12,000 bytes. For example, to select 1500 bytes, enter
0, 1, 5. To select 900 bytes, enter 0, 0, 9. The default is 1700 bytes.
Video View Finder Image Size
100
Loading...