Metadata-Version: 2.4
Name: XBee
Version: 2.3.2
Summary: Python tools for working with XBee radios
Home-page: https://github.com/nioinnovation/python-xbee
Author: n.io
Author-email: info@n.io
License: MIT
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Terminals :: Serial
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
License-File: LICENSE.txt
Requires-Dist: pyserial
Provides-Extra: tornado
Requires-Dist: tornado~=4.5; extra == "tornado"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

XBee
====

|build_status_badge| |pypi_badge| |py_versions_badge|

.. |build_status_badge| image:: https://travis-ci.org/nioinnovation/python-xbee.svg?branch=master
    :target: https://travis-ci.org/nioinnovation/python-xbee
.. |pypi_badge| image:: https://img.shields.io/pypi/v/XBee.svg   
    :target: https://pypi.python.org/pypi/XBee
.. |py_versions_badge| image:: https://img.shields.io/pypi/pyversions/XBee.svg   
    :target: https://pypi.python.org/pypi/XBee

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:

.. code:: python

    #! /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 <https://python-xbee.readthedocs.io/en/latest/>`_.

To build the documentation yourself, ensure that `Sphinx
<http://sphinx-doc.org/>`_ 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 <http://www.tornadoweb.org/>`_

To run automated tests: `pytest <https://docs.pytest.org>`_

To build the documentation: `Sphinx <http://sphinx-doc.org/>`_

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
============

* Paul Malmsten pmalmsten@gmail.com
* Greg Rapp gdrapp@gmail.com
* Brian blalor@bravo5.org
* Chris Brackert cbrackert@gmail.com
* Amit Synderman
* Marco Sangalli
* James Saunders james@saunders-family.net
* David Walker dwalker@n.io
