@kusinta/iot-schema 0.2.0-beta.4 → 0.2.0-beta.40

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.
Files changed (67) hide show
  1. package/package.json +12 -1
  2. package/src/kusinta/iot/access/v1/acl_pb.d.ts +119 -2
  3. package/src/kusinta/iot/access/v1/acl_pb.js +20 -3
  4. package/src/kusinta/iot/access/v1/roles_pb.d.ts +131 -4
  5. package/src/kusinta/iot/access/v1/roles_pb.js +110 -5
  6. package/src/kusinta/iot/accountlink/v1/account_link_pb.d.ts +583 -0
  7. package/src/kusinta/iot/accountlink/v1/account_link_pb.js +160 -0
  8. package/src/kusinta/iot/climate/v1/climate_pb.d.ts +1041 -0
  9. package/src/kusinta/iot/climate/v1/climate_pb.js +206 -0
  10. package/src/kusinta/iot/commissioning/v1/commissioning_pb.d.ts +1128 -0
  11. package/src/kusinta/iot/commissioning/v1/commissioning_pb.js +246 -0
  12. package/src/kusinta/iot/common/v1/pairing_pb.d.ts +217 -0
  13. package/src/kusinta/iot/common/v1/pairing_pb.js +50 -0
  14. package/src/kusinta/iot/common/v1/types_pb.d.ts +175 -0
  15. package/src/kusinta/iot/common/v1/types_pb.js +70 -1
  16. package/src/kusinta/iot/connector/v1/connector_pb.d.ts +691 -2
  17. package/src/kusinta/iot/connector/v1/connector_pb.js +104 -13
  18. package/src/kusinta/iot/device/v1/cluster_state_pb.d.ts +213 -1
  19. package/src/kusinta/iot/device/v1/cluster_state_pb.js +37 -2
  20. package/src/kusinta/iot/device/v1/descriptor_pb.d.ts +22 -2
  21. package/src/kusinta/iot/device/v1/descriptor_pb.js +2 -1
  22. package/src/kusinta/iot/device/v1/device_event_pb.d.ts +87 -5
  23. package/src/kusinta/iot/device/v1/device_event_pb.js +1 -1
  24. package/src/kusinta/iot/device/v1/device_pb.d.ts +164 -11
  25. package/src/kusinta/iot/device/v1/device_pb.js +33 -2
  26. package/src/kusinta/iot/device/v1/properties_pb.d.ts +26 -5
  27. package/src/kusinta/iot/device/v1/properties_pb.js +1 -1
  28. package/src/kusinta/iot/device/v1/property_update_pb.d.ts +28 -2
  29. package/src/kusinta/iot/device/v1/property_update_pb.js +2 -1
  30. package/src/kusinta/iot/heating/v1/heating_pb.d.ts +619 -0
  31. package/src/kusinta/iot/heating/v1/heating_pb.js +118 -0
  32. package/src/kusinta/iot/link/v1/link_pb.d.ts +438 -0
  33. package/src/kusinta/iot/link/v1/link_pb.js +121 -0
  34. package/src/kusinta/iot/registration/v1/registration_pb.d.ts +18 -0
  35. package/src/kusinta/iot/registration/v1/registration_pb.js +1 -1
  36. package/src/kusinta/iot/reporting/v1/reporting_pb.d.ts +1225 -0
  37. package/src/kusinta/iot/reporting/v1/reporting_pb.js +238 -0
  38. package/src/kusinta/iot/reporting/v1/reporting_service_pb.d.ts +63 -0
  39. package/src/kusinta/iot/reporting/v1/reporting_service_pb.js +24 -0
  40. package/src/kusinta/iot/signaling/v1/signaling_pb.d.ts +920 -7
  41. package/src/kusinta/iot/signaling/v1/signaling_pb.js +163 -4
  42. package/src/kusinta/iot/signaling/v1/signaling_service_pb.d.ts +24 -1
  43. package/src/kusinta/iot/signaling/v1/signaling_service_pb.js +1 -1
  44. package/src/kusinta/iot/space/v1/space_pb.d.ts +107 -2
  45. package/src/kusinta/iot/space/v1/space_pb.js +10 -1
  46. package/src/kusinta/iot/vendor/homematic/v1/homematic_pb.d.ts +19 -3
  47. package/src/kusinta/iot/vendor/homematic/v1/homematic_pb.js +1 -1
  48. package/src/kusinta/iot/vendor/lorawan/v1/lorawan_pb.d.ts +69 -0
  49. package/src/kusinta/iot/vendor/lorawan/v1/lorawan_pb.js +19 -0
  50. package/src/kusinta/iot/vendor/v1/vendor_options_pb.d.ts +4 -4
  51. package/src/kusinta/iot/vendor/v1/vendor_options_pb.js +4 -4
  52. package/src/kusinta/iot/webrtc/v1/app_token_pb.d.ts +48 -5
  53. package/src/kusinta/iot/webrtc/v1/app_token_pb.js +1 -1
  54. package/src/kusinta/iot/webrtc/v1/command_pb.d.ts +56 -0
  55. package/src/kusinta/iot/webrtc/v1/command_pb.js +1 -1
  56. package/src/kusinta/iot/webrtc/v1/device_state_pb.d.ts +179 -5
  57. package/src/kusinta/iot/webrtc/v1/device_state_pb.js +35 -6
  58. package/src/kusinta/iot/webrtc/v1/envelope_pb.d.ts +607 -3
  59. package/src/kusinta/iot/webrtc/v1/envelope_pb.js +68 -3
  60. package/src/kusinta/iot/webrtc/v1/invite_pb.d.ts +498 -0
  61. package/src/kusinta/iot/webrtc/v1/invite_pb.js +108 -0
  62. package/src/kusinta/iot/webrtc/v1/management_pb.d.ts +1687 -75
  63. package/src/kusinta/iot/webrtc/v1/management_pb.js +261 -5
  64. package/src/kusinta/iot/webrtc/v1/members_pb.d.ts +536 -0
  65. package/src/kusinta/iot/webrtc/v1/members_pb.js +113 -0
  66. package/src/kusinta/iot/webrtc/v1/permission_push_pb.d.ts +66 -4
  67. package/src/kusinta/iot/webrtc/v1/permission_push_pb.js +10 -2
