@kusinta/iot-schema 0.2.0-beta.1 → 0.2.0-beta.11

package/src/kusinta/iot/link/v1/link_pb.d.ts

@@ -0,0 +1,419 @@
+// @generated by protoc-gen-es v2.12.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file kusinta/iot/link/v1/link.proto (package kusinta.iot.link.v1, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { DeviceId } from "../../identity/v1/identity_pb.js";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+import type { AttributeRef } from "../../access/v1/acl_pb.js";
+
+/**
+ * Describes the file kusinta/iot/link/v1/link.proto.
+ */
+export declare const file_kusinta_iot_link_v1_link: GenFile;
+
+/**
+ * What a gateway-kept link of a given function needs told to it.
+ *
+ * Only a soft link has settings at all — see LINK_MODE_HARD for why there is
+ * nothing in a device-to-device link for anyone to tune. And what a soft link
+ * needs differs entirely by function: a climate lead needs a target
+ * temperature, while forwarding a window's open state needs nothing whatsoever.
+ * Hence a oneof per function rather than a flat set of fields: the second
+ * function to arrive must not turn this into a bag of unrelated optionals named
+ * after the first.
+ *
+ * A function with no arm here has nothing to configure, and an attempt to
+ * configure it should be refused rather than accepted as a no-op.
+ *
+ * @generated from message kusinta.iot.link.v1.LinkSettings
+ */
+export declare type LinkSettings = Message<"kusinta.iot.link.v1.LinkSettings"> & {
+  /**
+   * @generated from oneof kusinta.iot.link.v1.LinkSettings.per_function
+   */
+  perFunction: {
+    /**
+     * @generated from field: kusinta.iot.link.v1.ClimateLeadSettings climate_lead = 1;
+     */
+    value: ClimateLeadSettings;
+    case: "climateLead";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message kusinta.iot.link.v1.LinkSettings.
+ * Use `create(LinkSettingsSchema)` to create a new message.
+ */
+export declare const LinkSettingsSchema: GenMessage<LinkSettings>;
+
+/**
+ * Settings for a gateway-kept LINK_FUNCTION_CLIMATE_LEAD.
+ *
+ * @generated from message kusinta.iot.link.v1.ClimateLeadSettings
+ */
+export declare type ClimateLeadSettings = Message<"kusinta.iot.link.v1.ClimateLeadSettings"> & {
+  /**
+   * The temperature this link is to hold, in centidegrees — the unit and
+   * encoding device/v1/properties.proto declares for every temperature in this
+   * schema, so nothing converts between the target and the readings it is
+   * compared against.
+   *
+   * Deliberately not the receiver's own setpoint attribute. A gateway steering
+   * a radiator valve it cannot feed a measurement to has only that setpoint to
+   * act through, so the setpoint becomes an actuator position which moves on
+   * its own and settles wherever the target needs it to. It stops being a
+   * statement of what anybody asked for, which is why the request is kept here.
+   *
+   * Per link, and a sender may lead several receivers — a room with more than
+   * one radiator is the ordinary case, and each of its links carries this
+   * number separately. An interface offering "the temperature in here" is
+   * therefore setting several links at once and is responsible for keeping them
+   * equal; nothing on this wire enforces it. A single target per room needs a
+   * room to hang it on, which is a larger idea than a link.
+   *
+   * One target, not one per heating and cooling mode: this addresses a valve
+   * that only heats. A device that can do both would need the setpoint's mode
+   * named alongside, the way webrtc/v1/setpoint_mode.proto names it for a
+   * command, and that is a new arm rather than a reinterpretation of this one.
+   *
+   * Explicit presence, per the rule properties.proto sets out: a settings
+   * message present with this never set must not be indistinguishable from a
+   * request to hold the room at 0.00 °C.
+   *
+   * @generated from field: optional sint32 target_setpoint = 1;
+   */
+  targetSetpoint?: number | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.link.v1.ClimateLeadSettings.
+ * Use `create(ClimateLeadSettingsSchema)` to create a new message.
+ */
+export declare const ClimateLeadSettingsSchema: GenMessage<ClimateLeadSettings>;
+
+/**
+ * One device leading another.
+ *
+ * @generated from message kusinta.iot.link.v1.DeviceLink
+ */
+export declare type DeviceLink = Message<"kusinta.iot.link.v1.DeviceLink"> & {
+  /**
+   * @generated from field: string link_id = 1;
+   */
+  linkId: string;
+
+  /**
+   * Which device leads. This is the control surface for the pair: for a climate
+   * link, the setpoint that governs both is written here.
+   *
+   * @generated from field: kusinta.iot.identity.v1.DeviceId sender = 2;
+   */
+  sender?: DeviceId | undefined;
+
+  /**
+   * Which device follows. One sender may lead several receivers — a room with
+   * more than one radiator is the ordinary case — and each is its own link.
+   * Several senders leading one receiver is not modelled: combining two
+   * measurements needs a policy, and no policy is defined.
+   *
+   * @generated from field: kusinta.iot.identity.v1.DeviceId receiver = 3;
+   */
+  receiver?: DeviceId | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.link.v1.LinkFunction function = 4;
+   */
+  function: LinkFunction;
+
+  /**
+   * @generated from field: kusinta.iot.link.v1.LinkMode mode = 5;
+   */
+  mode: LinkMode;
+
+  /**
+   * @generated from field: kusinta.iot.link.v1.LinkState state = 6;
+   */
+  state: LinkState;
+
+  /**
+   * @generated from field: google.protobuf.Timestamp created_at = 7;
+   */
+  createdAt?: Timestamp | undefined;
+
+  /**
+   * Why the link is not carrying, when state says it is not. Free text for a
+   * person, never parsed.
+   *
+   * @generated from field: string state_detail = 8;
+   */
+  stateDetail: string;
+
+  /**
+   * How this link is configured, where its mode and function give it anything
+   * to configure. Unset on every hard link, and on a soft one nobody has set up
+   * yet — which is a link that exists and is not doing anything, not an error.
+   *
+   * Carried on the link rather than left to be asked for separately, because an
+   * interface showing a soft climate link has to show the room's target next to
+   * it, and the receiver's own setpoint is not that number.
+   *
+   * @generated from field: kusinta.iot.link.v1.LinkSettings settings = 9;
+   */
+  settings?: LinkSettings | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.link.v1.DeviceLink.
+ * Use `create(DeviceLinkSchema)` to create a new message.
+ */
+export declare const DeviceLinkSchema: GenMessage<DeviceLink>;
+
+/**
+ * What a device can be linked as, declared by the connector that models it.
+ *
+ * Without this an interface cannot offer a sensible choice: it has no way to know
+ * which of two devices may lead, whether a hub can broker them, or which
+ * attribute carries the quantity in question. Matching is mechanical — the same
+ * function, opposite directions, and a mode both ends support.
+ *
+ * Declared per device rather than per endpoint. Endpoint would be more precise,
+ * but the channels a link actually attaches to frequently carry no readings and
+ * so are not announced as endpoints at all; a per-endpoint declaration would have
+ * nowhere honest to live. The reserved range on DeviceLink is where that would go
+ * if a vendor ever needs it.
+ *
+ * @generated from message kusinta.iot.link.v1.LinkCapability
+ */
+export declare type LinkCapability = Message<"kusinta.iot.link.v1.LinkCapability"> & {
+  /**
+   * @generated from field: kusinta.iot.link.v1.LinkFunction function = 1;
+   */
+  function: LinkFunction;
+
+  /**
+   * @generated from field: kusinta.iot.link.v1.LinkDirection direction = 2;
+   */
+  direction: LinkDirection;
+
+  /**
+   * Modes this device supports for this function. A hard link additionally
+   * requires the other end to be on the same hub, which this cannot state alone.
+   *
+   * @generated from field: repeated kusinta.iot.link.v1.LinkMode supported_modes = 3;
+   */
+  supportedModes: LinkMode[];
+
+  /**
+   * This device's own attribute for this function — the one it reads as a
+   * sender, or the one it is driven through as a receiver. Present because the
+   * two ends of a link need not speak the same cluster.
+   *
+   * @generated from field: kusinta.iot.access.v1.AttributeRef attribute = 4;
+   */
+  attribute?: AttributeRef | undefined;
+
+  /**
+   * Human-readable, from the connector, in whatever locale it was given. For
+   * display beside a choice; never matched on.
+   *
+   * @generated from field: string label = 5;
+   */
+  label: string;
+};
+
+/**
+ * Describes the message kusinta.iot.link.v1.LinkCapability.
+ * Use `create(LinkCapabilitySchema)` to create a new message.
+ */
+export declare const LinkCapabilitySchema: GenMessage<LinkCapability>;
+
+/**
+ * Every link a caller was shown, in reply to a listing.
+ *
+ * @generated from message kusinta.iot.link.v1.DeviceLinkList
+ */
+export declare type DeviceLinkList = Message<"kusinta.iot.link.v1.DeviceLinkList"> & {
+  /**
+   * @generated from field: repeated kusinta.iot.link.v1.DeviceLink links = 1;
+   */
+  links: DeviceLink[];
+};
+
+/**
+ * Describes the message kusinta.iot.link.v1.DeviceLinkList.
+ * Use `create(DeviceLinkListSchema)` to create a new message.
+ */
+export declare const DeviceLinkListSchema: GenMessage<DeviceLinkList>;
+
+/**
+ * What a link makes the sender do to the receiver.
+ *
+ * A function, not a cluster id, because the two ends do not necessarily speak the
+ * same cluster: a wall thermostat reports its temperature as Thermostat
+ * LocalTemperature while a bare sensor reports the same quantity as Temperature
+ * Measurement MeasuredValue. Each end states its own attribute in its
+ * LinkCapability; the function is what says the two belong together.
+ *
+ * @generated from enum kusinta.iot.link.v1.LinkFunction
+ */
+export enum LinkFunction {
+  /**
+   * @generated from enum value: LINK_FUNCTION_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * The sender leads the receiver's climate control.
+   *
+   * Stronger than feeding a measurement, and the difference matters to anything
+   * building a UI. Both the sender's measured temperature and its setpoint reach
+   * the receiver, and the transfer is one way: the receiver reports the sender's
+   * temperature as its own, and a setpoint written to the receiver is accepted
+   * and then reverted to the sender's. So the sender is the control surface for
+   * the pair, and a setpoint control offered on a linked receiver is one that
+   * appears to work and silently undoes itself.
+   *
+   * @generated from enum value: LINK_FUNCTION_CLIMATE_LEAD = 1;
+   */
+  CLIMATE_LEAD = 1,
+
+  /**
+   * The sender's open/closed state reaches the receiver, which acts on it —
+   * typically a contact telling a valve to stop heating an open room.
+   *
+   * Not implied by CLIMATE_LEAD: a device that leads a room's climate does not
+   * necessarily forward its own window state, and on at least one vendor it does
+   * not. Where both are wanted, both are linked.
+   *
+   * @generated from enum value: LINK_FUNCTION_WINDOW_STATE = 2;
+   */
+  WINDOW_STATE = 2,
+
+  /**
+   * The sender is an input the receiver acts on — a button or remote.
+   *
+   * @generated from enum value: LINK_FUNCTION_REMOTE_CONTROL = 3;
+   */
+  REMOTE_CONTROL = 3,
+}
+
+/**
+ * Describes the enum kusinta.iot.link.v1.LinkFunction.
+ */
+export declare const LinkFunctionSchema: GenEnum<LinkFunction>;
+
+/**
+ * Which end of a link a device can be.
+ *
+ * @generated from enum kusinta.iot.link.v1.LinkDirection
+ */
+export enum LinkDirection {
+  /**
+   * @generated from enum value: LINK_DIRECTION_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * can lead
+   *
+   * @generated from enum value: LINK_DIRECTION_SOURCE = 1;
+   */
+  SOURCE = 1,
+
+  /**
+   * can follow
+   *
+   * @generated from enum value: LINK_DIRECTION_TARGET = 2;
+   */
+  TARGET = 2,
+}
+
+/**
+ * Describes the enum kusinta.iot.link.v1.LinkDirection.
+ */
+export declare const LinkDirectionSchema: GenEnum<LinkDirection>;
+
+/**
+ * How a link is carried.
+ *
+ * @generated from enum kusinta.iot.link.v1.LinkMode
+ */
+export enum LinkMode {
+  /**
+   * @generated from enum value: LINK_MODE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * Device to device, brokered by the hub and then carried without it. Survives
+   * a gateway outage. Requires both devices on the same hub, and the hub's own
+   * support for the function.
+   *
+   * @generated from enum value: LINK_MODE_HARD = 1;
+   */
+  HARD = 1,
+
+  /**
+   * Kept by the gateway, which reads one device and writes the other. Works
+   * across vendors and across hubs, and is the only option where no hub can
+   * broker the pair — at the cost of not surviving a gateway outage.
+   *
+   * @generated from enum value: LINK_MODE_SOFT = 2;
+   */
+  SOFT = 2,
+}
+
+/**
+ * Describes the enum kusinta.iot.link.v1.LinkMode.
+ */
+export declare const LinkModeSchema: GenEnum<LinkMode>;
+
+/**
+ * Whether a link is doing anything.
+ *
+ * There is deliberately no "created but not yet in effect" state. On current
+ * device firmware a link takes effect immediately, and on firmware old enough not
+ * to, it never takes effect at all without physical intervention — which is a
+ * refusal at creation time, not a state to wait in.
+ *
+ * Nor should ACTIVE be inferred from the hub reporting a link exists. A hub can
+ * report a link as present, unpending and healthy while the devices ignore it
+ * entirely; only behaviour distinguishes the two.
+ *
+ * @generated from enum kusinta.iot.link.v1.LinkState
+ */
+export enum LinkState {
+  /**
+   * @generated from enum value: LINK_STATE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * carrying
+   *
+   * @generated from enum value: LINK_STATE_ACTIVE = 1;
+   */
+  ACTIVE = 1,
+
+  /**
+   * the sender is unreachable, gone, or the set is incomplete
+   *
+   * @generated from enum value: LINK_STATE_BROKEN = 2;
+   */
+  BROKEN = 2,
+
+  /**
+   * the hub and our records disagree, or the hub cannot say
+   *
+   * @generated from enum value: LINK_STATE_UNKNOWN = 3;
+   */
+  UNKNOWN = 3,
+}
+
+/**
+ * Describes the enum kusinta.iot.link.v1.LinkState.
+ */
+export declare const LinkStateSchema: GenEnum<LinkState>;
+

package/src/kusinta/iot/link/v1/link_pb.js

@@ -0,0 +1,121 @@
+// @generated by protoc-gen-es v2.12.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file kusinta/iot/link/v1/link.proto (package kusinta.iot.link.v1, syntax proto3)
+/* eslint-disable */
+
+import { enumDesc, fileDesc, messageDesc, tsEnum } from "@bufbuild/protobuf/codegenv2";
+import { file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
+import { file_kusinta_iot_access_v1_acl } from "../../access/v1/acl_pb.js";
+import { file_kusinta_iot_identity_v1_identity } from "../../identity/v1/identity_pb.js";
+
+/**
+ * Describes the file kusinta/iot/link/v1/link.proto.
+ */
+export const file_kusinta_iot_link_v1_link = /*@__PURE__*/
+  fileDesc("Ch5rdXNpbnRhL2lvdC9saW5rL3YxL2xpbmsucHJvdG8SE2t1c2ludGEuaW90LmxpbmsudjEiYAoMTGlua1NldHRpbmdzEkAKDGNsaW1hdGVfbGVhZBgBIAEoCzIoLmt1c2ludGEuaW90LmxpbmsudjEuQ2xpbWF0ZUxlYWRTZXR0aW5nc0gAQg4KDHBlcl9mdW5jdGlvbiJHChNDbGltYXRlTGVhZFNldHRpbmdzEhwKD3RhcmdldF9zZXRwb2ludBgBIAEoEUgAiAEBQhIKEF90YXJnZXRfc2V0cG9pbnQilwMKCkRldmljZUxpbmsSDwoHbGlua19pZBgBIAEoCRIxCgZzZW5kZXIYAiABKAsyIS5rdXNpbnRhLmlvdC5pZGVudGl0eS52MS5EZXZpY2VJZBIzCghyZWNlaXZlchgDIAEoCzIhLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLkRldmljZUlkEjMKCGZ1bmN0aW9uGAQgASgOMiEua3VzaW50YS5pb3QubGluay52MS5MaW5rRnVuY3Rpb24SKwoEbW9kZRgFIAEoDjIdLmt1c2ludGEuaW90LmxpbmsudjEuTGlua01vZGUSLQoFc3RhdGUYBiABKA4yHi5rdXNpbnRhLmlvdC5saW5rLnYxLkxpbmtTdGF0ZRIuCgpjcmVhdGVkX2F0GAcgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBIUCgxzdGF0ZV9kZXRhaWwYCCABKAkSMwoIc2V0dGluZ3MYCSABKAsyIS5rdXNpbnRhLmlvdC5saW5rLnYxLkxpbmtTZXR0aW5nc0oECBQQHiL7AQoOTGlua0NhcGFiaWxpdHkSMwoIZnVuY3Rpb24YASABKA4yIS5rdXNpbnRhLmlvdC5saW5rLnYxLkxpbmtGdW5jdGlvbhI1CglkaXJlY3Rpb24YAiABKA4yIi5rdXNpbnRhLmlvdC5saW5rLnYxLkxpbmtEaXJlY3Rpb24SNgoPc3VwcG9ydGVkX21vZGVzGAMgAygOMh0ua3VzaW50YS5pb3QubGluay52MS5MaW5rTW9kZRI2CglhdHRyaWJ1dGUYBCABKAsyIy5rdXNpbnRhLmlvdC5hY2Nlc3MudjEuQXR0cmlidXRlUmVmEg0KBWxhYmVsGAUgASgJIkAKDkRldmljZUxpbmtMaXN0Ei4KBWxpbmtzGAEgAygLMh8ua3VzaW50YS5pb3QubGluay52MS5EZXZpY2VMaW5rKo8BCgxMaW5rRnVuY3Rpb24SHQoZTElOS19GVU5DVElPTl9VTlNQRUNJRklFRBAAEh4KGkxJTktfRlVOQ1RJT05fQ0xJTUFURV9MRUFEEAESHgoaTElOS19GVU5DVElPTl9XSU5ET1dfU1RBVEUQAhIgChxMSU5LX0ZVTkNUSU9OX1JFTU9URV9DT05UUk9MEAMqZQoNTGlua0RpcmVjdGlvbhIeChpMSU5LX0RJUkVDVElPTl9VTlNQRUNJRklFRBAAEhkKFUxJTktfRElSRUNUSU9OX1NPVVJDRRABEhkKFUxJTktfRElSRUNUSU9OX1RBUkdFVBACKk0KCExpbmtNb2RlEhkKFUxJTktfTU9ERV9VTlNQRUNJRklFRBAAEhIKDkxJTktfTU9ERV9IQVJEEAESEgoOTElOS19NT0RFX1NPRlQQAiptCglMaW5rU3RhdGUSGgoWTElOS19TVEFURV9VTlNQRUNJRklFRBAAEhUKEUxJTktfU1RBVEVfQUNUSVZFEAESFQoRTElOS19TVEFURV9CUk9LRU4QAhIWChJMSU5LX1NUQVRFX1VOS05PV04QA0ICSAFiBnByb3RvMw", [file_google_protobuf_timestamp, file_kusinta_iot_access_v1_acl, file_kusinta_iot_identity_v1_identity]);
+
+/**
+ * Describes the message kusinta.iot.link.v1.LinkSettings.
+ * Use `create(LinkSettingsSchema)` to create a new message.
+ */
+export const LinkSettingsSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_link_v1_link, 0);
+
+/**
+ * Describes the message kusinta.iot.link.v1.ClimateLeadSettings.
+ * Use `create(ClimateLeadSettingsSchema)` to create a new message.
+ */
+export const ClimateLeadSettingsSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_link_v1_link, 1);
+
+/**
+ * Describes the message kusinta.iot.link.v1.DeviceLink.
+ * Use `create(DeviceLinkSchema)` to create a new message.
+ */
+export const DeviceLinkSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_link_v1_link, 2);
+
+/**
+ * Describes the message kusinta.iot.link.v1.LinkCapability.
+ * Use `create(LinkCapabilitySchema)` to create a new message.
+ */
+export const LinkCapabilitySchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_link_v1_link, 3);
+
+/**
+ * Describes the message kusinta.iot.link.v1.DeviceLinkList.
+ * Use `create(DeviceLinkListSchema)` to create a new message.
+ */
+export const DeviceLinkListSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_link_v1_link, 4);
+
+/**
+ * Describes the enum kusinta.iot.link.v1.LinkFunction.
+ */
+export const LinkFunctionSchema = /*@__PURE__*/
+  enumDesc(file_kusinta_iot_link_v1_link, 0);
+
+/**
+ * What a link makes the sender do to the receiver.
+ *
+ * A function, not a cluster id, because the two ends do not necessarily speak the
+ * same cluster: a wall thermostat reports its temperature as Thermostat
+ * LocalTemperature while a bare sensor reports the same quantity as Temperature
+ * Measurement MeasuredValue. Each end states its own attribute in its
+ * LinkCapability; the function is what says the two belong together.
+ *
+ * @generated from enum kusinta.iot.link.v1.LinkFunction
+ */
+export const LinkFunction = /*@__PURE__*/
+  tsEnum(LinkFunctionSchema);
+
+/**
+ * Describes the enum kusinta.iot.link.v1.LinkDirection.
+ */
+export const LinkDirectionSchema = /*@__PURE__*/
+  enumDesc(file_kusinta_iot_link_v1_link, 1);
+
+/**
+ * Which end of a link a device can be.
+ *
+ * @generated from enum kusinta.iot.link.v1.LinkDirection
+ */
+export const LinkDirection = /*@__PURE__*/
+  tsEnum(LinkDirectionSchema);
+
+/**
+ * Describes the enum kusinta.iot.link.v1.LinkMode.
+ */
+export const LinkModeSchema = /*@__PURE__*/
+  enumDesc(file_kusinta_iot_link_v1_link, 2);
+
+/**
+ * How a link is carried.
+ *
+ * @generated from enum kusinta.iot.link.v1.LinkMode
+ */
+export const LinkMode = /*@__PURE__*/
+  tsEnum(LinkModeSchema);
+
+/**
+ * Describes the enum kusinta.iot.link.v1.LinkState.
+ */
+export const LinkStateSchema = /*@__PURE__*/
+  enumDesc(file_kusinta_iot_link_v1_link, 3);
+
+/**
+ * Whether a link is doing anything.
+ *
+ * There is deliberately no "created but not yet in effect" state. On current
+ * device firmware a link takes effect immediately, and on firmware old enough not
+ * to, it never takes effect at all without physical intervention — which is a
+ * refusal at creation time, not a state to wait in.
+ *
+ * Nor should ACTIVE be inferred from the hub reporting a link exists. A hub can
+ * report a link as present, unpending and healthy while the devices ignore it
+ * entirely; only behaviour distinguishes the two.
+ *
+ * @generated from enum kusinta.iot.link.v1.LinkState
+ */
+export const LinkState = /*@__PURE__*/
+  tsEnum(LinkStateSchema);
+