matterbridge 1.5.3 → 1.5.5

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 (115) hide show
  1. package/CHANGELOG.md +29 -0
  2. package/README-DEV.md +13 -4
  3. package/README.md +32 -11
  4. package/dist/cluster/export.d.ts +1 -21
  5. package/dist/cluster/export.d.ts.map +1 -1
  6. package/dist/cluster/export.js +2 -21
  7. package/dist/cluster/export.js.map +1 -1
  8. package/dist/matterbridge.js +20 -20
  9. package/dist/matterbridge.js.map +1 -1
  10. package/dist/matterbridgeDevice.d.ts +105 -210
  11. package/dist/matterbridgeDevice.d.ts.map +1 -1
  12. package/dist/matterbridgeDevice.js +31 -48
  13. package/dist/matterbridgeDevice.js.map +1 -1
  14. package/dist/matterbridgePlatform.d.ts +6 -0
  15. package/dist/matterbridgePlatform.d.ts.map +1 -1
  16. package/dist/matterbridgePlatform.js +26 -0
  17. package/dist/matterbridgePlatform.js.map +1 -1
  18. package/dist/pluginManager.d.ts.map +1 -1
  19. package/dist/pluginManager.js +72 -5
  20. package/dist/pluginManager.js.map +1 -1
  21. package/frontend/build/asset-manifest.json +3 -3
  22. package/frontend/build/index.html +1 -1
  23. package/frontend/build/static/js/{main.6725e5ab.js → main.f86befcf.js} +3 -3
  24. package/frontend/build/static/js/{main.6725e5ab.js.map → main.f86befcf.js.map} +1 -1
  25. package/npm-shrinkwrap.json +7334 -0
  26. package/package.json +13 -12
  27. package/dist/cluster/AirQualityCluster.d.ts +0 -188
  28. package/dist/cluster/AirQualityCluster.d.ts.map +0 -1
  29. package/dist/cluster/AirQualityCluster.js +0 -98
  30. package/dist/cluster/AirQualityCluster.js.map +0 -1
  31. package/dist/cluster/CarbonDioxideConcentrationMeasurementCluster.d.ts +0 -396
  32. package/dist/cluster/CarbonDioxideConcentrationMeasurementCluster.d.ts.map +0 -1
  33. package/dist/cluster/CarbonDioxideConcentrationMeasurementCluster.js +0 -30
  34. package/dist/cluster/CarbonDioxideConcentrationMeasurementCluster.js.map +0 -1
  35. package/dist/cluster/CarbonMonoxideConcentrationMeasurementCluster.d.ts +0 -396
  36. package/dist/cluster/CarbonMonoxideConcentrationMeasurementCluster.d.ts.map +0 -1
  37. package/dist/cluster/CarbonMonoxideConcentrationMeasurementCluster.js +0 -30
  38. package/dist/cluster/CarbonMonoxideConcentrationMeasurementCluster.js.map +0 -1
  39. package/dist/cluster/ConcentrationMeasurementCluster.d.ts +0 -524
  40. package/dist/cluster/ConcentrationMeasurementCluster.d.ts.map +0 -1
  41. package/dist/cluster/ConcentrationMeasurementCluster.js +0 -282
  42. package/dist/cluster/ConcentrationMeasurementCluster.js.map +0 -1
  43. package/dist/cluster/DeviceEnergyManagementCluster.d.ts +0 -7851
  44. package/dist/cluster/DeviceEnergyManagementCluster.d.ts.map +0 -1
  45. package/dist/cluster/DeviceEnergyManagementCluster.js +0 -1634
  46. package/dist/cluster/DeviceEnergyManagementCluster.js.map +0 -1
  47. package/dist/cluster/DeviceEnergyManagementModeCluster.d.ts +0 -68
  48. package/dist/cluster/DeviceEnergyManagementModeCluster.d.ts.map +0 -1
  49. package/dist/cluster/DeviceEnergyManagementModeCluster.js +0 -49
  50. package/dist/cluster/DeviceEnergyManagementModeCluster.js.map +0 -1
  51. package/dist/cluster/ElectricalEnergyMeasurementCluster.d.ts +0 -4978
  52. package/dist/cluster/ElectricalEnergyMeasurementCluster.d.ts.map +0 -1
  53. package/dist/cluster/ElectricalEnergyMeasurementCluster.js +0 -510
  54. package/dist/cluster/ElectricalEnergyMeasurementCluster.js.map +0 -1
  55. package/dist/cluster/ElectricalPowerMeasurementCluster.d.ts +0 -3250
  56. package/dist/cluster/ElectricalPowerMeasurementCluster.d.ts.map +0 -1
  57. package/dist/cluster/ElectricalPowerMeasurementCluster.js +0 -675
  58. package/dist/cluster/ElectricalPowerMeasurementCluster.js.map +0 -1
  59. package/dist/cluster/FormaldehydeConcentrationMeasurementCluster.d.ts +0 -396
  60. package/dist/cluster/FormaldehydeConcentrationMeasurementCluster.d.ts.map +0 -1
  61. package/dist/cluster/FormaldehydeConcentrationMeasurementCluster.js +0 -30
  62. package/dist/cluster/FormaldehydeConcentrationMeasurementCluster.js.map +0 -1
  63. package/dist/cluster/MeasurementAccuracy.d.ts +0 -63
  64. package/dist/cluster/MeasurementAccuracy.d.ts.map +0 -1
  65. package/dist/cluster/MeasurementAccuracy.js +0 -47
  66. package/dist/cluster/MeasurementAccuracy.js.map +0 -1
  67. package/dist/cluster/MeasurementAccuracyRange.d.ts +0 -134
  68. package/dist/cluster/MeasurementAccuracyRange.d.ts.map +0 -1
  69. package/dist/cluster/MeasurementAccuracyRange.js +0 -103
  70. package/dist/cluster/MeasurementAccuracyRange.js.map +0 -1
  71. package/dist/cluster/MeasurementType.d.ts +0 -68
  72. package/dist/cluster/MeasurementType.d.ts.map +0 -1
  73. package/dist/cluster/MeasurementType.js +0 -69
  74. package/dist/cluster/MeasurementType.js.map +0 -1
  75. package/dist/cluster/NitrogenDioxideConcentrationMeasurementCluster.d.ts +0 -396
  76. package/dist/cluster/NitrogenDioxideConcentrationMeasurementCluster.d.ts.map +0 -1
  77. package/dist/cluster/NitrogenDioxideConcentrationMeasurementCluster.js +0 -34
  78. package/dist/cluster/NitrogenDioxideConcentrationMeasurementCluster.js.map +0 -1
  79. package/dist/cluster/OzoneConcentrationMeasurementCluster.d.ts +0 -395
  80. package/dist/cluster/OzoneConcentrationMeasurementCluster.d.ts.map +0 -1
  81. package/dist/cluster/OzoneConcentrationMeasurementCluster.js +0 -29
  82. package/dist/cluster/OzoneConcentrationMeasurementCluster.js.map +0 -1
  83. package/dist/cluster/Pm10ConcentrationMeasurementCluster.d.ts +0 -395
  84. package/dist/cluster/Pm10ConcentrationMeasurementCluster.d.ts.map +0 -1
  85. package/dist/cluster/Pm10ConcentrationMeasurementCluster.js +0 -29
  86. package/dist/cluster/Pm10ConcentrationMeasurementCluster.js.map +0 -1
  87. package/dist/cluster/Pm1ConcentrationMeasurementCluster.d.ts +0 -395
  88. package/dist/cluster/Pm1ConcentrationMeasurementCluster.d.ts.map +0 -1
  89. package/dist/cluster/Pm1ConcentrationMeasurementCluster.js +0 -29
  90. package/dist/cluster/Pm1ConcentrationMeasurementCluster.js.map +0 -1
  91. package/dist/cluster/Pm25ConcentrationMeasurementCluster.d.ts +0 -395
  92. package/dist/cluster/Pm25ConcentrationMeasurementCluster.d.ts.map +0 -1
  93. package/dist/cluster/Pm25ConcentrationMeasurementCluster.js +0 -29
  94. package/dist/cluster/Pm25ConcentrationMeasurementCluster.js.map +0 -1
  95. package/dist/cluster/PowerTopologyCluster.d.ts +0 -345
  96. package/dist/cluster/PowerTopologyCluster.d.ts.map +0 -1
  97. package/dist/cluster/PowerTopologyCluster.js +0 -138
  98. package/dist/cluster/PowerTopologyCluster.js.map +0 -1
  99. package/dist/cluster/RadonConcentrationMeasurementCluster.d.ts +0 -395
  100. package/dist/cluster/RadonConcentrationMeasurementCluster.d.ts.map +0 -1
  101. package/dist/cluster/RadonConcentrationMeasurementCluster.js +0 -29
  102. package/dist/cluster/RadonConcentrationMeasurementCluster.js.map +0 -1
  103. package/dist/cluster/ScenesCluster.d.ts +0 -1249
  104. package/dist/cluster/ScenesCluster.d.ts.map +0 -1
  105. package/dist/cluster/ScenesCluster.js +0 -436
  106. package/dist/cluster/ScenesCluster.js.map +0 -1
  107. package/dist/cluster/SmokeCoAlarmCluster.d.ts +0 -1575
  108. package/dist/cluster/SmokeCoAlarmCluster.d.ts.map +0 -1
  109. package/dist/cluster/SmokeCoAlarmCluster.js +0 -603
  110. package/dist/cluster/SmokeCoAlarmCluster.js.map +0 -1
  111. package/dist/cluster/TvocCluster.d.ts +0 -465
  112. package/dist/cluster/TvocCluster.d.ts.map +0 -1
  113. package/dist/cluster/TvocCluster.js +0 -197
  114. package/dist/cluster/TvocCluster.js.map +0 -1
  115. /package/frontend/build/static/js/{main.6725e5ab.js.LICENSE.txt → main.f86befcf.js.LICENSE.txt} +0 -0
