com.digi.xbee.api

Class DigiMeshDevice

java.lang.Object

com.digi.xbee.api.AbstractXBeeDevice

com.digi.xbee.api.XBeeDevice

com.digi.xbee.api.DigiMeshDevice

public class DigiMeshDevice
extends XBeeDevice

This class represents a local DigiMesh device.

See Also:

XBeeDevice, DigiPointDevice, Raw802Device, ZigBeeDevice

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addExplicitDataListener(IExplicitDataReceiveListener listener) Adds the provided listener to the list of listeners to be notified when new explicit data packets are received.
APIOutputMode	getAPIOutputMode() Returns the API output mode of the XBee device.
XBeeNetwork	getNetwork() Returns the network associated with this XBee device.
XBeeProtocol	getXBeeProtocol() Returns the XBee Protocol of this XBee device.
void	open() Opens the connection interface associated with this XBee device.
ExplicitXBeeMessage	readExplicitData() Reads new explicit data received by this XBee device during the configured receive timeout.
ExplicitXBeeMessage	readExplicitData(int timeout) Reads new explicit data received by this XBee device during the provided timeout.
ExplicitXBeeMessage	readExplicitDataFrom(RemoteXBeeDevice remoteXBeeDevice) Reads new explicit data received from the given remote XBee device during the configured receive timeout.
ExplicitXBeeMessage	readExplicitDataFrom(RemoteXBeeDevice remoteXBeeDevice, int timeout) Reads new explicit data received from the given remote XBee device during the provided timeout.
void	removeExplicitDataListener(IExplicitDataReceiveListener listener) Removes the provided listener from the list of explicit data receive listeners.
void	sendBroadcastExplicitData(int sourceEndpoint, int destEndpoint, int clusterID, int profileID, byte[] data) Sends the provided data to all the XBee nodes of the network (broadcast) in application layer mode.
void	sendData(XBee64BitAddress address, byte[] data) Sends the provided data to the XBee device of the network corresponding to the given 64-bit address.
void	sendDataAsync(XBee64BitAddress address, byte[] data) Sends asynchronously the provided data to the XBee device of the network corresponding to the given 64-bit address.
void	sendExplicitData(RemoteXBeeDevice remoteXBeeDevice, int sourceEndpoint, int destEndpoint, int clusterID, int profileID, byte[] data) Sends the provided data to the given XBee device in application layer mode choosing the optimal send method depending on the protocol of the local XBee device.
void	sendExplicitData(XBee64BitAddress address, int sourceEndpoint, int destEndpoint, int clusterID, int profileID, byte[] data) Sends the provided data in application layer mode to the XBee device of the network corresponding to the given 64-bit address.
void	sendExplicitDataAsync(RemoteXBeeDevice xbeeDevice, int sourceEndpoint, int destEndpoint, int clusterID, int profileID, byte[] data) Sends asynchronously the provided data in application layer mode to the provided XBee device choosing the optimal send method depending on the protocol of the local XBee device.
void	sendExplicitDataAsync(XBee64BitAddress address, int sourceEndpoint, int destEndpoint, int clusterID, int profileID, byte[] data) Sends asynchronously the provided data in application layer mode to the XBee device of the network corresponding to the given 64-bit address.
void	setAPIOutputMode(APIOutputMode apiOutputMode) Configures the API output mode of the XBee device.

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

addDataListener, addIOSampleListener, addModemStatusListener, addPacketListener, close, getOperatingMode, getReceiveTimeout, isOpen, isRemote, readData, readData, readDataFrom, readDataFrom, removeDataListener, removeIOSampleListener, removeModemStatusListener, removePacketListener, reset, sendBroadcastData, sendData, sendDataAsync, sendPacket, sendPacket, sendPacketAsync, setReceiveTimeout, 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

DigiMeshDevice

public DigiMeshDevice(IConnectionInterface connectionInterface)

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

Parameters:

connectionInterface - The connection interface with the physical DigiMesh device.

Throws:

NullPointerException - if connectionInterface == null

See Also:

IConnectionInterface

DigiMeshDevice

public DigiMeshDevice(String port,
              int baudRate)

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

Parameters:

port - Serial port name where DigiMesh 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.

DigiMeshDevice

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

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

Parameters:

port - Serial port name where DigiMesh 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.

DigiMeshDevice

public DigiMeshDevice(String port,
              SerialPortParameters serialPortParameters)

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

Parameters:

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

serialPortParameters - Object containing the serial port parameters.

Throws:

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

See Also:

SerialPortParameters

Method Detail

addExplicitDataListener

public void addExplicitDataListener(IExplicitDataReceiveListener listener)

