The flow diagram shows how scanned data will be processed by the Cisco barcode service.

See the Barcode API example app included in this SDK for more details. Android projects using the barcode capability must include the com.spectralink.barcode.lib library (contained within com.spectralink.sdk.jar). The library can also be done adding the following to the manifest.xml file.

<uses-library android:name="com.spectralink.barcode.lib" />

On Cisco Wireless Phones with barcode readers (for example 840s), a Cisco barcode system service is started during boot. The service is responsible for generating intents with barcode reader state and barcode data. If the above uses-library declaration has android:required="false" set, the developer needs to check for this to be a Cisco device before using any barcode API.

Determining if a barcode scanner is present

Applications can determine if a barcode scanner is present, either by checking device model numbers (i.e. using Android.os.Build MODEL field) which may be challenging to keep in sync with new Cisco or OEM product offerings, or by using the BarcodeManager hasBarcodeReader method, where the latter is the preferred approach.

Note	The BarcodeManager instance shall exist even on devices without a barcode scanner.

barcodeManager = BarcodeManager.getInstance();
if(barcodeManager.hasBarcodeReader()){
// do something useful with reader
} else{
// no barcode reader on this phone.
}

Enabling / disabling the barcode scanner

To prevent a user accidentally illuminating the scanner’s LED when pointed at someone, an app can control the scanner function using the disableBarcodeReader and enableBarcodeReader methods. The current scanner state can be identified via the BarcodeManager.STATE_INTENT and checking the extra data for STATE_BC_DISABLED or STATE_BC_ENABLED.

disableButton.setOnClickListener(new OnClickListener(){
@Override
public void onClick(View v) {
barcodeManager.disableBarcodeReader(v.getContext());
}
});
enableButton.setOnClickListener(new OnClickListener(){
@Override
public void onClick(View v) {
barcodeManager.enableBarcodeReader(v.getContext());
}
});

Receiving scanned barcode data

To receive barcode data, an application can register a broadcast receiver for the BarcodeManager.DATA_INTENT. The actual data is available in the extended data of the intent by using the String key BarcodeManager.SCAN_DATA_EXTRA. You can also get symbology by using the string key BarcodeManager.SCAN_DATA_SYMBOLOGY.

public class BarcodeReceiver extends BroadcastReceiver {
String mReceiverName = "";
BarcodeReceiver(String receiverName){
mReceiverName = receiverName;
}
@Override
public void onReceive(Context context, Intent intent) {
String rcvData = intent.getStringExtra(BarcodeManager.SCAN_DATA_EXTRA);
String rcvSymbology =
intent.getStringExtra(BarcodeManager.SCAN_DATA_SYMBOLOGY);
Logging.myLog(mReceiverName + " Received: " + rcvData, context);
Logging.myLog(mReceiverName + " Received Symbology: " + rcvSymbology,
context);
}
public class TestActivity extends Activity{
public void onCreate(Bundle savedInstanceState) {
<snip>
// Register activity barcode receiver.
bcReceiver = new BarcodeReceiver("BC Activity");
IntentFilter filter = new IntentFilter(BarcodeManager.DATA_INTENT);
registerReceiver(bcReceiver, filter);
<snip>
}
}

Enabling / disabling text input field data insertion

By default, Cisco Wireless Phone will input scanned data into a text input field if in focus. This is useful if the application does not actively interface with the barcode API to receive the data directly. However, some apps may not want this behavior, so the behavior can be disabled by an app using the disableBarcodeKeyboard and enableBarcodeKeyboard methods. The current keyboard input state can be identified via the BarcodeManager.STATE_INTENT and checking the extra data for STATE_KEYBOARD_DISABLED or STATE_KEYBOARD_DISABLED. If an application is using our API it is suggested to disable this keyboard capability.

testBarcode.disableBarcodeKeyboard(v.getContext());

Example code

Please see the example code package for the Barcode API.

1. Start Activity use case

   The partner app wants to move from the MainActivity to a different activity on a successfully completed scan and send data to the new activity.

2. Send Broadcast use case

   The partner application wants to send a broadcast to a broadcastReceiver that it has already implemented, either within the same application or a different application developed by the same partner.

Please see the Button API example app included in this SDK for more details. The following provides a simple code snippet to detect a PTT long press.

public static final String PTT_BUTTON =
“com.apollo.intent.action.PTT_BUTTON”;
public static final String LONGPRESS = “longpress”;
public class ButtonActionReceiver extends BroadcastReceiver {
@Override
public void onReceive(Context context, Intent intent) {
if(intent.getAction().equals(PTT_BUTTON)) {
Bundle b = intent.getExtras();
if(b.get(Intent.EXTRA_TEXT).equals(LONGPRESS)){
//do something cool with long key press
}
}
}
}

The generated intents do have dependencies based on Cisco Wireless Phone’s awake or asleep state, i.e. whether the screen is on or off. The following provides an explanation of the behaviors. However, application developers should become familiar with the button intent behaviors before trying to integrate them into their app:

Phone Awake, Screen On (All buttons):

1. Button pressed -> button’s respective intent generated with EXTRA_TEXT=keypress.

2. If button is held longer than Android’s longpress threshold -> button’s respective intent generated with EXTRA_TEXT=longpress.

3. If button is released before Android’s longpress threshold -> button’s respective intent generated with EXTRA_TEXT=shortpress.

4. Button released -> button’s respective intent generated with EXTRA_TEXT=keyrelease.

Phone Asleep, Screen Off (button set to Scanner or Custom):

1. Button pressed -> No intent generated

2. Button released -> No intent generated

Phone Asleep, Screen Off (button set to Alarm or PTT):

1. Button pressed -> Phone wakes, NO keypress intent generated

2. If button is held longer than Android’s longpress threshold -> button’s respective intent generated with EXTRA_TEXT=longpress.

3. If button is released before Android’s longpress threshold -> button’s respective intent generated with EXTRA_TEXT=shortpress.

4. Button released -> button’s respective intent generated with EXTRA_TEXT=keyrelease.

As shown above, buttons can behave differently, and behavior differs depending on phone state.