com.digi.xbee.api

Class IPDevice

java.lang.Object

com.digi.xbee.api.AbstractXBeeDevice

com.digi.xbee.api.XBeeDevice

com.digi.xbee.api.IPDevice

Direct Known Subclasses:

CellularDevice, WiFiDevice

public class IPDevice
extends XBeeDevice

This class provides common functionality for XBee IP devices.

Since:

1.2.0

See Also:

CellularDevice, WiFiDevice

Field Summary

Fields

Modifier and Type	Field and Description
static String	BROADCAST_IP

Method Summary

Modifier and Type	Method and Description
void	addIPDataListener(IIPDataReceiveListener listener) Adds the provided listener to the list of listeners to be notified when new IP data is received.
Inet4Address	getDestinationIPAddress() Returns the destination IP address.
Inet4Address	getIPAddress() Returns the IP address of this IP device.
void	readDeviceInfo() Reads some parameters from this device and obtains its protocol.
IPMessage	readIPData() Reads new IP data received by this XBee device during the configured receive timeout.
IPMessage	readIPData(int timeout) Reads new IP data received by this XBee device during the provided timeout.
IPMessage	readIPDataFrom(Inet4Address ipAddress) Reads new IP data received from the given IP address during the configured receive timeout.
IPMessage	readIPDataFrom(Inet4Address ipAddress, int timeout) Reads new IP data received from the given IP address during the provided timeout.
void	removeIPDataListener(IIPDataReceiveListener listener) Removes the provided listener from the list of IP data listeners.
void	sendBroadcastIPData(int destPort, byte[] data) Sends the provided IP data to all clients.
void	sendIPData(Inet4Address ipAddress, int destPort, IPProtocol protocol, boolean closeSocket, byte[] data) Sends the provided IP data to the given IP address and port using the specified IP protocol.
void	sendIPData(Inet4Address ipAddress, int destPort, IPProtocol protocol, byte[] data) Sends the provided IP data to the given IP address and port using the specified IP protocol.
void	sendIPDataAsync(Inet4Address ipAddress, int destPort, IPProtocol protocol, boolean closeSocket, byte[] data) Sends the provided IP data to the given IP address and port asynchronously using the specified IP protocol.
void	sendIPDataAsync(Inet4Address ipAddress, int destPort, IPProtocol protocol, byte[] data) Sends the provided IP data to the given IP address and port asynchronously.
void	setDestinationIPAddress(Inet4Address address) Sets the destination IP address.
void	startListening(int sourcePort) Starts listening for incoming IP transmissions in the provided port.
void	stopListening() Stops listening for incoming IP transmissions.

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

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

Field Detail

BROADCAST_IP

public static final String BROADCAST_IP

See Also:

Constant Field Values

Method Detail

addIPDataListener

public void addIPDataListener(IIPDataReceiveListener listener)

Description copied from class: AbstractXBeeDevice

Adds the provided listener to the list of listeners to be notified when new IP data is received.

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

Parameters:

listener - Listener to be notified when new IP data is received.

See Also:

AbstractXBeeDevice.removeIPDataListener(IIPDataReceiveListener), IIPDataReceiveListener

getDestinationIPAddress

public Inet4Address getDestinationIPAddress()
                                     throws TimeoutException,
                                            XBeeException

Returns the destination IP address.

Returns:

The configured destination IP address.

Throws:

TimeoutException - if there is a timeout reading the destination address.

XBeeException - if there is any other XBee related exception.

See Also:

setDestinationIPAddress(Inet4Address), Inet4Address

getIPAddress

public Inet4Address getIPAddress()

Returns the IP address of this IP device.

To refresh this value use the readDeviceInfo() method.

Returns:

The IP address of this IP device.

See Also:

Inet4Address

readDeviceInfo

public void readDeviceInfo()
                    throws TimeoutException,
                           XBeeException

Description copied from class: AbstractXBeeDevice

Reads some parameters from this device and obtains its protocol.

This method refresh the values of:

• 64-bit address only if it is not initialized.
• Node Identifier.
• Hardware version if it is not initialized.
• Firmware version.
• XBee device protocol.
• 16-bit address (not for DigiMesh/DigiPoint modules).

Overrides:

readDeviceInfo in class AbstractXBeeDevice

Throws:

TimeoutException - if there is a timeout reading the parameters.

XBeeException - if there is any error trying to read the device information or if there is any other XBee related exception.

See Also:

AbstractXBeeDevice.get16BitAddress(), AbstractXBeeDevice.get64BitAddress(), AbstractXBeeDevice.getHardwareVersion(), AbstractXBeeDevice.getNodeID(), AbstractXBeeDevice.getFirmwareVersion(), AbstractXBeeDevice.getXBeeProtocol(), AbstractXBeeDevice.setNodeID(String)

readIPData

public IPMessage readIPData()

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

This method blocks until new IP 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 IIPDataReceiveListener using the method addIPDataListener(IIPDataReceiveListener).

Before reading IP data you need to start listening for incoming IP data at a specific port. Use the startListening method for that purpose. When finished, you can use the stopListening method to stop listening for incoming IP data.

