CipherLab RK25 User manual

Android Programming
for RK25/RS30/RS31/RS50/RS51/9700A
Mobile Computers
Version 1.13

- 2 -
Copyright © 2015 ~ 2019 CIPHERLAB CO., LTD.
All rights reserved
The software contains proprietary information of CIPHERLAB CO., LTD.; it is provided under
a license agreement containing restrictions on use and disclosure and is also protected by
copyright law. Reverse engineering of the software is prohibited.
Due to continued product development this information may change without notice. The
information and intellectual property contained herein is confidential between CIPHERLAB
and the client and remains the exclusive property of CIPHERLAB CO., LTD. If you find any
problems in the documentation, please report them to us in writing. CIPHERLAB does not
warrant that this document is error-free.
No part of this publication may be reproduced, stored in a retrieval system, or transmitted
in any form or by any means, electronic, mechanical, photocopying, recording or otherwise
without the prior written permission of CIPHERLAB CO., LTD.
For product consultancy and technical support, please contact your local sales
representative. Also, you may visit our web site for more information.
The CipherLab logo is a registered trademark of CIPHERLAB CO., LTD.
Other product name mentioned in this manual may be trademarks or registered trademarks
of their respective companies and are hereby acknowledged.
The editorial use of these names is for identification as well as to the benefit of the owners,
with no intention of infringement.
CIPHERLAB CO., LTD.
Website: http://www.cipherlab.com

- 3 -
Version
Date
Notes
1.13 Apr. 08, 2019 RS51 supported
1.12 Sep. 10, 2018 New: Appendix IV ADC Profile Deployment
1.11 Jun. 07, 2018 Modified: 1.5.1 Preferences – triggerPresentationModeTrigger
added to Get_UserPreferences/Set_UserPreferences
Modified: 1.5.1 Preferences – descriptions for RK25 series not
supporting Presentation Mode added to the Get_UserPreferences
Remarks item
Modified: 1.5.2 Symbology Settings – "SecurityLevel
securitylevel;" added to Interleaved2Of5 for Get_Symbology
Modified: 1.5.2 Symbology Settings – “int length1” & “int
length2” added to Code128
Modified: 1.5.2 Symbology Settings – “int securityLevel” added
to GS1 DataBar14 & GS1 DataBarExpanded
Modified: 1.5.9 Code128 Class – “int length1” & “int length2”
added
Modified: 1.5.14 Interleaved2Of5 Class – “public SecurityLevel
securityLevel;” added
Modified: 1.5.18 GS1DataBarLimited Class – note for
converToUpcEan
Modified: 1.5.19 GS1DataBarExpanded Class – note for
securityLevel
Modified: 1.5. 22 Ean 13 Class – note for transmitCheckDigit
Modified: 1.5.25 UpcE1 Class – note for transmitCheckDigit
Modified: Appendix II Scan Engine Settings: Configure
Symbology Properties – securityLevel of Interleaved2Of5
appended for SE4500/SE4750SR/SE4750MR
Modified: Appendix II Scan Engine Settings: Symbologies
Supported – symbologies updated
1.10 Oct. 16, 2017 New: Chapter 3 OS Update
New: 1.3.4 Reader Firmware Version
Modified: 1.5.1 – AimerMode aimerMode, Enable_State
centerDecoding, int centerDecodingTolerance added to
Get_UserPreferences & Set_UserPreferences
Modified: 1.5.2 – “securityLevel” added to Code128 in
Get_Symbology
Modified: 1.5.9 – “Code128SecurityLevel securitylevel” added to
Code128
1.09 Jun. 16, 2017 Modified: Chapter 1 – Library location added
1.08 Jun. 02, 2017 Modified: 1.2.3 Reader Type – return values updated
Modified: 1.5.1 – add timeoutBetweenSameSymbology range
(0~2550) of UserPreferences for EX25
New: 1.5.41 Telepen Class
New: 1.5.42 Plessey Class
 Modified: Appendix II Scane Engine Settings: tables updated
RELEASE NOTES

