biosignal-device-interface 0.2.4__tar.gz → 0.2.6__tar.gz

biosignal_device_interface-0.2.6/.github/workflows/publish_pypi.yml

@@ -0,0 +1,29 @@
+name: Publish to PyPI
+
+on:
+  push:
+    branches:
+      - main  # Only trigger on the main branch
+
+jobs:
+  deploy:
+    name: Build and Publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Install Poetry
+        run: pip install poetry
+
+      - name: Authenticate PyPI
+        run: poetry config pypi-token.pypi "${{ secrets.PYPI_API_TOKEN }}"
+
+      - name: Publish to PyPI
+        run: poetry publish --build --no-interaction

biosignal_device_interface-0.2.6/.github/workflows/sphinx.yml

@@ -0,0 +1,38 @@
+name: publish-docs
+
+on:
+  push:
+    branches:
+    - main
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.10.14
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libegl1 libgl1
+        uv sync --group docs
+
+    - name: Build the docs
+      run: |
+        cd docs
+        uv run make html
+        cd ..
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/build/html

biosignal_device_interface-0.2.6/.gitignore

@@ -0,0 +1,165 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Visual Studio Code
+.vscode/

{biosignal_device_interface-0.2.4 → biosignal_device_interface-0.2.6}/PKG-INFO

@@ -1,25 +1,19 @@
 Metadata-Version: 2.4
 Name: biosignal-device-interface
-Version: 0.2.4
+Version: 0.2.6
 Summary: Python communication interface to many biosignal devices manufactured by several companies to easy integration in custom PySide6 applications.
+Author-email: "Dominik I. Braun" <dome.braun@fau.de>, "Raul C. Sîmpetru" <raul.simpetru@fau.de>
 License: GPL-3.0
 License-File: LICENSE
-Author: Dominik I. Braun
-Author-email: dome.braun@fau.de
-Requires-Python: >=3.10,<3.13
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: aenum (>=3.1.15,<4.0.0)
-Requires-Dist: matplotlib (>=3.9.0,<4.0.0)
-Requires-Dist: numpy (>=1.26.4,<2.0.0)
-Requires-Dist: psutil (>=5.9.8,<6.0.0)
-Requires-Dist: pyside6 (>=6.7.0,<7.0.0)
-Requires-Dist: scipy (>=1.14.0,<2.0.0)
-Requires-Dist: tornado (>=6.4.2,<7.0.0)
-Requires-Dist: vispy (>=0.14.3,<0.15.0)
+Requires-Python: <3.13,>=3.10
+Requires-Dist: aenum>=3.1.15
+Requires-Dist: matplotlib>=3.9.0
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: psutil>=5.9.8
+Requires-Dist: pyside6>=6.7.0
+Requires-Dist: scipy>=1.14.0
+Requires-Dist: tornado>=6.4.2
+Requires-Dist: vispy>=0.14.3
 Description-Content-Type: text/markdown
 
 # Biosignal-Device-Interface
