My favorites | Sign in
External links:
XBee Arduino
Project feeds
XBee API Forum


This is a Java API for communication with XBee/XBee-Pro series 1 (802.15.4) and series 2 (ZNet 2.5 and ZB/ZigBee Pro) OEM RF Modules, in API mode. The objective of this project is to provide a flexible and simple to use API to interact with XBee radios. In terms of flexibility, the goal is to not constrain you to a particular implementation (e.g. GUI, Web App, Processing etc.), but instead let you decide how to use it. This software has been tested on Windows, Mac, and Linux and can run on any other platform that supports Java 5 or greater and RXTX.

Note: This software requires API mode, by setting AP=2 (this is a good thing). It will not work correctly with AP=1 Refer to XBeeConfiguration and WhyApiMode for more info.




Here are a few examples that demostrate some common functionality:

Turn on an I/O port on a remote Series 2 (ZNet/ZB Pro) XBee:

XBee xbee = new XBee();"COM5", 9600);

// this is the Serial High (SH) + Serial Low (SL) of the remote XBee			
XBeeAddress64 addr64 = new XBeeAddress64(0xa, 0xb, 0xc, 0xd, 0xe, 0xf, 0, 1);

// Turn on DIO0 (Pin 20).  5 is Digital Output High
ZNetRemoteAtRequest request = new ZNetRemoteAtRequest(addr64, "D0", new int[] {5});


ZNetRemoteAtResponse response = (ZNetRemoteAtResponse) xbee.getResponse();

if (response.isOk()) {
    System.out.println("Successfully turned on DIO0");
} else {
    System.out.println("Attempt to turn on DIO0 failed.  Status: " + response.getStatus());

// shutdown the serial port and associated threads

Receive I/O samples from a remote Series 1 (802.15.4) XBee:

XBee xbee = new XBee();"COM15", 9600);
while (true) {
    RxResponseIoSample ioSample = (RxResponseIoSample) xbee.getResponse();

    System.out.println("We received a sample from " + ioSample.getSourceAddress());	
    if (ioSample.containsAnalog()) {
        System.out.println("10-bit temp reading (pin 19) is " + ioSample.getSamples()[0].getAnalog1();

There are many more detailed examples included in the code for both ZigBee and 802.15.4. Here are just a few:

This example contains a few sample configurations to get your ZigBee coordinator and end devices configured quickly, without needing X-CTU (windows only)

Example of sending packets from a ZigBee coordinator to an end device

This example receives the packets sent in the previous example

Feature Support

The majority of the XBee specification has been implemented for both 802.15.4 (Series 1) and ZNet 2.5/ZB Pro (Series 2). See FeatureSupport for a full listing of supported API types.


I received my first pair of XBee Pro radios in Nov '07, after learning about them on the Arduino website. I quickly learned that to take advantage of the real power in XBee radios (e.g. I/O Samples, ACK/Delivery Status, Remote AT etc.), you need to configure the radio in API mode. I searched for open source XBee software with support for API mode, but couldn't find anything, so I decided to write my own. I started coding on 12/15/2007 and after about 300 commits and several months later I released the software here, on Google Code.


Please report any bugs on the Issue Tracker For questions regarding this software, not covered in the documentation, use the Forum


Questions about this project should be posted to Be sure to provide as much detail as possible.

For other stuff, I can be contacted at andrew.rapp [at] gmail.

Powered by Google Project Hosting

Wik portal where you can upload your ideas and interests and educational mind set for a free website account please apply here