Skip to main content

XBee

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)
xbee.remote_at(
    dest_addr=b'\x56\x78',
    command='D2',
    parameter=b'\x04')

xbee.remote_at(
    dest_addr=b'\x56\x78',
    command='WR')

Installation

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 setup.py install

This will automatically install the package for you.

Install with Tornado Support

pip install xbee[tornado]

Documentation

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.

Dependencies

PySerial

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.

Contributors

Metadata

Release files for XBee 2.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for XBee 2.3.2
File Size Uploaded
XBee-2.3.2.tar.gz 28.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for XBee 2.3.2
File Interpreter ABI Platform
XBee-2.3.2-py3-none-any.whl Python 3 none any Details

Total release size: 53.5 kB

Release files / XBee-2.3.2.tar.gz

Download URL XBee-2.3.2.tar.gz
Size 28.1 kB
Tags Source
SHA-256 checksum
How to use checksums
77c06de63403409a7e6ca2305b05f499fbff52a0d6031366ffb7acebe14db657
BLAKE2b-256 checksum
How to use checksums
4e6b34a1a5a0c45c662f8ae033a0d077b0fcc45b3e0e71e0b17522b2861e0090
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / XBee-2.3.2-py3-none-any.whl

Download URL XBee-2.3.2-py3-none-any.whl
Size 25.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f4a9f7d5da7c0fbc19b4e52f8b975859c277ef72606d18d1b6f468049e14d0ae
BLAKE2b-256 checksum
How to use checksums
0ea3464ff453523bd0a614df9f738afbdc02888bd59440ba35edcacb50805c85
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

2.3.2 This release

2 release files

2.3.1

2 release files

2.2.5

2 release files

2.2.4

1 release file

2.2.3

1 release file

2.1.0

1 release file

2.0.0

1 release file

1.9.2

1 release file

1.9.1

1 release file

1.9.0

1 release file

1.8.0

1 release file

1.7.1

1 release file

1.7.0

1 release file

1.5.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page