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

package/src/kusinta/iot/commissioning/v1/commissioning_pb.d.ts

@@ -0,0 +1,1344 @@
+// @generated by protoc-gen-es v2.12.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file kusinta/iot/commissioning/v1/commissioning.proto (package kusinta.iot.commissioning.v1, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+import type { DeviceId, SpaceId, UserId } from "../../identity/v1/identity_pb.js";
+import type { AttributeValue } from "../../device/v1/cluster_state_pb.js";
+
+/**
+ * Describes the file kusinta/iot/commissioning/v1/commissioning.proto.
+ */
+export declare const file_kusinta_iot_commissioning_v1_commissioning: GenFile;
+
+/**
+ * Who answered, how and when. Set by the gateway from the caller, never taken from a put,
+ * save evidence.
+ *
+ * @generated from message kusinta.iot.commissioning.v1.Provenance
+ */
+export declare type Provenance = Message<"kusinta.iot.commissioning.v1.Provenance"> & {
+  /**
+   * @generated from field: kusinta.iot.commissioning.v1.Party party = 1;
+   */
+  party: Party;
+
+  /**
+   * @generated from field: kusinta.iot.commissioning.v1.Evidence evidence = 2;
+   */
+  evidence: Evidence;
+
+  /**
+   * @generated from field: google.protobuf.Timestamp at = 3;
+   */
+  at?: Timestamp | undefined;
+
+  /**
+   * Unset for AUTOMATIC, and after a household handover. On a home's facts and tests it is
+   * given to the home's residents, and to an installer only on what that installer put,
+   * started or concluded; to anyone else it is left unset, with party kept.
+   *
+   * @generated from field: kusinta.iot.identity.v1.UserId by = 4;
+   */
+  by?: UserId | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.Provenance.
+ * Use `create(ProvenanceSchema)` to create a new message.
+ */
+export declare const ProvenanceSchema: GenMessage<Provenance>;
+
+/**
+ * One heating record (heating.v1), or one binding of it. An output is always named by its
+ * proto field name as the heating record puts name it ("output", "sg_ready_block", ...),
+ * even a record's only one; an empty field is the record itself, never an output.
+ *
+ * @generated from message kusinta.iot.commissioning.v1.BindingRef
+ */
+export declare type BindingRef = Message<"kusinta.iot.commissioning.v1.BindingRef"> & {
+  /**
+   * @generated from field: string record_id = 1;
+   */
+  recordId: string;
+
+  /**
+   * @generated from field: string field = 2;
+   */
+  field: string;
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.BindingRef.
+ * Use `create(BindingRefSchema)` to create a new message.
+ */
+export declare const BindingRefSchema: GenMessage<BindingRef>;
+
+/**
+ * One version of a house template.
+ *
+ * @generated from message kusinta.iot.commissioning.v1.TemplateRef
+ */
+export declare type TemplateRef = Message<"kusinta.iot.commissioning.v1.TemplateRef"> & {
+  /**
+   * @generated from field: string template_id = 1;
+   */
+  templateId: string;
+
+  /**
+   * @generated from field: uint32 version = 2;
+   */
+  version: number;
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.TemplateRef.
+ * Use `create(TemplateRefSchema)` to create a new message.
+ */
+export declare const TemplateRefSchema: GenMessage<TemplateRef>;
+
+/**
+ * @generated from message kusinta.iot.commissioning.v1.CommissioningFact
+ */
+export declare type CommissioningFact = Message<"kusinta.iot.commissioning.v1.CommissioningFact"> & {
+  /**
+   * Assigned by the gateway, opaque; empty when creating.
+   *
+   * @generated from field: string fact_id = 1;
+   */
+  factId: string;
+
+  /**
+   * The space the fact is about: a building, a home or a room.
+   *
+   * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 2;
+   */
+  spaceId?: SpaceId | undefined;
+
+  /**
+   * A heating record within that space the fact is about. Empty: the space itself.
+   *
+   * @generated from field: string record_id = 3;
+   */
+  recordId: string;
+
+  /**
+   * @generated from field: string key = 4;
+   */
+  key: string;
+
+  /**
+   * @generated from oneof kusinta.iot.commissioning.v1.CommissioningFact.answer
+   */
+  answer: {
+    /**
+     * @generated from field: kusinta.iot.device.v1.AttributeValue value = 5;
+     */
+    value: AttributeValue;
+    case: "value";
+  } | {
+    /**
+     * "Don't know": an answer, which lists the fact as a need for the next party who can
+     * answer it. Only true is sent; false is refused.
+     *
+     * @generated from field: bool unknown = 6;
+     */
+    value: boolean;
+    case: "unknown";
+  } | { case: undefined; value?: undefined };
+
+  /**
+   * From the gateway's catalogue.
+   *
+   * @generated from field: kusinta.iot.commissioning.v1.Party answerer = 7;
+   */
+  answerer: Party;
+
+  /**
+   * @generated from field: kusinta.iot.commissioning.v1.Necessity necessity = 8;
+   */
+  necessity: Necessity;
+
+  /**
+   * For FOR_FEATURE.
+   *
+   * @generated from field: kusinta.iot.commissioning.v1.Feature feature = 9;
+   */
+  feature: Feature;
+
+  /**
+   * @generated from field: kusinta.iot.commissioning.v1.Provenance provenance = 10;
+   */
+  provenance?: Provenance | undefined;
+
+  /**
+   * Set by the gateway and bumped by every change; a put that replaces a fact, and a
+   * remove, names the revision it acts on.
+   *
+   * @generated from field: uint64 revision = 13;
+   */
+  revision: bigint;
+
+  /**
+   * Set: this answer departs from that version of a template, the home's when it was
+   * recorded.
+   *
+   * @generated from field: kusinta.iot.commissioning.v1.TemplateRef deviates_from = 15;
+   */
+  deviatesFrom?: TemplateRef | undefined;
+
+  /**
+   * From the gateway's catalogue.
+   *
+   * @generated from field: kusinta.iot.commissioning.v1.FactTopic topic = 16;
+   */
+  topic: FactTopic;
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.CommissioningFact.
+ * Use `create(CommissioningFactSchema)` to create a new message.
+ */
+export declare const CommissioningFactSchema: GenMessage<CommissioningFact>;
+
+/**
+ * One answer in a house template.
+ *
+ * @generated from message kusinta.iot.commissioning.v1.TemplateFact
+ */
+export declare type TemplateFact = Message<"kusinta.iot.commissioning.v1.TemplateFact"> & {
+  /**
+   * @generated from field: string key = 1;
+   */
+  key: string;
+
+  /**
+   * What it is about, as named on the drawing ("SL 2", "Bathroom"). Empty: the house.
+   *
+   * @generated from field: string subject_label = 2;
+   */
+  subjectLabel: string;
+
+  /**
+   * @generated from field: kusinta.iot.device.v1.AttributeValue value = 3;
+   */
+  value?: AttributeValue | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.TemplateFact.
+ * Use `create(TemplateFactSchema)` to create a new message.
+ */
+export declare const TemplateFactSchema: GenMessage<TemplateFact>;
+
+/**
+ * One house type of a building, as built. The owner organisation's.
+ *
+ * @generated from message kusinta.iot.commissioning.v1.HouseTemplate
+ */
+export declare type HouseTemplate = Message<"kusinta.iot.commissioning.v1.HouseTemplate"> & {
+  /**
+   * Assigned by the gateway, opaque; empty when creating.
+   *
+   * @generated from field: string template_id = 1;
+   */
+  templateId: string;
+
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId building_id = 2;
+   */
+  buildingId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: string name = 3;
+   */
+  name: string;
+
+  /**
+   * Set by the gateway and bumped by every put; a put that replaces a template names the
+   * version it replaces. A version once given is never given to other content.
+   *
+   * @generated from field: uint32 version = 4;
+   */
+  version: number;
+
+  /**
+   * @generated from field: repeated kusinta.iot.commissioning.v1.TemplateFact facts = 5;
+   */
+  facts: TemplateFact[];
+
+  /**
+   * Who put this version, set by the gateway; its evidence is DRAWING. provenance.by is
+   * given to the owner organisation only, and left unset for residents and installers.
+   *
+   * @generated from field: kusinta.iot.commissioning.v1.Provenance provenance = 6;
+   */
+  provenance?: Provenance | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.HouseTemplate.
+ * Use `create(HouseTemplateSchema)` to create a new message.
+ */
+export declare const HouseTemplateSchema: GenMessage<HouseTemplate>;
+
+/**
+ * A fact or a test a feature needs, and who can provide it.
+ *
+ * @generated from message kusinta.iot.commissioning.v1.Need
+ */
+export declare type Need = Message<"kusinta.iot.commissioning.v1.Need"> & {
+  /**
+   * @generated from oneof kusinta.iot.commissioning.v1.Need.what
+   */
+  what: {
+    /**
+     * @generated from field: string fact_key = 1;
+     */
+    value: string;
+    case: "factKey";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.commissioning.v1.TestKind test = 2;
+     */
+    value: TestKind;
+    case: "test";
+  } | { case: undefined; value?: undefined };
+
+  /**
+   * What it is needed about. For a fact, CommissioningFact.space_id and record_id, with
+   * binding.field empty; for a test, what it runs on, as CommissioningTest.binding.
+   *
+   * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 3;
+   */
+  spaceId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.commissioning.v1.Party answerer = 5;
+   */
+  answerer: Party;
+
+  /**
+   * @generated from field: kusinta.iot.commissioning.v1.BindingRef binding = 7;
+   */
+  binding?: BindingRef | undefined;
+
+  /**
+   * For a fact, its CommissioningFact.topic.
+   *
+   * @generated from field: kusinta.iot.commissioning.v1.FactTopic fact_topic = 8;
+   */
+  factTopic: FactTopic;
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.Need.
+ * Use `create(NeedSchema)` to create a new message.
+ */
+export declare const NeedSchema: GenMessage<Need>;
+
+/**
+ * @generated from message kusinta.iot.commissioning.v1.FeatureBlock
+ */
+export declare type FeatureBlock = Message<"kusinta.iot.commissioning.v1.FeatureBlock"> & {
+  /**
+   * @generated from field: kusinta.iot.commissioning.v1.BlockReason reason = 1;
+   */
+  reason: BlockReason;
+
+  /**
+   * The binding, and the device, it is blocked on.
+   *
+   * @generated from field: kusinta.iot.identity.v1.DeviceId device_id = 3;
+   */
+  deviceId?: DeviceId | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.commissioning.v1.BindingRef binding = 5;
+   */
+  binding?: BindingRef | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.FeatureBlock.
+ * Use `create(FeatureBlockSchema)` to create a new message.
+ */
+export declare const FeatureBlockSchema: GenMessage<FeatureBlock>;
+
+/**
+ * One feature of one home. WORKS when every heating record of the feature in the home may
+ * be driven and nothing it needs is missing.
+ *
+ * @generated from message kusinta.iot.commissioning.v1.FeatureStatus
+ */
+export declare type FeatureStatus = Message<"kusinta.iot.commissioning.v1.FeatureStatus"> & {
+  /**
+   * @generated from field: kusinta.iot.commissioning.v1.Feature feature = 1;
+   */
+  feature: Feature;
+
+  /**
+   * @generated from field: kusinta.iot.commissioning.v1.FeatureState state = 2;
+   */
+  state: FeatureState;
+
+  /**
+   * @generated from field: repeated kusinta.iot.commissioning.v1.Need needs = 3;
+   */
+  needs: Need[];
+
+  /**
+   * @generated from field: repeated kusinta.iot.commissioning.v1.FeatureBlock blocks = 4;
+   */
+  blocks: FeatureBlock[];
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.FeatureStatus.
+ * Use `create(FeatureStatusSchema)` to create a new message.
+ */
+export declare const FeatureStatusSchema: GenMessage<FeatureStatus>;
+
+/**
+ * @generated from message kusinta.iot.commissioning.v1.CommissioningTest
+ */
+export declare type CommissioningTest = Message<"kusinta.iot.commissioning.v1.CommissioningTest"> & {
+  /**
+   * Assigned by the gateway, opaque.
+   *
+   * @generated from field: string test_id = 1;
+   */
+  testId: string;
+
+  /**
+   * @generated from field: kusinta.iot.commissioning.v1.TestKind kind = 2;
+   */
+  kind: TestKind;
+
+  /**
+   * What it runs on: for OUTPUT_LEASE one binding; for ZONE_EFFECT and PUMP_ALL_ZONES_OFF
+   * the record, field empty.
+   *
+   * @generated from field: kusinta.iot.commissioning.v1.BindingRef binding = 13;
+   */
+  binding?: BindingRef | undefined;
+
+  /**
+   * The device it ran on. Set by the gateway.
+   *
+   * @generated from field: kusinta.iot.identity.v1.DeviceId device_id = 5;
+   */
+  deviceId?: DeviceId | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.commissioning.v1.TestState state = 6;
+   */
+  state: TestState;
+
+  /**
+   * FAILED only.
+   *
+   * @generated from field: kusinta.iot.commissioning.v1.TestFailure failure = 7;
+   */
+  failure: TestFailure;
+
+  /**
+   * @generated from field: google.protobuf.Timestamp started_at = 8;
+   */
+  startedAt?: Timestamp | undefined;
+
+  /**
+   * The latest it ends, while it runs.
+   *
+   * @generated from field: google.protobuf.Timestamp ends_at = 9;
+   */
+  endsAt?: Timestamp | undefined;
+
+  /**
+   * @generated from field: google.protobuf.Timestamp finished_at = 10;
+   */
+  finishedAt?: Timestamp | undefined;
+
+  /**
+   * Who started it; for an installer's verdict, who concluded it.
+   *
+   * @generated from field: kusinta.iot.commissioning.v1.Provenance provenance = 11;
+   */
+  provenance?: Provenance | undefined;
+
+  /**
+   * A pass that no longer holds; see the file comment.
+   *
+   * @generated from field: bool superseded = 12;
+   */
+  superseded: boolean;
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.CommissioningTest.
+ * Use `create(CommissioningTestSchema)` to create a new message.
+ */
+export declare const CommissioningTestSchema: GenMessage<CommissioningTest>;
+
+/**
+ * A space's commissioning, in reply to ListCommissioning.
+ *
+ * @generated from message kusinta.iot.commissioning.v1.CommissioningProfile
+ */
+export declare type CommissioningProfile = Message<"kusinta.iot.commissioning.v1.CommissioningProfile"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
+   */
+  spaceId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: repeated kusinta.iot.commissioning.v1.CommissioningFact facts = 2;
+   */
+  facts: CommissioningFact[];
+
+  /**
+   * The latest test of each kind on each binding.
+   *
+   * @generated from field: repeated kusinta.iot.commissioning.v1.CommissioningTest tests = 3;
+   */
+  tests: CommissioningTest[];
+
+  /**
+   * For a home, one per feature.
+   *
+   * @generated from field: repeated kusinta.iot.commissioning.v1.FeatureStatus features = 4;
+   */
+  features: FeatureStatus[];
+
+  /**
+   * The home's template, at its latest version. Unset: it follows none.
+   *
+   * @generated from field: kusinta.iot.commissioning.v1.HouseTemplate template = 6;
+   */
+  template?: HouseTemplate | undefined;
+
+  /**
+   * Set when FeatureStatus.needs are left out for this caller, so that none listed is not
+   * read as nothing missing.
+   *
+   * @generated from field: bool needs_withheld = 7;
+   */
+  needsWithheld: boolean;
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.CommissioningProfile.
+ * Use `create(CommissioningProfileSchema)` to create a new message.
+ */
+export declare const CommissioningProfileSchema: GenMessage<CommissioningProfile>;
+
+/**
+ * Whether a home is set up: every REQUIRED fact answered with a value at least once, and
+ * every output bound in it passed OUTPUT_LEASE at least once on the device it is bound to.
+ * "Don't know" is not an answer here. What the household does afterwards counts neither
+ * way: a REQUIRED fact once answered still counts when it is removed or changed to "don't
+ * know", as a pass superseded by a change of a floor zone's rooms or control room still
+ * does, so that set_up tells the owner organisation neither of a household's edits nor of
+ * a renovation. Binding a new output, or a new device, is what it can show. All the owner
+ * organisation learns of a home's commissioning.
+ *
+ * The REQUIRED keys are those this file marks REQUIRED (HOUSEHOLD QUESTIONS) and no other, so
+ * that set_up means the same on every gateway. A home with no room is not set up. Once a
+ * home has been set up, its facts count neither way, whatever changes since — a room
+ * created, an answer removed, a key a later release of this schema marks REQUIRED: only an
+ * output bound since without a pass on the device it is bound to makes it not set up. A
+ * household handover does not reset it: the home stays set up for the next household, so
+ * that set_up tells the owner organisation nothing of who moved in or out.
+ *
+ * @generated from message kusinta.iot.commissioning.v1.HomeSetup
+ */
+export declare type HomeSetup = Message<"kusinta.iot.commissioning.v1.HomeSetup"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId home_id = 1;
+   */
+  homeId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: bool set_up = 2;
+   */
+  setUp: boolean;
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.HomeSetup.
+ * Use `create(HomeSetupSchema)` to create a new message.
+ */
+export declare const HomeSetupSchema: GenMessage<HomeSetup>;
+
+/**
+ * In reply to ListHomeSetups.
+ *
+ * @generated from message kusinta.iot.commissioning.v1.HomeSetups
+ */
+export declare type HomeSetups = Message<"kusinta.iot.commissioning.v1.HomeSetups"> & {
+  /**
+   * @generated from field: repeated kusinta.iot.commissioning.v1.HomeSetup homes = 1;
+   */
+  homes: HomeSetup[];
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.HomeSetups.
+ * Use `create(HomeSetupsSchema)` to create a new message.
+ */
+export declare const HomeSetupsSchema: GenMessage<HomeSetups>;
+
+/**
+ * One commissioning record as stored, in reply to a put, a test's start or its conclusion.
+ *
+ * @generated from message kusinta.iot.commissioning.v1.CommissioningRecord
+ */
+export declare type CommissioningRecord = Message<"kusinta.iot.commissioning.v1.CommissioningRecord"> & {
+  /**
+   * @generated from oneof kusinta.iot.commissioning.v1.CommissioningRecord.record
+   */
+  record: {
+    /**
+     * @generated from field: kusinta.iot.commissioning.v1.CommissioningFact fact = 1;
+     */
+    value: CommissioningFact;
+    case: "fact";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.commissioning.v1.CommissioningTest test = 2;
+     */
+    value: CommissioningTest;
+    case: "test";
+  } | {
+    /**
+     * @generated from field: kusinta.iot.commissioning.v1.HouseTemplate template = 3;
+     */
+    value: HouseTemplate;
+    case: "template";
+  } | { case: undefined; value?: undefined };
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.CommissioningRecord.
+ * Use `create(CommissioningRecordSchema)` to create a new message.
+ */
+export declare const CommissioningRecordSchema: GenMessage<CommissioningRecord>;
+
+/**
+ * One installer's grant to commission one space (see the file comment, GRANTS).
+ *
+ * @generated from message kusinta.iot.commissioning.v1.CommissioningGrant
+ */
+export declare type CommissioningGrant = Message<"kusinta.iot.commissioning.v1.CommissioningGrant"> & {
+  /**
+   * Minted by the gateway, opaque.
+   *
+   * @generated from field: string grant_id = 1;
+   */
+  grantId: string;
+
+  /**
+   * A home's apartment, or a space outside homes.
+   *
+   * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 2;
+   */
+  spaceId?: SpaceId | undefined;
+
+  /**
+   * The installer who asked for it, and the name they gave their account
+   * (webrtc.v1.AppTokenClaims.name) as the gateway last learnt it, so the household knows
+   * whom it lets in; empty when none is learnt. Self-chosen, as webrtc.v1.MemberDetail.name
+   * is.
+   *
+   * @generated from field: kusinta.iot.identity.v1.UserId installer = 3;
+   */
+  installer?: UserId | undefined;
+
+  /**
+   * @generated from field: string installer_name = 4;
+   */
+  installerName: string;
+
+  /**
+   * @generated from field: kusinta.iot.commissioning.v1.CommissioningGrantState state = 5;
+   */
+  state: CommissioningGrantState;
+
+  /**
+   * @generated from field: google.protobuf.Timestamp requested_at = 6;
+   */
+  requestedAt?: Timestamp | undefined;
+
+  /**
+   * When a request lapses unanswered: 7 days after requested_at, as
+   * webrtc.v1.PromotionRequest.expires_at. REQUESTED only.
+   *
+   * @generated from field: google.protobuf.Timestamp expires_at = 7;
+   */
+  expiresAt?: Timestamp | undefined;
+
+  /**
+   * When it is active, as granted, within the bounds webrtc.v1.AnswerCommissioningGrant sets.
+   * GRANTED only.
+   *
+   * @generated from field: google.protobuf.Timestamp starts_at = 8;
+   */
+  startsAt?: Timestamp | undefined;
+
+  /**
+   * @generated from field: google.protobuf.Timestamp ends_at = 9;
+   */
+  endsAt?: Timestamp | undefined;
+
+  /**
+   * Who granted it, and when. GRANTED only. granted_by is given to the home's residents, and
+   * for a space outside homes or an empty home to the property owner and the gateway's
+   * administrators; to the installer it is unset, since a resident's user id would tell them
+   * who lives in the home.
+   *
+   * @generated from field: kusinta.iot.identity.v1.UserId granted_by = 10;
+   */
+  grantedBy?: UserId | undefined;
+
+  /**
+   * @generated from field: google.protobuf.Timestamp granted_at = 11;
+   */
+  grantedAt?: Timestamp | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.CommissioningGrant.
+ * Use `create(CommissioningGrantSchema)` to create a new message.
+ */
+export declare const CommissioningGrantSchema: GenMessage<CommissioningGrant>;
+
+/**
+ * The grants on one space that have not ended, as listed to one caller: the answer to
+ * webrtc.v1.ListCommissioningGrants, and pushed whole as webrtc.v1.GatewayMessage
+ * .commissioning_grants to every session that may list them whenever one is requested,
+ * answered or ended before its time — to the installer, their own grants alone. When who may
+ * list a home's grants changes — the home gaining a resident (webrtc.v1 household.proto,
+ * MOVE-IN), its last residency ending — they are pushed whole to the sessions that could list
+ * them before as well: empty, to one that may list none now, so that no session keeps showing a
+ * grant it no longer has or a request it can no longer answer. Nothing is pushed when a grant
+ * starts, ends or lapses at the time it states: a client reads those from starts_at, ends_at
+ * and expires_at.
+ *
+ * @generated from message kusinta.iot.commissioning.v1.CommissioningGrants
+ */
+export declare type CommissioningGrants = Message<"kusinta.iot.commissioning.v1.CommissioningGrants"> & {
+  /**
+   * The space the grants are on, on a push; unset on a listing.
+   *
+   * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
+   */
+  spaceId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: repeated kusinta.iot.commissioning.v1.CommissioningGrant grants = 2;
+   */
+  grants: CommissioningGrant[];
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.CommissioningGrants.
+ * Use `create(CommissioningGrantsSchema)` to create a new message.
+ */
+export declare const CommissioningGrantsSchema: GenMessage<CommissioningGrants>;
+
+/**
+ * A commissioning grant on a home that was granted, as its residents are told it afterwards
+ * (webrtc.v1.PrivacyDisclosure.commissioning_grants): who held commissioning access to their
+ * home, and when. The installer by the name they gave their account as the gateway last learnt
+ * it, never by user id; empty when none is learnt, and emptied once their account is deleted or
+ * removed from the gateway, when the record stays without it.
+ *
+ * @generated from message kusinta.iot.commissioning.v1.CommissioningGrantRecord
+ */
+export declare type CommissioningGrantRecord = Message<"kusinta.iot.commissioning.v1.CommissioningGrantRecord"> & {
+  /**
+   * @generated from field: string installer_name = 1;
+   */
+  installerName: string;
+
+  /**
+   * When it was granted, and the time it covered: from its start until it ended. ended_at is
+   * unset while it is active.
+   *
+   * @generated from field: google.protobuf.Timestamp granted_at = 2;
+   */
+  grantedAt?: Timestamp | undefined;
+
+  /**
+   * @generated from field: google.protobuf.Timestamp starts_at = 3;
+   */
+  startsAt?: Timestamp | undefined;
+
+  /**
+   * @generated from field: google.protobuf.Timestamp ended_at = 4;
+   */
+  endedAt?: Timestamp | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.commissioning.v1.CommissioningGrantRecord.
+ * Use `create(CommissioningGrantRecordSchema)` to create a new message.
+ */
+export declare const CommissioningGrantRecordSchema: GenMessage<CommissioningGrantRecord>;
+
+/**
+ * Who answers a fact, or ran or concluded a test.
+ *
+ * @generated from enum kusinta.iot.commissioning.v1.Party
+ */
+export enum Party {
+  /**
+   * @generated from enum value: PARTY_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * The property owner or the gateway's administrators.
+   *
+   * @generated from enum value: PARTY_OWNER_ORGANISATION = 1;
+   */
+  OWNER_ORGANISATION = 1,
+
+  /**
+   * A household admin of the home (access.v1.MEMBERSHIP_RELATION_HOUSEHOLD_ADMIN).
+   *
+   * @generated from enum value: PARTY_HOUSEHOLD = 2;
+   */
+  HOUSEHOLD = 2,
+
+  /**
+   * An installer under a commissioning grant (CommissioningGrant).
+   *
+   * @generated from enum value: PARTY_INSTALLER = 3;
+   */
+  INSTALLER = 3,
+
+  /**
+   * The gateway, from a device, a connector or a measurement of its own.
+   *
+   * @generated from enum value: PARTY_AUTOMATIC = 4;
+   */
+  AUTOMATIC = 4,
+}
+
+/**
+ * Describes the enum kusinta.iot.commissioning.v1.Party.
+ */
+export declare const PartySchema: GenEnum<Party>;
+
+/**
+ * How much a fact is needed.
+ *
+ * @generated from enum kusinta.iot.commissioning.v1.Necessity
+ */
+export enum Necessity {
+  /**
+   * @generated from enum value: NECESSITY_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * Before the home is set up (HomeSetup).
+   *
+   * @generated from enum value: NECESSITY_REQUIRED = 1;
+   */
+  REQUIRED = 1,
+
+  /**
+   * Before its feature works (CommissioningFact.feature).
+   *
+   * @generated from enum value: NECESSITY_FOR_FEATURE = 2;
+   */
+  FOR_FEATURE = 2,
+
+  /**
+   * @generated from enum value: NECESSITY_OPTIONAL = 3;
+   */
+  OPTIONAL = 3,
+}
+
+/**
+ * Describes the enum kusinta.iot.commissioning.v1.Necessity.
+ */
+export declare const NecessitySchema: GenEnum<Necessity>;
+
+/**
+ * How an answer was confirmed. A household answers STATED, PHOTO or DRAWING; INSPECTED and
+ * MEASURED are an installer's or the gateway's; DERIVED is the gateway's alone. A key may
+ * require more (see the file comment); less is refused.
+ *
+ * @generated from enum kusinta.iot.commissioning.v1.Evidence
+ */
+export enum Evidence {
+  /**
+   * @generated from enum value: EVIDENCE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * @generated from enum value: EVIDENCE_STATED = 1;
+   */
+  STATED = 1,
+
+  /**
+   * @generated from enum value: EVIDENCE_PHOTO = 2;
+   */
+  PHOTO = 2,
+
+  /**
+   * @generated from enum value: EVIDENCE_DRAWING = 3;
+   */
+  DRAWING = 3,
+
+  /**
+   * @generated from enum value: EVIDENCE_INSPECTED = 4;
+   */
+  INSPECTED = 4,
+
+  /**
+   * @generated from enum value: EVIDENCE_MEASURED = 5;
+   */
+  MEASURED = 5,
+
+  /**
+   * From other facts, the address or a connector's declaration.
+   *
+   * @generated from enum value: EVIDENCE_DERIVED = 6;
+   */
+  DERIVED = 6,
+}
+
+/**
+ * Describes the enum kusinta.iot.commissioning.v1.Evidence.
+ */
+export declare const EvidenceSchema: GenEnum<Evidence>;
+
+/**
+ * What a fact is about, for a client that does not know its key. Closed: a client words a
+ * topic it does not know as a detail about the space or record, from its answerer.
+ *
+ * @generated from enum kusinta.iot.commissioning.v1.FactTopic
+ */
+export enum FactTopic {
+  /**
+   * @generated from enum value: FACT_TOPIC_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * The building: type, house types, drawings, gateway site, service agreements, payer.
+   *
+   * @generated from enum value: FACT_TOPIC_BUILDING = 1;
+   */
+  BUILDING = 1,
+
+  /**
+   * Rooms, walls added or removed, how each room is heated, its thermostats.
+   *
+   * @generated from enum value: FACT_TOPIC_ROOMS = 2;
+   */
+  ROOMS = 2,
+
+  /**
+   * The heat source: heat pump, its inputs, vendor account, blocks.
+   *
+   * @generated from enum value: FACT_TOPIC_HEAT_SOURCE = 3;
+   */
+  HEAT_SOURCE = 3,
+
+  /**
+   * Floor heating: circuits, pump, mixing, supply cap, zones, actuators, probes.
+   *
+   * @generated from enum value: FACT_TOPIC_FLOOR_HEATING = 4;
+   */
+  FLOOR_HEATING = 4,
+
+  /**
+   * Electric comfort loads: bathroom floors, towel heaters, their thermostats.
+   *
+   * @generated from enum value: FACT_TOPIC_COMFORT_LOADS = 5;
+   */
+  COMFORT_LOADS = 5,
+
+  /**
+   * Electricity: grid subscription, operator, fuse size, meter and its port.
+   *
+   * @generated from enum value: FACT_TOPIC_ELECTRICITY = 6;
+   */
+  ELECTRICITY = 6,
+
+  /**
+   * District heating: utility and tariff.
+   *
+   * @generated from enum value: FACT_TOPIC_DISTRICT_HEATING = 7;
+   */
+  DISTRICT_HEATING = 7,
+
+  /**
+   * Radio coverage and the gateways that carry it.
+   *
+   * @generated from enum value: FACT_TOPIC_CONNECTIVITY = 8;
+   */
+  CONNECTIVITY = 8,
+
+  /**
+   * Comfort wishes and schedules. Residents only, never under a commissioning grant.
+   *
+   * @generated from enum value: FACT_TOPIC_COMFORT = 9;
+   */
+  COMFORT = 9,
+}
+
+/**
+ * Describes the enum kusinta.iot.commissioning.v1.FactTopic.
+ */
+export declare const FactTopicSchema: GenEnum<FactTopic>;
+
+/**
+ * The heating features a home's commissioning unlocks.
+ *
+ * @generated from enum kusinta.iot.commissioning.v1.Feature
+ */
+export enum Feature {
+  /**
+   * @generated from enum value: FEATURE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * @generated from enum value: FEATURE_FLOOR_ZONES = 1;
+   */
+  FLOOR_ZONES = 1,
+
+  /**
+   * Steering the heat source (heating.v1.HeatingPlant.control).
+   *
+   * @generated from enum value: FEATURE_PLANT = 2;
+   */
+  PLANT = 2,
+
+  /**
+   * @generated from enum value: FEATURE_COMFORT_LOADS = 3;
+   */
+  COMFORT_LOADS = 3,
+
+  /**
+   * Planning by electricity price and the home's grid tariff.
+   *
+   * @generated from enum value: FEATURE_COST = 4;
+   */
+  COST = 4,
+
+  /**
+   * Holding the home's load under a power peak, live.
+   *
+   * @generated from enum value: FEATURE_PEAK_GUARD = 5;
+   */
+  PEAK_GUARD = 5,
+
+  /**
+   * Planning by forecast, from the room models.
+   *
+   * @generated from enum value: FEATURE_PLANNING = 6;
+   */
+  PLANNING = 6,
+}
+
+/**
+ * Describes the enum kusinta.iot.commissioning.v1.Feature.
+ */
+export declare const FeatureSchema: GenEnum<Feature>;
+
+/**
+ * @generated from enum kusinta.iot.commissioning.v1.FeatureState
+ */
+export enum FeatureState {
+  /**
+   * A state this schema does not know: read as NEEDS.
+   *
+   * @generated from enum value: FEATURE_STATE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * @generated from enum value: FEATURE_STATE_WORKS = 1;
+   */
+  WORKS = 1,
+
+  /**
+   * Something it needs is missing (FeatureStatus.needs), and nothing blocks it.
+   *
+   * @generated from enum value: FEATURE_STATE_NEEDS = 2;
+   */
+  NEEDS = 2,
+
+  /**
+   * FeatureStatus.blocks says why. Takes precedence over NEEDS.
+   *
+   * @generated from enum value: FEATURE_STATE_BLOCKED_FOR_SAFETY = 3;
+   */
+  BLOCKED_FOR_SAFETY = 3,
+}
+
+/**
+ * Describes the enum kusinta.iot.commissioning.v1.FeatureState.
+ */
+export declare const FeatureStateSchema: GenEnum<FeatureState>;
+
+/**
+ * @generated from enum kusinta.iot.commissioning.v1.BlockReason
+ */
+export enum BlockReason {
+  /**
+   * @generated from enum value: BLOCK_REASON_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * Its latest test failed, and has not passed since.
+   *
+   * @generated from enum value: BLOCK_REASON_TEST_FAILED = 1;
+   */
+  TEST_FAILED = 1,
+
+  /**
+   * Its producer no longer states the output's write as leased with a lapse value at rest
+   * (heating.v1).
+   *
+   * @generated from enum value: BLOCK_REASON_OUTPUT_NOT_LEASED = 2;
+   */
+  OUTPUT_NOT_LEASED = 2,
+
+  /**
+   * Its producer now states a power-on value that would leave the contact away from rest,
+   * though a pass predates it. A test that finds this fails instead
+   * (TEST_FAILURE_POWER_ON_NOT_AT_REST), and blocks as TEST_FAILED.
+   *
+   * @generated from enum value: BLOCK_REASON_POWER_ON_NOT_AT_REST = 3;
+   */
+  POWER_ON_NOT_AT_REST = 3,
+
+  /**
+   * @generated from enum value: BLOCK_REASON_DEVICE_GONE = 4;
+   */
+  DEVICE_GONE = 4,
+
+  /**
+   * A floor zone whose control room is deleted or outside its plant's space.
+   *
+   * @generated from enum value: BLOCK_REASON_CONTROL_ROOM_GONE = 5;
+   */
+  CONTROL_ROOM_GONE = 5,
+
+  /**
+   * The output's shortest lease (device.v1.LeasedWrite.min_lease_seconds) is longer than
+   * the longest it may be held: "plant.max_block_minutes" for a blocking input, or the
+   * OUTPUT_LEASE test's 5 minutes.
+   *
+   * @generated from enum value: BLOCK_REASON_LEASE_TOO_LONG = 6;
+   */
+  LEASE_TOO_LONG = 6,
+
+  /**
+   * The device lies on the other side of a home's boundary from the record that binds or reads
+   * it: a binding stored before such crossings were refused or undone (heating.v1). Mostly
+   * transitional: a gateway removes such a binding once at start-up, before it first reads its
+   * records (webrtc.v1 management.proto, START-UP), so this is sent only by one that holds such
+   * a binding yet. Its output is held at rest and nothing reads it for the record meanwhile.
+   *
+   * @generated from enum value: BLOCK_REASON_DEVICE_ACROSS_HOME = 7;
+   */
+  DEVICE_ACROSS_HOME = 7,
+}
+
+/**
+ * Describes the enum kusinta.iot.commissioning.v1.BlockReason.
+ */
+export declare const BlockReasonSchema: GenEnum<BlockReason>;
+
+/**
+ * @generated from enum kusinta.iot.commissioning.v1.TestKind
+ */
+export enum TestKind {
+  /**
+   * @generated from enum value: TEST_KIND_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * On one bound output (heating.v1). The gateway checks that the output's power-on value,
+   * where its producer states one, leaves the contact at rest; writes the value that takes
+   * it away from rest under a lease of L = the greater of the producer's min_lease_seconds
+   * and 60 seconds, and sees the reported contact leave rest; renews the lease before it
+   * ends and sees the contact hold past the first lease's end; then lets it lapse and sees
+   * the contact return to rest. ends_at is the start plus 2 × L plus 5 minutes for the
+   * reports. Runs only on an output whose producer states its reads REAL_TIME and whose
+   * lease bounds admit an L of at most 5 minutes, so it ends within 15 minutes; any other
+   * is refused before it starts (RunCommissioningTest). Judged by the gateway.
+   *
+   * @generated from enum value: TEST_KIND_OUTPUT_LEASE = 1;
+   */
+  OUTPUT_LEASE = 1,
+
+  /**
+   * On one floor zone with a current OUTPUT_LEASE pass. The gateway switches the zone and
+   * sees its control room's temperature and the circuit's return probe answer. Judged by
+   * the gateway. Takes hours; the zone is kept within its rooms' comfort while it runs.
+   *
+   * @generated from enum value: TEST_KIND_ZONE_EFFECT = 2;
+   */
+  ZONE_EFFECT = 2,
+
+  /**
+   * On one floor circuit whose every zone holds a current OUTPUT_LEASE pass. The gateway
+   * holds every zone off for at most 15 minutes while the installer watches the pump, and
+   * the installer concludes it (ConcludeCommissioningTest). Passed or failed, it sets
+   * "floor.pump_tolerates_all_zones_off" as MEASURED, with the installer's provenance.
+   *
+   * @generated from enum value: TEST_KIND_PUMP_ALL_ZONES_OFF = 3;
+   */
+  PUMP_ALL_ZONES_OFF = 3,
+}
+
+/**
+ * Describes the enum kusinta.iot.commissioning.v1.TestKind.
+ */
+export declare const TestKindSchema: GenEnum<TestKind>;
+
+/**
+ * @generated from enum kusinta.iot.commissioning.v1.TestState
+ */
+export enum TestState {
+  /**
+   * @generated from enum value: TEST_STATE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * @generated from enum value: TEST_STATE_RUNNING = 1;
+   */
+  RUNNING = 1,
+
+  /**
+   * @generated from enum value: TEST_STATE_PASSED = 2;
+   */
+  PASSED = 2,
+
+  /**
+   * @generated from enum value: TEST_STATE_FAILED = 3;
+   */
+  FAILED = 3,
+
+  /**
+   * Stopped by a caller, or ended at ends_at without a verdict. Proves nothing.
+   *
+   * @generated from enum value: TEST_STATE_ABORTED = 4;
+   */
+  ABORTED = 4,
+}
+
+/**
+ * Describes the enum kusinta.iot.commissioning.v1.TestState.
+ */
+export declare const TestStateSchema: GenEnum<TestState>;
+
+/**
+ * @generated from enum kusinta.iot.commissioning.v1.TestFailure
+ */
+export enum TestFailure {
+  /**
+   * @generated from enum value: TEST_FAILURE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * OUTPUT_LEASE.
+   *
+   * @generated from enum value: TEST_FAILURE_POWER_ON_NOT_AT_REST = 1;
+   */
+  POWER_ON_NOT_AT_REST = 1,
+
+  /**
+   * @generated from enum value: TEST_FAILURE_NO_STATE_CHANGE = 2;
+   */
+  NO_STATE_CHANGE = 2,
+
+  /**
+   * @generated from enum value: TEST_FAILURE_LEASE_NOT_RENEWED = 3;
+   */
+  LEASE_NOT_RENEWED = 3,
+
+  /**
+   * @generated from enum value: TEST_FAILURE_DID_NOT_RETURN_TO_REST = 4;
+   */
+  DID_NOT_RETURN_TO_REST = 4,
+
+  /**
+   * The device answered nothing within the test.
+   *
+   * @generated from enum value: TEST_FAILURE_DEVICE_UNREACHABLE = 5;
+   */
+  DEVICE_UNREACHABLE = 5,
+
+  /**
+   * ZONE_EFFECT: the control room and the return did not answer the zone.
+   *
+   * @generated from enum value: TEST_FAILURE_NO_EFFECT = 6;
+   */
+  NO_EFFECT = 6,
+
+  /**
+   * PUMP_ALL_ZONES_OFF: the installer's verdict.
+   *
+   * @generated from enum value: TEST_FAILURE_OBSERVED = 7;
+   */
+  OBSERVED = 7,
+}
+
+/**
+ * Describes the enum kusinta.iot.commissioning.v1.TestFailure.
+ */
+export declare const TestFailureSchema: GenEnum<TestFailure>;
+
+/**
+ * Where a commissioning grant stands (see the file comment, GRANTS). An ended grant has no
+ * state: it is listed no more.
+ *
+ * @generated from enum kusinta.iot.commissioning.v1.CommissioningGrantState
+ */
+export enum CommissioningGrantState {
+  /**
+   * A state this schema does not know: read as REQUESTED, which covers nothing.
+   *
+   * @generated from enum value: COMMISSIONING_GRANT_STATE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * Asked for by the installer and not yet answered. Covers nothing. Lapses unanswered at
+   * expires_at.
+   *
+   * @generated from enum value: COMMISSIONING_GRANT_STATE_REQUESTED = 1;
+   */
+  REQUESTED = 1,
+
+  /**
+   * Granted. Active from starts_at until ends_at; before starts_at it covers nothing yet.
+   *
+   * @generated from enum value: COMMISSIONING_GRANT_STATE_GRANTED = 2;
+   */
+  GRANTED = 2,
+}
+
+/**
+ * Describes the enum kusinta.iot.commissioning.v1.CommissioningGrantState.
+ */
+export declare const CommissioningGrantStateSchema: GenEnum<CommissioningGrantState>;
+