Returns:

A IPMessage object containing the IP data and the IP address that sent the data. null if this did not receive new IP data during the configured receive timeout.

Throws:

InterfaceNotOpenException - if this device connection is not open.

See Also:

XBeeDevice.getReceiveTimeout(), readIPData(int), readIPDataFrom(Inet4Address), readIPDataFrom(Inet4Address, int), XBeeDevice.setReceiveTimeout(int), startListening(int), stopListening(), IPMessage

readIPData

public IPMessage readIPData(int timeout)

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

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

For non-blocking operations, register a IIPDataReceiveListener using the method addIPDataListener(IIPDataReceiveListener).

Before reading IP data you need to start listening for incoming IP data at a specific port. Use the startListening method for that purpose. When finished, you can use the stopListening method to stop listening for incoming IP data.

Parameters:

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

Returns:

A IPMessage object containing the data and the IP address that sent the data. null if this device did not receive new data during timeout milliseconds.

Throws:

IllegalArgumentException - if timeout < 0.

InterfaceNotOpenException - if this device connection is not open.

See Also:

readIPData(), readIPDataFrom(Inet4Address), readIPDataFrom(Inet4Address, int), startListening(int), stopListening(), IPMessage

readIPDataFrom

public IPMessage readIPDataFrom(Inet4Address ipAddress)

Reads new IP data received from the given IP address during the configured receive timeout.

This method blocks until new data from the provided IP address 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 IIPDataReceiveListener using the method addIPDataListener(IIPDataReceiveListener).

Before reading IP data you need to start listening for incoming IP data at a specific port. Use the startListening method for that purpose. When finished, you can use the stopListening method to stop listening for incoming IP data.

Parameters:

ipAddress - The IP address to read data from.

Returns:

A IPMessage object containing the IP data and the IP address of the remote node that sent the data. null if this device did not receive new IP data from the provided IP address during the configured receive timeout.

Throws:

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if ipAddress == null.

See Also:

XBeeDevice.getReceiveTimeout(), readIPData(), readIPData(int), readIPDataFrom(Inet4Address, int), XBeeDevice.setReceiveTimeout(int), startListening(int), stopListening(), IPMessage, Inet4Address

readIPDataFrom

public IPMessage readIPDataFrom(Inet4Address ipAddress,
                                int timeout)

Reads new IP data received from the given IP address during the provided timeout.

This method blocks until new IP data from the provided IP address is received or the given timeout expires.

For non-blocking operations, register a IIPDataReceiveListener using the method addIPDataListener(IIPDataReceiveListener).

Before reading IP data you need to start listening for incoming IP data at a specific port. Use the startListening method for that purpose. When finished, you can use the stopListening method to stop listening for incoming IP data.

Parameters:

ipAddress - The IP address to read data from.

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

Returns:

An IPMessage object containing the IP data and the IP address that sent the data. null if this device did not receive new IP data from the provided IP address during timeout milliseconds.

Throws:

IllegalArgumentException - if timeout < 0.

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if ipAddress == null.

See Also:

readIPDataFrom(Inet4Address), readIPData(), readIPData(int), startListening(int), stopListening(), IPMessage, Inet4Address

removeIPDataListener

public void removeIPDataListener(IIPDataReceiveListener listener)

Description copied from class: AbstractXBeeDevice

Removes the provided listener from the list of IP data 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.addIPDataListener(IIPDataReceiveListener), IIPDataReceiveListener

sendBroadcastIPData

public void sendBroadcastIPData(int destPort,
                                byte[] data)
                         throws TimeoutException,
                                XBeeException

Sends the provided IP data to all clients.

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:

destPort - The destination port of the transmission.

data - Byte array containing the IP data to be sent.

Throws:

IllegalArgumentException - if destPort < 0 or if destPort > 65535

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if data == null.

TimeoutException - if there is a timeout sending the data.

XBeeException - if there is any other XBee related exception.

See Also:

XBeeDevice.getReceiveTimeout(), sendIPData(Inet4Address, int, IPProtocol, byte[]), sendIPData(Inet4Address, int, IPProtocol, boolean, byte[]), sendIPDataAsync(Inet4Address, int, IPProtocol, byte[]), sendIPDataAsync(Inet4Address, int, IPProtocol, boolean, byte[]), XBeeDevice.setReceiveTimeout(int)

sendIPData

public void sendIPData(Inet4Address ipAddress,
                       int destPort,
                       IPProtocol protocol,
                       boolean closeSocket,
                       byte[] data)
                throws TimeoutException,
                       XBeeException

Sends the provided IP data to the given IP address and port using the specified IP protocol. For TCP and TCP SSL protocols, you can also indicate if the socket should be closed when data is sent.

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

Parameters:

ipAddress - The IP address to send IP data to.

destPort - The destination port of the transmission.

protocol - The IP protocol used for the transmission.

closeSocket - true to close the socket just after the transmission. false to keep it open.

data - Byte array containing the IP data to be sent.

Throws:

