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

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

@@ -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
@@ -9,7 +9,7 @@ Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 
-# synchroni_sdk_python
+# sensor-sdk
 
 Synchroni sdk for Python
 
@@ -17,7 +17,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.
@@ -34,7 +33,7 @@ MIT
 pip install sensor-sdk 
 ```
 
-## 1. Permission 
+## 1. Permission
 
 Application will obtain bluetooth permission by itself.
 
@@ -44,9 +43,9 @@ Application will obtain bluetooth permission by itself.
 from sensor import *
 ```
 
-# SensorController methods:
+## SensorController methods
 
-## 1. Initalize
+### 1. Initalize
 
 ```python
 SensorControllerInstance = SensorController()
@@ -59,33 +58,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.
 
@@ -95,7 +102,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.
 
@@ -105,24 +112,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()
@@ -133,13 +143,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)
 
@@ -166,26 +178,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):
@@ -197,15 +213,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.
@@ -229,28 +246,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()
@@ -290,19 +313,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.2 → sensor-sdk-0.0.4}/README.md

@@ -1,4 +1,4 @@
-# synchroni_sdk_python
+# sensor-sdk
 
 Synchroni sdk for Python
 
@@ -6,7 +6,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.
@@ -23,7 +22,7 @@ MIT
 pip install sensor-sdk 
 ```
 
-## 1. Permission 
+## 1. Permission
 
 Application will obtain bluetooth permission by itself.
 
@@ -33,9 +32,9 @@ Application will obtain bluetooth permission by itself.
 from sensor import *
 ```
 
-# SensorController methods:
+## SensorController methods
 
-## 1. Initalize
+### 1. Initalize
 
 ```python
 SensorControllerInstance = SensorController()
@@ -48,33 +47,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.
 
@@ -84,7 +91,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.
 
@@ -94,24 +101,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()
@@ -122,13 +132,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)
 
@@ -155,26 +167,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):
@@ -186,15 +202,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.
@@ -218,28 +235,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()
@@ -279,19 +302,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
@@ -300,4 +328,4 @@ 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 console.py in examples directory
+Please check console.py in examples directory