XBeeDevice (XBee Java Library)

java.lang.Object
- com.digi.xbee.api.AbstractXBeeDevice
- - com.digi.xbee.api.XBeeDevice

Direct Known Subclasses:

DigiMeshDevice, DigiPointDevice, IPDevice, IPv6Device, Raw802Device, ZigBeeDevice
```
public class XBeeDevice
extends AbstractXBeeDevice
```
This class represents a local XBee device.

See Also:

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

Constructor Summary

Constructors
Constructor and Description
`XBeeDevice(IConnectionInterface connectionInterface)` Class constructor.
`XBeeDevice(String port, int baudRate)` Class constructor.
`XBeeDevice(String port, int baudRate, int dataBits, int stopBits, int parity, int flowControl)` Class constructor.
`XBeeDevice(String port, SerialPortParameters serialPortParameters)` Class constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBluetoothDataListener(IBluetoothDataReceiveListener listener)` Adds the provided listener to the list of listeners to be notified when new data from the Bluetooth interface is received in a User Data Relay frame.
`void`	`addDataListener(IDataReceiveListener listener)` Adds the provided listener to the list of listeners to be notified when new data from a remote XBee device is received.
`void`	`addIOSampleListener(IIOSampleReceiveListener listener)` Adds the provided listener to the list of listeners to be notified when new IO samples are received.
`void`	`addMicroPythonDataListener(IMicroPythonDataReceiveListener listener)` Adds the provided listener to the list of listeners to be notified when new data from the MicroPython interface is received in a User Data Relay frame.
`void`	`addModemStatusListener(IModemStatusReceiveListener listener)` Adds the provided listener to the list of listeners to be notified when new Modem Status events are received.
`void`	`addPacketListener(IPacketReceiveListener listener)` Adds the provided listener to the list of listeners to be notified when new packets are received.
`void`	`addUserDataRelayListener(IUserDataRelayReceiveListener listener)` Adds the provided listener to the list of listeners to be notified when new User Data Relay message is received.
`void`	`close()` Closes the connection interface associated with this XBee device.
`XBeeNetwork`	`getNetwork()` Returns the network associated with this XBee device.
`int`	`getNextFrameID()` Returns the next Frame ID of this XBee device.
`OperatingMode`	`getOperatingMode()` Returns the Operating mode (AT, API or API escaped) of this XBee device for a local device, and the operating mode of the local device used as communication interface for a remote device.
`int`	`getReceiveTimeout()` Returns this XBee device configured timeout for receiving packets in synchronous operations.
`boolean`	`isOpen()` Returns whether the connection interface associated to this device is already open.
`boolean`	`isRemote()` Returns whether this XBee device is a remote device.
`void`	`open()` Opens the connection interface associated with this XBee device.
`XBeeMessage`	`readData()` Reads new data received by this XBee device during the configured receive timeout.
`XBeeMessage`	`readData(int timeout)` Reads new data received by this XBee device during the provided timeout.
`XBeeMessage`	`readDataFrom(RemoteXBeeDevice remoteXBeeDevice)` Reads new data received from the given remote XBee device during the configured receive timeout.
`XBeeMessage`	`readDataFrom(RemoteXBeeDevice remoteXBeeDevice, int timeout)` Reads new data received from the given remote XBee device during the provided timeout.
`void`	`removeBluetoothDataListener(IBluetoothDataReceiveListener listener)` Removes the provided listener from the list of data receive listeners for the Bluetooth interface.
`void`	`removeDataListener(IDataReceiveListener listener)` Removes the provided listener from the list of data listeners for remote XBee devices.
`void`	`removeIOSampleListener(IIOSampleReceiveListener listener)` Removes the provided listener from the list of IO samples listeners.
`void`	`removeMicroPythonDataListener(IMicroPythonDataReceiveListener listener)` Removes the provided listener from the list of data receive listeners for the MicroPython interface.
`void`	`removeModemStatusListener(IModemStatusReceiveListener listener)` Removes the provided listener from the list of Modem Status listeners.
`void`	`removePacketListener(IPacketReceiveListener listener)` Removes the provided listener from the list of packets listeners.
`void`	`removeUserDataRelayListener(IUserDataRelayReceiveListener listener)` Removes the provided listener from the list of User Data Relay listeners.
`void`	`reset()` Performs a software reset on this XBee device and blocks until the process is completed.
`void`	`sendBluetoothData(byte[] data)` Sends the given data to the XBee Bluetooth interface in a User Data Relay frame.
`void`	`sendBroadcastData(byte[] data)` Sends the provided data to all the XBee nodes of the network (broadcast).
`void`	`sendData(RemoteXBeeDevice remoteXBeeDevice, byte[] data)` Sends the provided data to the given XBee device choosing the optimal send method depending on the protocol of the local XBee device.
`void`	`sendDataAsync(RemoteXBeeDevice remoteXBeeDevice, byte[] data)` Sends the provided data to the provided XBee device asynchronously choosing the optimal send method depending on the protocol of the local XBee device.
`void`	`sendMicroPythonData(byte[] data)` Sends the given data to the XBee MicroPython interface in a User Data Relay frame.
`XBeePacket`	`sendPacket(XBeePacket packet)` Sends the given XBee packet synchronously and blocks until the response is received or the configured receive timeout expires.
`void`	`sendPacket(XBeePacket packet, IPacketReceiveListener packetReceiveListener)` Sends the given XBee packet and registers the given packet listener (if not `null`) to be notified when the answers is received.
`void`	`sendPacketAsync(XBeePacket packet)` Sends the given XBee packet asynchronously.
`void`	`sendUserDataRelay(XBeeLocalInterface destInterface, byte[] data)` Sends the given data to the given XBee local interface.
`void`	`setReceiveTimeout(int receiveTimeout)` Configures this XBee device timeout in milliseconds for receiving packets in synchronous operations.
`String`	`toString()`

Methods inherited from class com.digi.xbee.api.AbstractXBeeDevice
applyChanges, disableBluetooth, enableApplyConfigurationChanges, enableBluetooth, executeParameter, get16BitAddress, get64BitAddress, getADCValue, getBluetoothMacAddress, getConnectionInterface, getDestinationAddress, getDIOChangeDetection, getDIOValue, getFirmwareVersion, getHardwareVersion, getIOConfiguration, getIOSamplingRate, getIPv6Address, getIPv6DestinationAddress, getNodeID, getPANID, getParameter, getPowerLevel, getPWMDutyCycle, getXBeeProtocol, isApplyConfigurationChangesEnabled, readDeviceInfo, readIOSample, setDestinationAddress, setDIOChangeDetection, setDIOValue, setIOConfiguration, setIOSamplingRate, setIPv6DestinationAddress, setNodeID, setPANID, setParameter, setPowerLevel, setPWMDutyCycle, updateBluetoothPassword, updateDeviceDataFrom, writeChanges

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - XBeeDevice
```
public XBeeDevice(IConnectionInterface connectionInterface)
```
    Class constructor. Instantiates a new XBeeDevice object with the given connection interface.
    
    Parameters:
    
    connectionInterface - The connection interface with the physical XBee device.
    
    Throws:
    
    NullPointerException - if connectionInterface == null.
    
    See Also:
    
    XBeeDevice(String, int), XBeeDevice(String, SerialPortParameters), XBeeDevice(String, int, int, int, int, int), IConnectionInterface
  - XBeeDevice
```
public XBeeDevice(String port,
                  int baudRate)
