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

A

AbstractBluetoothInterface - Class in com.digi.xbee.api.connection.bluetooth

This class provides common functionality to Bluetooth Low Energy interfaces.

AbstractBluetoothInterface() - Constructor for class com.digi.xbee.api.connection.bluetooth.AbstractBluetoothInterface

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(AbstractXBeeDevice, XBee64BitAddress) - Constructor for class com.digi.xbee.api.AbstractXBeeDevice

Class constructor.

AbstractXBeeDevice(AbstractXBeeDevice, XBee64BitAddress, XBee16BitAddress, String) - Constructor for class com.digi.xbee.api.AbstractXBeeDevice

Class constructor.

AbstractXBeeDevice(AbstractXBeeDevice, Inet6Address) - Constructor for class com.digi.xbee.api.AbstractXBeeDevice

Class constructor.

AbstractXBeeDevice(AbstractXBeeDevice, Inet6Address, String) - Constructor for class com.digi.xbee.api.AbstractXBeeDevice

Class constructor.

AccessPoint - Class in com.digi.xbee.api.models

This class represents an Access Point for the Wi-Fi protocol.

AccessPoint(String, WiFiEncryptionType) - Constructor for class com.digi.xbee.api.models.AccessPoint

Class constructor.

AccessPoint(String, WiFiEncryptionType, int, int) - Constructor for class com.digi.xbee.api.models.AccessPoint

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.

