com.zebra.sdk.btleComm

Class BluetoothLeStatusConnection

Object

com.zebra.sdk.comm.ConnectionA

com.zebra.sdk.comm.ConnectionStatusA

com.zebra.sdk.btleComm.BluetoothLeStatusConnection

All Implemented Interfaces:

Connection, ConnectionWithWriteLogging, StatusConnection, StatusConnectionWithWriteLogging

public class BluetoothLeStatusConnection
extends ConnectionStatusA

Establishes a Bluetooth® Low Energy status only connection to a Link-OS printer. This connection requires Link-OS firmware 3.2 or higher. This channel will not block the printing channel, nor can it print. If you wish to print, see BluetoothLeConnection.

package test.zebra.android.comm.examples;
 
 import com.zebra.sdk.btleComm.BluetoothLeStatusConnection;
 import com.zebra.sdk.comm.Connection;
 import com.zebra.sdk.comm.ConnectionException;
 import com.zebra.sdk.printer.SGD;
 
 import android.app.Activity;
 import android.content.Context;
 import android.os.Bundle;
 
 public class BluetoothLeStatusConnectionExample extends Activity {
 
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
 
         String theBtMacAddress = "00:11:BB:DD:55:FF";
         Context context = getApplicationContext();
         sendJSONOverStatusChannel(theBtMacAddress, context);
     }
 
     private void sendJSONOverStatusChannel(final String theBtMacAddress, final Context context) {
         new Thread(new Runnable() {
             public void run() {
                 Connection thePrinterConn = null;
                 try {
                     // Instantiate a status only connection for given Bluetooth® MAC Address.
                     thePrinterConn = new BluetoothLeStatusConnection(theBtMacAddress, context);
 
                     // Open the connection - physical connection is established here.
                     thePrinterConn.open();
 
                     // This sends down JSON to the status channel to retrieve the 'appl.name' setting
                     String firmwareVersion = SGD.GET("appl.name", thePrinterConn);
 
                     System.out.println("The firmware version is : " + firmwareVersion);
                 } catch (Exception e) {
                     // Handle communications error here.
                     e.printStackTrace();
                 } finally {
                     // Close the connection to release resources.
                     if (null != thePrinterConn) {
                         try {
                             thePrinterConn.close();
                         } catch (ConnectionException e) {
                             e.printStackTrace();
                         }
                     }
                 }
             }
         }).start();
     }
 
 }
 

Note: In order to connect to a device with Bluetooth® Low Energy, the device must have Bluetooth® Low Energy capabilies.
The encryption type and whether or not it is used is determined by the device being connected to and the bluetooth.le settings.

Constructor Summary

Constructors

Constructor and Description
BluetoothLeStatusConnection(String macAddress, android.content.Context context) Constructs a new Bluetooth® connection with the given macAddress.
BluetoothLeStatusConnection(String macAddress, int maxTimeoutForRead, int timeToWaitForMoreData, android.content.Context context) Exposed this protected constructor for testing.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the Bluetooth® connection.
ConnectionReestablisher	getConnectionReestablisher(long thresholdTime) Returns a ConnectionReestablisher which allows for easy recreation of a connection which may have been closed.
android.content.Context	getContext() Get the Context.
String	getFriendlyName() Returns the friendly name of the Bluetooth® Low Energy connection.
String	getMACAddress() Returns the MAC address which was passed into the constructor.
String	getSimpleConnectionName() Return the MAC address and the friendly name as the description.
void	open() Opens a Bluetooth® connection as specified in the constructor.
void	setContext(android.content.Context context) Set Application Context. Note: This method will need to be called after building a connection with com.zebra.sdk.comm.ConnectionBuilder.build(String)
String	toString() Returns BluetoothLe_STATUS:[MAC Address]:[Friendly Name]. The friendly name is obtained from the device when this connection is opened.

Methods inherited from class com.zebra.sdk.comm.ConnectionA

addWriteLogStream, bytesAvailable, getMaxTimeoutForRead, getTimeToWaitForMoreData, isConnected, read, read, readChar, sendAndWaitForResponse, sendAndWaitForResponse, sendAndWaitForValidResponse, sendAndWaitForValidResponse, setMaxTimeoutForRead, setTimeToWaitForMoreData, waitForData, write, write, write

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.zebra.sdk.comm.StatusConnectionWithWriteLogging

addWriteLogStream

Methods inherited from interface com.zebra.sdk.comm.Connection

