com.digi.xbee.api.android

Class XBeeBLEDevice

java.lang.Object

com.digi.xbee.api.AbstractXBeeDevice

com.digi.xbee.api.android.XBeeBLEDevice

Direct Known Subclasses:

CellularBLEDevice, DigiMeshBLEDevice, Raw802BLEDevice, ZigBeeBLEDevice

public class XBeeBLEDevice
extends com.digi.xbee.api.AbstractXBeeDevice

This class represents an XBee Bluetooth Low Energy (BLE) device.

See Also:

CellularBLEDevice, DigiMeshBLEDevice, Raw802BLEDevice, ZigBeeBLEDevice

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
XBeeBLEDevice(android.content.Context context, android.bluetooth.BluetoothDevice bleDevice, java.lang.String password) Class constructor.
XBeeBLEDevice(android.content.Context context, java.lang.String deviceAddress, java.lang.String password) Class constructor.

Method Summary

Modifier and Type	Method and Description
void	addMicroPythonDataListener(com.digi.xbee.api.listeners.relay.IMicroPythonDataReceiveListener listener)
void	addPacketListener(com.digi.xbee.api.listeners.IPacketReceiveListener listener)
void	addSerialDataListener(com.digi.xbee.api.listeners.relay.ISerialDataReceiveListener listener)
void	addUserDataRelayListener(com.digi.xbee.api.listeners.IUserDataRelayReceiveListener listener)
void	close()
int	getNextFrameID()
int	getReceiveTimeout()
boolean	isOpen()
boolean	isRemote()
void	open()
void	removeMicroPythonDataListener(com.digi.xbee.api.listeners.relay.IMicroPythonDataReceiveListener listener)
void	removePacketListener(com.digi.xbee.api.listeners.IPacketReceiveListener listener)
void	removeSerialDataListener(com.digi.xbee.api.listeners.relay.ISerialDataReceiveListener listener)
void	removeUserDataRelayListener(com.digi.xbee.api.listeners.IUserDataRelayReceiveListener listener)
void	reset()
void	sendMicroPythonData(byte[] data)
com.digi.xbee.api.packet.XBeePacket	sendPacket(com.digi.xbee.api.packet.XBeePacket packet)
void	sendPacket(com.digi.xbee.api.packet.XBeePacket packet, com.digi.xbee.api.listeners.IPacketReceiveListener packetReceiveListener)
void	sendPacketAsync(com.digi.xbee.api.packet.XBeePacket packet)
void	sendSerialData(byte[] data)
void	sendUserDataRelay(com.digi.xbee.api.models.XBeeLocalInterface destInterface, byte[] data)
void	setBluetoothPassword(java.lang.String password)
void	setReceiveTimeout(int receiveTimeout)
java.lang.String	toString()

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

addBluetoothDataListener, addDataListener, addExplicitDataListener, addIOSampleListener, addIPDataListener, addModemStatusListener, 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, getNetwork, getNodeID, getOperatingMode, getPANID, getParameter, getPowerLevel, getPWMDutyCycle, getXBeeProtocol, isApplyConfigurationChangesEnabled, readData, readData, readDataFrom, readDataFrom, readDeviceInfo, readExplicitData, readExplicitData, readExplicitDataFrom, readExplicitDataFrom, readIOSample, removeBluetoothDataListener, removeDataListener, removeExplicitDataListener, removeIOSampleListener, removeIPDataListener, removeModemStatusListener, removeSMSListener, sendAndCheckCoAPPacket, sendAndCheckXBeePacket, sendATCommand, sendBluetoothData, sendBroadcastData, sendBroadcastExplicitData, sendData, sendData, sendData, sendDataAsync, sendDataAsync, sendDataAsync, sendExplicitData, sendExplicitData, sendExplicitData, sendExplicitDataAsync, sendExplicitDataAsync, sendExplicitDataAsync, sendXBeePacket, sendXBeePacket, sendXBeePacketAsync, set16BitAddress, setAPIOutputMode, 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

XBeeBLEDevice

public XBeeBLEDevice(android.content.Context context,
                     android.bluetooth.BluetoothDevice bleDevice,
                     java.lang.String password)

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

This constructor uses the Android Bluetooth Low Energy API to communicate with the devices.

The Bluetooth password must be provided before calling the open() method, either through this constructor or the setBluetoothPassword(String) method.

Parameters:

context - The Android application context.

bleDevice - Bluetooth device.

password - Bluetooth password (can be null).

See Also:

XBeeBLEDevice(Context, String, String), BluetoothDevice

XBeeBLEDevice

public XBeeBLEDevice(android.content.Context context,
                     java.lang.String deviceAddress,
                     java.lang.String password)

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

This constructor uses the Android Bluetooth Low Energy API to communicate with the devices.

The Bluetooth password must be provided before calling the open() method, either through this constructor or the setBluetoothPassword(String) method.

Parameters:

context - The Android application context.

deviceAddress - Address of the Bluetooth device.

password - Bluetooth password (can be null).

See Also:

XBeeBLEDevice(Context, BluetoothDevice, String)

Method Detail

isRemote

public boolean isRemote()

Specified by:

isRemote in class com.digi.xbee.api.AbstractXBeeDevice

reset

public void reset()
           throws com.digi.xbee.api.exceptions.TimeoutException,
                  com.digi.xbee.api.exceptions.XBeeException

Specified by:

reset in class com.digi.xbee.api.AbstractXBeeDevice

Throws:

