Documentation
¶
Overview ¶
Package server is the umbrella for the Linux Server-Target HTTP + WebSocket adapter. Sub-packages own bootstrap (core), per-mode handlers (dictation, assist, voiceagent, personas, transcripts, vocabulary), the middleware chain (middleware), wake-word training upload (wakewordtraining), and onboarding asset embeds (onboarding). All of internal/server is //go:build linux.
Audit 2026-05-24 maintainability sweep.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package assist implements the POST /v1/assist/process handler.
|
Package assist implements the POST /v1/assist/process handler. |
|
Package audio normalizes inbound audio payloads to the Framework kernel's canonical PCM format (16 kHz, signed 16-bit little-endian, mono) before they enter the STT router.
|
Package audio normalizes inbound audio payloads to the Framework kernel's canonical PCM format (16 kHz, signed 16-bit little-endian, mono) before they enter the STT router. |
|
Package cli holds the small amount of CLI-level glue for the Linux SpeechKit Server entry point.
|
Package cli holds the small amount of CLI-level glue for the Linux SpeechKit Server entry point. |
|
Package core is the SpeechKit server bootstrap layer.
|
Package core is the SpeechKit server bootstrap layer. |
|
claimstore
Package claimstore provides the durable at-most-once request ledger used by the local SpeechKit to Home Assistant bridge.
|
Package claimstore provides the durable at-most-once request ledger used by the local SpeechKit to Home Assistant bridge. |
|
Package dictation implements the POST /v1/dictation/transcribe handler.
|
Package dictation implements the POST /v1/dictation/transcribe handler. |
|
Package httpx contains tiny cross-handler helpers for JSON error envelopes and status mapping.
|
Package httpx contains tiny cross-handler helpers for JSON error envelopes and status mapping. |
|
Package middleware provides HTTP middleware primitives for the SpeechKit server adapter.
|
Package middleware provides HTTP middleware primitives for the SpeechKit server adapter. |
|
Package persona provides the Voice Agent persona / role / sequence catalog for the Server-Target.
|
Package persona provides the Voice Agent persona / role / sequence catalog for the Server-Target. |
|
Package toolbridge implements a generic HTTP client for the SpeechKit voice-agent tool bridge wire contract "speechkit.toolbridge.v1" (docs/server/toolbridge.v1.md).
|
Package toolbridge implements a generic HTTP client for the SpeechKit voice-agent tool bridge wire contract "speechkit.toolbridge.v1" (docs/server/toolbridge.v1.md). |
|
Package voiceagent implements the Voice Agent WebSocket surface on the Server-Target.
|
Package voiceagent implements the Voice Agent WebSocket surface on the Server-Target. |
|
Package wakewordmodels serves SpeechKit's wake-word MODEL catalog to devices, so a wake phrase trained via SpeechKit can be individualized on both device families from one contract:
|
Package wakewordmodels serves SpeechKit's wake-word MODEL catalog to devices, so a wake phrase trained via SpeechKit can be individualized on both device families from one contract: |
|
Package wakewordtraining mounts the v0.37.5 REST endpoints that accept wake-word activation training-data uploads from device clients.
|
Package wakewordtraining mounts the v0.37.5 REST endpoints that accept wake-word activation training-data uploads from device clients. |
|
Package wssession holds the transport-neutral session plumbing shared by the Server-Target's ticket-authenticated WebSocket surfaces (Voice Agent, streaming Dictation):
|
Package wssession holds the transport-neutral session plumbing shared by the Server-Target's ticket-authenticated WebSocket surfaces (Voice Agent, streaming Dictation): |
|
Package wyoming implements the Wyoming voice protocol so an ESPHome voice satellite (mediated by Home Assistant's Assist pipeline) can use speechkit-server as its STT and TTS backend.
|
Package wyoming implements the Wyoming voice protocol so an ESPHome voice satellite (mediated by Home Assistant's Assist pipeline) can use speechkit-server as its STT and TTS backend. |
Click to show internal directories.
Click to hide internal directories.