com.digi.xbee.api.android

Class XBee

java.lang.Object

com.digi.xbee.api.android.XBee

public class XBee
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
XBee()

Method Summary

Modifier and Type	Method and Description
static com.digi.xbee.api.connection.bluetooth.AbstractBluetoothInterface	createConnectionInterface(android.content.Context context, android.bluetooth.BluetoothDevice bleDevice) Retrieves an XBee Android Bluetooth connection interface for the given context and Bluetooth device.
static com.digi.xbee.api.connection.bluetooth.AbstractBluetoothInterface	createConnectionInterface(android.content.Context context, java.lang.String deviceAddress) Retrieves an XBee Android Bluetooth connection interface for the given context and Bluetooth device address.
static com.digi.xbee.api.connection.IConnectionInterface	createConnectiontionInterface(android.content.Context context, int baudRate) Returns an XBee Android connection interface for the given context and baud rate.
static com.digi.xbee.api.connection.IConnectionInterface	createConnectiontionInterface(android.content.Context context, int baudRate, AndroidUSBPermissionListener permissionListener) Returns an XBee Android connection interface for the given context and baud rate.
static com.digi.xbee.api.connection.IConnectionInterface	createConnectiontionInterface(android.content.Context context, java.lang.String port, int baudRate) Retrieves an XBee Android connection interface for the given context, port and baud rate.
static com.digi.xbee.api.connection.IConnectionInterface	createConnectiontionInterface(android.content.Context context, java.lang.String port, com.digi.xbee.api.connection.serial.SerialPortParameters serialPortParameters) Retrieves an XBee Android connection interface for the given context, port and parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XBee

public XBee()

Method Detail

createConnectiontionInterface

public static com.digi.xbee.api.connection.IConnectionInterface createConnectiontionInterface(android.content.Context context,
                                                                                              int baudRate)

Returns an XBee Android connection interface for the given context and baud rate.

This constructor uses the Android USB host interface API to communicate with the devices.

Parameters:

context - The Android application context.

baudRate - The USB connection baud rate.

Returns:

The XBee Android connection interface.

Throws:

java.lang.NullPointerException - if context == null.

java.lang.IllegalArgumentException - if baudRate < 1.

See Also:

createConnectiontionInterface(Context, int, AndroidUSBPermissionListener), IConnectionInterface

createConnectiontionInterface

public static com.digi.xbee.api.connection.IConnectionInterface createConnectiontionInterface(android.content.Context context,
                                                                                              int baudRate,
                                                                                              AndroidUSBPermissionListener permissionListener)

Returns an XBee Android connection interface for the given context and baud rate.

This constructor uses the Android USB host interface API to communicate with the devices.

Parameters:

context - The Android context.

baudRate - The USB connection baud rate.

permissionListener - The USB permission listener that will be notified when user grants USB permissions.

Returns:

The XBee Android connection interface.

Throws:

java.lang.NullPointerException - if context == null.

java.lang.IllegalArgumentException - if baudRate < 1.

See Also:

createConnectiontionInterface(Context, int), IConnectionInterface, AndroidUSBPermissionListener

createConnectiontionInterface

public static com.digi.xbee.api.connection.IConnectionInterface createConnectiontionInterface(android.content.Context context,
                                                                                              java.lang.String port,
                                                                                              int baudRate)

Retrieves an XBee Android connection interface for the given context, port and baud rate.

This constructor uses the Digi Android Serial Port API based on the RxTx library to communicate with the devices.

Parameters:

context - The Android application context.

port - The Android COM port.

baudRate - The serial port connection baud rate.

Returns:

The XBee Android connection interface.

Throws:

java.lang.NullPointerException - if context == null or if port == null.

java.lang.IllegalArgumentException - if baudRate < 1.

See Also:

createConnectiontionInterface(Context, String, SerialPortParameters), IConnectionInterface

createConnectiontionInterface

public static com.digi.xbee.api.connection.IConnectionInterface createConnectiontionInterface(android.content.Context context,
                                                                                              java.lang.String port,
                                                                                              com.digi.xbee.api.connection.serial.SerialPortParameters serialPortParameters)

Retrieves an XBee Android connection interface for the given context, port and parameters.

This constructor uses the Digi Android Serial Port API based on the RxTx library to communicate with the devices.

Parameters:

context - The Android application context.

port - The Android COM port.

serialPortParameters - The serial port parameters.

Returns:

The XBee Android connection interface.

Throws:

java.lang.NullPointerException - if context == null or if port == null or if serialPortParameters == null.

See Also:

createConnectiontionInterface(Context, String, int), IConnectionInterface, SerialPortParameters

createConnectionInterface

public static com.digi.xbee.api.connection.bluetooth.AbstractBluetoothInterface createConnectionInterface(android.content.Context context,
                                                                                                          android.bluetooth.BluetoothDevice bleDevice)

Retrieves an XBee Android Bluetooth connection interface for the given context and Bluetooth device.

Parameters:

context - The Android application context.

bleDevice - The Bluetooth device.

Returns:

The XBee Android Bluetooth connection interface.

Throws:

java.lang.NullPointerException - if context == null or if bleDevice == null.

See Also:

createConnectionInterface(Context, String), AbstractBluetoothInterface, BluetoothDevice

createConnectionInterface

public static com.digi.xbee.api.connection.bluetooth.AbstractBluetoothInterface createConnectionInterface(android.content.Context context,
                                                                                                          java.lang.String deviceAddress)

Retrieves an XBee Android Bluetooth connection interface for the given context and Bluetooth device address.

Parameters:

context - The Android application context.

deviceAddress - The address of the Bluetooth device.

Returns:

The XBee Android Bluetooth connection interface.

Throws:

java.lang.IllegalArgumentException - if the device address does not follow the format "00:11:22:33:AA:BB".

java.lang.NullPointerException - if context == null or if deviceAddress == null.

See Also:

createConnectionInterface(Context, BluetoothDevice), AbstractBluetoothInterface