Документация LovensePy

Здесь собраны развёрнутые руководства, таблицы API и справочные материалы для LovensePy. README репозитория остаётся кратким для PyPI и быстрого знакомства.

С чего начать

• Установка и настройка — требования, extras ([mqtt], [ble]), первый скрипт в Game Mode
• Способы подключения и архитектура — какой клиент выбрать, пути трафика, схема
• Прямой BLE — быстрый старт BleDirectHubSync (как LAN), асинхронный хаб, замечания

Руководства

• LAN Game Mode и прямой BLE-хаб
• Server API + сопряжение по QR
• Socket API
• События игрушек
• Home Assistant MQTT
• FastAPI LAN REST

Справочник

• Справочник API — конструкторы, методы, проигрыватели паттернов, утилиты
• Приложение — действия/пресеты, типы событий, диаграммы потоков Lovense, таблица примеров, тесты, внешние ссылки
• История изменений — заметки о релизах (ссылки на CHANGELOG.md в репозитории)

Локальная сборка

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

Откройте http://127.0.0.1:8000 для предпросмотра.

Живой сайт собирается из этой папки с помощью MkDocs; конфигурация в mkdocs.yml. GitHub Actions публикует статический вывод. Если сайт не обновился после первого запуска workflow, откройте в репозитории Settings → Pages и в Build and deployment выберите GitHub Actions.