@m1kad0/hannah-proto 3.5.0 → 3.6.1

package/dist/agent.d.ts

@@ -1,5 +1,6 @@
 import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 import { EnumValues, StateType } from "./shared";
+import { CaptureMode, SampleType } from "./wakeword_capture";
 import { AgentWeatherUpdate } from "./weather";
 export declare const protobufPackage = "hannah";
 export declare enum ResidentType {
@@ -32,8 +33,9 @@ export interface AgentMessage {
 /**
  * Adapter instructs Hannah to control satellites in a room or a specific satellite.
  * room: room_id (enum ID segment) or "all" for all rooms.
- * device_id: if non-empty, only the named satellite is targeted (volume/mute only);
+ * device_id: if non-empty, only the named satellite is targeted (volume/mute/capture only);
  *            room is still required (used for room-scoped commands and as fallback).
+ *            For capture, device_id is mandatory — never room-broadcast.
  */
 export interface AgentSatelliteControl {
     room: string;
@@ -51,6 +53,17 @@ export interface AgentSatelliteControl {
     announcementSsml?: string | undefined;
     /** speak announcement, text rephrased by LLM first */
     announcementRephrase?: string | undefined;
+    /** start/stop a Voice Collector capture on this satellite */
+    capture?: CaptureControl | undefined;
+}
+/**
+ * Start or stop a Voice Collector capture — the AgentSatelliteControl counterpart
+ * to CaptureCommand, routed to the satellite named by AgentSatelliteControl.device_id.
+ */
+export interface CaptureControl {
+    sampleType: SampleType | undefined;
+    captureMode: CaptureMode;
+    stop: boolean;
 }
 /**
  * An ioBroker state change event. ack=true means the device confirmed the value
@@ -319,6 +332,7 @@ export interface AgentSensorUpdate {
 }
 export declare const AgentMessage: MessageFns<AgentMessage>;
 export declare const AgentSatelliteControl: MessageFns<AgentSatelliteControl>;
+export declare const CaptureControl: MessageFns<CaptureControl>;
 export declare const AgentStateUpdate: MessageFns<AgentStateUpdate>;
 export declare const AgentTextCommand: MessageFns<AgentTextCommand>;
 export declare const AgentCommand: MessageFns<AgentCommand>;

package/dist/agent.js

@@ -5,10 +5,11 @@
 //   protoc               unknown
 // source: hannah/agent.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AgentSensorUpdate = exports.AgentBleUpdate = exports.AgentResidentAnswered = exports.AgentAskResident = exports.AgentResidentSnapshot = exports.AgentResident = exports.AgentRoomSnapshot = exports.AgentRoom_DisplayNamesEntry = exports.AgentRoom = exports.AgentDeviceSnapshot = exports.AgentDevice_RoomNamesEntry = exports.AgentDevice = exports.AgentStateValue = exports.AgentNotification = exports.AgentTextAnswer = exports.AgentSatelliteDeleted = exports.AgentSatelliteUpdate = exports.AgentSetResidentMood = exports.AgentSetResident = exports.AgentWatchMore = exports.AgentSetState = exports.AgentFirmwareEvent = exports.AgentCommand = exports.AgentTextCommand = exports.AgentStateUpdate = exports.AgentSatelliteControl = exports.AgentMessage = exports.ResidentType = exports.protobufPackage = void 0;
+exports.AgentSensorUpdate = exports.AgentBleUpdate = exports.AgentResidentAnswered = exports.AgentAskResident = exports.AgentResidentSnapshot = exports.AgentResident = exports.AgentRoomSnapshot = exports.AgentRoom_DisplayNamesEntry = exports.AgentRoom = exports.AgentDeviceSnapshot = exports.AgentDevice_RoomNamesEntry = exports.AgentDevice = exports.AgentStateValue = exports.AgentNotification = exports.AgentTextAnswer = exports.AgentSatelliteDeleted = exports.AgentSatelliteUpdate = exports.AgentSetResidentMood = exports.AgentSetResident = exports.AgentWatchMore = exports.AgentSetState = exports.AgentFirmwareEvent = exports.AgentCommand = exports.AgentTextCommand = exports.AgentStateUpdate = exports.CaptureControl = exports.AgentSatelliteControl = exports.AgentMessage = exports.ResidentType = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const shared_1 = require("./shared");
+const wakeword_capture_1 = require("./wakeword_capture");
 const weather_1 = require("./weather");
 exports.protobufPackage = "hannah";
 var ResidentType;
@@ -186,6 +187,7 @@ function createBaseAgentSatelliteControl() {
         announcement: undefined,
         announcementSsml: undefined,
         announcementRephrase: undefined,
+        capture: undefined,
     };
 }
 exports.AgentSatelliteControl = {
@@ -214,6 +216,9 @@ exports.AgentSatelliteControl = {
         if (message.announcementRephrase !== undefined) {
             writer.uint32(66).string(message.announcementRephrase);
         }
+        if (message.capture !== undefined) {
+            exports.CaptureControl.encode(message.capture, writer.uint32(74).fork()).join();
+        }
         return writer;
     },
     decode(input, length) {
@@ -279,6 +284,13 @@ exports.AgentSatelliteControl = {
                     message.announcementRephrase = reader.string();
                     continue;
                 }
+                case 9: {
+                    if (tag !== 74) {
+                        break;
+                    }
+                    message.capture = exports.CaptureControl.decode(reader, reader.uint32());
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -300,6 +312,74 @@ exports.AgentSatelliteControl = {
         message.announcement = object.announcement ?? undefined;
         message.announcementSsml = object.announcementSsml ?? undefined;
         message.announcementRephrase = object.announcementRephrase ?? undefined;
+        message.capture = (object.capture !== undefined && object.capture !== null)
+            ? exports.CaptureControl.fromPartial(object.capture)
+            : undefined;
+        return message;
+    },
+};
+function createBaseCaptureControl() {
+    return { sampleType: undefined, captureMode: 0, stop: false };
+}
+exports.CaptureControl = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.sampleType !== undefined) {
+            wakeword_capture_1.SampleType.encode(message.sampleType, writer.uint32(10).fork()).join();
+        }
+        if (message.captureMode !== 0) {
+            writer.uint32(16).int32(message.captureMode);
+        }
+        if (message.stop !== false) {
+            writer.uint32(24).bool(message.stop);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseCaptureControl();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.sampleType = wakeword_capture_1.SampleType.decode(reader, reader.uint32());
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.captureMode = reader.int32();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 24) {
+                        break;
+                    }
+                    message.stop = reader.bool();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    create(base) {
+        return exports.CaptureControl.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseCaptureControl();
+        message.sampleType = (object.sampleType !== undefined && object.sampleType !== null)
+            ? wakeword_capture_1.SampleType.fromPartial(object.sampleType)
+            : undefined;
+        message.captureMode = object.captureMode ?? 0;
+        message.stop = object.stop ?? false;
         return message;
     },
 };

package/dist/compat_versions.js

@@ -62,6 +62,7 @@ exports.REQUIRED_COMPAT_VERSIONS = {
     "StreamSatelliteAudio": 1,
     "TriggerPlink": 1,
     "CollectorConnect": 1,
+    "TriggerCollectorCapture": 1,
     "RegisterProxy": 1,
     "SubmitSatelliteAudio": 1,
     "NotifySatelliteRegistered": 1,

package/dist/hannah.d.ts

@@ -618,6 +618,20 @@ export declare const HannahServiceService: {
         readonly responseSerialize: (value: CaptureCommand) => Buffer;
         readonly responseDeserialize: (value: Buffer) => CaptureCommand;
     };
+    /**
+     * Unary trigger for external callers (e.g. WebUI) that can't hold a CollectorConnect
+     * stream themselves — Hannah relays the command over its own CollectorConnect stream
+     * to the connected Collector. Fails with ok=false if no Collector is connected.
+     */
+    readonly triggerCollectorCapture: {
+        readonly path: "/hannah.HannahService/TriggerCollectorCapture";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: CaptureCommand) => Buffer;
+        readonly requestDeserialize: (value: Buffer) => CaptureCommand;
+        readonly responseSerialize: (value: StatusResponse) => Buffer;
+        readonly responseDeserialize: (value: Buffer) => StatusResponse;
+    };
     /**
      * --- Satellite Proxy (Go gRPC proxy) ---
      * Bidirectional keepalive stream. Proxy sends heartbeats; Hannah sends TTS
@@ -928,6 +942,12 @@ export interface HannahServiceServer extends UntypedServiceImplementation {
      * down to start/stop satellite captures instead of the Collector polling for them.
      */
     collectorConnect: handleBidiStreamingCall<CollectorMessage, CaptureCommand>;
+    /**
+     * Unary trigger for external callers (e.g. WebUI) that can't hold a CollectorConnect
+     * stream themselves — Hannah relays the command over its own CollectorConnect stream
+     * to the connected Collector. Fails with ok=false if no Collector is connected.
+     */
+    triggerCollectorCapture: handleUnaryCall<CaptureCommand, StatusResponse>;
     /**
      * --- Satellite Proxy (Go gRPC proxy) ---
      * Bidirectional keepalive stream. Proxy sends heartbeats; Hannah sends TTS
@@ -1248,6 +1268,14 @@ export interface HannahServiceClient extends Client {
     collectorConnect(): ClientDuplexStream<CollectorMessage, CaptureCommand>;
     collectorConnect(options: Partial<CallOptions>): ClientDuplexStream<CollectorMessage, CaptureCommand>;
     collectorConnect(metadata: Metadata, options?: Partial<CallOptions>): ClientDuplexStream<CollectorMessage, CaptureCommand>;
+    /**
+     * Unary trigger for external callers (e.g. WebUI) that can't hold a CollectorConnect
+     * stream themselves — Hannah relays the command over its own CollectorConnect stream
+     * to the connected Collector. Fails with ok=false if no Collector is connected.
+     */
+    triggerCollectorCapture(request: CaptureCommand, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
+    triggerCollectorCapture(request: CaptureCommand, metadata: Metadata, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
+    triggerCollectorCapture(request: CaptureCommand, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
     /**
      * --- Satellite Proxy (Go gRPC proxy) ---
      * Bidirectional keepalive stream. Proxy sends heartbeats; Hannah sends TTS

package/dist/hannah.js

@@ -626,6 +626,20 @@ exports.HannahServiceService = {
         responseSerialize: (value) => Buffer.from(wakeword_capture_1.CaptureCommand.encode(value).finish()),
         responseDeserialize: (value) => wakeword_capture_1.CaptureCommand.decode(value),
     },
+    /**
+     * Unary trigger for external callers (e.g. WebUI) that can't hold a CollectorConnect
+     * stream themselves — Hannah relays the command over its own CollectorConnect stream
+     * to the connected Collector. Fails with ok=false if no Collector is connected.
+     */
+    triggerCollectorCapture: {
+        path: "/hannah.HannahService/TriggerCollectorCapture",
+        requestStream: false,
+        responseStream: false,
+        requestSerialize: (value) => Buffer.from(wakeword_capture_1.CaptureCommand.encode(value).finish()),
+        requestDeserialize: (value) => wakeword_capture_1.CaptureCommand.decode(value),
+        responseSerialize: (value) => Buffer.from(shared_1.StatusResponse.encode(value).finish()),
+        responseDeserialize: (value) => shared_1.StatusResponse.decode(value),
+    },
     /**
      * --- Satellite Proxy (Go gRPC proxy) ---
      * Bidirectional keepalive stream. Proxy sends heartbeats; Hannah sends TTS

package/dist/wakeword_capture.d.ts

@@ -2,6 +2,12 @@ import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 export declare const protobufPackage = "hannah";
 export declare enum CaptureMode {
     CAPTURE_MODE_UNSPECIFIED = 0,
+    /**
+     * CAPTURE_MODE_MANUAL - Deprecated: identical in practice to CAPTURE_MODE_PTT (both mean "hand-triggered
+     * via the PTT button") — never produce this value, use CAPTURE_MODE_PTT instead.
+     *
+     * @deprecated
+     */
     CAPTURE_MODE_MANUAL = 1,
     CAPTURE_MODE_PTT = 2,
     CAPTURE_MODE_PLINK = 3,

package/dist/wakeword_capture.js

@@ -12,6 +12,12 @@ exports.protobufPackage = "hannah";
 var CaptureMode;
 (function (CaptureMode) {
     CaptureMode[CaptureMode["CAPTURE_MODE_UNSPECIFIED"] = 0] = "CAPTURE_MODE_UNSPECIFIED";
+    /**
+     * CAPTURE_MODE_MANUAL - Deprecated: identical in practice to CAPTURE_MODE_PTT (both mean "hand-triggered
+     * via the PTT button") — never produce this value, use CAPTURE_MODE_PTT instead.
+     *
+     * @deprecated
+     */
     CaptureMode[CaptureMode["CAPTURE_MODE_MANUAL"] = 1] = "CAPTURE_MODE_MANUAL";
     CaptureMode[CaptureMode["CAPTURE_MODE_PTT"] = 2] = "CAPTURE_MODE_PTT";
     CaptureMode[CaptureMode["CAPTURE_MODE_PLINK"] = 3] = "CAPTURE_MODE_PLINK";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@m1kad0/hannah-proto",
-  "version": "3.5.0",
+  "version": "3.6.1",
   "description": "Generated TypeScript gRPC-js client stubs for the Hannah voice assistant proto schema",
   "license": "UNLICENSED",
   "main": "dist/index.js",