com.zebra.sdk.comm

Class BluetoothConnection

Object

com.zebra.sdk.comm.ConnectionA

com.zebra.sdk.comm.BluetoothConnection

All Implemented Interfaces:

Connection, ConnectionWithWriteLogging

Direct Known Subclasses:

BluetoothConnectionInsecure

public class BluetoothConnection
extends ConnectionA

Establishes a Bluetooth® connection to a printer

package test.zebra.android.comm.examples;
 
 
 import android.os.Looper;
 
 import com.zebra.sdk.comm.BluetoothConnection;
 import com.zebra.sdk.comm.Connection;
 
 public class BluetoothConnectionExample {
 
     public static void main(String[] args) {
         BluetoothConnectionExample example = new BluetoothConnectionExample();
 
         String theBtMacAddress = "00:11:BB:DD:55:FF";
         example.sendZplOverBluetooth(theBtMacAddress);
         example.sendCpclOverBluetooth(theBtMacAddress);
     }
 
     private void sendZplOverBluetooth(final String theBtMacAddress) {
 
         new Thread(new Runnable() {
             public void run() {
                 try {
                     // Instantiate connection for given Bluetooth® MAC Address.
                     Connection thePrinterConn = new BluetoothConnection(theBtMacAddress);
 
                     // Initialize
                     Looper.prepare();
 
                     // 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);
 
                     // Close the connection to release resources.
                     thePrinterConn.close();
 
                     Looper.myLooper().quit();
                 } catch (Exception e) {
                     // Handle communications error here.
                     e.printStackTrace();
                 }
             }
         }).start();
     }
 
     private void sendCpclOverBluetooth(final String theBtMacAddress) {
 
         new Thread(new Runnable() {
             public void run() {
                 try {
 
                     // Instantiate connection for given Bluetooth® MAC Address.
                     Connection thePrinterConn = new BluetoothConnection(theBtMacAddress);
 
                     // Initialize
                     Looper.prepare();
                     // Open the connection - physical connection is established here.
                     thePrinterConn.open();
 
                     // This example prints "This is a CPCL test." near the top of the label.
                     String cpclData = "! 0 200 200 210 1\r\n"
                             + "TEXT 4 0 30 40 This is a CPCL test.\r\n"
                             + "FORM\r\n"
                             + "PRINT\r\n";
 
                     // Send the data to printer as a byte array.
                     thePrinterConn.write(cpclData.getBytes());
 
                     // Make sure the data got to the printer before closing the connection
                     Thread.sleep(500);
 
                     // Close the connection to release resources.
                     thePrinterConn.close();
 
                     Looper.myLooper().quit();
 
                 } catch (Exception e) {
 
                     // Handle communications error here.
                     e.printStackTrace();
 
                 }
             }
         }).start();
     }
 
 }
 

Note: In order to connect to a device with Bluetooth®, the device must be discoverable, authentication must be enabled, and the authentication pin must be set (1-16 alphanumeric characters).
The encryption type and whether or not it is used is determined by the device initiating the connection and not device being connected to.

Constructor Summary

Constructors

Constructor and Description
BluetoothConnection(String macAddress) Constructs a new Bluetooth® connection with the given macAddress.
BluetoothConnection(String macAddress, int maxTimeoutForRead, int timeToWaitForMoreData) 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.
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® connection as specified in the constructor.
String	toString() Returns Bluetooth:[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, 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

BluetoothConnection

public BluetoothConnection(String macAddress)

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 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:
BluetoothConnection(String, int, int).

Parameters:

macAddress - the device's MAC address.

BluetoothConnection

public BluetoothConnection(String macAddress,
                   int maxTimeoutForRead,
                   int timeToWaitForMoreData)

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 Connection.read(). 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.

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 Bluetooth:[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® 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.

• This call should be made while there is still an active connection to the printer (prior to issuing a command which will make the printer non-responsive).

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)