com.digi.xbee.api

Class RemoteRaw802Device

java.lang.Object

com.digi.xbee.api.AbstractXBeeDevice

com.digi.xbee.api.RemoteXBeeDevice

com.digi.xbee.api.RemoteRaw802Device

public class RemoteRaw802Device
extends RemoteXBeeDevice

This class represents a remote 802.15.4 device.

See Also:

RemoteXBeeDevice, RemoteDigiMeshDevice, RemoteDigiPointDevice, RemoteZigBeeDevice

Constructor Summary

Constructors

Constructor and Description
RemoteRaw802Device(Raw802Device localXBeeDevice, XBee16BitAddress addr16) Class constructor.
RemoteRaw802Device(Raw802Device localXBeeDevice, XBee64BitAddress addr64) Class constructor.
RemoteRaw802Device(XBeeDevice localXBeeDevice, XBee16BitAddress addr16) Class constructor.
RemoteRaw802Device(XBeeDevice localXBeeDevice, XBee64BitAddress addr64, XBee16BitAddress addr16, String id) Class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
AssociationIndicationStatus	getAssociationIndicationStatus() Returns the current association status of this XBee device.
XBeeProtocol	getXBeeProtocol() Returns the XBee Protocol of this XBee device.
void	set16BitAddress(XBee16BitAddress xbee16BitAddress) Configures the 16-bit address (network address) of this XBee device with the provided one.
void	set64BitAddress(XBee64BitAddress addr64) Sets the XBee64BitAddress of this remote 802.15.4 device.

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

isRemote, reset, toString

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

applyChanges, enableApplyConfigurationChanges, executeParameter, get16BitAddress, get64BitAddress, getADCValue, getConnectionInterface, getDestinationAddress, getDIOChangeDetection, getDIOValue, getFirmwareVersion, getHardwareVersion, getIOConfiguration, getIOSamplingRate, getNodeID, getPANID, getParameter, getPowerLevel, getPWMDutyCycle, isApplyConfigurationChangesEnabled, readDeviceInfo, readIOSample, setDestinationAddress, setDIOChangeDetection, setDIOValue, setIOConfiguration, setIOSamplingRate, setNodeID, setPANID, setParameter, setPowerLevel, setPWMDutyCycle, updateDeviceDataFrom, writeChanges

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RemoteRaw802Device

public RemoteRaw802Device(Raw802Device localXBeeDevice,
                  XBee16BitAddress addr16)

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

Parameters:

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

addr16 - The 16-bit address to identify this remote 802.15.4 device.

Throws:

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

See Also:

XBee16BitAddress

RemoteRaw802Device

public RemoteRaw802Device(Raw802Device localXBeeDevice,
                  XBee64BitAddress addr64)

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

Parameters:

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

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

Throws:

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

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

See Also:

XBee64BitAddress

RemoteRaw802Device

public RemoteRaw802Device(XBeeDevice localXBeeDevice,
                  XBee16BitAddress addr16)

Class constructor. Instantiates a new RemoteRaw802Device object interface to be used.

Parameters:

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

addr16 - The 16-bit address to identify this remote 802.15.4 device.

Throws:

IllegalArgumentException - if localXBeeDevice.getXBeeProtocol() != XBeeProtocol.RAW_802_15_4.

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

See Also:

XBee16BitAddress

RemoteRaw802Device

public RemoteRaw802Device(XBeeDevice localXBeeDevice,
                  XBee64BitAddress addr64,
                  XBee16BitAddress addr16,
                  String id)

Class constructor. Instantiates a new RemoteRaw802Device 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 802.15.4 device.

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

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

id - The node identifier of this remote 802.15.4 device. It might be null.

Throws:

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

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

See Also:

XBee16BitAddress, XBee64BitAddress

Method Detail

getAssociationIndicationStatus

public AssociationIndicationStatus getAssociationIndicationStatus()
                                                           throws TimeoutException,
                                                                  XBeeException

Description copied from class: AbstractXBeeDevice

Returns the current association status of this XBee device.

It indicates occurrences of errors during the last association request.

Returns:

The association indication status of the XBee device.

Throws:

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

XBeeException - if there is any other XBee related exception.

See Also:

AbstractXBeeDevice.forceDisassociate(), AssociationIndicationStatus

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

set16BitAddress

public void set16BitAddress(XBee16BitAddress xbee16BitAddress)
                     throws TimeoutException,
                            XBeeException

Description copied from class: AbstractXBeeDevice

Configures the 16-bit address (network address) of this XBee device with the provided one.

Parameters:

xbee16BitAddress - The new 16-bit address.

Throws:

TimeoutException - if there is a timeout setting the address.

XBeeException - if there is any other XBee related exception.

See Also:

AbstractXBeeDevice.get16BitAddress(), XBee16BitAddress

set64BitAddress

public void set64BitAddress(XBee64BitAddress addr64)

Sets the XBee64BitAddress of this remote 802.15.4 device.

Parameters:

addr64 - The 64-bit address to be set to the device.

See Also:

XBee64BitAddress