Skip navigation links
A B C D E F G H I L M N O P R S T U V W X Z 

A

AbstractSerialPort - Class in com.digi.xbee.api.connection.serial
Abstract class that provides common functionality to work with serial ports.
AbstractXBeeDevice - Class in com.digi.xbee.api
This class provides common functionality for all XBee devices.
AbstractXBeeDevice(String, int) - Constructor for class com.digi.xbee.api.AbstractXBeeDevice
Class constructor.
AbstractXBeeDevice(String, int, int, int, int, int) - Constructor for class com.digi.xbee.api.AbstractXBeeDevice
Class constructor.
AbstractXBeeDevice(String, SerialPortParameters) - Constructor for class com.digi.xbee.api.AbstractXBeeDevice
Class constructor.
AbstractXBeeDevice(IConnectionInterface) - Constructor for class com.digi.xbee.api.AbstractXBeeDevice
Class constructor.
AbstractXBeeDevice(XBeeDevice, XBee64BitAddress) - Constructor for class com.digi.xbee.api.AbstractXBeeDevice
Class constructor.
AbstractXBeeDevice(XBeeDevice, XBee64BitAddress, XBee16BitAddress, String) - Constructor for class com.digi.xbee.api.AbstractXBeeDevice
Class constructor.
add(int) - Method in class com.digi.xbee.api.packet.XBeeChecksum
Adds the given byte to the checksum.
add(byte[]) - Method in class com.digi.xbee.api.packet.XBeeChecksum
Adds the given data to the checksum.
addDataListener(IDataReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice
 
addDataReceiveListener(IDataReceiveListener) - Method in class com.digi.xbee.api.connection.DataReader
Adds the given data receive listener to the list of listeners that will be notified when XBee data packets are received.
addDiscoveryListener(IDiscoveryListener) - Method in class com.digi.xbee.api.XBeeNetwork
Adds the given discovery listener to the list of listeners to be notified when the discovery process is running.
addIOSampleListener(IIOSampleReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice
 
addIOSampleReceiveListener(IIOSampleReceiveListener) - Method in class com.digi.xbee.api.connection.DataReader
Adds the given IO sample receive listener to the list of listeners that will be notified when an IO sample packet is received.
addModemStatusListener(IModemStatusReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice
 
addModemStatusReceiveListener(IModemStatusReceiveListener) - Method in class com.digi.xbee.api.connection.DataReader
Adds the given Modem Status receive listener to the list of listeners that will be notified when a modem status packet is received.
addPacket(XBeePacket) - Method in class com.digi.xbee.api.models.XBeePacketsQueue
Adds the provided packet to the list of packets.
addPacketListener(IPacketReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice
 
addPacketReceiveListener(IPacketReceiveListener) - Method in class com.digi.xbee.api.connection.DataReader
Adds the given packet receive listener to the list of listeners that will be notified when any XBee packet is received.
addPacketReceiveListener(IPacketReceiveListener, int) - Method in class com.digi.xbee.api.connection.DataReader
Adds the given packet receive listener to the list of listeners that will be notified when an XBee packet with the given frame ID is received.
addRemoteDevice(RemoteXBeeDevice) - Method in class com.digi.xbee.api.XBeeNetwork
Adds the given remote device to the network.
addRemoteDevices(List<RemoteXBeeDevice>) - Method in class com.digi.xbee.api.XBeeNetwork
Adds the given list of remote devices to the network.
APIFrameType - Enum in com.digi.xbee.api.packet
This enumeration lists all the available frame types used in any XBee protocol.
applyChanges() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Applies changes to all command registers causing queued command register values to be applied.
APS_ENCRYPTED - Static variable in class com.digi.xbee.api.models.XBeeReceiveOptions
Packet encrypted with APS encryption (value: 32).
AssociationIndicationStatus - Enum in com.digi.xbee.api.models
Enumerates the different association indication status.
ATCommand - Class in com.digi.xbee.api.models
This class represents an AT command used to read or set different properties of the XBee device.
ATCommand(String) - Constructor for class com.digi.xbee.api.models.ATCommand
Class constructor.
ATCommand(String, String) - Constructor for class com.digi.xbee.api.models.ATCommand
Class constructor.
ATCommand(String, byte[]) - Constructor for class com.digi.xbee.api.models.ATCommand
Class constructor.
ATCommandException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when receiving a command response containing a status different than ATCommandStatus#OK after sending an XBee AT command.
ATCommandException(ATCommandStatus) - Constructor for exception com.digi.xbee.api.exceptions.ATCommandException
Creates an ATCommandException with the provided ATCommandStatus indicating the status of the AT command response and as its error detail message.
ATCommandException(String, ATCommandStatus) - Constructor for exception com.digi.xbee.api.exceptions.ATCommandException
Creates an ATCommandException with the specified message and ATCommandStatus indicating the status of the AT command response.
ATCommandException(String, Throwable, ATCommandStatus) - Constructor for exception com.digi.xbee.api.exceptions.ATCommandException
Creates an ATCommandException with the specified message, cause and ATCommandStatus indicating the status of the AT command response.
ATCommandPacket - Class in com.digi.xbee.api.packet.common
This class represents an AT Command XBee packet.
ATCommandPacket(int, String, String) - Constructor for class com.digi.xbee.api.packet.common.ATCommandPacket
Class constructor.
ATCommandPacket(int, String, byte[]) - Constructor for class com.digi.xbee.api.packet.common.ATCommandPacket
Class constructor.
ATCommandQueuePacket - Class in com.digi.xbee.api.packet.common
This class represents an AT Command Queue XBee packet.
ATCommandQueuePacket(int, String, String) - Constructor for class com.digi.xbee.api.packet.common.ATCommandQueuePacket
Class constructor.
ATCommandQueuePacket(int, String, byte[]) - Constructor for class com.digi.xbee.api.packet.common.ATCommandQueuePacket
Class constructor.
ATCommandResponse - Class in com.digi.xbee.api.models
This class represents the response of an AT Command sent by the connected XBee device or by a remote device after executing an AT Command.
ATCommandResponse(ATCommand) - Constructor for class com.digi.xbee.api.models.ATCommandResponse
Class constructor.
ATCommandResponse(ATCommand, ATCommandStatus) - Constructor for class com.digi.xbee.api.models.ATCommandResponse
Class constructor.
ATCommandResponse(ATCommand, byte[]) - Constructor for class com.digi.xbee.api.models.ATCommandResponse
Class constructor.
ATCommandResponse(ATCommand, byte[], ATCommandStatus) - Constructor for class com.digi.xbee.api.models.ATCommandResponse
Class constructor.
ATCommandResponsePacket - Class in com.digi.xbee.api.packet.common
This class represents an AT Command Response packet.
ATCommandResponsePacket(int, ATCommandStatus, String, byte[]) - Constructor for class com.digi.xbee.api.packet.common.ATCommandResponsePacket
Class constructor.
ATCommandStatus - Enum in com.digi.xbee.api.models
Enumerates all the possible states of an AT Command after executing it.
ATStringCommands - Enum in com.digi.xbee.api.models
Enumerates several AT commands used to parse AT command packets.

B

baudrate - Variable in class com.digi.xbee.api.connection.serial.SerialPortParameters
 
BROADCAST_ADDRESS - Static variable in class com.digi.xbee.api.models.XBee16BitAddress
16-bit broadcast address (value: FFFF).
BROADCAST_ADDRESS - Static variable in class com.digi.xbee.api.models.XBee64BitAddress
64-bit broadcast address (value: 000000000000FFFF).
BROADCAST_PACKET - Static variable in class com.digi.xbee.api.models.XBeeReceiveOptions
Packet was a broadcast packet (value: 2).
byteArrayToHexString(byte[]) - Static method in class com.digi.xbee.api.utils.HexUtils
Converts the given byte array into an hex string.
byteArrayToInt(byte[]) - Static method in class com.digi.xbee.api.utils.ByteUtils
Converts the given byte array (4 bytes length max) into an integer.
byteArrayToLong(byte[]) - Static method in class com.digi.xbee.api.utils.ByteUtils
Converts the given byte array (8 bytes length max) into a long.
byteArrayToShort(byte[]) - Static method in class com.digi.xbee.api.utils.ByteUtils
Converts the given byte array (2 bytes length max) to short.
byteArrayToString(byte[]) - Static method in class com.digi.xbee.api.utils.ByteUtils
Converts the given byte array into a string.
byteToHexString(byte) - Static method in class com.digi.xbee.api.utils.HexUtils
Converts the given byte into an hex string.
byteToInt(byte) - Static method in class com.digi.xbee.api.utils.ByteUtils
Converts the given byte into an integer.
ByteUtils - Class in com.digi.xbee.api.utils
Utility class containing methods to work with bytes and byte arrays and several data type conversions.
ByteUtils() - Constructor for class com.digi.xbee.api.utils.ByteUtils
 

C

calculateDiscoveryValue(XBeeProtocol, Set<DiscoveryOptions>) - Static method in enum com.digi.xbee.api.models.DiscoveryOptions
Calculates the total value of a combination of several options for the given protocol.
checkFrameID(int) - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
Returns whether the given ID is the current frame ID.
clearDeviceList() - Method in class com.digi.xbee.api.XBeeNetwork
Removes all the devices from this network.
clearQueue() - Method in class com.digi.xbee.api.models.XBeePacketsQueue
Clears the list of packets.
close() - Method in interface com.digi.xbee.api.connection.IConnectionInterface
Attempts to close the connection interface.
close() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
close() - Method in class com.digi.xbee.api.XBeeDevice
Closes the connection interface associated with this XBee device.
com.digi.xbee.api - package com.digi.xbee.api
 
com.digi.xbee.api.connection - package com.digi.xbee.api.connection
 
com.digi.xbee.api.connection.serial - package com.digi.xbee.api.connection.serial
 
com.digi.xbee.api.exceptions - package com.digi.xbee.api.exceptions
 
com.digi.xbee.api.io - package com.digi.xbee.api.io
 
com.digi.xbee.api.listeners - package com.digi.xbee.api.listeners
 
com.digi.xbee.api.models - package com.digi.xbee.api.models
 
com.digi.xbee.api.packet - package com.digi.xbee.api.packet
 
com.digi.xbee.api.packet.common - package com.digi.xbee.api.packet.common
 
com.digi.xbee.api.packet.raw - package com.digi.xbee.api.packet.raw
 
com.digi.xbee.api.utils - package com.digi.xbee.api.utils
 
CommunicationException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when any problem related to the communication with the XBee device occurs.
CommunicationException() - Constructor for exception com.digi.xbee.api.exceptions.CommunicationException
Creates a CommunicationException with null as its error detail message.
CommunicationException(Throwable) - Constructor for exception com.digi.xbee.api.exceptions.CommunicationException
Creates a CommunicationException with the specified cause.
CommunicationException(String) - Constructor for exception com.digi.xbee.api.exceptions.CommunicationException
Creates a CommunicationException with the specified message.
CommunicationException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.CommunicationException
Creates a CommunicationException with the specified message and cause.
ConnectionException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when any problem related to the connection with the XBee device occurs.
ConnectionException() - Constructor for exception com.digi.xbee.api.exceptions.ConnectionException
Creates a ConnectionException with null as its error detail message.
ConnectionException(Throwable) - Constructor for exception com.digi.xbee.api.exceptions.ConnectionException
Creates a ConnectionException with the specified cause.
ConnectionException(String) - Constructor for exception com.digi.xbee.api.exceptions.ConnectionException
Creates a ConnectionException with the specified message.
ConnectionException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.ConnectionException
Creates a ConnectionException with the specified message and cause.
containsLetters(String) - Static method in class com.digi.xbee.api.utils.HexUtils
Checks whether the given parameter is a string or a numeric value.
COORDINATOR_ADDRESS - Static variable in class com.digi.xbee.api.models.XBee16BitAddress
16-bit address reserved for the coordinator (value: 0000).
COORDINATOR_ADDRESS - Static variable in class com.digi.xbee.api.models.XBee64BitAddress
64-bit address reserved for the coordinator (value: 0000000000000000).
createConnectiontionInterface(String, int) - Static method in class com.digi.xbee.api.XBee
Retrieves a serial port connection interface for the provided port with the given baud rate.
createConnectiontionInterface(String, SerialPortParameters) - Static method in class com.digi.xbee.api.XBee
Retrieves a serial port connection interface for the provided port with the given serial port parameters.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.ATCommandPacket
Creates a new ATCommandPacket object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
Creates a new ATCommandQueuePacket object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
Creates a new ATCommandResponsePacket object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
Creates a new IODataSampleRxIndicatorPacket object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.ModemStatusPacket
Creates a new ModemStatusPacket object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.ReceivePacket
Creates a new ReceivePacket object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
Creates a new RemoteATCommandPacket object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
Creates an new RemoteATCommandResponsePacket object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.TransmitPacket
Creates a new TransmitPacket object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
Creates a new TransmitStatusPacket object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.GenericXBeePacket
Creates a new GenericXBeePacket from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.raw.RX16IOPacket
Creates a new RX16IOPacket object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.raw.RX16Packet
Creates a new RX16Packet object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.raw.RX64IOPacket
Creates an new RX64IOPacket object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.raw.RX64Packet
Creates a new RX64Packet object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.raw.TX16Packet
Creates a new TX16Packet object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.raw.TX64Packet
Creates a new TX64Packet object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.raw.TXStatusPacket
Creates a new TXStatusPacket object from the given payload.
createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.UnknownXBeePacket
Creates a new UnknownXBeePacket from the given payload.
CURRENT_VERSION - Static variable in class com.digi.xbee.api.Version
 

D

dataBits - Variable in class com.digi.xbee.api.connection.serial.SerialPortParameters
 
DataReader - Class in com.digi.xbee.api.connection
Thread that constantly reads data from an input stream.
DataReader(IConnectionInterface, OperatingMode, XBeeDevice) - Constructor for class com.digi.xbee.api.connection.DataReader
Class constructor.
dataReceived(XBeeMessage) - Method in interface com.digi.xbee.api.listeners.IDataReceiveListener
Called when data is received from a remote node of the network.
DEFAULT_DATA_BITS - Static variable in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Default number of data bits: 8.
DEFAULT_FLOW_CONTROL - Static variable in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Default flow control: 0 (None).
DEFAULT_MAX_LENGTH - Static variable in class com.digi.xbee.api.models.XBeePacketsQueue
Default maximum number of packets to store in the queue (value: 50).
DEFAULT_PARITY - Static variable in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Default parity: 0 (None).
DEFAULT_PORT_TIMEOUT - Static variable in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Default receive timeout: 10 seconds.
DEFAULT_STOP_BITS - Static variable in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Default number of stop bits: 1.
determineProtocol(HardwareVersion, String) - Static method in enum com.digi.xbee.api.models.XBeeProtocol
Determines the XBee protocol based on the given Hardware and firmware versions.
deviceDiscovered(RemoteXBeeDevice) - Method in interface com.digi.xbee.api.listeners.IDiscoveryListener
Notifies that a remote device was discovered in the network.
DIGIMESH_MODE - Static variable in class com.digi.xbee.api.models.XBeeTransmitOptions
Transmission is performed using DigiMesh mode (value: 192).
DigiMeshDevice - Class in com.digi.xbee.api
This class represents a local DigiMesh device.
DigiMeshDevice(String, int) - Constructor for class com.digi.xbee.api.DigiMeshDevice
Class constructor.
DigiMeshDevice(String, int, int, int, int, int) - Constructor for class com.digi.xbee.api.DigiMeshDevice
Class constructor.
DigiMeshDevice(String, SerialPortParameters) - Constructor for class com.digi.xbee.api.DigiMeshDevice
Class constructor.
DigiMeshDevice(IConnectionInterface) - Constructor for class com.digi.xbee.api.DigiMeshDevice
Class constructor.
DigiMeshNetwork - Class in com.digi.xbee.api
This class represents a DigiMesh Network.
DigiPointDevice - Class in com.digi.xbee.api
This class represents a local DigiPoint device.
DigiPointDevice(String, int) - Constructor for class com.digi.xbee.api.DigiPointDevice
Class constructor.
DigiPointDevice(String, int, int, int, int, int) - Constructor for class com.digi.xbee.api.DigiPointDevice
Class constructor.
DigiPointDevice(String, SerialPortParameters) - Constructor for class com.digi.xbee.api.DigiPointDevice
Class constructor.
DigiPointDevice(IConnectionInterface) - Constructor for class com.digi.xbee.api.DigiPointDevice
Class constructor.
DigiPointNetwork - Class in com.digi.xbee.api
This class represents a DigiPoint Network.
DISABLE_ACK - Static variable in class com.digi.xbee.api.models.XBeeTransmitOptions
Disables acknowledgments on all unicasts (value: 1).
DISABLE_RETRIES_AND_REPAIR - Static variable in class com.digi.xbee.api.models.XBeeTransmitOptions
Disables the retries and router repair in the frame (value: 1).
discoverDevice(String) - Method in class com.digi.xbee.api.XBeeNetwork
Discovers and reports the first remote XBee device that matches the supplied identifier.
discoverDevices(List<String>) - Method in class com.digi.xbee.api.XBeeNetwork
Discovers and reports all remote XBee devices that match the supplied identifiers.
discoveryError(String) - Method in interface com.digi.xbee.api.listeners.IDiscoveryListener
Notifies that an error occurred during the discovery process.
discoveryFinished(String) - Method in interface com.digi.xbee.api.listeners.IDiscoveryListener
Notifies that the discovery process has finished.
DiscoveryOptions - Enum in com.digi.xbee.api.models
Enumerates the different options used in the discovery process.
DONT_ATTEMPT_RD - Static variable in class com.digi.xbee.api.models.XBeeTransmitOptions
Doesn't attempt Route Discovery (value: 2).

E

ENABLE_APS_ENCRYPTION - Static variable in class com.digi.xbee.api.models.XBeeTransmitOptions
Enables APS encryption, only if EE=1 (value: 32).
ENABLE_UNICAST_NACK - Static variable in class com.digi.xbee.api.models.XBeeTransmitOptions
Enables unicast NACK messages (value: 4).
ENABLE_UNICAST_TRACE_ROUTE - Static variable in class com.digi.xbee.api.models.XBeeTransmitOptions
Enables unicast trace route messages (value: 4).
enableApplyConfigurationChanges(boolean) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Enables or disables the 'apply configuration changes' option for this device.
equals(Object) - Method in class com.digi.xbee.api.connection.serial.SerialPortParameters
 
equals(Object) - Method in class com.digi.xbee.api.models.HardwareVersion
 
equals(Object) - Method in class com.digi.xbee.api.models.XBee16BitAddress
 
equals(Object) - Method in class com.digi.xbee.api.models.XBee64BitAddress
 
escapeByte() - Method in enum com.digi.xbee.api.models.SpecialByte
Escapes the byte by performing a XOR operation with 0x20 value.
executeParameter(String) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Executes the given command in this XBee device.

F

flowControl - Variable in class com.digi.xbee.api.connection.serial.SerialPortParameters
 
flush() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Flushes the available data of the output stream.
forceDisassociate() - Method in class com.digi.xbee.api.RemoteZigBeeDevice
 
forceDisassociate() - Method in class com.digi.xbee.api.ZigBeeDevice
 

G

generate() - Method in class com.digi.xbee.api.packet.XBeeChecksum
Generates the checksum byte for the API packet.
generateByteArray() - Method in class com.digi.xbee.api.packet.XBeePacket
Generates the XBee packet byte array.
generateByteArrayEscaped() - Method in class com.digi.xbee.api.packet.XBeePacket
Generates the XBee packet byte array escaping the special bytes.
generateDeviceID() - Method in class com.digi.xbee.api.models.XBee64BitAddress
Generates the Device ID corresponding to this XBee64BitAddress to be used in Device Cloud.
GenericXBeePacket - Class in com.digi.xbee.api.packet
This class represents a basic and Generic XBee packet where the payload is set as a byte array without a defined structure.
GenericXBeePacket(byte[]) - Constructor for class com.digi.xbee.api.packet.GenericXBeePacket
Class constructor.
get(int) - Static method in enum com.digi.xbee.api.models.AssociationIndicationStatus
Returns the AssociationIndicationStatus associated to the given value.
get(int) - Static method in enum com.digi.xbee.api.models.ATCommandStatus
Returns the ATCommandStatus associated to the given ID.
get(String) - Static method in enum com.digi.xbee.api.models.ATStringCommands
Returns the ATStringCommands for the given AT Command alias.
get(int) - Static method in class com.digi.xbee.api.models.HardwareVersion
Returns the HardwareVersion object associated to the given numeric value.
get(int, String) - Static method in class com.digi.xbee.api.models.HardwareVersion
Returns the HardwareVersion object associated to the given numeric value and description.
get(int) - Static method in enum com.digi.xbee.api.models.HardwareVersionEnum
Returns the HardwareVersionEnum associated to the given numeric value.
get(int) - Static method in enum com.digi.xbee.api.models.ModemStatusEvent
Returns the ModemStatusEvent associated to the given ID.
get(int) - Static method in enum com.digi.xbee.api.models.PowerLevel
Returns the PowerLevel entry associated to the given value.
get(int) - Static method in enum com.digi.xbee.api.models.SpecialByte
Returns the SpecialByte entry associated with the given value.
get(int) - Static method in enum com.digi.xbee.api.models.XBeeDiscoveryStatus
Returns the XBeeDiscoveryStatus associated to the given ID.
get(int) - Static method in enum com.digi.xbee.api.models.XBeeProtocol
Returns the XBeeProtocol associated to the given ID.
get(int) - Static method in enum com.digi.xbee.api.models.XBeeTransmitStatus
Returns the XBeeTransmitStatus associated to the given ID.
get(int) - Static method in enum com.digi.xbee.api.packet.APIFrameType
Returns the APIFrameType associated with the given ID value.
get16BitAddress() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the 16-bit address of this XBee device.
get16bitDestinationAddress() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
Returns the 16 bit destination address.
get16bitDestinationAddress() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
Returns the 16-bit destination address.
get16bitDestinationAddress() - Method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
Returns the 16-bit destination address.
get16bitDestinationAddress() - Method in class com.digi.xbee.api.packet.raw.TX16Packet
Returns the 16-bit destination address.
get16bitSourceAddress() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
Returns the 16-bit sender/source address.
get16bitSourceAddress() - Method in class com.digi.xbee.api.packet.common.ReceivePacket
Returns the 16-bit sender/source address.
get16bitSourceAddress() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
Returns the 16-bit source address.
get16bitSourceAddress() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
Returns the 16-bit sender/source address.
get16bitSourceAddress() - Method in class com.digi.xbee.api.packet.raw.RX16Packet
Returns the 16-bit sender/source address.
get64BitAddress() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the 64-bit address of this XBee device.
get64bitDestinationAddress() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
Returns the 64 bit destination address.
get64bitDestinationAddress() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
Returns the 64-bit destination address.
get64bitDestinationAddress() - Method in class com.digi.xbee.api.packet.raw.TX64Packet
Returns the 64-bit destination address.
get64bitSourceAddress() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
Returns the 64-bit sender/source address.
get64bitSourceAddress() - Method in class com.digi.xbee.api.packet.common.ReceivePacket
Returns the 64-bit sender/source address.
get64bitSourceAddress() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
Returns the 64-bit source address.
get64bitSourceAddress() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
Returns the 64-bit sender/source address.
get64bitSourceAddress() - Method in class com.digi.xbee.api.packet.raw.RX64Packet
Returns the 64-bit sender/source address.
getADCValue(IOLine) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the analog value of the provided IO line of this XBee device.
getAnalogMask() - Method in class com.digi.xbee.api.io.IOSample
Returns the analog mask.
getAnalogValue(IOLine) - Method in class com.digi.xbee.api.io.IOSample
Returns the analog value of the provided IO line.
getAnalogValues() - Method in class com.digi.xbee.api.io.IOSample
Returns the analog values map.
getAPIData() - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
Returns the XBee API packet data.
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.ModemStatusPacket
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.ReceivePacket
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.raw.RX16Packet
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.raw.RX64Packet
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.raw.TX16Packet
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.raw.TX64Packet
 
getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.raw.TXStatusPacket
 
getAPIPacketSpecificData() - Method in class com.digi.xbee.api.packet.common.ModemStatusPacket
 
getAssociationIndicationStatus() - Method in class com.digi.xbee.api.Raw802Device
 
getAssociationIndicationStatus() - Method in class com.digi.xbee.api.RemoteRaw802Device
 
getAssociationIndicationStatus() - Method in class com.digi.xbee.api.RemoteZigBeeDevice
 
getAssociationIndicationStatus() - Method in class com.digi.xbee.api.ZigBeeDevice
 
getBroadcastRadius() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
Returns the broadcast radius.
getCause() - Method in exception com.digi.xbee.api.exceptions.XBeeException
 
getChecksum() - Method in class com.digi.xbee.api.packet.XBeePacket
Returns the packet checksum.
getCommand() - Method in class com.digi.xbee.api.models.ATCommand
Returns the AT command alias.
getCommand() - Method in class com.digi.xbee.api.models.ATCommandResponse
Returns the AT command that generated the response.
getCommand() - Method in enum com.digi.xbee.api.models.ATStringCommands
Returns the AT Command alias.
getCommand() - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
Returns the AT command.
getCommand() - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
Returns the AT command.
getCommand() - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
Returns the AT command.
getCommand() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
Returns the AT Command.
getCommand() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
Returns the AT command.
getCommandStatus() - Method in exception com.digi.xbee.api.exceptions.ATCommandException
Returns the ATCommandStatus of the exception containing information about the AT command response.
getCommandStatusMessage() - Method in exception com.digi.xbee.api.exceptions.ATCommandException
Returns the text containing the status of the AT command response from the exception.
getCommandValue() - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
Returns the AT command response value.
getCommandValue() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
Retrieves the AT command response value.
getCommandValueAsString() - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
Returns the AT command response value as String.
getCommandValueAsString() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
Returns the AT command response value as String.
getConfigurationATCommand() - Method in enum com.digi.xbee.api.io.IOLine
Returns the configuration AT command associated to the IO line.
getConnectionInterface() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the connection interface associated to this XBee device.
getCurrentSize() - Method in class com.digi.xbee.api.models.XBeePacketsQueue
Returns the current size of the XBee packets queue.
getCurrentVersion() - Static method in class com.digi.xbee.api.Version
Returns the current version of the XBee Java Library.
getData() - Method in class com.digi.xbee.api.models.XBeeMessage
Returns the a byte array containing the data of the message.
getDataString() - Method in class com.digi.xbee.api.models.XBeeMessage
Returns the data of the message in string format.
getDescription() - Method in enum com.digi.xbee.api.models.AssociationIndicationStatus
Returns the association indication status description.
getDescription() - Method in enum com.digi.xbee.api.models.ATCommandStatus
Returns the AT Command Status description.
getDescription() - Method in enum com.digi.xbee.api.models.DiscoveryOptions
Returns the description of the discovery option.
getDescription() - Method in class com.digi.xbee.api.models.HardwareVersion
Returns the Hardware version description.
getDescription() - Method in enum com.digi.xbee.api.models.HardwareVersionEnum
Returns the hardware version description.
getDescription() - Method in enum com.digi.xbee.api.models.ModemStatusEvent
Returns the modem status description.
getDescription() - Method in enum com.digi.xbee.api.models.PowerLevel
Returns the power level description.
getDescription() - Method in enum com.digi.xbee.api.models.XBeeDiscoveryStatus
Returns the discovery status description.
getDescription() - Method in enum com.digi.xbee.api.models.XBeeProtocol
Returns the XBee protocol description.
getDescription() - Method in enum com.digi.xbee.api.models.XBeeTransmitStatus
Returns the XBee transmit status description.
getDestinationAddress() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the 64-bit destination extended address of this XBee device.
getDevice() - Method in class com.digi.xbee.api.models.XBeeMessage
Returns the remote XBee device this message is associated to.
getDevice(String) - Method in class com.digi.xbee.api.XBeeNetwork
Returns the first remote device that matches the supplied identifier.
getDevice(XBee64BitAddress) - Method in class com.digi.xbee.api.XBeeNetwork
Returns the remote device already contained in the network whose 64-bit address matches the given one.
getDevice(XBee16BitAddress) - Method in class com.digi.xbee.api.XBeeNetwork
Returns the remote device already contained in the network whose 16-bit address matches the given one.
getDevices() - Method in class com.digi.xbee.api.XBeeNetwork
Returns all remote devices already contained in the network.
getDevices(String) - Method in class com.digi.xbee.api.XBeeNetwork
Returns all remote devices that match the supplied identifier.
getDigitalHSBMask() - Method in class com.digi.xbee.api.io.IOSample
Returns the HSB of the digital mask.
getDigitalLSBMask() - Method in class com.digi.xbee.api.io.IOSample
Returns the LSB of the digital mask.
getDigitalMask() - Method in class com.digi.xbee.api.io.IOSample
Returns the combined (HSB + LSB) digital mask.
getDigitalValue(IOLine) - Method in class com.digi.xbee.api.io.IOSample
Returns the digital value of the provided IO line.
getDigitalValues() - Method in class com.digi.xbee.api.io.IOSample
Returns the digital values map.
getDIO(int) - Static method in enum com.digi.xbee.api.io.IOLine
Returns the IOLine associated to the given index.
getDIOChangeDetection() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the set of IO lines of this device that are monitored for change detection.
getDIOValue(IOLine) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the digital value of the provided IO line of this XBee device.
getDiscoveryStatus() - Method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
Returns the discovery status.
getFirmwareVersion() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the firmware version (hexadecimal string value) of this XBee device.
getFirstDataPacket(int) - Method in class com.digi.xbee.api.models.XBeePacketsQueue
Returns the first data packet from the queue waiting up to the specified timeout if necessary for an XBee data packet to become available.
getFirstDataPacketFrom(RemoteXBeeDevice, int) - Method in class com.digi.xbee.api.models.XBeePacketsQueue
Returns the first data packet from the queue whose 64-bit source address matches the address of the provided remote XBee device.
getFirstPacket(int) - Method in class com.digi.xbee.api.models.XBeePacketsQueue
Returns the first packet from the queue waiting up to the specified timeout if necessary for an XBee packet to become available.
getFirstPacketFrom(RemoteXBeeDevice, int) - Method in class com.digi.xbee.api.models.XBeePacketsQueue
Returns the first packet from the queue whose 64-bit source address matches the address of the provided remote XBee device.
getFrameID() - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
Returns the Frame ID of the API packet.
getFrameType() - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
Returns the XBee packet frame type.
getFrameTypeValue() - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
Returns the XBee packet frame type integer value.
getHardwareVersion() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the hardware version of this XBee device.
getHsb() - Method in class com.digi.xbee.api.models.XBee16BitAddress
Returns the address high significant byte.
getID() - Method in enum com.digi.xbee.api.io.IOMode
Returns the IO mode ID.
getID() - Method in enum com.digi.xbee.api.io.IOValue
Returns the ID of the IO value.
getId() - Method in enum com.digi.xbee.api.models.ATCommandStatus
Returns the AT Command Status ID.
getId() - Method in enum com.digi.xbee.api.models.ModemStatusEvent
Returns the modem status ID.
getID() - Method in enum com.digi.xbee.api.models.OperatingMode
Returns the operating mode ID.
getId() - Method in enum com.digi.xbee.api.models.XBeeDiscoveryStatus
Returns the discovery status ID.
getID() - Method in enum com.digi.xbee.api.models.XBeeProtocol
Returns the XBee protocol ID.
getId() - Method in enum com.digi.xbee.api.models.XBeeTransmitStatus
Returns the XBee transmit status ID.
getIndex() - Method in enum com.digi.xbee.api.io.IOLine
Returns the index of the IO line.
getInputStream() - Method in interface com.digi.xbee.api.connection.IConnectionInterface
Returns the connection interface input stream to read data from.
getInputStream() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
getIOConfiguration(IOLine) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the configuration mode of the provided IO line of this XBee device.
getIOMode(int) - Static method in enum com.digi.xbee.api.io.IOMode
Returns the IOMode associated to the provided mode ID.
getIOMode(int, IOLine) - Static method in enum com.digi.xbee.api.io.IOMode
Returns the IOMode corresponding to the provided mode ID and IO line.
getIOSample() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
Returns the IO sample corresponding to the data contained in the packet.
getIOSample() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
Returns the IO sample corresponding to the data contained in the packet.
getIOSample() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
Returns the IO sample corresponding to the data contained in the packet.
getIOSamplingRate() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the IO sampling rate of this XBee device.
getIOValue(int) - Static method in enum com.digi.xbee.api.io.IOValue
Returns the IOValue associated to the provided value ID.
getLsb() - Method in class com.digi.xbee.api.models.XBee16BitAddress
Returns the address low significant byte.
getMaxSize() - Method in class com.digi.xbee.api.models.XBeePacketsQueue
Returns the maximum size of the XBee packets queue.
getMessage() - Method in exception com.digi.xbee.api.exceptions.ATCommandException
 
getMessage() - Method in exception com.digi.xbee.api.exceptions.TransmitException
 
getName() - Method in enum com.digi.xbee.api.io.IOLine
Returns the name of the IO line.
getName() - Method in enum com.digi.xbee.api.io.IOMode
Returns the IO mode name.
getName() - Method in enum com.digi.xbee.api.io.IOValue
Returns the name of the IO value.
getName() - Method in enum com.digi.xbee.api.models.OperatingMode
Returns the operating mode name.
getName() - Method in enum com.digi.xbee.api.packet.APIFrameType
Returns the API frame type name.
getNetwork() - Method in class com.digi.xbee.api.DigiMeshDevice
 
getNetwork() - Method in class com.digi.xbee.api.DigiPointDevice
 
getNetwork() - Method in class com.digi.xbee.api.Raw802Device
 
getNetwork() - Method in class com.digi.xbee.api.XBeeDevice
Returns the network associated with this XBee device.
getNetwork() - Method in class com.digi.xbee.api.ZigBeeDevice
 
getNodeID() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the node identifier of this XBee device.
getNumberOfDevices() - Method in class com.digi.xbee.api.XBeeNetwork
Returns the number of devices already discovered in this network.
getOperatingMode() - Method in class com.digi.xbee.api.XBeeDevice
Returns the Operating mode (AT, API or API escaped) of this XBee device.
getOutputStream() - Method in interface com.digi.xbee.api.connection.IConnectionInterface
Returns the connection interface output stream to write data to.
getOutputStream() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
getPacketData() - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
 
getPacketData() - Method in class com.digi.xbee.api.packet.XBeePacket
Returns the packet data.
getPacketLength() - Method in class com.digi.xbee.api.packet.XBeePacket
Returns the packet length.
getPANID() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the operating PAN ID (Personal Area Network Identifier) of this XBee device.
getParameter(String) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Gets the value of the given parameter from this XBee device.
getParameter() - Method in class com.digi.xbee.api.models.ATCommand
Returns the AT command parameter.
getParameter() - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
Returns the AT command parameter.
getParameter() - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
Returns the AT command parameter.
getParameter() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
Returns the AT command parameter.
getParameterAsString() - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
Returns the AT command parameter as String.
getParameterAsString() - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
Returns the AT command parameter as String.
getParameterAsString() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
Returns the AT command parameter as String.
getParameters() - Method in class com.digi.xbee.api.packet.XBeePacket
Returns a map with the XBee packet parameters and their values.
getParameterString() - Method in class com.digi.xbee.api.models.ATCommand
Returns the AT command parameter in string format.
getPort() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Returns the name of the serial port.
getPortDescription() - Method in class com.digi.xbee.api.connection.serial.SerialPortInfo
Returns the serial port description.
getPortName() - Method in class com.digi.xbee.api.connection.serial.SerialPortInfo
Returns the serial port name.
getPortParameters() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Returns the XBee serial port parameters.
getPowerLevel() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the output power level at which this XBee device transmits conducted power.
getPowerSupplyValue() - Method in class com.digi.xbee.api.io.IOSample
Returns the value of the power supply voltage.
getPWMDutyCycle(IOLine) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Gets the PWM duty cycle (in %) corresponding to the provided IO line of this XBee device.
getPWMDutyCycleATCommand() - Method in enum com.digi.xbee.api.io.IOLine
Returns the PWM AT command associated to the IO line.
getReadTimeout() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Returns the read timeout of the serial port (in milliseconds).
getReadTimeout() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
getReceiveOptions() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
Returns the receive options.
getReceiveOptions() - Method in class com.digi.xbee.api.packet.common.ReceivePacket
Returns the receive options bitfield.
getReceiveOptions() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
Returns the receive options bitfield.
getReceiveOptions() - Method in class com.digi.xbee.api.packet.raw.RX16Packet
Returns the receive options bitfield.
getReceiveOptions() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
Returns the receive options bitfield.
getReceiveOptions() - Method in class com.digi.xbee.api.packet.raw.RX64Packet
Returns the receive options bitfield.
getReceiveTimeout() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Returns the serial port receive timeout (in milliseconds).
getReceiveTimeout() - Method in class com.digi.xbee.api.XBeeDevice
Returns this XBee device configured timeout for receiving packets in synchronous operations.
getResponse() - Method in class com.digi.xbee.api.models.ATCommandResponse
Returns the AT command response data in byte array format if any.
getResponseStatus() - Method in class com.digi.xbee.api.models.ATCommandResponse
Returns the AT command response status.
getResponseString() - Method in class com.digi.xbee.api.models.ATCommandResponse
Returns the AT command response data as string if any.
getRFData() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
Returns the received RF data.
getRFData() - Method in class com.digi.xbee.api.packet.common.ReceivePacket
Returns the received RF data.
getRFData() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
Returns the RF Data to send.
getRFData() - Method in class com.digi.xbee.api.packet.GenericXBeePacket
Returns the XBee RF Data of the packet.
getRFData() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
Returns the received RF data.
getRFData() - Method in class com.digi.xbee.api.packet.raw.RX16Packet
Returns the received RF data.
getRFData() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
Returns the received RF data.
getRFData() - Method in class com.digi.xbee.api.packet.raw.RX64Packet
Returns the received RF data.
getRFData() - Method in class com.digi.xbee.api.packet.raw.TX16Packet
Returns the RF Data to send.
getRFData() - Method in class com.digi.xbee.api.packet.raw.TX64Packet
Returns the RF Data to send.
getRFData() - Method in class com.digi.xbee.api.packet.UnknownXBeePacket
Returns the XBee RF Data of the packet.
getRSSI() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
Returns the Received Signal Strength Indicator (RSSI).
getRSSI() - Method in class com.digi.xbee.api.packet.raw.RX16Packet
Returns the Received Signal Strength Indicator (RSSI).
getRSSI() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
Returns the Received Signal Strength Indicator (RSSI).
getRSSI() - Method in class com.digi.xbee.api.packet.raw.RX64Packet
Returns the Received Signal Strength Indicator (RSSI).
getStatus() - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
Returns the AT command response status.
getStatus() - Method in class com.digi.xbee.api.packet.common.ModemStatusPacket
Returns modem status event enum.
getStatus() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
Returns the AT command response status.
getTransmitOptions() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
Returns the transmit options bitfield.
getTransmitOptions() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
Returns the transmit options bitfield.
getTransmitOptions() - Method in class com.digi.xbee.api.packet.raw.TX16Packet
Returns the transmit options bitfield.
getTransmitOptions() - Method in class com.digi.xbee.api.packet.raw.TX64Packet
Returns the transmit options bitfield.
getTransmitRetryCount() - Method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
Returns the transmit retry count.
getTransmitStatus() - Method in exception com.digi.xbee.api.exceptions.TransmitException
Returns the XBeeTransmitStatus of the exception containing information about the transmission.
getTransmitStatus() - Method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
Returns the transmit status.
getTransmitStatus() - Method in class com.digi.xbee.api.packet.raw.TXStatusPacket
Returns the transmit status.
getTransmitStatusMessage() - Method in exception com.digi.xbee.api.exceptions.TransmitException
Returns the text containing the status of the transmission from the exception.
getValue() - Method in enum com.digi.xbee.api.models.AssociationIndicationStatus
Returns the association indication status value.
getValue() - Method in enum com.digi.xbee.api.models.DiscoveryOptions
Returns the value of the discovery option.
getValue() - Method in class com.digi.xbee.api.models.HardwareVersion
Returns the Hardware version numeric value.
getValue() - Method in enum com.digi.xbee.api.models.HardwareVersionEnum
Returns the Hardware version numeric value.
getValue() - Method in enum com.digi.xbee.api.models.PowerLevel
Returns the power level value.
getValue() - Method in enum com.digi.xbee.api.models.SpecialByte
Returns the special byte value.
getValue() - Method in class com.digi.xbee.api.models.XBee16BitAddress
Returns the 16-bit address value in byte array format.
getValue() - Method in class com.digi.xbee.api.models.XBee64BitAddress
Returns the XBee 64-bit address value as byte array.
getValue() - Method in enum com.digi.xbee.api.packet.APIFrameType
Returns the API frame type value.
getXBeePacketsQueue() - Method in class com.digi.xbee.api.connection.DataReader
Returns the queue of read XBee packets.
getXBeeProtocol() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns the XBee Protocol of this XBee device.
getXBeeProtocol() - Method in class com.digi.xbee.api.DigiMeshDevice
 
getXBeeProtocol() - Method in class com.digi.xbee.api.DigiPointDevice
 
getXBeeProtocol() - Method in class com.digi.xbee.api.Raw802Device
 
getXBeeProtocol() - Method in class com.digi.xbee.api.RemoteDigiMeshDevice
 
getXBeeProtocol() - Method in class com.digi.xbee.api.RemoteDigiPointDevice
 
getXBeeProtocol() - Method in class com.digi.xbee.api.RemoteRaw802Device
 
getXBeeProtocol() - Method in class com.digi.xbee.api.RemoteZigBeeDevice
 
getXBeeProtocol() - Method in class com.digi.xbee.api.ZigBeeDevice
 

H

HardwareVersion - Class in com.digi.xbee.api.models
This class represents the hardware version number of an XBee device.
HardwareVersionEnum - Enum in com.digi.xbee.api.models
Enumerates the different hardware versions of the XBee devices.
hasAnalogValue(IOLine) - Method in class com.digi.xbee.api.io.IOSample
Returns whether or not the given IO line has an analog value.
hasAnalogValues() - Method in class com.digi.xbee.api.io.IOSample
Returns whether or not the IOSample has analog values.
hasDigitalValue(IOLine) - Method in class com.digi.xbee.api.io.IOSample
Returns whether or not this IO sample contains a digital value for the given IO line.
hasDigitalValues() - Method in class com.digi.xbee.api.io.IOSample
Checks whether or not the IOSample has digital values.
hashCode() - Method in class com.digi.xbee.api.connection.serial.SerialPortParameters
 
hashCode() - Method in class com.digi.xbee.api.models.HardwareVersion
 
hashCode() - Method in class com.digi.xbee.api.models.XBee16BitAddress
 
hashCode() - Method in class com.digi.xbee.api.models.XBee64BitAddress
 
hasPowerSupplyValue() - Method in class com.digi.xbee.api.io.IOSample
Returns whether or not the IOSample has power supply value.
hasPWMCapability() - Method in enum com.digi.xbee.api.io.IOLine
Returns whether or not the IO line has PWM capability.
hexStringToByteArray(String) - Static method in class com.digi.xbee.api.utils.HexUtils
Converts the given hex string into a byte array.
HexUtils - Class in com.digi.xbee.api.utils
Utility class containing methods to work with hexadecimal values and several data type conversions.
HexUtils() - Constructor for class com.digi.xbee.api.utils.HexUtils
 

I

IConnectionInterface - Interface in com.digi.xbee.api.connection
This interface represents a protocol independent connection with an XBee device.
IDataReceiveListener - Interface in com.digi.xbee.api.listeners
This interface defines the required methods that should be implemented to behave as a data listener and be notified when new data is received from a remote XBee device of the network.
IDiscoveryListener - Interface in com.digi.xbee.api.listeners
Interface defining the required methods that an object should implement to be notified about device discovery events.
IIOSampleReceiveListener - Interface in com.digi.xbee.api.listeners
This interface defines the required methods that an object should implement to behave as an IO Sample listener and be notified when IO samples are received from a remote XBee device of the network.
IModemStatusReceiveListener - Interface in com.digi.xbee.api.listeners
This interface defines the required methods that an object should implement to behave as a modem status listener and be notified when modem status events are received from the radio.
integerToHexString(int, int) - Static method in class com.digi.xbee.api.utils.HexUtils
Converts the given integer into an hexadecimal string.
InterfaceAlreadyOpenException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when trying to open an interface that is already opened by the application.
InterfaceAlreadyOpenException() - Constructor for exception com.digi.xbee.api.exceptions.InterfaceAlreadyOpenException
Creates an InterfaceAlreadyOpenedException with as its error detail message.
InterfaceAlreadyOpenException(String) - Constructor for exception com.digi.xbee.api.exceptions.InterfaceAlreadyOpenException
Creates an InterfaceAlreadyOpenedException with the specified message.
InterfaceAlreadyOpenException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.InterfaceAlreadyOpenException
Creates an InterfaceAlreadyOpenException with the specified message and cause.
InterfaceInUseException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when trying to open the port/communication interface but it is already in use by other applications.
InterfaceInUseException() - Constructor for exception com.digi.xbee.api.exceptions.InterfaceInUseException
Creates an InterfaceInUseException with as its error detail message.
InterfaceInUseException(String) - Constructor for exception com.digi.xbee.api.exceptions.InterfaceInUseException
Creates an InterfaceInUseException with the specified message.
InterfaceInUseException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.InterfaceInUseException
Creates an InterfaceInUseException with the specified message and cause.
InterfaceNotOpenException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when trying to perform any operation with the XBee device and its communication interface is closed.
InterfaceNotOpenException() - Constructor for exception com.digi.xbee.api.exceptions.InterfaceNotOpenException
Creates an InterfaceNotOpenException with as its error detail message.
InterfaceNotOpenException(String) - Constructor for exception com.digi.xbee.api.exceptions.InterfaceNotOpenException
Creates an InterfaceNotOpenException with the specified message.
InterfaceNotOpenException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.InterfaceNotOpenException
Creates an InterfaceNotOpenException with the specified message and cause.
intToByteArray(int) - Static method in class com.digi.xbee.api.utils.ByteUtils
Converts the given integer value into a byte array.
InvalidConfigurationException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when trying to open an interface with an invalid configuration.
InvalidConfigurationException() - Constructor for exception com.digi.xbee.api.exceptions.InvalidConfigurationException
Creates an InvalidConfigurationException with as its error detail message.
InvalidConfigurationException(String) - Constructor for exception com.digi.xbee.api.exceptions.InvalidConfigurationException
Creates an InvalidConfigurationException with the specified message.
InvalidConfigurationException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.InvalidConfigurationException
Creates an InvalidConfigurationException with the specified message and cause.
InvalidInterfaceException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when trying to open a non-existing interface.
InvalidInterfaceException() - Constructor for exception com.digi.xbee.api.exceptions.InvalidInterfaceException
Creates an InvalidInterfaceException with as its error detail message.
InvalidInterfaceException(String) - Constructor for exception com.digi.xbee.api.exceptions.InvalidInterfaceException
Creates an InvalidInterfaceException with the specified message.
InvalidInterfaceException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.InvalidInterfaceException
Creates an InvalidInterfaceException with the specified message and cause.
InvalidOperatingModeException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when performing any action with the XBee device and its operating mode is different than OperatingMode.API and OperatingMode.API_ESCAPE.
InvalidOperatingModeException() - Constructor for exception com.digi.xbee.api.exceptions.InvalidOperatingModeException
Creates an InvalidOperatingModeException with as its error detail message.
InvalidOperatingModeException(OperatingMode) - Constructor for exception com.digi.xbee.api.exceptions.InvalidOperatingModeException
Creates an InvalidOperatingModeException with the specified operating mode.
InvalidOperatingModeException(String) - Constructor for exception com.digi.xbee.api.exceptions.InvalidOperatingModeException
Creates an InvalidOperatingModeException with the specified message.
InvalidOperatingModeException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.InvalidOperatingModeException
Creates an InvalidOperatingModeException with the specified message and cause.
InvalidPacketException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when there is an error parsing an API packet from the input stream.
InvalidPacketException() - Constructor for exception com.digi.xbee.api.exceptions.InvalidPacketException
Creates a InvalidPacketException with as its error detail message.
InvalidPacketException(String) - Constructor for exception com.digi.xbee.api.exceptions.InvalidPacketException
Creates a InvalidPacketException with the specified message.
InvalidPacketException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.InvalidPacketException
Creates an InvalidPacketException with the specified message and cause.
IODataSampleRxIndicatorPacket - Class in com.digi.xbee.api.packet.common
This class represents an IO Data Sample RX Indicator packet.
IODataSampleRxIndicatorPacket(XBee64BitAddress, XBee16BitAddress, int, byte[]) - Constructor for class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
Class constructor.
IOLine - Enum in com.digi.xbee.api.io
Enumerates the different IO lines that can be found in the XBee devices.
IOMode - Enum in com.digi.xbee.api.io
Enumerates the different Input/Output modes that an IO line can be configured with.
IOSample - Class in com.digi.xbee.api.io
This class represents an IO Data Sample.
IOSample(byte[]) - Constructor for class com.digi.xbee.api.io.IOSample
Class constructor.
ioSampleReceived(RemoteXBeeDevice, IOSample) - Method in interface com.digi.xbee.api.listeners.IIOSampleReceiveListener
Called when an IO sample is received through the connection interface.
IOValue - Enum in com.digi.xbee.api.io
Enumerates the possible values of a IOLine configured as digital I/O.
IPacketReceiveListener - Interface in com.digi.xbee.api.listeners
This interface defines the required methods that an object should implement to behave as a packet listener and be notified when new packets are received from a remote XBee device of the network.
isApplyConfigurationChangesEnabled() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns whether the 'apply configuration changes' option is enabled in this device.
isBitEnabled(int, int) - Static method in class com.digi.xbee.api.utils.ByteUtils
Returns whether the specified bit of the given integer is set to 1 or not.
isBroadcast() - Method in class com.digi.xbee.api.models.XBeeMessage
Returns whether or not the message was received via broadcast.
isBroadcast() - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.common.ModemStatusPacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.common.ReceivePacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.GenericXBeePacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.raw.RX16Packet
 
isBroadcast() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.raw.RX64Packet
 
isBroadcast() - Method in class com.digi.xbee.api.packet.raw.TX16Packet
 
isBroadcast() - Method in class com.digi.xbee.api.packet.raw.TX64Packet
 
isBroadcast() - Method in class com.digi.xbee.api.packet.raw.TXStatusPacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.UnknownXBeePacket
 
isBroadcast() - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
Returns whether or not the packet is a broadcast packet.
isCD() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Returns the state of the CD line.
isCD() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
isCTS() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Returns the state of the CTS line.
isCTS() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
isDiscoveryRunning() - Method in class com.digi.xbee.api.XBeeNetwork
Retrieves whether the discovery process is running or not.
isDSR() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Returns the state of the DSR line.
isDSR() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
isHardwareFlowControl() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Returns whether or not the port's flow control is configured in hardware mode.
isOpen() - Method in interface com.digi.xbee.api.connection.IConnectionInterface
Returns whether the connection interface is open or not.
isOpen() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
 
isOpen() - Method in class com.digi.xbee.api.XBeeDevice
Returns whether the connection interface associated to this device is already open.
isRemote() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns whether this XBee device is a remote device.
isRemote() - Method in class com.digi.xbee.api.RemoteXBeeDevice
Always returns true, since it is a remote device.
isRemote() - Method in class com.digi.xbee.api.XBeeDevice
Always returns false, since this is always a local device.
isRunning() - Method in class com.digi.xbee.api.connection.DataReader
Returns whether this Data reader is running or not.
isSpecialByte(int) - Static method in enum com.digi.xbee.api.models.SpecialByte
Checks whether the given byte is special or not.

L

listSerialPorts() - Static method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
Retrieves the list of available serial ports in the system.
listSerialPortsInfo() - Static method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
Retrieves the list of available serial ports with their information.
longToByteArray(long) - Static method in class com.digi.xbee.api.utils.ByteUtils
Converts the given long value into a byte array.

M

ModemStatusEvent - Enum in com.digi.xbee.api.models
Enumerates the different modem status events.
modemStatusEventReceived(ModemStatusEvent) - Method in interface com.digi.xbee.api.listeners.IModemStatusReceiveListener
Called when a modem status event from the radio is received.
ModemStatusPacket - Class in com.digi.xbee.api.packet.common
This class represents a Modem Status packet.
ModemStatusPacket(ModemStatusEvent) - Constructor for class com.digi.xbee.api.packet.common.ModemStatusPacket
Class constructor.

N

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.common.ModemStatusPacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.common.ReceivePacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.GenericXBeePacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.raw.RX16Packet
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.raw.RX64Packet
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.raw.TX16Packet
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.raw.TX64Packet
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.raw.TXStatusPacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.UnknownXBeePacket
 
needsAPIFrameID() - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
Returns whether the API packet needs API Frame ID or not.
newByteArray(byte[], int) - Static method in class com.digi.xbee.api.utils.ByteUtils
Generates a new byte array of the given size using the given data and filling with ASCII zeros (0x48) the remaining space.
NO_FRAME_ID - Static variable in class com.digi.xbee.api.packet.XBeeAPIPacket
 
NONE - Static variable in class com.digi.xbee.api.models.XBeeReceiveOptions
No special receive options (value: 0).
NONE - Static variable in class com.digi.xbee.api.models.XBeeTransmitOptions
No special transmit options (value: 0).

O

open() - Method in interface com.digi.xbee.api.connection.IConnectionInterface
Attempts to open the connection interface.
open() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
open() - Method in class com.digi.xbee.api.DigiMeshDevice
 
open() - Method in class com.digi.xbee.api.DigiPointDevice
 
open() - Method in class com.digi.xbee.api.Raw802Device
 
open() - Method in class com.digi.xbee.api.XBeeDevice
Opens the connection interface associated with this XBee device.
open() - Method in class com.digi.xbee.api.ZigBeeDevice
 
OperatingMode - Enum in com.digi.xbee.api.models
Enumerates the different working modes of the XBee device.
OperationNotSupportedException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when the operation performed is not supported by the XBee device.
OperationNotSupportedException() - Constructor for exception com.digi.xbee.api.exceptions.OperationNotSupportedException
Creates an OperationNotSupportedException with as its error detail message.
OperationNotSupportedException(String) - Constructor for exception com.digi.xbee.api.exceptions.OperationNotSupportedException
Creates an OperationNotSupportedException with the specified message.
OperationNotSupportedException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.OperationNotSupportedException
Creates an OperationNotSupportedException with the specified message and cause.
OPTION_APPLY_CHANGES - Static variable in class com.digi.xbee.api.models.RemoteATCommandOptions
Applies changes in the remote device (value: 2).
OPTION_DISABLE_ACK - Static variable in class com.digi.xbee.api.models.RemoteATCommandOptions
Disables ACK (value: 1).
OPTION_EXTENDED_TIMEOUT - Static variable in class com.digi.xbee.api.models.RemoteATCommandOptions
Uses the extended transmission timeout (value: 64).
OPTION_NONE - Static variable in class com.digi.xbee.api.models.RemoteATCommandOptions
No special transmit options (value: 0).
ownershipChange(int) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 

P

PACKET_ACKNOWLEDGED - Static variable in class com.digi.xbee.api.models.XBeeReceiveOptions
Packet was acknowledged (value: 1).
packetReceived(XBeePacket) - Method in interface com.digi.xbee.api.listeners.IPacketReceiveListener
Called when an XBee packet is received through the connection interface.
parity - Variable in class com.digi.xbee.api.connection.serial.SerialPortParameters
 
parsePacket(String, OperatingMode) - Static method in class com.digi.xbee.api.packet.XBeePacket
Parses the given hexadecimal string and returns a Generic XBee packet.
parsePacket(byte[], OperatingMode) - Static method in class com.digi.xbee.api.packet.XBeePacket
Parses the given byte array and returns a Generic XBee packet.
parsePacket(InputStream, OperatingMode) - Method in class com.digi.xbee.api.packet.XBeePacketParser
Parses the bytes from the given input stream depending on the provided operating mode and returns the API packet.
parsePacket(byte[], OperatingMode) - Method in class com.digi.xbee.api.packet.XBeePacketParser
Parses the bytes from the given array depending on the provided operating mode and returns the API packet.
PermissionDeniedException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when the user does not have the appropriate access to the connection interface.
PermissionDeniedException() - Constructor for exception com.digi.xbee.api.exceptions.PermissionDeniedException
Creates a PermissionDeniedException with as its error detail message.
PermissionDeniedException(String) - Constructor for exception com.digi.xbee.api.exceptions.PermissionDeniedException
Creates a PermissionDeniedException with the specified message.
PermissionDeniedException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.PermissionDeniedException
Creates a PermissionDeniedException with the specified message and cause.
POINT_MULTIPOINT_MODE - Static variable in class com.digi.xbee.api.models.XBeeTransmitOptions
Transmission is performed using point-to-Multipoint mode (value: 64).
PowerLevel - Enum in com.digi.xbee.api.models
Enumerates the different power levels.
prettyHexString(String) - Static method in class com.digi.xbee.api.utils.HexUtils
Converts the given hexadecimal string to a pretty format by splitting the content byte by byte.
prettyHexString(byte[]) - Static method in class com.digi.xbee.api.utils.HexUtils
Converts the given byte array into an hex string and retrieves it in pretty format by splitting the content byte by byte.
purge() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Purges the serial port removing all the data from the input stream.

R

Raw802Device - Class in com.digi.xbee.api
This class represents a local 802.15.4 device.
Raw802Device(String, int) - Constructor for class com.digi.xbee.api.Raw802Device
Class constructor.
Raw802Device(String, int, int, int, int, int) - Constructor for class com.digi.xbee.api.Raw802Device
Class constructor.
Raw802Device(String, SerialPortParameters) - Constructor for class com.digi.xbee.api.Raw802Device
Class constructor.
Raw802Device(IConnectionInterface) - Constructor for class com.digi.xbee.api.Raw802Device
Class constructor.
Raw802Network - Class in com.digi.xbee.api
This class represents an 802.15.4 Network.
readBooleanFromByte(byte, int) - Static method in class com.digi.xbee.api.utils.ByteUtils
Reads a boolean value from the given byte at the given bit position.
readBytes(int, ByteArrayInputStream) - Static method in class com.digi.xbee.api.utils.ByteUtils
Reads the given amount of bytes from the given byte array input stream.
readData(byte[]) - Method in interface com.digi.xbee.api.connection.IConnectionInterface
Reads data from the connection interface and stores it in the provided byte array returning the number of read bytes.
readData(byte[], int, int) - Method in interface com.digi.xbee.api.connection.IConnectionInterface
Reads the given number of bytes at the given offset from the connection interface and stores it in the provided byte array returning the number of read bytes.
readData(byte[]) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
 
readData(byte[], int, int) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
 
readData() - Method in class com.digi.xbee.api.XBeeDevice
Reads new data received by this XBee device during the configured received timeout.
readData(int) - Method in class com.digi.xbee.api.XBeeDevice
Reads new data received by this XBee device during the provided timeout.
readDataFrom(RemoteXBeeDevice) - Method in class com.digi.xbee.api.XBeeDevice
Reads new data received from the given remote XBee device during the configured received timeout.
readDataFrom(RemoteXBeeDevice, int) - Method in class com.digi.xbee.api.XBeeDevice
Reads new data received from the given remote XBee device during the provided timeout.
readDeviceInfo() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Reads some parameters from this device and obtains its protocol.
readIntegerFromByte(byte, int, int) - Static method in class com.digi.xbee.api.utils.ByteUtils
Reads an integer value from the given byte using the given bit offset and the given bit size.
readIOSample() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Returns an IO sample from this XBee device containing the value of all enabled digital IO and analog input channels.
readString(ByteArrayInputStream) - Static method in class com.digi.xbee.api.utils.ByteUtils
Reads a null-terminated string from the given byte array input stream.
readUntilCR(ByteArrayInputStream) - Static method in class com.digi.xbee.api.utils.ByteUtils
Reads from the given byte array input stream until a CR character is found or the end of stream is reached.
ReceivePacket - Class in com.digi.xbee.api.packet.common
This class represents a Receive Packet.
ReceivePacket(XBee64BitAddress, XBee16BitAddress, int, byte[]) - Constructor for class com.digi.xbee.api.packet.common.ReceivePacket
Class constructor.
RemoteATCommandOptions - Class in com.digi.xbee.api.models
This class lists all the possible options that can be set while transmitting a remote AT Command.
RemoteATCommandOptions() - Constructor for class com.digi.xbee.api.models.RemoteATCommandOptions
 
RemoteATCommandPacket - Class in com.digi.xbee.api.packet.common
This class represents a Remote AT Command Request packet.
RemoteATCommandPacket(int, XBee64BitAddress, XBee16BitAddress, int, String, String) - Constructor for class com.digi.xbee.api.packet.common.RemoteATCommandPacket
Class constructor.
RemoteATCommandPacket(int, XBee64BitAddress, XBee16BitAddress, int, String, byte[]) - Constructor for class com.digi.xbee.api.packet.common.RemoteATCommandPacket
Class constructor.
RemoteATCommandResponsePacket - Class in com.digi.xbee.api.packet.common
This class represents a Remote AT Command Response packet.
RemoteATCommandResponsePacket(int, XBee64BitAddress, XBee16BitAddress, String, ATCommandStatus, byte[]) - Constructor for class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
Class constructor.
RemoteDigiMeshDevice - Class in com.digi.xbee.api
This class represents a remote DigiMesh device.
RemoteDigiMeshDevice(DigiMeshDevice, XBee64BitAddress) - Constructor for class com.digi.xbee.api.RemoteDigiMeshDevice
Class constructor.
RemoteDigiMeshDevice(XBeeDevice, XBee64BitAddress) - Constructor for class com.digi.xbee.api.RemoteDigiMeshDevice
Class constructor.
RemoteDigiMeshDevice(XBeeDevice, XBee64BitAddress, String) - Constructor for class com.digi.xbee.api.RemoteDigiMeshDevice
Class constructor.
RemoteDigiPointDevice - Class in com.digi.xbee.api
This class represents a remote DigiPoint device.
RemoteDigiPointDevice(DigiPointDevice, XBee64BitAddress) - Constructor for class com.digi.xbee.api.RemoteDigiPointDevice
Class constructor.
RemoteDigiPointDevice(XBeeDevice, XBee64BitAddress) - Constructor for class com.digi.xbee.api.RemoteDigiPointDevice
Class constructor.
RemoteDigiPointDevice(XBeeDevice, XBee64BitAddress, String) - Constructor for class com.digi.xbee.api.RemoteDigiPointDevice
Class constructor.
RemoteRaw802Device - Class in com.digi.xbee.api
This class represents a remote 802.15.4 device.
RemoteRaw802Device(Raw802Device, XBee64BitAddress) - Constructor for class com.digi.xbee.api.RemoteRaw802Device
Class constructor.
RemoteRaw802Device(XBeeDevice, XBee64BitAddress, XBee16BitAddress, String) - Constructor for class com.digi.xbee.api.RemoteRaw802Device
Class constructor.
RemoteRaw802Device(Raw802Device, XBee16BitAddress) - Constructor for class com.digi.xbee.api.RemoteRaw802Device
Class constructor.
RemoteRaw802Device(XBeeDevice, XBee16BitAddress) - Constructor for class com.digi.xbee.api.RemoteRaw802Device
Class constructor.
RemoteXBeeDevice - Class in com.digi.xbee.api
This class represents a remote XBee device.
RemoteXBeeDevice(XBeeDevice, XBee64BitAddress) - Constructor for class com.digi.xbee.api.RemoteXBeeDevice
Class constructor.
RemoteXBeeDevice(XBeeDevice, XBee64BitAddress, XBee16BitAddress, String) - Constructor for class com.digi.xbee.api.RemoteXBeeDevice
Class constructor.
RemoteZigBeeDevice - Class in com.digi.xbee.api
This class represents a remote ZigBee device.
RemoteZigBeeDevice(ZigBeeDevice, XBee64BitAddress) - Constructor for class com.digi.xbee.api.RemoteZigBeeDevice
Class constructor.
RemoteZigBeeDevice(XBeeDevice, XBee64BitAddress) - Constructor for class com.digi.xbee.api.RemoteZigBeeDevice
Class constructor.
RemoteZigBeeDevice(XBeeDevice, XBee64BitAddress, XBee16BitAddress, String) - Constructor for class com.digi.xbee.api.RemoteZigBeeDevice
Class constructor.
removeDataListener(IDataReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice
 
removeDataReceiveListener(IDataReceiveListener) - Method in class com.digi.xbee.api.connection.DataReader
Removes the given data receive listener from the list of data receive listeners.
removeDiscoveryListener(IDiscoveryListener) - Method in class com.digi.xbee.api.XBeeNetwork
Removes the given discovery listener from the list of discovery listeners.
removeIOSampleListener(IIOSampleReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice
 
removeIOSampleReceiveListener(IIOSampleReceiveListener) - Method in class com.digi.xbee.api.connection.DataReader
Removes the given IO sample receive listener from the list of IO sample receive listeners.
removeModemStatusListener(IModemStatusReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice
 
removeModemStatusReceiveListener(IModemStatusReceiveListener) - Method in class com.digi.xbee.api.connection.DataReader
Removes the given Modem Status receive listener from the list of Modem Status receive listeners.
removePacketListener(IPacketReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice
 
removePacketReceiveListener(IPacketReceiveListener) - Method in class com.digi.xbee.api.connection.DataReader
Removes the given packet receive listener from the list of XBee packet receive listeners.
removeRemoteDevice(RemoteXBeeDevice) - Method in class com.digi.xbee.api.XBeeNetwork
Removes the given remote XBee device from the network.
REPEATER_MODE - Static variable in class com.digi.xbee.api.models.XBeeTransmitOptions
Transmission is performed using repeater mode (value: 128).
reset() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Performs a software reset on this XBee device and blocks until the process is completed.
reset() - Method in class com.digi.xbee.api.packet.XBeeChecksum
Resets the checksum.
reset() - Method in class com.digi.xbee.api.RemoteXBeeDevice
 
reset() - Method in class com.digi.xbee.api.XBeeDevice
 
run() - Method in class com.digi.xbee.api.connection.DataReader
 
RX16IOPacket - Class in com.digi.xbee.api.packet.raw
This class represents an RX16 Address IO packet.
RX16IOPacket(XBee16BitAddress, int, int, byte[]) - Constructor for class com.digi.xbee.api.packet.raw.RX16IOPacket
Class constructor.
RX16Packet - Class in com.digi.xbee.api.packet.raw
This class represents an RX (Receive) 16 Request packet.
RX16Packet(XBee16BitAddress, int, int, byte[]) - Constructor for class com.digi.xbee.api.packet.raw.RX16Packet
Class constructor.
RX64IOPacket - Class in com.digi.xbee.api.packet.raw
This class represents an RX64 Address IO packet.
RX64IOPacket(XBee64BitAddress, int, int, byte[]) - Constructor for class com.digi.xbee.api.packet.raw.RX64IOPacket
Class constructor.
RX64Packet - Class in com.digi.xbee.api.packet.raw
This class represents an RX (Receive) 64 Request packet.
RX64Packet(XBee64BitAddress, int, int, byte[]) - Constructor for class com.digi.xbee.api.packet.raw.RX64Packet
Class constructor.

S

sendBreak(int) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Sends a break signal to the serial port with the given duration (in milliseconds).
sendBreak(int) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
sendBroadcastData(byte[]) - Method in class com.digi.xbee.api.XBeeDevice
Sends the provided data to all the XBee nodes of the network (broadcast).
sendData(XBee64BitAddress, byte[]) - Method in class com.digi.xbee.api.DigiMeshDevice
 
sendData(XBee64BitAddress, byte[]) - Method in class com.digi.xbee.api.Raw802Device
 
sendData(XBee16BitAddress, byte[]) - Method in class com.digi.xbee.api.Raw802Device
Sends the provided data to the XBee device of the network corresponding to the given 16-bit address.
sendData(RemoteXBeeDevice, byte[]) - Method in class com.digi.xbee.api.XBeeDevice
Sends the provided data to the given XBee device choosing the optimal send method depending on the protocol of the local XBee device.
sendData(XBee64BitAddress, XBee16BitAddress, byte[]) - Method in class com.digi.xbee.api.ZigBeeDevice
 
sendDataAsync(XBee64BitAddress, byte[]) - Method in class com.digi.xbee.api.DigiMeshDevice
 
sendDataAsync(XBee64BitAddress, XBee16BitAddress, byte[]) - Method in class com.digi.xbee.api.DigiPointDevice
 
sendDataAsync(XBee64BitAddress, byte[]) - Method in class com.digi.xbee.api.Raw802Device
 
sendDataAsync(XBee16BitAddress, byte[]) - Method in class com.digi.xbee.api.Raw802Device
Sends the provided data to the XBee device of the network corresponding to the given 16-bit address asynchronously.
sendDataAsync(RemoteXBeeDevice, byte[]) - Method in class com.digi.xbee.api.XBeeDevice
Sends the provided data to the provided XBee device asynchronously.
sendDataAsync(XBee64BitAddress, XBee16BitAddress, byte[]) - Method in class com.digi.xbee.api.ZigBeeDevice
 
sendPacket(XBeePacket, IPacketReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice
Sends the given XBee packet and registers the given packet listener (if not null) to be notified when the answers is received.
sendPacket(XBeePacket) - Method in class com.digi.xbee.api.XBeeDevice
Sends the given XBee packet synchronously and blocks until the response is received or the configured receive timeout expires.
sendPacketAsync(XBeePacket) - Method in class com.digi.xbee.api.XBeeDevice
Sends the given XBee packet asynchronously.
SENT_FROM_END_DEVICE - Static variable in class com.digi.xbee.api.models.XBeeReceiveOptions
Packet was sent from an end device, if known (value: 64).
serialEvent(SerialPortEvent) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
SerialPortInfo - Class in com.digi.xbee.api.connection.serial
Helper class used to store serial port information.
SerialPortInfo(String) - Constructor for class com.digi.xbee.api.connection.serial.SerialPortInfo
Class constructor.
SerialPortInfo(String, String) - Constructor for class com.digi.xbee.api.connection.serial.SerialPortInfo
Class constructor.
SerialPortParameters - Class in com.digi.xbee.api.connection.serial
Helper class used to store serial connection parameters information.
SerialPortParameters(int, int, int, int, int) - Constructor for class com.digi.xbee.api.connection.serial.SerialPortParameters
Class constructor.
SerialPortRxTx - Class in com.digi.xbee.api.connection.serial
This class represents a serial port using the RxTx library to communicate with it.
SerialPortRxTx(String, SerialPortParameters) - Constructor for class com.digi.xbee.api.connection.serial.SerialPortRxTx
Class constructor.
SerialPortRxTx(String, SerialPortParameters, int) - Constructor for class com.digi.xbee.api.connection.serial.SerialPortRxTx
Class constructor.
SerialPortRxTx(String, int) - Constructor for class com.digi.xbee.api.connection.serial.SerialPortRxTx
Class constructor.
SerialPortRxTx(String, int, int) - Constructor for class com.digi.xbee.api.connection.serial.SerialPortRxTx
Class constructor.
set16BitAddress(XBee16BitAddress) - Method in class com.digi.xbee.api.Raw802Device
 
set16BitAddress(XBee16BitAddress) - Method in class com.digi.xbee.api.RemoteRaw802Device
 
set64BitAddress(XBee64BitAddress) - Method in class com.digi.xbee.api.RemoteRaw802Device
Sets the XBee64BitAddress of this remote 802.15.4 device.
setBreak(boolean) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Enables or disables the break line.
setBreak(boolean) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
setCommandValue(String) - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
Sets the AT command response value as String.
setCommandValue(byte[]) - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
Sets the AT command response value.
setCommandValue(String) - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
Sets the AT command response value as String.
setCommandValue(byte[]) - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
Sets the AT response response value.
setDestinationAddress(XBee64BitAddress) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Sets the 64-bit destination extended address of this XBee device.
setDIOChangeDetection(Set<IOLine>) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Sets the digital IO lines of this XBee device to be monitored and sampled whenever their status changes.
setDIOValue(IOLine, IOValue) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Sets the digital value (high or low) to the provided IO line of this XBee device.
setDiscoveryOptions(Set<DiscoveryOptions>) - Method in class com.digi.xbee.api.XBeeNetwork
Configures the discovery options (NO parameter) with the given value.
setDiscoveryTimeout(long) - Method in class com.digi.xbee.api.XBeeNetwork
Configures the discovery timeout (NT parameter) with the given value.
setDTR(boolean) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Sets the state of the DTR.
setDTR(boolean) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
setFrameID(int) - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
Sets the frame ID of the API packet.
setIOConfiguration(IOLine, IOMode) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Sets the configuration of the given IO line of this XBee device.
setIOSamplingRate(int) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Sets the IO sampling rate to enable periodic sampling in this XBee device.
setNodeID(String) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Sets the node identifier of this XBee device.
setPANID(byte[]) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Sets the PAN ID (Personal Area Network Identifier) of this XBee device.
setParameter(String, byte[]) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Sets the given parameter with the provided value in this XBee device.
setParameter(String) - Method in class com.digi.xbee.api.models.ATCommand
Sets the AT command parameter as string.
setParameter(byte[]) - Method in class com.digi.xbee.api.models.ATCommand
Sets the AT command parameter as byte array.
setParameter(String) - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
Sets the AT command parameter as String.
setParameter(byte[]) - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
Sets the AT command parameter.
setParameter(String) - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
Sets the AT command parameter as String.
setParameter(byte[]) - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
Sets the AT command parameter.
setParameter(String) - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
Sets the AT command parameter as String.
setParameter(byte[]) - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
Sets the AT command parameter.
setPortDescription(String) - Method in class com.digi.xbee.api.connection.serial.SerialPortInfo
Sets the serial port description.
setPortParameters(int, int, int, int, int) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Sets the new parameters of the serial port.
setPortParameters(SerialPortParameters) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Sets the new parameters of the serial port as SerialPortParameters.
setPortParameters(int, int, int, int, int) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
setPowerLevel(PowerLevel) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Sets the output power level at which this XBee device transmits conducted power.
setPWMDutyCycle(IOLine, double) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Sets the duty cycle (in %) of the provided IO line of this XBee device.
setReadTimeout(int) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Sets the read timeout of the serial port (in milliseconds).
setReadTimeout(int) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
setReceiveTimeout(int) - Method in class com.digi.xbee.api.XBeeDevice
Configures this XBee device timeout in milliseconds for receiving packets in synchronous operations.
setRFData(byte[]) - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
Sets the received RF data.
setRFData(byte[]) - Method in class com.digi.xbee.api.packet.common.ReceivePacket
Sets the received RF data.
setRFData(byte[]) - Method in class com.digi.xbee.api.packet.common.TransmitPacket
Sets the RF Data to send.
setRFData(byte[]) - Method in class com.digi.xbee.api.packet.GenericXBeePacket
Sets the XBee RF Data.
setRFData(byte[]) - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
Sets the received RF data.
setRFData(byte[]) - Method in class com.digi.xbee.api.packet.raw.RX16Packet
Sets the received RF data.
setRFData(byte[]) - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
Sets the received RF data.
setRFData(byte[]) - Method in class com.digi.xbee.api.packet.raw.RX64Packet
Sets the received RF data.
setRFData(byte[]) - Method in class com.digi.xbee.api.packet.raw.TX16Packet
Sets the RF data to send.
setRFData(byte[]) - Method in class com.digi.xbee.api.packet.raw.TX64Packet
Sets the RF data to send.
setRFData(byte[]) - Method in class com.digi.xbee.api.packet.UnknownXBeePacket
Sets the XBee RF Data.
setRTS(boolean) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
Sets the state of the RTS line.
setRTS(boolean) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
setXBeeReaderMode(OperatingMode) - Method in class com.digi.xbee.api.connection.DataReader
Sets the XBee operating mode of this data reader.
shortToByteArray(short) - Static method in class com.digi.xbee.api.utils.ByteUtils
Converts the given short value into a byte array.
SpecialByte - Enum in com.digi.xbee.api.models
Enumerates all the special bytes of the XBee protocol that must be escaped when working on API 2 mode.
startDiscoveryProcess() - Method in class com.digi.xbee.api.XBeeNetwork
Starts the discovery process with the configured timeout and options.
stopBits - Variable in class com.digi.xbee.api.connection.serial.SerialPortParameters
 
stopDiscoveryProcess() - Method in class com.digi.xbee.api.XBeeNetwork
Stops the discovery process if it is running.
stopReader() - Method in class com.digi.xbee.api.connection.DataReader
Stops the Data reader thread.
stringToByteArray(String) - Static method in class com.digi.xbee.api.utils.ByteUtils
Converts the given string into a byte array.
swapByteArray(byte[]) - Static method in class com.digi.xbee.api.utils.ByteUtils
Swaps the given byte array order.

T

TimeoutException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when performing synchronous operations and the configured time expires.
TimeoutException() - Constructor for exception com.digi.xbee.api.exceptions.TimeoutException
Creates a TimeoutException with as its error detail message.
TimeoutException(String) - Constructor for exception com.digi.xbee.api.exceptions.TimeoutException
Creates a TimeoutException with the specified message.
TimeoutException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.TimeoutException
Creates a TimeoutException with the specified message and cause.
toPrettyString() - Method in class com.digi.xbee.api.packet.XBeePacket
Returns a pretty string representing the packet.
toString() - Method in class com.digi.xbee.api.AbstractXBeeDevice
 
toString() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
 
toString() - Method in class com.digi.xbee.api.connection.serial.SerialPortParameters
 
toString() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
 
toString() - Method in enum com.digi.xbee.api.io.IOLine
 
toString() - Method in enum com.digi.xbee.api.io.IOMode
 
toString() - Method in class com.digi.xbee.api.io.IOSample
 
toString() - Method in enum com.digi.xbee.api.io.IOValue
 
toString() - Method in enum com.digi.xbee.api.models.AssociationIndicationStatus
 
toString() - Method in enum com.digi.xbee.api.models.ATCommandStatus
 
toString() - Method in enum com.digi.xbee.api.models.DiscoveryOptions
 
toString() - Method in class com.digi.xbee.api.models.HardwareVersion
 
toString() - Method in enum com.digi.xbee.api.models.HardwareVersionEnum
 
toString() - Method in enum com.digi.xbee.api.models.ModemStatusEvent
 
toString() - Method in enum com.digi.xbee.api.models.OperatingMode
 
toString() - Method in enum com.digi.xbee.api.models.PowerLevel
 
toString() - Method in class com.digi.xbee.api.models.XBee16BitAddress
 
toString() - Method in class com.digi.xbee.api.models.XBee64BitAddress
 
toString() - Method in enum com.digi.xbee.api.models.XBeeDiscoveryStatus
 
toString() - Method in enum com.digi.xbee.api.models.XBeeProtocol
 
toString() - Method in enum com.digi.xbee.api.models.XBeeTransmitStatus
 
toString() - Method in enum com.digi.xbee.api.packet.APIFrameType
 
toString() - Method in class com.digi.xbee.api.packet.XBeePacket
 
toString() - Method in class com.digi.xbee.api.RemoteXBeeDevice
 
toString() - Method in class com.digi.xbee.api.XBeeDevice
 
toString() - Method in class com.digi.xbee.api.XBeeNetwork
 
TransmitException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when receiving a transmit status different than XBeeTransmitStatus#SUCCESS after sending an XBee API packet.
TransmitException(XBeeTransmitStatus) - Constructor for exception com.digi.xbee.api.exceptions.TransmitException
Creates a TransmitException with the provided XBeeTransmitStatus indicating the status of the transmission and as its error detail message.
TransmitException(String, XBeeTransmitStatus) - Constructor for exception com.digi.xbee.api.exceptions.TransmitException
Creates a TransmitException with the specified message and XBeeTransmitStatus indicating the status of the transmission.
TransmitException(String, Throwable, XBeeTransmitStatus) - Constructor for exception com.digi.xbee.api.exceptions.TransmitException
Creates a TransmitException with the specified message, cause and XBeeTransmitStatus indicating the status of the transmission.
TransmitPacket - Class in com.digi.xbee.api.packet.common
This class represents a Transmit Packet.
TransmitPacket(int, XBee64BitAddress, XBee16BitAddress, int, int, byte[]) - Constructor for class com.digi.xbee.api.packet.common.TransmitPacket
Class constructor.
TransmitStatusPacket - Class in com.digi.xbee.api.packet.common
This class represents a Transmit Status Packet.
TransmitStatusPacket(int, XBee16BitAddress, int, XBeeTransmitStatus, XBeeDiscoveryStatus) - Constructor for class com.digi.xbee.api.packet.common.TransmitStatusPacket
Class constructor.
TX16Packet - Class in com.digi.xbee.api.packet.raw
This class represents a TX (Transmit) 16 Request packet.
TX16Packet(int, XBee16BitAddress, int, byte[]) - Constructor for class com.digi.xbee.api.packet.raw.TX16Packet
Class constructor.
TX64Packet - Class in com.digi.xbee.api.packet.raw
This class represents a TX (Transmit) 64 Request packet.
TX64Packet(int, XBee64BitAddress, int, byte[]) - Constructor for class com.digi.xbee.api.packet.raw.TX64Packet
Class constructor.
TXStatusPacket - Class in com.digi.xbee.api.packet.raw
This class represents a TX (Transmit) Status packet.
TXStatusPacket(int, XBeeTransmitStatus) - Constructor for class com.digi.xbee.api.packet.raw.TXStatusPacket
Class constructor.

U

UNKNOWN_ADDRESS - Static variable in class com.digi.xbee.api.models.XBee16BitAddress
16-bit unknown address (value: FFFE).
UNKNOWN_ADDRESS - Static variable in class com.digi.xbee.api.models.XBee64BitAddress
64-bit unknown address (value: 000000000000FFFE).
UnknownXBeePacket - Class in com.digi.xbee.api.packet
This class represents a basic and unknown XBee packet where the payload is set as a byte array without a defined structure.
UnknownXBeePacket(int, byte[]) - Constructor for class com.digi.xbee.api.packet.UnknownXBeePacket
Class constructor.
updateDeviceDataFrom(AbstractXBeeDevice) - Method in class com.digi.xbee.api.AbstractXBeeDevice
Updates the current device reference with the data provided for the given device.
USE_BROADCAST_PAN_ID - Static variable in class com.digi.xbee.api.models.XBeeTransmitOptions
Sends packet with broadcast PAN ID.
USE_EXTENDED_TIMEOUT - Static variable in class com.digi.xbee.api.models.XBeeTransmitOptions
Uses the extended transmission timeout (value: 64).

V

validate() - Method in class com.digi.xbee.api.packet.XBeeChecksum
Validates the checksum.
valueOf(String) - Static method in enum com.digi.xbee.api.io.IOLine
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.io.IOMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.io.IOValue
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.models.AssociationIndicationStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.models.ATCommandStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.models.ATStringCommands
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.models.DiscoveryOptions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.models.HardwareVersionEnum
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.models.ModemStatusEvent
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.models.OperatingMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.models.PowerLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.models.SpecialByte
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.models.XBeeDiscoveryStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.models.XBeeProtocol
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.models.XBeeTransmitStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.digi.xbee.api.packet.APIFrameType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.digi.xbee.api.io.IOLine
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.io.IOMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.io.IOValue
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.models.AssociationIndicationStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.models.ATCommandStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.models.ATStringCommands
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.models.DiscoveryOptions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.models.HardwareVersionEnum
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.models.ModemStatusEvent
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.models.OperatingMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.models.PowerLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.models.SpecialByte
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.models.XBeeDiscoveryStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.models.XBeeProtocol
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.models.XBeeTransmitStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.digi.xbee.api.packet.APIFrameType
Returns an array containing the constants of this enum type, in the order they are declared.
Version - Class in com.digi.xbee.api
Class used to retrieve the current version of the XBee Java Library.
Version() - Constructor for class com.digi.xbee.api.Version
 

W

writeChanges() - Method in class com.digi.xbee.api.AbstractXBeeDevice
Writes configurable parameter values to the non-volatile memory of this XBee device so that parameter modifications persist through subsequent resets.
writeData(byte[]) - Method in interface com.digi.xbee.api.connection.IConnectionInterface
Writes the given data in the connection interface.
writeData(byte[], int, int) - Method in interface com.digi.xbee.api.connection.IConnectionInterface
Writes the given data in the connection interface.
writeData(byte[]) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
 
writeData(byte[], int, int) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
 

X

XBee - Class in com.digi.xbee.api
Helper class used to create a serial port connection interface.
XBee() - Constructor for class com.digi.xbee.api.XBee
 
XBee16BitAddress - Class in com.digi.xbee.api.models
This class represents a 16-bit network address.
XBee16BitAddress(int, int) - Constructor for class com.digi.xbee.api.models.XBee16BitAddress
Class constructor.
XBee16BitAddress(byte[]) - Constructor for class com.digi.xbee.api.models.XBee16BitAddress
Class constructor.
XBee16BitAddress(String) - Constructor for class com.digi.xbee.api.models.XBee16BitAddress
Class constructor.
XBee64BitAddress - Class in com.digi.xbee.api.models
This class represents a 64-bit address (also known as MAC address).
XBee64BitAddress(byte[]) - Constructor for class com.digi.xbee.api.models.XBee64BitAddress
Class constructor.
XBee64BitAddress(String) - Constructor for class com.digi.xbee.api.models.XBee64BitAddress
Class constructor.
XBee64BitAddress(int, int, int, int, int, int, int, int) - Constructor for class com.digi.xbee.api.models.XBee64BitAddress
Class constructor.
XBeeAPIPacket - Class in com.digi.xbee.api.packet
This abstract class provides the basic structure of a ZigBee API frame.
XBeeChecksum - Class in com.digi.xbee.api.packet
This class stores, computes and verifies the checksum of the API packets.
XBeeChecksum() - Constructor for class com.digi.xbee.api.packet.XBeeChecksum
 
XBeeDevice - Class in com.digi.xbee.api
This class represents a local XBee device.
XBeeDevice(String, int) - Constructor for class com.digi.xbee.api.XBeeDevice
Class constructor.
XBeeDevice(String, int, int, int, int, int) - Constructor for class com.digi.xbee.api.XBeeDevice
Class constructor.
XBeeDevice(String, SerialPortParameters) - Constructor for class com.digi.xbee.api.XBeeDevice
Class constructor.
XBeeDevice(IConnectionInterface) - Constructor for class com.digi.xbee.api.XBeeDevice
Class constructor.
XBeeDeviceException - Exception in com.digi.xbee.api.exceptions
This exception will be thrown when any problem related to the XBee device occurs.
XBeeDeviceException() - Constructor for exception com.digi.xbee.api.exceptions.XBeeDeviceException
Creates an XBeeDeviceException with null as its error detail message.
XBeeDeviceException(Throwable) - Constructor for exception com.digi.xbee.api.exceptions.XBeeDeviceException
Creates an XBeeDeviceException with the specified cause.
XBeeDeviceException(String) - Constructor for exception com.digi.xbee.api.exceptions.XBeeDeviceException
Creates an XBeeDeviceException with the specified message.
XBeeDeviceException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.XBeeDeviceException
Creates an XBeeDeviceException with the specified message and cause.
XBeeDiscoveryStatus - Enum in com.digi.xbee.api.models
Enumerates all the possible states of the discovery.
XBeeException - Exception in com.digi.xbee.api.exceptions
Generic XBee API exception.
XBeeException() - Constructor for exception com.digi.xbee.api.exceptions.XBeeException
Creates an XBeeException with null as its error detail message.
XBeeException(Throwable) - Constructor for exception com.digi.xbee.api.exceptions.XBeeException
Creates an XBeeException with the specified cause.
XBeeException(String) - Constructor for exception com.digi.xbee.api.exceptions.XBeeException
Creates an XBeeException with the specified message.
XBeeException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.XBeeException
Creates an XBeeException with the specified message and cause.
XBeeMessage - Class in com.digi.xbee.api.models
This class represents an XBee message containing the remote XBee device the message belongs to, the content (data) of the message and a flag indicating if the message is a broadcast message (was received or is being sent via broadcast).
XBeeMessage(RemoteXBeeDevice, byte[]) - Constructor for class com.digi.xbee.api.models.XBeeMessage
Class constructor.
XBeeMessage(RemoteXBeeDevice, byte[], boolean) - Constructor for class com.digi.xbee.api.models.XBeeMessage
Class constructor.
XBeeNetwork - Class in com.digi.xbee.api
This class represents an XBee Network.
XBeePacket - Class in com.digi.xbee.api.packet
This abstract class represents the basic structure of an XBee packet.
XBeePacketParser - Class in com.digi.xbee.api.packet
This class reads and parses XBee packets from the input stream returning a generic XBeePacket which can be casted later to the corresponding high level specific API packet.
XBeePacketParser() - Constructor for class com.digi.xbee.api.packet.XBeePacketParser
 
XBeePacketsQueue - Class in com.digi.xbee.api.models
This class represents a queue of XBee packets used for sequential packets reading within the XBee Java API.
XBeePacketsQueue() - Constructor for class com.digi.xbee.api.models.XBeePacketsQueue
Class constructor.
XBeePacketsQueue(int) - Constructor for class com.digi.xbee.api.models.XBeePacketsQueue
Class constructor.
XBeeProtocol - Enum in com.digi.xbee.api.models
Enumerates the available XBee protocols.
XBeeReceiveOptions - Class in com.digi.xbee.api.models
This class lists all the possible options that have been set while receiving an XBee packet.
XBeeReceiveOptions() - Constructor for class com.digi.xbee.api.models.XBeeReceiveOptions
 
XBeeTransmitOptions - Class in com.digi.xbee.api.models
This class lists all the possible options that can be set while transmitting an XBee data packet.
XBeeTransmitOptions() - Constructor for class com.digi.xbee.api.models.XBeeTransmitOptions
 
XBeeTransmitStatus - Enum in com.digi.xbee.api.models
Enumerates the different transmit status.

Z

ZigBeeDevice - Class in com.digi.xbee.api
This class represents a local ZigBee device.
ZigBeeDevice(String, int) - Constructor for class com.digi.xbee.api.ZigBeeDevice
Class constructor.
ZigBeeDevice(String, int, int, int, int, int) - Constructor for class com.digi.xbee.api.ZigBeeDevice
Class constructor.
ZigBeeDevice(String, SerialPortParameters) - Constructor for class com.digi.xbee.api.ZigBeeDevice
Class constructor.
ZigBeeDevice(IConnectionInterface) - Constructor for class com.digi.xbee.api.ZigBeeDevice
Class constructor.
ZigBeeNetwork - Class in com.digi.xbee.api
This class represents a ZigBee Network.
A B C D E F G H I L M N O P R S T U V W X Z 
Skip navigation links
XBee Java Library 1.0.1
2014-dic-10 18:52 CET

© Copyright 2014–2014 Digi International Inc. All rights reserved.