Skip to content

Commit 71dc996

Browse files
jamesleesaundersjamesleesaunders
committed
Reversion to 2.2.4. Update README, CHANGES and .gitignore.
1 parent 19aad4a commit 71dc996

3 files changed

Lines changed: 108 additions & 96 deletions

File tree

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,6 @@ ENV/
8787

8888
# Rope project settings
8989
.ropeproject
90+
91+
# InteliJ PyCharm
92+
.idea

‎CHANGES.txt‎

Lines changed: 102 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,103 @@
1-
v1.5.0, 6/27/10 -- Initial Packaging. Fully restructured into a unified API with tests.
2-
v1.7.0 6/29/10 -- Now supports both Series 1 and Series 2 modules
3-
(the API turned out to be the same). Additionally:
4-
* API frame logic was split into its own class, APIFrame
5-
* XBee renamed to XBeeBase
6-
* XBee1 renamed to XBee
7-
* Tests updated to reflect changes; API frame tests
8-
moved to test_frame.py, now test APIFrame instead of
9-
XBee base class
10-
* Test files renamed appropriately
11-
* PyLint score improved
12-
* Various docstring updates
13-
* Updated example code to reflect changes
14-
v1.7.1 7/7/2010 -- Bug fix: Now supports receiving I/O data with 64-bit addressing
15-
* Previously, an exception was raised when a packet with ID 0x82
16-
* arrived, which contains I/O samples with a 64-bit source address
17-
* This has been fixed.
18-
v1.8.0 7/8/10 -- Implemented threading support
19-
* If a callback method is given to the XBeeBase constructor,
20-
a new thread will automatically be spawned. This thread
21-
will read from the serial port and call the given callback
22-
method whenever a valid data packet arrives.
23-
* XBeeBase.halt() was added. This method ensures the proper
24-
shutdown of a separate thread if one has been spawned.
25-
This method must be called before closing the serial
26-
port used by an XBee instance in order to prevent
27-
improper use of the serial port.
28-
v1.9.0 7/10/10 -- Implemented Dispatch helper as xbee.helpers.dispatch
29-
* Dispatch allows one to filter incoming packets
30-
between one or more handler functions. This simplifies
31-
application logic which must handle more than one
32-
packet type.
33-
Automated tests are now run as a part of the build process
34-
* nose must be installed for this feature to operate.
35-
If it is not installed, the tests will be skipped
36-
and a warning will be generated.
37-
* A 'test' command has been added to setup.py
38-
v1.9.1 8/11/10 -- Added support for I/O sample data packet with 64-bit
39-
addressing.
40-
Fixed bug where threading.Thread library was not
41-
properly initalized in all use cases.
42-
Added initial documentation.
43-
Properly included distutils_extensions.py in source
44-
distribution archives
45-
v1.9.2 8/19/10 -- Fixed bug where _write() call on a serial object
46-
should have been write()
47-
v2.0.0 12/29/10 -- Added preiminary support for XBee ZB devices; thanks
48-
Greg and Brian!
49-
Improved & unified sample data header parsing code.
50-
Improved documentation.
51-
v2.1.0 4/14/13 -- Support for XBee ZB devices significantly improved.
52-
Now raises a KeyError with a useful message when a
53-
response that looks like a command is received. This
54-
helps debug devices that are not in API mode.
55-
Improper lengths for the ZigBee tx_explicit cluster
56-
and profile fields have been corrected.
57-
Removed auto-testing distutils extension for lack of
58-
easy cross-version compatibility.
59-
Now compatible with both Python 2.X and Python 3.X.
60-
Fixed bug in APIFrame.escape().
61-
Fixed crash where a failed call to Serial.read()
62-
could return nothing.
63-
Packet-parsing subsystem generalized to allow for
64-
much more general parsing behavior.
65-
ZigBee now parses IS command responses.
66-
Node Discover responses for ZigBee devices are
67-
now parsed.
68-
Added tests for escaped API communication.
69-
Fixes issue #31 on Google Code: parameter information
70-
for lowercase nd or is commands were not parsed.
71-
Closes issue 35, as reported by Mark Fickett
72-
If an empty frame is received from a device, it is
73-
ignored.
74-
Removed deprecated build process files.
75-
Backported parsing of IS AT command response as I/O
76-
data from ZigBee devices.
1+
v1.5.0 06/27/2010 -- * Initial Packaging.
2+
* Fully restructured into a unified API with tests.
3+
v1.7.0 06/29/2010 -- * Now supports both Series 1 and Series 2 modules
4+
(the API turned out to be the same).
5+
* API frame logic was split into its own class, APIFrame
6+
* XBee renamed to XBeeBase
7+
* XBee1 renamed to XBee
8+
* Tests updated to reflect changes; API frame tests
9+
moved to test_frame.py, now test APIFrame instead of
10+
XBee base class
11+
* Test files renamed appropriately
12+
* PyLint score improved
13+
* Various docstring updates
14+
* Updated example code to reflect changes
15+
v1.7.1 07/07/2010 -- * Bug fix: Now supports receiving I/O data with 64-bit addressing
16+
* Previously, an exception was raised when a packet with ID 0x82
17+
* arrived, which contains I/O samples with a 64-bit source address
18+
* This has been fixed.
19+
v1.8.0 07/08/2010 -- Implemented threading support
20+
* If a callback method is given to the XBeeBase constructor,
21+
a new thread will automatically be spawned. This thread
22+
will read from the serial port and call the given callback
23+
method whenever a valid data packet arrives.
24+
* XBeeBase.halt() was added. This method ensures the proper
25+
shutdown of a separate thread if one has been spawned.
26+
This method must be called before closing the serial
27+
port used by an XBee instance in order to prevent
28+
improper use of the serial port.
29+
v1.9.0 07/10/2010 -- * Implemented Dispatch helper as xbee.helpers.dispatch
30+
* Dispatch allows one to filter incoming packets
31+
between one or more handler functions. This simplifies
32+
application logic which must handle more than one
33+
packet type.
34+
Automated tests are now run as a part of the build process
35+
* nose must be installed for this feature to operate.
36+
If it is not installed, the tests will be skipped
37+
and a warning will be generated.
38+
* A 'test' command has been added to setup.py
39+
v1.9.1 08/11/2010 -- * Added support for I/O sample data packet with 64-bit addressing.
40+
* Fixed bug where threading.Thread library was not
41+
properly initalized in all use cases.
42+
* Added initial documentation.
43+
* Properly included distutils_extensions.py in source
44+
distribution archives
45+
v1.9.2 08/19/2010 -- * Fixed bug where _write() call on a serial object
46+
should have been write()
47+
v2.0.0 12/29/2010 -- * Added preiminary support for XBee ZB devices; thanks
48+
Greg and Brian!
49+
* Improved & unified sample data header parsing code.
50+
* Improved documentation.
51+
v2.1.0 04/14/2013 -- * Support for XBee ZB devices significantly improved.
52+
* Now raises a KeyError with a useful message when a
53+
response that looks like a command is received. This
54+
helps debug devices that are not in API mode.
55+
* Improper lengths for the ZigBee tx_explicit cluster
56+
and profile fields have been corrected.
57+
* Removed auto-testing distutils extension for lack of
58+
easy cross-version compatibility.
59+
* Now compatible with both Python 2.X and Python 3.X.
60+
* Fixed bug in APIFrame.escape().
61+
* Fixed crash where a failed call to Serial.read()
62+
could return nothing.
63+
* Packet-parsing subsystem generalized to allow for
64+
much more general parsing behavior.
65+
* ZigBee now parses IS command responses.
66+
* Node Discover responses for ZigBee devices are
67+
now parsed.
68+
* Added tests for escaped API communication.
69+
* Fixes issue #31 on Google Code: parameter information
70+
for lowercase nd or is commands were not parsed.
71+
* Closes issue 35, as reported by Mark Fickett
72+
* If an empty frame is received from a device, it is
73+
ignored.
74+
* Removed deprecated build process files.
75+
* Backported parsing of IS AT command response as I/O
76+
data from ZigBee devices.
7777