@@ -1,3250 +0,0 @@
1
- /**
2
- * @license
3
- * Copyright 2022-2024 Matter.js Authors
4
- * SPDX-License-Identifier: Apache-2.0
5
- */
6
- import { MutableCluster, OptionalAttribute, OptionalEvent } from '@project-chip/matter-node.js/cluster';
7
- import { FixedAttribute, Attribute } from '@project-chip/matter-node.js/cluster';
8
- import { BitFlag } from '@project-chip/matter-node.js/schema';
9
- import { TypeFromSchema } from '@project-chip/matter-node.js/tlv';
10
- import { Identity } from '@project-chip/matter-node.js/util';
11
- import { MeasurementType } from './MeasurementType.js';
12
- export declare namespace ElectricalPowerMeasurement {
13
- /**
14
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3
15
- */
16
- const TlvHarmonicMeasurement: import("@project-chip/matter-node.js/tlv").ObjectSchema<{
17
- /**
18
- * This field shall be the order of the harmonic being measured. Typically this is an odd number, but servers
19
- * may choose to report even harmonics.
20
- *
21
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.1
22
- */
23
- order: import("@project-chip/matter-node.js/tlv").FieldType<number>;
24
- /**
25
- * This field shall be the measured value for the given harmonic order.
26
- *
27
- * For the Harmonic Currents attribute, this value is the most recently measured harmonic current reading in
28
- * milliamps (mA). A positive value indicates that the measured harmonic current is positive, and a negative
29
- * value indicates that the measured harmonic current is negative.
30
- *
31
- * For the Harmonic Phases attribute, this value is the most recent phase of the given harmonic order
32
- *
33
- * in millidegrees (mDeg). A positive value indicates that the measured phase is leading, and a negative value
34
- * indicates that the measured phase is lagging.
35
- *
36
- * If this measurement is not currently available, a value of null shall be returned.
37
- *
38
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.2
39
- */
40
- measurement: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint | null>;
41
- }>;
42
- /**
43
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3
44
- */
45
- type HarmonicMeasurement = TypeFromSchema<typeof TlvHarmonicMeasurement>;
46
- /**
47
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.1
48
- */
49
- enum PowerMode {
50
- Unknown = 0,
51
- /**
52
- * Direct current
53
- */
54
- Dc = 1,
55
- /**
56
- * Alternating current, either single-phase or polyphase
57
- */
58
- Ac = 2
59
- }
60
- /**
61
- * This struct shall indicate the maximum and minimum values of a given measurement type during a measurement
62
- * period, along with the observation times of these values.
63
- *
64
- * A server which does not have the ability to determine the time in UTC, or has not yet done so, shall use the
65
- * system time fields to specify the measurement period and observation times.
66
- *
67
- * A server which has determined the time in UTC shall use the timestamp fields to specify the measurement period
68
- * and observation times. Such a server may also include the systime fields to indicate how many seconds had passed
69
- * since boot for a given timestamp; this allows for client-side resolution of UTC time for previous reports that
70
- * only included systime.
71
- *
72
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2
73
- */
74
- const TlvMeasurementRange: import("@project-chip/matter-node.js/tlv").ObjectSchema<{
75
- /**
76
- * This field shall be the type of measurement for the range provided.
77
- *
78
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.1
79
- */
80
- measurementType: import("@project-chip/matter-node.js/tlv").FieldType<MeasurementType>;
81
- /**
82
- * This field shall be the smallest measured value for the associated measurement over either the period
83
- * between StartTimestamp and EndTimestamp, or the period between StartSystime and EndSystime, or both.
84
- *
85
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.2
86
- */
87
- min: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
88
- /**
89
- * This field shall be the largest measured value for the associated measurement over the period between either
90
- * StartTimestamp and EndTimestamp or the period between StartSystime and EndSystime, or both.
91
- *
92
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.3
93
- */
94
- max: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
95
- /**
96
- * This field shall be the timestamp in UTC of the beginning of the measurement period.
97
- *
98
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
99
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
100
- *
101
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.4
102
- */
103
- startTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
104
- /**
105
- * This field shall be the timestamp in UTC of the end of the measurement period.
106
- *
107
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
108
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
109
- *
110
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.5
111
- */
112
- endTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
113
- /**
114
- * This field shall be the most recent timestamp in UTC that the value in the Min field was measured.
115
- *
116
- * This field shall be greater than or equal to the value of the StartTimestamp field. This field shall be less
117
- * than or equal to the value of the EndTimestamp field.
118
- *
119
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.6
120
- */
121
- minTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
122
- /**
123
- * This field shall be the most recent timestamp in UTC of the value in the Max field. This field shall be
124
- * greater than or equal to the value of the StartTimestamp field. This field shall be less than or equal to
125
- * the value of the EndTimestamp field.
126
- *
127
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.7
128
- */
129
- maxTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
130
- /**
131
- * This field shall be the time since boot of the beginning of the measurement period.
132
- *
133
- * If the server had determined the time in UTC at or before the start of the measurement period, this field
134
- * may be omitted along with the EndSystime, MinSystime, and MaxSystime fields.
135
- *
136
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.8
137
- */
138
- startSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
139
- /**
140
- * This field shall be the time since boot of the end of the measurement period.
141
- *
142
- * If the server had determined the time in UTC at the end of the measurement period, this field may be omitted
143
- * along with the StartSystime field, MinSystime, and MaxSystime fields.
144
- *
145
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.9
146
- */
147
- endSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
148
- /**
149
- * This field shall be the measurement time since boot of the value in the Min field was measured. This field
150
- * shall be greater than or equal to the value of the StartSystime field.
151
- *
152
- * This field shall be less than or equal to the value of the EndSystime field.
153
- *
154
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.10
155
- */
156
- minSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
157
- /**
158
- * This field shall be the measurement time since boot of the value in the Max field. This field shall be
159
- * greater than or equal to the value of the StartSystime field.
160
- *
161
- * This field shall be less than or equal to the value of the EndSystime field.
162
- *
163
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.11
164
- */
165
- maxSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
166
- }>;
167
- /**
168
- * This struct shall indicate the maximum and minimum values of a given measurement type during a measurement
169
- * period, along with the observation times of these values.
170
- *
171
- * A server which does not have the ability to determine the time in UTC, or has not yet done so, shall use the
172
- * system time fields to specify the measurement period and observation times.
173
- *
174
- * A server which has determined the time in UTC shall use the timestamp fields to specify the measurement period
175
- * and observation times. Such a server may also include the systime fields to indicate how many seconds had passed
176
- * since boot for a given timestamp; this allows for client-side resolution of UTC time for previous reports that
177
- * only included systime.
178
- *
179
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2
180
- */
181
- type MeasurementRange = TypeFromSchema<typeof TlvMeasurementRange>;
182
- /**
183
- * Body of the ElectricalPowerMeasurement measurementPeriodRanges event
184
- *
185
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.7.1
186
- */
187
- const TlvMeasurementPeriodRangesEvent: import("@project-chip/matter-node.js/tlv").ObjectSchema<{
188
- /**
189
- * This shall indicate the value of the Ranges attribute at the time of event generation.
190
- *
191
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.7.1.1
192
- */
193
- ranges: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
194
- /**
195
- * This field shall be the type of measurement for the range provided.
196
- *
197
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.1
198
- */
199
- measurementType: import("@project-chip/matter-node.js/tlv").FieldType<MeasurementType>;
200
- /**
201
- * This field shall be the smallest measured value for the associated measurement over either the period
202
- * between StartTimestamp and EndTimestamp, or the period between StartSystime and EndSystime, or both.
203
- *
204
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.2
205
- */
206
- min: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
207
- /**
208
- * This field shall be the largest measured value for the associated measurement over the period between either
209
- * StartTimestamp and EndTimestamp or the period between StartSystime and EndSystime, or both.
210
- *
211
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.3
212
- */
213
- max: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
214
- /**
215
- * This field shall be the timestamp in UTC of the beginning of the measurement period.
216
- *
217
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
218
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
219
- *
220
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.4
221
- */
222
- startTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
223
- /**
224
- * This field shall be the timestamp in UTC of the end of the measurement period.
225
- *
226
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
227
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
228
- *
229
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.5
230
- */
231
- endTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
232
- /**
233
- * This field shall be the most recent timestamp in UTC that the value in the Min field was measured.
234
- *
235
- * This field shall be greater than or equal to the value of the StartTimestamp field. This field shall be less
236
- * than or equal to the value of the EndTimestamp field.
237
- *
238
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.6
239
- */
240
- minTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
241
- /**
242
- * This field shall be the most recent timestamp in UTC of the value in the Max field. This field shall be
243
- * greater than or equal to the value of the StartTimestamp field. This field shall be less than or equal to
244
- * the value of the EndTimestamp field.
245
- *
246
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.7
247
- */
248
- maxTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
249
- /**
250
- * This field shall be the time since boot of the beginning of the measurement period.
251
- *
252
- * If the server had determined the time in UTC at or before the start of the measurement period, this field
253
- * may be omitted along with the EndSystime, MinSystime, and MaxSystime fields.
254
- *
255
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.8
256
- */
257
- startSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
258
- /**
259
- * This field shall be the time since boot of the end of the measurement period.
260
- *
261
- * If the server had determined the time in UTC at the end of the measurement period, this field may be omitted
262
- * along with the StartSystime field, MinSystime, and MaxSystime fields.
263
- *
264
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.9
265
- */
266
- endSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
267
- /**
268
- * This field shall be the measurement time since boot of the value in the Min field was measured. This field
269
- * shall be greater than or equal to the value of the StartSystime field.
270
- *
271
- * This field shall be less than or equal to the value of the EndSystime field.
272
- *
273
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.10
274
- */
275
- minSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
276
- /**
277
- * This field shall be the measurement time since boot of the value in the Max field. This field shall be
278
- * greater than or equal to the value of the StartSystime field.
279
- *
280
- * This field shall be less than or equal to the value of the EndSystime field.
281
- *
282
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.11
283
- */
284
- maxSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
285
- }>[]>;
286
- }>;
287
- /**
288
- * Body of the ElectricalPowerMeasurement measurementPeriodRanges event
289
- *
290
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.7.1
291
- */
292
- type MeasurementPeriodRangesEvent = TypeFromSchema<typeof TlvMeasurementPeriodRangesEvent>;
293
- /**
294
- * A ElectricalPowerMeasurementCluster supports these elements if it supports feature AlternatingCurrent.
295
- */
296
- const AlternatingCurrentComponent: {
297
- readonly attributes: {
298
- /**
299
- * This shall indicate the most recent ReactiveCurrent reading in milliamps (mA).
300
- *
301
- * A positive value represents current flowing into the server, while a negative value represents current
302
- * flowing out of the server.
303
- *
304
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
305
- * publication of deltas considered not meaningful.
306
- *
307
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
308
- * recently than 1 second ago.
309
- *
310
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
311
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
312
- *
313
- * If the current cannot be measured, a value of null shall be returned.
314
- *
315
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.7
316
- */
317
- readonly reactiveCurrent: OptionalAttribute<number | bigint | null, any>;
318
- /**
319
- * This shall indicate the most recent ApparentCurrent (square root sum of the squares of active and
320
- * reactive currents) reading in milliamps (mA).
321
- *
322
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
323
- * publication of deltas considered not meaningful.
324
- *
325
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
326
- * recently than 1 second ago.
327
- *
328
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
329
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
330
- *
331
- * If the active or reactive currents cannot be measured, a value of null shall be returned.
332
- *
333
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.8
334
- */
335
- readonly apparentCurrent: OptionalAttribute<number | bigint | null, any>;
336
- /**
337
- * This shall indicate the most recent ReactivePower reading in millivolt-amps reactive (mVAR). A positive
338
- * value represents power imported, while a negative value represents power exported.
339
- *
340
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
341
- * publication of deltas considered not meaningful.
342
- *
343
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
344
- * recently than 1 second ago.
345
- *
346
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
347
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
348
- *
349
- * If the reactive power cannot be measured, a value of null shall be returned.
350
- *
351
- * If the Polyphase Power feature is supported, this value represents the combined reactive power imported
352
- * or exported.
353
- *
354
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.10
355
- */
356
- readonly reactivePower: OptionalAttribute<number | bigint | null, any>;
357
- /**
358
- * This shall indicate the most recent ApparentPower reading in millivolt-amps (mVA).
359
- *
360
- * A positive value represents power imported, while a negative value represents power exported.
361
- *
362
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
363
- * publication of deltas considered not meaningful.
364
- *
365
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
366
- * recently than 1 second ago.
367
- *
368
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
369
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
370
- *
371
- * If the apparent power cannot be measured, a value of null shall be returned.
372
- *
373
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.11
374
- */
375
- readonly apparentPower: OptionalAttribute<number | bigint | null, any>;
376
- /**
377
- * This shall indicate the most recent RMSVoltage reading in millivolts (mV).
378
- *
379
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
380
- * publication of deltas considered not meaningful.
381
- *
382
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
383
- * recently than 1 second ago.
384
- *
385
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
386
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
387
- *
388
- * If the RMS voltage cannot be measured, a value of null shall be returned.
389
- *
390
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.12
391
- */
392
- readonly rmsVoltage: OptionalAttribute<number | bigint | null, any>;
393
- /**
394
- * This shall indicate the most recent RMSCurrent reading in milliamps (mA).
395
- *
396
- * A positive value represents current flowing into the server, while a negative value represents current
397
- * flowing out of the server.
398
- *
399
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
400
- * publication of deltas considered not meaningful.
401
- *
402
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
403
- * recently than 1 second ago.
404
- *
405
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
406
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
407
- *
408
- * If the RMS current cannot be measured, a value of null shall be returned.
409
- *
410
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.13
411
- */
412
- readonly rmsCurrent: OptionalAttribute<number | bigint | null, any>;
413
- /**
414
- * This shall indicate the most recent RMSPower reading in milliwatts (mW).
415
- *
416
- * A positive value represents power imported, while a negative value represents power exported.
417
- *
418
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
419
- * publication of deltas considered not meaningful.
420
- *
421
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
422
- * recently than 1 second ago.
423
- *
424
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
425
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
426
- *
427
- * If the RMS power cannot be measured, a value of null shall be returned.
428
- *
429
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.14
430
- */
431
- readonly rmsPower: OptionalAttribute<number | bigint | null, any>;
432
- /**
433
- * This shall indicate the most recent Frequency reading in millihertz (mHz).
434
- *
435
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
436
- * publication of deltas considered not meaningful.
437
- *
438
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
439
- * recently than 1 second ago.
440
- *
441
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
442
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
443
- *
444
- * If the frequency cannot be measured, a value of null shall be returned.
445
- *
446
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.15
447
- */
448
- readonly frequency: OptionalAttribute<number | bigint | null, any>;
449
- /**
450
- * This shall indicate the Power Factor ratio in +/- 1/100ths of a percent.
451
- *
452
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
453
- * publication of deltas considered not meaningful.
454
- *
455
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
456
- * recently than 1 second ago.
457
- *
458
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
459
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
460
- *
461
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.18
462
- */
463
- readonly powerFactor: OptionalAttribute<number | bigint | null, any>;
464
- };
465
- };
466
- /**
467
- * A ElectricalPowerMeasurementCluster supports these elements if it supports feature Harmonics.
468
- */
469
- const HarmonicsComponent: {
470
- readonly attributes: {
471
- /**
472
- * This shall indicate a list of HarmonicMeasurementStruct values, with each HarmonicMeasurementStruct
473
- * representing the harmonic current reading for the harmonic order specified by Order.
474
- *
475
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
476
- * publication of deltas considered not meaningful.
477
- *
478
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
479
- * recently than 1 second ago.
480
- *
481
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
482
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
483
- *
484
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.16
485
- */
486
- readonly harmonicCurrents: Attribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
487
- /**
488
- * This field shall be the order of the harmonic being measured. Typically this is an odd number, but servers
489
- * may choose to report even harmonics.
490
- *
491
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.1
492
- */
493
- order: import("@project-chip/matter-node.js/tlv").FieldType<number>;
494
- /**
495
- * This field shall be the measured value for the given harmonic order.
496
- *
497
- * For the Harmonic Currents attribute, this value is the most recently measured harmonic current reading in
498
- * milliamps (mA). A positive value indicates that the measured harmonic current is positive, and a negative
499
- * value indicates that the measured harmonic current is negative.
500
- *
501
- * For the Harmonic Phases attribute, this value is the most recent phase of the given harmonic order
502
- *
503
- * in millidegrees (mDeg). A positive value indicates that the measured phase is leading, and a negative value
504
- * indicates that the measured phase is lagging.
505
- *
506
- * If this measurement is not currently available, a value of null shall be returned.
507
- *
508
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.2
509
- */
510
- measurement: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint | null>;
511
- }>[] | null, any>;
512
- };
513
- };
514
- /**
515
- * A ElectricalPowerMeasurementCluster supports these elements if it supports feature PowerQuality.
516
- */
517
- const PowerQualityComponent: {
518
- readonly attributes: {
519
- /**
520
- * This shall indicate a list of HarmonicMeasurementStruct values, with each HarmonicMeasurementStruct
521
- * representing the most recent phase of the harmonic current reading for the harmonic
522
- *
523
- * order specified by Order.
524
- *
525
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
526
- * publication of deltas considered not meaningful.
527
- *
528
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
529
- * recently than 1 second ago.
530
- *
531
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
532
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
533
- *
534
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.17
535
- */
536
- readonly harmonicPhases: Attribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
537
- /**
538
- * This field shall be the order of the harmonic being measured. Typically this is an odd number, but servers
539
- * may choose to report even harmonics.
540
- *
541
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.1
542
- */
543
- order: import("@project-chip/matter-node.js/tlv").FieldType<number>;
544
- /**
545
- * This field shall be the measured value for the given harmonic order.
546
- *
547
- * For the Harmonic Currents attribute, this value is the most recently measured harmonic current reading in
548
- * milliamps (mA). A positive value indicates that the measured harmonic current is positive, and a negative
549
- * value indicates that the measured harmonic current is negative.
550
- *
551
- * For the Harmonic Phases attribute, this value is the most recent phase of the given harmonic order
552
- *
553
- * in millidegrees (mDeg). A positive value indicates that the measured phase is leading, and a negative value
554
- * indicates that the measured phase is lagging.
555
- *
556
- * If this measurement is not currently available, a value of null shall be returned.
557
- *
558
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.2
559
- */
560
- measurement: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint | null>;
561
- }>[] | null, any>;
562
- };
563
- };
564
- /**
565
- * A ElectricalPowerMeasurementCluster supports these elements if it supports feature PolyphasePower.
566
- */
567
- const PolyphasePowerComponent: {
568
- readonly attributes: {
569
- /**
570
- * This shall indicate the most recent NeutralCurrent reading in milliamps (mA). Typically this is a
571
- * derived value, taking the magnitude of the vector sum of phase currents.
572
- *
573
- * If the neutral current cannot be measured or derived, a value of null shall be returned.
574
- *
575
- * A positive value represents an imbalance between the phase currents when power is imported. A negative
576
- * value represents an imbalance between the phase currents when power is exported.
577
- *
578
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
579
- * publication of deltas considered not meaningful.
580
- *
581
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
582
- * recently than 1 second ago.
583
- *
584
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
585
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
586
- *
587
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.19
588
- */
589
- readonly neutralCurrent: OptionalAttribute<number | bigint | null, any>;
590
- };
591
- };
592
- /**
593
- * These are optional features supported by ElectricalPowerMeasurementCluster.
594
- *
595
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4
596
- */
597
- enum Feature {
598
- /**
599
- * DirectCurrent
600
- *
601
- * This feature indicates the cluster can measure a direct current.
602
- *
603
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.1
604
- */
605
- DirectCurrent = "DirectCurrent",
606
- /**
607
- * AlternatingCurrent
608
- *
609
- * This feature indicates the cluster can measure an alternating current.
610
- *
611
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.2
612
- */
613
- AlternatingCurrent = "AlternatingCurrent",
614
- /**
615
- * PolyphasePower
616
- *
617
- * This feature indicates the cluster represents the collective measurements for a Polyphase power supply.
618
- *
619
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.3
620
- */
621
- PolyphasePower = "PolyphasePower",
622
- /**
623
- * Harmonics
624
- *
625
- * This feature indicates the cluster can measure the harmonics of an alternating current.
626
- *
627
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.4
628
- */
629
- Harmonics = "Harmonics",
630
- /**
631
- * PowerQuality
632
- *
633
- * This feature indicates the cluster can measure the harmonic phases of an alternating current.
634
- *
635
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.5
636
- */
637
- PowerQuality = "PowerQuality"
638
- }
639
- /**
640
- * These elements and properties are present in all ElectricalPowerMeasurement clusters.
641
- */
642
- const Base: {
643
- readonly id: 144;
644
- readonly name: "ElectricalPowerMeasurement";
645
- readonly revision: 1;
646
- readonly features: {
647
- /**
648
- * DirectCurrent
649
- *
650
- * This feature indicates the cluster can measure a direct current.
651
- *
652
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.1
653
- */
654
- readonly directCurrent: BitFlag;
655
- /**
656
- * AlternatingCurrent
657
- *
658
- * This feature indicates the cluster can measure an alternating current.
659
- *
660
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.2
661
- */
662
- readonly alternatingCurrent: BitFlag;
663
- /**
664
- * PolyphasePower
665
- *
666
- * This feature indicates the cluster represents the collective measurements for a Polyphase power supply.
667
- *
668
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.3
669
- */
670
- readonly polyphasePower: BitFlag;
671
- /**
672
- * Harmonics
673
- *
674
- * This feature indicates the cluster can measure the harmonics of an alternating current.
675
- *
676
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.4
677
- */
678
- readonly harmonics: BitFlag;
679
- /**
680
- * PowerQuality
681
- *
682
- * This feature indicates the cluster can measure the harmonic phases of an alternating current.
683
- *
684
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.5
685
- */
686
- readonly powerQuality: BitFlag;
687
- };
688
- readonly attributes: {
689
- /**
690
- * This shall indicate the current mode of the server. For some servers, such as an EV, this may change
691
- * depending on the mode of charging or discharging.
692
- *
693
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.1
694
- */
695
- readonly powerMode: Attribute<PowerMode, any>;
696
- /**
697
- * This shall indicate the maximum number of measurement types the server is capable of reporting.
698
- *
699
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.2
700
- */
701
- readonly numberOfMeasurementTypes: FixedAttribute<number, any>;
702
- /**
703
- * This shall indicate a list of accuracy specifications for the measurement types supported by the server.
704
- * There shall be an entry for ActivePower, as well as any other measurement types implemented by this
705
- * server.
706
- *
707
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.3
708
- */
709
- readonly accuracy: FixedAttribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
710
- measurementType: import("@project-chip/matter-node.js/tlv").FieldType<MeasurementType>;
711
- measured: import("@project-chip/matter-node.js/tlv").FieldType<boolean>;
712
- minMeasuredValue: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
713
- maxMeasuredValue: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
714
- accuracyRanges: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
715
- rangeMin: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
716
- rangeMax: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
717
- percentMax: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
718
- percentMin: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
719
- percentTypical: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
720
- fixedMax: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
721
- fixedMin: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
722
- fixedTypical: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
723
- }>[]>;
724
- }>[], any>;
725
- /**
726
- * This shall indicate a list of measured ranges for different measurement types. Each measurement type
727
- * shall have at most one entry in this list, representing the range of measurements in the most recent
728
- * measurement period.
729
- *
730
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
731
- * publication of deltas considered not meaningful.
732
- *
733
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
734
- * recently than 1 second ago.
735
- *
736
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
737
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
738
- *
739
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.4
740
- */
741
- readonly ranges: OptionalAttribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
742
- /**
743
- * This field shall be the type of measurement for the range provided.
744
- *
745
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.1
746
- */
747
- measurementType: import("@project-chip/matter-node.js/tlv").FieldType<MeasurementType>;
748
- /**
749
- * This field shall be the smallest measured value for the associated measurement over either the period
750
- * between StartTimestamp and EndTimestamp, or the period between StartSystime and EndSystime, or both.
751
- *
752
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.2
753
- */
754
- min: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
755
- /**
756
- * This field shall be the largest measured value for the associated measurement over the period between either
757
- * StartTimestamp and EndTimestamp or the period between StartSystime and EndSystime, or both.
758
- *
759
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.3
760
- */
761
- max: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
762
- /**
763
- * This field shall be the timestamp in UTC of the beginning of the measurement period.
764
- *
765
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
766
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
767
- *
768
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.4
769
- */
770
- startTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
771
- /**
772
- * This field shall be the timestamp in UTC of the end of the measurement period.
773
- *
774
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
775
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
776
- *
777
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.5
778
- */
779
- endTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
780
- /**
781
- * This field shall be the most recent timestamp in UTC that the value in the Min field was measured.
782
- *
783
- * This field shall be greater than or equal to the value of the StartTimestamp field. This field shall be less
784
- * than or equal to the value of the EndTimestamp field.
785
- *
786
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.6
787
- */
788
- minTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
789
- /**
790
- * This field shall be the most recent timestamp in UTC of the value in the Max field. This field shall be
791
- * greater than or equal to the value of the StartTimestamp field. This field shall be less than or equal to
792
- * the value of the EndTimestamp field.
793
- *
794
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.7
795
- */
796
- maxTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
797
- /**
798
- * This field shall be the time since boot of the beginning of the measurement period.
799
- *
800
- * If the server had determined the time in UTC at or before the start of the measurement period, this field
801
- * may be omitted along with the EndSystime, MinSystime, and MaxSystime fields.
802
- *
803
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.8
804
- */
805
- startSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
806
- /**
807
- * This field shall be the time since boot of the end of the measurement period.
808
- *
809
- * If the server had determined the time in UTC at the end of the measurement period, this field may be omitted
810
- * along with the StartSystime field, MinSystime, and MaxSystime fields.
811
- *
812
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.9
813
- */
814
- endSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
815
- /**
816
- * This field shall be the measurement time since boot of the value in the Min field was measured. This field
817
- * shall be greater than or equal to the value of the StartSystime field.
818
- *
819
- * This field shall be less than or equal to the value of the EndSystime field.
820
- *
821
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.10
822
- */
823
- minSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
824
- /**
825
- * This field shall be the measurement time since boot of the value in the Max field. This field shall be
826
- * greater than or equal to the value of the StartSystime field.
827
- *
828
- * This field shall be less than or equal to the value of the EndSystime field.
829
- *
830
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.11
831
- */
832
- maxSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
833
- }>[], any>;
834
- /**
835
- * This shall indicate the most recent Voltage reading in millivolts (mV).
836
- *
837
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
838
- * publication of deltas considered not meaningful.
839
- *
840
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
841
- * recently than 1 second ago.
842
- *
843
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
844
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
845
- *
846
- * If the voltage cannot be measured, a value of null shall be returned.
847
- *
848
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.5
849
- */
850
- readonly voltage: OptionalAttribute<number | bigint | null, any>;
851
- /**
852
- * This shall indicate the most recent ActiveCurrent reading in milliamps (mA).
853
- *
854
- * A positive value represents current flowing into the server, while a negative value represents current
855
- * flowing out of the server.
856
- *
857
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
858
- * publication of deltas considered not meaningful.
859
- *
860
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
861
- * recently than 1 second ago.
862
- *
863
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
864
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
865
- *
866
- * If the current cannot be measured, a value of null shall be returned.
867
- *
868
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.6
869
- */
870
- readonly activeCurrent: OptionalAttribute<number | bigint | null, any>;
871
- /**
872
- * This shall indicate the most recent ActivePower reading in milliwatts (mW). If the power cannot be
873
- * measured, a value of null shall be returned.
874
- *
875
- * A positive value represents power imported, while a negative value represents power exported.
876
- *
877
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
878
- * publication of deltas considered not meaningful.
879
- *
880
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
881
- * recently than 1 second ago.
882
- *
883
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
884
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
885
- *
886
- * If the Polyphase Power feature is set, this value represents the combined active power imported or
887
- * exported.
888
- *
889
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.9
890
- */
891
- readonly activePower: Attribute<number | bigint | null, any>;
892
- };
893
- readonly events: {
894
- /**
895
- * If supported, this event shall be generated at the end of a measurement period. The start and end times
896
- * for measurement periods shall be determined by the server, and may represent overlapping periods.
897
- *
898
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.7.1
899
- */
900
- readonly measurementPeriodRanges: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
901
- /**
902
- * This shall indicate the value of the Ranges attribute at the time of event generation.
903
- *
904
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.7.1.1
905
- */
906
- ranges: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
907
- /**
908
- * This field shall be the type of measurement for the range provided.
909
- *
910
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.1
911
- */
912
- measurementType: import("@project-chip/matter-node.js/tlv").FieldType<MeasurementType>;
913
- /**
914
- * This field shall be the smallest measured value for the associated measurement over either the period
915
- * between StartTimestamp and EndTimestamp, or the period between StartSystime and EndSystime, or both.
916
- *
917
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.2
918
- */
919
- min: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
920
- /**
921
- * This field shall be the largest measured value for the associated measurement over the period between either
922
- * StartTimestamp and EndTimestamp or the period between StartSystime and EndSystime, or both.
923
- *
924
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.3
925
- */
926
- max: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
927
- /**
928
- * This field shall be the timestamp in UTC of the beginning of the measurement period.
929
- *
930
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
931
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
932
- *
933
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.4
934
- */
935
- startTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
936
- /**
937
- * This field shall be the timestamp in UTC of the end of the measurement period.
938
- *
939
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
940
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
941
- *
942
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.5
943
- */
944
- endTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
945
- /**
946
- * This field shall be the most recent timestamp in UTC that the value in the Min field was measured.
947
- *
948
- * This field shall be greater than or equal to the value of the StartTimestamp field. This field shall be less
949
- * than or equal to the value of the EndTimestamp field.
950
- *
951
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.6
952
- */
953
- minTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
954
- /**
955
- * This field shall be the most recent timestamp in UTC of the value in the Max field. This field shall be
956
- * greater than or equal to the value of the StartTimestamp field. This field shall be less than or equal to
957
- * the value of the EndTimestamp field.
958
- *
959
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.7
960
- */
961
- maxTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
962
- /**
963
- * This field shall be the time since boot of the beginning of the measurement period.
964
- *
965
- * If the server had determined the time in UTC at or before the start of the measurement period, this field
966
- * may be omitted along with the EndSystime, MinSystime, and MaxSystime fields.
967
- *
968
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.8
969
- */
970
- startSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
971
- /**
972
- * This field shall be the time since boot of the end of the measurement period.
973
- *
974
- * If the server had determined the time in UTC at the end of the measurement period, this field may be omitted
975
- * along with the StartSystime field, MinSystime, and MaxSystime fields.
976
- *
977
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.9
978
- */
979
- endSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
980
- /**
981
- * This field shall be the measurement time since boot of the value in the Min field was measured. This field
982
- * shall be greater than or equal to the value of the StartSystime field.
983
- *
984
- * This field shall be less than or equal to the value of the EndSystime field.
985
- *
986
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.10
987
- */
988
- minSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
989
- /**
990
- * This field shall be the measurement time since boot of the value in the Max field. This field shall be
991
- * greater than or equal to the value of the StartSystime field.
992
- *
993
- * This field shall be less than or equal to the value of the EndSystime field.
994
- *
995
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.11
996
- */
997
- maxSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
998
- }>[]>;
999
- }>, any>;
1000
- };
1001
- /**
1002
- * This metadata controls which ElectricalPowerMeasurementCluster elements matter.js activates for specific
1003
- * feature combinations.
1004
- */
1005
- readonly extensions: readonly [{
1006
- readonly flags: {
1007
- readonly alternatingCurrent: true;
1008
- };
1009
- readonly component: {
1010
- readonly attributes: {
1011
- /**
1012
- * This shall indicate the most recent ReactiveCurrent reading in milliamps (mA).
1013
- *
1014
- * A positive value represents current flowing into the server, while a negative value represents current
1015
- * flowing out of the server.
1016
- *
1017
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1018
- * publication of deltas considered not meaningful.
1019
- *
1020
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1021
- * recently than 1 second ago.
1022
- *
1023
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1024
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1025
- *
1026
- * If the current cannot be measured, a value of null shall be returned.
1027
- *
1028
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.7
1029
- */
1030
- readonly reactiveCurrent: OptionalAttribute<number | bigint | null, any>;
1031
- /**
1032
- * This shall indicate the most recent ApparentCurrent (square root sum of the squares of active and
1033
- * reactive currents) reading in milliamps (mA).
1034
- *
1035
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1036
- * publication of deltas considered not meaningful.
1037
- *
1038
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1039
- * recently than 1 second ago.
1040
- *
1041
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1042
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1043
- *
1044
- * If the active or reactive currents cannot be measured, a value of null shall be returned.
1045
- *
1046
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.8
1047
- */
1048
- readonly apparentCurrent: OptionalAttribute<number | bigint | null, any>;
1049
- /**
1050
- * This shall indicate the most recent ReactivePower reading in millivolt-amps reactive (mVAR). A positive
1051
- * value represents power imported, while a negative value represents power exported.
1052
- *
1053
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1054
- * publication of deltas considered not meaningful.
1055
- *
1056
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1057
- * recently than 1 second ago.
1058
- *
1059
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1060
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1061
- *
1062
- * If the reactive power cannot be measured, a value of null shall be returned.
1063
- *
1064
- * If the Polyphase Power feature is supported, this value represents the combined reactive power imported
1065
- * or exported.
1066
- *
1067
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.10
1068
- */
1069
- readonly reactivePower: OptionalAttribute<number | bigint | null, any>;
1070
- /**
1071
- * This shall indicate the most recent ApparentPower reading in millivolt-amps (mVA).
1072
- *
1073
- * A positive value represents power imported, while a negative value represents power exported.
1074
- *
1075
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1076
- * publication of deltas considered not meaningful.
1077
- *
1078
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1079
- * recently than 1 second ago.
1080
- *
1081
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1082
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1083
- *
1084
- * If the apparent power cannot be measured, a value of null shall be returned.
1085
- *
1086
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.11
1087
- */
1088
- readonly apparentPower: OptionalAttribute<number | bigint | null, any>;
1089
- /**
1090
- * This shall indicate the most recent RMSVoltage reading in millivolts (mV).
1091
- *
1092
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1093
- * publication of deltas considered not meaningful.
1094
- *
1095
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1096
- * recently than 1 second ago.
1097
- *
1098
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1099
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1100
- *
1101
- * If the RMS voltage cannot be measured, a value of null shall be returned.
1102
- *
1103
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.12
1104
- */
1105
- readonly rmsVoltage: OptionalAttribute<number | bigint | null, any>;
1106
- /**
1107
- * This shall indicate the most recent RMSCurrent reading in milliamps (mA).
1108
- *
1109
- * A positive value represents current flowing into the server, while a negative value represents current
1110
- * flowing out of the server.
1111
- *
1112
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1113
- * publication of deltas considered not meaningful.
1114
- *
1115
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1116
- * recently than 1 second ago.
1117
- *
1118
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1119
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1120
- *
1121
- * If the RMS current cannot be measured, a value of null shall be returned.
1122
- *
1123
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.13
1124
- */
1125
- readonly rmsCurrent: OptionalAttribute<number | bigint | null, any>;
1126
- /**
1127
- * This shall indicate the most recent RMSPower reading in milliwatts (mW).
1128
- *
1129
- * A positive value represents power imported, while a negative value represents power exported.
1130
- *
1131
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1132
- * publication of deltas considered not meaningful.
1133
- *
1134
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1135
- * recently than 1 second ago.
1136
- *
1137
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1138
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1139
- *
1140
- * If the RMS power cannot be measured, a value of null shall be returned.
1141
- *
1142
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.14
1143
- */
1144
- readonly rmsPower: OptionalAttribute<number | bigint | null, any>;
1145
- /**
1146
- * This shall indicate the most recent Frequency reading in millihertz (mHz).
1147
- *
1148
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1149
- * publication of deltas considered not meaningful.
1150
- *
1151
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1152
- * recently than 1 second ago.
1153
- *
1154
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1155
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1156
- *
1157
- * If the frequency cannot be measured, a value of null shall be returned.
1158
- *
1159
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.15
1160
- */
1161
- readonly frequency: OptionalAttribute<number | bigint | null, any>;
1162
- /**
1163
- * This shall indicate the Power Factor ratio in +/- 1/100ths of a percent.
1164
- *
1165
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1166
- * publication of deltas considered not meaningful.
1167
- *
1168
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1169
- * recently than 1 second ago.
1170
- *
1171
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1172
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1173
- *
1174
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.18
1175
- */
1176
- readonly powerFactor: OptionalAttribute<number | bigint | null, any>;
1177
- };
1178
- };
1179
- }, {
1180
- readonly flags: {
1181
- readonly harmonics: true;
1182
- };
1183
- readonly component: {
1184
- readonly attributes: {
1185
- /**
1186
- * This shall indicate a list of HarmonicMeasurementStruct values, with each HarmonicMeasurementStruct
1187
- * representing the harmonic current reading for the harmonic order specified by Order.
1188
- *
1189
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1190
- * publication of deltas considered not meaningful.
1191
- *
1192
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1193
- * recently than 1 second ago.
1194
- *
1195
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1196
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1197
- *
1198
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.16
1199
- */
1200
- readonly harmonicCurrents: Attribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1201
- /**
1202
- * This field shall be the order of the harmonic being measured. Typically this is an odd number, but servers
1203
- * may choose to report even harmonics.
1204
- *
1205
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.1
1206
- */
1207
- order: import("@project-chip/matter-node.js/tlv").FieldType<number>;
1208
- /**
1209
- * This field shall be the measured value for the given harmonic order.
1210
- *
1211
- * For the Harmonic Currents attribute, this value is the most recently measured harmonic current reading in
1212
- * milliamps (mA). A positive value indicates that the measured harmonic current is positive, and a negative
1213
- * value indicates that the measured harmonic current is negative.
1214
- *
1215
- * For the Harmonic Phases attribute, this value is the most recent phase of the given harmonic order
1216
- *
1217
- * in millidegrees (mDeg). A positive value indicates that the measured phase is leading, and a negative value
1218
- * indicates that the measured phase is lagging.
1219
- *
1220
- * If this measurement is not currently available, a value of null shall be returned.
1221
- *
1222
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.2
1223
- */
1224
- measurement: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint | null>;
1225
- }>[] | null, any>;
1226
- };
1227
- };
1228
- }, {
1229
- readonly flags: {
1230
- readonly powerQuality: true;
1231
- };
1232
- readonly component: {
1233
- readonly attributes: {
1234
- /**
1235
- * This shall indicate a list of HarmonicMeasurementStruct values, with each HarmonicMeasurementStruct
1236
- * representing the most recent phase of the harmonic current reading for the harmonic
1237
- *
1238
- * order specified by Order.
1239
- *
1240
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1241
- * publication of deltas considered not meaningful.
1242
- *
1243
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1244
- * recently than 1 second ago.
1245
- *
1246
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1247
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1248
- *
1249
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.17
1250
- */
1251
- readonly harmonicPhases: Attribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1252
- /**
1253
- * This field shall be the order of the harmonic being measured. Typically this is an odd number, but servers
1254
- * may choose to report even harmonics.
1255
- *
1256
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.1
1257
- */
1258
- order: import("@project-chip/matter-node.js/tlv").FieldType<number>;
1259
- /**
1260
- * This field shall be the measured value for the given harmonic order.
1261
- *
1262
- * For the Harmonic Currents attribute, this value is the most recently measured harmonic current reading in
1263
- * milliamps (mA). A positive value indicates that the measured harmonic current is positive, and a negative
1264
- * value indicates that the measured harmonic current is negative.
1265
- *
1266
- * For the Harmonic Phases attribute, this value is the most recent phase of the given harmonic order
1267
- *
1268
- * in millidegrees (mDeg). A positive value indicates that the measured phase is leading, and a negative value
1269
- * indicates that the measured phase is lagging.
1270
- *
1271
- * If this measurement is not currently available, a value of null shall be returned.
1272
- *
1273
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.2
1274
- */
1275
- measurement: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint | null>;
1276
- }>[] | null, any>;
1277
- };
1278
- };
1279
- }, {
1280
- readonly flags: {
1281
- readonly polyphasePower: true;
1282
- };
1283
- readonly component: {
1284
- readonly attributes: {
1285
- /**
1286
- * This shall indicate the most recent NeutralCurrent reading in milliamps (mA). Typically this is a
1287
- * derived value, taking the magnitude of the vector sum of phase currents.
1288
- *
1289
- * If the neutral current cannot be measured or derived, a value of null shall be returned.
1290
- *
1291
- * A positive value represents an imbalance between the phase currents when power is imported. A negative
1292
- * value represents an imbalance between the phase currents when power is exported.
1293
- *
1294
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1295
- * publication of deltas considered not meaningful.
1296
- *
1297
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1298
- * recently than 1 second ago.
1299
- *
1300
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1301
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1302
- *
1303
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.19
1304
- */
1305
- readonly neutralCurrent: OptionalAttribute<number | bigint | null, any>;
1306
- };
1307
- };
1308
- }, {
1309
- readonly flags: {
1310
- readonly polyphasePower: true;
1311
- readonly alternatingCurrent: false;
1312
- };
1313
- readonly component: false;
1314
- }, {
1315
- readonly flags: {
1316
- readonly harmonics: true;
1317
- readonly alternatingCurrent: false;
1318
- };
1319
- readonly component: false;
1320
- }, {
1321
- readonly flags: {
1322
- readonly powerQuality: true;
1323
- readonly alternatingCurrent: false;
1324
- };
1325
- readonly component: false;
1326
- }, {
1327
- readonly flags: {
1328
- readonly directCurrent: false;
1329
- readonly alternatingCurrent: false;
1330
- };
1331
- readonly component: false;
1332
- }];
1333
- };
1334
- /**
1335
- * @see {@link Cluster}
1336
- */
1337
- const ClusterInstance: MutableCluster.ExtensibleOnly<{
1338
- readonly id: 144;
1339
- readonly name: "ElectricalPowerMeasurement";
1340
- readonly revision: 1;
1341
- readonly features: {
1342
- /**
1343
- * DirectCurrent
1344
- *
1345
- * This feature indicates the cluster can measure a direct current.
1346
- *
1347
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.1
1348
- */
1349
- readonly directCurrent: BitFlag;
1350
- /**
1351
- * AlternatingCurrent
1352
- *
1353
- * This feature indicates the cluster can measure an alternating current.
1354
- *
1355
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.2
1356
- */
1357
- readonly alternatingCurrent: BitFlag;
1358
- /**
1359
- * PolyphasePower
1360
- *
1361
- * This feature indicates the cluster represents the collective measurements for a Polyphase power supply.
1362
- *
1363
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.3
1364
- */
1365
- readonly polyphasePower: BitFlag;
1366
- /**
1367
- * Harmonics
1368
- *
1369
- * This feature indicates the cluster can measure the harmonics of an alternating current.
1370
- *
1371
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.4
1372
- */
1373
- readonly harmonics: BitFlag;
1374
- /**
1375
- * PowerQuality
1376
- *
1377
- * This feature indicates the cluster can measure the harmonic phases of an alternating current.
1378
- *
1379
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.5
1380
- */
1381
- readonly powerQuality: BitFlag;
1382
- };
1383
- readonly attributes: {
1384
- /**
1385
- * This shall indicate the current mode of the server. For some servers, such as an EV, this may change
1386
- * depending on the mode of charging or discharging.
1387
- *
1388
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.1
1389
- */
1390
- readonly powerMode: Attribute<PowerMode, any>;
1391
- /**
1392
- * This shall indicate the maximum number of measurement types the server is capable of reporting.
1393
- *
1394
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.2
1395
- */
1396
- readonly numberOfMeasurementTypes: FixedAttribute<number, any>;
1397
- /**
1398
- * This shall indicate a list of accuracy specifications for the measurement types supported by the server.
1399
- * There shall be an entry for ActivePower, as well as any other measurement types implemented by this
1400
- * server.
1401
- *
1402
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.3
1403
- */
1404
- readonly accuracy: FixedAttribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1405
- measurementType: import("@project-chip/matter-node.js/tlv").FieldType<MeasurementType>;
1406
- measured: import("@project-chip/matter-node.js/tlv").FieldType<boolean>;
1407
- minMeasuredValue: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
1408
- maxMeasuredValue: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
1409
- accuracyRanges: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1410
- rangeMin: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
1411
- rangeMax: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
1412
- percentMax: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
1413
- percentMin: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
1414
- percentTypical: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
1415
- fixedMax: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
1416
- fixedMin: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
1417
- fixedTypical: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
1418
- }>[]>;
1419
- }>[], any>;
1420
- /**
1421
- * This shall indicate a list of measured ranges for different measurement types. Each measurement type
1422
- * shall have at most one entry in this list, representing the range of measurements in the most recent
1423
- * measurement period.
1424
- *
1425
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1426
- * publication of deltas considered not meaningful.
1427
- *
1428
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1429
- * recently than 1 second ago.
1430
- *
1431
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1432
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1433
- *
1434
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.4
1435
- */
1436
- readonly ranges: OptionalAttribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1437
- /**
1438
- * This field shall be the type of measurement for the range provided.
1439
- *
1440
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.1
1441
- */
1442
- measurementType: import("@project-chip/matter-node.js/tlv").FieldType<MeasurementType>;
1443
- /**
1444
- * This field shall be the smallest measured value for the associated measurement over either the period
1445
- * between StartTimestamp and EndTimestamp, or the period between StartSystime and EndSystime, or both.
1446
- *
1447
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.2
1448
- */
1449
- min: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
1450
- /**
1451
- * This field shall be the largest measured value for the associated measurement over the period between either
1452
- * StartTimestamp and EndTimestamp or the period between StartSystime and EndSystime, or both.
1453
- *
1454
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.3
1455
- */
1456
- max: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
1457
- /**
1458
- * This field shall be the timestamp in UTC of the beginning of the measurement period.
1459
- *
1460
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
1461
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
1462
- *
1463
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.4
1464
- */
1465
- startTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
1466
- /**
1467
- * This field shall be the timestamp in UTC of the end of the measurement period.
1468
- *
1469
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
1470
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
1471
- *
1472
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.5
1473
- */
1474
- endTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
1475
- /**
1476
- * This field shall be the most recent timestamp in UTC that the value in the Min field was measured.
1477
- *
1478
- * This field shall be greater than or equal to the value of the StartTimestamp field. This field shall be less
1479
- * than or equal to the value of the EndTimestamp field.
1480
- *
1481
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.6
1482
- */
1483
- minTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
1484
- /**
1485
- * This field shall be the most recent timestamp in UTC of the value in the Max field. This field shall be
1486
- * greater than or equal to the value of the StartTimestamp field. This field shall be less than or equal to
1487
- * the value of the EndTimestamp field.
1488
- *
1489
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.7
1490
- */
1491
- maxTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
1492
- /**
1493
- * This field shall be the time since boot of the beginning of the measurement period.
1494
- *
1495
- * If the server had determined the time in UTC at or before the start of the measurement period, this field
1496
- * may be omitted along with the EndSystime, MinSystime, and MaxSystime fields.
1497
- *
1498
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.8
1499
- */
1500
- startSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
1501
- /**
1502
- * This field shall be the time since boot of the end of the measurement period.
1503
- *
1504
- * If the server had determined the time in UTC at the end of the measurement period, this field may be omitted
1505
- * along with the StartSystime field, MinSystime, and MaxSystime fields.
1506
- *
1507
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.9
1508
- */
1509
- endSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
1510
- /**
1511
- * This field shall be the measurement time since boot of the value in the Min field was measured. This field
1512
- * shall be greater than or equal to the value of the StartSystime field.
1513
- *
1514
- * This field shall be less than or equal to the value of the EndSystime field.
1515
- *
1516
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.10
1517
- */
1518
- minSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
1519
- /**
1520
- * This field shall be the measurement time since boot of the value in the Max field. This field shall be
1521
- * greater than or equal to the value of the StartSystime field.
1522
- *
1523
- * This field shall be less than or equal to the value of the EndSystime field.
1524
- *
1525
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.11
1526
- */
1527
- maxSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
1528
- }>[], any>;
1529
- /**
1530
- * This shall indicate the most recent Voltage reading in millivolts (mV).
1531
- *
1532
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1533
- * publication of deltas considered not meaningful.
1534
- *
1535
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1536
- * recently than 1 second ago.
1537
- *
1538
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1539
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1540
- *
1541
- * If the voltage cannot be measured, a value of null shall be returned.
1542
- *
1543
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.5
1544
- */
1545
- readonly voltage: OptionalAttribute<number | bigint | null, any>;
1546
- /**
1547
- * This shall indicate the most recent ActiveCurrent reading in milliamps (mA).
1548
- *
1549
- * A positive value represents current flowing into the server, while a negative value represents current
1550
- * flowing out of the server.
1551
- *
1552
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1553
- * publication of deltas considered not meaningful.
1554
- *
1555
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1556
- * recently than 1 second ago.
1557
- *
1558
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1559
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1560
- *
1561
- * If the current cannot be measured, a value of null shall be returned.
1562
- *
1563
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.6
1564
- */
1565
- readonly activeCurrent: OptionalAttribute<number | bigint | null, any>;
1566
- /**
1567
- * This shall indicate the most recent ActivePower reading in milliwatts (mW). If the power cannot be
1568
- * measured, a value of null shall be returned.
1569
- *
1570
- * A positive value represents power imported, while a negative value represents power exported.
1571
- *
1572
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1573
- * publication of deltas considered not meaningful.
1574
- *
1575
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1576
- * recently than 1 second ago.
1577
- *
1578
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1579
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1580
- *
1581
- * If the Polyphase Power feature is set, this value represents the combined active power imported or
1582
- * exported.
1583
- *
1584
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.9
1585
- */
1586
- readonly activePower: Attribute<number | bigint | null, any>;
1587
- };
1588
- readonly events: {
1589
- /**
1590
- * If supported, this event shall be generated at the end of a measurement period. The start and end times
1591
- * for measurement periods shall be determined by the server, and may represent overlapping periods.
1592
- *
1593
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.7.1
1594
- */
1595
- readonly measurementPeriodRanges: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1596
- /**
1597
- * This shall indicate the value of the Ranges attribute at the time of event generation.
1598
- *
1599
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.7.1.1
1600
- */
1601
- ranges: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1602
- /**
1603
- * This field shall be the type of measurement for the range provided.
1604
- *
1605
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.1
1606
- */
1607
- measurementType: import("@project-chip/matter-node.js/tlv").FieldType<MeasurementType>;
1608
- /**
1609
- * This field shall be the smallest measured value for the associated measurement over either the period
1610
- * between StartTimestamp and EndTimestamp, or the period between StartSystime and EndSystime, or both.
1611
- *
1612
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.2
1613
- */
1614
- min: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
1615
- /**
1616
- * This field shall be the largest measured value for the associated measurement over the period between either
1617
- * StartTimestamp and EndTimestamp or the period between StartSystime and EndSystime, or both.
1618
- *
1619
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.3
1620
- */
1621
- max: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
1622
- /**
1623
- * This field shall be the timestamp in UTC of the beginning of the measurement period.
1624
- *
1625
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
1626
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
1627
- *
1628
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.4
1629
- */
1630
- startTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
1631
- /**
1632
- * This field shall be the timestamp in UTC of the end of the measurement period.
1633
- *
1634
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
1635
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
1636
- *
1637
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.5
1638
- */
1639
- endTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
1640
- /**
1641
- * This field shall be the most recent timestamp in UTC that the value in the Min field was measured.
1642
- *
1643
- * This field shall be greater than or equal to the value of the StartTimestamp field. This field shall be less
1644
- * than or equal to the value of the EndTimestamp field.
1645
- *
1646
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.6
1647
- */
1648
- minTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
1649
- /**
1650
- * This field shall be the most recent timestamp in UTC of the value in the Max field. This field shall be
1651
- * greater than or equal to the value of the StartTimestamp field. This field shall be less than or equal to
1652
- * the value of the EndTimestamp field.
1653
- *
1654
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.7
1655
- */
1656
- maxTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
1657
- /**
1658
- * This field shall be the time since boot of the beginning of the measurement period.
1659
- *
1660
- * If the server had determined the time in UTC at or before the start of the measurement period, this field
1661
- * may be omitted along with the EndSystime, MinSystime, and MaxSystime fields.
1662
- *
1663
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.8
1664
- */
1665
- startSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
1666
- /**
1667
- * This field shall be the time since boot of the end of the measurement period.
1668
- *
1669
- * If the server had determined the time in UTC at the end of the measurement period, this field may be omitted
1670
- * along with the StartSystime field, MinSystime, and MaxSystime fields.
1671
- *
1672
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.9
1673
- */
1674
- endSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
1675
- /**
1676
- * This field shall be the measurement time since boot of the value in the Min field was measured. This field
1677
- * shall be greater than or equal to the value of the StartSystime field.
1678
- *
1679
- * This field shall be less than or equal to the value of the EndSystime field.
1680
- *
1681
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.10
1682
- */
1683
- minSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
1684
- /**
1685
- * This field shall be the measurement time since boot of the value in the Max field. This field shall be
1686
- * greater than or equal to the value of the StartSystime field.
1687
- *
1688
- * This field shall be less than or equal to the value of the EndSystime field.
1689
- *
1690
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.11
1691
- */
1692
- maxSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
1693
- }>[]>;
1694
- }>, any>;
1695
- };
1696
- /**
1697
- * This metadata controls which ElectricalPowerMeasurementCluster elements matter.js activates for specific
1698
- * feature combinations.
1699
- */
1700
- readonly extensions: readonly [{
1701
- readonly flags: {
1702
- readonly alternatingCurrent: true;
1703
- };
1704
- readonly component: {
1705
- readonly attributes: {
1706
- /**
1707
- * This shall indicate the most recent ReactiveCurrent reading in milliamps (mA).
1708
- *
1709
- * A positive value represents current flowing into the server, while a negative value represents current
1710
- * flowing out of the server.
1711
- *
1712
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1713
- * publication of deltas considered not meaningful.
1714
- *
1715
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1716
- * recently than 1 second ago.
1717
- *
1718
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1719
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1720
- *
1721
- * If the current cannot be measured, a value of null shall be returned.
1722
- *
1723
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.7
1724
- */
1725
- readonly reactiveCurrent: OptionalAttribute<number | bigint | null, any>;
1726
- /**
1727
- * This shall indicate the most recent ApparentCurrent (square root sum of the squares of active and
1728
- * reactive currents) reading in milliamps (mA).
1729
- *
1730
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1731
- * publication of deltas considered not meaningful.
1732
- *
1733
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1734
- * recently than 1 second ago.
1735
- *
1736
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1737
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1738
- *
1739
- * If the active or reactive currents cannot be measured, a value of null shall be returned.
1740
- *
1741
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.8
1742
- */
1743
- readonly apparentCurrent: OptionalAttribute<number | bigint | null, any>;
1744
- /**
1745
- * This shall indicate the most recent ReactivePower reading in millivolt-amps reactive (mVAR). A positive
1746
- * value represents power imported, while a negative value represents power exported.
1747
- *
1748
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1749
- * publication of deltas considered not meaningful.
1750
- *
1751
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1752
- * recently than 1 second ago.
1753
- *
1754
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1755
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1756
- *
1757
- * If the reactive power cannot be measured, a value of null shall be returned.
1758
- *
1759
- * If the Polyphase Power feature is supported, this value represents the combined reactive power imported
1760
- * or exported.
1761
- *
1762
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.10
1763
- */
1764
- readonly reactivePower: OptionalAttribute<number | bigint | null, any>;
1765
- /**
1766
- * This shall indicate the most recent ApparentPower reading in millivolt-amps (mVA).
1767
- *
1768
- * A positive value represents power imported, while a negative value represents power exported.
1769
- *
1770
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1771
- * publication of deltas considered not meaningful.
1772
- *
1773
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1774
- * recently than 1 second ago.
1775
- *
1776
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1777
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1778
- *
1779
- * If the apparent power cannot be measured, a value of null shall be returned.
1780
- *
1781
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.11
1782
- */
1783
- readonly apparentPower: OptionalAttribute<number | bigint | null, any>;
1784
- /**
1785
- * This shall indicate the most recent RMSVoltage reading in millivolts (mV).
1786
- *
1787
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1788
- * publication of deltas considered not meaningful.
1789
- *
1790
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1791
- * recently than 1 second ago.
1792
- *
1793
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1794
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1795
- *
1796
- * If the RMS voltage cannot be measured, a value of null shall be returned.
1797
- *
1798
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.12
1799
- */
1800
- readonly rmsVoltage: OptionalAttribute<number | bigint | null, any>;
1801
- /**
1802
- * This shall indicate the most recent RMSCurrent reading in milliamps (mA).
1803
- *
1804
- * A positive value represents current flowing into the server, while a negative value represents current
1805
- * flowing out of the server.
1806
- *
1807
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1808
- * publication of deltas considered not meaningful.
1809
- *
1810
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1811
- * recently than 1 second ago.
1812
- *
1813
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1814
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1815
- *
1816
- * If the RMS current cannot be measured, a value of null shall be returned.
1817
- *
1818
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.13
1819
- */
1820
- readonly rmsCurrent: OptionalAttribute<number | bigint | null, any>;
1821
- /**
1822
- * This shall indicate the most recent RMSPower reading in milliwatts (mW).
1823
- *
1824
- * A positive value represents power imported, while a negative value represents power exported.
1825
- *
1826
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1827
- * publication of deltas considered not meaningful.
1828
- *
1829
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1830
- * recently than 1 second ago.
1831
- *
1832
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1833
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1834
- *
1835
- * If the RMS power cannot be measured, a value of null shall be returned.
1836
- *
1837
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.14
1838
- */
1839
- readonly rmsPower: OptionalAttribute<number | bigint | null, any>;
1840
- /**
1841
- * This shall indicate the most recent Frequency reading in millihertz (mHz).
1842
- *
1843
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1844
- * publication of deltas considered not meaningful.
1845
- *
1846
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1847
- * recently than 1 second ago.
1848
- *
1849
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1850
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1851
- *
1852
- * If the frequency cannot be measured, a value of null shall be returned.
1853
- *
1854
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.15
1855
- */
1856
- readonly frequency: OptionalAttribute<number | bigint | null, any>;
1857
- /**
1858
- * This shall indicate the Power Factor ratio in +/- 1/100ths of a percent.
1859
- *
1860
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1861
- * publication of deltas considered not meaningful.
1862
- *
1863
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1864
- * recently than 1 second ago.
1865
- *
1866
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1867
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1868
- *
1869
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.18
1870
- */
1871
- readonly powerFactor: OptionalAttribute<number | bigint | null, any>;
1872
- };
1873
- };
1874
- }, {
1875
- readonly flags: {
1876
- readonly harmonics: true;
1877
- };
1878
- readonly component: {
1879
- readonly attributes: {
1880
- /**
1881
- * This shall indicate a list of HarmonicMeasurementStruct values, with each HarmonicMeasurementStruct
1882
- * representing the harmonic current reading for the harmonic order specified by Order.
1883
- *
1884
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1885
- * publication of deltas considered not meaningful.
1886
- *
1887
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1888
- * recently than 1 second ago.
1889
- *
1890
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1891
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1892
- *
1893
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.16
1894
- */
1895
- readonly harmonicCurrents: Attribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1896
- /**
1897
- * This field shall be the order of the harmonic being measured. Typically this is an odd number, but servers
1898
- * may choose to report even harmonics.
1899
- *
1900
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.1
1901
- */
1902
- order: import("@project-chip/matter-node.js/tlv").FieldType<number>;
1903
- /**
1904
- * This field shall be the measured value for the given harmonic order.
1905
- *
1906
- * For the Harmonic Currents attribute, this value is the most recently measured harmonic current reading in
1907
- * milliamps (mA). A positive value indicates that the measured harmonic current is positive, and a negative
1908
- * value indicates that the measured harmonic current is negative.
1909
- *
1910
- * For the Harmonic Phases attribute, this value is the most recent phase of the given harmonic order
1911
- *
1912
- * in millidegrees (mDeg). A positive value indicates that the measured phase is leading, and a negative value
1913
- * indicates that the measured phase is lagging.
1914
- *
1915
- * If this measurement is not currently available, a value of null shall be returned.
1916
- *
1917
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.2
1918
- */
1919
- measurement: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint | null>;
1920
- }>[] | null, any>;
1921
- };
1922
- };
1923
- }, {
1924
- readonly flags: {
1925
- readonly powerQuality: true;
1926
- };
1927
- readonly component: {
1928
- readonly attributes: {
1929
- /**
1930
- * This shall indicate a list of HarmonicMeasurementStruct values, with each HarmonicMeasurementStruct
1931
- * representing the most recent phase of the harmonic current reading for the harmonic
1932
- *
1933
- * order specified by Order.
1934
- *
1935
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1936
- * publication of deltas considered not meaningful.
1937
- *
1938
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1939
- * recently than 1 second ago.
1940
- *
1941
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1942
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1943
- *
1944
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.17
1945
- */
1946
- readonly harmonicPhases: Attribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
1947
- /**
1948
- * This field shall be the order of the harmonic being measured. Typically this is an odd number, but servers
1949
- * may choose to report even harmonics.
1950
- *
1951
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.1
1952
- */
1953
- order: import("@project-chip/matter-node.js/tlv").FieldType<number>;
1954
- /**
1955
- * This field shall be the measured value for the given harmonic order.
1956
- *
1957
- * For the Harmonic Currents attribute, this value is the most recently measured harmonic current reading in
1958
- * milliamps (mA). A positive value indicates that the measured harmonic current is positive, and a negative
1959
- * value indicates that the measured harmonic current is negative.
1960
- *
1961
- * For the Harmonic Phases attribute, this value is the most recent phase of the given harmonic order
1962
- *
1963
- * in millidegrees (mDeg). A positive value indicates that the measured phase is leading, and a negative value
1964
- * indicates that the measured phase is lagging.
1965
- *
1966
- * If this measurement is not currently available, a value of null shall be returned.
1967
- *
1968
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.2
1969
- */
1970
- measurement: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint | null>;
1971
- }>[] | null, any>;
1972
- };
1973
- };
1974
- }, {
1975
- readonly flags: {
1976
- readonly polyphasePower: true;
1977
- };
1978
- readonly component: {
1979
- readonly attributes: {
1980
- /**
1981
- * This shall indicate the most recent NeutralCurrent reading in milliamps (mA). Typically this is a
1982
- * derived value, taking the magnitude of the vector sum of phase currents.
1983
- *
1984
- * If the neutral current cannot be measured or derived, a value of null shall be returned.
1985
- *
1986
- * A positive value represents an imbalance between the phase currents when power is imported. A negative
1987
- * value represents an imbalance between the phase currents when power is exported.
1988
- *
1989
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
1990
- * publication of deltas considered not meaningful.
1991
- *
1992
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
1993
- * recently than 1 second ago.
1994
- *
1995
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
1996
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
1997
- *
1998
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.19
1999
- */
2000
- readonly neutralCurrent: OptionalAttribute<number | bigint | null, any>;
2001
- };
2002
- };
2003
- }, {
2004
- readonly flags: {
2005
- readonly polyphasePower: true;
2006
- readonly alternatingCurrent: false;
2007
- };
2008
- readonly component: false;
2009
- }, {
2010
- readonly flags: {
2011
- readonly harmonics: true;
2012
- readonly alternatingCurrent: false;
2013
- };
2014
- readonly component: false;
2015
- }, {
2016
- readonly flags: {
2017
- readonly powerQuality: true;
2018
- readonly alternatingCurrent: false;
2019
- };
2020
- readonly component: false;
2021
- }, {
2022
- readonly flags: {
2023
- readonly directCurrent: false;
2024
- readonly alternatingCurrent: false;
2025
- };
2026
- readonly component: false;
2027
- }];
2028
- }>;
2029
- /**
2030
- * This cluster provides a mechanism for querying data about electrical power as measured by the server.
2031
- *
2032
- * Per the Matter specification you cannot use {@link ElectricalPowerMeasurementCluster} without enabling certain
2033
- * feature combinations. You must use the {@link with} factory method to obtain a working cluster.
2034
- *
2035
- * @see {@link MatterSpecification.v13.Cluster} § 2.13
2036
- */
2037
- type Cluster = Identity<typeof ClusterInstance>;
2038
- const Cluster: Cluster;
2039
- /**
2040
- * @see {@link Complete}
2041
- */
2042
- const CompleteInstance: MutableCluster<{
2043
- readonly id: 144;
2044
- readonly name: "ElectricalPowerMeasurement";
2045
- readonly revision: 1;
2046
- readonly features: {
2047
- /**
2048
- * DirectCurrent
2049
- *
2050
- * This feature indicates the cluster can measure a direct current.
2051
- *
2052
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.1
2053
- */
2054
- readonly directCurrent: BitFlag;
2055
- /**
2056
- * AlternatingCurrent
2057
- *
2058
- * This feature indicates the cluster can measure an alternating current.
2059
- *
2060
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.2
2061
- */
2062
- readonly alternatingCurrent: BitFlag;
2063
- /**
2064
- * PolyphasePower
2065
- *
2066
- * This feature indicates the cluster represents the collective measurements for a Polyphase power supply.
2067
- *
2068
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.3
2069
- */
2070
- readonly polyphasePower: BitFlag;
2071
- /**
2072
- * Harmonics
2073
- *
2074
- * This feature indicates the cluster can measure the harmonics of an alternating current.
2075
- *
2076
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.4
2077
- */
2078
- readonly harmonics: BitFlag;
2079
- /**
2080
- * PowerQuality
2081
- *
2082
- * This feature indicates the cluster can measure the harmonic phases of an alternating current.
2083
- *
2084
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.5
2085
- */
2086
- readonly powerQuality: BitFlag;
2087
- };
2088
- readonly attributes: {
2089
- readonly reactiveCurrent: OptionalAttribute<number | bigint | null, any> & {
2090
- readonly optional: true;
2091
- readonly isConditional: true;
2092
- readonly optionalIf: [] | [{
2093
- alternatingCurrent: boolean;
2094
- }];
2095
- readonly mandatoryIf: [] | import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema>;
2096
- };
2097
- readonly apparentCurrent: OptionalAttribute<number | bigint | null, any> & {
2098
- readonly optional: true;
2099
- readonly isConditional: true;
2100
- readonly optionalIf: [] | [{
2101
- alternatingCurrent: boolean;
2102
- }];
2103
- readonly mandatoryIf: [] | import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema>;
2104
- };
2105
- readonly reactivePower: OptionalAttribute<number | bigint | null, any> & {
2106
- readonly optional: true;
2107
- readonly isConditional: true;
2108
- readonly optionalIf: [] | [{
2109
- alternatingCurrent: boolean;
2110
- }];
2111
- readonly mandatoryIf: [] | import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema>;
2112
- };
2113
- readonly apparentPower: OptionalAttribute<number | bigint | null, any> & {
2114
- readonly optional: true;
2115
- readonly isConditional: true;
2116
- readonly optionalIf: [] | [{
2117
- alternatingCurrent: boolean;
2118
- }];
2119
- readonly mandatoryIf: [] | import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema>;
2120
- };
2121
- readonly rmsVoltage: OptionalAttribute<number | bigint | null, any> & {
2122
- readonly optional: true;
2123
- readonly isConditional: true;
2124
- readonly optionalIf: [] | [{
2125
- alternatingCurrent: boolean;
2126
- }];
2127
- readonly mandatoryIf: [] | import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema>;
2128
- };
2129
- readonly rmsCurrent: OptionalAttribute<number | bigint | null, any> & {
2130
- readonly optional: true;
2131
- readonly isConditional: true;
2132
- readonly optionalIf: [] | [{
2133
- alternatingCurrent: boolean;
2134
- }];
2135
- readonly mandatoryIf: [] | import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema>;
2136
- };
2137
- readonly rmsPower: OptionalAttribute<number | bigint | null, any> & {
2138
- readonly optional: true;
2139
- readonly isConditional: true;
2140
- readonly optionalIf: [] | [{
2141
- alternatingCurrent: boolean;
2142
- }];
2143
- readonly mandatoryIf: [] | import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema>;
2144
- };
2145
- readonly frequency: OptionalAttribute<number | bigint | null, any> & {
2146
- readonly optional: true;
2147
- readonly isConditional: true;
2148
- readonly optionalIf: [] | [{
2149
- alternatingCurrent: boolean;
2150
- }];
2151
- readonly mandatoryIf: [] | import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema>;
2152
- };
2153
- readonly harmonicCurrents: Attribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2154
- /**
2155
- * This field shall be the order of the harmonic being measured. Typically this is an odd number, but servers
2156
- * may choose to report even harmonics.
2157
- *
2158
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.1
2159
- */
2160
- order: import("@project-chip/matter-node.js/tlv").FieldType<number>;
2161
- /**
2162
- * This field shall be the measured value for the given harmonic order.
2163
- *
2164
- * For the Harmonic Currents attribute, this value is the most recently measured harmonic current reading in
2165
- * milliamps (mA). A positive value indicates that the measured harmonic current is positive, and a negative
2166
- * value indicates that the measured harmonic current is negative.
2167
- *
2168
- * For the Harmonic Phases attribute, this value is the most recent phase of the given harmonic order
2169
- *
2170
- * in millidegrees (mDeg). A positive value indicates that the measured phase is leading, and a negative value
2171
- * indicates that the measured phase is lagging.
2172
- *
2173
- * If this measurement is not currently available, a value of null shall be returned.
2174
- *
2175
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.2
2176
- */
2177
- measurement: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint | null>;
2178
- }>[] | null, any> & {
2179
- readonly optional: true;
2180
- readonly isConditional: true;
2181
- readonly optionalIf: [] | import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema>;
2182
- readonly mandatoryIf: [] | [{
2183
- harmonics: boolean;
2184
- }];
2185
- };
2186
- readonly harmonicPhases: Attribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2187
- /**
2188
- * This field shall be the order of the harmonic being measured. Typically this is an odd number, but servers
2189
- * may choose to report even harmonics.
2190
- *
2191
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.1
2192
- */
2193
- order: import("@project-chip/matter-node.js/tlv").FieldType<number>;
2194
- /**
2195
- * This field shall be the measured value for the given harmonic order.
2196
- *
2197
- * For the Harmonic Currents attribute, this value is the most recently measured harmonic current reading in
2198
- * milliamps (mA). A positive value indicates that the measured harmonic current is positive, and a negative
2199
- * value indicates that the measured harmonic current is negative.
2200
- *
2201
- * For the Harmonic Phases attribute, this value is the most recent phase of the given harmonic order
2202
- *
2203
- * in millidegrees (mDeg). A positive value indicates that the measured phase is leading, and a negative value
2204
- * indicates that the measured phase is lagging.
2205
- *
2206
- * If this measurement is not currently available, a value of null shall be returned.
2207
- *
2208
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.2
2209
- */
2210
- measurement: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint | null>;
2211
- }>[] | null, any> & {
2212
- readonly optional: true;
2213
- readonly isConditional: true;
2214
- readonly optionalIf: [] | import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema>;
2215
- readonly mandatoryIf: [] | [{
2216
- powerQuality: boolean;
2217
- }];
2218
- };
2219
- readonly powerFactor: OptionalAttribute<number | bigint | null, any> & {
2220
- readonly optional: true;
2221
- readonly isConditional: true;
2222
- readonly optionalIf: [] | [{
2223
- alternatingCurrent: boolean;
2224
- }];
2225
- readonly mandatoryIf: [] | import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema>;
2226
- };
2227
- readonly neutralCurrent: OptionalAttribute<number | bigint | null, any> & {
2228
- readonly optional: true;
2229
- readonly isConditional: true;
2230
- readonly optionalIf: [] | [{
2231
- polyphasePower: boolean;
2232
- }];
2233
- readonly mandatoryIf: [] | import("@project-chip/matter-node.js/cluster").ConditionalFeatureList<import("@project-chip/matter-node.js/schema").BitSchema>;
2234
- };
2235
- /**
2236
- * This shall indicate the current mode of the server. For some servers, such as an EV, this may change
2237
- * depending on the mode of charging or discharging.
2238
- *
2239
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.1
2240
- */
2241
- readonly powerMode: Attribute<PowerMode, any>;
2242
- /**
2243
- * This shall indicate the maximum number of measurement types the server is capable of reporting.
2244
- *
2245
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.2
2246
- */
2247
- readonly numberOfMeasurementTypes: FixedAttribute<number, any>;
2248
- /**
2249
- * This shall indicate a list of accuracy specifications for the measurement types supported by the server.
2250
- * There shall be an entry for ActivePower, as well as any other measurement types implemented by this
2251
- * server.
2252
- *
2253
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.3
2254
- */
2255
- readonly accuracy: FixedAttribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2256
- measurementType: import("@project-chip/matter-node.js/tlv").FieldType<MeasurementType>;
2257
- measured: import("@project-chip/matter-node.js/tlv").FieldType<boolean>;
2258
- minMeasuredValue: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2259
- maxMeasuredValue: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2260
- accuracyRanges: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2261
- rangeMin: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2262
- rangeMax: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2263
- percentMax: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2264
- percentMin: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2265
- percentTypical: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2266
- fixedMax: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2267
- fixedMin: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2268
- fixedTypical: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2269
- }>[]>;
2270
- }>[], any>;
2271
- /**
2272
- * This shall indicate a list of measured ranges for different measurement types. Each measurement type
2273
- * shall have at most one entry in this list, representing the range of measurements in the most recent
2274
- * measurement period.
2275
- *
2276
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
2277
- * publication of deltas considered not meaningful.
2278
- *
2279
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
2280
- * recently than 1 second ago.
2281
- *
2282
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
2283
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
2284
- *
2285
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.4
2286
- */
2287
- readonly ranges: OptionalAttribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2288
- /**
2289
- * This field shall be the type of measurement for the range provided.
2290
- *
2291
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.1
2292
- */
2293
- measurementType: import("@project-chip/matter-node.js/tlv").FieldType<MeasurementType>;
2294
- /**
2295
- * This field shall be the smallest measured value for the associated measurement over either the period
2296
- * between StartTimestamp and EndTimestamp, or the period between StartSystime and EndSystime, or both.
2297
- *
2298
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.2
2299
- */
2300
- min: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2301
- /**
2302
- * This field shall be the largest measured value for the associated measurement over the period between either
2303
- * StartTimestamp and EndTimestamp or the period between StartSystime and EndSystime, or both.
2304
- *
2305
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.3
2306
- */
2307
- max: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2308
- /**
2309
- * This field shall be the timestamp in UTC of the beginning of the measurement period.
2310
- *
2311
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
2312
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
2313
- *
2314
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.4
2315
- */
2316
- startTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2317
- /**
2318
- * This field shall be the timestamp in UTC of the end of the measurement period.
2319
- *
2320
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
2321
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
2322
- *
2323
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.5
2324
- */
2325
- endTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2326
- /**
2327
- * This field shall be the most recent timestamp in UTC that the value in the Min field was measured.
2328
- *
2329
- * This field shall be greater than or equal to the value of the StartTimestamp field. This field shall be less
2330
- * than or equal to the value of the EndTimestamp field.
2331
- *
2332
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.6
2333
- */
2334
- minTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2335
- /**
2336
- * This field shall be the most recent timestamp in UTC of the value in the Max field. This field shall be
2337
- * greater than or equal to the value of the StartTimestamp field. This field shall be less than or equal to
2338
- * the value of the EndTimestamp field.
2339
- *
2340
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.7
2341
- */
2342
- maxTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2343
- /**
2344
- * This field shall be the time since boot of the beginning of the measurement period.
2345
- *
2346
- * If the server had determined the time in UTC at or before the start of the measurement period, this field
2347
- * may be omitted along with the EndSystime, MinSystime, and MaxSystime fields.
2348
- *
2349
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.8
2350
- */
2351
- startSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2352
- /**
2353
- * This field shall be the time since boot of the end of the measurement period.
2354
- *
2355
- * If the server had determined the time in UTC at the end of the measurement period, this field may be omitted
2356
- * along with the StartSystime field, MinSystime, and MaxSystime fields.
2357
- *
2358
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.9
2359
- */
2360
- endSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2361
- /**
2362
- * This field shall be the measurement time since boot of the value in the Min field was measured. This field
2363
- * shall be greater than or equal to the value of the StartSystime field.
2364
- *
2365
- * This field shall be less than or equal to the value of the EndSystime field.
2366
- *
2367
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.10
2368
- */
2369
- minSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2370
- /**
2371
- * This field shall be the measurement time since boot of the value in the Max field. This field shall be
2372
- * greater than or equal to the value of the StartSystime field.
2373
- *
2374
- * This field shall be less than or equal to the value of the EndSystime field.
2375
- *
2376
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.11
2377
- */
2378
- maxSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2379
- }>[], any>;
2380
- /**
2381
- * This shall indicate the most recent Voltage reading in millivolts (mV).
2382
- *
2383
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
2384
- * publication of deltas considered not meaningful.
2385
- *
2386
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
2387
- * recently than 1 second ago.
2388
- *
2389
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
2390
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
2391
- *
2392
- * If the voltage cannot be measured, a value of null shall be returned.
2393
- *
2394
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.5
2395
- */
2396
- readonly voltage: OptionalAttribute<number | bigint | null, any>;
2397
- /**
2398
- * This shall indicate the most recent ActiveCurrent reading in milliamps (mA).
2399
- *
2400
- * A positive value represents current flowing into the server, while a negative value represents current
2401
- * flowing out of the server.
2402
- *
2403
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
2404
- * publication of deltas considered not meaningful.
2405
- *
2406
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
2407
- * recently than 1 second ago.
2408
- *
2409
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
2410
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
2411
- *
2412
- * If the current cannot be measured, a value of null shall be returned.
2413
- *
2414
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.6
2415
- */
2416
- readonly activeCurrent: OptionalAttribute<number | bigint | null, any>;
2417
- /**
2418
- * This shall indicate the most recent ActivePower reading in milliwatts (mW). If the power cannot be
2419
- * measured, a value of null shall be returned.
2420
- *
2421
- * A positive value represents power imported, while a negative value represents power exported.
2422
- *
2423
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
2424
- * publication of deltas considered not meaningful.
2425
- *
2426
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
2427
- * recently than 1 second ago.
2428
- *
2429
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
2430
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
2431
- *
2432
- * If the Polyphase Power feature is set, this value represents the combined active power imported or
2433
- * exported.
2434
- *
2435
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.9
2436
- */
2437
- readonly activePower: Attribute<number | bigint | null, any>;
2438
- };
2439
- readonly events: {
2440
- /**
2441
- * If supported, this event shall be generated at the end of a measurement period. The start and end times
2442
- * for measurement periods shall be determined by the server, and may represent overlapping periods.
2443
- *
2444
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.7.1
2445
- */
2446
- readonly measurementPeriodRanges: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2447
- /**
2448
- * This shall indicate the value of the Ranges attribute at the time of event generation.
2449
- *
2450
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.7.1.1
2451
- */
2452
- ranges: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2453
- /**
2454
- * This field shall be the type of measurement for the range provided.
2455
- *
2456
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.1
2457
- */
2458
- measurementType: import("@project-chip/matter-node.js/tlv").FieldType<MeasurementType>;
2459
- /**
2460
- * This field shall be the smallest measured value for the associated measurement over either the period
2461
- * between StartTimestamp and EndTimestamp, or the period between StartSystime and EndSystime, or both.
2462
- *
2463
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.2
2464
- */
2465
- min: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2466
- /**
2467
- * This field shall be the largest measured value for the associated measurement over the period between either
2468
- * StartTimestamp and EndTimestamp or the period between StartSystime and EndSystime, or both.
2469
- *
2470
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.3
2471
- */
2472
- max: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2473
- /**
2474
- * This field shall be the timestamp in UTC of the beginning of the measurement period.
2475
- *
2476
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
2477
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
2478
- *
2479
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.4
2480
- */
2481
- startTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2482
- /**
2483
- * This field shall be the timestamp in UTC of the end of the measurement period.
2484
- *
2485
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
2486
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
2487
- *
2488
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.5
2489
- */
2490
- endTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2491
- /**
2492
- * This field shall be the most recent timestamp in UTC that the value in the Min field was measured.
2493
- *
2494
- * This field shall be greater than or equal to the value of the StartTimestamp field. This field shall be less
2495
- * than or equal to the value of the EndTimestamp field.
2496
- *
2497
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.6
2498
- */
2499
- minTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2500
- /**
2501
- * This field shall be the most recent timestamp in UTC of the value in the Max field. This field shall be
2502
- * greater than or equal to the value of the StartTimestamp field. This field shall be less than or equal to
2503
- * the value of the EndTimestamp field.
2504
- *
2505
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.7
2506
- */
2507
- maxTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2508
- /**
2509
- * This field shall be the time since boot of the beginning of the measurement period.
2510
- *
2511
- * If the server had determined the time in UTC at or before the start of the measurement period, this field
2512
- * may be omitted along with the EndSystime, MinSystime, and MaxSystime fields.
2513
- *
2514
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.8
2515
- */
2516
- startSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2517
- /**
2518
- * This field shall be the time since boot of the end of the measurement period.
2519
- *
2520
- * If the server had determined the time in UTC at the end of the measurement period, this field may be omitted
2521
- * along with the StartSystime field, MinSystime, and MaxSystime fields.
2522
- *
2523
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.9
2524
- */
2525
- endSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2526
- /**
2527
- * This field shall be the measurement time since boot of the value in the Min field was measured. This field
2528
- * shall be greater than or equal to the value of the StartSystime field.
2529
- *
2530
- * This field shall be less than or equal to the value of the EndSystime field.
2531
- *
2532
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.10
2533
- */
2534
- minSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2535
- /**
2536
- * This field shall be the measurement time since boot of the value in the Max field. This field shall be
2537
- * greater than or equal to the value of the StartSystime field.
2538
- *
2539
- * This field shall be less than or equal to the value of the EndSystime field.
2540
- *
2541
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.11
2542
- */
2543
- maxSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2544
- }>[]>;
2545
- }>, any>;
2546
- };
2547
- }, []>;
2548
- /**
2549
- * This cluster supports all ElectricalPowerMeasurement features. It may support illegal feature combinations.
2550
- *
2551
- * If you use this cluster you must manually specify which features are active and ensure the set of active
2552
- * features is legal per the Matter specification.
2553
- */
2554
- type Complete = Identity<typeof CompleteInstance>;
2555
- const Complete: Complete;
2556
- }
2557
- export type ElectricalPowerMeasurementCluster = ElectricalPowerMeasurement.Cluster;
2558
- export declare const ElectricalPowerMeasurementCluster: MutableCluster.ExtensibleOnly<{
2559
- readonly id: 144;
2560
- readonly name: "ElectricalPowerMeasurement";
2561
- readonly revision: 1;
2562
- readonly features: {
2563
- /**
2564
- * DirectCurrent
2565
- *
2566
- * This feature indicates the cluster can measure a direct current.
2567
- *
2568
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.1
2569
- */
2570
- readonly directCurrent: BitFlag;
2571
- /**
2572
- * AlternatingCurrent
2573
- *
2574
- * This feature indicates the cluster can measure an alternating current.
2575
- *
2576
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.2
2577
- */
2578
- readonly alternatingCurrent: BitFlag;
2579
- /**
2580
- * PolyphasePower
2581
- *
2582
- * This feature indicates the cluster represents the collective measurements for a Polyphase power supply.
2583
- *
2584
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.3
2585
- */
2586
- readonly polyphasePower: BitFlag;
2587
- /**
2588
- * Harmonics
2589
- *
2590
- * This feature indicates the cluster can measure the harmonics of an alternating current.
2591
- *
2592
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.4
2593
- */
2594
- readonly harmonics: BitFlag;
2595
- /**
2596
- * PowerQuality
2597
- *
2598
- * This feature indicates the cluster can measure the harmonic phases of an alternating current.
2599
- *
2600
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.4.5
2601
- */
2602
- readonly powerQuality: BitFlag;
2603
- };
2604
- readonly attributes: {
2605
- /**
2606
- * This shall indicate the current mode of the server. For some servers, such as an EV, this may change
2607
- * depending on the mode of charging or discharging.
2608
- *
2609
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.1
2610
- */
2611
- readonly powerMode: Attribute<ElectricalPowerMeasurement.PowerMode, any>;
2612
- /**
2613
- * This shall indicate the maximum number of measurement types the server is capable of reporting.
2614
- *
2615
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.2
2616
- */
2617
- readonly numberOfMeasurementTypes: FixedAttribute<number, any>;
2618
- /**
2619
- * This shall indicate a list of accuracy specifications for the measurement types supported by the server.
2620
- * There shall be an entry for ActivePower, as well as any other measurement types implemented by this
2621
- * server.
2622
- *
2623
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.3
2624
- */
2625
- readonly accuracy: FixedAttribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2626
- measurementType: import("@project-chip/matter-node.js/tlv").FieldType<MeasurementType>;
2627
- measured: import("@project-chip/matter-node.js/tlv").FieldType<boolean>;
2628
- minMeasuredValue: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2629
- maxMeasuredValue: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2630
- accuracyRanges: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2631
- rangeMin: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2632
- rangeMax: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2633
- percentMax: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2634
- percentMin: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2635
- percentTypical: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2636
- fixedMax: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2637
- fixedMin: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2638
- fixedTypical: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2639
- }>[]>;
2640
- }>[], any>;
2641
- /**
2642
- * This shall indicate a list of measured ranges for different measurement types. Each measurement type
2643
- * shall have at most one entry in this list, representing the range of measurements in the most recent
2644
- * measurement period.
2645
- *
2646
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
2647
- * publication of deltas considered not meaningful.
2648
- *
2649
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
2650
- * recently than 1 second ago.
2651
- *
2652
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
2653
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
2654
- *
2655
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.4
2656
- */
2657
- readonly ranges: OptionalAttribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2658
- /**
2659
- * This field shall be the type of measurement for the range provided.
2660
- *
2661
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.1
2662
- */
2663
- measurementType: import("@project-chip/matter-node.js/tlv").FieldType<MeasurementType>;
2664
- /**
2665
- * This field shall be the smallest measured value for the associated measurement over either the period
2666
- * between StartTimestamp and EndTimestamp, or the period between StartSystime and EndSystime, or both.
2667
- *
2668
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.2
2669
- */
2670
- min: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2671
- /**
2672
- * This field shall be the largest measured value for the associated measurement over the period between either
2673
- * StartTimestamp and EndTimestamp or the period between StartSystime and EndSystime, or both.
2674
- *
2675
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.3
2676
- */
2677
- max: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2678
- /**
2679
- * This field shall be the timestamp in UTC of the beginning of the measurement period.
2680
- *
2681
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
2682
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
2683
- *
2684
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.4
2685
- */
2686
- startTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2687
- /**
2688
- * This field shall be the timestamp in UTC of the end of the measurement period.
2689
- *
2690
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
2691
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
2692
- *
2693
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.5
2694
- */
2695
- endTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2696
- /**
2697
- * This field shall be the most recent timestamp in UTC that the value in the Min field was measured.
2698
- *
2699
- * This field shall be greater than or equal to the value of the StartTimestamp field. This field shall be less
2700
- * than or equal to the value of the EndTimestamp field.
2701
- *
2702
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.6
2703
- */
2704
- minTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2705
- /**
2706
- * This field shall be the most recent timestamp in UTC of the value in the Max field. This field shall be
2707
- * greater than or equal to the value of the StartTimestamp field. This field shall be less than or equal to
2708
- * the value of the EndTimestamp field.
2709
- *
2710
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.7
2711
- */
2712
- maxTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2713
- /**
2714
- * This field shall be the time since boot of the beginning of the measurement period.
2715
- *
2716
- * If the server had determined the time in UTC at or before the start of the measurement period, this field
2717
- * may be omitted along with the EndSystime, MinSystime, and MaxSystime fields.
2718
- *
2719
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.8
2720
- */
2721
- startSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2722
- /**
2723
- * This field shall be the time since boot of the end of the measurement period.
2724
- *
2725
- * If the server had determined the time in UTC at the end of the measurement period, this field may be omitted
2726
- * along with the StartSystime field, MinSystime, and MaxSystime fields.
2727
- *
2728
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.9
2729
- */
2730
- endSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2731
- /**
2732
- * This field shall be the measurement time since boot of the value in the Min field was measured. This field
2733
- * shall be greater than or equal to the value of the StartSystime field.
2734
- *
2735
- * This field shall be less than or equal to the value of the EndSystime field.
2736
- *
2737
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.10
2738
- */
2739
- minSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2740
- /**
2741
- * This field shall be the measurement time since boot of the value in the Max field. This field shall be
2742
- * greater than or equal to the value of the StartSystime field.
2743
- *
2744
- * This field shall be less than or equal to the value of the EndSystime field.
2745
- *
2746
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.11
2747
- */
2748
- maxSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2749
- }>[], any>;
2750
- /**
2751
- * This shall indicate the most recent Voltage reading in millivolts (mV).
2752
- *
2753
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
2754
- * publication of deltas considered not meaningful.
2755
- *
2756
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
2757
- * recently than 1 second ago.
2758
- *
2759
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
2760
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
2761
- *
2762
- * If the voltage cannot be measured, a value of null shall be returned.
2763
- *
2764
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.5
2765
- */
2766
- readonly voltage: OptionalAttribute<number | bigint | null, any>;
2767
- /**
2768
- * This shall indicate the most recent ActiveCurrent reading in milliamps (mA).
2769
- *
2770
- * A positive value represents current flowing into the server, while a negative value represents current
2771
- * flowing out of the server.
2772
- *
2773
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
2774
- * publication of deltas considered not meaningful.
2775
- *
2776
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
2777
- * recently than 1 second ago.
2778
- *
2779
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
2780
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
2781
- *
2782
- * If the current cannot be measured, a value of null shall be returned.
2783
- *
2784
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.6
2785
- */
2786
- readonly activeCurrent: OptionalAttribute<number | bigint | null, any>;
2787
- /**
2788
- * This shall indicate the most recent ActivePower reading in milliwatts (mW). If the power cannot be
2789
- * measured, a value of null shall be returned.
2790
- *
2791
- * A positive value represents power imported, while a negative value represents power exported.
2792
- *
2793
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
2794
- * publication of deltas considered not meaningful.
2795
- *
2796
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
2797
- * recently than 1 second ago.
2798
- *
2799
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
2800
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
2801
- *
2802
- * If the Polyphase Power feature is set, this value represents the combined active power imported or
2803
- * exported.
2804
- *
2805
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.9
2806
- */
2807
- readonly activePower: Attribute<number | bigint | null, any>;
2808
- };
2809
- readonly events: {
2810
- /**
2811
- * If supported, this event shall be generated at the end of a measurement period. The start and end times
2812
- * for measurement periods shall be determined by the server, and may represent overlapping periods.
2813
- *
2814
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.7.1
2815
- */
2816
- readonly measurementPeriodRanges: OptionalEvent<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2817
- /**
2818
- * This shall indicate the value of the Ranges attribute at the time of event generation.
2819
- *
2820
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.7.1.1
2821
- */
2822
- ranges: import("@project-chip/matter-node.js/tlv").FieldType<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
2823
- /**
2824
- * This field shall be the type of measurement for the range provided.
2825
- *
2826
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.1
2827
- */
2828
- measurementType: import("@project-chip/matter-node.js/tlv").FieldType<MeasurementType>;
2829
- /**
2830
- * This field shall be the smallest measured value for the associated measurement over either the period
2831
- * between StartTimestamp and EndTimestamp, or the period between StartSystime and EndSystime, or both.
2832
- *
2833
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.2
2834
- */
2835
- min: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2836
- /**
2837
- * This field shall be the largest measured value for the associated measurement over the period between either
2838
- * StartTimestamp and EndTimestamp or the period between StartSystime and EndSystime, or both.
2839
- *
2840
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.3
2841
- */
2842
- max: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint>;
2843
- /**
2844
- * This field shall be the timestamp in UTC of the beginning of the measurement period.
2845
- *
2846
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
2847
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
2848
- *
2849
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.4
2850
- */
2851
- startTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2852
- /**
2853
- * This field shall be the timestamp in UTC of the end of the measurement period.
2854
- *
2855
- * If the server had not yet determined the time in UTC at or before the beginning of the measurement period,
2856
- * or does not have the capability of determining the time in UTC, this field shall be omitted.
2857
- *
2858
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.5
2859
- */
2860
- endTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2861
- /**
2862
- * This field shall be the most recent timestamp in UTC that the value in the Min field was measured.
2863
- *
2864
- * This field shall be greater than or equal to the value of the StartTimestamp field. This field shall be less
2865
- * than or equal to the value of the EndTimestamp field.
2866
- *
2867
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.6
2868
- */
2869
- minTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2870
- /**
2871
- * This field shall be the most recent timestamp in UTC of the value in the Max field. This field shall be
2872
- * greater than or equal to the value of the StartTimestamp field. This field shall be less than or equal to
2873
- * the value of the EndTimestamp field.
2874
- *
2875
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.7
2876
- */
2877
- maxTimestamp: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number>;
2878
- /**
2879
- * This field shall be the time since boot of the beginning of the measurement period.
2880
- *
2881
- * If the server had determined the time in UTC at or before the start of the measurement period, this field
2882
- * may be omitted along with the EndSystime, MinSystime, and MaxSystime fields.
2883
- *
2884
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.8
2885
- */
2886
- startSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2887
- /**
2888
- * This field shall be the time since boot of the end of the measurement period.
2889
- *
2890
- * If the server had determined the time in UTC at the end of the measurement period, this field may be omitted
2891
- * along with the StartSystime field, MinSystime, and MaxSystime fields.
2892
- *
2893
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.9
2894
- */
2895
- endSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2896
- /**
2897
- * This field shall be the measurement time since boot of the value in the Min field was measured. This field
2898
- * shall be greater than or equal to the value of the StartSystime field.
2899
- *
2900
- * This field shall be less than or equal to the value of the EndSystime field.
2901
- *
2902
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.10
2903
- */
2904
- minSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2905
- /**
2906
- * This field shall be the measurement time since boot of the value in the Max field. This field shall be
2907
- * greater than or equal to the value of the StartSystime field.
2908
- *
2909
- * This field shall be less than or equal to the value of the EndSystime field.
2910
- *
2911
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.2.11
2912
- */
2913
- maxSystime: import("@project-chip/matter-node.js/tlv").OptionalFieldType<number | bigint>;
2914
- }>[]>;
2915
- }>, any>;
2916
- };
2917
- /**
2918
- * This metadata controls which ElectricalPowerMeasurementCluster elements matter.js activates for specific
2919
- * feature combinations.
2920
- */
2921
- readonly extensions: readonly [{
2922
- readonly flags: {
2923
- readonly alternatingCurrent: true;
2924
- };
2925
- readonly component: {
2926
- readonly attributes: {
2927
- /**
2928
- * This shall indicate the most recent ReactiveCurrent reading in milliamps (mA).
2929
- *
2930
- * A positive value represents current flowing into the server, while a negative value represents current
2931
- * flowing out of the server.
2932
- *
2933
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
2934
- * publication of deltas considered not meaningful.
2935
- *
2936
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
2937
- * recently than 1 second ago.
2938
- *
2939
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
2940
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
2941
- *
2942
- * If the current cannot be measured, a value of null shall be returned.
2943
- *
2944
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.7
2945
- */
2946
- readonly reactiveCurrent: OptionalAttribute<number | bigint | null, any>;
2947
- /**
2948
- * This shall indicate the most recent ApparentCurrent (square root sum of the squares of active and
2949
- * reactive currents) reading in milliamps (mA).
2950
- *
2951
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
2952
- * publication of deltas considered not meaningful.
2953
- *
2954
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
2955
- * recently than 1 second ago.
2956
- *
2957
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
2958
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
2959
- *
2960
- * If the active or reactive currents cannot be measured, a value of null shall be returned.
2961
- *
2962
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.8
2963
- */
2964
- readonly apparentCurrent: OptionalAttribute<number | bigint | null, any>;
2965
- /**
2966
- * This shall indicate the most recent ReactivePower reading in millivolt-amps reactive (mVAR). A positive
2967
- * value represents power imported, while a negative value represents power exported.
2968
- *
2969
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
2970
- * publication of deltas considered not meaningful.
2971
- *
2972
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
2973
- * recently than 1 second ago.
2974
- *
2975
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
2976
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
2977
- *
2978
- * If the reactive power cannot be measured, a value of null shall be returned.
2979
- *
2980
- * If the Polyphase Power feature is supported, this value represents the combined reactive power imported
2981
- * or exported.
2982
- *
2983
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.10
2984
- */
2985
- readonly reactivePower: OptionalAttribute<number | bigint | null, any>;
2986
- /**
2987
- * This shall indicate the most recent ApparentPower reading in millivolt-amps (mVA).
2988
- *
2989
- * A positive value represents power imported, while a negative value represents power exported.
2990
- *
2991
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
2992
- * publication of deltas considered not meaningful.
2993
- *
2994
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
2995
- * recently than 1 second ago.
2996
- *
2997
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
2998
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
2999
- *
3000
- * If the apparent power cannot be measured, a value of null shall be returned.
3001
- *
3002
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.11
3003
- */
3004
- readonly apparentPower: OptionalAttribute<number | bigint | null, any>;
3005
- /**
3006
- * This shall indicate the most recent RMSVoltage reading in millivolts (mV).
3007
- *
3008
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
3009
- * publication of deltas considered not meaningful.
3010
- *
3011
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
3012
- * recently than 1 second ago.
3013
- *
3014
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
3015
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
3016
- *
3017
- * If the RMS voltage cannot be measured, a value of null shall be returned.
3018
- *
3019
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.12
3020
- */
3021
- readonly rmsVoltage: OptionalAttribute<number | bigint | null, any>;
3022
- /**
3023
- * This shall indicate the most recent RMSCurrent reading in milliamps (mA).
3024
- *
3025
- * A positive value represents current flowing into the server, while a negative value represents current
3026
- * flowing out of the server.
3027
- *
3028
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
3029
- * publication of deltas considered not meaningful.
3030
- *
3031
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
3032
- * recently than 1 second ago.
3033
- *
3034
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
3035
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
3036
- *
3037
- * If the RMS current cannot be measured, a value of null shall be returned.
3038
- *
3039
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.13
3040
- */
3041
- readonly rmsCurrent: OptionalAttribute<number | bigint | null, any>;
3042
- /**
3043
- * This shall indicate the most recent RMSPower reading in milliwatts (mW).
3044
- *
3045
- * A positive value represents power imported, while a negative value represents power exported.
3046
- *
3047
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
3048
- * publication of deltas considered not meaningful.
3049
- *
3050
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
3051
- * recently than 1 second ago.
3052
- *
3053
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
3054
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
3055
- *
3056
- * If the RMS power cannot be measured, a value of null shall be returned.
3057
- *
3058
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.14
3059
- */
3060
- readonly rmsPower: OptionalAttribute<number | bigint | null, any>;
3061
- /**
3062
- * This shall indicate the most recent Frequency reading in millihertz (mHz).
3063
- *
3064
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
3065
- * publication of deltas considered not meaningful.
3066
- *
3067
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
3068
- * recently than 1 second ago.
3069
- *
3070
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
3071
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
3072
- *
3073
- * If the frequency cannot be measured, a value of null shall be returned.
3074
- *
3075
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.15
3076
- */
3077
- readonly frequency: OptionalAttribute<number | bigint | null, any>;
3078
- /**
3079
- * This shall indicate the Power Factor ratio in +/- 1/100ths of a percent.
3080
- *
3081
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
3082
- * publication of deltas considered not meaningful.
3083
- *
3084
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
3085
- * recently than 1 second ago.
3086
- *
3087
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
3088
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
3089
- *
3090
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.18
3091
- */
3092
- readonly powerFactor: OptionalAttribute<number | bigint | null, any>;
3093
- };
3094
- };
3095
- }, {
3096
- readonly flags: {
3097
- readonly harmonics: true;
3098
- };
3099
- readonly component: {
3100
- readonly attributes: {
3101
- /**
3102
- * This shall indicate a list of HarmonicMeasurementStruct values, with each HarmonicMeasurementStruct
3103
- * representing the harmonic current reading for the harmonic order specified by Order.
3104
- *
3105
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
3106
- * publication of deltas considered not meaningful.
3107
- *
3108
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
3109
- * recently than 1 second ago.
3110
- *
3111
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
3112
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
3113
- *
3114
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.16
3115
- */
3116
- readonly harmonicCurrents: Attribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
3117
- /**
3118
- * This field shall be the order of the harmonic being measured. Typically this is an odd number, but servers
3119
- * may choose to report even harmonics.
3120
- *
3121
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.1
3122
- */
3123
- order: import("@project-chip/matter-node.js/tlv").FieldType<number>;
3124
- /**
3125
- * This field shall be the measured value for the given harmonic order.
3126
- *
3127
- * For the Harmonic Currents attribute, this value is the most recently measured harmonic current reading in
3128
- * milliamps (mA). A positive value indicates that the measured harmonic current is positive, and a negative
3129
- * value indicates that the measured harmonic current is negative.
3130
- *
3131
- * For the Harmonic Phases attribute, this value is the most recent phase of the given harmonic order
3132
- *
3133
- * in millidegrees (mDeg). A positive value indicates that the measured phase is leading, and a negative value
3134
- * indicates that the measured phase is lagging.
3135
- *
3136
- * If this measurement is not currently available, a value of null shall be returned.
3137
- *
3138
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.2
3139
- */
3140
- measurement: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint | null>;
3141
- }>[] | null, any>;
3142
- };
3143
- };
3144
- }, {
3145
- readonly flags: {
3146
- readonly powerQuality: true;
3147
- };
3148
- readonly component: {
3149
- readonly attributes: {
3150
- /**
3151
- * This shall indicate a list of HarmonicMeasurementStruct values, with each HarmonicMeasurementStruct
3152
- * representing the most recent phase of the harmonic current reading for the harmonic
3153
- *
3154
- * order specified by Order.
3155
- *
3156
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
3157
- * publication of deltas considered not meaningful.
3158
- *
3159
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
3160
- * recently than 1 second ago.
3161
- *
3162
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
3163
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
3164
- *
3165
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.17
3166
- */
3167
- readonly harmonicPhases: Attribute<import("@project-chip/matter-node.js/tlv").TypeFromFields<{
3168
- /**
3169
- * This field shall be the order of the harmonic being measured. Typically this is an odd number, but servers
3170
- * may choose to report even harmonics.
3171
- *
3172
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.1
3173
- */
3174
- order: import("@project-chip/matter-node.js/tlv").FieldType<number>;
3175
- /**
3176
- * This field shall be the measured value for the given harmonic order.
3177
- *
3178
- * For the Harmonic Currents attribute, this value is the most recently measured harmonic current reading in
3179
- * milliamps (mA). A positive value indicates that the measured harmonic current is positive, and a negative
3180
- * value indicates that the measured harmonic current is negative.
3181
- *
3182
- * For the Harmonic Phases attribute, this value is the most recent phase of the given harmonic order
3183
- *
3184
- * in millidegrees (mDeg). A positive value indicates that the measured phase is leading, and a negative value
3185
- * indicates that the measured phase is lagging.
3186
- *
3187
- * If this measurement is not currently available, a value of null shall be returned.
3188
- *
3189
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.5.3.2
3190
- */
3191
- measurement: import("@project-chip/matter-node.js/tlv").FieldType<number | bigint | null>;
3192
- }>[] | null, any>;
3193
- };
3194
- };
3195
- }, {
3196
- readonly flags: {
3197
- readonly polyphasePower: true;
3198
- };
3199
- readonly component: {
3200
- readonly attributes: {
3201
- /**
3202
- * This shall indicate the most recent NeutralCurrent reading in milliamps (mA). Typically this is a
3203
- * derived value, taking the magnitude of the vector sum of phase currents.
3204
- *
3205
- * If the neutral current cannot be measured or derived, a value of null shall be returned.
3206
- *
3207
- * A positive value represents an imbalance between the phase currents when power is imported. A negative
3208
- * value represents an imbalance between the phase currents when power is exported.
3209
- *
3210
- * The reporting interval of this attribute shall be manufacturer dependent. The server may choose to omit
3211
- * publication of deltas considered not meaningful.
3212
- *
3213
- * The server shall NOT mark this attribute ready for report if the last time this was done was more
3214
- * recently than 1 second ago.
3215
- *
3216
- * The server may delay marking this attribute ready for report for longer periods if needed, however the
3217
- * server shall NOT delay marking this attribute as ready for report for longer than 60 seconds.
3218
- *
3219
- * @see {@link MatterSpecification.v13.Cluster} § 2.13.6.19
3220
- */
3221
- readonly neutralCurrent: OptionalAttribute<number | bigint | null, any>;
3222
- };
3223
- };
3224
- }, {
3225
- readonly flags: {
3226
- readonly polyphasePower: true;
3227
- readonly alternatingCurrent: false;
3228
- };
3229
- readonly component: false;
3230
- }, {
3231
- readonly flags: {
3232
- readonly harmonics: true;
3233
- readonly alternatingCurrent: false;
3234
- };
3235
- readonly component: false;
3236
- }, {
3237
- readonly flags: {
3238
- readonly powerQuality: true;
3239
- readonly alternatingCurrent: false;
3240
- };
3241
- readonly component: false;
3242
- }, {
3243
- readonly flags: {
3244
- readonly directCurrent: false;
3245
- readonly alternatingCurrent: false;
3246
- };
3247
- readonly component: false;
3248
- }];
3249
- }>;
3250
- //# sourceMappingURL=ElectricalPowerMeasurementCluster.d.ts.map