```
    Class constructor. Instantiates a new XBeeDevice object physically connected to the given port name and configured at the provided baud rate.
    
    Parameters:
    
    port - Serial port name where XBee device is attached to.
    
    baudRate - Serial port baud rate to communicate with the device. Other connection parameters will be set as default (8 data bits, 1 stop bit, no parity, no flow control).
    
    Throws:
    
    IllegalArgumentException - if baudRate < 0.
    
    NullPointerException - if port == null.
    
    See Also:
    
    XBeeDevice(IConnectionInterface), XBeeDevice(String, SerialPortParameters), XBeeDevice(String, int, int, int, int, int)
  - XBeeDevice
```
public XBeeDevice(String port,
                  int baudRate,
                  int dataBits,
                  int stopBits,
                  int parity,
                  int flowControl)
```
    Class constructor. Instantiates a new XBeeDevice object physically connected to the given port name and configured to communicate with the provided serial settings.
    
    Parameters:
    
    port - Serial port name where XBee device is attached to.
    
    baudRate - Serial port baud rate to communicate with the device.
    
    dataBits - Serial port data bits.
    
    stopBits - Serial port data bits.
    
    parity - Serial port data bits.
    
    flowControl - Serial port data bits.
    
    Throws:
    
    IllegalArgumentException - if baudRate < 0 or if dataBits < 0 or if stopBits < 0 or if parity < 0 or if flowControl < 0.
    
    NullPointerException - if port == null.
    
    See Also:
    
    XBeeDevice(IConnectionInterface), XBeeDevice(String, int), XBeeDevice(String, SerialPortParameters)
  - XBeeDevice
```
public XBeeDevice(String port,
                  SerialPortParameters serialPortParameters)
