com.digi.xbee.api

Class ThreadDevice

java.lang.Object

com.digi.xbee.api.AbstractXBeeDevice

com.digi.xbee.api.XBeeDevice

com.digi.xbee.api.IPv6Device

com.digi.xbee.api.ThreadDevice

public class ThreadDevice
extends IPv6Device

This class represents a local Thread device.

Since:

1.2.1

See Also:

CellularDevice, DigiPointDevice, DigiMeshDevice, Raw802Device, WiFiDevice, XBeeDevice, ZigBeeDevice

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ThreadAssociationIndicationStatus	getThreadAssociationIndicationStatus() Returns the current association status of this Thread device.
XBeeProtocol	getXBeeProtocol() Returns the XBee Protocol of this XBee device.
boolean	isConnected() Returns whether the device is associated to a network or not.
void	open() Opens the connection interface associated with this XBee device.
byte[]	sendCoAPData(Inet6Address ipv6Address, String uri, HTTPMethodEnum method, boolean applyChanges, byte[] data) Sends the provided CoAP IPv6 data to the given IPv6 address and port using the specified IPv6 protocol.
byte[]	sendCoAPData(Inet6Address ipv6Address, String uri, HTTPMethodEnum method, byte[] data) Sends the provided CoAP IPv6 data to the given IPv6 address and port using the specified IPv6 protocol.
void	sendCoAPDataAsync(Inet6Address ipv6Address, String uri, HTTPMethodEnum method, boolean applyChanges, byte[] data) Sends the provided CoAP IPv6 data to the given IPv6 address and port asynchronously using the specified IPv6 protocol.
void	sendCoAPDataAsync(Inet6Address ipv6Address, String uri, HTTPMethodEnum method, byte[] data) Sends the provided CoAP IPv6 data to the given IPv6 address and port asynchronously using the specified IPv6 protocol.
void	sendIPData(Inet6Address ipv6Address, int destPort, IPProtocol protocol, byte[] data) Sends the provided IPv6 data to the given IPv6 address and port using the specified IPv6 protocol.
void	sendIPDataAsync(Inet6Address ipv6Address, int destPort, IPProtocol protocol, byte[] data) Sends the provided IPv6 data to the given IPv6 address and port asynchronously using the specified IPv6 protocol.

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

addIPDataListener, readDeviceInfo, readIPData, readIPData, readIPDataFrom, readIPDataFrom, removeIPDataListener, startListening, stopListening

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

addBluetoothDataListener, addDataListener, addIOSampleListener, addMicroPythonDataListener, addModemStatusListener, addPacketListener, addUserDataRelayListener, close, getNetwork, getNextFrameID, getOperatingMode, getReceiveTimeout, isOpen, isRemote, readData, readData, readDataFrom, readDataFrom, readPacket, readPacket, readPacketFrom, readPacketFrom, 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

applyChanges, disableBluetooth, enableApplyConfigurationChanges, enableBluetooth, executeParameter, get16BitAddress, get64BitAddress, getADCValue, getBluetoothMacAddress, getConnectionInterface, getDestinationAddress, getDIOChangeDetection, getDIOValue, getFirmwareVersion, getHardwareVersion, getIOConfiguration, getIOSamplingRate, getIPv6Address, getIPv6DestinationAddress, getNodeID, getPANID, getParameter, getPowerLevel, getPWMDutyCycle, isApplyConfigurationChangesEnabled, 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

ThreadDevice

public ThreadDevice(IConnectionInterface connectionInterface)

Class constructor. Instantiates a new ThreadDevice object with the given connection interface.

Parameters:

connectionInterface - The connection interface with the physical Thread device.

Throws:

NullPointerException - if connectionInterface == null

See Also:

ThreadDevice(String, int), ThreadDevice(String, SerialPortParameters), ThreadDevice(String, int, int, int, int, int), IConnectionInterface

ThreadDevice

public ThreadDevice(String port,
                    int baudRate)

Class constructor. Instantiates a new ThreadDevice object in the given port name and baud rate.

Parameters:

port - Serial port name where Thread 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:

ThreadDevice(IConnectionInterface), ThreadDevice(String, SerialPortParameters), ThreadDevice(String, int, int, int, int, int)

