| Package | Description |
|---|---|
| com.digi.xbee.api |
| Modifier and Type | Method and Description |
|---|---|
void |
AbstractXBeeDevice.applyChanges()
Applies changes to all command registers causing queued command register
values to be applied.
|
boolean |
WiFiDevice.connect(AccessPoint accessPoint,
String password)
Connects to the provided access point.
|
boolean |
WiFiDevice.connect(String ssid,
String password)
Connects to the access point with provided SSID.
|
void |
AbstractXBeeDevice.disableBluetooth()
Disables the Bluetooth interface of this XBee device.
|
boolean |
WiFiDevice.disconnect()
Disconnects from the access point the device is connected to.
|
void |
AbstractXBeeDevice.enableBluetooth()
Enables the Bluetooth interface of this XBee device.
|
void |
AbstractXBeeDevice.executeParameter(String parameter)
Executes the given command in this XBee device.
|
void |
ZigBeeDevice.forceDisassociate() |
void |
RemoteZigBeeDevice.forceDisassociate() |
void |
RemoteThreadDevice.forceDisassociate() |
int |
AbstractXBeeDevice.getADCValue(IOLine ioLine)
Returns the analog value of the provided IO line of this XBee device.
|
APIOutputMode |
ZigBeeDevice.getAPIOutputMode() |
APIOutputMode |
DigiPointDevice.getAPIOutputMode() |
APIOutputMode |
DigiMeshDevice.getAPIOutputMode() |
AssociationIndicationStatus |
ZigBeeDevice.getAssociationIndicationStatus() |
AssociationIndicationStatus |
RemoteZigBeeDevice.getAssociationIndicationStatus() |
AssociationIndicationStatus |
RemoteRaw802Device.getAssociationIndicationStatus() |
AssociationIndicationStatus |
Raw802Device.getAssociationIndicationStatus() |
String |
AbstractXBeeDevice.getBluetoothMacAddress()
Reads and returns the EUI-48 Bluetooth MAC address of this XBee device
in a format such as
00112233AABB. |
CellularAssociationIndicationStatus |
CellularDevice.getCellularAssociationIndicationStatus()
Returns the current association status of this Cellular device.
|
XBee64BitAddress |
RemoteThreadDevice.getDestinationAddress()
Deprecated.
Operation not supported in this protocol. Use
AbstractXBeeDevice.getIPv6DestinationAddress() instead.
This method will raise an
UnsupportedOperationException. |
XBee64BitAddress |
IPv6Device.getDestinationAddress()
Deprecated.
Operation not supported in this protocol. Use
AbstractXBeeDevice.getIPv6DestinationAddress() instead.
This method will raise an
UnsupportedOperationException. |
XBee64BitAddress |
IPDevice.getDestinationAddress()
Deprecated.
Operation not supported in this protocol. Use
IPDevice.getDestinationIPAddress() instead.
This method will raise an
UnsupportedOperationException. |
XBee64BitAddress |
AbstractXBeeDevice.getDestinationAddress()
Returns the 64-bit destination extended address of this XBee device.
|
Inet4Address |
IPDevice.getDestinationIPAddress()
Returns the destination IP address.
|
Set<IOLine> |
CellularDevice.getDIOChangeDetection()
Deprecated.
Operation not supported in Cellular protocol. This method
will raise an
UnsupportedOperationException. |
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.
|
Inet4Address |
WiFiDevice.getDNSAddress()
Returns the IP address of domain name server.
|
Inet4Address |
WiFiDevice.getGatewayIPAddress()
Returns the IP address of the gateway.
|
IOMode |
AbstractXBeeDevice.getIOConfiguration(IOLine ioLine)
Returns the configuration mode of the provided IO line of this XBee
device.
|
int |
CellularDevice.getIOSamplingRate()
Deprecated.
Operation not supported in Cellular protocol. This method
will raise an
UnsupportedOperationException. |
int |
AbstractXBeeDevice.getIOSamplingRate()
Returns the IO sampling rate of this XBee device.
|
IPAddressingMode |
WiFiDevice.getIPAddressingMode()
Returns the IP addressing mode.
|
Inet4Address |
WiFiDevice.getIPAddressMask()
Returns the IP address subnet mask.
|
Inet6Address |
ZigBeeDevice.getIPv6DestinationAddress()
Deprecated.
Operation not supported in ZigBee protocol. This method
will raise an
UnsupportedOperationException. |
Inet6Address |
RemoteZigBeeDevice.getIPv6DestinationAddress()
Deprecated.
Operation not supported in ZigBee protocol. This method
will raise an
UnsupportedOperationException. |
Inet6Address |
RemoteRaw802Device.getIPv6DestinationAddress()
Deprecated.
Operation not supported in 802.15.4 protocol. This method
will raise an
UnsupportedOperationException. |
Inet6Address |
RemoteDigiPointDevice.getIPv6DestinationAddress()
Deprecated.
Operation not supported in DigiPoint protocol. This method
will raise an
UnsupportedOperationException. |
Inet6Address |
RemoteDigiMeshDevice.getIPv6DestinationAddress()
Deprecated.
Operation not supported in DigiMesh protocol. This method
will raise an
UnsupportedOperationException. |
Inet6Address |
Raw802Device.getIPv6DestinationAddress()
Deprecated.
Operation not supported in 802.15.4 protocol. This method
will raise an
UnsupportedOperationException. |
Inet6Address |
IPDevice.getIPv6DestinationAddress()
Deprecated.
Operation not supported in this protocol. This method
will raise an
UnsupportedOperationException. |
Inet6Address |
DigiPointDevice.getIPv6DestinationAddress()
Deprecated.
Operation not supported in DigiPoint protocol. This method
will raise an
UnsupportedOperationException. |
Inet6Address |
DigiMeshDevice.getIPv6DestinationAddress()
Deprecated.
Operation not supported in DigiMesh protocol. This method
will raise an
UnsupportedOperationException. |
Inet6Address |
AbstractXBeeDevice.getIPv6DestinationAddress()
Returns the destination IPv6 address.
|
byte[] |
IPDevice.getPANID()
Deprecated.
Operation not supported in this protocol. This method will
raise an
UnsupportedOperationException. |
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 |
CellularDevice.getPowerLevel()
Deprecated.
Operation not supported in Cellular protocol. This method
will raise an
UnsupportedOperationException. |
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.
|
ThreadAssociationIndicationStatus |
ThreadDevice.getThreadAssociationIndicationStatus()
Returns the current association status of this Thread device.
|
ThreadAssociationIndicationStatus |
RemoteThreadDevice.getThreadAssociationIndicationStatus()
Returns the current association status of this Thread device.
|
WiFiAssociationIndicationStatus |
WiFiDevice.getWiFiAssociationIndicationStatus()
Returns the current association status of this Wi-Fi device.
|
boolean |
WiFiDevice.isConnected()
Returns whether the device is connected to an access point or not.
|
boolean |
ThreadDevice.isConnected()
Returns whether the device is associated to a network or not.
|
boolean |
CellularDevice.isConnected()
Returns whether the device is connected to the Internet or not.
|
void |
IPv6Device.readDeviceInfo() |
void |
IPDevice.readDeviceInfo() |
void |
CellularDevice.readDeviceInfo() |
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) |
void |
IPv6Device.sendBroadcastData(byte[] data)
Deprecated.
Operation not supported in this protocol. This method will
raise an
UnsupportedOperationException. |
void |
IPDevice.sendBroadcastData(byte[] data)
Deprecated.
Operation not supported in this protocol. This method will
raise an
UnsupportedOperationException. |
void |
ZigBeeDevice.sendBroadcastExplicitData(int sourceEndpoint,
int destEndpoint,
int clusterID,
int profileID,
byte[] data) |
void |
DigiPointDevice.sendBroadcastExplicitData(int sourceEndpoint,
int destEndpoint,
int clusterID,
int profileID,
byte[] data) |
void |
DigiMeshDevice.sendBroadcastExplicitData(int sourceEndpoint,
int destEndpoint,
int clusterID,
int profileID,
byte[] data) |
void |
IPDevice.sendBroadcastIPData(int destPort,
byte[] data)
Sends the provided IP data to all clients.
|
byte[] |
ThreadDevice.sendCoAPData(Inet6Address ipv6Address,
String uri,
HTTPMethodEnum method,
boolean applyChanges,
byte[] data)
Sends the provided CoAP IPv6 data to the given IPv6 address and port using
the specified IPv6 protocol.
|
byte[] |
ThreadDevice.sendCoAPData(Inet6Address ipv6Address,
String uri,
HTTPMethodEnum method,
byte[] data)
Sends the provided CoAP IPv6 data to the given IPv6 address and port using
the specified IPv6 protocol.
|
void |
ThreadDevice.sendCoAPDataAsync(Inet6Address ipv6Address,
String uri,
HTTPMethodEnum method,
boolean applyChanges,
byte[] data)
Sends the provided CoAP IPv6 data to the given IPv6 address and port
asynchronously using the specified IPv6 protocol.
|
void |
ThreadDevice.sendCoAPDataAsync(Inet6Address ipv6Address,
String uri,
HTTPMethodEnum method,
byte[] data)
Sends the provided CoAP IPv6 data to the given IPv6 address and port
asynchronously using the specified IPv6 protocol.
|
void |
XBeeDevice.sendData(RemoteXBeeDevice remoteXBeeDevice,
byte[] data) |
void |
IPv6Device.sendData(RemoteXBeeDevice remoteXBeeDevice,
byte[] data)
Deprecated.
Operation not supported in this protocol. This method will
raise an
UnsupportedOperationException. |
void |
IPDevice.sendData(RemoteXBeeDevice remoteXBeeDevice,
byte[] data)
Deprecated.
Operation not supported in this protocol. This method will
raise an
UnsupportedOperationException. |
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 |
DigiPointDevice.sendData(XBee64BitAddress address64Bit,
XBee16BitAddress address16bit,
byte[] data) |
void |
ZigBeeDevice.sendExplicitData(RemoteXBeeDevice remoteXBeeDevice,
int sourceEndpoint,
int destEndpoint,
int clusterID,
int profileID,
byte[] data) |
void |
DigiPointDevice.sendExplicitData(RemoteXBeeDevice remoteXBeeDevice,
int sourceEndpoint,
int destEndpoint,
int clusterID,
int profileID,
byte[] data) |
void |
DigiMeshDevice.sendExplicitData(RemoteXBeeDevice remoteXBeeDevice,
int sourceEndpoint,
int destEndpoint,
int clusterID,
int profileID,
byte[] data) |
void |
DigiMeshDevice.sendExplicitData(XBee64BitAddress address,
int sourceEndpoint,
int destEndpoint,
int clusterID,
int profileID,
byte[] data) |
void |
ZigBeeDevice.sendExplicitData(XBee64BitAddress address64Bit,
XBee16BitAddress address16bit,
int sourceEndpoint,
int destEndpoint,
int clusterID,
int profileID,
byte[] data) |
void |
DigiPointDevice.sendExplicitData(XBee64BitAddress address64Bit,
XBee16BitAddress address16bit,
int sourceEndpoint,
int destEndpoint,
int clusterID,
int profileID,
byte[] data) |
void |
LPWANDevice.sendIPData(Inet4Address ipAddress,
int destPort,
IPProtocol protocol,
boolean closeSocket,
byte[] data)
Deprecated.
Use
LPWANDevice.sendIPData(Inet4Address, int, IPProtocol, byte[])
instead. |
void |
IPDevice.sendIPData(Inet4Address ipAddress,
int destPort,
IPProtocol protocol,
boolean closeSocket,
byte[] data)
Sends the provided IP data to the given IP address and port using
the specified IP protocol.
|
void |
LPWANDevice.sendIPData(Inet4Address ipAddress,
int destPort,
IPProtocol protocol,
byte[] data)
Deprecated.
Sends the provided IP data to the given IP address and port using
the specified IP protocol (must be UDP).
|
void |
IPDevice.sendIPData(Inet4Address ipAddress,
int destPort,
IPProtocol protocol,
byte[] data)
Sends the provided IP data to the given IP address and port using
the specified IP protocol.
|
void |
ThreadDevice.sendIPData(Inet6Address ipv6Address,
int destPort,
IPProtocol protocol,
byte[] data) |
void |
IPv6Device.sendIPData(Inet6Address ipv6Address,
int destPort,
IPProtocol protocol,
byte[] data)
Sends the provided IPv6 data to the given IPv6 address and port using
the specified IPv6 protocol.
|
void |
LPWANDevice.sendIPDataAsync(Inet4Address ipAddress,
int destPort,
IPProtocol protocol,
byte[] data)
Deprecated.
Sends the provided IP data to the given IP address and port
asynchronously using the specified protocol (must be UDP).
|
void |
IPDevice.sendIPDataAsync(Inet4Address ipAddress,
int destPort,
IPProtocol protocol,
byte[] data)
Sends the provided IP data to the given IP address and port
asynchronously.
|
XBeePacket |
XBeeDevice.sendPacket(XBeePacket packet) |
void |
LPWANDevice.sendSMS(String phoneNumber,
String data)
Deprecated.
Operation not supported in this protocol. This method will
raise an
UnsupportedOperationException. |
void |
CellularDevice.sendSMS(String phoneNumber,
String data)
Sends the provided SMS message to the given phone number.
|
void |
LPWANDevice.sendSMSAsync(String phoneNumber,
String data)
Deprecated.
Operation not supported in this protocol. This method will
raise an
UnsupportedOperationException. |
void |
CellularDevice.sendSMSAsync(String phoneNumber,
String data)
Sends asynchronously the provided SMS to the given phone number.
|
void |
RemoteRaw802Device.set16BitAddress(XBee16BitAddress xbee16BitAddress) |
void |
Raw802Device.set16BitAddress(XBee16BitAddress xbee16BitAddress) |
void |
ZigBeeDevice.setAPIOutputMode(APIOutputMode apiOutputMode) |
void |
DigiPointDevice.setAPIOutputMode(APIOutputMode apiOutputMode) |
void |
DigiMeshDevice.setAPIOutputMode(APIOutputMode apiOutputMode) |
void |
RemoteThreadDevice.setDestinationAddress(XBee64BitAddress xbee64BitAddress)
Deprecated.
Operation not supported in this protocol. Use
AbstractXBeeDevice.setIPv6DestinationAddress(Inet6Address) instead.
This method will raise an
UnsupportedOperationException. |
void |
IPv6Device.setDestinationAddress(XBee64BitAddress xbee64BitAddress)
Deprecated.
Operation not supported in this protocol. Use
AbstractXBeeDevice.setIPv6DestinationAddress(Inet6Address) instead.
This method will raise an
UnsupportedOperationException. |
void |
IPDevice.setDestinationAddress(XBee64BitAddress xbee64BitAddress)
Deprecated.
Operation not supported in this protocol. Use
IPDevice.setDestinationIPAddress(Inet4Address) instead.
This method will raise an
UnsupportedOperationException. |
void |
AbstractXBeeDevice.setDestinationAddress(XBee64BitAddress xbee64BitAddress)
Sets the 64-bit destination extended address of this XBee device.
|
void |
IPDevice.setDestinationIPAddress(Inet4Address address)
Sets the destination IP address.
|
void |
CellularDevice.setDIOChangeDetection(Set<IOLine> lines)
Deprecated.
Operation not supported in Cellular protocol. This method
will raise an
UnsupportedOperationException. |
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 |
WiFiDevice.setDNSAddress(Inet4Address address)
Sets the IP address of domain name server.
|
void |
WiFiDevice.setGatewayIPAddress(Inet4Address address)
Sets the IP address of the gateway.
|
void |
AbstractXBeeDevice.setIOConfiguration(IOLine ioLine,
IOMode ioMode)
Sets the configuration of the given IO line of this XBee device.
|
void |
CellularDevice.setIOSamplingRate(int rate)
Deprecated.
Operation not supported in Cellular protocol. This method
will raise an
UnsupportedOperationException. |
void |
AbstractXBeeDevice.setIOSamplingRate(int rate)
Sets the IO sampling rate to enable periodic sampling in this XBee
device.
|
void |
WiFiDevice.setIPAddress(Inet4Address address)
Sets the IP address of the module.
|
void |
WiFiDevice.setIPAddressingMode(IPAddressingMode mode)
Sets the IP addressing mode.
|
void |
WiFiDevice.setIPAddressMask(Inet4Address address)
Sets the IP address subnet mask.
|
void |
ZigBeeDevice.setIPv6DestinationAddress(Inet6Address ipv6Address)
Deprecated.
Operation not supported in ZigBee protocol. This method
will raise an
UnsupportedOperationException. |
void |
RemoteZigBeeDevice.setIPv6DestinationAddress(Inet6Address ipv6Address)
Deprecated.
Operation not supported in ZigBee protocol. This method
will raise an
UnsupportedOperationException. |
void |
RemoteRaw802Device.setIPv6DestinationAddress(Inet6Address ipv6Address)
Deprecated.
Operation not supported in 802.15.4 protocol. This method
will raise an
UnsupportedOperationException. |
void |
RemoteDigiPointDevice.setIPv6DestinationAddress(Inet6Address ipv6Address)
Deprecated.
Operation not supported in DigiPoint protocol. This method
will raise an
UnsupportedOperationException. |
void |
RemoteDigiMeshDevice.setIPv6DestinationAddress(Inet6Address ipv6Address)
Deprecated.
Operation not supported in DigiMesh protocol. This method
will raise an
UnsupportedOperationException. |
void |
Raw802Device.setIPv6DestinationAddress(Inet6Address ipv6Address)
Deprecated.
Operation not supported in 802.15.4 protocol. This method
will raise an
UnsupportedOperationException. |
void |
IPDevice.setIPv6DestinationAddress(Inet6Address ipv6Address)
Deprecated.
Operation not supported in this protocol. This method
will raise an
UnsupportedOperationException. |
void |
DigiPointDevice.setIPv6DestinationAddress(Inet6Address ipv6Address)
Deprecated.
Operation not supported in DigiPoint protocol. This method
will raise an
UnsupportedOperationException. |
void |
DigiMeshDevice.setIPv6DestinationAddress(Inet6Address ipv6Address)
Deprecated.
Operation not supported in DigiMesh protocol. This method
will raise an
UnsupportedOperationException. |
void |
AbstractXBeeDevice.setIPv6DestinationAddress(Inet6Address ipv6Address)
Sets the destination IPv6 address.
|
void |
CellularDevice.setNodeID(String nodeID)
Deprecated.
Operation not supported in Cellular protocol. This method
will raise an
UnsupportedOperationException. |
void |
AbstractXBeeDevice.setNodeID(String nodeID)
Sets the node identifier of this XBee device.
|
void |
IPDevice.setPANID(byte[] panID)
Deprecated.
Operation not supported in this protocol. This method will
raise an
UnsupportedOperationException. |
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 |
CellularDevice.setPowerLevel(PowerLevel powerLevel)
Deprecated.
Operation not supported in Cellular protocol. This method
will raise an
UnsupportedOperationException. |
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 |
IPv6Device.startListening(int sourcePort)
Starts listening for incoming IPv6 transmissions in the provided port.
|
void |
IPDevice.startListening(int sourcePort)
Starts listening for incoming IP transmissions in the provided port.
|
void |
IPv6Device.stopListening()
Stops listening for incoming IPv6 transmissions.
|
void |
IPDevice.stopListening()
Stops listening for incoming IP transmissions.
|
void |
AbstractXBeeDevice.updateBluetoothPassword(String newPassword)
Changes the password of this Bluetooth device with the new one provided.
|
void |
AbstractXBeeDevice.writeChanges()
Writes configurable parameter values to the non-volatile memory of this
XBee device so that parameter modifications persist through subsequent
resets.
|
© Copyright 2014 - 2024 Digi International Inc. All rights reserved.