com.zebra.sdk.btleComm

Class BluetoothLeConnection

Object

com.zebra.sdk.comm.ConnectionA

com.zebra.sdk.btleComm.BluetoothLeConnection

All Implemented Interfaces:

Connection, ConnectionWithWriteLogging

public class BluetoothLeConnection
extends ConnectionA

Establishes a Bluetooth® Low Energy connection to a printer

package test.zebra.android.comm.examples;
 
 import com.zebra.sdk.btleComm.BluetoothLeConnection;
 import com.zebra.sdk.comm.Connection;
 import com.zebra.sdk.comm.ConnectionException;
 
 import android.app.Activity;
 import android.content.Context;
 import android.os.Bundle;
 
 public class BluetoothLeConnectionExample extends Activity {
 
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
 
         String theBtMacAddress = "00:11:BB:DD:55:FF";
         Context context = getApplicationContext();
         sendZplOverBluetoothLe(theBtMacAddress, context);
     }
 
     private void sendZplOverBluetoothLe(final String theBtMacAddress, final Context context) {
         new Thread(new Runnable() {
             public void run() {
                 Connection thePrinterConn = null;
                 try {
                     // Instantiate connection for given Bluetooth® MAC Address.
                     thePrinterConn = new BluetoothLeConnection(theBtMacAddress, context);
 
                     // Open the connection - physical connection is established here.
                     thePrinterConn.open();
 
                     // This example prints "This is a ZPL test." near the top of the label.
                     String zplData = "^XA^FO20,20^A0N,25,25^FDThis is a ZPL test.^FS^XZ";
 
                     // Send the data to printer as a byte array.
                     thePrinterConn.write(zplData.getBytes());
 
                     // Make sure the data got to the printer before closing the connection
                     Thread.sleep(500);
                 } 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®, the device must 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
BluetoothLeConnection(String macAddress) Constructs a new Bluetooth® connection with the given macAddress and timeout values.
BluetoothLeConnection(String macAddress, android.content.Context context) Constructs a new Bluetooth® connection with the given macAddress and timeout values.
BluetoothLeConnection(String macAddress, int maxTimeoutForRead, int timeToWaitForMoreData, android.content.Context context) Constructs a new Bluetooth® connection with the given macAddress and timeout values.

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® 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® Low Energy 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:[MAC Address]:[Friendly Name].

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

addWriteLogStream, bytesAvailable, getManufacturer, getMaxDataToWrite, getMaxTimeoutForRead, getTimeToWaitForMoreData, isConnected, read, read, read, read, readChar, sendAndWaitForResponse, sendAndWaitForResponse, sendAndWaitForValidResponse, sendAndWaitForValidResponse, setMaxDataToWrite, setMaxTimeoutForRead, setReadTimeout, setTimeToWaitForMoreData, waitForData, write, write, write

Methods inherited from class Object

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

Constructor Detail

BluetoothLeConnection

public BluetoothLeConnection(String macAddress)

Constructs a new Bluetooth® connection with the given macAddress and timeout values. 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 specified timeouts for com.zebra.sdk.comm.Connection. The timeout is a maximum of maxTimeoutForRead milliseconds for any data to be received. If no more data is available after timeToWaitForMoreData milliseconds the read operation is assumed to be complete.
Note: You will need to call setContext(Context) in order to connect to a Printer.

Parameters:

macAddress - the device's MAC address.

BluetoothLeConnection

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

Constructs a new Bluetooth® connection with the given macAddress and timeout values. 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 specified timeouts for com.zebra.sdk.comm.Connection. The timeout is a maximum of maxTimeoutForRead milliseconds for any data to be received. If no more data is available after timeToWaitForMoreData milliseconds the read operation is assumed to be complete.

Parameters:

macAddress - the device's MAC address.

context - Android™ application context.

BluetoothLeConnection

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

Constructs a new Bluetooth® connection with the given macAddress and timeout values. 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 specified timeouts for com.zebra.sdk.comm.Connection. The timeout is a maximum of maxTimeoutForRead milliseconds for any data to be received. If no more data is available after timeToWaitForMoreData milliseconds the read operation is assumed to be complete.

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® Low Energy connection as specified in the constructor.

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:[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:

[MAC Address]:[Friendly Name]

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® 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

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.