biosignal-device-interface 0.1.1a0__py3-none-any.whl → 0.1.4a1__py3-none-any.whl

biosignal_device_interface/constants/devices/otb/otb_syncstation_constants.py

@@ -0,0 +1,233 @@
+"""
+Device class for real-time interfacing the OTB Syncstation device.
+Developer: Dominik I. Braun
+Contact: dome.braun@fau.de
+Last Update: 2025-01-09
+"""
+
+from typing import Dict, Union
+from aenum import Enum, auto
+from biosignal_device_interface.constants.devices.core.base_device_constants import (
+    DeviceType,
+    DeviceChannelTypes,
+)
+from biosignal_device_interface.constants.devices.otb.otb_muovi_constants import (
+    MUOVI_AVAILABLE_CHANNELS_DICT,
+)
+
+
+class SyncStationRecOnMode(Enum):
+    """
+    Enum class for the recording on mode of the SyncStation device.
+    """
+
+    _init_ = "value __doc__"
+
+    OFF = auto(), (
+        "The PC is not recording the received signals from SyncStation."
+        "If the Timestapms.log is closed if it was previously opened."
+    )
+    ON = auto(), (
+        "The PC is recording the signals received by the SyncStation."
+        "When triggered, this bit reset the internal timer for the"
+        "ramp counter sent on the Accessory Ch2 and start the log of"
+        "the timestamps on the internal timestamps.log file"
+    )
+
+
+class SyncStationWorkingMode(Enum):
+    """
+    Enum class for the sampling frequency mode of the SyncStation device.
+    """
+
+    _init_ = "value __doc__"
+
+    NONE = 0, "No working mode set."
+    EEG = auto(), "EEG Mode Fsamp 500 Hz, DC coupled, 24 bit resolution."
+    EMG = (
+        auto(),
+        "EMG Mode Fsamp 2000 Hz, high pass filter at 10 Hz*, 16 bit resolution",
+    )
+
+
+class SyncStationDetectionMode(Enum):
+    """
+    Enum class for the detection mode of the SyncStation device.
+    """
+
+    _init_ = "value __doc__"
+
+    NONE = 0, "No detection mode set."
+    MONOPOLAR_GAIN_HIGH = auto(), (
+        "Monopolar Mode. High gain. 32 monopolar bioelectrical signals + 6 accessory signals. "
+        "Resolution is 286.1 nV and range +/-9.375 mV."
+    )
+    MONOPOLAR_GAIN_LOW = auto(), (
+        "Monopolar Mode. Low gain. 32 monopolar bioelectrical signals + 6 accessory signals. "
+        "Resolution is 572.2nV and range +/-18.75 mV."
+    )
+    IMPEDANCE_CHECK = auto(), "Impedance Check on all 32 + 6 channels."
+    TEST = auto(), "Ramps on all 32 + 6 channels."
+
+
+class SyncStationProbeConfigMode(Enum):
+    """
+    Enum class for the probe configuration mode of the SyncStation device.
+    """
+
+    _init_ = "value __doc__"
+
+    NONE = 0, "No probe configuration mode set."
+    MUOVI_PROBE_ONE = auto(), "Probe configuration mode for Muovi probe one."
+    MUOVI_PROBE_TWO = auto(), "Probe configuration mode for Muovi probe two."
+    MUOVI_PROBE_THREE = auto(), "Probe configuration mode for Muovi probe three."
+    MUOVI_PROBE_FOUR = auto(), "Probe configuration mode for Muovi probe four."
+    MUOVI_PLUS_PROBE_ONE = auto(), "Probe configuration mode for Muovi Plus probe one."
+    MUOVI_PLUS_PROBE_TWO = auto(), "Probe configuration mode for Muovi Plus probe two."
+    DUE_PLUS_PROBE_ONE = (
+        auto(),
+        "Probe configuration mode for Due Plus probe one.",
+    )
+    DUE_PLUS_PROBE_TWO = (
+        auto(),
+        "Probe configuration mode for Due Plus probe two.",
+    )
+    DUE_PLUS_PROBE_THREE = (
+        auto(),
+        "Probe configuration mode for Due Plus probe three.",
+    )
+    DUE_PLUS_PROBE_FOUR = (
+        auto(),
+        "Probe configuration mode for Due Plus probe four.",
+    )
+    DUE_PLUS_PROBE_FIVE = (
+        auto(),
+        "Probe configuration mode for Due Plus probe five.",
+    )
+    DUE_PLUS_PROBE_SIX = (
+        auto(),
+        "Probe configuration mode for Due Plus probe six.",
+    )
+    DUE_PLUS_PROBE_SEVEN = (
+        auto(),
+        "Probe configuration mode for Due Plus probe seven.",
+    )
+    DUE_PLUS_PROBE_EIGHT = (
+        auto(),
+        "Probe configuration mode for Due Plus probe eight.",
+    )
+    DUE_PLUS_PROBE_NINE = (
+        auto(),
+        "Probe configuration mode for Due Plus probe nine.",
+    )
+    DUE_PLUS_PROBE_TEN = (
+        auto(),
+        "Probe configuration mode for Due Plus probe ten.",
+    )
+
+
+# DICTS
+
+SYNCSTATION_CHARACTERISTICS_DICT: Dict[str, int] = {
+    DeviceChannelTypes.ALL: 6,
+    "bytes_per_sample": 2,
+    "channel_information": {
+        SyncStationWorkingMode.EEG: {
+            "sampling_frequency": 500,
+            "bytes_per_sample": 3,
+            "frame_size": 5,
+        },
+        SyncStationWorkingMode.EMG: {
+            "sampling_frequency": 2000,
+            "bytes_per_sample": 2,
+            "frame_size": 10,
+        },
+    },
+    "number_of_packages": 32,
+    "package_size": 1460,
+    "FPS": 50,
+}
+
+#  TODO: Load information from Device Constants directly!
+PROBE_CHARACTERISTICS_DICT: Dict[
+    SyncStationProbeConfigMode, Dict[str, Union[str, int]]
+] = {
+    SyncStationProbeConfigMode.MUOVI_PROBE_ONE: MUOVI_AVAILABLE_CHANNELS_DICT[
+        DeviceType.OTB_MUOVI
+    ],
+    SyncStationProbeConfigMode.MUOVI_PROBE_TWO: MUOVI_AVAILABLE_CHANNELS_DICT[
+        DeviceType.OTB_MUOVI
+    ],
+    SyncStationProbeConfigMode.MUOVI_PROBE_THREE: MUOVI_AVAILABLE_CHANNELS_DICT[
+        DeviceType.OTB_MUOVI
+    ],
+    SyncStationProbeConfigMode.MUOVI_PROBE_FOUR: MUOVI_AVAILABLE_CHANNELS_DICT[
+        DeviceType.OTB_MUOVI
+    ],
+    SyncStationProbeConfigMode.MUOVI_PLUS_PROBE_ONE: MUOVI_AVAILABLE_CHANNELS_DICT[
+        DeviceType.OTB_MUOVI_PLUS
+    ],
+    SyncStationProbeConfigMode.MUOVI_PLUS_PROBE_TWO: MUOVI_AVAILABLE_CHANNELS_DICT[
+        DeviceType.OTB_MUOVI_PLUS
+    ],
+    SyncStationProbeConfigMode.DUE_PLUS_PROBE_ONE: {
+        DeviceChannelTypes.ALL: 8,
+        DeviceChannelTypes.BIOSIGNAL: 2,
+        DeviceChannelTypes.AUXILIARY: 6,
+    },
+    SyncStationProbeConfigMode.DUE_PLUS_PROBE_TWO: {
+        DeviceChannelTypes.ALL: 8,
+        DeviceChannelTypes.BIOSIGNAL: 2,
+        DeviceChannelTypes.AUXILIARY: 6,
+    },
+    SyncStationProbeConfigMode.DUE_PLUS_PROBE_THREE: {
+        DeviceChannelTypes.ALL: 8,
+        DeviceChannelTypes.BIOSIGNAL: 2,
+        DeviceChannelTypes.AUXILIARY: 6,
+    },
+    SyncStationProbeConfigMode.DUE_PLUS_PROBE_FOUR: {
+        DeviceChannelTypes.ALL: 8,
+        DeviceChannelTypes.BIOSIGNAL: 2,
+        DeviceChannelTypes.AUXILIARY: 6,
+    },
+    SyncStationProbeConfigMode.DUE_PLUS_PROBE_FIVE: {
+        DeviceChannelTypes.ALL: 8,
+        DeviceChannelTypes.BIOSIGNAL: 2,
+        DeviceChannelTypes.AUXILIARY: 6,
+    },
+    SyncStationProbeConfigMode.DUE_PLUS_PROBE_SIX: {
+        DeviceChannelTypes.ALL: 8,
+        DeviceChannelTypes.BIOSIGNAL: 2,
+        DeviceChannelTypes.AUXILIARY: 6,
+    },
+    SyncStationProbeConfigMode.DUE_PLUS_PROBE_SEVEN: {
+        DeviceChannelTypes.ALL: 8,
+        DeviceChannelTypes.BIOSIGNAL: 2,
+        DeviceChannelTypes.AUXILIARY: 6,
+    },
+    SyncStationProbeConfigMode.DUE_PLUS_PROBE_EIGHT: {
+        DeviceChannelTypes.ALL: 8,
+        DeviceChannelTypes.BIOSIGNAL: 2,
+        DeviceChannelTypes.AUXILIARY: 6,
+    },
+    SyncStationProbeConfigMode.DUE_PLUS_PROBE_NINE: {
+        DeviceChannelTypes.ALL: 8,
+        DeviceChannelTypes.BIOSIGNAL: 2,
+        DeviceChannelTypes.AUXILIARY: 6,
+    },
+    SyncStationProbeConfigMode.DUE_PLUS_PROBE_TEN: {
+        DeviceChannelTypes.ALL: 8,
+        DeviceChannelTypes.BIOSIGNAL: 2,
+        DeviceChannelTypes.AUXILIARY: 6,
+    },
+}
+
+SYNCSTATION_CONVERSION_FACTOR_DICT: dict[SyncStationDetectionMode, int] = {
+    SyncStationDetectionMode.MONOPOLAR_GAIN_HIGH: 572.2e-6,
+    SyncStationDetectionMode.MONOPOLAR_GAIN_LOW: 286.1e-6,
+}
+"""
+Dictionary to get the gain of the Muovi detection mode. \\
+The keys are the detection modes of the Muovi device. \\
+The values are the gain of the detection mode in V.
+"""