```
    Class constructor. Instantiates a new XBeeDevice object physically connected to the given port name and configured to communicate with the provided serial settings.
    
    Parameters:
    
    port - Serial port name where XBee device is attached to.
    
    serialPortParameters - Object containing the serial port parameters.
    
    Throws:
    
    NullPointerException - if port == null or if serialPortParameters == null.
    
    See Also:
    
    XBeeDevice(IConnectionInterface), XBeeDevice(String, int), XBeeDevice(String, int, int, int, int, int), SerialPortParameters
- Method Detail
  - addBluetoothDataListener
```
public void addBluetoothDataListener(IBluetoothDataReceiveListener listener)
```
    Description copied from class: AbstractXBeeDevice
    
    Adds the provided listener to the list of listeners to be notified when new data from the Bluetooth interface is received in a User Data Relay frame.
    If the listener has been already included this method does nothing.
    
    Parameters:
    
    listener - Listener to be notified when new data from the Bluetooth interface is received.
    
    See Also:
    
    AbstractXBeeDevice.removeBluetoothDataListener(IBluetoothDataReceiveListener), IBluetoothDataReceiveListener
  - addDataListener
```
public void addDataListener(IDataReceiveListener listener)
```
    Description copied from class: AbstractXBeeDevice
    
    Adds the provided listener to the list of listeners to be notified when new data from a remote XBee device is received.
    If the listener has been already included this method does nothing.
    
    Parameters:
    
    listener - Listener to be notified when new data from a remote XBee device is received.
    
    See Also:
    
    AbstractXBeeDevice.removeDataListener(IDataReceiveListener), IDataReceiveListener
  - addIOSampleListener
```
public void addIOSampleListener(IIOSampleReceiveListener listener)
```
    Description copied from class: AbstractXBeeDevice
    
    Adds the provided listener to the list of listeners to be notified when new IO samples are received.
    If the listener has been already included this method does nothing.
    
    Parameters:
    
    listener - Listener to be notified when new IO samples are received.
    
    See Also:
    
    AbstractXBeeDevice.removeIOSampleListener(IIOSampleReceiveListener), IIOSampleReceiveListener
  - addMicroPythonDataListener
```
public void addMicroPythonDataListener(IMicroPythonDataReceiveListener listener)
```
    Description copied from class: AbstractXBeeDevice
    
    Adds the provided listener to the list of listeners to be notified when new data from the MicroPython interface is received in a User Data Relay frame.
    If the listener has been already included this method does nothing.
    
    Parameters:
    
    listener - Listener to be notified when new data from the MicroPython interface is received.
    
    See Also:
    
    AbstractXBeeDevice.removeMicroPythonDataListener(IMicroPythonDataReceiveListener), IMicroPythonDataReceiveListener
  - addModemStatusListener
```
public void addModemStatusListener(IModemStatusReceiveListener listener)
```
    Description copied from class: AbstractXBeeDevice
    
    Adds the provided listener to the list of listeners to be notified when new Modem Status events are received.
    If the listener has been already included this method does nothing.
    
    Parameters:
    
    listener - Listener to be notified when new Modem Status events are received.
    
    See Also:
    
    AbstractXBeeDevice.removeModemStatusListener(IModemStatusReceiveListener), IModemStatusReceiveListener
  - addPacketListener
```
public void addPacketListener(IPacketReceiveListener listener)
```
    Description copied from class: AbstractXBeeDevice
    
    Adds the provided listener to the list of listeners to be notified when new packets are received.
    If the listener has been already included, this method does nothing.
    
    Parameters:
    
    listener - Listener to be notified when new packets are received.
    
    See Also:
    
    AbstractXBeeDevice.removePacketListener(IPacketReceiveListener), IPacketReceiveListener
  - addUserDataRelayListener
```
public void addUserDataRelayListener(IUserDataRelayReceiveListener listener)
```
    Description copied from class: AbstractXBeeDevice
    
    Adds the provided listener to the list of listeners to be notified when new User Data Relay message is received.
    If the listener has been already included this method does nothing.
    
    Parameters:
    
    listener - Listener to be notified when new User Data Relay message is received.
    
    See Also:
    
    AbstractXBeeDevice.removeUserDataRelayListener(IUserDataRelayReceiveListener), IUserDataRelayReceiveListener
  - close
```
public void close()
```
    Description copied from class: AbstractXBeeDevice
    
    Closes the connection interface associated with this XBee device.
    
    See Also:
    
    AbstractXBeeDevice.isOpen(), AbstractXBeeDevice.open()
  - getNetwork
```
public XBeeNetwork getNetwork()
```
    Description copied from class: AbstractXBeeDevice
    
    Returns the network associated with this XBee device.
    
    Returns:
    
    The XBee network of the device.
    
    See Also:
    
    XBeeNetwork
  - getNextFrameID
```
public int getNextFrameID()
```
    Description copied from class: AbstractXBeeDevice
    
    Returns the next Frame ID of this XBee device.
    
    Returns:
    
    The next Frame ID.
  - getOperatingMode
```
public OperatingMode getOperatingMode()
```
    Description copied from class: AbstractXBeeDevice
    
    Returns the Operating mode (AT, API or API escaped) of this XBee device for a local device, and the operating mode of the local device used as communication interface for a remote device.
    
    Returns:
    
    The operating mode of the local XBee device.
    
    See Also:
    
    AbstractXBeeDevice.isRemote(), OperatingMode
  - getReceiveTimeout
```
public int getReceiveTimeout()
```
    Description copied from class: AbstractXBeeDevice
    
    Returns this XBee device configured timeout for receiving packets in synchronous operations.
    
    Returns:
    
    The current receive timeout in milliseconds.
    
    See Also:
    
    AbstractXBeeDevice.setReceiveTimeout(int)
  - isOpen
```
public boolean isOpen()
```
    Description copied from class: AbstractXBeeDevice
    
    Returns whether the connection interface associated to this device is already open.
    
    Returns:
    
    true if the interface is open, false otherwise.
    
    See Also:
    
    AbstractXBeeDevice.close(), AbstractXBeeDevice.open()
  - isRemote
```
public boolean isRemote()
```
    Description copied from class: AbstractXBeeDevice
    
    Returns whether this XBee device is a remote device.
    
    Specified by:
    
    isRemote in class AbstractXBeeDevice
    
    Returns:
    
    true if this XBee device is a remote device, false otherwise.
  - open
```
public void open()
          throws XBeeException
