com.digi.xbee.api

Class RemoteThreadDevice

java.lang.Object

com.digi.xbee.api.AbstractXBeeDevice

com.digi.xbee.api.RemoteXBeeDevice

com.digi.xbee.api.RemoteThreadDevice

public class RemoteThreadDevice
extends RemoteXBeeDevice

This class represents a remote Thread device.

Since:

1.2.1

See Also:

RemoteDigiMeshDevice, RemoteDigiPointDevice, RemoteRaw802Device, RemoteXBeeDevice, RemoteZigBeeDevice

Constructor Summary

Constructors

Constructor and Description
RemoteThreadDevice(AbstractXBeeDevice localXBeeDevice, Inet6Address ipv6Addr) Class constructor.
RemoteThreadDevice(AbstractXBeeDevice localXBeeDevice, Inet6Address ipv6Addr, String ni) Class constructor.
RemoteThreadDevice(ThreadDevice localXBeeDevice, Inet6Address ipv6Addr) Class constructor.

Method Summary

Modifier and Type	Method and Description
void	forceDisassociate() Forces this XBee device to immediately disassociate from the network and re-attempt to associate.
ThreadAssociationIndicationStatus	getThreadAssociationIndicationStatus() Returns the current association status of this Thread device.
XBeeProtocol	getXBeeProtocol() Returns the XBee Protocol of this XBee device.

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

isRemote, reset, 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, 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

RemoteThreadDevice

public RemoteThreadDevice(AbstractXBeeDevice localXBeeDevice,
                          Inet6Address ipv6Addr)

Class constructor. Instantiates a new RemoteThreadDevice object with the given local XBeeDevice which contains the connection interface to be used.

Parameters:

localXBeeDevice - The local XBee device that will behave as connection interface to communicate with this remote Thread device.

ipv6Addr - The IPv6 address to identify this remote Thread device.

Throws:

IllegalArgumentException - if localXBeeDevice.isRemote() == true or if localXBeeDevice.getXBeeProtocol() != XBeeProtocol.THREAD.

NullPointerException - if localXBeeDevice == null or if ipv6addr == null.

See Also:

RemoteThreadDevice(ThreadDevice, Inet6Address), RemoteThreadDevice(AbstractXBeeDevice, Inet6Address, String), XBeeDevice, Inet6Address

RemoteThreadDevice

public RemoteThreadDevice(AbstractXBeeDevice localXBeeDevice,
                          Inet6Address ipv6Addr,
                          String ni)

Class constructor. Instantiates a new RemoteThreadDevice object with the given local XBeeDevice which contains the connection interface to be used.

Parameters:

localXBeeDevice - The local XBee device that will behave as connection interface to communicate with this remote Thread device.

ipv6Addr - The IPv6 address to identify this remote Thread device.

ni - The node identifier of this remote Thread device. It might be null.

Throws:

IllegalArgumentException - if localXBeeDevice.isRemote() == true or if localXBeeDevice.getXBeeProtocol() != XBeeProtocol.THREAD.

NullPointerException - if localXBeeDevice == null or if ipv6Address == null.

See Also:

RemoteThreadDevice(ThreadDevice, Inet6Address), RemoteThreadDevice(AbstractXBeeDevice, Inet6Address), XBeeDevice, Inet6Address

RemoteThreadDevice

public RemoteThreadDevice(ThreadDevice localXBeeDevice,
                          Inet6Address ipv6Addr)

Class constructor. Instantiates a new RemoteThreadDevice object with the given local ThreadDevice which contains the connection interface to be used.

Parameters:

localXBeeDevice - The local Thread device that will behave as connection interface to communicate with this remote Thread device.

ipv6Addr - The IPv6 address to identify this remote Thread device.

Throws:

IllegalArgumentException - if localXBeeDevice.isRemote() == true.

NullPointerException - if localXBeeDevice == null or if ipv6addr == null.

See Also:

RemoteThreadDevice(AbstractXBeeDevice, Inet6Address), RemoteThreadDevice(AbstractXBeeDevice, Inet6Address, String), ThreadDevice, Inet6Address

Method Detail

forceDisassociate

public void forceDisassociate()
                       throws TimeoutException,
                              XBeeException

Description copied from class: AbstractXBeeDevice

Forces this XBee device to immediately disassociate from the network and re-attempt to associate.

Only valid for End Devices.

Throws:

TimeoutException - if there is a timeout executing the disassociation command.

XBeeException - if there is any other XBee related exception.

See Also:

AbstractXBeeDevice.getAssociationIndicationStatus()

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