ThreadDevice

public ThreadDevice(String port,
                    int baudRate,
                    int dataBits,
                    int stopBits,
                    int parity,
                    int flowControl)

Class constructor. Instantiates a new ThreadDevice object in the given serial port name and settings.

Parameters:

port - Serial port name where Thread 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:

ThreadDevice(IConnectionInterface), ThreadDevice(String, int), ThreadDevice(String, SerialPortParameters)

ThreadDevice

public ThreadDevice(String port,
                    SerialPortParameters serialPortParameters)

Class constructor. Instantiates a new ThreadDevice object in the given serial port name and parameters.

Parameters:

port - Serial port name where Thread device is attached to.

serialPortParameters - Object containing the serial port parameters.

Throws:

NullPointerException - if port == null or if serialPortParameters == null.

See Also:

ThreadDevice(IConnectionInterface), ThreadDevice(String, int), ThreadDevice(String, int, int, int, int, int), SerialPortParameters

Method Detail

getThreadAssociationIndicationStatus

public ThreadAssociationIndicationStatus getThreadAssociationIndicationStatus()
                                                                       throws TimeoutException,
                                                                              XBeeException

Returns the current association status of this Thread device.

Returns:

The association indication status of the Thread device.

Throws:

InterfaceNotOpenException - if this device connection is not open.

TimeoutException - if there is a timeout getting the association indication status.

XBeeException - if there is any other XBee related exception.

See Also:

ThreadAssociationIndicationStatus

getXBeeProtocol

public XBeeProtocol getXBeeProtocol()

Description copied from class: AbstractXBeeDevice

Returns the XBee Protocol of this XBee device.

To refresh this value use the AbstractXBeeDevice.readDeviceInfo() method.

Overrides:

getXBeeProtocol in class AbstractXBeeDevice

Returns:

The XBee device protocol.

See Also:

XBeeProtocol

isConnected

public boolean isConnected()
                    throws TimeoutException,
                           XBeeException

Returns whether the device is associated to a network or not.

Returns:

true if the device is connected to a network, false otherwise.

Throws:

InterfaceNotOpenException - if this device connection is not open.

TimeoutException - if there is a timeout getting the association indication status.

XBeeException - if there is any other XBee related exception.

See Also:

getThreadAssociationIndicationStatus(), ThreadAssociationIndicationStatus

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).

Overrides:

open in class XBeeDevice

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()

sendCoAPData

public byte[] sendCoAPData(Inet6Address ipv6Address,
                           String uri,
                           HTTPMethodEnum method,
                           boolean applyChanges,
                           byte[] data)
                    throws TimeoutException,
                           IllegalArgumentException,
                           XBeeException

Sends the provided CoAP IPv6 data to the given IPv6 address and port using the specified IPv6 protocol.

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 sendCoAPDataAsync(Inet6Address, String, HTTPMethodEnum, boolean, byte[]).

Parameters:

ipv6Address - The IPv6 address to send CoAP IPv6 data to.

uri - Uniform Resource Identifier. Every CoAP message must have a valid URI string and must meet the following criteria. There are built-in CoAP URIs:

• CoAPURI.URI_DATA_TRANSMISSION: "XB/TX" for data transmissions (HTTP method must be set to PUT)
• CoAPURI.URI_AT_COMMAND: "XB/AT" for AT Command operation (HTTP method must be set to PUT or GET). After the URI, an AT command needs to be specified, for example: CoAPURI.URI_AT_COMMAND + "/NI"
• CoAPURI.URI_IO_SAMPLING: "XB/IO" for IO operation (HTTP method must be set to POST)

method - HTTP method used for the transmission.

applyChanges - true to apply the changes after sending the packet, false otherwise.

data - Byte array containing the CoAP IPv6 data to be sent.

Returns:

A byte array containing the response, if any. Otherwise, null.

Throws:

IllegalArgumentException - if uri starts with "XB/AT" and its length is lesser than 8 (XB/AT/XX).

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if ipv6Address == null or if uri == null or if method == null.

TimeoutException - if there is a timeout sending the data.

XBeeException - if there is any other XBee related exception.

See Also:

