Bump to v2.1.0: add kao_tui.py developer TUI and WSL venv
- Add kao_tui.py: Textual TUI with Sounds, Faces, Events, Controls tabs - Add textual to requirements.txt - Add venv activation instructions to README - Add Developer TUI section to README Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
34
README.md
34
README.md
@@ -33,6 +33,23 @@ python kao.py
|
||||
|
||||
Open http://localhost:5100 on your phone (use Fully Kiosk Browser for best results).
|
||||
|
||||
## Activating the venv
|
||||
|
||||
Two venvs exist — one for Windows, one for WSL:
|
||||
|
||||
```bash
|
||||
# WSL / Linux
|
||||
source venv-wsl/bin/activate
|
||||
|
||||
# Windows (PowerShell)
|
||||
.\venv\Scripts\Activate.ps1
|
||||
|
||||
# Windows (cmd)
|
||||
.\venv\Scripts\activate.bat
|
||||
```
|
||||
|
||||
Deactivate either with `deactivate`.
|
||||
|
||||
## Status Faces
|
||||
|
||||
| State | Emote | Meaning |
|
||||
@@ -179,6 +196,23 @@ automation:
|
||||
- `animation`: `breathing`, `shaking`, `popping`, `celebrating`, `floating`, `bouncing`, `swaying`
|
||||
- `sound`: `chime`, `alert`, `warning`, `critical`, `success`, `notify`, `doorbell`, `knock`, `ding`, `blip`, `siren`, `tada`, `ping`, `bubble`, `fanfare`, `alarm`, `none`
|
||||
|
||||
## Developer TUI
|
||||
|
||||
`kao_tui.py` is a terminal UI for firing test events, faces, and sounds at a running Kao instance — no `curl` needed.
|
||||
|
||||
```bash
|
||||
python kao_tui.py # connect to http://localhost:5100
|
||||
python kao_tui.py http://192.168.1.x:5100 # custom URL
|
||||
```
|
||||
|
||||
Four tabs:
|
||||
- **Sounds** — fire any of the 17 sounds via `/notify`
|
||||
- **Faces** — send any preset emote/animation combo via `/notify`
|
||||
- **Events** — post Critical/Warning/Notify events (10s TTL) or clear all
|
||||
- **Controls** — Sleep, Wake, Clear all
|
||||
|
||||
Navigate with `↑↓` or `Tab`, press `Enter` to fire, `Q` to quit. A toast confirms each action.
|
||||
|
||||
## API Reference
|
||||
|
||||
| Endpoint | Method | Description |
|
||||
|
||||
Reference in New Issue
Block a user