clj-xbee

Clojure Wrapper for Digi's Official XBee Java Library

Contents

• Dependencies
• Setup
• Usage
• Resources
• License

Dependencies

You will need to install the native rxtx serial library. We have not found a consistently good developer experience for this on modern Macs, so we are recommending that developers use Linux for this.

For example, with Debian-based systems, to install both rxtx and rxtx-native, you just need to do this:

$ sudo apt-get install librxtx-java

In order to access the serial port as non-root, you will need to add yourself to the group that owns the device. On Ubuntu, this is the dialout group:

$ sudo usermod -a -G dialout `whoami`

Setup

Once your XBee radio is plugged in, you can find the device file by doing the following:

$ dmesg

and looking for the recent line that comes up mentioning a USB serial device; the message will also give the relative device path, e.g.:

[518497.515732] usb 1-1.3: FTDI USB Serial Device converter now attached to ttyUSB0

You can confirm that this is the correct device by this:

$ udevadm info -q all /dev/ttyUSB0

Note that the device info you'll be seeing is for the USB Serial-to-USB converter, i.e., the "XBee Explorer" -- not the XBee radio itself.

Usage

To get started, your project will need to include the dependency. For lein:

[systems.billo/clj-xbee "0.2.0-SNAPSHOT"]

Then, in your ns setup, require the following:

[xbee.device.core :as xbee]

Create and open a device:

[xbee.dev] λ=> (def d (xbee/create-device :raw802 "/dev/ttyUSB0" 9600))
#'xbee.dev/d
[xbee.dev] λ=> (xbee/open d)
nil

Note that the passed device type will depend upon what type of radio you have. If we haven't wrapped the Java API for your particular XBee radio, just submit a new ticket and we'll get that done for you.

If you get warnings about minor version mismatches, you can disregard.

Update the device info cache:

[xbee.dev] λ=> (xbee/read-device-info d)
nil

Get some basic device info:

[xbee.dev] λ=> (xbee/get-firmware-version d)
"10EF"
[xbee.dev] λ=> (xbee/get-hardware-version d)
24
[xbee.dev] λ=> (xbee/get-power-level d)
{:id 4, :name "Highest"}
[xbee.dev] λ=> (xbee/get-xbee-protocol d)
{:id 1, :name "802.15.4"}
[xbee.dev] λ=> (xbee/get-64bit-addr d)
"00000000-00000000-A20040FF-FFD692BD"

Resources

• XBee Java Library User Guide
• XBee Java Library API Reference (Javadocs)

License

Copyright © 2017, Billo Systems, Ltd. Co.

Copyright © 2017, Duncan McGreggor

Distributed under the Apache License Version 2.0.