bump version number

Author: fsmeraldi

CITATION.cff

@@ -5,8 +5,7 @@ authors:
     given-names: Fabrizio
     orcid: https://orcid.org/0000-0002-0057-8940
 title: "BleakHeart"
-version: 0.1.3
-doi: 10.5281/zenodo.10992864
-https://doi.org/
-date-released: 2025-01-19
+version: 0.2.0
+doi: https://doi.org/10.5281/zenodo.10992864
+date-released: 2025-10-19
 url: "https://github.com/fsmeraldi/bleakheart"

README.md

@@ -1,6 +1,6 @@
 # 🖤 BleakHeart 
 
-An asynchronous BLE Heart Monitor library that supports additional measurements (such as ECG and accelerometer data) available from Polar sensors through the Polar Measurement Data interface. 
+An asynchronous BLE Heart Monitor library that supports additional measurements  available from Polar sensors through the Polar Measurement Data interface (currently, ECG and accelerometer data from the Polar H10, and PPG from the Polar Verity). 
 
 BleakHeart is written in Python using the [asyncio](https://docs.python.org/3/library/asyncio.html) framework; BLE communication is based on [Bleak](https://bleak.readthedocs.io/en/latest/#).
 
@@ -14,8 +14,9 @@ python3 -m pip install "bleakheart"
 ## Features
 
 * Supports heart rate acquisition for devices supporting the standard BLE [heart rate service](https://www.bluetooth.com/specifications/specs/heart-rate-service-1-0/), including RR intervals, instant heart rate, energy expenditure and (client-based) time stamps;
-* Reads Accelerometer and ECG signals from the Polar H10 chest strap; 
-* Offers partial support for measurements available from other Polar devices through the Polar Measurement Data interface;
+* Reads Accelerometer and ECG signals from the Polar H10 chest strap;
+* Reads PPG data from the Polar Verity, including in SDK mode;
+* Offers partial support for other measurements available through the Polar Measurement Data interface, possibly from other devices;
 * Normalises Polar sensor timestamps to Epoch time; 
 * Reads the battery charge state through the standard BLE [battery service](https://www.bluetooth.com/specifications/specs/battery-service/) (also available on other types of BLE devices);
 * Compatible with Jupyter Notebooks (IPython version 7+, IPykernel version 5+).
@@ -27,7 +28,7 @@ BleakHeart supports a variety of software design choices. Specifically:
 * Alternatively, data can be sent to a callback. Simple tasks such as sensor logging can be accomplished with only a minimal understanding of ```asyncio```;
 * All data are tagged with their measurement type; thus the same queue or callback can be used to handle different types of measurements if desired.
 
-Please see the [getting_started](examples/getting_started.ipynb) notebook in the examples directory, or click on the image below for a video introduction. 
+Please see the [getting_started](examples/getting_started.ipynb) notebook in the examples directory, or see this [video introduction](https://youtu.be/WzNl-cQH7HU). 
 
 <a href="https://youtu.be/WzNl-cQH7HU"><img src="screenshot.png" align="center" height="400" width="542" ></a>
 
@@ -36,13 +37,14 @@ The examples directory also contains detailed stand-alone examples for some of t
 
 ## Limitations
 
-BleakHeart has mainly been tested on a Polar H10 chest strap (under Linux), since that is what I have available. However, reports from Windows and MacOS users have been positive. Other Polar devices are only partly supported; measurements other than ECG and acceleration are returned as raw bytearrays. Offline recording to the internal Polar H10 memory is not supported.
+BleakHeart has mainly been tested on a Polar H10 chest strap under Linux and on a Verity sensor under Windows. However, reports from Windows and MacOS users have been positive. Other Polar devices are only partly supported; measurements other than ECG and acceleration on the H10, and PPG on the Verity, are returned as raw bytearrays. Offline recording to the internal Polar H10 memory is not supported.
 
 ## Credits and contributing
 
 This software was originally developed and is maintained by [Fabrizio Smeraldi](http://www.eecs.qmul.ac.uk/~fabri/). Many thanks to 
 
 * Alex Ong - [alex-ong](https://github.com/alex-ong),
+* Andy Scott - [scott86](https://github.com/scott86),
 * Chris Spooner - [Chris-Spooner999](https://github.com/Chris-Spooner999),
 * Fareza - [farezae](https://github.com/farezae),
 * Léo Flaventin Hauchecorne - [hl037](https://github.com/hl037),
@@ -63,9 +65,11 @@ This software is provided subject to the terms of the [Mozilla Public License ve
 
 ## Resources
 
-* The official [Polar BLE SDK](https://github.com/polarofficial/polar-ble-sdk), contains software for Android and iOS and some interesting documentation, in particular:
+* The official [Polar BLE SDK](https://github.com/polarofficial/polar-ble-sdk), contains software for Android and iOS and some interesting [documentation](https://github.com/polarofficial/polar-ble-sdk/blob/master/README.md), in particular:
     * An explanation of [ECG on the Polar H10](https://github.com/polarofficial/polar-ble-sdk/blob/master/technical_documentation/H10_ECG_Explained.docx)
-    * A specification of the proprietary [Polar Measurement Data](https://github.com/polarofficial/polar-ble-sdk/blob/52ef4c4b77e5f83b0839f0f4f72623a9b9d79372/technical_documentation/Polar_Measurement_Data_Specification.pdf) service
+    * An older but detailed specification of the proprietary [Polar Measurement Data](https://github.com/polarofficial/polar-ble-sdk/blob/52ef4c4b77e5f83b0839f0f4f72623a9b9d79372/technical_documentation/Polar_Measurement_Data_Specification.pdf) service
+	* More details on the [PMD frame types](https://github.com/polarofficial/polar-ble-sdk/blob/master/technical_documentation/online_measurement.pdf)
+	* Decoding examples for  the Verity ACC delta frames: see [here](https://github.com/polarofficial/polar-ble-sdk/issues/187) and [here](https://github.com/polarofficial/polar-ble-sdk/issues/443) 
     * An explanation of the [time system](https://github.com/polarofficial/polar-ble-sdk/blob/master/documentation/TimeSystemExplained.md) in Polar devices (BleakHeart transparently normalises this to Epoch time).
 * The [Heart Rate service](https://www.bluetooth.com/specifications/specs/heart-rate-service-1-0/) specification, on  the BLE SIG website.
 * The [Battery service](https://www.bluetooth.com/specifications/specs/battery-service/) specification, on the BLE SIG website.

src/bleakheart/_version.py

@@ -1,5 +1,5 @@
 """ contains the current package version, which is imported
-by __init__.py """
+by __init__.py and by the packager """
 
 
-__version__ = "0.1.3"
+__version__ = "0.2.0"