- 4 -
1.07 Apr. 12, 2017 Modified: 1.5.1 – change “InverseType.Autodetect” to
“InverseType.AutoDetect” (Get_UserPreferences)
Modified: 1.5.1 – Continuous and Presentation modes for
timeoutBetweenSameSymbology
Modified: 1.5.1 – Replace “0x06” with
“InterCharacterGapSize.Normal” of Get_UserPreferences
Modified: 1.5.1 – Replace “0x0A” with
“InterCharacterGapSize.Large” of Get_UserPreferences
Modified: 1.5.1 – IlluminationPowerLevel added to
Get_UserPreferences & Set_UserPreferences
Modified: 1.5.3 – parameter names of notisEditingType changed
Modified: 1.5.14 – description for transmitCheckDigit
Modified: 1.5.36 – descriptions for MatrixMirrorImage
New: 1.7.6. Physical Scan Button Simulation
New: 1.8 Callback
1.06 Nov. 04, 2016 New: 1.7 Intent
New: Appendix V Open Source License
1.05 Oct. 14, 2016 Modified: Development Tool – Xamarin appended
Modified: Chapter 1 – Barcodeapi_vx_x_xx.dll added
New: 1.1.3 Xamarin for Visual Studio 2015
New: 1.3.3 Reader API Version
Modified: 1.5.1 – TriggerType.PresentationMode added to
GetUserPreferences
Modified: 1.5.1 – “public int timeoutPresentationMode” added to
GetUserPreferences and SetUserPreferences
Modified: 1.5.10 GS1128 Class – application ID added
Modified: 1.5.17 GS1DataBar14 Class – “
public int
securityLevel” added
Modified: 1.5.19 GS1DataBarExpanded Class – “public int
securityLevel” added
1.04 May 24, 2016 Modified: 1.5.5 Code39 Class – convertToCode32 changed to
“False” by default
Modified: 1.5.6 TriopticCode39 Class – changed to “False” by
default
Modified: 1.5.9 GS1DataBarExpanded Class – “fieldSeparator”
corrected
Modified: Data type of all “fieldSeparator” class members changed
from ‘char’ to ‘String’
Modified: Appendix II: remove “MacroPDF” from Supported
Symbologies
1.03 Feb. 02, 2016 Modified: 1.3.1 Get_ReaderOutputConfiguration – add
szCharsetName and clearPreviousData parameters
Modified: 1.3.1 Set_ReaderOutputConfiguration - add
szCharsetName and clearPreviousData parameters
Modified: 1.5.3 Codabar Class – “Start/Stop characters”
description for notisEditingType added
Modified: 1.5.3 Codabar Class – notisEditing marked as
“Reserved”
New: Appendix III – Code Type & Symbology
1.02 Oct. 26, 2015 1.5.3 Codabar Class – notes for Modulo_7DR of verifyCheckDigit
added

- 5 -
1.01 Oct. 12, 2015 1.3.1 Get_ReaderOutputConfiguration - replace Enable_State
with KeyboardEmulationType
1.3.1 Set_ReaderOutputConfiguration - replace Enable_State
with KeyboardEmulationType
1.5.1 Get_UserPreferences - TriggerType.PulseMode,
BlinkingMode, HostMode, PresentationMode removed
1.5.2 Get_Symbology - Codabar, GS1DataBarLimited updated
1.5.3 - Codabar Class updated
1.5.18 - GS1DatabarLimited Class updated
Appendix III - Sample Code updated
1.00 Jul. 14, 2015 First Release

- 6 -
CONTENTS
RELEASE NOTES
....................................................................................................................- 3 -
INTRODUCTION
........................................................................................................................ 1
Development Tool....................................................................................................................... 2
BARCODE READER API
......................................................................................................... 3
1.1. Import Library..................................................................................................... 4
1.1.1 Android Studio .................................................................................................... 4
1.1.2 Eclipse.................................................................................................................... 7
1.1.3 Xamarin for Visual Studio 2015.................................................................11
1.2. Initialize/Identify Reader..............................................................................14
1.2.1. Initialization .......................................................................................................14
1.2.2. Active Device.....................................................................................................15
1.2.3. Reader Type.......................................................................................................16
1.3. Obtain Data........................................................................................................17
1.3.1. Data Output Settings......................................................................................17
1.3.2. Reader Service Version .................................................................................23
1.3.3. Reader API Version.........................................................................................23
1.3.4. Reader Firmware Version .............................................................................23
1.4. Manipulate Status Indication.......................................................................24
1.4.1. Notification Settings........................................................................................24
1.5. Configure Scan Engine...................................................................................26
1.5.1.Preferences.........................................................................................................26
1.5.2. Symbology Settings........................................................................................35
1.5.3. Codabar Class....................................................................................................42
1.5.4. Code11 Class.....................................................................................................43
1.5.5. Code39 Class.....................................................................................................44
1.5.6. TriopticCode39 Class......................................................................................45
1.5.7. Korean3Of5 Class ............................................................................................45
1.5.8. Code93 Class.....................................................................................................45
1.5.9. Code128 Class...................................................................................................46
1.5.10. GS1128 Class....................................................................................................47
1.5.11. ISBT128 Class...................................................................................................47
1.5.12. Chinese2Of5 Class...........................................................................................48
1.5.13. Industrial2Of5 Class .......................................................................................48
1.5.14. Interleaved2Of5 Class....................................................................................49
1.5.15. Matrix2Of5 Class..............................................................................................50
1.5.16. UccCoupon Class..............................................................................................51
1.5.17. GS1DataBar14 Class.......................................................................................51
1.5.18. GS1DataBarLimited Class.............................................................................52
1.5.19. GS1DataBarExpanded Class........................................................................52
1.5.20. Msi Class..............................................................................................................53
1.5.21. Ean8 Class..........................................................................................................54
1.5.22. Ean13 Class........................................................................................................55

