Transcript
AUTOID9 Android SDK User Guide
www.seuic.com Jiangsu Seuic Technology Co.,Ltd
Page 1 totally 9 pages
Amendment Records Version 0.0
Content
Staff
0.1
Doc establishment keypad、touch interface description
Qianjin
0.2
Model Standardization
Liangwei
1.0
Add new package user and touch guide
Liangwei
1.1
Update new touch interface guide Update misc interface
Zhangsong
Qiyun
Cataloge Summary Fout! Bladwijzer niet gedefinieerd. Software platform Fout! Bladwijzer niet gedefinieerd. Target users Fout! Bladwijzer niet gedefinieerd. System package use 3 Touch Screen Interface Fout! Bladwijzer niet gedefinieerd. TouchService Class 4 Use Method Fout! Bladwijzer niet gedefinieerd. Function Port Fout! Bladwijzer niet gedefinieerd. 1. Get current glove mode status 4 2. Set current glove mode status Fout! Bladwijzer niet gedefinieerd. 3. Get touch screen enable status Fout! Bladwijzer niet gedefinieerd. 4. Set touch screen enable status Fout! Bladwijzer niet gedefinieerd. 5. Get virtual key disabled status Fout! Bladwijzer niet gedefinieerd. 6. Set virtual key disabled status Fout! Bladwijzer niet gedefinieerd. Keypad Interface Fout! Bladwijzer niet gedefinieerd. KeypadService Class 7 Use Method Fout! Bladwijzer niet gedefinieerd. Function Port Fout! Bladwijzer niet gedefinieerd. 1. Get Keypad Mode Fout! Bladwijzer niet gedefinieerd. 2. Set Keypad Mode Fout! Bladwijzer niet gedefinieerd. Misc Interface 9 Misc Class 9 Use Method Fout! Bladwijzer niet gedefinieerd. Function Port Fout! Bladwijzer niet gedefinieerd. 1. Get Device SN 9
Jiangsu Seuic Technology Co.,Ltd
Page 2 totally 9 pages
Summary This document introduces AUTOID9 provided device related SDK package user guide to help end users better use special functions of the device AUTOID9.
Software Platform SDK is based on Android 4.3 version and support eclipse development kits.
Target Users Except Android standard functions the developers who want to use additional functions of the device. These additional functions include 1D and 2D scanning, keypad special setting as well as special touch setting etc.
System Package Use If interface indicates system package,it means the package is built in the system and no need to include package into apk.Below is an example of keypad interface to demonstrate how to use system package/library in eclipse. 1.
Build libsref directory(directory could be named of any appointed) under project directory, copy keypad.jar into this directory.
2.
Select project in eclips, choose Project - Properties - Java Build Path in the menu, click button of Add External JARS…,select keypad.jar. User could find just invoked keypad.jar in the Referenced Libraries of project view and see all of keypad.jar provided packages, classses, functions, variables.
3.
In AndroidManifest.xml it adopt “uses-library” to mark library pack of keypad.jar is an invoked library.
……
Jiangsu Seuic Technology Co.,Ltd
Page 3 totally 9 pages
Touch Interface Library name
com.seuic.touch
Library File
touch.jar
System Library
Yes
Class included
TouchService
Function
To provide touch control interfaces
TouchService Class Application Method import com.seuic.touch.TouchService; TouchService touch = TouchService.getInstance();
Function Interface Function
Explain
getGloveMode
get current glove mode status(open or close)
setGloveMode
Set glove mode (open or close)
getTouchEnabled
get touch screen enable status
setTouchEnabled
set touch screen enable status
getVirKeyDisabled
get virtual key disabled status
setVirKeyDisabled
set virtual key disabled status
1. Get current glove mode status(open or close) int getGloveMode() Parameter None Return Value Include below: Status
Value
Explain
MODE_GLOVE_OFF
0
Glove mode is closed
MODE_GLOVE_ON
1
Glove mode is open
<0
Jiangsu Seuic Technology Co.,Ltd
glove mode interface abnormal or the device don’t support glove mode setting
Page 4 totally 9 pages
2. Set glove mode (open or close) boolean setGloveMode(int mode) Parameter mode Glove mode status,refer to above mentioned function getGloveMode() return value explain. Return Value If return true means success，false means fail to set;
3. Get touch screen status(enabled or not) int getTouchEnable() Parameter None Return Value Include below: Status
Value
Explain
TOUCH_ENABLED_OFF
0
Touch screen is under locked status.
TOUCH_ENABLED_ON
1
Touch screen is under normal use status.
<0
Touch interface abnormal or the device don’t support touch enable setting
4. Set touch screen status(enabled or not) boolean setTouchEnabled(int enable, Context context) Parameter enable Touch screen enabled status refer to getTouchEnabled() function return value statement sheet. context Invoker’s context to be used for delivering touch screen locking notification to system and reflect screen locking status in the notification column. Return value If return true mean successful，false means failaure.
5.
Get virtual key disabled status
int getVirKeyDisabled () Parameter None Return value Jiangsu Seuic Technology Co.,Ltd
Page 5 totally 9 pages
Include below： Status
Value
Explain
VKEY1_DISABLE_MASK
1 << 0
virtual key 1 been masked
VKEY2_DISABLE_MASK
1 << 1
virtual key 2 been masked
VKEY3_DISABLE_MASK
1 << 2
virtual key 3 been masked
VKEY_ALL_DISABLE_MASK
0x7
all of virtual masked
keys
been
0
All of virtual keys are not masked
<0
Touch interface abnormal or device don’t support touch screen setting
6. Set virtual key mask status boolean setVirKeyDisabled(int disableMask) Parameter disableMask Virtual key mask status，refer to GetVirKeyDisabled () function return value statement sheet. Return value If return true means successful，false means failed.
Jiangsu Seuic Technology Co.,Ltd
Page 6 totally 9 pages
Keypad Interface Library Name
com.seuic.keypad
Library File
keypad.jar
System Library
Yes
Contained Class
KeypadService
Function
Provide keypad related control interface
KeypadService class Use Method import com.seuic.keypad.KeypadService; KeypadService keypad = KeypadService.getInstance();
Function interface Function
Explain
getMode
get keypad mode
setMode
set keypad mode
1. Get keypad mode int getMode() Parameter None Return value Includes below: Status
value
Explain
MODE_NORMAL
0
Standard mode, output Num or Fn key value according to lighting status of current Num、Fn key
MODE_STICK_ONCE
1
Fn key only stick once.In the Fn status, press the key to output function key, then automatically switch to Num mode.
<0
Keypad interface abnormal or device don’t support keypad mode setting
Jiangsu Seuic Technology Co.,Ltd
Page 7 totally 9 pages
2. Set keypad mode boolean setMode(int mode) Parameter mode keypad mode status, refer to getMode() function return value explain. Return value If return true means successful，false means failed.
Jiangsu Seuic Technology Co.,Ltd
Page 8 totally 9 pages
Misc Interface Library name
com.seuic.misc
Library file
misc.jar
System library
Yes
Contained class
Misc
Function
Provide keypad control interface
Misc Class Use Method import com.seuic.misc.Misc; Misc misc = new Misc();
Function interface Funciton getSN
1.
Explain Get device SN
Get device SN
String getSN() Parameter None Return value Includes below： Status null String type
Jiangsu Seuic Technology Co.,Ltd
value null String type
Explain Failed to get SN Successfully get SN
Page 9 totally 9 pages