Description copied from class: AbstractXBeeDevice

Adds the provided listener to the list of listeners to be notified when new explicit data packets are received.

If the listener has been already included this method does nothing.

Parameters:

listener - Listener to be notified when new explicit data packets are received.

See Also:

AbstractXBeeDevice.removeExplicitDataListener(IExplicitDataReceiveListener), IExplicitDataReceiveListener

getAPIOutputMode

public APIOutputMode getAPIOutputMode()
                               throws TimeoutException,
                                      XBeeException

Description copied from class: XBeeDevice

Returns the API output mode of the XBee device.

The API output mode determines the format that the received data is output through the serial interface of the XBee device.

Returns:

The API output mode that the XBee device is configured with.

Throws:

TimeoutException - if there is a timeout getting the API output mode from the device.

XBeeException - if there is any other XBee related exception.

See Also:

XBeeDevice.setAPIOutputMode(APIOutputMode), APIOutputMode

getNetwork

public XBeeNetwork getNetwork()

Description copied from class: XBeeDevice

Returns the network associated with this XBee device.

Overrides:

getNetwork in class XBeeDevice

Returns:

The XBee network of the device.

See Also:

XBeeNetwork

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

open

public void open()
          throws XBeeException

Description copied from class: XBeeDevice

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:

XBeeException - if there is any problem opening this device connection.

See Also:

XBeeDevice.close(), XBeeDevice.isOpen()

readExplicitData

public ExplicitXBeeMessage readExplicitData()

Description copied from class: XBeeDevice

Reads new explicit data received by this XBee device during the configured receive timeout.

This method blocks until new explicit 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 IExplicitDataReceiveListener using the method AbstractXBeeDevice.addExplicitDataListener(IExplicitDataReceiveListener).

Returns:

An ExplicitXBeeMessage object containing the explicit data, the source address of the remote node that sent the data and other values related to the transmission. null if this did not receive new explicit data during the configured receive timeout.

See Also:

XBeeDevice.getReceiveTimeout(), XBeeDevice.readExplicitData(int), XBeeDevice.readExplicitDataFrom(RemoteXBeeDevice), XBeeDevice.readExplicitDataFrom(RemoteXBeeDevice, int), XBeeDevice.setReceiveTimeout(int), ExplicitXBeeMessage

readExplicitData

public ExplicitXBeeMessage readExplicitData(int timeout)

Description copied from class: XBeeDevice

Reads new explicit data received by this XBee device during the provided timeout.

This method blocks until new explicit data is received or the provided timeout expires.

For non-blocking operations, register a IExplicitDataReceiveListener using the method AbstractXBeeDevice.addExplicitDataListener(IExplicitDataReceiveListener).

Parameters:

timeout - The time to wait for new explicit data in milliseconds.

Returns:

An ExplicitXBeeMessage object containing the explicit data, the source address of the remote node that sent the data and other values related to the transmission. null if this device did not receive new explicit data during timeout milliseconds.

See Also:

XBeeDevice.readExplicitData(), XBeeDevice.readExplicitDataFrom(RemoteXBeeDevice), XBeeDevice.readExplicitDataFrom(RemoteXBeeDevice, int), ExplicitXBeeMessage

readExplicitDataFrom

public ExplicitXBeeMessage readExplicitDataFrom(RemoteXBeeDevice remoteXBeeDevice)

Description copied from class: XBeeDevice

Reads new explicit data received from the given remote XBee device during the configured receive timeout.

This method blocks until new explicit 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 IExplicitDataReceiveListener using the method AbstractXBeeDevice.addExplicitDataListener(IExplicitDataReceiveListener).

Parameters:

remoteXBeeDevice - The remote device to read explicit data from.

Returns:

An ExplicitXBeeMessage object containing the explicit data, the source address of the remote node that sent the data and other values related to the transmission. null if this device did not receive new explicit data from the provided remote XBee device during the configured receive timeout.

See Also:

XBeeDevice.getReceiveTimeout(), XBeeDevice.readExplicitData(), XBeeDevice.readExplicitData(int), XBeeDevice.readExplicitDataFrom(RemoteXBeeDevice, int), XBeeDevice.setReceiveTimeout(int), RemoteXBeeDevice, ExplicitXBeeMessage

readExplicitDataFrom

public ExplicitXBeeMessage readExplicitDataFrom(RemoteXBeeDevice remoteXBeeDevice,
                                       int timeout)

Description copied from class: XBeeDevice

Reads new explicit data received from the given remote XBee device during the provided timeout.

This method blocks until new explicit data from the provided remote XBee device is received or the given timeout expires.