```
    Description copied from class: AbstractXBeeDevice
    Opens the connection interface associated with this XBee device.
    When opening the device an information reading process is automatically performed. This includes:
    - 64-bit address.
    - Node Identifier.
    - Hardware version.
    - Firmware version.
    - XBee device protocol.
    - 16-bit address (not for DigiMesh modules).
    Throws:
    
    BluetoothAuthenticationException - if there is any problem in the Bluetooth authentication.
    
    XBeeException - if there is any problem opening this device connection.
    
    See Also:
    
    AbstractXBeeDevice.close(), AbstractXBeeDevice.isOpen()
  - readData
```
public XBeeMessage readData()
```
    Description copied from class: AbstractXBeeDevice
    
    Reads new data received by this XBee device during the configured receive timeout.
    This method blocks until new data is received or the configured receive timeout expires.
    
    The receive timeout is configured using the setReceiveTimeout method and can be consulted with getReceiveTimeout method.
    
    For non-blocking operations, register a IDataReceiveListener using the method AbstractXBeeDevice.addDataListener(IDataReceiveListener).
    
    Returns:
    
    An XBeeMessage object containing the data and the source address of the remote node that sent the data. null if this did not receive new data during the configured receive timeout.
    
    See Also:
    
    AbstractXBeeDevice.readData(int), AbstractXBeeDevice.getReceiveTimeout(), AbstractXBeeDevice.setReceiveTimeout(int), AbstractXBeeDevice.readDataFrom(RemoteXBeeDevice), AbstractXBeeDevice.readDataFrom(RemoteXBeeDevice, int), XBeeMessage
  - readData
```
public XBeeMessage readData(int timeout)
```
    Description copied from class: AbstractXBeeDevice
    
    Reads new data received by this XBee device during the provided timeout.
    This method blocks until new data is received or the provided timeout expires.
    
    For non-blocking operations, register a IDataReceiveListener using the method AbstractXBeeDevice.addDataListener(IDataReceiveListener).
    
    Parameters:
    
    timeout - The time to wait for new data in milliseconds.
    
    Returns:
    
    An XBeeMessage object containing the data and the source address of the remote node that sent the data. null if this device did not receive new data during timeout milliseconds.
    
    See Also:
    
    AbstractXBeeDevice.readData(), AbstractXBeeDevice.readDataFrom(RemoteXBeeDevice), AbstractXBeeDevice.readDataFrom(RemoteXBeeDevice, int), XBeeMessage
  - readDataFrom
```
public XBeeMessage readDataFrom(RemoteXBeeDevice remoteXBeeDevice)
```
    Description copied from class: AbstractXBeeDevice
    
    Reads new data received from the given remote XBee device during the configured receive timeout.
    This method blocks until new data from the provided remote XBee device is received or the configured receive timeout expires.
    
    The receive timeout is configured using the setReceiveTimeout method and can be consulted with getReceiveTimeout method.
    
    For non-blocking operations, register a IDataReceiveListener using the method AbstractXBeeDevice.addDataListener(IDataReceiveListener).
    
    Parameters:
    
    remoteXBeeDevice - The remote device to read data from.
    
    Returns:
    
    An XBeeMessage object containing the data and the source address of the remote node that sent the data. null if this device did not receive new data from the provided remote XBee device during the configured receive timeout.
    
    See Also:
    
    AbstractXBeeDevice.readDataFrom(RemoteXBeeDevice, int), AbstractXBeeDevice.getReceiveTimeout(), AbstractXBeeDevice.setReceiveTimeout(int), AbstractXBeeDevice.readData(), AbstractXBeeDevice.readData(int), RemoteXBeeDevice, XBeeMessage
  - readDataFrom
```
public XBeeMessage readDataFrom(RemoteXBeeDevice remoteXBeeDevice,
                                int timeout)
