SOFTWARE DECODE SDK FOR ANDROID DEVELOPER GUIDE SOFTWARE DECODE SDK FOR ANDROID DEVELOPER GUIDE 72E-162670-06 Revision A November 2016 ii Software Decode SDK for Android Developer Guide No part of this publication may be reproduced or used in any form, or by any electrical or mechanical means, without permission in writing from Zebra. This includes electronic or mechanical means, such as photocopying, recording, or information storage and retrieval systems. The material in this manual is subject to change without notice. The software is provided strictly on an “as is” basis. All software, including firmware, furnished to the user is on a licensed basis. Zebra grants to the user a non-transferable and non-exclusive license to use each software or firmware program delivered hereunder (licensed program). Except as noted below, such license may not be assigned, sublicensed, or otherwise transferred by the user without prior written consent of Zebra. No right to copy a licensed program in whole or in part is granted, except as permitted under copyright law. The user shall not modify, merge, or incorporate any form or portion of a licensed program with other program material, create a derivative work from a licensed program, or use a licensed program in a network without written permission from Zebra. The user agrees to maintain Zebra’s copyright notice on the licensed programs delivered hereunder, and to include the same on any authorized copies it makes, in whole or in part. The user agrees not to decompile, disassemble, decode, or reverse engineer any licensed program delivered to the user or any portion thereof. Zebra reserves the right to make changes to any software or product to improve reliability, function, or design. Zebra does not assume any product liability arising out of, or in connection with, the application or use of any product, circuit, or application described herein. No license is granted, either expressly or by implication, estoppel, or otherwise under any Zebra Technologies Corp. intellectual property rights. An implied license only exists for equipment, circuits, and subsystems contained in Zebra products. Portions of this software are based in part on the work of the Independent JPEG Group. Zebra Technologies Corporation Lincolnshire, IL U.S.A. http://www.zebra.com Warranty For the complete hardware product warranty statement, go to: http://www.zebra.com/warranty. iii Revision History Changes to the original manual are listed below: Change Date Description -01 Rev A 7/2012 Initial release -02 Rev A 11/2013 • Added support for the SE4750 engine • Updated Theory of Operation • Updated Software Installation and Setting Up Build Environment sections • Added Enabling and Disabling All Symbologies, Get Decode Count, and Get Last Decoded Image • Added following parameters: Mobile Phone/Display Mode, Multi Decode Mode, Bar Codes to Read, Full Read Mode, Illumination Power Level, Video Scaling, Retrieve Last Decoded Image, Han Xin, and Han Xin Inverse • Updated Sample Application section • Added Signature Capture Code appendix -03 Rev A 7/2014 • Added support for the SE4710 engine • Updated processors and operating systems supported • Updated Software Decode SDK File Listing • Updated Video Capture section • Added Engine Interface configuration key • Added Fuzzy 1D parameter • Updated following parameters: Image Cropping, Signature Capture Width, Video Scaling • Added Any Length option to Set Lengths for I 2 of 5 • Added I 2 of 5 Security parameter -04 Rev A 2/2015 • Rebranded • Added Ignore Code 128 <FNC4> • Added Quiet Zone parameters -05 Rev A 3/2016 • Updated configuration file location information • Removed Note from Composite CC-C parameter • Added OCR chapter -06 Rev A 11/2016 • Added Notes regarding SE2100 support of parameters iv Software Decode SDK for Android Developer Guide TABLE OF CONTENTS About This Guide Introduction ..................................................................................................................................... xi Chapter Descriptions ...................................................................................................................... xi Notational Conventions................................................................................................................... xii Related Documents ........................................................................................................................ xii Service Information......................................................................................................................... xiii Chapter 1: Getting Started Introduction .................................................................................................................................... 1-1 Theory of Operation ....................................................................................................................... 1-2 Supported Symbologies ................................................................................................................. 1-3 Operating Modes ........................................................................................................................... 1-3 System Requirements .................................................................................................................... 1-4 Software Installation ....................................................................................................................... 1-5 Software Decode SDK File Listing ........................................................................................... 1-5 Setting Up the Build Environment .................................................................................................. 1-10 Chapter 2: Software Decode Library Operation Introduction .................................................................................................................................... 2-1 Initialization .................................................................................................................................... 2-1 Scanner Connection and Setup ..................................................................................................... 2-1 Properties and Parameters ............................................................................................................ 2-2 Image Frame Management ............................................................................................................ 2-3 Bar Code Decoding ........................................................................................................................ 2-4 Snapshot Capture .......................................................................................................................... 2-5 Video Capture ................................................................................................................................ 2-5 Enabling all Symbologies ............................................................................................................... 2-5 Disabling all Symbologies .............................................................................................................. 2-5 Get Decode Count ......................................................................................................................... 2-5 Get Last Decoded Image ............................................................................................................... 2-5 Shutdown ....................................................................................................................................... 2-5 vi Software Decode SDK for Android Developer Guide Chapter 3: Software Decode Library API Introduction .................................................................................................................................... 3-1 Configuration ................................................................................................................................. 3-1 sdl.conf Sample File ................................................................................................................. 3-2 Chapter 4: User and Imaging Parameters Introduction .................................................................................................................................... 4-1 User and Imaging Parameter Defaults .......................................................................................... 4-1 User Preferences ........................................................................................................................... 4-3 Trigger Mode ............................................................................................................................ 4-3 Picklist Mode ............................................................................................................................ 4-3 Decode Session Timeout ......................................................................................................... 4-3 Timeout Between Decodes, Same Symbol ............................................................................. 4-4 Transmit Code ID Character .................................................................................................... 4-4 Transmit “No Read” Message .................................................................................................. 4-4 Fuzzy 1D Processing ..............................................................................................................