com.digi.xbee.api

Class WiFiDevice

java.lang.Object

com.digi.xbee.api.AbstractXBeeDevice

com.digi.xbee.api.XBeeDevice

com.digi.xbee.api.IPDevice

com.digi.xbee.api.WiFiDevice

public class WiFiDevice
extends IPDevice

This class represents a local Wi-Fi device.

Since:

1.2.0

See Also:

CellularDevice, DigiPointDevice, DigiMeshDevice, Raw802Device, ThreadDevice, XBeeDevice, ZigBeeDevice

Field Summary

Fields inherited from class com.digi.xbee.api.IPDevice

BROADCAST_IP

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	connect(AccessPoint accessPoint, String password) Connects to the provided access point.
boolean	connect(String ssid, String password) Connects to the access point with provided SSID.
boolean	disconnect() Disconnects from the access point the device is connected to.
AccessPoint	getAccessPoint(String ssid) Finds and reports the access point that matches the supplied SSID.
int	getAccessPointTimeout() Returns the configured access point timeout for connecting, disconnecting and scanning access points.
Inet4Address	getDNSAddress() Returns the IP address of domain name server.
Inet4Address	getGatewayIPAddress() Returns the IP address of the gateway.
IPAddressingMode	getIPAddressingMode() Returns the IP addressing mode.
Inet4Address	getIPAddressMask() Returns the IP address subnet mask.
WiFiAssociationIndicationStatus	getWiFiAssociationIndicationStatus() Returns the current association status of this Wi-Fi device.
XBeeProtocol	getXBeeProtocol() Returns the XBee Protocol of this XBee device.
boolean	isConnected() Returns whether the device is connected to an access point or not.
void	open() Opens the connection interface associated with this XBee device.
List<AccessPoint>	scanAccessPoints() Performs a scan to search for access points in the vicinity.
void	setAccessPointTimeout(int accessPointTimeout) Configures the access point timeout in milliseconds for connecting, disconnecting and scanning access points.
void	setDNSAddress(Inet4Address address) Sets the IP address of domain name server.
void	setGatewayIPAddress(Inet4Address address) Sets the IP address of the gateway.
void	setIPAddress(Inet4Address address) Sets the IP address of the module.
void	setIPAddressingMode(IPAddressingMode mode) Sets the IP addressing mode.
void	setIPAddressMask(Inet4Address address) Sets the IP address subnet mask.

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

addIPDataListener, getDestinationIPAddress, getIPAddress, readDeviceInfo, readIPData, readIPData, readIPDataFrom, readIPDataFrom, removeIPDataListener, sendBroadcastIPData, sendIPData, sendIPData, sendIPDataAsync, sendIPDataAsync, setDestinationIPAddress, startListening, stopListening

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

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

Constructor Detail

WiFiDevice

public WiFiDevice(IConnectionInterface connectionInterface)

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

Parameters:

connectionInterface - The connection interface with the physical Wi-Fi device.

Throws:

NullPointerException - if connectionInterface == null

See Also:

WiFiDevice(String, int), WiFiDevice(String, SerialPortParameters), WiFiDevice(String, int, int, int, int, int), IConnectionInterface

WiFiDevice

public WiFiDevice(String port,
                  int baudRate)

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

Parameters:

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

See Also:

WiFiDevice(IConnectionInterface), WiFiDevice(String, SerialPortParameters), WiFiDevice(String, int, int, int, int, int)

WiFiDevice

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

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

Parameters:

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

See Also:

WiFiDevice(IConnectionInterface), WiFiDevice(String, int), WiFiDevice(String, SerialPortParameters)

WiFiDevice

public WiFiDevice(String port,
                  SerialPortParameters serialPortParameters)

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

Parameters:

port - Serial port name where Wi-Fi device is attached to.

serialPortParameters - Object containing the serial port parameters.

Throws:

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

See Also:

WiFiDevice(IConnectionInterface), WiFiDevice(String, int), WiFiDevice(String, int, int, int, int, int), SerialPortParameters

Method Detail

connect

public boolean connect(AccessPoint accessPoint,
                       String password)
                throws TimeoutException,
                       XBeeException

Connects to the provided access point.

This method blocks until the connection with the access point is established or the configured access point timeout expires.

The access point timeout is configured using the setAccessPointTimeout method and can be consulted with getAccessPointTimeout method.

Once the module is connected to the access point, you can issue the writeSettings method to save the connection settings. This way the module will try to connect to the access point every time it is powered on.

Parameters:

accessPoint - The access point to connect to.

password - The password for the access point, null if it does not have any encryption enabled.

