py-neuromodulation 0.0.2__py3-none-any.whl → 0.0.3__py3-none-any.whl

packages/tmsi/build/lib/apex_sdk/device/tmsi_device_enums.py

@@ -0,0 +1,103 @@
+"""
+(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+#######  #     #   #####   #
+   #     ##   ##  #        
+   #     # # # #  #        #
+   #     #  #  #   #####   #
+   #     #     #        #  #
+   #     #     #        #  #
+   #     #     #  #####    #
+
+/**
+ * @file tmsi_device_enums.py 
+ * @brief 
+ * Enumerable classes useful for the use of the SDK.
+ */
+
+
+"""
+
+from enum import Enum, unique
+from .devices.apex.measurements.eeg_measurement import EEGMeasurement
+from .devices.apex.measurements.impedance_measurement import (
+    ImpedanceMeasurement,
+)
+from .devices.apex.measurements.download_measurement import DownloadMeasurement
+
+
+@unique
+class DeviceInterfaceType(Enum):
+    none = 0
+    usb = 1
+    network = 2
+    wifi = 3
+    docked = 4
+    optical = 5
+    bluetooth = 6
+    serial = 7
+
+
+@unique
+class DeviceState(Enum):
+    disconnected = 0
+    connected = 1
+    sampling = 2
+
+
+@unique
+class PairingStatus(Enum):
+    no_pairing_needed = 0
+    paired = 1
+    not_paired = 2
+
+
+@unique
+class ChannelType(Enum):
+    unknown = 0
+    UNI = 1
+    BIP = 2
+    AUX = 3
+    sensor = 4
+    status = 5
+    counter = 6
+    impedance = 7
+    cycling_status = 8
+    all_types = 9
+
+
+@unique
+class ReferenceMethod(Enum):
+    common = 0
+    average = 1
+
+
+@unique
+class DeviceType(Enum):
+    none = 0
+    saga = 1
+    apex = 2
+
+
+@unique
+class ReferenceSwitch(Enum):
+    fixed = 0
+    auto = 1
+
+
+class MeasurementType:
+    APEX_EEG = EEGMeasurement
+    APEX_IMPEDANCE = ImpedanceMeasurement
+    APEX_DOWNLOAD = DownloadMeasurement

packages/tmsi/build/lib/apex_sdk/device/tmsi_dongle.py

@@ -0,0 +1,43 @@
+"""
+(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+#######  #     #   #####   #
+   #     ##   ##  #        
+   #     # # # #  #        #
+   #     #  #  #   #####   #
+   #     #     #        #  #
+   #     #     #        #  #
+   #     #     #  #####    #
+
+/**
+ * @file tmsi_dongle.py 
+ * @brief 
+ * TMSi Dongle interface.
+ */
+
+
+"""
+
+
+class TMSiDongle:
+    def __init__(self, dongle_id, serial_number):
+        self.__dongle_id = dongle_id
+        self.__serial_number = serial_number
+
+    def get_id(self):
+        return self.__dongle_id
+
+    def get_serial_number(self):
+        return self.__serial_number

packages/tmsi/build/lib/apex_sdk/device/tmsi_event_reader.py

@@ -0,0 +1,50 @@
+"""
+(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+#######  #     #   #####   #
+   #     ##   ##  #        
+   #     # # # #  #        #
+   #     #  #  #   #####   #
+   #     #     #        #  #
+   #     #     #        #  #
+   #     #     #  #####    #
+
+/**
+ * @file tmsi_event_reader.py 
+ * @brief 
+ * Event reader interface.
+ */
+
+
+"""
+
+from .threads.sampling_thread import SamplingThread
+
+
+class TMSiEventReader:
+    def __init__(self, name="Event Reader"):
+        self._name = name
+        self._reading_thread = SamplingThread(
+            sampling_function=self._reading_function, pause=0.5
+        )
+
+    def start(self):
+        raise NotImplementedError("method not available for this reader")
+
+    def stop(self):
+        self._reading_thread.stop()
+
+    def _reading_function(self):
+        raise NotImplementedError("method not available for this reader")

packages/tmsi/build/lib/apex_sdk/device/tmsi_measurement.py