```
    Description copied from class: AbstractXBeeDevice
    
    Reads new data received from the given remote XBee device during the provided timeout.
    This method blocks until new data from the provided remote XBee device is received or the given timeout expires.
    
    For non-blocking operations, register a IDataReceiveListener using the method AbstractXBeeDevice.addDataListener(IDataReceiveListener).
    
    Parameters:
    
    remoteXBeeDevice - The remote device to read data from.
    
    timeout - The time to wait for new data in milliseconds.
    
    Returns:
    
    An XBeeMessage object containing the data and the source address of the remote node that sent the data. null if this device did not receive new data from the provided remote XBee device during timeout milliseconds.
    
    See Also:
    
    AbstractXBeeDevice.readDataFrom(RemoteXBeeDevice), AbstractXBeeDevice.getReceiveTimeout(), AbstractXBeeDevice.setReceiveTimeout(int), AbstractXBeeDevice.readData(), AbstractXBeeDevice.readData(int), RemoteXBeeDevice, XBeeMessage
  - removeBluetoothDataListener
```
public void removeBluetoothDataListener(IBluetoothDataReceiveListener listener)
```
    Description copied from class: AbstractXBeeDevice
    
    Removes the provided listener from the list of data receive listeners for the Bluetooth interface.
    If the listener was not in the list this method does nothing.
    
    Parameters:
    
    listener - Listener to be removed from the list of listeners.
    
    See Also:
    
    AbstractXBeeDevice.addBluetoothDataListener(IBluetoothDataReceiveListener), IBluetoothDataReceiveListener
  - removeDataListener
```
public void removeDataListener(IDataReceiveListener listener)
```
    Description copied from class: AbstractXBeeDevice
    
    Removes the provided listener from the list of data listeners for remote XBee devices.
    If the listener was not in the list this method does nothing.
    
    Parameters:
    
    listener - Listener to be removed from the list of listeners.
    
    See Also:
    
    AbstractXBeeDevice.addDataListener(IDataReceiveListener), IDataReceiveListener
  - removeIOSampleListener
```
public void removeIOSampleListener(IIOSampleReceiveListener listener)
```
    Description copied from class: AbstractXBeeDevice
    
    Removes the provided listener from the list of IO samples listeners.
    If the listener was not in the list this method does nothing.
    
    Parameters:
    
    listener - Listener to be removed from the list of listeners.
    
    See Also:
    
    AbstractXBeeDevice.addIOSampleListener(IIOSampleReceiveListener), IIOSampleReceiveListener
  - removeMicroPythonDataListener
```
public void removeMicroPythonDataListener(IMicroPythonDataReceiveListener listener)
```
    Description copied from class: AbstractXBeeDevice
    
    Removes the provided listener from the list of data receive listeners for the MicroPython interface.
    If the listener was not in the list this method does nothing.
    
    Parameters:
    
    listener - Listener to be removed from the list of listeners.
    
    See Also:
    
    AbstractXBeeDevice.addMicroPythonDataListener(IMicroPythonDataReceiveListener), IMicroPythonDataReceiveListener
  - removeModemStatusListener
```
public void removeModemStatusListener(IModemStatusReceiveListener listener)
```
    Description copied from class: AbstractXBeeDevice
    
    Removes the provided listener from the list of Modem Status listeners.
    If the listener was not in the list this method does nothing.
    
    Parameters:
    
    listener - Listener to be removed from the list of listeners.
    
    See Also:
    
    AbstractXBeeDevice.addModemStatusListener(IModemStatusReceiveListener), IModemStatusReceiveListener
  - removePacketListener
```
public void removePacketListener(IPacketReceiveListener listener)
```
    Description copied from class: AbstractXBeeDevice
    
    Removes the provided listener from the list of packets listeners.
    If the listener was not in the list this method does nothing.
    
    Parameters:
    
    listener - Listener to be removed from the list of listeners.
    
    See Also:
    
    AbstractXBeeDevice.addPacketListener(IPacketReceiveListener), IPacketReceiveListener
  - removeUserDataRelayListener
```
public void removeUserDataRelayListener(IUserDataRelayReceiveListener listener)
```
    Description copied from class: AbstractXBeeDevice
    
    Removes the provided listener from the list of User Data Relay listeners.
    If the listener was not in the list this method does nothing.
    
    Parameters:
    
    listener - Listener to be removed from the list of listeners.
    
    See Also:
    
    AbstractXBeeDevice.addUserDataRelayListener(IUserDataRelayReceiveListener), IUserDataRelayReceiveListener
  - reset
```
public void reset()
           throws TimeoutException,
                  XBeeException
