@m1kad0/hannah-proto 5.1.0 → 5.2.0

package/dist/v2/agent.d.ts

@@ -100,13 +100,15 @@ export interface CaptureControl {
 }
 /**
  * A state change event for a state Hannah asked to watch (AgentWatchMore), e.g. the
- * trigger engine's conditions. Devices are not reported this way, they use SlotUpdate.
+ * trigger engine's conditions. `state_id` is the identifier the adapter uses for the value
+ * (for ioBroker the state ID, the same as `Slot.identifier` for a slot of a device). Devices
+ * report their changes as SlotUpdate; a value that is both a slot and watched gets both.
  * ack=true means the device confirmed the value (as opposed to ack=false which is the
  * "desired" value). Hannah uses this to verify that a SetState command was executed
- * successfully.
+ * successfully. The value is the raw one of that state, not normalized to a slot scale.
  */
 export interface AgentStateUpdate {
-    /** full ioBroker state ID, e.g. "0_userdata.0.feeded" */
+    /** identifier of the value, for ioBroker the full state ID, e.g. "0_userdata.0.feeded" */
     stateId: string;
     /** JSON-encoded value: "true", "42", "\"text\"" */
     value: string;
@@ -114,6 +116,13 @@ export interface AgentStateUpdate {
     ack: boolean;
     /** Unix timestamp in milliseconds */
     ts: bigint;
+    /**
+     * Field 5 is deliberately unused: in hannah.v1 it was `canonical_key`, a different type.
+     * true = the current value the adapter sends when it starts watching a state (its answer to
+     * AgentWatchMore), not a change. Hannah Core uses it to prefill the trigger engine's cache
+     * silently, without firing triggers: an update from "unknown" to a value is not a transition.
+     */
+    initial: boolean;
 }
 /** The text-command state in ioBroker changed — treat as a SubmitText call. */
 export interface AgentTextCommand {
@@ -183,15 +192,16 @@ export interface AgentFirmwareEvent {
  * confirms execution back to Hannah.
  */
 export interface AgentSetState {
-    /** ioBroker state ID to write */
+    /** identifier of the value to write, for ioBroker the state ID */
     stateId: string;
     /** JSON-encoded value */
     value: string;
 }
 /**
- * Hannah requests additional state IDs to be included in the AgentStateUpdate stream.
- * Used by the trigger engine at runtime when triggers reference arbitrary state IDs
- * (e.g. unless.state: "0_userdata.0.feeded") that aren't covered by enum discovery.
+ * Hannah requests additional identifiers (for ioBroker state IDs) to be included in the
+ * AgentStateUpdate stream. Used by the trigger engine at runtime when triggers reference
+ * arbitrary values (e.g. unless.state: "0_userdata.0.feeded") that aren't covered by enum
+ * discovery. The adapter answers every new one with its current raw value, `initial` = true.
  */
 export interface AgentWatchMore {
     stateIds: string[];

package/dist/v2/agent.js

@@ -476,7 +476,7 @@ exports.CaptureControl = {
     },
 };
 function createBaseAgentStateUpdate() {
-    return { stateId: "", value: "", ack: false, ts: 0n };
+    return { stateId: "", value: "", ack: false, ts: 0n, initial: false };
 }
 exports.AgentStateUpdate = {
     encode(message, writer = new wire_1.BinaryWriter()) {
@@ -495,6 +495,9 @@ exports.AgentStateUpdate = {
             }
             writer.uint32(32).int64(message.ts);
         }
+        if (message.initial !== false) {
+            writer.uint32(48).bool(message.initial);
+        }
         return writer;
     },
     decode(input, length) {
@@ -538,6 +541,13 @@ exports.AgentStateUpdate = {
                         message.ts = reader.int64();
                         continue;
                     }
+                    case 6: {
+                        if (tag !== 48) {
+                            break;
+                        }
+                        message.initial = reader.bool();
+                        continue;
+                    }
                 }
                 if ((tag & 7) === 4 || tag === 0) {
                     break;
@@ -559,6 +569,7 @@ exports.AgentStateUpdate = {
         message.value = object.value ?? "";
         message.ack = object.ack ?? false;
         message.ts = (object.ts !== undefined && object.ts !== null) ? BigInt(object.ts) : 0n;
+        message.initial = object.initial ?? false;
         return message;
     },
 };

package/dist/v2/device_model.d.ts

@@ -163,6 +163,14 @@ export interface Slot {
      * honestly when a device cannot do what was asked.
      */
     options: string[];
+    /**
+     * How a trigger (and any client building triggers) refers to the value behind this slot: the
+     * identifier the adapter uses for it, for ioBroker the state ID. Opaque to Hannah Core, which
+     * only passes it through (AgentWatchMore, AgentSetState, AgentStateUpdate, trigger conditions
+     * and actions). Empty = not addressable by triggers. Triggers compare against the raw value
+     * of the identified state (and its own scale), not against the normalized `value` above.
+     */
+    identifier: string;
 }
 /** A device, as the adapter derived it from the ioBroker objects (grouping, class, slots). */
 export interface TypedDevice {

package/dist/v2/device_model.js

@@ -230,6 +230,7 @@ function createBaseSlot() {
         label: "",
         requiredTrustLevel: undefined,
         options: [],
+        identifier: "",
     };
 }
 exports.Slot = {
@@ -258,6 +259,9 @@ exports.Slot = {
         for (const v of message.options) {
             writer.uint32(66).string(v);
         }
+        if (message.identifier !== "") {
+            writer.uint32(74).string(message.identifier);
+        }
         return writer;
     },
     decode(input, length) {
@@ -329,6 +333,13 @@ exports.Slot = {
                         message.options.push(reader.string());
                         continue;
                     }
+                    case 9: {
+                        if (tag !== 74) {
+                            break;
+                        }
+                        message.identifier = reader.string();
+                        continue;
+                    }
                 }
                 if ((tag & 7) === 4 || tag === 0) {
                     break;
@@ -356,6 +367,7 @@ exports.Slot = {
         message.label = object.label ?? "";
         message.requiredTrustLevel = object.requiredTrustLevel ?? undefined;
         message.options = object.options?.map((e) => e) || [];
+        message.identifier = object.identifier ?? "";
         return message;
     },
 };

package/package.json

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