Skip to content

release-notes.md

Latest commit

 

History

History
96 lines (71 loc) · 3.41 KB

release-notes.md

File metadata and controls

96 lines (71 loc) · 3.41 KB
Raw

Release notes

Changelog for published tap-python-sdk releases on PyPI.

Add user-facing changes for the next release under Unreleased in your pull request. At release time scripts/prepare_release.py renames this section to the new version and opens a fresh empty one.

Unreleased

Main features

Bug fixes

0.8.0 (2026-08-04)

Main features

  • Unified v1/v2 entry: await connect() auto-detects protocol from GATT (c3ff000e), returns TapSDK or TapSDK2; register callbacks then await start() (#36)
  • Shared BLE transport (tapsdk._transport) so TapSDK2 uses the same Windows retrieve/scan/reconnect path as TapSDK
  • Shared get_device_info() / DeviceInfo on both TapSDK and TapSDK2 via tapsdk.device_info (#36)
  • Versioned docs site (mike) deployed after successful PyPI publish, with a release notes page derived from docs/release-notes.md (#47) (#48)
  • Prep-commit-then-tag release flow: author-written Unreleased entries, scripts/prepare_release.py, and a verify-only publish pipeline (#47) (#48)
  • Shared reusable test workflow used by CI and Publish (#39) (#48)

Bug fixes

  • connect() now discovers GATT services before protocol detect so empty service caches cannot mis-classify v2 devices as v1

0.7.0 (2026-06-09)

Main features

  • Unified cross-platform implementation in tapsdk/tap.py (removed separate posix/dotnet backends).
  • Windows rewritten to use Bleak/WinRT instead of TAPWin.dll.
  • InputMode API: TapInputMode("…") replaced by InputModeText, InputModeController, InputModeControllerText, InputModeRaw.
  • Raw mode: typed sensitivity enums and optional scaling to mg/mdps (scaled=True).
  • Connection and disconnection events implemented on all platforms.
  • Windows: BLE scan and reconnect polling for paired devices.
  • Python requirement raised to 3.9+.
  • CI: cross-platform pytest and flake8.
  • New AirGestures values (thumb and state gestures).

Breaking changes

  • Removed TapInputMode, loop constructor argument, tapsdk.models, and OS-specific examples.
  • Windows no longer uses bundled TAPWin.dll.

0.6.0 (2024-07-04)

Main features

  • Added Spatial features for TapXR.
  • Mac and Linux backends unified to posix backend.

Known Issues

  • Windows backend -
    • Raw sensor data rate might be lower than expected.
    • Sometimes a Tap strap wouldn't be detected upon connection. In this case try restarting your Tap and/or the Python application. In worst case scenario re-pair your Tap.
    • 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), therefore in order to scale to physical units need to multiply by the relevant scale factor

0.5.1 (2024-01-01)

Main features

  • Support TapXR Air Gesture pinch

0.5.0 (2021-08-03)

Main features

  • Support Bleak 0.12.1 for mac

0.3.0 (2020-09-07)

Main features

  • Linux support
  • Some bug fixes

0.2.0 (2020-02-22)

Main features

  • Added dll to enable windows backend.
  • fix parsers output types on gesture and tap messages

0.1.0 (2020-02-20)

Main features

  • SDK created.