XBeeDevice.getReceiveTimeout(), sendCoAPData(Inet6Address, String, HTTPMethodEnum, byte[]), sendCoAPDataAsync(Inet6Address, String, HTTPMethodEnum, byte[]), sendCoAPDataAsync(Inet6Address, String, HTTPMethodEnum, boolean, byte[]), XBeeDevice.setReceiveTimeout(int), HTTPMethodEnum, Inet6Address

sendCoAPData

public byte[] sendCoAPData(Inet6Address ipv6Address,
                           String uri,
                           HTTPMethodEnum method,
                           byte[] data)
                    throws TimeoutException,
                           IllegalArgumentException,
                           XBeeException

Sends the provided CoAP IPv6 data to the given IPv6 address and port using the specified IPv6 protocol.

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 sendCoAPDataAsync(Inet6Address, String, HTTPMethodEnum, byte[]).

Parameters:

ipv6Address - The IPv6 address to send CoAP IPv6 data to.

uri - Uniform Resource Identifier. Every CoAP message must have a valid URI string and must meet the following criteria. There are built-in CoAP URIs:

• CoAPURI.URI_DATA_TRANSMISSION: "XB/TX" for data transmissions (HTTP method must be set to PUT)
• CoAPURI.URI_AT_COMMAND: "XB/AT" for AT Command operation (HTTP method must be set to PUT or GET). After the URI, an AT command needs to be specified, for example: CoAPURI.URI_AT_COMMAND + "/NI"
• CoAPURI.URI_IO_SAMPLING: "XB/IO" for IO operation (HTTP method must be set to POST)

method - HTTP method used for the transmission.

data - Byte array containing the CoAP IPv6 data to be sent.

Returns:

A byte array containing the response, if any. Otherwise, null.

Throws:

IllegalArgumentException - if uri starts with "XB/AT" and its length is lesser than 8 (XB/AT/XX).

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if ipv6Address == null or if uri == null or if method == null.

TimeoutException - if there is a timeout sending the data.

XBeeException - if there is any other XBee related exception.

See Also:

XBeeDevice.getReceiveTimeout(), sendCoAPData(Inet6Address, String, HTTPMethodEnum, boolean, byte[]), sendCoAPDataAsync(Inet6Address, String, HTTPMethodEnum, byte[]), sendCoAPDataAsync(Inet6Address, String, HTTPMethodEnum, boolean, byte[]), XBeeDevice.setReceiveTimeout(int), HTTPMethodEnum, Inet6Address

sendCoAPDataAsync

public void sendCoAPDataAsync(Inet6Address ipv6Address,
                              String uri,
                              HTTPMethodEnum method,
                              boolean applyChanges,
                              byte[] data)
                       throws TimeoutException,
                              IllegalArgumentException,
                              XBeeException

Sends the provided CoAP IPv6 data to the given IPv6 address and port asynchronously using the specified IPv6 protocol.

Asynchronous transmissions do not wait for answer from the remote device or for transmit status packet.

For blocking operations use the method sendCoAPData(Inet6Address, String, HTTPMethodEnum, boolean, byte[]).

Parameters:

ipv6Address - The IPv6 address to send CoAP IPv6 data to.

uri - Uniform Resource Identifier. Every CoAP message must have a valid URI string and must meet the following criteria. There are built-in CoAP URIs:

• CoAPURI.URI_DATA_TRANSMISSION: "XB/TX" for data transmissions (PUT)
• CoAPURI.URI_AT_COMMAND: "XB/AT" for AT Command operation (PUT or GET). After the URI, an AT command needs to be specified, for example: CoAPURI.URI_AT_COMMAND + "/NI"
• CoAPURI.URI_IO_SAMPLING: "XB/IO" for IO operation (POST)

method - HTTP method used for the transmission.

applyChanges - true to apply the changes after sending the packet, false otherwise.

data - Byte array containing the CoAP IPv6 data to be sent.

Throws:

IllegalArgumentException - if uri starts with "XB/AT" and its length is lesser than 8 (XB/AT/XX).

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if ipv6Address == null or if uri == null or if method == null.

TimeoutException - if there is a timeout sending the data.

XBeeException - if there is any other XBee related exception.

