com.digi.xbee.api

Class RemoteXBeeDevice

java.lang.Object

com.digi.xbee.api.AbstractXBeeDevice

com.digi.xbee.api.RemoteXBeeDevice

Direct Known Subclasses:

RemoteDigiMeshDevice, RemoteDigiPointDevice, RemoteRaw802Device, RemoteThreadDevice, RemoteZigBeeDevice

public class RemoteXBeeDevice
extends AbstractXBeeDevice

This class represents a remote XBee device.

See Also:

RemoteDigiMeshDevice, RemoteDigiPointDevice, RemoteRaw802Device, RemoteThreadDevice, RemoteZigBeeDevice

Constructor Summary

Constructors

Constructor and Description
RemoteXBeeDevice(AbstractXBeeDevice localXBeeDevice, Inet6Address ipv6Addr) Class constructor.
RemoteXBeeDevice(AbstractXBeeDevice localXBeeDevice, Inet6Address ipv6Addr, String ni) Class constructor.
RemoteXBeeDevice(AbstractXBeeDevice localXBeeDevice, XBee64BitAddress addr64) Class constructor.
RemoteXBeeDevice(AbstractXBeeDevice localXBeeDevice, XBee64BitAddress addr64, XBee16BitAddress addr16, String ni) Class constructor.

Method Summary

Modifier and Type	Method and Description
boolean	isRemote() Always returns true, since it is a remote device.
void	reset() Performs a software reset on this XBee device and blocks until the process is completed.
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

RemoteXBeeDevice

public RemoteXBeeDevice(AbstractXBeeDevice localXBeeDevice,
                        Inet6Address ipv6Addr)

Class constructor. Instantiates a new RemoteXBeeDevice 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 XBee device.

ipv6Addr - The IPv6 address to identify this XBee device.

Throws:

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

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

See Also:

Inet6Address

RemoteXBeeDevice

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

Class constructor. Instantiates a new RemoteXBeeDevice 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 XBee device.

ipv6Addr - The IPv6 address to identify this XBee device.

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

Throws:

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

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

See Also:

Inet6Address

RemoteXBeeDevice

public RemoteXBeeDevice(AbstractXBeeDevice localXBeeDevice,
                        XBee64BitAddress addr64)

Class constructor. Instantiates a new RemoteXBeeDevice 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 XBee device.

addr64 - The 64-bit address to identify this remote XBee device.

Throws:

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

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

See Also:

XBee64BitAddress

RemoteXBeeDevice

public RemoteXBeeDevice(AbstractXBeeDevice localXBeeDevice,
                        XBee64BitAddress addr64,
                        XBee16BitAddress addr16,
                        String ni)

Class constructor. Instantiates a new RemoteXBeeDevice 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 XBee device.

addr64 - The 64-bit address to identify this remote XBee device.

addr16 - The 16-bit address to identify this remote XBee device. It might be null.

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

Throws:

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

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

See Also:

XBee16BitAddress, XBee64BitAddress

Method Detail

isRemote

public boolean isRemote()

Always returns true, since it is a remote device.

Specified by:

isRemote in class AbstractXBeeDevice

Returns:

true always.

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.

toString

public String toString()

Overrides:

toString in class AbstractXBeeDevice