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

biosignal_device_interface/devices/otb/otb_quattrocento.py

@@ -1,13 +1,10 @@
 """
-1)  Quattrocento Light class for real-time interface to 
-    Quattrocento using OT Biolab Light.
-
-2)  Quattrocento class for direct real-time interface to 
-    Quattrocento without using OT Biolab Light.
+Quattrocento class for real-time direct interface to 
+Quattrocento.
 
 Developer: Dominik I. Braun
 Contact: dome.braun@fau.de
-Last Update: 2023-06-05
+Last Update: 2025-01-14
 """
 
 # Python Libraries
@@ -23,61 +20,75 @@ from biosignal_device_interface.constants.devices.core.base_device_constants imp
     DeviceType,
 )
 from biosignal_device_interface.constants.devices.otb.otb_quattrocento_constants import (
-    COMMAND_START_STREAMING,
-    COMMAND_STOP_STREAMING,
-    CONNECTION_RESPONSE,
-    QUATTROCENTO_LIGHT_STREAMING_FREQUENCY_DICT,
-    QUATTROCENTO_SAMPLING_FREQUENCY_DICT,
-    QuattrocentoLightSamplingFrequency,
-    QuattrocentoLightStreamingFrequency,
+    QUATTROCENTO_AUXILIARY_CHANNELS,
+    QUATTROCENTO_BYTES_PER_SAMPLE,
+    QUATTROCENTO_SAMPLES_PER_FRAME,
+    QUATTROCENTO_SUPPLEMENTARY_CHANNELS,
+    QuattrocentoAcqSettByte,
+    QuattrocentoINXConf2Byte,
+    QuattrocentoRecordingMode,
+    QuattrocentoSamplingFrequencyMode,
+    QuattrocentoNumberOfChannelsMode,
+    QuattrocentoLowPassFilterMode,
+    QuattrocentoHighPassFilterMode,
+    QuattrocentoDetectionMode,
 )
 
-
 if TYPE_CHECKING:
     # Python Libraries
     from PySide6.QtWidgets import QMainWindow, QWidget
     from aenum import Enum
 
 
-class OTBQuattrocentoLight(BaseDevice):
+class OTBQuattrocento(BaseDevice):
     """
-    QuattrocentoLight device class derived from BaseDevice class.
-    The QuattrocentoLight is using a TCP/IP protocol to communicate with the device.
+    Quattrocento device class derived from BaseDevice class.
+    The Quattrocento is using a TCP/IP protocol to communicate with the device.
 
-    This class directly interfaces with the OT Biolab Light software from
-    OT Bioelettronica. The configured settings of the device have to
-    match the settings from the OT Biolab Light software!
+    This class directly interfaces with the Quattrocento from
+    OT Bioelettronica.
     """
 
-    def __init__(
-        self,
-        parent: Union[QMainWindow, QWidget] = None,
-    ) -> None:
+    def __init__(self, parent: Union[QMainWindow, QWidget] = None):
         super().__init__(parent)
 
-        # Device Parameters
-        self._device_type: DeviceType = DeviceType.OTB_QUATTROCENTO_LIGHT
+        # Device Paramters
+        self._device_type: DeviceType = DeviceType.OTB_QUATTROCENTO
 
         # Device Information
-        self._number_of_channels: int = 408  # Fix value
-        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._bytes_per_sample: int = 2  # Fix value
-        # Quattrocento unique parameters
-        self._streaming_frequency: int | None = None
+        self._number_of_streamed_channels: int = None
 
         # Connection Parameters
         self._interface: QTcpSocket = QTcpSocket()
 