IllegalArgumentException - if destPort < 0 or if destPort > 65535

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if ipAddress == null or if protocol == null or if data == null.

TimeoutException - if there is a timeout sending the data.

XBeeException - if there is any other XBee related exception.

See Also:

XBeeDevice.getReceiveTimeout(), sendBroadcastIPData(int, byte[]), sendIPData(Inet4Address, int, IPProtocol, byte[]), sendIPDataAsync(Inet4Address, int, IPProtocol, byte[]), sendIPDataAsync(Inet4Address, int, IPProtocol, boolean, byte[]), XBeeDevice.setReceiveTimeout(int), IPProtocol, Inet4Address

sendIPData

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

Sends the provided IP data to the given IP address and port using the specified IP 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 sendIPDataAsync(Inet4Address, int, IPProtocol, byte[]).

Parameters:

ipAddress - The IP address to send IP data to.

destPort - The destination port of the transmission.

protocol - The IP protocol used for the transmission.

data - Byte array containing the IP data to be sent.

Throws:

IllegalArgumentException - if destPort < 0 or if destPort > 65535

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if ipAddress == null or if protocol == null or if data == null.

TimeoutException - if there is a timeout sending the data.

XBeeException - if there is any other XBee related exception.

See Also:

XBeeDevice.getReceiveTimeout(), sendBroadcastIPData(int, byte[]), sendIPData(Inet4Address, int, IPProtocol, boolean, byte[]), sendIPDataAsync(Inet4Address, int, IPProtocol, byte[]), sendIPDataAsync(Inet4Address, int, IPProtocol, boolean, byte[]), XBeeDevice.setReceiveTimeout(int), IPProtocol, Inet4Address

sendIPDataAsync

public void sendIPDataAsync(Inet4Address ipAddress,
                            int destPort,
                            IPProtocol protocol,
                            boolean closeSocket,
                            byte[] data)
                     throws XBeeException

Sends the provided IP data to the given IP address and port asynchronously using the specified IP protocol. For TCP and TCP SSL protocols, you can also indicate if the socket should be closed when data is sent.

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

Parameters:

ipAddress - The IP address to send IP data to.

destPort - The destination port of the transmission.

protocol - The IP protocol used for the transmission.

closeSocket - true to close the socket just after the transmission. false to keep it open.

data - Byte array containing the IP data to be sent.

Throws:

IllegalArgumentException - if destPort < 0 or if destPort > 65535

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if ipAddress == null or if protocol == null or if data == null.

TimeoutException - if there is a timeout sending the data.

XBeeException - if there is any other XBee related exception.

See Also:

sendBroadcastIPData(int, byte[]), sendIPData(Inet4Address, int, IPProtocol, byte[]), sendIPData(Inet4Address, int, IPProtocol, boolean, byte[]), sendIPDataAsync(Inet4Address, int, IPProtocol, byte[]), IPProtocol, Inet4Address

sendIPDataAsync

public void sendIPDataAsync(Inet4Address ipAddress,
                            int destPort,
                            IPProtocol protocol,
                            byte[] data)
                     throws TimeoutException,
                            XBeeException

Sends the provided IP data to the given IP address and port asynchronously.

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

Parameters:

ipAddress - The IP address to send IP data to.

destPort - The destination port of the transmission.

protocol - The IP protocol used for the transmission.

data - Byte array containing the IP data to be sent.

Throws:

IllegalArgumentException - if destPort < 0 or if destPort > 65535

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if ipAddress == null or if protocol == null or if data == null.

TimeoutException - if there is a timeout sending the data.

XBeeException - if there is any other XBee related exception.

See Also:

sendBroadcastIPData(int, byte[]), sendIPData(Inet4Address, int, IPProtocol, byte[]), sendIPData(Inet4Address, int, IPProtocol, boolean, byte[]), sendIPDataAsync(Inet4Address, int, IPProtocol, boolean, byte[]), IPProtocol, Inet4Address

setDestinationIPAddress

public void setDestinationIPAddress(Inet4Address address)
                             throws TimeoutException,
                                    XBeeException

Sets the destination IP address.

Parameters:

address - Destination IP address.

Throws:

NullPointerException - if address == null.

TimeoutException - if there is a timeout setting the destination address.

XBeeException - if there is any other XBee related exception.

See Also:

getDestinationIPAddress(), Inet4Address

startListening

public void startListening(int sourcePort)
                    throws TimeoutException,
                           XBeeException

Starts listening for incoming IP transmissions in the provided port.

Parameters:

sourcePort - Port to listen for incoming transmissions.

Throws:

IllegalArgumentException - if sourcePort < 0 or if sourcePort > 65535.

TimeoutException - if there is a timeout setting the source port.

XBeeException - if there is any error setting the source port.

See Also:

stopListening()

stopListening

public void stopListening()
                   throws TimeoutException,
                          XBeeException

Stops listening for incoming IP transmissions.

Throws:

TimeoutException - if there is a timeout processing the operation.

XBeeException - if there is any other XBee related exception.

See Also:

startListening(int)