- 7 -
1.5.23. UpcA Class..........................................................................................................56
1.5.24. UpcE Class..........................................................................................................57
1.5.25. UpcE1 Class........................................................................................................58
1.5.26. Composite Class...............................................................................................59
1.5.27. USPostal Class...................................................................................................60
1.5.28. UKPostal Class...................................................................................................60
1.5.29. JapanPostal Class.............................................................................................61
1.5.30. AustralianPostal Class....................................................................................61
1.5.31. DutchPostal Class ............................................................................................61
1.5.32. USPSPostal Class .............................................................................................62
1.5.33. UPUFICSPostal Class.......................................................................................62
1.5.34. PDF417 Class.....................................................................................................62
1.5.35. MicroPDF417 Class..........................................................................................63
1.5.36. DataMatrix Class ..............................................................................................63
1.5.37. MaxiCode Class.................................................................................................64
1.5.38. QRCode Class....................................................................................................64
1.5.39. MicroQR Class....................................................................................................64
1.5.40. Aztec Class .........................................................................................................65
1.5.41. Telepen Class ....................................................................................................65
1.5.42. Plessey Class .....................................................................................................66
1.6. Reset Reader.....................................................................................................67
1.7. Intent....................................................................................................................68
1.7.1. Reader Service Connection..........................................................................68
1.7.2. Software Trigger ..............................................................................................68
1.7.3. Hardware Scan Key.........................................................................................68
1.7.4. Decoding Error..................................................................................................69
1.7.5. Data Sending.....................................................................................................69
1.7.6. Physical Scan Button Simulation ...............................................................69
1.8. Callback...............................................................................................................70
1.8.1. SetReaderCallback...........................................................................................70
1.8.2. GetReaderCallback..........................................................................................70
1.8.3. Sample Code......................................................................................................70
SAM API
..................................................................................................................................... 73
2.1 Bind SAM Service.............................................................................................74
2.2 Service Information........................................................................................75
OS UPDATE
............................................................................................................................... 77
3.1 OS Update Intent...............................................................................................................78
3.1.1. OS Update Architecture.................................................................................78
3.1.2. Launch OS Update with Intent...................................................................79
3.1.3. Get Error Message with Broadcast............................................................80
3.1.4. OS Update Result.............................................................................................81
3.1.5. Sample Code......................................................................................................82

RESPONSE CODE INSTRUCTIONS
................................................................................. 85
SCAN ENGINE SETTINGS
................................................................................................... 87
Symbologies Supported..........................................................................................................88
Configurable Symbology Properties...................................................................................90
CODE TYPE & SYMBOLOGY
............................................................................................... 95
ADC PROFILE DEPLOYMENT
............................................................................................. 99
General Deployment.................................................................................................................99
Deployment for Barcode Reader, AppLock, Terminal Emulation............................99
Deployment for File Transfer ..............................................................................................100
Deployment for AutoInstallation........................................................................................100
Deployment for System Settings ......................................................................................101
Setting ADC ...............................................................................................................................102
SAMPLE CODE
........................................................................................................................103
OPEN SOURCE LICENSE
....................................................................................................105