@@ -0,0 +1,1128 @@
1
+ // @generated by protoc-gen-es v2.12.0 with parameter "target=js+dts,import_extension=js"
2
+ // @generated from file kusinta/iot/commissioning/v1/commissioning.proto (package kusinta.iot.commissioning.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
+ import type { AttributeValue } from "../../device/v1/cluster_state_pb.js";
10
+
11
+ /**
12
+ * Describes the file kusinta/iot/commissioning/v1/commissioning.proto.
13
+ */
14
+ export declare const file_kusinta_iot_commissioning_v1_commissioning: GenFile;
15
+
16
+ /**
17
+ * Who answered, how and when. Set by the gateway from the caller, never taken from a put,
18
+ * save evidence.
19
+ *
20
+ * @generated from message kusinta.iot.commissioning.v1.Provenance
21
+ */
22
+ export declare type Provenance = Message<"kusinta.iot.commissioning.v1.Provenance"> & {
23
+ /**
24
+ * @generated from field: kusinta.iot.commissioning.v1.Party party = 1;
25
+ */
26
+ party: Party;
27
+
28
+ /**
29
+ * @generated from field: kusinta.iot.commissioning.v1.Evidence evidence = 2;
30
+ */
31
+ evidence: Evidence;
32
+
33
+ /**
34
+ * @generated from field: google.protobuf.Timestamp at = 3;
35
+ */
36
+ at?: Timestamp | undefined;
37
+
38
+ /**
39
+ * Unset for AUTOMATIC, and after a household handover. On a home's facts and tests it is
40
+ * given to the home's residents, and to an installer only on what that installer put,
41
+ * started or concluded; to anyone else it is left unset, with party kept.
42
+ *
43
+ * @generated from field: kusinta.iot.identity.v1.UserId by = 4;
44
+ */
45
+ by?: UserId | undefined;
46
+ };
47
+
48
+ /**
49
+ * Describes the message kusinta.iot.commissioning.v1.Provenance.
50
+ * Use `create(ProvenanceSchema)` to create a new message.
51
+ */
52
+ export declare const ProvenanceSchema: GenMessage<Provenance>;
53
+
54
+ /**
55
+ * One heating record (heating.v1), or one binding of it. An output is always named by its
56
+ * proto field name as the heating record puts name it ("output", "sg_ready_block", ...),
57
+ * even a record's only one; an empty field is the record itself, never an output.
58
+ *
59
+ * @generated from message kusinta.iot.commissioning.v1.BindingRef
60
+ */
61
+ export declare type BindingRef = Message<"kusinta.iot.commissioning.v1.BindingRef"> & {
62
+ /**
63
+ * @generated from field: string record_id = 1;
64
+ */
65
+ recordId: string;
66
+
67
+ /**
68
+ * @generated from field: string field = 2;
69
+ */
70
+ field: string;
71
+ };
72
+
73
+ /**
74
+ * Describes the message kusinta.iot.commissioning.v1.BindingRef.
75
+ * Use `create(BindingRefSchema)` to create a new message.
76
+ */
77
+ export declare const BindingRefSchema: GenMessage<BindingRef>;
78
+
79
+ /**
80
+ * One version of a house template.
81
+ *
82
+ * @generated from message kusinta.iot.commissioning.v1.TemplateRef
83
+ */
84
+ export declare type TemplateRef = Message<"kusinta.iot.commissioning.v1.TemplateRef"> & {
85
+ /**
86
+ * @generated from field: string template_id = 1;
87
+ */
88
+ templateId: string;
89
+
90
+ /**
91
+ * @generated from field: uint32 version = 2;
92
+ */
93
+ version: number;
94
+ };
95
+
96
+ /**
97
+ * Describes the message kusinta.iot.commissioning.v1.TemplateRef.
98
+ * Use `create(TemplateRefSchema)` to create a new message.
99
+ */
100
+ export declare const TemplateRefSchema: GenMessage<TemplateRef>;
101
+
102
+ /**
103
+ * @generated from message kusinta.iot.commissioning.v1.CommissioningFact
104
+ */
105
+ export declare type CommissioningFact = Message<"kusinta.iot.commissioning.v1.CommissioningFact"> & {
106
+ /**
107
+ * Assigned by the gateway, opaque; empty when creating.
108
+ *
109
+ * @generated from field: string fact_id = 1;
110
+ */
111
+ factId: string;
112
+
113
+ /**
114
+ * The space the fact is about: a building, a home or a room.
115
+ *
116
+ * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 2;
117
+ */
118
+ spaceId?: SpaceId | undefined;
119
+
120
+ /**
121
+ * A heating record within that space the fact is about. Empty: the space itself.
122
+ *
123
+ * @generated from field: string record_id = 3;
124
+ */
125
+ recordId: string;
126
+
127
+ /**
128
+ * @generated from field: string key = 4;
129
+ */
130
+ key: string;
131
+
132
+ /**
133
+ * @generated from oneof kusinta.iot.commissioning.v1.CommissioningFact.answer
134
+ */
135
+ answer: {
136
+ /**
137
+ * @generated from field: kusinta.iot.device.v1.AttributeValue value = 5;
138
+ */
139
+ value: AttributeValue;
140
+ case: "value";
141
+ } | {
142
+ /**
143
+ * "Don't know": an answer, which lists the fact as a need for the next party who can
144
+ * answer it. Only true is sent; false is refused.
145
+ *
146
+ * @generated from field: bool unknown = 6;
147
+ */
148
+ value: boolean;
149
+ case: "unknown";
150
+ } | { case: undefined; value?: undefined };
151
+
152
+ /**
153
+ * From the gateway's catalogue.
154
+ *
155
+ * @generated from field: kusinta.iot.commissioning.v1.Party answerer = 7;
156
+ */
157
+ answerer: Party;
158
+
159
+ /**
160
+ * @generated from field: kusinta.iot.commissioning.v1.Necessity necessity = 8;
161
+ */
162
+ necessity: Necessity;
163
+
164
+ /**
165
+ * For FOR_FEATURE.
166
+ *
167
+ * @generated from field: kusinta.iot.commissioning.v1.Feature feature = 9;
168
+ */
169
+ feature: Feature;
170
+
171
+ /**
172
+ * @generated from field: kusinta.iot.commissioning.v1.Provenance provenance = 10;
173
+ */
174
+ provenance?: Provenance | undefined;
175
+
176
+ /**
177
+ * Set by the gateway and bumped by every change; a put that replaces a fact, and a
178
+ * remove, names the revision it acts on.
179
+ *
180
+ * @generated from field: uint64 revision = 13;
181
+ */
182
+ revision: bigint;
183
+
184
+ /**
185
+ * Set: this answer departs from that version of a template, the home's when it was
186
+ * recorded.
187
+ *
188
+ * @generated from field: kusinta.iot.commissioning.v1.TemplateRef deviates_from = 15;
189
+ */
190
+ deviatesFrom?: TemplateRef | undefined;
191
+
192
+ /**
193
+ * From the gateway's catalogue.
194
+ *
195
+ * @generated from field: kusinta.iot.commissioning.v1.FactTopic topic = 16;
196
+ */
197
+ topic: FactTopic;
198
+ };
199
+
200
+ /**
201
+ * Describes the message kusinta.iot.commissioning.v1.CommissioningFact.
202
+ * Use `create(CommissioningFactSchema)` to create a new message.
203
+ */
204
+ export declare const CommissioningFactSchema: GenMessage<CommissioningFact>;
205
+
206
+ /**
207
+ * One answer in a house template.
208
+ *
209
+ * @generated from message kusinta.iot.commissioning.v1.TemplateFact
210
+ */
211
+ export declare type TemplateFact = Message<"kusinta.iot.commissioning.v1.TemplateFact"> & {
212
+ /**
213
+ * @generated from field: string key = 1;
214
+ */
215
+ key: string;
216
+
217
+ /**
218
+ * What it is about, as named on the drawing ("SL 2", "Bathroom"). Empty: the house.
219
+ *
220
+ * @generated from field: string subject_label = 2;
221
+ */
222
+ subjectLabel: string;
223
+
224
+ /**
225
+ * @generated from field: kusinta.iot.device.v1.AttributeValue value = 3;
226
+ */
227
+ value?: AttributeValue | undefined;
228
+ };
229
+
230
+ /**
231
+ * Describes the message kusinta.iot.commissioning.v1.TemplateFact.
232
+ * Use `create(TemplateFactSchema)` to create a new message.
233
+ */
234
+ export declare const TemplateFactSchema: GenMessage<TemplateFact>;
235
+
236
+ /**
237
+ * One house type of a building, as built. The owner organisation's.
238
+ *
239
+ * @generated from message kusinta.iot.commissioning.v1.HouseTemplate
240
+ */
241
+ export declare type HouseTemplate = Message<"kusinta.iot.commissioning.v1.HouseTemplate"> & {
242
+ /**
243
+ * Assigned by the gateway, opaque; empty when creating.
244
+ *
245
+ * @generated from field: string template_id = 1;
246
+ */
247
+ templateId: string;
248
+
249
+ /**
250
+ * @generated from field: kusinta.iot.identity.v1.SpaceId building_id = 2;
251
+ */
252
+ buildingId?: SpaceId | undefined;
253
+
254
+ /**
255
+ * @generated from field: string name = 3;
256
+ */
257
+ name: string;
258
+
259
+ /**
260
+ * Set by the gateway and bumped by every put; a put that replaces a template names the
261
+ * version it replaces. A version once given is never given to other content.
262
+ *
263
+ * @generated from field: uint32 version = 4;
264
+ */
265
+ version: number;
266
+
267
+ /**
268
+ * @generated from field: repeated kusinta.iot.commissioning.v1.TemplateFact facts = 5;
269
+ */
270
+ facts: TemplateFact[];
271
+
272
+ /**
273
+ * Who put this version, set by the gateway; its evidence is DRAWING. provenance.by is
274
+ * given to the owner organisation only, and left unset for residents and installers.
275
+ *
276
+ * @generated from field: kusinta.iot.commissioning.v1.Provenance provenance = 6;
277
+ */
278
+ provenance?: Provenance | undefined;
279
+ };
280
+
281
+ /**
282
+ * Describes the message kusinta.iot.commissioning.v1.HouseTemplate.
283
+ * Use `create(HouseTemplateSchema)` to create a new message.
284
+ */
285
+ export declare const HouseTemplateSchema: GenMessage<HouseTemplate>;
286
+
287
+ /**
288
+ * A fact or a test a feature needs, and who can provide it.
289
+ *
290
+ * @generated from message kusinta.iot.commissioning.v1.Need
291
+ */
292
+ export declare type Need = Message<"kusinta.iot.commissioning.v1.Need"> & {
293
+ /**
294
+ * @generated from oneof kusinta.iot.commissioning.v1.Need.what
295
+ */
296
+ what: {
297
+ /**
298
+ * @generated from field: string fact_key = 1;
299
+ */
300
+ value: string;
301
+ case: "factKey";
302
+ } | {
303
+ /**
304
+ * @generated from field: kusinta.iot.commissioning.v1.TestKind test = 2;
305
+ */
306
+ value: TestKind;
307
+ case: "test";
308
+ } | { case: undefined; value?: undefined };
309
+
310
+ /**
311
+ * What it is needed about. For a fact, CommissioningFact.space_id and record_id, with
312
+ * binding.field empty; for a test, what it runs on, as CommissioningTest.binding.
313
+ *
314
+ * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 3;
315
+ */
316
+ spaceId?: SpaceId | undefined;
317
+
318
+ /**
319
+ * @generated from field: kusinta.iot.commissioning.v1.Party answerer = 5;
320
+ */
321
+ answerer: Party;
322
+
323
+ /**
324
+ * @generated from field: kusinta.iot.commissioning.v1.BindingRef binding = 7;
325
+ */
326
+ binding?: BindingRef | undefined;
327
+
328
+ /**
329
+ * For a fact, its CommissioningFact.topic.
330
+ *
331
+ * @generated from field: kusinta.iot.commissioning.v1.FactTopic fact_topic = 8;
332
+ */
333
+ factTopic: FactTopic;
334
+ };
335
+
336
+ /**
337
+ * Describes the message kusinta.iot.commissioning.v1.Need.
338
+ * Use `create(NeedSchema)` to create a new message.
339
+ */
340
+ export declare const NeedSchema: GenMessage<Need>;
341
+
342
+ /**
343
+ * @generated from message kusinta.iot.commissioning.v1.FeatureBlock
344
+ */
345
+ export declare type FeatureBlock = Message<"kusinta.iot.commissioning.v1.FeatureBlock"> & {
346
+ /**
347
+ * @generated from field: kusinta.iot.commissioning.v1.BlockReason reason = 1;
348
+ */
349
+ reason: BlockReason;
350
+
351
+ /**
352
+ * The binding, and the device, it is blocked on.
353
+ *
354
+ * @generated from field: kusinta.iot.identity.v1.DeviceId device_id = 3;
355
+ */
356
+ deviceId?: DeviceId | undefined;
357
+
358
+ /**
359
+ * @generated from field: kusinta.iot.commissioning.v1.BindingRef binding = 5;
360
+ */
361
+ binding?: BindingRef | undefined;
362
+ };
363
+
364
+ /**
365
+ * Describes the message kusinta.iot.commissioning.v1.FeatureBlock.
366
+ * Use `create(FeatureBlockSchema)` to create a new message.
367
+ */
368
+ export declare const FeatureBlockSchema: GenMessage<FeatureBlock>;
369
+
370
+ /**
371
+ * One feature of one home. WORKS when every heating record of the feature in the home may
372
+ * be driven and nothing it needs is missing.
373
+ *
374
+ * @generated from message kusinta.iot.commissioning.v1.FeatureStatus
375
+ */
376
+ export declare type FeatureStatus = Message<"kusinta.iot.commissioning.v1.FeatureStatus"> & {
377
+ /**
378
+ * @generated from field: kusinta.iot.commissioning.v1.Feature feature = 1;
379
+ */
380
+ feature: Feature;
381
+
382
+ /**
383
+ * @generated from field: kusinta.iot.commissioning.v1.FeatureState state = 2;
384
+ */
385
+ state: FeatureState;
386
+
387
+ /**
388
+ * @generated from field: repeated kusinta.iot.commissioning.v1.Need needs = 3;
389
+ */
390
+ needs: Need[];
391
+
392
+ /**
393
+ * @generated from field: repeated kusinta.iot.commissioning.v1.FeatureBlock blocks = 4;
394
+ */
395
+ blocks: FeatureBlock[];
396
+ };
397
+
398
+ /**
399
+ * Describes the message kusinta.iot.commissioning.v1.FeatureStatus.
400
+ * Use `create(FeatureStatusSchema)` to create a new message.
401
+ */
402
+ export declare const FeatureStatusSchema: GenMessage<FeatureStatus>;
403
+
404
+ /**
405
+ * @generated from message kusinta.iot.commissioning.v1.CommissioningTest
406
+ */
407
+ export declare type CommissioningTest = Message<"kusinta.iot.commissioning.v1.CommissioningTest"> & {
408
+ /**
409
+ * Assigned by the gateway, opaque.
410
+ *
411
+ * @generated from field: string test_id = 1;
412
+ */
413
+ testId: string;
414
+
415
+ /**
416
+ * @generated from field: kusinta.iot.commissioning.v1.TestKind kind = 2;
417
+ */
418
+ kind: TestKind;
419
+
420
+ /**
421
+ * What it runs on: for OUTPUT_LEASE one binding; for ZONE_EFFECT and PUMP_ALL_ZONES_OFF
422
+ * the record, field empty.
423
+ *
424
+ * @generated from field: kusinta.iot.commissioning.v1.BindingRef binding = 13;
425
+ */
426
+ binding?: BindingRef | undefined;
427
+
428
+ /**
429
+ * The device it ran on. Set by the gateway.
430
+ *
431
+ * @generated from field: kusinta.iot.identity.v1.DeviceId device_id = 5;
432
+ */
433
+ deviceId?: DeviceId | undefined;
434
+
435
+ /**
436
+ * @generated from field: kusinta.iot.commissioning.v1.TestState state = 6;
437
+ */
438
+ state: TestState;
439
+
440
+ /**
441
+ * FAILED only.
442
+ *
443
+ * @generated from field: kusinta.iot.commissioning.v1.TestFailure failure = 7;
444
+ */
445
+ failure: TestFailure;
446
+
447
+ /**
448
+ * @generated from field: google.protobuf.Timestamp started_at = 8;
449
+ */
450
+ startedAt?: Timestamp | undefined;
451
+
452
+ /**
453
+ * The latest it ends, while it runs.
454
+ *
455
+ * @generated from field: google.protobuf.Timestamp ends_at = 9;
456
+ */
457
+ endsAt?: Timestamp | undefined;
458
+
459
+ /**
460
+ * @generated from field: google.protobuf.Timestamp finished_at = 10;
461
+ */
462
+ finishedAt?: Timestamp | undefined;
463
+
464
+ /**
465
+ * Who started it; for an installer's verdict, who concluded it.
466
+ *
467
+ * @generated from field: kusinta.iot.commissioning.v1.Provenance provenance = 11;
468
+ */
469
+ provenance?: Provenance | undefined;
470
+
471
+ /**
472
+ * A pass that no longer holds; see the file comment.
473
+ *
474
+ * @generated from field: bool superseded = 12;
475
+ */
476
+ superseded: boolean;
477
+ };
478
+
479
+ /**
480
+ * Describes the message kusinta.iot.commissioning.v1.CommissioningTest.
481
+ * Use `create(CommissioningTestSchema)` to create a new message.
482
+ */
483
+ export declare const CommissioningTestSchema: GenMessage<CommissioningTest>;
484
+
485
+ /**
486
+ * A space's commissioning, in reply to ListCommissioning.
487
+ *
488
+ * @generated from message kusinta.iot.commissioning.v1.CommissioningProfile
489
+ */
490
+ export declare type CommissioningProfile = Message<"kusinta.iot.commissioning.v1.CommissioningProfile"> & {
491
+ /**
492
+ * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
493
+ */
494
+ spaceId?: SpaceId | undefined;
495
+
496
+ /**
497
+ * @generated from field: repeated kusinta.iot.commissioning.v1.CommissioningFact facts = 2;
498
+ */
499
+ facts: CommissioningFact[];
500
+
501
+ /**
502
+ * The latest test of each kind on each binding.
503
+ *
504
+ * @generated from field: repeated kusinta.iot.commissioning.v1.CommissioningTest tests = 3;
505
+ */
506
+ tests: CommissioningTest[];
507
+
508
+ /**
509
+ * For a home, one per feature.
510
+ *
511
+ * @generated from field: repeated kusinta.iot.commissioning.v1.FeatureStatus features = 4;
512
+ */
513
+ features: FeatureStatus[];
514
+
515
+ /**
516
+ * The home's template, at its latest version. Unset: it follows none.
517
+ *
518
+ * @generated from field: kusinta.iot.commissioning.v1.HouseTemplate template = 6;
519
+ */
520
+ template?: HouseTemplate | undefined;
521
+
522
+ /**
523
+ * Set when FeatureStatus.needs are left out for this caller, so that none listed is not
524
+ * read as nothing missing.
525
+ *
526
+ * @generated from field: bool needs_withheld = 7;
527
+ */
528
+ needsWithheld: boolean;
529
+ };
530
+
531
+ /**
532
+ * Describes the message kusinta.iot.commissioning.v1.CommissioningProfile.
533
+ * Use `create(CommissioningProfileSchema)` to create a new message.
534
+ */
535
+ export declare const CommissioningProfileSchema: GenMessage<CommissioningProfile>;
536
+
537
+ /**
538
+ * Whether a home is set up: every REQUIRED fact answered with a value at least once, and
539
+ * every output bound in it passed OUTPUT_LEASE at least once on the device it is bound to.
540
+ * "Don't know" is not an answer here. What the household does afterwards counts neither
541
+ * way: a REQUIRED fact once answered still counts when it is removed or changed to "don't
542
+ * know", as a pass superseded by a change of a floor zone's rooms or control room still
543
+ * does, so that set_up tells the owner organisation neither of a household's edits nor of
544
+ * a renovation. Binding a new output, or a new device, is what it can show. All the owner
545
+ * organisation learns of a home's commissioning.
546
+ *
547
+ * @generated from message kusinta.iot.commissioning.v1.HomeSetup
548
+ */
549
+ export declare type HomeSetup = Message<"kusinta.iot.commissioning.v1.HomeSetup"> & {
550
+ /**
551
+ * @generated from field: kusinta.iot.identity.v1.SpaceId home_id = 1;
552
+ */
553
+ homeId?: SpaceId | undefined;
554
+
555
+ /**
556
+ * @generated from field: bool set_up = 2;
557
+ */
558
+ setUp: boolean;
559
+ };
560
+
561
+ /**
562
+ * Describes the message kusinta.iot.commissioning.v1.HomeSetup.
563
+ * Use `create(HomeSetupSchema)` to create a new message.
564
+ */
565
+ export declare const HomeSetupSchema: GenMessage<HomeSetup>;
566
+
567
+ /**
568
+ * In reply to ListHomeSetups.
569
+ *
570
+ * @generated from message kusinta.iot.commissioning.v1.HomeSetups
571
+ */
572
+ export declare type HomeSetups = Message<"kusinta.iot.commissioning.v1.HomeSetups"> & {
573
+ /**
574
+ * @generated from field: repeated kusinta.iot.commissioning.v1.HomeSetup homes = 1;
575
+ */
576
+ homes: HomeSetup[];
577
+ };
578
+
579
+ /**
580
+ * Describes the message kusinta.iot.commissioning.v1.HomeSetups.
581
+ * Use `create(HomeSetupsSchema)` to create a new message.
582
+ */
583
+ export declare const HomeSetupsSchema: GenMessage<HomeSetups>;
584
+
585
+ /**
586
+ * One commissioning record as stored, in reply to a put, a test's start or its conclusion.
587
+ *
588
+ * @generated from message kusinta.iot.commissioning.v1.CommissioningRecord
589
+ */
590
+ export declare type CommissioningRecord = Message<"kusinta.iot.commissioning.v1.CommissioningRecord"> & {
591
+ /**
592
+ * @generated from oneof kusinta.iot.commissioning.v1.CommissioningRecord.record
593
+ */
594
+ record: {
595
+ /**
596
+ * @generated from field: kusinta.iot.commissioning.v1.CommissioningFact fact = 1;
597
+ */
598
+ value: CommissioningFact;
599
+ case: "fact";
600
+ } | {
601
+ /**
602
+ * @generated from field: kusinta.iot.commissioning.v1.CommissioningTest test = 2;
603
+ */
604
+ value: CommissioningTest;
605
+ case: "test";
606
+ } | {
607
+ /**
608
+ * @generated from field: kusinta.iot.commissioning.v1.HouseTemplate template = 3;
609
+ */
610
+ value: HouseTemplate;
611
+ case: "template";
612
+ } | { case: undefined; value?: undefined };
613
+ };
614
+
615
+ /**
616
+ * Describes the message kusinta.iot.commissioning.v1.CommissioningRecord.
617
+ * Use `create(CommissioningRecordSchema)` to create a new message.
618
+ */
619
+ export declare const CommissioningRecordSchema: GenMessage<CommissioningRecord>;
620
+
621
+ /**
622
+ * Who answers a fact, or ran or concluded a test.
623
+ *
624
+ * @generated from enum kusinta.iot.commissioning.v1.Party
625
+ */
626
+ export enum Party {
627
+ /**
628
+ * @generated from enum value: PARTY_UNSPECIFIED = 0;
629
+ */
630
+ UNSPECIFIED = 0,
631
+
632
+ /**
633
+ * The property owner or the gateway's administrators.
634
+ *
635
+ * @generated from enum value: PARTY_OWNER_ORGANISATION = 1;
636
+ */
637
+ OWNER_ORGANISATION = 1,
638
+
639
+ /**
640
+ * A household admin of the home.
641
+ *
642
+ * @generated from enum value: PARTY_HOUSEHOLD = 2;
643
+ */
644
+ HOUSEHOLD = 2,
645
+
646
+ /**
647
+ * An installer under a commissioning grant.
648
+ *
649
+ * @generated from enum value: PARTY_INSTALLER = 3;
650
+ */
651
+ INSTALLER = 3,
652
+
653
+ /**
654
+ * The gateway, from a device, a connector or a measurement of its own.
655
+ *
656
+ * @generated from enum value: PARTY_AUTOMATIC = 4;
657
+ */
658
+ AUTOMATIC = 4,
659
+ }
660
+
661
+ /**
662
+ * Describes the enum kusinta.iot.commissioning.v1.Party.
663
+ */
664
+ export declare const PartySchema: GenEnum<Party>;
665
+
666
+ /**
667
+ * How much a fact is needed.
668
+ *
669
+ * @generated from enum kusinta.iot.commissioning.v1.Necessity
670
+ */
671
+ export enum Necessity {
672
+ /**
673
+ * @generated from enum value: NECESSITY_UNSPECIFIED = 0;
674
+ */
675
+ UNSPECIFIED = 0,
676
+
677
+ /**
678
+ * Before the home is set up (HomeSetup).
679
+ *
680
+ * @generated from enum value: NECESSITY_REQUIRED = 1;
681
+ */
682
+ REQUIRED = 1,
683
+
684
+ /**
685
+ * Before its feature works (CommissioningFact.feature).
686
+ *
687
+ * @generated from enum value: NECESSITY_FOR_FEATURE = 2;
688
+ */
689
+ FOR_FEATURE = 2,
690
+
691
+ /**
692
+ * @generated from enum value: NECESSITY_OPTIONAL = 3;
693
+ */
694
+ OPTIONAL = 3,
695
+ }
696
+
697
+ /**
698
+ * Describes the enum kusinta.iot.commissioning.v1.Necessity.
699
+ */
700
+ export declare const NecessitySchema: GenEnum<Necessity>;
701
+
702
+ /**
703
+ * How an answer was confirmed. A household answers STATED, PHOTO or DRAWING; INSPECTED and
704
+ * MEASURED are an installer's or the gateway's; DERIVED is the gateway's alone. A key may
705
+ * require more (see the file comment); less is refused.
706
+ *
707
+ * @generated from enum kusinta.iot.commissioning.v1.Evidence
708
+ */
709
+ export enum Evidence {
710
+ /**
711
+ * @generated from enum value: EVIDENCE_UNSPECIFIED = 0;
712
+ */
713
+ UNSPECIFIED = 0,
714
+
715
+ /**
716
+ * @generated from enum value: EVIDENCE_STATED = 1;
717
+ */
718
+ STATED = 1,
719
+
720
+ /**
721
+ * @generated from enum value: EVIDENCE_PHOTO = 2;
722
+ */
723
+ PHOTO = 2,
724
+
725
+ /**
726
+ * @generated from enum value: EVIDENCE_DRAWING = 3;
727
+ */
728
+ DRAWING = 3,
729
+
730
+ /**
731
+ * @generated from enum value: EVIDENCE_INSPECTED = 4;
732
+ */
733
+ INSPECTED = 4,
734
+
735
+ /**
736
+ * @generated from enum value: EVIDENCE_MEASURED = 5;
737
+ */
738
+ MEASURED = 5,
739
+
740
+ /**
741
+ * From other facts, the address or a connector's declaration.
742
+ *
743
+ * @generated from enum value: EVIDENCE_DERIVED = 6;
744
+ */
745
+ DERIVED = 6,
746
+ }
747
+
748
+ /**
749
+ * Describes the enum kusinta.iot.commissioning.v1.Evidence.
750
+ */
751
+ export declare const EvidenceSchema: GenEnum<Evidence>;
752
+
753
+ /**
754
+ * What a fact is about, for a client that does not know its key. Closed: a client words a
755
+ * topic it does not know as a detail about the space or record, from its answerer.
756
+ *
757
+ * @generated from enum kusinta.iot.commissioning.v1.FactTopic
758
+ */
759
+ export enum FactTopic {
760
+ /**
761
+ * @generated from enum value: FACT_TOPIC_UNSPECIFIED = 0;
762
+ */
763
+ UNSPECIFIED = 0,
764
+
765
+ /**
766
+ * The building: type, house types, drawings, gateway site, service agreements, payer.
767
+ *
768
+ * @generated from enum value: FACT_TOPIC_BUILDING = 1;
769
+ */
770
+ BUILDING = 1,
771
+
772
+ /**
773
+ * Rooms, walls added or removed, how each room is heated, its thermostats.
774
+ *
775
+ * @generated from enum value: FACT_TOPIC_ROOMS = 2;
776
+ */
777
+ ROOMS = 2,
778
+
779
+ /**
780
+ * The heat source: heat pump, its inputs, vendor account, blocks.
781
+ *
782
+ * @generated from enum value: FACT_TOPIC_HEAT_SOURCE = 3;
783
+ */
784
+ HEAT_SOURCE = 3,
785
+
786
+ /**
787
+ * Floor heating: circuits, pump, mixing, supply cap, zones, actuators, probes.
788
+ *
789
+ * @generated from enum value: FACT_TOPIC_FLOOR_HEATING = 4;
790
+ */
791
+ FLOOR_HEATING = 4,
792
+
793
+ /**
794
+ * Electric comfort loads: bathroom floors, towel heaters, their thermostats.
795
+ *
796
+ * @generated from enum value: FACT_TOPIC_COMFORT_LOADS = 5;
797
+ */
798
+ COMFORT_LOADS = 5,
799
+
800
+ /**
801
+ * Electricity: grid subscription, operator, fuse size, meter and its port.
802
+ *
803
+ * @generated from enum value: FACT_TOPIC_ELECTRICITY = 6;
804
+ */
805
+ ELECTRICITY = 6,
806
+
807
+ /**
808
+ * District heating: utility and tariff.
809
+ *
810
+ * @generated from enum value: FACT_TOPIC_DISTRICT_HEATING = 7;
811
+ */
812
+ DISTRICT_HEATING = 7,
813
+
814
+ /**
815
+ * Radio coverage and the gateways that carry it.
816
+ *
817
+ * @generated from enum value: FACT_TOPIC_CONNECTIVITY = 8;
818
+ */
819
+ CONNECTIVITY = 8,
820
+
821
+ /**
822
+ * Comfort wishes and schedules. Residents only, never under a commissioning grant.
823
+ *
824
+ * @generated from enum value: FACT_TOPIC_COMFORT = 9;
825
+ */
826
+ COMFORT = 9,
827
+ }
828
+
829
+ /**
830
+ * Describes the enum kusinta.iot.commissioning.v1.FactTopic.
831
+ */
832
+ export declare const FactTopicSchema: GenEnum<FactTopic>;
833
+
834
+ /**
835
+ * The heating features a home's commissioning unlocks.
836
+ *
837
+ * @generated from enum kusinta.iot.commissioning.v1.Feature
838
+ */
839
+ export enum Feature {
840
+ /**
841
+ * @generated from enum value: FEATURE_UNSPECIFIED = 0;
842
+ */
843
+ UNSPECIFIED = 0,
844
+
845
+ /**
846
+ * @generated from enum value: FEATURE_FLOOR_ZONES = 1;
847
+ */
848
+ FLOOR_ZONES = 1,
849
+
850
+ /**
851
+ * Steering the heat source (heating.v1.HeatingPlant.control).
852
+ *
853
+ * @generated from enum value: FEATURE_PLANT = 2;
854
+ */
855
+ PLANT = 2,
856
+
857
+ /**
858
+ * @generated from enum value: FEATURE_COMFORT_LOADS = 3;
859
+ */
860
+ COMFORT_LOADS = 3,
861
+
862
+ /**
863
+ * Planning by electricity price and the home's grid tariff.
864
+ *
865
+ * @generated from enum value: FEATURE_COST = 4;
866
+ */
867
+ COST = 4,
868
+
869
+ /**
870
+ * Holding the home's load under a power peak, live.
871
+ *
872
+ * @generated from enum value: FEATURE_PEAK_GUARD = 5;
873
+ */
874
+ PEAK_GUARD = 5,
875
+
876
+ /**
877
+ * Planning by forecast, from the room models.
878
+ *
879
+ * @generated from enum value: FEATURE_PLANNING = 6;
880
+ */
881
+ PLANNING = 6,
882
+ }
883
+
884
+ /**
885
+ * Describes the enum kusinta.iot.commissioning.v1.Feature.
886
+ */
887
+ export declare const FeatureSchema: GenEnum<Feature>;
888
+
889
+ /**
890
+ * @generated from enum kusinta.iot.commissioning.v1.FeatureState
891
+ */
892
+ export enum FeatureState {
893
+ /**
894
+ * A state this schema does not know: read as NEEDS.
895
+ *
896
+ * @generated from enum value: FEATURE_STATE_UNSPECIFIED = 0;
897
+ */
898
+ UNSPECIFIED = 0,
899
+
900
+ /**
901
+ * @generated from enum value: FEATURE_STATE_WORKS = 1;
902
+ */
903
+ WORKS = 1,
904
+
905
+ /**
906
+ * Something it needs is missing (FeatureStatus.needs), and nothing blocks it.
907
+ *
908
+ * @generated from enum value: FEATURE_STATE_NEEDS = 2;
909
+ */
910
+ NEEDS = 2,
911
+
912
+ /**
913
+ * FeatureStatus.blocks says why. Takes precedence over NEEDS.
914
+ *
915
+ * @generated from enum value: FEATURE_STATE_BLOCKED_FOR_SAFETY = 3;
916
+ */
917
+ BLOCKED_FOR_SAFETY = 3,
918
+ }
919
+
920
+ /**
921
+ * Describes the enum kusinta.iot.commissioning.v1.FeatureState.
922
+ */
923
+ export declare const FeatureStateSchema: GenEnum<FeatureState>;
924
+
925
+ /**
926
+ * @generated from enum kusinta.iot.commissioning.v1.BlockReason
927
+ */
928
+ export enum BlockReason {
929
+ /**
930
+ * @generated from enum value: BLOCK_REASON_UNSPECIFIED = 0;
931
+ */
932
+ UNSPECIFIED = 0,
933
+
934
+ /**
935
+ * Its latest test failed, and has not passed since.
936
+ *
937
+ * @generated from enum value: BLOCK_REASON_TEST_FAILED = 1;
938
+ */
939
+ TEST_FAILED = 1,
940
+
941
+ /**
942
+ * Its producer no longer states the output's write as leased with a lapse value at rest
943
+ * (heating.v1).
944
+ *
945
+ * @generated from enum value: BLOCK_REASON_OUTPUT_NOT_LEASED = 2;
946
+ */
947
+ OUTPUT_NOT_LEASED = 2,
948
+
949
+ /**
950
+ * Its producer now states a power-on value that would leave the contact away from rest,
951
+ * though a pass predates it. A test that finds this fails instead
952
+ * (TEST_FAILURE_POWER_ON_NOT_AT_REST), and blocks as TEST_FAILED.
953
+ *
954
+ * @generated from enum value: BLOCK_REASON_POWER_ON_NOT_AT_REST = 3;
955
+ */
956
+ POWER_ON_NOT_AT_REST = 3,
957
+
958
+ /**
959
+ * @generated from enum value: BLOCK_REASON_DEVICE_GONE = 4;
960
+ */
961
+ DEVICE_GONE = 4,
962
+
963
+ /**
964
+ * A floor zone whose control room is deleted or outside its plant's space.
965
+ *
966
+ * @generated from enum value: BLOCK_REASON_CONTROL_ROOM_GONE = 5;
967
+ */
968
+ CONTROL_ROOM_GONE = 5,
969
+
970
+ /**
971
+ * The output's shortest lease (device.v1.LeasedWrite.min_lease_seconds) is longer than
972
+ * the longest it may be held: "plant.max_block_minutes" for a blocking input, or the
973
+ * OUTPUT_LEASE test's 5 minutes.
974
+ *
975
+ * @generated from enum value: BLOCK_REASON_LEASE_TOO_LONG = 6;
976
+ */
977
+ LEASE_TOO_LONG = 6,
978
+ }
979
+
980
+ /**
981
+ * Describes the enum kusinta.iot.commissioning.v1.BlockReason.
982
+ */
983
+ export declare const BlockReasonSchema: GenEnum<BlockReason>;
984
+
985
+ /**
986
+ * @generated from enum kusinta.iot.commissioning.v1.TestKind
987
+ */
988
+ export enum TestKind {
989
+ /**
990
+ * @generated from enum value: TEST_KIND_UNSPECIFIED = 0;
991
+ */
992
+ UNSPECIFIED = 0,
993
+
994
+ /**
995
+ * On one bound output (heating.v1). The gateway checks that the output's power-on value,
996
+ * where its producer states one, leaves the contact at rest; writes the value that takes
997
+ * it away from rest under a lease of L = the greater of the producer's min_lease_seconds
998
+ * and 60 seconds, and sees the reported contact leave rest; renews the lease before it
999
+ * ends and sees the contact hold past the first lease's end; then lets it lapse and sees
1000
+ * the contact return to rest. ends_at is the start plus 2 × L plus 5 minutes for the
1001
+ * reports. Runs only on an output whose producer states its reads REAL_TIME and whose
1002
+ * lease bounds admit an L of at most 5 minutes, so it ends within 15 minutes; any other
1003
+ * is refused before it starts (RunCommissioningTest). Judged by the gateway.
1004
+ *
1005
+ * @generated from enum value: TEST_KIND_OUTPUT_LEASE = 1;
1006
+ */
1007
+ OUTPUT_LEASE = 1,
1008
+
1009
+ /**
1010
+ * On one floor zone with a current OUTPUT_LEASE pass. The gateway switches the zone and
1011
+ * sees its control room's temperature and the circuit's return probe answer. Judged by
1012
+ * the gateway. Takes hours; the zone is kept within its rooms' comfort while it runs.
1013
+ *
1014
+ * @generated from enum value: TEST_KIND_ZONE_EFFECT = 2;
1015
+ */
1016
+ ZONE_EFFECT = 2,
1017
+
1018
+ /**
1019
+ * On one floor circuit whose every zone holds a current OUTPUT_LEASE pass. The gateway
1020
+ * holds every zone off for at most 15 minutes while the installer watches the pump, and
1021
+ * the installer concludes it (ConcludeCommissioningTest). Passed or failed, it sets
1022
+ * "floor.pump_tolerates_all_zones_off" as MEASURED, with the installer's provenance.
1023
+ *
1024
+ * @generated from enum value: TEST_KIND_PUMP_ALL_ZONES_OFF = 3;
1025
+ */
1026
+ PUMP_ALL_ZONES_OFF = 3,
1027
+ }
1028
+
1029
+ /**
1030
+ * Describes the enum kusinta.iot.commissioning.v1.TestKind.
1031
+ */
1032
+ export declare const TestKindSchema: GenEnum<TestKind>;
1033
+
1034
+ /**
1035
+ * @generated from enum kusinta.iot.commissioning.v1.TestState
1036
+ */
1037
+ export enum TestState {
1038
+ /**
1039
+ * @generated from enum value: TEST_STATE_UNSPECIFIED = 0;
1040
+ */
1041
+ UNSPECIFIED = 0,
1042
+
1043
+ /**
1044
+ * @generated from enum value: TEST_STATE_RUNNING = 1;
1045
+ */
1046
+ RUNNING = 1,
1047
+
1048
+ /**
1049
+ * @generated from enum value: TEST_STATE_PASSED = 2;
1050
+ */
1051
+ PASSED = 2,
1052
+
1053
+ /**
1054
+ * @generated from enum value: TEST_STATE_FAILED = 3;
1055
+ */
1056
+ FAILED = 3,
1057
+
1058
+ /**
1059
+ * Stopped by a caller, or ended at ends_at without a verdict. Proves nothing.
1060
+ *
1061
+ * @generated from enum value: TEST_STATE_ABORTED = 4;
1062
+ */
1063
+ ABORTED = 4,
1064
+ }
1065
+
1066
+ /**
1067
+ * Describes the enum kusinta.iot.commissioning.v1.TestState.
1068
+ */
1069
+ export declare const TestStateSchema: GenEnum<TestState>;
1070
+
1071
+ /**
1072
+ * @generated from enum kusinta.iot.commissioning.v1.TestFailure
1073
+ */
1074
+ export enum TestFailure {
1075
+ /**
1076
+ * @generated from enum value: TEST_FAILURE_UNSPECIFIED = 0;
1077
+ */
1078
+ UNSPECIFIED = 0,
1079
+
1080
+ /**
1081
+ * OUTPUT_LEASE.
1082
+ *
1083
+ * @generated from enum value: TEST_FAILURE_POWER_ON_NOT_AT_REST = 1;
1084
+ */
1085
+ POWER_ON_NOT_AT_REST = 1,
1086
+
1087
+ /**
1088
+ * @generated from enum value: TEST_FAILURE_NO_STATE_CHANGE = 2;
1089
+ */
1090
+ NO_STATE_CHANGE = 2,
1091
+
1092
+ /**
1093
+ * @generated from enum value: TEST_FAILURE_LEASE_NOT_RENEWED = 3;
1094
+ */
1095
+ LEASE_NOT_RENEWED = 3,
1096
+
1097
+ /**
1098
+ * @generated from enum value: TEST_FAILURE_DID_NOT_RETURN_TO_REST = 4;
1099
+ */
1100
+ DID_NOT_RETURN_TO_REST = 4,
1101
+
1102
+ /**
1103
+ * The device answered nothing within the test.
1104
+ *
1105
+ * @generated from enum value: TEST_FAILURE_DEVICE_UNREACHABLE = 5;
1106
+ */
1107
+ DEVICE_UNREACHABLE = 5,
1108
+
1109
+ /**
1110
+ * ZONE_EFFECT: the control room and the return did not answer the zone.
1111
+ *
1112
+ * @generated from enum value: TEST_FAILURE_NO_EFFECT = 6;
1113
+ */
1114
+ NO_EFFECT = 6,
1115
+
1116
+ /**
1117
+ * PUMP_ALL_ZONES_OFF: the installer's verdict.
1118
+ *
1119
+ * @generated from enum value: TEST_FAILURE_OBSERVED = 7;
1120
+ */
1121
+ OBSERVED = 7,
1122
+ }
1123
+
1124
+ /**
1125
+ * Describes the enum kusinta.iot.commissioning.v1.TestFailure.
1126
+ */
1127
+ export declare const TestFailureSchema: GenEnum<TestFailure>;
1128
+