biosignal-device-interface 0.1.0__tar.gz → 0.1.1__tar.gz

{biosignal_device_interface-0.1.0 → biosignal_device_interface-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: biosignal-device-interface
-Version: 0.1.0
+Version: 0.1.1
 Summary: Python communication interface to many biosignal devices manufactured by several companies to easy integration in custom PySide6 applications.
 License: CC BY-SA 4.0
 Author: Dominik I. Braun
@@ -12,7 +12,6 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Dist: aenum (>=3.1.15,<4.0.0)
 Requires-Dist: matplotlib (>=3.9.0,<4.0.0)
-Requires-Dist: mindrove (>=0.0.10,<0.0.11)
 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)
@@ -34,7 +33,7 @@ Description-Content-Type: text/markdown
   <p align="center">
     Python communication interface to many biosignal devices manufactured by several companies to easy integration in custom PySide6 applications.
     <br />
-    <a href="https://github.com/NsquaredLab/Biosignal-Device-Interface/-/wikis/home"><strong>Explore the docs »</strong></a>
+    <a href="https://nsquaredlab.github.io/Biosignal-Device-Interface/"><strong>Explore the docs »</strong></a>
   </p>
 </div>
 
@@ -46,9 +45,6 @@ Description-Content-Type: text/markdown
   <ol>
     <li>
       <a href="#about-the-project">About The Project</a>
-      <ul>
-        <li><a href="#built-with">Built With</a></li>
-      </ul>
     </li>
     <li><a href="#contact">Contact</a></li>
     <li>
@@ -69,14 +65,6 @@ Description-Content-Type: text/markdown
 
 Give a brief introduction into the project.
 
-
-
-### Built With
-
-* Python 3.10 / 3.11
-* PySide6 - Version ^6.7.0
-* Vispy - Version ^0.14.0
-
 <!-- CONTACT -->
 ### Contact
 
@@ -120,7 +108,7 @@ pip install git+https://github.com/NsquaredLab/Biosignal-Device-Interface.git
 <!-- USAGE EXAMPLES -->
 ## Usage
 
