@m1kad0/hannah-proto 0.5.2 → 0.5.4

package/README.md

@@ -0,0 +1,33 @@
+# hannah-proto
+
+Protobuf/gRPC schema definitions for the Hannah voice assistant ecosystem (Core, satellites, WebUI, ioBroker adapter, Telegram bot, and other consumers). This repo is the single source of truth for the wire protocol shared across all of them.
+
+The `.proto` files live flat at the repo root, one per functional area — satellite control, event streaming, the ioBroker agent bridge, user registry, timers, automations, and so on. Nothing here is application code, just schema.
+
+## Distribution
+
+Three independent, tag-triggered publish targets — pick whichever matches your language. Each contains only generated gRPC stubs/types for the current tagged release.
+
+| Language   | Package                                 | Install                                    |
+|------------|------------------------------------------|---------------------------------------------|
+| Python     | PyPI [`hannah-proto`](https://pypi.org/project/hannah-proto/) | `pip install hannah-proto` |
+| TypeScript | npm [`@m1kad0/hannah-proto`](https://www.npmjs.com/package/@m1kad0/hannah-proto) | `npm install @m1kad0/hannah-proto` |
+| Go         | [github.com/NurPech/hannah-proto-go](https://github.com/NurPech/hannah-proto-go) | `go get github.com/NurPech/hannah-proto-go` |
+
+Go has no separate package registry, so that tagged GitHub repo *is* the package — `go get` resolves it directly.
+
+## Versioning: PROTO_VERSION
+
+Alongside the semver package/tag version, every release carries a single-integer `PROTO_VERSION` (see the `PROTO_VERSION` file). Hannah Core and its clients exchange this value on every call and reject a mismatch at runtime — that's the actual compatibility gate, not the semver tag. A breaking schema change requires bumping `PROTO_VERSION`; CI enforces this on every merge request via `buf breaking`.
+
+## Compatibility checks
+
+CI runs `buf lint` and `buf breaking` (against `origin/master`) on every MR. To check a local branch against a specific released version:
+
+```sh
+buf breaking --against '.git#tag=vX.Y.Z'
+```
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for what changed release to release, including breaking changes and the consumers they affect.

package/dist/control.d.ts

@@ -68,6 +68,13 @@ export interface Satellite {
     ownerUserId: number;
     /** display name of owner_user_id, "" if unassigned */
     ownerDisplayName: string;
+    /** firmware_version of the satellite */
+    firmwareVersion: string;
+    /** true if the device has a new firmware available */
+    updateAvailable: boolean;
+    newVersion?: string | undefined;
+    /** #158: mic reopens after a Smalltalk answer instead of waiting for wake-word/PTT again */
+    smalltalkFollowupListen: boolean;
 }
 export interface GetSatellitesResponse {
     satellites: Satellite[];
@@ -92,6 +99,12 @@ export interface SetSatelliteOwnerRequest {
     /** requestor */
     requestorId: number;
 }
+export interface SetSatelliteSmalltalkFollowupRequest {
+    deviceId: string;
+    enabled: boolean;
+    /** requestor */
+    requestorId: number;
+}
 export interface DeleteSatelliteRequest {
     deviceId: string;
     /** requestor */
@@ -319,6 +332,7 @@ export declare const GetSatellitesResponse: MessageFns<GetSatellitesResponse>;
 export declare const SetSatelliteRoomRequest: MessageFns<SetSatelliteRoomRequest>;
 export declare const SetSatelliteDisplayNameRequest: MessageFns<SetSatelliteDisplayNameRequest>;
 export declare const SetSatelliteOwnerRequest: MessageFns<SetSatelliteOwnerRequest>;
+export declare const SetSatelliteSmalltalkFollowupRequest: MessageFns<SetSatelliteSmalltalkFollowupRequest>;
 export declare const DeleteSatelliteRequest: MessageFns<DeleteSatelliteRequest>;
 export declare const Room: MessageFns<Room>;
 export declare const GetRoomsResponse: MessageFns<GetRoomsResponse>;

package/dist/control.js

@@ -5,7 +5,7 @@
 //   protoc               unknown
 // source: control.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeleteCarRequest = exports.UpdateCarRequest = exports.CreateCarResponse = exports.CreateCarRequest = exports.GetCarsResponse = exports.Car = exports.DeleteBleTagRequest = exports.UpdateBleTagRequest = exports.CreateBleTagResponse = exports.CreateBleTagRequest = exports.GetBleTagsResponse = exports.BleTag = exports.UpdateConfigRequest = exports.SettingUpdate = exports.GetSettingsResponse = exports.Setting = exports.Category = exports.DeleteAlarmRequest = exports.UpdateAlarmRequest = exports.CreateAlarmResponse = exports.CreateAlarmRequest = exports.GetAlarmsResponse = exports.Alarm = exports.DeleteTriggerRequest = exports.UpdateTriggerRequest = exports.CreateTriggerRequest = exports.GetTriggersResponse = exports.Trigger = exports.SetGroupRoomsRequest = exports.DeleteGroupRequest = exports.UpdateGroupRequest = exports.CreateGroupRequest = exports.GetGroupsResponse = exports.Group = exports.GetRoomsResponse = exports.Room = exports.DeleteSatelliteRequest = exports.SetSatelliteOwnerRequest = exports.SetSatelliteDisplayNameRequest = exports.SetSatelliteRoomRequest = exports.GetSatellitesResponse = exports.Satellite = exports.AnnounceRequest = exports.SubmitVoiceResponse = exports.SubmitVoiceRequest = exports.SubmitTextResponse = exports.SubmitTextRequest = exports.protobufPackage = void 0;
+exports.DeleteCarRequest = exports.UpdateCarRequest = exports.CreateCarResponse = exports.CreateCarRequest = exports.GetCarsResponse = exports.Car = exports.DeleteBleTagRequest = exports.UpdateBleTagRequest = exports.CreateBleTagResponse = exports.CreateBleTagRequest = exports.GetBleTagsResponse = exports.BleTag = exports.UpdateConfigRequest = exports.SettingUpdate = exports.GetSettingsResponse = exports.Setting = exports.Category = exports.DeleteAlarmRequest = exports.UpdateAlarmRequest = exports.CreateAlarmResponse = exports.CreateAlarmRequest = exports.GetAlarmsResponse = exports.Alarm = exports.DeleteTriggerRequest = exports.UpdateTriggerRequest = exports.CreateTriggerRequest = exports.GetTriggersResponse = exports.Trigger = exports.SetGroupRoomsRequest = exports.DeleteGroupRequest = exports.UpdateGroupRequest = exports.CreateGroupRequest = exports.GetGroupsResponse = exports.Group = exports.GetRoomsResponse = exports.Room = exports.DeleteSatelliteRequest = exports.SetSatelliteSmalltalkFollowupRequest = exports.SetSatelliteOwnerRequest = exports.SetSatelliteDisplayNameRequest = exports.SetSatelliteRoomRequest = exports.GetSatellitesResponse = exports.Satellite = exports.AnnounceRequest = exports.SubmitVoiceResponse = exports.SubmitVoiceRequest = exports.SubmitTextResponse = exports.SubmitTextRequest = exports.protobufPackage = void 0;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 exports.protobufPackage = "hannah";
@@ -348,6 +348,10 @@ function createBaseSatellite() {
         roomMismatch: false,
         ownerUserId: 0,
         ownerDisplayName: "",
+        firmwareVersion: "",
+        updateAvailable: false,
+        newVersion: undefined,
+        smalltalkFollowupListen: false,
     };
 }
 exports.Satellite = {
@@ -385,6 +389,18 @@ exports.Satellite = {
         if (message.ownerDisplayName !== "") {
             writer.uint32(98).string(message.ownerDisplayName);
         }
+        if (message.firmwareVersion !== "") {
+            writer.uint32(106).string(message.firmwareVersion);
+        }
+        if (message.updateAvailable !== false) {
+            writer.uint32(112).bool(message.updateAvailable);
+        }
+        if (message.newVersion !== undefined) {
+            writer.uint32(122).string(message.newVersion);
+        }
+        if (message.smalltalkFollowupListen !== false) {
+            writer.uint32(128).bool(message.smalltalkFollowupListen);
+        }
         return writer;
     },
     decode(input, length) {
@@ -471,6 +487,34 @@ exports.Satellite = {
                     message.ownerDisplayName = reader.string();
                     continue;
                 }
+                case 13: {
+                    if (tag !== 106) {
+                        break;
+                    }
+                    message.firmwareVersion = reader.string();
+                    continue;
+                }
+                case 14: {
+                    if (tag !== 112) {
+                        break;
+                    }
+                    message.updateAvailable = reader.bool();
+                    continue;
+                }
+                case 15: {
+                    if (tag !== 122) {
+                        break;
+                    }
+                    message.newVersion = reader.string();
+                    continue;
+                }
+                case 16: {
+                    if (tag !== 128) {
+                        break;
+                    }
+                    message.smalltalkFollowupListen = reader.bool();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -495,6 +539,10 @@ exports.Satellite = {
         message.roomMismatch = object.roomMismatch ?? false;
         message.ownerUserId = object.ownerUserId ?? 0;
         message.ownerDisplayName = object.ownerDisplayName ?? "";
+        message.firmwareVersion = object.firmwareVersion ?? "";
+        message.updateAvailable = object.updateAvailable ?? false;
+        message.newVersion = object.newVersion ?? undefined;
+        message.smalltalkFollowupListen = object.smalltalkFollowupListen ?? false;
         return message;
     },
 };
@@ -728,6 +776,69 @@ exports.SetSatelliteOwnerRequest = {
         return message;
     },
 };
+function createBaseSetSatelliteSmalltalkFollowupRequest() {
+    return { deviceId: "", enabled: false, requestorId: 0 };
+}
+exports.SetSatelliteSmalltalkFollowupRequest = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.deviceId !== "") {
+            writer.uint32(10).string(message.deviceId);
+        }
+        if (message.enabled !== false) {
+            writer.uint32(16).bool(message.enabled);
+        }
+        if (message.requestorId !== 0) {
+            writer.uint32(24).int32(message.requestorId);
+        }
+        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 = createBaseSetSatelliteSmalltalkFollowupRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.deviceId = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.enabled = reader.bool();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 24) {
+                        break;
+                    }
+                    message.requestorId = reader.int32();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    create(base) {
+        return exports.SetSatelliteSmalltalkFollowupRequest.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseSetSatelliteSmalltalkFollowupRequest();
+        message.deviceId = object.deviceId ?? "";
+        message.enabled = object.enabled ?? false;
+        message.requestorId = object.requestorId ?? 0;
+        return message;
+    },
+};
 function createBaseDeleteSatelliteRequest() {
     return { deviceId: "", requestorId: 0 };
 }

package/dist/event_stream.d.ts

@@ -22,6 +22,8 @@ export interface SystemNotificationEvent {
 export interface FirmwareEventProto {
     device: string;
     version: string;
+    updateAvailable: boolean;
+    newVersion?: string | undefined;
 }
 export interface TriggerFirmwareUpdateRequest {
     device: string;

package/dist/event_stream.js

@@ -204,7 +204,7 @@ exports.SystemNotificationEvent = {
     },
 };
 function createBaseFirmwareEventProto() {
-    return { device: "", version: "" };
+    return { device: "", version: "", updateAvailable: false, newVersion: undefined };
 }
 exports.FirmwareEventProto = {
     encode(message, writer = new wire_1.BinaryWriter()) {
@@ -214,6 +214,12 @@ exports.FirmwareEventProto = {
         if (message.version !== "") {
             writer.uint32(18).string(message.version);
         }
+        if (message.updateAvailable !== false) {
+            writer.uint32(24).bool(message.updateAvailable);
+        }
+        if (message.newVersion !== undefined) {
+            writer.uint32(34).string(message.newVersion);
+        }
         return writer;
     },
     decode(input, length) {
@@ -237,6 +243,20 @@ exports.FirmwareEventProto = {
                     message.version = reader.string();
                     continue;
                 }
+                case 3: {
+                    if (tag !== 24) {
+                        break;
+                    }
+                    message.updateAvailable = reader.bool();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.newVersion = reader.string();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -252,6 +272,8 @@ exports.FirmwareEventProto = {
         const message = createBaseFirmwareEventProto();
         message.device = object.device ?? "";
         message.version = object.version ?? "";
+        message.updateAvailable = object.updateAvailable ?? false;
+        message.newVersion = object.newVersion ?? undefined;
         return message;
     },
 };

package/dist/hannah.d.ts

@@ -2,7 +2,7 @@ import { type CallOptions, type ChannelCredentials, Client, type ClientDuplexStr
 import { AgentCommand, AgentMessage, AgentNotification } from "./agent";
 import { AutomationCommand, AutomationMessage } from "./automation";
 import { CarStateResponse, GetAllCarStatesResponse } from "./car_state";
-import { AnnounceRequest, CreateAlarmRequest, CreateAlarmResponse, CreateBleTagRequest, CreateBleTagResponse, CreateCarRequest, CreateCarResponse, CreateGroupRequest, CreateTriggerRequest, DeleteAlarmRequest, DeleteBleTagRequest, DeleteCarRequest, DeleteGroupRequest, DeleteSatelliteRequest, DeleteTriggerRequest, GetAlarmsResponse, GetBleTagsResponse, GetCarsResponse, GetGroupsResponse, GetRoomsResponse, GetSatellitesResponse, GetSettingsResponse, GetTriggersResponse, SetGroupRoomsRequest, SetSatelliteDisplayNameRequest, SetSatelliteOwnerRequest, SetSatelliteRoomRequest, SubmitTextRequest, SubmitTextResponse, SubmitVoiceRequest, SubmitVoiceResponse, UpdateAlarmRequest, UpdateBleTagRequest, UpdateCarRequest, UpdateConfigRequest, UpdateGroupRequest, UpdateTriggerRequest } from "./control";
+import { AnnounceRequest, CreateAlarmRequest, CreateAlarmResponse, CreateBleTagRequest, CreateBleTagResponse, CreateCarRequest, CreateCarResponse, CreateGroupRequest, CreateTriggerRequest, DeleteAlarmRequest, DeleteBleTagRequest, DeleteCarRequest, DeleteGroupRequest, DeleteSatelliteRequest, DeleteTriggerRequest, GetAlarmsResponse, GetBleTagsResponse, GetCarsResponse, GetGroupsResponse, GetRoomsResponse, GetSatellitesResponse, GetSettingsResponse, GetTriggersResponse, SetGroupRoomsRequest, SetSatelliteDisplayNameRequest, SetSatelliteOwnerRequest, SetSatelliteRoomRequest, SetSatelliteSmalltalkFollowupRequest, SubmitTextRequest, SubmitTextResponse, SubmitVoiceRequest, SubmitVoiceResponse, UpdateAlarmRequest, UpdateBleTagRequest, UpdateCarRequest, UpdateConfigRequest, UpdateGroupRequest, UpdateTriggerRequest } from "./control";
 import { ControlDeviceRequest, GetDevicesResponse } from "./device_control_menu";
 import { EventFilter, HannahEvent, TriggerFirmwareUpdateRequest } from "./event_stream";
 import { ProvisionSatelliteRequest } from "./satellite_provisioning";
@@ -239,6 +239,19 @@ export declare const HannahServiceService: {
         readonly responseSerialize: (value: StatusResponse) => Buffer;
         readonly responseDeserialize: (value: Buffer) => StatusResponse;
     };
+    /**
+     * Toggle whether the satellite's mic reopens after a Smalltalk answer instead of
+     * waiting for wake-word/PTT again (silence-timeout lives in the satellite firmware). #158
+     */
+    readonly setSatelliteSmalltalkFollowup: {
+        readonly path: "/hannah.HannahService/SetSatelliteSmalltalkFollowup";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: SetSatelliteSmalltalkFollowupRequest) => Buffer;
+        readonly requestDeserialize: (value: Buffer) => SetSatelliteSmalltalkFollowupRequest;
+        readonly responseSerialize: (value: StatusResponse) => Buffer;
+        readonly responseDeserialize: (value: Buffer) => StatusResponse;
+    };
     /** Delete existing satellite */
     readonly deleteSatellite: {
         readonly path: "/hannah.HannahService/DeleteSatellite";
@@ -770,6 +783,11 @@ export interface HannahServiceServer extends UntypedServiceImplementation {
     setSatelliteDisplayName: handleUnaryCall<SetSatelliteDisplayNameRequest, StatusResponse>;
     /** Assign a satellite to a Person (User), independent of its room. #31 */
     setSatelliteOwner: handleUnaryCall<SetSatelliteOwnerRequest, StatusResponse>;
+    /**
+     * Toggle whether the satellite's mic reopens after a Smalltalk answer instead of
+     * waiting for wake-word/PTT again (silence-timeout lives in the satellite firmware). #158
+     */
+    setSatelliteSmalltalkFollowup: handleUnaryCall<SetSatelliteSmalltalkFollowupRequest, StatusResponse>;
     /** Delete existing satellite */
     deleteSatellite: handleUnaryCall<DeleteSatelliteRequest, StatusResponse>;
     /** --- Rooms/Groups (Admin-UI, #27 Phase 1) --- */
@@ -993,6 +1011,13 @@ export interface HannahServiceClient extends Client {
     setSatelliteOwner(request: SetSatelliteOwnerRequest, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
     setSatelliteOwner(request: SetSatelliteOwnerRequest, metadata: Metadata, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
     setSatelliteOwner(request: SetSatelliteOwnerRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
+    /**
+     * Toggle whether the satellite's mic reopens after a Smalltalk answer instead of
+     * waiting for wake-word/PTT again (silence-timeout lives in the satellite firmware). #158
+     */
+    setSatelliteSmalltalkFollowup(request: SetSatelliteSmalltalkFollowupRequest, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
+    setSatelliteSmalltalkFollowup(request: SetSatelliteSmalltalkFollowupRequest, metadata: Metadata, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
+    setSatelliteSmalltalkFollowup(request: SetSatelliteSmalltalkFollowupRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
     /** Delete existing satellite */
     deleteSatellite(request: DeleteSatelliteRequest, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;
     deleteSatellite(request: DeleteSatelliteRequest, metadata: Metadata, callback: (error: ServiceError | null, response: StatusResponse) => void): ClientUnaryCall;

package/dist/hannah.js

@@ -247,6 +247,19 @@ exports.HannahServiceService = {
         responseSerialize: (value) => Buffer.from(shared_1.StatusResponse.encode(value).finish()),
         responseDeserialize: (value) => shared_1.StatusResponse.decode(value),
     },
+    /**
+     * Toggle whether the satellite's mic reopens after a Smalltalk answer instead of
+     * waiting for wake-word/PTT again (silence-timeout lives in the satellite firmware). #158
+     */
+    setSatelliteSmalltalkFollowup: {
+        path: "/hannah.HannahService/SetSatelliteSmalltalkFollowup",
+        requestStream: false,
+        responseStream: false,
+        requestSerialize: (value) => Buffer.from(control_1.SetSatelliteSmalltalkFollowupRequest.encode(value).finish()),
+        requestDeserialize: (value) => control_1.SetSatelliteSmalltalkFollowupRequest.decode(value),
+        responseSerialize: (value) => Buffer.from(shared_1.StatusResponse.encode(value).finish()),
+        responseDeserialize: (value) => shared_1.StatusResponse.decode(value),
+    },
     /** Delete existing satellite */
     deleteSatellite: {
         path: "/hannah.HannahService/DeleteSatellite",

package/package.json

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