For non-blocking operations, register a IExplicitDataReceiveListener using the method AbstractXBeeDevice.addExplicitDataListener(IExplicitDataReceiveListener).

Parameters:

remoteXBeeDevice - The remote device to read explicit data from.

timeout - The time to wait for new explicit data in milliseconds.

Returns:

An ExplicitXBeeMessage object containing the explicit data, the source address of the remote node that sent the data and other values related to the transmission. null if this device did not receive new data from the provided remote XBee device during timeout milliseconds.

See Also:

XBeeDevice.getReceiveTimeout(), XBeeDevice.readExplicitData(), XBeeDevice.readExplicitData(int), XBeeDevice.readExplicitDataFrom(RemoteXBeeDevice), XBeeDevice.setReceiveTimeout(int), RemoteXBeeDevice, ExplicitXBeeMessage

removeExplicitDataListener

public void removeExplicitDataListener(IExplicitDataReceiveListener listener)

Description copied from class: AbstractXBeeDevice

Removes the provided listener from the list of explicit data receive 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.addExplicitDataListener(IExplicitDataReceiveListener), IExplicitDataReceiveListener

sendBroadcastExplicitData

public void sendBroadcastExplicitData(int sourceEndpoint,
                             int destEndpoint,
                             int clusterID,
                             int profileID,
                             byte[] data)
                               throws TimeoutException,
                                      XBeeException

Description copied from class: XBeeDevice

Sends the provided data to all the XBee nodes of the network (broadcast) in application layer mode. Application layer mode means that you need to specify the application layer fields to be sent with the data.

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:

sourceEndpoint - Source endpoint for the transmission.

destEndpoint - Destination endpoint for the transmission.

clusterID - Cluster ID used in the transmission.

profileID - Profile ID used in the transmission.

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:

XBeeDevice.getReceiveTimeout(), XBeeDevice.setReceiveTimeout(int)

sendData

public void sendData(XBee64BitAddress address,
            byte[] data)
              throws TimeoutException,
                     XBeeException

Description copied from class: XBeeDevice

Sends the provided data to the XBee device of the network corresponding to the given 64-bit address.

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 XBeeDevice.sendDataAsync(XBee64BitAddress, byte[]).

Parameters:

address - The 64-bit address of the XBee 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:

XBeeDevice.getReceiveTimeout(), XBeeDevice.setReceiveTimeout(int), XBeeDevice.sendData(RemoteXBeeDevice, byte[]), XBeeDevice.sendData(XBee64BitAddress, XBee16BitAddress, byte[]), XBeeDevice.sendDataAsync(RemoteXBeeDevice, byte[]), XBeeDevice.sendDataAsync(XBee64BitAddress, byte[]), XBeeDevice.sendDataAsync(XBee64BitAddress, XBee16BitAddress, byte[]), XBee64BitAddress

sendDataAsync

public void sendDataAsync(XBee64BitAddress address,
                 byte[] data)
                   throws XBeeException

Description copied from class: XBeeDevice

Sends asynchronously the provided data to the XBee device of the network corresponding to the given 64-bit address.

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

Parameters:

address - The 64-bit address of the XBee 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:

XBeeDevice.sendData(RemoteXBeeDevice, byte[]), XBeeDevice.sendData(XBee64BitAddress, byte[]), XBeeDevice.sendData(XBee64BitAddress, XBee16BitAddress, byte[]), XBeeDevice.sendDataAsync(RemoteXBeeDevice, byte[]), XBeeDevice.sendDataAsync(XBee64BitAddress, XBee16BitAddress, byte[]), XBee64BitAddress

sendExplicitData

public void sendExplicitData(RemoteXBeeDevice remoteXBeeDevice,
                    int sourceEndpoint,
                    int destEndpoint,
                    int clusterID,
                    int profileID,
                    byte[] data)
                      throws TimeoutException,
                             XBeeException

Description copied from class: XBeeDevice

Sends the provided data to the given XBee device in application layer mode choosing the optimal send method depending on the protocol of the local XBee device. Application layer mode means that you need to specify the application layer fields to be sent with the data.

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.

Parameters:

remoteXBeeDevice - The XBee device of the network that will receive the explicit data.

sourceEndpoint - Source endpoint for the transmission.

destEndpoint - Destination endpoint for the transmission.

clusterID - Cluster ID used in the transmission.

profileID - Profile ID used in the transmission.

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:

XBeeDevice.getReceiveTimeout(), XBeeDevice.sendExplicitData(XBee64BitAddress, int, int, int, int, byte[]), XBeeDevice.sendExplicitData(XBee64BitAddress, XBee16BitAddress, int, int, int, int, byte[]), XBeeDevice.setReceiveTimeout(int), RemoteXBeeDevice