-Examples of how you can use this package can be found in our [examples gallery](https://github.com/NsquaredLab/Biosignal-Device-Interface).
+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 -->

{biosignal_device_interface-0.1.0 → biosignal_device_interface-0.1.1}/README.md

@@ -12,7 +12,7 @@
   <p align="center">
     Python communication interface to many biosignal devices manufactured by several companies to easy integration in custom PySide6 applications.
     <br />
-    <a href="https://github.com/NsquaredLab/Biosignal-Device-Interface/-/wikis/home"><strong>Explore the docs »</strong></a>
+    <a href="https://nsquaredlab.github.io/Biosignal-Device-Interface/"><strong>Explore the docs »</strong></a>
   </p>
 </div>
 
@@ -24,9 +24,6 @@
   <ol>
     <li>
       <a href="#about-the-project">About The Project</a>
-      <ul>
-        <li><a href="#built-with">Built With</a></li>
-      </ul>
     </li>
     <li><a href="#contact">Contact</a></li>
     <li>
@@ -47,14 +44,6 @@
 
 Give a brief introduction into the project.
 
-
-
-### Built With
-
-* Python 3.10 / 3.11
-* PySide6 - Version ^6.7.0
-* Vispy - Version ^0.14.0
-
 <!-- CONTACT -->
 ### Contact
 
@@ -98,7 +87,7 @@ pip install git+https://github.com/NsquaredLab/Biosignal-Device-Interface.git
 <!-- USAGE EXAMPLES -->
 ## Usage
 
-Examples of how you can use this package can be found in our [examples gallery](https://github.com/NsquaredLab/Biosignal-Device-Interface).
+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 -->

{biosignal_device_interface-0.1.0/biosignal_device_interface → biosignal_device_interface-0.1.1/biosignal_device_interface/constants/devices}/__init__.py

@@ -1,4 +1,3 @@
-from biosignal_device_interface.devices import otb
 from biosignal_device_interface.constants.devices.core.base_device_constants import (
     DeviceType,
 )

{biosignal_device_interface-0.1.0 → biosignal_device_interface-0.1.1}/biosignal_device_interface/constants/devices/otb/otb_muovi_constants.py

@@ -99,7 +99,7 @@ The values are dictionaries with the following keys:
 
 MUOVI_AVAILABLE_CHANNELS_DICT: dict[DeviceType, dict[DeviceChannelTypes, int]] = {
     DeviceType.OTB_MUOVI: {
-        DeviceChannelTypes.ALL: 70,
+        DeviceChannelTypes.ALL: 38,
         DeviceChannelTypes.BIOSIGNAL: 32,
         DeviceChannelTypes.AUXILIARY: 6,
     },
@@ -115,8 +115,8 @@ MUOVI_AVAILABLE_CHANNELS_DICT: dict[DeviceType, dict[DeviceChannelTypes, int]] =
 """
 
 MUOVI_CONVERSION_FACTOR_DICT: dict[MuoviDetectionMode, int] = {
-    MuoviDetectionMode.MONOPOLAR_GAIN_8: 572.2e-9,
-    MuoviDetectionMode.MONOPOLAR_GAIN_4: 286.1e-9,
+    MuoviDetectionMode.MONOPOLAR_GAIN_8: 572.2e-6,
+    MuoviDetectionMode.MONOPOLAR_GAIN_4: 286.1e-6,
 }
 """
 Dictionary to get the gain of the Muovi detection mode. \\

biosignal_device_interface-0.1.1/biosignal_device_interface/devices/__init__.py

@@ -0,0 +1,15 @@
+# Import Devices to be used from biosignal_device_interface.devices
+# import Muovi, MindRoveBracelet, Quattrocento, QuattrocentoLight, ...
+
+from biosignal_device_interface.devices.otb import (
+    OTBMuoviWidget,
+    OTBMuoviPlusWidget,
+    OTBQuattrocentoLightWidget,
+    OTBMuovi,
+    OTBQuattrocentoLight,
+    OTBDevicesWidget,
+)
+
+from biosignal_device_interface.gui.device_template_widgets.all_devices_widget import (
+    AllDevicesWidget,
+)

biosignal_device_interface-0.1.1/biosignal_device_interface/devices/otb/__init__.py

@@ -0,0 +1,21 @@
+from biosignal_device_interface.devices.otb.otb_quattrocento_light import (
+    OTBQuattrocentoLight,
+)
+from biosignal_device_interface.devices.otb.otb_muovi import OTBMuovi
+
+# Widgets
+# All OTB Devices Widget
+from biosignal_device_interface.gui.device_template_widgets.otb.otb_devices_widget import (
+    OTBDevicesWidget,
+)
+
+# Individual OTB Device Widgets
+from biosignal_device_interface.gui.device_template_widgets.otb.otb_muovi_widget import (
+    OTBMuoviWidget,
+)
+from biosignal_device_interface.gui.device_template_widgets.otb.otb_muovi_plus_widget import (
+    OTBMuoviPlusWidget,
+)
+from biosignal_device_interface.gui.device_template_widgets.otb.otb_quattrocento_light_widget import (
+    OTBQuattrocentoLightWidget,
+)

{biosignal_device_interface-0.1.0 → biosignal_device_interface-0.1.1}/biosignal_device_interface/devices/otb/otb_muovi.py

@@ -19,7 +19,7 @@ from biosignal_device_interface.constants.devices.core.base_device_constants imp
 )
 
 # Constants
-from biosignal_device_interface.constants.devices.otb_muovi_constants import (
+from biosignal_device_interface.constants.devices.otb.otb_muovi_constants import (
     MUOVI_CONVERSION_FACTOR_DICT,
     MuoviWorkingMode,
     MuoviDetectionMode,
@@ -126,9 +126,9 @@ class OTBMuovi(BaseDevice):
         return True
 
     def configure_device(
-        self, settings: Dict[str, Union[Enum, Dict[str, Enum]]]  # type: ignore
+        self, params: Dict[str, Union[Enum, Dict[str, Enum]]]  # type: ignore
     ) -> None:
-        super().configure_device(settings)
+        super().configure_device(params)
 
         if not self._is_connected or self._client_socket is None:
             return
@@ -233,10 +233,10 @@ class OTBMuovi(BaseDevice):
                 self._process_data(data_to_process)
                 self._received_bytes = self._received_bytes[self._buffer_size :]
 
-    def _process_data(self, data: bytearray) -> None:
-        super()._process_data(data)
+    def _process_data(self, input: bytearray) -> None:
+        super()._process_data(input)
 
-        decoded_data = self._bytes_to_integers(data)
+        decoded_data = self._bytes_to_integers(input)
 
         processed_data = decoded_data.reshape(
             self._number_of_channels, -1, order="F"

biosignal_device_interface-0.1.0/biosignal_device_interface/devices/otb/otb_quattrocento.py → biosignal_device_interface-0.1.1/biosignal_device_interface/devices/otb/otb_quattrocento_light.py

@@ -22,7 +22,7 @@ from biosignal_device_interface.devices.core.base_device import BaseDevice
 from biosignal_device_interface.constants.devices.core.base_device_constants import (
     DeviceType,
 )
-from biosignal_device_interface.constants.devices.otb_quattrocento_constants import (
+from biosignal_device_interface.constants.devices.otb.otb_quattrocento_light_constants import (
     COMMAND_START_STREAMING,
     COMMAND_STOP_STREAMING,
     CONNECTION_RESPONSE,
@@ -110,9 +110,9 @@ class OTBQuattrocentoLight(BaseDevice):
         self._interface.close()
 
     def configure_device(
-        self, settings: Dict[str, Union[Enum, Dict[str, Enum]]]  # type: ignore
+        self, params: Dict[str, Union[Enum, Dict[str, Enum]]]  # type: ignore
     ) -> None:
-        super().configure_device(settings)
+        super().configure_device(params)
 
         # Configure the device
         self._number_of_biosignal_channels = len(self._grids) * self._grid_size
@@ -191,11 +191,11 @@ class OTBQuattrocentoLight(BaseDevice):
                 self._process_data(data_to_process)
                 self._received_bytes = self._received_bytes[self._buffer_size :]
 
-    def _process_data(self, data: bytearray) -> None:
-        super()._process_data(data)
+    def _process_data(self, input: bytearray) -> None:
+        super()._process_data(input)
 
         # Decode the data
-        decoded_data = np.frombuffer(data, dtype=np.int16)
+        decoded_data = np.frombuffer(input, dtype=np.int16)
 
         # Reshape it to the correct format
         processed_data = decoded_data.reshape(
@@ -207,29 +207,5 @@ class OTBQuattrocentoLight(BaseDevice):
         self.biosignal_data_available.emit(self._extract_biosignal_data(processed_data))
         self.auxiliary_data_available.emit(self._extract_auxiliary_data(processed_data))
 
-    def get_device_information(self) -> Dict[str, Enum | int | float | str]:
+    def get_device_information(self) -> Dict[str, Enum | int | float | str]:  # type: ignore
         return super().get_device_information()
-
-
-class OTBQuattrocento(BaseDevice):
-    """
-    Quattrocento device class derived from BaseDevice class.
-
-    The Quattrocento class is using a TCP/IP protocol to communicate with the device.
-    """
-
-    def __init__(
-        self,
-        parent: Union[QMainWindow, QWidget] = None,
-    ) -> None:
-        super().__init__(parent)
-
-        # Device Parameters
-        self._device_type: DeviceType = DeviceType.OTB_QUATTROCENTO
-
-        # Device Information
-        self._conversion_factor_biosignal: float = 5 / (2**16) / 150 * 1000
-        self._conversion_factor_auxiliary: float = 5 / (2**16) / 0.5
-
-        # Connection Parameters
-        self._interface: QTcpSocket = QTcpSocket()

{biosignal_device_interface-0.1.0 → biosignal_device_interface-0.1.1}/biosignal_device_interface/gui/device_template_widgets/all_devices_widget.py

@@ -14,10 +14,14 @@ from biosignal_device_interface.gui.device_template_widgets.core.base_multiple_d
 from biosignal_device_interface.constants.devices.core.base_device_constants import (
     DeviceType,
 )
-from biosignal_device_interface.gui.device_template_widgets import (
-    MuoviPlusWidget,
-    MuoviWidget,
-    QuattrocentoLightWidget,
+from biosignal_device_interface.gui.device_template_widgets.otb.otb_muovi_plus_widget import (
+    OTBMuoviPlusWidget,
+)
+from biosignal_device_interface.gui.device_template_widgets.otb.otb_muovi_widget import (
+    OTBMuoviWidget,
+)
+from biosignal_device_interface.gui.device_template_widgets.otb.otb_quattrocento_light_widget import (
+    OTBQuattrocentoLightWidget,
 )
 
 if TYPE_CHECKING:
@@ -32,8 +36,8 @@ class AllDevicesWidget(BaseMultipleDevicesWidget):
         super().__init__(parent)
 
         self._device_selection: Dict[DeviceType, BaseDeviceWidget] = {
-            DeviceType.OTB_QUATTROCENTO_LIGHT: QuattrocentoLightWidget(self),
-            DeviceType.OTB_MUOVI: MuoviWidget(self),
-            DeviceType.OTB_MUOVI_PLUS: MuoviPlusWidget(self),
+            DeviceType.OTB_QUATTROCENTO_LIGHT: OTBQuattrocentoLightWidget(self),
+            DeviceType.OTB_MUOVI: OTBMuoviWidget(self),
+            DeviceType.OTB_MUOVI_PLUS: OTBMuoviPlusWidget(self),
         }
         self._set_devices(self._device_selection)

{biosignal_device_interface-0.1.0 → biosignal_device_interface-0.1.1}/biosignal_device_interface/gui/device_template_widgets/otb/otb_devices_widget.py

@@ -7,10 +7,14 @@ from biosignal_device_interface.gui.device_template_widgets.core.base_multiple_d
 from biosignal_device_interface.constants.devices.core.base_device_constants import (
     DeviceType,
 )
-from biosignal_device_interface.gui.device_template_widgets.otb import (
-    MuoviPlusWidget,
-    MuoviWidget,
-    QuattrocentoLightWidget,
+from biosignal_device_interface.gui.device_template_widgets.otb.otb_muovi_plus_widget import (
+    OTBMuoviPlusWidget,
+)
+from biosignal_device_interface.gui.device_template_widgets.otb.otb_muovi_widget import (
+    OTBMuoviWidget,
+)
+from biosignal_device_interface.gui.device_template_widgets.otb.otb_quattrocento_light_widget import (
+    OTBQuattrocentoLightWidget,
 )
 
 if TYPE_CHECKING:
@@ -20,13 +24,13 @@ if TYPE_CHECKING:
     )
 
 
-class AllDevicesWidget(BaseMultipleDevicesWidget):
+class OTBDevicesWidget(BaseMultipleDevicesWidget):
     def __init__(self, parent: QWidget | QMainWindow | None = None):
         super().__init__(parent)
 
         self._device_selection: Dict[DeviceType, BaseDeviceWidget] = {
-            DeviceType.OTB_QUATTROCENTO_LIGHT: QuattrocentoLightWidget(self),
-            DeviceType.OTB_MUOVI: MuoviWidget(self),
-            DeviceType.OTB_MUOVI_PLUS: MuoviPlusWidget(self),
+            DeviceType.OTB_QUATTROCENTO_LIGHT: OTBQuattrocentoLightWidget(self),
+            DeviceType.OTB_MUOVI: OTBMuoviWidget(self),
+            DeviceType.OTB_MUOVI_PLUS: OTBMuoviPlusWidget(self),
         }
         self._set_devices(self._device_selection)

{biosignal_device_interface-0.1.0 → biosignal_device_interface-0.1.1}/biosignal_device_interface/gui/device_template_widgets/otb/otb_muovi_plus_widget.py

@@ -7,10 +7,10 @@ from biosignal_device_interface.gui.device_template_widgets.core.base_device_wid
 from biosignal_device_interface.gui.ui_compiled.otb_muovi_template_widget import (
     Ui_MuoviForm,
 )
-from biosignal_device_interface.devices import OTBMuovi
+from biosignal_device_interface.devices.otb.otb_muovi import OTBMuovi
 
 # Constants
-from biosignal_device_interface.constants.devices.otb_muovi_constants import (
+from biosignal_device_interface.constants.devices.otb.otb_muovi_constants import (
     MuoviWorkingMode,
     MuoviDetectionMode,
     MUOVI_NETWORK_PORT,
@@ -27,7 +27,7 @@ if TYPE_CHECKING:
     )
 
 
-class OTBMuoviWidget(BaseDeviceWidget):
+class OTBMuoviPlusWidget(BaseDeviceWidget):
     def __init__(self, parent: QWidget | QMainWindow | None = None):
         super().__init__(parent)
 

{biosignal_device_interface-0.1.0 → biosignal_device_interface-0.1.1}/biosignal_device_interface/gui/device_template_widgets/otb/otb_muovi_widget.py

@@ -7,10 +7,10 @@ from biosignal_device_interface.gui.device_template_widgets.core.base_device_wid
 from biosignal_device_interface.gui.ui_compiled.otb_muovi_template_widget import (
     Ui_MuoviForm,
 )
-from biosignal_device_interface.devices import OTBMuovi
+from biosignal_device_interface.devices.otb.otb_muovi import OTBMuovi
 
 # Constants
-from biosignal_device_interface.constants.devices.otb_muovi_constants import (
+from biosignal_device_interface.constants.devices.otb.otb_muovi_constants import (
     MuoviWorkingMode,
     MuoviDetectionMode,
     MUOVI_NETWORK_PORT,
@@ -27,7 +27,7 @@ if TYPE_CHECKING:
     )
 
 
-class MuoviWidget(BaseDeviceWidget):
+class OTBMuoviWidget(BaseDeviceWidget):
     def __init__(self, parent: QWidget | QMainWindow | None = None):
         super().__init__(parent)
 

{biosignal_device_interface-0.1.0 → biosignal_device_interface-0.1.1}/biosignal_device_interface/gui/device_template_widgets/otb/otb_quattrocento_light_widget.py

@@ -7,10 +7,10 @@ from biosignal_device_interface.gui.device_template_widgets.core.base_device_wid
 from biosignal_device_interface.gui.ui_compiled.otb_quattrocento_light_template_widget import (
     Ui_QuattrocentoLightForm,
 )
-from biosignal_device_interface.devices import OTBQuattrocentoLight
+from biosignal_device_interface.devices.otb.otb_quattrocento_light import OTBQuattrocentoLight
 
 # Constants
-from biosignal_device_interface.constants.devices.otb_quattrocento_constants import (
+from biosignal_device_interface.constants.devices.otb.otb_quattrocento_light_constants import (
     QuattrocentoLightSamplingFrequency,
     QuattrocentoLightStreamingFrequency,
 )
@@ -27,7 +27,7 @@ if TYPE_CHECKING:
     )
 
 
-class QuattrocentoLightWidget(BaseDeviceWidget):
+class OTBQuattrocentoLightWidget(BaseDeviceWidget):
     def __init__(self, parent: QWidget | QMainWindow | None = None):
         super().__init__(parent)
         self._set_device(OTBQuattrocentoLight(self))

{biosignal_device_interface-0.1.0 → biosignal_device_interface-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "biosignal-device-interface"
-version = "0.1.0"
+version = "0.1.1"
 description = "Python communication interface to many biosignal devices manufactured by several companies to easy integration in custom PySide6 applications."
 authors = ["Dominik I. Braun <dome.braun@fau.de>"]
 license = "CC BY-SA 4.0"
@@ -11,16 +11,19 @@ python = ">=3.10,<3.12"
 pyside6 = "^6.7.0"
 numpy = "^1.26.4"
 psutil = "^5.9.8"
-mindrove = "^0.0.10"
 aenum = "^3.1.15"
 vispy = "^0.14.3"
 scipy = "^1.14.0"
 matplotlib = "^3.9.0"
 
 
+[tool.poetry.group.dev]
+optional = true
 [tool.poetry.group.dev.dependencies]
 ipykernel = "^6.29.5"
 
+[tool.poetry.group.docs]
+optional = true
 [tool.poetry.group.docs.dependencies]
 sphinx = "^7.4.6"
 rinohtype = "^0.5.5"
@@ -32,7 +35,6 @@ enum-tools = {extras = ["sphinx"], version = "^0.12.0"}
 sphinx-autodoc-typehints = "^2.2.3"
 
 
-
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

biosignal_device_interface-0.1.0/biosignal_device_interface/devices/__init__.py

@@ -1,9 +0,0 @@
-# Import Devices to be used from biosignal_device_interface.devices
-# import Muovi, MindRoveBracelet, Quattrocento, QuattrocentoLight, ...
-
-# OTB Devices
-from biosignal_device_interface.devices.otb.otb_quattrocento import (
-    OTBQuattrocento,
-    OTBQuattrocentoLight,
-)
-from biosignal_device_interface.devices.otb.otb_muovi import OTBMuovi

biosignal_device_interface-0.1.0/biosignal_device_interface/devices/otb/__init__.py

@@ -1,9 +0,0 @@
-# Import OTB Devices to be used from biosignal_device_interface.devices
-# import Muovi, Quattrocento, QuattrocentoLight, ...
-
-# OTB Devices
-from biosignal_device_interface.devices.otb.otb_quattrocento import (
-    OTBQuattrocento as Quattrocento,
-    OTBQuattrocentoLight as QuattrocentoLight,
-)
-from biosignal_device_interface.devices.otb.otb_muovi import OTBMuovi as Muovi

biosignal_device_interface-0.1.0/biosignal_device_interface/gui/device_template_widgets/__init__.py

@@ -1,6 +0,0 @@
-# OTB Devices
-from biosignal_device_interface.gui.device_template_widgets.otb import (
-    MuoviWidget,
-    MuoviPlusWidget,
-    QuattrocentoLightWidget,
-)

biosignal_device_interface-0.1.0/biosignal_device_interface/gui/device_template_widgets/otb/__init__.py

@@ -1,10 +0,0 @@
-# OTB Devices
-from biosignal_device_interface.gui.device_template_widgets.otb.otb_muovi_widget import (
-    MuoviWidget,
-)
-from biosignal_device_interface.gui.device_template_widgets.otb.otb_muovi_plus_widget import (
-    OTBMuoviWidget as MuoviPlusWidget,
-)
-from biosignal_device_interface.gui.device_template_widgets.otb.otb_quattrocento_light_widget import (
-    QuattrocentoLightWidget,
-)