Skip to content

Commit

Permalink
Bump version to 2.2.2
Browse files Browse the repository at this point in the history
  • Loading branch information
hansmosh committed Oct 19, 2015
1 parent e25e519 commit efa961c
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 38 deletions.
8 changes: 8 additions & 0 deletions CHANGES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,11 @@ v2.1.0 4/14/13 -- Support for XBee ZB devices significantly improved.
ZigBee ND "Node Discover" AT response (and Remote AT Response) 'parameter'
value is no longer raw; it is parsed into a node
discover dictionary. See the documentation for details.
v2.2.2 11/19/15 -- Add error_callback function to XBeeBase
* If an error_callback method is given to the XBeeBase constructor
(in addition to the callback method),
a new thread will automatically be spawned. This thread
will read from the serial port and call the error_callback
when an unexpected Exception (not ThreadQuitException) is raised
while waiting for serial data. This generally indicates that the XBee
serial interface needs to be reconnected.
65 changes: 35 additions & 30 deletions README.txt → README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,54 @@
=========
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::

#! /usr/bin/python

# Import and init an XBee device
from xbee import XBee,ZigBee
import serial
```python
#! /usr/bin/python

ser = serial.Serial('/dev/ttyUSB0', 9600)
# 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
# To use with an XBee ZigBee device, replace with:
#xbee = ZigBee(ser)
xbee = XBee(ser)

# Set remote DIO pin 2 to low (mode 4)
xbee.remote_at(
dest_addr='\x56\x78',
command='D2',
parameter='\x04')

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

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

# Set remote DIO pin 2 to low (mode 4)
xbee.remote_at(
dest_addr='\x56\x78',
command='D2',
parameter='\x04')

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


Installation
============

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

python setup.py install
```
python setup.py install
```

This will automatically test and install the package for you.

Additionally, one may run this package's automated tests at any time
by executing::

python setup.py test
```
python setup.py test
```

If a Test Fails
---------------
Expand All @@ -60,7 +64,7 @@ Documentation

See the python-xbee project on Google Code (https://code.google.com/p/python-xbee/downloads/list)
for the latest documentation.

To build the documentation yourself, ensure that Sphynx (http://sphinx.pocoo.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.
Expand All @@ -74,7 +78,7 @@ Dependencies
PySerial

Additional Dependencies
--------------------------------------------
-----------------------

To run automated tests: Nose (https://code.google.com/p/python-nose/)
To build the documentation: Sphinx (http://sphinx.pocoo.org/)
Expand All @@ -87,14 +91,15 @@ provided by Digi. Using an old firmware revision is not supported and
may result in unspecified behavior.

Contributors
==================
============

Paul Malmsten <[email protected]>
Greg Rapp <[email protected]>
Brian <[email protected]>
Chris Brackert <[email protected]>

Special Thanks
==================
==============

Amit Synderman,
Marco Sangalli
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@
# built documents.
#
# The short X.Y version.
version = '2.1.0'
version = '2.2.2'
# The full version, including alpha/beta/rc tags.
release = '2.1.0'
release = '2.2.2'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
12 changes: 6 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
from distutils.core import setup

packages=[
'xbee',
'xbee.tests',
'xbee.helpers',
'xbee',
'xbee.tests',
'xbee.helpers',
'xbee.helpers.dispatch',
'xbee.helpers.dispatch.tests',
]

setup(
name='XBee',
version='2.1.0',
version='2.2.2',
author='Paul Malmsten',
author_email='[email protected]',
packages=packages,
scripts=[],
url='http://code.google.com/p/python-xbee/',
url='https://github.com/nioinnovation/python-xbee',
license='LICENSE.txt',
description='Python tools for working with XBee radios',
long_description=open('README.txt').read(),
long_description=open('README.md').read(),
requires=['serial'],
provides=packages,
)

0 comments on commit efa961c

Please sign in to comment.