sendExplicitData

public void sendExplicitData(XBee64BitAddress address,
                    int sourceEndpoint,
                    int destEndpoint,
                    int clusterID,
                    int profileID,
                    byte[] data)
                      throws TimeoutException,
                             XBeeException

Description copied from class: XBeeDevice

Sends the provided data in application layer mode to the XBee device of the network corresponding to the given 64-bit address. Application layer mode means that you need to specify the application layer fields to be sent with the data.

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.

Parameters:

address - The 64-bit address of the XBee that will receive the data.

sourceEndpoint - Source endpoint for the transmission.

destEndpoint - Destination endpoint for the transmission.

clusterID - Cluster ID used in the transmission.

profileID - Profile ID used in the transmission.

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:

XBeeDevice.getReceiveTimeout(), XBeeDevice.sendExplicitData(RemoteXBeeDevice, int, int, int, int, byte[]), XBeeDevice.sendExplicitData(XBee64BitAddress, XBee16BitAddress, int, int, int, int, byte[]), XBeeDevice.setReceiveTimeout(int), XBee64BitAddress

sendExplicitDataAsync

public void sendExplicitDataAsync(RemoteXBeeDevice xbeeDevice,
                         int sourceEndpoint,
                         int destEndpoint,
                         int clusterID,
                         int profileID,
                         byte[] data)
                           throws XBeeException

Description copied from class: XBeeDevice

Sends asynchronously the provided data in application layer mode to the provided XBee device choosing the optimal send method depending on the protocol of the local XBee device. Application layer mode means that you need to specify the application layer fields to be sent with the data.

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

Parameters:

xbeeDevice - The XBee device of the network that will receive the data.

sourceEndpoint - Source endpoint for the transmission.

destEndpoint - Destination endpoint for the transmission.

clusterID - Cluster ID used in the transmission.

profileID - Profile ID used in the transmission.

data - Byte array containing the data to be sent.

Throws:

XBeeException - if there is any other XBee related exception.

See Also:

XBeeDevice.sendExplicitData(RemoteXBeeDevice, int, int, int, int, byte[]), XBeeDevice.sendExplicitData(XBee64BitAddress, int, int, int, int, byte[]), XBeeDevice.sendExplicitData(XBee64BitAddress, XBee16BitAddress, int, int, int, int, byte[]), XBeeDevice.sendExplicitDataAsync(XBee64BitAddress, int, int, int, int, byte[]), XBeeDevice.sendExplicitDataAsync(XBee64BitAddress, XBee16BitAddress, int, int, int, int, byte[]), RemoteXBeeDevice

sendExplicitDataAsync

public void sendExplicitDataAsync(XBee64BitAddress address,
                         int sourceEndpoint,
                         int destEndpoint,
                         int clusterID,
                         int profileID,
                         byte[] data)
                           throws XBeeException

Description copied from class: XBeeDevice

Sends asynchronously the provided data in application layer mode to the XBee device of the network corresponding to the given 64-bit address. Application layer mode means that you need to specify the application layer fields to be sent with the data.

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

Parameters:

address - The 64-bit address of the XBee that will receive the data.

sourceEndpoint - Source endpoint for the transmission.

destEndpoint - Destination endpoint for the transmission.

clusterID - Cluster ID used in the transmission.

profileID - Profile ID used in the transmission.

data - Byte array containing the data to be sent.

Throws:

XBeeException - if there is any other XBee related exception.

See Also:

XBeeDevice.sendExplicitData(RemoteXBeeDevice, int, int, int, int, byte[]), XBeeDevice.sendExplicitData(XBee64BitAddress, int, int, int, int, byte[]), XBeeDevice.sendExplicitData(XBee64BitAddress, XBee16BitAddress, int, int, int, int, byte[]), XBeeDevice.sendExplicitDataAsync(RemoteXBeeDevice, int, int, int, int, byte[]), XBeeDevice.sendExplicitDataAsync(XBee64BitAddress, XBee16BitAddress, int, int, int, int, byte[]), XBee64BitAddress

setAPIOutputMode

public void setAPIOutputMode(APIOutputMode apiOutputMode)
                      throws TimeoutException,
                             XBeeException

Description copied from class: XBeeDevice

Configures the API output mode of the XBee device.

The API output mode determines the format that the received data is output through the serial interface of the XBee device.

Parameters:

apiOutputMode - The API output mode to be set to the XBee device.

Throws:

TimeoutException - if there is a timeout configuring the API output mode.

XBeeException - if there is any other XBee related exception.

See Also:

XBeeDevice.getAPIOutputMode(), APIOutputMode