com.digi.xbee.api.android

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

com.digi.xbee.api.android.CellularDevice

public class CellularDevice
extends com.digi.xbee.api.CellularDevice

This class represents a local Cellular device.

See Also:

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

Field Summary

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

BROADCAST_IP, DEFAULT_PROTOCOL, DEFAULT_SOURCE_PORT, ipAddress, sourcePort

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

bluetoothPassword, connectionInterface, currentFrameID, dataReader, DEFAULT_RECEIVE_TIMETOUT, ipv6Address, localXBeeDevice, logger, network, operatingMode, receiveTimeout, TIMEOUT_BEFORE_COMMAND_MODE, TIMEOUT_ENTER_COMMAND_MODE, TIMEOUT_READ_PACKET, xbee16BitAddress, xbee64BitAddress, xbeeProtocol

Constructor Summary

Constructors

Constructor and Description
CellularDevice(android.content.Context context, int baudRate) Class constructor.
CellularDevice(android.content.Context context, int baudRate, AndroidUSBPermissionListener permissionListener) Class constructor.
CellularDevice(android.content.Context context, java.lang.String port, int baudRate) Class constructor.
CellularDevice(android.content.Context context, java.lang.String port, com.digi.xbee.api.connection.serial.SerialPortParameters parameters) Class constructor.

Method Summary

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

addIOSampleListener, addSMSListener, get64BitAddress, getAssociationIndicationStatus, getCellularAssociationIndicationStatus, getDIOChangeDetection, getIMEIAddress, getIOSamplingRate, getNodeID, getPowerLevel, getXBeeProtocol, isConnected, open, readDeviceInfo, removeIOSampleListener, removeSMSListener, sendSMS, sendSMSAsync, setDIOChangeDetection, setIOSamplingRate, setNodeID, setPowerLevel

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

addDataListener, addIPDataListener, get16BitAddress, getDestinationAddress, getDestinationIPAddress, getIPAddress, getIPv6Address, getIPv6DestinationAddress, getNetwork, getPANID, readData, readData, readDataFrom, readDataFrom, readIPData, readIPData, readIPDataFrom, readIPDataFrom, removeDataListener, removeIPDataListener, sendBroadcastData, sendBroadcastIPData, sendData, sendDataAsync, sendIPData, sendIPData, sendIPDataAsync, sendIPDataAsync, setDestinationAddress, setDestinationIPAddress, setIPv6DestinationAddress, setPANID, startListening, stopListening

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

addBluetoothDataListener, addMicroPythonDataListener, addModemStatusListener, addPacketListener, addUserDataRelayListener, close, getNextFrameID, getOperatingMode, getReceiveTimeout, isOpen, isRemote, removeBluetoothDataListener, removeMicroPythonDataListener, removeModemStatusListener, removePacketListener, removeUserDataRelayListener, reset, sendBluetoothData, sendMicroPythonData, sendPacket, sendPacket, sendPacketAsync, sendUserDataRelay, setReceiveTimeout, toString

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

addExplicitDataListener, addSerialDataListener, applyChanges, checkATCommandResponseIsValid, determineOperatingMode, disableBluetooth, enableApplyConfigurationChanges, enableBluetooth, executeParameter, forceDisassociate, getADCValue, getAPIOutputMode, getBluetoothMacAddress, getConnectionInterface, getDIOValue, getFirmwareVersion, getHardwareVersion, getIOConfiguration, getParameter, getPWMDutyCycle, isApplyConfigurationChangesEnabled, readExplicitData, readExplicitData, readExplicitDataFrom, readExplicitDataFrom, readIOSample, removeExplicitDataListener, removeSerialDataListener, sendAndCheckCoAPPacket, sendAndCheckXBeePacket, sendATCommand, sendBroadcastExplicitData, sendData, sendData, sendDataAsync, sendDataAsync, sendExplicitData, sendExplicitData, sendExplicitData, sendExplicitDataAsync, sendExplicitDataAsync, sendExplicitDataAsync, sendSerialData, sendXBeePacket, sendXBeePacket, sendXBeePacketAsync, set16BitAddress, setAPIOutputMode, setBluetoothPassword, setDIOValue, setIOConfiguration, setParameter, setPWMDutyCycle, softwareReset, updateBluetoothPassword, updateDeviceDataFrom, writeChanges

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CellularDevice

public CellularDevice(android.content.Context context,
                      int baudRate)

Class constructor. Instantiates a new CellularDevice object for Android with the given parameters.

Parameters:

context - The Android context.

baudRate - The USB connection baud rate.

Throws:

java.lang.IllegalArgumentException - if baudRate < 1.

java.lang.NullPointerException - if context == null.

See Also:

CellularDevice(Context, int, AndroidUSBPermissionListener), CellularDevice(Context, String, int), CellularDevice(Context, String, SerialPortParameters)

CellularDevice

public CellularDevice(android.content.Context context,
                      int baudRate,
                      AndroidUSBPermissionListener permissionListener)

Class constructor. Instantiates a new CellularDevice object for Android with the given parameters.

Parameters:

context - The Android context.

baudRate - The USB connection baud rate.

permissionListener - The USB permission listener that will be notified when user grants USB permissions.

Throws:

java.lang.IllegalArgumentException - if baudRate < 1.

java.lang.NullPointerException - if context == null.

See Also:

CellularDevice(Context, int), CellularDevice(Context, String, int), CellularDevice(Context, String, SerialPortParameters), AndroidUSBPermissionListener

CellularDevice

public CellularDevice(android.content.Context context,
                      java.lang.String port,
                      int baudRate)

Class constructor. Instantiates a new CellularDevice object for Android with the given parameters.

This constructor uses the Digi Android Serial Port API based on the RxTx library to communicate with the devices.

Parameters:

context - The Android application context.

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

baudRate - The serial port connection baud rate.

Throws:

java.lang.NullPointerException - If context == null or if port == null.

java.lang.IllegalArgumentException - if baudRate < 1.

See Also:

CellularDevice(Context, int), CellularDevice(Context, int, AndroidUSBPermissionListener), CellularDevice(Context, String, SerialPortParameters)

CellularDevice

public CellularDevice(android.content.Context context,
                      java.lang.String port,
                      com.digi.xbee.api.connection.serial.SerialPortParameters parameters)

Class constructor. Instantiates a new CellularDevice object for Android with the given parameters.

This constructor uses the Digi Android Serial Port API based on the RxTx library to communicate with the devices.

Parameters:

context - The Android application context.

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

parameters - The serial port parameters.

Throws:

java.lang.NullPointerException - If context == null or if port == null or if parameters == null.

See Also:

CellularDevice(Context, int), CellularDevice(Context, int, AndroidUSBPermissionListener), CellularDevice(Context, String, int), SerialPortParameters