```
    Description copied from class: AbstractXBeeDevice
    
    Performs a software reset on this XBee device and blocks until the process is completed.
    
    Specified by:
    
    reset in class AbstractXBeeDevice
    
    Throws:
    
    TimeoutException - if the configured time expires while waiting for the command reply.
    
    XBeeException - if there is any other XBee related exception.
  - sendBluetoothData
```
public void sendBluetoothData(byte[] data)
                       throws XBeeException
```
    Description copied from class: AbstractXBeeDevice
    
    Sends the given data to the XBee Bluetooth interface in a User Data Relay frame.
    
    Parameters:
    
    data - Data to send.
    
    Throws:
    
    XBeeException - if there is any XBee related exception sending the data.
    
    See Also:
    
    AbstractXBeeDevice.sendMicroPythonData(byte[]), AbstractXBeeDevice.sendUserDataRelay(XBeeLocalInterface, byte[])
  - sendBroadcastData
```
public void sendBroadcastData(byte[] data)
                       throws TimeoutException,
                              XBeeException
```
    Description copied from class: AbstractXBeeDevice
    
    Sends the provided data to all the XBee nodes of the network (broadcast).
    This method blocks till a success or error transmit status arrives or the configured receive timeout expires.
    
    The receive timeout is configured using the setReceiveTimeout method and can be consulted with getReceiveTimeout method.
    
    Parameters:
    
    data - Byte array containing the data to be sent.
    
    Throws:
    
    TimeoutException - if there is a timeout sending the data.
    
    XBeeException - if there is any other XBee related exception.
    
    See Also:
    
    AbstractXBeeDevice.getReceiveTimeout(), AbstractXBeeDevice.setReceiveTimeout(int)
  - sendData
```
public void sendData(RemoteXBeeDevice remoteXBeeDevice,
                     byte[] data)
              throws TimeoutException,
                     XBeeException
