Merge branch 'develop'

Author: salman2135

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.8.1
+current_version = 1.8.2
 commit = False
 tag = False
 

.readthedocs.yaml

@@ -0,0 +1,64 @@
+# Read the Docs configuration file for Sphinx projects
+
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+
+# Required
+
+version: 2
+
+
+# Set the OS, Python version and other tools you might need
+
+build:
+
+  os: ubuntu-22.04
+
+  tools:
+
+    python: "3.11"
+
+    # You can also specify other tool versions:
+
+    # nodejs: "20"
+
+    # rust: "1.70"
+
+    # golang: "1.20"
+
+
+# Build documentation in the "docs/" directory with Sphinx
+
+sphinx:
+
+  configuration: docs/conf.py
+
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+
+  # builder: "dirhtml"
+
+  # Fail on all warnings to avoid broken references
+
+  # fail_on_warning: true
+
+
+# Optionally build your docs in additional formats such as PDF and ePub
+
+# formats:
+
+#    - pdf
+
+#    - epub
+
+
+# Optional but recommended, declare the Python requirements required
+
+# to build your documentation
+
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+
+python:
+
+   install:
+
+   - requirements: docs/requirements.txt

README.rst

@@ -17,9 +17,9 @@
     :target: https://pypi.org/project/explorepy
 
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/Mentalab-hub/explorepy/v1.8.1.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/Mentalab-hub/explorepy/v1.8.2.svg
     :alt: Commits since latest release
-    :target: https://github.com/Mentalab-hub/explorepy/compare/v1.8.1...master
+    :target: https://github.com/Mentalab-hub/explorepy/compare/v1.8.2...master
 
 
 .. |wheel| image:: https://img.shields.io/pypi/wheel/explorepy.svg

docs/conf.py

@@ -29,7 +29,7 @@
 year = '2018-2022'
 author = 'Mentalab GmbH.'
 copyright = '{0}, {1}'.format(year, author)
-version = release = '1.8.1'
+version = release = '1.8.2'
 
 pygments_style = 'trac'
 templates_path = ['.']

docs/requirements.txt

@@ -1,4 +1,14 @@
-sphinx>=1.3
-sphinx-rtd-theme
--e .
-sphinxcontrib-napoleon
+appdirs==1.4.3
+bokeh==2.2.3
+click==7.1.2
+Jinja2==3.0.0
+mne==0.24.1
+numpy==1.24.4
+pandas==1.3.4
+pyEDFlib==0.1.34
+pylsl==1.16.1
+PyYAML==6.0.1
+PyYAML==6.0.1
+scipy==1.11.1
+sentry_sdk==1.19.1
+tornado==6.3.2

installer/windows/installer.cfg

@@ -1,12 +1,12 @@
 [Application]
 name=MentaLab ExplorePy
-version=1.8.1
+version=1.8.2
 entry_point=explorepy.cli:cli
 console=true
 icon=mentalab.ico
 
 [Python]
-version=3.8.0
+version=3.9.0
 bitness=64
 
 
@@ -16,49 +16,54 @@ entry_point=explorepy.cli:cli
 
 [Include]
 pypi_wheels =
-    #explorepy==1.8.1
     appdirs==1.4.3
-#   bokeh==2.2.3 # No wheel available
-    certifi==2020.12.5
+    certifi==2023.7.22
+    charset-normalizer==3.2.0
     click==7.1.2
     colorama==0.4.6
-    contourpy==1.0.7
+    contourpy==1.1.0
     cycler==0.11.0
     decorator==5.1.1
-    eeglabio==0.0.2.post3
-    fonttools==4.38.0
+    distlib==0.3.7
+    eeglabio==0.0.2.post4
+    fonttools==4.42.1
     idna==3.4
+    importlib-resources==6.0.1
     Jinja2==3.0.0
-    kiwisolver==1.4.4
-    MarkupSafe==2.1.2
-    matplotlib==3.6.3
-    mne==1.3.0
-    numpy==1.21.4
-    packaging==23.0
-    pandas==1.5.3
-    Pillow==9.4.0
-    pipdeptree==2.3.3
-    pooch==1.6.0
-    pyEDFlib==0.1.25
-    pylsl==1.16.0
+    kiwisolver==1.4.5
+    MarkupSafe==2.1.3
+    matplotlib==3.7.2
+    mne==1.5.0
+    numpy==1.25.2
+    packaging==23.1
+    pandas==2.0.3
+    Pillow==10.0.0
+    pipdeptree==2.13.0
+    platformdirs==3.10.0
+    pooch==1.7.0
+    pyEDFlib==0.1.34
+    pylsl==1.16.1
+    pynsist==2.8
     pyparsing==3.0.9
     python-dateutil==2.8.2
