@kusinta/iot-schema 0.2.0-beta.4 → 0.2.0-beta.41
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 +120 -2
- package/src/kusinta/iot/access/v1/acl_pb.js +20 -3
- package/src/kusinta/iot/access/v1/roles_pb.d.ts +157 -4
- package/src/kusinta/iot/access/v1/roles_pb.js +125 -5
- package/src/kusinta/iot/accountlink/v1/account_link_pb.d.ts +583 -0
- package/src/kusinta/iot/accountlink/v1/account_link_pb.js +160 -0
- package/src/kusinta/iot/climate/v1/climate_pb.d.ts +1041 -0
- package/src/kusinta/iot/climate/v1/climate_pb.js +206 -0
- package/src/kusinta/iot/commissioning/v1/commissioning_pb.d.ts +1280 -0
- package/src/kusinta/iot/commissioning/v1/commissioning_pb.js +275 -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 +232 -0
- package/src/kusinta/iot/common/v1/types_pb.js +84 -2
- package/src/kusinta/iot/connector/v1/connector_pb.d.ts +691 -2
- package/src/kusinta/iot/connector/v1/connector_pb.js +104 -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 +33 -3
- package/src/kusinta/iot/device/v1/descriptor_pb.js +2 -1
- package/src/kusinta/iot/device/v1/device_event_pb.d.ts +87 -5
- package/src/kusinta/iot/device/v1/device_event_pb.js +1 -1
- package/src/kusinta/iot/device/v1/device_pb.d.ts +164 -11
- package/src/kusinta/iot/device/v1/device_pb.js +33 -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 +28 -2
- package/src/kusinta/iot/device/v1/property_update_pb.js +2 -1
- package/src/kusinta/iot/heating/v1/heating_pb.d.ts +619 -0
- package/src/kusinta/iot/heating/v1/heating_pb.js +118 -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 +1228 -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 +129 -2
- package/src/kusinta/iot/space/v1/space_pb.js +10 -1
- package/src/kusinta/iot/vendor/homematic/v1/homematic_pb.d.ts +19 -3
- 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 +4 -4
- package/src/kusinta/iot/vendor/v1/vendor_options_pb.js +4 -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 +35 -6
- package/src/kusinta/iot/webrtc/v1/envelope_pb.d.ts +664 -3
- package/src/kusinta/iot/webrtc/v1/envelope_pb.js +69 -3
- package/src/kusinta/iot/webrtc/v1/household_pb.d.ts +490 -0
- package/src/kusinta/iot/webrtc/v1/household_pb.js +120 -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 +1944 -76
- package/src/kusinta/iot/webrtc/v1/management_pb.js +297 -5
- package/src/kusinta/iot/webrtc/v1/members_pb.d.ts +578 -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 +10 -2
|
@@ -0,0 +1,1041 @@
|
|
|
1
|
+
// @generated by protoc-gen-es v2.12.0 with parameter "target=js+dts,import_extension=js"
|
|
2
|
+
// @generated from file kusinta/iot/climate/v1/climate.proto (package kusinta.iot.climate.v1, syntax proto3)
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
|
|
5
|
+
import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
|
|
6
|
+
import type { Message } from "@bufbuild/protobuf";
|
|
7
|
+
import type { Timestamp } from "@bufbuild/protobuf/wkt";
|
|
8
|
+
import type { DeviceId, SpaceId, UserId } from "../../identity/v1/identity_pb.js";
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Describes the file kusinta/iot/climate/v1/climate.proto.
|
|
12
|
+
*/
|
|
13
|
+
export declare const file_kusinta_iot_climate_v1_climate: GenFile;
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Who or what last set a room's target, and when.
|
|
17
|
+
*
|
|
18
|
+
* Shown beside the target, because under "last change wins" a target that moved on its
|
|
19
|
+
* own looks like a fault unless the reader can see that somebody turned a radiator by
|
|
20
|
+
* hand ten minutes ago.
|
|
21
|
+
*
|
|
22
|
+
* @generated from message kusinta.iot.climate.v1.TargetChange
|
|
23
|
+
*/
|
|
24
|
+
export declare type TargetChange = Message<"kusinta.iot.climate.v1.TargetChange"> & {
|
|
25
|
+
/**
|
|
26
|
+
* @generated from field: google.protobuf.Timestamp at = 1;
|
|
27
|
+
*/
|
|
28
|
+
at?: Timestamp | undefined;
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* @generated from oneof kusinta.iot.climate.v1.TargetChange.by
|
|
32
|
+
*/
|
|
33
|
+
by: {
|
|
34
|
+
/**
|
|
35
|
+
* Set in the app, by this user.
|
|
36
|
+
*
|
|
37
|
+
* @generated from field: kusinta.iot.identity.v1.UserId user = 2;
|
|
38
|
+
*/
|
|
39
|
+
value: UserId;
|
|
40
|
+
case: "user";
|
|
41
|
+
} | {
|
|
42
|
+
/**
|
|
43
|
+
* Turned by hand at this device: a valve's knob or a wall thermostat's dial, as the
|
|
44
|
+
* device reported it (Matter Thermostat SetpointChangeSource = Manual). A change the
|
|
45
|
+
* device made on its own — window-open, frost protection, its own schedule — is never
|
|
46
|
+
* adopted and never appears here.
|
|
47
|
+
*
|
|
48
|
+
* @generated from field: kusinta.iot.identity.v1.DeviceId device = 3;
|
|
49
|
+
*/
|
|
50
|
+
value: DeviceId;
|
|
51
|
+
case: "device";
|
|
52
|
+
} | { case: undefined; value?: undefined };
|
|
53
|
+
};
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Describes the message kusinta.iot.climate.v1.TargetChange.
|
|
57
|
+
* Use `create(TargetChangeSchema)` to create a new message.
|
|
58
|
+
*/
|
|
59
|
+
export declare const TargetChangeSchema: GenMessage<TargetChange>;
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* The climate of one room.
|
|
63
|
+
*
|
|
64
|
+
* Apply as an upsert keyed on space_id: the same room is sent again whenever any of it
|
|
65
|
+
* that the recipient is sent moves (see state_withheld).
|
|
66
|
+
*
|
|
67
|
+
* @generated from message kusinta.iot.climate.v1.RoomClimate
|
|
68
|
+
*/
|
|
69
|
+
export declare type RoomClimate = Message<"kusinta.iot.climate.v1.RoomClimate"> & {
|
|
70
|
+
/**
|
|
71
|
+
* A Space of SPACE_TYPE_ROOM.
|
|
72
|
+
*
|
|
73
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
|
|
74
|
+
*/
|
|
75
|
+
spaceId?: SpaceId | undefined;
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* The temperature the room is to be held at, in centidegrees. Unset: nobody has set
|
|
79
|
+
* one. Always within [min_centidegrees, max_centidegrees] where those are set.
|
|
80
|
+
*
|
|
81
|
+
* @generated from field: optional sint32 target_centidegrees = 2;
|
|
82
|
+
*/
|
|
83
|
+
targetCentidegrees?: number | undefined;
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* Who or what set target_centidegrees. Unset while the target is, and when it is withheld
|
|
87
|
+
* from the recipient: from service in a home, and from anyone when it dates from before
|
|
88
|
+
* their current residency in the home, or from a home they did not live in at the time
|
|
89
|
+
* (see access.v1.MembershipRelation).
|
|
90
|
+
*
|
|
91
|
+
* @generated from field: kusinta.iot.climate.v1.TargetChange target_change = 3;
|
|
92
|
+
*/
|
|
93
|
+
targetChange?: TargetChange | undefined;
|
|
94
|
+
|
|
95
|
+
/**
|
|
96
|
+
* What the valves are actually being held at, in centidegrees. Equal to the target
|
|
97
|
+
* unless a ClimateMode on an enclosing space sets the room back — and then the room's
|
|
98
|
+
* own target again if somebody changed this room during the mode (see
|
|
99
|
+
* overrides_mode). Unset while nothing is being held.
|
|
100
|
+
*
|
|
101
|
+
* @generated from field: optional sint32 effective_target_centidegrees = 4;
|
|
102
|
+
*/
|
|
103
|
+
effectiveTargetCentidegrees?: number | undefined;
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* Set when somebody changed this room while a ClimateMode was on: the room keeps its
|
|
107
|
+
* own target until the mode ends, while the rest of the apartment stays set back.
|
|
108
|
+
*
|
|
109
|
+
* @generated from field: bool overrides_mode = 5;
|
|
110
|
+
*/
|
|
111
|
+
overridesMode: boolean;
|
|
112
|
+
|
|
113
|
+
/**
|
|
114
|
+
* The space whose ClimateMode applies to this room, if one does — set back or,
|
|
115
|
+
* with overrides_mode, overridden. Unset when no mode applies.
|
|
116
|
+
*
|
|
117
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId mode_space_id = 13;
|
|
118
|
+
*/
|
|
119
|
+
modeSpaceId?: SpaceId | undefined;
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* The owner's limits, in centidegrees. The gateway writes them to every device in the
|
|
123
|
+
* room (Matter Min/MaxHeatSetpointLimit), so a knob stops at them physically, and
|
|
124
|
+
* clamps every target — from the app, a knob or a mode — to them. The minimum is also
|
|
125
|
+
* the floor under a mode's setback.
|
|
126
|
+
*
|
|
127
|
+
* @generated from field: optional sint32 min_centidegrees = 6;
|
|
128
|
+
*/
|
|
129
|
+
minCentidegrees?: number | undefined;
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* @generated from field: optional sint32 max_centidegrees = 7;
|
|
133
|
+
*/
|
|
134
|
+
maxCentidegrees?: number | undefined;
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* The sensors the room measures with, in order: the first is used, each later one
|
|
138
|
+
* takes over while those before it are quiet. Only devices filed in this room.
|
|
139
|
+
*
|
|
140
|
+
* In a home, sensors its residents own come first, in the order they were filed, and then
|
|
141
|
+
* the building's; outside homes a room measures with the building's sensors only. The
|
|
142
|
+
* building's are by default every building temperature sensor filed in the room, in the
|
|
143
|
+
* order it was filed, so a sensor filed later joins at the end without anyone configuring
|
|
144
|
+
* anything; an owner can set their order explicitly (see sensors_configured). Empty: the
|
|
145
|
+
* room has no temperature sensor, and its valves regulate on their own probes
|
|
146
|
+
* (NO_SENSOR).
|
|
147
|
+
*
|
|
148
|
+
* @generated from field: repeated kusinta.iot.identity.v1.DeviceId sensor_ids = 8;
|
|
149
|
+
*/
|
|
150
|
+
sensorIds: DeviceId[];
|
|
151
|
+
|
|
152
|
+
/**
|
|
153
|
+
* Whether the building's part of sensor_ids is an order an owner chose, rather than the
|
|
154
|
+
* default of filing order. A building sensor filed into a room with a chosen order is
|
|
155
|
+
* not added to it; a resident's own always is. A sensor that becomes the building's in a
|
|
156
|
+
* room — released by its owner — counts as filed there at that moment.
|
|
157
|
+
*
|
|
158
|
+
* @generated from field: bool sensors_configured = 14;
|
|
159
|
+
*/
|
|
160
|
+
sensorsConfigured: boolean;
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* The reading steering the room now, in centidegrees, and which sensor it came from.
|
|
164
|
+
* measured_by unset while the valves are on their own probes.
|
|
165
|
+
*
|
|
166
|
+
* @generated from field: optional sint32 measured_centidegrees = 9;
|
|
167
|
+
*/
|
|
168
|
+
measuredCentidegrees?: number | undefined;
|
|
169
|
+
|
|
170
|
+
/**
|
|
171
|
+
* @generated from field: kusinta.iot.identity.v1.DeviceId measured_by = 10;
|
|
172
|
+
*/
|
|
173
|
+
measuredBy?: DeviceId | undefined;
|
|
174
|
+
|
|
175
|
+
/**
|
|
176
|
+
* @generated from field: kusinta.iot.climate.v1.RoomClimateCondition condition = 11;
|
|
177
|
+
*/
|
|
178
|
+
condition: RoomClimateCondition;
|
|
179
|
+
|
|
180
|
+
/**
|
|
181
|
+
* Whether the controls on this room's devices are locked. While unlocked, a change made
|
|
182
|
+
* by hand at a device becomes the room's target. Locked, the gateway sets the devices'
|
|
183
|
+
* own lock (Matter Thermostat User Interface Configuration KeypadLockout), so the
|
|
184
|
+
* refusal happens at the device rather than being undone later.
|
|
185
|
+
*
|
|
186
|
+
* Stated as the lock rather than as a permission so that the proto3 default — false,
|
|
187
|
+
* unlocked — is the intended default: a room nobody has configured takes changes at its
|
|
188
|
+
* devices, as a room in an apartment should until its residents decide otherwise; when a
|
|
189
|
+
* home loses its last resident, its rooms' locks are cleared. Elsewhere locking is the
|
|
190
|
+
* owner's choice.
|
|
191
|
+
*
|
|
192
|
+
* @generated from field: bool lock_device_controls = 12;
|
|
193
|
+
*/
|
|
194
|
+
lockDeviceControls: boolean;
|
|
195
|
+
|
|
196
|
+
/**
|
|
197
|
+
* Set when the recipient reaches this room only as service (see
|
|
198
|
+
* access.v1.MembershipRelation): the room is in someone's home, and what describes the
|
|
199
|
+
* people in it is WITHHELD — target_centidegrees, target_change,
|
|
200
|
+
* effective_target_centidegrees, overrides_mode, mode_space_id, measured_centidegrees,
|
|
201
|
+
* measured_by, condition and lock_device_controls are all left unset, and sensor_ids
|
|
202
|
+
* leaves out sensors a resident owns.
|
|
203
|
+
*
|
|
204
|
+
* Unset because withheld, not because unknown: an app must not render them as NO_TARGET or
|
|
205
|
+
* a lost sensor. A withheld room is sent again only when something that IS sent changes,
|
|
206
|
+
* so that the timing of an update does not give away what was withheld. Its limits and
|
|
207
|
+
* the sensors service may see are still sent, since setting a room up is service work.
|
|
208
|
+
* Its climate over time is available to service only as an ApartmentClimateSummary.
|
|
209
|
+
*
|
|
210
|
+
* explanations, target_held_until, planning and the comfort band are withheld in the
|
|
211
|
+
* same way.
|
|
212
|
+
*
|
|
213
|
+
* @generated from field: bool state_withheld = 15;
|
|
214
|
+
*/
|
|
215
|
+
stateWithheld: boolean;
|
|
216
|
+
|
|
217
|
+
/**
|
|
218
|
+
* Why the room is being held where it is, when that differs from simply holding its
|
|
219
|
+
* target: a plan heating ahead of an expensive hour, the heat source busy with hot water,
|
|
220
|
+
* a floor zone held back. Most significant first. An app that shows one shows the first
|
|
221
|
+
* it can show: a kind and subject it knows, a pair that kind lists, and not past its
|
|
222
|
+
* ends_at. Empty: nothing beyond the target and condition needs explaining.
|
|
223
|
+
*
|
|
224
|
+
* A window, a lost sensor and the rest of RoomClimateCondition are told by condition and
|
|
225
|
+
* never repeated here; a target a person set is told by target_change and
|
|
226
|
+
* target_held_until; whether the room is planned for at all is told by planning — one
|
|
227
|
+
* fact, one place.
|
|
228
|
+
*
|
|
229
|
+
* Sent with the room, so a replaced room replaces its list: an explanation absent from
|
|
230
|
+
* the latest RoomClimate no longer holds.
|
|
231
|
+
*
|
|
232
|
+
* @generated from field: repeated kusinta.iot.climate.v1.ClimateExplanation explanations = 16;
|
|
233
|
+
*/
|
|
234
|
+
explanations: ClimateExplanation[];
|
|
235
|
+
|
|
236
|
+
/**
|
|
237
|
+
* When a target a person set will next be moved by the gateway on its own — a schedule
|
|
238
|
+
* step, a plan taking over again. Unset: it holds until somebody changes it. Told so that
|
|
239
|
+
* a person is not surprised when their change ends. Unset whenever target_change is
|
|
240
|
+
* withheld from the recipient, for the same reasons: it describes the same change.
|
|
241
|
+
*
|
|
242
|
+
* @generated from field: google.protobuf.Timestamp target_held_until = 17;
|
|
243
|
+
*/
|
|
244
|
+
targetHeldUntil?: Timestamp | undefined;
|
|
245
|
+
|
|
246
|
+
/**
|
|
247
|
+
* Whether a plan steers the room. See RoomPlanning.
|
|
248
|
+
*
|
|
249
|
+
* @generated from field: kusinta.iot.climate.v1.RoomPlanning planning = 18;
|
|
250
|
+
*/
|
|
251
|
+
planning: RoomPlanning;
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
* The comfort band in force, in centidegrees: the lowest and highest a plan may hold the
|
|
255
|
+
* room at while it heats ahead, coasts or saves on dear energy. Both set or neither, low
|
|
256
|
+
* no higher than high, and within [min_centidegrees, max_centidegrees] where those are
|
|
257
|
+
* set. Absent: no band, and a plan holds the room at its target — never 0 °C.
|
|
258
|
+
*
|
|
259
|
+
* @generated from field: optional sint32 comfort_band_low_centidegrees = 19;
|
|
260
|
+
*/
|
|
261
|
+
comfortBandLowCentidegrees?: number | undefined;
|
|
262
|
+
|
|
263
|
+
/**
|
|
264
|
+
* @generated from field: optional sint32 comfort_band_high_centidegrees = 20;
|
|
265
|
+
*/
|
|
266
|
+
comfortBandHighCentidegrees?: number | undefined;
|
|
267
|
+
};
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* Describes the message kusinta.iot.climate.v1.RoomClimate.
|
|
271
|
+
* Use `create(RoomClimateSchema)` to create a new message.
|
|
272
|
+
*/
|
|
273
|
+
export declare const RoomClimateSchema: GenMessage<RoomClimate>;
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* One reason a room, or a part of its heating, is where it is.
|
|
277
|
+
*
|
|
278
|
+
* @generated from message kusinta.iot.climate.v1.ClimateExplanation
|
|
279
|
+
*/
|
|
280
|
+
export declare type ClimateExplanation = Message<"kusinta.iot.climate.v1.ClimateExplanation"> & {
|
|
281
|
+
/**
|
|
282
|
+
* @generated from field: kusinta.iot.climate.v1.ClimateExplanationKind kind = 1;
|
|
283
|
+
*/
|
|
284
|
+
kind: ClimateExplanationKind;
|
|
285
|
+
|
|
286
|
+
/**
|
|
287
|
+
* What the cause acts on. The gateway always sets it. An app shows nothing for an
|
|
288
|
+
* explanation whose subject is unspecified or unknown to it, rather than presenting it
|
|
289
|
+
* as the room's.
|
|
290
|
+
*
|
|
291
|
+
* @generated from field: kusinta.iot.climate.v1.ClimateExplanationSubject subject = 2;
|
|
292
|
+
*/
|
|
293
|
+
subject: ClimateExplanationSubject;
|
|
294
|
+
|
|
295
|
+
/**
|
|
296
|
+
* When the explanation stops holding. Unset: while the room's latest RoomClimate carries
|
|
297
|
+
* it. An app MUST NOT show an explanation past its ends_at, also while it cannot reach
|
|
298
|
+
* the gateway, and while it cannot reach the gateway it shows none without an ends_at:
|
|
299
|
+
* an explanation that outlives its window is a claim about the room nobody is making any
|
|
300
|
+
* more. An explanation that holds because of a leased write ends no later than that
|
|
301
|
+
* lease, after which the output is back at its lapse value whatever the gateway does.
|
|
302
|
+
*
|
|
303
|
+
* @generated from field: google.protobuf.Timestamp ends_at = 3;
|
|
304
|
+
*/
|
|
305
|
+
endsAt?: Timestamp | undefined;
|
|
306
|
+
};
|
|
307
|
+
|
|
308
|
+
/**
|
|
309
|
+
* Describes the message kusinta.iot.climate.v1.ClimateExplanation.
|
|
310
|
+
* Use `create(ClimateExplanationSchema)` to create a new message.
|
|
311
|
+
*/
|
|
312
|
+
export declare const ClimateExplanationSchema: GenMessage<ClimateExplanation>;
|
|
313
|
+
|
|
314
|
+
/**
|
|
315
|
+
* A mode on a home ends when whoever switched it on stops being one of its residents: a new
|
|
316
|
+
* tenant does not inherit the previous one's holiday. A mode on a room ends when the room
|
|
317
|
+
* joins a home, whose rooms follow the apartment's mode alone. Any other mode — one switched on by
|
|
318
|
+
* someone who is not one of its residents now: who never lived there, or a member still
|
|
319
|
+
* recorded with no relation — ends when the
|
|
320
|
+
* home gains a resident: when anyone other than its setter, not already its resident, is
|
|
321
|
+
* assigned RESIDENT on the apartment, a member recorded with no relation included, or the
|
|
322
|
+
* space becomes an apartment with RESIDENT members on it other than its setter. A mode's
|
|
323
|
+
* setter recorded with no relation being assigned RESIDENT ends none of their own modes;
|
|
324
|
+
* being assigned SERVICE or removed ends them.
|
|
325
|
+
*
|
|
326
|
+
* A mode set on an apartment — or, for rooms that are not in one, on their floor or
|
|
327
|
+
* common area. While it is on it sets back every room below that space, except that a
|
|
328
|
+
* room inside an apartment follows only its apartment's mode: a mode on a floor does not
|
|
329
|
+
* reach into the flats on it. Where more than one mode could apply, the nearest enclosing
|
|
330
|
+
* space's wins. A room somebody changes during the mode keeps its own target
|
|
331
|
+
* (RoomClimate.overrides_mode) until the mode ends.
|
|
332
|
+
*
|
|
333
|
+
* @generated from message kusinta.iot.climate.v1.ClimateMode
|
|
334
|
+
*/
|
|
335
|
+
export declare type ClimateMode = Message<"kusinta.iot.climate.v1.ClimateMode"> & {
|
|
336
|
+
/**
|
|
337
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
|
|
338
|
+
*/
|
|
339
|
+
spaceId?: SpaceId | undefined;
|
|
340
|
+
|
|
341
|
+
/**
|
|
342
|
+
* @generated from field: kusinta.iot.climate.v1.ClimateModeKind kind = 2;
|
|
343
|
+
*/
|
|
344
|
+
kind: ClimateModeKind;
|
|
345
|
+
|
|
346
|
+
/**
|
|
347
|
+
* The temperature every room is set back to, in centidegrees. Required while a mode is
|
|
348
|
+
* on — a mode with nothing to set back to is refused, not defaulted. Clamped by each
|
|
349
|
+
* room's min_centidegrees, which is the frost floor.
|
|
350
|
+
*
|
|
351
|
+
* @generated from field: optional sint32 setback_centidegrees = 3;
|
|
352
|
+
*/
|
|
353
|
+
setbackCentidegrees?: number | undefined;
|
|
354
|
+
|
|
355
|
+
/**
|
|
356
|
+
* HOLIDAY: when the setback begins and when the rooms are to be back at their own
|
|
357
|
+
* targets — warm by then, not starting to heat (see warm_from). AWAY: starts_at is when it
|
|
358
|
+
* was switched on; ends_at is unset. starts_at is unset when it dates from before the
|
|
359
|
+
* recipient's current residency in the home, or from a home they did not live in at the
|
|
360
|
+
* time; an ends_at ahead is always sent.
|
|
361
|
+
*
|
|
362
|
+
* @generated from field: google.protobuf.Timestamp starts_at = 4;
|
|
363
|
+
*/
|
|
364
|
+
startsAt?: Timestamp | undefined;
|
|
365
|
+
|
|
366
|
+
/**
|
|
367
|
+
* @generated from field: google.protobuf.Timestamp ends_at = 5;
|
|
368
|
+
*/
|
|
369
|
+
endsAt?: Timestamp | undefined;
|
|
370
|
+
|
|
371
|
+
/**
|
|
372
|
+
* Who switched it on. Unset when it is withheld from the recipient: from service in a
|
|
373
|
+
* home, and from anyone when it dates from before their current residency in the home, or
|
|
374
|
+
* from a home they did not live in at the time (see access.v1.MembershipRelation).
|
|
375
|
+
*
|
|
376
|
+
* @generated from field: kusinta.iot.identity.v1.UserId set_by = 6;
|
|
377
|
+
*/
|
|
378
|
+
setBy?: UserId | undefined;
|
|
379
|
+
|
|
380
|
+
/**
|
|
381
|
+
* Read-only: filled by the gateway, ignored if sent to it. The moment the setback ends
|
|
382
|
+
* ahead of ends_at, so that the rooms are warm by ends_at. Absent when there is no
|
|
383
|
+
* lead — an AWAY mode, or one the gateway has not computed.
|
|
384
|
+
*
|
|
385
|
+
* @generated from field: optional google.protobuf.Timestamp warm_from = 7;
|
|
386
|
+
*/
|
|
387
|
+
warmFrom?: Timestamp | undefined;
|
|
388
|
+
};
|
|
389
|
+
|
|
390
|
+
/**
|
|
391
|
+
* Describes the message kusinta.iot.climate.v1.ClimateMode.
|
|
392
|
+
* Use `create(ClimateModeSchema)` to create a new message.
|
|
393
|
+
*/
|
|
394
|
+
export declare const ClimateModeSchema: GenMessage<ClimateMode>;
|
|
395
|
+
|
|
396
|
+
/**
|
|
397
|
+
* Every room climate and mode a caller may see, in reply to a listing.
|
|
398
|
+
*
|
|
399
|
+
* @generated from message kusinta.iot.climate.v1.RoomClimateList
|
|
400
|
+
*/
|
|
401
|
+
export declare type RoomClimateList = Message<"kusinta.iot.climate.v1.RoomClimateList"> & {
|
|
402
|
+
/**
|
|
403
|
+
* @generated from field: repeated kusinta.iot.climate.v1.RoomClimate rooms = 1;
|
|
404
|
+
*/
|
|
405
|
+
rooms: RoomClimate[];
|
|
406
|
+
|
|
407
|
+
/**
|
|
408
|
+
* @generated from field: repeated kusinta.iot.climate.v1.ClimateMode modes = 2;
|
|
409
|
+
*/
|
|
410
|
+
modes: ClimateMode[];
|
|
411
|
+
};
|
|
412
|
+
|
|
413
|
+
/**
|
|
414
|
+
* Describes the message kusinta.iot.climate.v1.RoomClimateList.
|
|
415
|
+
* Use `create(RoomClimateListSchema)` to create a new message.
|
|
416
|
+
*/
|
|
417
|
+
export declare const RoomClimateListSchema: GenMessage<RoomClimateList>;
|
|
418
|
+
|
|
419
|
+
/**
|
|
420
|
+
* One fixed 15-minute bucket of a room's history. Every reading is optional: absent
|
|
421
|
+
* means nothing was known for that bucket, never zero.
|
|
422
|
+
*
|
|
423
|
+
* @generated from message kusinta.iot.climate.v1.RoomHistorySample
|
|
424
|
+
*/
|
|
425
|
+
export declare type RoomHistorySample = Message<"kusinta.iot.climate.v1.RoomHistorySample"> & {
|
|
426
|
+
/**
|
|
427
|
+
* The start of the bucket. Buckets are fixed 15-minute intervals aligned to UTC
|
|
428
|
+
* quarter hours (:00, :15, :30, :45).
|
|
429
|
+
*
|
|
430
|
+
* @generated from field: google.protobuf.Timestamp at = 1;
|
|
431
|
+
*/
|
|
432
|
+
at?: Timestamp | undefined;
|
|
433
|
+
|
|
434
|
+
/**
|
|
435
|
+
* The mean of the room's measured temperature over the bucket, in centidegrees.
|
|
436
|
+
*
|
|
437
|
+
* @generated from field: optional sint32 measured_centidegrees = 2;
|
|
438
|
+
*/
|
|
439
|
+
measuredCentidegrees?: number | undefined;
|
|
440
|
+
|
|
441
|
+
/**
|
|
442
|
+
* RoomClimate.target_centidegrees and .effective_target_centidegrees as they were in
|
|
443
|
+
* force at the bucket's start, in centidegrees.
|
|
444
|
+
*
|
|
445
|
+
* @generated from field: optional sint32 target_centidegrees = 3;
|
|
446
|
+
*/
|
|
447
|
+
targetCentidegrees?: number | undefined;
|
|
448
|
+
|
|
449
|
+
/**
|
|
450
|
+
* @generated from field: optional sint32 effective_target_centidegrees = 4;
|
|
451
|
+
*/
|
|
452
|
+
effectiveTargetCentidegrees?: number | undefined;
|
|
453
|
+
|
|
454
|
+
/**
|
|
455
|
+
* The mean opening over the bucket across the room's valves that report one, in
|
|
456
|
+
* thousandths of fully open. Absent if none of them does.
|
|
457
|
+
*
|
|
458
|
+
* @generated from field: optional uint32 valve_open_permille = 5;
|
|
459
|
+
*/
|
|
460
|
+
valveOpenPermille?: number | undefined;
|
|
461
|
+
|
|
462
|
+
/**
|
|
463
|
+
* The seconds within the bucket during which any of the room's valves was open.
|
|
464
|
+
*
|
|
465
|
+
* @generated from field: optional uint32 valve_open_seconds = 6;
|
|
466
|
+
*/
|
|
467
|
+
valveOpenSeconds?: number | undefined;
|
|
468
|
+
|
|
469
|
+
/**
|
|
470
|
+
* The seconds within the bucket during which any floor zone heating the room was heating
|
|
471
|
+
* (heating.v1.FloorZone), counted from the contact state the zone's output reports, read
|
|
472
|
+
* through its closed_value, not from what was commanded. Kept apart from the valve
|
|
473
|
+
* fields: a zone's duty and a valve's opening are different controls with different time
|
|
474
|
+
* scales. Absent where no floor zone heats the room.
|
|
475
|
+
*
|
|
476
|
+
* @generated from field: optional uint32 floor_heating_seconds = 7;
|
|
477
|
+
*/
|
|
478
|
+
floorHeatingSeconds?: number | undefined;
|
|
479
|
+
};
|
|
480
|
+
|
|
481
|
+
/**
|
|
482
|
+
* Describes the message kusinta.iot.climate.v1.RoomHistorySample.
|
|
483
|
+
* Use `create(RoomHistorySampleSchema)` to create a new message.
|
|
484
|
+
*/
|
|
485
|
+
export declare const RoomHistorySampleSchema: GenMessage<RoomHistorySample>;
|
|
486
|
+
|
|
487
|
+
/**
|
|
488
|
+
* A room's history, in reply to GetRoomHistory.
|
|
489
|
+
*
|
|
490
|
+
* @generated from message kusinta.iot.climate.v1.RoomHistory
|
|
491
|
+
*/
|
|
492
|
+
export declare type RoomHistory = Message<"kusinta.iot.climate.v1.RoomHistory"> & {
|
|
493
|
+
/**
|
|
494
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId room_id = 1;
|
|
495
|
+
*/
|
|
496
|
+
roomId?: SpaceId | undefined;
|
|
497
|
+
|
|
498
|
+
/**
|
|
499
|
+
* The earliest moment the gateway still holds for this room. The request's from_time
|
|
500
|
+
* and to_time are clamped to [kept_from, now], so nothing before kept_from is ever
|
|
501
|
+
* returned. For a room in the recipient's own home it is no earlier than the start of
|
|
502
|
+
* their current residency, nor than when the room last joined their home; for any other
|
|
503
|
+
* room, no earlier than when it last left a home.
|
|
504
|
+
*
|
|
505
|
+
* @generated from field: google.protobuf.Timestamp kept_from = 2;
|
|
506
|
+
*/
|
|
507
|
+
keptFrom?: Timestamp | undefined;
|
|
508
|
+
|
|
509
|
+
/**
|
|
510
|
+
* The buckets within the clamped range, in order of `at`.
|
|
511
|
+
*
|
|
512
|
+
* @generated from field: repeated kusinta.iot.climate.v1.RoomHistorySample samples = 3;
|
|
513
|
+
*/
|
|
514
|
+
samples: RoomHistorySample[];
|
|
515
|
+
};
|
|
516
|
+
|
|
517
|
+
/**
|
|
518
|
+
* Describes the message kusinta.iot.climate.v1.RoomHistory.
|
|
519
|
+
* Use `create(RoomHistorySchema)` to create a new message.
|
|
520
|
+
*/
|
|
521
|
+
export declare const RoomHistorySchema: GenMessage<RoomHistory>;
|
|
522
|
+
|
|
523
|
+
/**
|
|
524
|
+
* An apartment's climate over one period.
|
|
525
|
+
*
|
|
526
|
+
* Each room's mean is taken over the quarter hours of the period in which it was in this
|
|
527
|
+
* apartment and had a value; coverage likewise counts only the quarter hours it was here,
|
|
528
|
+
* and the apartment's mean is formed from the rooms' means as the summary's weighting says.
|
|
529
|
+
* Every mean is optional: absent means nothing was known, never zero.
|
|
530
|
+
*
|
|
531
|
+
* @generated from message kusinta.iot.climate.v1.ClimatePeriodMean
|
|
532
|
+
*/
|
|
533
|
+
export declare type ClimatePeriodMean = Message<"kusinta.iot.climate.v1.ClimatePeriodMean"> & {
|
|
534
|
+
/**
|
|
535
|
+
* The period, half-open: starts_at <= t < ends_at.
|
|
536
|
+
*
|
|
537
|
+
* @generated from field: google.protobuf.Timestamp starts_at = 1;
|
|
538
|
+
*/
|
|
539
|
+
startsAt?: Timestamp | undefined;
|
|
540
|
+
|
|
541
|
+
/**
|
|
542
|
+
* @generated from field: google.protobuf.Timestamp ends_at = 2;
|
|
543
|
+
*/
|
|
544
|
+
endsAt?: Timestamp | undefined;
|
|
545
|
+
|
|
546
|
+
/**
|
|
547
|
+
* The mean measured temperature, in centidegrees, taken from the building's own sensors
|
|
548
|
+
* only: in each room, the first of its building sensors that was heard. A reading from a
|
|
549
|
+
* sensor a resident owns never enters it.
|
|
550
|
+
*
|
|
551
|
+
* @generated from field: optional sint32 measured_centidegrees = 3;
|
|
552
|
+
*/
|
|
553
|
+
measuredCentidegrees?: number | undefined;
|
|
554
|
+
|
|
555
|
+
/**
|
|
556
|
+
* The mean target, in centidegrees: RoomClimate.target_centidegrees — the temperature
|
|
557
|
+
* somebody asked for, not the effective target a mode set it back to, so that a
|
|
558
|
+
* setback is not reported as what the residents chose. The measured mean still falls
|
|
559
|
+
* while a home is set back; how much that reveals is governed by how long a period
|
|
560
|
+
* service may ask for (webrtc.v1.PrivacyDisclosure.climate_summary_period).
|
|
561
|
+
*
|
|
562
|
+
* @generated from field: optional sint32 target_centidegrees = 4;
|
|
563
|
+
*/
|
|
564
|
+
targetCentidegrees?: number | undefined;
|
|
565
|
+
|
|
566
|
+
/**
|
|
567
|
+
* How much of the period the means rest on, in thousandths: the quarter hours with a
|
|
568
|
+
* value, summed over the apartment's rooms, divided by the quarter hours each room was in
|
|
569
|
+
* the apartment during the period, summed likewise. A room with no sensor, or one that
|
|
570
|
+
* went quiet, lowers it — a mean with low coverage describes part of the apartment, or
|
|
571
|
+
* part of the period.
|
|
572
|
+
*
|
|
573
|
+
* @generated from field: uint32 measured_coverage_permille = 5;
|
|
574
|
+
*/
|
|
575
|
+
measuredCoveragePermille: number;
|
|
576
|
+
|
|
577
|
+
/**
|
|
578
|
+
* @generated from field: uint32 target_coverage_permille = 6;
|
|
579
|
+
*/
|
|
580
|
+
targetCoveragePermille: number;
|
|
581
|
+
|
|
582
|
+
/**
|
|
583
|
+
* The rooms that contributed a measured value, of the rooms the apartment had at any time
|
|
584
|
+
* in the period.
|
|
585
|
+
*
|
|
586
|
+
* @generated from field: uint32 rooms_measured = 7;
|
|
587
|
+
*/
|
|
588
|
+
roomsMeasured: number;
|
|
589
|
+
|
|
590
|
+
/**
|
|
591
|
+
* @generated from field: uint32 rooms = 8;
|
|
592
|
+
*/
|
|
593
|
+
rooms: number;
|
|
594
|
+
};
|
|
595
|
+
|
|
596
|
+
/**
|
|
597
|
+
* Describes the message kusinta.iot.climate.v1.ClimatePeriodMean.
|
|
598
|
+
* Use `create(ClimatePeriodMeanSchema)` to create a new message.
|
|
599
|
+
*/
|
|
600
|
+
export declare const ClimatePeriodMeanSchema: GenMessage<ClimatePeriodMean>;
|
|
601
|
+
|
|
602
|
+
/**
|
|
603
|
+
* An apartment's climate as means over whole periods, in reply to
|
|
604
|
+
* webrtc.v1.GetApartmentClimateSummary. What a party who does not live there may know of
|
|
605
|
+
* how warm it is kept — see webrtc.v1.PrivacyDisclosure.
|
|
606
|
+
*
|
|
607
|
+
* Only CLOSED periods are given. The period running now is never included, so that a
|
|
608
|
+
* summary cannot be polled into a live reading.
|
|
609
|
+
*
|
|
610
|
+
* @generated from message kusinta.iot.climate.v1.ApartmentClimateSummary
|
|
611
|
+
*/
|
|
612
|
+
export declare type ApartmentClimateSummary = Message<"kusinta.iot.climate.v1.ApartmentClimateSummary"> & {
|
|
613
|
+
/**
|
|
614
|
+
* @generated from field: kusinta.iot.identity.v1.SpaceId apartment_id = 1;
|
|
615
|
+
*/
|
|
616
|
+
apartmentId?: SpaceId | undefined;
|
|
617
|
+
|
|
618
|
+
/**
|
|
619
|
+
* @generated from field: kusinta.iot.climate.v1.ClimateSummaryPeriod period = 2;
|
|
620
|
+
*/
|
|
621
|
+
period: ClimateSummaryPeriod;
|
|
622
|
+
|
|
623
|
+
/**
|
|
624
|
+
* @generated from field: kusinta.iot.climate.v1.ClimateSummaryWeighting weighting = 3;
|
|
625
|
+
*/
|
|
626
|
+
weighting: ClimateSummaryWeighting;
|
|
627
|
+
|
|
628
|
+
/**
|
|
629
|
+
* The start of the earliest period the gateway still holds that the recipient may be
|
|
630
|
+
* given: for a resident of this apartment, no earlier than their current residency; for
|
|
631
|
+
* anyone else, of the length disclosed now, and no earlier than the first such period
|
|
632
|
+
* after it was last changed (see webrtc.v1.PrivacyDisclosure.climate_summary_period).
|
|
633
|
+
*
|
|
634
|
+
* @generated from field: google.protobuf.Timestamp kept_from = 4;
|
|
635
|
+
*/
|
|
636
|
+
keptFrom?: Timestamp | undefined;
|
|
637
|
+
|
|
638
|
+
/**
|
|
639
|
+
* The periods within the requested range, in order of starts_at.
|
|
640
|
+
*
|
|
641
|
+
* @generated from field: repeated kusinta.iot.climate.v1.ClimatePeriodMean periods = 5;
|
|
642
|
+
*/
|
|
643
|
+
periods: ClimatePeriodMean[];
|
|
644
|
+
};
|
|
645
|
+
|
|
646
|
+
/**
|
|
647
|
+
* Describes the message kusinta.iot.climate.v1.ApartmentClimateSummary.
|
|
648
|
+
* Use `create(ApartmentClimateSummarySchema)` to create a new message.
|
|
649
|
+
*/
|
|
650
|
+
export declare const ApartmentClimateSummarySchema: GenMessage<ApartmentClimateSummary>;
|
|
651
|
+
|
|
652
|
+
/**
|
|
653
|
+
* What a room is doing right now, in one word. Details live in the fields of
|
|
654
|
+
* RoomClimate; this is what a list row shows.
|
|
655
|
+
*
|
|
656
|
+
* Where several hold at once the room reports the first that applies, in this order:
|
|
657
|
+
* NO_TARGET, NO_HEATING, WINDOW_OPEN, HEATING_UNREACHABLE, SENSOR_LOST, NO_SENSOR,
|
|
658
|
+
* HOLDING — the one that most changes what a person should expect of the room.
|
|
659
|
+
*
|
|
660
|
+
* @generated from enum kusinta.iot.climate.v1.RoomClimateCondition
|
|
661
|
+
*/
|
|
662
|
+
export enum RoomClimateCondition {
|
|
663
|
+
/**
|
|
664
|
+
* @generated from enum value: ROOM_CLIMATE_CONDITION_UNSPECIFIED = 0;
|
|
665
|
+
*/
|
|
666
|
+
UNSPECIFIED = 0,
|
|
667
|
+
|
|
668
|
+
/**
|
|
669
|
+
* Being held at its effective target from a sensor's reading.
|
|
670
|
+
*
|
|
671
|
+
* @generated from enum value: ROOM_CLIMATE_CONDITION_HOLDING = 1;
|
|
672
|
+
*/
|
|
673
|
+
HOLDING = 1,
|
|
674
|
+
|
|
675
|
+
/**
|
|
676
|
+
* Nobody has set a target yet. Not a fault: a room that was just created.
|
|
677
|
+
*
|
|
678
|
+
* @generated from enum value: ROOM_CLIMATE_CONDITION_NO_TARGET = 2;
|
|
679
|
+
*/
|
|
680
|
+
NO_TARGET = 2,
|
|
681
|
+
|
|
682
|
+
/**
|
|
683
|
+
* Every sensor the room uses has gone quiet. The valves regulate on their own probes
|
|
684
|
+
* towards the target meanwhile — worse comfort, never a frozen reading.
|
|
685
|
+
*
|
|
686
|
+
* @generated from enum value: ROOM_CLIMATE_CONDITION_SENSOR_LOST = 3;
|
|
687
|
+
*/
|
|
688
|
+
SENSOR_LOST = 3,
|
|
689
|
+
|
|
690
|
+
/**
|
|
691
|
+
* A window in the room is open, so heating is paused.
|
|
692
|
+
*
|
|
693
|
+
* @generated from enum value: ROOM_CLIMATE_CONDITION_WINDOW_OPEN = 4;
|
|
694
|
+
*/
|
|
695
|
+
WINDOW_OPEN = 4,
|
|
696
|
+
|
|
697
|
+
/**
|
|
698
|
+
* The room has a target but nothing in it can heat.
|
|
699
|
+
*
|
|
700
|
+
* @generated from enum value: ROOM_CLIMATE_CONDITION_NO_HEATING = 5;
|
|
701
|
+
*/
|
|
702
|
+
NO_HEATING = 5,
|
|
703
|
+
|
|
704
|
+
/**
|
|
705
|
+
* Every heating device in the room has gone quiet, so nothing is being held however
|
|
706
|
+
* the target is set.
|
|
707
|
+
*
|
|
708
|
+
* @generated from enum value: ROOM_CLIMATE_CONDITION_HEATING_UNREACHABLE = 6;
|
|
709
|
+
*/
|
|
710
|
+
HEATING_UNREACHABLE = 6,
|
|
711
|
+
|
|
712
|
+
/**
|
|
713
|
+
* The room has no temperature sensor, so its valves regulate on their own probes
|
|
714
|
+
* towards the target. Not a fault; a room can be set up that way.
|
|
715
|
+
*
|
|
716
|
+
* @generated from enum value: ROOM_CLIMATE_CONDITION_NO_SENSOR = 7;
|
|
717
|
+
*/
|
|
718
|
+
NO_SENSOR = 7,
|
|
719
|
+
}
|
|
720
|
+
|
|
721
|
+
/**
|
|
722
|
+
* Describes the enum kusinta.iot.climate.v1.RoomClimateCondition.
|
|
723
|
+
*/
|
|
724
|
+
export declare const RoomClimateConditionSchema: GenEnum<RoomClimateCondition>;
|
|
725
|
+
|
|
726
|
+
/**
|
|
727
|
+
* Whether a plan steers a room: one that looks ahead at prices, weather and the heat
|
|
728
|
+
* source and moves the room within its comfort band. A standing state of the room, not a
|
|
729
|
+
* reason, so it is a field of its own rather than an explanation.
|
|
730
|
+
*
|
|
731
|
+
* @generated from enum kusinta.iot.climate.v1.RoomPlanning
|
|
732
|
+
*/
|
|
733
|
+
export enum RoomPlanning {
|
|
734
|
+
/**
|
|
735
|
+
* Not stated.
|
|
736
|
+
*
|
|
737
|
+
* @generated from enum value: ROOM_PLANNING_UNSPECIFIED = 0;
|
|
738
|
+
*/
|
|
739
|
+
UNSPECIFIED = 0,
|
|
740
|
+
|
|
741
|
+
/**
|
|
742
|
+
* A plan steers the room. Its explanations say what it is doing.
|
|
743
|
+
*
|
|
744
|
+
* @generated from enum value: ROOM_PLANNING_PLANNED = 1;
|
|
745
|
+
*/
|
|
746
|
+
PLANNED = 1,
|
|
747
|
+
|
|
748
|
+
/**
|
|
749
|
+
* No plan steers the room: planning is switched off for it, or was never set up. The
|
|
750
|
+
* room follows its target and schedule.
|
|
751
|
+
*
|
|
752
|
+
* @generated from enum value: ROOM_PLANNING_NOT_PLANNED = 2;
|
|
753
|
+
*/
|
|
754
|
+
NOT_PLANNED = 2,
|
|
755
|
+
|
|
756
|
+
/**
|
|
757
|
+
* A plan would steer the room but cannot be made — prices or a forecast are missing —
|
|
758
|
+
* so the room follows its target and schedule until one can.
|
|
759
|
+
*
|
|
760
|
+
* @generated from enum value: ROOM_PLANNING_UNAVAILABLE = 3;
|
|
761
|
+
*/
|
|
762
|
+
UNAVAILABLE = 3,
|
|
763
|
+
}
|
|
764
|
+
|
|
765
|
+
/**
|
|
766
|
+
* Describes the enum kusinta.iot.climate.v1.RoomPlanning.
|
|
767
|
+
*/
|
|
768
|
+
export declare const RoomPlanningSchema: GenEnum<RoomPlanning>;
|
|
769
|
+
|
|
770
|
+
/**
|
|
771
|
+
* What held a room, or a part of its heating, where it is. A closed list of causes: the
|
|
772
|
+
* gateway sends a kind, never a sentence, and the app names each kind in its user's
|
|
773
|
+
* language. What the cause acts on is ClimateExplanation.subject, and each kind lists the
|
|
774
|
+
* subjects it may carry. A pair a kind does not list is shown as nothing, so a pair added
|
|
775
|
+
* later reaches an older app as nothing rather than as a guess.
|
|
776
|
+
*
|
|
777
|
+
* No kind identifies another household or anything about one, its activity included.
|
|
778
|
+
* Where a limit is shared — a building's power, a shared heat source — the explanation
|
|
779
|
+
* says that this room was limited, never by whom or because of whom. A kind that a source
|
|
780
|
+
* or limit shared with other homes drives — HOT_WATER_PRIORITY on a shared heat source,
|
|
781
|
+
* SHARED_POWER_BUDGET, DISTRICT_HEATING_PEAK on a shared connection — is sent only where at
|
|
782
|
+
* least three homes share that source or limit, in rooms in homes and outside them alike.
|
|
783
|
+
* Below that, its onset and end would track another home's use as it happens, and the
|
|
784
|
+
* room carries no explanation for it.
|
|
785
|
+
*
|
|
786
|
+
* @generated from enum kusinta.iot.climate.v1.ClimateExplanationKind
|
|
787
|
+
*/
|
|
788
|
+
export enum ClimateExplanationKind {
|
|
789
|
+
/**
|
|
790
|
+
* Sender did not set a kind, or sent one this client's schema does not know. An app
|
|
791
|
+
* shows nothing for it rather than guessing.
|
|
792
|
+
*
|
|
793
|
+
* @generated from enum value: CLIMATE_EXPLANATION_KIND_UNSPECIFIED = 0;
|
|
794
|
+
*/
|
|
795
|
+
UNSPECIFIED = 0,
|
|
796
|
+
|
|
797
|
+
/**
|
|
798
|
+
* Heated ahead of a dearer or colder period, within the comfort band, so less is needed
|
|
799
|
+
* then. Subjects: ROOM, FLOOR_ZONE.
|
|
800
|
+
*
|
|
801
|
+
* @generated from enum value: CLIMATE_EXPLANATION_KIND_PRE_HEAT = 1;
|
|
802
|
+
*/
|
|
803
|
+
PRE_HEAT = 1,
|
|
804
|
+
|
|
805
|
+
/**
|
|
806
|
+
* Held back while stored heat carries the room, within the comfort band. Subjects: ROOM,
|
|
807
|
+
* FLOOR_ZONE.
|
|
808
|
+
*
|
|
809
|
+
* @generated from enum value: CLIMATE_EXPLANATION_KIND_COASTING = 2;
|
|
810
|
+
*/
|
|
811
|
+
COASTING = 2,
|
|
812
|
+
|
|
813
|
+
/**
|
|
814
|
+
* Held back while energy is expensive, within the comfort band. Subjects: ROOM,
|
|
815
|
+
* FLOOR_ZONE, COMFORT_LOAD, ADD_ON_HEATER.
|
|
816
|
+
*
|
|
817
|
+
* @generated from enum value: CLIMATE_EXPLANATION_KIND_PRICE_HIGH = 3;
|
|
818
|
+
*/
|
|
819
|
+
PRICE_HIGH = 3,
|
|
820
|
+
|
|
821
|
+
/**
|
|
822
|
+
* Held back to keep the home's own electricity use below a peak it is charged for.
|
|
823
|
+
* Subjects: ROOM, FLOOR_ZONE, COMFORT_LOAD, ADD_ON_HEATER.
|
|
824
|
+
*
|
|
825
|
+
* @generated from enum value: CLIMATE_EXPLANATION_KIND_PEAK_GUARD = 4;
|
|
826
|
+
*/
|
|
827
|
+
PEAK_GUARD = 4,
|
|
828
|
+
|
|
829
|
+
/**
|
|
830
|
+
* Paused while the heat source heats domestic hot water. Subjects: ROOM, FLOOR_ZONE.
|
|
831
|
+
*
|
|
832
|
+
* @generated from enum value: CLIMATE_EXPLANATION_KIND_HOT_WATER_PRIORITY = 5;
|
|
833
|
+
*/
|
|
834
|
+
HOT_WATER_PRIORITY = 5,
|
|
835
|
+
|
|
836
|
+
/**
|
|
837
|
+
* Held back to keep electricity that several homes share — a building's connection, a
|
|
838
|
+
* shared heat source — within its limit. Subjects: ROOM, FLOOR_ZONE, COMFORT_LOAD,
|
|
839
|
+
* ADD_ON_HEATER.
|
|
840
|
+
*
|
|
841
|
+
* @generated from enum value: CLIMATE_EXPLANATION_KIND_SHARED_POWER_BUDGET = 6;
|
|
842
|
+
*/
|
|
843
|
+
SHARED_POWER_BUDGET = 6,
|
|
844
|
+
|
|
845
|
+
/**
|
|
846
|
+
* Held back to keep a district-heating connection below its charged peak. Subjects:
|
|
847
|
+
* ROOM, FLOOR_ZONE.
|
|
848
|
+
*
|
|
849
|
+
* @generated from enum value: CLIMATE_EXPLANATION_KIND_DISTRICT_HEATING_PEAK = 7;
|
|
850
|
+
*/
|
|
851
|
+
DISTRICT_HEATING_PEAK = 7,
|
|
852
|
+
|
|
853
|
+
/**
|
|
854
|
+
* Not heated further because the room is at the top of its comfort band, even though
|
|
855
|
+
* energy is cheap. Subjects: ROOM, FLOOR_ZONE.
|
|
856
|
+
*
|
|
857
|
+
* @generated from enum value: CLIMATE_EXPLANATION_KIND_AT_COMFORT_CEILING = 8;
|
|
858
|
+
*/
|
|
859
|
+
AT_COMFORT_CEILING = 8,
|
|
860
|
+
|
|
861
|
+
/**
|
|
862
|
+
* Run on a cautious fixed share of the time because the reading that steers it has gone
|
|
863
|
+
* quiet. Subjects: FLOOR_ZONE only — a room's own lost sensor is told by condition. In
|
|
864
|
+
* the room whose sensor steers the zone, condition says the sensor is lost and this says
|
|
865
|
+
* what the zone does about it.
|
|
866
|
+
*
|
|
867
|
+
* @generated from enum value: CLIMATE_EXPLANATION_KIND_NO_READING = 9;
|
|
868
|
+
*/
|
|
869
|
+
NO_READING = 9,
|
|
870
|
+
|
|
871
|
+
/**
|
|
872
|
+
* Off because it is outside its time window — a heated floor kept warm for comfort, a
|
|
873
|
+
* towel heater. Subjects: COMFORT_LOAD only.
|
|
874
|
+
*
|
|
875
|
+
* @generated from enum value: CLIMATE_EXPLANATION_KIND_OUTSIDE_WINDOW = 10;
|
|
876
|
+
*/
|
|
877
|
+
OUTSIDE_WINDOW = 10,
|
|
878
|
+
}
|
|
879
|
+
|
|
880
|
+
/**
|
|
881
|
+
* Describes the enum kusinta.iot.climate.v1.ClimateExplanationKind.
|
|
882
|
+
*/
|
|
883
|
+
export declare const ClimateExplanationKindSchema: GenEnum<ClimateExplanationKind>;
|
|
884
|
+
|
|
885
|
+
/**
|
|
886
|
+
* What a cause acts on.
|
|
887
|
+
*
|
|
888
|
+
* @generated from enum kusinta.iot.climate.v1.ClimateExplanationSubject
|
|
889
|
+
*/
|
|
890
|
+
export enum ClimateExplanationSubject {
|
|
891
|
+
/**
|
|
892
|
+
* Sender did not set a subject, or sent one this client's schema does not know — some
|
|
893
|
+
* decoders read an unknown value as this one. Never the room as a whole.
|
|
894
|
+
*
|
|
895
|
+
* @generated from enum value: CLIMATE_EXPLANATION_SUBJECT_UNSPECIFIED = 0;
|
|
896
|
+
*/
|
|
897
|
+
UNSPECIFIED = 0,
|
|
898
|
+
|
|
899
|
+
/**
|
|
900
|
+
* The room's heating as a whole.
|
|
901
|
+
*
|
|
902
|
+
* @generated from enum value: CLIMATE_EXPLANATION_SUBJECT_ROOM = 1;
|
|
903
|
+
*/
|
|
904
|
+
ROOM = 1,
|
|
905
|
+
|
|
906
|
+
/**
|
|
907
|
+
* A floor zone heating this room. A zone's explanation is sent only in rooms on the same
|
|
908
|
+
* side of a home's boundary as the zone's control room: rooms in the same home as it, or
|
|
909
|
+
* rooms outside homes when it is outside one. A zone that heats rooms on both sides
|
|
910
|
+
* explains itself on its control room's side alone, so a fact withheld across that
|
|
911
|
+
* boundary does not cross it here.
|
|
912
|
+
*
|
|
913
|
+
* @generated from enum value: CLIMATE_EXPLANATION_SUBJECT_FLOOR_ZONE = 2;
|
|
914
|
+
*/
|
|
915
|
+
FLOOR_ZONE = 2,
|
|
916
|
+
|
|
917
|
+
/**
|
|
918
|
+
* A comfort load in the room: a heated floor kept warm for comfort, a towel heater.
|
|
919
|
+
*
|
|
920
|
+
* @generated from enum value: CLIMATE_EXPLANATION_SUBJECT_COMFORT_LOAD = 3;
|
|
921
|
+
*/
|
|
922
|
+
COMFORT_LOAD = 3,
|
|
923
|
+
|
|
924
|
+
/**
|
|
925
|
+
* The heat source's add-on heater.
|
|
926
|
+
*
|
|
927
|
+
* @generated from enum value: CLIMATE_EXPLANATION_SUBJECT_ADD_ON_HEATER = 4;
|
|
928
|
+
*/
|
|
929
|
+
ADD_ON_HEATER = 4,
|
|
930
|
+
}
|
|
931
|
+
|
|
932
|
+
/**
|
|
933
|
+
* Describes the enum kusinta.iot.climate.v1.ClimateExplanationSubject.
|
|
934
|
+
*/
|
|
935
|
+
export declare const ClimateExplanationSubjectSchema: GenEnum<ClimateExplanationSubject>;
|
|
936
|
+
|
|
937
|
+
/**
|
|
938
|
+
* A setback that applies to every room in a space while it is on.
|
|
939
|
+
*
|
|
940
|
+
* @generated from enum kusinta.iot.climate.v1.ClimateModeKind
|
|
941
|
+
*/
|
|
942
|
+
export enum ClimateModeKind {
|
|
943
|
+
/**
|
|
944
|
+
* No mode: every room at its own target.
|
|
945
|
+
*
|
|
946
|
+
* @generated from enum value: CLIMATE_MODE_KIND_UNSPECIFIED = 0;
|
|
947
|
+
*/
|
|
948
|
+
UNSPECIFIED = 0,
|
|
949
|
+
|
|
950
|
+
/**
|
|
951
|
+
* Every room to the setback until the mode is switched off.
|
|
952
|
+
*
|
|
953
|
+
* @generated from enum value: CLIMATE_MODE_KIND_AWAY = 1;
|
|
954
|
+
*/
|
|
955
|
+
AWAY = 1,
|
|
956
|
+
|
|
957
|
+
/**
|
|
958
|
+
* Every room to the setback between starts_at and ends_at, then back to normal on its
|
|
959
|
+
* own — timed so the rooms are warm again at ends_at, not starting to heat then.
|
|
960
|
+
*
|
|
961
|
+
* @generated from enum value: CLIMATE_MODE_KIND_HOLIDAY = 2;
|
|
962
|
+
*/
|
|
963
|
+
HOLIDAY = 2,
|
|
964
|
+
}
|
|
965
|
+
|
|
966
|
+
/**
|
|
967
|
+
* Describes the enum kusinta.iot.climate.v1.ClimateModeKind.
|
|
968
|
+
*/
|
|
969
|
+
export declare const ClimateModeKindSchema: GenEnum<ClimateModeKind>;
|
|
970
|
+
|
|
971
|
+
/**
|
|
972
|
+
* The length of the periods an ApartmentClimateSummary is given in. Each period runs from
|
|
973
|
+
* the start of one local date to the start of another in the building's time zone
|
|
974
|
+
* (space.v1.Space.time_zone) — midnight, or the first moment of the date where daylight
|
|
975
|
+
* saving skips midnight — so a day is 23 or 25 hours long across a change of daylight
|
|
976
|
+
* saving time. A period is cut by the time zone in force when it opened, and kept as cut.
|
|
977
|
+
* After a change of zone, the next period runs from that cut to the first boundary of its
|
|
978
|
+
* length in the new zone — a midnight, a Monday or a first of the month — that leaves it
|
|
979
|
+
* covering at least one whole day, week or month of the new zone's calendar, so no period
|
|
980
|
+
* covers less than one whole day, week or month of its calendar, however many hours that
|
|
981
|
+
* is. While the zone is unknown — never set, or cleared — nothing is summarised, and the
|
|
982
|
+
* period open when it was cleared ends unsummarised; once it is known again, the first
|
|
983
|
+
* period begins at the first boundary of its length after that.
|
|
984
|
+
*
|
|
985
|
+
* @generated from enum kusinta.iot.climate.v1.ClimateSummaryPeriod
|
|
986
|
+
*/
|
|
987
|
+
export enum ClimateSummaryPeriod {
|
|
988
|
+
/**
|
|
989
|
+
* @generated from enum value: CLIMATE_SUMMARY_PERIOD_UNSPECIFIED = 0;
|
|
990
|
+
*/
|
|
991
|
+
UNSPECIFIED = 0,
|
|
992
|
+
|
|
993
|
+
/**
|
|
994
|
+
* @generated from enum value: CLIMATE_SUMMARY_PERIOD_DAY = 1;
|
|
995
|
+
*/
|
|
996
|
+
DAY = 1,
|
|
997
|
+
|
|
998
|
+
/**
|
|
999
|
+
* ISO weeks, Monday to Monday.
|
|
1000
|
+
*
|
|
1001
|
+
* @generated from enum value: CLIMATE_SUMMARY_PERIOD_WEEK = 2;
|
|
1002
|
+
*/
|
|
1003
|
+
WEEK = 2,
|
|
1004
|
+
|
|
1005
|
+
/**
|
|
1006
|
+
* Calendar months.
|
|
1007
|
+
*
|
|
1008
|
+
* @generated from enum value: CLIMATE_SUMMARY_PERIOD_MONTH = 3;
|
|
1009
|
+
*/
|
|
1010
|
+
MONTH = 3,
|
|
1011
|
+
}
|
|
1012
|
+
|
|
1013
|
+
/**
|
|
1014
|
+
* Describes the enum kusinta.iot.climate.v1.ClimateSummaryPeriod.
|
|
1015
|
+
*/
|
|
1016
|
+
export declare const ClimateSummaryPeriodSchema: GenEnum<ClimateSummaryPeriod>;
|
|
1017
|
+
|
|
1018
|
+
/**
|
|
1019
|
+
* How an apartment's mean is formed from its rooms' means.
|
|
1020
|
+
*
|
|
1021
|
+
* @generated from enum kusinta.iot.climate.v1.ClimateSummaryWeighting
|
|
1022
|
+
*/
|
|
1023
|
+
export enum ClimateSummaryWeighting {
|
|
1024
|
+
/**
|
|
1025
|
+
* @generated from enum value: CLIMATE_SUMMARY_WEIGHTING_UNSPECIFIED = 0;
|
|
1026
|
+
*/
|
|
1027
|
+
UNSPECIFIED = 0,
|
|
1028
|
+
|
|
1029
|
+
/**
|
|
1030
|
+
* Each room counts once, whatever its size: a bathroom weighs as much as a living room.
|
|
1031
|
+
*
|
|
1032
|
+
* @generated from enum value: CLIMATE_SUMMARY_WEIGHTING_ROOMS_EQUAL = 1;
|
|
1033
|
+
*/
|
|
1034
|
+
ROOMS_EQUAL = 1,
|
|
1035
|
+
}
|
|
1036
|
+
|
|
1037
|
+
/**
|
|
1038
|
+
* Describes the enum kusinta.iot.climate.v1.ClimateSummaryWeighting.
|
|
1039
|
+
*/
|
|
1040
|
+
export declare const ClimateSummaryWeightingSchema: GenEnum<ClimateSummaryWeighting>;
|
|
1041
|
+
|