Merge pull request #25 from TapWithUs/unified-client

Unified backends with bleak

Author: ilouzl

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 120

.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.9", "3.10", "3.11"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[dev]
+    - name: Lint with flake8
+      run: |
+        pip install flake8
+        flake8 examples tapsdk tests
+    - name: Run tests
+      run: pytest -v

History.md

@@ -13,7 +13,6 @@ ______________________
     * Spatial features are still not available for Windows backend.
 * MacOS & Linux backends - 
     * Doesn't support multiple Tap strap connections.
-    * OnConnect and OnDisconnect events are not implemented 
     * Raw sensor data is given unscaled (i.e. unitless), thereforein order to scale to physical units need to multiply by the relevant scale factor
 
 ## 0.5.1 (2024-01-01)

Readme.md

@@ -3,14 +3,14 @@
 ### What Is This ?
 
 TAP python SDK allows you to build python app that can establish BLE connection with Tap Strap and TapXR, send commands and receive events and data - Thus allowing TAP to act as a controller for your app!  
-The library is developed with Python >= 3.7 and is **currently in beta**.
+The library is developed with Python >= 3.9 and is **currently in beta**.
 
 
 ### Supported Platforms
 This package supports the following platforms:
 * MacOS (tested on 10.15.2) - using Apple's CoreBluetooth library. The library depends on PyObjC which Apple includes with their Python version on OSX. Note that if you're using a different Python, be sure to install PyObjC for that version of Python.  
 * Windows 10 - by wrapping the dynamic library (DLL) generated by [tap-standalonewin-sdk](https://github.com/TapWithUs/tap-standalonewin-sdk).
-* Linux (testerd on Ubuntu 18.04) - need to install libbluetooth-dev and bluez-tools
+* Linux (tested on Ubuntu 18.04) - need to install libbluetooth-dev and bluez-tools
     ```
     sudo apt-get install bluez-tools libbluetooth-dev
     ```
@@ -166,7 +166,7 @@ Resgister callback to raw sensors data packet received event.
 6. ```register_air_gesture_events(self, listener:Callable):```  
 Resgister callback to air gesture events.
     ```python
-    from tapsdk.models import AirGestures
+    from tapsdk import AirGestures
 
     def on_airgesture(identifier, gesture):
         print(identifier + " - gesture: " + str(AirGestures(gesture)))
@@ -239,7 +239,22 @@ The dynamic range of the sensors is determined with the ```set_input_mode``` met
 
 ### Examples
 
-You can find OS specific examples on the [examples folder](examples).
+You can find some examples in the [examples folder](examples).
+
+### Testing
+
+To run the tests, first install the development dependencies:
+
+```bash
+pip install .[dev]
+```
+
+Then run the tests using pytest:
+
+```bash
+pytest
+```
+
 
 ### Known Issues
 An up-to-date list of known issues is available [here](History.md).

examples/example_unix.py examples/basic.pyexamples/example_unix.py renamed to examples/basic.py

@@ -1,8 +1,15 @@
 import asyncio
 import time
 
-from tapsdk import TapInputMode, TapSDK, InputType
-from tapsdk.models import AirGestures
+from tapsdk import TapInputMode, TapSDK, InputType, AirGestures
+
+
+def OnDisconnection(identifier):
+    print("Disconnected. ", identifier)
+
+
+def OnConnection(identifier):
+    print("Connected. ", identifier)
 
 
 def OnMouseModeChange(identifier, mouse_mode):
@@ -28,23 +35,25 @@ def OnRawData(identifier, packets):
 
 async def run(loop):
     client = TapSDK(loop=loop)
+
+    client.register_disconnection_events(OnDisconnection)
+    client.register_connection_events(OnConnection)
+    client.register_air_gesture_events(OnGesture)
+    client.register_tap_events(OnTapped)
+    client.register_raw_data_events(OnRawData)
+    client.register_mouse_events(OnMoused)
+    client.register_air_gesture_state_events(OnMouseModeChange)
     await client.run()
     print("Connected: {0}".format(client.client.is_connected))
 
-    await client.register_air_gesture_events(OnGesture)
-    await client.register_tap_events(OnTapped)
-    await client.register_raw_data_events(OnRawData)
-    await client.register_mouse_events(OnMoused)
-    await client.register_air_gesture_state_events(OnMouseModeChange)
-
     print("Set Controller Mode for 5 seconds")
     await client.set_input_mode(TapInputMode("controller"))
     await asyncio.sleep(5)
 
     print("Force Mouse Mode for 5 seconds")
     await client.set_input_type(InputType.MOUSE)
     await asyncio.sleep(5)
-    
+
     print("Force keyboard Mode for 5 seconds")
     await client.set_input_type(InputType.KEYBOARD)
     await asyncio.sleep(5)

examples/example_win.py

@@ -1,2 +1,2 @@
 bleak
-setuptools
+setuptools

requirements.txt

@@ -21,7 +21,7 @@
 REQUIRED = [
     # linux reqs
     'bleak==0.6.4;platform_system=="Linux"',
-     # macOS reqs
+    # macOS reqs
     'bleak==0.12.1;platform_system=="Darwin"',
     # Windows reqs
     'pythonnet;platform_system=="Windows"'
@@ -82,13 +82,13 @@ def run(self):
     author_email=EMAIL,
     url=URL,
     packages=find_packages(exclude=("tests", "examples", "docs")),
-    # package_data={"tapsdk.backends.dotnet": ["*.dll"]},
     install_requires=REQUIRED,
-    # test_suite="tests",
-    # tests_require=TEST_REQUIRED,
     include_package_data=True,
     license="MIT",
-    python_requires='>=3.7'
+    python_requires='>=3.9',
+    extras_require={
+        "dev": ["pytest", "flake8"]
+    },
     # classifiers=[
     #     # Trove classifiers
     #     # Full list: https://pypi.python.org/pypi?%3Aaction=list_classifiers

setup.py

@@ -1,14 +1,3 @@
-import platform
-from .models.enumerations import InputType
-
-this_platform = platform.system()
-
-if this_platform == "Windows":
-    from tapsdk.backends.dotnet.TapSDK import TapWindowsSDK as TapSDK
-    from tapsdk.backends.dotnet.inputmodes import TapInputMode
-elif this_platform in ["Darwin", "Linux"]:
-    from tapsdk.backends.posix.TapSDK import TapPosixSDK as TapSDK
-    from tapsdk.backends.posix.inputmodes import TapInputMode
-
-else:
-   raise ValueError("Value for platfrom is unknown: {}".format(this_platform))
+from tapsdk.enumerations import InputType, AirGestures  # noqa: F401
+from tapsdk.inputmodes import TapInputMode              # noqa: F401
+from tapsdk.tap import TapSDK                           # noqa: F401