Troubleshooting

You can remove the XBee Grove Development Board from the USB port and see which port name disappears from your port list. The name that disappears is your XBee board.

You may be able to figure out which port is right via trial and error, but you can also use XCTU to find it:

Open XCTU and discover the radio modules attached to your computer by clicking on the top-left corner.
Select all ports to be scanned.
Click Next and then Finish.

Once the discovery process has finished, a new window notifies you of the discovered devices and their details. The serial port and the baud rate are shown in the Port label.

Can't identify XBee modules

Once you have added the modules to XCTU, a simple way to identify them is to read the radio settings of each one and check the Rx and Tx LEDs of the XBee Grove Development Boards. These LEDs indicate that the XBee module is receiving (Rx) or transmitting (Tx) information through the serial port.

When you read or write the settings of a module, its Rx and Tx LEDs blink, so you can identify which module is connected to each serial port.

Error: Port is already in use

The serial port where the local XBee module is connected can only be in use by one application. Check that the connection with the module in the XCTU console is closed and there are no other applications using the port.

Error: Device driver was not successfully installed

Sometimes when you connect the XBee Grove Development Board into you computer, the operating system cannot install the driver automatically. If you get that error, try to remove and re-insert the board into your computer. If the OS is still unable to install the driver, remove and re-insert the board into another USB port.

As a last resort, see Manually install USB drivers.

Error upon installation of XCTU

XCTU requires Administrator permissions. Check that you have Administrator access on the machine where you are installing XCTU. You may need to request permission to install or run applications as administrator from your network manager.

On Windows systems, a User Account Control dialog may appear when you install XCTU or try to run the XCTU program. You must answer yes when prompted to allow the program to make changes to your computer, or XCTU will not work correctly.

Discovery process either does not find devices, or XCTU does not list serial ports

There are several troubleshooting methods to try under these circumstances:

Check cables: Double check all cables. The USB cable should be firmly and fully attached to both the computer and the XBee Grove Development Board. When attached correctly, the association LED on the adapter will be lit.
Check that the XBee is fully seated in the XBee Grove Development Board: When the XBee is correctly installed, it should be pushed fully into the board and no air or metal should be visible between the plastic of the adapter socket and the XBee headers. Also, double check that all ten pins on each side of the XBee made it into a matching hole in the socket.
Check the XBee orientation: The angled "nose" of the XBee should match the lines on the silk screening of the board and point away from the USB socket on the XBee Grove Development Board.
Check driver installation: Drivers are installed the first time the XBee Grove Development Board is plugged in. If this process is not complete or has failed, try the following steps:
- Remove and re-insert the board into your computer. This may cause driver installation to re-occur.
- Remove and re-insert the board into another USB port.
- (Windows) Open Computer management, find the failing device in the Device Manager section and remove it.
- You can download drivers for all major operating systems from FTDI for manual installation.
Check whether the modules are sleeping: The On/Sleep LED of the XBee Grove Development Board indicates if the module is awake (LED on) or asleep (LED off). When a module is sleeping, it cannot be discovered in XCTU; press the Commissioning button to wake a module for 30 seconds.

XCTU reports errors for KY and DD settings after resetting to factory defaults

This is a known issue with XCTU version 6.1.2 and earlier. When the Invalid settings dialog appears, it is safe to continue to write settings.

AES Encryption Key (KY) is a setting that must be set by the user when encryption is used and does not apply with factory settings.
Device Type Identifier (DD) is a diagnostic parameter which is not used in the operation of the radio and can safely be set to any value.

Chat example

Advanced Chat example

Receive digital data example

XBee Java library

Warning message: RXTX version mismatch

If you launch an application and see the message "WARNING: RXTX version mismatch", this indicates that the versions of the JAR file and the native library are not the same. You can safely ignore this message.

Java lang unsatisfied exception message

If you experience the "java.lang.UnsatisfiedLinkError" exception, there are several possibilities.

"no rxtxSerial in java.library.path thrown while loading gnu.io.RXTXCommDriver":

java.lang.UnsatisfiedLinkError: no rxtxSerial in java.library.path thrown while loading gnu.io.RXTXCommDriver
	at java.lang.ClassLoader.loadLibrary(ClassLoader.java:1878)
	at java.lang.Runtime.loadLibrary0(Runtime.java:849)
	at java.lang.System.loadLibrary(System.java:1087)
	at gnu.io.CommPortIdentifier.<clinit>(CommPortIdentifier.java:123)
	at com.digi.xbee.api.connection.serial.SerialPortRxTx.open(SerialPortRxTx.java:161)
	at com.digi.xbee.api.XBeeDevice.open(XBeeDevice.java:189)
	at com.digi.xbee.sendreceivedatasample.MainApp.main(MainApp.java:43)

This exception indicates that the RXTX native library is not linked to the rxtx-2.2.jar file. See the second step of the Link the libraries to the project section.

"Can't load AMD 64-bit .dll on a IA 32-bit platform thrown while loading gnu.io.RXTXCommDriver" (or similar message):