addBluetoothDataListener(IBluetoothDataReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice

addBluetoothDataReceiveListener(IBluetoothDataReceiveListener) - Method in class com.digi.xbee.api.DataReader

Adds the given data receive listener to the list of listeners that will be notified when new data from the Bluetooth interface is received in a User Data Relay frame.

addDataListener(IDataReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice

addDataReceiveListener(IDataReceiveListener) - Method in class com.digi.xbee.api.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.

addExplicitDataListener(IExplicitDataReceiveListener) - Method in class com.digi.xbee.api.DigiMeshDevice

addExplicitDataListener(IExplicitDataReceiveListener) - Method in class com.digi.xbee.api.DigiPointDevice

addExplicitDataListener(IExplicitDataReceiveListener) - Method in class com.digi.xbee.api.ZigBeeDevice

addExplicitDataReceiveListener(IExplicitDataReceiveListener) - Method in class com.digi.xbee.api.DataReader

Adds the given explicit data receive listener to the list of listeners that will be notified when an explicit data packet is received.

addIOSampleListener(IIOSampleReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice

addIOSampleReceiveListener(IIOSampleReceiveListener) - Method in class com.digi.xbee.api.DataReader

Adds the given IO sample receive listener to the list of listeners that will be notified when an IO sample packet is received.

addIPDataListener(IIPDataReceiveListener) - Method in class com.digi.xbee.api.IPDevice

addIPDataListener(IIPDataReceiveListener) - Method in class com.digi.xbee.api.IPv6Device

addIPDataReceiveListener(IIPDataReceiveListener) - Method in class com.digi.xbee.api.DataReader

Adds the given IP data receive listener to the list of listeners that will be notified when a IP data packet is received.

addMicroPythonDataListener(IMicroPythonDataReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice

addMicroPythonDataReceiveListener(IMicroPythonDataReceiveListener) - Method in class com.digi.xbee.api.DataReader

Adds the given data receive listener to the list of listeners that will be notified when new data from the MicroPython interface is received in a User Data Relay frame.

addModemStatusListener(IModemStatusReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice

addModemStatusReceiveListener(IModemStatusReceiveListener) - Method in class com.digi.xbee.api.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.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.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.

addSerialDataReceiveListener(ISerialDataReceiveListener) - Method in class com.digi.xbee.api.DataReader

Adds the given data receive listener to the list of listeners that will be notified when new data from the serial interface is received in a User Data Relay frame.

addSMSListener(ISMSReceiveListener) - Method in class com.digi.xbee.api.CellularDevice

addSMSReceiveListener(ISMSReceiveListener) - Method in class com.digi.xbee.api.DataReader

Adds the given SMS receive listener to the list of listeners that will be notified when an SMS packet is received.

addUserDataRelayListener(IUserDataRelayReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice

addUserDataRelayReceiveListener(IUserDataRelayReceiveListener) - Method in class com.digi.xbee.api.DataReader

Adds the given User Data Relay receive listener to the list of listeners that will be notified when a User Data Relay packet is received.

API_USERNAME - Static variable in class com.digi.xbee.api.utils.srp.SrpConstants

APIFrameType - Enum in com.digi.xbee.api.packet

This enumeration lists all the available frame types used in any XBee protocol.

APIOutputMode - Enum in com.digi.xbee.api.models

Enumerates the different API output modes.

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

BluetoothAuthenticationException - Exception in com.digi.xbee.api.exceptions

This exception will be thrown when trying authenticate over Bluetooth with an XBee device and there is an error.

BluetoothAuthenticationException() - Constructor for exception com.digi.xbee.api.exceptions.BluetoothAuthenticationException

Creates a BluetoothAuthenticationException with a default message as its error detail message.

BluetoothAuthenticationException(Throwable) - Constructor for exception com.digi.xbee.api.exceptions.BluetoothAuthenticationException

Creates a BluetoothAuthenticationException with the given cause of the exception.

BluetoothAuthenticationException(String) - Constructor for exception com.digi.xbee.api.exceptions.BluetoothAuthenticationException

Creates a BluetoothAuthenticationException with the given message.

BluetoothAuthenticationException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.BluetoothAuthenticationException

Creates a BluetoothAuthenticationException with the given message and cause.

BluetoothUnlockPacket - Class in com.digi.xbee.api.packet.bluetooth

This class represents a Bluetooth Unlock packet.

BluetoothUnlockPacket(SrpStep, byte[]) - Constructor for class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockPacket

Class constructor.

BluetoothUnlockResponsePacket - Class in com.digi.xbee.api.packet.bluetooth

This class represents a Bluetooth Unlock Respone packet.

BluetoothUnlockResponsePacket(SrpStep, byte[]) - Constructor for class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockResponsePacket

Class constructor.

BluetoothUnlockResponsePacket(SrpError) - Constructor for class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockResponsePacket

Class constructor.

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_IP - Static variable in class com.digi.xbee.api.IPDevice

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.

CellularAssociationIndicationStatus - Enum in com.digi.xbee.api.models

Enumerates the different association indication status for the Cellular protocol.

CellularDevice - Class in com.digi.xbee.api

This class represents a local Cellular device.

CellularDevice(String, int) - Constructor for class com.digi.xbee.api.CellularDevice

Class constructor.

CellularDevice(String, int, int, int, int, int) - Constructor for class com.digi.xbee.api.CellularDevice

Class constructor.

CellularDevice(String, SerialPortParameters) - Constructor for class com.digi.xbee.api.CellularDevice

Class constructor.

CellularDevice(IConnectionInterface) - Constructor for class com.digi.xbee.api.CellularDevice

Class constructor.

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

CoAPRxResponsePacket - Class in com.digi.xbee.api.packet.thread

This class represents a CoAP Rx Response packet.

CoAPRxResponsePacket(int, Inet6Address, Inet6Address, int, int, IPProtocol, RestFulStatusEnum, byte[]) - Constructor for class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Class constructor.

CoAPTxRequestPacket - Class in com.digi.xbee.api.packet.thread

This class represents a CoAP Tx Request packet.

CoAPTxRequestPacket(int, int, HTTPMethodEnum, Inet6Address, String, byte[]) - Constructor for class com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

Class constructor.

CoAPURI - Class in com.digi.xbee.api.models

Class containing the different constants that can be used as Uniform Resource Identifier (URI) when working with CoAP transmissions.

CoAPURI() - Constructor for class com.digi.xbee.api.models.CoAPURI

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.bluetooth - package com.digi.xbee.api.connection.bluetooth

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.listeners.relay - package com.digi.xbee.api.listeners.relay

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.bluetooth - package com.digi.xbee.api.packet.bluetooth

com.digi.xbee.api.packet.cellular - package com.digi.xbee.api.packet.cellular

com.digi.xbee.api.packet.common - package com.digi.xbee.api.packet.common

com.digi.xbee.api.packet.devicecloud - package com.digi.xbee.api.packet.devicecloud

com.digi.xbee.api.packet.ip - package com.digi.xbee.api.packet.ip

com.digi.xbee.api.packet.raw - package com.digi.xbee.api.packet.raw

com.digi.xbee.api.packet.relay - package com.digi.xbee.api.packet.relay

com.digi.xbee.api.packet.thread - package com.digi.xbee.api.packet.thread

com.digi.xbee.api.packet.wifi - package com.digi.xbee.api.packet.wifi

com.digi.xbee.api.utils - package com.digi.xbee.api.utils

com.digi.xbee.api.utils.srp - package com.digi.xbee.api.utils.srp

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.

connect(String, String) - Method in class com.digi.xbee.api.WiFiDevice

Connects to the access point with provided SSID.

connect(AccessPoint, String) - Method in class com.digi.xbee.api.WiFiDevice

Connects to the provided access point.

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.

ConnectionType - Enum in com.digi.xbee.api.connection

Enumerates the different connection types.

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

Returns 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

Returns 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.bluetooth.BluetoothUnlockPacket

Creates a new BluetoothUnlockPacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockResponsePacket

Creates a new BluetoothUnlockResponsePacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.cellular.RXSMSPacket

Creates a new RXSMSPacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.cellular.TXSMSPacket

Creates a new TXSMSPacket object from the given payload.

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.ExplicitAddressingPacket

Creates a new ExplicitAddressingPacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

Creates a new ExplicitRxIndicatorPacket 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.devicecloud.DeviceRequestPacket

Creates a new DeviceRequestPacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.devicecloud.DeviceResponsePacket

Creates a new DeviceResponsePacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.devicecloud.DeviceResponseStatusPacket

Creates a new DeviceResponseStatusPacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.devicecloud.FrameErrorPacket

Creates a new FrameErrorPacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

Creates a new SendDataRequestPacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.devicecloud.SendDataResponsePacket

Creates a new SendDataResponsePacket 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.ip.RXIPv4Packet

Creates a new RXIPv4Packet object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

Creates a new TXIPv4Packet object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

Creates a new TXTLSProfilePacket object 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.relay.UserDataRelayOutputPacket

Creates a new UserDataRelayOutputPacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.relay.UserDataRelayPacket

Creates a new UserDataRelayPacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Creates a new CoAPRxResponsePacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

Creates a new CoAPTxRequestPacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.thread.IPv6IODataSampleRxIndicator

Creates a new IPv6IODataSampleRxIndicator object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandRequestPacket

Creates a new IPv6RemoteATCommandRequestPacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandResponsePacket

Creates a new IPv6RemoteATCommandResponsePacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

Creates a new RXIPv6Packet object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.thread.TXIPv6Packet

Creates a new TXIPv6Packet 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.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.wifi.IODataSampleRxIndicatorWifiPacket

Creates a new IODataSampleRxIndicatorWifiPacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.wifi.RemoteATCommandResponseWifiPacket

Creates an new RemoteATCommandResponseWifiPacket object from the given payload.

createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.wifi.RemoteATCommandWifiPacket

Creates a new RemoteATCommandWifiPacket object from the given payload.

CURRENT_VERSION - Static variable in class com.digi.xbee.api.Version

D

DATA_CLUSTER - Static variable in class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

DATA_ENDPOINT - Static variable in class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

dataBits - Variable in class com.digi.xbee.api.connection.serial.SerialPortParameters

DataReader - Class in com.digi.xbee.api

Thread that constantly reads data from an input stream.

DataReader(IConnectionInterface, OperatingMode, AbstractXBeeDevice) - Constructor for class com.digi.xbee.api.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.

dataReceived(byte[]) - Method in interface com.digi.xbee.api.listeners.relay.IBluetoothDataReceiveListener

Called when data is received from the Bluetooth interface in a User Data Relay frame.

dataReceived(byte[]) - Method in interface com.digi.xbee.api.listeners.relay.IMicroPythonDataReceiveListener

Called when data is received from the MicroPython interface in a User Data Relay frame.

dataReceived(byte[]) - Method in interface com.digi.xbee.api.listeners.relay.ISerialDataReceiveListener

Called when data is received from the serial interface in a User Data Relay frame.

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.

DeviceCloudStatus - Enum in com.digi.xbee.api.models

Enumerates the different Device Cloud statuses.

deviceDiscovered(RemoteXBeeDevice) - Method in interface com.digi.xbee.api.listeners.IDiscoveryListener

Notifies that a remote device was discovered in the network.

DeviceRequestPacket - Class in com.digi.xbee.api.packet.devicecloud

This class represents a Device Request packet.

DeviceRequestPacket(int, String, byte[]) - Constructor for class com.digi.xbee.api.packet.devicecloud.DeviceRequestPacket

Class constructor.

DeviceResponsePacket - Class in com.digi.xbee.api.packet.devicecloud

This class represents a Device Response packet.

DeviceResponsePacket(int, int, byte[]) - Constructor for class com.digi.xbee.api.packet.devicecloud.DeviceResponsePacket

Class constructor.

DeviceResponseStatusPacket - Class in com.digi.xbee.api.packet.devicecloud

This class represents a Device Response Status packet.

DeviceResponseStatusPacket(int, DeviceCloudStatus) - Constructor for class com.digi.xbee.api.packet.devicecloud.DeviceResponseStatusPacket

Class constructor.

DIGI_PROFILE - Static variable in class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

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

disableBluetooth() - Method in class com.digi.xbee.api.AbstractXBeeDevice

Disables the Bluetooth interface of this XBee device.

disconnect() - Method in class com.digi.xbee.api.WiFiDevice

Disconnects from the access point the device is connected to.

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_MULTICAST - Static variable in class com.digi.xbee.api.models.XBeeTransmitOptions

Enables multicast transmission request (value: 8).

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.

enableBluetooth() - Method in class com.digi.xbee.api.AbstractXBeeDevice

Enables the Bluetooth interface of this XBee device.

equals(Object) - Method in class com.digi.xbee.api.connection.serial.SerialPortParameters

equals(Object) - Method in class com.digi.xbee.api.io.IOSample

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

equals(Object) - Method in class com.digi.xbee.api.models.XBeeIMEIAddress

equals(Object) - Method in class com.digi.xbee.api.packet.XBeePacket

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.

ExplicitAddressingPacket - Class in com.digi.xbee.api.packet.common

This class represents an Explicit Addressing Command packet.

ExplicitAddressingPacket(int, XBee64BitAddress, XBee16BitAddress, int, int, int, int, int, int, byte[]) - Constructor for class com.digi.xbee.api.packet.common.ExplicitAddressingPacket

Class constructor.

explicitDataReceived(ExplicitXBeeMessage) - Method in interface com.digi.xbee.api.listeners.IExplicitDataReceiveListener

Called when explicit data is received from a remote node of the network.

ExplicitRxIndicatorPacket - Class in com.digi.xbee.api.packet.common

This class represents an Explicit RX Indicator packet.

ExplicitRxIndicatorPacket(XBee64BitAddress, XBee16BitAddress, int, int, int, int, int, byte[]) - Constructor for class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

Class constructor.

ExplicitXBeeMessage - Class in com.digi.xbee.api.models

This class represents an Explicit XBee message containing the remote XBee device the message belongs to, the content (data) of the message, a flag indicating if the message is a broadcast message (was received or is being sent via broadcast) and all the application layer fields: source endpoint, destination endpoint, cluster ID and profile ID.

ExplicitXBeeMessage(RemoteXBeeDevice, int, int, int, int, byte[]) - Constructor for class com.digi.xbee.api.models.ExplicitXBeeMessage

Class constructor.

ExplicitXBeeMessage(RemoteXBeeDevice, int, int, int, int, byte[], boolean) - Constructor for class com.digi.xbee.api.models.ExplicitXBeeMessage

Class constructor.

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.RemoteThreadDevice

forceDisassociate() - Method in class com.digi.xbee.api.RemoteZigBeeDevice

forceDisassociate() - Method in class com.digi.xbee.api.ZigBeeDevice

FrameError - Enum in com.digi.xbee.api.models

Enumerates the different frame errors.

FrameErrorPacket - Class in com.digi.xbee.api.packet.devicecloud

This class represents a Frame Error packet.

FrameErrorPacket(FrameError) - Constructor for class com.digi.xbee.api.packet.devicecloud.FrameErrorPacket

Class constructor.

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.

generateSalt() - Static method in class com.digi.xbee.api.utils.srp.SrpUtils

Generates and returns a random salt number.

generateVerifier(byte[], String) - Static method in class com.digi.xbee.api.utils.srp.SrpUtils

Generates and returns a verifier from the provided salt and password.

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.connection.ConnectionType

Retrieves the connection type for the given ID.

get(int) - Static method in enum com.digi.xbee.api.models.APIOutputMode

Returns the APIOutputMode entry associated to the given value.

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 enum com.digi.xbee.api.models.CellularAssociationIndicationStatus

Returns the CellularAssociationIndicationStatus associated to the given value.

get(int) - Static method in enum com.digi.xbee.api.models.DeviceCloudStatus

Retrieves the DeviceCloudStatus for the given ID.

get(int) - Static method in enum com.digi.xbee.api.models.FrameError

Retrieves the Frame Error for the given ID.

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.HTTPMethodEnum

Returns the HTTP method associated to the given value.

get(int) - Static method in enum com.digi.xbee.api.models.IPAddressingMode

Retrieves the IP addressing mode for the given ID.

get(int) - Static method in enum com.digi.xbee.api.models.IPProtocol

Retrieves the IP protocol for the given ID.

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.OperatingMode

Returns the OperatingMode entry associated to the given value.

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.RestFulStatusEnum

Retrieves the RestFul status for the given ID.

get(int) - Static method in enum com.digi.xbee.api.models.SendDataRequestOptions

Retrieves the SendDataRequestOptions for the given ID.

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.SrpError

Retrieves the SrpError for the given ID code.

get(int) - Static method in enum com.digi.xbee.api.models.SrpStep

Retrieves the SrpStep for the given ID code.

get(int) - Static method in enum com.digi.xbee.api.models.ThreadAssociationIndicationStatus

Returns the ThreadAssociationIndicationStatus associated to the given value.

get(int) - Static method in enum com.digi.xbee.api.models.WiFiAssociationIndicationStatus

Returns the WiFiAssociationIndicationStatus associated to the given value.

get(int) - Static method in enum com.digi.xbee.api.models.WiFiEncryptionType

Retrieves the encryption type for the given ID.

get(int) - Static method in enum com.digi.xbee.api.models.XBeeDiscoveryStatus

Returns the XBeeDiscoveryStatus associated to the given identifier.

get(int) - Static method in enum com.digi.xbee.api.models.XBeeLocalInterface

Retrieves the XBeeLocalInterface for the given ID code.

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 identifier.

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.ExplicitAddressingPacket

Returns the 16-bit destination address.

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.ExplicitRxIndicatorPacket

Returns the 16 bit sender/source 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.ExplicitAddressingPacket

Returns the 64-bit destination address.

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.ExplicitRxIndicatorPacket

Returns the 64 bit sender/source 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.

getAccessPoint(String) - Method in class com.digi.xbee.api.WiFiDevice

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

getAccessPointTimeout() - Method in class com.digi.xbee.api.WiFiDevice

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

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.

getAPIOutputMode() - Method in class com.digi.xbee.api.DigiMeshDevice

getAPIOutputMode() - Method in class com.digi.xbee.api.DigiPointDevice

getAPIOutputMode() - Method in class com.digi.xbee.api.ZigBeeDevice

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockPacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockResponsePacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.cellular.RXSMSPacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.cellular.TXSMSPacket

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.ExplicitAddressingPacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

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.devicecloud.DeviceRequestPacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.devicecloud.DeviceResponsePacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.devicecloud.DeviceResponseStatusPacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.devicecloud.FrameErrorPacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.devicecloud.SendDataResponsePacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.ip.RXIPv4Packet

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

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

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.relay.UserDataRelayOutputPacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.relay.UserDataRelayPacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.thread.IPv6IODataSampleRxIndicator

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandRequestPacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandResponsePacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.thread.TXIPv6Packet

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.wifi.IODataSampleRxIndicatorWifiPacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandResponseWifiPacket

getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandWifiPacket

getAPIPacketSpecificData() - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockPacket

getAPIPacketSpecificData() - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockResponsePacket

getAPIPacketSpecificData() - Method in class com.digi.xbee.api.packet.common.ExplicitAddressingPacket

getAPIPacketSpecificData() - Method in class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

getAPIPacketSpecificData() - Method in class com.digi.xbee.api.packet.common.ModemStatusPacket

getAPIPacketSpecificData() - Method in class com.digi.xbee.api.packet.relay.UserDataRelayOutputPacket

getAPIPacketSpecificData() - Method in class com.digi.xbee.api.packet.relay.UserDataRelayPacket

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

getBluetoothMacAddress() - Method in class com.digi.xbee.api.AbstractXBeeDevice

Reads and returns the EUI-48 Bluetooth MAC address of this XBee device in a format such as 00112233AABB.

getBroadcastRadius() - Method in class com.digi.xbee.api.packet.common.ExplicitAddressingPacket

Returns the broadcast radius.

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

getCellularAssociationIndicationStatus() - Method in class com.digi.xbee.api.CellularDevice

Returns the current association status of this Cellular device.

getChannel() - Method in class com.digi.xbee.api.models.AccessPoint

Returns the operating channel of the access point.

getChecksum() - Method in class com.digi.xbee.api.packet.XBeePacket

Returns the packet checksum.

getClusterID() - Method in class com.digi.xbee.api.models.ExplicitXBeeMessage

Returns the cluster ID the packet was addressed to.

getClusterID() - Method in class com.digi.xbee.api.packet.common.ExplicitAddressingPacket

Returns the cluster ID used in the transmission.

getClusterID() - Method in class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

Returns the cluster ID used in the transmission.

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.

getCommand() - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandRequestPacket

Returns the AT Command.

getCommand() - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandResponsePacket

Returns the AT Command.

getCommand() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandResponseWifiPacket

Returns the AT command.

getCommand() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandWifiPacket

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.

getCommandValue() - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandResponsePacket

Retrieves the AT command response value as byte array.

getCommandValue() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandResponseWifiPacket

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.

getCommandValueAsString() - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandResponsePacket

Returns the AT command response value as String.

getCommandValueAsString() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandResponseWifiPacket

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.

getConnectionType() - Method in class com.digi.xbee.api.connection.bluetooth.AbstractBluetoothInterface

getConnectionType() - Method in interface com.digi.xbee.api.connection.IConnectionInterface

Returns the connection type of the interface.

getConnectionType() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort

getContentType() - Method in class com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

Retrieves the content type of the file to upload.

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.IPMessage

Returns the byte array containing the data of the message.

getData() - Method in class com.digi.xbee.api.models.SMSMessage

Returns a string containing the data of the message.

getData() - Method in class com.digi.xbee.api.models.UserDataRelayMessage

Returns a byte array containing the data of the message.

getData() - Method in class com.digi.xbee.api.models.XBeeMessage

Returns the a byte array containing the data of the message.

getData() - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockPacket

Retrieves the SRP data.

getData() - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockResponsePacket

Retrieves the SRP data.

getData() - Method in class com.digi.xbee.api.packet.cellular.RXSMSPacket

Returns the received data.

getData() - Method in class com.digi.xbee.api.packet.cellular.TXSMSPacket

Returns the data to send.

getData() - Method in class com.digi.xbee.api.packet.ip.RXIPv4Packet

Retrieves the received data.

getData() - Method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

Retrieves the transmission data.

getData() - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

Returns the transmission data.

getData() - Method in class com.digi.xbee.api.packet.relay.UserDataRelayOutputPacket

Retrieves the received data.

getData() - Method in class com.digi.xbee.api.packet.relay.UserDataRelayPacket

Retrieves the data to send.

getData() - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Retrieves the transmission data.

getData() - Method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

Retrieves the received data.

getData() - Method in class com.digi.xbee.api.packet.thread.TXIPv6Packet

Retrieves the transmission data.

getDataString() - Method in class com.digi.xbee.api.models.IPMessage

Returns the data of the message in string format.

getDataString() - Method in class com.digi.xbee.api.models.UserDataRelayMessage

Returns the data of the message in string format.

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.APIOutputMode

Returns the API output mode description.

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.CellularAssociationIndicationStatus

Returns the Cellular association indication 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.RestFulStatusEnum

Retrieves the RestFul status description.

getDescription() - Method in enum com.digi.xbee.api.models.SrpError

Retrieves the SrpError description.

getDescription() - Method in enum com.digi.xbee.api.models.SrpStep

Retrieves the SrpStep description.

getDescription() - Method in enum com.digi.xbee.api.models.ThreadAssociationIndicationStatus

Returns the Thread association indication status description.

getDescription() - Method in enum com.digi.xbee.api.models.WiFiAssociationIndicationStatus

Returns the Wi-Fi association indication status 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.XBeeLocalInterface

Retrieves the XBeeLocalInterface 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 transmit status description.

getDestAddress() - Method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

Retrieves the destination IP address.

getDestAddress() - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

Returns the destination IP address.

getDestAddress() - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Retrieves the destination IPv6 address.

getDestAddress() - Method in class com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

Retrieves the destination IPv6 address.

getDestAddress() - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandRequestPacket

Retrieves the destination IPv6 address.

getDestAddress() - Method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

Retrieves the destination IPv6 address.

getDestAddress() - Method in class com.digi.xbee.api.packet.thread.TXIPv6Packet

Retrieves the destination IPv6 address.

getDestinationAddress() - Method in class com.digi.xbee.api.AbstractXBeeDevice

Returns the 64-bit destination extended address of this XBee device.

getDestinationAddress() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandWifiPacket

Retrieves the IP destination address.

getDestinationEndpoint() - Method in class com.digi.xbee.api.models.ExplicitXBeeMessage

Returns the endpoint of the destination the message was addressed to.

getDestinationEndpoint() - Method in class com.digi.xbee.api.packet.common.ExplicitAddressingPacket

Returns the destination endpoint of the transmission.

getDestinationEndpoint() - Method in class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

Returns the destination endpoint of the transmission.

getDestinationInterface() - Method in class com.digi.xbee.api.packet.relay.UserDataRelayPacket

Retrieves the the destination XBee local interface.

getDestinationIPAddress() - Method in class com.digi.xbee.api.IPDevice

Returns the destination IP address.

getDestPort() - Method in class com.digi.xbee.api.models.IPMessage

Returns the destination port of the transmission.

getDestPort() - Method in class com.digi.xbee.api.packet.ip.RXIPv4Packet

Retrieves the destination port.

getDestPort() - Method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

Retrieves the destination port.

getDestPort() - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

Returns the destination port.

getDestPort() - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Retrieves the destination port.

getDestPort() - Method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

Retrieves the destination port.

getDestPort() - Method in class com.digi.xbee.api.packet.thread.TXIPv6Packet

Retrieves the destination port.

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.

getDNSAddress() - Method in class com.digi.xbee.api.WiFiDevice

Returns the IP address of domain name server.

getEncryptionType() - Method in class com.digi.xbee.api.models.AccessPoint

Returns the encryption type of the access point.

getError() - Method in class com.digi.xbee.api.packet.devicecloud.FrameErrorPacket

Retrieves the frame error.

getFileData() - Method in class com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

Retrieves the data of the file to upload.

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.

getFirstExplicitDataPacket(int) - Method in class com.digi.xbee.api.models.XBeePacketsQueue

Returns the first explicit data packet from the queue waiting up to the specified timeout if necessary for an XBee explicit data packet to become available.

getFirstExplicitDataPacketFrom(RemoteXBeeDevice, int) - Method in class com.digi.xbee.api.models.XBeePacketsQueue

Returns the first explicit data packet from the queue whose 64-bit source address matches the address of the provided remote XBee device.

getFirstIPDataPacket(int) - Method in class com.digi.xbee.api.models.XBeePacketsQueue

Returns the first IP data packet from the queue waiting up to the specified timeout if necessary for a IP data packet to become available.

getFirstIPDataPacketFrom(Inet4Address, int) - Method in class com.digi.xbee.api.models.XBeePacketsQueue

Returns the first IP data packet from the queue whose IP address matches the provided address.

getFirstIPv6DataPacket(int) - Method in class com.digi.xbee.api.models.XBeePacketsQueue

Returns the first IPv6 data packet from the queue waiting up to the specified timeout if necessary for a IPv6 data packet to become available.

getFirstIPv6DataPacketFrom(Inet6Address, int) - Method in class com.digi.xbee.api.models.XBeePacketsQueue

Returns the first IPv6 data packet from the queue whose IPv6 address matches the provided address.

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.

getFlags() - Method in class com.digi.xbee.api.packet.devicecloud.DeviceRequestPacket

Retrieves the flags.

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.

getGatewayIPAddress() - Method in class com.digi.xbee.api.WiFiDevice

Returns the IP address of the gateway.

getHardwareVersion() - Method in class com.digi.xbee.api.AbstractXBeeDevice

Returns the hardware version of this XBee device.

getHostAddress() - Method in class com.digi.xbee.api.models.IPMessage

Returns the IPv4 or IPv6 address this message is associated to.

getHsb() - Method in class com.digi.xbee.api.models.XBee16BitAddress

Returns the address high significant byte.

getID() - Method in enum com.digi.xbee.api.connection.ConnectionType

Retrieves the connection type ID.

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.DeviceCloudStatus

Retrieves the status ID.

getID() - Method in enum com.digi.xbee.api.models.FrameError

Retrieves the Frame Error ID.

getID() - Method in enum com.digi.xbee.api.models.IPAddressingMode

Retrieves the IP addressing mode ID.

getID() - Method in enum com.digi.xbee.api.models.IPProtocol

Retrieves the IP protocol 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.RestFulStatusEnum

Retrieves the RestFul status ID.

getID() - Method in enum com.digi.xbee.api.models.SendDataRequestOptions

Retrieves the option ID.

getID() - Method in enum com.digi.xbee.api.models.SrpError

Retrieves the SrpError ID code.

getID() - Method in enum com.digi.xbee.api.models.SrpStep

Retrieves the SrpStep ID code.

getID() - Method in enum com.digi.xbee.api.models.WiFiEncryptionType

Retrieves the encryption type ID.

getId() - Method in enum com.digi.xbee.api.models.XBeeDiscoveryStatus

Returns the numeric value of the discovery status identifier.

getID() - Method in enum com.digi.xbee.api.models.XBeeLocalInterface

Retrieves the XBeeLocalInterface ID code.

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 numeric value of the transmit status identifier.

getIMEIAddress() - Method in class com.digi.xbee.api.CellularDevice

Returns the IMEI address of this Cellular device.

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.thread.IPv6IODataSampleRxIndicator

Returns the IO sample corresponding to the data contained in the packet.

getIOSample() - Method in class com.digi.xbee.api.packet.wifi.IODataSampleRxIndicatorWifiPacket

Returns the IO sample corresponding to the data contained in the packet.

getIOSamples() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket

Returns the IO samples corresponding to the data contained in the packet.

getIOSamples() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket

Returns the IO samples 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.

getIPAddress() - Method in class com.digi.xbee.api.IPDevice

Returns the IP address of this IP device.

getIPAddress() - Method in class com.digi.xbee.api.models.IPMessage

Returns the IPv4 address this message is associated to.

getIPAddressingMode() - Method in class com.digi.xbee.api.WiFiDevice

Returns the IP addressing mode.

getIPAddressMask() - Method in class com.digi.xbee.api.WiFiDevice

Returns the IP address subnet mask.

getIPv6Address() - Method in class com.digi.xbee.api.AbstractXBeeDevice

Returns the IPv6 address of this IPv6 device.

getIPv6Address() - Method in class com.digi.xbee.api.models.IPMessage

Returns the IPv6 address this message is associated to.

getIPv6DestinationAddress() - Method in class com.digi.xbee.api.AbstractXBeeDevice

Returns the destination IPv6 address.

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

getMethod() - Method in class com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

Returns the HTTP method used for the transmission.

getName() - Method in enum com.digi.xbee.api.connection.ConnectionType

Retrieves the connection type name.

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.DeviceCloudStatus

Retrieves the status name.

getName() - Method in enum com.digi.xbee.api.models.FrameError

Retrieves the Frame Error name.

getName() - Method in enum com.digi.xbee.api.models.HTTPMethodEnum

Returns the HTTP method name.

getName() - Method in enum com.digi.xbee.api.models.IPAddressingMode

Retrieves the IP addressing mode name.

getName() - Method in enum com.digi.xbee.api.models.IPProtocol

Retrieves the IP protocol name.

getName() - Method in enum com.digi.xbee.api.models.OperatingMode

Returns the operating mode name.

getName() - Method in enum com.digi.xbee.api.models.SendDataRequestOptions

Retrieves the option name.

getName() - Method in enum com.digi.xbee.api.models.WiFiEncryptionType

Retrieves the encryption type 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

getNetwork() - Method in class com.digi.xbee.api.ZigBeeDevice

getNextFrameID() - Method in class com.digi.xbee.api.XBeeDevice

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

getOptions() - Method in class com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

Retrieves the file upload operation options.

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.

getParameter() - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandRequestPacket

Returns the AT command parameter as byte array.

getParameter() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandWifiPacket

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.

getParameterAsString() - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandRequestPacket

Returns the AT command parameter as String.

getParameterAsString() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandWifiPacket

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.

getPath() - Method in class com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

Retrieves the path of the file to upload to Device Cloud.

getPayload() - Method in class com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

Retrieves the transmission data.

getPhoneNumber() - Method in class com.digi.xbee.api.models.SMSMessage

Returns the phone number that sent the message.

getPhoneNumber() - Method in class com.digi.xbee.api.packet.cellular.RXSMSPacket

Returns the phone number.

getPhoneNumber() - Method in class com.digi.xbee.api.packet.cellular.TXSMSPacket

Returns the phone number.

getPhoneNumberByteArray() - Method in class com.digi.xbee.api.packet.cellular.RXSMSPacket

Returns the phone number byte array.

getPhoneNumberByteArray() - Method in class com.digi.xbee.api.packet.cellular.TXSMSPacket

Returns the phone number byte array.

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.

getProfile() - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

Returns the TLS profile.

getProfileID() - Method in class com.digi.xbee.api.models.ExplicitXBeeMessage

Returns the profile ID the packet was addressed to.

getProfileID() - Method in class com.digi.xbee.api.packet.common.ExplicitAddressingPacket

Returns the profile ID used in the transmission.

getProfileID() - Method in class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

Returns the profile ID used in the transmission.

getProtocol() - Method in class com.digi.xbee.api.models.IPMessage

Returns the protocol used in the transmission.

getProtocol() - Method in class com.digi.xbee.api.packet.ip.RXIPv4Packet

Retrieves the IP protocol.

getProtocol() - Method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

Retrieves the IP protocol.

getProtocol() - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Retrieves the IP protocol.

getProtocol() - Method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

Retrieves the IP protocol.

getProtocol() - Method in class com.digi.xbee.api.packet.thread.TXIPv6Packet

Retrieves the IP protocol.

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.ExplicitRxIndicatorPacket

Returns the receive options bitfield.

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.

getReceiveOptions() - Method in class com.digi.xbee.api.packet.wifi.IODataSampleRxIndicatorWifiPacket

Retrieves the receive options.

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

getRemoteXBeeDeviceFromPacket(XBeeAPIPacket) - Method in class com.digi.xbee.api.DataReader

Returns the remote XBee device from where the given package was sent from.

getRequestData() - Method in class com.digi.xbee.api.packet.devicecloud.DeviceRequestPacket

Retrieves the data of the device request.

getRequestID() - Method in class com.digi.xbee.api.packet.devicecloud.DeviceRequestPacket

Retrieves the ID of the device request.

getRequestID() - Method in class com.digi.xbee.api.packet.devicecloud.DeviceResponsePacket

Retrieves the ID of the device response.

getRequestTarget() - Method in class com.digi.xbee.api.packet.devicecloud.DeviceRequestPacket

Retrieves the device request target.

getResponse() - Method in class com.digi.xbee.api.models.ATCommandResponse

Returns the AT command response data in byte array format if any.

getResponseData() - Method in class com.digi.xbee.api.packet.devicecloud.DeviceResponsePacket

Retrieves the data of the device response.

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.ExplicitAddressingPacket

Returns the RF Data to send.

getRFData() - Method in class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

Returns the received RF data.

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.thread.IPv6IODataSampleRxIndicator

Returns the received RF data.

getRFData() - Method in class com.digi.xbee.api.packet.UnknownXBeePacket

Returns the XBee RF Data of the packet.

getRFData() - Method in class com.digi.xbee.api.packet.wifi.IODataSampleRxIndicatorWifiPacket

Returns the received RF data.

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

getRSSI() - Method in class com.digi.xbee.api.packet.wifi.IODataSampleRxIndicatorWifiPacket

Retrieves the RSSI value in terms of link margin.

getSessionKey() - Method in class com.digi.xbee.api.utils.srp.SrpUser

Returns the session key.

getSignalQuality() - Method in class com.digi.xbee.api.models.AccessPoint

Returns the signal quality with the access point in %.

getSourceAddress() - Method in class com.digi.xbee.api.packet.ip.RXIPv4Packet

Retrieves the source IP address.

getSourceAddress() - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Retrieves the source IPv6 address.

getSourceAddress() - Method in class com.digi.xbee.api.packet.thread.IPv6IODataSampleRxIndicator

Retrieves the source IPv6 address.

getSourceAddress() - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandResponsePacket

Retrieves the source IPv6 address.

getSourceAddress() - Method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

Retrieves the source IPv6 address.

getSourceAddress() - Method in class com.digi.xbee.api.packet.wifi.IODataSampleRxIndicatorWifiPacket

Retrieves the sender/source IP address.

getSourceAddress() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandResponseWifiPacket

Returns the IP source address.

getSourceEndpoint() - Method in class com.digi.xbee.api.models.ExplicitXBeeMessage

Returns the endpoint of the source that initiated the transmission.

getSourceEndpoint() - Method in class com.digi.xbee.api.packet.common.ExplicitAddressingPacket

Returns the source endpoint of the transmission.

getSourceEndpoint() - Method in class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

Returns the source endpoint of the transmission.

getSourceInterface() - Method in class com.digi.xbee.api.models.UserDataRelayMessage

Returns the source interface that sent this message.

getSourceInterface() - Method in class com.digi.xbee.api.packet.relay.UserDataRelayOutputPacket

Retrieves the the source XBee local interface.

getSourcePort() - Method in class com.digi.xbee.api.models.IPMessage

Returns the source port of the transmission.

getSourcePort() - Method in class com.digi.xbee.api.packet.ip.RXIPv4Packet

Retrieves the source port.

getSourcePort() - Method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

Retrieves the source port.

getSourcePort() - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

Returns the source port.

getSourcePort() - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Retrieves the source port.

getSourcePort() - Method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

Retrieves the source port.

getSourcePort() - Method in class com.digi.xbee.api.packet.thread.TXIPv6Packet

Retrieves the source port.

getSrpError() - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockResponsePacket

Retrieves the SRP error.

getSrpStep() - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockPacket

Retrieves the SRP step.

getSrpStep() - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockResponsePacket

Retrieves the SRP step.

getSSID() - Method in class com.digi.xbee.api.models.AccessPoint

Returns the SSID of the access point.

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.

getStatus() - Method in class com.digi.xbee.api.packet.devicecloud.DeviceResponseStatusPacket

Retrieves the status of the device response.

getStatus() - Method in class com.digi.xbee.api.packet.devicecloud.SendDataResponsePacket

Retrieves the file upload status.

getStatus() - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Returns the RESTFul status used for the transmission.

getStatus() - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandResponsePacket

Returns the AT command response status.

getStatus() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandResponseWifiPacket

Returns the AT command response status.

getThreadAssociationIndicationStatus() - Method in class com.digi.xbee.api.RemoteThreadDevice

Returns the current association status of this Thread device.

getThreadAssociationIndicationStatus() - Method in class com.digi.xbee.api.ThreadDevice

Returns the current association status of this Thread device.

getTransmitOptions() - Method in class com.digi.xbee.api.packet.common.ExplicitAddressingPacket

Returns the transmit options bitfield.

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.ip.TXIPv4Packet

Retrieves the transmit options.

getTransmitOptions() - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

Returns the transmit options.

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.

getTransmitOptions() - Method in class com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

Retrieves the transmit options bitfield.

getTransmitOptions() - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandRequestPacket

Returns the transmit options bitfield.

getTransmitOptions() - Method in class com.digi.xbee.api.packet.thread.TXIPv6Packet

Retrieves the transmit options.

getTransmitOptions() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandWifiPacket

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.

getTransport() - Method in class com.digi.xbee.api.packet.devicecloud.DeviceRequestPacket

Retrieves the transport.

getTransport() - Method in class com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

Retrieves the transport.

getURI() - Method in class com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

Retrieves the URI.

getValue() - Method in enum com.digi.xbee.api.models.APIOutputMode

Returns the API output mode value.

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.CellularAssociationIndicationStatus

Returns the Cellular 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.HTTPMethodEnum

Returns the HTTP method 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 enum com.digi.xbee.api.models.ThreadAssociationIndicationStatus

Returns the Thread association indication status value.

getValue() - Method in enum com.digi.xbee.api.models.WiFiAssociationIndicationStatus

Returns the Wi-Fi association indication status 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 class com.digi.xbee.api.models.XBeeIMEIAddress

Retrieves the IMEI address value.

getValue() - Method in enum com.digi.xbee.api.packet.APIFrameType

Returns the API frame type value.

getWiFiAssociationIndicationStatus() - Method in class com.digi.xbee.api.WiFiDevice

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

getXBeePacketsQueue() - Method in class com.digi.xbee.api.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.CellularDevice

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.RemoteThreadDevice

getXBeeProtocol() - Method in class com.digi.xbee.api.RemoteZigBeeDevice

getXBeeProtocol() - Method in class com.digi.xbee.api.ThreadDevice

getXBeeProtocol() - Method in class com.digi.xbee.api.WiFiDevice

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

hashCode() - Method in class com.digi.xbee.api.models.XBeeIMEIAddress

hashCode() - Method in class com.digi.xbee.api.packet.XBeePacket

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

HTTPMethodEnum - Enum in com.digi.xbee.api.models

Enumerates the different HTTP method values.

I

IBluetoothDataReceiveListener - Interface in com.digi.xbee.api.listeners.relay

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 the Bluetooth interface in a User Data Relay frame.

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.

IExplicitDataReceiveListener - Interface in com.digi.xbee.api.listeners

This interface defines the required methods that should be implemented to behave as an explicit data listener and be notified when new explicit data is received from a remote XBee device of the network.

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.

IIPDataReceiveListener - Interface in com.digi.xbee.api.listeners

This interface defines the required methods that should be implemented to behave as an IP data listener and be notified when new IP data is received.

IMicroPythonDataReceiveListener - Interface in com.digi.xbee.api.listeners.relay

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 the MicroPython interface in a User Data Relay frame.

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.

IODataSampleRxIndicatorWifiPacket - Class in com.digi.xbee.api.packet.wifi

This class represents a IO Data Sample Rx Indicator (Wi-Fi) packet.

IODataSampleRxIndicatorWifiPacket(Inet4Address, int, int, byte[]) - Constructor for class com.digi.xbee.api.packet.wifi.IODataSampleRxIndicatorWifiPacket

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.

IPAddressingMode - Enum in com.digi.xbee.api.models

Enumerates the different IP addressing modes.

ipDataReceived(IPMessage) - Method in interface com.digi.xbee.api.listeners.IIPDataReceiveListener

Called when IP data is received.

IPDevice - Class in com.digi.xbee.api

This class provides common functionality for XBee IP devices.

IPMessage - Class in com.digi.xbee.api.models

This class represents an IP message containing the IP address the message belongs to, the source and destination ports, the IP protocol, and the content (data) of the message.

IPMessage(Inet4Address, int, int, IPProtocol, byte[]) - Constructor for class com.digi.xbee.api.models.IPMessage

Class constructor.

IPMessage(Inet6Address, int, int, IPProtocol, byte[]) - Constructor for class com.digi.xbee.api.models.IPMessage

Class constructor.

IPProtocol - Enum in com.digi.xbee.api.models

Enumerates the different IP protocols.

IPv6Device - Class in com.digi.xbee.api

This class provides common functionality for XBee IPv6 devices.

IPv6IODataSampleRxIndicator - Class in com.digi.xbee.api.packet.thread

This class represents an IPv6 IO Data Sample Rx Indicator packet.

IPv6IODataSampleRxIndicator(Inet6Address, byte[]) - Constructor for class com.digi.xbee.api.packet.thread.IPv6IODataSampleRxIndicator

Class constructor.

IPv6RemoteATCommandRequestPacket - Class in com.digi.xbee.api.packet.thread

This class represents an IPv6 Remote AT Command Request packet.

IPv6RemoteATCommandRequestPacket(int, Inet6Address, int, String, String) - Constructor for class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandRequestPacket

Class constructor.

IPv6RemoteATCommandRequestPacket(int, Inet6Address, int, String, byte[]) - Constructor for class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandRequestPacket

Class constructor.

IPv6RemoteATCommandResponsePacket - Class in com.digi.xbee.api.packet.thread

This class represents an IPv6 Remote AT Command Response packet.

IPv6RemoteATCommandResponsePacket(int, Inet6Address, String, ATCommandStatus, String) - Constructor for class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandResponsePacket

Class constructor.

IPv6RemoteATCommandResponsePacket(int, Inet6Address, String, ATCommandStatus, byte[]) - Constructor for class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandResponsePacket

Class constructor.

isApplyConfigurationChangesEnabled() - Method in class com.digi.xbee.api.AbstractXBeeDevice

Returns whether the 'apply configuration changes' option is enabled in this device.

isAuthenticated() - Method in class com.digi.xbee.api.utils.srp.SrpUser

Returns whether the user is authenticated or not.

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.bluetooth.BluetoothUnlockPacket

isBroadcast() - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockResponsePacket

isBroadcast() - Method in class com.digi.xbee.api.packet.cellular.RXSMSPacket

isBroadcast() - Method in class com.digi.xbee.api.packet.cellular.TXSMSPacket

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.ExplicitAddressingPacket

isBroadcast() - Method in class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

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.devicecloud.DeviceRequestPacket

isBroadcast() - Method in class com.digi.xbee.api.packet.devicecloud.DeviceResponsePacket

isBroadcast() - Method in class com.digi.xbee.api.packet.devicecloud.DeviceResponseStatusPacket

isBroadcast() - Method in class com.digi.xbee.api.packet.devicecloud.FrameErrorPacket

isBroadcast() - Method in class com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

isBroadcast() - Method in class com.digi.xbee.api.packet.devicecloud.SendDataResponsePacket

isBroadcast() - Method in class com.digi.xbee.api.packet.GenericXBeePacket

isBroadcast() - Method in class com.digi.xbee.api.packet.ip.RXIPv4Packet

isBroadcast() - Method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

isBroadcast() - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

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.relay.UserDataRelayOutputPacket

isBroadcast() - Method in class com.digi.xbee.api.packet.relay.UserDataRelayPacket

isBroadcast() - Method in class com.digi.xbee.api.packet.UnknownXBeePacket

isBroadcast() - Method in class com.digi.xbee.api.packet.wifi.IODataSampleRxIndicatorWifiPacket

isBroadcast() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandResponseWifiPacket

isBroadcast() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandWifiPacket

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

isConnected() - Method in class com.digi.xbee.api.CellularDevice

Returns whether the device is connected to the Internet or not.

isConnected() - Method in class com.digi.xbee.api.ThreadDevice

Returns whether the device is associated to a network or not.

isConnected() - Method in class com.digi.xbee.api.WiFiDevice

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

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

ISerialDataReceiveListener - Interface in com.digi.xbee.api.listeners.relay

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 the serial interface in a User Data Relay frame.

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.

ISMSReceiveListener - Interface in com.digi.xbee.api.listeners

This interface defines the required methods that should be implemented to behave as an SMS listener and be notified when new SMS is received.

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

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

isRunning() - Method in class com.digi.xbee.api.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.

IUserDataRelayReceiveListener - Interface in com.digi.xbee.api.listeners

This interface defines the required methods that should be implemented to behave as an User Data Relay listener and be notified when new User Data Relay messages are received.

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.bluetooth.BluetoothUnlockPacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockResponsePacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.cellular.RXSMSPacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.cellular.TXSMSPacket

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.ExplicitAddressingPacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

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.devicecloud.DeviceRequestPacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.devicecloud.DeviceResponsePacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.devicecloud.DeviceResponseStatusPacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.devicecloud.FrameErrorPacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.devicecloud.SendDataResponsePacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.GenericXBeePacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.ip.RXIPv4Packet

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

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.relay.UserDataRelayOutputPacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.relay.UserDataRelayPacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.thread.IPv6IODataSampleRxIndicator

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandRequestPacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandResponsePacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.thread.TXIPv6Packet

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.UnknownXBeePacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.wifi.IODataSampleRxIndicatorWifiPacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandResponseWifiPacket

needsAPIFrameID() - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandWifiPacket

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 class com.digi.xbee.api.CellularDevice

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.ThreadDevice

open() - Method in class com.digi.xbee.api.WiFiDevice

open() - Method in class com.digi.xbee.api.XBeeDevice

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

OPTIONS_CLOSE_SOCKET - Static variable in class com.digi.xbee.api.packet.ip.TXIPv4Packet

This option will close the socket after the transmission.

OPTIONS_CLOSE_SOCKET - Static variable in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

This option will close the socket after the transmission.

OPTIONS_LEAVE_SOCKET_OPEN - Static variable in class com.digi.xbee.api.packet.ip.TXIPv4Packet

This option will leave socket open after the transmission.

OPTIONS_LEAVE_SOCKET_OPEN - Static variable in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

This option will leave socket open after the transmission.

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

parseIOSamples(byte[]) - Static method in class com.digi.xbee.api.io.IOSample

Parses the IO samples contained in the given payload.

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.

processChallenge(byte[], byte[]) - Method in class com.digi.xbee.api.utils.srp.SrpUser

Returns M1 if the challenge was successfully processed.

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

readData(int) - Method in class com.digi.xbee.api.XBeeDevice

readDataFrom(RemoteXBeeDevice) - Method in class com.digi.xbee.api.XBeeDevice

readDataFrom(RemoteXBeeDevice, int) - Method in class com.digi.xbee.api.XBeeDevice

readDeviceInfo() - Method in class com.digi.xbee.api.AbstractXBeeDevice

Reads some parameters from this device and obtains its protocol.

readDeviceInfo() - Method in class com.digi.xbee.api.CellularDevice

readDeviceInfo() - Method in class com.digi.xbee.api.IPDevice

readDeviceInfo() - Method in class com.digi.xbee.api.IPv6Device

readExplicitData() - Method in class com.digi.xbee.api.DigiMeshDevice

readExplicitData(int) - Method in class com.digi.xbee.api.DigiMeshDevice

readExplicitData() - Method in class com.digi.xbee.api.DigiPointDevice

readExplicitData(int) - Method in class com.digi.xbee.api.DigiPointDevice

readExplicitData() - Method in class com.digi.xbee.api.ZigBeeDevice

readExplicitData(int) - Method in class com.digi.xbee.api.ZigBeeDevice

readExplicitDataFrom(RemoteXBeeDevice) - Method in class com.digi.xbee.api.DigiMeshDevice

readExplicitDataFrom(RemoteXBeeDevice, int) - Method in class com.digi.xbee.api.DigiMeshDevice

readExplicitDataFrom(RemoteXBeeDevice) - Method in class com.digi.xbee.api.DigiPointDevice

readExplicitDataFrom(RemoteXBeeDevice, int) - Method in class com.digi.xbee.api.DigiPointDevice

readExplicitDataFrom(RemoteXBeeDevice) - Method in class com.digi.xbee.api.ZigBeeDevice

readExplicitDataFrom(RemoteXBeeDevice, int) - Method in class com.digi.xbee.api.ZigBeeDevice

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.

readIPData() - Method in class com.digi.xbee.api.IPDevice

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

readIPData(int) - Method in class com.digi.xbee.api.IPDevice

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

readIPData() - Method in class com.digi.xbee.api.IPv6Device

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

readIPData(int) - Method in class com.digi.xbee.api.IPv6Device

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

readIPDataFrom(Inet4Address) - Method in class com.digi.xbee.api.IPDevice

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

readIPDataFrom(Inet4Address, int) - Method in class com.digi.xbee.api.IPDevice

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

readIPDataFrom(Inet6Address) - Method in class com.digi.xbee.api.IPv6Device

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

readIPDataFrom(Inet6Address, int) - Method in class com.digi.xbee.api.IPv6Device

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

readPacket() - Method in class com.digi.xbee.api.XBeeDevice

readPacket(int) - Method in class com.digi.xbee.api.XBeeDevice

readPacketFrom(RemoteXBeeDevice) - Method in class com.digi.xbee.api.XBeeDevice

readPacketFrom(RemoteXBeeDevice, int) - Method in class com.digi.xbee.api.XBeeDevice

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.

RemoteATCommandResponseWifiPacket - Class in com.digi.xbee.api.packet.wifi

This class represents a Remote AT Command Response (Wi-Fi) packet.

RemoteATCommandResponseWifiPacket(int, Inet4Address, String, ATCommandStatus, byte[]) - Constructor for class com.digi.xbee.api.packet.wifi.RemoteATCommandResponseWifiPacket

Class constructor.

RemoteATCommandWifiPacket - Class in com.digi.xbee.api.packet.wifi

This class represents a Remote AT Command Request (Wi-Fi) packet.

RemoteATCommandWifiPacket(int, Inet4Address, int, String, byte[]) - Constructor for class com.digi.xbee.api.packet.wifi.RemoteATCommandWifiPacket

Class constructor.

RemoteATCommandWifiPacket(int, Inet4Address, int, String, String) - Constructor for class com.digi.xbee.api.packet.wifi.RemoteATCommandWifiPacket

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(AbstractXBeeDevice, XBee64BitAddress) - Constructor for class com.digi.xbee.api.RemoteDigiMeshDevice

Class constructor.

RemoteDigiMeshDevice(AbstractXBeeDevice, 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(AbstractXBeeDevice, XBee64BitAddress) - Constructor for class com.digi.xbee.api.RemoteDigiPointDevice

Class constructor.

RemoteDigiPointDevice(AbstractXBeeDevice, 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(AbstractXBeeDevice, 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(AbstractXBeeDevice, XBee16BitAddress) - Constructor for class com.digi.xbee.api.RemoteRaw802Device

Class constructor.

RemoteThreadDevice - Class in com.digi.xbee.api

This class represents a remote Thread device.

RemoteThreadDevice(ThreadDevice, Inet6Address) - Constructor for class com.digi.xbee.api.RemoteThreadDevice

Class constructor.

RemoteThreadDevice(AbstractXBeeDevice, Inet6Address) - Constructor for class com.digi.xbee.api.RemoteThreadDevice

Class constructor.

RemoteThreadDevice(AbstractXBeeDevice, Inet6Address, String) - Constructor for class com.digi.xbee.api.RemoteThreadDevice

Class constructor.

RemoteXBeeDevice - Class in com.digi.xbee.api

This class represents a remote XBee device.

RemoteXBeeDevice(AbstractXBeeDevice, XBee64BitAddress) - Constructor for class com.digi.xbee.api.RemoteXBeeDevice

Class constructor.

RemoteXBeeDevice(AbstractXBeeDevice, XBee64BitAddress, XBee16BitAddress, String) - Constructor for class com.digi.xbee.api.RemoteXBeeDevice

Class constructor.

RemoteXBeeDevice(AbstractXBeeDevice, Inet6Address) - Constructor for class com.digi.xbee.api.RemoteXBeeDevice

Class constructor.

RemoteXBeeDevice(AbstractXBeeDevice, Inet6Address, 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(AbstractXBeeDevice, XBee64BitAddress) - Constructor for class com.digi.xbee.api.RemoteZigBeeDevice

Class constructor.

RemoteZigBeeDevice(AbstractXBeeDevice, XBee64BitAddress, XBee16BitAddress, String) - Constructor for class com.digi.xbee.api.RemoteZigBeeDevice

Class constructor.

removeBluetoothDataListener(IBluetoothDataReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice

removeBluetoothDataReceiveListener(IBluetoothDataReceiveListener) - Method in class com.digi.xbee.api.DataReader

Removes the given data receive listener from the list of data receive listeners for the Bluetooth interface.

removeDataListener(IDataReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice

removeDataReceiveListener(IDataReceiveListener) - Method in class com.digi.xbee.api.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.

removeExplicitDataListener(IExplicitDataReceiveListener) - Method in class com.digi.xbee.api.DigiMeshDevice

removeExplicitDataListener(IExplicitDataReceiveListener) - Method in class com.digi.xbee.api.DigiPointDevice

removeExplicitDataListener(IExplicitDataReceiveListener) - Method in class com.digi.xbee.api.ZigBeeDevice

removeExplicitDataReceiveListener(IExplicitDataReceiveListener) - Method in class com.digi.xbee.api.DataReader

Removes the given explicit data receive listener from the list of explicit data receive listeners.

removeIOSampleListener(IIOSampleReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice

removeIOSampleReceiveListener(IIOSampleReceiveListener) - Method in class com.digi.xbee.api.DataReader

Removes the given IO sample receive listener from the list of IO sample receive listeners.

removeIPDataListener(IIPDataReceiveListener) - Method in class com.digi.xbee.api.IPDevice

removeIPDataListener(IIPDataReceiveListener) - Method in class com.digi.xbee.api.IPv6Device

removeIPDataReceiveListener(IIPDataReceiveListener) - Method in class com.digi.xbee.api.DataReader

Removes the given IP data receive listener from the list of IP data receive listeners.

removeMicroPythonDataListener(IMicroPythonDataReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice

removeMicroPythonDataReceiveListener(IMicroPythonDataReceiveListener) - Method in class com.digi.xbee.api.DataReader

Removes the given data receive listener from the list of data receive listeners for the MicroPython interface.

removeModemStatusListener(IModemStatusReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice

removeModemStatusReceiveListener(IModemStatusReceiveListener) - Method in class com.digi.xbee.api.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.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.

removeSerialDataReceiveListener(ISerialDataReceiveListener) - Method in class com.digi.xbee.api.DataReader

Removes the given data receive listener from the list of data receive listeners for the serial interface.

removeSMSListener(ISMSReceiveListener) - Method in class com.digi.xbee.api.CellularDevice

removeSMSReceiveListener(ISMSReceiveListener) - Method in class com.digi.xbee.api.DataReader

Removes the given SMS receive listener from the list of SMS receive listeners.

removeUserDataRelayListener(IUserDataRelayReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice

removeUserDataRelayReceiveListener(IUserDataRelayReceiveListener) - Method in class com.digi.xbee.api.DataReader

Removes the given User Data Relay receive listener from the list of User Data Relay receive listeners.

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

RestFulStatusEnum - Enum in com.digi.xbee.api.models

Enumerates the different RestFul statuses.

run() - Method in class com.digi.xbee.api.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.

RXIPv4Packet - Class in com.digi.xbee.api.packet.ip

This class represents an RX (Receive) IPv4 packet.

RXIPv4Packet(Inet4Address, int, int, IPProtocol, byte[]) - Constructor for class com.digi.xbee.api.packet.ip.RXIPv4Packet

Class constructor.

RXIPv6Packet - Class in com.digi.xbee.api.packet.thread

This class represents an RX (Receive) IPv6 packet.

RXIPv6Packet(Inet6Address, Inet6Address, int, int, IPProtocol, byte[]) - Constructor for class com.digi.xbee.api.packet.thread.RXIPv6Packet

Class constructor.

RXSMSPacket - Class in com.digi.xbee.api.packet.cellular

This class represents a RX (Receive) SMS packet.

RXSMSPacket(String, String) - Constructor for class com.digi.xbee.api.packet.cellular.RXSMSPacket

Class constructor.

S

scanAccessPoints() - Method in class com.digi.xbee.api.WiFiDevice

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

sendBluetoothData(byte[]) - Method in class com.digi.xbee.api.XBeeDevice

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

sendBroadcastExplicitData(int, int, int, int, byte[]) - Method in class com.digi.xbee.api.DigiMeshDevice

sendBroadcastExplicitData(int, int, int, int, byte[]) - Method in class com.digi.xbee.api.DigiPointDevice

sendBroadcastExplicitData(int, int, int, int, byte[]) - Method in class com.digi.xbee.api.ZigBeeDevice

sendBroadcastIPData(int, byte[]) - Method in class com.digi.xbee.api.IPDevice

Sends the provided IP data to all clients.

sendCoAPData(Inet6Address, String, HTTPMethodEnum, byte[]) - Method in class com.digi.xbee.api.ThreadDevice

Sends the provided CoAP IPv6 data to the given IPv6 address and port using the specified IPv6 protocol.

sendCoAPData(Inet6Address, String, HTTPMethodEnum, boolean, byte[]) - Method in class com.digi.xbee.api.ThreadDevice

Sends the provided CoAP IPv6 data to the given IPv6 address and port using the specified IPv6 protocol.

sendCoAPDataAsync(Inet6Address, String, HTTPMethodEnum, byte[]) - Method in class com.digi.xbee.api.ThreadDevice

Sends the provided CoAP IPv6 data to the given IPv6 address and port asynchronously using the specified IPv6 protocol.

sendCoAPDataAsync(Inet6Address, String, HTTPMethodEnum, boolean, byte[]) - Method in class com.digi.xbee.api.ThreadDevice

Sends the provided CoAP IPv6 data to the given IPv6 address and port asynchronously using the specified IPv6 protocol.

sendData(XBee64BitAddress, byte[]) - Method in class com.digi.xbee.api.DigiMeshDevice

sendData(XBee64BitAddress, XBee16BitAddress, byte[]) - Method in class com.digi.xbee.api.DigiPointDevice

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

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

sendDataAsync(XBee64BitAddress, XBee16BitAddress, byte[]) - Method in class com.digi.xbee.api.ZigBeeDevice

SendDataRequestOptions - Enum in com.digi.xbee.api.models

Enumerates the different options for the SendDataRequestPacket.

SendDataRequestPacket - Class in com.digi.xbee.api.packet.devicecloud

This class represents a Send Data Request packet.

SendDataRequestPacket(int, String, String, SendDataRequestOptions, byte[]) - Constructor for class com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

Class constructor.

SendDataResponsePacket - Class in com.digi.xbee.api.packet.devicecloud

This class represents a Send Data Response packet.

SendDataResponsePacket(int, DeviceCloudStatus) - Constructor for class com.digi.xbee.api.packet.devicecloud.SendDataResponsePacket

Class constructor.

sendExplicitData(RemoteXBeeDevice, int, int, int, int, byte[]) - Method in class com.digi.xbee.api.DigiMeshDevice

sendExplicitData(XBee64BitAddress, int, int, int, int, byte[]) - Method in class com.digi.xbee.api.DigiMeshDevice

sendExplicitData(RemoteXBeeDevice, int, int, int, int, byte[]) - Method in class com.digi.xbee.api.DigiPointDevice

sendExplicitData(XBee64BitAddress, XBee16BitAddress, int, int, int, int, byte[]) - Method in class com.digi.xbee.api.DigiPointDevice

sendExplicitData(RemoteXBeeDevice, int, int, int, int, byte[]) - Method in class com.digi.xbee.api.ZigBeeDevice

sendExplicitData(XBee64BitAddress, XBee16BitAddress, int, int, int, int, byte[]) - Method in class com.digi.xbee.api.ZigBeeDevice

sendExplicitDataAsync(RemoteXBeeDevice, int, int, int, int, byte[]) - Method in class com.digi.xbee.api.DigiMeshDevice

sendExplicitDataAsync(XBee64BitAddress, int, int, int, int, byte[]) - Method in class com.digi.xbee.api.DigiMeshDevice

sendExplicitDataAsync(RemoteXBeeDevice, int, int, int, int, byte[]) - Method in class com.digi.xbee.api.DigiPointDevice

sendExplicitDataAsync(XBee64BitAddress, XBee16BitAddress, int, int, int, int, byte[]) - Method in class com.digi.xbee.api.DigiPointDevice

sendExplicitDataAsync(RemoteXBeeDevice, int, int, int, int, byte[]) - Method in class com.digi.xbee.api.ZigBeeDevice

sendExplicitDataAsync(XBee64BitAddress, XBee16BitAddress, int, int, int, int, byte[]) - Method in class com.digi.xbee.api.ZigBeeDevice

sendIPData(Inet4Address, int, IPProtocol, boolean, byte[]) - Method in class com.digi.xbee.api.IPDevice

Sends the provided IP data to the given IP address and port using the specified IP protocol.

sendIPData(Inet4Address, int, IPProtocol, byte[]) - Method in class com.digi.xbee.api.IPDevice

Sends the provided IP data to the given IP address and port using the specified IP protocol.

sendIPData(Inet6Address, int, IPProtocol, byte[]) - Method in class com.digi.xbee.api.IPv6Device

Sends the provided IPv6 data to the given IPv6 address and port using the specified IPv6 protocol.

sendIPData(Inet6Address, int, IPProtocol, byte[]) - Method in class com.digi.xbee.api.ThreadDevice

sendIPDataAsync(Inet4Address, int, IPProtocol, boolean, byte[]) - Method in class com.digi.xbee.api.IPDevice

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

sendIPDataAsync(Inet4Address, int, IPProtocol, byte[]) - Method in class com.digi.xbee.api.IPDevice

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

sendIPDataAsync(Inet6Address, int, IPProtocol, byte[]) - Method in class com.digi.xbee.api.IPv6Device

Sends the provided IPv6 data to the given IPv6 address and port asynchronously using the specified IPv6 protocol.

sendIPDataAsync(Inet6Address, int, IPProtocol, byte[]) - Method in class com.digi.xbee.api.ThreadDevice

sendMicroPythonData(byte[]) - Method in class com.digi.xbee.api.XBeeDevice

sendMulticastData(XBee16BitAddress, int, int, int, int, byte[]) - Method in class com.digi.xbee.api.ZigBeeDevice

Sends a multicast transmission with the provided data to the given group ID.

sendMulticastDataAsync(XBee16BitAddress, int, int, int, int, byte[]) - Method in class com.digi.xbee.api.ZigBeeDevice

Sends a multicast asynchronous transmission with the provided data to the given group ID.

sendPacket(XBeePacket, IPacketReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice

sendPacket(XBeePacket) - Method in class com.digi.xbee.api.XBeeDevice

sendPacketAsync(XBeePacket) - Method in class com.digi.xbee.api.XBeeDevice

sendSMS(String, String) - Method in class com.digi.xbee.api.CellularDevice

Sends the provided SMS message to the given phone number.

sendSMSAsync(String, String) - Method in class com.digi.xbee.api.CellularDevice

Sends asynchronously the provided SMS to the given phone number.

sendUserDataRelay(XBeeLocalInterface, byte[]) - Method in class com.digi.xbee.api.XBeeDevice

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.

setAccessPointTimeout(int) - Method in class com.digi.xbee.api.WiFiDevice

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

setAPIOutputMode(APIOutputMode) - Method in class com.digi.xbee.api.DigiMeshDevice

setAPIOutputMode(APIOutputMode) - Method in class com.digi.xbee.api.DigiPointDevice

setAPIOutputMode(APIOutputMode) - Method in class com.digi.xbee.api.ZigBeeDevice

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

setChannel(int) - Method in class com.digi.xbee.api.models.AccessPoint

Sets the new channel of the access point.

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.

setCommandValue(String) - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandResponsePacket

Sets the AT command response value as String.

setCommandValue(byte[]) - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandResponsePacket

Sets the AT command response response value as byte array.

setCommandValue(String) - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandResponseWifiPacket

Sets the AT command response value as String.

setCommandValue(byte[]) - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandResponseWifiPacket

Sets the AT response response value.

setContentType(String) - Method in class com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

Sets the content type of the file to upload.

setData(byte[]) - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockPacket

Sets the SRP data.

setData(byte[]) - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockResponsePacket

Sets the SRP data.

setData(String) - Method in class com.digi.xbee.api.packet.cellular.RXSMSPacket

Sets the received data.

setData(String) - Method in class com.digi.xbee.api.packet.cellular.TXSMSPacket

Sets the data to send.

setData(byte[]) - Method in class com.digi.xbee.api.packet.ip.RXIPv4Packet

Sets the new received data.

setData(byte[]) - Method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

Sets the new transmission data.

setData(byte[]) - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

Sets the new transmission data.

setData(byte[]) - Method in class com.digi.xbee.api.packet.relay.UserDataRelayOutputPacket

Sets the received data.

setData(byte[]) - Method in class com.digi.xbee.api.packet.relay.UserDataRelayPacket

Sets the data to send.

setData(byte[]) - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Sets the new transmission data.

setData(byte[]) - Method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

Sets the new received data.

setData(byte[]) - Method in class com.digi.xbee.api.packet.thread.TXIPv6Packet

Sets the new transmission data.

setDestAddress(Inet4Address) - Method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

Sets the destination IP address.

setDestAddress(Inet4Address) - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

Sets the destination IP address.

setDestAddress(Inet6Address) - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Sets the destination IPv6 address.

setDestAddress(Inet6Address) - Method in class com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

Sets the destination IPv6 address.

setDestAddress(Inet6Address) - Method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

Sets the destination IPv6 address.

setDestAddress(Inet6Address) - Method in class com.digi.xbee.api.packet.thread.TXIPv6Packet

Sets the destination IPv6 address.

setDestinationAddress(XBee64BitAddress) - Method in class com.digi.xbee.api.AbstractXBeeDevice

Sets the 64-bit destination extended address of this XBee device.

setDestinationInterface(XBeeLocalInterface) - Method in class com.digi.xbee.api.packet.relay.UserDataRelayPacket

Sets the destination XBee local interface.

setDestinationIPAddress(Inet4Address) - Method in class com.digi.xbee.api.IPDevice

Sets the destination IP address.

setDestPort(int) - Method in class com.digi.xbee.api.packet.ip.RXIPv4Packet

Sets the destination port.

setDestPort(int) - Method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

Sets the destination port.

setDestPort(int) - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

Sets the destination port.

setDestPort(int) - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Sets the destination port.

setDestPort(int) - Method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

Sets the destination port.

setDestPort(int) - Method in class com.digi.xbee.api.packet.thread.TXIPv6Packet

Sets the destination port.

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.

setDNSAddress(Inet4Address) - Method in class com.digi.xbee.api.WiFiDevice

Sets the IP address of domain name server.

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

setEncryptionKeys(byte[], byte[], byte[]) - Method in class com.digi.xbee.api.connection.bluetooth.AbstractBluetoothInterface

Sets the encryption keys and starts to encrypt the communication with the module.

setError(FrameError) - Method in class com.digi.xbee.api.packet.devicecloud.FrameErrorPacket

Sets the frame error.

setFileData(byte[]) - Method in class com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

Sets the data of the file to upload.

setFrameID(int) - Method in class com.digi.xbee.api.packet.XBeeAPIPacket

Sets the frame ID of the API packet.

setGatewayIPAddress(Inet4Address) - Method in class com.digi.xbee.api.WiFiDevice

Sets the IP address of the gateway.

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.

setIPAddress(Inet4Address) - Method in class com.digi.xbee.api.WiFiDevice

Sets the IP address of the module.

setIPAddressingMode(IPAddressingMode) - Method in class com.digi.xbee.api.WiFiDevice

Sets the IP addressing mode.

setIPAddressMask(Inet4Address) - Method in class com.digi.xbee.api.WiFiDevice

Sets the IP address subnet mask.

setIPv6DestinationAddress(Inet6Address) - Method in class com.digi.xbee.api.AbstractXBeeDevice

Sets the destination IPv6 address.

setMethod(HTTPMethodEnum) - Method in class com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

Sets the HTTP method used for the transmission.

setNodeID(String) - Method in class com.digi.xbee.api.AbstractXBeeDevice

Sets the node identifier of this XBee device.

setOptions(SendDataRequestOptions) - Method in class com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

Sets the file upload operation options.

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.

setParameter(String) - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandRequestPacket

Sets the AT command parameter as String.

setParameter(byte[]) - Method in class com.digi.xbee.api.packet.thread.IPv6RemoteATCommandRequestPacket

Sets the AT command parameter as byte array.

setParameter(String) - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandWifiPacket

Sets the AT command parameter as String.

setParameter(byte[]) - Method in class com.digi.xbee.api.packet.wifi.RemoteATCommandWifiPacket

Sets the AT command parameter.

setPath(String) - Method in class com.digi.xbee.api.packet.devicecloud.SendDataRequestPacket

Sets the path of the file to upload to Device Cloud.

setPayload(byte[]) - Method in class com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

Sets the new transmission data.

setPhoneNumber(String) - Method in class com.digi.xbee.api.packet.cellular.RXSMSPacket

Sets the phone number.

setPhoneNumber(String) - Method in class com.digi.xbee.api.packet.cellular.TXSMSPacket

Sets the phone number.

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.

setProfile(int) - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

Sets the TLS profile.

setProtocol(IPProtocol) - Method in class com.digi.xbee.api.packet.ip.RXIPv4Packet

Sets the IP protocol.

setProtocol(IPProtocol) - Method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

Sets the IP protocol.

setProtocol(IPProtocol) - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Sets the IP protocol.

setProtocol(IPProtocol) - Method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

Sets the IP protocol.

setProtocol(IPProtocol) - Method in class com.digi.xbee.api.packet.thread.TXIPv6Packet

Sets the IP protocol.

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

setReceiveOptions(int) - Method in class com.digi.xbee.api.packet.wifi.IODataSampleRxIndicatorWifiPacket

Sets the receive options.

setReceiveTimeout(int) - Method in class com.digi.xbee.api.XBeeDevice

setRequestData(byte[]) - Method in class com.digi.xbee.api.packet.devicecloud.DeviceRequestPacket

Sets the data of the device request.

setRequestID(int) - Method in class com.digi.xbee.api.packet.devicecloud.DeviceRequestPacket

Sets ID of the device request.

setRequestID(int) - Method in class com.digi.xbee.api.packet.devicecloud.DeviceResponsePacket

Sets ID of the device response.

setRequestTarget(String) - Method in class com.digi.xbee.api.packet.devicecloud.DeviceRequestPacket

Sets the device request target.

setResponseData(byte[]) - Method in class com.digi.xbee.api.packet.devicecloud.DeviceResponsePacket

Sets the data of the device response.

setRFData(byte[]) - Method in class com.digi.xbee.api.packet.common.ExplicitAddressingPacket

Sets the RF Data to send.

setRFData(byte[]) - Method in class com.digi.xbee.api.packet.common.ExplicitRxIndicatorPacket

Sets the received RF data.

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.thread.IPv6IODataSampleRxIndicator

Sets the received RF data.

setRFData(byte[]) - Method in class com.digi.xbee.api.packet.UnknownXBeePacket

Sets the XBee RF Data.

setRSSI(int) - Method in class com.digi.xbee.api.packet.wifi.IODataSampleRxIndicatorWifiPacket

Sets the RSSI value in terms of link margin.

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

setSignalQuality(int) - Method in class com.digi.xbee.api.models.AccessPoint

Sets the new signal quality with the access point.

setSourceAddress(Inet4Address) - Method in class com.digi.xbee.api.packet.ip.RXIPv4Packet

Sets the source IP address.

setSourceAddress(Inet6Address) - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Sets the source IPv6 address.

setSourceAddress(Inet6Address) - Method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

Sets the destination IPv6 address.

setSourceAddress(Inet4Address) - Method in class com.digi.xbee.api.packet.wifi.IODataSampleRxIndicatorWifiPacket

Sets the sender/source IP address.

setSourceInterface(XBeeLocalInterface) - Method in class com.digi.xbee.api.packet.relay.UserDataRelayOutputPacket

Sets the source XBee local interface.

setSourcePort(int) - Method in class com.digi.xbee.api.packet.ip.RXIPv4Packet

Sets the source port.

setSourcePort(int) - Method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

Sets the source port.

setSourcePort(int) - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

Sets the source port.

setSourcePort(int) - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Sets the source port.

setSourcePort(int) - Method in class com.digi.xbee.api.packet.thread.RXIPv6Packet

Sets the source port.

setSourcePort(int) - Method in class com.digi.xbee.api.packet.thread.TXIPv6Packet

Sets the source port.

setSrpError(SrpError) - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockResponsePacket

Sets the SRP error.

setSrpStep(SrpStep) - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockPacket

Sets the SRP step.

setSrpStep(SrpStep) - Method in class com.digi.xbee.api.packet.bluetooth.BluetoothUnlockResponsePacket

Sets the SRP step.

setStatus(DeviceCloudStatus) - Method in class com.digi.xbee.api.packet.devicecloud.DeviceResponseStatusPacket

Sets the status of the device response.

setStatus(DeviceCloudStatus) - Method in class com.digi.xbee.api.packet.devicecloud.SendDataResponsePacket

Sets the file upload status.

setStatus(RestFulStatusEnum) - Method in class com.digi.xbee.api.packet.thread.CoAPRxResponsePacket

Sets the RESTFul status used for the transmission.

setTransmitOptions(int) - Method in class com.digi.xbee.api.packet.ip.TXIPv4Packet

Sets the transmit options.

setTransmitOptions(int) - Method in class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

Sets the transmit options.

setTransmitOptions(int) - Method in class com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

Sets the transmit options bifield.

setURI(String) - Method in class com.digi.xbee.api.packet.thread.CoAPTxRequestPacket

Sets the URI.

setXBeeReaderMode(OperatingMode) - Method in class com.digi.xbee.api.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.

SMSMessage - Class in com.digi.xbee.api.models

This class represents an SMS message containing the phone number that sent the message and the content (data) of the message.

SMSMessage(String, String) - Constructor for class com.digi.xbee.api.models.SMSMessage

Class constructor.

smsReceived(SMSMessage) - Method in interface com.digi.xbee.api.listeners.ISMSReceiveListener

Called when SMS is received.

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.

SrpConstants - Class in com.digi.xbee.api.utils.srp

Class that defines the Secure Remote Password protocol constants.

SrpConstants() - Constructor for class com.digi.xbee.api.utils.srp.SrpConstants

SrpError - Enum in com.digi.xbee.api.models

Enumerates the different errors of the SRP authentication.

SrpStep - Enum in com.digi.xbee.api.models

Enumerates the available steps of the SRP authentication.

SrpUser - Class in com.digi.xbee.api.utils.srp

This class represents the user role in the Secure Remote Password protocol.

SrpUser(String, String) - Constructor for class com.digi.xbee.api.utils.srp.SrpUser

Class constructor.

SrpUtils - Class in com.digi.xbee.api.utils.srp

Utility class for the Secure Remote Password protocol.

SrpUtils() - Constructor for class com.digi.xbee.api.utils.srp.SrpUtils

startAuthentication() - Method in class com.digi.xbee.api.utils.srp.SrpUser

Computes and returns A, which is needed to start authentication.

startDiscoveryProcess() - Method in class com.digi.xbee.api.XBeeNetwork

Starts the discovery process with the configured timeout and options.

startListening(int) - Method in class com.digi.xbee.api.IPDevice

Starts listening for incoming IP transmissions in the provided port.

startListening(int) - Method in class com.digi.xbee.api.IPv6Device

Starts listening for incoming IPv6 transmissions in the provided port.

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.

stopListening() - Method in class com.digi.xbee.api.IPDevice

Stops listening for incoming IP transmissions.

stopListening() - Method in class com.digi.xbee.api.IPv6Device

Stops listening for incoming IPv6 transmissions.

stopReader() - Method in class com.digi.xbee.api.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

ThreadAssociationIndicationStatus - Enum in com.digi.xbee.api.models

Enumerates the different association indication status for the Thread protocol.

ThreadDevice - Class in com.digi.xbee.api

This class represents a local Thread device.

ThreadDevice(String, int) - Constructor for class com.digi.xbee.api.ThreadDevice

Class constructor.

ThreadDevice(String, int, int, int, int, int) - Constructor for class com.digi.xbee.api.ThreadDevice

Class constructor.

ThreadDevice(String, SerialPortParameters) - Constructor for class com.digi.xbee.api.ThreadDevice

Class constructor.

ThreadDevice(IConnectionInterface) - Constructor for class com.digi.xbee.api.ThreadDevice

Class constructor.

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 enum com.digi.xbee.api.connection.ConnectionType

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 class com.digi.xbee.api.models.AccessPoint

toString() - Method in enum com.digi.xbee.api.models.APIOutputMode

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.CellularAssociationIndicationStatus

toString() - Method in enum com.digi.xbee.api.models.DeviceCloudStatus

toString() - Method in enum com.digi.xbee.api.models.DiscoveryOptions

toString() - Method in enum com.digi.xbee.api.models.FrameError

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.HTTPMethodEnum

toString() - Method in enum com.digi.xbee.api.models.IPAddressingMode

toString() - Method in enum com.digi.xbee.api.models.IPProtocol

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 enum com.digi.xbee.api.models.RestFulStatusEnum

toString() - Method in enum com.digi.xbee.api.models.SendDataRequestOptions

toString() - Method in enum com.digi.xbee.api.models.ThreadAssociationIndicationStatus

toString() - Method in enum com.digi.xbee.api.models.WiFiAssociationIndicationStatus

toString() - Method in enum com.digi.xbee.api.models.WiFiEncryptionType

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 class com.digi.xbee.api.models.XBeeIMEIAddress

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.

TXIPv4Packet - Class in com.digi.xbee.api.packet.ip

This class represents a TX (Transmit) IPv4 packet.

TXIPv4Packet(int, Inet4Address, int, int, IPProtocol, int, byte[]) - Constructor for class com.digi.xbee.api.packet.ip.TXIPv4Packet

Class constructor.

TXIPv6Packet - Class in com.digi.xbee.api.packet.thread

This class represents a TX (Transmit) IPv6 packet.

TXIPv6Packet(int, Inet6Address, int, int, IPProtocol, byte[]) - Constructor for class com.digi.xbee.api.packet.thread.TXIPv6Packet

Class constructor.

TXSMSPacket - Class in com.digi.xbee.api.packet.cellular

This class represents a TX (Transmit) SMS packet.

TXSMSPacket(int, String, String) - Constructor for class com.digi.xbee.api.packet.cellular.TXSMSPacket

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.

TXTLSProfilePacket - Class in com.digi.xbee.api.packet.ip

This class represents a TX (Transmit) request with TLS profile packet.

TXTLSProfilePacket(int, Inet4Address, int, int, int, int, byte[]) - Constructor for class com.digi.xbee.api.packet.ip.TXTLSProfilePacket

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: FFFFFFFFFFFFFFFF).

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.

updateBluetoothPassword(String) - Method in class com.digi.xbee.api.AbstractXBeeDevice

Changes the password of this Bluetooth device with the new one provided.

updateDeviceDataFrom(AbstractXBeeDevice) - Method in class com.digi.xbee.api.AbstractXBeeDevice

Updates the current device reference with the data provided for the given device.

URI_AT_COMMAND - Static variable in class com.digi.xbee.api.models.CoAPURI

URI for AT Command operation (PUT or GET).

URI_DATA_TRANSMISSION - Static variable in class com.digi.xbee.api.models.CoAPURI

URI for data transmissions (PUT).

URI_IO_SAMPLING - Static variable in class com.digi.xbee.api.models.CoAPURI

URI for IO operation (POST).

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

UserDataRelayMessage - Class in com.digi.xbee.api.models

This class represents a User Data Relay message containing the source interface and the content (data) of the message.

UserDataRelayMessage(XBeeLocalInterface, byte[]) - Constructor for class com.digi.xbee.api.models.UserDataRelayMessage

Class constructor.

UserDataRelayOutputPacket - Class in com.digi.xbee.api.packet.relay

This class represents a User Data Relay Output packet.

UserDataRelayOutputPacket(XBeeLocalInterface, byte[]) - Constructor for class com.digi.xbee.api.packet.relay.UserDataRelayOutputPacket

Class constructor.

UserDataRelayPacket - Class in com.digi.xbee.api.packet.relay

This class represents a User Data Relay packet.

UserDataRelayPacket(int, XBeeLocalInterface, byte[]) - Constructor for class com.digi.xbee.api.packet.relay.UserDataRelayPacket

Class constructor.

userDataRelayReceived(UserDataRelayMessage) - Method in interface com.digi.xbee.api.listeners.IUserDataRelayReceiveListener

Called when a User Data Relay message is received.

V

validate() - Method in class com.digi.xbee.api.packet.XBeeChecksum

Validates the checksum.

valueOf(String) - Static method in enum com.digi.xbee.api.connection.ConnectionType

Returns the enum constant of this type with the specified name.

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.APIOutputMode

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.CellularAssociationIndicationStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.digi.xbee.api.models.DeviceCloudStatus

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.FrameError

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.HTTPMethodEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.digi.xbee.api.models.IPAddressingMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.digi.xbee.api.models.IPProtocol

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.RestFulStatusEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.digi.xbee.api.models.SendDataRequestOptions

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.SrpError

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.digi.xbee.api.models.SrpStep

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.digi.xbee.api.models.ThreadAssociationIndicationStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.digi.xbee.api.models.WiFiAssociationIndicationStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.digi.xbee.api.models.WiFiEncryptionType

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.XBeeLocalInterface

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.connection.ConnectionType

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.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.APIOutputMode

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.CellularAssociationIndicationStatus

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.DeviceCloudStatus

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.FrameError

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.HTTPMethodEnum

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.IPAddressingMode

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.IPProtocol

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.RestFulStatusEnum

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.SendDataRequestOptions

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.SrpError

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.SrpStep

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.ThreadAssociationIndicationStatus

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.WiFiAssociationIndicationStatus

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.WiFiEncryptionType

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.XBeeLocalInterface

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.

verifySession(byte[]) - Method in class com.digi.xbee.api.utils.srp.SrpUser

Verifies the given server proof of session key M2.

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

WiFiAssociationIndicationStatus - Enum in com.digi.xbee.api.models

Enumerates the different association indication status for the Wi-Fi protocol.

WiFiDevice - Class in com.digi.xbee.api

This class represents a local Wi-Fi device.

WiFiDevice(String, int) - Constructor for class com.digi.xbee.api.WiFiDevice

Class constructor.

WiFiDevice(String, int, int, int, int, int) - Constructor for class com.digi.xbee.api.WiFiDevice

Class constructor.

WiFiDevice(String, SerialPortParameters) - Constructor for class com.digi.xbee.api.WiFiDevice

Class constructor.

WiFiDevice(IConnectionInterface) - Constructor for class com.digi.xbee.api.WiFiDevice

Class constructor.

WiFiEncryptionType - Enum in com.digi.xbee.api.models

Enumerates the different Wi-Fi encryption types.

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.

XBeeIMEIAddress - Class in com.digi.xbee.api.models

This class represents an IMEI address used by cellular devices.

XBeeIMEIAddress(byte[]) - Constructor for class com.digi.xbee.api.models.XBeeIMEIAddress

Class constructor.

XBeeIMEIAddress(String) - Constructor for class com.digi.xbee.api.models.XBeeIMEIAddress

Class constructor.

XBeeLocalInterface - Enum in com.digi.xbee.api.models

Enumerates the different XBee local interfaces used in the Relay API packets.

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