@@ -0,0 +1,118 @@
+"""
+(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+#######  #     #   #####   #
+   #     ##   ##  #        
+   #     # # # #  #        #
+   #     #  #  #   #####   #
+   #     #     #        #  #
+   #     #     #        #  #
+   #     #     #  #####    #
+
+/**
+ * @file tmsi_measurement.py 
+ * @brief 
+ * Measurement interface.
+ */
+
+
+"""
+
+from ctypes import *
+import queue
+import time
+
+from ..tmsi_utilities.decorators import LogPerformances
+from ..tmsi_utilities.tmsi_logger import TMSiLogger as logger
+from .threads.sampling_thread import SamplingThread
+from .threads.conversion_thread import ConversionThread
+
+
+class TMSiMeasurement:
+    def __init__(self, dev, name="TMSi Measurement"):
+        self._dev = dev
+        self._name = name
+        self._downloaded_samples = 0
+        self._download_percentage = 0
+        self._download_samples_limit = None
+        self._sample_data_buffer_size = 409600
+        self._retrieved_sample_sets = (c_uint)(0)
+        self._retrieved_data_type = (c_int)(0)
+        __MAX_SIZE_CONVERSION_QUEUE = 50
+        self._conversion_queue = queue.Queue(__MAX_SIZE_CONVERSION_QUEUE)
+        self._empty_read_counter = 0
+        self._tic_timeout = None
+        self._timeout = 3
+        self._disable_live_impedance = 0
+        self._disable_average_reference_calculation = 0
+        self._float_channels = []
+        channels = self._dev.get_device_channels()
+        for i in range(len(channels)):
+            if channels[i].get_channel_format() == 0x0020:
+                self._float_channels.append(i)
+        self._sampling_thread = SamplingThread(
+            sampling_function=self._sampling_function, pause=0.01
+        )
+        self._conversion_thread = ConversionThread(
+            conversion_function=self._conversion_function, pause=0.01
+        )
+
+    @LogPerformances
+    def get_conversion_pause(self):
+        return self._conversion_thread.get_pause()
+
+    @LogPerformances
+    def get_sampling_pause(self):
+        return self._sampling_thread.get_pause()
+
+    @LogPerformances
+    def is_timeout(self):
+        if self._tic_timeout is None:
+            return False
+        return self._timeout < time.perf_counter() - self._tic_timeout
+
+    @LogPerformances
+    def get_download_percentage(self):
+        return self._download_percentage
+
+    @LogPerformances
+    def set_conversion_pause(self, pause):
+        logger().debug("conversion pause set to {}".format(pause))
+        self._conversion_thread.set_pause(pause)
+
+    @LogPerformances
+    def set_download_samples_limit(self, max_number_of_samples=None):
+        self._download_samples_limit = max_number_of_samples - 1
+
+    @LogPerformances
+    def set_sampling_pause(self, pause):
+        logger().debug("sampling pause set to {}".format(pause))
+        self._sampling_thread.set_pause(pause)
+
+    @LogPerformances
+    def start(self):
+        raise NotImplementedError("method not available for this measurement")
+
+    @LogPerformances
+    def stop(self):
+        raise NotImplementedError("method not available for this measurement")
+
+    @LogPerformances
+    def _conversion_function(self):
+        raise NotImplementedError("method not available for this measurement")
+
+    @LogPerformances
+    def _sampling_function(self):
+        raise NotImplementedError("method not available for this measurement")

packages/tmsi/build/lib/apex_sdk/sample_data_server/__init__.py

@@ -0,0 +1,33 @@
+"""
+(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+#######  #     #   #####   #
+   #     ##   ##  #        
+   #     # # # #  #        #
+   #     #  #  #   #####   #
+   #     #     #        #  #
+   #     #     #        #  #
+   #     #     #  #####    #
+
+/**
+ * @file __init__.py 
+ * @brief 
+ * Initialization of the sample data server.
+ */
+
+
+"""
+
+from .sample_data_server import SampleDataServer

packages/tmsi/build/lib/apex_sdk/sample_data_server/event_data.py

@@ -0,0 +1,44 @@
+"""
+(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+#######  #     #   #####   #
+   #     ##   ##  #        
+   #     # # # #  #        #
+   #     #  #  #   #####   #
+   #     #     #        #  #
+   #     #     #        #  #
+   #     #     #  #####    #
+
+/**
+ * @file event_data.py 
+ * @brief 
+ * Event data structure.
+ */
+
+
+"""
+
+from ..device.devices.apex.apex_API_structures import TMSiEvent
+
+
+class EventData:
+    def __init__(self, event: TMSiEvent):
+        self.event = event
+
+
+class EventDataConsumer:
+    def __init__(self, id, q):
+        self.id = id
+        self.q = q

packages/tmsi/build/lib/apex_sdk/sample_data_server/sample_data.py

