com.digi.xbee.api

Class CellularDevice

java.lang.Object

com.digi.xbee.api.AbstractXBeeDevice

com.digi.xbee.api.XBeeDevice

com.digi.xbee.api.IPDevice

com.digi.xbee.api.CellularDevice

public class CellularDevice
extends IPDevice

This class represents a local Cellular device.

Since:

1.2.0

See Also:

DigiPointDevice, DigiMeshDevice, Raw802Device, ThreadDevice, WiFiDevice, XBeeDevice, ZigBeeDevice

Field Summary

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

BROADCAST_IP

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addSMSListener(ISMSReceiveListener listener) Adds the provided listener to the list of listeners to be notified when new SMS is received.
CellularAssociationIndicationStatus	getCellularAssociationIndicationStatus() Returns the current association status of this Cellular device.
XBeeIMEIAddress	getIMEIAddress() Returns the IMEI address of this Cellular device.
XBeeProtocol	getXBeeProtocol() Returns the XBee Protocol of this XBee device.
boolean	isConnected() Returns whether the device is connected to the Internet or not.
void	open() Opens the connection interface associated with this XBee device.
void	readDeviceInfo() Reads some parameters from this device and obtains its protocol.
void	removeSMSListener(ISMSReceiveListener listener) Removes the provided listener from the list of SMS listeners.
void	sendSMS(String phoneNumber, String data) Sends the provided SMS message to the given phone number.
void	sendSMSAsync(String phoneNumber, String data) Sends asynchronously the provided SMS to the given phone number.

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

addIPDataListener, getDestinationIPAddress, getIPAddress, 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, readPacket, readPacket, readPacketFrom, readPacketFrom, 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

CellularDevice

public CellularDevice(IConnectionInterface connectionInterface)

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

Parameters:

connectionInterface - The connection interface with the physical Cellular device.

Throws:

NullPointerException - if connectionInterface == null

See Also:

CellularDevice(String, int), CellularDevice(String, SerialPortParameters), CellularDevice(String, int, int, int, int, int), IConnectionInterface

CellularDevice

public CellularDevice(String port,
                      int baudRate)

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

Parameters:

port - Serial port name where Cellular 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:

CellularDevice(IConnectionInterface), CellularDevice(String, SerialPortParameters), CellularDevice(String, int, int, int, int, int)

CellularDevice

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

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

Parameters:

port - Serial port name where Cellular 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:

CellularDevice(IConnectionInterface), CellularDevice(String, int), CellularDevice(String, SerialPortParameters)

CellularDevice

public CellularDevice(String port,
                      SerialPortParameters serialPortParameters)

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

Parameters:

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

serialPortParameters - Object containing the serial port parameters.

Throws:

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

See Also:

CellularDevice(IConnectionInterface), CellularDevice(String, int), CellularDevice(String, int, int, int, int, int), SerialPortParameters

Method Detail

addSMSListener

public void addSMSListener(ISMSReceiveListener listener)

Description copied from class: AbstractXBeeDevice

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

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

Parameters:

listener - Listener to be notified when new SMS is received.

See Also:

AbstractXBeeDevice.removeSMSListener(ISMSReceiveListener), ISMSReceiveListener

getCellularAssociationIndicationStatus

public CellularAssociationIndicationStatus getCellularAssociationIndicationStatus()
                                                                           throws TimeoutException,
                                                                                  XBeeException

Returns the current association status of this Cellular device.

It indicates occurrences of errors during the modem initialization and connection.

Returns:

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

CellularAssociationIndicationStatus

getIMEIAddress

public XBeeIMEIAddress getIMEIAddress()

Returns the IMEI address of this Cellular device.

To refresh this value use the readDeviceInfo() method.

Returns:

The IMEI address of this Cellular device.

See Also:

XBeeIMEIAddress

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 the Internet or not.

Returns:

true if the device is connected to the Internet, 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:

getCellularAssociationIndicationStatus(), CellularAssociationIndicationStatus

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()

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 IPDevice

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)

removeSMSListener

public void removeSMSListener(ISMSReceiveListener listener)

Description copied from class: AbstractXBeeDevice

Removes the provided listener from the list of SMS 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.addSMSListener(ISMSReceiveListener), ISMSReceiveListener

sendSMS

public void sendSMS(String phoneNumber,
                    String data)
             throws TimeoutException,
                    XBeeException

Sends the provided SMS message to the given phone number.

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 sendSMSAsync(String, String).

Parameters:

phoneNumber - The phone number to send the SMS to.

data - String containing the text of the SMS.

Throws:

IllegalArgumentException - if phoneNumber.length() > 20 or if phoneNumber is invalid.

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if phoneNumber == null or if data == null.

TimeoutException - if there is a timeout sending the SMS.

XBeeException - if there is any other XBee related exception.

See Also:

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

sendSMSAsync

public void sendSMSAsync(String phoneNumber,
                         String data)
                  throws TimeoutException,
                         XBeeException

Sends asynchronously the provided SMS to the given phone number.

Asynchronous transmissions do not wait for answer or for transmit status packet.

Parameters:

phoneNumber - The phone number to send the SMS to.

data - String containing the text of the SMS.

Throws:

IllegalArgumentException - if phoneNumber.length() > 20 or if phoneNumber is invalid.

InterfaceNotOpenException - if this device connection is not open.

NullPointerException - if phoneNumber == null or if data == null.

TimeoutException - if there is a timeout sending the SMS.

XBeeException - if there is any other XBee related exception.

See Also:

sendSMS(String, String)