Package | Description |
---|---|
com.digi.xbee.api | |
com.digi.xbee.api.exceptions |
Modifier and Type | Method and Description |
---|---|
void |
AbstractXBeeDevice.applyChanges()
Applies changes to all command registers causing queued command register
values to be applied.
|
RemoteXBeeDevice |
XBeeNetwork.discoverDevice(String id)
Discovers and reports the first remote XBee device that matches the
supplied identifier.
|
List<RemoteXBeeDevice> |
XBeeNetwork.discoverDevices(List<String> ids)
Discovers and reports all remote XBee devices that match the supplied
identifiers.
|
void |
AbstractXBeeDevice.executeParameter(String parameter)
Executes the given command in this XBee device.
|
void |
ZigBeeDevice.forceDisassociate() |
void |
RemoteZigBeeDevice.forceDisassociate() |
int |
AbstractXBeeDevice.getADCValue(IOLine ioLine)
Returns the analog value of the provided IO line of this XBee device.
|
AssociationIndicationStatus |
ZigBeeDevice.getAssociationIndicationStatus() |
AssociationIndicationStatus |
RemoteZigBeeDevice.getAssociationIndicationStatus() |
AssociationIndicationStatus |
RemoteRaw802Device.getAssociationIndicationStatus() |
AssociationIndicationStatus |
Raw802Device.getAssociationIndicationStatus() |
XBee64BitAddress |
AbstractXBeeDevice.getDestinationAddress()
Returns the 64-bit destination extended address of this XBee device.
|
Set<IOLine> |
AbstractXBeeDevice.getDIOChangeDetection()
Returns the set of IO lines of this device that are monitored for
change detection.
|
IOValue |
AbstractXBeeDevice.getDIOValue(IOLine ioLine)
Returns the digital value of the provided IO line of this XBee device.
|
IOMode |
AbstractXBeeDevice.getIOConfiguration(IOLine ioLine)
Returns the configuration mode of the provided IO line of this XBee
device.
|
int |
AbstractXBeeDevice.getIOSamplingRate()
Returns the IO sampling rate of this XBee device.
|
byte[] |
AbstractXBeeDevice.getPANID()
Returns the operating PAN ID (Personal Area Network Identifier) of
this XBee device.
|
byte[] |
AbstractXBeeDevice.getParameter(String parameter)
Gets the value of the given parameter from this XBee device.
|
PowerLevel |
AbstractXBeeDevice.getPowerLevel()
Returns the output power level at which this XBee device transmits
conducted power.
|
double |
AbstractXBeeDevice.getPWMDutyCycle(IOLine ioLine)
Gets the PWM duty cycle (in %) corresponding to the provided IO line of
this XBee device.
|
void |
ZigBeeDevice.open() |
void |
XBeeDevice.open()
Opens the connection interface associated with this XBee device.
|
void |
Raw802Device.open() |
void |
DigiPointDevice.open() |
void |
DigiMeshDevice.open() |
void |
AbstractXBeeDevice.readDeviceInfo()
Reads some parameters from this device and obtains its protocol.
|
IOSample |
AbstractXBeeDevice.readIOSample()
Returns an IO sample from this XBee device containing the value of all
enabled digital IO and analog input channels.
|
void |
XBeeDevice.reset() |
void |
RemoteXBeeDevice.reset() |
abstract void |
AbstractXBeeDevice.reset()
Performs a software reset on this XBee device and blocks until the
process is completed.
|
void |
XBeeDevice.sendBroadcastData(byte[] data)
Sends the provided data to all the XBee nodes of the network (broadcast).
|
void |
XBeeDevice.sendData(RemoteXBeeDevice xbeeDevice,
byte[] data)
Sends the provided data to the given XBee device choosing the optimal
send method depending on the protocol of the local XBee device.
|
void |
Raw802Device.sendData(XBee16BitAddress address,
byte[] data)
Sends the provided data to the XBee device of the network corresponding
to the given 16-bit address.
|
void |
Raw802Device.sendData(XBee64BitAddress address,
byte[] data) |
void |
DigiMeshDevice.sendData(XBee64BitAddress address,
byte[] data) |
void |
ZigBeeDevice.sendData(XBee64BitAddress address64Bit,
XBee16BitAddress address16bit,
byte[] data) |
void |
XBeeDevice.sendDataAsync(RemoteXBeeDevice xbeeDevice,
byte[] data)
Sends the provided data to the provided XBee device asynchronously.
|
void |
Raw802Device.sendDataAsync(XBee16BitAddress address,
byte[] data)
Sends the provided data to the XBee device of the network corresponding
to the given 16-bit address asynchronously.
|
void |
Raw802Device.sendDataAsync(XBee64BitAddress address,
byte[] data) |
void |
DigiMeshDevice.sendDataAsync(XBee64BitAddress address,
byte[] data) |
void |
ZigBeeDevice.sendDataAsync(XBee64BitAddress address64Bit,
XBee16BitAddress address16bit,
byte[] data) |
void |
DigiPointDevice.sendDataAsync(XBee64BitAddress address64Bit,
XBee16BitAddress address16bit,
byte[] data) |
XBeePacket |
XBeeDevice.sendPacket(XBeePacket packet)
Sends the given XBee packet synchronously and blocks until the response
is received or the configured receive timeout expires.
|
void |
XBeeDevice.sendPacket(XBeePacket packet,
IPacketReceiveListener packetReceiveListener)
Sends the given XBee packet and registers the given packet listener
(if not
null ) to be notified when the answers is received. |
void |
XBeeDevice.sendPacketAsync(XBeePacket packet)
Sends the given XBee packet asynchronously.
|
void |
RemoteRaw802Device.set16BitAddress(XBee16BitAddress xbee16BitAddress) |
void |
Raw802Device.set16BitAddress(XBee16BitAddress xbee16BitAddress) |
void |
AbstractXBeeDevice.setDestinationAddress(XBee64BitAddress xbee64BitAddress)
Sets the 64-bit destination extended address of this XBee device.
|
void |
AbstractXBeeDevice.setDIOChangeDetection(Set<IOLine> lines)
Sets the digital IO lines of this XBee device to be monitored and
sampled whenever their status changes.
|
void |
AbstractXBeeDevice.setDIOValue(IOLine ioLine,
IOValue ioValue)
Sets the digital value (high or low) to the provided IO line of this
XBee device.
|
void |
XBeeNetwork.setDiscoveryOptions(Set<DiscoveryOptions> options)
Configures the discovery options (
NO parameter) with the given
value. |
void |
XBeeNetwork.setDiscoveryTimeout(long timeout)
Configures the discovery timeout (
NT parameter) with the given
value. |
void |
AbstractXBeeDevice.setIOConfiguration(IOLine ioLine,
IOMode ioMode)
Sets the configuration of the given IO line of this XBee device.
|
void |
AbstractXBeeDevice.setIOSamplingRate(int rate)
Sets the IO sampling rate to enable periodic sampling in this XBee
device.
|
void |
AbstractXBeeDevice.setNodeID(String nodeID)
Sets the node identifier of this XBee device.
|
void |
AbstractXBeeDevice.setPANID(byte[] panID)
Sets the PAN ID (Personal Area Network Identifier) of this XBee device.
|
void |
AbstractXBeeDevice.setParameter(String parameter,
byte[] parameterValue)
Sets the given parameter with the provided value in this XBee device.
|
void |
AbstractXBeeDevice.setPowerLevel(PowerLevel powerLevel)
Sets the output power level at which this XBee device transmits
conducted power.
|
void |
AbstractXBeeDevice.setPWMDutyCycle(IOLine ioLine,
double dutyCycle)
Sets the duty cycle (in %) of the provided IO line of this XBee device.
|
void |
AbstractXBeeDevice.writeChanges()
Writes configurable parameter values to the non-volatile memory of this
XBee device so that parameter modifications persist through subsequent
resets.
|
Modifier and Type | Class and Description |
---|---|
class |
ATCommandException
This exception will be thrown when receiving a command response containing
a status different than
ATCommandStatus#OK after sending an XBee
AT command. |
class |
CommunicationException
This exception will be thrown when any problem related to the communication
with the XBee device occurs.
|
class |
ConnectionException
This exception will be thrown when any problem related to the connection
with the XBee device occurs.
|
class |
InterfaceInUseException
This exception will be thrown when trying to open the port/communication
interface but it is already in use by other applications.
|
class |
InvalidConfigurationException
This exception will be thrown when trying to open an interface with an
invalid configuration.
|
class |
InvalidInterfaceException
This exception will be thrown when trying to open a non-existing interface.
|
class |
InvalidOperatingModeException
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 . |
class |
InvalidPacketException
This exception will be thrown when there is an error parsing an API packet
from the input stream.
|
class |
OperationNotSupportedException
This exception will be thrown when the operation performed is not supported
by the XBee device.
|
class |
PermissionDeniedException
This exception will be thrown when the user does not have the appropriate
access to the connection interface.
|
class |
TimeoutException
This exception will be thrown when performing synchronous operations and the
configured time expires.
|
class |
TransmitException
This exception will be thrown when receiving a transmit status different than
XBeeTransmitStatus#SUCCESS after sending an XBee API packet. |
class |
XBeeDeviceException
This exception will be thrown when any problem related to the XBee device
occurs.
|
© Copyright 2014–2014 Digi International Inc. All rights reserved.