java.lang.UnsatisfiedLinkError: C:\Users\user\workspace\SendReceiveDataSample\libs\native\Windows\win64\rxtxSerial.dll: Can't load AMD 64-bit .dll on a IA 32-bit platform thrown while loading gnu.io.RXTXCommDriver
	Exception in thread "main" java.lang.UnsatisfiedLinkError: C:\Users\user\workspace\SendReceiveDataSample\libs\native\Windows\win64\rxtxSerial.dll: Can't load AMD 64-bit .dll on a IA 32-bit platform
	at java.lang.ClassLoader$NativeLibrary.load(Native Method)
	at java.lang.ClassLoader.loadLibrary1(ClassLoader.java:1957)	
	at java.lang.ClassLoader.loadLibrary0(ClassLoader.java:1882)
	at java.lang.ClassLoader.loadLibrary(ClassLoader.java:1872)
	at java.lang.Runtime.loadLibrary0(Runtime.java:849)
	at java.lang.System.loadLibrary(System.java:1087)
	at gnu.io.CommPortIdentifier.<clinit>(CommPortIdentifier.java:123)
	at com.digi.xbee.api.connection.serial.SerialPortRxTx.open(SerialPortRxTx.java:161)
	at com.digi.xbee.api.XBeeDevice.open(XBeeDevice.java:189)
	at com.digi.xbee.sendreceivedatasample.MainApp.main(MainApp.java:43)

This exception indicates that the RXTX native library you have linked is not the correct one. Check to be sure you aren't using a 32-bit JVM linked the 64-bit library, or vice versa.

SLF4J class path contains multiple bindings message
If you receive the "SLF4J: Class path contains multiple SLF4J bindings" message, it indicates that you linked several logger libraries. Ensure that only the following four libraries are added to your project:
- xbee-java-library-X.Y.Z.jar
- rxtx-2.2.jar
- slf4j-api-x.y.z.jar
- slf4j-nop-x.y.z.jar
XBee Java Library and transparent mode

The XBee Java Library only supports API and API escaped operating modes. You cannot use it with modules in transparent mode.

Receive analog data example

When I launch the example, the message "Could not find the module <XXXX> in the network" appears.

This message indicates that the module attached to your computer could not establish the connection with the device whose node identifier is REMOTE_NODE_ID. Check the following:

Both modules are in the same Channel (CH).
Both modules are in the same PAN ID (ID).
The Node Identifier (NI) of the XBee A (sender) is XBEE_A and the XBee B (receiver) is XBEE_B.

Tip The default NI value is a blank space. Make sure to delete the space when you change the value.

In addition, the value of the REMOTE_NODE_ID constant that appears in the Java source code should be XBEE_B.

The LED does not blink.

Check the following:

In the XBee B (receiver), the value of the D4 setting is DO High [5].
The LINE constant that appears on the Java source code is IOLine.DIO4_AD4.

When I launch the example, the message "Could not find the module <XXXX> in the network" appears.

This message indicates that the module attached to your computer could not establish the connection with the device whose node identifier is REMOTE_NODE_ID. Check the following:

Both modules are in the same Channel (CH).
Both modules are in the same PAN ID (ID).
The Node Identifier (NI) of the XBee A (sender) is XBEE_A and the XBee B (receiver) is XBEE_B.

Tip The default NI value is a blank space. Make sure to delete the space when you change the value.

In addition, the value of the REMOTE_NODE_ID constant that appears in the Java source code should be XBEE_B.

The LED does not dim.

Check the following:

In the XBee B (receiver), the value of the P0 setting is PWM Output [2].
The LINE constant that appears on the Java source code is IOLine.DIO10_PWM0.

The error 'In 802.15.4 protocol the destination device must be running in AT (Transparent) mode' is displayed and I cannot continue.

Range test using 802.15.4 XBees is only supported if the remote device is working in transparent mode.

You must reconfigure the remote device to work in transparent mode:

Parameter	Value	Effect
AP	API disabled [0]	Disables API mode to work in transparent mode.

There are no remote devices to select.

Check cables

Double check all cables. The USB cable should be firmly and fully attached to both the computer and the XBee Grove Development Board. When attached correctly, the association LED on the adapter will be lit.

Check that the XBee is fully seated in the XBee Grove Development Board

When the XBee is correctly installed, it should be pushed fully into the board and no air or metal should be visible between the plastic of the adapter socket and the XBee headers. Also, double check that all ten pins on each side of the XBee made it into a matching hole in the socket.

Check the XBee orientation

The angled "nose" of the XBee should match the lines on the silk screening of the board and point away from the USB socket on the XBee Grove Development Board.

Check that the XBees are in the same network

Check that the Channel (CH) value is the same for both XBees. Check that the PAN ID (ID) has the same value for both XBees

Restore default settings

If the XBees are properly connected and in the same network, restore default settings and configure them again.

The local RSSI and the number of packets received are always 0.

Check cables

Double check all cables. The USB cable should be firmly and fully attached to both the computer and the XBee Grove Development Board. When attached correctly, the association LED on the adapter will be lit.

Check that the XBee is fully seated in the XBee Grove Development Board

When the XBee is correctly installed, it should be pushed fully into the board and no air or metal should be visible between the plastic of the adapter socket and the XBee headers. Also, double check that all ten pins on each side of the XBee made it into a matching hole in the socket.

Check the XBee orientation

The angled "nose" of the XBee should match the lines on the silk screening of the board and point away from the USB socket on the XBee Grove Development Board.

Check the loopback jumper

The remote device loopback jumper must be closed before starting the range test. Otherwise, the packets sent from the local device will not be echoed by the remote device. This means the number of packets received will be always 0 and the RSSI therefore cannot be measured because no packets are being received.

Remote RSSI is not included in the chart and the Remote RSSI control is disabled.

The local device (the one attached to your computer) can be configured to use API or transparent mode. The remote device RSSI value can only be read when the local XBee is working in API mode.

To display the remote RSSI value, reconfigure the local module to work in API mode.

Parameter	Value	Effect
AP	API enabled [1]	Enables API mode.

Troubleshooting

General

XCTU

Send digital actuations example

Send analog actuations example

Range test example