sensor-sdk 0.0.1__tar.gz → 0.0.2__tar.gz

{sensor-sdk-0.0.1 → sensor-sdk-0.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sensor-sdk
-Version: 0.0.1
+Version: 0.0.2
 Summary: Python sdk for Synchroni
 Home-page: https://github.com/oymotion/SynchroniSDKPython
 Author: Martin Ye
@@ -31,7 +31,7 @@ MIT
 ## Installation
 
 ```sh
-pip install synchroni_sdk_python 
+pip install sensor-sdk 
 ```
 
 ## 1. Permission 
@@ -49,41 +49,41 @@ from sensor import *
 ## 1. Initalize
 
 ```python
-sensorControllerInstance = SensorController.Instance
+SensorControllerInstance = SensorController()
 
 # register scan listener
-if not sensorControllerInstance.hasDeviceCallback:
-    def on_device_callback(devices):
+if not SensorControllerInstance.hasDeviceFoundCallback:
+    def on_device_callback(deviceList: List[BLEDevice]):
         # return all devices doesn't connected
         pass
-    sensorControllerInstance.onDeviceCallback = on_device_callback
+    SensorControllerInstance.onDeviceFoundCallback = on_device_callback
 ```
 
 ## 2. Start scan
-Use `async def start_scan(period_in_ms: int) -> bool` to start scan
+Use `def start_scan(period_in_ms: int) -> bool` to start scan
 ```python
-success = await sensorControllerInstance.startScan(6000)
+success = SensorControllerInstance.startScan(6000)
 ```
 returns true if start scan success, periodInMS means onDeviceCallback will be called every periodInMS
 
 ## 3. Stop scan
 
-Use `async def stop_scan() -> None` to stop scan
+Use `def stop_scan() -> None` to stop scan
 ```python
-await sensorControllerInstance.stopScan()
+SensorControllerInstance.stopScan()
 ```
 ## 4. Check scaning
 
 Use `property isScanning: bool` to check scanning status
 ```python
-isScanning = sensorControllerInstance.isScanning
+isScanning = SensorControllerInstance.isScanning
 ```
 
 ## 5. Check if bluetooth is enabled
 
 Use `property isEnabled: bool` to check if bluetooth is enabled
 ```python
-isEnabled = sensorControllerInstance.isEnabled
+isEnabled = SensorControllerInstance.isEnabled
 ```
 ## 6. Create SensorProfile
 
@@ -92,7 +92,7 @@ Use `def requireSensor(device: BLEDevice) -> SensorProfile | None` to create Sen
 If bleDevice is invalid, result is None.
 
 ```python
-sensorProfile = sensorControllerInstance.requireSensor(bleDevice)
+sensorProfile = SensorControllerInstance.requireSensor(bleDevice)
 ```
 
 ## 7. Get SensorProfile
@@ -119,12 +119,29 @@ Use `def getConnectedDevices() -> list[SensorProfile]` to get connected BLE Devi
 bleDevices = SensorControllerInstance.getConnectedDevices()
 ```
 
+## 10. Terminate
+
+```python
+SensorControllerInstance.terminate()
+
+def terminate():
+    SensorControllerInstance.terminate()
+    exit()
+    
+def main():
+    signal.signal(signal.SIGINT, lambda signal, frame: terminate())
+    time.sleep(30)
+    SensorControllerInstance.terminate()
+    
+Please call terminate when exit main() or press Ctrl+C
+```
+
 # SensorProfile methods:
 
 ## 1. Initalize
 Please register callbacks for SensorProfile
 ```python
-sensorProfile = sensorControllerInstance.requireSensor(bleDevice)
+sensorProfile = SensorControllerInstance.requireSensor(bleDevice)
 
 # register callbacks
 def on_state_changed(sensor, newState):
@@ -150,15 +167,15 @@ sensorProfile.onDataCallback = on_data_callback
 ```
 
 ## 2. Connect device
-Use `async def connect() -> bool` to connect.
+Use `def connect() -> bool` to connect.
 ```python
-success = await sensorProfile.connect()
+success = sensorProfile.connect()
 ```
 
 ## 3. Disconnect
-Use `async def disconnect() -> bool` to disconnect.
+Use `def disconnect() -> bool` to disconnect.
 ```python
-success = await sensorProfile.disconnect()
+success = sensorProfile.disconnect()
 ```
 
 
@@ -189,12 +206,12 @@ bleDevice = sensorProfile.BLEDevice
 ```
 
 ## 6. Get device info of SensorProfile
-Use `async def deviceInfo() -> dict | None` to get device info of SensorProfile.
+Use `def getDeviceInfo() -> dict | None` to get device info of SensorProfile.
 
 Please call after device in 'Ready' state, return None if it's not connected.
 
 ```python
-    deviceInfo = await sensorProfile.deviceInfo()
+    deviceInfo = sensorProfile.getDeviceInfo()
 
 # deviceInfo has defines:
 # deviceInfo = {
@@ -214,11 +231,11 @@ Please call after device in 'Ready' state, return None if it's not connected.
 
 
 ## 7. Init data transfer
-Use `async def init(packageSampleCount: int, powerRefreshInterval: int) -> bool`.
+Use `def init(packageSampleCount: int, powerRefreshInterval: int) -> bool`.
 
 Please call after device in 'Ready' state, return True if init succeed.
 ```python
-success = await sensorProfile.init(5, 60*1000)
+success = sensorProfile.init(5, 60*1000)
 ```
 packageSampleCount:   set sample counts of SensorData.channelSamples in onDataCallback()
 powerRefreshInterval: callback period for onPowerChanged()
@@ -230,13 +247,13 @@ hasInited = sensorProfile.hasInited
 ```
 
 ## 9. DataNotify
-Use `async def startDataNotification() -> bool` to start data notification.
+Use `def startDataNotification() -> bool` to start data notification.
 
 Please call if hasInited return True
 ### 9.1 Start data transfer
 
 ```python
-success = await sensorProfile.startDataNotification()
+success = sensorProfile.startDataNotification()
 ```
 
 Data type list：
@@ -274,9 +291,9 @@ sensorProfile.onDataCallback = on_data_callback
 ```
 
 ### 9.2 Stop data transfer
-Use `async def stopDataNotification() -> bool` to stop data transfer.
+Use `def stopDataNotification() -> bool` to stop data transfer.
 ```python
-success = await sensorProfile.stopDataNotification()
+success = sensorProfile.stopDataNotification()
 ```
 
 ### 9.3 Check if it's data transfering
@@ -286,12 +303,12 @@ isDataTransfering = sensorProfile.isDataTransfering
 ```
 
 ## 10. Get battery level
-Use `async def batteryPower() -> int` to get battery level. Please call after device in 'Ready' state.
+Use `def getBatteryLevel() -> int` to get battery level. Please call after device in 'Ready' state.
 
 ```python
-batteryPower = await sensorProfile.batteryPower()
+batteryPower = sensorProfile.getBatteryLevel()
 
 # batteryPower is battery level returned, value ranges from 0 to 100, 0 means out of battery, while 100 means full.
 ```
 
-Please check SimpleTest function in App
+Please check console.py in examples directory

{sensor-sdk-0.0.1 → sensor-sdk-0.0.2}/README.md

@@ -20,7 +20,7 @@ MIT
 ## Installation
 
 ```sh
-pip install synchroni_sdk_python 
+pip install sensor-sdk 
 ```
 
 ## 1. Permission 
@@ -38,41 +38,41 @@ from sensor import *
 ## 1. Initalize
 
 ```python
-sensorControllerInstance = SensorController.Instance
+SensorControllerInstance = SensorController()
 
 # register scan listener
-if not sensorControllerInstance.hasDeviceCallback:
-    def on_device_callback(devices):
+if not SensorControllerInstance.hasDeviceFoundCallback:
+    def on_device_callback(deviceList: List[BLEDevice]):
         # return all devices doesn't connected
         pass
-    sensorControllerInstance.onDeviceCallback = on_device_callback
+    SensorControllerInstance.onDeviceFoundCallback = on_device_callback
 ```
 
 ## 2. Start scan
-Use `async def start_scan(period_in_ms: int) -> bool` to start scan
+Use `def start_scan(period_in_ms: int) -> bool` to start scan
 ```python
-success = await sensorControllerInstance.startScan(6000)
+success = SensorControllerInstance.startScan(6000)
 ```
 returns true if start scan success, periodInMS means onDeviceCallback will be called every periodInMS
 
 ## 3. Stop scan
 
-Use `async def stop_scan() -> None` to stop scan
+Use `def stop_scan() -> None` to stop scan
 ```python
-await sensorControllerInstance.stopScan()
+SensorControllerInstance.stopScan()
 ```
 ## 4. Check scaning
 
 Use `property isScanning: bool` to check scanning status
 ```python
-isScanning = sensorControllerInstance.isScanning
+isScanning = SensorControllerInstance.isScanning
 ```
 
 ## 5. Check if bluetooth is enabled
 
 Use `property isEnabled: bool` to check if bluetooth is enabled
 ```python
-isEnabled = sensorControllerInstance.isEnabled
+isEnabled = SensorControllerInstance.isEnabled
 ```
 ## 6. Create SensorProfile
 
@@ -81,7 +81,7 @@ Use `def requireSensor(device: BLEDevice) -> SensorProfile | None` to create Sen
 If bleDevice is invalid, result is None.
 
 ```python
-sensorProfile = sensorControllerInstance.requireSensor(bleDevice)
+sensorProfile = SensorControllerInstance.requireSensor(bleDevice)
 ```
 
 ## 7. Get SensorProfile
@@ -108,12 +108,29 @@ Use `def getConnectedDevices() -> list[SensorProfile]` to get connected BLE Devi
 bleDevices = SensorControllerInstance.getConnectedDevices()
 ```
 
+## 10. Terminate
+
+```python
+SensorControllerInstance.terminate()
+
+def terminate():
+    SensorControllerInstance.terminate()
+    exit()
+    
+def main():
+    signal.signal(signal.SIGINT, lambda signal, frame: terminate())
+    time.sleep(30)
+    SensorControllerInstance.terminate()
+    
+Please call terminate when exit main() or press Ctrl+C
+```
+
 # SensorProfile methods:
 
 ## 1. Initalize
 Please register callbacks for SensorProfile
 ```python
-sensorProfile = sensorControllerInstance.requireSensor(bleDevice)
+sensorProfile = SensorControllerInstance.requireSensor(bleDevice)
 
 # register callbacks
 def on_state_changed(sensor, newState):
@@ -139,15 +156,15 @@ sensorProfile.onDataCallback = on_data_callback
 ```
 
 ## 2. Connect device
-Use `async def connect() -> bool` to connect.
+Use `def connect() -> bool` to connect.
 ```python
-success = await sensorProfile.connect()
+success = sensorProfile.connect()
 ```
 
 ## 3. Disconnect
-Use `async def disconnect() -> bool` to disconnect.
+Use `def disconnect() -> bool` to disconnect.
 ```python
-success = await sensorProfile.disconnect()
+success = sensorProfile.disconnect()
 ```
 
 
@@ -178,12 +195,12 @@ bleDevice = sensorProfile.BLEDevice
 ```
 
 ## 6. Get device info of SensorProfile
-Use `async def deviceInfo() -> dict | None` to get device info of SensorProfile.
+Use `def getDeviceInfo() -> dict | None` to get device info of SensorProfile.
 
 Please call after device in 'Ready' state, return None if it's not connected.
 
 ```python
-    deviceInfo = await sensorProfile.deviceInfo()
+    deviceInfo = sensorProfile.getDeviceInfo()
 
 # deviceInfo has defines:
 # deviceInfo = {
@@ -203,11 +220,11 @@ Please call after device in 'Ready' state, return None if it's not connected.
 
 
 ## 7. Init data transfer
-Use `async def init(packageSampleCount: int, powerRefreshInterval: int) -> bool`.
+Use `def init(packageSampleCount: int, powerRefreshInterval: int) -> bool`.
 
 Please call after device in 'Ready' state, return True if init succeed.
 ```python
-success = await sensorProfile.init(5, 60*1000)
+success = sensorProfile.init(5, 60*1000)
 ```
 packageSampleCount:   set sample counts of SensorData.channelSamples in onDataCallback()
 powerRefreshInterval: callback period for onPowerChanged()
@@ -219,13 +236,13 @@ hasInited = sensorProfile.hasInited
 ```
 
 ## 9. DataNotify
-Use `async def startDataNotification() -> bool` to start data notification.
+Use `def startDataNotification() -> bool` to start data notification.
 
 Please call if hasInited return True
 ### 9.1 Start data transfer
 
 ```python
-success = await sensorProfile.startDataNotification()
+success = sensorProfile.startDataNotification()
 ```
 
 Data type list：
@@ -263,9 +280,9 @@ sensorProfile.onDataCallback = on_data_callback
 ```
 
 ### 9.2 Stop data transfer
-Use `async def stopDataNotification() -> bool` to stop data transfer.
+Use `def stopDataNotification() -> bool` to stop data transfer.
 ```python
-success = await sensorProfile.stopDataNotification()
+success = sensorProfile.stopDataNotification()
 ```
 
 ### 9.3 Check if it's data transfering
@@ -275,12 +292,12 @@ isDataTransfering = sensorProfile.isDataTransfering
 ```
 
 ## 10. Get battery level
-Use `async def batteryPower() -> int` to get battery level. Please call after device in 'Ready' state.
+Use `def getBatteryLevel() -> int` to get battery level. Please call after device in 'Ready' state.
 
 ```python
-batteryPower = await sensorProfile.batteryPower()
+batteryPower = sensorProfile.getBatteryLevel()
 
 # batteryPower is battery level returned, value ranges from 0 to 100, 0 means out of battery, while 100 means full.
 ```
 
-Please check SimpleTest function in App
+Please check console.py in examples directory

{sensor-sdk-0.0.1 → sensor-sdk-0.0.2}/sensor/sensor_controller.py

@@ -61,7 +61,7 @@ class SensorController:
     def terminate(self):
         for sensor in self._sensor_profiles.values():
             if sensor.deviceState == DeviceStateEx.Connected or sensor.deviceState == DeviceStateEx.Ready:
-                sensor.destroy()
+                sensor._destroy()
             
 
     def _match_device(self, _device: bleak.BLEDevice, adv: AdvertisementData):
@@ -104,7 +104,7 @@ class SensorController:
         self._enable_callback = callback
 
     @property
-    def hasDeviceCallback(self) -> bool:
+    def hasDeviceFoundCallback(self) -> bool:
         """
         检查是否有扫描设备回调。
 
@@ -112,7 +112,7 @@ class SensorController:
         """
         return self._device_callback != None
 
-    @hasDeviceCallback.setter
+    @hasDeviceFoundCallback.setter
     def onDeviceFoundCallback(self, callback: Callable[[List[sensor_profile.BLEDevice]], None]):
         """
         设置扫描设备回调。

{sensor-sdk-0.0.1 → sensor-sdk-0.0.2}/sensor/sensor_profile.py

@@ -70,9 +70,9 @@ class SensorProfile:
         反初始化 SensorProfile 类的实例。
 
         """
-        self.destroy()
+        self._destroy()
 
-    def destroy(self):
+    def _destroy(self):
         if self._device_state == DeviceStateEx.Connected or self._device_state == DeviceStateEx.Ready:
             self.disconnect()
         if (self._data_event_loop != None):

{sensor-sdk-0.0.1 → sensor-sdk-0.0.2}/sensor_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sensor-sdk
-Version: 0.0.1
+Version: 0.0.2
 Summary: Python sdk for Synchroni
 Home-page: https://github.com/oymotion/SynchroniSDKPython
 Author: Martin Ye
@@ -31,7 +31,7 @@ MIT
 ## Installation
 
 ```sh
-pip install synchroni_sdk_python 
+pip install sensor-sdk 
 ```
 
 ## 1. Permission 
@@ -49,41 +49,41 @@ from sensor import *
 ## 1. Initalize
 
 ```python
-sensorControllerInstance = SensorController.Instance
+SensorControllerInstance = SensorController()
 
 # register scan listener
-if not sensorControllerInstance.hasDeviceCallback:
-    def on_device_callback(devices):
+if not SensorControllerInstance.hasDeviceFoundCallback:
+    def on_device_callback(deviceList: List[BLEDevice]):
         # return all devices doesn't connected
         pass
-    sensorControllerInstance.onDeviceCallback = on_device_callback
+    SensorControllerInstance.onDeviceFoundCallback = on_device_callback
 ```
 
 ## 2. Start scan
-Use `async def start_scan(period_in_ms: int) -> bool` to start scan
+Use `def start_scan(period_in_ms: int) -> bool` to start scan
 ```python
-success = await sensorControllerInstance.startScan(6000)
+success = SensorControllerInstance.startScan(6000)
 ```
 returns true if start scan success, periodInMS means onDeviceCallback will be called every periodInMS
 
 ## 3. Stop scan
 
-Use `async def stop_scan() -> None` to stop scan
+Use `def stop_scan() -> None` to stop scan
 ```python
-await sensorControllerInstance.stopScan()
+SensorControllerInstance.stopScan()
 ```
 ## 4. Check scaning
 
 Use `property isScanning: bool` to check scanning status
 ```python
-isScanning = sensorControllerInstance.isScanning
+isScanning = SensorControllerInstance.isScanning
 ```
 
 ## 5. Check if bluetooth is enabled
 
 Use `property isEnabled: bool` to check if bluetooth is enabled
 ```python
-isEnabled = sensorControllerInstance.isEnabled
+isEnabled = SensorControllerInstance.isEnabled
 ```
 ## 6. Create SensorProfile
 
@@ -92,7 +92,7 @@ Use `def requireSensor(device: BLEDevice) -> SensorProfile | None` to create Sen
 If bleDevice is invalid, result is None.
 
 ```python
-sensorProfile = sensorControllerInstance.requireSensor(bleDevice)
+sensorProfile = SensorControllerInstance.requireSensor(bleDevice)
 ```
 
 ## 7. Get SensorProfile
@@ -119,12 +119,29 @@ Use `def getConnectedDevices() -> list[SensorProfile]` to get connected BLE Devi
 bleDevices = SensorControllerInstance.getConnectedDevices()
 ```
 
+## 10. Terminate
+
+```python
+SensorControllerInstance.terminate()
+
+def terminate():
+    SensorControllerInstance.terminate()
+    exit()
+    
+def main():
+    signal.signal(signal.SIGINT, lambda signal, frame: terminate())
+    time.sleep(30)
+    SensorControllerInstance.terminate()
+    
+Please call terminate when exit main() or press Ctrl+C
+```
+
 # SensorProfile methods:
 
 ## 1. Initalize
 Please register callbacks for SensorProfile
 ```python
-sensorProfile = sensorControllerInstance.requireSensor(bleDevice)
+sensorProfile = SensorControllerInstance.requireSensor(bleDevice)
 
 # register callbacks
 def on_state_changed(sensor, newState):
@@ -150,15 +167,15 @@ sensorProfile.onDataCallback = on_data_callback
 ```
 
 ## 2. Connect device
-Use `async def connect() -> bool` to connect.
+Use `def connect() -> bool` to connect.
 ```python
-success = await sensorProfile.connect()
+success = sensorProfile.connect()
 ```
 
 ## 3. Disconnect
-Use `async def disconnect() -> bool` to disconnect.
+Use `def disconnect() -> bool` to disconnect.
 ```python
-success = await sensorProfile.disconnect()
+success = sensorProfile.disconnect()
 ```
 
 
@@ -189,12 +206,12 @@ bleDevice = sensorProfile.BLEDevice
 ```
 
 ## 6. Get device info of SensorProfile
-Use `async def deviceInfo() -> dict | None` to get device info of SensorProfile.
+Use `def getDeviceInfo() -> dict | None` to get device info of SensorProfile.
 
 Please call after device in 'Ready' state, return None if it's not connected.
 
 ```python
-    deviceInfo = await sensorProfile.deviceInfo()
+    deviceInfo = sensorProfile.getDeviceInfo()
 
 # deviceInfo has defines:
 # deviceInfo = {
@@ -214,11 +231,11 @@ Please call after device in 'Ready' state, return None if it's not connected.
 
 
 ## 7. Init data transfer
-Use `async def init(packageSampleCount: int, powerRefreshInterval: int) -> bool`.
+Use `def init(packageSampleCount: int, powerRefreshInterval: int) -> bool`.
 
 Please call after device in 'Ready' state, return True if init succeed.
 ```python
-success = await sensorProfile.init(5, 60*1000)
+success = sensorProfile.init(5, 60*1000)
 ```
 packageSampleCount:   set sample counts of SensorData.channelSamples in onDataCallback()
 powerRefreshInterval: callback period for onPowerChanged()
@@ -230,13 +247,13 @@ hasInited = sensorProfile.hasInited
 ```
 
 ## 9. DataNotify
-Use `async def startDataNotification() -> bool` to start data notification.
+Use `def startDataNotification() -> bool` to start data notification.
 
 Please call if hasInited return True
 ### 9.1 Start data transfer
 
 ```python
-success = await sensorProfile.startDataNotification()
+success = sensorProfile.startDataNotification()
 ```
 
 Data type list：
@@ -274,9 +291,9 @@ sensorProfile.onDataCallback = on_data_callback
 ```
 
 ### 9.2 Stop data transfer
-Use `async def stopDataNotification() -> bool` to stop data transfer.
+Use `def stopDataNotification() -> bool` to stop data transfer.
 ```python
-success = await sensorProfile.stopDataNotification()
+success = sensorProfile.stopDataNotification()
 ```
 
 ### 9.3 Check if it's data transfering
@@ -286,12 +303,12 @@ isDataTransfering = sensorProfile.isDataTransfering
 ```
 
 ## 10. Get battery level
-Use `async def batteryPower() -> int` to get battery level. Please call after device in 'Ready' state.
+Use `def getBatteryLevel() -> int` to get battery level. Please call after device in 'Ready' state.
 
 ```python
-batteryPower = await sensorProfile.batteryPower()
+batteryPower = sensorProfile.getBatteryLevel()
 
 # batteryPower is battery level returned, value ranges from 0 to 100, 0 means out of battery, while 100 means full.
 ```
 
-Please check SimpleTest function in App
+Please check console.py in examples directory

{sensor-sdk-0.0.1 → sensor-sdk-0.0.2}/setup.py

@@ -8,7 +8,7 @@ with open(os.path.join(this_directory, 'README.md'), "r", encoding="utf-8") as f
 
 setup(
     name='sensor-sdk',
-    version='0.0.1',
+    version='0.0.2',
     description='Python sdk for Synchroni',
     long_description=long_description,
     long_description_content_type='text/markdown',