1
This Programming Guide contains necessary information for building Android applications
that can tune reader module(s), capture data, or control built-in hardware on CipherLab
mobile computers, which are powered by Android.
Android Framework makes it easy to create such applications. Simply import the
prospective Android component (Android Class Library) to your Android application to make
your way to build it.
We recommend that you read the documents thoroughly before use and keep them at hand
for quick reference.
Thank you for choosing CipherLab products!
INTRODUCTION

2
Android Programming Guide
DEVELOPMENT TOOL
Before developing Android applications, programmers are supposed to make their machine
ready with the requirements as follows:
Java SE Development Kit (JDK, Java SE 7 or greater is recommended)
Android SDK
Android Studio, Eclipse IDE, or Xamarin for Visual Studio
Visual Studio 2015 (a must while using Xamarin)
The software tools listed above are free and can be downloaded from their official websites
respectively. Programmers are assumed to possess Android programming knowledge.

3
Before developing your self-made application, the offered “barcodeapi_vx_x_xx.jar” or
“barcodeapi_vx_x_xx.dll” library file has to be imported into your project.
Library Required
Location
Barcodeapi_vx_x_xx.jar (for Android Studio or Eclipse)
Barcodeapi_vx_x_xx.dll (for Xamarin) /sdcard/ReaderService_data
IN THIS CHAPTER
1.1 Import Library..............................................................4
1.2 Initialize/Identify Reader.............................................. 14
1.3 Obtain Data................................................................ 17
1.4 Manipulate Status Indication ........................................ 24
1.5 Configure Scan Engine................................................. 26
1.6 Reset Reader.............................................................. 67
1.7 Intent........................................................................ 68
1.8 Callback..................................................................... 70
Chapter 1
BARCODE READER API

4
Android Programming Guide
1.1.
IMPORT LIBRARY
1.1.1
ANDROID STUDIO
1) After creating an Android Studio project, click the Android project view icon to switch to
the Traditional project view.
Android project view Traditional project view
2) Locate the offered “barcodeapi.jar” library file in your file system and copy it.
3) Right-click on the libs folder in the project view, and then select Paste.

5
Chapter 1 Barcode Reader API
4) A dialog shows up indicating the file name and the destination directory to be copied.
Click the OK button to start importing the library file.
5) In the project view, you can see the library is imported.
If you don’t see any files listed under the barcodeapi.jar item, please click the Sync
Project with Gradle Files button from the toolbar.

6
Android Programming Guide
After the project sync completes, the files relating to the library will be displayed.
6) Finally, import the packages by manually typing statements as follows to finish the
library import process:
import com.cipherlab.barcode.*;
import com.cipherlab.barcodebase.*;
import com.cipherlab.barcode.decoder.*;
import com.cipherlab.barcode.decoderparams.*;

7
Chapter 1 Barcode Reader API
1.1.2
ECLIPSE
Have the library file (barcodeapi.jar) be ready on the file system. And then follow the
instructions below:
1) In the Project Explorer view, right-click the libs folder in your Android project and
then select Import.
2) With the Import dialog showing up, select General -> File System and click the Next
button.

8
Android Programming Guide
3) Click the Browse button to locate the library file.
4) For example, “D:\Import Library” is the destination directory where the library file is
located. Check the .JAR file in the right pane and click the Finish button. You will see the
library has been imported into your project.

9
Chapter 1 Barcode Reader API
5) If the library is not on your build path, please right-click on the project name and then
select Build Path -> Configure Build Path on the pop-up menu.
6) After the project properties window shows up, click the Libraries tab and then click the
Add JARs button.

10
Android Programming Guide
7) Select the JAR file you’ve just imported. Click the OK button.
8) Now the library is on the build path.

11
Chapter 1 Barcode Reader API
1.1.3
XAMARIN FOR VISUAL STUDIO 2015
1) Download Xamarin from http://store.xamarin.com and install it.
2) Open Visual Studio on your PC to create a new project.
3) Select File New Project and then choose the C# Windows Android 
Blank APP (Android) project template.
4) Copy the offered “barcodeapi_vx_x_xx.dll” library file to the new project folder.

12
Android Programming Guide
5) In the right pane of Visual Studio, right-click on References and then select Add
Reference under the name of the new project.
6) In the Reference Manager dialog, click Browse in the left pane and then click the
Browse button to locate the library file. When the “barcodeapi_vx_x_xx.dll” file is
selected in the file browser dialog, click the Add button. Now check the added file and
click the OK button.