Skip to main content

Python tools for working with XBee radios

Project description


build_status_badge pypi_badge py_versions_badge

XBee provides an implementation of the XBee serial communication API. It allows one to easily access advanced features of one or more XBee devices from an application written in Python. An example use case might look like this:

#! /usr/bin/python

# Import and init an XBee device
from xbee import XBee, ZigBee
import serial

ser = serial.Serial('/dev/ttyUSB0', 9600)

# Use an XBee 802.15.4 device
xbee = XBee(ser)
# To use with an XBee ZigBee device, replace with:
# xbee = ZigBee(ser)

# Set remote DIO pin 2 to low (mode 4)



pip install xbee

Install from Source

Extract the source code to your computer, then run the following command in the root of the source tree:

python install

This will automatically install the package for you.

Install with Tornado Support

pip install xbee[tornado]


See the python-xbee project on Read the Docs.

To build the documentation yourself, ensure that Sphinx is installed. Then cd into the docs folder, and run ‘make html’. The documentation can then be opened in any modern web browser at docs/build/html/index.html.

For more information about building or modifying this project’s documentation, see the documentation for the Sphinx project.



Additional Dependencies

If wanting to use the Tornado IOLoop: Tornado

To run automated tests: pytest

To build the documentation: Sphinx

XBee Firmware

Please ensure that your XBee device is programmed with the latest firmware provided by Digi. Using an old firmware revision is not supported and may result in unspecified behavior.


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for XBee, version 2.3.2
Filename, size File type Python version Upload date Hashes
Filename, size XBee-2.3.2-py3-none-any.whl (25.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size XBee-2.3.2.tar.gz (28.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page