See Also:

XBeeDevice.getReceiveTimeout(), sendCoAPData(Inet6Address, String, HTTPMethodEnum, byte[]), sendCoAPData(Inet6Address, String, HTTPMethodEnum, boolean, byte[]), sendCoAPDataAsync(Inet6Address, String, HTTPMethodEnum, byte[]), XBeeDevice.setReceiveTimeout(int), HTTPMethodEnum, Inet6Address

sendCoAPDataAsync

public void sendCoAPDataAsync(Inet6Address ipv6Address,
                              String uri,
                              HTTPMethodEnum method,
                              byte[] data)
                       throws TimeoutException,
                              IllegalArgumentException,
                              XBeeException

Sends the provided CoAP IPv6 data to the given IPv6 address and port asynchronously using the specified IPv6 protocol.

Asynchronous transmissions do not wait for answer from the remote device or for transmit status packet.

For blocking operations use the method sendCoAPData(Inet6Address, String, HTTPMethodEnum, byte[]).

Parameters:

ipv6Address - The IPv6 address to send CoAP IPv6 data to.

uri - Uniform Resource Identifier. Every CoAP message must have a valid URI string and must meet the following criteria. There are built-in CoAP URIs:

• CoAPURI.URI_DATA_TRANSMISSION: "XB/TX" for data transmissions (PUT)
• CoAPURI.URI_AT_COMMAND: "XB/AT" for AT Command operation (PUT or GET). After the URI, an AT command needs to be specified, for example: CoAPURI.URI_AT_COMMAND + "/NI"
• CoAPURI.URI_IO_SAMPLING: "XB/IO" for IO operation (POST)

method - HTTP method used for the transmission.

data - Byte array containing the CoAP IPv6 data to be sent.

Throws:

IllegalArgumentException - if uri starts with "XB/AT" and its length is lesser than 8 (XB/AT/XX).

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if ipv6Address == null or if uri == null or if method == null.

TimeoutException - if there is a timeout sending the data.

XBeeException - if there is any other XBee related exception.

See Also:

XBeeDevice.getReceiveTimeout(), sendCoAPData(Inet6Address, String, HTTPMethodEnum, byte[]), sendCoAPData(Inet6Address, String, HTTPMethodEnum, boolean, byte[]), sendCoAPDataAsync(Inet6Address, String, HTTPMethodEnum, boolean, byte[]), XBeeDevice.setReceiveTimeout(int), HTTPMethodEnum, Inet6Address

sendIPData

public void sendIPData(Inet6Address ipv6Address,
                       int destPort,
                       IPProtocol protocol,
                       byte[] data)
                throws TimeoutException,
                       XBeeException

Description copied from class: IPv6Device

Sends the provided IPv6 data to the given IPv6 address and port using the specified IPv6 protocol.

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 IPv6Device.sendIPDataAsync(Inet6Address, int, IPProtocol, byte[]).

Overrides:

sendIPData in class IPv6Device

Parameters:

ipv6Address - The IPv6 address to send IPv6 data to.

destPort - The destination port of the transmission.

protocol - The IPv6 protocol used for the transmission.

data - Byte array containing the IPv6 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:

XBeeDevice.getReceiveTimeout(), IPv6Device.sendIPDataAsync(Inet6Address, int, IPProtocol, byte[]), XBeeDevice.setReceiveTimeout(int), IPProtocol, Inet6Address

sendIPDataAsync

public void sendIPDataAsync(Inet6Address ipv6Address,
                            int destPort,
                            IPProtocol protocol,
                            byte[] data)
                     throws XBeeException

Description copied from class: IPv6Device

Sends the provided IPv6 data to the given IPv6 address and port asynchronously using the specified IPv6 protocol.

Asynchronous transmissions do not wait for answer from the remote device or for transmit status packet.

Overrides:

sendIPDataAsync in class IPv6Device

Parameters:

ipv6Address - The IPv6 address to send IPv6 data to.

destPort - The destination port of the transmission.

protocol - The IPv6 protocol used for the transmission.

data - Byte array containing the IPv6 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:

IPv6Device.sendIPData(Inet6Address, int, IPProtocol, byte[]), IPProtocol, Inet6Address