biosignal_device_interface/devices/__init__.py

@@ -1,9 +1,17 @@
 # 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 (
+from biosignal_device_interface.devices.otb import (
+    OTBMuoviWidget,
+    OTBMuoviPlusWidget,
+    OTBQuattrocentoLightWidget,
+    OTBMuovi,
     OTBQuattrocento,
     OTBQuattrocentoLight,
+    OTBSyncStationWidget,
+    OTBDevicesWidget,
+)
+
+from biosignal_device_interface.gui.device_template_widgets.all_devices_widget import (
+    AllDevicesWidget,
 )
-from biosignal_device_interface.devices.otb.otb_muovi import OTBMuovi

biosignal_device_interface/devices/core/base_device.py

@@ -73,7 +73,7 @@ class BaseDevice(QObject):
         self._connection_timeout_timer.setInterval(1000)
 
         # Device Status
-        self._is_connected: bool = False
+        self.is_connected: bool = False
         self._is_configured: bool = False
         self._is_streaming: bool = False
 
@@ -114,7 +114,7 @@ class BaseDevice(QObject):
             bool:
                 Success of the disconnection attempt.
         """
-        self._is_connected = False
+        self.is_connected = False
         self.connect_toggled.emit(False)
         self._is_configured = False
         self.configure_toggled.emit(False)
@@ -247,13 +247,10 @@ class BaseDevice(QObject):
             np.ndarray:
                 Extracted biosignal channels.
         """
