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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kusinta/iot-schema",
-  "version": "0.2.0-beta.49",
+  "version": "0.2.0-beta.50",
   "type": "module",
   "license": "MIT",
   "files": ["src"],

package/src/kusinta/iot/access/v1/acl_pb.d.ts

@@ -313,8 +313,12 @@ export declare type DeviceAcl = Message<"kusinta.iot.access.v1.DeviceAcl"> & {
    * relation their membership records. They hold no action on it — allowed_actions is empty
    * — and are sent no reading or event of it. The Device they are sent carries its
    * description only: its endpoints with their device types and implemented lists, and no
-   * property value. What keeps it working comes as a webrtc.v1.ServiceStatus instead. An
-   * app should show its readings as withheld, not missing. RESIDENT: the user lives in the
+   * property value — save that, while a commissioning grant on the home is active, its
+   * installer is also sent each cluster's attribute_behaviours and each endpoint's
+   * vendor_attribute_behaviours, the device's statement of how it holds an output, to bind
+   * outputs by (commissioning.v1, GRANTS); still no property value. What keeps it working
+   * comes as a webrtc.v1.ServiceStatus instead. An app should show its readings as withheld,
+   * not missing. RESIDENT: the user lives in the
    * home the device is filed in, whether or not they also own it; a household admin is given
    * RESIDENT here too, since they see the device as any resident does. UNSPECIFIED: neither
    * applies — the device is not in a home, or the user reaches it only by owning it.

package/src/kusinta/iot/access/v1/roles_pb.d.ts

@@ -212,8 +212,9 @@ export declare const PermissionActionSchema: GenEnum<PermissionAction>;
  *     quarter hour of their residency, from that quarter hour on.
  *   * As an installer under a commissioning grant on the home, while it is active — the
  *     service view below, and on top of it what commissioning.v1 (GRANTS) lists: the home's
- *     commissioning and heating records, and the readings a test they run is judged by while
- *     it runs. Never its history, savings, comfort settings or device events, nor who lives
+ *     commissioning and heating records, its devices' write behaviours to bind outputs by
+ *     (device.v1.AttributeBehaviour), and the readings a test they run is judged by while it
+ *     runs. Never its history, savings, comfort settings or device events, nor who lives
  *     there.
  *   * As service — SERVICE on the apartment, a room in it, or a building or floor above it,
  *     or as the gateway's administrator. Of the building's own devices in what they reach of
@@ -225,7 +226,7 @@ export declare const PermissionActionSchema: GenEnum<PermissionAction>;
  *     RoomClimate.state_withheld marking what is not shown, and its links with
  *     DeviceLink.details_withheld; modes on a home are not sent to them at all — save that the
  *     property owner and the gateway administrators are sent an empty home's rooms and modes
- *     in full (webrtc.v1 household.proto, EMPTY HOME). Service
+ *     in full, and its floor zones (webrtc.v1 household.proto, EMPTY HOME). Service
  *     that reaches the apartment itself also gets its climate summary over the disclosed
  *     period. What they newly see of the home reaches them as it happens; what they lose,
  *     at once.

package/src/kusinta/iot/access/v1/roles_pb.js

@@ -116,8 +116,9 @@ export const MembershipRelationSchema = /*@__PURE__*/
  *     quarter hour of their residency, from that quarter hour on.
  *   * As an installer under a commissioning grant on the home, while it is active — the
  *     service view below, and on top of it what commissioning.v1 (GRANTS) lists: the home's
- *     commissioning and heating records, and the readings a test they run is judged by while
- *     it runs. Never its history, savings, comfort settings or device events, nor who lives
+ *     commissioning and heating records, its devices' write behaviours to bind outputs by
+ *     (device.v1.AttributeBehaviour), and the readings a test they run is judged by while it
+ *     runs. Never its history, savings, comfort settings or device events, nor who lives
  *     there.
  *   * As service — SERVICE on the apartment, a room in it, or a building or floor above it,
  *     or as the gateway's administrator. Of the building's own devices in what they reach of
@@ -129,7 +130,7 @@ export const MembershipRelationSchema = /*@__PURE__*/
  *     RoomClimate.state_withheld marking what is not shown, and its links with
  *     DeviceLink.details_withheld; modes on a home are not sent to them at all — save that the
  *     property owner and the gateway administrators are sent an empty home's rooms and modes
- *     in full (webrtc.v1 household.proto, EMPTY HOME). Service
+ *     in full, and its floor zones (webrtc.v1 household.proto, EMPTY HOME). Service
  *     that reaches the apartment itself also gets its climate summary over the disclosed
  *     period. What they newly see of the home reaches them as it happens; what they lose,
  *     at once.

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

@@ -379,6 +379,9 @@ export declare type FloorZone = Message<"kusinta.iot.heating.v1.FloorZone"> & {
    * 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.

package/src/kusinta/iot/webrtc/v1/management_pb.d.ts

@@ -198,7 +198,11 @@ export declare const UpdateSpaceSchema: GenMessage<UpdateSpace>;
  * Refused as FAILED_PRECONDITION with metadata {"reason": "handover_pending"}, cascade or not,
  * while a handover is under way, as UpdateSpace has it, of the home deleted or of any home
  * beneath the space: a household's records go by its wipe (household.proto, WIPE), never by a
- * deletion.
+ * deletion. Refused as FAILED_PRECONDITION with metadata {"reason": "home_occupied"}, cascade or
+ * not, while any residency of the home deleted, or of any home beneath the space, names someone:
+ * a current resident, or a past household whose data has not been wiped. The home's household
+ * data goes by a handover first (household.proto, HANDOVER, WIPE), and no residency names a home
+ * that was deleted. "handover_pending" is checked before "home_occupied".
  *
  * @generated from message kusinta.iot.webrtc.v1.DeleteSpace
  */
@@ -1480,6 +1484,18 @@ export declare const PutHeatingCircuitSchema: GenMessage<PutHeatingCircuit>;
 /**
  * Creates or replaces a floor zone of a floor circuit; as PutHeatingPlant.
  *
+ * While a home is empty (household.proto, EMPTY HOME), the property owner and the gateway
+ * administrators who reach it may change which of its rooms a stored floor zone of the home
+ * heats, and so bring a zone left uncontrolled back under control (heating.v1, UNCONTROLLED
+ * ZONES). From them, only a stored zone's rooms and control_room_id may change, its rooms
+ * staying in that home. Any other change from them — its output, its circuit, its name — a new
+ * zone, and removing one (RemoveHeatingRecord) are refused as NOT_ENTITLED, the same answer as
+ * for a zone out of reach. A caller not given the home's zones is refused NOT_ENTITLED first.
+ * For one given the zone, a put naming a revision the zone has moved on from is refused as
+ * FAILED_PRECONDITION "STALE_REVISION" before any of the changes above is judged, so a racing
+ * put is told to re-read. It ends at MOVE-IN (household.proto), and the zone mapping they left
+ * is kept: MOVE-IN's reset does not touch heating records.
+ *
  * @generated from message kusinta.iot.webrtc.v1.PutFloorZone
  */
 export declare type PutFloorZone = Message<"kusinta.iot.webrtc.v1.PutFloorZone"> & {
@@ -1519,7 +1535,8 @@ export declare const PutComfortLoadSchema: GenMessage<PutComfortLoad>;
  * FAILED_PRECONDITION with metadata "reason" "STALE_REVISION" when it changed since, and
  * "HAS_CHILDREN" while records lie under it — a plant's circuits, a circuit's zones — so
  * nothing is removed that the caller did not name. Its outputs are returned to rest at once
- * (see heating.v1). Acked.
+ * (see heating.v1). Acked. An empty home's floor zone is not removed by the property owner or
+ * the gateway administrators who are given it: NOT_ENTITLED, as PutFloorZone says.
  *
  * @generated from message kusinta.iot.webrtc.v1.RemoveHeatingRecord
  */