LovensePy documentation

Long-form guides, API tables, and reference material for LovensePy live here. The repository README stays short for PyPI and quick orientation.

Start here

• Installation and setup — prerequisites, extras ([mqtt], [ble]), first Game Mode script
• Connection methods and architecture — which client to use, traffic paths, diagram
• Direct BLE — BleDirectHubSync quick start (LAN-like), async hub, notes

Tutorials

• LAN Game Mode and direct BLE hub
• Server API + QR pairing
• Socket API
• Toy Events
• Home Assistant MQTT
• FastAPI LAN REST

Reference

• API Reference — constructors, methods, pattern players, utilities
• Appendix — actions/presets, event types, Lovense flow diagrams, examples table, tests, external links
• Changelog — release notes (links to repository CHANGELOG.md)

Build locally

pip install -e ".[docs]"
mkdocs serve

Open http://127.0.0.1:8000 to preview.

The live site is built from this folder with MkDocs; configuration lives in mkdocs.yml. GitHub Actions deploys the static output. If the site does not update after the first workflow run, open the repository Settings, then Pages, and set Build and deployment to GitHub Actions.