com.zebra.sdk.comm

Class BluetoothStatusConnection

Object

com.zebra.sdk.comm.ConnectionA

com.zebra.sdk.comm.ConnectionStatusA

com.zebra.sdk.comm.BluetoothStatusConnection

All Implemented Interfaces:

Connection, ConnectionWithWriteLogging, StatusConnection, StatusConnectionWithWriteLogging

Direct Known Subclasses:

BluetoothStatusConnectionInsecure

public class BluetoothStatusConnection
extends ConnectionStatusA

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

package test.zebra.android.comm.examples;
 
 import android.os.Looper;
 
 import com.zebra.sdk.comm.BluetoothStatusConnection;
 import com.zebra.sdk.comm.Connection;
 import com.zebra.sdk.printer.SGD;
 
 public class BluetoothStatusConnectionExample {
 
     public static void main(String[] args) {
         BluetoothStatusConnectionExample example = new BluetoothStatusConnectionExample();
 
         String theBtMacAddress = "00:11:BB:DD:55:FF";
         example.sendJSONOverStatusChannel(theBtMacAddress);
     }
 
     private void sendJSONOverStatusChannel(final String theBtMacAddress) {
 
         new Thread(new Runnable() {
             public void run() {
                 try {
                     // Instantiate a status only connection for given Bluetooth® MAC Address.
                     Connection thePrinterConn = new BluetoothStatusConnection(theBtMacAddress);
 
                     // Initialize
                     Looper.prepare();
 
                     // 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);
 
                     // 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
BluetoothStatusConnection(String macAddress) Constructs a new status only Bluetooth® connection with the given macAddress.
BluetoothStatusConnection(String macAddress, int maxTimeoutForRead, int timeToWaitForMoreData) Constructs a new status only Bluetooth® connection with the given macAddress and timeout values.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the Bluetooth® connection.
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 friendly name of the status port as the description.
void	open() Opens a status only Bluetooth® connection as specified in the constructor.
String	toString() Returns Bluetooth_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, getConnectionReestablisher, 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

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

addWriteLogStream

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

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

Constructor Detail

BluetoothStatusConnection

public BluetoothStatusConnection(String macAddress)

Constructs a new status only 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:
BluetoothStatusConnection(String, int, int).

Parameters:

macAddress - the device's MAC address.

BluetoothStatusConnection

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

Constructs a new status only 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 status only Bluetooth® connection as specified in the constructor. Looper.prepare() should be called prior to calling this method, followed by Looper.myLooper().quit().

Note that if the device does not support status connections (that is, if it is not a Link-OS 2.5 or higher device) calling open will throw a ConnectionException.

Specified by:

open in interface Connection

Overrides:

open in class ConnectionA

Throws:

ConnectionException

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_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 friendly name of the status port 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.