Wizarpos Pdf417 Cloud Pos Scanner Instruction Manual

wizarPOS PDF417 Cloud POS Scanner Instruction Manual

Introduction

Purpose

This document describes the instruction of using Scan Service, including interface description, parameter description, and methods of calling the services.

User
The reader of this document is a developer who uses the Scan Service.

Project Background

Overview
The smart POS currently use enhanced and customized Android system as the OS, and as for the scan function, the Android system does not come with the barcode scan/2D barcode scan function, but use open source services, such as Zxing/Zbar. Many of the Android Apps that are used on smart POS devices, have already realized a very quick scan function.
However, there are many other applications are developed based on smart POS, not ready-made commercial applications. And many of the smart POS developers also have POS industry background, not professional Android developers. So when they start developing applications, they want to be provided with a convenient scan API , instead of learning Zxing/Zbar themselves.
From the hardware point of view, the scan parts used on smart POS, are not necessarily the standard camera, there will be some transformation. In some cases, the scan part will be required to be a specialized hardware. Therefore, the direct use of Zxing /Zbar is not really applicable for the smart POS, but need some modification and customization.
For the reasons above, we consider to develop Scan Services to facilitate the third-party developers in developing applications with scan function.

Scan Service Usage
The scan service is an app and started by using AIDL. The third-party app’s custom their UI through by transfer some parameters.

Interface and parameter description

Interface description

 ScanBarcode
This interface is a synchronous call interface.
When the application calls the interface, the scan service opens the camera as defined by the scan parameter and starts the scan. After the scan, the camera is turned off and the results are returned immediately

ScanResult scanBarcode(ScanParameter parameter);

• Parameter: ScanParameter
• Return: ScanResult

Start Scan

This interface is an asynchronous call interface, indicating the continuous scan is started.
When the application calls this interface, the scan service opens the camera as defined by the scan parameter and starts the scan. After each scan, the results will be returned during the callback. After each callback is done, the next scan process starts.
void startScan(ScanParameter parameter, IScanCallBack callBack); Parameter: ScanParameter, IScanCallBack
Return: void

FoundBarcode in IScanCallBack
When calling startScan(), the parameter IScanCallBack must be implement. The caller can get the ScanResult through this interface. When this interface is called, the scan service is in the pause state, and after the call is returned, the next scan action will be continued.
You can turn off the scan service that is in pause with “stopScan”.

oid foundBarcode(ScanResult result);

Parameter: ScanResult
Return: Void

StopScan
Stop the continuous scan, and turn off the scan service’s UI. After stop, other callers can call startScan, or scanBarcode interface.
Return:

Boolean, true/false.

getScanType(int index)

Get scanner type.
String getScanType(int index);
Parameter:
Int 0 or 1;
Return:
String “Scanner” or “Camera” or “Error”;

Parameter Description

ScanParameter

ScanParameter is a parameter object, it defines the parameters that need  by the scanner service. method: set(String key, String value)  (Value Not case sensitive)

Scanner mode
In dialog mode, the scanner UI has drawed by the camera scanner service, the third app don’t need to consider about the UI.
In overlay mode, the camera scanner service only provide the scanner window, the window will display on top of the third app UI. So the third app can draw the UI by itself, such as the title, the buttons. In this mode, if the app need to switch the camera, the flash light, the indicator light, it must use the broadcast like belows:

• Camera:
  Broadcast Action : com.cloudpos.scanner.setcamera
  Broadcast Key: overlay_config
  value: 0 Fixed camera;1 zoom camera; 2 customer display camera
  
• Flash light:
  Broadcast Action : com.cloudpos.scanner.setflashlight Broadcast Key: overlay_config
  Value: true opened; false closed
• Indicator light:
  Broadcast Action : com.cloudpos.scanner.setindicator Broadcast Key : overlay_config
  Value: true opened; false closed
  

Sample Code:
// open the flash light
Intent intent = new Intent();
intent.setAction(ScanParameter.BROADCAST_SET_FLASHLIGHT);
intent.putExtra(ScanParameter.BROADCAST_VALUE, true);
sendBroadcast(intent);

Zebra Scanner

Zebra scan requires the following conditions:

1. Exist Zebra
2. Set the parameter “camera_index” to 0- main
3. When screen black, the imager can not
4. Set the parameter “enable_ui_by_zebra” to false- hide the default UI from syestem

ScanResult

Error Code

Usage

 Scanner service integration
The scanner service use AIDL, so the third-party apps must include the AIDL files( get from \source\aidl from barcode SDK package). The follows are described the methods of integrating in Eclipse and Android Studio.

The files includes:

In Eclipse, put all the files in to the package: com.cloudpos.scanserver.aidl.
In Android Studio, firstly put the AIDL files in the package(com.cloudpos. scanserver.aidl) , the package is in folder (src—main—aildl), if the package and the folders are not existed, please make them first.

And then, put the two java files in the package(com.cloudpos.scanserver.aidl), the package is in folder(src—main–java), if the package and the folders are not existed, please
make them first.

clean project, if compiled success in folder: build—generated—source—aidl—debug, then the app can call the scanner service successfully.

 Bind service
We have provided the API for bind service. Put the interface and the implement in any package. Get from \source\aidlControl from barcode SDK package.

1.  Use the follow method to bind service:
   AidlController.getInstance().startScanService(this, this);
2. Implement the interface IAIDLListener. Get the scanner service, use the service to call the functions. private IScannService scanService; //Scanner service
   private ServiceConnection scanConn;

@Override
public void serviceConnected(Object objService, ServiceConnection connection) {if(objService instanceof IScannService){scanService = (IScannService) objService; scanConn = connection;}}

Use this function to unbind service.

if(scanService != null){this.unbindService(scanConn); scanService = null; scanConn = null;}

Please see also the demo project for detail.

Appendix

Barcode Format
Example:

ScanParameter parameter = new ScanParameter(); parameter.set(ScanParameter.KEY_DECODEFORMAT, ” SymbologyType_Aztec, ITF “);