@kusinta/iot-schema 0.2.0-beta.5 → 0.2.0-beta.51

package/src/kusinta/iot/heating/v1/heating_pb.d.ts

@@ -0,0 +1,656 @@
+// @generated by protoc-gen-es v2.12.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file kusinta/iot/heating/v1/heating.proto (package kusinta.iot.heating.v1, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { DeviceId, SpaceId, UserId } from "../../identity/v1/identity_pb.js";
+import type { AttributeRef } from "../../access/v1/acl_pb.js";
+import type { AttributeValue } from "../../device/v1/cluster_state_pb.js";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+
+/**
+ * Describes the file kusinta/iot/heating/v1/heating.proto.
+ */
+export declare const file_kusinta_iot_heating_v1_heating: GenFile;
+
+/**
+ * One attribute of one device: what a role reads or writes. Endpoint_id is required on the
+ * Matter branch of the attribute here — an absent endpoint is refused, never read as the
+ * root node.
+ *
+ * @generated from message kusinta.iot.heating.v1.DeviceAttribute
+ */
+export declare type DeviceAttribute = Message<"kusinta.iot.heating.v1.DeviceAttribute"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.DeviceId device_id = 1;
+   */
+  deviceId?: DeviceId | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.access.v1.AttributeRef attribute = 2;
+   */
+  attribute?: AttributeRef | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.heating.v1.DeviceAttribute.
+ * Use `create(DeviceAttributeSchema)` to create a new message.
+ */
+export declare const DeviceAttributeSchema: GenMessage<DeviceAttribute>;
+
+/**
+ * One device output switching one contact on the heating side: a floor zone's thermostat
+ * input, a heat-source input, a comfort load's supply.
+ *
+ * @generated from message kusinta.iot.heating.v1.ContactBinding
+ */
+export declare type ContactBinding = Message<"kusinta.iot.heating.v1.ContactBinding"> & {
+  /**
+   * OnOff on a relay channel, or a vendor parameter.
+   *
+   * @generated from field: kusinta.iot.heating.v1.DeviceAttribute output = 1;
+   */
+  output?: DeviceAttribute | undefined;
+
+  /**
+   * The value of the output with which the contact is closed. A wiring fact, not a device
+   * fact: a changeover relay wired through its normally closed contact closes it with the
+   * channel off, so OnOff false. The producer cannot know it; whoever wires the relay
+   * states it, and the gateway reads every state of the role through it — never from the
+   * output's value alone.
+   *
+   * Each role has a fixed rest state (see the role), and the output's lapse value
+   * (device.v1.LeasedWrite.lapse_value), read through this value, must leave the contact
+   * where the role rests. Every comparison with this value matches type as well as value:
+   * an int 0 is not a bool false.
+   *
+   * @generated from field: kusinta.iot.device.v1.AttributeValue closed_value = 2;
+   */
+  closedValue?: AttributeValue | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.heating.v1.ContactBinding.
+ * Use `create(ContactBindingSchema)` to create a new message.
+ */
+export declare const ContactBindingSchema: GenMessage<ContactBinding>;
+
+/**
+ * One heat source.
+ *
+ * @generated from message kusinta.iot.heating.v1.HeatingPlant
+ */
+export declare type HeatingPlant = Message<"kusinta.iot.heating.v1.HeatingPlant"> & {
+  /**
+   * Assigned by the gateway, unique among heating records; empty when creating.
+   *
+   * @generated from field: string plant_id = 1;
+   */
+  plantId: string;
+
+  /**
+   * The space the plant serves: a home, or a space outside homes for a central plant.
+   *
+   * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 2;
+   */
+  spaceId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: string name = 3;
+   */
+  name: string;
+
+  /**
+   * @generated from field: kusinta.iot.heating.v1.HeatSourceKind source = 4;
+   */
+  source: HeatSourceKind;
+
+  /**
+   * The device the heat source's own readings come from — its temperatures, compressor and
+   * hot-water state — when it has one; its temperatures are the device's
+   * device.v1.HeatSourceReadings. Read only: the gateway drives a heat source through the
+   * plant's control, never through this device.
+   *
+   * @generated from field: kusinta.iot.identity.v1.DeviceId readings_device_id = 5;
+   */
+  readingsDeviceId?: DeviceId | undefined;
+
+  /**
+   * How the gateway steers the heat source. Unset: it does not; the plant is read only. A
+   * control set binds at least one input.
+   *
+   * @generated from oneof kusinta.iot.heating.v1.HeatingPlant.control
+   */
+  control: {
+    /**
+     * @generated from field: kusinta.iot.heating.v1.HeatPumpControl heat_pump = 6;
+     */
+    value: HeatPumpControl;
+    case: "heatPump";
+  } | { case: undefined; value?: undefined };
+
+  /**
+   * The electricity or heat meter the plant is measured by.
+   *
+   * @generated from field: kusinta.iot.heating.v1.DeviceAttribute meter = 7;
+   */
+  meter?: DeviceAttribute | undefined;
+
+  /**
+   * See the file comment.
+   *
+   * @generated from field: uint64 revision = 8;
+   */
+  revision: bigint;
+};
+
+/**
+ * Describes the message kusinta.iot.heating.v1.HeatingPlant.
+ * Use `create(HeatingPlantSchema)` to create a new message.
+ */
+export declare const HeatingPlantSchema: GenMessage<HeatingPlant>;
+
+/**
+ * A heat pump's control inputs.
+ *
+ * @generated from message kusinta.iot.heating.v1.HeatPumpControl
+ */
+export declare type HeatPumpControl = Message<"kusinta.iot.heating.v1.HeatPumpControl"> & {
+  /**
+   * The SG Ready inputs, by what each means closed alone: sg_ready_block closed alone
+   * blocks the heat pump, sg_ready_boost closed alone recommends running harder, both
+   * closed commands it to, and both open is normal operation. Both rest open, so a lapsed
+   * lease or a stopped gateway leaves the heat pump running normally. Bound together or not
+   * at all.
+   *
+   * They lapse separately, so their leases are ordered: while both are closed, the gateway
+   * gives sg_ready_block no longer a lease than sg_ready_boost, so the heat pump never passes
+   * through "blocked" on its way back to normal. In general, of two bound inputs, the one
+   * whose half-state blocks heat never lapses last.
+   *
+   * @generated from field: kusinta.iot.heating.v1.ContactBinding sg_ready_block = 1;
+   */
+  sgReadyBlock?: ContactBinding | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.heating.v1.ContactBinding sg_ready_boost = 2;
+   */
+  sgReadyBoost?: ContactBinding | undefined;
+
+  /**
+   * The input that blocks the heat pump's add-on (electric) heater while closed. Rests
+   * open: the add-on heater is allowed.
+   *
+   * @generated from field: kusinta.iot.heating.v1.ContactBinding add_on_heater_block = 3;
+   */
+  addOnHeaterBlock?: ContactBinding | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.heating.v1.HeatPumpControl.
+ * Use `create(HeatPumpControlSchema)` to create a new message.
+ */
+export declare const HeatPumpControlSchema: GenMessage<HeatPumpControl>;
+
+/**
+ * One heating circuit of a plant. Supply temperature and its cap are per circuit.
+ *
+ * @generated from message kusinta.iot.heating.v1.HeatingCircuit
+ */
+export declare type HeatingCircuit = Message<"kusinta.iot.heating.v1.HeatingCircuit"> & {
+  /**
+   * Assigned by the gateway, unique among heating records; empty when creating.
+   *
+   * @generated from field: string circuit_id = 1;
+   */
+  circuitId: string;
+
+  /**
+   * @generated from field: string plant_id = 2;
+   */
+  plantId: string;
+
+  /**
+   * @generated from field: string name = 3;
+   */
+  name: string;
+
+  /**
+   * @generated from oneof kusinta.iot.heating.v1.HeatingCircuit.distribution
+   */
+  distribution: {
+    /**
+     * @generated from field: kusinta.iot.heating.v1.RadiatorCircuit radiator = 4;
+     */
+    value: RadiatorCircuit;
+    case: "radiator";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.heating.v1.FloorCircuit floor = 5;
+     */
+    value: FloorCircuit;
+    case: "floor";
+  } | { case: undefined; value?: undefined };
+
+  /**
+   * See the file comment.
+   *
+   * @generated from field: uint64 revision = 6;
+   */
+  revision: bigint;
+};
+
+/**
+ * Describes the message kusinta.iot.heating.v1.HeatingCircuit.
+ * Use `create(HeatingCircuitSchema)` to create a new message.
+ */
+export declare const HeatingCircuitSchema: GenMessage<HeatingCircuit>;
+
+/**
+ * A radiator circuit. Its valves belong to the rooms (climate.v1.RoomClimate).
+ *
+ * @generated from message kusinta.iot.heating.v1.RadiatorCircuit
+ */
+export declare type RadiatorCircuit = Message<"kusinta.iot.heating.v1.RadiatorCircuit"> & {
+};
+
+/**
+ * Describes the message kusinta.iot.heating.v1.RadiatorCircuit.
+ * Use `create(RadiatorCircuitSchema)` to create a new message.
+ */
+export declare const RadiatorCircuitSchema: GenMessage<RadiatorCircuit>;
+
+/**
+ * Hydronic floor heating: its own pump, mixing and supply cap, and the floor zones on its
+ * manifold.
+ *
+ * @generated from message kusinta.iot.heating.v1.FloorCircuit
+ */
+export declare type FloorCircuit = Message<"kusinta.iot.heating.v1.FloorCircuit"> & {
+  /**
+   * Whether a mixing valve feeds the circuit.
+   *
+   * @generated from field: bool mixing_valve = 1;
+   */
+  mixingValve: boolean;
+
+  /**
+   * The supply temperature its self-acting limiter caps it at, in centidegrees. Absent: not
+   * known, never 0 °C.
+   *
+   * @generated from field: optional sint32 supply_cap_centidegrees = 2;
+   */
+  supplyCapCentidegrees?: number | undefined;
+
+  /**
+   * Probes on the supply (after mixing) and the return.
+   *
+   * @generated from field: kusinta.iot.heating.v1.DeviceAttribute supply_probe = 3;
+   */
+  supplyProbe?: DeviceAttribute | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.heating.v1.DeviceAttribute return_probe = 4;
+   */
+  returnProbe?: DeviceAttribute | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.heating.v1.FloorCircuit.
+ * Use `create(FloorCircuitSchema)` to create a new message.
+ */
+export declare const FloorCircuitSchema: GenMessage<FloorCircuit>;
+
+/**
+ * One loop or group of loops on a floor circuit's manifold, switched by one output on its
+ * wiring centre's thermostat input. The output's contact closed means the zone heats, and it
+ * rests closed: when the gateway is gone the zone heats, capped only by the circuit's supply
+ * limiter.
+ *
+ * @generated from message kusinta.iot.heating.v1.FloorZone
+ */
+export declare type FloorZone = Message<"kusinta.iot.heating.v1.FloorZone"> & {
+  /**
+   * Assigned by the gateway, unique among heating records; empty when creating.
+   *
+   * @generated from field: string zone_id = 1;
+   */
+  zoneId: string;
+
+  /**
+   * A FLOOR circuit.
+   *
+   * @generated from field: string circuit_id = 2;
+   */
+  circuitId: string;
+
+  /**
+   * As marked on the manifold or the drawing ("SL 2").
+   *
+   * @generated from field: string name = 3;
+   */
+  name: string;
+
+  /**
+   * @generated from field: kusinta.iot.heating.v1.ContactBinding output = 4;
+   */
+  output?: ContactBinding | undefined;
+
+  /**
+   * The rooms the zone heats, each a room within its plant's space, listed once, with a
+   * share above 0 and shares summing to 1000. A zone may heat several rooms and a room may
+   * be heated by several zones. A put names at least one; empty only for a zone whose rooms
+   * were all deleted, which is uncontrolled (see the file comment, UNCONTROLLED ZONES).
+   *
+   * @generated from field: repeated kusinta.iot.heating.v1.FloorZoneRoom rooms = 5;
+   */
+  rooms: FloorZoneRoom[];
+
+  /**
+   * One of rooms. Only its error, its sensor and its open window steer the zone. A put names
+   * one; unset only once a deletion cleared it, and always while rooms is empty. A zone
+   * without one is uncontrolled (see the file comment, UNCONTROLLED ZONES).
+   *
+   * @generated from field: kusinta.iot.identity.v1.SpaceId control_room_id = 6;
+   */
+  controlRoomId?: SpaceId | undefined;
+
+  /**
+   * See the file comment.
+   *
+   * @generated from field: uint64 revision = 7;
+   */
+  revision: bigint;
+
+  /**
+   * While the zone is uncontrolled — no room, or no control room (see the file comment,
+   * UNCONTROLLED ZONES): since when it has been so, and the user whose change left it so — the
+   * deletion of its control room or its last room; uncontrolled_by is unset where no user's
+   * change did. Both unset while the zone is controlled. Read-only: set by the gateway, ignored
+   * in a put. A put that names a control room among its rooms ends it.
+   *
+   * uncontrolled_by is erased at the home's wipe with the record of who did what in the home
+   * (webrtc.v1 household.proto, WIPE); uncontrolled_since stays with the zone, which describes
+   * the house.
+   *
+   * For a home's zone — one left uncontrolled stays whose it was — sent only to the home's
+   * household admins (access.v1.MEMBERSHIP_RELATION_HOUSEHOLD_ADMIN) and an installer under a
+   * commissioning grant on the home, and unset for the home's other residents; never sent to
+   * service. Unset, too, when it dates from before the recipient's current residency in the
+   * home, or from a home they did not live in at the time (see access.v1.MembershipRelation).
+   * While the home is empty (webrtc.v1 household.proto, EMPTY HOME), the property owner and the
+   * gateway administrators who reach it are sent uncontrolled_since, never uncontrolled_by (see
+   * the file comment).
+   * For a zone outside homes, sent to whoever is given the zone. That rooms is empty, or
+   * control_room_id unset, is what says the zone is uncontrolled; these say only since when
+   * and by whom, where the recipient is given them.
+   *
+   * @generated from field: google.protobuf.Timestamp uncontrolled_since = 8;
+   */
+  uncontrolledSince?: Timestamp | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.identity.v1.UserId uncontrolled_by = 9;
+   */
+  uncontrolledBy?: UserId | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.heating.v1.FloorZone.
+ * Use `create(FloorZoneSchema)` to create a new message.
+ */
+export declare const FloorZoneSchema: GenMessage<FloorZone>;
+
+/**
+ * @generated from message kusinta.iot.heating.v1.FloorZoneRoom
+ */
+export declare type FloorZoneRoom = Message<"kusinta.iot.heating.v1.FloorZoneRoom"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId room_id = 1;
+   */
+  roomId?: SpaceId | undefined;
+
+  /**
+   * This room's share of the zone's loop area, in thousandths.
+   *
+   * @generated from field: uint32 area_share_permille = 2;
+   */
+  areaSharePermille: number;
+};
+
+/**
+ * Describes the message kusinta.iot.heating.v1.FloorZoneRoom.
+ * Use `create(FloorZoneRoomSchema)` to create a new message.
+ */
+export declare const FloorZoneRoomSchema: GenMessage<FloorZoneRoom>;
+
+/**
+ * An electric load kept warm for comfort rather than heating a room to a target — a heated
+ * bathroom floor, a towel heater — run inside its time windows. Its output's contact closed
+ * means the load may heat under its own thermostat, and it rests closed: when the gateway is
+ * gone the load works as it did before.
+ *
+ * @generated from message kusinta.iot.heating.v1.ComfortLoad
+ */
+export declare type ComfortLoad = Message<"kusinta.iot.heating.v1.ComfortLoad"> & {
+  /**
+   * Assigned by the gateway, unique among heating records; empty when creating.
+   *
+   * @generated from field: string comfort_load_id = 1;
+   */
+  comfortLoadId: string;
+
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId room_id = 2;
+   */
+  roomId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: string name = 3;
+   */
+  name: string;
+
+  /**
+   * @generated from field: kusinta.iot.heating.v1.ContactBinding output = 4;
+   */
+  output?: ContactBinding | undefined;
+
+  /**
+   * When the load may heat: the union of its windows, at most 16. Empty: only when the
+   * plan allows it for price. Set with SetComfortWindows, never in a put, which keeps them.
+   * While the building's time zone is not known (space.v1.Space.time_zone unset) no window
+   * applies and the load is left at rest, heating under its own thermostat.
+   *
+   * @generated from field: repeated kusinta.iot.heating.v1.ComfortWindow windows = 5;
+   */
+  windows: ComfortWindow[];
+
+  /**
+   * See the file comment.
+   *
+   * @generated from field: uint64 revision = 6;
+   */
+  revision: bigint;
+
+  /**
+   * Set by the gateway and bumped by every SetComfortWindows; see SetComfortWindows.
+   *
+   * @generated from field: uint64 windows_revision = 7;
+   */
+  windowsRevision: bigint;
+
+  /**
+   * Set when windows is left out for the recipient — an installer under a commissioning
+   * grant — so that an empty list is not read as "only when the plan allows it for price".
+   *
+   * @generated from field: bool windows_withheld = 8;
+   */
+  windowsWithheld: boolean;
+};
+
+/**
+ * Describes the message kusinta.iot.heating.v1.ComfortLoad.
+ * Use `create(ComfortLoadSchema)` to create a new message.
+ */
+export declare const ComfortLoadSchema: GenMessage<ComfortLoad>;
+
+/**
+ * A recurring stretch of the building's local day (space.v1.Space.time_zone).
+ *
+ * @generated from message kusinta.iot.heating.v1.ComfortWindow
+ */
+export declare type ComfortWindow = Message<"kusinta.iot.heating.v1.ComfortWindow"> & {
+  /**
+   * The days it starts on: bit 0 Monday through bit 6 Sunday, at least one, no higher bit.
+   * Not Matter's day bitmap, which starts on Sunday.
+   *
+   * @generated from field: uint32 weekdays = 1;
+   */
+  weekdays: number;
+
+  /**
+   * Minutes after local midnight: start 0–1439, end 1–1440 and exclusive, never equal, so 0
+   * to 1440 is a whole day. A window whose end is before its start runs past midnight into
+   * the next day.
+   *
+   * On a day that changes to or from daylight saving, minutes are local wall-clock time: a
+   * start or end in the skipped hour falls at the first minute after it, and a repeated
+   * hour counts once, at its first occurrence.
+   *
+   * @generated from field: uint32 start_minute = 2;
+   */
+  startMinute: number;
+
+  /**
+   * @generated from field: uint32 end_minute = 3;
+   */
+  endMinute: number;
+};
+
+/**
+ * Describes the message kusinta.iot.heating.v1.ComfortWindow.
+ * Use `create(ComfortWindowSchema)` to create a new message.
+ */
+export declare const ComfortWindowSchema: GenMessage<ComfortWindow>;
+
+/**
+ * The heating records a caller may see under a space, in reply to ListHeating.
+ *
+ * @generated from message kusinta.iot.heating.v1.HeatingLayout
+ */
+export declare type HeatingLayout = Message<"kusinta.iot.heating.v1.HeatingLayout"> & {
+  /**
+   * @generated from field: repeated kusinta.iot.heating.v1.HeatingPlant plants = 1;
+   */
+  plants: HeatingPlant[];
+
+  /**
+   * @generated from field: repeated kusinta.iot.heating.v1.HeatingCircuit circuits = 2;
+   */
+  circuits: HeatingCircuit[];
+
+  /**
+   * @generated from field: repeated kusinta.iot.heating.v1.FloorZone floor_zones = 3;
+   */
+  floorZones: FloorZone[];
+
+  /**
+   * @generated from field: repeated kusinta.iot.heating.v1.ComfortLoad comfort_loads = 4;
+   */
+  comfortLoads: ComfortLoad[];
+};
+
+/**
+ * Describes the message kusinta.iot.heating.v1.HeatingLayout.
+ * Use `create(HeatingLayoutSchema)` to create a new message.
+ */
+export declare const HeatingLayoutSchema: GenMessage<HeatingLayout>;
+
+/**
+ * One heating record as stored, in reply to a put.
+ *
+ * @generated from message kusinta.iot.heating.v1.HeatingRecord
+ */
+export declare type HeatingRecord = Message<"kusinta.iot.heating.v1.HeatingRecord"> & {
+  /**
+   * @generated from oneof kusinta.iot.heating.v1.HeatingRecord.record
+   */
+  record: {
+    /**
+     * @generated from field: kusinta.iot.heating.v1.HeatingPlant plant = 1;
+     */
+    value: HeatingPlant;
+    case: "plant";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.heating.v1.HeatingCircuit circuit = 2;
+     */
+    value: HeatingCircuit;
+    case: "circuit";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.heating.v1.FloorZone floor_zone = 3;
+     */
+    value: FloorZone;
+    case: "floorZone";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.heating.v1.ComfortLoad comfort_load = 4;
+     */
+    value: ComfortLoad;
+    case: "comfortLoad";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message kusinta.iot.heating.v1.HeatingRecord.
+ * Use `create(HeatingRecordSchema)` to create a new message.
+ */
+export declare const HeatingRecordSchema: GenMessage<HeatingRecord>;
+
+/**
+ * @generated from enum kusinta.iot.heating.v1.HeatSourceKind
+ */
+export enum HeatSourceKind {
+  /**
+   * @generated from enum value: HEAT_SOURCE_KIND_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * @generated from enum value: HEAT_SOURCE_KIND_EXHAUST_AIR_HEAT_PUMP = 1;
+   */
+  EXHAUST_AIR_HEAT_PUMP = 1,
+
+  /**
+   * @generated from enum value: HEAT_SOURCE_KIND_GROUND_SOURCE_HEAT_PUMP = 2;
+   */
+  GROUND_SOURCE_HEAT_PUMP = 2,
+
+  /**
+   * @generated from enum value: HEAT_SOURCE_KIND_AIR_WATER_HEAT_PUMP = 3;
+   */
+  AIR_WATER_HEAT_PUMP = 3,
+
+  /**
+   * @generated from enum value: HEAT_SOURCE_KIND_DISTRICT_HEATING = 4;
+   */
+  DISTRICT_HEATING = 4,
+
+  /**
+   * @generated from enum value: HEAT_SOURCE_KIND_ELECTRIC_BOILER = 5;
+   */
+  ELECTRIC_BOILER = 5,
+
+  /**
+   * @generated from enum value: HEAT_SOURCE_KIND_FUEL_BOILER = 6;
+   */
+  FUEL_BOILER = 6,
+}
+
+/**
+ * Describes the enum kusinta.iot.heating.v1.HeatSourceKind.
+ */
+export declare const HeatSourceKindSchema: GenEnum<HeatSourceKind>;
+