78-
BACKWARDS-INCOMPATIBLE CHANGES:
79-
XBee IS "Force Sample" AT response (and Remote AT Response) 'parameter'
80-
value is no longer raw; it is parsed as I/O samples.
81-
See the documentation for details.
82-
ZigBee IS "Force Sample" AT response (and Remote AT Response) 'parameter'
83-
value is no longer raw; it is parsed as I/O samples.
84-
See the documentation for details.
85-
ZigBee ND "Node Discover" AT response (and Remote AT Response) 'parameter'
86-
value is no longer raw; it is parsed into a node
87-
discover dictionary. See the documentation for details.
88-
v2.2.2 11/19/15 -- Add error_callback function to XBeeBase
89-
* If an error_callback method is given to the XBeeBase constructor
90-
(in addition to the callback method),
91-
a new thread will automatically be spawned. This thread
92-
will read from the serial port and call the error_callback
93-
when an unexpected Exception (not ThreadQuitException) is raised
94-
while waiting for serial data. This generally indicates that the XBee
95-
serial interface needs to be reconnected.
96-
v2.2.3 11/21/15 -- Fix README for GitHub and PyPI
78+
BACKWARDS-INCOMPATIBLE CHANGES:
79+
* XBee IS "Force Sample" AT response (and Remote AT Response) 'parameter'
80+
value is no longer raw; it is parsed as I/O samples.
81+
See the documentation for details.
82+
* ZigBee IS "Force Sample" AT response (and Remote AT Response) 'parameter'
83+
value is no longer raw; it is parsed as I/O samples.
84+
See the documentation for details.
85+
* ZigBee ND "Node Discover" AT response (and Remote AT Response) 'parameter'
86+
value is no longer raw; it is parsed into a node
87+
discover dictionary. See the documentation for details.
88+
v2.2.2 11/19/2015 -- * Add error_callback function to XBeeBase.
89+
* If an error_callback method is given to the XBeeBase constructor
90+
(in addition to the callback method),
91+
a new thread will automatically be spawned. This thread
92+
will read from the serial port and call the error_callback
93+
when an unexpected Exception (not ThreadQuitException) is raised
94+
while waiting for serial data. This generally indicates that the XBee
95+
serial interface needs to be reconnected.
96+
v2.2.3 11/21/2015 -- * Fix README for GitHub and PyPI
97+
v2.2.4 01/11/2017 -- * Added DigiMesh support.
98+
* Added support for Route Record Indicator and Many-to-One Route Request packets.
99+
* Improved and simplified tests.
100+
* Documentation updates and comment typo corrections.
101+
* Do not break on error, rather log error.
102+
* Add Travis CI for unit tests.
103+
* Modernized setup.py.

‎README.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,6 @@ Contributors
9696
Special Thanks
9797
==============
9898

99-
Amit Synderman, Marco Sangalli
99+
* Amit Synderman
100+
* Marco Sangalli
101+
* James Saunders

0 commit comments

Comments
 (0)