@@ -134,4 +128,3 @@ Project Link: [https://github.com/NsquaredLab/Biosignal-Device-Interface](https:
 Note: The example scripts do not provide you with the same level of utility for GUI implementations.
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
-

{biosignal_device_interface-0.2.4 → biosignal_device_interface-0.2.6}/biosignal_device_interface/constants/devices/core/base_device_constants.py

@@ -21,6 +21,7 @@ class DeviceType(Enum):
     OTB_MUOVI = auto(), "OT Bioelettronica Muovi"
     OTB_MUOVI_PLUS = auto(), "OT Bioelettronica Muovi Plus"
     OTB_SYNCSTATION = auto(), "OT Bioelettronica SyncStation"
+    OTB_SESSANTAQUATTRO = auto(), "OT Bioelettronica Sessantaquattro"
 
 
 class OTBDeviceType(Enum):
@@ -36,6 +37,7 @@ class OTBDeviceType(Enum):
     MUOVI = auto(), "Muovi"
     MUOVI_PLUS = auto(), "Muovi Plus"
     SYNCSTATION = auto(), "SyncStation"
+    SESSANTAQUATTRO = auto(), "Sessantaquattro"
 
 
 class DeviceChannelTypes(Enum):
@@ -58,4 +60,6 @@ DEVICE_NAME_DICT: dict[DeviceType | OTBDeviceType, str] = {
     OTBDeviceType.MUOVI_PLUS: "Muovi Plus",
     DeviceType.OTB_SYNCSTATION: "SyncStation",
     OTBDeviceType.SYNCSTATION: "SyncStation",
+    DeviceType.OTB_SESSANTAQUATTRO: "Sessantaquattro",
+    OTBDeviceType.SESSANTAQUATTRO: "Sessantaquattro",
 }

biosignal_device_interface-0.2.6/biosignal_device_interface/constants/devices/otb/otb_sessantaquattro_constants.py

@@ -0,0 +1,227 @@
+"""
+Constants for the Sessantaquattro device.
+
+Developer: Dominik I. Braun
+Contact: dome.braun@fau.de
+Last Update: 2025-09-16
+"""
+
+from typing import Dict
+from aenum import Enum, auto
+
+from biosignal_device_interface.constants.devices.core.base_device_constants import (
+    DeviceChannelTypes,
+)
+
+
+class SessantaquattroSamplingFrequencyMode(Enum):
+    """Enum class for the sampling frequency of the Sessantaquattro device."""
+
+    _init_ = "value __doc__"
+
+    NONE = 0, "No sampling frequency set."
+    LOW = auto(), "500 Hz (2000 Hz - Accelerometer)"
+    MEDIUM = auto(), "1000 Hz (4000 Hz - Accelerometer)"
+    HIGH = auto(), "2000 Hz (8000 Hz - Accelerometer)"
+    ULTRA = auto(), "4000 Hz (16000 Hz - Accelerometer)"
+
+
+class SessantaquattroDetectionMode(Enum):
+    """
+    Enum class for the working mode of the Sessantaquattro device.
+    """
+
+    _init_ = "value __doc__"
+
+    NONE = 0, "No working mode set."
+    MONOPOLAR = auto(), ("Monopolar Mode")
+    BIPOLAR = auto(), ("Bipolar Mode")
+    DIFFERENTIAL = auto(), ("Differential Mode")
+    ACCELEROMETER = auto(), ("Accelerometer Mode")
+    UNDEFINED = auto(), ("Undefined Mode")
+    IMPEDANCE_ADVANCED = auto(), ("Impedance Check Advanced")
+    IMPEDANCE = auto(), ("Impedance Check")
+    TEST = auto(), ("Test Mode")
+
+
+class SessantaquattroChannelMode(Enum):
+    """
+    Enum class for the channel mode of the Sessantaquattro device.
+    """
+
+    _init_ = "value __doc__"
+
+    NONE = 0, "No channel mode set."
+    LOW = auto(), (
+        "8 bioelec. + 2 AUX + 2 accessory (if MODE=001: 4 bio + 2 AUX + 2 acc)"
+    )
+    MEDIUM = auto(), (
+        "16 bioelec. + 2 AUX + 2 accessory (if MODE=001: 8 bio + 2 AUX + 2 acc)"
+    )
+    HIGH = auto(), (
+        "32 bioelec. + 2 AUX + 2 accessory (if MODE=001: 16 bio + 2 AUX + 2 acc)"
+    )
+    ULTRA = auto(), (
+        "64 bioelec. + 2 AUX + 2 accessory (if MODE=001: 32 bio + 2 AUX + 2 acc)"
+    )
+
+
+class SessantaquattroResolutionMode(Enum):
+    """
+    Enum class for the resolution mode of the Sessantaquattro device.
+    """
+
+    _init_ = "value __doc__"
+
+    NONE = 0, "No resolution mode set."
+    LOW = auto(), ("16 Bits Resolution")
+    HIGH = auto(), ("24 Bits Resolution")
+
+
+class SessantaquattroGainMode(Enum):
+    """
+    Enum class for the gain mode of the Sessantaquattro device.
+    """
+
+    _init_ = "value __doc__"
+
+    NONE = 0, "No gain mode set."
+    DEFAULT = auto(), (
+        "Gain x2 (for 24 bits resolution) / Gain x8 (for 16 bits resolution)"
+    )
+    LOW = auto(), ("Gain x4")
+    MEDIUM = auto(), ("Gain x6")
+    HIGH = auto(), ("Gain x8")
+
+
+class SessantaquattroTriggerMode(Enum):
+    """
+    Enum class for the trigger mode of the Sessantaquattro device.
+    """
+
+    _init_ = "value __doc__"
+
+    NONE = 0, "No trigger mode set."
+    DEFAULT = auto(), (
+        "The data transfer is controlled from GO/STOP bit, REC has no effect."
+    )
+    INTERNAL = auto(), (
+        "The data transfer ist triggered by the internal signal (phototransistor)"
+    )
+    EXTERNAL = auto(), (
+        "The data transfer is triggered by the external signal (from the adapter)"
+    )
+    SDCARD = auto(), (
+        "SDCARD: SD card acquisition starts/stops with the hardware button or with the REC bit."
+    )
+
+
+class SessantaquattroRecordingMode(Enum):
+    """
+    Enum class for the recording mode of the Sessantaquattro device.
+    """
+
+    _init_ = "value __doc__"
+
+    NONE = 0, "No recording mode set."
+    STOP = auto(), ("Stop the recording. Works only if TRIG = 3 (SDCARD).")
+    START = auto(), ("Start the recording. Works only if TRIG = 3 (SDCARD).")
+
+
+def _get_sampling_frequency(
+    detection_mode: SessantaquattroDetectionMode,
+    sampling_freq_mode: SessantaquattroSamplingFrequencyMode,
+) -> int:
+    """Get sampling frequency for given detection and sampling frequency modes."""
+    if detection_mode == SessantaquattroDetectionMode.ACCELEROMETER:
+        base_freq = 2000
+    else:
+        base_freq = 500
+
+    multiplier = 2 ** (sampling_freq_mode.value - 1)
+    return base_freq * multiplier
+
+
+def _get_biosignal_channel_count(
+    sampling_freq_mode: SessantaquattroSamplingFrequencyMode,
+    detection_mode: SessantaquattroDetectionMode,
+) -> int:
+    """Get biosignal channel count for given modes."""
+    base_channels = 8 * (2 ** (sampling_freq_mode.value - 1))
+
+    # Bipolar mode has half the channels
+    if detection_mode == SessantaquattroDetectionMode.BIPOLAR:
+        return base_channels // 2
+
+    return base_channels
+
+
+# Generate dictionaries using functions
+SESSANTAQUATTRO_DETECTION_MODE_CHARACTERISTICS_DICT: Dict[
+    SessantaquattroDetectionMode, Dict[SessantaquattroSamplingFrequencyMode, int]
+] = {
+    detection_mode: {
+        sampling_freq: _get_sampling_frequency(detection_mode, sampling_freq)
+        for sampling_freq in SessantaquattroSamplingFrequencyMode
+        if sampling_freq != SessantaquattroSamplingFrequencyMode.NONE
+    }
+    for detection_mode in SessantaquattroDetectionMode
+    if detection_mode != SessantaquattroDetectionMode.NONE
+}
+
+SESSANTAQUATTRO_CHANNEL_MODE_CHARACTERISTICS_DICT: Dict[
+    SessantaquattroSamplingFrequencyMode,
+    Dict[SessantaquattroDetectionMode, Dict[DeviceChannelTypes, int]],
+] = {
+    sampling_freq: {
+        detection_mode: {
+            DeviceChannelTypes.BIOSIGNAL: _get_biosignal_channel_count(
+                sampling_freq, detection_mode
+            ),
+            DeviceChannelTypes.AUXILIARY: 4,
+        }
+        for detection_mode in SessantaquattroDetectionMode
+        if detection_mode != SessantaquattroDetectionMode.NONE
+    }
+    for sampling_freq in SessantaquattroSamplingFrequencyMode
+    if sampling_freq != SessantaquattroSamplingFrequencyMode.NONE
+}
+
+SESSANTAQUATTRO_GAIN_MODE_CHARACTERISTICS_DICT: Dict[
+    SessantaquattroResolutionMode, Dict[SessantaquattroGainMode, float]
+] = {
+    SessantaquattroResolutionMode.LOW: {
+        SessantaquattroGainMode.DEFAULT: 286.1e-6,  # Gain8, 16-bit (in mV, originally 286.1 nV)
+        SessantaquattroGainMode.LOW: 572.2e-6,  # Gain4, 16-bit (in mV, originally 572.2 nV)
+        SessantaquattroGainMode.MEDIUM: 381.5e-6,  # Gain6, 16-bit (in mV, originally 381.5 nV)
+        SessantaquattroGainMode.HIGH: 286.1e-6,  # Gain8, 16-bit (in mV, originally 286.1 nV)
+    },
+    SessantaquattroResolutionMode.HIGH: {
+        SessantaquattroGainMode.DEFAULT: 71.5e-6,  # Gain8, 24-bit (in mV, originally 71.5 nV)
+        SessantaquattroGainMode.LOW: 143.0e-6,  # Gain4, 24-bit (in mV, originally 143.0 nV)
+        SessantaquattroGainMode.MEDIUM: 95.4e-6,  # Gain6, 24-bit (in mV, originally 95.4 nV)
+        SessantaquattroGainMode.HIGH: 71.5e-6,  # Gain8, 24-bit (in mV, originally 71.5 nV)
+    },
+}
+
+SESSANTAQUATTRO_AUXILIARY_LSB_DICT: Dict[SessantaquattroResolutionMode, float] = {
+    SessantaquattroResolutionMode.LOW: 146.48e-6,  # in mV (originally 146.48 nV)
+    SessantaquattroResolutionMode.HIGH: 572.2e-6,  # in mV (originally 572.2 nV)
+}
+
+SESSANTAQUATTRO_SAMPLES_PER_FRAME_DICT: Dict[SessantaquattroChannelMode, int] = {
+    SessantaquattroChannelMode.LOW: 48,
+    SessantaquattroChannelMode.MEDIUM: 28,
+    SessantaquattroChannelMode.HIGH: 16,
+    SessantaquattroChannelMode.ULTRA: 8,
+}
+
+if __name__ == "__main__":
+    # Print the generated dictionaries for verification
+    import pprint
+
+    print("Sessantaquattro Detection Mode Characteristics Dictionary:")
+    pprint.pprint(SESSANTAQUATTRO_DETECTION_MODE_CHARACTERISTICS_DICT)
+
+    print("\nSessantaquattro Channel Mode Characteristics Dictionary:")
+    pprint.pprint(SESSANTAQUATTRO_CHANNEL_MODE_CHARACTERISTICS_DICT)

{biosignal_device_interface-0.2.4 → biosignal_device_interface-0.2.6}/biosignal_device_interface/devices/__init__.py

@@ -5,9 +5,11 @@ from biosignal_device_interface.devices.otb import (
     OTBMuoviWidget,
     OTBMuoviPlusWidget,
     OTBQuattrocentoLightWidget,
+    OTBSessantaquattroWidget,
     OTBMuovi,
     OTBQuattrocento,
     OTBQuattrocentoLight,
+    OTBSessantaquattro,
     OTBSyncStationWidget,
     OTBDevicesWidget,
 )

{biosignal_device_interface-0.2.4 → biosignal_device_interface-0.2.6}/biosignal_device_interface/devices/otb/__init__.py

@@ -4,6 +4,9 @@ from biosignal_device_interface.devices.otb.otb_quattrocento_light import (
 )
 from biosignal_device_interface.devices.otb.otb_muovi import OTBMuovi
 from biosignal_device_interface.devices.otb.otb_syncstation import OTBSyncStation
+from biosignal_device_interface.devices.otb.otb_sessantaquattro import (
+    OTBSessantaquattro,
+)
 
 # Widgets
 # All OTB Devices Widget
@@ -27,3 +30,6 @@ from biosignal_device_interface.gui.device_template_widgets.otb.otb_quattrocento
 from biosignal_device_interface.gui.device_template_widgets.otb.otb_syncstation_widget import (
     OTBSyncStationWidget,
 )
+from biosignal_device_interface.gui.device_template_widgets.otb.otb_sessantaquattro_widget import (
+    OTBSessantaquattroWidget,
+)

{biosignal_device_interface-0.2.4 → biosignal_device_interface-0.2.6}/biosignal_device_interface/devices/otb/otb_muovi.py

@@ -212,6 +212,7 @@ class OTBMuovi(BaseDevice):
     def clear_socket(self) -> None:
         if self._client_socket is not None:
             self._client_socket.readAll()
+            self._received_bytes = bytearray()
 
     def _read_data(self) -> None:
         super()._read_data()

{biosignal_device_interface-0.2.4 → biosignal_device_interface-0.2.6}/biosignal_device_interface/devices/otb/otb_quattrocento.py

@@ -57,7 +57,7 @@ class OTBQuattrocento(BaseDevice):
 
         # Device Information
         self._conversion_factor_biosignal: float = 5 / (2**16) / 150 * 1000  # in mV
-        self._conversion_factor_auxiliary: float = 5 / (2**16) / 0.5  # in mV
+        self._conversion_factor_auxiliary: float = 5 / (2**16) / 0.5  # in V
         self._number_of_streamed_channels: int = None
 
         # Connection Parameters

{biosignal_device_interface-0.2.4 → biosignal_device_interface-0.2.6}/biosignal_device_interface/devices/otb/otb_quattrocento_light.py

@@ -60,7 +60,7 @@ class OTBQuattrocentoLight(BaseDevice):
         self._auxiliary_channel_start_index: int = 384  # Fix value
         self._number_of_auxiliary_channels: int = 16  # Fix value
         self._conversion_factor_biosignal: float = 5 / (2**16) / 150 * 1000  # in mV
-        self._conversion_factor_auxiliary: float = 5 / (2**16) / 0.5  # in mV
+        self._conversion_factor_auxiliary: float = 5 / (2**16) / 0.5  # in V
         self._bytes_per_sample: int = 2  # Fix value
         # Quattrocento unique parameters
         self._streaming_frequency: int | None = None