- calculateDiscoveryValue(XBeeProtocol, Set<DiscoveryOptions>) - Static method in enum com.digi.xbee.api.models.DiscoveryOptions
-
Calculates the total value of a combination of several options for the
given protocol.
- checkFrameID(int) - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
-
Returns whether the given ID is the current frame ID.
- clearDeviceList() - Method in class com.digi.xbee.api.XBeeNetwork
-
Removes all the devices from this network.
- clearQueue() - Method in class com.digi.xbee.api.models.XBeePacketsQueue
-
Clears the list of packets.
- close() - Method in interface com.digi.xbee.api.connection.IConnectionInterface
-
Attempts to close the connection interface.
- close() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
- close() - Method in class com.digi.xbee.api.XBeeDevice
-
Closes the connection interface associated with this XBee device.
- com.digi.xbee.api - package com.digi.xbee.api
-
- com.digi.xbee.api.connection - package com.digi.xbee.api.connection
-
- com.digi.xbee.api.connection.serial - package com.digi.xbee.api.connection.serial
-
- com.digi.xbee.api.exceptions - package com.digi.xbee.api.exceptions
-
- com.digi.xbee.api.io - package com.digi.xbee.api.io
-
- com.digi.xbee.api.listeners - package com.digi.xbee.api.listeners
-
- com.digi.xbee.api.models - package com.digi.xbee.api.models
-
- com.digi.xbee.api.packet - package com.digi.xbee.api.packet
-
- com.digi.xbee.api.packet.common - package com.digi.xbee.api.packet.common
-
- com.digi.xbee.api.packet.raw - package com.digi.xbee.api.packet.raw
-
- com.digi.xbee.api.utils - package com.digi.xbee.api.utils
-
- CommunicationException - Exception in com.digi.xbee.api.exceptions
-
This exception will be thrown when any problem related to the communication
with the XBee device occurs.
- CommunicationException() - Constructor for exception com.digi.xbee.api.exceptions.CommunicationException
-
Creates a CommunicationException
with null
as its error
detail message.
- CommunicationException(Throwable) - Constructor for exception com.digi.xbee.api.exceptions.CommunicationException
-
Creates a CommunicationException
with the specified cause.
- CommunicationException(String) - Constructor for exception com.digi.xbee.api.exceptions.CommunicationException
-
Creates a CommunicationException
with the specified message.
- CommunicationException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.CommunicationException
-
Creates a CommunicationException
with the specified message and
cause.
- ConnectionException - Exception in com.digi.xbee.api.exceptions
-
This exception will be thrown when any problem related to the connection
with the XBee device occurs.
- ConnectionException() - Constructor for exception com.digi.xbee.api.exceptions.ConnectionException
-
Creates a ConnectionException
with null
as its error
detail message.
- ConnectionException(Throwable) - Constructor for exception com.digi.xbee.api.exceptions.ConnectionException
-
Creates a ConnectionException
with the specified cause.
- ConnectionException(String) - Constructor for exception com.digi.xbee.api.exceptions.ConnectionException
-
Creates a ConnectionException
with the specified message.
- ConnectionException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.ConnectionException
-
Creates a ConnectionException
with the specified message and
cause.
- containsLetters(String) - Static method in class com.digi.xbee.api.utils.HexUtils
-
Checks whether the given parameter is a string or a numeric value.
- COORDINATOR_ADDRESS - Static variable in class com.digi.xbee.api.models.XBee16BitAddress
-
16-bit address reserved for the coordinator (value: 0000).
- COORDINATOR_ADDRESS - Static variable in class com.digi.xbee.api.models.XBee64BitAddress
-
64-bit address reserved for the coordinator (value: 0000000000000000).
- createConnectiontionInterface(String, int) - Static method in class com.digi.xbee.api.XBee
-
Retrieves a serial port connection interface for the provided port with
the given baud rate.
- createConnectiontionInterface(String, SerialPortParameters) - Static method in class com.digi.xbee.api.XBee
-
Retrieves a serial port connection interface for the provided port with
the given serial port parameters.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.ATCommandPacket
-
Creates a new ATCommandPacket
object from the given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
-
Creates a new ATCommandQueuePacket
object from the given
payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
-
Creates a new ATCommandResponsePacket
object from the given
payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
-
Creates a new IODataSampleRxIndicatorPacket
object from the
given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.ModemStatusPacket
-
Creates a new ModemStatusPacket
object from the given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.ReceivePacket
-
Creates a new ReceivePacket
object from the given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
-
Creates a new RemoteATCommandPacket
object from the given
payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
-
Creates an new RemoteATCommandResponsePacket
object from the
given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.TransmitPacket
-
Creates a new TransmitPacket
object from the given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
-
Creates a new TransmitStatusPacket
object from the given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.GenericXBeePacket
-
Creates a new GenericXBeePacket
from the given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.raw.RX16IOPacket
-
Creates a new RX16IOPacket
object from the given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.raw.RX16Packet
-
Creates a new RX16Packet
object from the given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.raw.RX64IOPacket
-
Creates an new RX64IOPacket
object from the given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.raw.RX64Packet
-
Creates a new RX64Packet
object from the given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.raw.TX16Packet
-
Creates a new TX16Packet
object from the given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.raw.TX64Packet
-
Creates a new TX64Packet
object from the given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.raw.TXStatusPacket
-
Creates a new TXStatusPacket
object from the given payload.
- createPacket(byte[]) - Static method in class com.digi.xbee.api.packet.UnknownXBeePacket
-
Creates a new UnknownXBeePacket
from the given payload.
- CURRENT_VERSION - Static variable in class com.digi.xbee.api.Version
-
- generate() - Method in class com.digi.xbee.api.packet.XBeeChecksum
-
Generates the checksum byte for the API packet.
- generateByteArray() - Method in class com.digi.xbee.api.packet.XBeePacket
-
Generates the XBee packet byte array.
- generateByteArrayEscaped() - Method in class com.digi.xbee.api.packet.XBeePacket
-
Generates the XBee packet byte array escaping the special bytes.
- generateDeviceID() - Method in class com.digi.xbee.api.models.XBee64BitAddress
-
Generates the Device ID corresponding to this XBee64BitAddress
to be used in Device Cloud.
- GenericXBeePacket - Class in com.digi.xbee.api.packet
-
This class represents a basic and Generic XBee packet where the payload is
set as a byte array without a defined structure.
- GenericXBeePacket(byte[]) - Constructor for class com.digi.xbee.api.packet.GenericXBeePacket
-
Class constructor.
- get(int) - Static method in enum com.digi.xbee.api.models.AssociationIndicationStatus
-
Returns the AssociationIndicationStatus
associated to the
given value.
- get(int) - Static method in enum com.digi.xbee.api.models.ATCommandStatus
-
Returns the ATCommandStatus
associated to the given ID.
- get(String) - Static method in enum com.digi.xbee.api.models.ATStringCommands
-
Returns the ATStringCommands
for the given AT Command alias.
- get(int) - Static method in class com.digi.xbee.api.models.HardwareVersion
-
Returns the HardwareVersion
object associated to the given
numeric value.
- get(int, String) - Static method in class com.digi.xbee.api.models.HardwareVersion
-
Returns the HardwareVersion
object associated to the given
numeric value and description.
- get(int) - Static method in enum com.digi.xbee.api.models.HardwareVersionEnum
-
Returns the HardwareVersionEnum
associated to the given
numeric value.
- get(int) - Static method in enum com.digi.xbee.api.models.ModemStatusEvent
-
Returns the ModemStatusEvent
associated to the given ID.
- get(int) - Static method in enum com.digi.xbee.api.models.PowerLevel
-
Returns the PowerLevel
entry associated to the given value.
- get(int) - Static method in enum com.digi.xbee.api.models.SpecialByte
-
Returns the SpecialByte
entry associated with the given value.
- get(int) - Static method in enum com.digi.xbee.api.models.XBeeDiscoveryStatus
-
Returns the XBeeDiscoveryStatus
associated to the given ID.
- get(int) - Static method in enum com.digi.xbee.api.models.XBeeProtocol
-
Returns the XBeeProtocol
associated to the given ID.
- get(int) - Static method in enum com.digi.xbee.api.models.XBeeTransmitStatus
-
Returns the XBeeTransmitStatus
associated to the given ID.
- get(int) - Static method in enum com.digi.xbee.api.packet.APIFrameType
-
Returns the APIFrameType
associated with the given ID value.
- get16BitAddress() - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the 16-bit address of this XBee device.
- get16bitDestinationAddress() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
-
Returns the 16 bit destination address.
- get16bitDestinationAddress() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
-
Returns the 16-bit destination address.
- get16bitDestinationAddress() - Method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
-
Returns the 16-bit destination address.
- get16bitDestinationAddress() - Method in class com.digi.xbee.api.packet.raw.TX16Packet
-
Returns the 16-bit destination address.
- get16bitSourceAddress() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
-
Returns the 16-bit sender/source address.
- get16bitSourceAddress() - Method in class com.digi.xbee.api.packet.common.ReceivePacket
-
Returns the 16-bit sender/source address.
- get16bitSourceAddress() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
-
Returns the 16-bit source address.
- get16bitSourceAddress() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
-
Returns the 16-bit sender/source address.
- get16bitSourceAddress() - Method in class com.digi.xbee.api.packet.raw.RX16Packet
-
Returns the 16-bit sender/source address.
- get64BitAddress() - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the 64-bit address of this XBee device.
- get64bitDestinationAddress() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
-
Returns the 64 bit destination address.
- get64bitDestinationAddress() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
-
Returns the 64-bit destination address.
- get64bitDestinationAddress() - Method in class com.digi.xbee.api.packet.raw.TX64Packet
-
Returns the 64-bit destination address.
- get64bitSourceAddress() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
-
Returns the 64-bit sender/source address.
- get64bitSourceAddress() - Method in class com.digi.xbee.api.packet.common.ReceivePacket
-
Returns the 64-bit sender/source address.
- get64bitSourceAddress() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
-
Returns the 64-bit source address.
- get64bitSourceAddress() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
-
Returns the 64-bit sender/source address.
- get64bitSourceAddress() - Method in class com.digi.xbee.api.packet.raw.RX64Packet
-
Returns the 64-bit sender/source address.
- getADCValue(IOLine) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the analog value of the provided IO line of this XBee device.
- getAnalogMask() - Method in class com.digi.xbee.api.io.IOSample
-
Returns the analog mask.
- getAnalogValue(IOLine) - Method in class com.digi.xbee.api.io.IOSample
-
Returns the analog value of the provided IO line.
- getAnalogValues() - Method in class com.digi.xbee.api.io.IOSample
-
Returns the analog values map.
- getAPIData() - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
-
Returns the XBee API packet data.
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.ModemStatusPacket
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.ReceivePacket
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.raw.RX16Packet
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.raw.RX64Packet
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.raw.TX16Packet
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.raw.TX64Packet
-
- getAPIPacketParameters() - Method in class com.digi.xbee.api.packet.raw.TXStatusPacket
-
- getAPIPacketSpecificData() - Method in class com.digi.xbee.api.packet.common.ModemStatusPacket
-
- getAssociationIndicationStatus() - Method in class com.digi.xbee.api.Raw802Device
-
- getAssociationIndicationStatus() - Method in class com.digi.xbee.api.RemoteRaw802Device
-
- getAssociationIndicationStatus() - Method in class com.digi.xbee.api.RemoteZigBeeDevice
-
- getAssociationIndicationStatus() - Method in class com.digi.xbee.api.ZigBeeDevice
-
- getBroadcastRadius() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
-
Returns the broadcast radius.
- getCause() - Method in exception com.digi.xbee.api.exceptions.XBeeException
-
- getChecksum() - Method in class com.digi.xbee.api.packet.XBeePacket
-
Returns the packet checksum.
- getCommand() - Method in class com.digi.xbee.api.models.ATCommand
-
Returns the AT command alias.
- getCommand() - Method in class com.digi.xbee.api.models.ATCommandResponse
-
Returns the AT command that generated the response.
- getCommand() - Method in enum com.digi.xbee.api.models.ATStringCommands
-
Returns the AT Command alias.
- getCommand() - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
-
Returns the AT command.
- getCommand() - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
-
Returns the AT command.
- getCommand() - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
-
Returns the AT command.
- getCommand() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
-
Returns the AT Command.
- getCommand() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
-
Returns the AT command.
- getCommandStatus() - Method in exception com.digi.xbee.api.exceptions.ATCommandException
-
Returns the ATCommandStatus
of the exception containing
information about the AT command response.
- getCommandStatusMessage() - Method in exception com.digi.xbee.api.exceptions.ATCommandException
-
Returns the text containing the status of the AT command response
from the exception.
- getCommandValue() - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
-
Returns the AT command response value.
- getCommandValue() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
-
Retrieves the AT command response value.
- getCommandValueAsString() - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
-
Returns the AT command response value as String.
- getCommandValueAsString() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
-
Returns the AT command response value as String.
- getConfigurationATCommand() - Method in enum com.digi.xbee.api.io.IOLine
-
Returns the configuration AT command associated to the IO line.
- getConnectionInterface() - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the connection interface associated to this XBee device.
- getCurrentSize() - Method in class com.digi.xbee.api.models.XBeePacketsQueue
-
Returns the current size of the XBee packets queue.
- getCurrentVersion() - Static method in class com.digi.xbee.api.Version
-
Returns the current version of the XBee Java Library.
- getData() - Method in class com.digi.xbee.api.models.XBeeMessage
-
Returns the a byte array containing the data of the message.
- getDataString() - Method in class com.digi.xbee.api.models.XBeeMessage
-
Returns the data of the message in string format.
- getDescription() - Method in enum com.digi.xbee.api.models.AssociationIndicationStatus
-
Returns the association indication status description.
- getDescription() - Method in enum com.digi.xbee.api.models.ATCommandStatus
-
Returns the AT Command Status description.
- getDescription() - Method in enum com.digi.xbee.api.models.DiscoveryOptions
-
Returns the description of the discovery option.
- getDescription() - Method in class com.digi.xbee.api.models.HardwareVersion
-
Returns the Hardware version description.
- getDescription() - Method in enum com.digi.xbee.api.models.HardwareVersionEnum
-
Returns the hardware version description.
- getDescription() - Method in enum com.digi.xbee.api.models.ModemStatusEvent
-
Returns the modem status description.
- getDescription() - Method in enum com.digi.xbee.api.models.PowerLevel
-
Returns the power level description.
- getDescription() - Method in enum com.digi.xbee.api.models.XBeeDiscoveryStatus
-
Returns the discovery status description.
- getDescription() - Method in enum com.digi.xbee.api.models.XBeeProtocol
-
Returns the XBee protocol description.
- getDescription() - Method in enum com.digi.xbee.api.models.XBeeTransmitStatus
-
Returns the XBee transmit status description.
- getDestinationAddress() - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the 64-bit destination extended address of this XBee device.
- getDevice() - Method in class com.digi.xbee.api.models.XBeeMessage
-
Returns the remote XBee device this message is associated to.
- getDevice(String) - Method in class com.digi.xbee.api.XBeeNetwork
-
Returns the first remote device that matches the supplied identifier.
- getDevice(XBee64BitAddress) - Method in class com.digi.xbee.api.XBeeNetwork
-
Returns the remote device already contained in the network whose 64-bit
address matches the given one.
- getDevice(XBee16BitAddress) - Method in class com.digi.xbee.api.XBeeNetwork
-
Returns the remote device already contained in the network whose 16-bit
address matches the given one.
- getDevices() - Method in class com.digi.xbee.api.XBeeNetwork
-
Returns all remote devices already contained in the network.
- getDevices(String) - Method in class com.digi.xbee.api.XBeeNetwork
-
Returns all remote devices that match the supplied identifier.
- getDigitalHSBMask() - Method in class com.digi.xbee.api.io.IOSample
-
Returns the HSB of the digital mask.
- getDigitalLSBMask() - Method in class com.digi.xbee.api.io.IOSample
-
Returns the LSB of the digital mask.
- getDigitalMask() - Method in class com.digi.xbee.api.io.IOSample
-
Returns the combined (HSB + LSB) digital mask.
- getDigitalValue(IOLine) - Method in class com.digi.xbee.api.io.IOSample
-
Returns the digital value of the provided IO line.
- getDigitalValues() - Method in class com.digi.xbee.api.io.IOSample
-
Returns the digital values map.
- getDIO(int) - Static method in enum com.digi.xbee.api.io.IOLine
-
Returns the IOLine
associated to the given index.
- getDIOChangeDetection() - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the set of IO lines of this device that are monitored for
change detection.
- getDIOValue(IOLine) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the digital value of the provided IO line of this XBee device.
- getDiscoveryStatus() - Method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
-
Returns the discovery status.
- getFirmwareVersion() - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the firmware version (hexadecimal string value) of this XBee
device.
- getFirstDataPacket(int) - Method in class com.digi.xbee.api.models.XBeePacketsQueue
-
Returns the first data packet from the queue waiting up to the
specified timeout if necessary for an XBee data packet to become
available.
- getFirstDataPacketFrom(RemoteXBeeDevice, int) - Method in class com.digi.xbee.api.models.XBeePacketsQueue
-
Returns the first data packet from the queue whose 64-bit source
address matches the address of the provided remote XBee device.
- getFirstPacket(int) - Method in class com.digi.xbee.api.models.XBeePacketsQueue
-
Returns the first packet from the queue waiting up to the specified
timeout if necessary for an XBee packet to become available.
- getFirstPacketFrom(RemoteXBeeDevice, int) - Method in class com.digi.xbee.api.models.XBeePacketsQueue
-
Returns the first packet from the queue whose 64-bit source address
matches the address of the provided remote XBee device.
- getFrameID() - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
-
Returns the Frame ID of the API packet.
- getFrameType() - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
-
Returns the XBee packet frame type.
- getFrameTypeValue() - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
-
Returns the XBee packet frame type integer value.
- getHardwareVersion() - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the hardware version of this XBee device.
- getHsb() - Method in class com.digi.xbee.api.models.XBee16BitAddress
-
Returns the address high significant byte.
- getID() - Method in enum com.digi.xbee.api.io.IOMode
-
Returns the IO mode ID.
- getID() - Method in enum com.digi.xbee.api.io.IOValue
-
Returns the ID of the IO value.
- getId() - Method in enum com.digi.xbee.api.models.ATCommandStatus
-
Returns the AT Command Status ID.
- getId() - Method in enum com.digi.xbee.api.models.ModemStatusEvent
-
Returns the modem status ID.
- getID() - Method in enum com.digi.xbee.api.models.OperatingMode
-
Returns the operating mode ID.
- getId() - Method in enum com.digi.xbee.api.models.XBeeDiscoveryStatus
-
Returns the discovery status ID.
- getID() - Method in enum com.digi.xbee.api.models.XBeeProtocol
-
Returns the XBee protocol ID.
- getId() - Method in enum com.digi.xbee.api.models.XBeeTransmitStatus
-
Returns the XBee transmit status ID.
- getIndex() - Method in enum com.digi.xbee.api.io.IOLine
-
Returns the index of the IO line.
- getInputStream() - Method in interface com.digi.xbee.api.connection.IConnectionInterface
-
Returns the connection interface input stream to read data from.
- getInputStream() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
- getIOConfiguration(IOLine) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the configuration mode of the provided IO line of this XBee
device.
- getIOMode(int) - Static method in enum com.digi.xbee.api.io.IOMode
-
Returns the IOMode
associated to the provided mode ID.
- getIOMode(int, IOLine) - Static method in enum com.digi.xbee.api.io.IOMode
-
Returns the IOMode
corresponding to the provided mode ID and
IO line.
- getIOSample() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
-
Returns the IO sample corresponding to the data contained in the packet.
- getIOSample() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
-
Returns the IO sample corresponding to the data contained in the packet.
- getIOSample() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
-
Returns the IO sample corresponding to the data contained in the packet.
- getIOSamplingRate() - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the IO sampling rate of this XBee device.
- getIOValue(int) - Static method in enum com.digi.xbee.api.io.IOValue
-
Returns the IOValue
associated to the provided value ID.
- getLsb() - Method in class com.digi.xbee.api.models.XBee16BitAddress
-
Returns the address low significant byte.
- getMaxSize() - Method in class com.digi.xbee.api.models.XBeePacketsQueue
-
Returns the maximum size of the XBee packets queue.
- getMessage() - Method in exception com.digi.xbee.api.exceptions.ATCommandException
-
- getMessage() - Method in exception com.digi.xbee.api.exceptions.TransmitException
-
- getName() - Method in enum com.digi.xbee.api.io.IOLine
-
Returns the name of the IO line.
- getName() - Method in enum com.digi.xbee.api.io.IOMode
-
Returns the IO mode name.
- getName() - Method in enum com.digi.xbee.api.io.IOValue
-
Returns the name of the IO value.
- getName() - Method in enum com.digi.xbee.api.models.OperatingMode
-
Returns the operating mode name.
- getName() - Method in enum com.digi.xbee.api.packet.APIFrameType
-
Returns the API frame type name.
- getNetwork() - Method in class com.digi.xbee.api.DigiMeshDevice
-
- getNetwork() - Method in class com.digi.xbee.api.DigiPointDevice
-
- getNetwork() - Method in class com.digi.xbee.api.Raw802Device
-
- getNetwork() - Method in class com.digi.xbee.api.XBeeDevice
-
Returns the network associated with this XBee device.
- getNetwork() - Method in class com.digi.xbee.api.ZigBeeDevice
-
- getNodeID() - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the node identifier of this XBee device.
- getNumberOfDevices() - Method in class com.digi.xbee.api.XBeeNetwork
-
Returns the number of devices already discovered in this network.
- getOperatingMode() - Method in class com.digi.xbee.api.XBeeDevice
-
Returns the Operating mode (AT, API or API escaped) of this XBee device.
- getOutputStream() - Method in interface com.digi.xbee.api.connection.IConnectionInterface
-
Returns the connection interface output stream to write data to.
- getOutputStream() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
- getPacketData() - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
-
- getPacketData() - Method in class com.digi.xbee.api.packet.XBeePacket
-
Returns the packet data.
- getPacketLength() - Method in class com.digi.xbee.api.packet.XBeePacket
-
Returns the packet length.
- getPANID() - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the operating PAN ID (Personal Area Network Identifier) of
this XBee device.
- getParameter(String) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Gets the value of the given parameter from this XBee device.
- getParameter() - Method in class com.digi.xbee.api.models.ATCommand
-
Returns the AT command parameter.
- getParameter() - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
-
Returns the AT command parameter.
- getParameter() - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
-
Returns the AT command parameter.
- getParameter() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
-
Returns the AT command parameter.
- getParameterAsString() - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
-
Returns the AT command parameter as String.
- getParameterAsString() - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
-
Returns the AT command parameter as String.
- getParameterAsString() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
-
Returns the AT command parameter as String.
- getParameters() - Method in class com.digi.xbee.api.packet.XBeePacket
-
Returns a map with the XBee packet parameters and their values.
- getParameterString() - Method in class com.digi.xbee.api.models.ATCommand
-
Returns the AT command parameter in string format.
- getPort() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Returns the name of the serial port.
- getPortDescription() - Method in class com.digi.xbee.api.connection.serial.SerialPortInfo
-
Returns the serial port description.
- getPortName() - Method in class com.digi.xbee.api.connection.serial.SerialPortInfo
-
Returns the serial port name.
- getPortParameters() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Returns the XBee serial port parameters.
- getPowerLevel() - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the output power level at which this XBee device transmits
conducted power.
- getPowerSupplyValue() - Method in class com.digi.xbee.api.io.IOSample
-
Returns the value of the power supply voltage.
- getPWMDutyCycle(IOLine) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Gets the PWM duty cycle (in %) corresponding to the provided IO line of
this XBee device.
- getPWMDutyCycleATCommand() - Method in enum com.digi.xbee.api.io.IOLine
-
Returns the PWM AT command associated to the IO line.
- getReadTimeout() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Returns the read timeout of the serial port (in milliseconds).
- getReadTimeout() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
- getReceiveOptions() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
-
Returns the receive options.
- getReceiveOptions() - Method in class com.digi.xbee.api.packet.common.ReceivePacket
-
Returns the receive options bitfield.
- getReceiveOptions() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
-
Returns the receive options bitfield.
- getReceiveOptions() - Method in class com.digi.xbee.api.packet.raw.RX16Packet
-
Returns the receive options bitfield.
- getReceiveOptions() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
-
Returns the receive options bitfield.
- getReceiveOptions() - Method in class com.digi.xbee.api.packet.raw.RX64Packet
-
Returns the receive options bitfield.
- getReceiveTimeout() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Returns the serial port receive timeout (in milliseconds).
- getReceiveTimeout() - Method in class com.digi.xbee.api.XBeeDevice
-
Returns this XBee device configured timeout for receiving packets in
synchronous operations.
- getResponse() - Method in class com.digi.xbee.api.models.ATCommandResponse
-
Returns the AT command response data in byte array format if any.
- getResponseStatus() - Method in class com.digi.xbee.api.models.ATCommandResponse
-
Returns the AT command response status.
- getResponseString() - Method in class com.digi.xbee.api.models.ATCommandResponse
-
Returns the AT command response data as string if any.
- getRFData() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
-
Returns the received RF data.
- getRFData() - Method in class com.digi.xbee.api.packet.common.ReceivePacket
-
Returns the received RF data.
- getRFData() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
-
Returns the RF Data to send.
- getRFData() - Method in class com.digi.xbee.api.packet.GenericXBeePacket
-
Returns the XBee RF Data of the packet.
- getRFData() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
-
Returns the received RF data.
- getRFData() - Method in class com.digi.xbee.api.packet.raw.RX16Packet
-
Returns the received RF data.
- getRFData() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
-
Returns the received RF data.
- getRFData() - Method in class com.digi.xbee.api.packet.raw.RX64Packet
-
Returns the received RF data.
- getRFData() - Method in class com.digi.xbee.api.packet.raw.TX16Packet
-
Returns the RF Data to send.
- getRFData() - Method in class com.digi.xbee.api.packet.raw.TX64Packet
-
Returns the RF Data to send.
- getRFData() - Method in class com.digi.xbee.api.packet.UnknownXBeePacket
-
Returns the XBee RF Data of the packet.
- getRSSI() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
-
Returns the Received Signal Strength Indicator (RSSI).
- getRSSI() - Method in class com.digi.xbee.api.packet.raw.RX16Packet
-
Returns the Received Signal Strength Indicator (RSSI).
- getRSSI() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
-
Returns the Received Signal Strength Indicator (RSSI).
- getRSSI() - Method in class com.digi.xbee.api.packet.raw.RX64Packet
-
Returns the Received Signal Strength Indicator (RSSI).
- getStatus() - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
-
Returns the AT command response status.
- getStatus() - Method in class com.digi.xbee.api.packet.common.ModemStatusPacket
-
Returns modem status event enum.
- getStatus() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
-
Returns the AT command response status.
- getTransmitOptions() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
-
Returns the transmit options bitfield.
- getTransmitOptions() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
-
Returns the transmit options bitfield.
- getTransmitOptions() - Method in class com.digi.xbee.api.packet.raw.TX16Packet
-
Returns the transmit options bitfield.
- getTransmitOptions() - Method in class com.digi.xbee.api.packet.raw.TX64Packet
-
Returns the transmit options bitfield.
- getTransmitRetryCount() - Method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
-
Returns the transmit retry count.
- getTransmitStatus() - Method in exception com.digi.xbee.api.exceptions.TransmitException
-
Returns the XBeeTransmitStatus
of the exception containing
information about the transmission.
- getTransmitStatus() - Method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
-
Returns the transmit status.
- getTransmitStatus() - Method in class com.digi.xbee.api.packet.raw.TXStatusPacket
-
Returns the transmit status.
- getTransmitStatusMessage() - Method in exception com.digi.xbee.api.exceptions.TransmitException
-
Returns the text containing the status of the transmission from
the exception.
- getValue() - Method in enum com.digi.xbee.api.models.AssociationIndicationStatus
-
Returns the association indication status value.
- getValue() - Method in enum com.digi.xbee.api.models.DiscoveryOptions
-
Returns the value of the discovery option.
- getValue() - Method in class com.digi.xbee.api.models.HardwareVersion
-
Returns the Hardware version numeric value.
- getValue() - Method in enum com.digi.xbee.api.models.HardwareVersionEnum
-
Returns the Hardware version numeric value.
- getValue() - Method in enum com.digi.xbee.api.models.PowerLevel
-
Returns the power level value.
- getValue() - Method in enum com.digi.xbee.api.models.SpecialByte
-
Returns the special byte value.
- getValue() - Method in class com.digi.xbee.api.models.XBee16BitAddress
-
Returns the 16-bit address value in byte array format.
- getValue() - Method in class com.digi.xbee.api.models.XBee64BitAddress
-
Returns the XBee 64-bit address value as byte array.
- getValue() - Method in enum com.digi.xbee.api.packet.APIFrameType
-
Returns the API frame type value.
- getXBeePacketsQueue() - Method in class com.digi.xbee.api.connection.DataReader
-
Returns the queue of read XBee packets.
- getXBeeProtocol() - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns the XBee Protocol of this XBee device.
- getXBeeProtocol() - Method in class com.digi.xbee.api.DigiMeshDevice
-
- getXBeeProtocol() - Method in class com.digi.xbee.api.DigiPointDevice
-
- getXBeeProtocol() - Method in class com.digi.xbee.api.Raw802Device
-
- getXBeeProtocol() - Method in class com.digi.xbee.api.RemoteDigiMeshDevice
-
- getXBeeProtocol() - Method in class com.digi.xbee.api.RemoteDigiPointDevice
-
- getXBeeProtocol() - Method in class com.digi.xbee.api.RemoteRaw802Device
-
- getXBeeProtocol() - Method in class com.digi.xbee.api.RemoteZigBeeDevice
-
- getXBeeProtocol() - Method in class com.digi.xbee.api.ZigBeeDevice
-
- IConnectionInterface - Interface in com.digi.xbee.api.connection
-
This interface represents a protocol independent connection with an XBee
device.
- IDataReceiveListener - Interface in com.digi.xbee.api.listeners
-
This interface defines the required methods that should be implemented to
behave as a data listener and be notified when new data is received from a
remote XBee device of the network.
- IDiscoveryListener - Interface in com.digi.xbee.api.listeners
-
Interface defining the required methods that an object should implement to be
notified about device discovery events.
- IIOSampleReceiveListener - Interface in com.digi.xbee.api.listeners
-
This interface defines the required methods that an object should implement
to behave as an IO Sample listener and be notified when IO samples are
received from a remote XBee device of the network.
- IModemStatusReceiveListener - Interface in com.digi.xbee.api.listeners
-
This interface defines the required methods that an object should implement
to behave as a modem status listener and be notified when modem status events
are received from the radio.
- integerToHexString(int, int) - Static method in class com.digi.xbee.api.utils.HexUtils
-
Converts the given integer into an hexadecimal string.
- InterfaceAlreadyOpenException - Exception in com.digi.xbee.api.exceptions
-
This exception will be thrown when trying to open an interface that is
already opened by the application.
- InterfaceAlreadyOpenException() - Constructor for exception com.digi.xbee.api.exceptions.InterfaceAlreadyOpenException
-
Creates an InterfaceAlreadyOpenedException
with
as its error detail message.
- InterfaceAlreadyOpenException(String) - Constructor for exception com.digi.xbee.api.exceptions.InterfaceAlreadyOpenException
-
Creates an InterfaceAlreadyOpenedException
with the specified
message.
- InterfaceAlreadyOpenException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.InterfaceAlreadyOpenException
-
Creates an InterfaceAlreadyOpenException
with the specified
message and cause.
- InterfaceInUseException - Exception in com.digi.xbee.api.exceptions
-
This exception will be thrown when trying to open the port/communication
interface but it is already in use by other applications.
- InterfaceInUseException() - Constructor for exception com.digi.xbee.api.exceptions.InterfaceInUseException
-
Creates an InterfaceInUseException
with
as its error detail message.
- InterfaceInUseException(String) - Constructor for exception com.digi.xbee.api.exceptions.InterfaceInUseException
-
Creates an InterfaceInUseException
with the specified message.
- InterfaceInUseException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.InterfaceInUseException
-
Creates an InterfaceInUseException
with the specified message
and cause.
- InterfaceNotOpenException - Exception in com.digi.xbee.api.exceptions
-
This exception will be thrown when trying to perform any operation with
the XBee device and its communication interface is closed.
- InterfaceNotOpenException() - Constructor for exception com.digi.xbee.api.exceptions.InterfaceNotOpenException
-
Creates an InterfaceNotOpenException
with
as its error detail message.
- InterfaceNotOpenException(String) - Constructor for exception com.digi.xbee.api.exceptions.InterfaceNotOpenException
-
Creates an InterfaceNotOpenException
with the specified
message.
- InterfaceNotOpenException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.InterfaceNotOpenException
-
Creates an InterfaceNotOpenException
with the specified message
and cause.
- intToByteArray(int) - Static method in class com.digi.xbee.api.utils.ByteUtils
-
Converts the given integer value into a byte array.
- InvalidConfigurationException - Exception in com.digi.xbee.api.exceptions
-
This exception will be thrown when trying to open an interface with an
invalid configuration.
- InvalidConfigurationException() - Constructor for exception com.digi.xbee.api.exceptions.InvalidConfigurationException
-
Creates an InvalidConfigurationException
with
as its error detail message.
- InvalidConfigurationException(String) - Constructor for exception com.digi.xbee.api.exceptions.InvalidConfigurationException
-
Creates an InvalidConfigurationException
with the specified
message.
- InvalidConfigurationException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.InvalidConfigurationException
-
Creates an InvalidConfigurationException
with the specified
message and cause.
- InvalidInterfaceException - Exception in com.digi.xbee.api.exceptions
-
This exception will be thrown when trying to open a non-existing interface.
- InvalidInterfaceException() - Constructor for exception com.digi.xbee.api.exceptions.InvalidInterfaceException
-
Creates an InvalidInterfaceException
with
as its error detail message.
- InvalidInterfaceException(String) - Constructor for exception com.digi.xbee.api.exceptions.InvalidInterfaceException
-
Creates an InvalidInterfaceException
with the specified message.
- InvalidInterfaceException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.InvalidInterfaceException
-
Creates an InvalidInterfaceException
with the specified
message and cause.
- InvalidOperatingModeException - Exception in com.digi.xbee.api.exceptions
-
- InvalidOperatingModeException() - Constructor for exception com.digi.xbee.api.exceptions.InvalidOperatingModeException
-
Creates an InvalidOperatingModeException
with
as its error detail message.
- InvalidOperatingModeException(OperatingMode) - Constructor for exception com.digi.xbee.api.exceptions.InvalidOperatingModeException
-
Creates an InvalidOperatingModeException
with the specified
operating mode.
- InvalidOperatingModeException(String) - Constructor for exception com.digi.xbee.api.exceptions.InvalidOperatingModeException
-
Creates an InvalidOperatingModeException
with the specified
message.
- InvalidOperatingModeException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.InvalidOperatingModeException
-
Creates an InvalidOperatingModeException
with the specified
message and cause.
- InvalidPacketException - Exception in com.digi.xbee.api.exceptions
-
This exception will be thrown when there is an error parsing an API packet
from the input stream.
- InvalidPacketException() - Constructor for exception com.digi.xbee.api.exceptions.InvalidPacketException
-
Creates a InvalidPacketException
with
as its error detail message.
- InvalidPacketException(String) - Constructor for exception com.digi.xbee.api.exceptions.InvalidPacketException
-
Creates a InvalidPacketException
with the specified message.
- InvalidPacketException(String, Throwable) - Constructor for exception com.digi.xbee.api.exceptions.InvalidPacketException
-
Creates an InvalidPacketException
with the specified
message and cause.
- IODataSampleRxIndicatorPacket - Class in com.digi.xbee.api.packet.common
-
This class represents an IO Data Sample RX Indicator packet.
- IODataSampleRxIndicatorPacket(XBee64BitAddress, XBee16BitAddress, int, byte[]) - Constructor for class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
-
Class constructor.
- IOLine - Enum in com.digi.xbee.api.io
-
Enumerates the different IO lines that can be found in the XBee devices.
- IOMode - Enum in com.digi.xbee.api.io
-
Enumerates the different Input/Output modes that an IO line can be
configured with.
- IOSample - Class in com.digi.xbee.api.io
-
This class represents an IO Data Sample.
- IOSample(byte[]) - Constructor for class com.digi.xbee.api.io.IOSample
-
Class constructor.
- ioSampleReceived(RemoteXBeeDevice, IOSample) - Method in interface com.digi.xbee.api.listeners.IIOSampleReceiveListener
-
Called when an IO sample is received through the connection interface.
- IOValue - Enum in com.digi.xbee.api.io
-
Enumerates the possible values of a IOLine
configured as digital
I/O.
- IPacketReceiveListener - Interface in com.digi.xbee.api.listeners
-
This interface defines the required methods that an object should implement
to behave as a packet listener and be notified when new packets are received
from a remote XBee device of the network.
- isApplyConfigurationChangesEnabled() - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns whether the 'apply configuration changes' option is enabled in
this device.
- isBitEnabled(int, int) - Static method in class com.digi.xbee.api.utils.ByteUtils
-
Returns whether the specified bit of the given integer is set to 1
or not.
- isBroadcast() - Method in class com.digi.xbee.api.models.XBeeMessage
-
Returns whether or not the message was received via broadcast.
- isBroadcast() - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.common.ModemStatusPacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.common.ReceivePacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.common.TransmitPacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.common.TransmitStatusPacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.GenericXBeePacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.raw.RX16Packet
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.raw.RX64Packet
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.raw.TX16Packet
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.raw.TX64Packet
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.raw.TXStatusPacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.UnknownXBeePacket
-
- isBroadcast() - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
-
Returns whether or not the packet is a broadcast packet.
- isCD() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Returns the state of the CD line.
- isCD() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
- isCTS() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Returns the state of the CTS line.
- isCTS() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
- isDiscoveryRunning() - Method in class com.digi.xbee.api.XBeeNetwork
-
Retrieves whether the discovery process is running or not.
- isDSR() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Returns the state of the DSR line.
- isDSR() - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
- isHardwareFlowControl() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Returns whether or not the port's flow control is configured in
hardware mode.
- isOpen() - Method in interface com.digi.xbee.api.connection.IConnectionInterface
-
Returns whether the connection interface is open or not.
- isOpen() - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
- isOpen() - Method in class com.digi.xbee.api.XBeeDevice
-
Returns whether the connection interface associated to this device is
already open.
- isRemote() - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Returns whether this XBee device is a remote device.
- isRemote() - Method in class com.digi.xbee.api.RemoteXBeeDevice
-
Always returns true
, since it is a remote device.
- isRemote() - Method in class com.digi.xbee.api.XBeeDevice
-
Always returns false
, since this is always a local device.
- isRunning() - Method in class com.digi.xbee.api.connection.DataReader
-
Returns whether this Data reader is running or not.
- isSpecialByte(int) - Static method in enum com.digi.xbee.api.models.SpecialByte
-
Checks whether the given byte is special or not.
- sendBreak(int) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Sends a break signal to the serial port with the given duration
(in milliseconds).
- sendBreak(int) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
- sendBroadcastData(byte[]) - Method in class com.digi.xbee.api.XBeeDevice
-
Sends the provided data to all the XBee nodes of the network (broadcast).
- sendData(XBee64BitAddress, byte[]) - Method in class com.digi.xbee.api.DigiMeshDevice
-
- sendData(XBee64BitAddress, byte[]) - Method in class com.digi.xbee.api.Raw802Device
-
- sendData(XBee16BitAddress, byte[]) - Method in class com.digi.xbee.api.Raw802Device
-
Sends the provided data to the XBee device of the network corresponding
to the given 16-bit address.
- sendData(RemoteXBeeDevice, byte[]) - Method in class com.digi.xbee.api.XBeeDevice
-
Sends the provided data to the given XBee device choosing the optimal
send method depending on the protocol of the local XBee device.
- sendData(XBee64BitAddress, XBee16BitAddress, byte[]) - Method in class com.digi.xbee.api.ZigBeeDevice
-
- sendDataAsync(XBee64BitAddress, byte[]) - Method in class com.digi.xbee.api.DigiMeshDevice
-
- sendDataAsync(XBee64BitAddress, XBee16BitAddress, byte[]) - Method in class com.digi.xbee.api.DigiPointDevice
-
- sendDataAsync(XBee64BitAddress, byte[]) - Method in class com.digi.xbee.api.Raw802Device
-
- sendDataAsync(XBee16BitAddress, byte[]) - Method in class com.digi.xbee.api.Raw802Device
-
Sends the provided data to the XBee device of the network corresponding
to the given 16-bit address asynchronously.
- sendDataAsync(RemoteXBeeDevice, byte[]) - Method in class com.digi.xbee.api.XBeeDevice
-
Sends the provided data to the provided XBee device asynchronously.
- sendDataAsync(XBee64BitAddress, XBee16BitAddress, byte[]) - Method in class com.digi.xbee.api.ZigBeeDevice
-
- sendPacket(XBeePacket, IPacketReceiveListener) - Method in class com.digi.xbee.api.XBeeDevice
-
Sends the given XBee packet and registers the given packet listener
(if not null
) to be notified when the answers is received.
- sendPacket(XBeePacket) - Method in class com.digi.xbee.api.XBeeDevice
-
Sends the given XBee packet synchronously and blocks until the response
is received or the configured receive timeout expires.
- sendPacketAsync(XBeePacket) - Method in class com.digi.xbee.api.XBeeDevice
-
Sends the given XBee packet asynchronously.
- SENT_FROM_END_DEVICE - Static variable in class com.digi.xbee.api.models.XBeeReceiveOptions
-
Packet was sent from an end device, if known (value: 64).
- serialEvent(SerialPortEvent) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
- SerialPortInfo - Class in com.digi.xbee.api.connection.serial
-
Helper class used to store serial port information.
- SerialPortInfo(String) - Constructor for class com.digi.xbee.api.connection.serial.SerialPortInfo
-
Class constructor.
- SerialPortInfo(String, String) - Constructor for class com.digi.xbee.api.connection.serial.SerialPortInfo
-
Class constructor.
- SerialPortParameters - Class in com.digi.xbee.api.connection.serial
-
Helper class used to store serial connection parameters information.
- SerialPortParameters(int, int, int, int, int) - Constructor for class com.digi.xbee.api.connection.serial.SerialPortParameters
-
Class constructor.
- SerialPortRxTx - Class in com.digi.xbee.api.connection.serial
-
This class represents a serial port using the RxTx library to communicate
with it.
- SerialPortRxTx(String, SerialPortParameters) - Constructor for class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
Class constructor.
- SerialPortRxTx(String, SerialPortParameters, int) - Constructor for class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
Class constructor.
- SerialPortRxTx(String, int) - Constructor for class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
Class constructor.
- SerialPortRxTx(String, int, int) - Constructor for class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
Class constructor.
- set16BitAddress(XBee16BitAddress) - Method in class com.digi.xbee.api.Raw802Device
-
- set16BitAddress(XBee16BitAddress) - Method in class com.digi.xbee.api.RemoteRaw802Device
-
- set64BitAddress(XBee64BitAddress) - Method in class com.digi.xbee.api.RemoteRaw802Device
-
Sets the XBee64BitAddress of this remote 802.15.4 device.
- setBreak(boolean) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Enables or disables the break line.
- setBreak(boolean) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
- setCommandValue(String) - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
-
Sets the AT command response value as String.
- setCommandValue(byte[]) - Method in class com.digi.xbee.api.packet.common.ATCommandResponsePacket
-
Sets the AT command response value.
- setCommandValue(String) - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
-
Sets the AT command response value as String.
- setCommandValue(byte[]) - Method in class com.digi.xbee.api.packet.common.RemoteATCommandResponsePacket
-
Sets the AT response response value.
- setDestinationAddress(XBee64BitAddress) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Sets the 64-bit destination extended address of this XBee device.
- setDIOChangeDetection(Set<IOLine>) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Sets the digital IO lines of this XBee device to be monitored and
sampled whenever their status changes.
- setDIOValue(IOLine, IOValue) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Sets the digital value (high or low) to the provided IO line of this
XBee device.
- setDiscoveryOptions(Set<DiscoveryOptions>) - Method in class com.digi.xbee.api.XBeeNetwork
-
Configures the discovery options (NO
parameter) with the given
value.
- setDiscoveryTimeout(long) - Method in class com.digi.xbee.api.XBeeNetwork
-
Configures the discovery timeout (NT
parameter) with the given
value.
- setDTR(boolean) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Sets the state of the DTR.
- setDTR(boolean) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
- setFrameID(int) - Method in class com.digi.xbee.api.packet.XBeeAPIPacket
-
Sets the frame ID of the API packet.
- setIOConfiguration(IOLine, IOMode) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Sets the configuration of the given IO line of this XBee device.
- setIOSamplingRate(int) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Sets the IO sampling rate to enable periodic sampling in this XBee
device.
- setNodeID(String) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Sets the node identifier of this XBee device.
- setPANID(byte[]) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Sets the PAN ID (Personal Area Network Identifier) of this XBee device.
- setParameter(String, byte[]) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Sets the given parameter with the provided value in this XBee device.
- setParameter(String) - Method in class com.digi.xbee.api.models.ATCommand
-
Sets the AT command parameter as string.
- setParameter(byte[]) - Method in class com.digi.xbee.api.models.ATCommand
-
Sets the AT command parameter as byte array.
- setParameter(String) - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
-
Sets the AT command parameter as String.
- setParameter(byte[]) - Method in class com.digi.xbee.api.packet.common.ATCommandPacket
-
Sets the AT command parameter.
- setParameter(String) - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
-
Sets the AT command parameter as String.
- setParameter(byte[]) - Method in class com.digi.xbee.api.packet.common.ATCommandQueuePacket
-
Sets the AT command parameter.
- setParameter(String) - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
-
Sets the AT command parameter as String.
- setParameter(byte[]) - Method in class com.digi.xbee.api.packet.common.RemoteATCommandPacket
-
Sets the AT command parameter.
- setPortDescription(String) - Method in class com.digi.xbee.api.connection.serial.SerialPortInfo
-
Sets the serial port description.
- setPortParameters(int, int, int, int, int) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Sets the new parameters of the serial port.
- setPortParameters(SerialPortParameters) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Sets the new parameters of the serial port as
SerialPortParameters
.
- setPortParameters(int, int, int, int, int) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
- setPowerLevel(PowerLevel) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Sets the output power level at which this XBee device transmits
conducted power.
- setPWMDutyCycle(IOLine, double) - Method in class com.digi.xbee.api.AbstractXBeeDevice
-
Sets the duty cycle (in %) of the provided IO line of this XBee device.
- setReadTimeout(int) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Sets the read timeout of the serial port (in milliseconds).
- setReadTimeout(int) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
- setReceiveTimeout(int) - Method in class com.digi.xbee.api.XBeeDevice
-
Configures this XBee device timeout in milliseconds for receiving
packets in synchronous operations.
- setRFData(byte[]) - Method in class com.digi.xbee.api.packet.common.IODataSampleRxIndicatorPacket
-
Sets the received RF data.
- setRFData(byte[]) - Method in class com.digi.xbee.api.packet.common.ReceivePacket
-
Sets the received RF data.
- setRFData(byte[]) - Method in class com.digi.xbee.api.packet.common.TransmitPacket
-
Sets the RF Data to send.
- setRFData(byte[]) - Method in class com.digi.xbee.api.packet.GenericXBeePacket
-
Sets the XBee RF Data.
- setRFData(byte[]) - Method in class com.digi.xbee.api.packet.raw.RX16IOPacket
-
Sets the received RF data.
- setRFData(byte[]) - Method in class com.digi.xbee.api.packet.raw.RX16Packet
-
Sets the received RF data.
- setRFData(byte[]) - Method in class com.digi.xbee.api.packet.raw.RX64IOPacket
-
Sets the received RF data.
- setRFData(byte[]) - Method in class com.digi.xbee.api.packet.raw.RX64Packet
-
Sets the received RF data.
- setRFData(byte[]) - Method in class com.digi.xbee.api.packet.raw.TX16Packet
-
Sets the RF data to send.
- setRFData(byte[]) - Method in class com.digi.xbee.api.packet.raw.TX64Packet
-
Sets the RF data to send.
- setRFData(byte[]) - Method in class com.digi.xbee.api.packet.UnknownXBeePacket
-
Sets the XBee RF Data.
- setRTS(boolean) - Method in class com.digi.xbee.api.connection.serial.AbstractSerialPort
-
Sets the state of the RTS line.
- setRTS(boolean) - Method in class com.digi.xbee.api.connection.serial.SerialPortRxTx
-
- setXBeeReaderMode(OperatingMode) - Method in class com.digi.xbee.api.connection.DataReader
-
Sets the XBee operating mode of this data reader.
- shortToByteArray(short) - Static method in class com.digi.xbee.api.utils.ByteUtils
-
Converts the given short value into a byte array.
- SpecialByte - Enum in com.digi.xbee.api.models
-
Enumerates all the special bytes of the XBee protocol that must be escaped
when working on API 2 mode.
- startDiscoveryProcess() - Method in class com.digi.xbee.api.XBeeNetwork
-
Starts the discovery process with the configured timeout and options.
- stopBits - Variable in class com.digi.xbee.api.connection.serial.SerialPortParameters
-
- stopDiscoveryProcess() - Method in class com.digi.xbee.api.XBeeNetwork
-
Stops the discovery process if it is running.
- stopReader() - Method in class com.digi.xbee.api.connection.DataReader
-
Stops the Data reader thread.
- stringToByteArray(String) - Static method in class com.digi.xbee.api.utils.ByteUtils
-
Converts the given string into a byte array.
- swapByteArray(byte[]) - Static method in class com.digi.xbee.api.utils.ByteUtils
-
Swaps the given byte array order.
- validate() - Method in class com.digi.xbee.api.packet.XBeeChecksum
-
Validates the checksum.
- valueOf(String) - Static method in enum com.digi.xbee.api.io.IOLine
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.io.IOMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.io.IOValue
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.models.AssociationIndicationStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.models.ATCommandStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.models.ATStringCommands
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.models.DiscoveryOptions
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.models.HardwareVersionEnum
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.models.ModemStatusEvent
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.models.OperatingMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.models.PowerLevel
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.models.SpecialByte
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.models.XBeeDiscoveryStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.models.XBeeProtocol
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.models.XBeeTransmitStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.digi.xbee.api.packet.APIFrameType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.digi.xbee.api.io.IOLine
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.io.IOMode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.io.IOValue
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.models.AssociationIndicationStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.models.ATCommandStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.models.ATStringCommands
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.models.DiscoveryOptions
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.models.HardwareVersionEnum
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.models.ModemStatusEvent
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.models.OperatingMode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.models.PowerLevel
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.models.SpecialByte
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.models.XBeeDiscoveryStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.models.XBeeProtocol
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.models.XBeeTransmitStatus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.digi.xbee.api.packet.APIFrameType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- Version - Class in com.digi.xbee.api
-
Class used to retrieve the current version of the XBee Java Library.
- Version() - Constructor for class com.digi.xbee.api.Version
-