TC20
Mobile Computer
Integrator Guide
for Android ™ 7.1.2 Nougat
MN-003027-04 Rev. A
Copyright
© 2018 ZIH Corp. and/or its affiliates. All rights reserved. ZEBRA and the stylized Zebra head are trademarks of
ZIH Corp., registered in many jurisdictions worldwide. All other trademarks are the property of their respective
owners.
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.
Revision History
Changes to the original guide are listed below:
Change Date Description
-01 Rev A 9/2017 Initial release.
-02 Rev A 2/2018 Add TC20K key codes.
-03 Rev. A 3/2018 Add support for BSP 04-14-xx.
-04 Rev A 9/2018 Update WLAN Security and Encryption information on page 152.
2
Table of Contents
Copyright ........................................................................................................................................... 2
Terms of Use .................................................................................................................................... 2
Revision History ................................................................................................................................ 2
Table of Contents................................................................................................................................... 3
About This Guide
Introduction ..................................................................................................................................... 10
Configurations ................................................................................................................................. 10
Software Versions ........................................................................................................................... 10
Chapter Descriptions ...................................................................................................................... 11
Notational Conventions ................................................................................................................... 11
Related Documents ........................................................................................................................ 11
Service Information ......................................................................................................................... 12
Product Feedback ........................................................................................................................... 12
Getting Started
Introduction ..................................................................................................................................... 13
Setup ............................................................................................................................................... 13
Installing a microSD Card ......................................................................................................... 13
Charging the Battery ................................................................................................................. 15
Charging Indicators ................................................................................................................... 16
Replacing the microSD Card .......................................................................................................... 16
Resetting the TC20 ......................................................................................................................... 18
Performing a Soft Reset ............................................................................................................ 18
Performing a Hard Reset .......................................................................................................... 19
Performing an Enterprise Reset ................................................................................................ 19
Download the Enterprise Reset Package ........................................................................... 19
Using microSD Card ........................................................................................................... 19
Using ADB ........................................................................................................................... 19
Performing a Factory Reset ...................................................................................................... 20
Download the Factory Reset Package ................................................................................ 20
Using microSD Card ........................................................................................................... 20
Using ADB ........................................................................................................................... 21
3
Table of Contents
Accessories
Introduction ..................................................................................................................................... 23
Accessories ..................................................................................................................................... 23
1-Slot Base Charge Only Cradle ..................................................................................................... 26
Setup ......................................................................................................................................... 26
Cable Routing ........................................................................................................................... 26
Connecting Cradles Together ................................................................................................... 27
Charging the Device .................................................................................................................. 28
Battery Charging ....................................................................................................................... 28
Charging Temperature ........................................................................................................ 29
1-Slot Ethernet Charge Cradle ........................................................................................................ 30
Ethernet Bracket Installation ..................................................................................................... 30
USB/Ethernet Communication .................................................................................................. 34
Ethernet LED Indicators ...................................................................................................... 35
Ethernet Settings ................................................................................................................. 35
Configuring Ethernet Proxy Settings ................................................................................... 35
Configuring Ethernet Static IP Address ............................................................................... 36
Charging the Device .................................................................................................................. 37
Battery Charging ....................................................................................................................... 38
Charging Temperature ........................................................................................................ 38
5-Slot Charge Only Cradle .............................................................................................................. 39
Charging the TC20 .................................................................................................................... 39
Battery Charging ....................................................................................................................... 40
Charging Temperature ........................................................................................................ 40
5-Slot Cradle Rack Installation ........................................................................................................ 41
Rack Mount Installation ................................................................................................................... 45
Wall Installation ............................................................................................................................... 48
Bottom Tray Assembly .............................................................................................................. 48
Bracket Wall Mounting .............................................................................................................. 48
USB Communication
Introduction ..................................................................................................................................... 50
Transferring Files using Media Transfer Protocol ..................................................................... 50
Transferring Files using Photo Transfer Protocol ...................................................................... 51
Disconnect from the Host Computer ......................................................................................... 51
DataWedge
Introduction ..................................................................................................................................... 52
Basic Scanning ............................................................................................................................... 52
Profiles ............................................................................................................................................ 53
Profile0 .....................................................................................................................
Plug-ins ........................................................................................................................................... 53
Input Plug-ins ............................................................................................................................ 54
Process Plug-ins ....................................................................................................................... 54
Output Plug-ins ......................................................................................................................... 54
Profiles Screen ................................................................................................................................ 55
Profile Context Menu ................................................................................................................. 55
Options Menu ............................................................................................................................ 56
Disabling DataWedge ............................................................................................................... 56
................. 53
4
Table of Contents
Creating a New Profile .................................................................................................................... 56
Profile Configuration ....................................................................................................................... 56
Associating Applications ........................................................................................................... 57
Data Capture Plus ..................................................................................................................... 59
Bar Code Input .......................................................................................................................... 61
Enabled ............................................................................................................................... 61
Scanner Selection ............................................................................................................... 61
Decoders ................................................................................................................................... 61
Decoder Params ....................................................................................................................... 63
Codabar .............................................................................................................................. 63
Code 11 ............................................................................................................................... 63
Code128 .............................................................................................................................. 64
Code39 ................................................................................................................................ 65
Code93 ................................................................................................................................ 65
Composite AB ..................................................................................................................... 65
Discrete 2 of 5 ..................................................................................................................... 66
GS1 DataBar Limited .......................................................................................................... 66
HAN XIN .............................................................................................................................. 66
Interleaved 2 of 5 ................................................................................................................ 66
Matrix 2 of 5 ........................................................................................................................ 67
MSI ...................................................................................................................................... 67
Trioptic 39 ........................................................................................................................... 67
UK Postal ............................................................................................................................ 67
UPCA .................................................................................................................................. 67
UPCE0 ................................................................................................................................ 68
UPCE1 ................................................................................................................................ 68
US Planet ............................................................................................................................ 68
Decode Lengths .................................................................................................................. 68
UPC EAN Params ..................................................................................................................... 69
Reader Params ......................................................................................................................... 71
Scan Params ............................................................................................................................. 72
UDI Parameters ........................................................................................................................ 74
Multibarcode params ................................................................................................................. 74
Keep Enabled on Suspend ......................................................................................................
Keystroke Output ...................................................................................................................... 74
Intent Output ............................................................................................................................. 75
Intent Overview ......................................................................................................................... 76
IP Output ................................................................................................................................... 77
Usage ........................................................................................................................................ 78
Using IP Output with IPWedge .................................................................................................. 78
Using IP Output without IPWedge ............................................................................................. 79
Generating Advanced Data Formatting Rules ................................................................................ 80
Configuring ADF Plug-in ........................................................................................................... 81
Creating a Rule ................................................................................................................... 81
Defining a Rule .................................................................................................................... 81
Defining Criteria .................................................................................................................. 82
Defining an Action ..................................................................................................................... 83
Deleting a Rule .......................................................................................................................... 83
Order Rules List ........................................................................................................................ 84
Deleting an Action ..................................................................................................................... 86
ADF Example ............................................................................................................................ 86
. 74
5
Table of Contents
DataWedge Settings ................................................................................................................. 89
Importing a Configuration File ................................................................................................... 90
Exporting a Configuration File ................................................................................................... 90
Importing a Profile File .............................................................................................................. 90
Exporting a Profile ..................................................................................................................... 90
Restoring DataWedge ............................................................................................................... 91
Configuration and Profile File Management .................................................................................... 91
Enterprise Folder ....................................................................................................................... 91
Auto Import ................................................................................................................................ 91
Programming Notes ........................................................................................................................ 92
Overriding Trigger Key in an Application ................................................................................... 92
Capture Data and Taking a Photo in the Same Application ...................................................... 92
Disable DataWedge on Device and Mass Deploy .................................................................... 92
Soft Scan Feature ..................................................................................................................... 92
Sample ...................................................................................................................................... 93
Scanner Input Plugin ................................................................................................................. 93
Function Prototype .............................................................................................................. 93
Parameters .......................................................................................................................... 93
Return Values ..................................................................................................................... 93
Example .............................................................................................................................. 94
Comments ........................................................................................................................... 94
Enumerate Scanners ................................................................................................................ 94
Function Prototype .............................................................................................................. 94
Parameters .......................................................................................................................... 94
Return Values ..................................................................................................................... 95
Example .............................................................................................................................. 95
Comments ........................................................................................................................... 96
Set Default Profile ..................................................................................................................... 96
Default Profile Recap .......................................................................................................... 96
Usage Scenario ................................................................................................................... 96
Function Prototype .............................................................................................................. 96
Parameters .......................................................................................................................... 96
Return Values ..................................................................................................................... 96
Example .............................................................................................................................. 97
Comments ........................................................................................................................... 97
Reset Default Profile ................................................................................................................. 98
Function Prototype .............................................................................................................. 98
Parameters .......................................................................................................................... 98
Return Values ..................................................................................................................... 98
Example .............................................................................................................................. 98
Comments ........................................................................................................................... 98
Switch To Profile ....................................................................................................................... 99
Profiles Recap ..................................................................................................................... 99
Usage Scenario ................................................................................................................... 99
Function Prototype .............................................................................................................. 99
Parameters .......................................................................................................................... 99
Return Values ................................................................................................................... 100
Example ............................................................................................................................ 100
Comments ......................................................................................................................... 100
Notes ................................................................................................................................. 101
6
Table of Contents
Settings
Introduction ................................................................................................................................... 102
WLAN Configuration ..................................................................................................................... 102
Configuring a Wi-Fi Network ................................................................................................... 102
Manually Adding a Wi-Fi Network ........................................................................................... 104
Configuring for a Proxy Server ................................................................................................ 105
Configuring the Device to Use a Static IP Address ................................................................. 106
Advanced Wi-Fi Settings ......................................................................................................... 106
Screen Unlock Settings ................................................................................................................. 107
Set Screen Unlock Using PIN ........................................................................................... 107
Set Screen Unlock Using Password ................................................................................. 108
Set Screen Unlock Using Pattern ...................................................................................... 109
Passwords .................................................................................................................................... 110
System Language Usage .............................................................................................................. 110
Adding Languages .................................................................................................................. 110
Selecting a Language ............................................................................................................. 110
Removing a Language ............................................................................................................ 110
Adding Words to the Dictionary ............................................................................................... 111
Keyboard Settings ......................................................................................................................... 111
Enabling Keyboards ................................................................................................................ 111
Configuring a Keyboard .......................................................................................................... 111
TC20K Key Codes ........................................................................................................................ 112
PTT Express Configuration ........................................................................................................... 112
RxLogger ...................................................................................................................................... 112
RxLogger Configuration .......................................................................................................... 113
ANR Module ...................................................................................................................... 113
Kernal Module ................................................................................................................... 114
Logcat Module ................................................................................................................... 114
LTS Module ....................................................................................................................... 115
Ramoops Module .............................................................................................................. 116
Resource Module .............................................................................................................. 116
Snapshot Module .............................................................................................................. 116
TCPDump Module ............................................................................................................. 117
Tombstone Module ........................................................................................................... 117
Configuration File .................................................................................................................... 117
Enabling Logging .............................................................................................................
Disabling Logging .................................................................................................................... 118
Extracting Log Files ................................................................................................................. 118
RxLogger Utility ............................................................................................................................. 119
App View ................................................................................................................................. 119
Viewing Logs ..................................................................................................................... 119
Backup .............................................................................................................................. 120
Archiving ........................................................................................................................... 120
Overlay View ........................................................................................................................... 120
Removing the Main Chat Head ......................................................................................... 121
Viewing Logs ..................................................................................................................... 121
Removing a Sub Chat Head Icon ...................................................................................... 122
Backup .............................................................................................................................. 122
About Phone ................................................................................................................................. 122
....... 117
7
Table of Contents
Application Deployment
Introduction ................................................................................................................................... 124
Security ......................................................................................................................................... 124
Secure Certificates ........................................................................................................................ 124
Installing a Secure Certificate ....................................................................................................... 124
Configuring Credential Storage Settings ................................................................................. 125
Development Tools ....................................................................................................................... 125
Android .................................................................................................................................... 125
EMDK for Android ................................................................................................................... 127
StageNow ................................................................................................................................ 127
ADB USB Setup ............................................................................................................................ 127
Enabling USB Debugging ....................................................................................................... 127
Application Installation .................................................................................................................. 128
Installing Applications Using the USB Connection .................................................................. 128
Installing Applications Using the Android Debug Bridge ......................................................... 130
Installing Applications Using a microSD Card ......................................................................... 130
Uninstalling an Application ...................................................................................................... 131
Performing a System Update ........................................................................................................ 132
Download the System Update Package .................................................................................. 132
Using microSD Card ............................................................................................................... 132
Using ADB ............................................................................................................................... 133
Verify System Update Installation ........................................................................................... 134
Storage ......................................................................................................................................... 134
Random Access Memory ........................................................................................................ 134
Internal Storage ....................................................................................................................... 135
External Storage ..................................................................................................................... 136
Formatting a microSD Card .............................................................................................. 137
Format as Internal Memory ............................................................................................... 138
Enterprise Folder ..................................................................................................................... 139
Application Management .............................................................................................................. 139
Viewing Application Details ..................................................................................................... 140
Managing Downloads ................................................................................................................... 140
Maintenance and Troubleshooting
Introduction ................................................................................................................................... 142
Maintaining the TC20 .................................................................................................................... 142
Display Best Practices .................................................................................................................. 143
Image Retention ...................................................................................................................... 143
Cleaning Instructions .........................................
Approved Cleanser Active Ingredients .................................................................................... 143
Harmful Ingredients ................................................................................................................. 143
Cleaning Instructions ............................................................................................................... 143
Special Cleaning Notes ........................................................................................................... 144
Cleaning Materials Required ................................................................................................... 144
Cleaning Frequency ................................................................................................................ 144
Cleaning the TC20 ........................................................................................................................ 144
Housing ................................................................................................................................... 144
Display .................................................................................................................................... 144
Camera and Exit Window ........................................................................................................ 144
Connector Cleaning ................................................................................................................ 144
........................................................................... 143
8
Table of Contents
Cleaning Cradle Connectors ................................................................................................... 145
Troubleshooting ............................................................................................................................ 145
TC20 ....................................................................................................................................... 145
1-Slot Base Charge Only Cradle ............................................................................................. 147
1-Slot Ethernet Cradle ............................................................................................................. 148
5-Slot Charge Only Cradle Troubleshooting ........................................................................... 149
Technical Specifications
TC20 ............................................................................................................................................. 150
Decode Distances ................................................................................................................... 153
2-Pin I/O Connector Pin-Outs ................................................................................................. 154
1-Slot Base Charge Only Cradle Technical Specifications ..................................................... 155
1-Slot Ethernet Cradle Technical Specifications ..................................................................... 155
5-Slot Charge Only Cradle Technical Specifications .............................................................. 156
Trigger Handle Technical Specifications ................................................................................. 156
Extended Power Pack Technical Specifications ..................................................................... 157
Index
9
About This Guide
Introduction
This guide provides information about using the TC20 mobile computer and accessories.
NOTE Screens and windows pictured in this guide are samples and can differ from actual screens.
Configurations
This guide covers the following configurations:
Table 1 Configurations
Configuration
TC200J-10A111XX LAN GMS No SE2100 No 2 GB/16 GB 3.5 mm Blank
TC200J-10C112XX LAN GMS No SE4710 Yes 2 GB/16 GB 3.5 mm 2-Pin Connector
TC200J-1KC111XX LAN GMS Yes SE4710 Yes 2 GB/16 GB 3.5 mm Blank
TC200J-20A111CN LAN AOSP No SE2100 No 2 GB/16 GB 3.5 mm Blank
TC200J-20C112CN LAN AOSP No SE4710 Yes 2 GB/16 GB 3.5 mm 2-Pin Connector
TC200J-2KC111CN LAN AOSP Yes SE4710 Yes 2 GB/16 GB 3.5 mm Blank
Software Versions
To determine the current software versions touch > About phone.
• Model number- Displays the model number.
Radios
Operating System
Android 7.1
Keypad
10
Memory
Data Capture
8 MP Camera
RAM/Flash
Audio Jack
Access Door
• Android version - Displays the operating system version.
• Kernel version - Displays the kernel version number.
• Build number - Displays the software build number.
To determine the device serial number touch > About phone > Status.
• Serial number - Displays the serial number.
Chapter Descriptions
Topics covered in this guide are as follows:
• Getting Started provides information on getting the TC20 up and running for the first time.
• Accessories describes the available accessories and how to use them with the TC20.
• USB Communication describes how to connect the TC20 to a host computer.
• DataWedge describes how to use and configure the DataWedge application.
• Settings provides the settings for configuring the TC20.
• Application Deployment provides information for developing and managing applications.
About This Guide
• Maintenance and Troubleshooting includes instructions on cleaning and storing the TC20, and provides
troubleshooting solutions for potential problems during TC20 operation.
• Technical Specifications provides the technical specifications for the TC20.
Notational Conventions
The following conventions are used in this document:
• Bold text is used to highlight the following:
• Dialog box, window, and screen names
• Drop-down list and list box names
• Check box and radio button names
• Button names on a screen.
• Bullets (•) indicate:
• Action items
• Lists of alternatives
• Lists of required steps that are not necessarily sequential
• Sequential lists (for example, lists that describe step-by-step procedures) appear as numbered lists.
Related Documents
• TC20 Touch Computer Quick Start Guide, p/n MN-003018-xx.
• TC20 Touch Computer Regulatory Guide, p/n MN-003019-xx.
• TC20 Touch Computer User Guide for Android 7.1.2 Nougat, p/n MN-003020-xx.
For the latest version of this guide and all guides, go to: www.zebra.com/support
.
11
Service Information
Manufacturer Label
If you have a problem with your equipment, please use the Self-Help support resources available at
www.zebra.com. If the support provided via the Self-Help resources is not sufficient, you may contact Zebra Global
Customer Support for your region. Contact information is available at: zebra.com/support
When contacting support, please have the following information available:
• Serial number of the unit (found on manufacturing label)
• Model number or product name (found on manufacturing label)
• Software type and version number.
Figure 1 Manufacturer Label
About This Guide
.
Customer Support responds to calls by email or telephone within the time limits set forth in support agreements.
If the problem cannot be solved by Customer Support, the user may need to return the equipment for servicing and
will be given specific directions. We are 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. Remove the microSD
card from the device before shipping for service.
If the device was purchased from a business partner, contact that business partner for support.
Product Feedback
If you have comments, questions, or suggestions about this guide, send an email to EVM-Techdocs@zebra.com.
12
Getting Started
Introduction
This chapter provides information for getting the device up and running for the first time.
Setup
Perform this procedure to start using the TC20 for the first time.
1. Install a micro secure digital (SD) card (optional).
2. Charge the TC20.
3. Power on the TC20.
Installing a microSD Card
The microSD card slot provides secondary non-volatile storage. The slot is located under the access door. Refer to
the documentation provided with the card for more information, and follow the manufacturer’s recommendations for
use.
CAUTION Use proper electrostatic discharge (ESD) precautions to avoid damaging the microSD card. Proper
ESD precautions include, but are not limited to, working on an ESD mat and ensuring that the operator
is properly grounded.
1. Using a #0 Phillips screwdriver, remove two screws securing the access door.
13
Figure 2 Remove Access Door
2. Remove access door.
Figure 3 Remove Access Door
Getting Started
3. Align the microSD card with the SD card slot.
Figure 4 Align microSD Card
4. Push the microSD card into the SD card slot.
14
Getting Started
Figure 5 Push microSD Card into the SD Card Slot
5. Replace the access Door.
6. Secure the access door using the two screws.
Figure 6 Secure Access Door
Charging the Battery
Before using the TC20 for the first time, charge the battery until the green Charging/Notification light emitting diode
(LED) remains lit. To charge the TC20 use a cradle with the appropriate power supply or USB cable and power
supply. For information about the accessories available for the TC20 see Accessories for more information.
The battery charges from fully depleted to 90% in approximately four hours and from fully depleted to 100% in
approximately five hours.
NOTE In many cases the 90% charge provides plenty of charge for daily use. A full 100% charge lasts for
approximately 10 hours of use.
Use only Zebra charging accessories and batteries. Charge batteries at room temperature with the TC20 in
sleep mode.
Charge batteries in temperatures from 0°C to 40°C (32°F to 104°F). The TC20 or accessory always performs
battery charging in a safe and intelligent manner. At higher temperatures (e.g. approximately +37°C (+98°F)) the
TC20 or accessory may for small periods of time alternately enable and disable battery charging to keep the
battery at acceptable temperatures. The TC20 or accessory indicates when charging is disabled due to abnormal
temperatures via its LED and a notification appears on the display.
To charge the main battery:
15
Getting Started
1. Connect the charging accessory to the appropriate power source.
2. Insert the TC20 into a cradle or attach to a cable. The TC20 turns on and begins charging. The
Charging/Notification LED blinks amber while charging, then turns solid green when fully charged.
Charging Indicators
Table 2 Charging/Notification LED Charging Indicators
State LED Indication
Off TC20 is not charging. TC20 is not inserted correctly in the
cradle or connected to a power source. Charger/cradle is
not powered.
Slow Blinking Amber (1 blink every 4
seconds)
Slow Blinking Red (1 blink every 4
seconds)
Solid Green Charging complete.
Solid Red Charging complete but the battery is at end of useful life.
Fast Blinking Amber (2 blinks/second) Charging error, e.g.:
TC20 is charging.
TC20 is charging but the battery is at end of useful life.
• Temperature is too low or too high.
• Charging has gone on too long without completion
(typically eight hours).
Fast Blinking Red (2 blinks/second) Charging error but the battery is at end of useful life., e.g.:
• Temperature is too low or too high.
• Charging has gone on too long without completion
(typically eight hours).
Replacing the microSD Card
To replace the microSD card:
1. Press the Power button until the menu appears.
2. Touch Power off.
3. Touch OK.
4. If hand strap is attached, remove the hand strap.
5. Using a #0 Phillips screwdriver, remove two screws securing the access door.
6. Remove access door.
16
Getting Started
Figure 7 Remove Access Door
7. Slide the microSD card out of the SD card slot.
Figure 8 Align microSD Card
8. Lift the microSD card.
9. Align the replacement microSD card with the SD card slot.
Figure 9 Align microSD Card
10. Push the microSD card into the SD card slot.
17
Getting Started
Figure 10 Push microSD Card into the SD Card Slot
11. Replace the access Door.
12. Secure the access door using the two screws.
Figure 11 Secure Access Door
13. Replace the hand strap, if required.
14. Press and hold the Power button to turn on the TC20.
Resetting the TC20
There are four reset functions:
• Soft reset
• Hard reset
• Enterprise reset. See Performing an Enterprise Reset on page 19.
• Factory reset See Performing a Factory Reset on page 20.
Performing a Soft Reset
Perform a soft reset if applications stop responding.
1. Press and hold the Power button until the menu appears.
2. Touch Reset.
3. The device reboots.
18
Getting Started
Performing a Hard Reset
CAUTION Performing a hard reset with a SD card installed in the TC20 may cause damage or data corruption to
the SD card.
Perform a hard reset if the TC20 stops responding.
1. Simultaneously press the Power and Volume Up buttons for at least five seconds.
2. When the screen turns off, release the buttons.
3. The TC20 reboots.
Performing an Enterprise Reset
An Enterprise Reset erases all data in the /cache and /data partitions and clears all device settings, except those
in the
/enterprise partition.
Before performing an Enterprise Reset, copy all applications and the key remap configuration file that you want to
persist after the reset into the
Perform Enterprise Reset using either a microSD card or using ADB.
/enterprise/usr/persist folder.
Download the Enterprise Reset Package
Download the system update package:
1. Go to the Zebra Support web site, www.zebra.com/support.
2. Download the Enterprise Reset file to a host computer.
Using microSD Card
1. Copy the Enterprise Reset zip file to the root of the microSD card.
• Copy the zip file to a microSD card using a host computer (see USB Communication for more information)
and then installing the microSD card into the device (see Replacing the microSD Card on page 16 for more
information).
• Connect the device with a microSD card already installed to the host computer and copy zip file to the
microSD card. See USB Communication for more information. Disconnect the device from the host
computer.
2. Press and hold the Power button until the menu appears.
3. Touch Reboot.
4. Touch OK. The device resets.
5. Press and hold the PTT button until the device vibrates. The Android Recovery screen appears.
6. Press the Up and Down Volume buttons to navigate to the apply update from SD card.
7. Press the Power button.
8. Press the Up and Down Volume buttons to navigate to the Enterprise Reset file.
9. Press the Power button. The Enterprise Reset occurs and then the device returns to the Recovery screen.
10. Press the Power button.
Using ADB
To perform an Enterprise Reset using ADB:
19
Getting Started
1. Connect the device to the Zebra USB-C cable or insert the device into the 1-Slot Ethernet Cradle.
2. Connect the cable or cradle to the host computer.
3. On the device, swipe down from the status bar and then touch .
4. Touch Developer options.
5. Slide the switch to the ON position.
6. Touch USB Debugging. A check appears in the check box. The Allow USB debugging? dialog box appears.
7. Touch OK.
8. On the host computer, open a command prompt window and type:
adbdevices.
The following displays:
Listofdevicesattached
XXXXXXXXXXXXXXXdevice
NOTE If device number does not appear, ensure that ADB drivers are installed properly.
9. Type:
adbrebootrecovery
10. Press Enter. The Android Recovery screen appears.
11. Press the Volume Up and Volume Down buttons to navigate to apply from adb.
12. Press the Power button.
13. On the host computer command prompt window type:
adbsideload<file>
(where XXXXXXXXXXXXXXX is the device number).
where: <file> = the path and filename of the zip file.
14. Press Enter. The Enterprise Reset package installs and the device reboots.
Performing a Factory Reset
A Factory Reset erases all data in the /cache, /data and /enterprise partitions in internal storage and clears all
device settings. A Factory Reset returns the device to the last installed operating system image. To revert to a
previous operating system version, re-install that operating system image. See Performing a System Update on
page 132 for more information.
Download the Factory Reset Package
Download the Factory Reset package:
1. Go to the Zebra Support & Downloads web site, www.zebra.com/support.
2. Download the appropriate Factory Reset file to a host computer.
Using microSD Card
1. Copy the Factory Reset zip file to the root of the microSD card.
• Copy the zip file to a microSD card using a host computer (see USB Communication for more information)
and then installing the microSD card into the device (see Replacing the microSD Card on page 16 for more
information).
20
Getting Started
• Connect the device with a microSD card already installed to the host computer and copy zip file to the
microSD card. See USB Communication for more information. Disconnect the device from the host
computer.
2. Press and hold the Power button until the menu appears.
3. Touch Reboot.
4. Touch OK. The device resets.
5. Press and hold the PTT button until the device vibrates. The System Recovery screen appears.
6. Press the Up and Down Volume buttons to navigate to the apply update from sdcard.
7. Press the Power button.
8. Press the Up and Down Volume buttons to navigate to the Android Reset file.
9. Press the Power button. The Factory Reset occurs and then the device returns to the Recovery screen.
10. Press the Power button.
Using ADB
To perform an Factory Reset using ADB:
1. Connect the device to the USB-C Cable or insert the device into the 1-Slot Ethernet Cradle.
2. Connect the cable or cradle to the host computer.
3. On the device, swipe down from the status bar and then touch .
4. Touch Developer options.
5. Slide the switch to the ON position.
6. Touch USB Debugging. A check appears in the check box. The Allow USB debugging? dialog box appears.
7. Touch OK.
8. On the host computer, open a command prompt window and use the adb command:
adbrebootrecovery
9. Press Enter. The Android Recovery screen appears.
10. Press the Volume Up and Volume Down buttons to navigate to apply from adb.
11. Press the Power button.
12. On the host computer, open a command prompt window and use the adb command:
adbdevices.
The following displays:
Listofdevicesattached
XXXXXXXXXXXXXXXdevice
NOTE If device number does not appear, ensure that ADB drivers are installed properly.
13. Type:
(where XXXXXXXXXXXXXXX is the device number).
adbrebootrecovery
14. Press Enter. The System Recovery screen appears.
15. Press the Volume Up and Volume Down buttons to navigate to apply from adb.
16. Press the Power button.
17. On the host computer command prompt window type:
adbsideload<file>
21
Getting Started
where: <file> = the path and filename of the zip file.
18. Press Enter. The Factory Reset package installs and then the device reboots.
22
Accessories
Introduction
This chapter provides information for using the accessories for the device.
Accessories
This table lists the accessories available for the TC20.
Table 3 TC20 Accessories
Accessory Part Number Description
Cradles
1-Slot Base Charge Only
Cradle
1-Slot Ethernet Cradle CRD-TC2X-SE1ET-01 Provides device charging and communication,
5-Slot Charge Only Cradle CRD-TC2X-SE5CO-01 Charges up to five devices. Requires power
Cradle Mount BRKT-SCRD-SMRK-01 Mounts the 5-Slot Charge Only Cradle to a wall
Batteries and Chargers
Extended Power Pack BTRY-TC2X-PRPK1-01 Charges the TC20 internal battery to provide
CRD-TC2X-BS1CO-01 Provides charging for device and Extended
power pack. Requires power supply
(PWR-WUA5V12W0xx), and USB-C cable.
and charging for Extended Power Pack.
Requires power supply
(PWR-BGA12V50W0WW), DC line cord
(CBL-DC-388A1-01), and country-specific AC
line cord.
supply (PWR-BGA12V108W0WW), DC line
cord (CBL-DC-382A1-01), and country-specific
AC line cord.
or rack.
additional power and extend the shift time.
23
Table 3 TC20 Accessories (Continued)
Accessory Part Number Description
Vehicle Solutions
Accessories
Cigarette Lighter Adapter
Auto Charge Cable
Audio Accessories
3.5 mm Audio Adapter CBL-TC51-HDST35-01 Plugs into the device and provides audio to a
3.5 mm Headset HDST-35MM-PTVP-01 Use for PTT calls.
Miscellaneous
Trigger Handle TRG-TC2X-SNP1-01 Adds gun-style handle with a scanner trigger for
Screen Protector KT-TC20-SCRNP1-01 Add additional screen protection.
SmartDEX Solution DX30 Provides wireless DEX communications to the
Ethernet Bracket BRKT-TC51-ENET1-01 Use to connect the USB/Ethernet Adapter to the
USB/Ethernet Module MOD-MT2-EU1-01 Use with 1-Slot Ethernet Cradle to provide
Cradle Mating Adapter KIT-TC2X-BS1FT-05 Use the optional mating adapter to connect two
CHG-AUTO-USB1-01 Provides power to the device from a cigarette
lighter socket.
wired headset with collared 3.5 mm plug.
comfortable and productive scanning.
TC20.
1-Slot Ethernet Cradle.
Ethernet connectivity.
or more cradles together. Each cradle still
requires a power supply (5-pack).
Carrying Solutions
TC2X Soft Holster SG-TC2X-HLSTR1-01 Use to hold the device on hip. Accepts TC20
device with Trigger Handle.
TC20K Soft Holster SG-TC20K-HLST1-01 Use to hold the device on hip. Accepts TC20K
device with Trigger Handle.
TC2X Hand Strap SG-TC2X-HSTRP1-01 Replacement hand strap (3–pack).
TC20K Hand Strap SG-TC20K-HSTP1-01 Replacement hand strap for TC20K (3–pack).
Wrist/Arm Mount SG-TC2X-ARMNT-01 Use to mount the TC20 to the forearm.
Small Wrist Mount Strap SG-WT4023221-03R Replacement small wrist mount strap.
Large Wrist Mount Strap SG-WT4023221-04R Replacement long wrist mount strap.
Power Supplies
Power Supply PWR-BGA12V50W0WW Provides power to the 1-Slot Ethernet Cradle.
Requires DC Line Cord, p/n CBL-DC-388A1-01
and country specific three wire grounded AC line
cord sold separately.
24
Accessories
Table 3 TC20 Accessories (Continued)
Accessory Part Number Description
Power Supply PWR-BGA12V108W0WW Provides power to the 5-Slot Charge Only
cradle. Requires DC Line Cord, p/n
CBL-DC-382A1-01 and country specific three
wire grounded AC line cord sold separately.
Power Supply PWR-WUA5V12W0US Provides 5 VDC, 2.5 A power to the USB-C
cable. Includes plug adapter for use in the
United States.
Power Supply PWR-WUA5V12W0GB Provides 5 VDC, 2.5 A power to the USB-C
cable. Includes plug adapter for use in the
European Union.
Power Supply PWR-WUA5V12W0EU Provides 5 VDC, 2.5 A power to the USB-C
cable. Includes plug adapter for use in the
United Kingdom.
Power Supply PWR-WUA5V12W0AU Provides 5 VDC, 2.5 A power to the USB-C
cable. Includes plug adapter for use in Australia.
Power Supply PWR-WUA5V12W0CN Provides 5 VDC, 2.5 A power to the USB-C
cable. Includes plug adapter for use in China.
Power Supply PWR-WUA5V12W0BR Provides 5 VDC, 2.5 A power to the USB-C
cable. Includes plug adapter for use in Brazil.
Power Supply PWR-WUA5V12W0KR Provides 5 VDC, 2.5 A power to the USB-C
cable. Includes plug adapter for use in Korea.
Power Supply PWR-WUA5V12W0IN Provides 5 VDC, 2.5 A power to the USB-C
cable. Includes plug adapter for use in India.
DC Line Cord CBL-DC-382A1-01 Provides power from the power supply
(PWR-BGA12V108W0WW) to the 5-Slot
Charge Only Cradle.
DC Line Cord CBL-DC-388A1-01 Provides power from the power supply
(PWR-BGA12V50W0WW) to the 1-Slot Ethernet
Cradle.
2-Way DC Line Cord CBL-DC-377A1-01 Use to charge two 5-Slot Charge Only cradles
with one power supply.
2-Way DC Line Cord CBL-DC-379A1-01 Use to charge one 1-Slot Ethernet Cradle and
one 5-Slot Charge Only Cradle with one power
supply.
4-Way DC Line Cord CBL-DC-380A1-01 Use to charge four 1-Slot Ethernet cradles with
one power supply.
US AC Line Cord 23844-00-00R 7.5 feet long, grounded, three wire for power
supply.
USB-C Cable CBL-TC2X-USBC-01 The USB cable used to connect PC to single slot
USB cradle.
25
1-Slot Base Charge Only Cradle
Power Supply
USB-C Cable
USB C Port
The 1-Slot Base Charge Only Cradle provide 5 VDC for charging:
• TC20 battery
• Extended Power Pack
• TC20 and Extended Power Pack
• TC20 with Trigger Handle.
Setup
Figure 12 1-Slot Base Charge Only Cradle Setup
Accessories
Cable Routing
To cradle provides three ways to route the USB cable:
• Rear
• Left side
• Right side.
26
Accessories
Cable Holder
Cable Holder
Figure 13 USB Cable Routing
Insert the USB-C cable connector into the USB port. Routing the cable to the rear, left, or right and use cable
holders to secure cable.
Connecting Cradles Together
The 1-Slot Base Charge Only Cradle can be connected together to form a row of cradles using the optional
mounting brackets.
1. Align a mounting bracket on either side of cradle.
Figure 14 Align Mounting Bracket
2. Press the mounting bracket into the cradle.
3. Place cradle on flat surface.
4. Align second cradle.
27
Accessories
Charge/Notification
LED
Figure 15 Align Cradles
5. Press the cradle down ensuring that the bracket studs snap into the receiving holes in the cradle.
Charging the Device
To charge a device:
1. Insert the device into the slot to begin charging.
Figure 16 Battery Charging
2. Ensure the device is seated properly.
Battery Charging
The device’s Charging/Notification LED indicates the status of the battery charging in the device. See Table 2 on
page 16 for device charging status. The battery charges from fully depleted to 90% in approximately four hours and
from fully depleted to 100% in approximately five hours.
28
Accessories
NOTE In many cases the 90% charge provides plenty of charge for daily use. A full 100% charge lasts for
approximately 10 hours of use.
Use only Zebra charging accessories and batteries. Charge batteries at room temperature with the TC20 in
sleep mode.
Charging Temperature
Charge batteries in temperatures from 0°C to 40°C (32°F to 104°F). The device or cradle always performs battery
charging in a safe and intelligent manner. At higher temperatures (e.g. approximately +37°C (+98°F)) the device or
cradle may for small periods of time alternately enable and disable battery charging to keep the battery at
acceptable temperatures. The device and cradle indicates when charging is disabled due to abnormal
temperatures via its LED.
29
1-Slot Ethernet Charge Cradle
AC Line Cord
Power Supply
USB micro-B Connector
DC Line Cord
USB micro-AB Port
USB A Connector
The 1-Slot USB Charge Cradle:
• Provides 5 VDC power for operating the device.
• Charges the device’s battery.
• Provides USB communication with host computer.
• Provides USB and Ethernet communication using the Ethernet Bracket and Module adapter.
Figure 17 1–Slot USB Charge Cradle Setup
Accessories
Ethernet Bracket Installation
To install the Ethernet Bracket:
1. Turn over the Ethernet Bracket.
2. Remove the thumbscrew securing the plate to the bracket.
30
Figure 18 Remove Thumbscrew
3. Turn over the bracket and remove plate.
Figure 19 Remove Plate
Accessories
4. Align the 1-Slot Ethernet Cradle with the plate.
Figure 20 Align Cradle with Plate
5. Slide the plate and cradle into the bracket.
31
Figure 21 Align Cradle/Plate with Bracket
6. Push the plate into the bracket.
Figure 22 Push Plate into Bracket
Accessories
7. Turn over the bracket and cradle.
8. Secure the thumbscrew.
32
Accessories
USB micro-AB Port
Figure 23 Secure Screw
9. Insert the Ethernet Module into the bracket.
Figure 24 Insert Module
10. Push module in until it is seated properly. The USB micro-B connector on the Ethernet module plugs into the
USB micro-AB port on the cradle.
33
Figure 25 Ethernet Bracket Setup
RJ-45 Port
USB micro-AB Port
USB micro B Connector
Ethernet Cable
USB A Connector
Accessories
USB/Ethernet Communication
The 1-Slot Ethernet Cradle provides both Ethernet communication with a network and USB communication with a
host computer. Prior to using the cradle for Ethernet or USB communication. Ensure that the switch on the
USB/Ethernet module is set properly.
Figure 26 Ethernet Cradle Module Switch
For Ethernet communication, slide the switch to the position.
For USB communication, slide the switch to the position.
Place the switch in the center position to disable communications.
34
Accessories
1
2
Ethernet LED Indicators
There are two LEDs on the USB/Ethernet Module RJ-45 port. The green LED lights to indicate that the transfer rate
is 100 Mbps. When the LED is not lit the transfer rate is 10 Mbps. The yellow LED blinks to indicate activity, or
stays lit to indicate that a link is established. When it is not lit it indicates that there is no link.
Figure 27 LED Indicators
Table 2-1 USB/Ethernet Module LED Data Rate Indicators
Data Rate (1) Amber LED (2) Green LED
100 Mbps On/Blink On
10 Mbps On/Blink Off
Ethernet Settings
The following settings can be configured when using Ethernet communication:
• Proxy Settings
• Static IP.
Configuring Ethernet Proxy Settings
The TC20 includes Ethernet cradle drivers. After inserting the TC2 0, configure the Ethernet connection:
1. Swipe down from the status bar and then touch .
2. Touch Ethernet.
3. Place the TC20 into the Ethernet cradle slot.
4. Slide the switch to the ON position.
5. Touch and hold Eth0 until the menu appears.
6. Touch Modify Proxy.
7. Touch the Proxy drop-down list and select Manual.
35
Accessories
Figure 28 Ethernet Proxy Settings
8. In the Proxy hostname field, enter the proxy server address.
9. In the Proxy port field, enter the proxy server port number.
NOTE When entering proxy addresses in the Bypass proxy for field, do not use spaces or carriage returns
between addresses.
10. In the Bypass proxy for text box, enter addresses for web sites that do not require to go through the proxy
server. Use the separator “|” between addresses.
11. Touch MODIFY.
12. Touch .
Configuring Ethernet Static IP Address
The TC20 includes Ethernet cradle drivers. After inserting the TC2 0, configure the Ethernet connection:
1. Swipe down from the status bar and then touch .
2. Touch Ethernet.
3. Place the TC20 into the Ethernet cradle slot.
4. Slide the switch to the ON position.
5. Touch Eth0.
6. Touch Disconnect.
7. Touch Eth0.
8. Touch and hold the IP settings drop-down list and select Static.
36
Accessories
Figure 29 Static IP Settings
9. In the IP address field, enter the proxy server address.
10. If required, in the Gateway field, enter a gateway address for the device.
11. If required, in the Netmask field, enter the network mask address.
12. If required, in the DNS address fields, enter a Domain Name System (DNS) addresses.
13. Touch CONNECT.
14. Touch .
Charging the Device
To charge a device:
1. Insert the device into the slot to begin charging.
37
Figure 30 Battery Charging
Charge/Notification
LED
Accessories
2. Ensure the device is seated properly.
Battery Charging
The device’s Charging/Notification LED indicates the status of the battery charging in the device. See Table 2 on
page 16 for device charging status. The internal battery charges from fully depleted to 90% in approximately four
hours and from fully depleted to 100% in approximately five hours.
NOTE In many cases the 90% charge provides plenty of charge for daily use. A full 100% charge lasts for
approximately 10 hours of use.
Charging Temperature
Charge batteries in temperatures from 0°C to 40°C (32°F to 104°F). The device or cradle always performs battery
charging in a safe and intelligent manner. At higher temperatures (e.g. approximately +37°C (+98°F)) the device or
cradle may for small periods of time alternately enable and disable battery charging to keep the battery at
acceptable temperatures. The device and cradle indicates when charging is disabled due to abnormal
temperatures via its LED.
Use only Zebra charging accessories and batteries. Charge batteries at room temperature with the TC20 in
sleep mode.
38
5-Slot Charge Only Cradle
AC Line Cord
DC Line Cord
Power Supply
The 5-Slot Charge Only Cradle:
• Provides 5 VDC power for operating the TC20.
• Simultaneously charges up to five TC20s.
Figure 31 5-Slot Charge Only Cradle Setup
Accessories
Charging the TC20
To charge a device:
1. Insert the TC20 into a slot to begin charging.
39
Figure 32 TC20 Battery Charging
Charge/Notification
LED
Accessories
2. Ensure the TC20 is seated properly.
Battery Charging
The device’s Charging/Notification LED indicates the status of the battery charging in the device. See Table 2 on
page 16 for device charging status. The internal battery charges from fully depleted to 90% in approximately four
hours and from fully depleted to 100% in approximately five hours.
NOTE In many cases the 90% charge provides plenty of charge for daily use. A full 100% charge lasts for
approximately 10 hours of use.
Charging Temperature
Charge batteries in temperatures from 0°C to 40°C (32°F to 104°F). The device or cradle always performs battery
charging in a safe and intelligent manner. At higher temperatures (e.g. approximately +37°C (+98°F)) the device or
cradle may for small periods of time alternately enable and disable battery charging to keep the battery at
acceptable temperatures. The device and cradle indicates when charging is disabled due to abnormal
temperatures via its LED.
Use only Zebra charging accessories and batteries. Charge batteries at room temperature with the TC20 in
sleep mode.
40
5-Slot Cradle Rack Installation
DC line Cord AC line CordPower Supply
Studs (4)
Use the Rack/Wall Mount Bracket to mount a 5-slot cradle on a rack. When installing on a rack, first assemble the
bracket and cradles/chargers and then install the assembly on the rack.
1. Place the power supply in bottom tray.
2. Connect AC line cord to power supply.
3. Connect DC line cord to power supply.
4. Secure power supply and cables to bottom tray with tie wraps.
NOTE Ensure tie wrap buckle is on side of power supply. Tie wrap buckle on top of power supply interferes with
top tray.
5. Route cables through cable slots.
Figure 33 Power Supply in Bottom Tray
Accessories
6. Secure four M2.5 studs to top tray as shown.
Figure 34 Install Studs
7. Align and install 5-Slot cradle onto studs of top tray.
41
Accessories
Safety Screws(2)
Figure 35 Align Cradle on Studs
8. Secure cradle to top tray with two M2.5 safety screws.
Figure 36 Secure Cradle
9. Slide top tray onto bottom tray.
42
Figure 37 Slide Top Tray onto Bottom Tray
10. Connect cables to cradle.
Figure 38 Connect Cables
Accessories
11. Secure top tray to bottom tray with 4 M5 screws (two on each side).
43
Accessories
Figure 39 Secure Top and Bottom Tray
See Rack Mount Installation on page 45 for installing the bracket assembly onto a rack.
44
Rack Mount Installation
Fifth Screw Hole
Flange
Top Screw Hole
Flange
NOTE Use screws provided with rack system. Refer to rack user documentation for instructions.
1. Secure mounting brackets to both sides of top tray with four M5 screws (two on each side).
Figure 40 Flange Horizontal Position
Accessories
Figure 41 Flange 25° Position
CAUTION Install mounting bracket with 5-Slot cradle at a maximum height of four feet from ground.
NOTE Distance between two horizontal mounted brackets should be at least 14.5” apart (from top of one flange to
the top of the next flange).
Distance between two 25° mounted brackets should be at least 12” apart (from top of one flange to the top of
the next flange).
2. Install two rack system screws for top of mounting brackets. The screw heads should protrude half way from
the rail.
45
Figure 42 Install Rack System Screws
Rack Screws
14 “
14.5”
Accessories
3. Align the mounting bracket’s top mounting key holes with the screws.
4. Place the brackets on the screws.
Figure 43 Secure Bracket to Rack (Horizontal Position Shown)
5. Secure the top screws.
46
Accessories
6. Install bottom screws and tighten screws.
7. Route cables and connect to power source.
CAUTION Installer should ensure that all building codes are followed when connecting the power supplies to an
AC power source.
While installing the brackets, power supplies and cables:
• Use tie wraps to secure cables to the bracket and rails.
• Coil cables wherever possible.
• Route power cables along the rails.
• Route inter-cradle cables to the side rails and then from the rails to the bracket.
47
Wall Installation
22.85 mm
398 mm
Use the Rack/Wall Mount Bracket to mount a 5-Slot Charge Only cradle on a wall. When installing on a wall, first
assemble the bottom tray, install the bottom tray on the wall and then assemble the top tray.
Use mounting hardware (screws and/or anchors) appropriate for the type of wall mounting the bracket onto. The
Mount Bracket mounting slots dimensions are 5 mm (0.2 in.). Fasteners must be able to hold a minimum of 20 Kg
(44 lbs.)
For proper installation consult a professional installer. Failure to install the bracket properly can possibly result in
damage to the hardware.
CAUTION Install mounting bracket with 5-Slot Charge Only cradle at a maximum height of four feet from ground.
Bottom Tray Assembly
See steps 1 through 5 on page 41 for instructions.
Accessories
Bracket Wall Mounting
1. Drill holes and install anchors according to the template supplied with the bracket.
2. Install two screws for bottom of bracket. The screw heads should protrude 2.5 mm (0.01”) from the wall.
Figure 44 Horizontal Mounting Template
3. Align the mounting bracket’s bottom mounting key holes with the screws.
4. Hang the bracket on the screws.
48
Accessories
Figure 45 Horizontal Installation
5. Install two top screws.
6. Tighten all screws.
Figure 46 Horizontal Installation - Tighten Screws
7. Assembly the 5-Slot Charge Only cradle onto the bracket. See steps 7 through 11 on page 41.
8. Route cables and connect to power source.
CAUTION Installer should ensure that all building codes are followed when connecting the power supplies to an
AC power source.
While installing the brackets, power supplies and cables:
• Use tie wraps to secure cables to the bracket and rails.
• Coil cables wherever possible.
• Route power cables along the rails.
• Route inter-cradle cables to the side rails and then from the rails to the bracket.
49
USB Communication
Introduction
Connect the TC20 to a host computer using the USB-C Cable, or the 1-Slot Ethernet Cradle with a standard USB
B cable to transfer files between the TC20 and the host computer. See Accessories for more information.
When connecting the TC20 to a host computer, follow the host computer’s instructions for connecting and
disconnecting USB devices, to avoid damaging or corrupting files.
Transferring Files using Media Transfer Protocol
NOTE Use Media Transfer Protocol (MTP) to copy files between the TC20 (internal memory or microSD card)
and the host computer.
1. Connect the USB-C Cable to the TC20 or place the TC20 into the 1-Slot Ethernet Cradle. See Accessories for
setup information.
2. Pull down the Notification panel and touch USB for Charging.
Figure 47 Use USB Dialog Box
3. Touch Transfer files.
4. On the host computer, open a file explorer application.
5. Locate the TC20 as a portable device.
6. Open the SD card or the Internal storage folder.
7. Copy files to and from the TC20 or delete files as required.
50
Getting Started
Transferring Files using Photo Transfer Protocol
NOTE Use Photo Transfer Protocol (PTP) to copy photos from either the microSD card or internal memory to the
host computer.
1. Connect the USB-C Cable to the TC20 or place the TC20 into the 1-Slot Ethernet Cradle. See Accessories for
setup information.
2. Pull down the Notification panel and touch USB for Charging.
Figure 48 Use USB Dialog Box
3. Touch Transfer photos (PTP).
4. On the host computer, open a file explorer application.
5. Open the SD card or the Internal storage folder.
6. Copy or delete photos as required.
Disconnect from the Host Computer
CAUTION Carefully follow the host computer’s instructions to unmount the microSD card and disconnect USB
devices correctly to avoid losing information.
1. On the host computer, unmount the device.
2. Remove the USB-C Cable from the device or remove the device from the cradle.
51
DataWedge
Introduction
This chapter applies to DataWedge on Android devices. DataWedge is an application that reads data, processes
the data and sends the data to an application.
Basic Scanning
To capture bar code data:
1. Ensure that an application is open on the device and a text field is in focus (text cursor in text field).
2. Aim the exit window at a bar code.
3. Press and hold the a Scan button. The red aiming pattern turns on to assist in aiming. Ensure that the bar code
is within the area formed by the aiming pattern.
Figure 49 TC20 Data Capture
4. The Data Capture LED lights green, a beep sounds and the device vibrates, by default, to indicate the bar code
was decoded successfully. The captured data appears in the text field.
52
Profiles
DataWedge is based on profiles and plug-ins. A profile contains information on how DataWedge should behave
with different applications.
Profile information consists of:
Using profiles, each application can have a specific DataWedge configuration. For example, each user application
can have a profile which outputs scanned data in the required format when that application comes to the
foreground. DataWedge can be configured to process the same set of captured data differently based on the
requirements of each application.
DataWedge includes the following pre-configured profiles which support specific built-in applications:
DataWedge
• Associated application
• Input plug-in configurations
• Output plug-in configurations
• Process plug-in configurations.
• Visible profiles:
• Profile0 - created automatically the first time DataWedge runs. Generic profile used when there are no
user created profiles associated with an application.
• Launcher - enables scanning when the Launcher is in foreground. Note: to save battery power,
disable this profile when not required.
• DWDemo - provides support for the DWDemo application.
• AssetTrackerLite - provides support for the Asset Tracker Lite application (BSP 04-14-xx and above).
Some Zebra applications are capable of capturing data by scanning. DataWedge is pre-loaded with private and
hidden profiles for this purpose. There is no option to modify these private profiles.
Profile0
Profile0 can be edited but cannot be associated with an application. That is, DataWedge allows manipulation of
plug-in settings for Profile0 but it does not allow assignment of a foreground application. This configuration allows
DataWedge to send output data to any foreground application other than applications associated with user-defined
profiles when Profile0 is enabled.
Profile0 can be disabled to allow DataWedge to only send output data to those applications which are associated
in user-defined profiles. For example, create a profile associating a specific application, disable Profile0 and then
scan. DataWedge only sends data to the application specified in the user-created profile. This adds additional
security to DataWedge enabling the sending of data only to specified applications.
Plug-ins
A plug-in is a software module utilized in DataWedge to extend its functionality to encompass technologies such as
bar code scanning. The plug-ins can be categorized into three types based on their operations:
• Input Plug-ins
• Output Plug-ins
• Process Plug-ins.
53
DataWedge
Input Plug-ins
An Input Plug-in supports an input device, such as a bar code scanner contained in, or attached to the device.
DataWedge contains base plug-ins for these input devices.
• Bar Code Scanner Input Plug-in – The Bar Code Scanner Input Plug-in is responsible for reading data
from the integrated bar code scanner and supports different types of bar code readers including laser,
imager and internal camera. Raw data read from the bar code scanner can be processed or formatted
using Process Plug-ins as required. DataWedge has built-in feedback functionality for the bar code
scanner to issue user alerts. The feedback settings can be configured according to user requirement.
Process Plug-ins
Process Plug-ins are used in DataWedge to manipulate the received data according to the requirement, before
sending to the foreground application via the Output Plug-in.
• Basic Data Formatting Process Plug-in – The Basic Data Formatting Plug-in allows DataWedge to add
a prefix and/or a suffix to the captured data before passing it to an Output Plug-in.
• Advanced Data Formatting Process Plug-in – The Advanced Data Formatting Plug-in allows
DataWedge to apply rules (actions to be performed based on defined criteria) to the data received via an
input plug-in before passing it to an Output Plug-in.
Output Plug-ins
Output Plug-ins are responsible for sending the data from Input Plug-ins to a foreground application on the device.
• Keystroke Output Plug-in – The Keystroke Output Plug-in collects and sends data received from the
Input Plug-in to the foreground applications by emulating keystrokes.
• Intent Output Plug-in – The Intent Output Plug-in collects and sends data received from the Input
Plug-ins to foreground applications using the Android Intent mechanism.
• IP Output Plug-in – The IP Output Plug-in collects and sends data received from the Input Plug-ins to a
host computer via a network connection. Captured data can be sent over an IP network to a specified IP
address and port using either TCP or UDP transport protocols.
54
Profiles Screen
To launch DataWedge, swipe up from the bottom of the screen and touch . By default, three profiles appear:
• Profile0
• Launcher
• DWDemo.
Profile0 is the default profile and is used when no other profile can be applied.
Figure 50 DataWedge Profiles Screen
DataWedge
Profile names are color coded. Enabled profiles are white and disabled profiles are gray.
To configure a profile touch the profile name.
Profile Context Menu
Touch and hold a profile to open a context menu that allows additional actions to be performed on the selected
profile.
Figure 51 Profile Context Menu
The profile context menu allows the profile to be edited (same as just tapping on a profile), renamed or deleted.
55
DataWedge
Options Menu
Figure 52 DataWedge Options Menu
The menu provides options to create a new profiles, access to general DataWedge settings and DataWedge
version information.
Disabling DataWedge
1. Swipe up from the bottom of the screen and touch .
2. Touch .
3. Touch Settings.
4. Touch DataWedge enabled.
The blue check disappears from the checkbox indicating that DataWedge is disabled.
Creating a New Profile
5. Swipe up from the bottom of the screen and touch .
6. Touch .
7. Touch New profile.
8. In the New profile dialog box, enter a name for the new profile. It is recommended that profile names be
unique and made up of only alpha-numeric characters (A-Z, a-z, 0-9).
Figure 53 New Profile Name Dialog Box
9. Touch OK.
The new profile name appears in the DataWedge profile screen.
Profile Configuration
To configure the Profile0 or a user-created profile, touch the profile name.
56
DataWedge
Figure 54 Profile Configuration Screen
The configuration screen lists the following sections:
• Profile enabled
• Applications
• Data Capture panel (DCP)
• Barcode Input
• Keystroke output
• Intent Output
• IP Output.
Associating Applications
Use Applications option to associate applications with this profile. User created profiles should be associated with
one or more applications and its activities.
1. Touch Associated apps. A list of applications/activities associated with the profile displays. Initially the list
does not contain any applications/activities.
57
Figure 55 Associated Apps Screen
2. Touch .
3. Touch New app/activity.
DataWedge
Figure 56 Select Application Menu
4. In the Select application screen, select the desired application from the list.
5. In the Select activity menu, selecting the activity adds that application/activity combination to the associated
application list for that profile. Selecting * as the activity results in all activities within that application being
associated to the profile. During operation, DataWedge tries to match the specific application/activity
combinations with the foreground application/activity before trying to match the general application/*
combinations.
6. Touch .
58
Figure 57 Selected Application/Activity
DCP Button
Data Capture Plus
DataWedge
Data Capture Plus (DCP) is a DataWedge feature that enables the user to initiate data capture by touching a
designated part of the screen. A variable screen overlay acts like a scan button.
Figure 58 Minimized Data Capture Panel
The DataWedge profile configuration screen allows the user to configure how the DCP appears on the screen once
the particular profile is enabled. The DCP is hidden by default. Enabling DCP option displays seven additional
configuration parameters.
59
DataWedge
Figure 59 Data Capture Panel Settings
• Enable - Select to enable Data Capture Plus (default - disabled).
• Dock button on - Select position of the button.
• Left or right - Allows user to place the button on either the right or left edge of the screen.
• Left only - Places the button on left edge of the screen.
• Right only - Places the button on the right edge of the screen.
• Start in - Select the initial DCP state.
• Fullscreen mode - DCP covers the whole screen.
• Button mode - DCP displays as a circular button on the screen and can be switched to fullscreen
mode.
• Button only mode - DCP displays as a circular button on the screen and cannot be switched to
fullscreen mode.
• Button highest position - Select the top of the range the user is allowed to move the DCP, given as a
percent of the screen height (default - 0).
• Button lowest position - Select the bottom of the range the user is allowed to move the DCP, given as a
percent of the screen height (default - 100).
• Drag detect time - Select the time in milliseconds that the scanner waits before activating scanner. This
allows the user to drag the button without initiating scanner (default - 100 ms, maximum 1000 ms).
NOTE The DCP does not appear if the scanner is disabled in the profile even though the Enabled option is set.
In Button mode, the user can place DCP in full screen mode by dragging the button over Fullscreen mode. The
overlay covers the screen.
60
Figure 60 Maximized DCP
to return to button mode.
Bar Code Input
DataWedge
Use the Bar Code Input options to configure the Bar Code Scanner Input Plug-in for the profile.
Enabled
Enables or disables this plug-in. A check in the checkbox indicates that the plug-in is enabled.
Scanner Selection
Configures which scanning device to use for bar code data capture when the profile is active.
• Auto - The software automatically determines the best scanning device.
• 2D Barcode Imager - Scanning is performed using the 2D Imager.
• RS6000 Bluetooth Scanner - Scanning is performed using the option RS6000 Bluetooth scanner.
Decoders
Configures which bar code decoders are enabled or disabled. For best performance disable all unnecessary
decoders.
Touch Decoders. The Barcode input screen appears. A check in the checkbox indicates that the decoder is
enabled. By default the most commonly used decoders are enabled (shown below with an asterisk). The supported
decoders are:
NOTE DataWedge supports the decoders listed below but not all are validated on this device.
61
DataWedge
Table 3 Supported Decoders
Decoders Internal Imager RS6000
Australian Postal Disabled Disabled
Aztec Enabled Enabled
Canadian Postal Disabled Disabled
Chinese 2 of 5 Disabled Disabled
Codabar Enabled Enabled
Code 11 Disabled Disabled
Code 128 Enabled Enabled
Code 39 Enabled Enabled
Code 93 Disabled Disabled
Composite AB Disabled Disabled
Composite C Disabled Disabled
Discrete 2 of 5 Disabled Disabled
Datamatrix Enabled Enabled
Dutch Postal Disabled Disabled
EAN-13 Enabled Enabled
EAN-8 Enabled Enabled
GS1 DataBar Enabled Enabled
GS1 DataBar Expanded Enabled Enabled
GS1 DataBar Limited Disabled Disabled
HAN XIN Disabled Disabled
Interleaved 2 of 5 Disabled Disabled
Japanese Postal Disabled Disabled
Korean 3 of 5 Disabled Disabled
MAIL MARK Enabled Enabled
Matrix 2 of 5 Disabled Disabled
Maxicode Enabled Enabled
MicroPDF Disabled Disabled
MicroQR Disabled Disabled
MSI Disabled Disabled
PDF417 Enabled Enabled
QR Code Enabled Enabled
62
DataWedge
Table 3 Supported Decoders (Continued)
Decoders Internal Imager RS6000
Decoder Signature Disabled Disabled
TLC 39 Disabled Disabled
Trioptic 39 Disabled Disabled
UK Postal Disabled Disabled
UPC-A Enabled Enabled
UPC-E0 Enabled Enabled
UPC-E1 Disabled Disabled
US4state Disabled Disabled
US4state FICS Disabled Disabled
US Planet Disabled Disabled
US Postnet Disabled Disabled
Touch to return to the previous screen.
Decoder Params
Use Decode Params to configure individual decoder parameters.
Codabar
• CLSI Editing - Enable this parameter to strip the start and stop characters and insert a space after the
first, fifth, and tenth characters of a 14-character Codabar symbol. Enable this feature if the host
system requires this data format (default - disabled).
• Length1 - Use to set decode lengths (default - 6). See Decode Lengths on page 68 for more
information.
• Length2 - Use to set decode lengths (default - 55). See Decode Lengths on page 68 for more
information.
• NOTIS Editing - Enable this parameter to strip the start and stop characters from a decoded Codabar
symbol. Enable this feature if the host system requires this data format (default - disabled).
• Redundancy - Sets the reader to read the bar code twice before accepting data. A check in the
checkbox indicates that redundancy is enabled (default - enabled).
Code 11
• Length1 - Use to set decode lengths (default - 4). See Decode Lengths on page 68 for more information.
• Length2 - Use to set decode lengths (default - 55). See Decode Lengths on page 68 for more information.
• Redundancy - Sets the reader to read the bar code twice before accepting data. A check in the checkbox
indicates that redundancy is enabled (default - enabled).
• Report Check Digit - Transmit Code 11 data with or without the check digit. A check in the checkbox
indicates to send Code 11 data with check digit (default - disabled).
63
DataWedge
• Verify Check Digit - Check the integrity of all Code 11 symbols to verify that the data complies with the
specified check digit algorithm. This selects the check digit mechanism for the decoded Code 11 bar code.
• No Check Digit - Do not verify check digit.
• 1 Check Digit - Bar code contains one check digit (default).
• 2 Check Digits - Bar code contains two check digits.
Code128
• Code128 Reduced Quiet Zone - Enables decoding of margin-less Code 128 bar codes (default -
disabled) (Imager and RS6000 only).
• Ignore Code128 FCN4 - When enabled, and a Code 128 bar code has an embedded FNC4 character, it
will be removed from the data and the following characters will not be changed. When the feature is
disabled, the FNC4 character will not be transmitted but the following character will have 128 added to it
(default - disabled) (Imager and RS6000 only).
• Check ISBT Table - The ISBT specification includes a table that lists several types of ISBT bar codes that
are commonly used in pairs. If ISBT128 Concat Mode is set, enable Check ISBT Table to concatenate only
those pairs found in this table. Other types of ISBT codes are not concatenated. A check in the checkbox
indicates that redundancy is enabled (default - disabled).
• Enable GS1-128 - Set the GS1 128 subtype. A check in the checkbox indicates that the option is enabled
(default - enabled).
• Enable ISBT128 - Set the ISBT128 subtype. A check in the checkbox indicates that the option is enabled
(default - enabled).
• Enabled Plain Code128 - (default - enabled).
• ISBT128 Concatenation Mode - Select an option for concatenating pairs of ISBT code types:
• Concat Mode Never - Do not concatenate pairs of ISBT codes encountered (default).
• Concat Mode Always - There must be two ISBT codes in order to decode and perform concatenation.
Does not decode single ISBT symbols.
• Concat Mode Auto - Decodes and concatenates pairs of ISBT codes immediately. If only a single
ISBT symbol is present, the device must decode the symbol the number of times set via DataWedge
Configuration 4 - 11 Redundancy - Code128 before transmitting its data to confirm that there is no
additional ISBT symbol.
• Length1 - Use to set decode lengths (default - 0). See Decode Lengths on page 68 for more information.
• Length2- Use to set decode lengths (default - 55). See Decode Lengths on page 68 for more information.
• Redundancy - Sets the reader to read the bar code twice before accepting data. A check in the checkbox
indicates that redundancy is enabled (default - disabled).
• Security Level - The scanner offers four levels of decode security for Code 128 bar codes. Select
increasing levels of security for decreasing levels of bar code quality. There is an inverse relationship
between security and scanner aggressiveness, so choose only that level of security necessary for any
given application.
• Security Level 0 - This setting allows the scanner to operate in its most aggressive state, while
providing sufficient security in decoding most “in-spec” bar codes.
• Security Level 1 - This setting eliminates most misdecodes (default).
• Security Level 2 - Select this option if Security level 1 fails to eliminate misdecodes.
• Security Level 3 - If Security Level 2 is selected and misdecodes still occur, select this security level.
Be advised, selecting this option is an extreme measure against mis-decoding severely out of spec bar
codes. Selecting this level of security significantly impairs the decoding ability of the scanner. If this
level of security is needed, try to improve the quality of the bar codes.
64
DataWedge
Code39
• Code39 Reduced Quiet Zone - Enables decoding of margin-less Code 39 bar codes (default - disabled)
(imager and RS6000 only).
• Convert Code39 To Code32 - Code 32 is a variant of Code 39 used by the Italian pharmaceutical
industry. Scan the appropriate bar code below to enable or disable converting Code 39 to Code 32 (default
- disabled).
• Full ASCII - Code 39 Full ASCII is a variant of Code 39 that pairs characters to encode the full ASCII
character set. To enable or disable Code 39 Full ASCII (default - disabled),
• Length1 - Use to set decode lengths (default - 0). See Decode Lengths on page 68 for more information.
• Length2 - Use to set decode lengths 4 (default - 55). See Decode Lengths on page 68 for more
information.
• Redundancy - Sets the reader to read the bar code twice before accepting data. A check in the checkbox
indicates that redundancy is enabled (default - disabled).
• Report Check Digit - Transmit Code 39 data with or without the check digit. A check in the checkbox
indicates to send Code 39 data with check digit (default - disabled).
• Report Code32 Prefix - Scan the appropriate bar code to enable or disable adding the prefix character “A”
to all Code 32 bar codes (default - disabled).
• Security Level - Options: Security level 0, Security Level 1, Security Level 2 and Security Level 3
(default - Security level 1).
• Security Level 0 - This setting allows the scanner to operate in its most aggressive state, while
providing sufficient security in decoding most “in-spec” bar codes.
• Security Level 1 - This setting eliminates most misdecodes (default).
• Security Level 2 - Select this option if Security level 1 fails to eliminate misdecodes.
• Security Level 3 - If Security Level 2 is selected and misdecodes still occur, select this security level.
Be advised, selecting this option is an extreme measure against mis-decoding severely out of spec bar
codes. Selecting this level of security significantly impairs the decoding ability of the scanner. If this
level of security is needed, try to improve the quality of the bar codes.
• Verify Check Digit - Enable this feature to check the integrity of all Code 39 symbols to verify that the data
complies with a specified check digit algorithm. The digital scanner decodes only those Code 39 symbols
that include a modulo 43 check digit. Enable this feature only if the Code 39 symbols contain a modulo 43
check digit (default - disabled).
Code93
• Length1 - Use to set decode lengths (default - 0). See Decode Lengths on page 68 for more information.
• Length2 - Use to set decode lengths (default - 55). See Decode Lengths on page 68 for more information.
• Redundancy - Sets the reader to read the bar code twice before accepting data. A check in the checkbox
indicates that redundancy is enabled (default - disabled).
Composite AB
• UCC Link Mode
• Link Flag ignored - 1D component is transmitted regardless of whether a 2D component is detected.
• Always Linked - 1D and the 2D components are transmitted. If 2D is not present, the 1D component
is not transmitted.
• Auto Discriminate - the digital scanner determines if there is a 2D portion, then transmits the 1D
component, as well as the 2D portion if present. (default).
65
DataWedge
Discrete 2 of 5
• Length1 - Use to set decode lengths (default - 0). See Decode Lengths on page 68 for more information.
• Length2 - Use to set decode lengths (default - 14). See Decode Lengths on page 68 for more information.
• Redundancy - Sets the reader to read the bar code twice before accepting data. A check in the checkbox
indicates that redundancy is enabled (default - enabled).
GS1 DataBar Limited
• GS1 Limited Security Level
• GS1 Security Level 1 - This setting allows the scanner to operate in its most aggressive state, while
providing sufficient security in decoding most “in-spec” bar codes.
• GS1 Security Level 2 - This setting eliminates most misdecodes (default).
• GS1 Security Level 3 - Select this option if Security level 2 fails to eliminate misdecodes.
• GS1 Security Level 4 - If Security Level 3 is selected and misdecodes still occur, select this security
level. Be advised, selecting this option is an extreme measure against mis-decoding severely out of
spec bar codes. Selecting this level of security significantly impairs the decoding ability of the scanner.
If this level of security is needed, try to improve the quality of the bar codes.
HAN XIN
• HAN XIN Inverse
• Disable - Disables decoding of HAN XIN inverse bar codes (default).
• Enable - Enables decoding of HAN XIN inverse bar codes.
• Auto - Decodes both HAN XIN regular and inverse bar codes.
Interleaved 2 of 5
• Check Digit
• No Check Digit - A check digit is not used (default).
• USS Check Digit - Select to check the integrity of all Interleaved 2 of 5 symbols to verify the data
complies with either the Uniform Symbology Specification (USS) check digit algorithm.
• OPCC Check Digit - Select to check the integrity of all Interleaved 2 of 5 symbols to verify the data
complies with either the Optical Product Code Council (OPCC) check digit algorithm.
• Length1 - Use to set decode lengths (default - 14). See Decode Lengths on page 68 for more information.
• Length2 - Use to set decode lengths (default - 10). See Decode Lengths on page 68 for more information.
• Redundancy - Sets the reader to read the bar code twice before accepting data. A check in the checkbox
indicates that redundancy is enabled (default - enabled).
• Report Check Digit - Transmit Interleaved 2 of 5 data with or without the check digit. A check in the
checkbox indicates to send Interleaved 2 of 5 data with check digit (default - disabled).
• I2of5 Security Level - Options: I2of5 Security level 0, I2of5 Security Level 1, I2of5 Security Level 2
and I2of5 Security Level 3 (default - I2of5 Security level 1).
• Convert ITF-14 To EAN13 - Convert 14-character Interleaved 2 of 5 bar codes to EAN-13, and transmit as
EAN-13. The Interleaved 2 of 5 bar code must be enabled and must have a leading zero and a valid
EAN-13 check digit. A check in the checkbox indicates that the option is enabled (default - disabled).
• I2of5 Reduced Quiet Zone - Enables decoding of margin-less I2of5 bar codes.
66
DataWedge
Matrix 2 of 5
• Length1 - Use to set decode lengths (default - 10). See Decode Lengths on page 68 for more information.
• Length2 - Use to set decode lengths (default - 0). See Decode Lengths on page 68 for more information.
• Redundancy - Sets the reader to read the bar code twice before accepting data. A check in the checkbox
indicates that redundancy is enabled (default - disabled).
• Report Check Digit - Transmit Matrix 2 of 5 data with or without the check digit. A check in the checkbox
indicates to send Matrix 2 of 5 data with check digit (default - enabled).
• Verify Check Digit - Enable this feature to check the integrity of all Matrix 2 of 5 symbols to verify that the
data complies with a specified check digit algorithm (default - enabled).
MSI
• Check Digit - With MSI symbols, one check digit is mandatory and always verified by the reader. The
second check digit is optional.
• One Check Digit - Verify one check digit (default).
• Two Check Digits - Verify two check digits.
• Check Digit Scheme - Two algorithms are possible for the verification of the second MSI check digit.
Select the algorithm used to encode the check digit.
• Mod-11-10 - First check digit is MOD 11 and second check digit is MOD 10 (default).
• Mod-10-10 - Both check digits are MOD 10.
• Length 1 - Use to set decode lengths (default - 4). See Decode Lengths on page 68 for more information.
• Length 2 - Use to set decode lengths (default - 55). See Decode Lengths on page 68 for more information.
• Redundancy - Sets the reader to read the bar code twice before accepting data. A check in the checkbox
indicates that redundancy is enabled (default - enabled).
• Report Check Digit - Transmit MSI data with or without the check digit. A check in the checkbox indicates
to send MSI data with check digit (default - disabled).
Trioptic 39
• Redundancy - Sets the reader to read the bar code twice before accepting data. A check in the checkbox
indicates that redundancy is enabled (default - enabled) (RS6000 only).
UK Postal
• Report Check Digit - Transmit UK Postal data with or without the check digit. A check in the checkbox
indicates to send UK Postal data with check digit (default - disabled).
UPCA
• Preamble - Preamble characters are part of the UPC symbol consisting of Country Code and System
Character. Select the appropriate option to match the host system.
There are three options for transmitting a UPCA preamble:
• Preamble None - Transmit no preamble.
• Preamble Sys Char - Transmit System Character only (default).
• Preamble Country and Sys Char - Transmit System Character and Country Code (“0” for USA).
Select the appropriate option to match the host system.
67
DataWedge
• Report Check Digit - The check digit is the last character of the symbol used to verify the integrity of the
data. Enables or disables this option. A check in the checkbox indicates that the option is enabled (default
- enabled).
UPCE0
• Convert UPCE0 To UPCA - Enable to convert UPCE0 (zero suppressed) decoded data to UPC-A format
before transmission. After conversion, the data follows UPC-A format and is affected by UPC-A
programming selections. Disable to transmit UPCE0 decoded data as UPCE0 data, without conversion
(default - disabled).
• Preamble - Preamble characters are part of the UPC symbol consisting of Country Code and System
Character. Select the appropriate option to match the host system.
There are three options for transmitting a UPCE0 preamble:
• Preamble Sys Char - Transmit System Character only.
• Preamble Country and Sys Char - Transmit System Character and Country Code (“0” for USA).
• Preamble None - Transmit no preamble (default).
• Report Check Digit - The check digit is the last character of the symbol used to verify the integrity of the
data. Enables or disables this option. A check in the checkbox indicates that the option is enabled (default
- disabled).
UPCE1
• Convert UPCE1 To UPCA - Enable this to convert UPCE1 decoded data to UPC-A format before
transmission. After conversion, the data follows UPC-A format and is affected by UPC-A programming
selections. Disable this to transmit UPCE1 decoded data as UPCE1 data, without conversion (default disabled).
• Preamble - Preamble characters are part of the UPC symbol consisting of Country Code and System
Character. Select the appropriate option to match the host system.
There are three options for transmitting a UPCE1 preamble:
• Preamble Sys Char - Transmit System Character only.
• Preamble Country and Sys Char - Transmit System Character and Country Code (“0” for USA).
• Preamble None - Transmit no preamble (default).
• Report Check Digit - The check digit is the last character of the symbol used to verify the integrity of the
data. Enables or disables this option. A check in the checkbox indicates that the option is enabled (default
- disabled).
US Planet
• Report Check Digit - The check digit is the last character of the symbol used to verify the integrity of the
data. Enables or disables this option. A check in the checkbox indicates that the option is enabled (default
- disabled).
Decode Lengths
• The allowable decode lengths are specified by options Length1 and Length2 as follows:
• Variable length: Decode symbols containing any number of characters.
• Set both Length1 and Length2 to 0.
• Range: Decode a symbol with a specific length range (from
• Set Length1 to
a
and set Length2 to b.
a
to b, including a and b).
68
DataWedge
• Two Discrete Lengths: Decode only symbols containing either of two selected lengths.
• Set both Length1 or Length2 to the specific lengths. Length1 must be greater than Length2.
• One Discrete Length: Decode only symbols containing a specific length.
• Set both Length1 and Length2 to the specific length.
UPC EAN Params
Allows the configuration of the parameters that apply to more than one UPC or EAN decoder.
• Convert DataBar To UPC EAN - If this is set it converts DataBar bar codes to UPC/EAN format. For this
setting to work UPC/EAN symbologies must be enabled. A check in the checkbox indicates that the option
is enabled (default - disabled).
• UPC Reduced Quiet Zone - Enables decoding of margin-less UPC bar codes (default - disabled) (Imager
and RS6000 only).
• Bookland - Enable Bookland decoding. A check in the checkbox indicates that the option is enabled
(default - disabled).
• Bookland Format - If Bookland EAN is enabled, select one of the following formats for Bookland data:
• Format ISBN-10 - The decoder reports Bookland data starting with 978 in traditional 10-digit format
with the special Bookland check digit for backward-compatibility. Data starting with 979 is not
considered Bookland in this mode. (default)
• Format ISBN-13 - The decoder reports Bookland data (starting with either 978 or 979) as EAN-13 in
13-digit format to meet the 2007 ISBN-13 protocol.
• Coupon - Enables Coupon code decoding. Note that in order to successfully decode Coupon codes, all of
the correct decoders must be enabled. A check in the checkbox indicates that the option is enabled
(default - disabled).
• Coupon Report Mode - Traditional coupon symbols are composed of two bar code: UPC/EAN and Code
128. A new coupon symbol is composed of a single Data Expanded bar code. The new format offers more
options for purchase values (up to $999.999) and supports complex discount offers as a second purchase
requirement. An interim coupon symbol also exists that contain both types of bar codes: UPC/EAN and
Databar Expanded. This format accommodates both retailers that do not recognize or use the additional
information included in the new coupon symbol, as well as those who can process new coupon symbols.
• Old Coupon Report Mode - Scanning an old coupon symbol reports both UPC and Code 128,
scanning is interim coupon symbol reports UPC, and scanning a new coupon symbol reports nothing
(no decode).
• New Coupon Report Mode - Scanning an old coupon symbol reports either UPC or Code 128, and
scanning an interim coupon symbol or a new coupon symbol reports Databar Expanded.
• Both Coupon Report Modes - Scanning an old coupon symbol reports both UPC and Code 128, and
scanning an interim coupon symbol or a new coupon symbol reports Databar Expanded (default).
• Ean Zero Extended – Enable this parameter to add five leading zeros to decoded EAN-8 symbols to make
them compatible in format to EAN-13 symbols. Disable this to transmit EAN-8 symbols as is. Default –
disabled.
• Linear Decode - This option applies to code types containing two adjacent blocks (e.g., UPC-A, EAN-8,
EAN-13). Enable this parameter to transmit a bar code only when both the left and right blocks are
successfully decoded within one laser scan. Enable this option when bar codes are in proximity to each
other (default - disabled) (RS6000 only).
• Retry Count - Retry count for auto-discriminating for supplementals. Possible values are 2 to 20 inclusive.
Note that this flag is only considered if Supplemental Mode - UPC EAN is set to one of the following
69
DataWedge
values: Supplementals Auto, Supplementals Smart, Supplementals 378-379, Supplementals
978-979, Supplementals 977 or Supplementals 414-419-434-439 (2 to 20, default 10).
• Security Level - The scanner offers four levels of decode security for UPC/EAN bar codes. Select higher
security levels for lower quality bar codes. There is an inverse relationship between security and decode
speed, so be sure to choose only that level of security necessary for the application.
• Level 0 - This default setting allows the scanner to operate fastest, while providing sufficient security in
decoding “in-spec” UPC/EAN bar codes (default).
• Level 1 - As bar code quality levels diminish, certain characters become prone to misdecodes before
others (i.e., 1, 2, 7, 8). If the scanner is misdecoding poorly printed bar codes, and the misdecodes are
limited to these characters, select this security level.
• Level 2 - If the scanner is misdecoding poorly printed bar codes, and the misdecodes are not limited to
characters 1, 2, 7, and 8, select this security level.
• Level 3 - If the scanner is still misdecoding, select this security level. Be advised, selecting this option
is an extreme measure against misdecoding severely out of spec bar codes. Selecting this level of
security can significantly impair the decoding ability of the scanner. If this level of security is necessary,
try to improve the quality of the bar codes.
• Supplemental2 - Enables or disables this option. A check in the checkbox indicates that the option is
enabled.
• Supplemental5 - Enables or disables this option. A check in the checkbox indicates that the option is
enabled.
• Supplemental Mode
• No Supplementals - the scanner is presented with a UPC/EAN plus supplemental symbol, the
scanner decodes UPC/EAN and ignores the supplemental characters (default).
• Supplemental Always - the scanner only decodes UPC/EAN symbols with supplemental characters,
and ignores symbols without supplementals.
• Supplements Auto - the scanner decodes UPC/EAN symbols with supplemental characters
immediately. If the symbol does not have a supplemental, the scanner must decode the bar code the
number of times set via UPC/EAN Supplemental Redundancy before transmitting its data to confirm
that there is no supplemental.
• Supplemental Smart - Enables smart supplementals. In this mode the decoder returns the decoded
value of the main block right away if it does not belong to one of the following supplemental types: 378,
379, 977, 978, 979, 414, 419, 434 or 439. If the bar code starts with one of the prefixes it searches the
image more aggressively for a supplemental. Tries to scan the supplemental if it is present. If the
supplemental scanning failed, then the main bar code is returned.
• Supplemental 378-379 - Enables (auto-discriminate) supplemental for UPC/EAN codes starting with
378 or 379. Disables reading of supplementals for any other UPC/EAN bar code not starting with 378
or 379. Tries to scan the supplemental if it is present. If the supplemental scanning failed, then the
main bar code is returned.
• Supplemental 978-979 - Enables (auto-discriminate) supplemental for UPC/EAN codes starting with
978 or 979. Disables reading of supplementals for another UPC/EAN bar code not starting with 978 or
979. Tries to scan the supplemental if it is present. If the supplemental scanning failed, then the main
bar code is returned.
• Supplemental 414-419-434-439 - Enables (auto-discriminate) supplemental for UPC/EAN codes
starting with 414, 419, 434 or 439. Disables reading of supplementals for another UPC/EAN bar code
4 - 16 not starting with 414, 419, 434 or 439. Tries to scan the supplemental if it is present. If the
supplemental scanning failed, then the main bar code is returned.
• Supplemental 977 - Enables (auto-discriminate) supplemental for UPC/EAN codes starting with 977.
Disables reading of supplementals for another UPC/EAN bar code not starting with 977. Tries to scan
70
DataWedge
the supplemental if it is present. If the supplemental scanning failed, then the main bar code is
returned.
Reader Params
Allows the configuration of parameters specific to the selected bar code reader.
• 1D Quiet Zone Level - Sets the level of aggressiveness in decoding bar codes with a reduced quiet zone
(the area in front of and at the end of a bar code), and applies to symbologies enabled by a Reduced Quiet
Zone parameter. Because higher levels increase the decoding time and risk of misdecodes, Zebra strongly
recommends enabling only the symbologies which require higher quiet zone levels, and leaving Reduced
Quiet Zone disabled for all other symbologies (Imager only).
Options are:
• 0 - The scanner performs normally in terms of quiet zone.
• 1 - The scanner performs more aggressively in terms of quiet zone (default).
• 2 - The scanner only requires one side EB (end of bar code) for decoding.
• 3 - The scanner decodes anything in terms of quiet zone or end of bar code.
• Aim mode - Turns the scanner cross-hairs on or off.
• On - Cross-hair is on (default).
• Off - Cross-hair is off.
• Character Set Selection
• ISO-88959-1 - part of the ISO/IEC 8859 series of ASCII-based standard character encodings. It is
generally intended for Western European languages.
• Shift_JIS - Shift Japanese Industrial Standards (JIS) is a character encoding for the Japanese
language.
• GB18030 - CGB18030 is a character encoding for the Chinese language.
• UTF-8 - A character encoding capable of encoding all possible characters, or code points, defined by
Unicode (default).
• Time Delay to Low Power - Sets the time the decoder remains active after decoding. After a scan
session, the decoder waits this amount of time before entering Low Power Mode. Options: 1 Second
(default), 30 Seconds, 1 Minute or 5 Minutes (RS6000 only).
• Illumination Brightness - Sets the brightness of the illumination by altering LED power. The default is 10,
which is maximum LED brightness. For values from 1 to 10, LED brightness varies from lowest to highest
level of brightness (RS6000 only).
• Illumination mode - Turns imager illumination on and off. This option is only available when Bluetooth
Scanner is selected in the Barcode input, Scanner selection option.
• On - Illumination is on (default).
• Off - Illumination is off.
• Inverse 1D Mode - This parameter allows the user to select decoding on inverse 1D bar codes.
• Disable - Disables decoding of inverse 1D bar codes (default).
• Enable - Enables decoding of only inverse 1D bar codes.
• Auto - Allows decoding of both twice positive and inverse 1D bar codes.
71
DataWedge
• LCD Mode - Enables or disables LCD mode. LCD mode enhances the ability of the imager to read bar
codes from LCD displays such as cellphones.
• Disable - Disables the LCD mode (default).
• Enable - Enables LCD mode.
• HW Engine Low Power Timeout - Time (in ms) of inactivity before scanner enters low-power mode.
• Picklist - Allows the imager to decode only the bar code that is directly under the cross-hair/reticle (+) part
of the pattern. This feature is useful in applications where multiple bar codes may appear in the field of
view during a decode session and only one of them is targeted for decode.
• Disabled – Disables Picklist mode. Any bar code within the field of view can be decoded (default).
• Enabled – Enables Picklist mode so that only the bar code under the projected reticle can be decoded.
• Hardware Picklist - Picklist mode is enabled by sending a command to hardware.
• Software Picklist - Picklist feature is handled in the software; no commands are sent to hardware.
• Poor Quality Decode Effort - Enable poor quality bar code decoding enhancement feature.
• Aim Timer - Sets the maximum amount of time that aiming remains on (0 - 60,000 ms in increments of 100
ms). A value of 0 sets the aim to stay on indefinitely (default - 500) (Imager only).
• Aim Type - Set the aiming usage.
• Trigger - A trigger event activates decode processing, which continues until the trigger event ends or
a valid decode occurs (default).
• Timed Hold - A trigger pull and hold activates the laser for aiming, which continues until the trigger is
released, a valid decode, or the decode session time-out is expired.
• Timed Release - A trigger pull activates the laser for aiming, which continues until a valid decode or
the remaining decode session time has expired.
• Press and Release - A trigger pull and release activates the laser for aiming, which continues until a
trigger is pressed again, a valid decode, or the decode session time-out is expired.
• Continuous Read - When the imager detects an object in its field of view, it triggers and attempt to
decode.
• Press And Sustain - Starts the scan beam when the trigger is pressed and continues the decode
session until the Beam Timer is expired, barcode is decoded, or read is canceled. Scan beam does not
stop when the user releases the trigger. This avoids unexpected cancellations of a scan by
subsequently pressing the trigger button. Subsequent trigger presses while the beam is on have no
effect (only available on BSP 04-14-xx and above).
• Beam Timer - Sets the maximum amount of time that the reader remains on (0 - 60,000 ms in increments
of 100 ms). A value of 0 sets the reader to stay on indefinitely (default - 5000).
• Different Symbol Timeout - Controls the time the scanner is inactive between decoding different
symbols. Programmable in 500 msec increments from 0 to 5 seconds. The default is 500 msec.
• Same Symbol Timeout - Controls the time the scanner is inactive between decoding same symbols.
Programmable in 500 msec increments from 0 to 5 seconds. The default is 500 msec.
• Scanning Modes - Controls single or multiple barcode scanning. With multiple barcode scanning, the
device decodes the number barcodes set in the Multibarcode params option. Options: Single (default) or
Multibarcode (only available on BSP 04-14-xx and above).
Scan Params
Allows the configuration of Code ID and decode feedback options.
72
DataWedge
• Code ID Type - A Code ID character identifies the code type of a scanned bar code. This is useful when
the reader is decoding more than one code type. Select a code ID character to insert between the prefix
and the decoded symbol.
• Code ID Type None - No prefix (default)
• Code ID Type AIM - Insert AIM Character prefix.
• Code ID Type Symbol - Insert Symbol character prefix.
• BT Disconnect On Exit - Bluetooth connection is disconnected when data capture application is closed
(RS6000 only).
• Connection Idle Time - Set connection idle time. The Bluetooth connection disconnects after being idle
for set time (RS6000 only).
• Decode Haptic Feedback - Enable the device to vibrate upon a good decode (default - enabled).
• Display BT Address Barcode - Enable or disable displaying Bluetooth Address bar code if there is no
Bluetooth scanner being paired when application tries to enable the Bluetooth scanner (RS6000 only).
• Establish Connection Time - The timeout which the device will try to enable or reconnect to the Bluetooth
scanner when the Bluetooth scanner is not in the vicinity or not paired (RS6000 only).
• Audio Feedback Mode - Select good decode audio indication (RS6000 only).
• Local Audio Feedback - Good decode audio indication on the device only.
• Remote Audio Feedback - Good decode audio indication on Bluetooth scanner only.
• Both - Good decode audio indication on device and Bluetooth scanner.
• Disable - No good decode audio indication on either device or Bluetooth scanner (default).
• LED Feedback Mode - Select good decode LED indication (RS6000 only).
• Local LED Feedback - Good decode LED indication on device only.
• Remote LED Feedback - Good decode LED indication on Bluetooth scanner only.
• Both - Good decode LED indication on the device and Bluetooth scanner (default).
• Disable - No good decode LED indication on either the device or RS6000.
• Decode Audio Feedback - Select an audio tone to sound upon a good decode.
• Decoding LED Notification - Enable the device to light the red Data Capture LED when data capture is in
progress. (default - disabled).
• Decode Feedback LED Timer - Set the amount of time (in milliseconds) that the green Data Capture LED
stays lit after a good decode. (default - 75 msec.)
• Beep Volume Channel - Set the good decode beep to a system or other sound. This allows for
independent control of the good beep volume.
NOTE Not all ringtones are fully supported as decode tones and those of longer length may be truncated when used
as a decode tone. The recommendation is to test the selected tone for operation before deployment to a
customer site.
• Ringer - Set the good decode beep to the ringer sound.
• Music and Media - Set the good decode beep to the media sound.
• Alarms - Set the good decode beep to the alarm sound.
• Notifications - Set the good decode beep to the notification sound (default).
73
DataWedge
UDI Parameters
Not applicable.
Multibarcode params
Sets the number of barcodes that the device can read on a single scan. Options: 2 to 10. Must also enable Reader
Params > Scanning Modes > MultiBarcode option (only available on BSP 04-14-xx and above).
Keep Enabled on Suspend
Keep the Bluetooth scanner enabled after suspend (default - disabled).
Keystroke Output
Use to configure the Keystroke Output Plug-in for the profile.
• Enabled — Enables or disables this plug-in. A check in the checkbox indicates that the plug-in is enabled
(default - enabled).
• Action key character - Enables decoding of a special character embedded within a bar code data for use
in native Android applications. This feature is helpful when populating or executing a form.
• None - Action key character feature is disabled (default).
• Tab - Tab character code in a bar code is processed. When DataWedge detects this character code in
a bar code, move the focus to the next field.
• Line feed - Line feed character code in a bar code is processed. When DataWedge detects this
character code in a bar code, move the focus to the next field.
• Carriage return - Carriage return character code in a bar code is processed. When DataWedge
detects this character code in a bar code, move the focus to the next field.
• Inter Character Delay - used to set a delay (in ms) following the delivery of each character to the
application. This parameter is intended to help avoid issues that arise when data is dispatched too
quickly for an application to accept (default - 0). If experiencing errors in keystroke delivery, increase
this value in increments of 100 (to a maximum of 1000) until errors cease. Note: This parameter can
negatively effect application performance.
• Delay Multi byte character only - Set the amount of time (in milliseconds) of the inter character delay for
multi byte characters. (default - disabled.)
• Key event delay - Set the amount of time (in milliseconds) a delay for dispatching control characters as
keystrokes to the foreground application (default - 0).
• Data Formatting and Ordering - Applies when the Scanning mode in Barcode Input Reader Params is
set to MultiBarcode, which simultaneously acquires the number of barcodes (from 2 through 10) specified
in the corresponding reader parameter.
• UDI specific
• Send Tokens - Set to select the output format for UDI data. (default - disabled)
• Token Separator - Set to select a separator character. If no separator character is selected when
Send tokens is set to Barcodes and tokens, two instances of the same data are sent. (default none).
• Token order - Set to include or exclude Tokens from the output and adjust their output order.
• Multibarcode specific (SE2100 and SE4710 only and only available on BSP 04-14-xx and above).
• Barcode separator - Data from each barcode is otherwise concatenated and delivered as a
single string of keystrokes. Options: None (default), Tab, Line feed, or Carriage return.
74
DataWedge
• Advanced data formatting - is a way to customizing data before transmission. Use advanced data
formatting (ADF) to edit scan data to suit requirements.
• Enable - Enables or disables ADF. A check in the checkbox indicates that ADF is enabled (default -
disabled).
• Rules - ADF uses rules to customize data. These rules perform detailed actions when the data meets
certain criteria. One rule may consist of single or multiple criteria applied to single or multiple actions.
See Generating Advanced Data Formatting Rules on page 80 for more information.
• Basic data formatting - Allows the configuration of any data formatting for the related Output Plug-in.
When the plug-in is disabled, any data is passed on without modification.
• Enabled - Enables or disables Basic Data Formatting. A check in the checkbox indicates that it is
enabled (default - 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 (default - enabled).
• Send as hex - Set to send the data in hexadecimal format. A check in the checkbox indicates that the
plug-in is enabled (default - disabled).
• Send TAB key - Set to append a tab character to the end of the processed data. A check in the
checkbox indicates that the plug-in is enabled (default - disabled).
• Send ENTER key - Set to append an Enter character to the end of the processed data. A check in the
checkbox indicates that the plug-in is enabled (default - disabled).
Intent Output
Allows configuration of the Intent Output Plug-in for the profile. The Intent Output Plug-in allows the captured data
to be sent to an application in the form of an implicit Intent. Refer to the Android Developer web site for more
information, developer.android.com
• Enabled - Enables or disables this plug-in. A check in the checkbox indicates that the plug-in is enabled
(default - disabled).
• Intent action - Enter the Intent Action name (required).
• Intent category - Enter the Intent Category name (required).
• Intent delivery - Select the method by which the intent is delivered:
• Send via StartActivity
• Send via startService (default)
• Broadcast intent.
• Receiver foreground flag - Set flag in broadcast intent.
• Advanced data formatting - is a way to customizing data before transmission. Use advanced data
formatting (ADF) to edit scan data to suit requirements.
• Enable - Enables or disables ADF. A check in the checkbox indicates that ADF is enabled (default -
disabled).
• Rules - ADF uses rules to customize data. These rules perform detailed actions when the data meets
certain criteria. One rule may consist of single or multiple criteria applied to single or multiple actions.
See Generating Advanced Data Formatting Rules on page 80 for more information.
.
75
• Basic data formatting - Allows configuration of any data formatting for the related Output Plug-in. When
the plug-in is disabled any data is passed on without modification.
• Enabled - Enables or disables Basic Data Formatting. A check in the checkbox indicates that it is
enabled (default - 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 (default - enabled).
• Send as hex - Set to send the data in hexadecimal format. A check in the checkbox indicates that the
plug-in is enabled (default - disabled).
• Send TAB key - Set to append a tab character to the end of the processed data. A check in the
checkbox indicates that the plug-in is enabled (default - disabled).
• Send ENTER key - Set to append an Enter character to the end of the processed data. A check in the
checkbox indicates that the plug-in is enabled (default - disabled).
Intent Overview
DataWedge
The core components of an Android application (its activities, services, and broadcast receivers) are activated by
intents. An intent is a bundle of information (an Intent object) describing a desired action - including the data to be
acted upon, the category of component that should perform the action, and other pertinent instructions. Android
locates an appropriate component to respond to the intent, launches a new instance of the component if one is
needed, and passes it the Intent object.
Components advertise their capabilities, the kinds of intents they can respond to, through intent filters. Since the
system must learn which intents a component can handle before it launches the component, intent filters are
specified in the manifest as <intent-filter> elements. A component may have any number of filters, each one
describing a different capability. For example, if the manifest contains the following:
<intent-filter . . . >
<action android:name=”android.intent.action.DEFAULT” />
<category android:name=”android.intent.category.MAIN” />
</intent-filter>
In the Intent output plug-in configuration, the Intent action would be:
android.intent.category.DEFAULT
and the Intent category would be:
android.intent.category.MAIN.
The Intent delivery option allows the method by which the intent is delivered to be specified. The delivery
mechanisms are Send via startActivity, Send via startService or Broadcast intent.
The decode related data added to the Intent’s bundle can be retrieved using the
Intent.getSerializableExtra() calls, using the following String tags:
Intent.getStringExtra() and
• String LABEL_TYPE_TAG = “com.symbol.emdk.datawedge.label_type”;
• String contains the label type of the bar code.
76
DataWedge
• String DATA_STRING_TAG = “com.symbol.emdk.datawedge.data_string”;
• String contains the output data as a String. In the case of concatenated bar codes, the decode data is
concatenated and sent out as a single string.
• String DECODE_DATA_TAG = “com.symbol.emdk.datawedge.decode_data”;
• Decode data is returned as a list of byte arrays. In most cases there will be one byte array per decode.
For bar code symbologies that support concatenation e.g. Codabar, Code128, MicroPDF, etc., the
decoded data is stored in multiple byte arrays (one byte array per bar code). Clients can get data in
each byte array by passing an index.
Most scanning applications might want the user to be able to decode data and for that decode data to be sent to
the *current* activity but not necessarily displayed. If this is the case, then the activity needs to be marked as
‘singleTop’ in its AndroidManifest.xml file. If your activity is not defined as singleTop, then on every decode, the
system will create another copy of your Activity and send the decode data to this second copy.
Finally there will be a configuration option for each process plug-in so that the process plug-in can be configured
specifically for the intent output, which in this case is the basic data formatting process plug-in.
IP Output
NOTE IPWedge application is required on a host computer. Download the IPWedge application from the Support
Central web site: www.zebra.com/support.
IP Output allows DataWedge to send captured data to a host computer via a network connection. Captured data
can be sent over an IP network to a specified IP address and port using either TCP or UDP transport protocols.
• Enabled - Enables or disables this plug-in. A check in the checkbox indicates that the plug-in is enabled
(default - disabled).
• Remote Wedge - Enable or disable the Remote Wedge option (default - enabled). Remote Wedge is used
with the IPWedge application.
• Protocol - Select the protocol used by the remote application. Options: TCP (default) or UDP.
• IP address - Enter the IP address used by the remote application (default - 0.0.0.0).
• Port - Enter the port number used by the remote application (default - 58627).
• Token selection - Not applicable.
• Advanced data formatting - is a way of customizing data before transmission. Use advanced data
formatting (ADF) to edit scan data to suit requirements.
• Enable - Enables or disables ADF. A check in the checkbox indicates that ADF is enabled (default -
disabled).
• Rules - ADF uses rules to customize data. These rules perform detailed actions when the data meets
certain criteria. One rule may consist of single or multiple criteria applied to single or multiple actions.
See Generating Advanced Data Formatting Rules on page 80 for more information.
77
Usage
DataWedge
• Basic data formatting - Allows configuration of any data formatting for the related Output Plug-in. When
the plug-in is disabled any data is passed on without modification.
• Enabled - Enables or disables Basic Data Formatting. A check in the checkbox indicates that it is
enabled (default - 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 (default - enabled).
• Send as hex - Set to send the data in hexadecimal format. A check in the checkbox indicates that the
plug-in is enabled (default - disabled).
• Send TAB key - Set to append a tab character to the end of the processed data. A check in the
checkbox indicates that the plug-in is enabled (default - disabled).
• Send ENTER key - Set to append an Enter character to the end of the processed data. A check in the
checkbox indicates that the plug-in is enabled (default - disabled).
This section provides information on how to configure IP Output using the DataWedge configuration user interface.
To use IP Output in a particular DataWedge profile (for example: Profile0), scroll downward on IP Output.
Figure 61 IP Output Screen
Using IP Output with IPWedge
IPWedge is a computer application that can be easily configured to retrieve data sent over network by DataWedge
IP Output. Refer to the
Output to send captured data to a remote computer that is installed with IPWedge:
IPWedge User Manual
on how to install and configure in a host computer. To enable IP
1. In IP Output, touch Enabled.
A check appears in the checkbox.
2. Ensure Remote Wedge option is enabled.
3. Touch Protocol.
78
DataWedge
4. In the Choose protocol dialog box, touch the same protocol selected for the IPWedge computer application.
(TCP is the default).
Figure 62 Protocol Selection
5. Touch IP Address.
6. In the Enter IP Address dialog box, enter the IP address of host computer to send data to.
Figure 63 IP Address Entry
7. Touch Port.
8. In the Enter port number dialog box, enter same port number selected for IPWedge computer application.
Figure 64 Port Number Entry
9. Configure Advanced data formatting and Basic data formatting Plug-in if any required modification to be
done to captured data before sending to remote computer.
Using IP Output without IPWedge
IP Output Plug-in can be used to send captured data from DataWedge to a remote device or host computer without
using IPWedge. At the data receiving end, the host computer or mobile device should have an application, that
listens to TCP or UDP data coming from a configured port and IP address in the IP Output plug-in. To enable IP
Output to send captured data to a remote computer:
1. In IP Output, touch Enabled.
A check appears in the checkbox.
2. Ensure Remote Wedge option is disabled.
3. Touch Protocol.
79
DataWedge
4. In the Choose protocol dialog box, touch the same protocol selected in the client application. (TCP is the
default).
Figure 65 Protocol Selection
5. Touch IP Address.
6. In the Enter IP address dialog box, enter the IP address of host computer to send data to.
Figure 66 IP Address Entry
7. Touch Port.
8. In the Enter port number dialog box, enter the port number that the host computer application is listening on.
Figure 67 Port Number Entry
9. Configure Advanced Data Formatting and Basic Data Formatting Plug-in if any required modification to be
done to captured data before sending to remote computer.
Generating Advanced Data Formatting Rules
The ADF plug-in applies rules (actions to be performed based on defined criteria) to the data received via an input
plug-in before sending it to the output plug-in.
• Rules - The ADF process plug-in consists of one or more rules. DataWedge formats the output data
according to the first matching rule. A rule is a combination of criteria and a set of actions to be performed,
upon fulfillment of the criteria set in the rule.
• Criteria - Criteria can be set according to Input plug-in, symbology, matching string within the data (at the
specified position) and/or data length. Received data must match the defined criteria in order for the data
to be processed.
80
DataWedge
• Actions - A set of procedures defined to format data. There are four types of actions which are for
formatting cursor movement, data modification, data sending and delay specifications. An action can be
defined to send the first number of characters to the Output plug-in, pad the output data with spaces or
zeros, remove spaces in data, etc.
Configuring ADF Plug-in
Configuring the ADF plug-in consists of creating a rule, defining the criteria and defining the actions.
1. Swipe up from the bottom of the screen and touch .
2. Touch a DataWedge profile.
3. In Keystroke Output, touch Advanced data formatting.
Figure 68 Advanced Data Formatting Screen
4. Touch the Enable checkbox to enable ADF.
Creating a Rule
NOTE By default, Rule0, is the only rule in the Rules list.
1. Touch .
2. Touch New rule.
3. Touch the Enter rule name text box.
4. In the text box, enter a name for the new rule.
5. Touch OK.
Defining a Rule
1. Touch the newly created rule in the Rules list.
81
DataWedge
Figure 69 Rule List Screen
2. Touch the Rule enabled checkbox to enable the current rule.
Defining Criteria
1. Touch Criteria.
Figure 70 Criteria Screen
2. Touch String to check for option to specify the string that must be present in the data.
3. In the Enter the string to check for dialog box, enter the string.
4. Touch OK.
5. Touch String position option to specify the position of the string specified in the String to check for option.
The ADF rule is only applied if the specific string in String to check for is found at the specified String
position location (zero for the start of the string).
6. Touch the + or - to change the value.
7. Touch OK.
8. Touch String length option to specify a length for the received data. The ADF rule only applies to the bar
code data with that specified length.
9. Touch the + or - to change the value.
82
DataWedge
10. Touch OK.
11. Touch Source criteria option to associate an input device to an ADF rule. The ADF rule only applies to data
received from associated input devices.
12. Touch Barcode input. Options vary depending upon the device configuration.
13. Touch the Source enabled checkbox to accept data from this source.
Figure 71 Barcode Input Screen
14. For Barcode inputs, touch the All decoders enabled checkbox to select all bar code symbologies. Deselect
the All decoders enabled checkbox to individually select the symbologies.
15. Touch until the Rule screen appears.
16. If required, repeat steps to create another rule.
17. Touch until the Rule screen appears.
Defining an Action
NOTE By default the Send remaining action is in the Actions list.
1. Touch .
2. Touch New action.
3. In the New action menu, select an action to add to the Actions list. See Table 4 on page 85 for a list of
supported ADF actions.
4. Some Actions require additional information. Touch the Action to display additional information fields.
5. Repeat steps to create more actions.
6. Touch .
7. Touch .
Deleting a Rule
1. Touch and hold on a rule until the context menu appears.
2. Touch Delete to delete the rule from the Rules list.
83
DataWedge
NOTE When there is no rule available for ADF plug-in or all rules are disabled, DataWedge passes decoded data
to the output plug-in without processing the data.
Order Rules List
NOTE When there are no rules defined, ADF passes the captured data through as is. In contrast, when rules are
defined but all are disabled, ADF does not pass any captured data through.
Rules are processed in top-down order. The rules that are on top of the list are processed first. Use the icon next to
the rule to move it to another position in the list.
84
DataWedge
Table 4 ADF Supported Actions
Type Actions Description
Cursor
Movement
Data
Modification
Skip ahead Moves the cursor forward by a specified number of characters. Enter
the number of characters to move the cursor ahead.
Skip back Moves the cursor back by a specified number of characters. Enter the
number of characters to move the cursor back.
Skip to start Moves the cursor to the beginning of the data.
Move to Moves the cursor forward until the specified string is found. Enter the
string in the data field.
Move past a Moves the cursor forward past the specified string. Enter the string in
the data field.
Crunch spaces Remove spaces between words to one and remove all spaces at the
beginning and end of the data.
Stop space crunch Stops space crunching. This disables the last Crunch spaces action.
Remove all spaces Remove all spaces in the data.
Stop space removal Stop removing spaces. This disables the last Remove all spaces
action.
Remove leading zeros Remove all zeros at the beginning of data.
Stop zero removal Stop removing zeros at the beginning of data. This disables the
previous Remove leading zeros action.
Pad with zeros Left pad data with zeros to meet the specified length. Enter the
number zeros to pad.
Stop pad zeros Stop padding with zeros. This disables the previous Pad with zeros
action.
Pad with spaces Left pad data with spaces to meet the specified length. Enter the
number spaces to pad.
Stop pad spaces Stop padding with spaces. This disables the previous Pad with
spaces action.
Replace string Replaces a specified string with a new string. Enter the string to
replace and the string to replace it with.
Stop all replace string Stop all Replace string actions.
85
DataWedge
Table 4 ADF Supported Actions (Continued)
Type Actions Description
Data
Sending
Send next Sends the specified number of characters from the current cursor
position. Enter the number of characters to send.
Send remaining Sends all data that remains from the current cursor position.
Send up to Sends all data up to a specified string. Enter the string.
Send pause Pauses the specified number of milliseconds before continuing the
next action. Enter the amount of time in milliseconds.
Send string Sends a specified string. Enter the string to send.
Send char Sends a specified ASCII/ Unicode character. Enter a character value.
The maximum Unicode character value can be entered is U-10FFFF
(= 1114111 in decimal).
Deleting an Action
1. Touch and hold the action name.
2. Select Delete action from the context menu.
ADF Example
The following illustrates an example of creating Advanced Data Formatting:
When a user scans a bar code with the following criteria:
• Code 39 bar code.
• length of 12 characters.
• contains 129 at the start position.
Modify the data as follows:
• Pad all sends with zeros to length 8.
• send all data up to character X.
• send a space character.
To create an ADF rule for the above example:
1. Swipe up from the bottom of the screen and touch .
2. Touch Profile0.
3. Under Keystroke Output, touch Advanced data formatting.
4. Touch Enable.
5. Touch Rule0.
6. Touch Criteria.
7. Touch String to check for.
8. In the Enter the string to check for text box, enter 129 and then touch OK.
9. Touch String position.
10. Change the value to 0.
86
DataWedge
11. Touch OK.
12. Touch String length.
13. Change value to 12.
14. Touch OK.
15. Touch Source criteria.
16. Touch Barcode input.
17. Touch All decoders enabled to disable all decoders.
18. Touch Code 39.
19. Touch three times.
20. Touch Actions.
21. Touch and hold on the Send remaining rule until a menu appears.
22. Touch Delete action.
23. Touch .
24. Touch New action.
25. Select Pad with zeros.
26. Touch the Pad with zeros rule.
27. Touch How many.
28. Change value to 8 and then touch OK.
29. Touch .
30. Touch .
31. Touch New action.
32. Select Send up to.
33. Touch Send up to rule.
34. Touch String.
35. In the Enter a string text box, enter X.
36. Touch OK.
37. Touch .
38. Touch .
39. Touch New action.
40. Select Send char.
41. Touch Send char rule.
42. Touch Character code.
43. In the Enter character code text box, enter 32.
44. Touch OK.
45. Touch .
87
DataWedge
Figure 72 ADF Sample Screen
46. Ensure that an application is open on the device and a text field is in focus (text cursor in text field).
47. Aim the exit window at the bar code.
Figure 73 Sample Bar Code
48. Press and hold the scan key.
The red laser aiming pattern turns on to assist in aiming. Ensure that the bar code is within the area formed by
the aiming pattern.
49. The LED lights green, a beep sounds and the device vibrates, by default, to indicate the bar code was decoded
successfully. The formatted data 0000129 appears in the text field.
Scanning a Code 39 bar code of 1299X15598 does not transmit data (rule is ignored) because the bar code
data did not meet the length criteria.
88
Figure 74 Formatted Data
DataWedge Settings
DataWedge
The DataWedge Settings screen provides access to general, non-profile related options. Touch > Settings.
Figure 75 DataWedge Settings Window
• DataWedge enabled - Enables or disables DataWedge. To disable DataWedge uncheck this option.
• Enable logging - Enables or disables debug output file to logcat. To enable logging check this option.
• Import - allows import of a DataWedge configuration file. The imported configuration replaces the current
configuration.
• Export - allows export of the current DataWedge configuration.
• Import Profile - allows import of a DataWedge profile file.
• Export Profile - allows export of a DataWedge profile.
• Restore - return the current configuration back to factory defaults.
89
DataWedge
Importing a Configuration File
1. Copy the configuration file to the microSD card /Android/data/com.symbol.datawedge/files folder.
2. Swipe up from the bottom of the screen and touch .
3. Touch .
4. Touch Settings.
5. Touch Import.
6. Touch filename to import.
The configuration file (datawedge.db) is imported and replaces the current configuration.
Exporting a Configuration File
1. Swipe up from the bottom of the screen and touch .
2. Touch .
3. Touch Settings.
4. Touch Export.
5. In the Export to dialog box, select the location to save the file.
6. Touch Export. The configuration file (datawedge.db) is saved to the selected location.
Importing a Profile File
NOTE Do not change the filename of the of the profile file. If the filename is changed, the file will not be imported.
1. Copy the profile file to the On Device Storage /Android/data/com.symbol.datawedge folder.
2. Swipe up from the bottom of the screen and touch .
3. Touch .
4. Touch Settings.
5. Touch Import Profile.
6. Touch the profile file to import.
7. Touch Import. The profile file (dwprofile_x.db, where x = the name of the profile) is imported and appears in
the profile list.
Exporting a Profile
1. Swipe up from the bottom of the screen and touch .
2. Touch .
3. Touch Settings.
4. Touch Export Profile.
5. Touch the profile to export.
6. Touch Export.
The profile file (
dwprofile_x.db
, where x = name of the profile) is saved to the root of the On-device Storage.
90
DataWedge
Restoring DataWedge
To restore DataWedge to the factory default configuration:
1. Swipe up from the bottom of the screen and touch .
2. Touch .
3. Touch Settings.
4. Touch Restore.
5. Touch Yes.
Configuration and Profile File Management
The configuration or profile settings for DataWedge can be saved to a file for distribution to other devices.
After making configuration or profile changes, export the new configuration or profile to the root of the On-device
Storage. The configuration file created is automatically named
automatically named
Storage of other devices and imported into DataWedge on those devices. Importing a configuration or profile
replaces the existing settings.
dwprofile_x.db
, where x is the profile name. The files can then the copied to the On-device
datawedge.db
. The profile file created is
Enterprise Folder
Internal storage contains the Enterprise folder (/enterprise). The Enterprise folder is persistent and maintains
data after an Enterprise reset. After an Enterprise Reset, DataWedge checks folder
/enterprise/device/settings/datawedge/enterprisereset/for a configuration file,
file,
dwprofile_x.db
NOTE A Factory Reset deletes all files in the Enterprise folder.
. If the file is found, it imports the file to replace any existing configuration or profile.
datawedge.db
or a profile
Auto Import
DataWedge supports remote deployment of a configuration to a device, using tools such as MSP. DataWedge
monitors the
datawedge.db
(
or profile file is found, it imports the file to replace any existing configuration or profile. Once the file has been
imported it is deleted from the folder.
While DataWedge is running it receives a notification from the system that a file has been placed into the
/enterprise/device/settings/datawedge/autoimportfolder. When this occurs, DataWedge imports this new
configuration or profile, replacing the existing one and delete the file. DataWedge begins using the imported
configuration immediately.
/enterprise/device/settings/datawedge/autoimport folder for the DataWedge configuration file
) or a profile file (
dwprofile_x.db
). When DataWedge launches it checks the folder. If a configuration
NOTE A Factory Reset deletes all files in the Enterprise folder.
It is strongly recommended that the user exits DataWedge before remotely deploying any configuration or
profile. It is required that the file permissions are set to 666.
91
DataWedge
Programming Notes
The following paragraphs provide specific programming information when using DataWedge.
Overriding Trigger Key in an Application
To override the trigger key in an application, create a profile for the application that disables the Barcode input. In
the application, use standard APIs, such as onKeyDown() to listen for the KEYCODE_BUTTON_L1 and
KEYCODE_BUTTON_R1 presses.
Capture Data and Taking a Photo in the Same Application
To be able to capture bar code data and take a photo in the same application:
• Create a Datawedge profile pertaining to the picture taking Activity in your application that disables
scanning and use standard Android SDK APIs to control the Camera.
• The default Datawedge profile takes care of the scanning in the application. You might want to create
another DataWedge profile that caters to any specific scanning needs, associated to your Application's
Activity pertaining to scanning.
Disable DataWedge on Device and Mass Deploy
To disable DataWedge and deploy onto multiple devices:
1. Swipe up from the bottom of the screen and touch .
2. Touch .
3. Touch Settings.
4. Unselect the DataWedge enabled check box.
5. Export the DataWedge configuration. See Exporting a Configuration File on page 90 for instructions. See
Configuration and Profile File Management on page 91 for instructions for using the auto import feature.
Soft Scan Feature
DataWedge allows a native Android application to programmatically start, stop, or toggle the scan trigger state.
The application can issue an Android Broadcast Intent, to control the scanner, without requiring the scan key to be
pressed. The active DataWedge profile is required to control all the parameters during a scan operation.
The structure of the broadcast intent that resolves to the soft scan is:
action: “com.symbol.emdk.datawedge.api.ACTION_SOFTSCANTRIGGER”
extras: This is a String name/value pair that contains trigger state details.
name: “com.symbol.emdk.datawedge.api.EXTRA_PARAMETER”
value: “START_SCANNING” or “STOP_SCANNING” or “TOGGLE_SCANNING”
92
DataWedge
Sample
Intent sendIntent = new Intent();
sendIntent.setAction(“com.symbol.emdk.datawedge.api.ACTION_SOFTSCANTRIGGER”);
sendIntent.putExtra(“com.symbol.emdk.datawedge.api.EXTRA_PARAMETER”,
“TOGGLE_SCANNING”);
sendBroadcast(sendIntent);
Scanner Input Plugin
The ScannerInputPlugin API command can be used to enable/disable the scanner plug-in being used by the
currently active Profile. Disabling the scanner plug-in effectively disables scanning in that Profile, regardless of
whether the Profile is associated or unassociated. Valid only when Barcode Input is enabled in the active Profile.
NOTE Use of this API changes only the runtime status of the scanner; it does not make persistent changes to the
Profile.
Function Prototype
Intent i = new Intent();
i.setAction(ACTION);
i.putExtra(EXTRA_DATA, "<parameter>");
Parameters
action: String "com.symbol.datawedge.api.ACTION_SCANNERINPUTPLUGIN"
extra_data: String "com.symbol.datawedge.api.EXTRA_PARAMETER"
<parameter>: The parameter as a string, using either of the following:
• "ENABLE_PLUGIN" - enables the plug-in
• "DISABLE_PLUGIN" - disables the plug-in
Return Values
None.
Error and debug messages will be logged to the Android logging system which then can be viewed and filtered by
the logcat command. You can use logcat from an ADB shell to view the log messages, e.g.
$ adb logcat -s DWAPI
Error messages will be logged for invalid actions and parameters.
93
DataWedge
Example
// define action and data strings
String scannerInputPlugin = "com.symbol.datawedge.api.ACTION_SCANNERINPUTPLUGIN";
String extraData = "com.symbol.datawedge.api.EXTRA_PARAMETER";
public void onResume() {
// create the intent
Intent i = new Intent();
// set the action to perform
i.setAction(scannerInputPlugin);
// add additional info
i.putExtra(extraData, "DISABLE_PLUGIN");
// send the intent to DataWedge
context.this.sendBroadcast(i);
}
Comments
This Data Capture API intent allows the scanner plug-in for the current Profile to be enabled or disabled. For
example, activity A launches and uses the Data Capture API intent to switch to ProfileA in which the scanner
plug-in is enabled, then at some point it uses the Data Capture API to disable the scanner plug-in. Activity B is
launched. In DataWedge, ProfileB is associated with activity B. DataWedge switches to ProfileB. When activity A
comes back to the foreground, in the
switch back to ProfileA, then use the Data Capture API intent again to disable the scanner plug-in, to return back to
the state it was in.
NOTE Use of this API changes only the runtime status of the scanner; it does not make persistent changes to the
Profile.
The above assumes that ProfileA is not associated with any applications/activities, therefore when focus
switches back to activity A, DataWedge will not automatically switch to ProfileA therefore activity A must
switch back to ProfileA in its onResume method. Because DataWedge will automatically switch Profile
when an activity is pause d, it is recommended that this API function be called from the onResume method
of the activity.
onResume method, activity A needs to use the Data Capture API intent to
Enumerate Scanners
Use the enumerateScanners API command to get a list of scanners available on the device.
Function Prototype
Intent i = new Intent();
i.setAction(ACTION);
Parameters
action: String "com.symbol.datawedge.api.ACTION_ENUMERATESCANNERS"
94
DataWedge
Return Values
The enumerated list of scanners will be returned via a broadcast Intent. The broadcast Intent action is
"com.symbol.datawedge.api.ACTION_ENUMERATEDSCANNERLIST" and the list of scanners is returned as a
string array (see the example below).
Error and debug messages will be logged to the Android logging system which then can be viewed and filtered by
the logcat command. You can use logcat from an ADB shell to view the log messages, e.g.
$ adb logcat -s DWAPI
Error messages will be logged for invalid actions and parameters.
Example
// first send the intent to enumerate the available scanners on the device
// define action string
String enumerateScanners = "com.symbol.datawedge.api.ACTION_ENUMERATESCANNERS";
// create the intent
Intent i = new Intent();
// set the action to perform
i.setAction(enumerateScanners);
// send the intent to DataWedge
context.this.sendBroadcast(i);
// now we need to be able to receive the enumerate list of available scanners
String enumeratedList = "com.symbol.datawedge.api.ACTION_ENUMERATEDSCANNERLIST";
String KEY_ENUMERATEDSCANNERLIST = "DataWedgeAPI_KEY_ENUMERATEDSCANNERLIST";
// Create a filter for the broadcast intent
IntentFilter filter = new IntentFilter();
filter.addAction(enumeratedList);
registerReceiver(myBroadcastReceiver, filter);
// now we need a broadcast receiver
private BroadcastReceiver myBroadcastReceiver = new BroadcastReceiver() {
@Override
public void onReceive(Context context, Intent intent) {
String action = intent.getAction();
if (action.equals(enumeratedList)) {
Bundle b = intent.getExtras();
String[] scanner_list = b.getStringArray(KEY_ENUMERATEDSCANNERLIST);
}
}
};
95
DataWedge
Comments
The scanner and its parameters are set based on the currently active Profile.
Set Default Profile
Use the setDefaultProfile API function to set the specified Profile as the default Profile.
Default Profile Recap
Profile0 is the generic Profile used when there are no user created Profiles associated with an application.
Profile0 can be edited but cannot be associated with an application. That is, DataWedge allows manipulation of
plug-in settings for Profile0 but it does not allow assignment of a foreground application. This configuration allows
DataWedge to send output data to any foreground application other than applications associated with user-defined
Profiles when Profile0 is enabled.
Profile0 can be disabled to allow DataWedge to only send output data to those applications which are associated in
user-defined Profiles. For example, create a Profile associating a specific application, disable Profile0 and then
scan. DataWedge only sends data to the application specified in the user-created Profile. This adds additional
security to DataWedge enabling the sending of data only to specified applications.
Usage Scenario
A launcher application has a list of apps that a user can launch and that none of the listed apps has an associated
DataWedge Profile. Once the user has selected an app, the launcher needs to set the appropriate DataWedge
Profile for the selected app. This could be done by using
required Profile. Then when the user launches the selected app, DataWedge auto Profile switching switches to the
default Profile (which is now the required Profile for that app).
If, for some reason, the launched app has an associated DataWedge Profile then that will override the set default
Profile.
When control is returned to the launcher application,
Profile.
setDefaultProfile to set the default Profile to the
resetDefaultProfile can be used to reset the default
Function Prototype
Intent i = new Intent();
i.setAction(ACTION);
i.putExtra(EXTRA_DATA, "<profile name>");
Parameters
action: String "com.symbol.datawedge.api.ACTION_SETDEFAULTPROFILE"
extra_data: String "com.symbol.datawedge.api.EXTRA_PROFILENAME"
<profile name>: The Profile name to set as the default Profile as a string (case-sensitive).
Return Values
None.
Error and debug messages will be logged to the Android logging system which then can be viewed and filtered by
the logcat command. You can use logcat from an ADB shell to view the log messages, e.g.
96
DataWedge
$ adb logcat -s DWAPI
Error messages will be logged for invalid actions, parameters and failures (e.g. Profile not found or associated with
an application).
Example
// define action and data strings
String setDefaultProfile = "com.symbol.datawedge.api.ACTION_SETDEFAULTPROFILE";
String extraData = "com.symbol.datawedge.api.EXTRA_PROFILENAME";
public void onResume() {
// create the intent
Intent i = new Intent();
// set the action to perform
i.setAction(setDefaultProfile);
// add additional info
i.putExtra(extraData, "myProfile");
// send the intent to DataWedge
context.this.sendBroadcast(i);
}
Comments
The API command will have no effect if the specified Profile does not exist or if the specified Profile is already
associated with an application. DataWedge will automatically switch Profiles when the activity is paused, so it is
recommended that this API function be called from the onResume method of the activity.
Zebra recommends that this Profile be created to cater to all applications/activities that would otherwise default to
using Profile0. This will ensure that these applications/activities continue to work with a consistent configuration.
For example, let’s say that initially Profile0 is the default Profile using the camera as the barcode scanner. Using
the Browser application and scanning a barcode with the camera, DataWedge enters the data into the Browser.
Now launch an application that changes the default Profile to a Profile using the blockbuster as the barcode
scanner. When returning to the Browser application, since it is using the default Profile, scanning will now be via
the blockbuster not the camera as previously. To ensure that the Browser continues to use the camera as the
barcode scanner a Profile should be created and associated with the Browser that specifies the camera as the
barcode scanner.
97
DataWedge
Reset Default Profile
Use the resetDefaultProfile API function to reset the default Profile back to Profile0.
Function Prototype
Intent i = new Intent();
i.setAction(ACTION);
i.putExtra(EXTRA_DATA, "<Profile name>");
Parameters
action: String "com.symbol.datawedge.api.ACTION_RESETDEFAULTPROFILE"
extra_data: String "com.symbol.datawedge.api.EXTRA_PROFILENAME"
<Profile name>: The Profile name to set as the default Profile as a string (case-sensitive).
Return Values
None.
Error and debug messages will be logged to the Android logging system which then can be viewed and filtered by
the logcat command. You can use logcat from an ADB shell to view the log messages, e.g.
$ adb logcat -s DWAPI
Error messages will be logged for invalid actions, parameters and failures (e.g. Profile not found or associated with
an application).
Example
// define action string
String resetDefaultProfile = "com.symbol.datawedge.api.ACTION_RESETDEFAULTPROFILE";
public void onResume() {
// create the intent
Intent i = new Intent();
// set the action to perform
i.setAction(resetDefaultProfile);
context.this.sendBroadcast(i);
}
Comments
None.
98
DataWedge
Switch To Profile
Use the SwitchToProfile API action to switch to the specified Profile.
Profiles Recap
DataWedge is based on Profiles and plug-ins. A Profile contains information on how DataWedge should behave
with different applications.
Profile information consists of:
• Associated application
• Input plug-in configurations
• Output plug-in configurations
• Process plug-in configurations
DataWedge includes a default Profile, Profile0, that is created automatically the first time DataWedge runs.
Using Profiles, each application can have a specific DataWedge configuration. For example, each user application
can have a Profile which outputs scanned data in the required format when that application comes to the
foreground. DataWedge can be configured to process the same set of captured data differently based on the
requirements of each application.
NOTE Use of this API changes only the runtime status of the scanner; it does not make persistent changes to the
Profile.
NOTE
A single Profile may be associated with one or many activities/apps, however, given an activity, only one Profile
may be associated with it.
Usage Scenario
An application has two activities. Activity A only requires EAN13 bar codes to be scanned. Activity B only requires
MSR card data. Profile B is configured to only scan EAN13 bar codes and is left unassociated. Profile M is
configured to only accept MSR input and is left unassociated. When Activity A launches it uses SwitchToProfile to
activate Profile B. Similarly, when Activity B launches it uses switchToProfile to activate Profile M.
If another activity/app comes to the foreground, DataWedge auto Profile switching will set the DataWedge Profile
accordingly either to the default Profile or to an associated Profile.
When Activity A (or Activity B) comes back to the foreground it will use switchToProfile to reset the Profile back to
Profile B (or Profile M).
Function Prototype
Intent i = new Intent();
i.setAction(ACTION);
i.putExtra(EXTRA_DATA, "<profile name>");
Parameters
action: String "com.symbol.datawedge.api.ACTION_SWITCHTOPROFILE"
extra_data: String "com.symbol.datawedge.api.EXTRA_PROFILENAME"
99
DataWedge
<profile name>: The Profile name to switch to as a string (case-sensitive).
Return Values
None.
Error and debug messages will be logged to the Android logging system which then can be viewed and filtered by
the logcat command. You can use logcat from an ADB shell to view the log messages, e.g.
$ adb logcat -s DWAPI
Error messages will be logged for invalid actions, parameters and failures (e.g. Profile not found or associated with
an application).
Example
// define action and data strings
String switchToProfile = "com.symbol.datawedge.api.ACTION_SWITCHTOPROFILE";
String extraData = "com.symbol.datawedge.api.EXTRA_PROFILENAME";
public void onResume() {
super.onResume();
// create the intent
Intent i = new Intent();
// set the action to perform
i.setAction(switchToProfile);
// add additional info
i.putExtra(extraData, "myProfile");
// send the intent to DataWedge
context.this.sendBroadcast(i);
}
Comments
This API function will have no effect if the specified Profile does not exist or is already associated with an
application.
DataWedge has a one-to-one relationship between Profiles and activities; a Profile can be associated only with a
single activity. When a Profile is first created, it's not associated with any application, and will not be activated until
associated. This makes it possible to create multiple unassociated Profiles.
This API function activates such Profiles.
For example, Profile A is unassociated and Profile B is associated with activity B. If activity A is launched and uses
SwitchToProfile function to switch to Profile A, then Profile A will be active whenever activity A is in the
foreground. When activity B comes to the foreground, DataWedge will automatically switch to Profile B.
When activity A returns to the foreground, the app must use
This would be done in the
onResume method of activity A.
SwitchToProfile again to switch back to Profile A.
100
Loading...