-    pytz==2022.7.1
-    PyYAML==6.0
-    requests==2.28.2
-    scipy==1.10.0
-    sentry-sdk==1.0.0
+    pytz==2023.3
+    PyYAML==6.0.1
+    requests==2.31.0
+    requests_download==0.1.2
+    scipy==1.11.2
+    sentry-sdk==1.19.1
     six==1.16.0
-    tornado==6.2
-    tqdm==4.64.1
-    typing_extensions==4.4.0
-    urllib3==1.26.14
-    wincertstore==0.2
-    setuptools==67.1.0
+    tornado==6.3.3
+    tqdm==4.66.1
+    typing_extensions==4.7.1
+    tzdata==2023.3
+    urllib3==2.0.4
+    yarg==0.1.9
+    zipp==3.16.2
 
 local_wheels =
     local-wheels/bokeh-2.2.3-py3-none-any.whl
-    local-wheels/explorepy-1.8.0-cp38-cp38-win_amd64.whl
+    local-wheels/explorepy-1.8.2-cp39-cp39-win_amd64.whl
 
 # Other files and folders that should be installed
 files = ../../licenses

lib/windows/ex.py

@@ -0,0 +1,8 @@
+import explorepy
+from explorepy.stream_processor import TOPICS
+exp_device = explorepy.Explore()
+
+# Connect to the Explore device using device bluetooth name or mac address
+exp_device.connect('Explore_8531')
+exp_device.set_channels(channel_mask="00110011001100110011001100110011")
+exp_device.record_data( 'file_name', do_overwrite=True, duration=15, file_type='csv')

setup.py