-
+        biosignal_data = data[self._biosignal_channel_indices]
         if milli_volts:
-            return (
-                data[self._biosignal_channel_indices]
-                * self._conversion_factor_biosignal
-            )
-        return data[self._biosignal_channel_indices]
+            return biosignal_data * self._conversion_factor_biosignal
+        return biosignal_data
 
     def _extract_auxiliary_data(
         self, data: np.ndarray, milli_volts: bool = True
@@ -302,7 +299,7 @@ class BaseDevice(QObject):
         """
         self._connection_settings = settings
 
-        if self._is_connected:
+        if self.is_connected:
             if self._is_streaming:
                 self.toggle_streaming()
 
@@ -398,6 +395,8 @@ class BaseDevice(QObject):
                     or "wifi" in interface.lower()
                     or "wireless" in interface.lower()
                     or "en0" in interface.lower()
+                    or "wlp" in interface.lower()
+                    or "wln" in interface.lower()
                 ):
                     for address in addresses:
                         # Check if the address is an IPv4 address and not a loopback or virtual address

biosignal_device_interface/devices/otb/__init__.py

@@ -1,9 +1,29 @@
-# Import OTB Devices to be used from biosignal_device_interface.devices
-# import Muovi, Quattrocento, QuattrocentoLight, ...
+from biosignal_device_interface.devices.otb.otb_quattrocento import OTBQuattrocento
+from biosignal_device_interface.devices.otb.otb_quattrocento_light import (
+    OTBQuattrocentoLight,
+)
+from biosignal_device_interface.devices.otb.otb_muovi import OTBMuovi
+from biosignal_device_interface.devices.otb.otb_syncstation import OTBSyncStation
+
+# Widgets
+# All OTB Devices Widget
+from biosignal_device_interface.gui.device_template_widgets.otb.otb_devices_widget import (
+    OTBDevicesWidget,
+)
 
-# OTB Devices
-from biosignal_device_interface.devices.otb.otb_quattrocento import (
-    OTBQuattrocento as Quattrocento,
-    OTBQuattrocentoLight as QuattrocentoLight,
+# 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_widget import (
+    OTBQuattrocentoWidget,
+)
+from biosignal_device_interface.gui.device_template_widgets.otb.otb_quattrocento_light_widget import (
+    OTBQuattrocentoLightWidget,
+)
+from biosignal_device_interface.gui.device_template_widgets.otb.otb_syncstation_widget import (
+    OTBSyncStationWidget,
 )
-from biosignal_device_interface.devices.otb.otb_muovi import OTBMuovi as Muovi

biosignal_device_interface/devices/otb/otb_muovi.py

@@ -1,4 +1,3 @@
-# Python Libraries
 """
 Device class for real-time interfacing the Muovi device.
 Developer: Dominik I. Braun
@@ -101,9 +100,9 @@ class OTBMuovi(BaseDevice):
 
             self._client_socket.readyRead.connect(self._read_data)
 
-            if not self._is_connected:
-                self._is_connected = True
-                self.connect_toggled.emit(self._is_connected)
+            if not self.is_connected:
+                self.is_connected = True
+                self.connect_toggled.emit(self.is_connected)
                 self._connection_timeout_timer.stop()
                 return True
 
@@ -126,11 +125,11 @@ 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:
+        if not self.is_connected or self._client_socket is None:
             return
 
         # Check if detection mode is valid for working mode (Case EEG -> MONOPOLAR_GAIN_4 => MONOPOLAR_GAIN_8)
@@ -233,10 +232,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"