com.digi.xbee.api.exceptions.TimeoutException

com.digi.xbee.api.exceptions.XBeeException

open

public void open()
          throws com.digi.xbee.api.exceptions.XBeeException

Overrides:

open in class com.digi.xbee.api.AbstractXBeeDevice

Throws:

com.digi.xbee.api.exceptions.XBeeException

close

public void close()

Overrides:

close in class com.digi.xbee.api.AbstractXBeeDevice

isOpen

public boolean isOpen()

Overrides:

isOpen in class com.digi.xbee.api.AbstractXBeeDevice

getNextFrameID

public int getNextFrameID()

Overrides:

getNextFrameID in class com.digi.xbee.api.AbstractXBeeDevice

getReceiveTimeout

public int getReceiveTimeout()

Overrides:

getReceiveTimeout in class com.digi.xbee.api.AbstractXBeeDevice

setReceiveTimeout

public void setReceiveTimeout(int receiveTimeout)

Overrides:

setReceiveTimeout in class com.digi.xbee.api.AbstractXBeeDevice

addPacketListener

public void addPacketListener(com.digi.xbee.api.listeners.IPacketReceiveListener listener)

Overrides:

addPacketListener in class com.digi.xbee.api.AbstractXBeeDevice

removePacketListener

public void removePacketListener(com.digi.xbee.api.listeners.IPacketReceiveListener listener)

Overrides:

removePacketListener in class com.digi.xbee.api.AbstractXBeeDevice

addUserDataRelayListener

public void addUserDataRelayListener(com.digi.xbee.api.listeners.IUserDataRelayReceiveListener listener)

Overrides:

addUserDataRelayListener in class com.digi.xbee.api.AbstractXBeeDevice

removeUserDataRelayListener

public void removeUserDataRelayListener(com.digi.xbee.api.listeners.IUserDataRelayReceiveListener listener)

Overrides:

removeUserDataRelayListener in class com.digi.xbee.api.AbstractXBeeDevice

addMicroPythonDataListener

public void addMicroPythonDataListener(com.digi.xbee.api.listeners.relay.IMicroPythonDataReceiveListener listener)

Overrides:

addMicroPythonDataListener in class com.digi.xbee.api.AbstractXBeeDevice

removeMicroPythonDataListener

public void removeMicroPythonDataListener(com.digi.xbee.api.listeners.relay.IMicroPythonDataReceiveListener listener)

Overrides:

removeMicroPythonDataListener in class com.digi.xbee.api.AbstractXBeeDevice

addSerialDataListener

public void addSerialDataListener(com.digi.xbee.api.listeners.relay.ISerialDataReceiveListener listener)

Overrides:

addSerialDataListener in class com.digi.xbee.api.AbstractXBeeDevice

removeSerialDataListener

public void removeSerialDataListener(com.digi.xbee.api.listeners.relay.ISerialDataReceiveListener listener)

Overrides:

removeSerialDataListener in class com.digi.xbee.api.AbstractXBeeDevice

sendUserDataRelay

public void sendUserDataRelay(com.digi.xbee.api.models.XBeeLocalInterface destInterface,
                              byte[] data)
                       throws com.digi.xbee.api.exceptions.XBeeException

Overrides:

sendUserDataRelay in class com.digi.xbee.api.AbstractXBeeDevice

Throws:

com.digi.xbee.api.exceptions.XBeeException

sendMicroPythonData

public void sendMicroPythonData(byte[] data)
                         throws com.digi.xbee.api.exceptions.XBeeException

Overrides:

sendMicroPythonData in class com.digi.xbee.api.AbstractXBeeDevice

Throws:

com.digi.xbee.api.exceptions.XBeeException

sendSerialData

public void sendSerialData(byte[] data)
                    throws com.digi.xbee.api.exceptions.XBeeException

Overrides:

sendSerialData in class com.digi.xbee.api.AbstractXBeeDevice

Throws:

com.digi.xbee.api.exceptions.XBeeException

sendPacket

public void sendPacket(com.digi.xbee.api.packet.XBeePacket packet,
                       com.digi.xbee.api.listeners.IPacketReceiveListener packetReceiveListener)
                throws com.digi.xbee.api.exceptions.XBeeException

Overrides:

sendPacket in class com.digi.xbee.api.AbstractXBeeDevice

Throws:

com.digi.xbee.api.exceptions.XBeeException

sendPacketAsync

public void sendPacketAsync(com.digi.xbee.api.packet.XBeePacket packet)
                     throws com.digi.xbee.api.exceptions.XBeeException

Overrides:

sendPacketAsync in class com.digi.xbee.api.AbstractXBeeDevice

Throws:

com.digi.xbee.api.exceptions.XBeeException

sendPacket

public com.digi.xbee.api.packet.XBeePacket sendPacket(com.digi.xbee.api.packet.XBeePacket packet)
                                               throws com.digi.xbee.api.exceptions.TimeoutException,
                                                      com.digi.xbee.api.exceptions.XBeeException

Overrides:

sendPacket in class com.digi.xbee.api.AbstractXBeeDevice

Throws:

com.digi.xbee.api.exceptions.TimeoutException

com.digi.xbee.api.exceptions.XBeeException

setBluetoothPassword

public void setBluetoothPassword(java.lang.String password)

Overrides:

setBluetoothPassword in class com.digi.xbee.api.AbstractXBeeDevice

toString

public java.lang.String toString()

Overrides:

toString in class com.digi.xbee.api.AbstractXBeeDevice