@@ -82,7 +82,7 @@ def read(*names, **kwargs):
         os.system('cp  lib/mac/exploresdk.py  src/explorepy')
 setup(
     name='explorepy',
-    version='1.8.1',
+    version='1.8.2',
     license='MIT license',
     description='Python API for Mentalab biosignal aquisition devices',
     long_description_content_type="text/markdown",
@@ -112,6 +112,7 @@ def read(*names, **kwargs):
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
         'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
         'Topic :: Education',
         'Topic :: Scientific/Engineering :: Medical Science Apps.',
         'Topic :: Scientific/Engineering :: Visualization'

src/explorepy/__init__.py

@@ -22,7 +22,7 @@
 
 
 __all__ = ["Explore", "Dashboard", "command", "exploresdk", "tools", "log_config"]
-__version__ = '1.8.1'
+__version__ = '1.8.2'
 
 this = sys.modules[__name__]
 this._bt_interface = 'sdk'

src/explorepy/bt_mock_client.py

@@ -28,7 +28,7 @@ def __init__(self, device_name=None, mac_address=None):
             raise InputError("Either name or address options must be provided!")
         self.is_connected = False
         self.mac_address = 'ABCD_EFGH_IJKL_MNOP'  # dummy name as MAC address
-        self.device_name = 'Explore_Mock_Device'  # dummy name, can be changed
+        self.device_name = device_name
         self.bt_serial_port_manager = None
         self.device_manager = None
 

src/explorepy/bt_mock_server.py

@@ -28,6 +28,11 @@ class MockBtServer:
     CMD_STATUS_PID = b'\xC1'
     CMD_STATUS_PAYLOAD_LENGTH = b'\x0E\x00'
 
+    CALIB_INFO_PID = b'\xC5'
+    CALIB_INFO_PAYLOAD_LENGTH = b'\x0C\x00'
+    CALIB_INFO_SLOPE = b'\xCF\x5A'
+    CALIB_INFO_OFFSET = b'\xCE\x28'
+
     FLETCHER = b'\xAF\xBE\xAD\xDE'
 
     def __init__(self):
@@ -157,6 +162,19 @@ def generate_dev_info_v2_packet(self):
         dev_info += self.FLETCHER
         return dev_info
 
+    def generate_calibration_info(self):
+        """
+        Generates a calibration info packet that includes slope and offset for impedance measurement.
+        """
+        calib_info = self.CALIB_INFO_PID
+        calib_info += b'\x00'
+        calib_info += self.CALIB_INFO_PAYLOAD_LENGTH
+        calib_info += self.timestamp.to_bytes(4, byteorder='little')
+        calib_info += self.CALIB_INFO_SLOPE
+        calib_info += self.CALIB_INFO_OFFSET
+        calib_info += self.FLETCHER
+        return calib_info
+
     def generate_cmd_rcv(self, cmd_pid, cmd_ts):
         """
         Generates a command received packet based on command opcode (pid) and timestamp received.
@@ -169,7 +187,7 @@ def generate_cmd_rcv(self, cmd_pid, cmd_ts):
             self.counter.to_bytes(1, byteorder='little') + \
             self.CMD_RCV_PAYLOAD_LENGTH + \
             self.timestamp.to_bytes(4, byteorder='little')
-        cmd_rcv += cmd_pid
+        cmd_rcv += cmd_pid.to_bytes(1, byteorder='little')
         cmd_rcv += cmd_ts
         cmd_rcv += self.FLETCHER
         return cmd_rcv
@@ -187,7 +205,7 @@ def generate_cmd_status(self, cmd_pid, cmd_ts):
             self.counter.to_bytes(1, byteorder='little') + \
             self.CMD_STATUS_PAYLOAD_LENGTH + \
             self.timestamp.to_bytes(4, byteorder='little')
-        cmd_status += cmd_pid
+        cmd_status += cmd_pid.to_bytes(1, byteorder='little')
         cmd_status += cmd_ts
         cmd_status += b'\x01'  # Can't find list of possible status messages, have only found b'\x01' in streams
         cmd_status += self.FLETCHER
@@ -204,7 +222,11 @@ def generate_command_packets(self, cmd_pid, cmd_ts):
         """
         cmd = self.generate_cmd_rcv(cmd_pid, cmd_ts)
         self.counter = 0
-        cmd += self.generate_dev_info_v2_packet()
+        if cmd_pid == 167:
+            # Generate calibration info packet if received PID corresponds to impedance mode activation
+            cmd += self.generate_calibration_info()
+        else:
+            cmd += self.generate_dev_info_v2_packet()
         cmd += self.generate_cmd_status(cmd_pid, cmd_ts)
         self.counter = 1
         # Counter behaviour taken from a stream, is 0 for dev-info and cmd-status and then starts counting up again
@@ -262,7 +284,6 @@ def Read(self, length):
         Returns:
             A list of bytes
         """
-
         if len(self.buffer) <= length:
             self.buffer += self.generate_packet_buffer()
 
@@ -286,9 +307,12 @@ def process_incoming_data(self, data):
         pid = data[0]
         if pid == 160 or pid == 176:
             # 160 == Command(API2BCMD), 176 == Command(API2BCMD), 27 = TS (TS is sent at the start)
-            ts = data[4:7]
+            # cnt = data[1]
+            # payload_length = data[2:4]
+            ts = data[4:8]
             opcode = data[8]
             param = data[9]
+            # fletcher = data[10:]
             if opcode == 161:
                 # set sampling rate
                 self.exg_sr = self.cmd_sr_to_sr(param)

src/explorepy/explore.py

@@ -143,7 +143,7 @@ def record_data(
         Args:
             file_name (str): Output file name
             do_overwrite (bool): Overwrite if files exist already
-            duration (float): Duration of recording in seconds (if None records endlessly).
+            duration (float): Duration of recording in seconds (if None records for 3 hours).
             file_type (str): File type of the recorded file. Supported file types: 'csv', 'edf'
             block (bool): Record in blocking mode if 'block' is True
             exg_ch_names (list): list of channel names. If None, default names are used.
@@ -587,3 +587,12 @@ def _check_duration(duration):
             logger.warning("Duration has not been set by the user. The duration is 3 hours by default.")
             duration = 3 * 60 * 60  # 3 hours
         return duration
+
+    def is_explore_plus_device(self):
+        return True if 'board_id' in self.stream_processor.device_info.keys() else False
+
+    def is_bt_link_unstable(self):
+        if not self.stream_processor:
+            return False
+        else:
+            return self.stream_processor.is_connection_unstable()