sensor-sdk 0.0.2__py3-none-any.whl → 0.0.4__py3-none-any.whl

{sensor_sdk-0.0.2.dist-info → sensor_sdk-0.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sensor-sdk
-Version: 0.0.2
+Version: 0.0.4
 Summary: Python sdk for Synchroni
 Home-page: https://github.com/oymotion/SynchroniSDKPython
 Author: Martin Ye
@@ -12,7 +12,7 @@ Requires-Dist: numpy
 Requires-Dist: setuptools
 Requires-Dist: bleak
 
-# synchroni_sdk_python
+# sensor-sdk
 
 Synchroni sdk for Python
 
@@ -20,7 +20,6 @@ Synchroni sdk for Python
 
 Synchroni SDK is the software development kit for developers to access Synchroni products.
 
-
 ## Contributing
 
 See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
@@ -37,7 +36,7 @@ MIT
 pip install sensor-sdk 
 ```
 
-## 1. Permission 
+## 1. Permission
 
 Application will obtain bluetooth permission by itself.
 
@@ -47,9 +46,9 @@ Application will obtain bluetooth permission by itself.
 from sensor import *
 ```
 
-# SensorController methods:
+## SensorController methods
 
-## 1. Initalize
+### 1. Initalize
 
 ```python
 SensorControllerInstance = SensorController()
@@ -62,33 +61,41 @@ if not SensorControllerInstance.hasDeviceFoundCallback:
     SensorControllerInstance.onDeviceFoundCallback = on_device_callback
 ```
 
-## 2. Start scan
-Use `def start_scan(period_in_ms: int) -> bool` to start scan
+### 2. Start scan
+
+Use `def startScan(period_in_ms: int) -> bool` to start scan
+
 ```python
 success = SensorControllerInstance.startScan(6000)
 ```
+
 returns true if start scan success, periodInMS means onDeviceCallback will be called every periodInMS
 
-## 3. Stop scan
+### 3. Stop scan
+
+Use `def stopScan() -> None` to stop scan
 
-Use `def stop_scan() -> None` to stop scan
 ```python
 SensorControllerInstance.stopScan()
 ```
-## 4. Check scaning
+
+### 4. Check scaning
 
 Use `property isScanning: bool` to check scanning status
+
 ```python
 isScanning = SensorControllerInstance.isScanning
 ```
 
-## 5. Check if bluetooth is enabled
+### 5. Check if bluetooth is enabled
 
 Use `property isEnabled: bool` to check if bluetooth is enabled
+
 ```python
 isEnabled = SensorControllerInstance.isEnabled
 ```
-## 6. Create SensorProfile
+
+### 6. Create SensorProfile
 
 Use `def requireSensor(device: BLEDevice) -> SensorProfile | None` to create SensorProfile.
 
@@ -98,7 +105,7 @@ If bleDevice is invalid, result is None.
 sensorProfile = SensorControllerInstance.requireSensor(bleDevice)
 ```
 
-## 7. Get SensorProfile
+### 7. Get SensorProfile
 
 Use `def getSensor(device: BLEDevice) -> SensorProfile | None` to get SensorProfile.
 
@@ -108,24 +115,27 @@ If SensorProfile didn't created, result is None.
 sensorProfile = SensorControllerInstance.getSensor(bleDevice)
 ```
 
-## 8. Get Connected SensorProfiles
+### 8. Get Connected SensorProfiles
 
 Use `def getConnectedSensors() -> list[SensorProfile]` to get connected SensorProfiles.
+
 ```python
 sensorProfiles = SensorControllerInstance.getConnectedSensors()
 ```
 
-## 9. Get Connected BLE Devices
+### 9. Get Connected BLE Devices
 
 Use `def getConnectedDevices() -> list[SensorProfile]` to get connected BLE Devices.
+
 ```python
 bleDevices = SensorControllerInstance.getConnectedDevices()
 ```
 
-## 10. Terminate
+### 10. Terminate
+
+Use `def terminate()` to terminate sdk
 
 ```python
-SensorControllerInstance.terminate()
 
 def terminate():
     SensorControllerInstance.terminate()
@@ -136,13 +146,15 @@ def main():
     time.sleep(30)
     SensorControllerInstance.terminate()
     
-Please call terminate when exit main() or press Ctrl+C
+Please MAKE SURE to call terminate when exit main() or press Ctrl+C
 ```
 
-# SensorProfile methods:
+## SensorProfile methods
+
+### 11. Initalize
 
-## 1. Initalize
 Please register callbacks for SensorProfile
+
 ```python
 sensorProfile = SensorControllerInstance.requireSensor(bleDevice)
 
@@ -169,26 +181,30 @@ sensorProfile.onPowerChanged = on_power_changed
 sensorProfile.onDataCallback = on_data_callback
 ```
 
-## 2. Connect device
+### 12. Connect device
+
 Use `def connect() -> bool` to connect.
+
 ```python
 success = sensorProfile.connect()
 ```
 
-## 3. Disconnect
+### 13. Disconnect
+
 Use `def disconnect() -> bool` to disconnect.
+
 ```python
 success = sensorProfile.disconnect()
 ```
 
+### 14. Get device status
 
-## 4. Get device status
-Use `property connectionState: DeviceStateEx` to get device status.
+Use `property deviceState: DeviceStateEx` to get device status.
 
 Please send command in 'Ready' state, should be after connect() return True.
 
 ```python
-deviceStateEx = sensorProfile.connectionState
+deviceStateEx = sensorProfile.deviceState
 
 # deviceStateEx has define:
 # class DeviceStateEx(Enum):
@@ -200,15 +216,16 @@ deviceStateEx = sensorProfile.connectionState
 #     Invalid = 5
 ```
 
+### 15. Get BLE device of SensorProfile
 
-
-## 5. Get BLE device of SensorProfile
 Use `property BLEDevice: BLEDevice` to get BLE device of SensorProfile.
+
 ```python
 bleDevice = sensorProfile.BLEDevice
 ```
 
-## 6. Get device info of SensorProfile
+### 16. 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.
@@ -232,28 +249,34 @@ Please call after device in 'Ready' state, return None if it's not connected.
 # }
 ```
 
+### 17. Init data transfer
 
-## 7. Init data transfer
 Use `def init(packageSampleCount: int, powerRefreshInterval: int) -> bool`.
 
 Please call after device in 'Ready' state, return True if init succeed.
+
 ```python
 success = sensorProfile.init(5, 60*1000)
 ```
+
 packageSampleCount:   set sample counts of SensorData.channelSamples in onDataCallback()
 powerRefreshInterval: callback period for onPowerChanged()
 
-## 8. Check if init data transfer succeed
+### 18. Check if init data transfer succeed
+
 Use `property hasInited: bool` to check if init data transfer succeed.
+
 ```python
 hasInited = sensorProfile.hasInited
 ```
 
-## 9. DataNotify
+### 19. DataNotify
+
 Use `def startDataNotification() -> bool` to start data notification.
 
 Please call if hasInited return True
-### 9.1 Start data transfer
+
+#### 19.1 Start data transfer
 
 ```python
 success = sensorProfile.startDataNotification()
@@ -293,19 +316,24 @@ def on_data_callback(sensor, data):
 sensorProfile.onDataCallback = on_data_callback
 ```
 
-### 9.2 Stop data transfer
+#### 19.2 Stop data transfer
+
 Use `def stopDataNotification() -> bool` to stop data transfer.
+
 ```python
 success = sensorProfile.stopDataNotification()
 ```
 
-### 9.3 Check if it's data transfering
+#### 19.3 Check if it's data transfering
+
 Use `property isDataTransfering: bool` to check if it's data transfering.
+
 ```python
 isDataTransfering = sensorProfile.isDataTransfering
 ```
 
-## 10. Get battery level
+### 20. Get battery level
+
 Use `def getBatteryLevel() -> int` to get battery level. Please call after device in 'Ready' state.
 
 ```python

sensor_sdk-0.0.4.dist-info/RECORD

@@ -0,0 +1,14 @@
+sensor/__init__.py,sha256=L1VyAP0EDEnJIMeMTzp4iXHSRUUHyHScF_GIl3iYKRI,123
+sensor/gforce.py,sha256=ZVOHV6_NiwGMPAf4BXqlxEHsDrynUBr0rcgqmbJT5oc,24586
+sensor/sensor_controller.py,sha256=UcFsbkXbJsknkVARADB_wT0ZGIDVjHfBFMsmxglF1_0,8334
+sensor/sensor_data.py,sha256=Hu7Ql0LgQ7V24xYZhaLrKPwU4KWZeWE655v8Gy8xphY,3934
+sensor/sensor_data_context.py,sha256=fcGEYWOu5x9UGZ-psvKVKA-nxAKfA8vqMEeA4LjsxAA,27978
+sensor/sensor_device.py,sha256=LCjBzm2TuOh2KpHsFTjm1sF8hzwvS22LhF_ueAct0Jo,2848
+sensor/sensor_profile.py,sha256=NuWYSVGrHWA8y2Goi9UyNyZ3bXE8unKrQ560q8looNw,17873
+sensor/utils.py,sha256=LPLnLTOrrsLnVkL65L10PLtqpjgMYkomyVenRc7pUUo,744
+sensor_sdk-0.0.4.dist-info/LICENSE.txt,sha256=8CSivOpub3IuXODTyqBRI91AxouJZk02YrcKuOAkWu8,1111
+sensor_sdk-0.0.4.dist-info/METADATA,sha256=EYBnMeflySNLB1qxF0OtqRx-xW-FiUo_CFAB89w4el8,8055
+sensor_sdk-0.0.4.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+sensor_sdk-0.0.4.dist-info/top_level.txt,sha256=Ftq49B6bH0Ffdc7c8LkcyakHo6lsg_snlBbpEUoILSk,7
+sensor_sdk-0.0.4.dist-info/zip-safe,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
+sensor_sdk-0.0.4.dist-info/RECORD,,

sensor_sdk-0.0.2.dist-info/RECORD

@@ -1,14 +0,0 @@
-sensor/__init__.py,sha256=L1VyAP0EDEnJIMeMTzp4iXHSRUUHyHScF_GIl3iYKRI,123
-sensor/gforce.py,sha256=ZVOHV6_NiwGMPAf4BXqlxEHsDrynUBr0rcgqmbJT5oc,24586
-sensor/sensor_controller.py,sha256=SD4kcU9Z0IjAoCDCtpM475TpuNwymGxmuFATP4NjY9M,8078
-sensor/sensor_data.py,sha256=pHHHitKPs24MWYorW0DrIe4DKOMZU9c5Oh2mGktDUGg,4449
-sensor/sensor_data_context.py,sha256=DIY-7vN4ziCbtM8JQC5q_Ggz1FpBCVzm2vu8gEUu4mE,24148
-sensor/sensor_device.py,sha256=XLpYe7jlc60PmIstdcqWJ_Vr1CxR2GPVAx5ll_ofnPM,3052
-sensor/sensor_profile.py,sha256=44dCvb6EDv1fT6LJfjWmKlH_BMMVfdt46PlNO_LZaJs,17096
-sensor/utils.py,sha256=rrgMKIPJ3u1iVSbQqcfUhlQ5h_IatHNPtqojdUHIc9Y,741
-sensor_sdk-0.0.2.dist-info/LICENSE.txt,sha256=8CSivOpub3IuXODTyqBRI91AxouJZk02YrcKuOAkWu8,1111
-sensor_sdk-0.0.2.dist-info/METADATA,sha256=N1iLvtzUQTtxd9dIytAd61DYqcqZcUaP-TaVs5-FtXw,7970
-sensor_sdk-0.0.2.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-sensor_sdk-0.0.2.dist-info/top_level.txt,sha256=Ftq49B6bH0Ffdc7c8LkcyakHo6lsg_snlBbpEUoILSk,7
-sensor_sdk-0.0.2.dist-info/zip-safe,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
-sensor_sdk-0.0.2.dist-info/RECORD,,