matterbridge 1.2.21 → 1.3.0

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 (101) hide show
  1. package/CHANGELOG.md +39 -0
  2. package/README.md +48 -9
  3. package/dist/cluster/AirQualityCluster.d.ts.map +1 -0
  4. package/dist/cluster/AirQualityCluster.js.map +1 -0
  5. package/dist/cluster/BooleanStateConfigurationCluster.d.ts +2200 -0
  6. package/dist/cluster/BooleanStateConfigurationCluster.d.ts.map +1 -0
  7. package/dist/cluster/BooleanStateConfigurationCluster.js +388 -0
  8. package/dist/cluster/BooleanStateConfigurationCluster.js.map +1 -0
  9. package/dist/cluster/BridgedDeviceBasicInformationCluster.d.ts.map +1 -0
  10. package/dist/cluster/BridgedDeviceBasicInformationCluster.js.map +1 -0
  11. package/dist/cluster/CarbonMonoxideConcentrationMeasurementCluster.d.ts +396 -0
  12. package/dist/cluster/CarbonMonoxideConcentrationMeasurementCluster.d.ts.map +1 -0
  13. package/dist/cluster/CarbonMonoxideConcentrationMeasurementCluster.js +30 -0
  14. package/dist/cluster/CarbonMonoxideConcentrationMeasurementCluster.js.map +1 -0
  15. package/dist/cluster/ConcentrationMeasurementCluster.d.ts +524 -0
  16. package/dist/cluster/ConcentrationMeasurementCluster.d.ts.map +1 -0
  17. package/dist/cluster/ConcentrationMeasurementCluster.js +282 -0
  18. package/dist/cluster/ConcentrationMeasurementCluster.js.map +1 -0
  19. package/dist/cluster/DeviceEnergyManagementCluster.d.ts +7851 -0
  20. package/dist/cluster/DeviceEnergyManagementCluster.d.ts.map +1 -0
  21. package/dist/cluster/DeviceEnergyManagementCluster.js +1634 -0
  22. package/dist/cluster/DeviceEnergyManagementCluster.js.map +1 -0
  23. package/dist/cluster/DeviceEnergyManagementModeCluster.d.ts +68 -0
  24. package/dist/cluster/DeviceEnergyManagementModeCluster.d.ts.map +1 -0
  25. package/dist/cluster/DeviceEnergyManagementModeCluster.js +49 -0
  26. package/dist/cluster/DeviceEnergyManagementModeCluster.js.map +1 -0
  27. package/dist/cluster/ElectricalEnergyMeasurementCluster.d.ts +4978 -0
  28. package/dist/cluster/ElectricalEnergyMeasurementCluster.d.ts.map +1 -0
  29. package/dist/cluster/ElectricalEnergyMeasurementCluster.js +510 -0
  30. package/dist/cluster/ElectricalEnergyMeasurementCluster.js.map +1 -0
  31. package/dist/cluster/ElectricalPowerMeasurementCluster.d.ts +3250 -0
  32. package/dist/cluster/ElectricalPowerMeasurementCluster.d.ts.map +1 -0
  33. package/dist/cluster/ElectricalPowerMeasurementCluster.js +675 -0
  34. package/dist/cluster/ElectricalPowerMeasurementCluster.js.map +1 -0
  35. package/dist/cluster/FanControlCluster.d.ts +1583 -0
  36. package/dist/cluster/FanControlCluster.d.ts.map +1 -0
  37. package/dist/cluster/FanControlCluster.js +492 -0
  38. package/dist/cluster/FanControlCluster.js.map +1 -0
  39. package/dist/cluster/MeasurementAccuracy.d.ts +63 -0
  40. package/dist/cluster/MeasurementAccuracy.d.ts.map +1 -0
  41. package/dist/cluster/MeasurementAccuracy.js +47 -0
  42. package/dist/cluster/MeasurementAccuracy.js.map +1 -0
  43. package/dist/cluster/MeasurementAccuracyRange.d.ts +134 -0
  44. package/dist/cluster/MeasurementAccuracyRange.d.ts.map +1 -0
  45. package/dist/cluster/MeasurementAccuracyRange.js +103 -0
  46. package/dist/cluster/MeasurementAccuracyRange.js.map +1 -0
  47. package/dist/cluster/MeasurementType.d.ts +68 -0
  48. package/dist/cluster/MeasurementType.d.ts.map +1 -0
  49. package/dist/cluster/MeasurementType.js +69 -0
  50. package/dist/cluster/MeasurementType.js.map +1 -0
  51. package/dist/cluster/PowerTopologyCluster.d.ts +355 -0
  52. package/dist/cluster/PowerTopologyCluster.d.ts.map +1 -0
  53. package/dist/cluster/PowerTopologyCluster.js +138 -0
  54. package/dist/cluster/PowerTopologyCluster.js.map +1 -0
  55. package/dist/cluster/SmokeCoAlarmCluster.d.ts +1599 -0
  56. package/dist/cluster/SmokeCoAlarmCluster.d.ts.map +1 -0
  57. package/dist/cluster/SmokeCoAlarmCluster.js +603 -0
  58. package/dist/cluster/SmokeCoAlarmCluster.js.map +1 -0
  59. package/dist/cluster/TvocCluster.d.ts.map +1 -0
  60. package/dist/cluster/TvocCluster.js.map +1 -0
  61. package/dist/defaultConfigSchema.d.ts.map +1 -1
  62. package/dist/defaultConfigSchema.js +26 -12
  63. package/dist/defaultConfigSchema.js.map +1 -1
  64. package/dist/index.d.ts +7 -2
  65. package/dist/index.d.ts.map +1 -1
  66. package/dist/index.js +8 -2
  67. package/dist/index.js.map +1 -1
  68. package/dist/matterbridge.d.ts +63 -1
  69. package/dist/matterbridge.d.ts.map +1 -1
  70. package/dist/matterbridge.js +72 -26
  71. package/dist/matterbridge.js.map +1 -1
  72. package/dist/matterbridgeDevice.d.ts +692 -30
  73. package/dist/matterbridgeDevice.d.ts.map +1 -1
  74. package/dist/matterbridgeDevice.js +429 -73
  75. package/dist/matterbridgeDevice.js.map +1 -1
  76. package/dist/matterbridgeDeviceV8.d.ts +3 -5
  77. package/dist/matterbridgeDeviceV8.d.ts.map +1 -1
  78. package/dist/matterbridgeDeviceV8.js +62 -14
  79. package/dist/matterbridgeDeviceV8.js.map +1 -1
  80. package/dist/matterbridgeV8.d.ts +69 -5
  81. package/dist/matterbridgeV8.d.ts.map +1 -1
  82. package/dist/matterbridgeV8.js +413 -99
  83. package/dist/matterbridgeV8.js.map +1 -1
  84. package/frontend/build/asset-manifest.json +3 -3
  85. package/frontend/build/index.html +1 -1
  86. package/frontend/build/static/js/{main.23829a0f.js → main.cbfc6c9b.js} +3 -3
  87. package/frontend/build/static/js/{main.23829a0f.js.map → main.cbfc6c9b.js.map} +1 -1
  88. package/package.json +6 -6
  89. package/dist/AirQualityCluster.d.ts.map +0 -1
  90. package/dist/AirQualityCluster.js.map +0 -1
  91. package/dist/BridgedDeviceBasicInformationCluster.d.ts.map +0 -1
  92. package/dist/BridgedDeviceBasicInformationCluster.js.map +0 -1
  93. package/dist/TvocCluster.d.ts.map +0 -1
  94. package/dist/TvocCluster.js.map +0 -1
  95. /package/dist/{AirQualityCluster.d.ts → cluster/AirQualityCluster.d.ts} +0 -0
  96. /package/dist/{AirQualityCluster.js → cluster/AirQualityCluster.js} +0 -0
  97. /package/dist/{BridgedDeviceBasicInformationCluster.d.ts → cluster/BridgedDeviceBasicInformationCluster.d.ts} +0 -0
  98. /package/dist/{BridgedDeviceBasicInformationCluster.js → cluster/BridgedDeviceBasicInformationCluster.js} +0 -0
  99. /package/dist/{TvocCluster.d.ts → cluster/TvocCluster.d.ts} +0 -0
  100. /package/dist/{TvocCluster.js → cluster/TvocCluster.js} +0 -0
  101. /package/frontend/build/static/js/{main.23829a0f.js.LICENSE.txt → main.cbfc6c9b.js.LICENSE.txt} +0 -0
