Prep for v0.0.5

pimoroni · Mar 19, 2020 · ebdafc2 · ebdafc2
1 parent d441acd
commit ebdafc2
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 11 deletions.
diff --git a/library/CHANGELOG.txt b/library/CHANGELOG.txt
@@ -1,3 +1,11 @@
+0.0.5
+-----
+
+* BugFix: Read start-of-frame a byte at a time to avoid misalignment issues, potential fix for #2, #3 and #4
+* Enhancement: Clarified error message when length packet cannot be read
+* Enhancement: Clarified error message when start of frame cannot be read
+* Enhancement: Added new error message where raw data length is less than expected (frame length)
+
 0.0.4
 -----
 

diff --git a/library/README.rst b/library/README.rst
@@ -1,11 +1,7 @@
 PMS5003 Particulate Sensor
 ==========================
 
-`Build Status <https://travis-ci.com/pimoroni/pms5003-python>`__
-`Coverage
-Status <https://coveralls.io/github/pimoroni/pms5003-python?branch=master>`__
-`PyPi Package <https://pypi.python.org/pypi/pms5003>`__ `Python
-Versions <https://pypi.python.org/pypi/pms5003>`__
+|Build Status| |Coverage Status| |PyPi Package| |Python Versions|
 
 Installing
 ==========
@@ -27,11 +23,11 @@ The serial port on your Raspberry Pi must be enabled:
 
 ::
 
-   # Disable serial terminal over /dev/ttyAMA0
-   sudo raspi-config nonint do_serial 1
+    # Disable serial terminal over /dev/ttyAMA0
+    sudo raspi-config nonint do_serial 1
 
-   # Enable serial port
-   raspi-config nonint set_config_var enable_uart 1 /boot/config.txt
+    # Enable serial port
+    raspi-config nonint set_config_var enable_uart 1 /boot/config.txt
 
 And additionally be using a full UART (versus the default miniUART):
 
@@ -41,6 +37,23 @@ This will switch Bluetooth over to miniUART, see
 https://www.raspberrypi.org/documentation/configuration/uart.md for more
 details.
 
+.. |Build Status| image:: https://travis-ci.com/pimoroni/pms5003-python.svg?branch=master
+   :target: https://travis-ci.com/pimoroni/pms5003-python
+.. |Coverage Status| image:: https://coveralls.io/repos/github/pimoroni/pms5003-python/badge.svg?branch=master
+   :target: https://coveralls.io/github/pimoroni/pms5003-python?branch=master
+.. |PyPi Package| image:: https://img.shields.io/pypi/v/pms5003.svg
+   :target: https://pypi.python.org/pypi/pms5003
+.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/pms5003.svg
+   :target: https://pypi.python.org/pypi/pms5003
+
+0.0.5
+-----
+
+* BugFix: Read start-of-frame a byte at a time to avoid misalignment issues, potential fix for #2, #3 and #4
+* Enhancement: Clarified error message when length packet cannot be read
+* Enhancement: Clarified error message when start of frame cannot be read
+* Enhancement: Added new error message where raw data length is less than expected (frame length)
+
 0.0.4
 -----
 

diff --git a/library/pms5003/__init__.py b/library/pms5003/__init__.py
@@ -4,7 +4,7 @@
 import time
 
 
-__version__ = '0.0.4'
+__version__ = '0.0.5'
 
 
 PMS5003_SOF = bytearray(b'\x42\x4d')

diff --git a/library/setup.cfg b/library/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = pms5003
-version = 0.0.4
+version = 0.0.5
 author = Philip Howard
 author_email = phil@pimoroni.com
 description = PMS5003 Particulate Sensor