bytesAvailable, getMaxTimeoutForRead, getTimeToWaitForMoreData, isConnected, read, read, readChar, sendAndWaitForResponse, sendAndWaitForResponse, sendAndWaitForValidResponse, sendAndWaitForValidResponse, setMaxTimeoutForRead, setTimeToWaitForMoreData, waitForData, write, write, write

Constructor Detail

BluetoothLeStatusConnection

public BluetoothLeStatusConnection(String macAddress,
                           android.content.Context context)

Constructs a new Bluetooth® connection with the given macAddress. The MAC address is a hexadecimal string with or without separators between the octets. (e.g. 00:11:BB:DD:55:FF or 0011BBDD55FF). This constructor will use the default timeouts for com.zebra.sdk.comm.Connection.read(). The default timeout is a maximum of 5 seconds for any data to be received. If no more data is available after 500 milliseconds the read operation is assumed to be complete.
To specify timeouts other than the defaults, use:
BluetoothLeStatusConnection(String, int, int, Context).

Parameters:

macAddress - the device's MAC address.

context - Android™ application context.

BluetoothLeStatusConnection

public BluetoothLeStatusConnection(String macAddress,
                           int maxTimeoutForRead,
                           int timeToWaitForMoreData,
                           android.content.Context context)

Exposed this protected constructor for testing. We can pass in a mock Connector rather than the BTLE specific one The MAC address is a hexadecimal string with no separators between the octets. (e.g. 0011BBDD55FF).

Parameters:

macAddress - the device's MAC address.

maxTimeoutForRead - the maximum time, in milliseconds, to wait for any data to be received.

timeToWaitForMoreData - the maximum time, in milliseconds, to wait in-between reads after the initial read.

context - Android™ application context.

Method Detail

open

public void open()
          throws ConnectionException

Opens a Bluetooth® connection as specified in the constructor. Looper.prepare() should be called prior to calling this method, followed by Looper.myLooper().quit().

Specified by:

open in interface Connection

Overrides:

open in class ConnectionA

Throws:

ConnectionException - if the connection cannot be established.

See Also:

ConnectionA.open()

close

public void close()
           throws ConnectionException

Closes the Bluetooth® connection.

Specified by:

close in interface Connection

Overrides:

close in class ConnectionA

Throws:

ConnectionException - if an I/O error occurs.

See Also:

Connection.close()

toString

public String toString()

Returns BluetoothLe_STATUS:[MAC Address]:[Friendly Name].
The friendly name is obtained from the device when this connection is opened. If the friendly name changes on the device, it will not be refreshed until the connection is closed and reopened.

Specified by:

toString in interface Connection

Overrides:

toString in class Object

Returns:

the connection description string.

See Also:

Connection.toString()

getSimpleConnectionName

public String getSimpleConnectionName()

Return the MAC address and the friendly name as the description.

Returns:

a human-readable description of the connection.

See Also:

Connection.getSimpleConnectionName()

getMACAddress

public String getMACAddress()

Returns the MAC address which was passed into the constructor. The MAC address is a hexadecimal string with separators between the octets. (e.g. 00:11:BB:DD:55:FF).

Returns:

the MAC address for this Bluetooth® connection.

getFriendlyName

public String getFriendlyName()

Returns the friendly name of the Bluetooth® Low Energy connection. The friendly name is obtained from the device when this connection is opened. If the friendly name changes on the device, it will not be refreshed until the connection is closed and reopened.

Returns:

the friendly name.

getConnectionReestablisher

public ConnectionReestablisher getConnectionReestablisher(long thresholdTime)
                                                   throws ConnectionException

Description copied from interface: Connection

Returns a ConnectionReestablisher which allows for easy recreation of a connection which may have been closed.

Specified by:

getConnectionReestablisher in interface Connection

Overrides:

getConnectionReestablisher in class ConnectionA

Parameters:

thresholdTime - how long the Connection reestablisher will wait before attempting to reconnection to the printer

Returns:

ConnectionReestablisher

Throws:

ConnectionException - if the ConnectionReestablisher could not be created.

See Also:

Connection.getConnectionReestablisher(long thresholdTime)

getContext

public android.content.Context getContext()

Get the Context.

Returns:

returns the Android™ application context used for the Bluetooth® Low Energy connection or null if not specified.

setContext

public void setContext(android.content.Context context)

Set Application Context.
Note: This method will need to be called after building a connection with com.zebra.sdk.comm.ConnectionBuilder.build(String)

Parameters:

context - Android™ application context.