Skip to main content

Generic kmbox recording input plugin for AlphaWindow.

Project description

AlphaWindow kmbox Plugin

Generic kmbox recording input plugin for AlphaWindow.

The plugin registers the kmbox recording input method through the alphawindow.plugins entry point. It records kmbox mouse movement as AlphaWindow mouse_delta labels and leaves the target window selection to AlphaWindow itself.

It also registers a kmbox replay input method for AlphaWindow versions that expose plugin input methods as replay outputs. This replays recorded mouse_delta labels through the kmbox hardware instead of the foreground mouse or Win32 input backends.

Device Type Detection

The plugin supports device_type=auto, hid, and kmbox_a.

auto probes the notify-capable HID kmbox first, then probes kmboxA through the optional kmA Python extension. HID devices support recording input capture. The stock kmA modules bundled with the reference kmboxA package can be used for connection detection. An enhanced kmA binding that exposes read_mouse_delta(timeout_ms) is required for kmboxA recorder input capture; see native/.

The status probe does not enable mouse lock or notify capture:

python -c "from alphawindow_kmbox import kmbox_connection_status; print(kmbox_connection_status())"

AlphaWindow can also surface this probe through plugin status metadata.

Development

python -m pip install -e .[test]
pytest -q

Local tests use ../AlphaWindow-Python/src so this project can be developed against the adjacent AlphaWindow checkout while the recording input plugin protocol is being integrated.

License

MIT

Publishing

Publishing is handled by .github/workflows/publish.yml.

  • Push a v* tag, or run the workflow manually from GitHub Actions.
  • Set the repository secret PYPI_API_TOKEN to a PyPI API token.
  • The workflow runs tests, builds the package, checks the distribution metadata, and uploads the artifacts to PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alphawindow_kmbox-0.1.1.tar.gz (18.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

alphawindow_kmbox-0.1.1-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file alphawindow_kmbox-0.1.1.tar.gz.

File metadata

  • Download URL: alphawindow_kmbox-0.1.1.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for alphawindow_kmbox-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d658967b60003f228f8a23a527cda54dc04f6c58f6fae3f29bb5c616e52c471a
MD5 577823d045d1946e53bfe75558668172
BLAKE2b-256 fdfd38f99e5bca76122bdc077a31ee2887238793cc7e3ff0ed1ddfe4c931da5b

See more details on using hashes here.

File details

Details for the file alphawindow_kmbox-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for alphawindow_kmbox-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 75e17e6ba516f874f5437639409ecfa839ce9f48c2d2a13e6ce8351557734349
MD5 caf4c289a3175af481ffd4e434bb94fd
BLAKE2b-256 1245b98564dc69a0e8c4a5a66e4059cc14e7c266af94777d655730303fa2609e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page