sensor-sdk 0.0.71__tar.gz → 0.1.1__tar.gz

{sensor_sdk-0.0.71/sensor_sdk.egg-info → sensor_sdk-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sensor-sdk
-Version: 0.0.71
+Version: 0.1.1
 Summary: Python sdk for Synchroni
 Home-page: https://github.com/oymotion/SynchroniSDKPython
 Author: Martin Ye
@@ -208,6 +208,8 @@ success = sensorProfile.connect()
 
 Use `def disconnect() -> bool` to disconnect.
 
+If data notification is currently active, `disconnect()` will automatically stop it first before closing the BLE connection.
+
 ```python
 success = sensorProfile.disconnect()
 ```
@@ -369,24 +371,31 @@ Please check async_console.py in examples directory
 
 Use `def setParam(self, key: str, value: str) -> str` to set parameter of sensor profile. Please call after device in 'Ready' state.
 
+The asynchronous variant is `asyncSetParam(self, key: str, value: str) -> str`.
+
+If the device is already streaming when you change an `NTF_*` or `FILTER_*` key, the SDK will stop and restart the data notification so the new setting takes effect immediately.
+
 Below is available key and value:
 
 ```python
+# Data stream toggles
+result = sensorProfile.setParam("NTF_GEST", "ON")
 result = sensorProfile.setParam("NTF_EMG", "ON")
-# set EMG data to ON or OFF, result is "OK" if succeed
-
 result = sensorProfile.setParam("NTF_EEG", "ON")
-# set EEG data to ON or OFF, result is "OK" if succeed
-
 result = sensorProfile.setParam("NTF_ECG", "ON")
-# set ECG data to ON or OFF, result is "OK" if succeed
-
 result = sensorProfile.setParam("NTF_IMU", "ON")
-# set IMU data to ON or OFF, result is "OK" if succeed
-
 result = sensorProfile.setParam("NTF_BRTH", "ON")
-# set BRTH data to ON or OFF, result is "OK" if succeed
-
+result = sensorProfile.setParam("NTF_IMPEDANCE", "ON")
+result = sensorProfile.setParam("NTF_MAG_ANGLE", "ON")
+result = sensorProfile.setParam("NTF_PPG_RAW", "ON")
+result = sensorProfile.setParam("NTF_GFORCE_EULER", "ON")
+result = sensorProfile.setParam("NTF_GFORCE_QUAT", "ON")
+result = sensorProfile.setParam("NTF_GFORCE_ACC", "ON")
+result = sensorProfile.setParam("NTF_GFORCE_GYRO", "ON")
+# set data stream to ON or OFF, result is "OK" if succeed
+# Note: on legacy (non-new) EMG devices, NTF_GEST and NTF_EMG are mutually exclusive.
+
+# Firmware filter toggles
 result = sensorProfile.setParam("FILTER_50HZ", "ON")
 # set 50Hz notch filter to ON or OFF, result is "OK" if succeed
 
@@ -403,3 +412,24 @@ result = sensorProfile.setParam("DEBUG_BLE_DATA_PATH", "d:/temp/test.csv")
 # set debug ble data path, result is "OK" if succeed
 # please give an absolute path and make sure it is valid and writeable by yourself
 ```
+
+
+### getParam method
+
+Use `def getParam(self, key: str) -> str` to query the current parameter state of a sensor profile. Please call after the device reaches the 'Ready' state.
+
+The asynchronous variant is `asyncGetParam(self, key: str) -> str`.
+
+Supported aggregate query keys:
+
+```python
+result = sensorProfile.getParam("FILTER")
+# Returns a pipe-separated string of all filter states, e.g.:
+# "FILTER_50HZ|ON|FILTER_60HZ|ON|FILTER_HPF|ON|FILTER_LPF|ON"
+
+result = sensorProfile.getParam("NTF")
+# Returns a pipe-separated string of all notification states, e.g.:
+# "NTF_BRTH|ON|NTF_ECG|ON|NTF_EEG|ON|NTF_EMG|ON|..."
+```
+
+If the key is not supported, the result starts with `"Error"`.

{sensor_sdk-0.0.71 → sensor_sdk-0.1.1}/README.md

@@ -185,6 +185,8 @@ success = sensorProfile.connect()
 
 Use `def disconnect() -> bool` to disconnect.
 
+If data notification is currently active, `disconnect()` will automatically stop it first before closing the BLE connection.
+
 ```python
 success = sensorProfile.disconnect()
 ```
@@ -346,24 +348,31 @@ Please check async_console.py in examples directory
 
 Use `def setParam(self, key: str, value: str) -> str` to set parameter of sensor profile. Please call after device in 'Ready' state.
 
+The asynchronous variant is `asyncSetParam(self, key: str, value: str) -> str`.
+
+If the device is already streaming when you change an `NTF_*` or `FILTER_*` key, the SDK will stop and restart the data notification so the new setting takes effect immediately.
+
 Below is available key and value:
 
 ```python
+# Data stream toggles
+result = sensorProfile.setParam("NTF_GEST", "ON")
 result = sensorProfile.setParam("NTF_EMG", "ON")
-# set EMG data to ON or OFF, result is "OK" if succeed
-
 result = sensorProfile.setParam("NTF_EEG", "ON")
-# set EEG data to ON or OFF, result is "OK" if succeed
-
 result = sensorProfile.setParam("NTF_ECG", "ON")
-# set ECG data to ON or OFF, result is "OK" if succeed
-
 result = sensorProfile.setParam("NTF_IMU", "ON")
-# set IMU data to ON or OFF, result is "OK" if succeed
-
 result = sensorProfile.setParam("NTF_BRTH", "ON")
-# set BRTH data to ON or OFF, result is "OK" if succeed
-
+result = sensorProfile.setParam("NTF_IMPEDANCE", "ON")
+result = sensorProfile.setParam("NTF_MAG_ANGLE", "ON")
+result = sensorProfile.setParam("NTF_PPG_RAW", "ON")
+result = sensorProfile.setParam("NTF_GFORCE_EULER", "ON")
+result = sensorProfile.setParam("NTF_GFORCE_QUAT", "ON")
+result = sensorProfile.setParam("NTF_GFORCE_ACC", "ON")
+result = sensorProfile.setParam("NTF_GFORCE_GYRO", "ON")
+# set data stream to ON or OFF, result is "OK" if succeed
+# Note: on legacy (non-new) EMG devices, NTF_GEST and NTF_EMG are mutually exclusive.
+
+# Firmware filter toggles
 result = sensorProfile.setParam("FILTER_50HZ", "ON")
 # set 50Hz notch filter to ON or OFF, result is "OK" if succeed
 
@@ -380,3 +389,24 @@ result = sensorProfile.setParam("DEBUG_BLE_DATA_PATH", "d:/temp/test.csv")
 # set debug ble data path, result is "OK" if succeed
 # please give an absolute path and make sure it is valid and writeable by yourself
 ```
+
+
+### getParam method
+
+Use `def getParam(self, key: str) -> str` to query the current parameter state of a sensor profile. Please call after the device reaches the 'Ready' state.
+
+The asynchronous variant is `asyncGetParam(self, key: str) -> str`.
+
+Supported aggregate query keys:
+
+```python
+result = sensorProfile.getParam("FILTER")
+# Returns a pipe-separated string of all filter states, e.g.:
+# "FILTER_50HZ|ON|FILTER_60HZ|ON|FILTER_HPF|ON|FILTER_LPF|ON"
+
+result = sensorProfile.getParam("NTF")
+# Returns a pipe-separated string of all notification states, e.g.:
+# "NTF_BRTH|ON|NTF_ECG|ON|NTF_EEG|ON|NTF_EMG|ON|..."
+```
+
+If the key is not supported, the result starts with `"Error"`.

{sensor_sdk-0.0.71 → sensor_sdk-0.1.1}/sensor/bleak_host.py

@@ -6,6 +6,9 @@ import uuid
 
 from sensor.bleak_process import BleakProcess
 from sensor import sensor_utils
+from sensor.sdk_log import SdkLog
+
+_TAG = "BleakHost"
 
 
 class BleakHost:
@@ -14,7 +17,7 @@ class BleakHost:
     def __init__(self):
         self._cmd_queue = multiprocessing.Queue(maxsize=50)
         self._result_queue = multiprocessing.Queue(maxsize=sensor_utils.BLEAK_RESULT_QUEUE_MAXSIZE)
-        self._bleak_process = BleakProcess(self._cmd_queue, self._result_queue)
+        self._bleak_process = BleakProcess(self._cmd_queue, self._result_queue, SdkLog.get_log_path())
         self._started = False
 
 
@@ -51,8 +54,7 @@ class BleakHost:
         try:
             self._cmd_queue.put({"type": "terminate"})
         except Exception as e:
-            import traceback
-            traceback.print_exc()
+            SdkLog.exception(_TAG, "Unexpected error")
 
         if self._bleak_process.is_alive():
             self._bleak_process.join(timeout=5)
@@ -84,14 +86,12 @@ class BleakHost:
             try:
                 loop.call_soon_threadsafe(loop.stop)
             except Exception as e:
-                import traceback
-                traceback.print_exc()
+                SdkLog.exception(_TAG, "Unexpected error")
         if thread is not None and thread.is_alive():
             try:
                 thread.join(timeout=2)
             except Exception as e:
-                import traceback
-                traceback.print_exc()
+                SdkLog.exception(_TAG, "Unexpected error")
         self._result_loop = None
         self._result_thread = None
 
@@ -113,15 +113,13 @@ class BleakHost:
                     try:
                         self.on_scan_once_result(msg)
                     except Exception as e:
-                        import traceback
-                        traceback.print_exc()
+                        SdkLog.exception(_TAG, "Unexpected error")
             elif msg_type == "devices":
                 if self.on_scan_result is not None:
                     try:
                         self.on_scan_result(msg)
                     except Exception as e:
-                        import traceback
-                        traceback.print_exc()
+                        SdkLog.exception(_TAG, "Unexpected error")
             elif msg_type == "command_result":
                 self._handle_command_result(msg)
             elif msg_type in ("state_changed", "power_changed", "sensor_data", "error"):
@@ -130,8 +128,7 @@ class BleakHost:
                     try:
                         self.on_device_message(device_mac, msg)
                     except Exception as e:
-                        import traceback
-                        traceback.print_exc()
+                        SdkLog.exception(_TAG, "Unexpected error")
 
     def _handle_command_result(self, msg):
 
@@ -149,6 +146,15 @@ class BleakHost:
             if loop is not None and not loop.is_closed() and not waiter.done():
                 loop.call_soon_threadsafe(waiter.set_result, msg)
 
+        # 将 connect 返回的 chip_type 转发给对应 SensorProfile
+        chip_type = msg.get("chip_type")
+        device_mac = msg.get("device_mac")
+        if chip_type is not None and self.on_device_message is not None and device_mac is not None:
+            try:
+                self.on_device_message(device_mac, {"type": "chip_type", "chip_type": chip_type})
+            except Exception as e:
+                SdkLog.exception(_TAG, "Error forwarding chip_type")
+
     # ------------------------------------------------------------------
     # Command loop
     # ------------------------------------------------------------------
@@ -169,14 +175,12 @@ class BleakHost:
             try:
                 loop.call_soon_threadsafe(loop.stop)
             except Exception as e:
-                import traceback
-                traceback.print_exc()
+                SdkLog.exception(_TAG, "Unexpected error")
         if thread is not None and thread.is_alive():
             try:
                 thread.join(timeout=2)
             except Exception as e:
-                import traceback
-                traceback.print_exc()
+                SdkLog.exception(_TAG, "Unexpected error")
         self._cmd_loop = None
         self._cmd_thread = None
 
@@ -192,32 +196,28 @@ class BleakHost:
         try:
             self._cmd_queue.put_nowait({"type": "scan_once", "period": period})
         except queue.Full as e:
-            import traceback
-            traceback.print_exc()
+            SdkLog.exception(_TAG, "Unexpected error")
 
     def start_scan(self, period):
 
         try:
             self._cmd_queue.put_nowait({"type": "start_scan", "period": period})
         except queue.Full as e:
-            import traceback
-            traceback.print_exc()
+            SdkLog.exception(_TAG, "Unexpected error")
 
     def stop_scan(self):
 
         try:
             self._cmd_queue.put_nowait({"type": "stop_scan"})
         except queue.Full as e:
-            import traceback
-            traceback.print_exc()
+            SdkLog.exception(_TAG, "Unexpected error")
 
     def send_command(self, cmd: dict):
 
         try:
             self._cmd_queue.put_nowait(cmd)
         except queue.Full as e:
-            import traceback
-            traceback.print_exc()
+            SdkLog.exception(_TAG, "Command queue full")
 
     def send_command_sync(self, cmd: dict, timeout: float = 10.0) -> dict:
 
@@ -235,12 +235,14 @@ class BleakHost:
             try:
                 self._cmd_queue.put(cmd, timeout=1.0)
             except queue.Full:
+                SdkLog.e(_TAG, f"send_command_sync queue full: {cmd.get('type')}")
                 with self._pending_lock:
                     self._pending.pop(cmd_id, None)
                 return {}
             try:
                 await asyncio.wait_for(event.wait(), timeout=timeout)
             except asyncio.TimeoutError:
+                SdkLog.e(_TAG, f"send_command_sync timeout: {cmd.get('type')}")
                 with self._pending_lock:
                     self._pending.pop(cmd_id, None)
                 return {}
@@ -252,6 +254,7 @@ class BleakHost:
         try:
             return future.result(timeout=timeout)
         except Exception:
+            SdkLog.exception(_TAG, "send_command_sync future failed")
             return {}
 
     async def send_command_async(self, cmd: dict, timeout: float = 10.0) -> dict:
@@ -269,12 +272,14 @@ class BleakHost:
             try:
                 self._cmd_queue.put(cmd, timeout=1.0)
             except queue.Full:
+                SdkLog.e(_TAG, f"send_command_async queue full: {cmd.get('type')}")
                 with self._pending_lock:
                     self._pending.pop(cmd_id, None)
                 return {}
             try:
                 return await asyncio.wait_for(future, timeout=timeout)
             except asyncio.TimeoutError:
+                SdkLog.e(_TAG, f"send_command_async timeout: {cmd.get('type')}")
                 with self._pending_lock:
                     self._pending.pop(cmd_id, None)
                 return {}