Returns:

true if the module connected to the access point successfully, false otherwise.

Throws:

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if accessPoint == null.

TimeoutException - if there is a timeout sending the connect commands.

XBeeException - if there is any other XBee related exception.

See Also:

connect(String, String), disconnect(), getAccessPoint(String), getAccessPointTimeout(), scanAccessPoints(), setAccessPointTimeout(int), AccessPoint

connect

public boolean connect(String ssid,
                       String password)
                throws TimeoutException,
                       XBeeException

Connects to the access point with provided SSID.

This method blocks until the connection with the access point is established or the configured access point timeout expires.

The access point timeout is configured using the setAccessPointTimeout method and can be consulted with getAccessPointTimeout method.

Once the module is connected to the access point, you can issue the AbstractXBeeDevice.writeChanges() method to save the connection settings. This way the module will try to connect to the access point every time it is powered on.

Parameters:

ssid - The SSID of the access point to connect to.

password - The password for the access point, null if it does not have any encryption enabled.

Returns:

true if the module connected to the access point successfully, false otherwise.

Throws:

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if ssid == null.

TimeoutException - if there is a timeout sending the connect commands.

XBeeException - if the SSID provided is null or if there is any other XBee related exception.

See Also:

connect(AccessPoint, String), disconnect(), getAccessPoint(String), getAccessPointTimeout(), scanAccessPoints(), setAccessPointTimeout(int)

disconnect

public boolean disconnect()
                   throws TimeoutException,
                          XBeeException

Disconnects from the access point the device is connected to.

This method blocks until the device disconnects totally from the access point or the configured access point timeout expires.

The access point timeout is configured using the setAccessPointTimeout method and can be consulted with getAccessPointTimeout method.

Returns:

true if the module disconnected from the access point successfully, false otherwise.

Throws:

InterfaceNotOpenException - if this device connection is not open.

TimeoutException - if there is a timeout sending the disconnect command.

XBeeException - if there is any other XBee related exception.

See Also:

connect(AccessPoint, String), connect(String, String), getAccessPointTimeout(), setAccessPointTimeout(int)

getAccessPoint

public AccessPoint getAccessPoint(String ssid)
                           throws XBeeException

Finds and reports the access point that matches the supplied SSID.

This method blocks until the access point is discovered or the configured access point timeout expires.

The access point timeout is configured using the setAccessPointTimeout method and can be consulted with getAccessPointTimeout method.

Parameters:

ssid - The SSID of the access point to discover.

Returns:

The discovered access point with the given SSID, null if the timeout expires and the access point was not found.

Throws:

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if ssid == null.

TimeoutException - if there is a timeout getting the access point.

XBeeException - if there is an error sending the discovery command.

See Also:

getAccessPointTimeout(), scanAccessPoints(), setAccessPointTimeout(int)

getAccessPointTimeout

public int getAccessPointTimeout()

Returns the configured access point timeout for connecting, disconnecting and scanning access points.

Returns:

The current access point timeout in milliseconds.

See Also:

setAccessPointTimeout(int)

getDNSAddress

public Inet4Address getDNSAddress()
                           throws TimeoutException,
                                  XBeeException

Returns the IP address of domain name server.

Returns:

The configured DNS address.

Throws:

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

XBeeException - if there is any other XBee related exception.

See Also:

setDNSAddress(Inet4Address), Inet4Address

getGatewayIPAddress

public Inet4Address getGatewayIPAddress()
                                 throws TimeoutException,
                                        XBeeException

Returns the IP address of the gateway.

Returns:

The configured IP address of the gateway.

Throws:

TimeoutException - if there is a timeout reading the gateway IP address.

XBeeException - if there is any other XBee related exception.

See Also:

setGatewayIPAddress(Inet4Address), Inet4Address

getIPAddressingMode

public IPAddressingMode getIPAddressingMode()
                                     throws TimeoutException,
                                            XBeeException

Returns the IP addressing mode.

Returns:

The configured IP addressing mode.

Throws:

TimeoutException - if there is a timeout reading the IP addressing mode.

XBeeException - if there is any other XBee related exception.

See Also:

setIPAddressingMode(IPAddressingMode), IPAddressingMode

getIPAddressMask

public Inet4Address getIPAddressMask()
                              throws TimeoutException,
                                     XBeeException

Returns the IP address subnet mask.

Returns:

The configured IP address subnet mask.

Throws:

TimeoutException - if there is a timeout reading the IP address mask.

XBeeException - if there is any other XBee related exception.

See Also:

setIPAddressMask(Inet4Address), Inet4Address

