Version 0.10.0

Added logging support for acc, gyro, mag and sensor fusion modules.
Locked metawear package to 0.3.1.
Added documentation and examples.

HISTORY.rst

@@ -2,6 +2,13 @@
 History
 =======
 
+v0.10.0 (2018-06-18)
+--------------------
+- Added support for data logging, thanks to ``dmatthes1982`` (#32, #46, #48, #49)
+- Locked ``metawear`` version to ``0.3.1``
+- Documentation for data logging
+- Fixes for code examples and documentation examples.
+
 v0.9.1 (2018-04-02)
 -------------------
 - Fix for documentation and README
@@ -19,7 +26,7 @@ v0.8.0 (2017-07-04)
 v0.7.1 (2017-02-04)
 -------------------
 - Using MetaWear-CppAPI version 0.7.10
-- Sensor fusion module contributed from user m-georgi (#26).
+- Sensor fusion module contributed from user ``m-georgi`` (#26).
 - Fix to magnetometer power preset setting due to
   change in MetaWear-CppAPI (#25).
 

Pipfile

@@ -8,7 +8,7 @@ name = "pypi"
 [packages]
 
 gattlib = {git = "https://github.com/mbientlab/pygattlib"}
-metawear = "*"
+metawear = "==0.3.1"
 tqdm = "*"
 
 
@@ -18,3 +18,4 @@ pytest = "*"
 sphinx = "*"
 sphinx-rtd-theme = "*"
 pylint = "*"
+"flake8" = "*"

docs/source/exceptions.rst

@@ -1,7 +1,5 @@
 Exceptions
 ==========
 
-These are the PyMetaWear specific exceptions.
-
 .. automodule:: pymetawear.exceptions
    :members:

docs/source/modules/accelerometer.rst

@@ -13,7 +13,7 @@ attribute of the client.
 Data streaming example
 ----------------------
 
-If you need a real time stream of sensor data, use the :py:method:`notifications` method on the :py:mod:`accelerometer` module:
+If you need a real time stream of sensor data, use the :py:func:`notifications` method on the :py:mod:`accelerometer` module:
 
 .. code-block:: python
 
@@ -35,11 +35,14 @@ Logging example
 ---------------
 
 If you want to log data to the MetaWear board and retrieve it after some time, then use the
-:py:method:`start_logging`, :py:method:`stop_logging` and :py:method:`download_log` methods:
+:py:func:`start_logging`, :py:func:`stop_logging` and :py:func:`download_log` methods:
 
 .. code-block:: python
 
+    import os
     import json
+    import time
+
     from pymetawear.client import MetaWearClient
     from pymetawear.exceptions import PyMetaWearException, PyMetaWearDownloadTimeout
 
@@ -49,35 +52,44 @@ If you want to log data to the MetaWear board and retrieve it after some time, t
     c.accelerometer.set_settings(data_rate=200.0, data_range=8)
 
     # Log data for 10 seconds.
-    client.accelerometer.start_logging()
+    c.accelerometer.start_logging()
     print("Logging accelerometer data...")
 
     time.sleep(10.0)
 
-    client.accelerometer.stop_logging()
+    c.accelerometer.stop_logging()
     print("Finished logging.")
 
     # Download the stored data from the MetaWear board.
     print("Downloading data...")
     download_done = False
     n = 0
     data = None
-    while download_done and n < 3:
+    while (not download_done) and n < 3:
         try:
-            data = client.accelerometer.download_log()
+            data = c.accelerometer.download_log()
             download_done = True
         except PyMetaWearDownloadTimeout:
             print("Download of log interrupted. Trying to reconnect...")
-            client.disconnect()
-            client.connect()
+            c.disconnect()
+            c.connect()
             n += 1
     if data is None:
         raise PyMetaWearException("Download of logging data failed.")
 
     print("Disconnecting...")
-    client.disconnect()
+    c.disconnect()
 
     # Save the logged data.
+    class MetaWearDataEncoder(json.JSONEncoder):
+        """JSON Encoder for converting ``mbientlab`` module's CartesianFloat
+        class to data tuple ``(x,y,z)``."""
+        def default(self, o):
+            if isinstance(o, CartesianFloat):
+                return o.x, o.y, o.z
+            else:
+                return super(MetaWearDataEncoder, self).default(o)
+
     data_file = os.path.join(os.getcwd(), "logged_data.json")
     print("Saving the data to file: {0}".format(data_file))
     with open("logged_data.json", "wt") as f:

docs/source/modules/ambientlight.rst

@@ -1,4 +1,4 @@
-.. _modules_accelerometer:
+.. _modules_ambientlight:
 
 Ambient light module
 ====================
@@ -13,7 +13,7 @@ attribute of the client.
 Data streaming example
 ----------------------
 
-If you need a real time stream of sensor data, use the :py:method:`notifications` method on the :py:mod:`ambient_light` module:
+If you need a real time stream of sensor data, use the :py:func:`notifications` method on the :py:mod:`ambient_light` module:
 
 .. code-block:: python
 

docs/source/modules/gyroscope.rst

@@ -15,7 +15,7 @@ The only MetaWear gyroscope available is the BMI160 sensor.
 Data streaming example
 ----------------------
 
-If you need a real time stream of sensor data, use the :py:method:`notifications` method on the :py:mod:`gyroscope` module:
+If you need a real time stream of sensor data, use the :py:func:`notifications` method on the :py:mod:`gyroscope` module:
 
 .. code-block:: python
 
@@ -36,12 +36,15 @@ If you need a real time stream of sensor data, use the :py:method:`notifications
 Logging Example
 ---------------
 
-If you want to log data to the MetaWear board and retrieve it after some time, then use the 
-:py:method:`start_logging`, :py:method:`stop_logging` and :py:method:`download_log` methods:
+If you want to log data to the MetaWear board and retrieve it after some time, then use the
+:py:func:`start_logging`, :py:func:`stop_logging` and :py:func:`download_log` methods:
 
 .. code-block:: python
 
+    import os
     import json
+    import time
+
     from pymetawear.client import MetaWearClient
     from pymetawear.exceptions import PyMetaWearException, PyMetaWearDownloadTimeout
 
@@ -51,35 +54,44 @@ If you want to log data to the MetaWear board and retrieve it after some time, t
     c.gyroscope.set_settings(data_rate=200.0, data_range=1000.0)
 
     # Log data for 10 seconds.
-    client.gyroscope.start_logging()
+    c.gyroscope.start_logging()
     print("Logging gyroscope data...")
 
     time.sleep(10.0)
 
-    client.gyroscope.stop_logging()
+    c.gyroscope.stop_logging()
     print("Finished logging.")
 
     # Download the stored data from the MetaWear board.
     print("Downloading data...")
     download_done = False
     n = 0
     data = None
-    while download_done and n < 3:
+    while (not download_done) and n < 3:
         try:
-            data = client.gyroscope.download_log()
+            data = c.gyroscope.download_log()
             download_done = True
         except PyMetaWearDownloadTimeout:
             print("Download of log interrupted. Trying to reconnect...")
-            client.disconnect()
-            client.connect()
+            c.disconnect()
+            c.connect()
             n += 1
     if data is None:
         raise PyMetaWearException("Download of logging data failed.")
 
     print("Disconnecting...")
-    client.disconnect()
+    c.disconnect()
 
     # Save the logged data.
+    class MetaWearDataEncoder(json.JSONEncoder):
+        """JSON Encoder for converting ``mbientlab`` module's CartesianFloat
+        class to data tuple ``(x,y,z)``."""
+        def default(self, o):
+            if isinstance(o, CartesianFloat):
+                return o.x, o.y, o.z
+            else:
+                return super(MetaWearDataEncoder, self).default(o)
+
     data_file = os.path.join(os.getcwd(), "logged_data.json")
     print("Saving the data to file: {0}".format(data_file))
     with open("logged_data.json", "wt") as f:

docs/source/modules/magnetometer.rst

@@ -10,10 +10,11 @@ It is initialized at the creation of the :py:class:`~MetaWearClient`
 client and can then be accessed in the ``magnetometer``
 attribute of the client.
 
-Example streaming data
+Data streaming example
 ----------------------
 
-If you need a real time stream of sensor data, use the :py:method:`notifications` method on the :py:mod:`magnetometer` module:
+If you need a real time stream of sensor data, use the
+:py:func:`notifications` method on the :py:mod:`magnetometer` module:
 
 .. code-block:: python
 
@@ -36,12 +37,15 @@ If you need a real time stream of sensor data, use the :py:method:`notifications
 Logging Example
 ---------------
 
-If you want to log data to the MetaWear board and retrieve it after some time, then use the 
-:py:method:`start_logging`, :py:method:`stop_logging` and :py:method:`download_log` methods:
+If you want to log data to the MetaWear board and retrieve it after some time, then use the
+:py:func:`start_logging`, :py:func:`stop_logging` and :py:func:`download_log` methods:
 
 .. code-block:: python
 
+    import os
     import json
+    import time
+
     from pymetawear.client import MetaWearClient
     from pymetawear.exceptions import PyMetaWearException, PyMetaWearDownloadTimeout
 
@@ -51,35 +55,44 @@ If you want to log data to the MetaWear board and retrieve it after some time, t
     c.magnetometer.set_settings(power_preset='low_power')
 
     # Log data for 10 seconds.
-    client.magnetometer.start_logging()
+    c.magnetometer.start_logging()
     print("Logging magnetometer data...")
 
     time.sleep(10.0)
 
-    client.magnetometer.stop_logging()
+    c.magnetometer.stop_logging()
     print("Finished logging.")
 
     # Download the stored data from the MetaWear board.
     print("Downloading data...")
     download_done = False
     n = 0
     data = None
-    while download_done and n < 3:
+    while (not download_done) and n < 3:
         try:
-            data = client.magnetometer.download_log()
+            data = c.magnetometer.download_log()
             download_done = True
         except PyMetaWearDownloadTimeout:
             print("Download of log interrupted. Trying to reconnect...")
-            client.disconnect()
-            client.connect()
+            c.disconnect()
+            c.connect()
             n += 1
     if data is None:
         raise PyMetaWearException("Download of logging data failed.")
 
     print("Disconnecting...")
-    client.disconnect()
+    c.disconnect()
 
     # Save the logged data.
+    class MetaWearDataEncoder(json.JSONEncoder):
+        """JSON Encoder for converting ``mbientlab`` module's CartesianFloat
+        class to data tuple ``(x,y,z)``."""
+        def default(self, o):
+            if isinstance(o, CartesianFloat):
+                return o.x, o.y, o.z
+            else:
+                return super(MetaWearDataEncoder, self).default(o)
+
     data_file = os.path.join(os.getcwd(), "logged_data.json")
     print("Saving the data to file: {0}".format(data_file))
     with open("logged_data.json", "wt") as f:

examples/accelerometer_logging.py

@@ -47,7 +47,7 @@
 download_done = False
 n = 0
 data = None
-while download_done and n < 3:
+while (not download_done) and n < 3:
     try:
         data = client.accelerometer.download_log()
         download_done = True

examples/magnetometer.py

@@ -34,10 +34,6 @@
 
 time.sleep(1.0)
 
-#print("Check accelerometer settings...")
-#settings = c.accelerometer.get_current_settings()
-#print(settings)
-
 print("Subscribing to magnetometer signal notifications...")
 c.magnetometer.notifications(lambda data: print(data))
 

pymetawear/client.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
+Main module for PyMetaWear
 
 .. moduleauthor:: hbldh <henrik.blidh@nedomkull.com>
 

pymetawear/discover.py

@@ -1,8 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
-discover
---------
+Performing BLE scans
 
 :copyright: 2016-11-29 by hbldh <henrik.blidh@nedomkull.com>
 

pymetawear/exceptions.py

@@ -1,8 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
-exceptions
-----------
+Specific exceptions for PyMetaWear
 
 Created by hbldh <henrik.blidh@nedomkull.com> on 2016-03-30
 

pymetawear/modules/accelerometer.py

@@ -15,11 +15,9 @@
 
 import re
 import logging
-import time
 from ctypes import c_float
 
 from pymetawear import libmetawear
-from pymetawear.exceptions import PyMetaWearException
 from mbientlab.metawear.cbindings import AccBma255Odr, AccBmi160Odr, \
     AccBmi160StepCounterMode, AccBoschOrientationMode, AccBoschRange, \
     AccMma8452qOdr, AccMma8452qRange, Const