@@ -0,0 +1,1599 @@
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 { MutableCluster, OptionalAttribute, OptionalCommand, OptionalEvent, OptionalFixedAttribute, OptionalWritableAttribute } from '@project-chip/matter-node.js/cluster';
8
+ import { Attribute, Event } 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 SmokeCoAlarm {
13
+ /**
14
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.1
15
+ */
16
+ enum AlarmState {
17
+ /**
18
+ * Nominal state, the device is not alarming
19
+ *
20
+ * This value shall indicate that this alarm is not alarming.
21
+ *
22
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.1.1
23
+ */
24
+ Normal = 0,
25
+ /**
26
+ * Warning state
27
+ *
28
+ * This value shall indicate that this alarm is in a warning state. Alarms in this state SHOULD be subject to
29
+ * being muted via physical interaction.
30
+ *
31
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.1.2
32
+ */
33
+ Warning = 1,
34
+ /**
35
+ * Critical state
36
+ *
37
+ * This value shall indicate that this alarm is in a critical state. Alarms in this state shall NOT be subject
38
+ * to being muted via physical interaction.
39
+ *
40
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.1.3
41
+ */
42
+ Critical = 2
43
+ }
44
+ /**
45
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.6
46
+ */
47
+ enum ContaminationState {
48
+ /**
49
+ * Nominal state, the sensor is not contaminated
50
+ *
51
+ * This value shall indicate that the smoke sensor has nominal contamination levels, no customer action is
52
+ * required.
53
+ *
54
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.6.1
55
+ */
56
+ Normal = 0,
57
+ /**
58
+ * Low contamination
59
+ *
60
+ * This value shall indicate that the smoke sensor has detectable contamination levels, but the contamination
61
+ * is too low to cause a visible or audible alarm.
62
+ *
63
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.6.2
64
+ */
65
+ Low = 1,
66
+ /**
67
+ * Warning state
68
+ *
69
+ * This value shall indicate that the smoke sensor has contamination levels in a warning state. At this level,
70
+ * the contamination may cause a visible or audible alarm. User intervention is suggested.
71
+ *
72
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.6.3
73
+ */
74
+ Warning = 2,
75
+ /**
76
+ * Critical state, will cause nuisance alarms
77
+ *
78
+ * This value shall indicate that the smoke sensor has contamination levels in a critical state. At this level,
79
+ * the contamination should cause a visible or audible alarm. User intervention is required. Critical
80
+ * contamination of the sensor shall also be reflected as a HardwareFault.
81
+ *
82
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.6.4
83
+ */
84
+ Critical = 3
85
+ }
86
+ /**
87
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.2
88
+ */
89
+ enum Sensitivity {
90
+ /**
91
+ * High sensitivity
92
+ */
93
+ High = 0,
94
+ /**
95
+ * Standard Sensitivity
96
+ */
97
+ Standard = 1,
98
+ /**
99
+ * Low sensitivity
100
+ */
101
+ Low = 2
102
+ }
103
+ /**
104
+ * Body of the SmokeCoAlarm smokeAlarm event
105
+ *
106
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.1
107
+ */
108
+ const TlvSmokeAlarmEvent: import("@project-chip/matter-node.js/tlv").ObjectSchema<{
109
+ /**
110
+ * This field shall indicate the current value of the SmokeState attribute.
111
+ *
112
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.1.1
113
+ */
114
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
115
+ }>;
116
+ /**
117
+ * Body of the SmokeCoAlarm smokeAlarm event
118
+ *
119
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.1
120
+ */
121
+ type SmokeAlarmEvent = TypeFromSchema<typeof TlvSmokeAlarmEvent>;
122
+ /**
123
+ * Body of the SmokeCoAlarm interconnectSmokeAlarm event
124
+ *
125
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.9
126
+ */
127
+ const TlvInterconnectSmokeAlarmEvent: import("@project-chip/matter-node.js/tlv").ObjectSchema<{
128
+ /**
129
+ * This field shall indicate the current value of the InterconnectSmokeAlarm attribute.
130
+ *
131
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.9.1
132
+ */
133
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
134
+ }>;
135
+ /**
136
+ * Body of the SmokeCoAlarm interconnectSmokeAlarm event
137
+ *
138
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.9
139
+ */
140
+ type InterconnectSmokeAlarmEvent = TypeFromSchema<typeof TlvInterconnectSmokeAlarmEvent>;
141
+ /**
142
+ * Body of the SmokeCoAlarm coAlarm event
143
+ *
144
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.2
145
+ */
146
+ const TlvCoAlarmEvent: import("@project-chip/matter-node.js/tlv").ObjectSchema<{
147
+ /**
148
+ * This field shall indicate the current value of the COState attribute.
149
+ *
150
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.2.1
151
+ */
152
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
153
+ }>;
154
+ /**
155
+ * Body of the SmokeCoAlarm coAlarm event
156
+ *
157
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.2
158
+ */
159
+ type CoAlarmEvent = TypeFromSchema<typeof TlvCoAlarmEvent>;
160
+ /**
161
+ * Body of the SmokeCoAlarm interconnectCoAlarm event
162
+ *
163
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.10
164
+ */
165
+ const TlvInterconnectCoAlarmEvent: import("@project-chip/matter-node.js/tlv").ObjectSchema<{
166
+ /**
167
+ * This field shall indicate the current value of the InterconnectCOAlarm attribute.
168
+ *
169
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.10.1
170
+ */
171
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
172
+ }>;
173
+ /**
174
+ * Body of the SmokeCoAlarm interconnectCoAlarm event
175
+ *
176
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.10
177
+ */
178
+ type InterconnectCoAlarmEvent = TypeFromSchema<typeof TlvInterconnectCoAlarmEvent>;
179
+ /**
180
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.3
181
+ */
182
+ enum ExpressedState {
183
+ /**
184
+ * Nominal state, the device is not alarming
185
+ *
186
+ * This value shall indicate that this alarm is not alarming.
187
+ *
188
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.3.1
189
+ */
190
+ Normal = 0,
191
+ /**
192
+ * Smoke Alarm state
193
+ *
194
+ * This value shall indicate that this alarm is currently expressing visual indication of Smoke Alarm. This
195
+ * value shall indicate that the alarm is currently expressing audible indication of Smoke Alarm unless the
196
+ * DeviceMuted attribute is supported and set to Muted.
197
+ *
198
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.3.2
199
+ */
200
+ SmokeAlarm = 1,
201
+ /**
202
+ * CO Alarm state
203
+ *
204
+ * This value shall indicate that this alarm is currently expressing visual indication of CO Alarm. This value
205
+ * shall indicate that the alarm is currently expressing audible indication of CO Alarm unless the DeviceMuted
206
+ * attribute is supported and set to Muted.
207
+ *
208
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.3.3
209
+ */
210
+ CoAlarm = 2,
211
+ /**
212
+ * Battery Alert State
213
+ *
214
+ * This value shall indicate that this alarm is currently expressing visual indication of Critical Low Battery.
215
+ * This value shall indicate that the alarm is currently expressing audible indication of Critical Low Battery
216
+ * unless the DeviceMuted attribute is supported and set to Muted.
217
+ *
218
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.3.4
219
+ */
220
+ BatteryAlert = 3,
221
+ /**
222
+ * Test in Progress
223
+ *
224
+ * This value shall indicate that this alarm is currently expressing visual and audible indication of SelfTest.
225
+ *
226
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.3.5
227
+ */
228
+ Testing = 4,
229
+ /**
230
+ * Hardware Fault Alert State
231
+ *
232
+ * This value shall indicate that this alarm is currently expressing visual indication of Hardware Fault. This
233
+ * value shall indicate that the alarm is currently expressing audible indication of Hardware Fault unless the
234
+ * DeviceMuted attribute is supported and set to Muted.
235
+ *
236
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.3.6
237
+ */
238
+ HardwareFault = 5,
239
+ /**
240
+ * End of Service Alert State
241
+ *
242
+ * This value shall indicate that this alarm is currently expressing visual indication of End Of Service. This
243
+ * value shall indicate that the alarm is currently expressing audible indication of End of Service unless the
244
+ * DeviceMuted attribute is supported and set to Muted.
245
+ *
246
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.3.7
247
+ */
248
+ EndOfService = 6,
249
+ /**
250
+ * Interconnected Smoke Alarm State
251
+ *
252
+ * This value shall indicate that this alarm is currently expressing visual indication of Smoke Alarm caused by
253
+ * Interconnect. This value shall indicate that the alarm is currently expressing audible indication of Smoke
254
+ * Alarm caused by Interconnect unless the DeviceMuted attribute is supported and set to Muted.
255
+ *
256
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.3.8
257
+ */
258
+ InterconnectSmoke = 7,
259
+ /**
260
+ * Interconnected CO Alarm State
261
+ *
262
+ * This value shall indicate that this alarm is currently expressing visual indication of CO Alarm caused by
263
+ * Interconnect. This value shall indicate that the alarm is currently expressing audible indication of CO
264
+ * Alarm caused by Interconnect unless the DeviceMuted attribute is supported and set to Muted.
265
+ *
266
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.3.9
267
+ */
268
+ InterconnectCo = 8
269
+ }
270
+ /**
271
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.4
272
+ */
273
+ enum MuteState {
274
+ /**
275
+ * Not Muted
276
+ *
277
+ * This value shall indicate that the device is not muted.
278
+ *
279
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.4.1
280
+ */
281
+ NotMuted = 0,
282
+ /**
283
+ * Muted
284
+ *
285
+ * This value shall indicate that the device is muted.
286
+ *
287
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.4.2
288
+ */
289
+ Muted = 1
290
+ }
291
+ /**
292
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.5
293
+ */
294
+ enum EndOfService {
295
+ /**
296
+ * Device has not expired
297
+ *
298
+ * This value shall indicate that the device has not yet reached its end of service, and does not need to be
299
+ * imminently replaced.
300
+ *
301
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.5.2
302
+ */
303
+ Normal = 0,
304
+ /**
305
+ * Device has reached its end of service
306
+ *
307
+ * This value shall indicate that the device has reached its end of service, and needs to be replaced.
308
+ *
309
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.5.5.1
310
+ */
311
+ Expired = 1
312
+ }
313
+ /**
314
+ * Body of the SmokeCoAlarm lowBattery event
315
+ *
316
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.3
317
+ */
318
+ const TlvLowBatteryEvent: import("@project-chip/matter-node.js/tlv").ObjectSchema<{
319
+ /**
320
+ * This field shall indicate the current value of the BatteryAlert attribute.
321
+ *
322
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.3.1
323
+ */
324
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
325
+ }>;
326
+ /**
327
+ * Body of the SmokeCoAlarm lowBattery event
328
+ *
329
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.3
330
+ */
331
+ type LowBatteryEvent = TypeFromSchema<typeof TlvLowBatteryEvent>;
332
+ /**
333
+ * A SmokeCoAlarmCluster supports these elements if it supports feature SmokeAlarm.
334
+ */
335
+ const SmokeAlarmComponent: {
336
+ readonly attributes: {
337
+ /**
338
+ * Indicates whether the device’s smoke sensor is currently triggering a smoke alarm.
339
+ *
340
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.2
341
+ */
342
+ readonly smokeState: Attribute<AlarmState, any>;
343
+ /**
344
+ * Indicates the contamination level of the smoke sensor.
345
+ *
346
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.11
347
+ */
348
+ readonly contaminationState: OptionalAttribute<ContaminationState, any>;
349
+ /**
350
+ * Indicates the sensitivity level of the smoke sensor configured on the device.
351
+ *
352
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.12
353
+ */
354
+ readonly smokeSensitivityLevel: OptionalWritableAttribute<Sensitivity, any>;
355
+ };
356
+ readonly events: {
357
+ /**
358
+ * This event shall be generated when SmokeState attribute changes to either Warning or Critical state.
359
+ *
360
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.1
361
+ */
362
+ readonly smokeAlarm: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
363
+ /**
364
+ * This field shall indicate the current value of the SmokeState attribute.
365
+ *
366
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.1.1
367
+ */
368
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
369
+ }>, any>;
370
+ /**
371
+ * This event shall be generated when the device hosting the server receives a smoke alarm from an
372
+ * interconnected sensor.
373
+ *
374
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.9
375
+ */
376
+ readonly interconnectSmokeAlarm: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
377
+ /**
378
+ * This field shall indicate the current value of the InterconnectSmokeAlarm attribute.
379
+ *
380
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.9.1
381
+ */
382
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
383
+ }>, any>;
384
+ };
385
+ };
386
+ /**
387
+ * A SmokeCoAlarmCluster supports these elements if it supports feature CoAlarm.
388
+ */
389
+ const CoAlarmComponent: {
390
+ readonly attributes: {
391
+ /**
392
+ * Indicates whether the device’s CO sensor is currently triggering a CO alarm.
393
+ *
394
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.3
395
+ */
396
+ readonly coState: Attribute<AlarmState, any>;
397
+ };
398
+ readonly events: {
399
+ /**
400
+ * This event shall be generated when COState attribute changes to either Warning or Critical state.
401
+ *
402
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.2
403
+ */
404
+ readonly coAlarm: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
405
+ /**
406
+ * This field shall indicate the current value of the COState attribute.
407
+ *
408
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.2.1
409
+ */
410
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
411
+ }>, any>;
412
+ /**
413
+ * This event shall be generated when the device hosting the server receives a CO alarm from an
414
+ * interconnected sensor.
415
+ *
416
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.10
417
+ */
418
+ readonly interconnectCoAlarm: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
419
+ /**
420
+ * This field shall indicate the current value of the InterconnectCOAlarm attribute.
421
+ *
422
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.10.1
423
+ */
424
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
425
+ }>, any>;
426
+ };
427
+ };
428
+ /**
429
+ * These are optional features supported by SmokeCoAlarmCluster.
430
+ *
431
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.4
432
+ */
433
+ enum Feature {
434
+ /**
435
+ * SmokeAlarm (SMOKE)
436
+ *
437
+ * Supports Smoke alarm
438
+ */
439
+ SmokeAlarm = "SmokeAlarm",
440
+ /**
441
+ * CoAlarm (CO)
442
+ *
443
+ * Supports CO alarm
444
+ */
445
+ CoAlarm = "CoAlarm"
446
+ }
447
+ /**
448
+ * These elements and properties are present in all SmokeCoAlarm clusters.
449
+ */
450
+ const Base: {
451
+ readonly id: 92;
452
+ readonly name: "SmokeCoAlarm";
453
+ readonly revision: 1;
454
+ readonly features: {
455
+ /**
456
+ * SmokeAlarm
457
+ *
458
+ * Supports Smoke alarm
459
+ */
460
+ readonly smokeAlarm: BitFlag;
461
+ /**
462
+ * CoAlarm
463
+ *
464
+ * Supports CO alarm
465
+ */
466
+ readonly coAlarm: BitFlag;
467
+ };
468
+ readonly attributes: {
469
+ /**
470
+ * Indicates the visibly- and audibly-expressed state of the alarm. When multiple alarm conditions are
471
+ * being reflected in the server, this attribute shall indicate the condition with the highest priority.
472
+ * Priority order of conditions is determined by the manufacturer and shall be supplied as a part of
473
+ * certification procedure. If the value of ExpressedState is not Normal, the attribute corresponding to
474
+ * the value shall NOT be Normal. For example, if the ExpressedState is set to SmokeAlarm, the value of the
475
+ * SmokeState will indicate the severity of the alarm (Warning or Critical). Clients SHOULD also read the
476
+ * other attributes to be aware of further alarm conditions beyond the one indicated in ExpressedState.
477
+ *
478
+ * Visible expression is typically a LED light pattern. Audible expression is a horn or speaker pattern.
479
+ * Audible expression shall BE suppressed if the DeviceMuted attribute is supported and set to Muted.
480
+ *
481
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.1
482
+ */
483
+ readonly expressedState: Attribute<ExpressedState, any>;
484
+ /**
485
+ * Indicates whether the power resource fault detection mechanism is currently triggered at the device. If
486
+ * the detection mechanism is triggered, this attribute shall be set to Warning or Critical, otherwise it
487
+ * shall be set to Normal. The battery state shall also be reflected in the Power Source cluster
488
+ * representing the device’s battery using the appropriate supported attributes and events.
489
+ *
490
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.4
491
+ */
492
+ readonly batteryAlert: Attribute<AlarmState, any>;
493
+ /**
494
+ * Indicates the whether the audible expression of the device is currently muted. Audible expression is
495
+ * typically a horn or speaker pattern.
496
+ *
497
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.5
498
+ */
499
+ readonly deviceMuted: OptionalAttribute<MuteState, any>;
500
+ /**
501
+ * Indicates whether the device self-test is currently activated. If the device self- test is activated,
502
+ * this attribute shall be set to True, otherwise it shall be set to False.
503
+ *
504
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.6
505
+ */
506
+ readonly testInProgress: Attribute<boolean, any>;
507
+ /**
508
+ * Indicates whether the hardware fault detection mechanism is currently triggered. If the detection
509
+ * mechanism is triggered, this attribute shall be set to True, otherwise it shall be set to False.
510
+ *
511
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.7
512
+ */
513
+ readonly hardwareFaultAlert: Attribute<boolean, any>;
514
+ /**
515
+ * Indicates whether the end-of-service has been triggered at the device. This attribute shall be set to
516
+ * Expired when the device reaches the end-of-service.
517
+ *
518
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.8
519
+ */
520
+ readonly endOfServiceAlert: Attribute<EndOfService, any>;
521
+ /**
522
+ * Indicates whether the interconnected smoke alarm is currently triggering by branching devices. When the
523
+ * interconnected smoke alarm is being triggered, this attribute shall be set to Warning or Critical,
524
+ * otherwise it shall be set to Normal.
525
+ *
526
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.9
527
+ */
528
+ readonly interconnectSmokeAlarm: OptionalAttribute<AlarmState, any>;
529
+ /**
530
+ * Indicates whether the interconnected CO alarm is currently triggering by branching devices. When the
531
+ * interconnected CO alarm is being triggered, this attribute shall be set to Warning or Critical,
532
+ * otherwise it shall be set to Normal.
533
+ *
534
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.10
535
+ */
536
+ readonly interconnectCoAlarm: OptionalAttribute<AlarmState, any>;
537
+ /**
538
+ * Indicates the date when the device reaches its stated expiry date. After the ExpiryDate has been
539
+ * reached, the EndOfServiceAlert shall start to be triggered. To account for better customer experience
540
+ * across time zones, the EndOfServiceAlert may be delayed by up to 24 hours after the ExpiryDate.
541
+ * Similarly, clients may delay any actions based on the ExpiryDate by up to 24 hours to best align with
542
+ * the local time zone.
543
+ *
544
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.13
545
+ */
546
+ readonly expiryDate: OptionalFixedAttribute<number, any>;
547
+ };
548
+ readonly commands: {
549
+ /**
550
+ * This command shall initiate a device self-test. The return status shall indicate whether the test was
551
+ * successfully initiated. Only one SelfTestRequest may be processed at a time. When the value of the
552
+ * ExpressedState attribute is any of SmokeAlarm, COAlarm, Testing, InterconnectSmoke, Inter
553
+ *
554
+ * connectCO, the device shall NOT execute the self-test, and shall return status code BUSY.
555
+ *
556
+ * Upon successful acceptance of SelfTestRequest, the TestInProgress attribute shall be set to True and
557
+ * ExpressedState attribute shall be set to Testing. Any faults identified during the test shall be
558
+ * reflected in the appropriate attributes and events. Upon completion of the self test procedure, the
559
+ * SelfTestComplete event shall be generated, the TestInProgress attribute shall be set to False and
560
+ * ExpressedState attribute shall be updated to reflect the current state of the server.
561
+ *
562
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.7.1
563
+ */
564
+ readonly selfTestRequest: OptionalCommand<void, void, any>;
565
+ };
566
+ readonly events: {
567
+ /**
568
+ * This event shall be generated when BatteryAlert attribute changes to either Warning or Critical state.
569
+ *
570
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.3
571
+ */
572
+ readonly lowBattery: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
573
+ /**
574
+ * This field shall indicate the current value of the BatteryAlert attribute.
575
+ *
576
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.3.1
577
+ */
578
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
579
+ }>, any>;
580
+ /**
581
+ * This event shall be generated when the device detects a hardware fault that leads to setting
582
+ * HardwareFaultAlert to True.
583
+ *
584
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.4
585
+ */
586
+ readonly hardwareFault: Event<void, any>;
587
+ /**
588
+ * This event shall be generated when the EndOfServiceAlert is set to Expired.
589
+ *
590
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.5
591
+ */
592
+ readonly endOfService: Event<void, any>;
593
+ /**
594
+ * This event shall be generated when the SelfTest completes, and the attribute TestInProgress changes to
595
+ * False.
596
+ *
597
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.6
598
+ */
599
+ readonly selfTestComplete: Event<void, any>;
600
+ /**
601
+ * This event shall be generated when the DeviceMuted attribute changes to Muted.
602
+ *
603
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.7
604
+ */
605
+ readonly alarmMuted: OptionalEvent<void, any>;
606
+ /**
607
+ * This event shall be generated when DeviceMuted attribute changes to NotMuted.
608
+ *
609
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.8
610
+ */
611
+ readonly muteEnded: OptionalEvent<void, any>;
612
+ /**
613
+ * This event shall be generated when ExpressedState attribute returns to Normal state.
614
+ *
615
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.11
616
+ */
617
+ readonly allClear: Event<void, any>;
618
+ };
619
+ /**
620
+ * This metadata controls which SmokeCoAlarmCluster elements matter.js activates for specific feature
621
+ * combinations.
622
+ */
623
+ readonly extensions: readonly [{
624
+ readonly flags: {
625
+ readonly smokeAlarm: true;
626
+ };
627
+ readonly component: {
628
+ readonly attributes: {
629
+ /**
630
+ * Indicates whether the device’s smoke sensor is currently triggering a smoke alarm.
631
+ *
632
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.2
633
+ */
634
+ readonly smokeState: Attribute<AlarmState, any>;
635
+ /**
636
+ * Indicates the contamination level of the smoke sensor.
637
+ *
638
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.11
639
+ */
640
+ readonly contaminationState: OptionalAttribute<ContaminationState, any>;
641
+ /**
642
+ * Indicates the sensitivity level of the smoke sensor configured on the device.
643
+ *
644
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.12
645
+ */
646
+ readonly smokeSensitivityLevel: OptionalWritableAttribute<Sensitivity, any>;
647
+ };
648
+ readonly events: {
649
+ /**
650
+ * This event shall be generated when SmokeState attribute changes to either Warning or Critical state.
651
+ *
652
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.1
653
+ */
654
+ readonly smokeAlarm: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
655
+ /**
656
+ * This field shall indicate the current value of the SmokeState attribute.
657
+ *
658
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.1.1
659
+ */
660
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
661
+ }>, any>;
662
+ /**
663
+ * This event shall be generated when the device hosting the server receives a smoke alarm from an
664
+ * interconnected sensor.
665
+ *
666
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.9
667
+ */
668
+ readonly interconnectSmokeAlarm: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
669
+ /**
670
+ * This field shall indicate the current value of the InterconnectSmokeAlarm attribute.
671
+ *
672
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.9.1
673
+ */
674
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
675
+ }>, any>;
676
+ };
677
+ };
678
+ }, {
679
+ readonly flags: {
680
+ readonly coAlarm: true;
681
+ };
682
+ readonly component: {
683
+ readonly attributes: {
684
+ /**
685
+ * Indicates whether the device’s CO sensor is currently triggering a CO alarm.
686
+ *
687
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.3
688
+ */
689
+ readonly coState: Attribute<AlarmState, any>;
690
+ };
691
+ readonly events: {
692
+ /**
693
+ * This event shall be generated when COState attribute changes to either Warning or Critical state.
694
+ *
695
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.2
696
+ */
697
+ readonly coAlarm: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
698
+ /**
699
+ * This field shall indicate the current value of the COState attribute.
700
+ *
701
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.2.1
702
+ */
703
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
704
+ }>, any>;
705
+ /**
706
+ * This event shall be generated when the device hosting the server receives a CO alarm from an
707
+ * interconnected sensor.
708
+ *
709
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.10
710
+ */
711
+ readonly interconnectCoAlarm: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
712
+ /**
713
+ * This field shall indicate the current value of the InterconnectCOAlarm attribute.
714
+ *
715
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.10.1
716
+ */
717
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
718
+ }>, any>;
719
+ };
720
+ };
721
+ }, {
722
+ readonly flags: {
723
+ readonly smokeAlarm: false;
724
+ readonly coAlarm: false;
725
+ };
726
+ readonly component: false;
727
+ }];
728
+ };
729
+ /**
730
+ * @see {@link Cluster}
731
+ */
732
+ const ClusterInstance: MutableCluster.ExtensibleOnly<{
733
+ readonly id: 92;
734
+ readonly name: "SmokeCoAlarm";
735
+ readonly revision: 1;
736
+ readonly features: {
737
+ /**
738
+ * SmokeAlarm
739
+ *
740
+ * Supports Smoke alarm
741
+ */
742
+ readonly smokeAlarm: BitFlag;
743
+ /**
744
+ * CoAlarm
745
+ *
746
+ * Supports CO alarm
747
+ */
748
+ readonly coAlarm: BitFlag;
749
+ };
750
+ readonly attributes: {
751
+ /**
752
+ * Indicates the visibly- and audibly-expressed state of the alarm. When multiple alarm conditions are
753
+ * being reflected in the server, this attribute shall indicate the condition with the highest priority.
754
+ * Priority order of conditions is determined by the manufacturer and shall be supplied as a part of
755
+ * certification procedure. If the value of ExpressedState is not Normal, the attribute corresponding to
756
+ * the value shall NOT be Normal. For example, if the ExpressedState is set to SmokeAlarm, the value of the
757
+ * SmokeState will indicate the severity of the alarm (Warning or Critical). Clients SHOULD also read the
758
+ * other attributes to be aware of further alarm conditions beyond the one indicated in ExpressedState.
759
+ *
760
+ * Visible expression is typically a LED light pattern. Audible expression is a horn or speaker pattern.
761
+ * Audible expression shall BE suppressed if the DeviceMuted attribute is supported and set to Muted.
762
+ *
763
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.1
764
+ */
765
+ readonly expressedState: Attribute<ExpressedState, any>;
766
+ /**
767
+ * Indicates whether the power resource fault detection mechanism is currently triggered at the device. If
768
+ * the detection mechanism is triggered, this attribute shall be set to Warning or Critical, otherwise it
769
+ * shall be set to Normal. The battery state shall also be reflected in the Power Source cluster
770
+ * representing the device’s battery using the appropriate supported attributes and events.
771
+ *
772
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.4
773
+ */
774
+ readonly batteryAlert: Attribute<AlarmState, any>;
775
+ /**
776
+ * Indicates the whether the audible expression of the device is currently muted. Audible expression is
777
+ * typically a horn or speaker pattern.
778
+ *
779
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.5
780
+ */
781
+ readonly deviceMuted: OptionalAttribute<MuteState, any>;
782
+ /**
783
+ * Indicates whether the device self-test is currently activated. If the device self- test is activated,
784
+ * this attribute shall be set to True, otherwise it shall be set to False.
785
+ *
786
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.6
787
+ */
788
+ readonly testInProgress: Attribute<boolean, any>;
789
+ /**
790
+ * Indicates whether the hardware fault detection mechanism is currently triggered. If the detection
791
+ * mechanism is triggered, this attribute shall be set to True, otherwise it shall be set to False.
792
+ *
793
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.7
794
+ */
795
+ readonly hardwareFaultAlert: Attribute<boolean, any>;
796
+ /**
797
+ * Indicates whether the end-of-service has been triggered at the device. This attribute shall be set to
798
+ * Expired when the device reaches the end-of-service.
799
+ *
800
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.8
801
+ */
802
+ readonly endOfServiceAlert: Attribute<EndOfService, any>;
803
+ /**
804
+ * Indicates whether the interconnected smoke alarm is currently triggering by branching devices. When the
805
+ * interconnected smoke alarm is being triggered, this attribute shall be set to Warning or Critical,
806
+ * otherwise it shall be set to Normal.
807
+ *
808
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.9
809
+ */
810
+ readonly interconnectSmokeAlarm: OptionalAttribute<AlarmState, any>;
811
+ /**
812
+ * Indicates whether the interconnected CO alarm is currently triggering by branching devices. When the
813
+ * interconnected CO alarm is being triggered, this attribute shall be set to Warning or Critical,
814
+ * otherwise it shall be set to Normal.
815
+ *
816
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.10
817
+ */
818
+ readonly interconnectCoAlarm: OptionalAttribute<AlarmState, any>;
819
+ /**
820
+ * Indicates the date when the device reaches its stated expiry date. After the ExpiryDate has been
821
+ * reached, the EndOfServiceAlert shall start to be triggered. To account for better customer experience
822
+ * across time zones, the EndOfServiceAlert may be delayed by up to 24 hours after the ExpiryDate.
823
+ * Similarly, clients may delay any actions based on the ExpiryDate by up to 24 hours to best align with
824
+ * the local time zone.
825
+ *
826
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.13
827
+ */
828
+ readonly expiryDate: OptionalFixedAttribute<number, any>;
829
+ };
830
+ readonly commands: {
831
+ /**
832
+ * This command shall initiate a device self-test. The return status shall indicate whether the test was
833
+ * successfully initiated. Only one SelfTestRequest may be processed at a time. When the value of the
834
+ * ExpressedState attribute is any of SmokeAlarm, COAlarm, Testing, InterconnectSmoke, Inter
835
+ *
836
+ * connectCO, the device shall NOT execute the self-test, and shall return status code BUSY.
837
+ *
838
+ * Upon successful acceptance of SelfTestRequest, the TestInProgress attribute shall be set to True and
839
+ * ExpressedState attribute shall be set to Testing. Any faults identified during the test shall be
840
+ * reflected in the appropriate attributes and events. Upon completion of the self test procedure, the
841
+ * SelfTestComplete event shall be generated, the TestInProgress attribute shall be set to False and
842
+ * ExpressedState attribute shall be updated to reflect the current state of the server.
843
+ *
844
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.7.1
845
+ */
846
+ readonly selfTestRequest: OptionalCommand<void, void, any>;
847
+ };
848
+ readonly events: {
849
+ /**
850
+ * This event shall be generated when BatteryAlert attribute changes to either Warning or Critical state.
851
+ *
852
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.3
853
+ */
854
+ readonly lowBattery: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
855
+ /**
856
+ * This field shall indicate the current value of the BatteryAlert attribute.
857
+ *
858
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.3.1
859
+ */
860
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
861
+ }>, any>;
862
+ /**
863
+ * This event shall be generated when the device detects a hardware fault that leads to setting
864
+ * HardwareFaultAlert to True.
865
+ *
866
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.4
867
+ */
868
+ readonly hardwareFault: Event<void, any>;
869
+ /**
870
+ * This event shall be generated when the EndOfServiceAlert is set to Expired.
871
+ *
872
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.5
873
+ */
874
+ readonly endOfService: Event<void, any>;
875
+ /**
876
+ * This event shall be generated when the SelfTest completes, and the attribute TestInProgress changes to
877
+ * False.
878
+ *
879
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.6
880
+ */
881
+ readonly selfTestComplete: Event<void, any>;
882
+ /**
883
+ * This event shall be generated when the DeviceMuted attribute changes to Muted.
884
+ *
885
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.7
886
+ */
887
+ readonly alarmMuted: OptionalEvent<void, any>;
888
+ /**
889
+ * This event shall be generated when DeviceMuted attribute changes to NotMuted.
890
+ *
891
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.8
892
+ */
893
+ readonly muteEnded: OptionalEvent<void, any>;
894
+ /**
895
+ * This event shall be generated when ExpressedState attribute returns to Normal state.
896
+ *
897
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.11
898
+ */
899
+ readonly allClear: Event<void, any>;
900
+ };
901
+ /**
902
+ * This metadata controls which SmokeCoAlarmCluster elements matter.js activates for specific feature
903
+ * combinations.
904
+ */
905
+ readonly extensions: readonly [{
906
+ readonly flags: {
907
+ readonly smokeAlarm: true;
908
+ };
909
+ readonly component: {
910
+ readonly attributes: {
911
+ /**
912
+ * Indicates whether the device’s smoke sensor is currently triggering a smoke alarm.
913
+ *
914
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.2
915
+ */
916
+ readonly smokeState: Attribute<AlarmState, any>;
917
+ /**
918
+ * Indicates the contamination level of the smoke sensor.
919
+ *
920
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.11
921
+ */
922
+ readonly contaminationState: OptionalAttribute<ContaminationState, any>;
923
+ /**
924
+ * Indicates the sensitivity level of the smoke sensor configured on the device.
925
+ *
926
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.12
927
+ */
928
+ readonly smokeSensitivityLevel: OptionalWritableAttribute<Sensitivity, any>;
929
+ };
930
+ readonly events: {
931
+ /**
932
+ * This event shall be generated when SmokeState attribute changes to either Warning or Critical state.
933
+ *
934
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.1
935
+ */
936
+ readonly smokeAlarm: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
937
+ /**
938
+ * This field shall indicate the current value of the SmokeState attribute.
939
+ *
940
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.1.1
941
+ */
942
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
943
+ }>, any>;
944
+ /**
945
+ * This event shall be generated when the device hosting the server receives a smoke alarm from an
946
+ * interconnected sensor.
947
+ *
948
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.9
949
+ */
950
+ readonly interconnectSmokeAlarm: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
951
+ /**
952
+ * This field shall indicate the current value of the InterconnectSmokeAlarm attribute.
953
+ *
954
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.9.1
955
+ */
956
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
957
+ }>, any>;
958
+ };
959
+ };
960
+ }, {
961
+ readonly flags: {
962
+ readonly coAlarm: true;
963
+ };
964
+ readonly component: {
965
+ readonly attributes: {
966
+ /**
967
+ * Indicates whether the device’s CO sensor is currently triggering a CO alarm.
968
+ *
969
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.3
970
+ */
971
+ readonly coState: Attribute<AlarmState, any>;
972
+ };
973
+ readonly events: {
974
+ /**
975
+ * This event shall be generated when COState attribute changes to either Warning or Critical state.
976
+ *
977
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.2
978
+ */
979
+ readonly coAlarm: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
980
+ /**
981
+ * This field shall indicate the current value of the COState attribute.
982
+ *
983
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.2.1
984
+ */
985
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
986
+ }>, any>;
987
+ /**
988
+ * This event shall be generated when the device hosting the server receives a CO alarm from an
989
+ * interconnected sensor.
990
+ *
991
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.10
992
+ */
993
+ readonly interconnectCoAlarm: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
994
+ /**
995
+ * This field shall indicate the current value of the InterconnectCOAlarm attribute.
996
+ *
997
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.10.1
998
+ */
999
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
1000
+ }>, any>;
1001
+ };
1002
+ };
1003
+ }, {
1004
+ readonly flags: {
1005
+ readonly smokeAlarm: false;
1006
+ readonly coAlarm: false;
1007
+ };
1008
+ readonly component: false;
1009
+ }];
1010
+ }>;
1011
+ /**
1012
+ * This cluster provides an interface for observing and managing the state of smoke and CO alarms.
1013
+ *
1014
+ * Per the Matter specification you cannot use {@link SmokeCoAlarmCluster} without enabling certain feature
1015
+ * combinations. You must use the {@link with} factory method to obtain a working cluster.
1016
+ *
1017
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11
1018
+ */
1019
+ type Cluster = Identity<typeof ClusterInstance>;
1020
+ const Cluster: Cluster;
1021
+ /**
1022
+ * @see {@link Complete}
1023
+ */
1024
+ const CompleteInstance: MutableCluster<{
1025
+ readonly id: 92;
1026
+ readonly name: "SmokeCoAlarm";
1027
+ readonly revision: 1;
1028
+ readonly features: {
1029
+ /**
1030
+ * SmokeAlarm
1031
+ *
1032
+ * Supports Smoke alarm
1033
+ */
1034
+ readonly smokeAlarm: BitFlag;
1035
+ /**
1036
+ * CoAlarm
1037
+ *
1038
+ * Supports CO alarm
1039
+ */
1040
+ readonly coAlarm: BitFlag;
1041
+ };
1042
+ readonly attributes: {
1043
+ readonly smokeState: Attribute<AlarmState, any> & {
1044
+ readonly optional: true;
1045
+ readonly isConditional: true;
1046
+ readonly optionalIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1047
+ /**
1048
+ * Standard Sensitivity
1049
+ */
1050
+ readonly mandatoryIf: [] | [{
1051
+ smokeAlarm: boolean;
1052
+ }];
1053
+ };
1054
+ readonly coState: Attribute<AlarmState, any> & {
1055
+ readonly optional: true;
1056
+ readonly isConditional: true;
1057
+ readonly optionalIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1058
+ /**
1059
+ * Standard Sensitivity
1060
+ */
1061
+ readonly mandatoryIf: [] | [{
1062
+ coAlarm: boolean;
1063
+ }];
1064
+ };
1065
+ readonly contaminationState: OptionalAttribute<ContaminationState, any> & {
1066
+ readonly optional: true;
1067
+ readonly isConditional: true;
1068
+ readonly optionalIf: [] | [{
1069
+ smokeAlarm: boolean;
1070
+ }];
1071
+ /**
1072
+ * Standard Sensitivity
1073
+ */
1074
+ readonly mandatoryIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1075
+ };
1076
+ readonly smokeSensitivityLevel: OptionalWritableAttribute<Sensitivity, any> & {
1077
+ readonly optional: true;
1078
+ readonly isConditional: true;
1079
+ readonly optionalIf: [] | [{
1080
+ smokeAlarm: boolean;
1081
+ }];
1082
+ /**
1083
+ * Standard Sensitivity
1084
+ */
1085
+ readonly mandatoryIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1086
+ };
1087
+ /**
1088
+ * Indicates the visibly- and audibly-expressed state of the alarm. When multiple alarm conditions are
1089
+ * being reflected in the server, this attribute shall indicate the condition with the highest priority.
1090
+ * Priority order of conditions is determined by the manufacturer and shall be supplied as a part of
1091
+ * certification procedure. If the value of ExpressedState is not Normal, the attribute corresponding to
1092
+ * the value shall NOT be Normal. For example, if the ExpressedState is set to SmokeAlarm, the value of the
1093
+ * SmokeState will indicate the severity of the alarm (Warning or Critical). Clients SHOULD also read the
1094
+ * other attributes to be aware of further alarm conditions beyond the one indicated in ExpressedState.
1095
+ *
1096
+ * Visible expression is typically a LED light pattern. Audible expression is a horn or speaker pattern.
1097
+ * Audible expression shall BE suppressed if the DeviceMuted attribute is supported and set to Muted.
1098
+ *
1099
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.1
1100
+ */
1101
+ readonly expressedState: Attribute<ExpressedState, any>;
1102
+ /**
1103
+ * Indicates whether the power resource fault detection mechanism is currently triggered at the device. If
1104
+ * the detection mechanism is triggered, this attribute shall be set to Warning or Critical, otherwise it
1105
+ * shall be set to Normal. The battery state shall also be reflected in the Power Source cluster
1106
+ * representing the device’s battery using the appropriate supported attributes and events.
1107
+ *
1108
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.4
1109
+ */
1110
+ readonly batteryAlert: Attribute<AlarmState, any>;
1111
+ /**
1112
+ * Indicates the whether the audible expression of the device is currently muted. Audible expression is
1113
+ * typically a horn or speaker pattern.
1114
+ *
1115
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.5
1116
+ */
1117
+ readonly deviceMuted: OptionalAttribute<MuteState, any>;
1118
+ /**
1119
+ * Indicates whether the device self-test is currently activated. If the device self- test is activated,
1120
+ * this attribute shall be set to True, otherwise it shall be set to False.
1121
+ *
1122
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.6
1123
+ */
1124
+ readonly testInProgress: Attribute<boolean, any>;
1125
+ /**
1126
+ * Indicates whether the hardware fault detection mechanism is currently triggered. If the detection
1127
+ * mechanism is triggered, this attribute shall be set to True, otherwise it shall be set to False.
1128
+ *
1129
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.7
1130
+ */
1131
+ readonly hardwareFaultAlert: Attribute<boolean, any>;
1132
+ /**
1133
+ * Indicates whether the end-of-service has been triggered at the device. This attribute shall be set to
1134
+ * Expired when the device reaches the end-of-service.
1135
+ *
1136
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.8
1137
+ */
1138
+ readonly endOfServiceAlert: Attribute<EndOfService, any>;
1139
+ /**
1140
+ * Indicates whether the interconnected smoke alarm is currently triggering by branching devices. When the
1141
+ * interconnected smoke alarm is being triggered, this attribute shall be set to Warning or Critical,
1142
+ * otherwise it shall be set to Normal.
1143
+ *
1144
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.9
1145
+ */
1146
+ readonly interconnectSmokeAlarm: OptionalAttribute<AlarmState, any>;
1147
+ /**
1148
+ * Indicates whether the interconnected CO alarm is currently triggering by branching devices. When the
1149
+ * interconnected CO alarm is being triggered, this attribute shall be set to Warning or Critical,
1150
+ * otherwise it shall be set to Normal.
1151
+ *
1152
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.10
1153
+ */
1154
+ readonly interconnectCoAlarm: OptionalAttribute<AlarmState, any>;
1155
+ /**
1156
+ * Indicates the date when the device reaches its stated expiry date. After the ExpiryDate has been
1157
+ * reached, the EndOfServiceAlert shall start to be triggered. To account for better customer experience
1158
+ * across time zones, the EndOfServiceAlert may be delayed by up to 24 hours after the ExpiryDate.
1159
+ * Similarly, clients may delay any actions based on the ExpiryDate by up to 24 hours to best align with
1160
+ * the local time zone.
1161
+ *
1162
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.13
1163
+ */
1164
+ readonly expiryDate: OptionalFixedAttribute<number, any>;
1165
+ };
1166
+ readonly commands: {
1167
+ /**
1168
+ * This command shall initiate a device self-test. The return status shall indicate whether the test was
1169
+ * successfully initiated. Only one SelfTestRequest may be processed at a time. When the value of the
1170
+ * ExpressedState attribute is any of SmokeAlarm, COAlarm, Testing, InterconnectSmoke, Inter
1171
+ *
1172
+ * connectCO, the device shall NOT execute the self-test, and shall return status code BUSY.
1173
+ *
1174
+ * Upon successful acceptance of SelfTestRequest, the TestInProgress attribute shall be set to True and
1175
+ * ExpressedState attribute shall be set to Testing. Any faults identified during the test shall be
1176
+ * reflected in the appropriate attributes and events. Upon completion of the self test procedure, the
1177
+ * SelfTestComplete event shall be generated, the TestInProgress attribute shall be set to False and
1178
+ * ExpressedState attribute shall be updated to reflect the current state of the server.
1179
+ *
1180
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.7.1
1181
+ */
1182
+ readonly selfTestRequest: OptionalCommand<void, void, any>;
1183
+ };
1184
+ readonly events: {
1185
+ readonly smokeAlarm: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1186
+ /**
1187
+ * This field shall indicate the current value of the SmokeState attribute.
1188
+ *
1189
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.1.1
1190
+ */
1191
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
1192
+ }>, any> & {
1193
+ readonly optional: true;
1194
+ readonly isConditional: true;
1195
+ readonly optionalIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1196
+ /**
1197
+ * Standard Sensitivity
1198
+ */
1199
+ readonly mandatoryIf: [] | [{
1200
+ smokeAlarm: boolean;
1201
+ }];
1202
+ };
1203
+ readonly coAlarm: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1204
+ /**
1205
+ * This field shall indicate the current value of the COState attribute.
1206
+ *
1207
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.2.1
1208
+ */
1209
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
1210
+ }>, any> & {
1211
+ readonly optional: true;
1212
+ readonly isConditional: true;
1213
+ readonly optionalIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1214
+ /**
1215
+ * Standard Sensitivity
1216
+ */
1217
+ readonly mandatoryIf: [] | [{
1218
+ coAlarm: boolean;
1219
+ }];
1220
+ };
1221
+ readonly interconnectSmokeAlarm: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1222
+ /**
1223
+ * This field shall indicate the current value of the InterconnectSmokeAlarm attribute.
1224
+ *
1225
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.9.1
1226
+ */
1227
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
1228
+ }>, any> & {
1229
+ readonly optional: true;
1230
+ readonly isConditional: true;
1231
+ readonly optionalIf: [] | [{
1232
+ smokeAlarm: boolean;
1233
+ }];
1234
+ /**
1235
+ * Standard Sensitivity
1236
+ */
1237
+ readonly mandatoryIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1238
+ };
1239
+ readonly interconnectCoAlarm: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1240
+ /**
1241
+ * This field shall indicate the current value of the InterconnectCOAlarm attribute.
1242
+ *
1243
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.10.1
1244
+ */
1245
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
1246
+ }>, any> & {
1247
+ readonly optional: true;
1248
+ readonly isConditional: true;
1249
+ readonly optionalIf: [] | [{
1250
+ coAlarm: boolean;
1251
+ }];
1252
+ /**
1253
+ * Standard Sensitivity
1254
+ */
1255
+ readonly mandatoryIf: import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema> | [];
1256
+ };
1257
+ /**
1258
+ * This event shall be generated when BatteryAlert attribute changes to either Warning or Critical state.
1259
+ *
1260
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.3
1261
+ */
1262
+ readonly lowBattery: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1263
+ /**
1264
+ * This field shall indicate the current value of the BatteryAlert attribute.
1265
+ *
1266
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.3.1
1267
+ */
1268
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<AlarmState>;
1269
+ }>, any>;
1270
+ /**
1271
+ * This event shall be generated when the device detects a hardware fault that leads to setting
1272
+ * HardwareFaultAlert to True.
1273
+ *
1274
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.4
1275
+ */
1276
+ readonly hardwareFault: Event<void, any>;
1277
+ /**
1278
+ * This event shall be generated when the EndOfServiceAlert is set to Expired.
1279
+ *
1280
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.5
1281
+ */
1282
+ readonly endOfService: Event<void, any>;
1283
+ /**
1284
+ * This event shall be generated when the SelfTest completes, and the attribute TestInProgress changes to
1285
+ * False.
1286
+ *
1287
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.6
1288
+ */
1289
+ readonly selfTestComplete: Event<void, any>;
1290
+ /**
1291
+ * This event shall be generated when the DeviceMuted attribute changes to Muted.
1292
+ *
1293
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.7
1294
+ */
1295
+ readonly alarmMuted: OptionalEvent<void, any>;
1296
+ /**
1297
+ * This event shall be generated when DeviceMuted attribute changes to NotMuted.
1298
+ *
1299
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.8
1300
+ */
1301
+ readonly muteEnded: OptionalEvent<void, any>;
1302
+ /**
1303
+ * This event shall be generated when ExpressedState attribute returns to Normal state.
1304
+ *
1305
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.11
1306
+ */
1307
+ readonly allClear: Event<void, any>;
1308
+ };
1309
+ }>;
1310
+ /**
1311
+ * This cluster supports all SmokeCoAlarm features. It may support illegal feature combinations.
1312
+ *
1313
+ * If you use this cluster you must manually specify which features are active and ensure the set of active
1314
+ * features is legal per the Matter specification.
1315
+ */
1316
+ type Complete = Identity<typeof CompleteInstance>;
1317
+ const Complete: Complete;
1318
+ }
1319
+ export type SmokeCoAlarmCluster = SmokeCoAlarm.Cluster;
1320
+ export declare const SmokeCoAlarmCluster: MutableCluster.ExtensibleOnly<{
1321
+ readonly id: 92;
1322
+ readonly name: "SmokeCoAlarm";
1323
+ readonly revision: 1;
1324
+ readonly features: {
1325
+ /**
1326
+ * SmokeAlarm
1327
+ *
1328
+ * Supports Smoke alarm
1329
+ */
1330
+ readonly smokeAlarm: BitFlag;
1331
+ /**
1332
+ * CoAlarm
1333
+ *
1334
+ * Supports CO alarm
1335
+ */
1336
+ readonly coAlarm: BitFlag;
1337
+ };
1338
+ readonly attributes: {
1339
+ /**
1340
+ * Indicates the visibly- and audibly-expressed state of the alarm. When multiple alarm conditions are
1341
+ * being reflected in the server, this attribute shall indicate the condition with the highest priority.
1342
+ * Priority order of conditions is determined by the manufacturer and shall be supplied as a part of
1343
+ * certification procedure. If the value of ExpressedState is not Normal, the attribute corresponding to
1344
+ * the value shall NOT be Normal. For example, if the ExpressedState is set to SmokeAlarm, the value of the
1345
+ * SmokeState will indicate the severity of the alarm (Warning or Critical). Clients SHOULD also read the
1346
+ * other attributes to be aware of further alarm conditions beyond the one indicated in ExpressedState.
1347
+ *
1348
+ * Visible expression is typically a LED light pattern. Audible expression is a horn or speaker pattern.
1349
+ * Audible expression shall BE suppressed if the DeviceMuted attribute is supported and set to Muted.
1350
+ *
1351
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.1
1352
+ */
1353
+ readonly expressedState: Attribute<SmokeCoAlarm.ExpressedState, any>;
1354
+ /**
1355
+ * Indicates whether the power resource fault detection mechanism is currently triggered at the device. If
1356
+ * the detection mechanism is triggered, this attribute shall be set to Warning or Critical, otherwise it
1357
+ * shall be set to Normal. The battery state shall also be reflected in the Power Source cluster
1358
+ * representing the device’s battery using the appropriate supported attributes and events.
1359
+ *
1360
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.4
1361
+ */
1362
+ readonly batteryAlert: Attribute<SmokeCoAlarm.AlarmState, any>;
1363
+ /**
1364
+ * Indicates the whether the audible expression of the device is currently muted. Audible expression is
1365
+ * typically a horn or speaker pattern.
1366
+ *
1367
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.5
1368
+ */
1369
+ readonly deviceMuted: OptionalAttribute<SmokeCoAlarm.MuteState, any>;
1370
+ /**
1371
+ * Indicates whether the device self-test is currently activated. If the device self- test is activated,
1372
+ * this attribute shall be set to True, otherwise it shall be set to False.
1373
+ *
1374
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.6
1375
+ */
1376
+ readonly testInProgress: Attribute<boolean, any>;
1377
+ /**
1378
+ * Indicates whether the hardware fault detection mechanism is currently triggered. If the detection
1379
+ * mechanism is triggered, this attribute shall be set to True, otherwise it shall be set to False.
1380
+ *
1381
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.7
1382
+ */
1383
+ readonly hardwareFaultAlert: Attribute<boolean, any>;
1384
+ /**
1385
+ * Indicates whether the end-of-service has been triggered at the device. This attribute shall be set to
1386
+ * Expired when the device reaches the end-of-service.
1387
+ *
1388
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.8
1389
+ */
1390
+ readonly endOfServiceAlert: Attribute<SmokeCoAlarm.EndOfService, any>;
1391
+ /**
1392
+ * Indicates whether the interconnected smoke alarm is currently triggering by branching devices. When the
1393
+ * interconnected smoke alarm is being triggered, this attribute shall be set to Warning or Critical,
1394
+ * otherwise it shall be set to Normal.
1395
+ *
1396
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.9
1397
+ */
1398
+ readonly interconnectSmokeAlarm: OptionalAttribute<SmokeCoAlarm.AlarmState, any>;
1399
+ /**
1400
+ * Indicates whether the interconnected CO alarm is currently triggering by branching devices. When the
1401
+ * interconnected CO alarm is being triggered, this attribute shall be set to Warning or Critical,
1402
+ * otherwise it shall be set to Normal.
1403
+ *
1404
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.10
1405
+ */
1406
+ readonly interconnectCoAlarm: OptionalAttribute<SmokeCoAlarm.AlarmState, any>;
1407
+ /**
1408
+ * Indicates the date when the device reaches its stated expiry date. After the ExpiryDate has been
1409
+ * reached, the EndOfServiceAlert shall start to be triggered. To account for better customer experience
1410
+ * across time zones, the EndOfServiceAlert may be delayed by up to 24 hours after the ExpiryDate.
1411
+ * Similarly, clients may delay any actions based on the ExpiryDate by up to 24 hours to best align with
1412
+ * the local time zone.
1413
+ *
1414
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.13
1415
+ */
1416
+ readonly expiryDate: OptionalFixedAttribute<number, any>;
1417
+ };
1418
+ readonly commands: {
1419
+ /**
1420
+ * This command shall initiate a device self-test. The return status shall indicate whether the test was
1421
+ * successfully initiated. Only one SelfTestRequest may be processed at a time. When the value of the
1422
+ * ExpressedState attribute is any of SmokeAlarm, COAlarm, Testing, InterconnectSmoke, Inter
1423
+ *
1424
+ * connectCO, the device shall NOT execute the self-test, and shall return status code BUSY.
1425
+ *
1426
+ * Upon successful acceptance of SelfTestRequest, the TestInProgress attribute shall be set to True and
1427
+ * ExpressedState attribute shall be set to Testing. Any faults identified during the test shall be
1428
+ * reflected in the appropriate attributes and events. Upon completion of the self test procedure, the
1429
+ * SelfTestComplete event shall be generated, the TestInProgress attribute shall be set to False and
1430
+ * ExpressedState attribute shall be updated to reflect the current state of the server.
1431
+ *
1432
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.7.1
1433
+ */
1434
+ readonly selfTestRequest: OptionalCommand<void, void, any>;
1435
+ };
1436
+ readonly events: {
1437
+ /**
1438
+ * This event shall be generated when BatteryAlert attribute changes to either Warning or Critical state.
1439
+ *
1440
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.3
1441
+ */
1442
+ readonly lowBattery: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1443
+ /**
1444
+ * This field shall indicate the current value of the BatteryAlert attribute.
1445
+ *
1446
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.3.1
1447
+ */
1448
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<SmokeCoAlarm.AlarmState>;
1449
+ }>, any>;
1450
+ /**
1451
+ * This event shall be generated when the device detects a hardware fault that leads to setting
1452
+ * HardwareFaultAlert to True.
1453
+ *
1454
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.4
1455
+ */
1456
+ readonly hardwareFault: Event<void, any>;
1457
+ /**
1458
+ * This event shall be generated when the EndOfServiceAlert is set to Expired.
1459
+ *
1460
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.5
1461
+ */
1462
+ readonly endOfService: Event<void, any>;
1463
+ /**
1464
+ * This event shall be generated when the SelfTest completes, and the attribute TestInProgress changes to
1465
+ * False.
1466
+ *
1467
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.6
1468
+ */
1469
+ readonly selfTestComplete: Event<void, any>;
1470
+ /**
1471
+ * This event shall be generated when the DeviceMuted attribute changes to Muted.
1472
+ *
1473
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.7
1474
+ */
1475
+ readonly alarmMuted: OptionalEvent<void, any>;
1476
+ /**
1477
+ * This event shall be generated when DeviceMuted attribute changes to NotMuted.
1478
+ *
1479
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.8
1480
+ */
1481
+ readonly muteEnded: OptionalEvent<void, any>;
1482
+ /**
1483
+ * This event shall be generated when ExpressedState attribute returns to Normal state.
1484
+ *
1485
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.11
1486
+ */
1487
+ readonly allClear: Event<void, any>;
1488
+ };
1489
+ /**
1490
+ * This metadata controls which SmokeCoAlarmCluster elements matter.js activates for specific feature
1491
+ * combinations.
1492
+ */
1493
+ readonly extensions: readonly [{
1494
+ readonly flags: {
1495
+ readonly smokeAlarm: true;
1496
+ };
1497
+ readonly component: {
1498
+ readonly attributes: {
1499
+ /**
1500
+ * Indicates whether the device’s smoke sensor is currently triggering a smoke alarm.
1501
+ *
1502
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.2
1503
+ */
1504
+ readonly smokeState: Attribute<SmokeCoAlarm.AlarmState, any>;
1505
+ /**
1506
+ * Indicates the contamination level of the smoke sensor.
1507
+ *
1508
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.11
1509
+ */
1510
+ readonly contaminationState: OptionalAttribute<SmokeCoAlarm.ContaminationState, any>;
1511
+ /**
1512
+ * Indicates the sensitivity level of the smoke sensor configured on the device.
1513
+ *
1514
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.12
1515
+ */
1516
+ readonly smokeSensitivityLevel: OptionalWritableAttribute<SmokeCoAlarm.Sensitivity, any>;
1517
+ };
1518
+ readonly events: {
1519
+ /**
1520
+ * This event shall be generated when SmokeState attribute changes to either Warning or Critical state.
1521
+ *
1522
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.1
1523
+ */
1524
+ readonly smokeAlarm: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1525
+ /**
1526
+ * This field shall indicate the current value of the SmokeState attribute.
1527
+ *
1528
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.1.1
1529
+ */
1530
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<SmokeCoAlarm.AlarmState>;
1531
+ }>, any>;
1532
+ /**
1533
+ * This event shall be generated when the device hosting the server receives a smoke alarm from an
1534
+ * interconnected sensor.
1535
+ *
1536
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.9
1537
+ */
1538
+ readonly interconnectSmokeAlarm: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1539
+ /**
1540
+ * This field shall indicate the current value of the InterconnectSmokeAlarm attribute.
1541
+ *
1542
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.9.1
1543
+ */
1544
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<SmokeCoAlarm.AlarmState>;
1545
+ }>, any>;
1546
+ };
1547
+ };
1548
+ }, {
1549
+ readonly flags: {
1550
+ readonly coAlarm: true;
1551
+ };
1552
+ readonly component: {
1553
+ readonly attributes: {
1554
+ /**
1555
+ * Indicates whether the device’s CO sensor is currently triggering a CO alarm.
1556
+ *
1557
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.6.3
1558
+ */
1559
+ readonly coState: Attribute<SmokeCoAlarm.AlarmState, any>;
1560
+ };
1561
+ readonly events: {
1562
+ /**
1563
+ * This event shall be generated when COState attribute changes to either Warning or Critical state.
1564
+ *
1565
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.2
1566
+ */
1567
+ readonly coAlarm: Event<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1568
+ /**
1569
+ * This field shall indicate the current value of the COState attribute.
1570
+ *
1571
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.2.1
1572
+ */
1573
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<SmokeCoAlarm.AlarmState>;
1574
+ }>, any>;
1575
+ /**
1576
+ * This event shall be generated when the device hosting the server receives a CO alarm from an
1577
+ * interconnected sensor.
1578
+ *
1579
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.10
1580
+ */
1581
+ readonly interconnectCoAlarm: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1582
+ /**
1583
+ * This field shall indicate the current value of the InterconnectCOAlarm attribute.
1584
+ *
1585
+ * @see {@link MatterSpecification.v13.Cluster} § 2.11.8.10.1
1586
+ */
1587
+ alarmSeverityLevel: import("@project-chip/matter-node.js/tlv").FieldType<SmokeCoAlarm.AlarmState>;
1588
+ }>, any>;
1589
+ };
1590
+ };
1591
+ }, {
1592
+ readonly flags: {
1593
+ readonly smokeAlarm: false;
1594
+ readonly coAlarm: false;
1595
+ };
1596
+ readonly component: false;
1597
+ }];
1598
+ }>;
1599
+ //# sourceMappingURL=SmokeCoAlarmCluster.d.ts.map