getWiFiAssociationIndicationStatus

public WiFiAssociationIndicationStatus getWiFiAssociationIndicationStatus()
                                                                   throws TimeoutException,
                                                                          XBeeException

Returns the current association status of this Wi-Fi device.

It indicates occurrences of errors during the Wi-Fi transceiver initialization and connection.

Returns:

The association indication status of the Wi-Fi 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:

WiFiAssociationIndicationStatus

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

isConnected

public boolean isConnected()
                    throws TimeoutException,
                           XBeeException

Returns whether the device is connected to an access point or not.

Returns:

true if the device is connected to an access point, false otherwise.

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:

getWiFiAssociationIndicationStatus(), WiFiAssociationIndicationStatus

open

public void open()
          throws XBeeException

Description copied from class: AbstractXBeeDevice

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:

BluetoothAuthenticationException - if there is any problem in the Bluetooth authentication.

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

See Also:

AbstractXBeeDevice.close(), AbstractXBeeDevice.isOpen()

scanAccessPoints

public List<AccessPoint> scanAccessPoints()
                                   throws XBeeException

Performs a scan to search for access points in the vicinity.

This method blocks until all the access points are discovered or the configured access point timeout expires.

The access point timeout is configured using the setAccessPointTimeout method and can be consulted with getAccessPointTimeout method.

Returns:

The list of access points discovered.

Throws:

InterfaceNotOpenException - if this device connection is not open.

TimeoutException - if there is a timeout scanning the access points.

XBeeException - if there is any other XBee related exception.

See Also:

getAccessPoint(String), getAccessPointTimeout(), setAccessPointTimeout(int)

setAccessPointTimeout

public void setAccessPointTimeout(int accessPointTimeout)

Configures the access point timeout in milliseconds for connecting, disconnecting and scanning access points.

Parameters:

accessPointTimeout - The new access point timeout in milliseconds.

Throws:

IllegalArgumentException - if accessPointTimeout < 0.

See Also:

getAccessPointTimeout()

setDNSAddress

public void setDNSAddress(Inet4Address address)
                   throws TimeoutException,
                          XBeeException

Sets the IP address of domain name server.

Parameters:

address - DNS address.

Throws:

NullPointerException - if address == null.

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

XBeeException - if there is any other XBee related exception.

See Also:

getDNSAddress(), Inet4Address

setGatewayIPAddress

public void setGatewayIPAddress(Inet4Address address)
                         throws TimeoutException,
                                XBeeException

Sets the IP address of the gateway.

This method can only be called if the module is configured in IPAddressingMode.STATIC mode. Otherwise an XBeeException will be thrown.

Parameters:

address - IP address of the gateway.

Throws:

NullPointerException - if address == null.

TimeoutException - if there is a timeout setting the gateway IP address.

XBeeException - if the module is in IPAddressingMode.DHCP mode or there is any other XBee related exception.

See Also:

getGatewayIPAddress(), getIPAddressingMode(), Inet4Address

setIPAddress

public void setIPAddress(Inet4Address address)
                  throws TimeoutException,
                         XBeeException

Sets the IP address of the module.

This method can only be called if the module is configured in IPAddressingMode.STATIC mode. Otherwise an XBeeException will be thrown.

Parameters:

address - IP address.

Throws:

NullPointerException - if address == null.

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

XBeeException - if the module is in IPAddressingMode.DHCP mode or there is any other XBee related exception.

See Also:

IPDevice.getIPAddress(), getIPAddressingMode(), Inet4Address

setIPAddressingMode

public void setIPAddressingMode(IPAddressingMode mode)
                         throws TimeoutException,
                                XBeeException

Sets the IP addressing mode.

Parameters:

mode - IP addressing mode.

Throws:

NullPointerException - if mode == null.

TimeoutException - if there is a timeout setting the IP addressing mode.

XBeeException - if there is any other XBee related exception.

See Also:

getIPAddressingMode(), IPAddressingMode

setIPAddressMask

public void setIPAddressMask(Inet4Address address)
                      throws TimeoutException,
                             XBeeException

Sets the IP address subnet mask.

This method can only be called if the module is configured in IPAddressingMode.STATIC mode. Otherwise an XBeeException will be thrown.

Parameters:

address - IP address subnet mask.

Throws:

NullPointerException - if address == null.

TimeoutException - if there is a timeout setting the IP address mask.

XBeeException - if the module is in IPAddressingMode.DHCP mode or there is any other XBee related exception.

See Also:

getIPAddressingMode(), getIPAddressMask(), Inet4Address