signalk-whisper 0.0.1 → 0.2.0

package/README.md

@@ -1,16 +1,160 @@
 # signalk-whisper
 
-> **Status: pre-release placeholder.** This package reserves the name — nothing is functional yet. The design is under community review at **[hoeken/signalk-wyoming](https://github.com/hoeken/signalk-wyoming)** — read the spec there and leave feedback.
+> **Status: ALPHA.** This SignalK Wyoming system is 100% vibecoded slop. I
+> don't have the right hardware yet to test it, so I'm putting it out there
+> for people to test in the meantime. It _should_ work. File issues for
+> anything that doesn't.
 
-[Wyoming](https://github.com/rhasspy/wyoming) [Whisper](https://github.com/rhasspy/wyoming-faster-whisper) speech-to-text service for [Signal K](https://signalk.org), running as a managed container. Part of the **signalk-wyoming** offline voice assistant family, but fully standalone: any Wyoming client (including Home Assistant) can use it.
+## What is this?
 
-| Plugin | Role |
-|--------|------|
-| [signalk-wyoming](https://github.com/hoeken/signalk-wyoming) | Orchestrator — spec and discussion live here |
-| **signalk-whisper** | Speech-to-text |
-| [signalk-piper](https://github.com/hoeken/signalk-piper) | Text-to-speech |
-| [signalk-openwakeword](https://github.com/hoeken/signalk-openwakeword) | Wake word detection |
+Whisper speech-to-text for [Signal K](https://signalk.org) — it gives your
+boat server "ears". The plugin runs the
+[Whisper](https://github.com/rhasspy/wyoming-faster-whisper) speech
+recognizer as a background service and takes care of everything around it:
+starting it in a container (via the
+[signalk-container](https://www.npmjs.com/package/signalk-container)
+plugin), downloading the speech model, checking that it stays healthy, and
+telling the rest of the voice stack where to find it. You never have to
+touch docker or podman yourself.
+
+It is the speech-to-text (STT) building block of the
+[signalk-wyoming voice-assistant family](https://github.com/hoeken/signalk-wyoming)
+— install it together with the `signalk-wyoming` orchestrator to get voice
+commands on your boat. Because it speaks the standard
+[Wyoming protocol](https://github.com/rhasspy/wyoming), it also works as a
+standalone speech-to-text server for other software such as Home Assistant.
+
+## Requirements
+
+- Signal K server ≥ 2.x on **Node 24+**
+- The **signalk-container** plugin with a working podman or docker runtime
+- RAM for the model: the default `tiny-int8` uses roughly **400–500 MB
+  resident** (`base-int8` ≈ 700 MB). The container is capped at 1 GB by
+  default so a misbehaving model cannot starve the boat server. The full
+  voice stack with whisper is comfortable on a Pi 4/5 with 4 GB. (A
+  TTS-only voice install does not need this plugin at all.)
+
+## Install
+
+Install **signalk-whisper** from the Signal K App Store (or `npm install
+signalk-whisper` in your server directory), enable it in Plugin Config, and
+enable the signalk-container plugin if you have not already.
+
+## Configuration
+
+The plugin ships a graphical configuration panel (Server → Plugin Config →
+Whisper STT) with a live container status card, a one-click image update
+check/apply, a version dropdown fed by Docker Hub, and all the settings
+below — with inline warnings if you pick a heavyweight model or open the
+service to the network. On servers without custom-panel support you get a
+plain settings form with the same options.
+
+| Setting                  | Default            | Notes                                                                                                                                                                                                                         |
+| ------------------------ | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `model`                  | `tiny-int8`        | One of `tiny-int8`, `base-int8`, `small-int8`, `medium-int8`, `tiny`, `tiny.en`, `base`, `base.en`, `small`, `small.en`, `medium.en`, `turbo`. int8 models are recommended (smaller + faster on CPU). See "Choosing a model". |
+| `language`               | `en`               | Explicit language code. `auto` enables per-utterance detection but costs speed **and** accuracy on the small models — set it explicitly if you can.                                                                           |
+| `initialPrompt`          | nautical word list | A list of words that biases recognition toward your vocabulary — the cheapest accuracy win available. See "The initial prompt". Empty disables it.                                                                            |
+| `imageTag`               | `auto`             | `auto` runs the pinned, tested upstream release (**3.5.0**) and follows plugin updates. Set an explicit tag to pin something else.                                                                                            |
+| `port`                   | `10300`            | Host TCP port — only used with `bind: 0.0.0.0`, where the service is published on exactly this port. With the default loopback networking the setting is ignored and a host port is assigned automatically.                   |
+| `advanced.bind`          | `127.0.0.1`        | `127.0.0.1` keeps whisper local to the boat server (recommended — the orchestrator is its only intended consumer). `0.0.0.0` publishes it on all interfaces, e.g. to share it with Home Assistant. See Security.              |
+| `advanced.memoryLimit`   | `1g`               | Hard container memory cap (swap capped to the same value).                                                                                                                                                                    |
+| `advanced.restartPolicy` | `unless-stopped`   | Container runtime restart policy.                                                                                                                                                                                             |
+
+### Choosing a model
+
+Bigger models transcribe more accurately but need more RAM and take longer
+per utterance.
+
+| Model                                   | Download       | Resident RAM | When                                                                         |
+| --------------------------------------- | -------------- | ------------ | ---------------------------------------------------------------------------- |
+| `tiny-int8`                             | ≈ 43 MB        | ≈ 400–500 MB | Default. Fine for short commands on a Pi 4.                                  |
+| `base-int8`                             | ≈ 80 MB        | ≈ 700 MB     | Recommended on a Pi 5 / x86 box — noticeably better accuracy.                |
+| `small-int8` / `medium-int8`            | hundreds of MB | > 1 GB       | Only with plenty of RAM/CPU; raise `memoryLimit`.                            |
+| `tiny`–`small.en`, `medium.en`, `turbo` | larger (float) | more         | The `.en` variants are English-only and slightly more accurate at each size. |
+
+Transcription latency is the practical constraint: the signalk-wyoming
+webapp's **Test screen** shows a per-transcription latency figure — use it
+to decide whether your hardware can afford a bigger model.
+
+(A model setting of `auto` is deliberately **not** offered: with this
+service it can silently switch to a much larger non-Whisper backend and
+download hundreds of MB.)
+
+### The initial prompt
+
+The shipped default biases Whisper toward sailing vocabulary:
+
+> Genoa, jib, mainsail, spinnaker, windlass, gybe, tack, halyard, winch,
+> anchor chain, rode, bilge, galley, helm, autopilot, waypoint, knots, port,
+> starboard, bow, stern, leeward, windward, reef, furl, log position, anchor
+> alarm, engine, throttle.
+
+Customize it with words Whisper would otherwise mis-hear, for example:
+
+- your **vessel name** ("Wildeling"),
+- **local place and port names** ("Port Townsend, Deception Pass, Anacortes"),
+- **boat-specific gear** ("watermaker, Hydrovane, staysail, preventer").
+
+## First start & offline use
+
+On first start (and after a model change) the container downloads the model
+into this plugin's Signal K data directory — the download survives
+container recreation and image updates, so it only happens once per model.
+The plugin status shows _"starting — first start downloads the model
+(tiny-int8 ≈ 43 MB, base-int8 ≈ 80 MB)"_ until the service answers; up to
+10 minutes are allowed for slow connections.
+
+**Do the first start (and any model change) while you have internet** — at
+sea with no connectivity a never-downloaded model cannot load, and the
+plugin will report the failure rather than sit silent.
+
+## Using it from other software
+
+Once ready, the service is a plain Wyoming STT server at
+`tcp://<host>:<port>` (normally `tcp://127.0.0.1:10300`):
+
+- **signalk-wyoming** discovers it automatically — nothing to configure.
+- **Home Assistant** (or any other Wyoming client) can use it as an STT
+  provider: set `advanced.bind` to `0.0.0.0` and point HA's Wyoming
+  integration at `tcp://<boat-ip>:10300`.
+
+## HTTP API
+
+| Endpoint                                         | Access                 | Purpose                                                                                        |
+| ------------------------------------------------ | ---------------------- | ---------------------------------------------------------------------------------------------- |
+| `GET /plugins/signalk-whisper/api/status`        | any authenticated user | Current state: `{ status, uri, tag, containerState, lastHealth, info }`                        |
+| `GET /plugins/signalk-whisper/api/versions`      | any authenticated user | Available image versions from Docker Hub (feeds the config panel; works while plugin disabled) |
+| `GET /plugins/signalk-whisper/api/update/check`  | admin                  | Check whether a newer image is available                                                       |
+| `POST /plugins/signalk-whisper/api/update/apply` | admin                  | Pull and switch to the newer image                                                             |
+
+## Health & notifications
+
+The plugin checks the service every 30 seconds. If it stops answering,
+after three consecutive failures (about 90 seconds) it raises the Signal K
+notification **`notifications.voice.whisper`** with `state: "alarm"` and
+shows an error in Plugin Config. When the service answers again everything
+clears back to normal automatically — no action needed.
+
+The alarm is visual-only by design: plugins that read notifications aloud
+won't try to _speak_ the voice stack's own failure.
+
+## Security
+
+Wyoming has **no authentication**. Anyone who can reach the port can feed
+audio to (and read transcripts from) the service. The default
+`bind: 127.0.0.1` keeps it unreachable from the network — only the Signal K
+host (and its containers) can use it. Only switch to `0.0.0.0` on a trusted
+network, and prefer a firewall rule or VLAN that restricts the port to the
+machines that need it (see the signalk-wyoming documentation for a
+marina-wifi hardening recipe).
+
+## Development
+
+See [DEVELOPERS.md](DEVELOPERS.md) for the code layout, build/test
+commands, architecture notes, and the service-discovery contract.
 
 ## License
 
-Apache-2.0
+Apache-2.0 © hoeken. The upstream Whisper service is
+[rhasspy/wyoming-faster-whisper](https://github.com/rhasspy/wyoming-faster-whisper)
+(MIT).

package/dist/config.d.ts

@@ -0,0 +1,140 @@
+/**
+ * signalk-whisper configuration: JSON schema, defaults, and the pure
+ * settings → ContainerConfig mapping consumed by signalk-container-helper.
+ */
+import type { ContainerConfig } from "signalk-container-helper";
+export declare const PLUGIN_ID = "signalk-whisper";
+export declare const PLUGIN_NAME = "Whisper STT (Wyoming)";
+export declare const SERVICE_TYPE = "asr";
+/** Unprefixed container name; runs as `sk-whisper` on the host runtime. */
+export declare const CONTAINER_NAME = "whisper";
+export declare const IMAGE = "rhasspy/wyoming-whisper";
+/** Pinned, tested upstream release; `imageTag: "auto"` resolves to this. */
+export declare const PINNED_TAG = "3.5.0";
+/**
+ * Container-side Wyoming port. The image bakes `--uri tcp://0.0.0.0:10300`
+ * into its entrypoint, so the container ALWAYS listens on 10300 internally.
+ */
+export declare const WYOMING_PORT = 10300;
+export declare const NOTIFICATION_PATH = "notifications.voice.whisper";
+/** First-start model download sizes surfaced in plugin status / README. */
+export declare const DOWNLOAD_HINT = "tiny-int8 \u2248 43 MB, base-int8 \u2248 80 MB";
+/**
+ * Models accepted by the `--model` flag. NEVER "auto": with the 3.5.0 image
+ * `--model auto --language en` silently switches to a ~0.6B-parameter
+ * sherpa/Parakeet backend and downloads hundreds of MB — a disaster on a
+ * boat server. int8 models are the recommended choice.
+ */
+export declare const WHISPER_MODELS: readonly ["tiny-int8", "base-int8", "small-int8", "medium-int8", "tiny", "tiny.en", "base", "base.en", "small", "small.en", "medium.en", "turbo"];
+export type WhisperModel = (typeof WHISPER_MODELS)[number];
+/**
+ * Default `--initial-prompt`: nautical vocabulary that biases Whisper toward
+ * sailing terms. The cheapest accuracy win available — user-editable.
+ */
+export declare const NAUTICAL_PROMPT: string;
+export interface AdvancedSettings {
+    bind: "127.0.0.1" | "0.0.0.0";
+    memoryLimit: string;
+    restartPolicy: "no" | "unless-stopped" | "always";
+}
+export interface WhisperSettings {
+    imageTag: string;
+    model: WhisperModel;
+    language: string;
+    initialPrompt: string;
+    port: number;
+    advanced: AdvancedSettings;
+}
+export declare function defaultSettings(): WhisperSettings;
+/**
+ * Merge raw plugin config over the defaults. Signal K does NOT seed schema
+ * defaults into saved configurations, and hand-edited config files can hold
+ * anything — every field is validated and falls back to its default.
+ * Guarantees `model` is never "auto" (see WHISPER_MODELS).
+ */
+export declare function applyDefaults(raw: unknown): WhisperSettings;
+/** Maps the user-facing tag to the tag actually run: "auto" → pinned. */
+export declare function resolveTag(requested: string): string;
+/** True for plain numeric semver tags like "3.5.0" (update-check filter). */
+export declare function isSemverTag(tag: string): boolean;
+/**
+ * Pure, deterministic settings → ContainerConfig mapping. Called on every
+ * start/update; the `command` array is always present and stable so
+ * signalk-container's drift detection never recreate-loops.
+ *
+ * Networking: by default the Wyoming port is declared via
+ * `signalkAccessiblePorts` (published on host loopback on bare metal; wired
+ * to the right network on containerized Signal K). `bind: "0.0.0.0"`
+ * switches to an explicit all-interfaces port publish (for sharing the
+ * service with e.g. Home Assistant) — the two mechanisms must never be
+ * combined on the same port.
+ */
+export declare function buildContainerConfig(settings: WhisperSettings, tag: string): ContainerConfig;
+export declare const CONFIG_SCHEMA: {
+    readonly type: "object";
+    readonly properties: {
+        readonly model: {
+            readonly type: "string";
+            readonly title: "Whisper model";
+            readonly enum: readonly ["tiny-int8", "base-int8", "small-int8", "medium-int8", "tiny", "tiny.en", "base", "base.en", "small", "small.en", "medium.en", "turbo"];
+            readonly default: "tiny-int8";
+            readonly description: string;
+        };
+        readonly language: {
+            readonly type: "string";
+            readonly title: "Language";
+            readonly default: "en";
+            readonly description: string;
+        };
+        readonly initialPrompt: {
+            readonly type: "string";
+            readonly title: "Initial prompt (vocabulary hint)";
+            readonly default: string;
+            readonly description: string;
+        };
+        readonly imageTag: {
+            readonly type: "string";
+            readonly title: "Image tag";
+            readonly default: "auto";
+            readonly description: string;
+        };
+        readonly port: {
+            readonly type: "number";
+            readonly title: "Host port";
+            readonly default: 10300;
+            readonly description: string;
+        };
+        readonly advanced: {
+            readonly type: "object";
+            readonly title: "Advanced";
+            readonly properties: {
+                readonly bind: {
+                    readonly type: "string";
+                    readonly title: "Bind address";
+                    readonly enum: readonly ["127.0.0.1", "0.0.0.0"];
+                    readonly default: "127.0.0.1";
+                    readonly description: string;
+                };
+                readonly memoryLimit: {
+                    readonly type: "string";
+                    readonly title: "Memory limit";
+                    readonly default: "1g";
+                    readonly description: string;
+                };
+                readonly restartPolicy: {
+                    readonly type: "string";
+                    readonly title: "Restart policy";
+                    readonly enum: readonly ["no", "unless-stopped", "always"];
+                    readonly default: "unless-stopped";
+                    readonly description: "Container runtime restart policy.";
+                };
+            };
+        };
+    };
+};
+export declare const UI_SCHEMA: {
+    readonly initialPrompt: {
+        readonly "ui:widget": "textarea";
+    };
+};
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAEhE,eAAO,MAAM,SAAS,oBAAoB,CAAC;AAC3C,eAAO,MAAM,WAAW,0BAA0B,CAAC;AACnD,eAAO,MAAM,YAAY,QAAQ,CAAC;AAClC,2EAA2E;AAC3E,eAAO,MAAM,cAAc,YAAY,CAAC;AACxC,eAAO,MAAM,KAAK,4BAA4B,CAAC;AAC/C,4EAA4E;AAC5E,eAAO,MAAM,UAAU,UAAU,CAAC;AAClC;;;GAGG;AACH,eAAO,MAAM,YAAY,QAAQ,CAAC;AAClC,eAAO,MAAM,iBAAiB,gCAAgC,CAAC;AAC/D,2EAA2E;AAC3E,eAAO,MAAM,aAAa,mDAAyC,CAAC;AAEpE;;;;;GAKG;AACH,eAAO,MAAM,cAAc,mJAajB,CAAC;AAEX,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,eAAe,QAIqB,CAAC;AAElD,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,WAAW,GAAG,SAAS,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,IAAI,GAAG,gBAAgB,GAAG,QAAQ,CAAC;CACnD;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,YAAY,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,gBAAgB,CAAC;CAC5B;AAED,wBAAgB,eAAe,IAAI,eAAe,CAajD;AAMD;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,OAAO,GAAG,eAAe,CAkD3D;AAED,yEAAyE;AACzE,wBAAgB,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED,6EAA6E;AAC7E,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,eAAe,EACzB,GAAG,EAAE,MAAM,GACV,eAAe,CA4BjB;AAED,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2FhB,CAAC;AAEX,eAAO,MAAM,SAAS;;;;CAIZ,CAAC"}

package/dist/config.js

@@ -0,0 +1,255 @@
+/**
+ * signalk-whisper configuration: JSON schema, defaults, and the pure
+ * settings → ContainerConfig mapping consumed by signalk-container-helper.
+ */
+export const PLUGIN_ID = "signalk-whisper";
+export const PLUGIN_NAME = "Whisper STT (Wyoming)";
+export const SERVICE_TYPE = "asr";
+/** Unprefixed container name; runs as `sk-whisper` on the host runtime. */
+export const CONTAINER_NAME = "whisper";
+export const IMAGE = "rhasspy/wyoming-whisper";
+/** Pinned, tested upstream release; `imageTag: "auto"` resolves to this. */
+export const PINNED_TAG = "3.5.0";
+/**
+ * Container-side Wyoming port. The image bakes `--uri tcp://0.0.0.0:10300`
+ * into its entrypoint, so the container ALWAYS listens on 10300 internally.
+ */
+export const WYOMING_PORT = 10300;
+export const NOTIFICATION_PATH = "notifications.voice.whisper";
+/** First-start model download sizes surfaced in plugin status / README. */
+export const DOWNLOAD_HINT = "tiny-int8 ≈ 43 MB, base-int8 ≈ 80 MB";
+/**
+ * Models accepted by the `--model` flag. NEVER "auto": with the 3.5.0 image
+ * `--model auto --language en` silently switches to a ~0.6B-parameter
+ * sherpa/Parakeet backend and downloads hundreds of MB — a disaster on a
+ * boat server. int8 models are the recommended choice.
+ */
+export const WHISPER_MODELS = [
+    "tiny-int8",
+    "base-int8",
+    "small-int8",
+    "medium-int8",
+    "tiny",
+    "tiny.en",
+    "base",
+    "base.en",
+    "small",
+    "small.en",
+    "medium.en",
+    "turbo",
+];
+/**
+ * Default `--initial-prompt`: nautical vocabulary that biases Whisper toward
+ * sailing terms. The cheapest accuracy win available — user-editable.
+ */
+export const NAUTICAL_PROMPT = "Genoa, jib, mainsail, spinnaker, windlass, gybe, tack, halyard, winch, " +
+    "anchor chain, rode, bilge, galley, helm, autopilot, waypoint, knots, " +
+    "port, starboard, bow, stern, leeward, windward, reef, furl, " +
+    "log position, anchor alarm, engine, throttle.";
+export function defaultSettings() {
+    return {
+        imageTag: "auto",
+        model: "tiny-int8",
+        language: "en",
+        initialPrompt: NAUTICAL_PROMPT,
+        port: WYOMING_PORT,
+        advanced: {
+            bind: "127.0.0.1",
+            memoryLimit: "1g",
+            restartPolicy: "unless-stopped",
+        },
+    };
+}
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+/**
+ * Merge raw plugin config over the defaults. Signal K does NOT seed schema
+ * defaults into saved configurations, and hand-edited config files can hold
+ * anything — every field is validated and falls back to its default.
+ * Guarantees `model` is never "auto" (see WHISPER_MODELS).
+ */
+export function applyDefaults(raw) {
+    const defaults = defaultSettings();
+    if (!isRecord(raw))
+        return defaults;
+    const adv = isRecord(raw.advanced) ? raw.advanced : {};
+    const model = typeof raw.model === "string" &&
+        WHISPER_MODELS.includes(raw.model)
+        ? raw.model
+        : defaults.model;
+    const language = typeof raw.language === "string" && raw.language.trim() !== ""
+        ? raw.language.trim()
+        : defaults.language;
+    // Empty string is meaningful (disables --initial-prompt entirely).
+    const initialPrompt = typeof raw.initialPrompt === "string"
+        ? raw.initialPrompt
+        : defaults.initialPrompt;
+    const imageTag = typeof raw.imageTag === "string" && raw.imageTag.trim() !== ""
+        ? raw.imageTag.trim()
+        : defaults.imageTag;
+    const port = typeof raw.port === "number" &&
+        Number.isInteger(raw.port) &&
+        raw.port > 0 &&
+        raw.port <= 65535
+        ? raw.port
+        : defaults.port;
+    const bind = adv.bind === "0.0.0.0" ? "0.0.0.0" : defaults.advanced.bind;
+    const memoryLimit = typeof adv.memoryLimit === "string" && adv.memoryLimit.trim() !== ""
+        ? adv.memoryLimit.trim()
+        : defaults.advanced.memoryLimit;
+    const restartPolicy = adv.restartPolicy === "no" ||
+        adv.restartPolicy === "always" ||
+        adv.restartPolicy === "unless-stopped"
+        ? adv.restartPolicy
+        : defaults.advanced.restartPolicy;
+    return {
+        imageTag,
+        model,
+        language,
+        initialPrompt,
+        port,
+        advanced: { bind, memoryLimit, restartPolicy },
+    };
+}
+/** Maps the user-facing tag to the tag actually run: "auto" → pinned. */
+export function resolveTag(requested) {
+    return requested === "auto" ? PINNED_TAG : requested;
+}
+/** True for plain numeric semver tags like "3.5.0" (update-check filter). */
+export function isSemverTag(tag) {
+    return /^\d+\.\d+\.\d+$/.test(tag);
+}
+/**
+ * Pure, deterministic settings → ContainerConfig mapping. Called on every
+ * start/update; the `command` array is always present and stable so
+ * signalk-container's drift detection never recreate-loops.
+ *
+ * Networking: by default the Wyoming port is declared via
+ * `signalkAccessiblePorts` (published on host loopback on bare metal; wired
+ * to the right network on containerized Signal K). `bind: "0.0.0.0"`
+ * switches to an explicit all-interfaces port publish (for sharing the
+ * service with e.g. Home Assistant) — the two mechanisms must never be
+ * combined on the same port.
+ */
+export function buildContainerConfig(settings, tag) {
+    const prompt = settings.initialPrompt.trim();
+    const command = [
+        "--model",
+        settings.model,
+        "--language",
+        settings.language,
+        ...(prompt === "" ? [] : ["--initial-prompt", prompt]),
+    ];
+    const config = {
+        image: IMAGE,
+        tag,
+        command,
+        // Model downloads land in /data; mounting the plugin's Signal K data
+        // dir there makes them survive container recreation (offline-first).
+        signalkDataMount: "/data",
+        restart: settings.advanced.restartPolicy,
+        resources: {
+            memory: settings.advanced.memoryLimit,
+            memorySwap: settings.advanced.memoryLimit,
+        },
+    };
+    if (settings.advanced.bind === "0.0.0.0") {
+        config.ports = { [String(WYOMING_PORT)]: `0.0.0.0:${settings.port}` };
+    }
+    else {
+        config.signalkAccessiblePorts = [WYOMING_PORT];
+    }
+    return config;
+}
+export const CONFIG_SCHEMA = {
+    type: "object",
+    properties: {
+        model: {
+            type: "string",
+            title: "Whisper model",
+            enum: [...WHISPER_MODELS],
+            default: "tiny-int8",
+            description: "Speech-recognition model. The int8 models are recommended: " +
+                "tiny-int8 fits a Pi 4, base-int8 is noticeably more accurate on a " +
+                "Pi 5 / x86 box. Larger models are slower and use much more RAM — " +
+                "use the signalk-wyoming webapp's Test screen latency display to " +
+                "guide upgrades. Changing the model downloads it on first use " +
+                "(tiny-int8 ≈ 43 MB, base-int8 ≈ 80 MB).",
+        },
+        language: {
+            type: "string",
+            title: "Language",
+            default: "en",
+            description: "Spoken language code (e.g. en, de, fr). 'auto' enables per-utterance " +
+                "language detection but costs both speed and accuracy on the small " +
+                "models — set it explicitly if you can.",
+        },
+        initialPrompt: {
+            type: "string",
+            title: "Initial prompt (vocabulary hint)",
+            default: NAUTICAL_PROMPT,
+            description: "Text passed to Whisper as --initial-prompt to bias recognition " +
+                "toward your vocabulary. Ships with a nautical word list — add your " +
+                "vessel name, local port names, and boat-specific gear. Leave empty " +
+                "to disable.",
+        },
+        imageTag: {
+            type: "string",
+            title: "Image tag",
+            default: "auto",
+            description: `Docker image tag for ${IMAGE}. 'auto' runs the pinned, tested ` +
+                `release (${PINNED_TAG}) and follows this plugin's updates. Set an ` +
+                "explicit tag only if you need to pin a different upstream version.",
+        },
+        port: {
+            type: "number",
+            title: "Host port",
+            default: WYOMING_PORT,
+            description: "Host TCP port for the Wyoming service — only used with 'Bind " +
+                "address' 0.0.0.0, where the service is published on exactly this " +
+                "port. With the default loopback networking this setting is " +
+                "ignored: signalk-container assigns the host port automatically " +
+                "(normally 10300, the next free port if that is taken).",
+        },
+        advanced: {
+            type: "object",
+            title: "Advanced",
+            properties: {
+                bind: {
+                    type: "string",
+                    title: "Bind address",
+                    enum: ["127.0.0.1", "0.0.0.0"],
+                    default: "127.0.0.1",
+                    description: "127.0.0.1 (default) keeps whisper reachable only from this " +
+                        "machine — the signalk-wyoming orchestrator is its only " +
+                        "intended consumer. 0.0.0.0 publishes it on all interfaces so " +
+                        "other systems (e.g. Home Assistant) can share it. Wyoming has " +
+                        "no authentication: only expose it on trusted networks (see the " +
+                        "README security notes).",
+                },
+                memoryLimit: {
+                    type: "string",
+                    title: "Memory limit",
+                    default: "1g",
+                    description: "Hard container memory cap (docker syntax, e.g. 1g, 1536m). " +
+                        "Swap is capped to the same value. Keeps a misbehaving model " +
+                        "from taking down the boat server.",
+                },
+                restartPolicy: {
+                    type: "string",
+                    title: "Restart policy",
+                    enum: ["no", "unless-stopped", "always"],
+                    default: "unless-stopped",
+                    description: "Container runtime restart policy.",
+                },
+            },
+        },
+    },
+};
+export const UI_SCHEMA = {
+    initialPrompt: {
+        "ui:widget": "textarea",
+    },
+};
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,MAAM,CAAC,MAAM,SAAS,GAAG,iBAAiB,CAAC;AAC3C,MAAM,CAAC,MAAM,WAAW,GAAG,uBAAuB,CAAC;AACnD,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,CAAC;AAClC,2EAA2E;AAC3E,MAAM,CAAC,MAAM,cAAc,GAAG,SAAS,CAAC;AACxC,MAAM,CAAC,MAAM,KAAK,GAAG,yBAAyB,CAAC;AAC/C,4EAA4E;AAC5E,MAAM,CAAC,MAAM,UAAU,GAAG,OAAO,CAAC;AAClC;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,CAAC;AAClC,MAAM,CAAC,MAAM,iBAAiB,GAAG,6BAA6B,CAAC;AAC/D,2EAA2E;AAC3E,MAAM,CAAC,MAAM,aAAa,GAAG,sCAAsC,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,WAAW;IACX,WAAW;IACX,YAAY;IACZ,aAAa;IACb,MAAM;IACN,SAAS;IACT,MAAM;IACN,SAAS;IACT,OAAO;IACP,UAAU;IACV,WAAW;IACX,OAAO;CACC,CAAC;AAIX;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAC1B,yEAAyE;IACzE,uEAAuE;IACvE,8DAA8D;IAC9D,+CAA+C,CAAC;AAiBlD,MAAM,UAAU,eAAe;IAC7B,OAAO;QACL,QAAQ,EAAE,MAAM;QAChB,KAAK,EAAE,WAAW;QAClB,QAAQ,EAAE,IAAI;QACd,aAAa,EAAE,eAAe;QAC9B,IAAI,EAAE,YAAY;QAClB,QAAQ,EAAE;YACR,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,IAAI;YACjB,aAAa,EAAE,gBAAgB;SAChC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,GAAY;IACxC,MAAM,QAAQ,GAAG,eAAe,EAAE,CAAC;IACnC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,QAAQ,CAAC;IACpC,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAEvD,MAAM,KAAK,GACT,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ;QAC5B,cAAoC,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC;QACvD,CAAC,CAAE,GAAG,CAAC,KAAsB;QAC7B,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;IACrB,MAAM,QAAQ,GACZ,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE;QAC5D,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE;QACrB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACxB,mEAAmE;IACnE,MAAM,aAAa,GACjB,OAAO,GAAG,CAAC,aAAa,KAAK,QAAQ;QACnC,CAAC,CAAC,GAAG,CAAC,aAAa;QACnB,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC;IAC7B,MAAM,QAAQ,GACZ,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE;QAC5D,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE;QACrB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;IACxB,MAAM,IAAI,GACR,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;QAC5B,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC;QAC1B,GAAG,CAAC,IAAI,GAAG,CAAC;QACZ,GAAG,CAAC,IAAI,IAAI,KAAK;QACf,CAAC,CAAC,GAAG,CAAC,IAAI;QACV,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;IACpB,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;IACzE,MAAM,WAAW,GACf,OAAO,GAAG,CAAC,WAAW,KAAK,QAAQ,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE;QAClE,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE;QACxB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC;IACpC,MAAM,aAAa,GACjB,GAAG,CAAC,aAAa,KAAK,IAAI;QAC1B,GAAG,CAAC,aAAa,KAAK,QAAQ;QAC9B,GAAG,CAAC,aAAa,KAAK,gBAAgB;QACpC,CAAC,CAAC,GAAG,CAAC,aAAa;QACnB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC;IAEtC,OAAO;QACL,QAAQ;QACR,KAAK;QACL,QAAQ;QACR,aAAa;QACb,IAAI;QACJ,QAAQ,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE;KAC/C,CAAC;AACJ,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,UAAU,CAAC,SAAiB;IAC1C,OAAO,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;AACvD,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,OAAO,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,oBAAoB,CAClC,QAAyB,EACzB,GAAW;IAEX,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;IAC7C,MAAM,OAAO,GAAG;QACd,SAAS;QACT,QAAQ,CAAC,KAAK;QACd,YAAY;QACZ,QAAQ,CAAC,QAAQ;QACjB,GAAG,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;KACvD,CAAC;IACF,MAAM,MAAM,GAAoB;QAC9B,KAAK,EAAE,KAAK;QACZ,GAAG;QACH,OAAO;QACP,qEAAqE;QACrE,qEAAqE;QACrE,gBAAgB,EAAE,OAAO;QACzB,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,aAAa;QACxC,SAAS,EAAE;YACT,MAAM,EAAE,QAAQ,CAAC,QAAQ,CAAC,WAAW;YACrC,UAAU,EAAE,QAAQ,CAAC,QAAQ,CAAC,WAAW;SAC1C;KACF,CAAC;IACF,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QACzC,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,WAAW,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;IACxE,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,sBAAsB,GAAG,CAAC,YAAY,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC;YACzB,OAAO,EAAE,WAAW;YACpB,WAAW,EACT,6DAA6D;gBAC7D,oEAAoE;gBACpE,mEAAmE;gBACnE,kEAAkE;gBAClE,+DAA+D;gBAC/D,yCAAyC;SAC5C;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,UAAU;YACjB,OAAO,EAAE,IAAI;YACb,WAAW,EACT,uEAAuE;gBACvE,oEAAoE;gBACpE,wCAAwC;SAC3C;QACD,aAAa,EAAE;YACb,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,kCAAkC;YACzC,OAAO,EAAE,eAAe;YACxB,WAAW,EACT,iEAAiE;gBACjE,qEAAqE;gBACrE,qEAAqE;gBACrE,aAAa;SAChB;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,WAAW;YAClB,OAAO,EAAE,MAAM;YACf,WAAW,EACT,wBAAwB,KAAK,mCAAmC;gBAChE,YAAY,UAAU,8CAA8C;gBACpE,oEAAoE;SACvE;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,WAAW;YAClB,OAAO,EAAE,YAAY;YACrB,WAAW,EACT,+DAA+D;gBAC/D,mEAAmE;gBACnE,6DAA6D;gBAC7D,iEAAiE;gBACjE,wDAAwD;SAC3D;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,UAAU;YACjB,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,cAAc;oBACrB,IAAI,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC;oBAC9B,OAAO,EAAE,WAAW;oBACpB,WAAW,EACT,6DAA6D;wBAC7D,yDAAyD;wBACzD,+DAA+D;wBAC/D,gEAAgE;wBAChE,iEAAiE;wBACjE,yBAAyB;iBAC5B;gBACD,WAAW,EAAE;oBACX,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,cAAc;oBACrB,OAAO,EAAE,IAAI;oBACb,WAAW,EACT,6DAA6D;wBAC7D,8DAA8D;wBAC9D,mCAAmC;iBACtC;gBACD,aAAa,EAAE;oBACb,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,gBAAgB;oBACvB,IAAI,EAAE,CAAC,IAAI,EAAE,gBAAgB,EAAE,QAAQ,CAAC;oBACxC,OAAO,EAAE,gBAAgB;oBACzB,WAAW,EAAE,mCAAmC;iBACjD;aACF;SACF;KACF;CACO,CAAC;AAEX,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,aAAa,EAAE;QACb,WAAW,EAAE,UAAU;KACxB;CACO,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * signalk-whisper — Whisper speech-to-text (Wyoming protocol) for Signal K.
+ *
+ * Runs rhasspy/wyoming-whisper in a container managed via signalk-container
+ * (through signalk-container-helper), gates readiness on a Wyoming
+ * `describe` handshake, health-checks it, and advertises the service on the
+ * shared `wyoming-service` PropertyValues channel for the signalk-wyoming
+ * orchestrator (or any other consumer) to discover.
+ */
+import type { Plugin, ServerAPI } from "@signalk/server-api";
+import { ServiceRunner, type RunnerTiming } from "./service.js";
+export type { RunnerTiming };
+export { ServiceRunner };
+export default function createPlugin(app: ServerAPI): Plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAc7D,OAAO,EAAE,aAAa,EAAE,KAAK,YAAY,EAAE,MAAM,cAAc,CAAC;AAEhE,YAAY,EAAE,YAAY,EAAE,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,CAAC;AA6BzB,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM,CAiI3D"}