explorepy 4.3.0__tar.gz → 4.3.1__tar.gz

{explorepy-4.3.0 → explorepy-4.3.1}/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 4.3.0
+current_version = 4.3.1
 commit = False
 tag = False
 

{explorepy-4.3.0 → explorepy-4.3.1}/CHANGELOG.rst

@@ -2,6 +2,12 @@
 Changelog
 =========
 
+4.3.1 (17.9.2025)
+------------------
+* Bugfix for 32 channel impedance recording
+* Bugfix for BLE connection drop
+* Update binary converter
+
 4.3.0 (10.9.2025)
 ------------------
 * Live impedance acquisition and recording

{explorepy-4.3.0 → explorepy-4.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: explorepy
-Version: 4.3.0
+Version: 4.3.1
 Author-email: MentaLab Hub <support@mentab.org>
 License: MIT
 Project-URL: Homepage, https://github.com/Mentalab-hub/explorepy
@@ -62,9 +62,9 @@ Dynamic: license-file
     :target: https://pypi.org/project/explorepy
 
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/Mentalab-hub/explorepy/v4.3.0.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/Mentalab-hub/explorepy/v4.3.1.svg
     :alt: Commits since latest release
-    :target: https://github.com/Mentalab-hub/explorepy/compare/v4.3.0...master
+    :target: https://github.com/Mentalab-hub/explorepy/compare/v4.3.1...master
 
 
 .. |wheel| image:: https://img.shields.io/pypi/wheel/explorepy.svg

{explorepy-4.3.0 → explorepy-4.3.1}/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/v4.3.0.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/Mentalab-hub/explorepy/v4.3.1.svg
     :alt: Commits since latest release
-    :target: https://github.com/Mentalab-hub/explorepy/compare/v4.3.0...master
+    :target: https://github.com/Mentalab-hub/explorepy/compare/v4.3.1...master
 
 
 .. |wheel| image:: https://img.shields.io/pypi/wheel/explorepy.svg

{explorepy-4.3.0 → explorepy-4.3.1}/docs/conf.py

@@ -28,7 +28,7 @@ project = 'explorepy'
 year = '2018-2025'
 author = 'Mentalab GmbH.'
 copyright = '{0}, {1}'.format(year, author)
-version = release = '4.3.0'
+version = release = '4.3.1'
 pygments_style = 'trac'
 templates_path = ['.']
 extlinks = {

{explorepy-4.3.0 → explorepy-4.3.1}/docs/usage.rst

@@ -55,7 +55,7 @@ Connects to a device and records ExG and orientation data into two separate file
       -d, --duration <integer>        Recording duration in seconds
       --edf                           Write in EDF file
       --csv                           Write in csv file (default type)
-      --imp-mode                      Enable impedance mode with live monitoring
+      --imp-mode                      Enable impedance mode with real-time monitoring (CSV only)
       -h, --help                      Show this message and exit.
 
 
@@ -222,14 +222,13 @@ Recording
 You can record data in realtime to EDF (BDF+) or CSV files using:
 ::
     explore.record_data(file_name='test', duration=120, file_type='csv')
+This will record data in three separate files: "``test_ExG.csv``", "``test_ORN.csv``" and "``test_marker.csv``", which contain ExG data, orientation data (accelerometer, gyroscope, magnetometer) and event markers respectively. It is also possible to add arguments to overwrite files.
 
-To also record impedance data, use:
+Enable imp_mode argument to record impedance data as well:
 ::
     explore.record_data(file_name='test', duration=120, file_type='csv', imp_mode=True)
 
-This will record data in three separate files: "``test_ExG.csv``", "``test_ORN.csv``" and "``test_marker.csv``", which contain ExG data, orientation data (accelerometer, gyroscope, magnetometer) and event markers respectively. Add command arguments to overwrite files and set the duration of the recording (in seconds).
-::
-    explore.record_data(file_name='test', do_overwrite=True, file_type='csv', duration=120)
+.. note:: Impedance recording is only supported for CSV files!
 
 .. note:: To load EDF files, you can use `pyedflib <https://github.com/holgern/pyedflib>`_ or `mne <https://github.com/mne-tools/mne-python>`_ (for mne, you may need to change the file extension to ``bdf`` manually) in Python.
 

{explorepy-4.3.0 → explorepy-4.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend   = 'setuptools.build_meta'
 
 [project]
 name    = 'explorepy'
-version = "4.3.0"
+version = "4.3.1"
 license = { text = "MIT" }
 readme = { file = "README.rst", content-type = "text/markdown" }
 authors = [

{explorepy-4.3.0 → explorepy-4.3.1}/src/explorepy/__init__.py

@@ -20,7 +20,7 @@ from .explore import Explore  # noqa
 
 
 __all__ = ["Explore", "command", "tools", "log_config"]
-__version__ = '4.3.0'
+__version__ = '4.3.1'
 
 this = sys.modules[__name__]
 # TODO appropriate library

{explorepy-4.3.0 → explorepy-4.3.1}/src/explorepy/cli.py

@@ -76,7 +76,7 @@ def acquire(name, address, duration):
 @click.option("--edf", 'file_type', flag_value='edf', help="Write in EDF file")
 @click.option("--csv", 'file_type', flag_value='csv', help="Write in csv file (default type)", default=True)
 @click.option("--imp-mode", is_flag=True, help="Enable impedance mode with live monitoring")
-@click.option("-nf", "--notch-freq", help="Notch frequency for impedance mode initialization", type=float, default=50.0)
+@click.option("-nf", "--notch-freq", help="Notch frequency for impedance mode initialization", type=float, default=None)
 @verify_inputs
 def record_data(address, name, filename, overwrite, duration, file_type, imp_mode, notch_freq):
     """Record data from Explore to a file"""

{explorepy-4.3.0 → explorepy-4.3.1}/src/explorepy/explore.py

@@ -37,6 +37,7 @@ from explorepy.stream_processor import (
     StreamProcessor
 )
 from explorepy.tools import (
+    EXG_CHANNELS,
     LslServer,
     check_bin_compatibility,
     create_exg_recorder,
@@ -159,7 +160,7 @@ class Explore:
 
     def record_data(
         self, file_name, do_overwrite=False, duration=None, file_type='csv', block=False, exg_ch_names=None,
-        imp_mode=False, notch_freq=50.0
+        imp_mode=False, notch_freq=None
     ):
         r"""Records the data in real-time
 
@@ -170,7 +171,7 @@ class Explore:
             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.
-            imp_mode (bool): Enable impedance mode with live monitoring
+            imp_mode (bool): Enable impedance mode with live monitoring(only for CSV files)
             notch_freq (float): Notch frequency for impedance mode initialization
         """
         self._check_connection()
@@ -181,6 +182,14 @@ class Explore:
         if file_type not in ['edf', 'csv']:
             raise ValueError(
                 '{} is not a supported file extension!'.format(file_type))
+        if imp_mode:
+            if file_type == 'edf':
+                raise ValueError(
+                    '{} is not a supported file extension for recording impedance!'.format(file_type))
+            if notch_freq is None:
+                raise ValueError(
+                    'Missing notch frequency argument, please provide the notch frequency to get live impedance values')
+
         duration = self._check_duration(duration)
 
         exg_out_file = file_name + "_ExG"
@@ -223,7 +232,14 @@ class Explore:
             if imp_mode:
                 self.recorders['imp_csv_file'] = open(f"{impedance_out_file}.csv", 'w', newline='\n')
                 self.recorders['imp_csv_writer'] = csv.writer(self.recorders['imp_csv_file'], delimiter=",")
-                self.recorders['imp_csv_writer'].writerow(['TimeStamp'] + [f"imp_ch{i}" for i in range(1, 9)])
+                self.recorders['imp_csv_writer'].writerow(
+                    ['TimeStamp'] + (
+                        exg_ch_names
+                        if exg_ch_names is not None
+                        else [EXG_CHANNELS[i] for i, flag in enumerate(reversed(SettingsManager(
+                            self.device_name).get_adc_mask())) if flag == 1]
+                    )
+                )
 
         elif file_type == 'edf':
             self.recorders['marker'] = self.recorders['exg']
@@ -247,7 +263,7 @@ class Explore:
                 print("Impedance:", real_values.tolist())
 
                 if file_type == 'csv':
-                    row_data = [packet.timestamp, *real_values]
+                    row_data = [float(packet.timestamp), *real_values]
                     self.recorders['imp_csv_writer'].writerow(row_data)
 
             self.recorders['handle_exg_impedance_callback'] = handle_exg_impedance_packet

{explorepy-4.3.0 → explorepy-4.3.1}/src/explorepy/parser.py

@@ -221,11 +221,9 @@ class Parser:
             try:
                 bytes_out = binascii.hexlify(bytearray(self.stream_interface.read(1)))
             except TypeError:
-                if is_usb_mode():
-                    self.stop_streaming()
-                    break
-                logger.info('No data in interface, seeking again.....')
-                continue
+                logger.info('TypeError when seeking end of packet, disconnecting..')
+                self.stop_streaming()
+                break
             if bytes_out == b'af' and binascii.hexlify(bytearray(self.stream_interface.read(3))) == b'beadde':
                 self.seek_new_pid.clear()
                 break
@@ -293,7 +291,6 @@ class Parser:
                 payload_start = time.time()
                 payload_start_idx = header_start + self.header_len
                 payload_end = payload_start_idx + payload_length - self.data_len
-                payload_end = payload_start_idx + payload_length - 4
                 if payload_end > len(buffer):
                     continue
                 payload_data = buffer[payload_start_idx:payload_end]
@@ -311,7 +308,8 @@ class Parser:
         num_threads = multiprocessing.cpu_count()
         try:
             # Time: File reading
-            buffer = bytearray(self.stream_interface.read())
+            first_header = self.get_header_bytes()
+            buffer = first_header + bytearray(self.stream_interface.read())
             # Time: Finding markers
             arr = np.frombuffer(buffer, dtype=np.uint8)
             marker_arr = np.frombuffer(PACKET_MARKER, dtype=np.uint8)

{explorepy-4.3.0 → explorepy-4.3.1}/src/explorepy/tools.py

@@ -3,6 +3,7 @@
 import csv
 import datetime
 import logging
+import math
 import os.path
 import socket
 from contextlib import closing
@@ -427,7 +428,7 @@ class FileRecorder:
                     logger.debug('Value error on file write: {}'.format(e))
             else:
                 data = self._process_batch_csv(packet)
-                np.savetxt(self._file_obj, data.T, fmt='%4f', delimiter=',')
+                np.savetxt(self._file_obj, data.T, fmt='%.12g', delimiter=',')
 
 
 class LslServer:
@@ -670,6 +671,7 @@ def compare_recover_from_bin(file_name_csv, file_name_device):
     timestamp_key = 'TimeStamp'
     sampling_rate = meta_df['sr'][0]
     offset_ = meta_df["TimeOffset"][0]
+    offset_ = 0 if math.isnan(offset_) else offset_
     offset_ = round(offset_, 4)
     time_period = 1 / sampling_rate
 
@@ -701,7 +703,7 @@ def setup_usb_marker_port():
 def check_bin_compatibility(file_name):
     with open(file_name, "rb") as f:
         b = f.read(1).hex()
-        if b != "62":
+        if b != "62" and b != "63":
             raise ExplorePyDeprecationError()
 
 

{explorepy-4.3.0 → explorepy-4.3.1}/src/explorepy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: explorepy
-Version: 4.3.0
+Version: 4.3.1
 Author-email: MentaLab Hub <support@mentab.org>
 License: MIT
 Project-URL: Homepage, https://github.com/Mentalab-hub/explorepy
@@ -62,9 +62,9 @@ Dynamic: license-file
     :target: https://pypi.org/project/explorepy
 
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/Mentalab-hub/explorepy/v4.3.0.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/Mentalab-hub/explorepy/v4.3.1.svg
     :alt: Commits since latest release
-    :target: https://github.com/Mentalab-hub/explorepy/compare/v4.3.0...master
+    :target: https://github.com/Mentalab-hub/explorepy/compare/v4.3.1...master
 
 
 .. |wheel| image:: https://img.shields.io/pypi/wheel/explorepy.svg