@kusinta/iot-schema 0.2.0-beta.5 → 0.2.0-beta.50
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +13 -1
- package/src/kusinta/iot/access/v1/acl_pb.d.ts +138 -2
- package/src/kusinta/iot/access/v1/acl_pb.js +19 -2
- package/src/kusinta/iot/access/v1/roles_pb.d.ts +160 -4
- package/src/kusinta/iot/access/v1/roles_pb.js +128 -5
- package/src/kusinta/iot/accountlink/v1/account_link_pb.d.ts +591 -0
- package/src/kusinta/iot/accountlink/v1/account_link_pb.js +160 -0
- package/src/kusinta/iot/climate/v1/climate_pb.d.ts +1492 -0
- package/src/kusinta/iot/climate/v1/climate_pb.js +278 -0
- package/src/kusinta/iot/commissioning/v1/commissioning_pb.d.ts +1344 -0
- package/src/kusinta/iot/commissioning/v1/commissioning_pb.js +282 -0
- package/src/kusinta/iot/common/v1/pairing_pb.d.ts +217 -0
- package/src/kusinta/iot/common/v1/pairing_pb.js +50 -0
- package/src/kusinta/iot/common/v1/types_pb.d.ts +235 -0
- package/src/kusinta/iot/common/v1/types_pb.js +84 -2
- package/src/kusinta/iot/connector/v1/connector_pb.d.ts +874 -3
- package/src/kusinta/iot/connector/v1/connector_pb.js +126 -13
- package/src/kusinta/iot/device/v1/cluster_state_pb.d.ts +213 -1
- package/src/kusinta/iot/device/v1/cluster_state_pb.js +37 -2
- package/src/kusinta/iot/device/v1/descriptor_pb.d.ts +32 -4
- package/src/kusinta/iot/device/v1/descriptor_pb.js +2 -1
- package/src/kusinta/iot/device/v1/device_event_pb.d.ts +89 -5
- package/src/kusinta/iot/device/v1/device_event_pb.js +1 -1
- package/src/kusinta/iot/device/v1/device_pb.d.ts +426 -11
- package/src/kusinta/iot/device/v1/device_pb.js +74 -2
- package/src/kusinta/iot/device/v1/properties_pb.d.ts +26 -5
- package/src/kusinta/iot/device/v1/properties_pb.js +1 -1
- package/src/kusinta/iot/device/v1/property_update_pb.d.ts +42 -2
- package/src/kusinta/iot/device/v1/property_update_pb.js +2 -1
- package/src/kusinta/iot/heating/v1/heating_pb.d.ts +656 -0
- package/src/kusinta/iot/heating/v1/heating_pb.js +119 -0
- package/src/kusinta/iot/link/v1/link_pb.d.ts +438 -0
- package/src/kusinta/iot/link/v1/link_pb.js +121 -0
- package/src/kusinta/iot/registration/v1/registration_pb.d.ts +18 -0
- package/src/kusinta/iot/registration/v1/registration_pb.js +1 -1
- package/src/kusinta/iot/reporting/v1/reporting_pb.d.ts +1251 -0
- package/src/kusinta/iot/reporting/v1/reporting_pb.js +238 -0
- package/src/kusinta/iot/reporting/v1/reporting_service_pb.d.ts +63 -0
- package/src/kusinta/iot/reporting/v1/reporting_service_pb.js +24 -0
- package/src/kusinta/iot/signaling/v1/signaling_pb.d.ts +936 -7
- package/src/kusinta/iot/signaling/v1/signaling_pb.js +163 -4
- package/src/kusinta/iot/signaling/v1/signaling_service_pb.d.ts +24 -1
- package/src/kusinta/iot/signaling/v1/signaling_service_pb.js +1 -1
- package/src/kusinta/iot/space/v1/space_pb.d.ts +146 -2
- package/src/kusinta/iot/space/v1/space_pb.js +10 -1
- package/src/kusinta/iot/vendor/homematic/v1/homematic_pb.d.ts +15 -0
- package/src/kusinta/iot/vendor/homematic/v1/homematic_pb.js +1 -1
- package/src/kusinta/iot/vendor/lorawan/v1/lorawan_pb.d.ts +69 -0
- package/src/kusinta/iot/vendor/lorawan/v1/lorawan_pb.js +19 -0
- package/src/kusinta/iot/vendor/v1/vendor_options_pb.d.ts +5 -4
- package/src/kusinta/iot/vendor/v1/vendor_options_pb.js +5 -4
- package/src/kusinta/iot/webrtc/v1/app_token_pb.d.ts +48 -5
- package/src/kusinta/iot/webrtc/v1/app_token_pb.js +1 -1
- package/src/kusinta/iot/webrtc/v1/command_pb.d.ts +56 -0
- package/src/kusinta/iot/webrtc/v1/command_pb.js +1 -1
- package/src/kusinta/iot/webrtc/v1/device_state_pb.d.ts +179 -5
- package/src/kusinta/iot/webrtc/v1/device_state_pb.js +34 -5
- package/src/kusinta/iot/webrtc/v1/envelope_pb.d.ts +732 -3
- package/src/kusinta/iot/webrtc/v1/envelope_pb.js +84 -4
- package/src/kusinta/iot/webrtc/v1/household_pb.d.ts +612 -0
- package/src/kusinta/iot/webrtc/v1/household_pb.js +134 -0
- package/src/kusinta/iot/webrtc/v1/invite_pb.d.ts +502 -0
- package/src/kusinta/iot/webrtc/v1/invite_pb.js +108 -0
- package/src/kusinta/iot/webrtc/v1/management_pb.d.ts +2149 -76
- package/src/kusinta/iot/webrtc/v1/management_pb.js +311 -5
- package/src/kusinta/iot/webrtc/v1/members_pb.d.ts +582 -0
- package/src/kusinta/iot/webrtc/v1/members_pb.js +113 -0
- package/src/kusinta/iot/webrtc/v1/permission_push_pb.d.ts +66 -4
- package/src/kusinta/iot/webrtc/v1/permission_push_pb.js +9 -1
|
@@ -4,9 +4,21 @@
|
|
|
4
4
|
|
|
5
5
|
import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
|
|
6
6
|
import type { Message } from "@bufbuild/protobuf";
|
|
7
|
-
import type { DeviceOwnershipType, SpaceType } from "../../common/v1/types_pb.js";
|
|
8
|
-
import type { DeviceId, SpaceId, UserId } from "../../identity/v1/identity_pb.js";
|
|
7
|
+
import type { AssetOwner, DeviceOwnershipType, SpaceType } from "../../common/v1/types_pb.js";
|
|
8
|
+
import type { ConnectorId, DeviceId, SpaceId, UserId } from "../../identity/v1/identity_pb.js";
|
|
9
|
+
import type { MembershipRelation, Role } from "../../access/v1/roles_pb.js";
|
|
10
|
+
import type { LorawanProvisioning } from "../../vendor/lorawan/v1/lorawan_pb.js";
|
|
9
11
|
import type { Space } from "../../space/v1/space_pb.js";
|
|
12
|
+
import type { LinkFunction, LinkMode, LinkSettings } from "../../link/v1/link_pb.js";
|
|
13
|
+
import type { ClimateModeKind, ClimateSummaryPeriod, InnerRoomLimits, RoomHistoryResolution } from "../../climate/v1/climate_pb.js";
|
|
14
|
+
import type { Timestamp } from "@bufbuild/protobuf/wkt";
|
|
15
|
+
import type { CancelHouseholdHandover, ClearClimateHistory, ConfirmHouseholdHandover, DemoteHouseholdAdmin, ExportHouseholdData, ListHouseholdHandovers, SetHomeName, StaffAppointment, StartHouseholdHandover } from "./household_pb.js";
|
|
16
|
+
import type { BindingRef, CommissioningFact, CommissioningGrantRecord, HouseTemplate, TestKind, TestState } from "../../commissioning/v1/commissioning_pb.js";
|
|
17
|
+
import type { ServiceSignal } from "../../access/v1/acl_pb.js";
|
|
18
|
+
import type { ComfortLoad, ComfortWindow, FloorZone, HeatingCircuit, HeatingPlant } from "../../heating/v1/heating_pb.js";
|
|
19
|
+
import type { LinkedService } from "../../accountlink/v1/account_link_pb.js";
|
|
20
|
+
import type { ApproveJoinRequest, CreateInvite, DenyJoinRequest, ListSpaceInvites, MarkInviteEmailSent, ResendInvite, RevokeInvite } from "./invite_pb.js";
|
|
21
|
+
import type { AnswerPromotion, ListGatewayMembers, ListPromotionRequests, RemoveFromGateway, RequestPromotion, SetAccessUntil, SetMemberRole, SetOwnerOrganisation } from "./members_pb.js";
|
|
10
22
|
|
|
11
23
|
/**
|
|
12
24
|
* Describes the file kusinta/iot/webrtc/v1/management.proto.
|
|
@@ -18,6 +30,13 @@ export declare const file_kusinta_iot_webrtc_v1_management: GenFile;
|
|
|
18
30
|
* stronger request than it looks: there is no parent whose reach could authorize
|
|
19
31
|
* it, so it is reserved to the gateway's administrator.
|
|
20
32
|
*
|
|
33
|
+
* Under an apartment only a room may be created. Creating in a home is guarded as
|
|
34
|
+
* UpdateSpace is, and refused whatever the caller where UpdateSpace's structure rules would
|
|
35
|
+
* refuse it.
|
|
36
|
+
*
|
|
37
|
+
* An apartment is created by the property owner or the gateway's administrators, with a name
|
|
38
|
+
* that identifies it in the building (space.v1.Space.name); an empty name is INVALID_REQUEST.
|
|
39
|
+
*
|
|
21
40
|
* @generated from message kusinta.iot.webrtc.v1.CreateSpace
|
|
22
41
|
*/
|
|
23
42
|
export declare type CreateSpace = Message<"kusinta.iot.webrtc.v1.CreateSpace"> & {
|
|
@@ -49,6 +68,14 @@ export declare type CreateSpace = Message<"kusinta.iot.webrtc.v1.CreateSpace"> &
|
|
|
49
68
|
* @generated from field: kusinta.iot.identity.v1.SpaceId parent_space_id = 5;
|
|
50
69
|
*/
|
|
51
70
|
parentSpaceId?: SpaceId | undefined;
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* An IANA time zone name, e.g. "Europe/Stockholm". Accepted only on a building — a
|
|
74
|
+
* top-level space — and refused on any other. Unset leaves it unknown.
|
|
75
|
+
*
|
|
76
|
+
* @generated from field: optional string time_zone = 6;
|
|
77
|
+
*/
|
|
78
|
+
timeZone?: string | undefined;
|
|
52
79
|
};
|
|
53
80
|
|
|
54
81
|
/**
|
|
@@ -58,9 +85,42 @@ export declare type CreateSpace = Message<"kusinta.iot.webrtc.v1.CreateSpace"> &
|
|
|
58
85
|
export declare const CreateSpaceSchema: GenMessage<CreateSpace>;
|
|
59
86
|
|
|
60
87
|
/**
|
|
61
|
-
* Changes a space in place.
|
|
62
|
-
*
|
|
63
|
-
*
|
|
88
|
+
* Changes a space in place. Changes that would take a space into or out of a home, or move
|
|
89
|
+
* a home, are guarded by the gateway; a caller not allowed is refused as NOT_ENTITLED. A
|
|
90
|
+
* change is refused whatever the caller if it would leave anything but a room under an
|
|
91
|
+
* apartment, an apartment in a home, or — among what the caller can see — a device in two
|
|
92
|
+
* homes or a link across a home's boundary. What the caller cannot see never refuses it: a
|
|
93
|
+
* device a resident owns that would leave its owner's home, enter a home not theirs or sit
|
|
94
|
+
* in two homes is taken out of the moving space instead — staying in its owner's home,
|
|
95
|
+
* filed on the apartment, where it was in it — and any link it would carry across a
|
|
96
|
+
* boundary is removed. Changing the type of a space that has members needs
|
|
97
|
+
* ROLE_PROPERTY_OWNER or ROLE_GATEWAY_ADMIN, who see them, and is refused if it would
|
|
98
|
+
* leave a RESIDENT membership on a room, as INVALID_REQUEST with metadata
|
|
99
|
+
* {"reason": "resident_on_room"}.
|
|
100
|
+
*
|
|
101
|
+
* An apartment keeps its type while its household data is there. A change of an apartment's
|
|
102
|
+
* type is refused as FAILED_PRECONDITION with metadata {"reason": "handover_pending"} while a
|
|
103
|
+
* handover of the home is under way: pending (household.proto, HANDOVER, VACANCY), confirmed
|
|
104
|
+
* but its wipe not yet done, or its last residency ended and no handover recorded yet. It is
|
|
105
|
+
* refused as FAILED_PRECONDITION with metadata {"reason": "home_occupied"} while any residency
|
|
106
|
+
* of the home names someone: a current resident, or a past household whose data has not been
|
|
107
|
+
* wiped. The home's household data goes by a handover first (household.proto, HANDOVER, WIPE),
|
|
108
|
+
* never by a retype away and back. Neither refuses a change that leaves the type as it is, a
|
|
109
|
+
* rename among them. Every other check is made first — who may make the change, and the
|
|
110
|
+
* refusals of its shape as INVALID_REQUEST, "resident_on_room" among them — and
|
|
111
|
+
* "handover_pending" before "home_occupied".
|
|
112
|
+
*
|
|
113
|
+
* The name of an apartment is the building's identifier for it (space.v1.Space.name), and is
|
|
114
|
+
* changed only by the property owner or the gateway's administrators: from anyone else, a
|
|
115
|
+
* request setting it is refused whole as NOT_ENTITLED. The household names its home with
|
|
116
|
+
* SetHomeName instead.
|
|
117
|
+
*
|
|
118
|
+
* A heating record the change would leave across a home's boundary is refused or undone as
|
|
119
|
+
* HEATING ACROSS A HOME says.
|
|
120
|
+
*
|
|
121
|
+
* Every descriptive field carries explicit presence: absent means leave it alone, present
|
|
122
|
+
* means set it to this — including to the empty string, which is how a description is
|
|
123
|
+
* cleared.
|
|
64
124
|
*
|
|
65
125
|
* @generated from message kusinta.iot.webrtc.v1.UpdateSpace
|
|
66
126
|
*/
|
|
@@ -111,6 +171,15 @@ export declare type UpdateSpace = Message<"kusinta.iot.webrtc.v1.UpdateSpace"> &
|
|
|
111
171
|
value: boolean;
|
|
112
172
|
case: "detach";
|
|
113
173
|
} | { case: undefined; value?: undefined };
|
|
174
|
+
|
|
175
|
+
/**
|
|
176
|
+
* An IANA time zone name, e.g. "Europe/Stockholm". Accepted only on a building — a
|
|
177
|
+
* top-level space — and refused on any other. Unset leaves it unchanged; the empty
|
|
178
|
+
* string clears it.
|
|
179
|
+
*
|
|
180
|
+
* @generated from field: optional string time_zone = 8;
|
|
181
|
+
*/
|
|
182
|
+
timeZone?: string | undefined;
|
|
114
183
|
};
|
|
115
184
|
|
|
116
185
|
/**
|
|
@@ -122,7 +191,18 @@ export declare const UpdateSpaceSchema: GenMessage<UpdateSpace>;
|
|
|
122
191
|
/**
|
|
123
192
|
* Deletes a space. Refused if the space still holds devices or sub-spaces unless
|
|
124
193
|
* cascade is set, so that emptying a building is always something the caller
|
|
125
|
-
* asked for rather than something a stale client did by accident.
|
|
194
|
+
* asked for rather than something a stale client did by accident. Deleting a home, or
|
|
195
|
+
* anything in one, is guarded as UpdateSpace is, heating records included
|
|
196
|
+
* (HEATING ACROSS A HOME).
|
|
197
|
+
*
|
|
198
|
+
* Refused as FAILED_PRECONDITION with metadata {"reason": "handover_pending"}, cascade or not,
|
|
199
|
+
* while a handover is under way, as UpdateSpace has it, of the home deleted or of any home
|
|
200
|
+
* beneath the space: a household's records go by its wipe (household.proto, WIPE), never by a
|
|
201
|
+
* deletion. Refused as FAILED_PRECONDITION with metadata {"reason": "home_occupied"}, cascade or
|
|
202
|
+
* not, while any residency of the home deleted, or of any home beneath the space, names someone:
|
|
203
|
+
* a current resident, or a past household whose data has not been wiped. The home's household
|
|
204
|
+
* data goes by a handover first (household.proto, HANDOVER, WIPE), and no residency names a home
|
|
205
|
+
* that was deleted. "handover_pending" is checked before "home_occupied".
|
|
126
206
|
*
|
|
127
207
|
* @generated from message kusinta.iot.webrtc.v1.DeleteSpace
|
|
128
208
|
*/
|
|
@@ -145,10 +225,32 @@ export declare type DeleteSpace = Message<"kusinta.iot.webrtc.v1.DeleteSpace"> &
|
|
|
145
225
|
export declare const DeleteSpaceSchema: GenMessage<DeleteSpace>;
|
|
146
226
|
|
|
147
227
|
/**
|
|
148
|
-
* Adds a user to a space, granting them reach of it and everything beneath it
|
|
228
|
+
* Adds a user to a space, granting them reach of it and everything beneath it — except
|
|
229
|
+
* that a RESIDENT membership reaches no home beneath it (see access.v1.MembershipRelation).
|
|
149
230
|
* The user need not be known to the gateway beforehand — identities are minted by
|
|
150
231
|
* the token issuer, and this records that one of them belongs here.
|
|
151
232
|
*
|
|
233
|
+
* Assigning a user who is already a member changes their relation to the space.
|
|
234
|
+
* RESIDENT is refused on a room; see access.v1.MembershipRelation.
|
|
235
|
+
*
|
|
236
|
+
* Nobody is made a household admin through it: HOUSEHOLD_ADMIN is refused as
|
|
237
|
+
* INVALID_REQUEST, since that comes only by promotion or appointment (household.proto). A
|
|
238
|
+
* HOUSEHOLD_ADMIN membership is never changed through it either: assigning onto one is refused
|
|
239
|
+
* as FAILED_PRECONDITION with metadata {"reason": "household_admin"}; DemoteHouseholdAdmin and
|
|
240
|
+
* RemoveUserFromSpace are how it ends.
|
|
241
|
+
*
|
|
242
|
+
* Who may change who belongs to a home is restricted by the gateway; a caller not allowed is
|
|
243
|
+
* refused as NOT_ENTITLED. Residents see who is filed on their home in Space.members.
|
|
244
|
+
*
|
|
245
|
+
* A membership the caller is not told of under this user id (a residency, to anyone outside
|
|
246
|
+
* its household: access.v1.MembershipRelation, RESIDENCY IDS) is never changed through it:
|
|
247
|
+
* assigning onto it is refused as NOT_ENTITLED, and RemoveUserFromSpace answers as for one
|
|
248
|
+
* that does not exist. user_id is never a residency id.
|
|
249
|
+
*
|
|
250
|
+
* While a vacated handover of the home is pending, the property owner or a gateway
|
|
251
|
+
* administrator assigning RESIDENT to someone outside the departing household completes it
|
|
252
|
+
* first rather than being refused as "handover_pending" (household.proto, QUICK TURNOVER).
|
|
253
|
+
*
|
|
152
254
|
* @generated from message kusinta.iot.webrtc.v1.AssignUserToSpace
|
|
153
255
|
*/
|
|
154
256
|
export declare type AssignUserToSpace = Message<"kusinta.iot.webrtc.v1.AssignUserToSpace"> & {
|
|
@@ -161,6 +263,15 @@ export declare type AssignUserToSpace = Message<"kusinta.iot.webrtc.v1.AssignUse
|
|
|
161
263
|
* @generated from field: kusinta.iot.identity.v1.UserId user_id = 2;
|
|
162
264
|
*/
|
|
163
265
|
userId?: UserId | undefined;
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* How the user stands to the space — whether they live there or are there for the
|
|
269
|
+
* building. Required: UNSPECIFIED is refused, never defaulted. See
|
|
270
|
+
* access.v1.MembershipRelation for what each lets a member see of a home.
|
|
271
|
+
*
|
|
272
|
+
* @generated from field: kusinta.iot.access.v1.MembershipRelation relation = 4;
|
|
273
|
+
*/
|
|
274
|
+
relation: MembershipRelation;
|
|
164
275
|
};
|
|
165
276
|
|
|
166
277
|
/**
|
|
@@ -173,6 +284,18 @@ export declare const AssignUserToSpaceSchema: GenMessage<AssignUserToSpace>;
|
|
|
173
284
|
* Removes a user's membership of a space. Losing reach also drops whatever the
|
|
174
285
|
* user was streaming from it, announced by LivePermissionUpdate.
|
|
175
286
|
*
|
|
287
|
+
* Removing someone else from a home is guarded as assigning is: within the household, it is a
|
|
288
|
+
* household admin's (household.proto). Anyone may remove themselves, save the last household
|
|
289
|
+
* admin of a home that has other residents ("last_household_admin", household.proto, LAST
|
|
290
|
+
* ADMIN, which also refuses a household admin removing another when that would leave none). A
|
|
291
|
+
* membership the caller is not told of under the user id given (see AssignUserToSpace) is
|
|
292
|
+
* answered as one that does not exist, and stays.
|
|
293
|
+
*
|
|
294
|
+
* user_id may be a residency id (access.v1.MembershipRelation, RESIDENCY IDS): it then ends
|
|
295
|
+
* that residency, if space_id is its home, and answers as for one that does not exist
|
|
296
|
+
* otherwise. This is how a property owner or an administrator ends the residency of
|
|
297
|
+
* someone who moved out.
|
|
298
|
+
*
|
|
176
299
|
* @generated from message kusinta.iot.webrtc.v1.RemoveUserFromSpace
|
|
177
300
|
*/
|
|
178
301
|
export declare type RemoveUserFromSpace = Message<"kusinta.iot.webrtc.v1.RemoveUserFromSpace"> & {
|
|
@@ -197,6 +320,14 @@ export declare const RemoveUserFromSpaceSchema: GenMessage<RemoveUserFromSpace>;
|
|
|
197
320
|
* Files a device into a space. A device may sit in several spaces at once; this
|
|
198
321
|
* is additive, and filing a device where it already sits is a no-op.
|
|
199
322
|
*
|
|
323
|
+
* Into a home go only the building's own devices and devices its residents own, and a
|
|
324
|
+
* device belongs to one home at most; filing into, out of or beside a home is guarded by
|
|
325
|
+
* the gateway, and within the household it is a household admin's, save a device a resident
|
|
326
|
+
* owns, which its owner files (household.proto). A caller not allowed is refused as
|
|
327
|
+
* NOT_ENTITLED, and filing that would leave a link the caller can see across a home's
|
|
328
|
+
* boundary is refused whatever the caller; one they cannot see is removed instead. A heating
|
|
329
|
+
* record left across it is refused or undone as HEATING ACROSS A HOME says.
|
|
330
|
+
*
|
|
200
331
|
* @generated from message kusinta.iot.webrtc.v1.PlaceDeviceInSpace
|
|
201
332
|
*/
|
|
202
333
|
export declare type PlaceDeviceInSpace = Message<"kusinta.iot.webrtc.v1.PlaceDeviceInSpace"> & {
|
|
@@ -221,6 +352,10 @@ export declare const PlaceDeviceInSpaceSchema: GenMessage<PlaceDeviceInSpace>;
|
|
|
221
352
|
* Takes a device out of one space, leaving any others intact. A device in no
|
|
222
353
|
* space and with no owner is unfiled, and visible only to the administrator.
|
|
223
354
|
*
|
|
355
|
+
* Taking a device out of a home is guarded as PlaceDeviceInSpace is, and removes its links
|
|
356
|
+
* to devices still in the home; a heating record it would leave across the boundary is refused
|
|
357
|
+
* or undone as HEATING ACROSS A HOME says.
|
|
358
|
+
*
|
|
224
359
|
* @generated from message kusinta.iot.webrtc.v1.RemoveDeviceFromSpace
|
|
225
360
|
*/
|
|
226
361
|
export declare type RemoveDeviceFromSpace = Message<"kusinta.iot.webrtc.v1.RemoveDeviceFromSpace"> & {
|
|
@@ -244,7 +379,14 @@ export declare const RemoveDeviceFromSpaceSchema: GenMessage<RemoveDeviceFromSpa
|
|
|
244
379
|
/**
|
|
245
380
|
* Takes ownership of a device. Ownership is reach in its own right: an owner may
|
|
246
381
|
* see and control their device whatever their gateway-wide role permits, and may
|
|
247
|
-
* file it into spaces they belong to
|
|
382
|
+
* file it into spaces they belong to, and the rooms of a home they live in — though into a
|
|
383
|
+
* home only if they live there (see PlaceDeviceInSpace).
|
|
384
|
+
*
|
|
385
|
+
* Only a RESIDENT claim makes the caller the owner. A COMPANY claim records that the
|
|
386
|
+
* building owns the device, names no person, and grants the caller no reach. Claims of a
|
|
387
|
+
* device in a home, or of one already claimed, are restricted by the gateway. A claim, with
|
|
388
|
+
* initial_space_id or without, that would leave a heating record across a home's boundary is
|
|
389
|
+
* refused or undone as HEATING ACROSS A HOME says.
|
|
248
390
|
*
|
|
249
391
|
* @generated from message kusinta.iot.webrtc.v1.ClaimDevice
|
|
250
392
|
*/
|
|
@@ -265,8 +407,18 @@ export declare type ClaimDevice = Message<"kusinta.iot.webrtc.v1.ClaimDevice"> &
|
|
|
265
407
|
initialSpaceId?: SpaceId | undefined;
|
|
266
408
|
|
|
267
409
|
/**
|
|
268
|
-
* Evidence the claimant is standing at the device: the
|
|
269
|
-
* matched against DeviceDescriptor.serial_number.
|
|
410
|
+
* Evidence the claimant is standing at the device: the identifier printed on it,
|
|
411
|
+
* matched against DeviceDescriptor.serial_number.
|
|
412
|
+
*
|
|
413
|
+
* The match is by SUFFIX, because what a connector announces is not always the whole
|
|
414
|
+
* of what is printed and the announced value is commonly the tail of the printed one.
|
|
415
|
+
* Both sides are normalised first — lowercased, with whitespace and ASCII hyphens
|
|
416
|
+
* removed, since a label prints the value in groups and a scan does not — and the proof
|
|
417
|
+
* is accepted when what remains ends with the announced serial. Spelled out because two
|
|
418
|
+
* gateways normalising differently would accept different proofs for the same device.
|
|
419
|
+
*
|
|
420
|
+
* A serial shorter than eight characters cannot be proved at all: under a suffix rule a
|
|
421
|
+
* short one is proved by almost anything ending with it. Required precisely when the
|
|
270
422
|
* caller cannot already reach the device, which is the ordinary case for a
|
|
271
423
|
* resident claiming something they just bought — an unfiled device is invisible
|
|
272
424
|
* to them, so possession is the only thing left that can distinguish them from
|
|
@@ -286,8 +438,10 @@ export declare type ClaimDevice = Message<"kusinta.iot.webrtc.v1.ClaimDevice"> &
|
|
|
286
438
|
export declare const ClaimDeviceSchema: GenMessage<ClaimDevice>;
|
|
287
439
|
|
|
288
440
|
/**
|
|
289
|
-
* Gives up ownership. The device keeps whatever space filing it has
|
|
290
|
-
*
|
|
441
|
+
* Gives up ownership. The device keeps whatever space filing it has, except that a device in a
|
|
442
|
+
* home stays filed in the home alone, as one of the building's own devices there — as when its
|
|
443
|
+
* owner moves out; if it has none it becomes unfiled. A heating record the release would leave
|
|
444
|
+
* across a home's boundary is undone, never refused (HEATING ACROSS A HOME).
|
|
291
445
|
*
|
|
292
446
|
* @generated from message kusinta.iot.webrtc.v1.ReleaseDevice
|
|
293
447
|
*/
|
|
@@ -304,6 +458,66 @@ export declare type ReleaseDevice = Message<"kusinta.iot.webrtc.v1.ReleaseDevice
|
|
|
304
458
|
*/
|
|
305
459
|
export declare const ReleaseDeviceSchema: GenMessage<ReleaseDevice>;
|
|
306
460
|
|
|
461
|
+
/**
|
|
462
|
+
* Registers a device with the system that will admit it, so that it can join
|
|
463
|
+
* later. For a technology where a device is enrolled as a record rather than
|
|
464
|
+
* adopted during a window — see common.v1.PairingWindow for the other case, where
|
|
465
|
+
* something joins a hub during a window and the arrival is attributed to the
|
|
466
|
+
* caller. A LoRaWAN device has no window: it is written into a network server and
|
|
467
|
+
* joins whenever it is next powered, which may be minutes, days, or never.
|
|
468
|
+
*
|
|
469
|
+
* Answered with the ordinary ManagementAck. A provision writes a record and returns
|
|
470
|
+
* nothing to show; the device itself is announced by device_added if and when it
|
|
471
|
+
* joins, the same path every other device takes — which is why this adds no
|
|
472
|
+
* ManagementResult arm. A new result arm is a compile error in a consumer that
|
|
473
|
+
* matches the result exhaustively; a new request arm is not.
|
|
474
|
+
*
|
|
475
|
+
* Registering and owning stay two operations. ClaimDevice records the caller and
|
|
476
|
+
* carries possession_proof, so a device that has not joined yet is still claimable
|
|
477
|
+
* by whoever holds it — and because the connector derives the device id and the
|
|
478
|
+
* serial from the identifier here, that claim can be made before the join.
|
|
479
|
+
*
|
|
480
|
+
* Provisioning the same identifier twice is an upsert: it replaces the credentials
|
|
481
|
+
* rather than being refused as a conflict, so correcting a mistyped key does not
|
|
482
|
+
* require removing the device first. Removing a record is a distinct act from
|
|
483
|
+
* giving up ownership (ReleaseDevice) and is left to a later operation.
|
|
484
|
+
*
|
|
485
|
+
* @generated from message kusinta.iot.webrtc.v1.ProvisionDevice
|
|
486
|
+
*/
|
|
487
|
+
export declare type ProvisionDevice = Message<"kusinta.iot.webrtc.v1.ProvisionDevice"> & {
|
|
488
|
+
/**
|
|
489
|
+
* Required, unlike a pairing window's connector target. A registration is written
|
|
490
|
+
* to one specific registry; there is no sensible "open them all and see what
|
|
491
|
+
* joins". The app names it from the connector enumeration, targeting a connector
|
|
492
|
+
* that declares ConnectorInfo.supports_provisioning.
|
|
493
|
+
*
|
|
494
|
+
* @generated from field: kusinta.iot.identity.v1.ConnectorId connector_id = 1;
|
|
495
|
+
*/
|
|
496
|
+
connectorId?: ConnectorId | undefined;
|
|
497
|
+
|
|
498
|
+
/**
|
|
499
|
+
* What the registry needs to admit the device, which differs entirely by
|
|
500
|
+
* technology — a oneof per technology rather than a flat set of fields, for the
|
|
501
|
+
* reason LinkSettings gives: the second technology to arrive must not turn this
|
|
502
|
+
* into a bag of unrelated optionals named after the first.
|
|
503
|
+
*
|
|
504
|
+
* @generated from oneof kusinta.iot.webrtc.v1.ProvisionDevice.credentials
|
|
505
|
+
*/
|
|
506
|
+
credentials: {
|
|
507
|
+
/**
|
|
508
|
+
* @generated from field: kusinta.iot.vendor.lorawan.v1.LorawanProvisioning lorawan = 2;
|
|
509
|
+
*/
|
|
510
|
+
value: LorawanProvisioning;
|
|
511
|
+
case: "lorawan";
|
|
512
|
+
} | { case: undefined; value?: undefined };
|
|
513
|
+
};
|
|
514
|
+
|
|
515
|
+
/**
|
|
516
|
+
* Describes the message kusinta.iot.webrtc.v1.ProvisionDevice.
|
|
517
|
+
* Use `create(ProvisionDeviceSchema)` to create a new message.
|
|
518
|
+
*/
|
|
519
|
+
export declare const ProvisionDeviceSchema: GenMessage<ProvisionDevice>;
|
|
520
|
+
|
|
307
521
|
/**
|
|
308
522
|
* Asks for the spaces the caller can reach. Unset root_space_id means all of
|
|
309
523
|
* them, which for most users is one apartment and for an administrator is the
|
|
@@ -333,7 +547,9 @@ export declare const ListSpacesSchema: GenMessage<ListSpaces>;
|
|
|
333
547
|
*
|
|
334
548
|
* device_ids on each Space are filtered to what the caller may see. An
|
|
335
549
|
* unfiltered tree would list every device on the gateway by id, which is the
|
|
336
|
-
* enumeration channel the snapshot filter exists to close.
|
|
550
|
+
* enumeration channel the snapshot filter exists to close. To a caller who sees a home as
|
|
551
|
+
* service, what is new in it is listed as it happens and what is gone at once, its members
|
|
552
|
+
* included where they are shown (see Space.members).
|
|
337
553
|
*
|
|
338
554
|
* @generated from message kusinta.iot.webrtc.v1.SpaceTree
|
|
339
555
|
*/
|
|
@@ -373,73 +589,1930 @@ export declare const ManagementAckSchema: GenMessage<ManagementAck>;
|
|
|
373
589
|
* message kind, so these can never be gated by a table keyed on the envelope case
|
|
374
590
|
* the way device messages are. Keeping them behind one case means one place that
|
|
375
591
|
* must authorize, and one refusal path that must not leak whether a target exists.
|
|
592
|
+
* Links one device to another, so the sender leads the receiver. The gateway
|
|
593
|
+
* resolves which underlying connections that needs and asks the connector for
|
|
594
|
+
* them; a caller names two devices and what the link is for.
|
|
376
595
|
*
|
|
377
|
-
*
|
|
596
|
+
* Authorized against both ends, and not symmetrically. Leading a device is a
|
|
597
|
+
* standing grant of control over it, so the receiver requires ownership or a
|
|
598
|
+
* servicing role. The sender's requirement depends on the mode: a gateway-kept
|
|
599
|
+
* link only reads what the caller can already see, while a device-to-device one
|
|
600
|
+
* writes configuration to the sender and spends its battery, which is a change
|
|
601
|
+
* to someone else's hardware.
|
|
602
|
+
*
|
|
603
|
+
* In a home it is the other way round: links between its devices are its residents' to
|
|
604
|
+
* make, change and remove, and in an empty home (household.proto, EMPTY HOME) the property
|
|
605
|
+
* owner's and the gateway administrators' who reach it; any other caller who reaches it as
|
|
606
|
+
* service is refused as NOT_ENTITLED. A link between a device in a home and one outside it is
|
|
607
|
+
* refused to anyone.
|
|
608
|
+
* The same holds for UpdateDeviceLink and RemoveDeviceLink.
|
|
609
|
+
*
|
|
610
|
+
* @generated from message kusinta.iot.webrtc.v1.CreateDeviceLink
|
|
378
611
|
*/
|
|
379
|
-
export declare type
|
|
612
|
+
export declare type CreateDeviceLink = Message<"kusinta.iot.webrtc.v1.CreateDeviceLink"> & {
|
|
380
613
|
/**
|
|
381
|
-
* @generated from
|
|
614
|
+
* @generated from field: kusinta.iot.identity.v1.DeviceId sender = 1;
|
|
382
615
|
*/
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
616
|
+
sender?: DeviceId | undefined;
|
|
617
|
+
|
|
618
|
+
/**
|
|
619
|
+
* @generated from field: kusinta.iot.identity.v1.DeviceId receiver = 2;
|
|
620
|
+
*/
|
|
621
|
+
receiver?: DeviceId | undefined;
|
|
622
|
+
|
|
623
|
+
/**
|
|
624
|
+
* @generated from field: kusinta.iot.link.v1.LinkFunction function = 3;
|
|
625
|
+
*/
|
|
626
|
+
function: LinkFunction;
|
|
627
|
+
|
|
628
|
+
/**
|
|
629
|
+
* Unset lets the gateway choose, which prefers a device-to-device link where
|
|
630
|
+
* one can be brokered: it survives a gateway outage and runs at the devices'
|
|
631
|
+
* own rate. Name one to override that.
|
|
632
|
+
*
|
|
633
|
+
* @generated from field: kusinta.iot.link.v1.LinkMode mode = 4;
|
|
634
|
+
*/
|
|
635
|
+
mode: LinkMode;
|
|
636
|
+
|
|
637
|
+
/**
|
|
638
|
+
* How a gateway-kept link is to behave, set as it is made. Carried here as
|
|
639
|
+
* well as on UpdateDeviceLink so that a link does not have to exist in a
|
|
640
|
+
* configured-by-nobody state first — a soft climate link created without a
|
|
641
|
+
* target is one that holds the room at nothing until a second request
|
|
642
|
+
* arrives, and every reader would have to handle that transient forever.
|
|
643
|
+
*
|
|
644
|
+
* Unset is still allowed and still means unconfigured, since a hard link has
|
|
645
|
+
* nothing to configure and a caller may genuinely not know the target yet.
|
|
646
|
+
*
|
|
647
|
+
* @generated from field: kusinta.iot.link.v1.LinkSettings settings = 5;
|
|
648
|
+
*/
|
|
649
|
+
settings?: LinkSettings | undefined;
|
|
650
|
+
};
|
|
651
|
+
|
|
652
|
+
/**
|
|
653
|
+
* Describes the message kusinta.iot.webrtc.v1.CreateDeviceLink.
|
|
654
|
+
* Use `create(CreateDeviceLinkSchema)` to create a new message.
|
|
655
|
+
*/
|
|
656
|
+
export declare const CreateDeviceLinkSchema: GenMessage<CreateDeviceLink>;
|
|
657
|
+
|
|
658
|
+
/**
|
|
659
|
+
* Removes a link. Note that on at least one vendor, removing a link disturbs the
|
|
660
|
+
* receiver's own settings and the connector must repair them, so this is not the
|
|
661
|
+
* no-op it appears to be.
|
|
662
|
+
*
|
|
663
|
+
* @generated from message kusinta.iot.webrtc.v1.RemoveDeviceLink
|
|
664
|
+
*/
|
|
665
|
+
export declare type RemoveDeviceLink = Message<"kusinta.iot.webrtc.v1.RemoveDeviceLink"> & {
|
|
666
|
+
/**
|
|
667
|
+
* @generated from field: string link_id = 1;
|
|
668
|
+
*/
|
|
669
|
+
linkId: string;
|
|
670
|
+
};
|
|
671
|
+
|
|
672
|
+
/**
|
|
673
|
+
* Describes the message kusinta.iot.webrtc.v1.RemoveDeviceLink.
|
|
674
|
+
* Use `create(RemoveDeviceLinkSchema)` to create a new message.
|
|
675
|
+
*/
|
|
676
|
+
export declare const RemoveDeviceLinkSchema: GenMessage<RemoveDeviceLink>;
|
|
677
|
+
|
|
678
|
+
/**
|
|
679
|
+
* Changes how a gateway-kept link behaves — for a climate lead, the temperature
|
|
680
|
+
* it is to hold.
|
|
681
|
+
*
|
|
682
|
+
* Refused on a link that has nothing to configure — see LinkSettings — rather
|
|
683
|
+
* than accepted as a no-op, so that a caller who has mistaken which link they
|
|
684
|
+
* are holding is told.
|
|
685
|
+
*
|
|
686
|
+
* Authorized against both ends, as creating and removing the link are: deciding
|
|
687
|
+
* what temperature a room is held at is directing a device, not adjusting one,
|
|
688
|
+
* so it takes ownership of the ends or a servicing role, not the permission to
|
|
689
|
+
* turn a thermostat up. In a home it is its residents' instead (see CreateDeviceLink).
|
|
690
|
+
*
|
|
691
|
+
* @generated from message kusinta.iot.webrtc.v1.UpdateDeviceLink
|
|
692
|
+
*/
|
|
693
|
+
export declare type UpdateDeviceLink = Message<"kusinta.iot.webrtc.v1.UpdateDeviceLink"> & {
|
|
694
|
+
/**
|
|
695
|
+
* @generated from field: string link_id = 1;
|
|
696
|
+
*/
|
|
697
|
+
linkId: string;
|
|
698
|
+
|
|
699
|
+
/**
|
|
700
|
+
* Replaces the link's settings rather than patching them: the settings of one
|
|
701
|
+
* function are few and are set together, so there is no half-update worth
|
|
702
|
+
* expressing. This is why it does not follow UpdateSpace's per-field optional
|
|
703
|
+
* shape, which exists for a message whose fields genuinely move alone.
|
|
704
|
+
*
|
|
705
|
+
* Unset is refused rather than being given a meaning. It would have to mean
|
|
706
|
+
* either "leave everything alone", making the request a no-op, or "clear the
|
|
707
|
+
* settings", which is the one thing that reads like an accident — and the
|
|
708
|
+
* wire cannot tell those two callers apart.
|
|
709
|
+
*
|
|
710
|
+
* @generated from field: kusinta.iot.link.v1.LinkSettings settings = 2;
|
|
711
|
+
*/
|
|
712
|
+
settings?: LinkSettings | undefined;
|
|
713
|
+
};
|
|
714
|
+
|
|
715
|
+
/**
|
|
716
|
+
* Describes the message kusinta.iot.webrtc.v1.UpdateDeviceLink.
|
|
717
|
+
* Use `create(UpdateDeviceLinkSchema)` to create a new message.
|
|
718
|
+
*/
|
|
719
|
+
export declare const UpdateDeviceLinkSchema: GenMessage<UpdateDeviceLink>;
|
|
720
|
+
|
|
721
|
+
/**
|
|
722
|
+
* Lists links. Unset device_id lists every link among devices the caller can
|
|
723
|
+
* reach; naming one narrows it to that device's own, in either direction.
|
|
724
|
+
*
|
|
725
|
+
* A link with an end in a home reaches a caller who sees it as service with
|
|
726
|
+
* DeviceLink.details_withheld set, and what that withholds unset — a new link
|
|
727
|
+
* as it is made, a removed one at once — and not at all when either end is a
|
|
728
|
+
* device a resident owns.
|
|
729
|
+
*
|
|
730
|
+
* @generated from message kusinta.iot.webrtc.v1.ListDeviceLinks
|
|
731
|
+
*/
|
|
732
|
+
export declare type ListDeviceLinks = Message<"kusinta.iot.webrtc.v1.ListDeviceLinks"> & {
|
|
733
|
+
/**
|
|
734
|
+
* @generated from field: kusinta.iot.identity.v1.DeviceId device_id = 1;
|
|
735
|
+
*/
|
|
736
|
+
deviceId?: DeviceId | undefined;
|
|
737
|
+
};
|
|
738
|
+
|
|
739
|
+
/**
|
|
740
|
+
* Describes the message kusinta.iot.webrtc.v1.ListDeviceLinks.
|
|
741
|
+
* Use `create(ListDeviceLinksSchema)` to create a new message.
|
|
742
|
+
*/
|
|
743
|
+
export declare const ListDeviceLinksSchema: GenMessage<ListDeviceLinks>;
|
|
744
|
+
|
|
745
|
+
/**
|
|
746
|
+
* Sets the temperature a room is to be held at.
|
|
747
|
+
*
|
|
748
|
+
* Authorized as adjusting, not directing: WRITE on the room is enough. It is the same act
|
|
749
|
+
* as turning a radiator's knob; setting up what the room obeys is ConfigureRoomClimate,
|
|
750
|
+
* and stays with owners, except the lock in a home.
|
|
751
|
+
*
|
|
752
|
+
* In a home, only its residents may set it, and in an empty home the property owner and the
|
|
753
|
+
* gateway administrators who reach it (household.proto, EMPTY HOME); any other caller who
|
|
754
|
+
* reaches the room as service is refused as NOT_ENTITLED.
|
|
755
|
+
*
|
|
756
|
+
* Clamped to the room's inner limits (climate.v1.InnerRoomLimits) rather than refused outside
|
|
757
|
+
* them, and the clamped value is what the room's RoomClimate then reports; never to the outer
|
|
758
|
+
* ones (climate.v1.OuterRoomLimits, WHAT THEY BIND).
|
|
759
|
+
*
|
|
760
|
+
* @generated from message kusinta.iot.webrtc.v1.SetRoomTarget
|
|
761
|
+
*/
|
|
762
|
+
export declare type SetRoomTarget = Message<"kusinta.iot.webrtc.v1.SetRoomTarget"> & {
|
|
763
|
+
/**
|
|
764
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId room_id = 1;
|
|
765
|
+
*/
|
|
766
|
+
roomId?: SpaceId | undefined;
|
|
767
|
+
|
|
768
|
+
/**
|
|
769
|
+
* Unset clears the target: the room goes back to having none (NO_TARGET) and its
|
|
770
|
+
* devices to their own behaviour. With presence, so that a request that forgot the
|
|
771
|
+
* field is not read as 0 °C and clamped to the room's minimum.
|
|
772
|
+
*
|
|
773
|
+
* @generated from field: optional sint32 target_centidegrees = 2;
|
|
774
|
+
*/
|
|
775
|
+
targetCentidegrees?: number | undefined;
|
|
776
|
+
};
|
|
777
|
+
|
|
778
|
+
/**
|
|
779
|
+
* Describes the message kusinta.iot.webrtc.v1.SetRoomTarget.
|
|
780
|
+
* Use `create(SetRoomTargetSchema)` to create a new message.
|
|
781
|
+
*/
|
|
782
|
+
export declare const SetRoomTargetSchema: GenMessage<SetRoomTarget>;
|
|
783
|
+
|
|
784
|
+
/**
|
|
785
|
+
* The sensors a room measures with, in order of preference. A message of its own so that
|
|
786
|
+
* "leave the sensors alone" (unset) differs from "set" on the wire. It orders the
|
|
787
|
+
* building's sensors only (see climate.v1.RoomClimate.sensor_ids); set but empty returns
|
|
788
|
+
* them to the default, every building temperature sensor filed in the room in filing
|
|
789
|
+
* order.
|
|
790
|
+
*
|
|
791
|
+
* @generated from message kusinta.iot.webrtc.v1.RoomSensors
|
|
792
|
+
*/
|
|
793
|
+
export declare type RoomSensors = Message<"kusinta.iot.webrtc.v1.RoomSensors"> & {
|
|
794
|
+
/**
|
|
795
|
+
* @generated from field: repeated kusinta.iot.identity.v1.DeviceId sensor_ids = 1;
|
|
796
|
+
*/
|
|
797
|
+
sensorIds: DeviceId[];
|
|
798
|
+
};
|
|
799
|
+
|
|
800
|
+
/**
|
|
801
|
+
* Describes the message kusinta.iot.webrtc.v1.RoomSensors.
|
|
802
|
+
* Use `create(RoomSensorsSchema)` to create a new message.
|
|
803
|
+
*/
|
|
804
|
+
export declare const RoomSensorsSchema: GenMessage<RoomSensors>;
|
|
805
|
+
|
|
806
|
+
/**
|
|
807
|
+
* A room's limits. A message of its own so that "leave the limits alone" (unset) differs
|
|
808
|
+
* from "set" — and, set, an unset bound inside it removes that bound, which a bare
|
|
809
|
+
* optional on the request could not say.
|
|
810
|
+
*
|
|
811
|
+
* @generated from message kusinta.iot.webrtc.v1.RoomLimits
|
|
812
|
+
*/
|
|
813
|
+
export declare type RoomLimits = Message<"kusinta.iot.webrtc.v1.RoomLimits"> & {
|
|
814
|
+
/**
|
|
815
|
+
* @generated from field: optional sint32 min_centidegrees = 1;
|
|
816
|
+
*/
|
|
817
|
+
minCentidegrees?: number | undefined;
|
|
818
|
+
|
|
819
|
+
/**
|
|
820
|
+
* @generated from field: optional sint32 max_centidegrees = 2;
|
|
821
|
+
*/
|
|
822
|
+
maxCentidegrees?: number | undefined;
|
|
823
|
+
};
|
|
824
|
+
|
|
825
|
+
/**
|
|
826
|
+
* Describes the message kusinta.iot.webrtc.v1.RoomLimits.
|
|
827
|
+
* Use `create(RoomLimitsSchema)` to create a new message.
|
|
828
|
+
*/
|
|
829
|
+
export declare const RoomLimitsSchema: GenMessage<RoomLimits>;
|
|
830
|
+
|
|
831
|
+
/**
|
|
832
|
+
* One bound that moves alone, for the same reason as RoomLimits: unset leaves the bound as it
|
|
833
|
+
* is; set, an unset centidegrees removes it.
|
|
834
|
+
*
|
|
835
|
+
* @generated from message kusinta.iot.webrtc.v1.RoomLimitValue
|
|
836
|
+
*/
|
|
837
|
+
export declare type RoomLimitValue = Message<"kusinta.iot.webrtc.v1.RoomLimitValue"> & {
|
|
838
|
+
/**
|
|
839
|
+
* @generated from field: optional sint32 centidegrees = 1;
|
|
840
|
+
*/
|
|
841
|
+
centidegrees?: number | undefined;
|
|
842
|
+
};
|
|
843
|
+
|
|
844
|
+
/**
|
|
845
|
+
* Describes the message kusinta.iot.webrtc.v1.RoomLimitValue.
|
|
846
|
+
* Use `create(RoomLimitValueSchema)` to create a new message.
|
|
847
|
+
*/
|
|
848
|
+
export declare const RoomLimitValueSchema: GenMessage<RoomLimitValue>;
|
|
849
|
+
|
|
850
|
+
/**
|
|
851
|
+
* Configures what a room obeys: its outer limits, its sensors, and whether a change made by
|
|
852
|
+
* hand at one of its devices counts. Authorized as directing, because this decides what
|
|
853
|
+
* everybody in the room can do, and each part by its own deciders:
|
|
854
|
+
* * the outer limits — limits, away_min, move_in_target (climate.v1.OuterRoomLimits) — the
|
|
855
|
+
* property owner or a gateway administrator who reaches the room, or an installer under an
|
|
856
|
+
* active commissioning grant covering it (commissioning.v1, GRANTS), in a home or not. A
|
|
857
|
+
* household's own limits are SetInnerRoomLimits;
|
|
858
|
+
* * sensors — ROLE_PROPERTY_OWNER or a filing role. It orders only the building's own
|
|
859
|
+
* sensors (see RoomClimate.sensor_ids);
|
|
860
|
+
* * lock_device_controls — in a home, its residents', who may send this request with nothing
|
|
861
|
+
* else set, and in an empty home the property owner's and the gateway administrators' who
|
|
862
|
+
* reach it (household.proto, EMPTY HOME); outside homes, ROLE_PROPERTY_OWNER's or a filing
|
|
863
|
+
* role's, as the sensors are.
|
|
864
|
+
* A request that sets anything its caller may not is refused whole as NOT_ENTITLED, so nothing
|
|
865
|
+
* of it applies, with metadata {"field": the first such part, by its proto field name —
|
|
866
|
+
* "limits", "away_min", "move_in_target", "sensors" or "lock_device_controls"}, which tells the
|
|
867
|
+
* caller only what they may not set. Rollout note: outer limits were once a filing role's; a
|
|
868
|
+
* filing role that is neither ROLE_PROPERTY_OWNER nor ROLE_GATEWAY_ADMIN, without a grant, is
|
|
869
|
+
* now refused them, so an app offers the outer limits to those roles alone and sends sensors on
|
|
870
|
+
* their own.
|
|
871
|
+
*
|
|
872
|
+
* Each outer bound the request changes is stamped with the caller's role and the time
|
|
873
|
+
* (climate.v1.OuterLimit); one set to the value it has keeps its stamp. As the outer limits
|
|
874
|
+
* will stand, min above max, away_min above min or max, or move_in_target outside [min, max]
|
|
875
|
+
* where those are set, is refused as INVALID_REQUEST with metadata {"reason": "limits_order"}.
|
|
876
|
+
* A min changed to below the gateway's public-health threshold — its own setting, which no
|
|
877
|
+
* operation in this contract changes; none while unset — needs accept_below_threshold, and is
|
|
878
|
+
* refused without it as FAILED_PRECONDITION with metadata {"reason": "below_threshold",
|
|
879
|
+
* "threshold_centidegrees": the threshold}. Nothing in the answer to the outer limits depends
|
|
880
|
+
* on the home's state — its targets, inner limits, modes, or who lives there — so setting them
|
|
881
|
+
* tells the caller nothing of it; what they clamp is told to the household alone
|
|
882
|
+
* (RoomClimate.outer_limit_clamp). Only the lock in the same request is decided by whether the
|
|
883
|
+
* home is empty, as EMPTY HOME says.
|
|
884
|
+
*
|
|
885
|
+
* Each field moves alone, as on UpdateSpace: unset leaves it as it is.
|
|
886
|
+
*
|
|
887
|
+
* @generated from message kusinta.iot.webrtc.v1.ConfigureRoomClimate
|
|
888
|
+
*/
|
|
889
|
+
export declare type ConfigureRoomClimate = Message<"kusinta.iot.webrtc.v1.ConfigureRoomClimate"> & {
|
|
890
|
+
/**
|
|
891
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId room_id = 1;
|
|
892
|
+
*/
|
|
893
|
+
roomId?: SpaceId | undefined;
|
|
894
|
+
|
|
895
|
+
/**
|
|
896
|
+
* The outer limits' min and max (climate.v1.OuterRoomLimits); replaces both bounds, see
|
|
897
|
+
* RoomLimits.
|
|
898
|
+
*
|
|
899
|
+
* @generated from field: kusinta.iot.webrtc.v1.RoomLimits limits = 2;
|
|
900
|
+
*/
|
|
901
|
+
limits?: RoomLimits | undefined;
|
|
902
|
+
|
|
903
|
+
/**
|
|
904
|
+
* Only the building's sensors filed in this room; any other — including a sensor a
|
|
905
|
+
* resident owns — is refused, the same way whether or not it exists.
|
|
906
|
+
*
|
|
907
|
+
* @generated from field: kusinta.iot.webrtc.v1.RoomSensors sensors = 3;
|
|
908
|
+
*/
|
|
909
|
+
sensors?: RoomSensors | undefined;
|
|
910
|
+
|
|
911
|
+
/**
|
|
912
|
+
* @generated from field: optional bool lock_device_controls = 4;
|
|
913
|
+
*/
|
|
914
|
+
lockDeviceControls?: boolean | undefined;
|
|
915
|
+
|
|
916
|
+
/**
|
|
917
|
+
* The outer limits' away minimum and move-in target, each alone; see RoomLimitValue.
|
|
918
|
+
*
|
|
919
|
+
* @generated from field: kusinta.iot.webrtc.v1.RoomLimitValue away_min = 5;
|
|
920
|
+
*/
|
|
921
|
+
awayMin?: RoomLimitValue | undefined;
|
|
922
|
+
|
|
923
|
+
/**
|
|
924
|
+
* @generated from field: kusinta.iot.webrtc.v1.RoomLimitValue move_in_target = 6;
|
|
925
|
+
*/
|
|
926
|
+
moveInTarget?: RoomLimitValue | undefined;
|
|
927
|
+
|
|
928
|
+
/**
|
|
929
|
+
* The caller accepts a min below the public-health threshold, recorded with the bound
|
|
930
|
+
* (OuterRoomLimits.min_accepted_threshold_centidegrees). Ignored on a request that sets no
|
|
931
|
+
* such min.
|
|
932
|
+
*
|
|
933
|
+
* @generated from field: bool accept_below_threshold = 7;
|
|
934
|
+
*/
|
|
935
|
+
acceptBelowThreshold: boolean;
|
|
936
|
+
};
|
|
937
|
+
|
|
938
|
+
/**
|
|
939
|
+
* Describes the message kusinta.iot.webrtc.v1.ConfigureRoomClimate.
|
|
940
|
+
* Use `create(ConfigureRoomClimateSchema)` to create a new message.
|
|
941
|
+
*/
|
|
942
|
+
export declare const ConfigureRoomClimateSchema: GenMessage<ConfigureRoomClimate>;
|
|
943
|
+
|
|
944
|
+
/**
|
|
945
|
+
* Sets a room's inner limits (climate.v1.InnerRoomLimits). Answered with ManagementAck. A
|
|
946
|
+
* household admin of the home the room is in only (household.proto, HOUSEHOLD ADMIN); anyone
|
|
947
|
+
* else, and a room in no home, is refused as NOT_ENTITLED — never covered by a commissioning
|
|
948
|
+
* grant. min above max is refused as INVALID_REQUEST with metadata {"reason": "limits_order"}.
|
|
949
|
+
* Bounds outside the outer limits are accepted as they are (climate.v1.OuterRoomLimits, HELD).
|
|
950
|
+
* The room's target is clamped into the new limits.
|
|
951
|
+
*
|
|
952
|
+
* @generated from message kusinta.iot.webrtc.v1.SetInnerRoomLimits
|
|
953
|
+
*/
|
|
954
|
+
export declare type SetInnerRoomLimits = Message<"kusinta.iot.webrtc.v1.SetInnerRoomLimits"> & {
|
|
955
|
+
/**
|
|
956
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId room_id = 1;
|
|
957
|
+
*/
|
|
958
|
+
roomId?: SpaceId | undefined;
|
|
959
|
+
|
|
960
|
+
/**
|
|
961
|
+
* Replaces both bounds: a bound unset in it, or limits unset, removes them.
|
|
962
|
+
*
|
|
963
|
+
* @generated from field: kusinta.iot.climate.v1.InnerRoomLimits limits = 2;
|
|
964
|
+
*/
|
|
965
|
+
limits?: InnerRoomLimits | undefined;
|
|
966
|
+
};
|
|
967
|
+
|
|
968
|
+
/**
|
|
969
|
+
* Describes the message kusinta.iot.webrtc.v1.SetInnerRoomLimits.
|
|
970
|
+
* Use `create(SetInnerRoomLimitsSchema)` to create a new message.
|
|
971
|
+
*/
|
|
972
|
+
export declare const SetInnerRoomLimitsSchema: GenMessage<SetInnerRoomLimits>;
|
|
973
|
+
|
|
974
|
+
/**
|
|
975
|
+
* Switches a mode on a space on, or off with kind UNSPECIFIED. WRITE on the space.
|
|
976
|
+
* Switching one on needs setback_centidegrees; a mode with nothing to set back to is
|
|
977
|
+
* refused. Switching one on is refused on a room inside an apartment, whose rooms follow
|
|
978
|
+
* the apartment's mode alone; such a room carries none (see climate.v1.ClimateMode), and
|
|
979
|
+
* switching one off there is accepted and does nothing — for those who may switch modes in
|
|
980
|
+
* that home at all, which is checked first: anyone else is refused as NOT_ENTITLED.
|
|
981
|
+
*
|
|
982
|
+
* In a home, only its residents may switch one on or off: whether a home stands empty is
|
|
983
|
+
* theirs to say. A caller who reaches it as service is refused as NOT_ENTITLED — except
|
|
984
|
+
* that, while the home is empty (household.proto, EMPTY HOME), ROLE_PROPERTY_OWNER or
|
|
985
|
+
* ROLE_GATEWAY_ADMIN may switch one on, and switch off one that is on, so that no mode
|
|
986
|
+
* outlives everyone who could end it. Any other switch-off from them — in a home that is not
|
|
987
|
+
* empty, or with no mode on — is accepted and does nothing, so the answer tells them nothing of
|
|
988
|
+
* whether a mode was on.
|
|
989
|
+
*
|
|
990
|
+
* @generated from message kusinta.iot.webrtc.v1.SetClimateMode
|
|
991
|
+
*/
|
|
992
|
+
export declare type SetClimateMode = Message<"kusinta.iot.webrtc.v1.SetClimateMode"> & {
|
|
993
|
+
/**
|
|
994
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
|
|
995
|
+
*/
|
|
996
|
+
spaceId?: SpaceId | undefined;
|
|
997
|
+
|
|
998
|
+
/**
|
|
999
|
+
* @generated from field: kusinta.iot.climate.v1.ClimateModeKind kind = 2;
|
|
1000
|
+
*/
|
|
1001
|
+
kind: ClimateModeKind;
|
|
1002
|
+
|
|
1003
|
+
/**
|
|
1004
|
+
* @generated from field: optional sint32 setback_centidegrees = 3;
|
|
1005
|
+
*/
|
|
1006
|
+
setbackCentidegrees?: number | undefined;
|
|
1007
|
+
|
|
1008
|
+
/**
|
|
1009
|
+
* HOLIDAY only; both required there. Refused on AWAY.
|
|
1010
|
+
*
|
|
1011
|
+
* @generated from field: google.protobuf.Timestamp starts_at = 4;
|
|
1012
|
+
*/
|
|
1013
|
+
startsAt?: Timestamp | undefined;
|
|
1014
|
+
|
|
1015
|
+
/**
|
|
1016
|
+
* @generated from field: google.protobuf.Timestamp ends_at = 5;
|
|
1017
|
+
*/
|
|
1018
|
+
endsAt?: Timestamp | undefined;
|
|
1019
|
+
};
|
|
1020
|
+
|
|
1021
|
+
/**
|
|
1022
|
+
* Describes the message kusinta.iot.webrtc.v1.SetClimateMode.
|
|
1023
|
+
* Use `create(SetClimateModeSchema)` to create a new message.
|
|
1024
|
+
*/
|
|
1025
|
+
export declare const SetClimateModeSchema: GenMessage<SetClimateMode>;
|
|
1026
|
+
|
|
1027
|
+
/**
|
|
1028
|
+
* Lists the room climates and modes a caller may see. Unset root_space_id lists every
|
|
1029
|
+
* one the caller can reach; naming a space narrows it to that space and those below.
|
|
1030
|
+
*
|
|
1031
|
+
* A caller who reaches a room inside an apartment as service gets it with
|
|
1032
|
+
* RoomClimate.state_withheld set — what is new as it happens, what is gone at once — and
|
|
1033
|
+
* gets no ClimateMode set on that apartment or its rooms; save the property owner and the
|
|
1034
|
+
* gateway administrators while the home is empty, who get both as for a space outside homes
|
|
1035
|
+
* (household.proto, EMPTY HOME).
|
|
1036
|
+
*
|
|
1037
|
+
* @generated from message kusinta.iot.webrtc.v1.ListRoomClimates
|
|
1038
|
+
*/
|
|
1039
|
+
export declare type ListRoomClimates = Message<"kusinta.iot.webrtc.v1.ListRoomClimates"> & {
|
|
1040
|
+
/**
|
|
1041
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId root_space_id = 1;
|
|
1042
|
+
*/
|
|
1043
|
+
rootSpaceId?: SpaceId | undefined;
|
|
1044
|
+
};
|
|
1045
|
+
|
|
1046
|
+
/**
|
|
1047
|
+
* Describes the message kusinta.iot.webrtc.v1.ListRoomClimates.
|
|
1048
|
+
* Use `create(ListRoomClimatesSchema)` to create a new message.
|
|
1049
|
+
*/
|
|
1050
|
+
export declare const ListRoomClimatesSchema: GenMessage<ListRoomClimates>;
|
|
1051
|
+
|
|
1052
|
+
/**
|
|
1053
|
+
* Reads a room's history at one resolution, answered with a climate.v1.RoomHistory. Needs
|
|
1054
|
+
* READ on the room.
|
|
1055
|
+
*
|
|
1056
|
+
* The range is half-open: a bucket is returned when from_time <= at < to_time, so
|
|
1057
|
+
* back-to-back windows neither repeat nor skip a bucket. Unset to_time means now; unset
|
|
1058
|
+
* from_time means RoomHistory.kept_from. Both are clamped to [kept_from, now]. A long range is
|
|
1059
|
+
* answered newest first, in capped pages (RoomHistory.covered_from).
|
|
1060
|
+
*
|
|
1061
|
+
* A room in a home is readable by its residents only, and only from the start of their
|
|
1062
|
+
* current residency (see access.v1.MembershipRelation). A caller who reaches it as service is
|
|
1063
|
+
* refused as NOT_ENTITLED; one who reaches the apartment itself has
|
|
1064
|
+
* GetApartmentClimateSummary instead.
|
|
1065
|
+
*
|
|
1066
|
+
* @generated from message kusinta.iot.webrtc.v1.GetRoomHistory
|
|
1067
|
+
*/
|
|
1068
|
+
export declare type GetRoomHistory = Message<"kusinta.iot.webrtc.v1.GetRoomHistory"> & {
|
|
1069
|
+
/**
|
|
1070
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId room_id = 1;
|
|
1071
|
+
*/
|
|
1072
|
+
roomId?: SpaceId | undefined;
|
|
1073
|
+
|
|
1074
|
+
/**
|
|
1075
|
+
* @generated from field: google.protobuf.Timestamp from_time = 2;
|
|
1076
|
+
*/
|
|
1077
|
+
fromTime?: Timestamp | undefined;
|
|
1078
|
+
|
|
1079
|
+
/**
|
|
1080
|
+
* @generated from field: google.protobuf.Timestamp to_time = 3;
|
|
1081
|
+
*/
|
|
1082
|
+
toTime?: Timestamp | undefined;
|
|
1083
|
+
|
|
1084
|
+
/**
|
|
1085
|
+
* The resolution wanted. Unset, or one the gateway does not give, and the gateway chooses
|
|
1086
|
+
* from the request and the resolutions alone, never from what it holds: the finest
|
|
1087
|
+
* resolution it gives that it keeps for long enough to reach back to from_time, and whose
|
|
1088
|
+
* bucket length fits the span from from_time to to_time (unset: now) into no more buckets
|
|
1089
|
+
* than one answer may give samples (RoomHistory.covered_from); where none does, or from_time
|
|
1090
|
+
* is unset, the coarsest. How long each is kept is the gateway's, the same for every room and
|
|
1091
|
+
* recipient, so the choice tells nothing of a room or of who may read it.
|
|
1092
|
+
*
|
|
1093
|
+
* @generated from field: kusinta.iot.climate.v1.RoomHistoryResolution resolution = 4;
|
|
1094
|
+
*/
|
|
1095
|
+
resolution: RoomHistoryResolution;
|
|
1096
|
+
};
|
|
1097
|
+
|
|
1098
|
+
/**
|
|
1099
|
+
* Describes the message kusinta.iot.webrtc.v1.GetRoomHistory.
|
|
1100
|
+
* Use `create(GetRoomHistorySchema)` to create a new message.
|
|
1101
|
+
*/
|
|
1102
|
+
export declare const GetRoomHistorySchema: GenMessage<GetRoomHistory>;
|
|
1103
|
+
|
|
1104
|
+
/**
|
|
1105
|
+
* What the parties who do not live in a private space learn of it — the answer to a
|
|
1106
|
+
* resident asking who can see what in their home, in reply to GetPrivacyDisclosure.
|
|
1107
|
+
*
|
|
1108
|
+
* It states the policy, the kinds of party it applies to now and the people counted under
|
|
1109
|
+
* each (ServiceParty.names): a resident learns which technicians can see the battery of
|
|
1110
|
+
* their radiator valve. The names say who has reach, never where anyone lives.
|
|
1111
|
+
*
|
|
1112
|
+
* @generated from message kusinta.iot.webrtc.v1.PrivacyDisclosure
|
|
1113
|
+
*/
|
|
1114
|
+
export declare type PrivacyDisclosure = Message<"kusinta.iot.webrtc.v1.PrivacyDisclosure"> & {
|
|
1115
|
+
/**
|
|
1116
|
+
* An apartment, or a room in one.
|
|
1117
|
+
*
|
|
1118
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
|
|
1119
|
+
*/
|
|
1120
|
+
spaceId?: SpaceId | undefined;
|
|
1121
|
+
|
|
1122
|
+
/**
|
|
1123
|
+
* The kinds of party who see this space, or any part of it, as service now — or would
|
|
1124
|
+
* through another membership, were they not its residents — each role once, with what
|
|
1125
|
+
* that role brings here. Each party is listed under every role it holds other than
|
|
1126
|
+
* ROLE_RESIDENT, and sees what its entries say together; one with no other role, or whose
|
|
1127
|
+
* role the gateway has not yet learnt, counts as ROLE_UNSPECIFIED. ROLE_GATEWAY_ADMIN is
|
|
1128
|
+
* always listed, and ROLE_PROPERTY_OWNER whenever anyone holds it, wherever they are
|
|
1129
|
+
* filed: both may file themselves on the home. So the list reads the same whether or not
|
|
1130
|
+
* anyone lives in the home, and never understates who has reach or what they see. Devices a
|
|
1131
|
+
* resident owns are not shown to service at all.
|
|
1132
|
+
*
|
|
1133
|
+
* @generated from field: repeated kusinta.iot.webrtc.v1.ServiceParty service_parties = 5;
|
|
1134
|
+
*/
|
|
1135
|
+
serviceParties: ServiceParty[];
|
|
1136
|
+
|
|
1137
|
+
/**
|
|
1138
|
+
* How finely the space's climate is summarised for service, as means over periods of
|
|
1139
|
+
* this length (climate.v1.ApartmentClimateSummary). UNSPECIFIED: no summary is given.
|
|
1140
|
+
* The gateway's own setting, WEEK unless it is configured otherwise; no operation in this
|
|
1141
|
+
* contract changes it. A change applies to periods that open after it: service is given
|
|
1142
|
+
* no period that opened before the last change. A household's clear of its climate history
|
|
1143
|
+
* (ClearClimateHistory) likewise leaves service no period from before the clear, and none
|
|
1144
|
+
* until the first period that starts at or after it has closed.
|
|
1145
|
+
*
|
|
1146
|
+
* @generated from field: kusinta.iot.climate.v1.ClimateSummaryPeriod climate_summary_period = 4;
|
|
1147
|
+
*/
|
|
1148
|
+
climateSummaryPeriod: ClimateSummaryPeriod;
|
|
1149
|
+
|
|
1150
|
+
/**
|
|
1151
|
+
* The name of the organisation that owns the gateway, and so the property, as the vouched
|
|
1152
|
+
* set gives it (signaling.v1.VouchedAdministrators.organisation_name); empty while the
|
|
1153
|
+
* gateway holds no vouched set. Never its organisation number. SetOwnerOrganisation, which
|
|
1154
|
+
* once set it, is superseded.
|
|
1155
|
+
*
|
|
1156
|
+
* @generated from field: string owner_organisation_name = 6;
|
|
1157
|
+
*/
|
|
1158
|
+
ownerOrganisationName: string;
|
|
1159
|
+
|
|
1160
|
+
/**
|
|
1161
|
+
* Set when ServiceParty.names are not given to this caller, so that empty lists are not
|
|
1162
|
+
* read as nobody being named. Names are given to the home's own residents and to a
|
|
1163
|
+
* caller holding ROLE_GATEWAY_ADMIN or ROLE_PROPERTY_OWNER, and withheld from anyone
|
|
1164
|
+
* else: a technician who reaches the home learns the kinds of party, not who they are.
|
|
1165
|
+
*
|
|
1166
|
+
* @generated from field: bool names_withheld = 7;
|
|
1167
|
+
*/
|
|
1168
|
+
namesWithheld: boolean;
|
|
1169
|
+
|
|
1170
|
+
/**
|
|
1171
|
+
* Each staff appointment (household.proto, STAFF APPOINTMENT) of a member who lives in this
|
|
1172
|
+
* home now, made during their current residency — the one that began at an appointment
|
|
1173
|
+
* invite's redeem included — oldest first: whoever joins the household later learns who put
|
|
1174
|
+
* its admins there. Given to the home's residents only, and so never to a caller who sees it
|
|
1175
|
+
* as service: a client shows it to residents alone.
|
|
1176
|
+
*
|
|
1177
|
+
* @generated from field: repeated kusinta.iot.webrtc.v1.StaffAppointment staff_appointments = 8;
|
|
1178
|
+
*/
|
|
1179
|
+
staffAppointments: StaffAppointment[];
|
|
1180
|
+
|
|
1181
|
+
/**
|
|
1182
|
+
* Each commissioning grant on this home that was granted since it was last wiped, oldest
|
|
1183
|
+
* first, active ones included, and those the property owner or a gateway administrator
|
|
1184
|
+
* granted while it stood empty among them (commissioning.v1, GRANTS): who held commissioning
|
|
1185
|
+
* access to the home, and when. Given to the home's residents only, as staff_appointments is.
|
|
1186
|
+
*
|
|
1187
|
+
* @generated from field: repeated kusinta.iot.commissioning.v1.CommissioningGrantRecord commissioning_grants = 9;
|
|
1188
|
+
*/
|
|
1189
|
+
commissioningGrants: CommissioningGrantRecord[];
|
|
1190
|
+
};
|
|
1191
|
+
|
|
1192
|
+
/**
|
|
1193
|
+
* Describes the message kusinta.iot.webrtc.v1.PrivacyDisclosure.
|
|
1194
|
+
* Use `create(PrivacyDisclosureSchema)` to create a new message.
|
|
1195
|
+
*/
|
|
1196
|
+
export declare const PrivacyDisclosureSchema: GenMessage<PrivacyDisclosure>;
|
|
1197
|
+
|
|
1198
|
+
/**
|
|
1199
|
+
* One kind of party with service reach of a home, and what it sees there. Every service
|
|
1200
|
+
* party sees the same kinds of thing of the part of the home it reaches — a whole
|
|
1201
|
+
* ServiceStatus, nothing withheld from it — so signals differ between parties only in
|
|
1202
|
+
* RESIDENTS. How much of the home that part is, a room or all of it, the disclosure does
|
|
1203
|
+
* not say.
|
|
1204
|
+
*
|
|
1205
|
+
* @generated from message kusinta.iot.webrtc.v1.ServiceParty
|
|
1206
|
+
*/
|
|
1207
|
+
export declare type ServiceParty = Message<"kusinta.iot.webrtc.v1.ServiceParty"> & {
|
|
1208
|
+
/**
|
|
1209
|
+
* @generated from field: kusinta.iot.access.v1.Role role = 1;
|
|
1210
|
+
*/
|
|
1211
|
+
role: Role;
|
|
1212
|
+
|
|
1213
|
+
/**
|
|
1214
|
+
* @generated from field: repeated kusinta.iot.access.v1.ServiceSignal signals = 2;
|
|
1215
|
+
*/
|
|
1216
|
+
signals: ServiceSignal[];
|
|
1217
|
+
|
|
1218
|
+
/**
|
|
1219
|
+
* Each person counted under this role, by the name they gave their account
|
|
1220
|
+
* (AppTokenClaims.name), once each: everyone holding ROLE_GATEWAY_ADMIN or
|
|
1221
|
+
* ROLE_PROPERTY_OWNER, every vouched administrator included whether or not the gateway has
|
|
1222
|
+
* seen their token, and everyone else counted here by a SERVICE membership. A person counted
|
|
1223
|
+
* under several roles is named under each. An empty string stands for a person whose name
|
|
1224
|
+
* the gateway has not learnt, so the list is as long as the number of people. Self-chosen,
|
|
1225
|
+
* so the app shows it as the name they gave rather than as a verified identity. Empty for
|
|
1226
|
+
* every party when PrivacyDisclosure.names_withheld is set.
|
|
1227
|
+
*
|
|
1228
|
+
* @generated from field: repeated string names = 3;
|
|
1229
|
+
*/
|
|
1230
|
+
names: string[];
|
|
1231
|
+
};
|
|
1232
|
+
|
|
1233
|
+
/**
|
|
1234
|
+
* Describes the message kusinta.iot.webrtc.v1.ServiceParty.
|
|
1235
|
+
* Use `create(ServicePartySchema)` to create a new message.
|
|
1236
|
+
*/
|
|
1237
|
+
export declare const ServicePartySchema: GenMessage<ServiceParty>;
|
|
1238
|
+
|
|
1239
|
+
/**
|
|
1240
|
+
* Asks what the parties who do not live in a space learn of it, answered with a
|
|
1241
|
+
* PrivacyDisclosure. For an apartment or a room in one, and refused on any other
|
|
1242
|
+
* space. Needs READ on the space.
|
|
1243
|
+
*
|
|
1244
|
+
* @generated from message kusinta.iot.webrtc.v1.GetPrivacyDisclosure
|
|
1245
|
+
*/
|
|
1246
|
+
export declare type GetPrivacyDisclosure = Message<"kusinta.iot.webrtc.v1.GetPrivacyDisclosure"> & {
|
|
1247
|
+
/**
|
|
1248
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
|
|
1249
|
+
*/
|
|
1250
|
+
spaceId?: SpaceId | undefined;
|
|
1251
|
+
};
|
|
1252
|
+
|
|
1253
|
+
/**
|
|
1254
|
+
* Describes the message kusinta.iot.webrtc.v1.GetPrivacyDisclosure.
|
|
1255
|
+
* Use `create(GetPrivacyDisclosureSchema)` to create a new message.
|
|
1256
|
+
*/
|
|
1257
|
+
export declare const GetPrivacyDisclosureSchema: GenMessage<GetPrivacyDisclosure>;
|
|
1258
|
+
|
|
1259
|
+
/**
|
|
1260
|
+
* Reads an apartment's climate as means over whole periods, answered with a
|
|
1261
|
+
* climate.v1.ApartmentClimateSummary. Needs READ on the apartment itself. Refused on a
|
|
1262
|
+
* space that is not an apartment, and while the building's time zone (Space.time_zone) is
|
|
1263
|
+
* unknown, since periods are cut at its midnights.
|
|
1264
|
+
*
|
|
1265
|
+
* The range is half-open over the periods' starts: a period is returned when from_time <=
|
|
1266
|
+
* starts_at < to_time. Unset from_time means kept_from; unset to_time means now. Both are
|
|
1267
|
+
* clamped to [kept_from, the start of the period running now — or now, if none is] (see
|
|
1268
|
+
* ApartmentClimateSummary).
|
|
1269
|
+
*
|
|
1270
|
+
* @generated from message kusinta.iot.webrtc.v1.GetApartmentClimateSummary
|
|
1271
|
+
*/
|
|
1272
|
+
export declare type GetApartmentClimateSummary = Message<"kusinta.iot.webrtc.v1.GetApartmentClimateSummary"> & {
|
|
1273
|
+
/**
|
|
1274
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId apartment_id = 1;
|
|
1275
|
+
*/
|
|
1276
|
+
apartmentId?: SpaceId | undefined;
|
|
1277
|
+
|
|
1278
|
+
/**
|
|
1279
|
+
* Unset asks for the period the apartment's privacy disclosure names
|
|
1280
|
+
* (PrivacyDisclosure.climate_summary_period), or weeks when it names none. Anyone but the
|
|
1281
|
+
* apartment's residents may ask for that period only, and is refused as NOT_ENTITLED for
|
|
1282
|
+
* any other or when it names none. Its residents may ask for any, and are given only
|
|
1283
|
+
* periods that began in their current residency.
|
|
1284
|
+
*
|
|
1285
|
+
* @generated from field: kusinta.iot.climate.v1.ClimateSummaryPeriod period = 2;
|
|
1286
|
+
*/
|
|
1287
|
+
period: ClimateSummaryPeriod;
|
|
1288
|
+
|
|
1289
|
+
/**
|
|
1290
|
+
* @generated from field: google.protobuf.Timestamp from_time = 3;
|
|
1291
|
+
*/
|
|
1292
|
+
fromTime?: Timestamp | undefined;
|
|
1293
|
+
|
|
1294
|
+
/**
|
|
1295
|
+
* @generated from field: google.protobuf.Timestamp to_time = 4;
|
|
1296
|
+
*/
|
|
1297
|
+
toTime?: Timestamp | undefined;
|
|
1298
|
+
};
|
|
1299
|
+
|
|
1300
|
+
/**
|
|
1301
|
+
* Describes the message kusinta.iot.webrtc.v1.GetApartmentClimateSummary.
|
|
1302
|
+
* Use `create(GetApartmentClimateSummarySchema)` to create a new message.
|
|
1303
|
+
*/
|
|
1304
|
+
export declare const GetApartmentClimateSummarySchema: GenMessage<GetApartmentClimateSummary>;
|
|
1305
|
+
|
|
1306
|
+
/**
|
|
1307
|
+
* Asks the gateway to have a connector re-initialise its backend connection: reconnect to
|
|
1308
|
+
* its radio central or network server. Meant to be offered while a
|
|
1309
|
+
* reporting.v1.PROBLEM_KIND_CONNECTOR_ERROR is open for the connector — its
|
|
1310
|
+
* ConnectorDescriptor.backend_health is FAILING — and only for a connector listed in
|
|
1311
|
+
* ConnectorsAnnounced. A request for a connector that is not listed is refused, as
|
|
1312
|
+
* CONNECTOR_OFFLINE or UNKNOWN_CONNECTOR below. For a listed one it is accepted whatever its
|
|
1313
|
+
* health, since re-initialising a healthy backend is harmless.
|
|
1314
|
+
*
|
|
1315
|
+
* Authorized against the caller's role alone, as StartPairing is: a connector is not a
|
|
1316
|
+
* target the caller reaches the way a space is. ROLE_TECHNICIAN and ROLE_GATEWAY_ADMIN may
|
|
1317
|
+
* ask; anyone else is refused as NOT_ENTITLED, before the connector is looked up, so the
|
|
1318
|
+
* refusal says nothing of which connectors exist.
|
|
1319
|
+
*
|
|
1320
|
+
* The gateway forwards it as connector.v1.ReinitializeBackend and answers once the
|
|
1321
|
+
* connector has: with ManagementAck when the attempt was made. That says the attempt
|
|
1322
|
+
* finished, not that it worked. Whether it worked is the connector's backend health, and
|
|
1323
|
+
* when that changed the gateway pushes it in ConnectorsAnnounced before the ack. One
|
|
1324
|
+
* request at a time per connector.
|
|
1325
|
+
*
|
|
1326
|
+
* So a failure found only by attempting — credentials the backend rejects, a backend that
|
|
1327
|
+
* does not answer — is not a refusal. It arrives as a ManagementAck, with the backend
|
|
1328
|
+
* health it left (FAILING, e.g. with AUTH_FAILED, UNREACHABLE or BACKEND_ERROR) already
|
|
1329
|
+
* pushed: after the ack, the app reads ConnectorDescriptor.backend_health for the outcome,
|
|
1330
|
+
* and a FAILING health there means the reconnect did not help. The app handles any reason
|
|
1331
|
+
* there, one its schema does not know included. No push precedes the ack when the attempt
|
|
1332
|
+
* left health as it was; the descriptor the app holds is then still the outcome.
|
|
1333
|
+
*
|
|
1334
|
+
* A refusal is a GatewayError whose metadata "reason" says which, as CommandError.metadata
|
|
1335
|
+
* describes, and whose "detail" is a sentence the app may show. The app branches on
|
|
1336
|
+
* "reason" for this operation; the code is only the fallback for a reason it does not know,
|
|
1337
|
+
* since GatewayErrorCode is too coarse to say what to do here. The role refusal above is
|
|
1338
|
+
* the code NOT_ENTITLED alone, with no "reason"; the reasons are for a caller who may ask:
|
|
1339
|
+
* "UNKNOWN_CONNECTOR" UNAVAILABLE. The gateway does not track a connector by that id:
|
|
1340
|
+
* it never had one, or has stopped tracking it. Not a client bug:
|
|
1341
|
+
* the list the app holds may be stale.
|
|
1342
|
+
* "CONNECTOR_OFFLINE" UNAVAILABLE. A connector the gateway tracks, whose stream to the
|
|
1343
|
+
* gateway is down now, before or while the request was
|
|
1344
|
+
* outstanding; that is CONNECTOR_OFFLINE, and a reconnect of its
|
|
1345
|
+
* backend cannot help it.
|
|
1346
|
+
* "NOT_SUPPORTED" FAILED_PRECONDITION. The connector does not declare
|
|
1347
|
+
* ConnectorDescriptor.supports_backend_reinitialize, or declared it
|
|
1348
|
+
* and answered that it has nothing to re-initialise. Not a client
|
|
1349
|
+
* bug, and not worth retrying as is.
|
|
1350
|
+
* "ALREADY_IN_PROGRESS" UNAVAILABLE. A reconnect of this connector is outstanding, from
|
|
1351
|
+
* this caller or another. It ends within 60 seconds of being
|
|
1352
|
+
* asked, answered or timed out; retry after that. Only the caller
|
|
1353
|
+
* who asked is answered, but a change of health it causes reaches
|
|
1354
|
+
* every session in ConnectorsAnnounced.
|
|
1355
|
+
* "TIMED_OUT" UNAVAILABLE. The connector did not answer within the gateway's
|
|
1356
|
+
* deadline. The attempt may still finish, and its outcome still
|
|
1357
|
+
* arrives as backend health.
|
|
1358
|
+
* "REINITIALIZE_FAILED" The connector could not attempt it at all
|
|
1359
|
+
* (connector.v1.REINITIALIZE_OUTCOME_FAILED, or an outcome the
|
|
1360
|
+
* gateway's schema does not know, read as FAILED). The code
|
|
1361
|
+
* depends on the reason: FAILED_PRECONDITION when it is
|
|
1362
|
+
* MISCONFIGURED, which needs a person to correct the connector's
|
|
1363
|
+
* configuration before asking again can help; UNAVAILABLE for
|
|
1364
|
+
* any other — INTERNAL, UNSPECIFIED, a value the gateway does not
|
|
1365
|
+
* know — since a retry may work. Rejected credentials are never
|
|
1366
|
+
* this: they are found by attempting, and come back as an ack
|
|
1367
|
+
* (see above). metadata "backend_failure" is always set: the
|
|
1368
|
+
* common.v1.BackendFailureReason by its enum name, e.g.
|
|
1369
|
+
* "BACKEND_FAILURE_REASON_MISCONFIGURED". A reason that is
|
|
1370
|
+
* UNSPECIFIED, or a value the gateway's schema does not know, is
|
|
1371
|
+
* sent as "BACKEND_FAILURE_REASON_BACKEND_ERROR", as
|
|
1372
|
+
* BackendFailureReason has it; an app reading a name its own
|
|
1373
|
+
* schema does not know treats it as BACKEND_ERROR too.
|
|
1374
|
+
* The connector's own detail is never in a refusal; GatewayError.message is the gateway's.
|
|
1375
|
+
*
|
|
1376
|
+
* @generated from message kusinta.iot.webrtc.v1.ReconnectConnector
|
|
1377
|
+
*/
|
|
1378
|
+
export declare type ReconnectConnector = Message<"kusinta.iot.webrtc.v1.ReconnectConnector"> & {
|
|
1379
|
+
/**
|
|
1380
|
+
* As ConnectorDescriptor.connector_id, and the id a CONNECTOR_ERROR problem's subject
|
|
1381
|
+
* names (reporting.v1.ProblemSubject.connector_id).
|
|
1382
|
+
*
|
|
1383
|
+
* @generated from field: kusinta.iot.identity.v1.ConnectorId connector_id = 1;
|
|
1384
|
+
*/
|
|
1385
|
+
connectorId?: ConnectorId | undefined;
|
|
1386
|
+
};
|
|
1387
|
+
|
|
1388
|
+
/**
|
|
1389
|
+
* Describes the message kusinta.iot.webrtc.v1.ReconnectConnector.
|
|
1390
|
+
* Use `create(ReconnectConnectorSchema)` to create a new message.
|
|
1391
|
+
*/
|
|
1392
|
+
export declare const ReconnectConnectorSchema: GenMessage<ReconnectConnector>;
|
|
1393
|
+
|
|
1394
|
+
/**
|
|
1395
|
+
* Lists the heating records (heating.v1) a caller may see under a space: unset
|
|
1396
|
+
* root_space_id lists every one the caller can reach. Answered with a HeatingLayout.
|
|
1397
|
+
*
|
|
1398
|
+
* @generated from message kusinta.iot.webrtc.v1.ListHeating
|
|
1399
|
+
*/
|
|
1400
|
+
export declare type ListHeating = Message<"kusinta.iot.webrtc.v1.ListHeating"> & {
|
|
1401
|
+
/**
|
|
1402
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId root_space_id = 1;
|
|
1403
|
+
*/
|
|
1404
|
+
rootSpaceId?: SpaceId | undefined;
|
|
1405
|
+
};
|
|
1406
|
+
|
|
1407
|
+
/**
|
|
1408
|
+
* Describes the message kusinta.iot.webrtc.v1.ListHeating.
|
|
1409
|
+
* Use `create(ListHeatingSchema)` to create a new message.
|
|
1410
|
+
*/
|
|
1411
|
+
export declare const ListHeatingSchema: GenMessage<ListHeating>;
|
|
1412
|
+
|
|
1413
|
+
/**
|
|
1414
|
+
* Creates a plant (empty plant_id) or replaces one. Answered with the HeatingRecord as
|
|
1415
|
+
* stored. The puts of heating records refuse, with metadata "reason":
|
|
1416
|
+
*
|
|
1417
|
+
* INVALID_REQUEST
|
|
1418
|
+
* "ZONE_CONTROL_ROOM" a floor zone whose control room is unset or not one of its rooms.
|
|
1419
|
+
* "ZONE_ROOMS_ACROSS_HOMES" a floor zone with rooms in two homes, or in a home and outside
|
|
1420
|
+
* homes.
|
|
1421
|
+
* "ZONE_AREA_SHARES" a floor zone with a room listed twice, a share of 0, or shares
|
|
1422
|
+
* that do not sum to 1000.
|
|
1423
|
+
* "ROOM_OUTSIDE_PLANT" a zone room outside its plant's space; metadata "room_id" names it.
|
|
1424
|
+
* "ZONE_NOT_ON_FLOOR" a floor zone on a circuit that is not a floor circuit.
|
|
1425
|
+
* "SG_READY_HALF_BOUND" one SG Ready input bound without the other.
|
|
1426
|
+
* "CONTROL_EMPTY" a plant control that binds no input.
|
|
1427
|
+
* "NO_ENDPOINT" an attribute on the Matter branch with no endpoint_id.
|
|
1428
|
+
* "WINDOWS_IN_PUT" a comfort load put with windows (see SetComfortWindows).
|
|
1429
|
+
*
|
|
1430
|
+
* FAILED_PRECONDITION
|
|
1431
|
+
* "STALE_REVISION" the record changed since the revision the request names.
|
|
1432
|
+
* "CHILDREN_INVALID" a plant or circuit put that would leave a record under it
|
|
1433
|
+
* invalid: a circuit with zones no longer a floor circuit, or a
|
|
1434
|
+
* space or plant change leaving a zone's room outside its plant.
|
|
1435
|
+
* "OUTPUT_BOUND_TWICE" an output already bound in another role or record.
|
|
1436
|
+
* "OUTPUT_NOT_LEASED" an output whose write its producer does not state as leased.
|
|
1437
|
+
* "REST_STATE" an output whose lapse value, read through closed_value, does not
|
|
1438
|
+
* leave the contact where its role rests.
|
|
1439
|
+
*
|
|
1440
|
+
* A refusal about one binding names it in metadata "field", by its proto field name:
|
|
1441
|
+
* "sg_ready_block", "sg_ready_boost", "add_on_heater_block", "meter", "output",
|
|
1442
|
+
* "supply_probe", "return_probe".
|
|
1443
|
+
*
|
|
1444
|
+
* A device or room the caller cannot reach, a parent it may not use (see heating.v1) and an
|
|
1445
|
+
* id that does not exist are all refused as NOT_ENTITLED with the same metadata, so no answer
|
|
1446
|
+
* tells one from another. HAS_CHILDREN, CHILDREN_INVALID and OUTPUT_BOUND_TWICE may count
|
|
1447
|
+
* records the caller cannot see — a zone in a home under a circuit outside it. That one bit
|
|
1448
|
+
* is accepted, as it is for the members listing; their metadata never names or counts such
|
|
1449
|
+
* a record.
|
|
1450
|
+
*
|
|
1451
|
+
* @generated from message kusinta.iot.webrtc.v1.PutHeatingPlant
|
|
1452
|
+
*/
|
|
1453
|
+
export declare type PutHeatingPlant = Message<"kusinta.iot.webrtc.v1.PutHeatingPlant"> & {
|
|
1454
|
+
/**
|
|
1455
|
+
* @generated from field: kusinta.iot.heating.v1.HeatingPlant plant = 1;
|
|
1456
|
+
*/
|
|
1457
|
+
plant?: HeatingPlant | undefined;
|
|
1458
|
+
};
|
|
1459
|
+
|
|
1460
|
+
/**
|
|
1461
|
+
* Describes the message kusinta.iot.webrtc.v1.PutHeatingPlant.
|
|
1462
|
+
* Use `create(PutHeatingPlantSchema)` to create a new message.
|
|
1463
|
+
*/
|
|
1464
|
+
export declare const PutHeatingPlantSchema: GenMessage<PutHeatingPlant>;
|
|
1465
|
+
|
|
1466
|
+
/**
|
|
1467
|
+
* Creates or replaces a circuit of a plant; as PutHeatingPlant.
|
|
1468
|
+
*
|
|
1469
|
+
* @generated from message kusinta.iot.webrtc.v1.PutHeatingCircuit
|
|
1470
|
+
*/
|
|
1471
|
+
export declare type PutHeatingCircuit = Message<"kusinta.iot.webrtc.v1.PutHeatingCircuit"> & {
|
|
1472
|
+
/**
|
|
1473
|
+
* @generated from field: kusinta.iot.heating.v1.HeatingCircuit circuit = 1;
|
|
1474
|
+
*/
|
|
1475
|
+
circuit?: HeatingCircuit | undefined;
|
|
1476
|
+
};
|
|
1477
|
+
|
|
1478
|
+
/**
|
|
1479
|
+
* Describes the message kusinta.iot.webrtc.v1.PutHeatingCircuit.
|
|
1480
|
+
* Use `create(PutHeatingCircuitSchema)` to create a new message.
|
|
1481
|
+
*/
|
|
1482
|
+
export declare const PutHeatingCircuitSchema: GenMessage<PutHeatingCircuit>;
|
|
1483
|
+
|
|
1484
|
+
/**
|
|
1485
|
+
* Creates or replaces a floor zone of a floor circuit; as PutHeatingPlant.
|
|
1486
|
+
*
|
|
1487
|
+
* While a home is empty (household.proto, EMPTY HOME), the property owner and the gateway
|
|
1488
|
+
* administrators who reach it may change which of its rooms a stored floor zone of the home
|
|
1489
|
+
* heats, and so bring a zone left uncontrolled back under control (heating.v1, UNCONTROLLED
|
|
1490
|
+
* ZONES). From them, only a stored zone's rooms and control_room_id may change, its rooms
|
|
1491
|
+
* staying in that home. Any other change from them — its output, its circuit, its name — a new
|
|
1492
|
+
* zone, and removing one (RemoveHeatingRecord) are refused as NOT_ENTITLED, the same answer as
|
|
1493
|
+
* for a zone out of reach. A caller not given the home's zones is refused NOT_ENTITLED first.
|
|
1494
|
+
* For one given the zone, a put naming a revision the zone has moved on from is refused as
|
|
1495
|
+
* FAILED_PRECONDITION "STALE_REVISION" before any of the changes above is judged, so a racing
|
|
1496
|
+
* put is told to re-read. It ends at MOVE-IN (household.proto), and the zone mapping they left
|
|
1497
|
+
* is kept: MOVE-IN's reset does not touch heating records.
|
|
1498
|
+
*
|
|
1499
|
+
* @generated from message kusinta.iot.webrtc.v1.PutFloorZone
|
|
1500
|
+
*/
|
|
1501
|
+
export declare type PutFloorZone = Message<"kusinta.iot.webrtc.v1.PutFloorZone"> & {
|
|
1502
|
+
/**
|
|
1503
|
+
* @generated from field: kusinta.iot.heating.v1.FloorZone zone = 1;
|
|
1504
|
+
*/
|
|
1505
|
+
zone?: FloorZone | undefined;
|
|
1506
|
+
};
|
|
1507
|
+
|
|
1508
|
+
/**
|
|
1509
|
+
* Describes the message kusinta.iot.webrtc.v1.PutFloorZone.
|
|
1510
|
+
* Use `create(PutFloorZoneSchema)` to create a new message.
|
|
1511
|
+
*/
|
|
1512
|
+
export declare const PutFloorZoneSchema: GenMessage<PutFloorZone>;
|
|
1513
|
+
|
|
1514
|
+
/**
|
|
1515
|
+
* Creates or replaces a comfort load's room, name and output, keeping its windows; as
|
|
1516
|
+
* PutHeatingPlant.
|
|
1517
|
+
*
|
|
1518
|
+
* @generated from message kusinta.iot.webrtc.v1.PutComfortLoad
|
|
1519
|
+
*/
|
|
1520
|
+
export declare type PutComfortLoad = Message<"kusinta.iot.webrtc.v1.PutComfortLoad"> & {
|
|
1521
|
+
/**
|
|
1522
|
+
* @generated from field: kusinta.iot.heating.v1.ComfortLoad comfort_load = 1;
|
|
1523
|
+
*/
|
|
1524
|
+
comfortLoad?: ComfortLoad | undefined;
|
|
1525
|
+
};
|
|
1526
|
+
|
|
1527
|
+
/**
|
|
1528
|
+
* Describes the message kusinta.iot.webrtc.v1.PutComfortLoad.
|
|
1529
|
+
* Use `create(PutComfortLoadSchema)` to create a new message.
|
|
1530
|
+
*/
|
|
1531
|
+
export declare const PutComfortLoadSchema: GenMessage<PutComfortLoad>;
|
|
1532
|
+
|
|
1533
|
+
/**
|
|
1534
|
+
* Removes a heating record by its id, naming the revision it removes. Refused as
|
|
1535
|
+
* FAILED_PRECONDITION with metadata "reason" "STALE_REVISION" when it changed since, and
|
|
1536
|
+
* "HAS_CHILDREN" while records lie under it — a plant's circuits, a circuit's zones — so
|
|
1537
|
+
* nothing is removed that the caller did not name. Its outputs are returned to rest at once
|
|
1538
|
+
* (see heating.v1). Acked. An empty home's floor zone is not removed by the property owner or
|
|
1539
|
+
* the gateway administrators who are given it: NOT_ENTITLED, as PutFloorZone says.
|
|
1540
|
+
*
|
|
1541
|
+
* @generated from message kusinta.iot.webrtc.v1.RemoveHeatingRecord
|
|
1542
|
+
*/
|
|
1543
|
+
export declare type RemoveHeatingRecord = Message<"kusinta.iot.webrtc.v1.RemoveHeatingRecord"> & {
|
|
1544
|
+
/**
|
|
1545
|
+
* @generated from field: string id = 1;
|
|
1546
|
+
*/
|
|
1547
|
+
id: string;
|
|
1548
|
+
|
|
1549
|
+
/**
|
|
1550
|
+
* @generated from field: uint64 revision = 2;
|
|
1551
|
+
*/
|
|
1552
|
+
revision: bigint;
|
|
1553
|
+
};
|
|
1554
|
+
|
|
1555
|
+
/**
|
|
1556
|
+
* Describes the message kusinta.iot.webrtc.v1.RemoveHeatingRecord.
|
|
1557
|
+
* Use `create(RemoveHeatingRecordSchema)` to create a new message.
|
|
1558
|
+
*/
|
|
1559
|
+
export declare const RemoveHeatingRecordSchema: GenMessage<RemoveHeatingRecord>;
|
|
1560
|
+
|
|
1561
|
+
/**
|
|
1562
|
+
* Replaces a comfort load's windows: a resident's setting, apart from the binding and its
|
|
1563
|
+
* revision. Answered with the HeatingRecord as stored. Refused as FAILED_PRECONDITION
|
|
1564
|
+
* "STALE_REVISION" when windows_revision is set and the windows changed since, and as
|
|
1565
|
+
* INVALID_REQUEST "WINDOW" for a window that ComfortWindow does not allow or more than 16.
|
|
1566
|
+
* From an installer under a commissioning grant, NOT_ENTITLED.
|
|
1567
|
+
*
|
|
1568
|
+
* @generated from message kusinta.iot.webrtc.v1.SetComfortWindows
|
|
1569
|
+
*/
|
|
1570
|
+
export declare type SetComfortWindows = Message<"kusinta.iot.webrtc.v1.SetComfortWindows"> & {
|
|
1571
|
+
/**
|
|
1572
|
+
* @generated from field: string comfort_load_id = 1;
|
|
1573
|
+
*/
|
|
1574
|
+
comfortLoadId: string;
|
|
1575
|
+
|
|
1576
|
+
/**
|
|
1577
|
+
* @generated from field: repeated kusinta.iot.heating.v1.ComfortWindow windows = 2;
|
|
1578
|
+
*/
|
|
1579
|
+
windows: ComfortWindow[];
|
|
1580
|
+
|
|
1581
|
+
/**
|
|
1582
|
+
* The ComfortLoad.windows_revision these windows replace. Unset: whatever is stored.
|
|
1583
|
+
*
|
|
1584
|
+
* @generated from field: optional uint64 windows_revision = 3;
|
|
1585
|
+
*/
|
|
1586
|
+
windowsRevision?: bigint | undefined;
|
|
1587
|
+
};
|
|
1588
|
+
|
|
1589
|
+
/**
|
|
1590
|
+
* Describes the message kusinta.iot.webrtc.v1.SetComfortWindows.
|
|
1591
|
+
* Use `create(SetComfortWindowsSchema)` to create a new message.
|
|
1592
|
+
*/
|
|
1593
|
+
export declare const SetComfortWindowsSchema: GenMessage<SetComfortWindows>;
|
|
1594
|
+
|
|
1595
|
+
/**
|
|
1596
|
+
* Asks for a nonce to link one home's account at a third-party service
|
|
1597
|
+
* (accountlink.v1.AccountLinkNonce). Only a household admin of the home
|
|
1598
|
+
* (access.v1.MEMBERSHIP_RELATION_HOUSEHOLD_ADMIN) is issued one; anyone else is refused as
|
|
1599
|
+
* NOT_ENTITLED, as is a home the caller cannot reach. A service this gateway does not
|
|
1600
|
+
* support is refused as INVALID_REQUEST. A gateway that cannot hold linked accounts right now
|
|
1601
|
+
* — its key for sealing them is missing or is not the one its stored links were sealed with —
|
|
1602
|
+
* refuses as UNAVAILABLE with metadata {"reason": "account_links_off"}; nothing is linked until
|
|
1603
|
+
* that is put right on the gateway.
|
|
1604
|
+
*
|
|
1605
|
+
* @generated from message kusinta.iot.webrtc.v1.RequestAccountLinkNonce
|
|
1606
|
+
*/
|
|
1607
|
+
export declare type RequestAccountLinkNonce = Message<"kusinta.iot.webrtc.v1.RequestAccountLinkNonce"> & {
|
|
1608
|
+
/**
|
|
1609
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId home_id = 1;
|
|
1610
|
+
*/
|
|
1611
|
+
homeId?: SpaceId | undefined;
|
|
1612
|
+
|
|
1613
|
+
/**
|
|
1614
|
+
* @generated from field: kusinta.iot.accountlink.v1.LinkedService service = 2;
|
|
1615
|
+
*/
|
|
1616
|
+
service: LinkedService;
|
|
1617
|
+
};
|
|
1618
|
+
|
|
1619
|
+
/**
|
|
1620
|
+
* Describes the message kusinta.iot.webrtc.v1.RequestAccountLinkNonce.
|
|
1621
|
+
* Use `create(RequestAccountLinkNonceSchema)` to create a new message.
|
|
1622
|
+
*/
|
|
1623
|
+
export declare const RequestAccountLinkNonceSchema: GenMessage<RequestAccountLinkNonce>;
|
|
1624
|
+
|
|
1625
|
+
/**
|
|
1626
|
+
* Lists a home's linked accounts and their status, answered with an AccountLinks. Given to
|
|
1627
|
+
* the home's residents, and to the departing household while a vacated handover of the home is
|
|
1628
|
+
* pending (household.proto, VACANCY); anyone else is refused as NOT_ENTITLED.
|
|
1629
|
+
*
|
|
1630
|
+
* @generated from message kusinta.iot.webrtc.v1.ListAccountLinks
|
|
1631
|
+
*/
|
|
1632
|
+
export declare type ListAccountLinks = Message<"kusinta.iot.webrtc.v1.ListAccountLinks"> & {
|
|
1633
|
+
/**
|
|
1634
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId home_id = 1;
|
|
1635
|
+
*/
|
|
1636
|
+
homeId?: SpaceId | undefined;
|
|
1637
|
+
};
|
|
1638
|
+
|
|
1639
|
+
/**
|
|
1640
|
+
* Describes the message kusinta.iot.webrtc.v1.ListAccountLinks.
|
|
1641
|
+
* Use `create(ListAccountLinksSchema)` to create a new message.
|
|
1642
|
+
*/
|
|
1643
|
+
export declare const ListAccountLinksSchema: GenMessage<ListAccountLinks>;
|
|
1644
|
+
|
|
1645
|
+
/**
|
|
1646
|
+
* Unlinks a home's account at one service: the gateway reads no more through it and revokes
|
|
1647
|
+
* it (accountlink.v1.RevokeToken). A household admin of the home only; anyone else is refused
|
|
1648
|
+
* as NOT_ENTITLED. A service with no link is acked all the same. Acked.
|
|
1649
|
+
*
|
|
1650
|
+
* @generated from message kusinta.iot.webrtc.v1.UnlinkAccount
|
|
1651
|
+
*/
|
|
1652
|
+
export declare type UnlinkAccount = Message<"kusinta.iot.webrtc.v1.UnlinkAccount"> & {
|
|
1653
|
+
/**
|
|
1654
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId home_id = 1;
|
|
1655
|
+
*/
|
|
1656
|
+
homeId?: SpaceId | undefined;
|
|
1657
|
+
|
|
1658
|
+
/**
|
|
1659
|
+
* @generated from field: kusinta.iot.accountlink.v1.LinkedService service = 2;
|
|
1660
|
+
*/
|
|
1661
|
+
service: LinkedService;
|
|
1662
|
+
};
|
|
1663
|
+
|
|
1664
|
+
/**
|
|
1665
|
+
* Describes the message kusinta.iot.webrtc.v1.UnlinkAccount.
|
|
1666
|
+
* Use `create(UnlinkAccountSchema)` to create a new message.
|
|
1667
|
+
*/
|
|
1668
|
+
export declare const UnlinkAccountSchema: GenMessage<UnlinkAccount>;
|
|
1669
|
+
|
|
1670
|
+
/**
|
|
1671
|
+
* Lists a space's commissioning (commissioning.v1): for a home, its facts, tests and feature
|
|
1672
|
+
* states; for a space outside homes, its facts and the tests on records there. Answered
|
|
1673
|
+
* with a CommissioningProfile, filtered as commissioning.v1 says. A home asked by a caller
|
|
1674
|
+
* who is not given its commissioning is refused as NOT_ENTITLED.
|
|
1675
|
+
*
|
|
1676
|
+
* @generated from message kusinta.iot.webrtc.v1.ListCommissioning
|
|
1677
|
+
*/
|
|
1678
|
+
export declare type ListCommissioning = Message<"kusinta.iot.webrtc.v1.ListCommissioning"> & {
|
|
1679
|
+
/**
|
|
1680
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
|
|
1681
|
+
*/
|
|
1682
|
+
spaceId?: SpaceId | undefined;
|
|
1683
|
+
};
|
|
1684
|
+
|
|
1685
|
+
/**
|
|
1686
|
+
* Describes the message kusinta.iot.webrtc.v1.ListCommissioning.
|
|
1687
|
+
* Use `create(ListCommissioningSchema)` to create a new message.
|
|
1688
|
+
*/
|
|
1689
|
+
export declare const ListCommissioningSchema: GenMessage<ListCommissioning>;
|
|
1690
|
+
|
|
1691
|
+
/**
|
|
1692
|
+
* Creates a fact (empty fact_id) or replaces one. Answered with the CommissioningRecord as
|
|
1693
|
+
* stored. The gateway sets answerer, necessity, feature, topic and provenance, save
|
|
1694
|
+
* provenance.evidence, which the caller states. Refused with metadata "reason":
|
|
1695
|
+
*
|
|
1696
|
+
* INVALID_REQUEST
|
|
1697
|
+
* "UNKNOWN_KEY" a key the gateway's catalogue does not hold.
|
|
1698
|
+
* "VALUE_TYPE" a value of another type than the key takes, a value outside the
|
|
1699
|
+
* key's closed list or range or listed twice, unknown false, or no
|
|
1700
|
+
* answer.
|
|
1701
|
+
* "SUBJECT" a record_id that is not a heating record within space_id, or a key
|
|
1702
|
+
* that is not about that kind of space or record.
|
|
1703
|
+
* "ANSWERER" a key the caller's party does not answer.
|
|
1704
|
+
* "EVIDENCE" evidence the caller's party may not give, or less than the key
|
|
1705
|
+
* requires.
|
|
1706
|
+
* "TEMPLATE_VERSION" a new or changed deviates_from naming a template or version the
|
|
1707
|
+
* home's template never was, or set on a home that follows no
|
|
1708
|
+
* template. One carried over unchanged from the stored fact is kept,
|
|
1709
|
+
* even after the home moved to another template.
|
|
1710
|
+
*
|
|
1711
|
+
* FAILED_PRECONDITION
|
|
1712
|
+
* "STALE_REVISION" the fact changed since the revision the request names.
|
|
1713
|
+
* "FACT_EXISTS" a create for a space, record and key that already have a fact;
|
|
1714
|
+
* metadata "fact_id" names it. One answer per key.
|
|
1715
|
+
* "SET_BY_TEST" a key only a test sets.
|
|
1716
|
+
*
|
|
1717
|
+
* A space or record the caller cannot reach, and a fact_id that does not exist, are refused
|
|
1718
|
+
* as NOT_ENTITLED with the same metadata.
|
|
1719
|
+
*
|
|
1720
|
+
* @generated from message kusinta.iot.webrtc.v1.PutCommissioningFact
|
|
1721
|
+
*/
|
|
1722
|
+
export declare type PutCommissioningFact = Message<"kusinta.iot.webrtc.v1.PutCommissioningFact"> & {
|
|
1723
|
+
/**
|
|
1724
|
+
* @generated from field: kusinta.iot.commissioning.v1.CommissioningFact fact = 1;
|
|
1725
|
+
*/
|
|
1726
|
+
fact?: CommissioningFact | undefined;
|
|
1727
|
+
};
|
|
1728
|
+
|
|
1729
|
+
/**
|
|
1730
|
+
* Describes the message kusinta.iot.webrtc.v1.PutCommissioningFact.
|
|
1731
|
+
* Use `create(PutCommissioningFactSchema)` to create a new message.
|
|
1732
|
+
*/
|
|
1733
|
+
export declare const PutCommissioningFactSchema: GenMessage<PutCommissioningFact>;
|
|
1734
|
+
|
|
1735
|
+
/**
|
|
1736
|
+
* Removes a fact by its id, naming the revision it removes; as PutCommissioningFact. A fact
|
|
1737
|
+
* set by a test is replaced only by running it again: refused as FAILED_PRECONDITION
|
|
1738
|
+
* "SET_BY_TEST". Acked.
|
|
1739
|
+
*
|
|
1740
|
+
* @generated from message kusinta.iot.webrtc.v1.RemoveCommissioningFact
|
|
1741
|
+
*/
|
|
1742
|
+
export declare type RemoveCommissioningFact = Message<"kusinta.iot.webrtc.v1.RemoveCommissioningFact"> & {
|
|
1743
|
+
/**
|
|
1744
|
+
* @generated from field: string fact_id = 1;
|
|
1745
|
+
*/
|
|
1746
|
+
factId: string;
|
|
1747
|
+
|
|
1748
|
+
/**
|
|
1749
|
+
* @generated from field: uint64 revision = 2;
|
|
1750
|
+
*/
|
|
1751
|
+
revision: bigint;
|
|
1752
|
+
};
|
|
1753
|
+
|
|
1754
|
+
/**
|
|
1755
|
+
* Describes the message kusinta.iot.webrtc.v1.RemoveCommissioningFact.
|
|
1756
|
+
* Use `create(RemoveCommissioningFactSchema)` to create a new message.
|
|
1757
|
+
*/
|
|
1758
|
+
export declare const RemoveCommissioningFactSchema: GenMessage<RemoveCommissioningFact>;
|
|
1759
|
+
|
|
1760
|
+
/**
|
|
1761
|
+
* Creates a house template (empty template_id) or replaces one, naming the version it
|
|
1762
|
+
* replaces. From the property owner or the gateway's administrators, reaching the building;
|
|
1763
|
+
* anyone else is refused as NOT_ENTITLED. Answered with the CommissioningRecord as stored.
|
|
1764
|
+
* Refused as FAILED_PRECONDITION "STALE_REVISION" when the template changed since, as
|
|
1765
|
+
* INVALID_REQUEST "UNKNOWN_KEY" or "VALUE_TYPE" as PutCommissioningFact, and as
|
|
1766
|
+
* INVALID_REQUEST "EVIDENCE" for a key a template may not answer (commissioning.v1,
|
|
1767
|
+
* TEMPLATES); metadata "key" names it.
|
|
1768
|
+
*
|
|
1769
|
+
* @generated from message kusinta.iot.webrtc.v1.PutHouseTemplate
|
|
1770
|
+
*/
|
|
1771
|
+
export declare type PutHouseTemplate = Message<"kusinta.iot.webrtc.v1.PutHouseTemplate"> & {
|
|
1772
|
+
/**
|
|
1773
|
+
* @generated from field: kusinta.iot.commissioning.v1.HouseTemplate template = 1;
|
|
1774
|
+
*/
|
|
1775
|
+
template?: HouseTemplate | undefined;
|
|
1776
|
+
};
|
|
1777
|
+
|
|
1778
|
+
/**
|
|
1779
|
+
* Describes the message kusinta.iot.webrtc.v1.PutHouseTemplate.
|
|
1780
|
+
* Use `create(PutHouseTemplateSchema)` to create a new message.
|
|
1781
|
+
*/
|
|
1782
|
+
export declare const PutHouseTemplateSchema: GenMessage<PutHouseTemplate>;
|
|
1783
|
+
|
|
1784
|
+
/**
|
|
1785
|
+
* Says which house template a home follows; an empty template_id, none. From the property
|
|
1786
|
+
* owner or the gateway's administrators; anyone else is refused as NOT_ENTITLED. A template
|
|
1787
|
+
* of another building is refused as INVALID_REQUEST "TEMPLATE_BUILDING". Deviations recorded
|
|
1788
|
+
* against another template stay, naming the version they were recorded against. Acked.
|
|
1789
|
+
*
|
|
1790
|
+
* @generated from message kusinta.iot.webrtc.v1.SetHomeTemplate
|
|
1791
|
+
*/
|
|
1792
|
+
export declare type SetHomeTemplate = Message<"kusinta.iot.webrtc.v1.SetHomeTemplate"> & {
|
|
1793
|
+
/**
|
|
1794
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId home_id = 1;
|
|
1795
|
+
*/
|
|
1796
|
+
homeId?: SpaceId | undefined;
|
|
1797
|
+
|
|
1798
|
+
/**
|
|
1799
|
+
* @generated from field: string template_id = 2;
|
|
1800
|
+
*/
|
|
1801
|
+
templateId: string;
|
|
1802
|
+
};
|
|
1803
|
+
|
|
1804
|
+
/**
|
|
1805
|
+
* Describes the message kusinta.iot.webrtc.v1.SetHomeTemplate.
|
|
1806
|
+
* Use `create(SetHomeTemplateSchema)` to create a new message.
|
|
1807
|
+
*/
|
|
1808
|
+
export declare const SetHomeTemplateSchema: GenMessage<SetHomeTemplate>;
|
|
1809
|
+
|
|
1810
|
+
/**
|
|
1811
|
+
* Starts a commissioning test (commissioning.v1.TestKind) on a heating record, answered with
|
|
1812
|
+
* the CommissioningRecord of the test, RUNNING. Its changes of state, the start included,
|
|
1813
|
+
* are pushed (GatewayMessage.commissioning_test), save the start to the session that
|
|
1814
|
+
* started it, which has it as the reply. Run by whoever may bind the outputs it drives
|
|
1815
|
+
* (heating.v1); PUMP_ALL_ZONES_OFF by an installer under a commissioning grant only. Refused
|
|
1816
|
+
* with metadata "reason":
|
|
1817
|
+
*
|
|
1818
|
+
* INVALID_REQUEST
|
|
1819
|
+
* "TEST_SUBJECT" a kind that does not run on that record, or for OUTPUT_LEASE a
|
|
1820
|
+
* binding field that is empty or not a bound output of it; for the
|
|
1821
|
+
* other kinds, a binding field that is not empty.
|
|
1822
|
+
*
|
|
1823
|
+
* FAILED_PRECONDITION
|
|
1824
|
+
* "TEST_RUNNING" a test already drives one of its outputs.
|
|
1825
|
+
* "SG_READY_ORDER" OUTPUT_LEASE on one SG Ready input while a running test drives the
|
|
1826
|
+
* other input of the same plant, in either order: both held away from
|
|
1827
|
+
* rest is a state of the heat pump no test asks for. metadata "field"
|
|
1828
|
+
* names the input the running test drives.
|
|
1829
|
+
* "LAST_HEATING_ZONE" OUTPUT_LEASE or ZONE_EFFECT on a floor zone's output that would leave
|
|
1830
|
+
* its circuit no zone heating: the zone is the circuit's only one, or
|
|
1831
|
+
* every other zone of the circuit has its output driven by a running
|
|
1832
|
+
* test. A zone with no bound output counts as heating. Not refused once
|
|
1833
|
+
* the circuit's "floor.pump_tolerates_all_zones_off" is true
|
|
1834
|
+
* (commissioning.v1). metadata "record_id" names the zone.
|
|
1835
|
+
* "NEEDS_PASS" ZONE_EFFECT or PUMP_ALL_ZONES_OFF on outputs without a current
|
|
1836
|
+
* OUTPUT_LEASE pass; metadata "record_id" names one.
|
|
1837
|
+
* "OUTPUT_NOT_LEASED" an output its producer does not state as leased, with a lapse value
|
|
1838
|
+
* at rest (heating.v1), so no test could leave it at rest.
|
|
1839
|
+
* "READ_LATENCY" OUTPUT_LEASE on an output whose producer does not state its reads
|
|
1840
|
+
* REAL_TIME: a pass judged against a guessed latency is none.
|
|
1841
|
+
* "LEASE_BOUNDS" OUTPUT_LEASE on an output whose lease bounds admit no lease of 60
|
|
1842
|
+
* seconds to 5 minutes, so the test could not end by its ends_at.
|
|
1843
|
+
*
|
|
1844
|
+
* A record the caller cannot reach is refused as NOT_ENTITLED.
|
|
1845
|
+
*
|
|
1846
|
+
* @generated from message kusinta.iot.webrtc.v1.RunCommissioningTest
|
|
1847
|
+
*/
|
|
1848
|
+
export declare type RunCommissioningTest = Message<"kusinta.iot.webrtc.v1.RunCommissioningTest"> & {
|
|
1849
|
+
/**
|
|
1850
|
+
* @generated from field: kusinta.iot.commissioning.v1.TestKind kind = 1;
|
|
1851
|
+
*/
|
|
1852
|
+
kind: TestKind;
|
|
1853
|
+
|
|
1854
|
+
/**
|
|
1855
|
+
* binding.field for OUTPUT_LEASE only.
|
|
1856
|
+
*
|
|
1857
|
+
* @generated from field: kusinta.iot.commissioning.v1.BindingRef binding = 4;
|
|
1858
|
+
*/
|
|
1859
|
+
binding?: BindingRef | undefined;
|
|
1860
|
+
};
|
|
1861
|
+
|
|
1862
|
+
/**
|
|
1863
|
+
* Describes the message kusinta.iot.webrtc.v1.RunCommissioningTest.
|
|
1864
|
+
* Use `create(RunCommissioningTestSchema)` to create a new message.
|
|
1865
|
+
*/
|
|
1866
|
+
export declare const RunCommissioningTestSchema: GenMessage<RunCommissioningTest>;
|
|
1867
|
+
|
|
1868
|
+
/**
|
|
1869
|
+
* Ends a running test. verdict ABORTED stops any test, from whoever started it or may run
|
|
1870
|
+
* it; PASSED or FAILED concludes a PUMP_ALL_ZONES_OFF test, from an installer under a
|
|
1871
|
+
* commissioning grant only. Any other verdict, or PASSED or FAILED on another kind, is
|
|
1872
|
+
* refused as INVALID_REQUEST "VERDICT". Its outputs return to their normal control at once,
|
|
1873
|
+
* floor zones switching on no faster than "floor.max_zones_switching_on" allows. Answered
|
|
1874
|
+
* with the CommissioningRecord of the test. A test that has ended is refused as
|
|
1875
|
+
* FAILED_PRECONDITION "TEST_ENDED".
|
|
1876
|
+
*
|
|
1877
|
+
* @generated from message kusinta.iot.webrtc.v1.ConcludeCommissioningTest
|
|
1878
|
+
*/
|
|
1879
|
+
export declare type ConcludeCommissioningTest = Message<"kusinta.iot.webrtc.v1.ConcludeCommissioningTest"> & {
|
|
1880
|
+
/**
|
|
1881
|
+
* @generated from field: string test_id = 1;
|
|
1882
|
+
*/
|
|
1883
|
+
testId: string;
|
|
1884
|
+
|
|
1885
|
+
/**
|
|
1886
|
+
* @generated from field: kusinta.iot.commissioning.v1.TestState verdict = 2;
|
|
1887
|
+
*/
|
|
1888
|
+
verdict: TestState;
|
|
1889
|
+
};
|
|
1890
|
+
|
|
1891
|
+
/**
|
|
1892
|
+
* Describes the message kusinta.iot.webrtc.v1.ConcludeCommissioningTest.
|
|
1893
|
+
* Use `create(ConcludeCommissioningTestSchema)` to create a new message.
|
|
1894
|
+
*/
|
|
1895
|
+
export declare const ConcludeCommissioningTestSchema: GenMessage<ConcludeCommissioningTest>;
|
|
1896
|
+
|
|
1897
|
+
/**
|
|
1898
|
+
* Lists whether each home under a space is set up (commissioning.v1.HomeSetup): unset
|
|
1899
|
+
* root_space_id, every home the caller reaches. For the property owner and the gateway's
|
|
1900
|
+
* administrators; anyone else is refused as NOT_ENTITLED. Answered with a HomeSetups.
|
|
1901
|
+
*
|
|
1902
|
+
* @generated from message kusinta.iot.webrtc.v1.ListHomeSetups
|
|
1903
|
+
*/
|
|
1904
|
+
export declare type ListHomeSetups = Message<"kusinta.iot.webrtc.v1.ListHomeSetups"> & {
|
|
1905
|
+
/**
|
|
1906
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId root_space_id = 1;
|
|
1907
|
+
*/
|
|
1908
|
+
rootSpaceId?: SpaceId | undefined;
|
|
1909
|
+
};
|
|
1910
|
+
|
|
1911
|
+
/**
|
|
1912
|
+
* Describes the message kusinta.iot.webrtc.v1.ListHomeSetups.
|
|
1913
|
+
* Use `create(ListHomeSetupsSchema)` to create a new message.
|
|
1914
|
+
*/
|
|
1915
|
+
export declare const ListHomeSetupsSchema: GenMessage<ListHomeSetups>;
|
|
1916
|
+
|
|
1917
|
+
/**
|
|
1918
|
+
* Asks for a commissioning grant on one space (commissioning.v1, GRANTS), answered with the
|
|
1919
|
+
* CommissioningGrant, REQUESTED. From a caller holding ROLE_TECHNICIAN who reaches the space;
|
|
1920
|
+
* anyone else, and a space they do not reach, is refused as NOT_ENTITLED. A room in a home is
|
|
1921
|
+
* INVALID_REQUEST with metadata {"reason": "grant_space"}: a home is granted whole. Asking
|
|
1922
|
+
* again while one of the caller's is requested or granted on the space answers that one.
|
|
1923
|
+
*
|
|
1924
|
+
* Accepted on any home the caller reaches, whether or not anyone could answer it: it lapses
|
|
1925
|
+
* unanswered where nobody does, so the answer tells the installer nothing of whether anyone
|
|
1926
|
+
* lives there. A caller who lives in the home is refused as FAILED_PRECONDITION with metadata
|
|
1927
|
+
* {"reason": "installer_lives_here"}, which tells them nothing they do not know.
|
|
1928
|
+
*
|
|
1929
|
+
* @generated from message kusinta.iot.webrtc.v1.RequestCommissioningGrant
|
|
1930
|
+
*/
|
|
1931
|
+
export declare type RequestCommissioningGrant = Message<"kusinta.iot.webrtc.v1.RequestCommissioningGrant"> & {
|
|
1932
|
+
/**
|
|
1933
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
|
|
1934
|
+
*/
|
|
1935
|
+
spaceId?: SpaceId | undefined;
|
|
1936
|
+
};
|
|
1937
|
+
|
|
1938
|
+
/**
|
|
1939
|
+
* Describes the message kusinta.iot.webrtc.v1.RequestCommissioningGrant.
|
|
1940
|
+
* Use `create(RequestCommissioningGrantSchema)` to create a new message.
|
|
1941
|
+
*/
|
|
1942
|
+
export declare const RequestCommissioningGrantSchema: GenMessage<RequestCommissioningGrant>;
|
|
1943
|
+
|
|
1944
|
+
/**
|
|
1945
|
+
* Answers a requested commissioning grant, answered with the CommissioningGrant as stored when
|
|
1946
|
+
* granted, and with ManagementAck when declined, which ends it. From a household admin of the
|
|
1947
|
+
* home, or for a space outside homes or an empty home (household.proto, EMPTY HOME) the
|
|
1948
|
+
* property owner or a gateway administrator who reaches it; anyone else, and a grant_id that is
|
|
1949
|
+
* not requested on a space the caller may answer for, is refused as NOT_ENTITLED, so that no
|
|
1950
|
+
* grant id can be probed. So is a grant that names the caller as its installer, whoever they
|
|
1951
|
+
* are (commissioning.v1, GRANTS).
|
|
1952
|
+
*
|
|
1953
|
+
* Granting needs ends_at after starts_at, no more than 14 days after it, and starts_at no
|
|
1954
|
+
* later than 30 days from now; otherwise INVALID_REQUEST with metadata
|
|
1955
|
+
* {"reason": "grant_period"}. An answered grant is not answered again: to change its time,
|
|
1956
|
+
* end it and let the installer ask anew.
|
|
1957
|
+
*
|
|
1958
|
+
* @generated from message kusinta.iot.webrtc.v1.AnswerCommissioningGrant
|
|
1959
|
+
*/
|
|
1960
|
+
export declare type AnswerCommissioningGrant = Message<"kusinta.iot.webrtc.v1.AnswerCommissioningGrant"> & {
|
|
1961
|
+
/**
|
|
1962
|
+
* @generated from field: string grant_id = 1;
|
|
1963
|
+
*/
|
|
1964
|
+
grantId: string;
|
|
1965
|
+
|
|
1966
|
+
/**
|
|
1967
|
+
* true grants; false declines.
|
|
1968
|
+
*
|
|
1969
|
+
* @generated from field: bool accept = 2;
|
|
1970
|
+
*/
|
|
1971
|
+
accept: boolean;
|
|
1972
|
+
|
|
1973
|
+
/**
|
|
1974
|
+
* When it is active. Unset starts_at: now. Ignored when declining.
|
|
1975
|
+
*
|
|
1976
|
+
* @generated from field: google.protobuf.Timestamp starts_at = 3;
|
|
1977
|
+
*/
|
|
1978
|
+
startsAt?: Timestamp | undefined;
|
|
1979
|
+
|
|
1980
|
+
/**
|
|
1981
|
+
* @generated from field: google.protobuf.Timestamp ends_at = 4;
|
|
1982
|
+
*/
|
|
1983
|
+
endsAt?: Timestamp | undefined;
|
|
1984
|
+
};
|
|
1985
|
+
|
|
1986
|
+
/**
|
|
1987
|
+
* Describes the message kusinta.iot.webrtc.v1.AnswerCommissioningGrant.
|
|
1988
|
+
* Use `create(AnswerCommissioningGrantSchema)` to create a new message.
|
|
1989
|
+
*/
|
|
1990
|
+
export declare const AnswerCommissioningGrantSchema: GenMessage<AnswerCommissioningGrant>;
|
|
1991
|
+
|
|
1992
|
+
/**
|
|
1993
|
+
* Ends a commissioning grant at once, requested or granted. Answered with ManagementAck. From
|
|
1994
|
+
* the installer it names, from whoever may answer it, and from nobody else: anyone else, and a
|
|
1995
|
+
* grant_id they are not listed, is refused as NOT_ENTITLED.
|
|
1996
|
+
*
|
|
1997
|
+
* @generated from message kusinta.iot.webrtc.v1.EndCommissioningGrant
|
|
1998
|
+
*/
|
|
1999
|
+
export declare type EndCommissioningGrant = Message<"kusinta.iot.webrtc.v1.EndCommissioningGrant"> & {
|
|
2000
|
+
/**
|
|
2001
|
+
* @generated from field: string grant_id = 1;
|
|
2002
|
+
*/
|
|
2003
|
+
grantId: string;
|
|
2004
|
+
};
|
|
2005
|
+
|
|
2006
|
+
/**
|
|
2007
|
+
* Describes the message kusinta.iot.webrtc.v1.EndCommissioningGrant.
|
|
2008
|
+
* Use `create(EndCommissioningGrantSchema)` to create a new message.
|
|
2009
|
+
*/
|
|
2010
|
+
export declare const EndCommissioningGrantSchema: GenMessage<EndCommissioningGrant>;
|
|
2011
|
+
|
|
2012
|
+
/**
|
|
2013
|
+
* Lists the commissioning grants that have not ended on a space and those below it, answered
|
|
2014
|
+
* with CommissioningGrants: a home's to its residents, and an empty home's (household.proto,
|
|
2015
|
+
* EMPTY HOME) to the property owner and the gateway administrators who reach it, as one on a
|
|
2016
|
+
* space outside homes is; to an installer, their own.
|
|
2017
|
+
* Unset root_space_id lists every one the caller may be listed. Anyone may ask; nobody is
|
|
2018
|
+
* refused, and a caller listed none gets none.
|
|
2019
|
+
*
|
|
2020
|
+
* @generated from message kusinta.iot.webrtc.v1.ListCommissioningGrants
|
|
2021
|
+
*/
|
|
2022
|
+
export declare type ListCommissioningGrants = Message<"kusinta.iot.webrtc.v1.ListCommissioningGrants"> & {
|
|
2023
|
+
/**
|
|
2024
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId root_space_id = 1;
|
|
2025
|
+
*/
|
|
2026
|
+
rootSpaceId?: SpaceId | undefined;
|
|
2027
|
+
};
|
|
2028
|
+
|
|
2029
|
+
/**
|
|
2030
|
+
* Describes the message kusinta.iot.webrtc.v1.ListCommissioningGrants.
|
|
2031
|
+
* Use `create(ListCommissioningGrantsSchema)` to create a new message.
|
|
2032
|
+
*/
|
|
2033
|
+
export declare const ListCommissioningGrantsSchema: GenMessage<ListCommissioningGrants>;
|
|
2034
|
+
|
|
2035
|
+
/**
|
|
2036
|
+
* Sets who owns one of the building's own devices as an asset (common.v1.AssetOwner), and
|
|
2037
|
+
* with it whether a room's outer limits can bind the device (climate.v1.OuterRoomLimits), and
|
|
2038
|
+
* nobody's access. Answered with ManagementAck. From the property owner or a gateway
|
|
2039
|
+
* administrator who reaches the device; anyone else is refused as NOT_ENTITLED. Unset
|
|
2040
|
+
* asset_owner clears it, as does one with neither owner set.
|
|
2041
|
+
*
|
|
2042
|
+
* Refused as INVALID_REQUEST with metadata "reason":
|
|
2043
|
+
* "owned_by_resident" a device a person owns outright (common.v1.DeviceOwnershipType
|
|
2044
|
+
* RESIDENT), which has no asset owner.
|
|
2045
|
+
* "asset_owner" owner_organisation false, or a household_home_id that is not an
|
|
2046
|
+
* apartment.
|
|
2047
|
+
*
|
|
2048
|
+
* A household's asset keeps naming its home if the home's space is changed or deleted, until
|
|
2049
|
+
* it is set again: who owns what after a home is split or merged is decided here, not by the
|
|
2050
|
+
* change.
|
|
2051
|
+
*
|
|
2052
|
+
* @generated from message kusinta.iot.webrtc.v1.SetAssetOwner
|
|
2053
|
+
*/
|
|
2054
|
+
export declare type SetAssetOwner = Message<"kusinta.iot.webrtc.v1.SetAssetOwner"> & {
|
|
2055
|
+
/**
|
|
2056
|
+
* @generated from field: kusinta.iot.identity.v1.DeviceId device_id = 1;
|
|
2057
|
+
*/
|
|
2058
|
+
deviceId?: DeviceId | undefined;
|
|
2059
|
+
|
|
2060
|
+
/**
|
|
2061
|
+
* @generated from field: kusinta.iot.common.v1.AssetOwner asset_owner = 2;
|
|
2062
|
+
*/
|
|
2063
|
+
assetOwner?: AssetOwner | undefined;
|
|
2064
|
+
};
|
|
2065
|
+
|
|
2066
|
+
/**
|
|
2067
|
+
* Describes the message kusinta.iot.webrtc.v1.SetAssetOwner.
|
|
2068
|
+
* Use `create(SetAssetOwnerSchema)` to create a new message.
|
|
2069
|
+
*/
|
|
2070
|
+
export declare const SetAssetOwnerSchema: GenMessage<SetAssetOwner>;
|
|
2071
|
+
|
|
2072
|
+
/**
|
|
2073
|
+
* @generated from message kusinta.iot.webrtc.v1.ManagementRequest
|
|
2074
|
+
*/
|
|
2075
|
+
export declare type ManagementRequest = Message<"kusinta.iot.webrtc.v1.ManagementRequest"> & {
|
|
2076
|
+
/**
|
|
2077
|
+
* @generated from oneof kusinta.iot.webrtc.v1.ManagementRequest.request
|
|
2078
|
+
*/
|
|
2079
|
+
request: {
|
|
2080
|
+
/**
|
|
2081
|
+
* @generated from field: kusinta.iot.webrtc.v1.CreateSpace create_space = 1;
|
|
2082
|
+
*/
|
|
2083
|
+
value: CreateSpace;
|
|
2084
|
+
case: "createSpace";
|
|
2085
|
+
} | {
|
|
2086
|
+
/**
|
|
2087
|
+
* @generated from field: kusinta.iot.webrtc.v1.UpdateSpace update_space = 2;
|
|
2088
|
+
*/
|
|
2089
|
+
value: UpdateSpace;
|
|
2090
|
+
case: "updateSpace";
|
|
2091
|
+
} | {
|
|
2092
|
+
/**
|
|
2093
|
+
* @generated from field: kusinta.iot.webrtc.v1.DeleteSpace delete_space = 3;
|
|
2094
|
+
*/
|
|
2095
|
+
value: DeleteSpace;
|
|
2096
|
+
case: "deleteSpace";
|
|
2097
|
+
} | {
|
|
2098
|
+
/**
|
|
2099
|
+
* @generated from field: kusinta.iot.webrtc.v1.AssignUserToSpace assign_user_to_space = 4;
|
|
2100
|
+
*/
|
|
2101
|
+
value: AssignUserToSpace;
|
|
2102
|
+
case: "assignUserToSpace";
|
|
2103
|
+
} | {
|
|
2104
|
+
/**
|
|
2105
|
+
* @generated from field: kusinta.iot.webrtc.v1.RemoveUserFromSpace remove_user_from_space = 5;
|
|
2106
|
+
*/
|
|
2107
|
+
value: RemoveUserFromSpace;
|
|
2108
|
+
case: "removeUserFromSpace";
|
|
2109
|
+
} | {
|
|
2110
|
+
/**
|
|
2111
|
+
* @generated from field: kusinta.iot.webrtc.v1.PlaceDeviceInSpace place_device_in_space = 6;
|
|
2112
|
+
*/
|
|
2113
|
+
value: PlaceDeviceInSpace;
|
|
2114
|
+
case: "placeDeviceInSpace";
|
|
2115
|
+
} | {
|
|
2116
|
+
/**
|
|
2117
|
+
* @generated from field: kusinta.iot.webrtc.v1.RemoveDeviceFromSpace remove_device_from_space = 7;
|
|
2118
|
+
*/
|
|
2119
|
+
value: RemoveDeviceFromSpace;
|
|
2120
|
+
case: "removeDeviceFromSpace";
|
|
2121
|
+
} | {
|
|
2122
|
+
/**
|
|
2123
|
+
* @generated from field: kusinta.iot.webrtc.v1.ClaimDevice claim_device = 8;
|
|
2124
|
+
*/
|
|
2125
|
+
value: ClaimDevice;
|
|
2126
|
+
case: "claimDevice";
|
|
2127
|
+
} | {
|
|
2128
|
+
/**
|
|
2129
|
+
* @generated from field: kusinta.iot.webrtc.v1.ReleaseDevice release_device = 9;
|
|
2130
|
+
*/
|
|
2131
|
+
value: ReleaseDevice;
|
|
2132
|
+
case: "releaseDevice";
|
|
2133
|
+
} | {
|
|
2134
|
+
/**
|
|
2135
|
+
* @generated from field: kusinta.iot.webrtc.v1.ListSpaces list_spaces = 10;
|
|
2136
|
+
*/
|
|
2137
|
+
value: ListSpaces;
|
|
2138
|
+
case: "listSpaces";
|
|
2139
|
+
} | {
|
|
2140
|
+
/**
|
|
2141
|
+
* @generated from field: kusinta.iot.webrtc.v1.CreateDeviceLink create_device_link = 11;
|
|
2142
|
+
*/
|
|
2143
|
+
value: CreateDeviceLink;
|
|
2144
|
+
case: "createDeviceLink";
|
|
2145
|
+
} | {
|
|
2146
|
+
/**
|
|
2147
|
+
* @generated from field: kusinta.iot.webrtc.v1.RemoveDeviceLink remove_device_link = 12;
|
|
2148
|
+
*/
|
|
2149
|
+
value: RemoveDeviceLink;
|
|
2150
|
+
case: "removeDeviceLink";
|
|
2151
|
+
} | {
|
|
2152
|
+
/**
|
|
2153
|
+
* @generated from field: kusinta.iot.webrtc.v1.ListDeviceLinks list_device_links = 13;
|
|
2154
|
+
*/
|
|
2155
|
+
value: ListDeviceLinks;
|
|
2156
|
+
case: "listDeviceLinks";
|
|
2157
|
+
} | {
|
|
2158
|
+
/**
|
|
2159
|
+
* @generated from field: kusinta.iot.webrtc.v1.UpdateDeviceLink update_device_link = 14;
|
|
2160
|
+
*/
|
|
2161
|
+
value: UpdateDeviceLink;
|
|
2162
|
+
case: "updateDeviceLink";
|
|
2163
|
+
} | {
|
|
2164
|
+
/**
|
|
2165
|
+
* @generated from field: kusinta.iot.webrtc.v1.ProvisionDevice provision_device = 15;
|
|
2166
|
+
*/
|
|
2167
|
+
value: ProvisionDevice;
|
|
2168
|
+
case: "provisionDevice";
|
|
2169
|
+
} | {
|
|
2170
|
+
/**
|
|
2171
|
+
* @generated from field: kusinta.iot.webrtc.v1.SetRoomTarget set_room_target = 16;
|
|
2172
|
+
*/
|
|
2173
|
+
value: SetRoomTarget;
|
|
2174
|
+
case: "setRoomTarget";
|
|
2175
|
+
} | {
|
|
2176
|
+
/**
|
|
2177
|
+
* @generated from field: kusinta.iot.webrtc.v1.ConfigureRoomClimate configure_room_climate = 17;
|
|
2178
|
+
*/
|
|
2179
|
+
value: ConfigureRoomClimate;
|
|
2180
|
+
case: "configureRoomClimate";
|
|
2181
|
+
} | {
|
|
2182
|
+
/**
|
|
2183
|
+
* @generated from field: kusinta.iot.webrtc.v1.SetClimateMode set_climate_mode = 18;
|
|
2184
|
+
*/
|
|
2185
|
+
value: SetClimateMode;
|
|
2186
|
+
case: "setClimateMode";
|
|
2187
|
+
} | {
|
|
2188
|
+
/**
|
|
2189
|
+
* @generated from field: kusinta.iot.webrtc.v1.ListRoomClimates list_room_climates = 19;
|
|
2190
|
+
*/
|
|
2191
|
+
value: ListRoomClimates;
|
|
2192
|
+
case: "listRoomClimates";
|
|
2193
|
+
} | {
|
|
2194
|
+
/**
|
|
2195
|
+
* @generated from field: kusinta.iot.webrtc.v1.GetRoomHistory get_room_history = 20;
|
|
2196
|
+
*/
|
|
2197
|
+
value: GetRoomHistory;
|
|
2198
|
+
case: "getRoomHistory";
|
|
2199
|
+
} | {
|
|
2200
|
+
/**
|
|
2201
|
+
* @generated from field: kusinta.iot.webrtc.v1.GetPrivacyDisclosure get_privacy_disclosure = 21;
|
|
2202
|
+
*/
|
|
2203
|
+
value: GetPrivacyDisclosure;
|
|
2204
|
+
case: "getPrivacyDisclosure";
|
|
2205
|
+
} | {
|
|
2206
|
+
/**
|
|
2207
|
+
* @generated from field: kusinta.iot.webrtc.v1.GetApartmentClimateSummary get_apartment_climate_summary = 22;
|
|
2208
|
+
*/
|
|
2209
|
+
value: GetApartmentClimateSummary;
|
|
2210
|
+
case: "getApartmentClimateSummary";
|
|
2211
|
+
} | {
|
|
2212
|
+
/**
|
|
2213
|
+
* @generated from field: kusinta.iot.webrtc.v1.ReconnectConnector reconnect_connector = 23;
|
|
2214
|
+
*/
|
|
2215
|
+
value: ReconnectConnector;
|
|
2216
|
+
case: "reconnectConnector";
|
|
2217
|
+
} | {
|
|
2218
|
+
/**
|
|
2219
|
+
* Invites; see invite.proto.
|
|
2220
|
+
*
|
|
2221
|
+
* @generated from field: kusinta.iot.webrtc.v1.CreateInvite create_invite = 24;
|
|
2222
|
+
*/
|
|
2223
|
+
value: CreateInvite;
|
|
2224
|
+
case: "createInvite";
|
|
2225
|
+
} | {
|
|
2226
|
+
/**
|
|
2227
|
+
* @generated from field: kusinta.iot.webrtc.v1.ResendInvite resend_invite = 25;
|
|
2228
|
+
*/
|
|
2229
|
+
value: ResendInvite;
|
|
2230
|
+
case: "resendInvite";
|
|
2231
|
+
} | {
|
|
2232
|
+
/**
|
|
2233
|
+
* @generated from field: kusinta.iot.webrtc.v1.RevokeInvite revoke_invite = 26;
|
|
2234
|
+
*/
|
|
2235
|
+
value: RevokeInvite;
|
|
2236
|
+
case: "revokeInvite";
|
|
2237
|
+
} | {
|
|
2238
|
+
/**
|
|
2239
|
+
* @generated from field: kusinta.iot.webrtc.v1.MarkInviteEmailSent mark_invite_email_sent = 27;
|
|
2240
|
+
*/
|
|
2241
|
+
value: MarkInviteEmailSent;
|
|
2242
|
+
case: "markInviteEmailSent";
|
|
2243
|
+
} | {
|
|
2244
|
+
/**
|
|
2245
|
+
* @generated from field: kusinta.iot.webrtc.v1.ListSpaceInvites list_space_invites = 28;
|
|
2246
|
+
*/
|
|
2247
|
+
value: ListSpaceInvites;
|
|
2248
|
+
case: "listSpaceInvites";
|
|
2249
|
+
} | {
|
|
2250
|
+
/**
|
|
2251
|
+
* @generated from field: kusinta.iot.webrtc.v1.ApproveJoinRequest approve_join_request = 29;
|
|
2252
|
+
*/
|
|
2253
|
+
value: ApproveJoinRequest;
|
|
2254
|
+
case: "approveJoinRequest";
|
|
2255
|
+
} | {
|
|
2256
|
+
/**
|
|
2257
|
+
* @generated from field: kusinta.iot.webrtc.v1.DenyJoinRequest deny_join_request = 30;
|
|
2258
|
+
*/
|
|
2259
|
+
value: DenyJoinRequest;
|
|
2260
|
+
case: "denyJoinRequest";
|
|
2261
|
+
} | {
|
|
2262
|
+
/**
|
|
2263
|
+
* Members; see members.proto.
|
|
2264
|
+
*
|
|
2265
|
+
* @generated from field: kusinta.iot.webrtc.v1.ListGatewayMembers list_gateway_members = 31;
|
|
2266
|
+
*/
|
|
2267
|
+
value: ListGatewayMembers;
|
|
2268
|
+
case: "listGatewayMembers";
|
|
2269
|
+
} | {
|
|
2270
|
+
/**
|
|
2271
|
+
* @generated from field: kusinta.iot.webrtc.v1.SetMemberRole set_member_role = 32;
|
|
2272
|
+
*/
|
|
2273
|
+
value: SetMemberRole;
|
|
2274
|
+
case: "setMemberRole";
|
|
2275
|
+
} | {
|
|
2276
|
+
/**
|
|
2277
|
+
* @generated from field: kusinta.iot.webrtc.v1.RemoveFromGateway remove_from_gateway = 33;
|
|
2278
|
+
*/
|
|
2279
|
+
value: RemoveFromGateway;
|
|
2280
|
+
case: "removeFromGateway";
|
|
2281
|
+
} | {
|
|
2282
|
+
/**
|
|
2283
|
+
* @generated from field: kusinta.iot.webrtc.v1.SetAccessUntil set_access_until = 34;
|
|
2284
|
+
*/
|
|
2285
|
+
value: SetAccessUntil;
|
|
2286
|
+
case: "setAccessUntil";
|
|
2287
|
+
} | {
|
|
2288
|
+
/**
|
|
2289
|
+
* Superseded, and refused as INVALID_REQUEST; see SetOwnerOrganisation.
|
|
2290
|
+
*
|
|
2291
|
+
* @generated from field: kusinta.iot.webrtc.v1.SetOwnerOrganisation set_owner_organisation = 35 [deprecated = true];
|
|
2292
|
+
* @deprecated
|
|
2293
|
+
*/
|
|
2294
|
+
value: SetOwnerOrganisation;
|
|
2295
|
+
case: "setOwnerOrganisation";
|
|
2296
|
+
} | {
|
|
2297
|
+
/**
|
|
2298
|
+
* Promotion requests; see members.proto.
|
|
2299
|
+
*
|
|
2300
|
+
* @generated from field: kusinta.iot.webrtc.v1.RequestPromotion request_promotion = 36;
|
|
2301
|
+
*/
|
|
2302
|
+
value: RequestPromotion;
|
|
2303
|
+
case: "requestPromotion";
|
|
2304
|
+
} | {
|
|
2305
|
+
/**
|
|
2306
|
+
* @generated from field: kusinta.iot.webrtc.v1.AnswerPromotion answer_promotion = 37;
|
|
2307
|
+
*/
|
|
2308
|
+
value: AnswerPromotion;
|
|
2309
|
+
case: "answerPromotion";
|
|
2310
|
+
} | {
|
|
2311
|
+
/**
|
|
2312
|
+
* @generated from field: kusinta.iot.webrtc.v1.ListPromotionRequests list_promotion_requests = 38;
|
|
2313
|
+
*/
|
|
2314
|
+
value: ListPromotionRequests;
|
|
2315
|
+
case: "listPromotionRequests";
|
|
2316
|
+
} | {
|
|
2317
|
+
/**
|
|
2318
|
+
* Heating records; see heating.v1.
|
|
2319
|
+
*
|
|
2320
|
+
* @generated from field: kusinta.iot.webrtc.v1.ListHeating list_heating = 39;
|
|
2321
|
+
*/
|
|
2322
|
+
value: ListHeating;
|
|
2323
|
+
case: "listHeating";
|
|
2324
|
+
} | {
|
|
2325
|
+
/**
|
|
2326
|
+
* @generated from field: kusinta.iot.webrtc.v1.PutHeatingPlant put_heating_plant = 40;
|
|
2327
|
+
*/
|
|
2328
|
+
value: PutHeatingPlant;
|
|
2329
|
+
case: "putHeatingPlant";
|
|
2330
|
+
} | {
|
|
2331
|
+
/**
|
|
2332
|
+
* @generated from field: kusinta.iot.webrtc.v1.PutHeatingCircuit put_heating_circuit = 41;
|
|
2333
|
+
*/
|
|
2334
|
+
value: PutHeatingCircuit;
|
|
2335
|
+
case: "putHeatingCircuit";
|
|
2336
|
+
} | {
|
|
2337
|
+
/**
|
|
2338
|
+
* @generated from field: kusinta.iot.webrtc.v1.PutFloorZone put_floor_zone = 42;
|
|
2339
|
+
*/
|
|
2340
|
+
value: PutFloorZone;
|
|
2341
|
+
case: "putFloorZone";
|
|
2342
|
+
} | {
|
|
2343
|
+
/**
|
|
2344
|
+
* @generated from field: kusinta.iot.webrtc.v1.PutComfortLoad put_comfort_load = 43;
|
|
2345
|
+
*/
|
|
2346
|
+
value: PutComfortLoad;
|
|
2347
|
+
case: "putComfortLoad";
|
|
2348
|
+
} | {
|
|
2349
|
+
/**
|
|
2350
|
+
* @generated from field: kusinta.iot.webrtc.v1.RemoveHeatingRecord remove_heating_record = 44;
|
|
2351
|
+
*/
|
|
2352
|
+
value: RemoveHeatingRecord;
|
|
2353
|
+
case: "removeHeatingRecord";
|
|
2354
|
+
} | {
|
|
2355
|
+
/**
|
|
2356
|
+
* @generated from field: kusinta.iot.webrtc.v1.SetComfortWindows set_comfort_windows = 45;
|
|
2357
|
+
*/
|
|
2358
|
+
value: SetComfortWindows;
|
|
2359
|
+
case: "setComfortWindows";
|
|
2360
|
+
} | {
|
|
2361
|
+
/**
|
|
2362
|
+
* @generated from field: kusinta.iot.webrtc.v1.RequestAccountLinkNonce request_account_link_nonce = 46;
|
|
2363
|
+
*/
|
|
2364
|
+
value: RequestAccountLinkNonce;
|
|
2365
|
+
case: "requestAccountLinkNonce";
|
|
2366
|
+
} | {
|
|
2367
|
+
/**
|
|
2368
|
+
* @generated from field: kusinta.iot.webrtc.v1.ListAccountLinks list_account_links = 47;
|
|
2369
|
+
*/
|
|
2370
|
+
value: ListAccountLinks;
|
|
2371
|
+
case: "listAccountLinks";
|
|
2372
|
+
} | {
|
|
2373
|
+
/**
|
|
2374
|
+
* @generated from field: kusinta.iot.webrtc.v1.UnlinkAccount unlink_account = 48;
|
|
2375
|
+
*/
|
|
2376
|
+
value: UnlinkAccount;
|
|
2377
|
+
case: "unlinkAccount";
|
|
2378
|
+
} | {
|
|
2379
|
+
/**
|
|
2380
|
+
* Commissioning; see commissioning.v1.
|
|
2381
|
+
*
|
|
2382
|
+
* @generated from field: kusinta.iot.webrtc.v1.ListCommissioning list_commissioning = 49;
|
|
2383
|
+
*/
|
|
2384
|
+
value: ListCommissioning;
|
|
2385
|
+
case: "listCommissioning";
|
|
2386
|
+
} | {
|
|
2387
|
+
/**
|
|
2388
|
+
* @generated from field: kusinta.iot.webrtc.v1.PutCommissioningFact put_commissioning_fact = 50;
|
|
2389
|
+
*/
|
|
2390
|
+
value: PutCommissioningFact;
|
|
2391
|
+
case: "putCommissioningFact";
|
|
2392
|
+
} | {
|
|
2393
|
+
/**
|
|
2394
|
+
* @generated from field: kusinta.iot.webrtc.v1.RemoveCommissioningFact remove_commissioning_fact = 51;
|
|
2395
|
+
*/
|
|
2396
|
+
value: RemoveCommissioningFact;
|
|
2397
|
+
case: "removeCommissioningFact";
|
|
2398
|
+
} | {
|
|
2399
|
+
/**
|
|
2400
|
+
* @generated from field: kusinta.iot.webrtc.v1.PutHouseTemplate put_house_template = 52;
|
|
2401
|
+
*/
|
|
2402
|
+
value: PutHouseTemplate;
|
|
2403
|
+
case: "putHouseTemplate";
|
|
2404
|
+
} | {
|
|
2405
|
+
/**
|
|
2406
|
+
* @generated from field: kusinta.iot.webrtc.v1.SetHomeTemplate set_home_template = 53;
|
|
2407
|
+
*/
|
|
2408
|
+
value: SetHomeTemplate;
|
|
2409
|
+
case: "setHomeTemplate";
|
|
2410
|
+
} | {
|
|
2411
|
+
/**
|
|
2412
|
+
* @generated from field: kusinta.iot.webrtc.v1.RunCommissioningTest run_commissioning_test = 54;
|
|
2413
|
+
*/
|
|
2414
|
+
value: RunCommissioningTest;
|
|
2415
|
+
case: "runCommissioningTest";
|
|
2416
|
+
} | {
|
|
2417
|
+
/**
|
|
2418
|
+
* @generated from field: kusinta.iot.webrtc.v1.ConcludeCommissioningTest conclude_commissioning_test = 55;
|
|
2419
|
+
*/
|
|
2420
|
+
value: ConcludeCommissioningTest;
|
|
2421
|
+
case: "concludeCommissioningTest";
|
|
2422
|
+
} | {
|
|
2423
|
+
/**
|
|
2424
|
+
* @generated from field: kusinta.iot.webrtc.v1.ListHomeSetups list_home_setups = 56;
|
|
2425
|
+
*/
|
|
2426
|
+
value: ListHomeSetups;
|
|
2427
|
+
case: "listHomeSetups";
|
|
2428
|
+
} | {
|
|
2429
|
+
/**
|
|
2430
|
+
* Commissioning grants; see commissioning.v1, GRANTS.
|
|
2431
|
+
*
|
|
2432
|
+
* @generated from field: kusinta.iot.webrtc.v1.RequestCommissioningGrant request_commissioning_grant = 57;
|
|
2433
|
+
*/
|
|
2434
|
+
value: RequestCommissioningGrant;
|
|
2435
|
+
case: "requestCommissioningGrant";
|
|
2436
|
+
} | {
|
|
2437
|
+
/**
|
|
2438
|
+
* @generated from field: kusinta.iot.webrtc.v1.AnswerCommissioningGrant answer_commissioning_grant = 58;
|
|
2439
|
+
*/
|
|
2440
|
+
value: AnswerCommissioningGrant;
|
|
2441
|
+
case: "answerCommissioningGrant";
|
|
2442
|
+
} | {
|
|
2443
|
+
/**
|
|
2444
|
+
* @generated from field: kusinta.iot.webrtc.v1.EndCommissioningGrant end_commissioning_grant = 59;
|
|
2445
|
+
*/
|
|
2446
|
+
value: EndCommissioningGrant;
|
|
2447
|
+
case: "endCommissioningGrant";
|
|
2448
|
+
} | {
|
|
2449
|
+
/**
|
|
2450
|
+
* @generated from field: kusinta.iot.webrtc.v1.ListCommissioningGrants list_commissioning_grants = 60;
|
|
2451
|
+
*/
|
|
2452
|
+
value: ListCommissioningGrants;
|
|
2453
|
+
case: "listCommissioningGrants";
|
|
2454
|
+
} | {
|
|
2455
|
+
/**
|
|
2456
|
+
* @generated from field: kusinta.iot.webrtc.v1.SetAssetOwner set_asset_owner = 61;
|
|
2457
|
+
*/
|
|
2458
|
+
value: SetAssetOwner;
|
|
2459
|
+
case: "setAssetOwner";
|
|
2460
|
+
} | {
|
|
2461
|
+
/**
|
|
2462
|
+
* The household; see household.proto.
|
|
2463
|
+
*
|
|
2464
|
+
* @generated from field: kusinta.iot.webrtc.v1.DemoteHouseholdAdmin demote_household_admin = 62;
|
|
2465
|
+
*/
|
|
2466
|
+
value: DemoteHouseholdAdmin;
|
|
2467
|
+
case: "demoteHouseholdAdmin";
|
|
2468
|
+
} | {
|
|
2469
|
+
/**
|
|
2470
|
+
* @generated from field: kusinta.iot.webrtc.v1.StartHouseholdHandover start_household_handover = 63;
|
|
2471
|
+
*/
|
|
2472
|
+
value: StartHouseholdHandover;
|
|
2473
|
+
case: "startHouseholdHandover";
|
|
2474
|
+
} | {
|
|
2475
|
+
/**
|
|
2476
|
+
* @generated from field: kusinta.iot.webrtc.v1.ConfirmHouseholdHandover confirm_household_handover = 64;
|
|
2477
|
+
*/
|
|
2478
|
+
value: ConfirmHouseholdHandover;
|
|
2479
|
+
case: "confirmHouseholdHandover";
|
|
2480
|
+
} | {
|
|
2481
|
+
/**
|
|
2482
|
+
* @generated from field: kusinta.iot.webrtc.v1.CancelHouseholdHandover cancel_household_handover = 65;
|
|
2483
|
+
*/
|
|
2484
|
+
value: CancelHouseholdHandover;
|
|
2485
|
+
case: "cancelHouseholdHandover";
|
|
2486
|
+
} | {
|
|
2487
|
+
/**
|
|
2488
|
+
* @generated from field: kusinta.iot.webrtc.v1.ListHouseholdHandovers list_household_handovers = 66;
|
|
2489
|
+
*/
|
|
2490
|
+
value: ListHouseholdHandovers;
|
|
2491
|
+
case: "listHouseholdHandovers";
|
|
2492
|
+
} | {
|
|
2493
|
+
/**
|
|
2494
|
+
* @generated from field: kusinta.iot.webrtc.v1.ExportHouseholdData export_household_data = 67;
|
|
2495
|
+
*/
|
|
2496
|
+
value: ExportHouseholdData;
|
|
2497
|
+
case: "exportHouseholdData";
|
|
2498
|
+
} | {
|
|
2499
|
+
/**
|
|
2500
|
+
* @generated from field: kusinta.iot.webrtc.v1.SetHomeName set_home_name = 68;
|
|
2501
|
+
*/
|
|
2502
|
+
value: SetHomeName;
|
|
2503
|
+
case: "setHomeName";
|
|
2504
|
+
} | {
|
|
2505
|
+
/**
|
|
2506
|
+
* @generated from field: kusinta.iot.webrtc.v1.ClearClimateHistory clear_climate_history = 69;
|
|
2507
|
+
*/
|
|
2508
|
+
value: ClearClimateHistory;
|
|
2509
|
+
case: "clearClimateHistory";
|
|
2510
|
+
} | {
|
|
2511
|
+
/**
|
|
2512
|
+
* @generated from field: kusinta.iot.webrtc.v1.SetInnerRoomLimits set_inner_room_limits = 70;
|
|
2513
|
+
*/
|
|
2514
|
+
value: SetInnerRoomLimits;
|
|
2515
|
+
case: "setInnerRoomLimits";
|
|
443
2516
|
} | { case: undefined; value?: undefined };
|
|
444
2517
|
};
|
|
445
2518
|
|