matterbridge 1.5.2 → 1.5.3

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 (77) hide show
  1. package/CHANGELOG.md +19 -2
  2. package/dist/cluster/AirQualityCluster.d.ts +1 -1
  3. package/dist/cluster/AirQualityCluster.d.ts.map +1 -1
  4. package/dist/cluster/CarbonDioxideConcentrationMeasurementCluster.d.ts +11 -11
  5. package/dist/cluster/CarbonDioxideConcentrationMeasurementCluster.d.ts.map +1 -1
  6. package/dist/cluster/CarbonMonoxideConcentrationMeasurementCluster.d.ts +11 -11
  7. package/dist/cluster/CarbonMonoxideConcentrationMeasurementCluster.d.ts.map +1 -1
  8. package/dist/cluster/ConcentrationMeasurementCluster.d.ts +10 -10
  9. package/dist/cluster/DeviceEnergyManagementCluster.d.ts +16 -16
  10. package/dist/cluster/DeviceEnergyManagementCluster.d.ts.map +1 -1
  11. package/dist/cluster/DeviceEnergyManagementModeCluster.d.ts +3 -3
  12. package/dist/cluster/DeviceEnergyManagementModeCluster.d.ts.map +1 -1
  13. package/dist/cluster/ElectricalEnergyMeasurementCluster.d.ts +8 -8
  14. package/dist/cluster/ElectricalEnergyMeasurementCluster.d.ts.map +1 -1
  15. package/dist/cluster/ElectricalPowerMeasurementCluster.d.ts +13 -13
  16. package/dist/cluster/ElectricalPowerMeasurementCluster.d.ts.map +1 -1
  17. package/dist/cluster/FormaldehydeConcentrationMeasurementCluster.d.ts +11 -11
  18. package/dist/cluster/FormaldehydeConcentrationMeasurementCluster.d.ts.map +1 -1
  19. package/dist/cluster/NitrogenDioxideConcentrationMeasurementCluster.d.ts +11 -11
  20. package/dist/cluster/NitrogenDioxideConcentrationMeasurementCluster.d.ts.map +1 -1
  21. package/dist/cluster/OzoneConcentrationMeasurementCluster.d.ts +11 -11
  22. package/dist/cluster/OzoneConcentrationMeasurementCluster.d.ts.map +1 -1
  23. package/dist/cluster/Pm10ConcentrationMeasurementCluster.d.ts +11 -11
  24. package/dist/cluster/Pm10ConcentrationMeasurementCluster.d.ts.map +1 -1
  25. package/dist/cluster/Pm1ConcentrationMeasurementCluster.d.ts +11 -11
  26. package/dist/cluster/Pm1ConcentrationMeasurementCluster.d.ts.map +1 -1
  27. package/dist/cluster/Pm25ConcentrationMeasurementCluster.d.ts +11 -11
  28. package/dist/cluster/Pm25ConcentrationMeasurementCluster.d.ts.map +1 -1
  29. package/dist/cluster/PowerTopologyCluster.d.ts +7 -7
  30. package/dist/cluster/PowerTopologyCluster.d.ts.map +1 -1
  31. package/dist/cluster/RadonConcentrationMeasurementCluster.d.ts +11 -11
  32. package/dist/cluster/RadonConcentrationMeasurementCluster.d.ts.map +1 -1
  33. package/dist/cluster/ScenesCluster.d.ts +1249 -0
  34. package/dist/cluster/ScenesCluster.d.ts.map +1 -0
  35. package/dist/cluster/ScenesCluster.js +436 -0
  36. package/dist/cluster/ScenesCluster.js.map +1 -0
  37. package/dist/cluster/SmokeCoAlarmCluster.d.ts +9 -9
  38. package/dist/cluster/SmokeCoAlarmCluster.d.ts.map +1 -1
  39. package/dist/cluster/TvocCluster.d.ts +1 -1
  40. package/dist/cluster/TvocCluster.d.ts.map +1 -1
  41. package/dist/cluster/export.d.ts +0 -1
  42. package/dist/cluster/export.d.ts.map +1 -1
  43. package/dist/cluster/export.js +0 -1
  44. package/dist/cluster/export.js.map +1 -1
  45. package/dist/index.d.ts +3 -25
  46. package/dist/index.d.ts.map +1 -1
  47. package/dist/index.js +3 -32
  48. package/dist/index.js.map +1 -1
  49. package/dist/matterbridge.d.ts +3 -1
  50. package/dist/matterbridge.d.ts.map +1 -1
  51. package/dist/matterbridge.js +124 -17
  52. package/dist/matterbridge.js.map +1 -1
  53. package/dist/matterbridgeDevice.d.ts +4684 -2288
  54. package/dist/matterbridgeDevice.d.ts.map +1 -1
  55. package/dist/matterbridgeDevice.js +146 -545
  56. package/dist/matterbridgeDevice.js.map +1 -1
  57. package/dist/matterbridgeTypes.d.ts +3 -0
  58. package/dist/matterbridgeTypes.d.ts.map +1 -1
  59. package/frontend/build/asset-manifest.json +3 -3
  60. package/frontend/build/index.html +1 -1
  61. package/frontend/build/static/js/{main.cfcfbb06.js → main.6725e5ab.js} +3 -3
  62. package/frontend/build/static/js/main.6725e5ab.js.map +1 -0
  63. package/package.json +14 -9
  64. package/dist/cluster/BooleanStateConfigurationCluster.d.ts +0 -2200
  65. package/dist/cluster/BooleanStateConfigurationCluster.d.ts.map +0 -1
  66. package/dist/cluster/BooleanStateConfigurationCluster.js +0 -388
  67. package/dist/cluster/BooleanStateConfigurationCluster.js.map +0 -1
  68. package/dist/cluster/BridgedDeviceBasicInformationCluster.d.ts +0 -223
  69. package/dist/cluster/BridgedDeviceBasicInformationCluster.d.ts.map +0 -1
  70. package/dist/cluster/BridgedDeviceBasicInformationCluster.js +0 -177
  71. package/dist/cluster/BridgedDeviceBasicInformationCluster.js.map +0 -1
  72. package/dist/cluster/FanControlCluster.d.ts +0 -1583
  73. package/dist/cluster/FanControlCluster.d.ts.map +0 -1
  74. package/dist/cluster/FanControlCluster.js +0 -492
  75. package/dist/cluster/FanControlCluster.js.map +0 -1
  76. package/frontend/build/static/js/main.cfcfbb06.js.map +0 -1
  77. /package/frontend/build/static/js/{main.cfcfbb06.js.LICENSE.txt → main.6725e5ab.js.LICENSE.txt} +0 -0