```
    Description copied from class: AbstractXBeeDevice
    
    Sends the provided data to the given XBee device choosing the optimal send method depending on the protocol of the local XBee device.
    This method blocks till a success or error response arrives or the configured receive timeout expires.
    
    The receive timeout is configured using the setReceiveTimeout method and can be consulted with getReceiveTimeout method.
    
    For non-blocking operations use the method AbstractXBeeDevice.sendDataAsync(RemoteXBeeDevice, byte[]).
    
    Parameters:
    
    remoteXBeeDevice - The XBee device of the network that will receive the data.
    
    data - Byte array containing the data to be sent.
    
    Throws:
    
    TimeoutException - if there is a timeout sending the data.
    
    XBeeException - if there is any other XBee related exception.
    
    See Also:
    
    AbstractXBeeDevice.getReceiveTimeout(), AbstractXBeeDevice.setReceiveTimeout(int), AbstractXBeeDevice.sendData(XBee64BitAddress, byte[]), AbstractXBeeDevice.sendData(XBee64BitAddress, XBee16BitAddress, byte[]), AbstractXBeeDevice.sendDataAsync(RemoteXBeeDevice, byte[]), AbstractXBeeDevice.sendDataAsync(XBee64BitAddress, byte[]), AbstractXBeeDevice.sendDataAsync(XBee64BitAddress, XBee16BitAddress, byte[]), RemoteXBeeDevice
  - sendDataAsync
```
public void sendDataAsync(RemoteXBeeDevice remoteXBeeDevice,
                          byte[] data)
                   throws XBeeException
```
    Description copied from class: AbstractXBeeDevice
    
    Sends the provided data to the provided XBee device asynchronously choosing the optimal send method depending on the protocol of the local XBee device.
    Asynchronous transmissions do not wait for answer from the remote device or for transmit status packet.
    
    Parameters:
    
    remoteXBeeDevice - The XBee device of the network that will receive the data.
    
    data - Byte array containing the data to be sent.
    
    Throws:
    
    XBeeException - if there is any XBee related exception.
    
    See Also:
    
    AbstractXBeeDevice.sendData(RemoteXBeeDevice, byte[]), AbstractXBeeDevice.sendData(XBee64BitAddress, byte[]), AbstractXBeeDevice.sendData(XBee64BitAddress, XBee16BitAddress, byte[]), AbstractXBeeDevice.sendDataAsync(XBee64BitAddress, byte[]), AbstractXBeeDevice.sendDataAsync(XBee64BitAddress, XBee16BitAddress, byte[]), RemoteXBeeDevice
  - sendMicroPythonData
```
public void sendMicroPythonData(byte[] data)
                         throws XBeeException
