Skip to content

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

1.0.0 (2026-10-20)


Main features

  • Version 1.0.0: the package leaves beta. The PyPI distribution name stays tap-python-sdk (pip install tap-python-sdk; import tapsdk). The Development Status classifier is now 5 - Production/Stable.
  • Product messaging matches current devices: the TapXR developer firmware has the full gesture set (taps, thumb swipes, pinches with hold, fist with hold). TapBand uses the same BLE API as TapXR and is coming soon (waitlist); it is not for sale yet.
  • One first-run path for Tap Strap and TapXR: README and examples/connect.py enable input with hasattr(sdk, "set_input_mode") (Controller mode) or DeviceFeatures.MODEL_DETECTION + the tapping vision model — the same sequence as the developer portal Getting started.
  • README, docs, and agent skills no longer describe the product as “SDK v1 / SDK v2”. connect() still returns TapSDK or TapSDK2 from firmware; user-facing text talks about devices and those class names.
  • connect() accepts skip_scan: bool = False (Windows only): when True, never falls back to a live BLE scan — only attaches to a Tap Windows already reports connected/paired, raising ConnectionError immediately otherwise instead of waiting on a scan.
  • AI-assisted development kit: a skills plugin for Claude Code and Codex, Cursor skills and rule, AGENTS.md, and install-skills.sh. The installer writes into the current folder (.claude/skills/, .agents/skills/, .cursor/skills/, AGENTS.md). Pass -g to install for your user instead. Skills cover getting started, tapping, vision models and air gestures, IMU motion, raw sensors, building apps, and knob / D-Pad gesture recipes. See "AI-Assisted Development" in the README.

Bug fixes

  • TapSDK() / TapSDK2() no longer crash on Bleak 3 when constructed without an address (address_or_ble_device) (#54).
  • Windows BLE connect reliability: fixed intermittent leaked GattSession handles, stale/cached GATT service tables, and a services-changed race that could cause TapSDK2 devices to be misdetected as TapSDK or fail with "Characteristic ... was not found!". See Windows BLE connect notes.
  • TapSDK / TapSDK2 now support use as an async context manager (async with await connect() as sdk:), ensuring the underlying GATT session is disconnected on exit.

0.9.0 (2026-09-02)


Main features

  • Python 3.10–3.14 supported; Python 3.9 dropped (#40).
  • Bleak upgraded to 3.x on all platforms (macOS, Windows, Linux); per-OS bleak pins and bleak-winrt removed (#21).
  • Docs restructured protocol-first: separate v1 (TapSDK) and v2 (TapSDK2) trees with a Home compare table

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.