@@ -1,2200 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2022-2024 Matter.js Authors
4
- * SPDX-License-Identifier: Apache-2.0
5
- */
6
- /** * THIS FILE IS GENERATED, DO NOT EDIT ***/
7
- import { Command, Event, FixedAttribute, MutableCluster, OptionalAttribute, OptionalEvent, OptionalFixedAttribute, WritableAttribute } from '@project-chip/matter-node.js/cluster';
8
- import { Attribute } from '@project-chip/matter-node.js/cluster';
9
- import { BitFlag } from '@project-chip/matter-node.js/schema';
10
- import { TypeFromSchema } from '@project-chip/matter-node.js/tlv';
11
- import { Identity } from '@project-chip/matter-node.js/util';
12
- export declare namespace BooleanStateConfiguration {
13
- /**
14
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.5.1
15
- */
16
- const AlarmMode: {
17
- /**
18
- * Visual alarming
19
- */
20
- visual: BitFlag;
21
- /**
22
- * Audible alarming
23
- */
24
- audible: BitFlag;
25
- };
26
- /**
27
- * Input to the BooleanStateConfiguration enableDisableAlarm command
28
- *
29
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2
30
- */
31
- const TlvEnableDisableAlarmRequest: import("@project-chip/matter-node.js/tlv").ObjectSchema<{
32
- /**
33
- * This field shall indicate the alarm modes to either enable or disable depending on the bit status, as
34
- * specified for the AlarmsEnabled attribute.
35
- *
36
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2.1
37
- */
38
- alarmsToEnableDisable: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
39
- /**
40
- * Visual alarming
41
- */
42
- visual: BitFlag;
43
- /**
44
- * Audible alarming
45
- */
46
- audible: BitFlag;
47
- }>>;
48
- }>;
49
- /**
50
- * Input to the BooleanStateConfiguration enableDisableAlarm command
51
- *
52
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2
53
- */
54
- type EnableDisableAlarmRequest = TypeFromSchema<typeof TlvEnableDisableAlarmRequest>;
55
- /**
56
- * Body of the BooleanStateConfiguration alarmsStateChanged event
57
- *
58
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1
59
- */
60
- const TlvAlarmsStateChangedEvent: import("@project-chip/matter-node.js/tlv").ObjectSchema<{
61
- /**
62
- * This field shall indicate the state of active alarm modes, as indicated by the AlarmsActive attribute, at
63
- * the time the event was generated.
64
- *
65
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.1
66
- */
67
- alarmsActive: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
68
- /**
69
- * Visual alarming
70
- */
71
- visual: BitFlag;
72
- /**
73
- * Audible alarming
74
- */
75
- audible: BitFlag;
76
- }>>;
77
- /**
78
- * This field shall indicate the state of suppressed alarm modes, as indicated by the AlarmsSuppressed
79
- * attribute, at the time the event was generated.
80
- *
81
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.2
82
- */
83
- alarmsSuppressed: import("@project-chip/matter-node.js/tlv").OptionalFieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
84
- /**
85
- * Visual alarming
86
- */
87
- visual: BitFlag;
88
- /**
89
- * Audible alarming
90
- */
91
- audible: BitFlag;
92
- }>>;
93
- }>;
94
- /**
95
- * Body of the BooleanStateConfiguration alarmsStateChanged event
96
- *
97
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1
98
- */
99
- type AlarmsStateChangedEvent = TypeFromSchema<typeof TlvAlarmsStateChangedEvent>;
100
- /**
101
- * Input to the BooleanStateConfiguration suppressAlarm command
102
- *
103
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.1
104
- */
105
- const TlvSuppressAlarmRequest: import("@project-chip/matter-node.js/tlv").ObjectSchema<{
106
- /**
107
- * This field shall indicate the alarm modes to suppress.
108
- *
109
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.1.1
110
- */
111
- alarmsToSuppress: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
112
- /**
113
- * Visual alarming
114
- */
115
- visual: BitFlag;
116
- /**
117
- * Audible alarming
118
- */
119
- audible: BitFlag;
120
- }>>;
121
- }>;
122
- /**
123
- * Input to the BooleanStateConfiguration suppressAlarm command
124
- *
125
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.1
126
- */
127
- type SuppressAlarmRequest = TypeFromSchema<typeof TlvSuppressAlarmRequest>;
128
- /**
129
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.5.2
130
- */
131
- const SensorFault: {
132
- /**
133
- * Unspecified fault detected
134
- */
135
- generalFault: BitFlag;
136
- };
137
- /**
138
- * Body of the BooleanStateConfiguration sensorFault event
139
- *
140
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.2
141
- */
142
- const TlvSensorFaultEvent: import("@project-chip/matter-node.js/tlv").ObjectSchema<{
143
- /**
144
- * This field shall indicate the value of the SensorFault attribute, at the time this event is generated.
145
- *
146
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.2.1
147
- */
148
- sensorFault: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
149
- /**
150
- * Unspecified fault detected
151
- */
152
- generalFault: BitFlag;
153
- }>>;
154
- }>;
155
- /**
156
- * Body of the BooleanStateConfiguration sensorFault event
157
- *
158
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.2
159
- */
160
- type SensorFaultEvent = TypeFromSchema<typeof TlvSensorFaultEvent>;
161
- /**
162
- * A BooleanStateConfigurationCluster supports these elements if it supports feature SensitivityLevel.
163
- */
164
- const SensitivityLevelComponent: {
165
- readonly attributes: {
166
- /**
167
- * Indicates the currently selected sensitivity level.
168
- *
169
- * If a write interaction to this attribute contains an unsupported sensitivity value, a CONSTRAINT_ERROR
170
- * status shall be returned.
171
- *
172
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.1
173
- */
174
- readonly currentSensitivityLevel: WritableAttribute<number, any>;
175
- /**
176
- * Indicates the number of supported sensitivity levels by the device.
177
- *
178
- * These supported sensitivity levels shall be ordered by sensitivity, where a value of 0 shall be
179
- * considered the lowest sensitivity level (least sensitive) and the highest supported value shall be
180
- * considered the highest sensitivity level.
181
- *
182
- * The number of supported sensitivity levels SHOULD represent unique sensitivity levels supported by the
183
- * device.
184
- *
185
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.2
186
- */
187
- readonly supportedSensitivityLevels: FixedAttribute<number, any>;
188
- /**
189
- * Indicates the default sensitivity level selected by the manufacturer.
190
- *
191
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.3
192
- */
193
- readonly defaultSensitivityLevel: OptionalFixedAttribute<number, any>;
194
- };
195
- };
196
- /**
197
- * A BooleanStateConfigurationCluster supports these elements if it supports features Visual or Audible.
198
- */
199
- const VisualOrAudibleComponent: {
200
- readonly attributes: {
201
- /**
202
- * Indicates which specific alarm modes on the server are currently active. When the sensor is no longer
203
- * triggered, this attribute shall be set to the inactive state, by setting the bit to 0, for all supported
204
- * alarm modes.
205
- *
206
- * If an alarm mode is not supported, the bit indicating this alarm mode shall always be 0. A bit shall
207
- * indicate whether the alarm mode inactive or not:
208
- *
209
- * • 0 = Inactive
210
- *
211
- * • 1 = Active
212
- *
213
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.4
214
- */
215
- readonly alarmsActive: Attribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
216
- /**
217
- * Visual alarming
218
- */
219
- visual: BitFlag;
220
- /**
221
- * Audible alarming
222
- */
223
- audible: BitFlag;
224
- }>, any>;
225
- /**
226
- * Indicates the alarm modes that will be emitted if the sensor is triggered. If an alarm mode is not
227
- * supported, the bit indicating this alarm mode shall always be 0.
228
- *
229
- * A bit shall indicate whether the alarm mode is enabled or disabled:
230
- *
231
- * • 0 = Disabled
232
- *
233
- * • 1 = Enabled
234
- *
235
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.6
236
- */
237
- readonly alarmsEnabled: OptionalAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
238
- /**
239
- * Visual alarming
240
- */
241
- visual: BitFlag;
242
- /**
243
- * Audible alarming
244
- */
245
- audible: BitFlag;
246
- }>, any>;
247
- /**
248
- * Indicates the alarms supported by the sensor. A bit shall indicate whether the alarm mode is supported:
249
- *
250
- * • 0 = Not supported
251
- *
252
- * • 1 = Supported
253
- *
254
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.7
255
- */
256
- readonly alarmsSupported: FixedAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
257
- /**
258
- * Visual alarming
259
- */
260
- visual: BitFlag;
261
- /**
262
- * Audible alarming
263
- */
264
- audible: BitFlag;
265
- }>, any>;
266
- };
267
- readonly commands: {
268
- /**
269
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2
270
- */
271
- readonly enableDisableAlarm: Command<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
272
- /**
273
- * This field shall indicate the alarm modes to either enable or disable depending on the bit status, as
274
- * specified for the AlarmsEnabled attribute.
275
- *
276
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2.1
277
- */
278
- alarmsToEnableDisable: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
279
- /**
280
- * Visual alarming
281
- */
282
- visual: BitFlag;
283
- /**
284
- * Audible alarming
285
- */
286
- audible: BitFlag;
287
- }>>;
288
- }>, void, any>;
289
- };
290
- readonly events: {
291
- /**
292
- * This event shall be generated after any bits in the AlarmsActive and/or AlarmsSuppressed attributes
293
- * change. This may occur in situations such as when internal processing by the server determines that an
294
- * alarm mode becomes active or inactive, or when the SuppressAlarm or EnableDisableAlarm commands are
295
- * processed in a way that some alarm modes becomes suppressed, active or inactive.
296
- *
297
- * If several alarm modes change state at the same time, a single event combining multiple changes may be
298
- * emitted instead of multiple events each representing a single change.
299
- *
300
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1
301
- */
302
- readonly alarmsStateChanged: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
303
- /**
304
- * This field shall indicate the state of active alarm modes, as indicated by the AlarmsActive attribute, at
305
- * the time the event was generated.
306
- *
307
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.1
308
- */
309
- alarmsActive: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
310
- /**
311
- * Visual alarming
312
- */
313
- visual: BitFlag;
314
- /**
315
- * Audible alarming
316
- */
317
- audible: BitFlag;
318
- }>>;
319
- /**
320
- * This field shall indicate the state of suppressed alarm modes, as indicated by the AlarmsSuppressed
321
- * attribute, at the time the event was generated.
322
- *
323
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.2
324
- */
325
- alarmsSuppressed: import("@project-chip/matter-node.js/tlv").OptionalFieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
326
- /**
327
- * Visual alarming
328
- */
329
- visual: BitFlag;
330
- /**
331
- * Audible alarming
332
- */
333
- audible: BitFlag;
334
- }>>;
335
- }>, any>;
336
- };
337
- };
338
- /**
339
- * A BooleanStateConfigurationCluster supports these elements if it supports feature AlarmSuppress.
340
- */
341
- const AlarmSuppressComponent: {
342
- readonly attributes: {
343
- /**
344
- * Indicates which specific alarm modes on the server are currently suppressed. When the sensor is no
345
- * longer triggered, this attribute shall be set to the unsuppressed state, by setting the bit to 0, for
346
- * all supported alarm modes.
347
- *
348
- * If an alarm mode is not supported, the bit indicating this alarm mode shall always be 0. A bit shall
349
- * indicate whether the alarm mode is suppressed or not:
350
- *
351
- * • 0 = Not suppressed
352
- *
353
- * • 1 = Suppressed
354
- *
355
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.5
356
- */
357
- readonly alarmsSuppressed: Attribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
358
- /**
359
- * Visual alarming
360
- */
361
- visual: BitFlag;
362
- /**
363
- * Audible alarming
364
- */
365
- audible: BitFlag;
366
- }>, any>;
367
- };
368
- readonly commands: {
369
- /**
370
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.1
371
- */
372
- readonly suppressAlarm: Command<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
373
- /**
374
- * This field shall indicate the alarm modes to suppress.
375
- *
376
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.1.1
377
- */
378
- alarmsToSuppress: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
379
- /**
380
- * Visual alarming
381
- */
382
- visual: BitFlag;
383
- /**
384
- * Audible alarming
385
- */
386
- audible: BitFlag;
387
- }>>;
388
- }>, void, any>;
389
- };
390
- };
391
- /**
392
- * These are optional features supported by BooleanStateConfigurationCluster.
393
- *
394
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.4
395
- */
396
- enum Feature {
397
- /**
398
- * Visual (VIS)
399
- *
400
- * Supports visual alarms
401
- */
402
- Visual = "Visual",
403
- /**
404
- * Audible (AUD)
405
- *
406
- * Supports audible alarms
407
- */
408
- Audible = "Audible",
409
- /**
410
- * AlarmSuppress (SPRS)
411
- *
412
- * This feature shall indicate that the device is able to suppress the supported alarm modes, when the user
413
- * acknowledges the alarm. This is intended to stop visual and/or audible alarms, when the user has become
414
- * aware that the sensor is triggered, but it is no longer desired to have the alarm modes active on the
415
- * device, e.g.:
416
- *
417
- * • The triggering cause have been resolved by the user, but the sensor has not yet stopped detecting the
418
- * triggering cause.
419
- *
420
- * • The user is not able to address the triggering cause, but is aware of the alarm and suppress/acknowledge
421
- * it be addressed at a later point.
422
- *
423
- * Acknowledge of alarms will for the remainder of this cluster be referred to as suppress.
424
- *
425
- * A suppressed alarm is still considered active and will remain so unless it is actively disabled or the
426
- * triggering condition is not longer present. The action of suppressing an alarm mode is only applicable to
427
- * and is intended to stop the physical alarming, e.g. emitting a sound or blinking a light; it does not impact
428
- * alarm reporting in AlarmsActive.
429
- *
430
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.4.1
431
- */
432
- AlarmSuppress = "AlarmSuppress",
433
- /**
434
- * SensitivityLevel (SENSLVL)
435
- *
436
- * Supports ability to set sensor sensitivity
437
- */
438
- SensitivityLevel = "SensitivityLevel"
439
- }
440
- /**
441
- * These elements and properties are present in all BooleanStateConfiguration clusters.
442
- */
443
- const Base: {
444
- readonly id: 128;
445
- readonly name: "BooleanStateConfiguration";
446
- readonly revision: 1;
447
- readonly features: {
448
- /**
449
- * Visual
450
- *
451
- * Supports visual alarms
452
- */
453
- readonly visual: BitFlag;
454
- /**
455
- * Audible
456
- *
457
- * Supports audible alarms
458
- */
459
- readonly audible: BitFlag;
460
- /**
461
- * AlarmSuppress
462
- *
463
- * This feature shall indicate that the device is able to suppress the supported alarm modes, when the user
464
- * acknowledges the alarm. This is intended to stop visual and/or audible alarms, when the user has become
465
- * aware that the sensor is triggered, but it is no longer desired to have the alarm modes active on the
466
- * device, e.g.:
467
- *
468
- * • The triggering cause have been resolved by the user, but the sensor has not yet stopped detecting
469
- * the triggering cause.
470
- *
471
- * • The user is not able to address the triggering cause, but is aware of the alarm and
472
- * suppress/acknowledge it be addressed at a later point.
473
- *
474
- * Acknowledge of alarms will for the remainder of this cluster be referred to as suppress.
475
- *
476
- * A suppressed alarm is still considered active and will remain so unless it is actively disabled or the
477
- * triggering condition is not longer present. The action of suppressing an alarm mode is only applicable
478
- * to and is intended to stop the physical alarming, e.g. emitting a sound or blinking a light; it does not
479
- * impact alarm reporting in AlarmsActive.
480
- *
481
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.4.1
482
- */
483
- readonly alarmSuppress: BitFlag;
484
- /**
485
- * SensitivityLevel
486
- *
487
- * Supports ability to set sensor sensitivity
488
- */
489
- readonly sensitivityLevel: BitFlag;
490
- };
491
- readonly attributes: {
492
- /**
493
- * Indicates any faults registered by the device.
494
- *
495
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.8
496
- */
497
- readonly sensorFault: OptionalAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
498
- /**
499
- * Unspecified fault detected
500
- */
501
- generalFault: BitFlag;
502
- }>, any>;
503
- };
504
- readonly events: {
505
- /**
506
- * This event shall be generated when the device registers or clears a fault.
507
- *
508
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.2
509
- */
510
- readonly sensorFault: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
511
- /**
512
- * This field shall indicate the value of the SensorFault attribute, at the time this event is generated.
513
- *
514
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.2.1
515
- */
516
- sensorFault: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
517
- /**
518
- * Unspecified fault detected
519
- */
520
- generalFault: BitFlag;
521
- }>>;
522
- }>, any>;
523
- };
524
- /**
525
- * This metadata controls which BooleanStateConfigurationCluster elements matter.js activates for specific
526
- * feature combinations.
527
- */
528
- readonly extensions: readonly [{
529
- readonly flags: {
530
- readonly sensitivityLevel: true;
531
- };
532
- readonly component: {
533
- readonly attributes: {
534
- /**
535
- * Indicates the currently selected sensitivity level.
536
- *
537
- * If a write interaction to this attribute contains an unsupported sensitivity value, a CONSTRAINT_ERROR
538
- * status shall be returned.
539
- *
540
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.1
541
- */
542
- readonly currentSensitivityLevel: WritableAttribute<number, any>;
543
- /**
544
- * Indicates the number of supported sensitivity levels by the device.
545
- *
546
- * These supported sensitivity levels shall be ordered by sensitivity, where a value of 0 shall be
547
- * considered the lowest sensitivity level (least sensitive) and the highest supported value shall be
548
- * considered the highest sensitivity level.
549
- *
550
- * The number of supported sensitivity levels SHOULD represent unique sensitivity levels supported by the
551
- * device.
552
- *
553
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.2
554
- */
555
- readonly supportedSensitivityLevels: FixedAttribute<number, any>;
556
- /**
557
- * Indicates the default sensitivity level selected by the manufacturer.
558
- *
559
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.3
560
- */
561
- readonly defaultSensitivityLevel: OptionalFixedAttribute<number, any>;
562
- };
563
- };
564
- }, {
565
- readonly flags: {
566
- readonly visual: true;
567
- };
568
- readonly component: {
569
- readonly attributes: {
570
- /**
571
- * Indicates which specific alarm modes on the server are currently active. When the sensor is no longer
572
- * triggered, this attribute shall be set to the inactive state, by setting the bit to 0, for all supported
573
- * alarm modes.
574
- *
575
- * If an alarm mode is not supported, the bit indicating this alarm mode shall always be 0. A bit shall
576
- * indicate whether the alarm mode inactive or not:
577
- *
578
- * • 0 = Inactive
579
- *
580
- * • 1 = Active
581
- *
582
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.4
583
- */
584
- readonly alarmsActive: Attribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
585
- /**
586
- * Visual alarming
587
- */
588
- visual: BitFlag;
589
- /**
590
- * Audible alarming
591
- */
592
- audible: BitFlag;
593
- }>, any>;
594
- /**
595
- * Indicates the alarm modes that will be emitted if the sensor is triggered. If an alarm mode is not
596
- * supported, the bit indicating this alarm mode shall always be 0.
597
- *
598
- * A bit shall indicate whether the alarm mode is enabled or disabled:
599
- *
600
- * • 0 = Disabled
601
- *
602
- * • 1 = Enabled
603
- *
604
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.6
605
- */
606
- readonly alarmsEnabled: OptionalAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
607
- /**
608
- * Visual alarming
609
- */
610
- visual: BitFlag;
611
- /**
612
- * Audible alarming
613
- */
614
- audible: BitFlag;
615
- }>, any>;
616
- /**
617
- * Indicates the alarms supported by the sensor. A bit shall indicate whether the alarm mode is supported:
618
- *
619
- * • 0 = Not supported
620
- *
621
- * • 1 = Supported
622
- *
623
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.7
624
- */
625
- readonly alarmsSupported: FixedAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
626
- /**
627
- * Visual alarming
628
- */
629
- visual: BitFlag;
630
- /**
631
- * Audible alarming
632
- */
633
- audible: BitFlag;
634
- }>, any>;
635
- };
636
- readonly commands: {
637
- /**
638
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2
639
- */
640
- readonly enableDisableAlarm: Command<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
641
- /**
642
- * This field shall indicate the alarm modes to either enable or disable depending on the bit status, as
643
- * specified for the AlarmsEnabled attribute.
644
- *
645
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2.1
646
- */
647
- alarmsToEnableDisable: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
648
- /**
649
- * Visual alarming
650
- */
651
- visual: BitFlag;
652
- /**
653
- * Audible alarming
654
- */
655
- audible: BitFlag;
656
- }>>;
657
- }>, void, any>;
658
- };
659
- readonly events: {
660
- /**
661
- * This event shall be generated after any bits in the AlarmsActive and/or AlarmsSuppressed attributes
662
- * change. This may occur in situations such as when internal processing by the server determines that an
663
- * alarm mode becomes active or inactive, or when the SuppressAlarm or EnableDisableAlarm commands are
664
- * processed in a way that some alarm modes becomes suppressed, active or inactive.
665
- *
666
- * If several alarm modes change state at the same time, a single event combining multiple changes may be
667
- * emitted instead of multiple events each representing a single change.
668
- *
669
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1
670
- */
671
- readonly alarmsStateChanged: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
672
- /**
673
- * This field shall indicate the state of active alarm modes, as indicated by the AlarmsActive attribute, at
674
- * the time the event was generated.
675
- *
676
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.1
677
- */
678
- alarmsActive: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
679
- /**
680
- * Visual alarming
681
- */
682
- visual: BitFlag;
683
- /**
684
- * Audible alarming
685
- */
686
- audible: BitFlag;
687
- }>>;
688
- /**
689
- * This field shall indicate the state of suppressed alarm modes, as indicated by the AlarmsSuppressed
690
- * attribute, at the time the event was generated.
691
- *
692
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.2
693
- */
694
- alarmsSuppressed: import("@project-chip/matter-node.js/tlv").OptionalFieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
695
- /**
696
- * Visual alarming
697
- */
698
- visual: BitFlag;
699
- /**
700
- * Audible alarming
701
- */
702
- audible: BitFlag;
703
- }>>;
704
- }>, any>;
705
- };
706
- };
707
- }, {
708
- readonly flags: {
709
- readonly audible: true;
710
- };
711
- readonly component: {
712
- readonly attributes: {
713
- /**
714
- * Indicates which specific alarm modes on the server are currently active. When the sensor is no longer
715
- * triggered, this attribute shall be set to the inactive state, by setting the bit to 0, for all supported
716
- * alarm modes.
717
- *
718
- * If an alarm mode is not supported, the bit indicating this alarm mode shall always be 0. A bit shall
719
- * indicate whether the alarm mode inactive or not:
720
- *
721
- * • 0 = Inactive
722
- *
723
- * • 1 = Active
724
- *
725
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.4
726
- */
727
- readonly alarmsActive: Attribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
728
- /**
729
- * Visual alarming
730
- */
731
- visual: BitFlag;
732
- /**
733
- * Audible alarming
734
- */
735
- audible: BitFlag;
736
- }>, any>;
737
- /**
738
- * Indicates the alarm modes that will be emitted if the sensor is triggered. If an alarm mode is not
739
- * supported, the bit indicating this alarm mode shall always be 0.
740
- *
741
- * A bit shall indicate whether the alarm mode is enabled or disabled:
742
- *
743
- * • 0 = Disabled
744
- *
745
- * • 1 = Enabled
746
- *
747
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.6
748
- */
749
- readonly alarmsEnabled: OptionalAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
750
- /**
751
- * Visual alarming
752
- */
753
- visual: BitFlag;
754
- /**
755
- * Audible alarming
756
- */
757
- audible: BitFlag;
758
- }>, any>;
759
- /**
760
- * Indicates the alarms supported by the sensor. A bit shall indicate whether the alarm mode is supported:
761
- *
762
- * • 0 = Not supported
763
- *
764
- * • 1 = Supported
765
- *
766
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.7
767
- */
768
- readonly alarmsSupported: FixedAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
769
- /**
770
- * Visual alarming
771
- */
772
- visual: BitFlag;
773
- /**
774
- * Audible alarming
775
- */
776
- audible: BitFlag;
777
- }>, any>;
778
- };
779
- readonly commands: {
780
- /**
781
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2
782
- */
783
- readonly enableDisableAlarm: Command<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
784
- /**
785
- * This field shall indicate the alarm modes to either enable or disable depending on the bit status, as
786
- * specified for the AlarmsEnabled attribute.
787
- *
788
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2.1
789
- */
790
- alarmsToEnableDisable: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
791
- /**
792
- * Visual alarming
793
- */
794
- visual: BitFlag;
795
- /**
796
- * Audible alarming
797
- */
798
- audible: BitFlag;
799
- }>>;
800
- }>, void, any>;
801
- };
802
- readonly events: {
803
- /**
804
- * This event shall be generated after any bits in the AlarmsActive and/or AlarmsSuppressed attributes
805
- * change. This may occur in situations such as when internal processing by the server determines that an
806
- * alarm mode becomes active or inactive, or when the SuppressAlarm or EnableDisableAlarm commands are
807
- * processed in a way that some alarm modes becomes suppressed, active or inactive.
808
- *
809
- * If several alarm modes change state at the same time, a single event combining multiple changes may be
810
- * emitted instead of multiple events each representing a single change.
811
- *
812
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1
813
- */
814
- readonly alarmsStateChanged: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
815
- /**
816
- * This field shall indicate the state of active alarm modes, as indicated by the AlarmsActive attribute, at
817
- * the time the event was generated.
818
- *
819
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.1
820
- */
821
- alarmsActive: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
822
- /**
823
- * Visual alarming
824
- */
825
- visual: BitFlag;
826
- /**
827
- * Audible alarming
828
- */
829
- audible: BitFlag;
830
- }>>;
831
- /**
832
- * This field shall indicate the state of suppressed alarm modes, as indicated by the AlarmsSuppressed
833
- * attribute, at the time the event was generated.
834
- *
835
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.2
836
- */
837
- alarmsSuppressed: import("@project-chip/matter-node.js/tlv").OptionalFieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
838
- /**
839
- * Visual alarming
840
- */
841
- visual: BitFlag;
842
- /**
843
- * Audible alarming
844
- */
845
- audible: BitFlag;
846
- }>>;
847
- }>, any>;
848
- };
849
- };
850
- }, {
851
- readonly flags: {
852
- readonly alarmSuppress: true;
853
- };
854
- readonly component: {
855
- readonly attributes: {
856
- /**
857
- * Indicates which specific alarm modes on the server are currently suppressed. When the sensor is no
858
- * longer triggered, this attribute shall be set to the unsuppressed state, by setting the bit to 0, for
859
- * all supported alarm modes.
860
- *
861
- * If an alarm mode is not supported, the bit indicating this alarm mode shall always be 0. A bit shall
862
- * indicate whether the alarm mode is suppressed or not:
863
- *
864
- * • 0 = Not suppressed
865
- *
866
- * • 1 = Suppressed
867
- *
868
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.5
869
- */
870
- readonly alarmsSuppressed: Attribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
871
- /**
872
- * Visual alarming
873
- */
874
- visual: BitFlag;
875
- /**
876
- * Audible alarming
877
- */
878
- audible: BitFlag;
879
- }>, any>;
880
- };
881
- readonly commands: {
882
- /**
883
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.1
884
- */
885
- readonly suppressAlarm: Command<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
886
- /**
887
- * This field shall indicate the alarm modes to suppress.
888
- *
889
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.1.1
890
- */
891
- alarmsToSuppress: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
892
- /**
893
- * Visual alarming
894
- */
895
- visual: BitFlag;
896
- /**
897
- * Audible alarming
898
- */
899
- audible: BitFlag;
900
- }>>;
901
- }>, void, any>;
902
- };
903
- };
904
- }, {
905
- readonly flags: {
906
- readonly alarmSuppress: true;
907
- readonly visual: true;
908
- readonly audible: true;
909
- };
910
- readonly component: false;
911
- }];
912
- };
913
- /**
914
- * @see {@link Cluster}
915
- */
916
- const ClusterInstance: MutableCluster<{
917
- readonly id: 128;
918
- readonly name: "BooleanStateConfiguration";
919
- readonly revision: 1;
920
- readonly features: {
921
- /**
922
- * Visual
923
- *
924
- * Supports visual alarms
925
- */
926
- readonly visual: BitFlag;
927
- /**
928
- * Audible
929
- *
930
- * Supports audible alarms
931
- */
932
- readonly audible: BitFlag;
933
- /**
934
- * AlarmSuppress
935
- *
936
- * This feature shall indicate that the device is able to suppress the supported alarm modes, when the user
937
- * acknowledges the alarm. This is intended to stop visual and/or audible alarms, when the user has become
938
- * aware that the sensor is triggered, but it is no longer desired to have the alarm modes active on the
939
- * device, e.g.:
940
- *
941
- * • The triggering cause have been resolved by the user, but the sensor has not yet stopped detecting
942
- * the triggering cause.
943
- *
944
- * • The user is not able to address the triggering cause, but is aware of the alarm and
945
- * suppress/acknowledge it be addressed at a later point.
946
- *
947
- * Acknowledge of alarms will for the remainder of this cluster be referred to as suppress.
948
- *
949
- * A suppressed alarm is still considered active and will remain so unless it is actively disabled or the
950
- * triggering condition is not longer present. The action of suppressing an alarm mode is only applicable
951
- * to and is intended to stop the physical alarming, e.g. emitting a sound or blinking a light; it does not
952
- * impact alarm reporting in AlarmsActive.
953
- *
954
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.4.1
955
- */
956
- readonly alarmSuppress: BitFlag;
957
- /**
958
- * SensitivityLevel
959
- *
960
- * Supports ability to set sensor sensitivity
961
- */
962
- readonly sensitivityLevel: BitFlag;
963
- };
964
- readonly attributes: {
965
- /**
966
- * Indicates any faults registered by the device.
967
- *
968
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.8
969
- */
970
- readonly sensorFault: OptionalAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
971
- /**
972
- * Unspecified fault detected
973
- */
974
- generalFault: BitFlag;
975
- }>, any>;
976
- };
977
- readonly events: {
978
- /**
979
- * This event shall be generated when the device registers or clears a fault.
980
- *
981
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.2
982
- */
983
- readonly sensorFault: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
984
- /**
985
- * This field shall indicate the value of the SensorFault attribute, at the time this event is generated.
986
- *
987
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.2.1
988
- */
989
- sensorFault: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
990
- /**
991
- * Unspecified fault detected
992
- */
993
- generalFault: BitFlag;
994
- }>>;
995
- }>, any>;
996
- };
997
- /**
998
- * This metadata controls which BooleanStateConfigurationCluster elements matter.js activates for specific
999
- * feature combinations.
1000
- */
1001
- readonly extensions: readonly [{
1002
- readonly flags: {
1003
- readonly sensitivityLevel: true;
1004
- };
1005
- readonly component: {
1006
- readonly attributes: {
1007
- /**
1008
- * Indicates the currently selected sensitivity level.
1009
- *
1010
- * If a write interaction to this attribute contains an unsupported sensitivity value, a CONSTRAINT_ERROR
1011
- * status shall be returned.
1012
- *
1013
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.1
1014
- */
1015
- readonly currentSensitivityLevel: WritableAttribute<number, any>;
1016
- /**
1017
- * Indicates the number of supported sensitivity levels by the device.
1018
- *
1019
- * These supported sensitivity levels shall be ordered by sensitivity, where a value of 0 shall be
1020
- * considered the lowest sensitivity level (least sensitive) and the highest supported value shall be
1021
- * considered the highest sensitivity level.
1022
- *
1023
- * The number of supported sensitivity levels SHOULD represent unique sensitivity levels supported by the
1024
- * device.
1025
- *
1026
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.2
1027
- */
1028
- readonly supportedSensitivityLevels: FixedAttribute<number, any>;
1029
- /**
1030
- * Indicates the default sensitivity level selected by the manufacturer.
1031
- *
1032
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.3
1033
- */
1034
- readonly defaultSensitivityLevel: OptionalFixedAttribute<number, any>;
1035
- };
1036
- };
1037
- }, {
1038
- readonly flags: {
1039
- readonly visual: true;
1040
- };
1041
- readonly component: {
1042
- readonly attributes: {
1043
- /**
1044
- * Indicates which specific alarm modes on the server are currently active. When the sensor is no longer
1045
- * triggered, this attribute shall be set to the inactive state, by setting the bit to 0, for all supported
1046
- * alarm modes.
1047
- *
1048
- * If an alarm mode is not supported, the bit indicating this alarm mode shall always be 0. A bit shall
1049
- * indicate whether the alarm mode inactive or not:
1050
- *
1051
- * • 0 = Inactive
1052
- *
1053
- * • 1 = Active
1054
- *
1055
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.4
1056
- */
1057
- readonly alarmsActive: Attribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1058
- /**
1059
- * Visual alarming
1060
- */
1061
- visual: BitFlag;
1062
- /**
1063
- * Audible alarming
1064
- */
1065
- audible: BitFlag;
1066
- }>, any>;
1067
- /**
1068
- * Indicates the alarm modes that will be emitted if the sensor is triggered. If an alarm mode is not
1069
- * supported, the bit indicating this alarm mode shall always be 0.
1070
- *
1071
- * A bit shall indicate whether the alarm mode is enabled or disabled:
1072
- *
1073
- * • 0 = Disabled
1074
- *
1075
- * • 1 = Enabled
1076
- *
1077
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.6
1078
- */
1079
- readonly alarmsEnabled: OptionalAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1080
- /**
1081
- * Visual alarming
1082
- */
1083
- visual: BitFlag;
1084
- /**
1085
- * Audible alarming
1086
- */
1087
- audible: BitFlag;
1088
- }>, any>;
1089
- /**
1090
- * Indicates the alarms supported by the sensor. A bit shall indicate whether the alarm mode is supported:
1091
- *
1092
- * • 0 = Not supported
1093
- *
1094
- * • 1 = Supported
1095
- *
1096
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.7
1097
- */
1098
- readonly alarmsSupported: FixedAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1099
- /**
1100
- * Visual alarming
1101
- */
1102
- visual: BitFlag;
1103
- /**
1104
- * Audible alarming
1105
- */
1106
- audible: BitFlag;
1107
- }>, any>;
1108
- };
1109
- readonly commands: {
1110
- /**
1111
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2
1112
- */
1113
- readonly enableDisableAlarm: Command<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1114
- /**
1115
- * This field shall indicate the alarm modes to either enable or disable depending on the bit status, as
1116
- * specified for the AlarmsEnabled attribute.
1117
- *
1118
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2.1
1119
- */
1120
- alarmsToEnableDisable: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1121
- /**
1122
- * Visual alarming
1123
- */
1124
- visual: BitFlag;
1125
- /**
1126
- * Audible alarming
1127
- */
1128
- audible: BitFlag;
1129
- }>>;
1130
- }>, void, any>;
1131
- };
1132
- readonly events: {
1133
- /**
1134
- * This event shall be generated after any bits in the AlarmsActive and/or AlarmsSuppressed attributes
1135
- * change. This may occur in situations such as when internal processing by the server determines that an
1136
- * alarm mode becomes active or inactive, or when the SuppressAlarm or EnableDisableAlarm commands are
1137
- * processed in a way that some alarm modes becomes suppressed, active or inactive.
1138
- *
1139
- * If several alarm modes change state at the same time, a single event combining multiple changes may be
1140
- * emitted instead of multiple events each representing a single change.
1141
- *
1142
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1
1143
- */
1144
- readonly alarmsStateChanged: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1145
- /**
1146
- * This field shall indicate the state of active alarm modes, as indicated by the AlarmsActive attribute, at
1147
- * the time the event was generated.
1148
- *
1149
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.1
1150
- */
1151
- alarmsActive: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1152
- /**
1153
- * Visual alarming
1154
- */
1155
- visual: BitFlag;
1156
- /**
1157
- * Audible alarming
1158
- */
1159
- audible: BitFlag;
1160
- }>>;
1161
- /**
1162
- * This field shall indicate the state of suppressed alarm modes, as indicated by the AlarmsSuppressed
1163
- * attribute, at the time the event was generated.
1164
- *
1165
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.2
1166
- */
1167
- alarmsSuppressed: import("@project-chip/matter-node.js/tlv").OptionalFieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1168
- /**
1169
- * Visual alarming
1170
- */
1171
- visual: BitFlag;
1172
- /**
1173
- * Audible alarming
1174
- */
1175
- audible: BitFlag;
1176
- }>>;
1177
- }>, any>;
1178
- };
1179
- };
1180
- }, {
1181
- readonly flags: {
1182
- readonly audible: true;
1183
- };
1184
- readonly component: {
1185
- readonly attributes: {
1186
- /**
1187
- * Indicates which specific alarm modes on the server are currently active. When the sensor is no longer
1188
- * triggered, this attribute shall be set to the inactive state, by setting the bit to 0, for all supported
1189
- * alarm modes.
1190
- *
1191
- * If an alarm mode is not supported, the bit indicating this alarm mode shall always be 0. A bit shall
1192
- * indicate whether the alarm mode inactive or not:
1193
- *
1194
- * • 0 = Inactive
1195
- *
1196
- * • 1 = Active
1197
- *
1198
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.4
1199
- */
1200
- readonly alarmsActive: Attribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1201
- /**
1202
- * Visual alarming
1203
- */
1204
- visual: BitFlag;
1205
- /**
1206
- * Audible alarming
1207
- */
1208
- audible: BitFlag;
1209
- }>, any>;
1210
- /**
1211
- * Indicates the alarm modes that will be emitted if the sensor is triggered. If an alarm mode is not
1212
- * supported, the bit indicating this alarm mode shall always be 0.
1213
- *
1214
- * A bit shall indicate whether the alarm mode is enabled or disabled:
1215
- *
1216
- * • 0 = Disabled
1217
- *
1218
- * • 1 = Enabled
1219
- *
1220
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.6
1221
- */
1222
- readonly alarmsEnabled: OptionalAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1223
- /**
1224
- * Visual alarming
1225
- */
1226
- visual: BitFlag;
1227
- /**
1228
- * Audible alarming
1229
- */
1230
- audible: BitFlag;
1231
- }>, any>;
1232
- /**
1233
- * Indicates the alarms supported by the sensor. A bit shall indicate whether the alarm mode is supported:
1234
- *
1235
- * • 0 = Not supported
1236
- *
1237
- * • 1 = Supported
1238
- *
1239
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.7
1240
- */
1241
- readonly alarmsSupported: FixedAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1242
- /**
1243
- * Visual alarming
1244
- */
1245
- visual: BitFlag;
1246
- /**
1247
- * Audible alarming
1248
- */
1249
- audible: BitFlag;
1250
- }>, any>;
1251
- };
1252
- readonly commands: {
1253
- /**
1254
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2
1255
- */
1256
- readonly enableDisableAlarm: Command<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1257
- /**
1258
- * This field shall indicate the alarm modes to either enable or disable depending on the bit status, as
1259
- * specified for the AlarmsEnabled attribute.
1260
- *
1261
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2.1
1262
- */
1263
- alarmsToEnableDisable: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1264
- /**
1265
- * Visual alarming
1266
- */
1267
- visual: BitFlag;
1268
- /**
1269
- * Audible alarming
1270
- */
1271
- audible: BitFlag;
1272
- }>>;
1273
- }>, void, any>;
1274
- };
1275
- readonly events: {
1276
- /**
1277
- * This event shall be generated after any bits in the AlarmsActive and/or AlarmsSuppressed attributes
1278
- * change. This may occur in situations such as when internal processing by the server determines that an
1279
- * alarm mode becomes active or inactive, or when the SuppressAlarm or EnableDisableAlarm commands are
1280
- * processed in a way that some alarm modes becomes suppressed, active or inactive.
1281
- *
1282
- * If several alarm modes change state at the same time, a single event combining multiple changes may be
1283
- * emitted instead of multiple events each representing a single change.
1284
- *
1285
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1
1286
- */
1287
- readonly alarmsStateChanged: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1288
- /**
1289
- * This field shall indicate the state of active alarm modes, as indicated by the AlarmsActive attribute, at
1290
- * the time the event was generated.
1291
- *
1292
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.1
1293
- */
1294
- alarmsActive: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1295
- /**
1296
- * Visual alarming
1297
- */
1298
- visual: BitFlag;
1299
- /**
1300
- * Audible alarming
1301
- */
1302
- audible: BitFlag;
1303
- }>>;
1304
- /**
1305
- * This field shall indicate the state of suppressed alarm modes, as indicated by the AlarmsSuppressed
1306
- * attribute, at the time the event was generated.
1307
- *
1308
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.2
1309
- */
1310
- alarmsSuppressed: import("@project-chip/matter-node.js/tlv").OptionalFieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1311
- /**
1312
- * Visual alarming
1313
- */
1314
- visual: BitFlag;
1315
- /**
1316
- * Audible alarming
1317
- */
1318
- audible: BitFlag;
1319
- }>>;
1320
- }>, any>;
1321
- };
1322
- };
1323
- }, {
1324
- readonly flags: {
1325
- readonly alarmSuppress: true;
1326
- };
1327
- readonly component: {
1328
- readonly attributes: {
1329
- /**
1330
- * Indicates which specific alarm modes on the server are currently suppressed. When the sensor is no
1331
- * longer triggered, this attribute shall be set to the unsuppressed state, by setting the bit to 0, for
1332
- * all supported alarm modes.
1333
- *
1334
- * If an alarm mode is not supported, the bit indicating this alarm mode shall always be 0. A bit shall
1335
- * indicate whether the alarm mode is suppressed or not:
1336
- *
1337
- * • 0 = Not suppressed
1338
- *
1339
- * • 1 = Suppressed
1340
- *
1341
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.5
1342
- */
1343
- readonly alarmsSuppressed: Attribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1344
- /**
1345
- * Visual alarming
1346
- */
1347
- visual: BitFlag;
1348
- /**
1349
- * Audible alarming
1350
- */
1351
- audible: BitFlag;
1352
- }>, any>;
1353
- };
1354
- readonly commands: {
1355
- /**
1356
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.1
1357
- */
1358
- readonly suppressAlarm: Command<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1359
- /**
1360
- * This field shall indicate the alarm modes to suppress.
1361
- *
1362
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.1.1
1363
- */
1364
- alarmsToSuppress: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1365
- /**
1366
- * Visual alarming
1367
- */
1368
- visual: BitFlag;
1369
- /**
1370
- * Audible alarming
1371
- */
1372
- audible: BitFlag;
1373
- }>>;
1374
- }>, void, any>;
1375
- };
1376
- };
1377
- }, {
1378
- readonly flags: {
1379
- readonly alarmSuppress: true;
1380
- readonly visual: true;
1381
- readonly audible: true;
1382
- };
1383
- readonly component: false;
1384
- }];
1385
- }>;
1386
- /**
1387
- * This cluster is used to configure a boolean sensor, including optional state change alarm features and
1388
- * configuration of the sensitivity level associated with the sensor.
1389
- *
1390
- * BooleanStateConfigurationCluster supports optional features that you can enable with the
1391
- * BooleanStateConfigurationCluster.with() factory method.
1392
- *
1393
- * @see {@link MatterSpecification.v13.Cluster} § 1.8
1394
- */
1395
- type Cluster = Identity<typeof ClusterInstance>;
1396
- const Cluster: Cluster;
1397
- /**
1398
- * @see {@link Complete}
1399
- */
1400
- const CompleteInstance: MutableCluster<{
1401
- readonly id: import("@project-chip/matter-node.js/util").Branded<128, "ClusterId">;
1402
- readonly name: "BooleanStateConfiguration";
1403
- readonly revision: 1;
1404
- readonly features: {
1405
- /**
1406
- * Visual
1407
- *
1408
- * Supports visual alarms
1409
- */
1410
- readonly visual: BitFlag;
1411
- /**
1412
- * Audible
1413
- *
1414
- * Supports audible alarms
1415
- */
1416
- readonly audible: BitFlag;
1417
- /**
1418
- * AlarmSuppress
1419
- *
1420
- * This feature shall indicate that the device is able to suppress the supported alarm modes, when the user
1421
- * acknowledges the alarm. This is intended to stop visual and/or audible alarms, when the user has become
1422
- * aware that the sensor is triggered, but it is no longer desired to have the alarm modes active on the
1423
- * device, e.g.:
1424
- *
1425
- * • The triggering cause have been resolved by the user, but the sensor has not yet stopped detecting
1426
- * the triggering cause.
1427
- *
1428
- * • The user is not able to address the triggering cause, but is aware of the alarm and
1429
- * suppress/acknowledge it be addressed at a later point.
1430
- *
1431
- * Acknowledge of alarms will for the remainder of this cluster be referred to as suppress.
1432
- *
1433
- * A suppressed alarm is still considered active and will remain so unless it is actively disabled or the
1434
- * triggering condition is not longer present. The action of suppressing an alarm mode is only applicable
1435
- * to and is intended to stop the physical alarming, e.g. emitting a sound or blinking a light; it does not
1436
- * impact alarm reporting in AlarmsActive.
1437
- *
1438
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.4.1
1439
- */
1440
- readonly alarmSuppress: BitFlag;
1441
- /**
1442
- * SensitivityLevel
1443
- *
1444
- * Supports ability to set sensor sensitivity
1445
- */
1446
- readonly sensitivityLevel: BitFlag;
1447
- };
1448
- readonly attributes: {
1449
- readonly currentSensitivityLevel: WritableAttribute<number, any> & {
1450
- readonly optional: true;
1451
- readonly isConditional: true;
1452
- readonly optionalIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1453
- readonly mandatoryIf: [] | [{
1454
- sensitivityLevel: boolean;
1455
- }];
1456
- };
1457
- readonly supportedSensitivityLevels: FixedAttribute<number, any> & {
1458
- readonly optional: true;
1459
- readonly isConditional: true;
1460
- readonly optionalIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1461
- readonly mandatoryIf: [] | [{
1462
- sensitivityLevel: boolean;
1463
- }];
1464
- };
1465
- readonly defaultSensitivityLevel: OptionalFixedAttribute<number, any> & {
1466
- readonly optional: true;
1467
- readonly isConditional: true;
1468
- readonly optionalIf: [] | [{
1469
- sensitivityLevel: boolean;
1470
- }];
1471
- readonly mandatoryIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1472
- };
1473
- readonly alarmsActive: Attribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1474
- /**
1475
- * Visual alarming
1476
- */
1477
- visual: BitFlag;
1478
- /**
1479
- * Audible alarming
1480
- */
1481
- audible: BitFlag;
1482
- }>, any> & {
1483
- readonly optional: true;
1484
- readonly isConditional: true;
1485
- readonly optionalIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1486
- readonly mandatoryIf: [] | [{
1487
- visual: boolean;
1488
- }, {
1489
- audible: boolean;
1490
- }];
1491
- };
1492
- readonly alarmsSuppressed: Attribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1493
- /**
1494
- * Visual alarming
1495
- */
1496
- visual: BitFlag;
1497
- /**
1498
- * Audible alarming
1499
- */
1500
- audible: BitFlag;
1501
- }>, any> & {
1502
- readonly optional: true;
1503
- readonly isConditional: true;
1504
- readonly optionalIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1505
- readonly mandatoryIf: [] | [{
1506
- alarmSuppress: boolean;
1507
- }];
1508
- };
1509
- readonly alarmsEnabled: OptionalAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1510
- /**
1511
- * Visual alarming
1512
- */
1513
- visual: BitFlag;
1514
- /**
1515
- * Audible alarming
1516
- */
1517
- audible: BitFlag;
1518
- }>, any> & {
1519
- readonly optional: true;
1520
- readonly isConditional: true;
1521
- readonly optionalIf: [] | [{
1522
- visual: boolean;
1523
- }, {
1524
- audible: boolean;
1525
- }];
1526
- readonly mandatoryIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1527
- };
1528
- readonly alarmsSupported: FixedAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1529
- /**
1530
- * Visual alarming
1531
- */
1532
- visual: BitFlag;
1533
- /**
1534
- * Audible alarming
1535
- */
1536
- audible: BitFlag;
1537
- }>, any> & {
1538
- readonly optional: true;
1539
- readonly isConditional: true;
1540
- readonly optionalIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1541
- readonly mandatoryIf: [] | [{
1542
- visual: boolean;
1543
- }, {
1544
- audible: boolean;
1545
- }];
1546
- };
1547
- readonly sensorFault: OptionalAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1548
- /**
1549
- * Unspecified fault detected
1550
- */
1551
- generalFault: BitFlag;
1552
- }>, any>;
1553
- readonly clusterRevision: Attribute<number, never>;
1554
- readonly featureMap: Attribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1555
- /**
1556
- * Visual
1557
- *
1558
- * Supports visual alarms
1559
- */
1560
- readonly visual: BitFlag;
1561
- /**
1562
- * Audible
1563
- *
1564
- * Supports audible alarms
1565
- */
1566
- readonly audible: BitFlag;
1567
- /**
1568
- * AlarmSuppress
1569
- *
1570
- * This feature shall indicate that the device is able to suppress the supported alarm modes, when the user
1571
- * acknowledges the alarm. This is intended to stop visual and/or audible alarms, when the user has become
1572
- * aware that the sensor is triggered, but it is no longer desired to have the alarm modes active on the
1573
- * device, e.g.:
1574
- *
1575
- * • The triggering cause have been resolved by the user, but the sensor has not yet stopped detecting
1576
- * the triggering cause.
1577
- *
1578
- * • The user is not able to address the triggering cause, but is aware of the alarm and
1579
- * suppress/acknowledge it be addressed at a later point.
1580
- *
1581
- * Acknowledge of alarms will for the remainder of this cluster be referred to as suppress.
1582
- *
1583
- * A suppressed alarm is still considered active and will remain so unless it is actively disabled or the
1584
- * triggering condition is not longer present. The action of suppressing an alarm mode is only applicable
1585
- * to and is intended to stop the physical alarming, e.g. emitting a sound or blinking a light; it does not
1586
- * impact alarm reporting in AlarmsActive.
1587
- *
1588
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.4.1
1589
- */
1590
- readonly alarmSuppress: BitFlag;
1591
- /**
1592
- * SensitivityLevel
1593
- *
1594
- * Supports ability to set sensor sensitivity
1595
- */
1596
- readonly sensitivityLevel: BitFlag;
1597
- }>, never>;
1598
- readonly attributeList: Attribute<import("@project-chip/matter.js/datatype").AttributeId[], never>;
1599
- readonly eventList: Attribute<import("@project-chip/matter.js/datatype").EventId[], never>;
1600
- readonly acceptedCommandList: Attribute<import("@project-chip/matter.js/datatype").CommandId[], never>;
1601
- readonly generatedCommandList: Attribute<import("@project-chip/matter.js/datatype").CommandId[], never>;
1602
- };
1603
- readonly commands: {
1604
- readonly suppressAlarm: Command<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1605
- /**
1606
- * This field shall indicate the alarm modes to suppress.
1607
- *
1608
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.1.1
1609
- */
1610
- alarmsToSuppress: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1611
- /**
1612
- * Visual alarming
1613
- */
1614
- visual: BitFlag;
1615
- /**
1616
- * Audible alarming
1617
- */
1618
- audible: BitFlag;
1619
- }>>;
1620
- }>, void, any> & {
1621
- readonly optional: true;
1622
- readonly isConditional: true;
1623
- readonly optionalIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1624
- readonly mandatoryIf: [] | [{
1625
- alarmSuppress: boolean;
1626
- }];
1627
- };
1628
- readonly enableDisableAlarm: Command<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1629
- /**
1630
- * This field shall indicate the alarm modes to either enable or disable depending on the bit status, as
1631
- * specified for the AlarmsEnabled attribute.
1632
- *
1633
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2.1
1634
- */
1635
- alarmsToEnableDisable: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1636
- /**
1637
- * Visual alarming
1638
- */
1639
- visual: BitFlag;
1640
- /**
1641
- * Audible alarming
1642
- */
1643
- audible: BitFlag;
1644
- }>>;
1645
- }>, void, any> & {
1646
- readonly optional: true;
1647
- readonly isConditional: true;
1648
- readonly optionalIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1649
- readonly mandatoryIf: [] | [{
1650
- visual: boolean;
1651
- }, {
1652
- audible: boolean;
1653
- }];
1654
- };
1655
- };
1656
- readonly events: {
1657
- readonly alarmsStateChanged: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1658
- /**
1659
- * This field shall indicate the state of active alarm modes, as indicated by the AlarmsActive attribute, at
1660
- * the time the event was generated.
1661
- *
1662
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.1
1663
- */
1664
- alarmsActive: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1665
- /**
1666
- * Visual alarming
1667
- */
1668
- visual: BitFlag;
1669
- /**
1670
- * Audible alarming
1671
- */
1672
- audible: BitFlag;
1673
- }>>;
1674
- /**
1675
- * This field shall indicate the state of suppressed alarm modes, as indicated by the AlarmsSuppressed
1676
- * attribute, at the time the event was generated.
1677
- *
1678
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.2
1679
- */
1680
- alarmsSuppressed: import("@project-chip/matter-node.js/tlv").OptionalFieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1681
- /**
1682
- * Visual alarming
1683
- */
1684
- visual: BitFlag;
1685
- /**
1686
- * Audible alarming
1687
- */
1688
- audible: BitFlag;
1689
- }>>;
1690
- }>, any> & {
1691
- readonly optional: true;
1692
- readonly isConditional: true;
1693
- readonly optionalIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1694
- readonly mandatoryIf: [] | [{
1695
- visual: boolean;
1696
- }, {
1697
- audible: boolean;
1698
- }];
1699
- };
1700
- /**
1701
- * This event shall be generated when the device registers or clears a fault.
1702
- *
1703
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.2
1704
- */
1705
- readonly sensorFault: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1706
- /**
1707
- * This field shall indicate the value of the SensorFault attribute, at the time this event is generated.
1708
- *
1709
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.2.1
1710
- */
1711
- sensorFault: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1712
- /**
1713
- * Unspecified fault detected
1714
- */
1715
- generalFault: BitFlag;
1716
- }>>;
1717
- }>, any>;
1718
- };
1719
- }>;
1720
- /**
1721
- * This cluster supports all BooleanStateConfiguration features. It may support illegal feature combinations.
1722
- *
1723
- * If you use this cluster you must manually specify which features are active and ensure the set of active
1724
- * features is legal per the Matter specification.
1725
- */
1726
- type Complete = Identity<typeof CompleteInstance>;
1727
- const Complete: Complete;
1728
- }
1729
- export type BooleanStateConfigurationCluster = BooleanStateConfiguration.Cluster;
1730
- export declare const BooleanStateConfigurationCluster: MutableCluster<{
1731
- readonly id: 128;
1732
- readonly name: "BooleanStateConfiguration";
1733
- readonly revision: 1;
1734
- readonly features: {
1735
- /**
1736
- * Visual
1737
- *
1738
- * Supports visual alarms
1739
- */
1740
- readonly visual: BitFlag;
1741
- /**
1742
- * Audible
1743
- *
1744
- * Supports audible alarms
1745
- */
1746
- readonly audible: BitFlag;
1747
- /**
1748
- * AlarmSuppress
1749
- *
1750
- * This feature shall indicate that the device is able to suppress the supported alarm modes, when the user
1751
- * acknowledges the alarm. This is intended to stop visual and/or audible alarms, when the user has become
1752
- * aware that the sensor is triggered, but it is no longer desired to have the alarm modes active on the
1753
- * device, e.g.:
1754
- *
1755
- * • The triggering cause have been resolved by the user, but the sensor has not yet stopped detecting
1756
- * the triggering cause.
1757
- *
1758
- * • The user is not able to address the triggering cause, but is aware of the alarm and
1759
- * suppress/acknowledge it be addressed at a later point.
1760
- *
1761
- * Acknowledge of alarms will for the remainder of this cluster be referred to as suppress.
1762
- *
1763
- * A suppressed alarm is still considered active and will remain so unless it is actively disabled or the
1764
- * triggering condition is not longer present. The action of suppressing an alarm mode is only applicable
1765
- * to and is intended to stop the physical alarming, e.g. emitting a sound or blinking a light; it does not
1766
- * impact alarm reporting in AlarmsActive.
1767
- *
1768
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.4.1
1769
- */
1770
- readonly alarmSuppress: BitFlag;
1771
- /**
1772
- * SensitivityLevel
1773
- *
1774
- * Supports ability to set sensor sensitivity
1775
- */
1776
- readonly sensitivityLevel: BitFlag;
1777
- };
1778
- readonly attributes: {
1779
- /**
1780
- * Indicates any faults registered by the device.
1781
- *
1782
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.8
1783
- */
1784
- readonly sensorFault: OptionalAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1785
- /**
1786
- * Unspecified fault detected
1787
- */
1788
- generalFault: BitFlag;
1789
- }>, any>;
1790
- };
1791
- readonly events: {
1792
- /**
1793
- * This event shall be generated when the device registers or clears a fault.
1794
- *
1795
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.2
1796
- */
1797
- readonly sensorFault: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1798
- /**
1799
- * This field shall indicate the value of the SensorFault attribute, at the time this event is generated.
1800
- *
1801
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.2.1
1802
- */
1803
- sensorFault: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1804
- /**
1805
- * Unspecified fault detected
1806
- */
1807
- generalFault: BitFlag;
1808
- }>>;
1809
- }>, any>;
1810
- };
1811
- /**
1812
- * This metadata controls which BooleanStateConfigurationCluster elements matter.js activates for specific
1813
- * feature combinations.
1814
- */
1815
- readonly extensions: readonly [{
1816
- readonly flags: {
1817
- readonly sensitivityLevel: true;
1818
- };
1819
- readonly component: {
1820
- readonly attributes: {
1821
- /**
1822
- * Indicates the currently selected sensitivity level.
1823
- *
1824
- * If a write interaction to this attribute contains an unsupported sensitivity value, a CONSTRAINT_ERROR
1825
- * status shall be returned.
1826
- *
1827
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.1
1828
- */
1829
- readonly currentSensitivityLevel: WritableAttribute<number, any>;
1830
- /**
1831
- * Indicates the number of supported sensitivity levels by the device.
1832
- *
1833
- * These supported sensitivity levels shall be ordered by sensitivity, where a value of 0 shall be
1834
- * considered the lowest sensitivity level (least sensitive) and the highest supported value shall be
1835
- * considered the highest sensitivity level.
1836
- *
1837
- * The number of supported sensitivity levels SHOULD represent unique sensitivity levels supported by the
1838
- * device.
1839
- *
1840
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.2
1841
- */
1842
- readonly supportedSensitivityLevels: FixedAttribute<number, any>;
1843
- /**
1844
- * Indicates the default sensitivity level selected by the manufacturer.
1845
- *
1846
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.3
1847
- */
1848
- readonly defaultSensitivityLevel: OptionalFixedAttribute<number, any>;
1849
- };
1850
- };
1851
- }, {
1852
- readonly flags: {
1853
- readonly visual: true;
1854
- };
1855
- readonly component: {
1856
- readonly attributes: {
1857
- /**
1858
- * Indicates which specific alarm modes on the server are currently active. When the sensor is no longer
1859
- * triggered, this attribute shall be set to the inactive state, by setting the bit to 0, for all supported
1860
- * alarm modes.
1861
- *
1862
- * If an alarm mode is not supported, the bit indicating this alarm mode shall always be 0. A bit shall
1863
- * indicate whether the alarm mode inactive or not:
1864
- *
1865
- * • 0 = Inactive
1866
- *
1867
- * • 1 = Active
1868
- *
1869
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.4
1870
- */
1871
- readonly alarmsActive: Attribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1872
- /**
1873
- * Visual alarming
1874
- */
1875
- visual: BitFlag;
1876
- /**
1877
- * Audible alarming
1878
- */
1879
- audible: BitFlag;
1880
- }>, any>;
1881
- /**
1882
- * Indicates the alarm modes that will be emitted if the sensor is triggered. If an alarm mode is not
1883
- * supported, the bit indicating this alarm mode shall always be 0.
1884
- *
1885
- * A bit shall indicate whether the alarm mode is enabled or disabled:
1886
- *
1887
- * • 0 = Disabled
1888
- *
1889
- * • 1 = Enabled
1890
- *
1891
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.6
1892
- */
1893
- readonly alarmsEnabled: OptionalAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1894
- /**
1895
- * Visual alarming
1896
- */
1897
- visual: BitFlag;
1898
- /**
1899
- * Audible alarming
1900
- */
1901
- audible: BitFlag;
1902
- }>, any>;
1903
- /**
1904
- * Indicates the alarms supported by the sensor. A bit shall indicate whether the alarm mode is supported:
1905
- *
1906
- * • 0 = Not supported
1907
- *
1908
- * • 1 = Supported
1909
- *
1910
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.7
1911
- */
1912
- readonly alarmsSupported: FixedAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1913
- /**
1914
- * Visual alarming
1915
- */
1916
- visual: BitFlag;
1917
- /**
1918
- * Audible alarming
1919
- */
1920
- audible: BitFlag;
1921
- }>, any>;
1922
- };
1923
- readonly commands: {
1924
- /**
1925
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2
1926
- */
1927
- readonly enableDisableAlarm: Command<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1928
- /**
1929
- * This field shall indicate the alarm modes to either enable or disable depending on the bit status, as
1930
- * specified for the AlarmsEnabled attribute.
1931
- *
1932
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2.1
1933
- */
1934
- alarmsToEnableDisable: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1935
- /**
1936
- * Visual alarming
1937
- */
1938
- visual: BitFlag;
1939
- /**
1940
- * Audible alarming
1941
- */
1942
- audible: BitFlag;
1943
- }>>;
1944
- }>, void, any>;
1945
- };
1946
- readonly events: {
1947
- /**
1948
- * This event shall be generated after any bits in the AlarmsActive and/or AlarmsSuppressed attributes
1949
- * change. This may occur in situations such as when internal processing by the server determines that an
1950
- * alarm mode becomes active or inactive, or when the SuppressAlarm or EnableDisableAlarm commands are
1951
- * processed in a way that some alarm modes becomes suppressed, active or inactive.
1952
- *
1953
- * If several alarm modes change state at the same time, a single event combining multiple changes may be
1954
- * emitted instead of multiple events each representing a single change.
1955
- *
1956
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1
1957
- */
1958
- readonly alarmsStateChanged: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1959
- /**
1960
- * This field shall indicate the state of active alarm modes, as indicated by the AlarmsActive attribute, at
1961
- * the time the event was generated.
1962
- *
1963
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.1
1964
- */
1965
- alarmsActive: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1966
- /**
1967
- * Visual alarming
1968
- */
1969
- visual: BitFlag;
1970
- /**
1971
- * Audible alarming
1972
- */
1973
- audible: BitFlag;
1974
- }>>;
1975
- /**
1976
- * This field shall indicate the state of suppressed alarm modes, as indicated by the AlarmsSuppressed
1977
- * attribute, at the time the event was generated.
1978
- *
1979
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.2
1980
- */
1981
- alarmsSuppressed: import("@project-chip/matter-node.js/tlv").OptionalFieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
1982
- /**
1983
- * Visual alarming
1984
- */
1985
- visual: BitFlag;
1986
- /**
1987
- * Audible alarming
1988
- */
1989
- audible: BitFlag;
1990
- }>>;
1991
- }>, any>;
1992
- };
1993
- };
1994
- }, {
1995
- readonly flags: {
1996
- readonly audible: true;
1997
- };
1998
- readonly component: {
1999
- readonly attributes: {
2000
- /**
2001
- * Indicates which specific alarm modes on the server are currently active. When the sensor is no longer
2002
- * triggered, this attribute shall be set to the inactive state, by setting the bit to 0, for all supported
2003
- * alarm modes.
2004
- *
2005
- * If an alarm mode is not supported, the bit indicating this alarm mode shall always be 0. A bit shall
2006
- * indicate whether the alarm mode inactive or not:
2007
- *
2008
- * • 0 = Inactive
2009
- *
2010
- * • 1 = Active
2011
- *
2012
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.4
2013
- */
2014
- readonly alarmsActive: Attribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
2015
- /**
2016
- * Visual alarming
2017
- */
2018
- visual: BitFlag;
2019
- /**
2020
- * Audible alarming
2021
- */
2022
- audible: BitFlag;
2023
- }>, any>;
2024
- /**
2025
- * Indicates the alarm modes that will be emitted if the sensor is triggered. If an alarm mode is not
2026
- * supported, the bit indicating this alarm mode shall always be 0.
2027
- *
2028
- * A bit shall indicate whether the alarm mode is enabled or disabled:
2029
- *
2030
- * • 0 = Disabled
2031
- *
2032
- * • 1 = Enabled
2033
- *
2034
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.6
2035
- */
2036
- readonly alarmsEnabled: OptionalAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
2037
- /**
2038
- * Visual alarming
2039
- */
2040
- visual: BitFlag;
2041
- /**
2042
- * Audible alarming
2043
- */
2044
- audible: BitFlag;
2045
- }>, any>;
2046
- /**
2047
- * Indicates the alarms supported by the sensor. A bit shall indicate whether the alarm mode is supported:
2048
- *
2049
- * • 0 = Not supported
2050
- *
2051
- * • 1 = Supported
2052
- *
2053
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.7
2054
- */
2055
- readonly alarmsSupported: FixedAttribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
2056
- /**
2057
- * Visual alarming
2058
- */
2059
- visual: BitFlag;
2060
- /**
2061
- * Audible alarming
2062
- */
2063
- audible: BitFlag;
2064
- }>, any>;
2065
- };
2066
- readonly commands: {
2067
- /**
2068
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2
2069
- */
2070
- readonly enableDisableAlarm: Command<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2071
- /**
2072
- * This field shall indicate the alarm modes to either enable or disable depending on the bit status, as
2073
- * specified for the AlarmsEnabled attribute.
2074
- *
2075
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.2.1
2076
- */
2077
- alarmsToEnableDisable: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
2078
- /**
2079
- * Visual alarming
2080
- */
2081
- visual: BitFlag;
2082
- /**
2083
- * Audible alarming
2084
- */
2085
- audible: BitFlag;
2086
- }>>;
2087
- }>, void, any>;
2088
- };
2089
- readonly events: {
2090
- /**
2091
- * This event shall be generated after any bits in the AlarmsActive and/or AlarmsSuppressed attributes
2092
- * change. This may occur in situations such as when internal processing by the server determines that an
2093
- * alarm mode becomes active or inactive, or when the SuppressAlarm or EnableDisableAlarm commands are
2094
- * processed in a way that some alarm modes becomes suppressed, active or inactive.
2095
- *
2096
- * If several alarm modes change state at the same time, a single event combining multiple changes may be
2097
- * emitted instead of multiple events each representing a single change.
2098
- *
2099
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1
2100
- */
2101
- readonly alarmsStateChanged: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2102
- /**
2103
- * This field shall indicate the state of active alarm modes, as indicated by the AlarmsActive attribute, at
2104
- * the time the event was generated.
2105
- *
2106
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.1
2107
- */
2108
- alarmsActive: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
2109
- /**
2110
- * Visual alarming
2111
- */
2112
- visual: BitFlag;
2113
- /**
2114
- * Audible alarming
2115
- */
2116
- audible: BitFlag;
2117
- }>>;
2118
- /**
2119
- * This field shall indicate the state of suppressed alarm modes, as indicated by the AlarmsSuppressed
2120
- * attribute, at the time the event was generated.
2121
- *
2122
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.8.1.2
2123
- */
2124
- alarmsSuppressed: import("@project-chip/matter-node.js/tlv").OptionalFieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
2125
- /**
2126
- * Visual alarming
2127
- */
2128
- visual: BitFlag;
2129
- /**
2130
- * Audible alarming
2131
- */
2132
- audible: BitFlag;
2133
- }>>;
2134
- }>, any>;
2135
- };
2136
- };
2137
- }, {
2138
- readonly flags: {
2139
- readonly alarmSuppress: true;
2140
- };
2141
- readonly component: {
2142
- readonly attributes: {
2143
- /**
2144
- * Indicates which specific alarm modes on the server are currently suppressed. When the sensor is no
2145
- * longer triggered, this attribute shall be set to the unsuppressed state, by setting the bit to 0, for
2146
- * all supported alarm modes.
2147
- *
2148
- * If an alarm mode is not supported, the bit indicating this alarm mode shall always be 0. A bit shall
2149
- * indicate whether the alarm mode is suppressed or not:
2150
- *
2151
- * • 0 = Not suppressed
2152
- *
2153
- * • 1 = Suppressed
2154
- *
2155
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.6.5
2156
- */
2157
- readonly alarmsSuppressed: Attribute<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
2158
- /**
2159
- * Visual alarming
2160
- */
2161
- visual: BitFlag;
2162
- /**
2163
- * Audible alarming
2164
- */
2165
- audible: BitFlag;
2166
- }>, any>;
2167
- };
2168
- readonly commands: {
2169
- /**
2170
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.1
2171
- */
2172
- readonly suppressAlarm: Command<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2173
- /**
2174
- * This field shall indicate the alarm modes to suppress.
2175
- *
2176
- * @see {@link MatterSpecification.v13.Cluster} § 1.8.7.1.1
2177
- */
2178
- alarmsToSuppress: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/schema").TypeFromPartialBitSchema<{
2179
- /**
2180
- * Visual alarming
2181
- */
2182
- visual: BitFlag;
2183
- /**
2184
- * Audible alarming
2185
- */
2186
- audible: BitFlag;
2187
- }>>;
2188
- }>, void, any>;
2189
- };
2190
- };
2191
- }, {
2192
- readonly flags: {
2193
- readonly alarmSuppress: true;
2194
- readonly visual: true;
2195
- readonly audible: true;
2196
- };
2197
- readonly component: false;
2198
- }];
2199
- }>;
2200
- //# sourceMappingURL=BooleanStateConfigurationCluster.d.ts.map