```
    Description copied from class: AbstractXBeeDevice
    
    Sends the given data to the XBee MicroPython interface in a User Data Relay frame.
    
    Parameters:
    
    data - Data to send.
    
    Throws:
    
    XBeeException - if there is any XBee related exception sending the data.
    
    See Also:
    
    AbstractXBeeDevice.sendBluetoothData(byte[]), AbstractXBeeDevice.sendUserDataRelay(XBeeLocalInterface, byte[])
  - sendPacket
```
public XBeePacket sendPacket(XBeePacket packet)
                      throws TimeoutException,
                             XBeeException
```
    Description copied from class: AbstractXBeeDevice
    
    Sends the given XBee packet synchronously and blocks until the response is received or the configured receive timeout expires.
    The receive timeout is configured using the setReceiveTimeout method and can be consulted with getReceiveTimeout method.
    
    Use sendXBeePacketAsync(XBeePacket) or #sendXBeePacket(XBeePacket, IPacketReceiveListener) for non-blocking operations.
    
    Parameters:
    
    packet - XBee packet to be sent.
    
    Returns:
    
    An XBeePacket object containing the response of the sent packet or null if there is no response.
    
    Throws:
    
    TimeoutException - if there is a timeout sending the XBee packet.
    
    XBeeException - if there is any other XBee related exception.
    
    See Also:
    
    AbstractXBeeDevice.getReceiveTimeout(), AbstractXBeeDevice.sendXBeePacket(XBeePacket, IPacketReceiveListener), AbstractXBeeDevice.sendXBeePacketAsync(XBeePacket), AbstractXBeeDevice.setReceiveTimeout(int), XBeePacket
  - sendPacket
```
public void sendPacket(XBeePacket packet,
                       IPacketReceiveListener packetReceiveListener)
                throws XBeeException
```
    Description copied from class: AbstractXBeeDevice
    
    Sends the given XBee packet and registers the given packet listener (if not null) to be notified when the answers is received.
    This is a non-blocking operation. To wait for the answer use sendPacket(XBeePacket).
    
    Parameters:
    
    packet - XBee packet to be sent.
    
    packetReceiveListener - Listener for the operation, null not to be notified when the answer arrives.
    
    Throws:
    
    XBeeException - if there is any other XBee related exception.
    
    See Also:
    
    AbstractXBeeDevice.sendPacket(XBeePacket), AbstractXBeeDevice.sendPacketAsync(XBeePacket), IPacketReceiveListener, XBeePacket
  - sendPacketAsync
```
public void sendPacketAsync(XBeePacket packet)
                     throws XBeeException
```
    Description copied from class: AbstractXBeeDevice
    
    Sends the given XBee packet asynchronously.
    This is a non-blocking operation that do not wait for the answer and is never notified when it arrives.
    
    To be notified when the answer is received, use AbstractXBeeDevice.sendXBeePacket(XBeePacket, IPacketReceiveListener).
    
    Parameters:
    
    packet - XBee packet to be sent asynchronously.
    
    Throws:
    
    XBeeException - if there is any other XBee related exception.
    
    See Also:
    
    AbstractXBeeDevice.sendXBeePacket(XBeePacket), AbstractXBeeDevice.sendXBeePacket(XBeePacket, IPacketReceiveListener), XBeePacket
  - sendUserDataRelay
```
public void sendUserDataRelay(XBeeLocalInterface destInterface,
                              byte[] data)
                       throws XBeeException
```
    Description copied from class: AbstractXBeeDevice
    
    Sends the given data to the given XBee local interface.
    
    Parameters:
    
    destInterface - Destination XBee local interface.
    
    data - Data to send.
    
    Throws:
    
    XBeeException - if there is any XBee related exception sending the User Data Relay message.
    
    See Also:
    
    XBeeLocalInterface
  - setReceiveTimeout
```
public void setReceiveTimeout(int receiveTimeout)
```
    Description copied from class: AbstractXBeeDevice
    
    Configures this XBee device timeout in milliseconds for receiving packets in synchronous operations.
    
    Parameters:
    
    receiveTimeout - The new receive timeout in milliseconds.
    
    See Also:
    
    AbstractXBeeDevice.getReceiveTimeout()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractXBeeDevice

Class XBeeDevice

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

XBeeDevice

XBeeDevice

XBeeDevice

XBeeDevice

Method Detail

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