Zebra MS4717 Fixed Mount Imager Scan Engine MS4717 Fixed Mount Imager Integration Guide (en)
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
Loading...