Version 0.5.2

Implemented temperature module and added examples for it.
Added new contributor.
Adaptations to fit pygatt 3.0.0
Made Windows building possible; still not runnable on Windows due to missing BLE lib in Python.
Updated documentation and some docstrings.
Fixes #21

.gitignore

@@ -1,6 +1,7 @@
 # Created by .ignore support plugin (hsz.mobi)
 
 libmetawear.so*
+MetaWear.*.dll
 # Never add potentially built elements of submodule either.
 pymetawear/mbientlab/
 

CONTRIBUTORS.md

@@ -3,6 +3,11 @@ PyMetaWear contributors (sorted alphabetically)
 
 * [Jonas Böer](https://github.com/morgil) (Kinemic GmbH)
     - Magnetometer module
-
+
+* [Thibaud Mathieu](https://github.com/enlight3d)
+    - Raw example for temperature module
+
 * [Eric Tsai](https://github.com/scaryghost) (mbientlab)
     - 64-bit datasignal address handling and typecasting
+
+

HISTORY.rst

@@ -1,3 +1,9 @@
+v0.5.2 (2016-10-13)
+===================
+- Temperature Module
+- Using Pygatt 3.0.0 (including PR from PyMetaWear contributors)
+- Builds on Windows
+
 v0.5.1 (2016-09-15)
 ===================
 - Corrections to make it distributable via PyPI.

README.rst

@@ -20,8 +20,9 @@ Python packages for Bluetooth Low Energy communication:
 - `bluepy <https://github.com/IanHarvey/bluepy>`_ (not completely functional yet)
 
 PyMetaWear can be run with Python 2 or 3 with both backends,
-but only with the `pygatt` backend for Python 3.5. It is currently a
-Linux only package.
+but only with the `pygatt` backend for Python 3.5. It builds and runs on Linux systems,
+and can be built on Windows, given that Visual Studio Community 2015 has been installed first,
+but there is no working backend for Windows BLE yet.
 
 Installation
 ------------
@@ -43,8 +44,8 @@ or
 
     $ pip install pymetawear[bluepy]
 
-Requirements for ``pymetawear``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Debian requirements for ``pymetawear``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 * ``build-essential``
 * ``python-dev``

docs/source/index.rst

@@ -24,8 +24,10 @@ Python packages for Bluetooth Low Energy communication:
 - `bluepy <https://github.com/IanHarvey/bluepy>`_ (not completely functional yet)
 
 PyMetaWear can be run with Python 2 or 3 with both backends,
-but only with the `pygatt` backend for Python 3.5. It is currently a
-Linux only package.
+but only with the `pygatt` backend for Python 3.5. It builds and runs on Linux systems,
+and can be built on Windows, given that Visual Studio Community 2015 has been installed first,
+but there is no working backend for Windows BLE yet.
+
 
 
 Contents

docs/source/modules/accelerometer.rst

@@ -21,12 +21,12 @@ Example usage:
     # Set data rate to 200 Hz and measureing range to +/- 8g
     c.accelerometer.set_settings(data_rate=200.0, data_range=8)
 
-    def handle_acc_notification(data):
-        """Handle a (x,y,z) accelerometer tuple."""
-        print("X: {0}, Y: {1}, Z: {2}".format(*data))
+    def acc_callback(data):
+        """Handle a (epoch, (x,y,z)) accelerometer tuple."""
+        print("Epoch time: [{0}] - X: {1}, Y: {2}, Z: {3}".format(data[0], *data[1]))
 
     # Enable notifications and register a callback for them.
-    c.accelerometer.notifications(handle_acc_notifications)
+    c.accelerometer.notifications(acc_callback)
 
 API
 ---

docs/source/modules/barometer.rst

@@ -21,12 +21,12 @@ Example usage:
     # Set a large oversampling value.
     c.barometer.set_settings(oversampling='ultra_high')
 
-    def handle_barometer_notification(data):
+    def barometer_callback(data):
         """Handle a (epoch, altitude) barometer tuple."""
         print("[{0}]: Altitude: {1} m".format(*data))
 
     # Enable notifications and register a callback for them.
-    c.barometer.notifications(handle_barometer_notification)
+    c.barometer.notifications(barometer_callback)
 
 API
 ---

docs/source/modules/gyroscope.rst

@@ -23,12 +23,12 @@ Example usage:
     # Set data rate to 200 Hz and measuring range to +/- 1000 DPS
     c.gyroscope.set_settings(data_rate=200.0, data_range=1000.0)
 
-    def handle_notification(data):
-        """Handle a (x,y,z) gyroscope tuple."""
-        print("X: {0}, Y: {1}, Z: {2}".format(*data))
+    def gyro_callback(data):
+        """Handle a (epoch, (x,y,z)) gyroscope tuple."""
+        print("Epoch time: [{0}] - X: {1}, Y: {2}, Z: {3}".format(data[0], *data[1]))
 
     # Enable notifications and register a callback for them.
-    c.gyroscope.notifications(handle_notifications)
+    c.gyroscope.notifications(gyro_callback)
 
 API
 ---

docs/source/modules/index.rst

@@ -9,8 +9,10 @@ MetaWear modules
    base
    accelerometer
    gyroscope
+   magnetometer
    barometer
    led
    settings
    haptic
    switch
+   temperature

docs/source/modules/magnetometer.rst

@@ -21,14 +21,14 @@ Example usage:
     # Set Power preset to low power.
     c.magnetometer.set_settings(power_preset='low_power')
 
-    def handle_mag_notification(data):
+    def magnetometer_callback(data):
         """Handle a (epoch_time, (x,y,z)) magnetometer tuple."""
             epoch = data[0]
             xyz = data[1]
             print("[{0}] X: {1}, Y: {2}, Z: {3}".format(epoch, *xyz))
 
     # Enable notifications and register a callback for them.
-    c.magnetometer.notifications(handle_mag_notification)
+    c.magnetometer.notifications(magnetometer_callback)
 
 API
 ---

docs/source/modules/settings.rst

@@ -25,12 +25,13 @@ Example usage:
     """Handle a battery status tuple."""
         print("Voltage: {0}, Charge: {1}".format(
             data[0], data[1]))
-
+    # Enable notifications and register a callback for them.
     mwclient.battery.notifications(battery_callback)
+    # Trigger battery status notification.
     mwclient.battery.read_battery_state()
 
-    # Enable notifications and register a callback for them.
-    c.switch.notifications(handle_switch_notification)
+
+
 
 API
 ~~~

docs/source/modules/switch.rst

@@ -26,7 +26,7 @@ Example usage:
             print("Switch released!")
 
     # Enable notifications and register a callback for them.
-    c.switch.notifications(handle_switch_notification)
+    c.switch.notifications(switch_callback)
 
 API
 ---

docs/source/modules/temperature.rst

@@ -0,0 +1,36 @@
+.. _modules_temperature:
+
+Temperature module
+==================
+
+The PyMetaWear implementation of the ``libmetawear``
+temperature module.
+
+It is initialized at the creation of the :py:class:`~MetaWearClient`
+client and can then be accessed in the ``temperature``
+attribute of the client.
+
+Example usage:
+
+.. code-block:: python
+
+    from pymetawear.client import MetaWearClient
+
+    c = MetaWearClient('DD:3A:7D:4D:56:F0')
+
+    def temperature_callback(data):
+        """Handle a temperature notification data."""
+        epoch = data[0]
+        temp = data[1]
+        print("[{0}] Temperature {1} C".format(epoch, temp))
+
+    # Enable notifications and register a callback for them.
+    c.temperature.notifications(temperature_callback)
+    # Trigger temperature notification.
+    c.temperature.read_temperature()
+
+API
+---
+
+.. automodule:: pymetawear.modules.temperature
+   :members:

examples/discover.py

@@ -35,5 +35,5 @@ def scan_and_select_le_device(timeout=3):
     elif len(ble_devices) == 1:
         address = ble_devices[0][0]
     else:
-        raise ValueError("DId not detect any BLE devices.")
+        raise ValueError("Did not detect any BLE devices.")
     return address