com.digi.xbee.api.android

Class XBeeDevice

java.lang.Object

com.digi.xbee.api.AbstractXBeeDevice

com.digi.xbee.api.XBeeDevice

com.digi.xbee.api.android.XBeeDevice

public class XBeeDevice
extends com.digi.xbee.api.XBeeDevice

This class represents a local XBee device.

See Also:

CellularDevice, DigiPointDevice, DigiMeshDevice, Raw802Device, ThreadDevice, WiFiDevice, ZigBeeDevice

Field Summary

Fields inherited from class com.digi.xbee.api.AbstractXBeeDevice

bluetoothPassword, connectionInterface, currentFrameID, dataReader, DEFAULT_RECEIVE_TIMETOUT, ipv6Address, localXBeeDevice, logger, network, operatingMode, receiveTimeout, TIMEOUT_BEFORE_COMMAND_MODE, TIMEOUT_ENTER_COMMAND_MODE, TIMEOUT_READ_PACKET, xbee16BitAddress, xbee64BitAddress, xbeeProtocol

Constructor Summary

Constructors

Constructor and Description
XBeeDevice(android.content.Context context, int baudRate) Class constructor.
XBeeDevice(android.content.Context context, int baudRate, AndroidUSBPermissionListener permissionListener) Class constructor.
XBeeDevice(android.content.Context context, java.lang.String port, int baudRate) Class constructor.
XBeeDevice(android.content.Context context, java.lang.String port, com.digi.xbee.api.connection.serial.SerialPortParameters parameters) Class constructor.

Method Summary

Methods inherited from class com.digi.xbee.api.XBeeDevice

addBluetoothDataListener, addDataListener, addIOSampleListener, addMicroPythonDataListener, addModemStatusListener, addPacketListener, addUserDataRelayListener, close, getNetwork, getNextFrameID, getOperatingMode, getReceiveTimeout, isOpen, isRemote, open, readData, readData, readDataFrom, readDataFrom, removeBluetoothDataListener, removeDataListener, removeIOSampleListener, removeMicroPythonDataListener, removeModemStatusListener, removePacketListener, removeUserDataRelayListener, reset, sendBluetoothData, sendBroadcastData, sendData, sendDataAsync, sendMicroPythonData, sendPacket, sendPacket, sendPacketAsync, sendUserDataRelay, setReceiveTimeout, toString

Methods inherited from class com.digi.xbee.api.AbstractXBeeDevice

addExplicitDataListener, addIPDataListener, addSerialDataListener, addSMSListener, applyChanges, checkATCommandResponseIsValid, determineOperatingMode, disableBluetooth, enableApplyConfigurationChanges, enableBluetooth, executeParameter, forceDisassociate, get16BitAddress, get64BitAddress, getADCValue, getAPIOutputMode, getAssociationIndicationStatus, getBluetoothMacAddress, getConnectionInterface, getDestinationAddress, getDIOChangeDetection, getDIOValue, getFirmwareVersion, getHardwareVersion, getIOConfiguration, getIOSamplingRate, getIPv6Address, getIPv6DestinationAddress, getNodeID, getPANID, getParameter, getPowerLevel, getPWMDutyCycle, getXBeeProtocol, isApplyConfigurationChangesEnabled, readDeviceInfo, readExplicitData, readExplicitData, readExplicitDataFrom, readExplicitDataFrom, readIOSample, removeExplicitDataListener, removeIPDataListener, removeSerialDataListener, removeSMSListener, sendAndCheckCoAPPacket, sendAndCheckXBeePacket, sendATCommand, sendBroadcastExplicitData, sendData, sendData, sendDataAsync, sendDataAsync, sendExplicitData, sendExplicitData, sendExplicitData, sendExplicitDataAsync, sendExplicitDataAsync, sendExplicitDataAsync, sendSerialData, sendXBeePacket, sendXBeePacket, sendXBeePacketAsync, set16BitAddress, setAPIOutputMode, setBluetoothPassword, setDestinationAddress, setDIOChangeDetection, setDIOValue, setIOConfiguration, setIOSamplingRate, setIPv6DestinationAddress, setNodeID, setPANID, setParameter, setPowerLevel, setPWMDutyCycle, softwareReset, updateBluetoothPassword, updateDeviceDataFrom, writeChanges

Methods inherited from class java.lang.Object

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

Constructor Detail

XBeeDevice

public XBeeDevice(android.content.Context context,
                  int baudRate)

Class constructor. Instantiates a new XBeeDevice object for Android with the given parameters.

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.

Throws:

java.lang.IllegalArgumentException - if baudRate < 1.

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

See Also:

XBeeDevice(Context, int, AndroidUSBPermissionListener), XBeeDevice(Context, String, int), XBeeDevice(Context, String, SerialPortParameters)

XBeeDevice

public XBeeDevice(android.content.Context context,
                  int baudRate,
                  AndroidUSBPermissionListener permissionListener)

Class constructor. Instantiates a new XBeeDevice object for Android with the given parameters.

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.

Throws:

java.lang.IllegalArgumentException - if baudRate < 1.

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

See Also:

XBeeDevice(Context, int), XBeeDevice(Context, String, int), XBeeDevice(Context, String, SerialPortParameters), AndroidUSBPermissionListener

XBeeDevice

public XBeeDevice(android.content.Context context,
                  java.lang.String port,
                  int baudRate)

Class constructor. Instantiates a new XBeeDevice object for Android with the given 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 - Serial port name where XBee device is attached to.

baudRate - The serial port connection baud rate.

Throws:

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

java.lang.IllegalArgumentException - if baudRate < 1.

See Also:

XBeeDevice(Context, int), XBeeDevice(Context, int, AndroidUSBPermissionListener), XBeeDevice(Context, String, SerialPortParameters)

XBeeDevice

public XBeeDevice(android.content.Context context,
                  java.lang.String port,
                  com.digi.xbee.api.connection.serial.SerialPortParameters parameters)

Class constructor. Instantiates a new XBeeDevice object for Android with the given 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 - Serial port name where XBee device is attached to.

parameters - The serial port parameters.

Throws:

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

See Also:

XBeeDevice(Context, int), XBeeDevice(Context, int, AndroidUSBPermissionListener), XBeeDevice(Context, String, int), SerialPortParameters