Digi XBee Python library |pypiversion| |pythonversion|

This project contains the source code of the XBee Python library, an easy-to-use API developed in Python that allows you to interact with Digi International's XBee <https://www.digi.com/xbee>_ radio frequency (RF) modules.

This source has been contributed by Digi International.

Installation

You can install XBee Python library using pip <https://pip.pypa.io/en/stable/>_::

$ pip install digi-xbee

Install from Source

You can install XBee Python library directly from sources. To do so, extract the source code to your computer and execute the following command::

$ pip install <path_to_xbee-python_dir>

Documentation

XBee Python library has user guide and API reference documentation hosted on Read the Docs. You can find the latest, most up to date, documentation at latest docs <https://xbplib.readthedocs.io/en/latest/>. To see only those features which have been released, check out the stable docs <https://xbplib.readthedocs.io/en/stable/>.

How to contribute

The contributing guidelines are in the CONTRIBUTING.rst document <https://github.com/digidotcom/xbee-python/blob/master/CONTRIBUTING.rst>_.

License

Copyright 2017-2024, Digi International Inc.

The MPL 2.0 license <https://github.com/digidotcom/xbee-python/blob/master/LICENSE.txt>_ covers the majority of this project with the following exceptions:

• The ISC license <https://github.com/digidotcom/xbee-python/blob/master/examples/LICENSE.txt>_ covers the contents of the examples directory.

.. |pypiversion| image:: https://badge.fury.io/py/digi-xbee.svg :target: https://pypi.org/project/digi-xbee/ .. |pythonversion| image:: https://img.shields.io/pypi/pyversions/digi-xbee.svg :alt: PyPI - Python Version