-        # Configuration Parameters
-        self._grids: list[int] | None = None
-        self._grid_size: int = 64  # TODO: This is only valid for the big electrodes
-        self._streaming_frequency_mode: QuattrocentoLightStreamingFrequency | None = (
-            None
+        # Configuration parameters
+        self._acq_sett_configuration: QuattrocentoAcqSettByte = (
+            QuattrocentoAcqSettByte()
+        )
+        self._input_top_left_configuration: QuattrocentoINXConf2Byte = (
+            QuattrocentoINXConf2Byte()
+        )
+        self._input_top_right_configuration: QuattrocentoINXConf2Byte = (
+            QuattrocentoINXConf2Byte()
+        )
+        self._multiple_input_one_configuration: QuattrocentoINXConf2Byte = (
+            QuattrocentoINXConf2Byte()
         )
-        self._sampling_frequency_mode: QuattrocentoLightSamplingFrequency | None = None
+        self._multiple_input_two_configuration: QuattrocentoINXConf2Byte = (
+            QuattrocentoINXConf2Byte()
+        )
+        self._multiple_input_three_configuration: QuattrocentoINXConf2Byte = (
+            QuattrocentoINXConf2Byte()
+        )
+        self._multiple_input_four_configuration: QuattrocentoINXConf2Byte = (
+            QuattrocentoINXConf2Byte()
+        )
+        self._grid_size: int = 64  # TODO: This is only valid for the big electrodes
+        self._grids: list[int] | None = None
+
+        self._configuration_command: bytearray = bytearray(40)
 
     def _connect_to_device(self) -> bool:
         super()._connect_to_device()
@@ -87,11 +98,9 @@ class OTBQuattrocentoLight(BaseDevice):
 
     def _make_request(self) -> bool:
         super()._make_request()
-        # Signal self.connect_toggled is emitted in _read_data
+
         self._interface.connectToHost(
-            QHostAddress(self._connection_settings[0]),
-            self._connection_settings[1],
-            QIODevice.ReadWrite,
+            QHostAddress(self._connection_settings[0]), self._connection_settings[1]
         )
 
         if not self._interface.waitForConnected(1000):
@@ -100,6 +109,9 @@ class OTBQuattrocentoLight(BaseDevice):
 
         self._interface.readyRead.connect(self._read_data)
 
+        self.is_connected = True
+        self.connect_toggled.emit(self.is_connected)
+
         return True
 
     def _disconnect_from_device(self) -> None:
@@ -110,11 +122,75 @@ class OTBQuattrocentoLight(BaseDevice):
         self._interface.close()
 
     def configure_device(
-        self, settings: Dict[str, Union[Enum, Dict[str, Enum]]]  # type: ignore
-    ) -> None:
-        super().configure_device(settings)
+        self, params: Dict[str, Union[Enum, Dict[str, Enum]]]  # type: ignore
+    ):
+        super().configure_device(params)
+
+        self._sampling_frequency = self._acq_sett_configuration.get_sampling_frequency()
+        self._number_of_streamed_channels = (
+            self._acq_sett_configuration.get_number_of_channels()
+        )
 
+        self._configuration_command = bytearray(40)
         # Configure the device
+        # Byte 1: ACQ_SETT
+        self._configuration_command[0] = int(self._acq_sett_configuration)
+
+        # Byte 2: Configure AN_OUT_IN_SEL
+        self._configuration_command[1] = 0  # TODO:
+
+        # Byte 3: Configure AN_OUT_CH_SEL
+        self._configuration_command[2] = 0  # TODO:
+
+        # Byte 4-15: Configure IN1-4 -> TODO: change that to individual configuration
+        for i in range(4):
+            config = int(self._input_top_left_configuration)
+            self._configuration_command[3 + i * 3] = (config >> 16) & 0xFF
+            self._configuration_command[4 + i * 3] = (config >> 8) & 0xFF
+            self._configuration_command[5 + i * 3] = config & 0xFF
+
+        # Byte 16-27: Configure IN5-8 -> TODO: change that to individual configuration
+        for i in range(4):
+            config = int(self._input_top_right_configuration)
+            self._configuration_command[15 + i * 3] = (config >> 16) & 0xFF
+            self._configuration_command[16 + i * 3] = (config >> 8) & 0xFF
+            self._configuration_command[17 + i * 3] = config & 0xFF
+
+        # Byte 28-30: Configure MULTIPLE IN 1
+        config = int(self._multiple_input_one_configuration)
+        self._configuration_command[27] = (config >> 16) & 0xFF
+        self._configuration_command[28] = (config >> 8) & 0xFF
+        self._configuration_command[29] = config & 0xFF
+
+        # Byte 31-33: Configure MULTIPLE IN 2
+        config = int(self._multiple_input_two_configuration)
+        self._configuration_command[30] = (config >> 16) & 0xFF
+        self._configuration_command[31] = (config >> 8) & 0xFF
+        self._configuration_command[32] = config & 0xFF
+
+        # Byte 34-36: Configure MULTIPLE IN 3
+        config = int(self._multiple_input_three_configuration)
+        self._configuration_command[33] = (config >> 16) & 0xFF
+        self._configuration_command[34] = (config >> 8) & 0xFF
+        self._configuration_command[35] = config & 0xFF
+
+        # Byte 37-39: Configure MULTIPLE IN 4
+        config = int(self._multiple_input_four_configuration)
+        self._configuration_command[36] = (config >> 16) & 0xFF
+        self._configuration_command[37] = (config >> 8) & 0xFF
+        self._configuration_command[38] = config & 0xFF
+
+        # Control Byte
+        self._configuration_command[39] = self._crc_check(
+            self._configuration_command, 39
+        )
+
+        self._number_of_channels = (
+            len(self._grids) * self._grid_size
+            + QUATTROCENTO_AUXILIARY_CHANNELS
+            + QUATTROCENTO_SUPPLEMENTARY_CHANNELS
+        )
+
         self._number_of_biosignal_channels = len(self._grids) * self._grid_size
         self._biosignal_channel_indices = np.array(
             [
@@ -123,64 +199,110 @@ class OTBQuattrocentoLight(BaseDevice):
                 for j in range(self._grid_size)
             ]
         )
