Files
harbour-hermes/README.md
T
kaneda c5c4049030 fix(api): watchdog con timeout su tutte le richieste — mai piu' attese infinite (v0.5.1)
Sintomo sul device: l'app restava sullo splash in caricamento per sempre.
Causa: QNetworkAccessManager non applica timeout — una richiesta che non
riceve risposta (rete del telefono, server occupato) lasciava la UI in
attesa infinita, senza errori visibili.

- ApiClient::armTimeout(): watchdog per reply (abort -> normale percorso
  d'errore del chiamante). Applicato a: checkAuth (12 s), login (20 s),
  refreshSessions e openSession (60 s), newSession/chat-start/switchProfile
  (20-30 s), fetchProfiles (20 s), transcribe (300 s), tts (120 s).
  Nessun watchdog sullo stream SSE (longevo per design).
- checkAuth: imposta lastError anche in errore (messaggio tradotto
  "Server not reachable (timeout)") e logga indirizzo ed esito
- refreshSessions: log della durata (misurato sul probe: il primo fetch
  dopo un cambio profilo puo' prendere 11-16 s lato server, anche su DB
  minuscolo — l'app ora lo gestisce senza sembrare bloccata)
- SplashPage: rete di sicurezza (se authChecked non arriva entro 15 s si
  va comunque al login) + log di instradamento
- i18n: nuova stringa tradotta it/fr/de
2026-09-13 07:37:12 +02:00

83 lines
3.7 KiB
Markdown

# harbour-hermes
Native **Sailfish OS** client for the **Hermes Web UI** (`hermes-webui`):
chat with your Hermes agent from the phone — and use it with your **voice**.
## Features
- Sign in to your Hermes Web UI (session cookie persisted; password never stored)
- Sessions list, new session, open any session
- Chat with **live streaming** replies (SSE token deltas)
- **Voice dictation**: tap Mic, speak, tap Stop → server-side Whisper
transcription lands in the composer (optionally sent right away)
- **Read aloud**: server-side TTS (voice/engine configurable) played through
QMediaPlayer; optional auto-read of every completed reply
- **Voice dialog (hands-free)**: continuous listen → transcribe → send →
read-aloud loop, auto-stopping on speech pauses (tunable)
- **Localized UI**: English (source), Italian, French and German — follows
the system language
- **Profile selection**: pick which server profile's sessions to show
(Settings → Sessions; per-client via the WebUI signed cookie)
- Cancel a running turn, resync from server state, cover page
## Requirements
- Sailfish OS 4.4+ (developed against Sailfish 5.1)
- A running `hermes-webui` instance reachable over HTTPS (the address is
configured in the app — nothing is compiled in)
- Sailjail permissions `Internet;Audio;Microphone` (declared in the .desktop)
## Configuration
No configuration is compiled into the binary: everything lives in the app's
Settings (persisted in `~/.config/harbour/hermes.conf`, sandbox-persistent).
Defaults are neutral — empty means "the server decides" — and the login screen
requires a server address.
| Setting | Meaning |
|---|---|
| Server | Hermes Web UI address, e.g. `https://hermes.example.com` (required) |
| Profile | server profile whose sessions are shown (empty = server's active) |
| Read-aloud voice / TTS engine | empty = server defaults |
| Voice/engine presets | comma-separated lists used to fill the pickers |
| Read replies aloud | auto-play every reply (off by default) |
| Send right after dictation | auto-send when dictation lands (on by default) |
| Auto-stop pause / Mic sensitivity | voice-dialog tuning (1.5 s / medium) |
| Max recording time | voice-dialog safety cap (60 s) |
> **Read-aloud voices depend on your server.** The selected voice is sent to
> `hermes-webui`'s `/api/tts`, which only accepts voices present in its Edge
> TTS allowlist (`api/routes.py`; upstream ships Chinese, English, French and
> Indonesian voices). If your server rejects a voice (`400 invalid voice`),
> pick another one, leave the voice empty (server default), or add your
> language's voices to your own `hermes-webui`.
## Localization
The UI follows the system language: English is the source language, and
Italian, French and German translations live in `translations/*.ts`. At build
time (`sailfishapp_i18n`) the `.qm` files are generated and installed to
`/usr/share/harbour-hermes/translations`, where the app loads them on startup.
After changing UI strings:
```bash
lupdate -no-obsolete -recursive src qml \
-ts translations/harbour-hermes-it.ts \
translations/harbour-hermes-fr.ts \
translations/harbour-hermes-de.ts
# then edit the .ts files and rebuild
```
## Build
See [docs/BUILD.md](docs/BUILD.md) (Sailfish SDK, `sfdk build` / `sfdk deploy`)
and [docs/PROTOCOL.md](docs/PROTOCOL.md) for the HTTP/SSE protocol the app
speaks (validated live against a real instance).
## Status
Version 0.5.1 — protocol and C++ core validated against a real `hermes-webui`
(login, sessions, streaming chat, TTS, STT, voice dialog, profile selection);
UI in English, Italian, French and German; every request has a watchdog
timeout (no infinite waits); on-device testing still ongoing.