info xbee

Purpose

For Digi devices that have an XBee RF module, displays data counters that are specific to XBee sockets implemented using a Python application. Statistics displayed may aid in troubleshooting network communication problems with an XBee network.

Statistics that display are gathered since the statistic tables were last cleared by rebooting the Digi device, and include data, event, and error counts. These statistics are useful in understanding how the device is operating and can be helpful in finding problems. In particular, if an error counter is found to be increasing there may be a problem with the device.

To reset the statistics, reboot the device.

Required permissions

For Digi products with two or more users, set permissions to set permissions display=execute to use this command. See set permissions for details on setting user permissions for commands.

Syntax

info xbee

Example

#> info xbee
XBee sockets statistics:

Frames Sent                    : 0
Frames Received                : 0
Bytes Sent                     : 0
Bytes Received                 : 0

XBee sockets errors:

Transmit Frame Errors          : 0
Receive Frame Errors           : 0
Transmit Bytes Dropped         : 0
Receive Bytes Dropped by User  : 0
Receive Bytes Dropped by Stack : 0

XBee network statistics:

Frames received                : 41980
Bytes received                 : 157077
Frames transmitted             : 2
Bytes transmitted              : 0
Remote commands                : 2
Address discoveries            : 0
Route discoveries              : 0
Transmission retries           : 0

XBee network errors:

Removed from queue             : 0
Unable to transmit             : 0
Address not found              : 0
Route not found                : 0
Not acknowledged               : 0
No response or status          : 0

Output

Statistic/Error	Description
XBee sockets statistics	This section includes data counters that are specific to XBee sockets implemented using a Python application.
Frames Sent	The number of frames sent from local XBee device sockets.
Frames Received	The number of frames received by local XBee device sockets.
Bytes Sent	The total number of bytes sent from local XBee device sockets.
Bytes Received	The total number of bytes received from local XBee device sockets.
XBee sockets errors	This section includes error counters that are specific to XBee sockets implemented using a Python application. These values will help determine the quality of data that is being sent or received.
Transmit Frame Errors	The total number of frames that were not given to the XBee driver from the XBee device socket because of an internal error.
Receive Frame Errors	The total number of frames which were unable to be received by the XBee device socket because of an internal error.
Transmit Bytes Dropped	The total number of bytes dropped by XBee device sockets because of an internal error on transmission.
Receive Bytes Dropped by User	The total number of bytes dropped by the user because of an insufficiently sized receive buffer.
Receive Bytes Dropped by Stack	The total number of bytes dropped internally by XBee sockets because of insufficient internal buffers.
XBee network statistics	This section includes data counters for all activity on the XBee network.
Frames received	The total number of frames received.
Bytes received	The total number of bytes received.
Frames transmitted	The total number of frames transmitted.
Bytes transmitted	The total number of bytes transmitted.
Remote commands	The number of frames that were commands to remote nodes.
Address discoveries	The number of frames that required the discovery of the network address of a remote node.
Route discoveries	The number of frames that required the discovery of the route to a remote node.
Transmission retries	The number of frames that were retransmitted because of they were not acknowledged by the remote node.
XBee network errors	This section includes error counts for all activity on the XBee network. These values help determine the quality of data that is being sent or received.
Removed from queue	The number of frames that could not be transmitted due to a time limit set by an application.
Unable to transmit	The number of frames that could not be transmitted due to a transmission error. This includes duty cycle limits and CCA and PHY errors.
Address not found	The number of transmitted frames for which the network address of a remote node could not be found.
Route not found	The number of transmitted frames for which the route to a remote node could not be found.
Not acknowledged	The number of transmitted frames that were not acknowledged by the remote node.
No response or status	The number of transmitted frames for which no indication of success or failure was received from the local radio.