signalk-piper 0.0.1 → 0.1.0

package/README.md

@@ -1,15 +1,81 @@
 # signalk-piper
 
-> **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 doestn.
 
-[Wyoming](https://github.com/rhasspy/wyoming) [Piper](https://github.com/rhasspy/wyoming-piper) text-to-speech 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.
+[Piper](https://github.com/rhasspy/wyoming-piper) text-to-speech for [Signal K](https://signalk.org), running as a managed container and speaking the [Wyoming protocol](https://github.com/rhasspy/wyoming). The plugin pulls and supervises the pinned `rhasspy/wyoming-piper` image, gates readiness on a real Wyoming `describe`/`info` exchange (so "ready" means the voice model is downloaded _and_ the service answers), health-checks it continuously, and advertises the service on the `wyoming-service` PropertyValues convention for the [signalk-wyoming](https://github.com/hoeken/signalk-wyoming) orchestrator — the family spec lives in that repo. It is also fully standalone: any Wyoming client (including Home Assistant) can use the service directly.
 
-| Plugin | Role |
-|--------|------|
-| [signalk-wyoming](https://github.com/hoeken/signalk-wyoming) | Orchestrator — spec and discussion live here |
-| [signalk-whisper](https://github.com/hoeken/signalk-whisper) | Speech-to-text |
-| **signalk-piper** | Text-to-speech |
-| [signalk-openwakeword](https://github.com/hoeken/signalk-openwakeword) | Wake word detection |
+| Plugin                                                                 | Role                                                |
+| ---------------------------------------------------------------------- | --------------------------------------------------- |
+| [signalk-wyoming](https://github.com/hoeken/signalk-wyoming)           | Orchestrator — family spec and discussion live here |
+| [signalk-whisper](https://github.com/hoeken/signalk-whisper)           | Speech-to-text                                      |
+| **signalk-piper**                                                      | Text-to-speech                                      |
+| [signalk-openwakeword](https://github.com/hoeken/signalk-openwakeword) | Wake word detection                                 |
+
+## Requirements
+
+- The **[signalk-container](https://www.npmjs.com/package/signalk-container)** plugin, with a working podman or docker runtime (the plugin declares this via `"signalk": { "requires": ["signalk-container"] }`).
+- **Node.js ≥ 24** (Signal K server ≥ 2.x).
+- RAM: piper holds one loaded voice at **~150 MB resident**; the container is capped at 512 MB by default. A TTS-only voice install (piper + orchestrator) runs comfortably alongside Signal K on a Pi 4 / 2 GB.
+- Disk: ~410 MB (amd64) / ~370 MB (arm64) compressed image + ~60 MB per voice. Image architectures: `linux/amd64`, `linux/arm64` (no armv7).
+
+## Install
+
+Install **signalk-piper** from the Signal K App Store (Appstore → Available → search "piper"), then enable it in Plugin Config. Make sure signalk-container is installed and enabled first.
+
+## Configuration reference
+
+| Setting                    | Default               | Description                                                                                                                                                                                                                                                                                                    |
+| -------------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `voice`                    | `en_US-lessac-medium` | Piper voice to load and serve. **Use 22.05 kHz voices only** (`-medium` / `-high` qualities); `-low`/`-x_low` voices are 16 kHz and outside the signalk-wyoming v1 audio contract — the plugin warns but does not block. Browse voices at [rhasspy/piper-voices](https://huggingface.co/rhasspy/piper-voices). |
+| `imageTag`                 | `auto`                | Image tag for `rhasspy/wyoming-piper`. `auto` runs the pinned, tested release (**2.3.1**) and follows plugin updates; set an explicit tag to pin an upstream version.                                                                                                                                          |
+| `port`                     | `10200`               | Host port for the Wyoming TTS service.                                                                                                                                                                                                                                                                         |
+| `advanced.bind`            | `127.0.0.1`           | `127.0.0.1`: only Signal K can reach the service (recommended). `0.0.0.0`: publish on all interfaces for other machines (see [Security](#security)).                                                                                                                                                           |
+| `advanced.memoryLimit`     | `512m`                | Hard container memory cap (swap disabled).                                                                                                                                                                                                                                                                     |
+| `advanced.restartPolicy`   | `unless-stopped`      | Container restart policy (`no` / `unless-stopped` / `always`).                                                                                                                                                                                                                                                 |
+| `advanced.updateVoices`    | `false`               | Pass `--update-voices`: refresh the voices catalog from HuggingFace at container start (needs internet).                                                                                                                                                                                                       |
+| `advanced.sentenceSilence` | _(unset)_             | Pass `--sentence-silence <s>`: seconds of silence appended after each sentence.                                                                                                                                                                                                                                |
+| `advanced.lengthScale`     | _(unset)_             | Pass `--length-scale <n>`: phoneme length scale; > 1 slows speech down.                                                                                                                                                                                                                                        |
+
+## First start downloads the voice
+
+On first start the container downloads the configured voice (**~60 MB**) from HuggingFace into the plugin's data directory (mounted at `/data`), where it survives container recreation and image updates. Until the service answers, the plugin status shows _"Starting — first start downloads ~60 MB per voice"_.
+
+**Offline warning:** the first start of a given voice needs internet. Do this at the dock, not at sea — after that, everything runs fully offline. Per-request voices that were never downloaded also trigger a download at request time (see below), so pre-download any voice you plan to use.
+
+## How other software uses it
+
+The service is a plain Wyoming TTS endpoint at `tcp://<host>:10200`.
+
+- **signalk-wyoming** discovers it automatically via the `wyoming-service` PropertyValues emission (`{ plugin: "signalk-piper", type: "tts", uri, status }`) — no manual wiring needed.
+- **Home Assistant** (standalone use): set `advanced.bind` to `0.0.0.0`, then add a Wyoming Protocol integration pointing at `tcp://<boat-ip>:10200`.
+- **Per-request voice override:** Wyoming `synthesize` requests may name any known voice (`voice.name`); piper downloads voices it knows about but hasn't cached — a mid-request network hit, so pre-download voices you rely on.
+
+The plugin also serves (on its Signal K router, `/plugins/signalk-piper`):
+
+- `GET /api/status` — `{ status, uri, tag, containerState, lastHealth, info }` (readonly auth where supported)
+- `GET /api/update/check` / `POST /api/update/apply` — container image update endpoints (admin)
+
+## Health and notifications
+
+- Readiness is protocol-native: the plugin polls Wyoming `describe` every 2 s (for up to 10 minutes, to ride out slow first-start downloads) and reports ready only on a valid `info` response. Wyoming protocol versions outside 1.x log a loud warning but don't block.
+- After that, a health loop sends `describe` every 30 s (5 s timeout). **Three consecutive failures** raise the Signal K notification `notifications.voice.piper` (`state: "alarm"`, `method: ["visual"]`), set a plugin error, and emit `wyoming-service` status `error`; recovery clears the notification (`state: "normal"`) and re-emits `ready`.
+- Status emissions are debounced (≥ 500 ms apart, duplicate suppression, flap guard) so a wobbly service can't flood the server's PropertyValues table.
+
+## Security
+
+Wyoming has **no authentication**. The default `bind: 127.0.0.1` keeps the service reachable only from the Signal K host (and from Signal K itself in containerized deployments) — leave it that way unless another machine genuinely needs TTS. If you set `bind: 0.0.0.0` (e.g. to share the service with Home Assistant), firewall the port at the boat router or put it on a trusted VLAN; anyone who can reach the port can use the service. See the family spec's security section for the full picture (satellite mic ports are the sensitive ones).
+
+## Development
+
+```sh
+npm install
+npm run build                 # tsc → dist/
+npm test                      # typecheck + vitest (mock Wyoming server + fake container manager; no docker needed)
+npm run ci-lint               # eslint + prettier check
+npm run format                # prettier + eslint --fix
+```
+
+Tests use the scriptable mock Wyoming server from `signalk-wyoming/mock` (a devDependency on the [signalk-wyoming](https://github.com/hoeken/signalk-wyoming) package). Production code has no dependency on signalk-wyoming; it embeds its own minimal describe client (`src/wyoming.ts`).
 
 ## License
 

package/dist/config.d.ts

@@ -0,0 +1,127 @@
+/**
+ * Configuration schema, defaults and container-config construction for
+ * signalk-piper.
+ *
+ * Signal K does NOT seed schema defaults into the config it hands to
+ * `start()` — `resolveSettings()` merges user config over `DEFAULT_SETTINGS`.
+ * `buildContainerConfig()` must stay a pure, deterministic function of
+ * (settings, tag): signalk-container diffs the produced config against the
+ * live container to decide whether a recreate is needed.
+ */
+import type { ContainerConfig } from "signalk-container-helper";
+/** Upstream image (repo without tag). */
+export declare const IMAGE = "rhasspy/wyoming-piper";
+/** Pinned upstream release that `imageTag: "auto"` resolves to. */
+export declare const PINNED_TAG = "2.3.1";
+/** Wyoming TCP port piper listens on inside the container (image default). */
+export declare const DEFAULT_PORT = 10200;
+/** Approximate first-start download per voice (README + status hint). */
+export declare const DOWNLOAD_HINT = "~60 MB per voice";
+export interface PiperAdvancedSettings {
+    /**
+     * "127.0.0.1": Signal K-only networking via signalkAccessiblePorts.
+     * "0.0.0.0": publish the port on all interfaces (LAN-reachable).
+     */
+    bind: "127.0.0.1" | "0.0.0.0";
+    memoryLimit: string;
+    restartPolicy: "no" | "unless-stopped" | "always";
+    updateVoices: boolean;
+    sentenceSilence?: number;
+    lengthScale?: number;
+}
+export interface PiperSettings {
+    imageTag: string;
+    voice: string;
+    port: number;
+    advanced: PiperAdvancedSettings;
+}
+export declare const DEFAULT_SETTINGS: PiperSettings;
+/** Merge raw plugin config (possibly partial/undefined) over the defaults. */
+export declare function resolveSettings(raw: unknown): PiperSettings;
+/** `imageTag: "auto"` → the pinned upstream release; anything else verbatim. */
+export declare function resolveTag(requested: string): string;
+/** True for plain numeric semver tags like "2.3.1" (update-check filter). */
+export declare function isSemverTag(tag: string): boolean;
+/** True for 16 kHz voices, which the v1 family spec excludes (22.05 kHz only). */
+export declare function isLowSampleRateVoice(voice: string): boolean;
+/**
+ * `docker run` arguments appended to the image ENTRYPOINT (which already
+ * bakes `--uri tcp://0.0.0.0:10200 --data-dir /data`).
+ */
+export declare function buildCommand(settings: PiperSettings): string[];
+/** Pure (settings, tag) → ContainerConfig. */
+export declare function buildContainerConfig(settings: PiperSettings, tag: string): ContainerConfig;
+/** JSON schema for the Signal K plugin-config UI. */
+export declare const CONFIG_SCHEMA: {
+    readonly type: "object";
+    readonly properties: {
+        readonly voice: {
+            readonly type: "string";
+            readonly title: "Voice";
+            readonly default: string;
+            readonly description: string;
+        };
+        readonly imageTag: {
+            readonly type: "string";
+            readonly title: "Image tag";
+            readonly default: string;
+            readonly description: string;
+        };
+        readonly port: {
+            readonly type: "number";
+            readonly title: "Port";
+            readonly default: number;
+            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" | "0.0.0.0";
+                    readonly description: string;
+                };
+                readonly memoryLimit: {
+                    readonly type: "string";
+                    readonly title: "Memory limit";
+                    readonly default: string;
+                    readonly description: "Hard container memory cap (swap disabled), e.g. \"512m\" or \"1g\".";
+                };
+                readonly restartPolicy: {
+                    readonly type: "string";
+                    readonly title: "Restart policy";
+                    readonly enum: readonly ["no", "unless-stopped", "always"];
+                    readonly default: "no" | "unless-stopped" | "always";
+                    readonly description: "Container restart policy.";
+                };
+                readonly updateVoices: {
+                    readonly type: "boolean";
+                    readonly title: "Update voices list on start";
+                    readonly default: boolean;
+                    readonly description: string;
+                };
+                readonly sentenceSilence: {
+                    readonly type: "number";
+                    readonly title: "Sentence silence (seconds)";
+                    readonly description: "Optional seconds of silence appended after each sentence.";
+                };
+                readonly lengthScale: {
+                    readonly type: "number";
+                    readonly title: "Length scale";
+                    readonly description: "Optional phoneme length scale; values above 1 slow speech down.";
+                };
+            };
+        };
+    };
+};
+export declare const UI_SCHEMA: {
+    readonly advanced: {
+        readonly "ui:options": {
+            readonly collapsible: true;
+        };
+    };
+};
+//# 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;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAEhE,yCAAyC;AACzC,eAAO,MAAM,KAAK,0BAA0B,CAAC;AAE7C,mEAAmE;AACnE,eAAO,MAAM,UAAU,UAAU,CAAC;AAElC,8EAA8E;AAC9E,eAAO,MAAM,YAAY,QAAQ,CAAC;AAElC,yEAAyE;AACzE,eAAO,MAAM,aAAa,qBAAqB,CAAC;AAEhD,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,IAAI,EAAE,WAAW,GAAG,SAAS,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,IAAI,GAAG,gBAAgB,GAAG,QAAQ,CAAC;IAClD,YAAY,EAAE,OAAO,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,qBAAqB,CAAC;CACjC;AAED,eAAO,MAAM,gBAAgB,EAAE,aAU9B,CAAC;AAEF,8EAA8E;AAC9E,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,GAAG,aAAa,CAyB3D;AAED,gFAAgF;AAChF,wBAAgB,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED,6EAA6E;AAC7E,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED,kFAAkF;AAClF,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAE3D;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,aAAa,GAAG,MAAM,EAAE,CAkB9D;AAED,8CAA8C;AAC9C,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,aAAa,EACvB,GAAG,EAAE,MAAM,GACV,eAAe,CAyBjB;AAED,qDAAqD;AACrD,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmFhB,CAAC;AAEX,eAAO,MAAM,SAAS;;;;;;CAIZ,CAAC"}

package/dist/config.js

@@ -0,0 +1,208 @@
+/**
+ * Configuration schema, defaults and container-config construction for
+ * signalk-piper.
+ *
+ * Signal K does NOT seed schema defaults into the config it hands to
+ * `start()` — `resolveSettings()` merges user config over `DEFAULT_SETTINGS`.
+ * `buildContainerConfig()` must stay a pure, deterministic function of
+ * (settings, tag): signalk-container diffs the produced config against the
+ * live container to decide whether a recreate is needed.
+ */
+/** Upstream image (repo without tag). */
+export const IMAGE = "rhasspy/wyoming-piper";
+/** Pinned upstream release that `imageTag: "auto"` resolves to. */
+export const PINNED_TAG = "2.3.1";
+/** Wyoming TCP port piper listens on inside the container (image default). */
+export const DEFAULT_PORT = 10200;
+/** Approximate first-start download per voice (README + status hint). */
+export const DOWNLOAD_HINT = "~60 MB per voice";
+export const DEFAULT_SETTINGS = {
+    imageTag: "auto",
+    voice: "en_US-lessac-medium",
+    port: DEFAULT_PORT,
+    advanced: {
+        bind: "127.0.0.1",
+        memoryLimit: "512m",
+        restartPolicy: "unless-stopped",
+        updateVoices: false,
+    },
+};
+/** Merge raw plugin config (possibly partial/undefined) over the defaults. */
+export function resolveSettings(raw) {
+    const cfg = isObject(raw) ? raw : {};
+    const adv = isObject(cfg.advanced) ? cfg.advanced : {};
+    const settings = {
+        imageTag: str(cfg.imageTag) ?? DEFAULT_SETTINGS.imageTag,
+        voice: str(cfg.voice) ?? DEFAULT_SETTINGS.voice,
+        port: num(cfg.port) ?? DEFAULT_SETTINGS.port,
+        advanced: {
+            bind: adv.bind === "0.0.0.0" ? "0.0.0.0" : "127.0.0.1",
+            memoryLimit: str(adv.memoryLimit) ?? DEFAULT_SETTINGS.advanced.memoryLimit,
+            restartPolicy: adv.restartPolicy === "no" || adv.restartPolicy === "always"
+                ? adv.restartPolicy
+                : DEFAULT_SETTINGS.advanced.restartPolicy,
+            updateVoices: adv.updateVoices === true,
+        },
+    };
+    const sentenceSilence = num(adv.sentenceSilence);
+    if (sentenceSilence !== undefined) {
+        settings.advanced.sentenceSilence = sentenceSilence;
+    }
+    const lengthScale = num(adv.lengthScale);
+    if (lengthScale !== undefined)
+        settings.advanced.lengthScale = lengthScale;
+    return settings;
+}
+/** `imageTag: "auto"` → the pinned upstream release; anything else verbatim. */
+export function resolveTag(requested) {
+    return requested === "auto" ? PINNED_TAG : requested;
+}
+/** True for plain numeric semver tags like "2.3.1" (update-check filter). */
+export function isSemverTag(tag) {
+    return /^\d+\.\d+\.\d+$/.test(tag);
+}
+/** True for 16 kHz voices, which the v1 family spec excludes (22.05 kHz only). */
+export function isLowSampleRateVoice(voice) {
+    return voice.endsWith("-low") || voice.endsWith("-x_low");
+}
+/**
+ * `docker run` arguments appended to the image ENTRYPOINT (which already
+ * bakes `--uri tcp://0.0.0.0:10200 --data-dir /data`).
+ */
+export function buildCommand(settings) {
+    const command = ["--voice", settings.voice];
+    if (settings.advanced.updateVoices)
+        command.push("--update-voices");
+    if (settings.advanced.sentenceSilence !== undefined) {
+        command.push("--sentence-silence", String(settings.advanced.sentenceSilence));
+    }
+    if (settings.advanced.lengthScale !== undefined) {
+        command.push("--length-scale", String(settings.advanced.lengthScale));
+    }
+    if (settings.port !== DEFAULT_PORT) {
+        // --uri is last-wins in upstream argparse, so this overrides the baked-in
+        // port and makes the container actually listen on the configured port.
+        command.push("--uri", `tcp://0.0.0.0:${settings.port}`);
+    }
+    return command;
+}
+/** Pure (settings, tag) → ContainerConfig. */
+export function buildContainerConfig(settings, tag) {
+    const config = {
+        image: IMAGE,
+        tag,
+        command: buildCommand(settings),
+        // Voice models download into /data on first start; the Signal K data
+        // mount survives container recreation.
+        signalkDataMount: "/data",
+        restart: settings.advanced.restartPolicy,
+        resources: {
+            memory: settings.advanced.memoryLimit,
+            memorySwap: settings.advanced.memoryLimit,
+        },
+    };
+    if (settings.advanced.bind === "0.0.0.0") {
+        // LAN exposure (e.g. sharing the service with Home Assistant): explicit
+        // all-interfaces publish. Never combined with signalkAccessiblePorts —
+        // the manager would overwrite/drop the manual binding.
+        config.ports = { [String(settings.port)]: `0.0.0.0:${settings.port}` };
+    }
+    else {
+        // Default: loopback-only on bare metal, container networking when
+        // Signal K itself runs in a container. Only Signal K needs to reach it.
+        config.signalkAccessiblePorts = [settings.port];
+    }
+    return config;
+}
+/** JSON schema for the Signal K plugin-config UI. */
+export const CONFIG_SCHEMA = {
+    type: "object",
+    properties: {
+        voice: {
+            type: "string",
+            title: "Voice",
+            default: DEFAULT_SETTINGS.voice,
+            description: "Piper voice to load and serve (e.g. en_US-lessac-medium). Use 22.05 kHz " +
+                "voices only — -medium and -high qualities. Voices ending in -low or " +
+                "-x_low are 16 kHz and outside the signalk-wyoming v1 audio contract. " +
+                "Browse voices at https://huggingface.co/rhasspy/piper-voices. The " +
+                "voice (~60 MB) is downloaded on first start.",
+        },
+        imageTag: {
+            type: "string",
+            title: "Image tag",
+            default: DEFAULT_SETTINGS.imageTag,
+            description: `Docker image tag for ${IMAGE}. "auto" runs the pinned, tested ` +
+                `release (${PINNED_TAG}) and follows plugin updates. Set an explicit ` +
+                "tag only to pin a specific upstream version.",
+        },
+        port: {
+            type: "number",
+            title: "Port",
+            default: DEFAULT_SETTINGS.port,
+            description: "Host port for the Wyoming TTS service. Leave at 10200 unless it " +
+                "collides with something else on this machine.",
+        },
+        advanced: {
+            type: "object",
+            title: "Advanced",
+            properties: {
+                bind: {
+                    type: "string",
+                    title: "Bind address",
+                    enum: ["127.0.0.1", "0.0.0.0"],
+                    default: DEFAULT_SETTINGS.advanced.bind,
+                    description: "127.0.0.1 (recommended): only Signal K can reach the service. " +
+                        "0.0.0.0 publishes the port on all interfaces so other machines " +
+                        "(e.g. a Home Assistant box) can use it — Wyoming has no " +
+                        "authentication, so firewall accordingly.",
+                },
+                memoryLimit: {
+                    type: "string",
+                    title: "Memory limit",
+                    default: DEFAULT_SETTINGS.advanced.memoryLimit,
+                    description: 'Hard container memory cap (swap disabled), e.g. "512m" or "1g".',
+                },
+                restartPolicy: {
+                    type: "string",
+                    title: "Restart policy",
+                    enum: ["no", "unless-stopped", "always"],
+                    default: DEFAULT_SETTINGS.advanced.restartPolicy,
+                    description: "Container restart policy.",
+                },
+                updateVoices: {
+                    type: "boolean",
+                    title: "Update voices list on start",
+                    default: DEFAULT_SETTINGS.advanced.updateVoices,
+                    description: "Download the latest voices.json from HuggingFace at container " +
+                        "start (needs internet; off by default for offline-first boats).",
+                },
+                sentenceSilence: {
+                    type: "number",
+                    title: "Sentence silence (seconds)",
+                    description: "Optional seconds of silence appended after each sentence.",
+                },
+                lengthScale: {
+                    type: "number",
+                    title: "Length scale",
+                    description: "Optional phoneme length scale; values above 1 slow speech down.",
+                },
+            },
+        },
+    },
+};
+export const UI_SCHEMA = {
+    advanced: {
+        "ui:options": { collapsible: true },
+    },
+};
+function isObject(v) {
+    return v !== null && typeof v === "object" && !Array.isArray(v);
+}
+function str(v) {
+    return typeof v === "string" && v.length > 0 ? v : undefined;
+}
+function num(v) {
+    return typeof v === "number" && Number.isFinite(v) ? v : undefined;
+}
+//# 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;;;;;;;;;GASG;AAIH,yCAAyC;AACzC,MAAM,CAAC,MAAM,KAAK,GAAG,uBAAuB,CAAC;AAE7C,mEAAmE;AACnE,MAAM,CAAC,MAAM,UAAU,GAAG,OAAO,CAAC;AAElC,8EAA8E;AAC9E,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,CAAC;AAElC,yEAAyE;AACzE,MAAM,CAAC,MAAM,aAAa,GAAG,kBAAkB,CAAC;AAsBhD,MAAM,CAAC,MAAM,gBAAgB,GAAkB;IAC7C,QAAQ,EAAE,MAAM;IAChB,KAAK,EAAE,qBAAqB;IAC5B,IAAI,EAAE,YAAY;IAClB,QAAQ,EAAE;QACR,IAAI,EAAE,WAAW;QACjB,WAAW,EAAE,MAAM;QACnB,aAAa,EAAE,gBAAgB;QAC/B,YAAY,EAAE,KAAK;KACpB;CACF,CAAC;AAEF,8EAA8E;AAC9E,MAAM,UAAU,eAAe,CAAC,GAAY;IAC1C,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACrC,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IACvD,MAAM,QAAQ,GAAkB;QAC9B,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,QAAQ;QACxD,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,gBAAgB,CAAC,KAAK;QAC/C,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,gBAAgB,CAAC,IAAI;QAC5C,QAAQ,EAAE;YACR,IAAI,EAAE,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW;YACtD,WAAW,EACT,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,gBAAgB,CAAC,QAAQ,CAAC,WAAW;YAC/D,aAAa,EACX,GAAG,CAAC,aAAa,KAAK,IAAI,IAAI,GAAG,CAAC,aAAa,KAAK,QAAQ;gBAC1D,CAAC,CAAC,GAAG,CAAC,aAAa;gBACnB,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,aAAa;YAC7C,YAAY,EAAE,GAAG,CAAC,YAAY,KAAK,IAAI;SACxC;KACF,CAAC;IACF,MAAM,eAAe,GAAG,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IACjD,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QAClC,QAAQ,CAAC,QAAQ,CAAC,eAAe,GAAG,eAAe,CAAC;IACtD,CAAC;IACD,MAAM,WAAW,GAAG,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACzC,IAAI,WAAW,KAAK,SAAS;QAAE,QAAQ,CAAC,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC;IAC3E,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,gFAAgF;AAChF,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,kFAAkF;AAClF,MAAM,UAAU,oBAAoB,CAAC,KAAa;IAChD,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC5D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,QAAuB;IAClD,MAAM,OAAO,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5C,IAAI,QAAQ,CAAC,QAAQ,CAAC,YAAY;QAAE,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACpE,IAAI,QAAQ,CAAC,QAAQ,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;QACpD,OAAO,CAAC,IAAI,CACV,oBAAoB,EACpB,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,eAAe,CAAC,CAC1C,CAAC;IACJ,CAAC;IACD,IAAI,QAAQ,CAAC,QAAQ,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QAChD,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;IACxE,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QACnC,0EAA0E;QAC1E,uEAAuE;QACvE,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,iBAAiB,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,8CAA8C;AAC9C,MAAM,UAAU,oBAAoB,CAClC,QAAuB,EACvB,GAAW;IAEX,MAAM,MAAM,GAAoB;QAC9B,KAAK,EAAE,KAAK;QACZ,GAAG;QACH,OAAO,EAAE,YAAY,CAAC,QAAQ,CAAC;QAC/B,qEAAqE;QACrE,uCAAuC;QACvC,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,wEAAwE;QACxE,uEAAuE;QACvE,uDAAuD;QACvD,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;IACzE,CAAC;SAAM,CAAC;QACN,kEAAkE;QAClE,wEAAwE;QACxE,MAAM,CAAC,sBAAsB,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,qDAAqD;AACrD,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,OAAO;YACd,OAAO,EAAE,gBAAgB,CAAC,KAAK;YAC/B,WAAW,EACT,0EAA0E;gBAC1E,sEAAsE;gBACtE,uEAAuE;gBACvE,oEAAoE;gBACpE,8CAA8C;SACjD;QACD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,WAAW;YAClB,OAAO,EAAE,gBAAgB,CAAC,QAAQ;YAClC,WAAW,EACT,wBAAwB,KAAK,mCAAmC;gBAChE,YAAY,UAAU,gDAAgD;gBACtE,8CAA8C;SACjD;QACD,IAAI,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,MAAM;YACb,OAAO,EAAE,gBAAgB,CAAC,IAAI;YAC9B,WAAW,EACT,kEAAkE;gBAClE,+CAA+C;SAClD;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,gBAAgB,CAAC,QAAQ,CAAC,IAAI;oBACvC,WAAW,EACT,gEAAgE;wBAChE,iEAAiE;wBACjE,0DAA0D;wBAC1D,0CAA0C;iBAC7C;gBACD,WAAW,EAAE;oBACX,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,cAAc;oBACrB,OAAO,EAAE,gBAAgB,CAAC,QAAQ,CAAC,WAAW;oBAC9C,WAAW,EACT,iEAAiE;iBACpE;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,CAAC,QAAQ,CAAC,aAAa;oBAChD,WAAW,EAAE,2BAA2B;iBACzC;gBACD,YAAY,EAAE;oBACZ,IAAI,EAAE,SAAS;oBACf,KAAK,EAAE,6BAA6B;oBACpC,OAAO,EAAE,gBAAgB,CAAC,QAAQ,CAAC,YAAY;oBAC/C,WAAW,EACT,gEAAgE;wBAChE,iEAAiE;iBACpE;gBACD,eAAe,EAAE;oBACf,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,4BAA4B;oBACnC,WAAW,EACT,2DAA2D;iBAC9D;gBACD,WAAW,EAAE;oBACX,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,cAAc;oBACrB,WAAW,EACT,iEAAiE;iBACpE;aACF;SACF;KACF;CACO,CAAC;AAEX,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,QAAQ,EAAE;QACR,YAAY,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE;KACpC;CACO,CAAC;AAEX,SAAS,QAAQ,CAAC,CAAU;IAC1B,OAAO,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,GAAG,CAAC,CAAU;IACrB,OAAO,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC/D,CAAC;AAED,SAAS,GAAG,CAAC,CAAU;IACrB,OAAO,OAAO,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACrE,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * signalk-piper — Piper text-to-speech (Wyoming protocol) as a Signal K
+ * managed container plugin.
+ *
+ * Runs rhasspy/wyoming-piper via the signalk-container plugin, gates
+ * readiness on a real Wyoming `describe`/`info` exchange, health-checks the
+ * service, and advertises it on the `wyoming-service` PropertyValues
+ * convention for the signalk-wyoming orchestrator (or any other consumer).
+ */
+import type { Plugin, ServerAPI } from "@signalk/server-api";
+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;AAK7D,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM,CAyC3D"}

package/dist/index.js

@@ -0,0 +1,43 @@
+/**
+ * signalk-piper — Piper text-to-speech (Wyoming protocol) as a Signal K
+ * managed container plugin.
+ *
+ * Runs rhasspy/wyoming-piper via the signalk-container plugin, gates
+ * readiness on a real Wyoming `describe`/`info` exchange, health-checks the
+ * service, and advertises it on the `wyoming-service` PropertyValues
+ * convention for the signalk-wyoming orchestrator (or any other consumer).
+ */
+import { CONFIG_SCHEMA, UI_SCHEMA } from "./config.js";
+import { PLUGIN_ID, PiperService } from "./service.js";
+export default function createPlugin(app) {
+    // One PiperService per server process: Express routers cannot be
+    // deregistered, so routes must keep pointing at a live object across
+    // plugin stop/start cycles.
+    let service = null;
+    let lastRawConfig;
+    const getService = () => {
+        service ??= new PiperService(app);
+        return service;
+    };
+    const plugin = {
+        id: PLUGIN_ID,
+        name: "Piper TTS (Wyoming)",
+        description: "Piper text-to-speech in a managed container (Wyoming protocol) — " +
+            "spoken announcements for the signalk-wyoming voice assistant family, " +
+            "or standalone for Home Assistant and other Wyoming clients.",
+        schema: () => CONFIG_SCHEMA,
+        uiSchema: () => UI_SCHEMA,
+        start(config) {
+            lastRawConfig = config;
+            getService().start(config);
+        },
+        stop() {
+            return service?.stop() ?? Promise.resolve();
+        },
+        registerWithRouter(router) {
+            getService().registerRoutes(router, () => lastRawConfig);
+        },
+    };
+    return plugin;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAmB,MAAM,cAAc,CAAC;AAExE,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,GAAc;IACjD,iEAAiE;IACjE,qEAAqE;IACrE,4BAA4B;IAC5B,IAAI,OAAO,GAAwB,IAAI,CAAC;IACxC,IAAI,aAAsB,CAAC;IAE3B,MAAM,UAAU,GAAG,GAAiB,EAAE;QACpC,OAAO,KAAK,IAAI,YAAY,CAAC,GAA4B,CAAC,CAAC;QAC3D,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;IAEF,MAAM,MAAM,GAAW;QACrB,EAAE,EAAE,SAAS;QACb,IAAI,EAAE,qBAAqB;QAC3B,WAAW,EACT,mEAAmE;YACnE,uEAAuE;YACvE,6DAA6D;QAE/D,MAAM,EAAE,GAAG,EAAE,CAAC,aAAkC;QAChD,QAAQ,EAAE,GAAG,EAAE,CAAC,SAA8B;QAE9C,KAAK,CAAC,MAAc;YAClB,aAAa,GAAG,MAAM,CAAC;YACvB,UAAU,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7B,CAAC;QAED,IAAI;YACF,OAAO,OAAO,EAAE,IAAI,EAAE,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QAC9C,CAAC;QAED,kBAAkB,CAAC,MAAM;YACvB,UAAU,EAAE,CAAC,cAAc,CACzB,MAA+B,EAC/B,GAAG,EAAE,CAAC,aAAa,CACpB,CAAC;QACJ,CAAC;KACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC"}