aidlabsdk 2.0.1__tar.gz

aidlabsdk-2.0.1/LICENSE.md

@@ -0,0 +1,17 @@
+MIT License
+Copyright (c) 2016-2024 Aidlab
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

aidlabsdk-2.0.1/MANIFEST.in

@@ -0,0 +1,4 @@
+include aidlab/aidlabsdk-linux-gnu.so
+include aidlab/aidlabsdk-linux-gnueabihf.so
+include aidlab/aidlabsdk.dylib
+include aidlab/aidlabsdk.dll

aidlabsdk-2.0.1/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.1
+Name: aidlabsdk
+Version: 2.0.1
+Summary: Comprehensive SDK for integrating Aidlab's and Aidmed One's biofeedback and biosignal processing functionalities into your applications.
+Home-page: https://www.aidlab.com
+Author: Aidlab
+Author-email: contact@aidlab.com
+License: MIT License
+        Copyright (c) 2016-2024 Aidlab
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Keywords: biofeedback,aidlab,aidmed,wearable technology,fitness,data analysis,healthcare,biomedical,chest strap,sdk,signals,biosignals,heart rate,ecg
+Platform: UNKNOWN
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+
+Aidlab SDK simplifies the communication process with Aidlab and Aidmed One. The SDK also provides algorithms to manipulate received data so you don’t have to reinvent the wheel.
+

aidlabsdk-2.0.1/README.md

@@ -0,0 +1 @@
+Aidlab SDK simplifies the communication process with Aidlab and Aidmed One. The SDK also provides algorithms to manipulate received data so you don’t have to reinvent the wheel.

aidlabsdk-2.0.1/aidlab/__init__.py

@@ -0,0 +1,12 @@
+"""
+Aidlab Python SDK
+"""
+from .aidlab_manager import AidlabManager
+from .data_type import DataType
+from .device import Device
+from .device_delegate import DeviceDelegate
+from .wear_state import WearState
+from .body_position import BodyPosition
+from .activity_type import ActivityType
+
+__all__ = ["AidlabManager", "Device", "DeviceDelegate", "DataType", "WearState", "BodyPosition", "ActivityType"]

aidlabsdk-2.0.1/aidlab/activity_type.py

@@ -0,0 +1,25 @@
+"""
+Created by Jakub Domaszewicz on 16.03.2024.
+"""
+
+from enum import IntEnum
+
+class ActivityType(IntEnum):
+    """
+    Enumerates the possible types of activities that can be recognized by the device.
+
+    Attributes:
+        UNKNOWN (0): The activity is unknown or not recognized.
+        AUTOMOTIVE (1): The user is in a vehicle, such as a car, bus, or train.
+        WALKING (2): The user is walking.
+        RUNNING (4): The user is running.
+        CYCLING (8): The user is cycling.
+        STILL (16): The user is still, i.e. not moving.
+        
+    """
+    UNKNOWN = 0
+    AUTOMOTIVE = 1
+    WALKING = 2
+    RUNNING = 4
+    CYCLING = 8
+    STILL = 16

aidlabsdk-2.0.1/aidlab/aidlab_manager.py

@@ -0,0 +1,45 @@
+"""
+Part of the Aidlab Python SDK, providing the core functionality for scanning compatible devices.
+
+To customise logging, configure the standard Python logging system in your
+application, for example:
+
+    logging.getLogger("aidlab.aidlab_manager").setLevel(logging.INFO)
+
+Created by Szymon Gesicki on 09.05.2020.
+"""
+
+import logging
+from bleak import BleakScanner
+from .device import Device
+
+logger = logging.getLogger(__name__)
+
+
+class AidlabManager:
+    """
+    The central class of the Aidlab SDK for scanning compatible devices.
+    """
+
+    async def scan(self, timeout: int = 10) -> list[Device]:
+        """
+        Scans for compatible devices.
+
+        :param timeout: The time in seconds to scan for devices.
+        """
+
+        logger.info("Scanning for devices (timeout: %d seconds)...", timeout)
+
+        devices = await BleakScanner.discover(timeout)
+
+        # Container for compatible MAC addresses
+        compatible_devices: list[Device] = []
+
+        for device in devices:
+            # Name "Aidlab" is applicable for both Aidlab and Aidmed One
+            if (device.name == "Aidlab 2" or device.name == "Aidlab") and device.address:
+                compatible_devices.append(Device(device))
+
+        logger.info("Finished scanning. Found %d devices.", len(compatible_devices))
+
+        return compatible_devices

aidlabsdk-2.0.1/aidlab/body_position.py

@@ -0,0 +1,23 @@
+"""
+Created by Jakub Domaszewicz on 17.12.2023.
+"""
+
+from enum import IntEnum
+
+class BodyPosition(IntEnum):
+    """
+    Enumerates the possible positions of a body when lying on a bed with a device. 
+    Each value represents a specific orientation of the body relative to the bed.
+
+    Attributes:
+        UNKNOWN (0): The body's position is unknown or not recognized.
+        PRONE (1): The body is lying face down on its stomach.
+        SUPINE (2): The body is lying face up on its back.
+        LEFT_SIDE (3): The body is lying on its left side.
+        RIGHT_SIDE (4): The body is lying on its right side.
+    """
+    UNKNOWN = 0
+    PRONE = 1
+    SUPINE = 2
+    LEFT_SIDE = 3
+    RIGHT_SIDE = 4

aidlabsdk-2.0.1/aidlab/data_type.py

@@ -0,0 +1,29 @@
+"""
+Created by Szymon Gesicki on 07.11.2021.
+"""
+
+from enum import IntEnum
+
+class DataType(IntEnum):
+    """
+    Data types that can be received from Aidlab and Aidmed One.
+    See the documentation to learn more about each data type.
+    """
+    ECG = 0
+    RESPIRATION = 1
+    SKIN_TEMPERATURE = 2
+    MOTION = 3
+    # BATTERY = 4 # Enabled by default since SDK 1.6.0
+    ACTIVITY = 5
+    ORIENTATION = 6
+    STEPS = 7
+    HEART_RATE = 8
+    # HEALTH_THERMOMETER = 9 # No longer in use. Use SKIN_TEMPERATURE instead.
+    SOUND_VOLUME = 10
+    RR = 11
+    PRESSURE = 12 # Supported since Firmware 3.0.0. No longer available as characteristic.
+    SOUND_FEATURES = 13
+    RESPIRATION_RATE = 14
+    BODY_POSITION = 15
+    EDA = 16
+    GPS = 17