-
-        self._auxiliary_channel_indices = np.array(
-            [
-                i + self._auxiliary_channel_start_index
-                for i in range(self._number_of_auxiliary_channels)
-            ]
+        self._number_of_auxiliary_channels = QUATTROCENTO_AUXILIARY_CHANNELS
+        self._auxiliary_channel_indices = np.arange(
+            self._number_of_streamed_channels
+            - self._number_of_auxiliary_channels
+            - QUATTROCENTO_SUPPLEMENTARY_CHANNELS,
+            self._number_of_streamed_channels - QUATTROCENTO_SUPPLEMENTARY_CHANNELS,
         )
 
-        self._streaming_frequency = QUATTROCENTO_LIGHT_STREAMING_FREQUENCY_DICT[
-            self._streaming_frequency_mode
-        ]
-        self._sampling_frequency = QUATTROCENTO_SAMPLING_FREQUENCY_DICT[
-            self._sampling_frequency_mode
-        ]
+        self._samples_per_frame = QUATTROCENTO_SAMPLES_PER_FRAME
+        self._bytes_per_sample = QUATTROCENTO_BYTES_PER_SAMPLE
+        self._buffer_size = (
+            self._number_of_streamed_channels * self._bytes_per_sample
+        ) * self._samples_per_frame
 
-        self._samples_per_frame = self._sampling_frequency // self._streaming_frequency
+        self._send_configuration_to_device()
 
-        self._buffer_size = (
-            self._bytes_per_sample * self._number_of_channels * self._samples_per_frame
-        )
+    def _crc_check(self, command_bytes: bytearray, command_length: int) -> bytes:
+        """
+        Performs the Cyclic Redundancy Check (CRC) of the transmitted bytes.
 
-        self._is_configured = True
-        self.configure_toggled.emit(True)
+        Translated function from example code provided by OT Bioelettronica.
 
-    def _start_streaming(self) -> None:
-        super()._start_streaming()
+        Args:
+            command_bytes (bytearray):
+                Bytearray of the transmitted bytes.
+
+            command_length (int):
+                Length of the transmitted bytes.
+
+        Returns:
+            bytes:
+                CRC of the transmitted bytes.
+        """
+
+        crc = 0
+        j = 0
+
+        while command_length > 0:
+            extracted_byte = command_bytes[j]
+            for i in range(8, 0, -1):
+                sum = crc % 2 ^ extracted_byte % 2
+                crc = crc // 2
+
+                if sum > 0:
+                    crc_bin = format(crc, "08b")
+                    a_bin = format(140, "08b")
 
-        self._interface.write(COMMAND_START_STREAMING)
+                    str_list = []
+
+                    for k in range(8):
+                        str_list.append("0" if crc_bin[k] == a_bin[k] else "1")
+
+                    crc = int("".join(str_list), 2)
+
+                extracted_byte = extracted_byte // 2
+
+            command_length -= 1
+            j += 1
+
+        return crc
+
+    def _send_configuration_to_device(self) -> None:
+        success = self._interface.write(self._configuration_command)
+
+        if success == -1:
+            print("Error while sending configuration to device")
+
+        self._is_configured = True
+        self.configure_toggled.emit(self._is_configured)
 
     def _stop_streaming(self) -> None:
         super()._stop_streaming()
 
-        self._interface.write(COMMAND_STOP_STREAMING)
-        self._interface.waitForBytesWritten(1000)
+        self._configuration_command[0] -= 1
+        self._configuration_command[39] = self._crc_check(
+            self._configuration_command, 39
+        )
+        self._send_configuration_to_device()
 
-    def clear_socket(self) -> None:
-        super().clear_socket()
+    def _start_streaming(self) -> None:
+        super()._start_streaming()
 
-        self._interface.readAll()
+        self._configuration_command[0] += 1
+        self._configuration_command[39] = self._crc_check(
+            self._configuration_command, 39
+        )
+        self._send_configuration_to_device()
 
-    def _read_data(self) -> None:
-        super()._read_data()
+        self._is_streaming = True
+        self.stream_toggled.emit(self._is_streaming)
 
-        # Wait for connection response
-        if not self._is_connected:
-            if self._interface.bytesAvailable() == len(CONNECTION_RESPONSE):
-                if self._interface.readAll() == CONNECTION_RESPONSE:
+    def clear_socket(self) -> None:
+        if self._interface is not None:
+            self._interface.readAll()
 
-                    self._is_connected = True
-                    self.connect_toggled.emit(True)
-                    return
+    def _read_data(self) -> None:
+        super()._read_data()
 
         if not self._is_streaming:
             self.clear_socket()
             return
 
         while self._interface.bytesAvailable() > self._buffer_size:
-            packet = self._interface.read(self._buffer_size)
+            packet = self._interface.readAll()
             if not packet:
                 continue
 
@@ -191,45 +313,20 @@ 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)
-
-        # Reshape it to the correct format
-        processed_data = decoded_data.reshape(
-            self._number_of_channels, -1, order="F"
+        data = np.frombuffer(input, dtype="<i2")
+        reshaped_data = data.reshape(
+            (self._number_of_streamed_channels, -1), order="F"
         ).astype(np.float32)
 
-        # Emit the data
-        self.data_available.emit(processed_data)
-        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]:
-        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.
-    """
+        biosignal_data = self._extract_biosignal_data(reshaped_data)
+        auxiliary_data = self._extract_auxiliary_data(reshaped_data)
+        supplementary_data = reshaped_data[-QUATTROCENTO_SUPPLEMENTARY_CHANNELS:]
 
-    def __init__(
-        self,
-        parent: Union[QMainWindow, QWidget] = None,
-    ) -> None:
-        super().__init__(parent)
+        processed_data = np.vstack((biosignal_data, auxiliary_data, supplementary_data))
 
-        # 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()
+        self.data_available.emit(processed_data)
+        self.biosignal_data_available.emit(biosignal_data)
+        self.auxiliary_data_available.emit(auxiliary_data)

biosignal_device_interface/devices/otb/otb_quattrocento_light.py

@@ -0,0 +1,210 @@
+"""
+Quattrocento Light class for real-time interface to 
+Quattrocento using OT Biolab Light.
+
+Developer: Dominik I. Braun
+Contact: dome.braun@fau.de
+Last Update: 2023-06-05
+"""
+
+# Python Libraries
+from __future__ import annotations
+from typing import TYPE_CHECKING, Union, Dict
+from PySide6.QtNetwork import QTcpSocket, QHostAddress
+from PySide6.QtCore import QIODevice
+import numpy as np
+
+
+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.otb_quattrocento_light_constants import (
+    COMMAND_START_STREAMING,
+    COMMAND_STOP_STREAMING,
+    CONNECTION_RESPONSE,
+    QUATTROCENTO_LIGHT_STREAMING_FREQUENCY_DICT,
+    QUATTROCENTO_SAMPLING_FREQUENCY_DICT,
+    QuattrocentoLightSamplingFrequency,
+    QuattrocentoLightStreamingFrequency,
+)
+
+
+if TYPE_CHECKING:
+    # Python Libraries
+    from PySide6.QtWidgets import QMainWindow, QWidget
+    from aenum import Enum
+
+
+class OTBQuattrocentoLight(BaseDevice):
+    """
+    QuattrocentoLight device class derived from BaseDevice class.
+    The QuattrocentoLight is using a TCP/IP protocol to communicate with the device.
+
+    This class directly interfaces with the OT Biolab Light software from
+    OT Bioelettronica. The configured settings of the device have to
+    match the settings from the OT Biolab Light software!
+    """
+
+    def __init__(
+        self,
+        parent: Union[QMainWindow, QWidget] = None,
+    ) -> None:
+        super().__init__(parent)
+
+        # Device Parameters
+        self._device_type: DeviceType = DeviceType.OTB_QUATTROCENTO_LIGHT
+
+        # Device Information
+        self._number_of_channels: int = 408  # Fix value
+        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._bytes_per_sample: int = 2  # Fix value
+        # Quattrocento unique parameters
+        self._streaming_frequency: int | None = None
+
+        # Connection Parameters
+        self._interface: QTcpSocket = QTcpSocket()
+
+        # Configuration Parameters
+        self._grids: list[int] | None = None
+        self._grid_size: int = 64  # TODO: This is only valid for the big electrodes
+        self._streaming_frequency_mode: QuattrocentoLightStreamingFrequency | None = (
+            None
+        )
+        self._sampling_frequency_mode: QuattrocentoLightSamplingFrequency | None = None
+
+    def _connect_to_device(self) -> bool:
+        super()._connect_to_device()
+
+        self._received_bytes: bytearray = bytearray()
+        return self._make_request()
+
+    def _make_request(self) -> bool:
+        super()._make_request()
+        # Signal self.connect_toggled is emitted in _read_data
+        self._interface.connectToHost(
+            QHostAddress(self._connection_settings[0]),
+            self._connection_settings[1],
+            QIODevice.ReadWrite,
+        )
+
+        if not self._interface.waitForConnected(1000):
+            self._disconnect_from_device()
+            return False
+
+        self._interface.readyRead.connect(self._read_data)
+
+        return True
+
+    def _disconnect_from_device(self) -> None:
+        super()._disconnect_from_device()
+
+        self._interface.disconnectFromHost()
+        self._interface.readyRead.disconnect(self._read_data)
+        self._interface.close()
+
+    def configure_device(
+        self, params: Dict[str, Union[Enum, Dict[str, Enum]]]  # type: ignore
+    ) -> None:
+        super().configure_device(params)
+
+        # Configure the device
+        self._number_of_biosignal_channels = len(self._grids) * self._grid_size
+        self._biosignal_channel_indices = np.array(
+            [
+                i * self._grid_size + j
+                for i in self._grids
+                for j in range(self._grid_size)
+            ]
+        )
+
+        self._auxiliary_channel_indices = np.array(
+            [
+                i + self._auxiliary_channel_start_index
+                for i in range(self._number_of_auxiliary_channels)
+            ]
+        )
+
+        self._streaming_frequency = QUATTROCENTO_LIGHT_STREAMING_FREQUENCY_DICT[
+            self._streaming_frequency_mode
+        ]
+        self._sampling_frequency = QUATTROCENTO_SAMPLING_FREQUENCY_DICT[
+            self._sampling_frequency_mode
+        ]
+
+        self._samples_per_frame = self._sampling_frequency // self._streaming_frequency
+
+        self._buffer_size = (
+            self._bytes_per_sample * self._number_of_channels * self._samples_per_frame
+        )
+
+        self._is_configured = True
+        self.configure_toggled.emit(True)
+
+    def _start_streaming(self) -> None:
+        super()._start_streaming()
+
+        self._interface.write(COMMAND_START_STREAMING)
+
+    def _stop_streaming(self) -> None:
+        super()._stop_streaming()
+
+        self._interface.write(COMMAND_STOP_STREAMING)
+        self._interface.waitForBytesWritten(1000)
+
+    def clear_socket(self) -> None:
+        super().clear_socket()
+
+        self._interface.readAll()
+
+    def _read_data(self) -> None:
+        super()._read_data()
+
+        # Wait for connection response
+        if not self.is_connected and (
+            self._interface.bytesAvailable() == len(CONNECTION_RESPONSE)
+            and self._interface.readAll() == CONNECTION_RESPONSE
+        ):
+            self.is_connected = True
+            self.connect_toggled.emit(True)
+            return
+        if not self._is_streaming:
+            self.clear_socket()
+            return
+
+        while self._interface.bytesAvailable() > self._buffer_size:
+            packet = self._interface.read(self._buffer_size)
+            if not packet:
+                continue
+
+            self._received_bytes.extend(packet)
+
+            while len(self._received_bytes) >= self._buffer_size:
+                data_to_process = self._received_bytes[: self._buffer_size]
+                self._process_data(data_to_process)
+                self._received_bytes = self._received_bytes[self._buffer_size :]
+
+    def _process_data(self, input: bytearray) -> None:
+        super()._process_data(input)
+
+        # Decode the data
+        decoded_data = np.frombuffer(input, dtype=np.int16)
+
+        # Reshape it to the correct format
+        processed_data = decoded_data.reshape(
+            self._number_of_channels, -1, order="F"
+        ).astype(np.float32)
+
+        # Emit the data
+        self.data_available.emit(processed_data)
+
+        biosignal_data = self._extract_biosignal_data(processed_data)
+        self.biosignal_data_available.emit(biosignal_data)
+        auxiliary_data = self._extract_auxiliary_data(processed_data)
+        self.auxiliary_data_available.emit(auxiliary_data)
+
+    def get_device_information(self) -> Dict[str, Enum | int | float | str]:  # type: ignore
+        return super().get_device_information()