@@ -0,0 +1,50 @@
+"""
+(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+#######  #     #   #####   #
+   #     ##   ##  #        
+   #     # # # #  #        #
+   #     #  #  #   #####   #
+   #     #     #        #  #
+   #     #     #        #  #
+   #     #     #  #####    #
+
+/**
+ * @file sample_data.py 
+ * @brief 
+ * Sample data structure.
+ */
+
+
+"""
+
+
+class SampleSet:
+    def __init__(self, num_samples, samples):
+        self.num_samples = num_samples
+        self.samples = samples
+
+
+class SampleData:
+    def __init__(self, num_sample_sets, num_samples_per_sample_set, samples):
+        self.num_sample_sets = num_sample_sets
+        self.num_samples_per_sample_set = num_samples_per_sample_set
+        self.samples = samples
+
+
+class SampleDataConsumer:
+    def __init__(self, id, q):
+        self.id = id
+        self.q = q

packages/tmsi/build/lib/apex_sdk/sample_data_server/sample_data_server.py

@@ -0,0 +1,136 @@
+"""
+(c) 2022 Twente Medical Systems International B.V., Oldenzaal The Netherlands
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+#######  #     #   #####   #
+   #     ##   ##  #        
+   #     # # # #  #        #
+   #     #  #  #   #####   #
+   #     #     #        #  #
+   #     #     #        #  #
+   #     #     #  #####    #
+
+/**
+ * @file sample_data_server.py 
+ * @brief 
+ * Singleton class which handles the acquisition of data from the device and make them available to consumers.
+ */
+
+
+"""
+
+from queue import Queue
+from copy import copy
+
+from ..sample_data_server.sample_data import SampleDataConsumer, SampleData
+from ..sample_data_server.event_data import EventDataConsumer, EventData
+from ..tmsi_utilities.singleton import Singleton
+
+
+class SampleDataServer(metaclass=Singleton):
+    def __init__(self):
+        self.__consumer_list = []
+        self.__event_consumer_list = []
+
+    def get_consumer_list(self) -> list[SampleDataConsumer]:
+        """Gets the list of available consumer.
+
+        :return: list of available consumers.
+        :rtype: list[SampleDataConsumer]
+        """
+        return self.__consumer_list
+
+    def get_event_consumer_list(self) -> list[EventDataConsumer]:
+        """Gets the list of available event consumer.
+
+        :return: list of available event consumers.
+        :rtype: list[EventDataConsumer]
+        """
+        return self.__event_consumer_list
+
+    def put_event_data(self, id: int, data: EventData):
+        """Puts event in the corresponding event consumer.
+
+        :param id: id of the provider the event consumer is reading.
+        :type id: int
+        :param data: event to deliver to the event consumer.
+        :type data: EventData
+        """
+        num_consumers = len(self.__event_consumer_list)
+        for i in range(num_consumers):
+            if self.__event_consumer_list[i].id == id:
+                self.__event_consumer_list[i].q.put(data)
+
+    def put_sample_data(self, id: int, data: SampleData):
+        """Puts data in the corresponding consumer.
+
+        :param id: id of the provider the consumer is reading.
+        :type id: int
+        :param data: data to deliver to the consumer.
+        :type data: SampleData
+        """
+        num_consumers = len(self.__consumer_list)
+        for i in range(num_consumers):
+            if self.__consumer_list[i].id == id:
+                self.__consumer_list[i].q.put(data)
+
+    def register_consumer(self, id: int, q: Queue):
+        """Creates the new consumer and registers it to the list of consumers.
+
+        :param id: id of the provider.
+        :type id: int
+        :param q: queue of the consumer.
+        :type q: Queue
+        """
+        self.__consumer_list.append(SampleDataConsumer(id, q))
+
+    def register_event_consumer(self, id: int, q: Queue):
+        """Creates the new event consumer and registers it to the list of event consumers.
+
+        :param id: id of the provider.
+        :type id: int
+        :param q: queue of the event consumer.
+        :type q: Queue
+        """
+        self.__event_consumer_list.append(EventDataConsumer(id, q))
+
+    def unregister_consumer(self, id: int, q: Queue):
+        """Unregister the queue from the list of consumers.
+
+        :param id: if of the provider.
+        :type id: int
+        :param q: queue of the consumer.
+        :type q: Queue
+        """
+        num_consumers = len(self.__consumer_list)
+        for i in range(num_consumers):
+            if self.__consumer_list[i].id == id:
+                if self.__consumer_list[i].q == q:
+                    idx_remove = copy(i)
+        self.__consumer_list.pop(idx_remove)
+
+    def unregister_event_consumer(self, id: int, q: Queue):
+        """Unregister the queue from the list of event consumers.
+
+        :param id: if of the provider.
+        :type id: int
+        :param q: queue of the event consumer.
+        :type q: Queue
+        """
+        num_consumers = len(self.__event_consumer_list)
+        for i in range(num_consumers):
+            if self.__event_consumer_list[i].id == id:
+                if self.__event_consumer_list[i].q == q:
+                    idx_remove = copy(i)
+        self.__event_consumer_list.pop(idx_remove)