biosignal-device-interface 0.2.3__tar.gz → 0.2.5__tar.gz

biosignal_device_interface-0.2.5/.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.5/.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.5/.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.5/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: biosignal-device-interface
+Version: 0.2.5
+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
+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
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/NsquaredLab/Biosignal-Device-Interface">
+    <img src="images/logo.png" alt="Logo" width="80" height="80">
+  </a>
+
+<h3 align="center">Biosignal Device Interface</h3>
+
+  <p align="center">
+    Python communication interface to many biosignal devices manufactured by several companies for easy integration in custom PySide6 applications.
+    <br />
+    <a href="https://nsquaredlab.github.io/Biosignal-Device-Interface/"><strong>Explore the docs »</strong></a>
+  </p>
+
+[![PyPI version](https://img.shields.io/pypi/v/biosignal-device-interface.svg)](https://pypi.org/project/biosignal-device-interface/)
+[![Python versions](https://img.shields.io/pypi/pyversions/biosignal-device-interface.svg)](https://pypi.org/project/biosignal-device-interface/)
+[![License](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](LICENSE)
+
+</div>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li><a href="#about-the-project">About The Project</a></li>
+    <li><a href="#supported-devices">Supported Devices</a></li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#installation">Installation</a></li>
+        <li><a href="#development-installation">Development Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgments">Acknowledgments</a></li>
+  </ol>
+</details>
+
+
+## About The Project
+
+Biosignal Device Interface provides a unified Python API for communicating with biosignal acquisition devices from multiple manufacturers. It includes ready-to-use PySide6 widgets for device configuration and data streaming, making it easy to integrate biosignal acquisition into custom applications.
+
+## Supported Devices
+
+### OT Bioelettronica
+- **Quattrocento** - 400+ channel EMG/EEG amplifier
+- **Quattrocento Light** - Compact version of Quattrocento
+- **Muovi** - Wearable EMG sensor
+- **Muovi+** - Enhanced wearable EMG sensor
+- **SyncStation** - Multi-device synchronization hub (Muovi, Muovi+, Due+)
+
+### Other Devices
+- More devices coming soon...
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+### Installation
+
+Install from PyPI:
+```bash
+pip install biosignal-device-interface
+```
+
+Or with Poetry:
+```bash
+poetry add biosignal-device-interface
+```
+
+### Development Installation
+
+Clone the repository and install with development dependencies:
+
+```bash
+git clone https://github.com/NsquaredLab/Biosignal-Device-Interface.git
+cd Biosignal-Device-Interface
+poetry install --with dev,docs
+```
+
+<!-- USAGE EXAMPLES -->
+## Usage
+
+Examples of how you can use this package can be found in our [examples gallery](https://nsquaredlab.github.io/Biosignal-Device-Interface/auto_examples/index.html).
+
+<!-- LICENSE -->
+## License
+
+Distributed under the GPL-3.0 License. See `LICENSE` for more information.
+
+<!-- CONTACT -->
+## Contact
+
+- [Dominik I. Braun](https://www.nsquared.tf.fau.de/person/dominik-braun/) - dome.braun@fau.de
+- [Raul C. Sîmpetru](https://www.nsquared.tf.fau.de/person/raul-simpetru/) - raul.simpetru@fau.de
+
+Project Link: [https://github.com/NsquaredLab/Biosignal-Device-Interface](https://github.com/NsquaredLab/Biosignal-Device-Interface)
+
+<!-- ACKNOWLEDGMENTS -->
+## Acknowledgments
+* Find available Python and Matlab implementations of OT Bioelettronica's devices on their [website](https://otbioelettronica.it/en/download/).
+<br>
+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.5/README.md

@@ -0,0 +1,112 @@
+# Biosignal-Device-Interface
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/NsquaredLab/Biosignal-Device-Interface">
+    <img src="images/logo.png" alt="Logo" width="80" height="80">
+  </a>
+
+<h3 align="center">Biosignal Device Interface</h3>
+
+  <p align="center">
+    Python communication interface to many biosignal devices manufactured by several companies for easy integration in custom PySide6 applications.
+    <br />
+    <a href="https://nsquaredlab.github.io/Biosignal-Device-Interface/"><strong>Explore the docs »</strong></a>
+  </p>
+
+[![PyPI version](https://img.shields.io/pypi/v/biosignal-device-interface.svg)](https://pypi.org/project/biosignal-device-interface/)
+[![Python versions](https://img.shields.io/pypi/pyversions/biosignal-device-interface.svg)](https://pypi.org/project/biosignal-device-interface/)
+[![License](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](LICENSE)
+
+</div>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li><a href="#about-the-project">About The Project</a></li>
+    <li><a href="#supported-devices">Supported Devices</a></li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#installation">Installation</a></li>
+        <li><a href="#development-installation">Development Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgments">Acknowledgments</a></li>
+  </ol>
+</details>
+
+
+## About The Project
+
+Biosignal Device Interface provides a unified Python API for communicating with biosignal acquisition devices from multiple manufacturers. It includes ready-to-use PySide6 widgets for device configuration and data streaming, making it easy to integrate biosignal acquisition into custom applications.
+
+## Supported Devices
+
+### OT Bioelettronica
+- **Quattrocento** - 400+ channel EMG/EEG amplifier
+- **Quattrocento Light** - Compact version of Quattrocento
+- **Muovi** - Wearable EMG sensor
+- **Muovi+** - Enhanced wearable EMG sensor
+- **SyncStation** - Multi-device synchronization hub (Muovi, Muovi+, Due+)
+
+### Other Devices
+- More devices coming soon...
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+### Installation
+
+Install from PyPI:
+```bash
+pip install biosignal-device-interface
+```
+
+Or with Poetry:
+```bash
+poetry add biosignal-device-interface
+```
+
+### Development Installation
+
+Clone the repository and install with development dependencies:
+
+```bash
+git clone https://github.com/NsquaredLab/Biosignal-Device-Interface.git
+cd Biosignal-Device-Interface
+poetry install --with dev,docs
+```
+
+<!-- USAGE EXAMPLES -->
+## Usage
+
+Examples of how you can use this package can be found in our [examples gallery](https://nsquaredlab.github.io/Biosignal-Device-Interface/auto_examples/index.html).
+
+<!-- LICENSE -->
+## License
+
+Distributed under the GPL-3.0 License. See `LICENSE` for more information.
+
+<!-- CONTACT -->
+## Contact
+
+- [Dominik I. Braun](https://www.nsquared.tf.fau.de/person/dominik-braun/) - dome.braun@fau.de
+- [Raul C. Sîmpetru](https://www.nsquared.tf.fau.de/person/raul-simpetru/) - raul.simpetru@fau.de
+
+Project Link: [https://github.com/NsquaredLab/Biosignal-Device-Interface](https://github.com/NsquaredLab/Biosignal-Device-Interface)
+
+<!-- ACKNOWLEDGMENTS -->
+## Acknowledgments
+* Find available Python and Matlab implementations of OT Bioelettronica's devices on their [website](https://otbioelettronica.it/en/download/).
+<br>
+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.3 → biosignal_device_interface-0.2.5}/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",
 }