Zebra MC36 Integrator Manual

MC36
MN002340A01
Mobile Computer
Integrator Guide
MC36
INTEGRATOR GUIDE
MN002340A01
October 2015
ii | MC36 Integrator Guide
Copyrights
The products described in this document may include copyrighted computer programs. Laws in the United States and
other countries preserve for certain exclusive rights for copyrighted computer programs. Accordingly, any copyrighted
computer programs contained in the products described in this document may not be copied or reproduced in any
manner without the express written permission.
2015 Symbol Technologies LLC. All Rights Reserved.
No part of this document may be reproduced, transmitted, stored in a retrieval system, or translated into any language
or computer language, in any form or by any means, without the prior written permission.Furthermore, the purchase
of our products shall not be deemed to grant either directly or by implication, estoppel or otherwise, any license under
the copyrights, patents or patent applications, except for the normal non-exclusive, royalty-free license to use that arises
by operation of law in the sale of a product.
Disclaimer
Please note that certain features, facilities, and capabilities described in this document may not be applicable to or
licensed for use on a particular system, or may be dependent upon the characteristics of a particular mobile subscriber
unit or configuration of certain parameters. Please refer to your contact for further information.
Trademarks
Zebra and the Zebra head graphic are registered trademarks of ZIH Corp.
Revision History
Changes to the original guide are listed below:
Revision History | iii
Revision Date
A01 Rev. A
2015/10/29
Description
Initial release.
Table of Contents
Copyrights .............................................................................................................................................................. ii
Revision History .................................................................................................................................................... iii
Chapter 1: Scan Config
Introduction
Application Association
Barcode Input Option .............................................................................................................................................
............................................................................................................................................................1-1
..........................................................................................................................................1-2
Associated apps Quick Launch
Enabled ........................................................................................................................................................1-3
Decoders ......................................................................................................................................................1-4
Decoder Params ...........................................................................................................................................1-5
UPCA .........................................................................................................................................................1-6
UPCE0 ........................................................................................................................................................1-6
UPCE1 ........................................................................................................................................................1-6
Code128 ......................................................................................................................................................1-6
Code 39 .......................................................................................................................................................1-6
Code 93 .......................................................................................................................................................1-7
Code 11 .......................................................................................................................................................1-7
Matrix 2 of 5 ................................................................................................................................................1-7
Interleaved 2 of 5 ..........................................................................................................................................1-7
Discrete 2 of 5 ..............................................................................................................................................1-7
Codebar .......................................................................................................................................................1-7
MSI .............................................................................................................................................................1-8
Data Matrix .................................................................................................................................................1-8
Aztec ............................................................................................................................................................1-8
QR Code ......................................................................................................................................................1-8
Composite CC-A/B ....................................................................................................................................1-8
US Planet .....................................................................................................................................................1-8
............................................................................................................................................1-2
..............................................................................................................................................1-2
1-3
Table of Contents | vii
UK Postal .....................................................................................................................................................1-8
HAN XIN ...................................................................................................................................................1-8
UPC/EAN Params ..................................................................................................................................................1-9
Reader Params .......................................................................................................................................................1-10
Scan Params ..........................................................................................................................................................1-12
Plug-In functions ..................................................................................................................................................1-14
Basic Data Format ......................................................................................................................................1-14
Intent Output .............................................................................................................................................1-14
Keystroke Output .......................................................................................................................................1-15
Configuration Management .................................................................................................................................1-17
Import .......................................................................................................................................................1-17
Export ........................................................................................................................................................1-18
Restore .......................................................................................................................................................1-19
About .........................................................................................................................................................1-19
Configuration File Management ...............................................................................................................1-20
Enterprise Folder .......................................................................................................................................1-20
Auto Import ...............................................................................................................................................1-20
Chapter 2: Android Programming
Introduction 2-1
MC36 Android SDK Add-on
MC36 APIs 2-4
............................................................................................................................................................
..................................................................................................................................2-1
Prerequisites SDK Add-on Installation
How to use in Eclipse ...................................................................................................................................2-3
..............................................................................................................................................................
Scanning API ...............................................................................................................................................2-4
com.symbol.scanning.Scanner .....................................................................................................................2-4
com.symbol.scanning.Scanner.ScannerVersion ............................................................................................2-6
com.symbol.scanning.BarcodeManager .......................................................................................................2-6
com.symbol.scanning.ScannerException .....................................................................................................2-7
com.symbol.scanning.Scanner.DataListener ...............................................................................................2-7
com.symbol.scanning.Scanner.StatusListener .............................................................................................2-8
com.symbol.scanning.StatusData ................................................................................................................2-8
com.symbol.scanning.ScanDataCollection ..................................................................................................2-9
com.symbol.scanning.ScanDataCollection.ScanData .................................................................................2-9
com.symbol.scanning.ScannerConfig ........................................................................................................2-10
com.symbol.scanning.ScannerConfig.DecoderParams ..............................................................................2-11
com.symbol.scanning.ScannerConfig.ReaderParams ................................................................................2-27
com.symbol.scanning.ScannerConfig.ReaderParams.ReaderSpecific ........................................................2-27
com.symbol.scanning.ScannerConfig.ReaderParams.ReaderSpecific.ImagerSpecific ...............................2-27
com.symbol.scanning.ScannerConfig.ReaderParams.ReaderSpecific.LaserSpecific ..................................2-28
com.symbol.scanning.ScannerConfig.ScanParams ....................................................................................2-28
com.symbol.scanning.Scanner.ScannerInfo ...............................................................................................2-29
com.symbol.scanning.ProfileManager .......................................................................................................2-30
com.symbol.scanning.ProfileConfig ..........................................................................................................2-30
com.symbol.scanning.ProfileConfig.ActivitySelection ..............................................................................2-32
.................................................................................................................................................2-1
.............................................................................................................................2-1
viii | MC36 Integrator Guide
com.symbol.scanning.ProfileConfig.ActivitySelection.ActivityElement ...................................................2-32
com.symbol.scanning.ProfileConfig.QuickLaunch ...................................................................................2-32
com.symbol.scanning.ProfileConfig.DataCapture .....................................................................................2-33
com.symbol.scanning.ProfileConfig.DataCapture.Barcode .......................................................................2-33
com.symbol.scanning.ProfileConfig.DataCapture.Barcode.Decoders .......................................................2-33
com.symbol.scanning.ProfileConfig.DataCapture.Barcode.DecoderParams .............................................2-35
com.symbol.scanning.ProfileConfig.DataCapture.Barcode.ReaderParams ...............................................2-44
com.symbol.scanning.ProfileConfig.DataCapture.Barcode.ScanParams ...................................................2-45
com.symbol.scanning.ProfileConfig.DataCapture.Barcode.UpcEanParams .............................................2-45
com.symbol.scanning.ProfileConfig.DataCapture.DataDelivery ..............................................................2-46
com.symbol.scanning.ProfileConfig.DataCapture.DataDelivery.BasicDataFormatting............................2-46
com.symbol.scanning.ProfileConfig.DataCapture.DataDelivery.Intent ....................................................2-47
com.symbol.scanning.ProfileConfig.DataCapture.DataDelivery.Keystroke ..............................................2-47
TouchInputManager API .....................................................................................................................................2-48
com.symbol.touch.TouchInputManager ....................................................................................................2-48
Intent API .............................................................................................................................................................2-48
com.symbol.actions.DISBLE_DEVICE_RESET ...................................................................................2-48
com.symbol.actions.ENABLE_DEVICE_RESET .................................................................................2-49
com.symbol.intent.action.HOMEKEY_MODE .....................................................................................2-49
Mediatek API ........................................................................................................................................................2-49
Chapter 3: ADB USB Setup
Chapter 4: MTK Debug Logging
MTKLogger ............................................................................................................................................................4-1
Open MTKLogge .......................................................................................................................................4-1
Configurations for MTKLogge ...................................................................................................................4-2
Start Loggin ................................................................................................................................................4-3
Stop Loggin .................................................................................................................................................4-3
Clear All Previous Log .................................................................................................................................4-4
Extracting Log File ......................................................................................................................................4-4
Chapter 5: Key Remap
Mc36 Android – Key Remap ...................................................................................................................................5-1
Button Remapping .......................................................................................................................................5-1
Remapping a Button .....................................................................................................................................5-1
Exporting a Configuration File .....................................................................................................................5-2
Importing a Configuration File ....................................................................................................................5-2
Wakeup Configuration .................................................................................................................................5-3
Creating a Remap File ..................................................................................................................................5-4
Enterprise Reset ...........................................................................................................................................5-5
Key Remap Strings ......................................................................................................................................5-5
Chapter 1 Scan Config
Introduction
Scan Config is a utility to allow the user to scan bar codes in any application without adding any customization. It runs in the background and communicates with built-in barcode scanner. The function pictures give you basic idea about Scan Config’s UI. More functions will be shown on UI along with the development of Scan Config tool. This document is to introduce what are the functionalities that Scan Config has now or will have.
Figure1-1:
1-2 | MC36 Integrator Guide
Application Association
Associated apps
Specify application that is able to receive the data in foreground from scanner. User can select one or more apps from all existed applications/activities on the device. All of the selected apps are represented in a list. While the foreground application/activity is matched in the list, the captured barcode data is sent to the application via plug-in as typed on the keyboard. Initially the list contains some stock Android apps and ScanDemo. (refer to the demo picture above)
Figure 1-2:
Quick Launch
Enabled for triggering ScanDemo in Launcher application with scan keys. For example, we can trigger ScanDemo on home screen or programs by this. It is enabled as default.
Barcode Input Option
Figure 1-3:
Scan Config | 1-3
Scan Config provides below options to configure the barcode scanner input.
Enabled
Checked for enabling scanner decode input. Scanner can not decode unless user-end decodes directly by API. It is enabled as default.
1-4 | MC36 Integrator Guide
Decoders
Configures which barcode decoders are enabled or disabled. A list showing all supported barcode decoders appears when the option is touched. A check in the checkbox indicates that the decoder is enabled.
Figure 1-4:
Below are the supported decoders for 1D/2D scanners:
UPC-A(*)
UPC-E0(*)
UPC-E1
EAN-8(*)
EAN-13(*)
Code 128(*)
Code 39(*)
Code 93
Code 11
Interleaved 2 of 5(*)
Discrete 2 of 5
Chinese 2 of 5
Matrix 2 of 5
Codabar
MSI
Trioptic 39
GS1 DataBar(*)
GS1 DataBar Limited(*)
GS1 DataBar Expanded(*)
Below are the supported decoders for 2D scanner only:
Scan Config | 1-5
Composite CC-C
Composite CC-A/B
PDF417(*)
MicroPDF
Data Matrix(*)
Maxicode(*)
Note: * means the decoder is enabled in default.
Decoder Params
Decode Params provides options to configure individual decoder parameters.
Figure 1-5:
QR Code(*)
MicroQR(*)
Aztec(*)
Han Xin(*)
US4state
US4state FICS
US Postnet
US Planet
UK Postal
Japan Postal
Australia Post
TLC-39
Note: The default values are shown at the end of the description of each parameter.
1-6 | MC36 Integrator Guide
UPCA
·Report Check Digit - Enables to show the check digit. (*enabled)
·Preamble - Preamble characters are part of the UPC symbol consisting of Country Code and System Character.
(*Preamble Sys Char)
UPCE0
Report Check Digit - Enables to show the check digit. (*disabled)
·
·Preamble - Preamble characters are part of the UPC symbol consisting of Country Code and System Character. (*Preamble Sys Char)
·Convert UPCE0 To UPCA - Enable to convert UPCE0 (zero suppressed) decoded data to UPC-A format. (*disabled)
UPCE1
·Report Check Digit - Enables to show the check digit. (*enabled)
·Preamble - Preamble characters are part of the UPC symbol consisting of Country Code and System Character. (*Preamble None)
·Convert UPCE1 To UPCA - Enable to convert UPCE1 decoded data to UPC-A format. (*disabled)
Code128
Length1 - To decode a Code 128 symbol with a specific length range set this value to the lower limit. ( *0 )
·
·Length2 - To decode a Code 128 symbol with a specific length range set this value to the upper limit. (*55)
·Enable GS1-128 - Set the GS1-128 subtype. (*enabled)
·Enable ISBT128 - Set the ISBT128 subtype. (*enabled)
·ISBT128 Concatenation Mode - Select an option for concatenating pairs of ISBT code types.
(*Concat Mode Never)
·Check ISBT Table - Enable Check ISBT Table to concatenate only those pairs found in this table. (*disabled)
Code 39
Length1 - To decode a Code 39 symbol with a specific length range set this value to the lower limit. ( *0 )
·
·Length2 - To decode a Code 39 symbol with a specific length range set this value to the upper limit. (*55)
·Verify Check Digit - Enable this feature to check the integrity of all Code 39 symbols. (*disabled)
·Report Check Digit - Transmit Code 39 data with or without the check digit. (*disabled)
·Full ASCII - Code 39 Full ASCII is a variant of Code 39 that pairs characters to encode the full ASCII
character set. (*disabled)
·Convert Code39 To Code32 - Code 32 is a variant of Code 39 used by the Italian pharmaceutical industry. (*disabled)
·Report Code32 Prefix - Enable or disable adding the prefix character "A" to all Code 32 bar codes. (*disabled)
Code 93
·Length1 - To decode a Code 93 symbol with a specific length range set this value to the lower limit. ( *0 )
·Length2 - To decode a Code 93 symbol with a specific length range set this value to the upper limit. (*55)
Code 11
Length1 - To decode a Code 11 symbol with a specific length range set this value to the lower limit. ( *4 )
·
·Length2 - To decode a Code 11 symbol with a specific length range set this value to the upper limit. (*55)
·Verify Check Digit - Selects the check digit mechanism for the decoded Code 11 bar code. (*No Check Digit)
·Report Check Digit - Transmit Code 11 data with or without the check digit. (*disabled)
Matrix 2 of 5
Scan Config | 1-7
·Length1 - To decode a Matrix 2 of 5 symbol with a specific length range set this value to the lower limit. (*55)
·Length2 - To decode a Matrix 2 of 5 symbol with a specific length range set this value to the upper limit. ( *0 )
·Redundancy - Sets the reader to read the bar code twice before accepting data. (*disabled)
·Verify Check Digit - Enable this feature to check the integrity of all Matrix 2 of 5 symbols. (*disabled)
·Report Check Digit - Transmit M2of5 data with or without the check digit. (*disabled)
Interleaved 2 of 5
Length1 - To decode an Interleaved 2 of 5 symbol with a specific length range set this value to the lower limit. (*14 )
·
·Length2 - To decode an Interleaved 2 of 5 symbol with a specific length range set this value to the upper limit. (*10 )
·Check Digit – Select the Check Digit type. (*No Check Digit)
·Report Check Digit - Transmit Interleaved 2 of 5 data with or without the check digit. (*disabled)
·Convert ITF-14 To EAN13 - Convert 14-character Interleaved 2 of 5 bar codes to EAN-13. (*disabled)
Discrete 2 of 5
Length1 - To decode a Discrete 2 of 5 symbol with a specific length range set this value to the lower limit. (*12 )
·
·Length2 - To decode a Discrete 2 of 5 symbol with a specific length range set this value to the upper limit. (*55 )
Codebar
·
Length1 - To decode a Codabar symbol with a specific length range set this value to the lower limit. ( *6 )
·Length2 - To decode a Codabar symbol with a specific length range set this value to the upper limit. (*55)
·CLSI Editing - Enable this parameter to strip the start and stop characters and insert a space after the first, fifth,
1-8 | MC36 Integrator Guide
and tenth characters of a 14-character Codabar symbol. (*disabled)
·NOTIS Editing - Enable this parameter to strip the start and stop characters from a decoded Codabar symbol. (*disabled)
MSI
·Length 1 - To decode a MSI symbol with a specific length range set this value to the lower limit. ( *4 )
·Length 2 - To decode a MSI symbol with a specific length range set this value to the upper limit. (*55 )
·Check Digit – Select one or two check digit. (*One Check Digit)
·Check Digit Scheme - Select the algorithm used to encode the check digit. (*Mod-10-10)
·Report Check Digit - Transmit MSI data with or without the check digit. (*disabled)
Data Matrix
·DataMatrix Inverse. - Set the Data Matrix inverse decoder setting. It makes the decoder decode regular or inverse bar codes. (*Disable)
Aztec
·Aztec Inverse - Set the Aztec inverse decoder setting. It makes the decoder decode regular or inverse bar codes. (*Disable)
QR Code
·QRCode Inverse - Set the QR code inverse decoder setting. It makes the decoder decode regular or inverse bar codes. (*Disable)
Composite CC-A/B
·UCC Link Mode – Select UCC Link Mode. (*Link Flag Ignored)
US Planet
·Report Check Digit - Transmit US Planet data with or without the check digit. (*disabled)
UK Postal
·Report Check Digit - Transmit UK Postal data with or without the check digit. (*disabled)
HAN XIN
·HAN XIN Inverse. - Set the HAN XIN inverse decoder setting. It makes the decoder decode regular or inverse bar codes. (*Disable)
UPC/EAN Params
Figure 1-6:
Scan Config | 1-9
Note: The default values are shown at the end of the description of each parameter.
·Security Level – Select higher security levels for lower quality bar codes. (*Level 0)
·Supplemental Mode – select Supplemental Mode. (*No Supplementals)
·Retry Count – Retry count for auto-discriminating for supplemental. (*10)
·Bookland – Enable or disable this Bookland option. (*disabled)
·Coupon – Enables Coupon code decoding. (*disabled)
·Coupon Report Mode – Select Coupon Report Mode. (*Both Coupon Report Modes)
·EAN Zero Extend – Enable Ean Zero Extend. (*disabled)
·Bookland Format – If Bookland option is enabled, select one of the formats for Bookland data. (*Format ISBN-10)
·Convert DataBar to UPC EAN – converts DataBar barcodes to UPC/EAN format. (*disabled)
1-10 | MC36 Integrator Guide
Reader Params
Figure 1-7:
Note: The default values are shown at the end of the description of each parameter.
Laser Specific
·Beam Timer – Sets the maximum amount of time that the reader remains on.(*5000 )
·Linear Security Level – Sets the number of times a bar code is read to confirm an accurate decode.
(*Linear Security Level 1)
·Inverse 1D Mode – Allows the user to select decoding on inverse 1D barcodes. (*Disable)
·Power Mode –Set scanner power mode. (*Low Power)
Imager Specific
·Illumination Brightness –Set illumination Brightness of the Imager. (*10)
·Inverse 1D Mode – Allows the user to select decoding on inverse 1D barcodes. (*Disable)
·LCD Mode – Enables or disables LCD mode to enhance the ability of the imager to read bar codes from LCD
displays. (*Disable LCD Mode)
·Pick List – Allows the imager to decode only the bar code that is directly under the cross-hair/reticle (+)
·part of the pattern. (*Disable Picklist Mode)
Figure 1-8:
Scan Config | 1-11
1-12 | MC36 Integrator Guide
Scan Params
Figure 1-9:
Note: The default values are shown at the end of the description of each parameter.
·Code Id Type – Insert the code ID identifying code type of a scanned barcode. (*Code Id Type None)
·Character Encoding – Set the encoding as UTF-8, Simplified Chinese or Traditional Chinese for the decoded data.
(*UTF-8)
·Decode Audio Feedback – Select an audio tone to sound upon a good decode. (*optimized-beep)
·Volume Type – The audio stream type refers to type of streaming on which the scan beep should be played.
(*Ringer and Notifications)
·Decode Haptic Feedback – Enable vibration upon a good decode. (*diabled)
·Decode Feedback LED Timer – Sets the duration of green-LED feedback upon a good decode. (*75)
·Decoding LED Notification – Enable red-LED notification upon a decode action. (*enabled)
UPC/EAN Params
Figure 1-10:
Scan Config | 1-13
Note: The default values are shown at the end of the description of each parameter.
·Security Level – Select higher security levels for lower quality bar codes. (*Level 0)
·Supplemental Mode – select Supplemental Mode. (*No Supplementals)
·Retry Count – Retry count for auto-discriminating for supplemental. (*10)
·Bookland – Enable or disable this Bookland option. (*disabled)
·Coupon – Enables Coupon code decoding. (*disabled)
·Coupon Report Mode – Select Coupon Report Mode. (*Both Coupon Report Modes)
·EAN Zero Extend – Enable Ean Zero Extend. (*disabled)
·Bookland Format – If Bookland option is enabled, select one of the formats for Bookland data. (*Format ISBN-10)
·Convert DataBar to UPC EAN – converts DataBar barcodes to UPC/EAN format. (*disabled)
1-14 | MC36 Integrator Guide
Plug-In Functions
Basic Data Format
The Basic Data Format plug-in allows Scan Config to add a prefix and/or a suffix to the captured data before passing it to an Output Plug-in.
Figure1-11:
Intent Output
Note: The default values are shown at the end of the description of each parameter.
The Intent Output plug-in allows the captured data to be sent to an application in the form of an implicit Intent. It provides below options in Scan Config UI:
·Enabled - Enables or disables this plug-in. (*enabled)
·Intent action - Enter the Intent Action name (*com.symbol.scanconfig.SCANDEMO)
·Intent category?- Enter the Intent Category name. (*com.symbol.category)
·Basic data formatting - allows to configure data formatting for the Intent output
·Enabled - Enables or disables Basic Data Formatting. (*enabled)
·Prefix to data - Add characters to the beginning of the data when sent. Suffix to data - Add characters to the end of
the data when sent.Send data - Set to transfer the captured data to the foreground application. Disabling this option prevents the actual data from being transmitted. However, the prefix and suffix strings, if present,are still transmitted
·even when this option is disabled. (*enabled)
·Send as hex - Set to send the data in hexadecimal format. (*disabled)
·Send TAB key - Set to append a tab character to the end of the processed data. (*disabled)
·Send ENTER key - Set to append an Enter character to the end of the processed data. (*disabled)
Keystroke Output
Note: The default values are shown at the end of the description of each parameter.
Figure1-12:
Scan Config | 1-15
1-16 | MC36 Integrator Guide
The Keystroke Plug-in captures and sends data received from the scanner to the foreground applications by emulating keystrokes.
·Enabled - Enables or disables this plug-in. (*enabled)
·Action key character - Enables or disables decoding of a special character embedded within a bar code or MSR data
for use in native Android applications. (*None)
·Basic data formatting - allows to configure data formatting for the Intent output
Enabled - Enables or disables Basic Data Format (*enabled) Prefix to data - Add characters to the beginning of the data when sent. Suffix to data - Add characters to the end of the data when sent. Send data - Set to transfer the captured data to the foreground application. Disabling this option prevents the actual data from being transmitted. However, the prefix and suffix strings, if present, are still transmitted even when this option is disabled. (*enabled) Send as hex - Set to send the data in hexadecimal format. (*disabled) Send TAB key - Set to append a tab character to the end of the processed data. (*disabled) Send ENTER key - Set to append an Enter character to the end of the processed data. (*disabled)
Configuration Management
Import
Allows the user to import Scan Config configuration file from specified path. The imported configuration overrides the current configuration.
Figure1-13:
Scan Config | 1-17
1. Click
2. Select "Import"
3. Choose the path for the file
The imported configuration overrides the current configuration.
1-18 | MC36 Integrator Guide
Export
Allows the user to export the current Scan Config configuration to specified path.
Figure1-14:
1. Click
2. Select "Import"
3. Choose to save the file in internal storage or external storage (if it exists)
Restore
Restore the configuration to factory defaults.
About
Shows the versions of scanner API, scanning framework, ScanConfig and scanner firmware.
Figure 1-15:
Scan Config | 1-19
1-20 | MC36 Integrator Guide
Configuration File Management
Enterprise Folder
Internal storage contains an Enterprise folder(/enterprise). Enterprise folder is persistent and maintains data after an Enterprise reset. After an Enterprise reset, ScanConfig checks folder /enterprise/devices/settings/scanconfig/enterprise for a configuration file, prefs.xml. If the file exists, ScanConfig imports the file to replace the configuration.
Note:
1.This is an implicit operation.
2.The permissions of prefs.xml should be set to 777.
3.Factory reset clears all files in Enterprise folder.
Auto Import
ScanConfig monitors the Enterprise folder /enterprise/device/settings/scanconfig/autoimport for prefs.xml file. Once the prefs.xml is found, ScanConfig imports the file and replaces the existing configuration. And then, ScanConfig deletes the prefs.xml after finishing import. The configuration will be used the next time an associated application is opened.
Note:
1.This is an implicit operation.
2.The permissions of prefs.xml should be set to 777.
3.Factory reset clears all files in Enterprise folder.
Loading...
+ 64 hidden pages