@matter/types 0.13.0-alpha.0-20250304-d4a7592a4 → 0.13.0-alpha.0-20250307-ebf84a05a
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/clusters/access-control.d.ts +3972 -522
- package/dist/cjs/clusters/access-control.d.ts.map +1 -1
- package/dist/cjs/clusters/access-control.js +640 -116
- package/dist/cjs/clusters/access-control.js.map +2 -2
- package/dist/cjs/clusters/actions.d.ts +10 -9
- package/dist/cjs/clusters/actions.d.ts.map +1 -1
- package/dist/cjs/clusters/actions.js +4 -4
- package/dist/cjs/clusters/actions.js.map +1 -1
- package/dist/cjs/clusters/administrator-commissioning.d.ts +156 -129
- package/dist/cjs/clusters/administrator-commissioning.d.ts.map +1 -1
- package/dist/cjs/clusters/administrator-commissioning.js +40 -35
- package/dist/cjs/clusters/administrator-commissioning.js.map +1 -1
- package/dist/cjs/clusters/alarm-base.d.ts +9 -12
- package/dist/cjs/clusters/alarm-base.d.ts.map +1 -1
- package/dist/cjs/clusters/alarm-base.js +3 -4
- package/dist/cjs/clusters/alarm-base.js.map +1 -1
- package/dist/cjs/clusters/application-launcher.d.ts +27 -15
- package/dist/cjs/clusters/application-launcher.d.ts.map +1 -1
- package/dist/cjs/clusters/application-launcher.js +7 -4
- package/dist/cjs/clusters/application-launcher.js.map +1 -1
- package/dist/cjs/clusters/ballast-configuration.d.ts +7 -7
- package/dist/cjs/clusters/ballast-configuration.js +7 -7
- package/dist/cjs/clusters/basic-information.d.ts +29 -21
- package/dist/cjs/clusters/basic-information.d.ts.map +1 -1
- package/dist/cjs/clusters/basic-information.js +29 -21
- package/dist/cjs/clusters/basic-information.js.map +1 -1
- package/dist/cjs/clusters/bridged-device-basic-information.d.ts +816 -34
- package/dist/cjs/clusters/bridged-device-basic-information.d.ts.map +1 -1
- package/dist/cjs/clusters/bridged-device-basic-information.js +182 -29
- package/dist/cjs/clusters/bridged-device-basic-information.js.map +2 -2
- package/dist/cjs/clusters/channel.d.ts +115 -124
- package/dist/cjs/clusters/channel.d.ts.map +1 -1
- package/dist/cjs/clusters/channel.js +15 -16
- package/dist/cjs/clusters/channel.js.map +1 -1
- package/dist/cjs/clusters/color-control.d.ts +3076 -1366
- package/dist/cjs/clusters/color-control.d.ts.map +1 -1
- package/dist/cjs/clusters/color-control.js +423 -357
- package/dist/cjs/clusters/color-control.js.map +2 -2
- package/dist/cjs/clusters/commissioner-control.d.ts +268 -0
- package/dist/cjs/clusters/commissioner-control.d.ts.map +1 -0
- package/dist/cjs/clusters/commissioner-control.js +194 -0
- package/dist/cjs/clusters/commissioner-control.js.map +6 -0
- package/dist/cjs/clusters/content-control.d.ts +497 -221
- package/dist/cjs/clusters/content-control.d.ts.map +1 -1
- package/dist/cjs/clusters/content-control.js +59 -41
- package/dist/cjs/clusters/content-control.js.map +2 -2
- package/dist/cjs/clusters/content-launcher.d.ts +248 -215
- package/dist/cjs/clusters/content-launcher.d.ts.map +1 -1
- package/dist/cjs/clusters/content-launcher.js +16 -15
- package/dist/cjs/clusters/content-launcher.js.map +1 -1
- package/dist/cjs/clusters/device-energy-management-mode.d.ts +76 -333
- package/dist/cjs/clusters/device-energy-management-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/device-energy-management-mode.js +26 -73
- package/dist/cjs/clusters/device-energy-management-mode.js.map +1 -1
- package/dist/cjs/clusters/device-energy-management.d.ts +1299 -930
- package/dist/cjs/clusters/device-energy-management.d.ts.map +1 -1
- package/dist/cjs/clusters/device-energy-management.js +189 -160
- package/dist/cjs/clusters/device-energy-management.js.map +2 -2
- package/dist/cjs/clusters/dishwasher-alarm.d.ts +14 -17
- package/dist/cjs/clusters/dishwasher-alarm.d.ts.map +1 -1
- package/dist/cjs/clusters/dishwasher-alarm.js +3 -4
- package/dist/cjs/clusters/dishwasher-alarm.js.map +1 -1
- package/dist/cjs/clusters/dishwasher-mode.d.ts +65 -105
- package/dist/cjs/clusters/dishwasher-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/dishwasher-mode.js +12 -24
- package/dist/cjs/clusters/dishwasher-mode.js.map +1 -1
- package/dist/cjs/clusters/door-lock.d.ts +2751 -5427
- package/dist/cjs/clusters/door-lock.d.ts.map +1 -1
- package/dist/cjs/clusters/door-lock.js +480 -802
- package/dist/cjs/clusters/door-lock.js.map +2 -2
- package/dist/cjs/clusters/ecosystem-information.d.ts +186 -0
- package/dist/cjs/clusters/ecosystem-information.d.ts.map +1 -0
- package/dist/cjs/clusters/ecosystem-information.js +154 -0
- package/dist/cjs/clusters/ecosystem-information.js.map +6 -0
- package/dist/cjs/clusters/electrical-energy-measurement.d.ts +363 -368
- package/dist/cjs/clusters/electrical-energy-measurement.d.ts.map +1 -1
- package/dist/cjs/clusters/electrical-energy-measurement.js +15 -16
- package/dist/cjs/clusters/electrical-energy-measurement.js.map +1 -1
- package/dist/cjs/clusters/energy-evse-mode.d.ts +92 -330
- package/dist/cjs/clusters/energy-evse-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/energy-evse-mode.js +25 -72
- package/dist/cjs/clusters/energy-evse-mode.js.map +1 -1
- package/dist/cjs/clusters/energy-evse.d.ts +557 -273
- package/dist/cjs/clusters/energy-evse.d.ts.map +1 -1
- package/dist/cjs/clusters/energy-evse.js +107 -55
- package/dist/cjs/clusters/energy-evse.js.map +1 -1
- package/dist/cjs/clusters/energy-preference.d.ts +76 -76
- package/dist/cjs/clusters/energy-preference.d.ts.map +1 -1
- package/dist/cjs/clusters/energy-preference.js +15 -18
- package/dist/cjs/clusters/energy-preference.js.map +1 -1
- package/dist/cjs/clusters/ethernet-network-diagnostics.d.ts +3 -9
- package/dist/cjs/clusters/ethernet-network-diagnostics.d.ts.map +1 -1
- package/dist/cjs/clusters/ethernet-network-diagnostics.js +1 -3
- package/dist/cjs/clusters/ethernet-network-diagnostics.js.map +1 -1
- package/dist/cjs/clusters/fan-control.d.ts +12 -12
- package/dist/cjs/clusters/fan-control.js +4 -4
- package/dist/cjs/clusters/fixed-label.d.ts +7 -2
- package/dist/cjs/clusters/fixed-label.d.ts.map +1 -1
- package/dist/cjs/clusters/fixed-label.js.map +1 -1
- package/dist/cjs/clusters/flow-measurement.d.ts +4 -4
- package/dist/cjs/clusters/flow-measurement.d.ts.map +1 -1
- package/dist/cjs/clusters/flow-measurement.js +6 -6
- package/dist/cjs/clusters/flow-measurement.js.map +1 -1
- package/dist/cjs/clusters/general-commissioning.d.ts +1416 -111
- package/dist/cjs/clusters/general-commissioning.d.ts.map +1 -1
- package/dist/cjs/clusters/general-commissioning.js +272 -54
- package/dist/cjs/clusters/general-commissioning.js.map +2 -2
- package/dist/cjs/clusters/general-diagnostics.d.ts +115 -122
- package/dist/cjs/clusters/general-diagnostics.d.ts.map +1 -1
- package/dist/cjs/clusters/general-diagnostics.js +31 -33
- package/dist/cjs/clusters/general-diagnostics.js.map +1 -1
- package/dist/cjs/clusters/group-key-management.d.ts +72 -82
- package/dist/cjs/clusters/group-key-management.d.ts.map +1 -1
- package/dist/cjs/clusters/group-key-management.js +19 -22
- package/dist/cjs/clusters/group-key-management.js.map +1 -1
- package/dist/cjs/clusters/groups.d.ts +9 -6
- package/dist/cjs/clusters/groups.d.ts.map +1 -1
- package/dist/cjs/clusters/groups.js +3 -2
- package/dist/cjs/clusters/groups.js.map +1 -1
- package/dist/cjs/clusters/icd-management.d.ts +223 -66
- package/dist/cjs/clusters/icd-management.d.ts.map +1 -1
- package/dist/cjs/clusters/icd-management.js +61 -23
- package/dist/cjs/clusters/icd-management.js.map +2 -2
- package/dist/cjs/clusters/identify.d.ts +12 -13
- package/dist/cjs/clusters/identify.d.ts.map +1 -1
- package/dist/cjs/clusters/identify.js +9 -10
- package/dist/cjs/clusters/identify.js.map +1 -1
- package/dist/cjs/clusters/illuminance-measurement.d.ts +7 -8
- package/dist/cjs/clusters/illuminance-measurement.d.ts.map +1 -1
- package/dist/cjs/clusters/illuminance-measurement.js +9 -10
- package/dist/cjs/clusters/illuminance-measurement.js.map +1 -1
- package/dist/cjs/clusters/index.d.ts +11 -1
- package/dist/cjs/clusters/index.d.ts.map +1 -1
- package/dist/cjs/clusters/index.js +33 -3
- package/dist/cjs/clusters/index.js.map +1 -1
- package/dist/cjs/clusters/joint-fabric-datastore-cluster.d.ts +1239 -0
- package/dist/cjs/clusters/joint-fabric-datastore-cluster.d.ts.map +1 -0
- package/dist/cjs/clusters/joint-fabric-datastore-cluster.js +490 -0
- package/dist/cjs/clusters/joint-fabric-datastore-cluster.js.map +6 -0
- package/dist/cjs/clusters/joint-fabric-pki.d.ts +174 -0
- package/dist/cjs/clusters/joint-fabric-pki.d.ts.map +1 -0
- package/dist/cjs/clusters/joint-fabric-pki.js +120 -0
- package/dist/cjs/clusters/joint-fabric-pki.js.map +6 -0
- package/dist/cjs/clusters/keypad-input.d.ts +2 -2
- package/dist/cjs/clusters/laundry-dryer-controls.d.ts +6 -7
- package/dist/cjs/clusters/laundry-dryer-controls.d.ts.map +1 -1
- package/dist/cjs/clusters/laundry-dryer-controls.js +5 -9
- package/dist/cjs/clusters/laundry-dryer-controls.js.map +1 -1
- package/dist/cjs/clusters/laundry-washer-controls.d.ts +74 -62
- package/dist/cjs/clusters/laundry-washer-controls.d.ts.map +1 -1
- package/dist/cjs/clusters/laundry-washer-controls.js +26 -25
- package/dist/cjs/clusters/laundry-washer-controls.js.map +1 -1
- package/dist/cjs/clusters/laundry-washer-mode.d.ts +69 -109
- package/dist/cjs/clusters/laundry-washer-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/laundry-washer-mode.js +13 -25
- package/dist/cjs/clusters/laundry-washer-mode.js.map +1 -1
- package/dist/cjs/clusters/level-control.d.ts +209 -70
- package/dist/cjs/clusters/level-control.d.ts.map +1 -1
- package/dist/cjs/clusters/level-control.js +45 -12
- package/dist/cjs/clusters/level-control.js.map +1 -1
- package/dist/cjs/clusters/localization-configuration.d.ts +5 -6
- package/dist/cjs/clusters/localization-configuration.d.ts.map +1 -1
- package/dist/cjs/clusters/localization-configuration.js +5 -6
- package/dist/cjs/clusters/localization-configuration.js.map +1 -1
- package/dist/cjs/clusters/media-input.d.ts +9 -6
- package/dist/cjs/clusters/media-input.d.ts.map +1 -1
- package/dist/cjs/clusters/media-input.js +3 -2
- package/dist/cjs/clusters/media-input.js.map +1 -1
- package/dist/cjs/clusters/media-playback.d.ts +29 -24
- package/dist/cjs/clusters/media-playback.d.ts.map +1 -1
- package/dist/cjs/clusters/media-playback.js +5 -4
- package/dist/cjs/clusters/media-playback.js.map +1 -1
- package/dist/cjs/clusters/microwave-oven-control.d.ts +54 -48
- package/dist/cjs/clusters/microwave-oven-control.d.ts.map +1 -1
- package/dist/cjs/clusters/microwave-oven-control.js +19 -17
- package/dist/cjs/clusters/microwave-oven-control.js.map +1 -1
- package/dist/cjs/clusters/microwave-oven-mode.d.ts +63 -69
- package/dist/cjs/clusters/microwave-oven-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/microwave-oven-mode.js +14 -11
- package/dist/cjs/clusters/microwave-oven-mode.js.map +1 -1
- package/dist/cjs/clusters/mode-base.d.ts +27 -46
- package/dist/cjs/clusters/mode-base.d.ts.map +1 -1
- package/dist/cjs/clusters/mode-base.js +9 -10
- package/dist/cjs/clusters/mode-base.js.map +1 -1
- package/dist/cjs/clusters/mode-select.d.ts +33 -27
- package/dist/cjs/clusters/mode-select.d.ts.map +1 -1
- package/dist/cjs/clusters/mode-select.js +14 -13
- package/dist/cjs/clusters/mode-select.js.map +1 -1
- package/dist/cjs/clusters/network-commissioning.d.ts +263 -240
- package/dist/cjs/clusters/network-commissioning.d.ts.map +1 -1
- package/dist/cjs/clusters/network-commissioning.js +46 -39
- package/dist/cjs/clusters/network-commissioning.js.map +1 -1
- package/dist/cjs/clusters/occupancy-sensing.d.ts +1002 -63
- package/dist/cjs/clusters/occupancy-sensing.d.ts.map +1 -1
- package/dist/cjs/clusters/occupancy-sensing.js +278 -63
- package/dist/cjs/clusters/occupancy-sensing.js.map +2 -2
- package/dist/cjs/clusters/on-off.d.ts +18 -24
- package/dist/cjs/clusters/on-off.d.ts.map +1 -1
- package/dist/cjs/clusters/on-off.js +3 -4
- package/dist/cjs/clusters/on-off.js.map +1 -1
- package/dist/cjs/clusters/operational-credentials.d.ts +98 -85
- package/dist/cjs/clusters/operational-credentials.d.ts.map +1 -1
- package/dist/cjs/clusters/operational-credentials.js +56 -49
- package/dist/cjs/clusters/operational-credentials.js.map +1 -1
- package/dist/cjs/clusters/operational-state.d.ts +136 -57
- package/dist/cjs/clusters/operational-state.d.ts.map +1 -1
- package/dist/cjs/clusters/operational-state.js +62 -36
- package/dist/cjs/clusters/operational-state.js.map +2 -2
- package/dist/cjs/clusters/ota-software-update-provider.d.ts +43 -42
- package/dist/cjs/clusters/ota-software-update-provider.d.ts.map +1 -1
- package/dist/cjs/clusters/ota-software-update-provider.js +20 -19
- package/dist/cjs/clusters/ota-software-update-provider.js.map +1 -1
- package/dist/cjs/clusters/ota-software-update-requestor.d.ts +6 -10
- package/dist/cjs/clusters/ota-software-update-requestor.d.ts.map +1 -1
- package/dist/cjs/clusters/ota-software-update-requestor.js +4 -6
- package/dist/cjs/clusters/ota-software-update-requestor.js.map +1 -1
- package/dist/cjs/clusters/oven-cavity-operational-state.d.ts +44 -154
- package/dist/cjs/clusters/oven-cavity-operational-state.d.ts.map +1 -1
- package/dist/cjs/clusters/oven-cavity-operational-state.js +39 -156
- package/dist/cjs/clusters/oven-cavity-operational-state.js.map +1 -1
- package/dist/cjs/clusters/oven-mode.d.ts +79 -349
- package/dist/cjs/clusters/oven-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/oven-mode.js +26 -82
- package/dist/cjs/clusters/oven-mode.js.map +1 -1
- package/dist/cjs/clusters/power-source.d.ts +169 -44
- package/dist/cjs/clusters/power-source.d.ts.map +1 -1
- package/dist/cjs/clusters/power-source.js +40 -16
- package/dist/cjs/clusters/power-source.js.map +1 -1
- package/dist/cjs/clusters/pressure-measurement.js +2 -2
- package/dist/cjs/clusters/pressure-measurement.js.map +1 -1
- package/dist/cjs/clusters/pump-configuration-and-control.d.ts +73 -63
- package/dist/cjs/clusters/pump-configuration-and-control.d.ts.map +1 -1
- package/dist/cjs/clusters/pump-configuration-and-control.js +19 -20
- package/dist/cjs/clusters/pump-configuration-and-control.js.map +1 -1
- package/dist/cjs/clusters/refrigerator-alarm.d.ts +2 -1
- package/dist/cjs/clusters/refrigerator-alarm.d.ts.map +1 -1
- package/dist/cjs/clusters/refrigerator-alarm.js.map +1 -1
- package/dist/cjs/clusters/refrigerator-and-temperature-controlled-cabinet-mode.d.ts +59 -91
- package/dist/cjs/clusters/refrigerator-and-temperature-controlled-cabinet-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/refrigerator-and-temperature-controlled-cabinet-mode.js +11 -19
- package/dist/cjs/clusters/refrigerator-and-temperature-controlled-cabinet-mode.js.map +1 -1
- package/dist/cjs/clusters/relative-humidity-measurement.js +1 -1
- package/dist/cjs/clusters/relative-humidity-measurement.js.map +1 -1
- package/dist/cjs/clusters/rvc-clean-mode.d.ts +59 -103
- package/dist/cjs/clusters/rvc-clean-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/rvc-clean-mode.js +11 -15
- package/dist/cjs/clusters/rvc-clean-mode.js.map +1 -1
- package/dist/cjs/clusters/rvc-operational-state.d.ts +81 -25
- package/dist/cjs/clusters/rvc-operational-state.d.ts.map +1 -1
- package/dist/cjs/clusters/rvc-operational-state.js +49 -20
- package/dist/cjs/clusters/rvc-operational-state.js.map +1 -1
- package/dist/cjs/clusters/rvc-run-mode.d.ts +85 -129
- package/dist/cjs/clusters/rvc-run-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/rvc-run-mode.js +16 -15
- package/dist/cjs/clusters/rvc-run-mode.js.map +1 -1
- package/dist/cjs/clusters/scenes-management.d.ts +328 -181
- package/dist/cjs/clusters/scenes-management.d.ts.map +1 -1
- package/dist/cjs/clusters/scenes-management.js +37 -22
- package/dist/cjs/clusters/scenes-management.js.map +1 -1
- package/dist/cjs/clusters/service-area.d.ts +2052 -0
- package/dist/cjs/clusters/service-area.d.ts.map +1 -0
- package/dist/cjs/clusters/service-area.js +582 -0
- package/dist/cjs/clusters/service-area.js.map +6 -0
- package/dist/cjs/clusters/smoke-co-alarm.d.ts +10 -18
- package/dist/cjs/clusters/smoke-co-alarm.d.ts.map +1 -1
- package/dist/cjs/clusters/smoke-co-alarm.js +2 -3
- package/dist/cjs/clusters/smoke-co-alarm.js.map +1 -1
- package/dist/cjs/clusters/switch.d.ts +478 -191
- package/dist/cjs/clusters/switch.d.ts.map +1 -1
- package/dist/cjs/clusters/switch.js +145 -57
- package/dist/cjs/clusters/switch.js.map +1 -1
- package/dist/cjs/clusters/target-navigator.d.ts +1 -1
- package/dist/cjs/clusters/target-navigator.js +1 -1
- package/dist/cjs/clusters/thermostat.d.ts +3877 -830
- package/dist/cjs/clusters/thermostat.d.ts.map +1 -1
- package/dist/cjs/clusters/thermostat.js +841 -159
- package/dist/cjs/clusters/thermostat.js.map +2 -2
- package/dist/cjs/clusters/thread-border-router-management.d.ts +711 -0
- package/dist/cjs/clusters/thread-border-router-management.d.ts.map +1 -0
- package/dist/cjs/clusters/thread-border-router-management.js +265 -0
- package/dist/cjs/clusters/thread-border-router-management.js.map +6 -0
- package/dist/cjs/clusters/thread-network-diagnostics.d.ts +81 -55
- package/dist/cjs/clusters/thread-network-diagnostics.d.ts.map +1 -1
- package/dist/cjs/clusters/thread-network-diagnostics.js +32 -21
- package/dist/cjs/clusters/thread-network-diagnostics.js.map +1 -1
- package/dist/cjs/clusters/thread-network-directory.d.ts +250 -0
- package/dist/cjs/clusters/thread-network-directory.d.ts.map +1 -0
- package/dist/cjs/clusters/thread-network-directory.js +187 -0
- package/dist/cjs/clusters/thread-network-directory.js.map +6 -0
- package/dist/cjs/clusters/time-synchronization.d.ts +101 -76
- package/dist/cjs/clusters/time-synchronization.d.ts.map +1 -1
- package/dist/cjs/clusters/time-synchronization.js +30 -23
- package/dist/cjs/clusters/time-synchronization.js.map +1 -1
- package/dist/cjs/clusters/unit-localization.d.ts +3 -4
- package/dist/cjs/clusters/unit-localization.d.ts.map +1 -1
- package/dist/cjs/clusters/unit-localization.js.map +1 -1
- package/dist/cjs/clusters/user-label.d.ts +2 -1
- package/dist/cjs/clusters/user-label.d.ts.map +1 -1
- package/dist/cjs/clusters/user-label.js.map +1 -1
- package/dist/cjs/clusters/water-heater-management.d.ts +1371 -0
- package/dist/cjs/clusters/water-heater-management.d.ts.map +1 -0
- package/dist/cjs/clusters/water-heater-management.js +336 -0
- package/dist/cjs/clusters/water-heater-management.js.map +6 -0
- package/dist/cjs/clusters/water-heater-mode.d.ts +491 -0
- package/dist/cjs/clusters/water-heater-mode.d.ts.map +1 -0
- package/dist/cjs/clusters/water-heater-mode.js +195 -0
- package/dist/cjs/clusters/water-heater-mode.js.map +6 -0
- package/dist/cjs/clusters/water-tank-level-monitoring.d.ts +162 -0
- package/dist/cjs/clusters/water-tank-level-monitoring.d.ts.map +1 -0
- package/dist/cjs/clusters/water-tank-level-monitoring.js +47 -0
- package/dist/cjs/clusters/water-tank-level-monitoring.js.map +6 -0
- package/dist/cjs/clusters/wi-fi-network-diagnostics.d.ts +20 -27
- package/dist/cjs/clusters/wi-fi-network-diagnostics.d.ts.map +1 -1
- package/dist/cjs/clusters/wi-fi-network-diagnostics.js +6 -8
- package/dist/cjs/clusters/wi-fi-network-diagnostics.js.map +1 -1
- package/dist/cjs/clusters/wi-fi-network-management.d.ts +91 -0
- package/dist/cjs/clusters/wi-fi-network-management.d.ts.map +1 -0
- package/dist/cjs/clusters/wi-fi-network-management.js +122 -0
- package/dist/cjs/clusters/wi-fi-network-management.js.map +6 -0
- package/dist/cjs/clusters/window-covering.d.ts +66 -78
- package/dist/cjs/clusters/window-covering.d.ts.map +1 -1
- package/dist/cjs/clusters/window-covering.js +26 -37
- package/dist/cjs/clusters/window-covering.js.map +1 -1
- package/dist/cjs/globals/AtomicAttributeStatus.d.ts +34 -0
- package/dist/cjs/globals/AtomicAttributeStatus.d.ts.map +1 -0
- package/dist/cjs/globals/AtomicAttributeStatus.js +46 -0
- package/dist/cjs/globals/AtomicAttributeStatus.js.map +6 -0
- package/dist/cjs/globals/AtomicRequestType.d.ts +24 -0
- package/dist/cjs/globals/AtomicRequestType.d.ts.map +1 -0
- package/dist/cjs/globals/AtomicRequestType.js +35 -0
- package/dist/cjs/globals/AtomicRequestType.js.map +6 -0
- package/dist/cjs/globals/Locationdesc.d.ts +79 -0
- package/dist/cjs/globals/Locationdesc.d.ts.map +1 -0
- package/dist/cjs/globals/Locationdesc.js +89 -0
- package/dist/cjs/globals/Locationdesc.js.map +6 -0
- package/dist/cjs/globals/Priority.d.ts +1 -1
- package/dist/cjs/globals/Semtag.d.ts +6 -6
- package/dist/cjs/globals/Semtag.js +4 -4
- package/dist/cjs/globals/SoftwareVersionCertificationStatus.d.ts +1 -1
- package/dist/cjs/globals/Status.d.ts +18 -3
- package/dist/cjs/globals/Status.d.ts.map +1 -1
- package/dist/cjs/globals/Status.js +3 -1
- package/dist/cjs/globals/Status.js.map +1 -1
- package/dist/cjs/globals/Tod.d.ts +2 -2
- package/dist/cjs/globals/index.d.ts +3 -0
- package/dist/cjs/globals/index.d.ts.map +1 -1
- package/dist/cjs/globals/index.js +3 -0
- package/dist/cjs/globals/index.js.map +1 -1
- package/dist/cjs/schema/QrCodeSchema.d.ts.map +1 -1
- package/dist/cjs/schema/QrCodeSchema.js +4 -1
- package/dist/cjs/schema/QrCodeSchema.js.map +1 -1
- package/dist/esm/clusters/access-control.d.ts +3972 -522
- package/dist/esm/clusters/access-control.d.ts.map +1 -1
- package/dist/esm/clusters/access-control.js +645 -120
- package/dist/esm/clusters/access-control.js.map +2 -2
- package/dist/esm/clusters/actions.d.ts +10 -9
- package/dist/esm/clusters/actions.d.ts.map +1 -1
- package/dist/esm/clusters/actions.js +4 -4
- package/dist/esm/clusters/actions.js.map +1 -1
- package/dist/esm/clusters/administrator-commissioning.d.ts +156 -129
- package/dist/esm/clusters/administrator-commissioning.d.ts.map +1 -1
- package/dist/esm/clusters/administrator-commissioning.js +40 -35
- package/dist/esm/clusters/administrator-commissioning.js.map +1 -1
- package/dist/esm/clusters/alarm-base.d.ts +9 -12
- package/dist/esm/clusters/alarm-base.d.ts.map +1 -1
- package/dist/esm/clusters/alarm-base.js +3 -4
- package/dist/esm/clusters/alarm-base.js.map +1 -1
- package/dist/esm/clusters/application-launcher.d.ts +27 -15
- package/dist/esm/clusters/application-launcher.d.ts.map +1 -1
- package/dist/esm/clusters/application-launcher.js +7 -4
- package/dist/esm/clusters/application-launcher.js.map +1 -1
- package/dist/esm/clusters/ballast-configuration.d.ts +7 -7
- package/dist/esm/clusters/ballast-configuration.js +7 -7
- package/dist/esm/clusters/basic-information.d.ts +29 -21
- package/dist/esm/clusters/basic-information.d.ts.map +1 -1
- package/dist/esm/clusters/basic-information.js +29 -21
- package/dist/esm/clusters/basic-information.js.map +1 -1
- package/dist/esm/clusters/bridged-device-basic-information.d.ts +816 -34
- package/dist/esm/clusters/bridged-device-basic-information.d.ts.map +1 -1
- package/dist/esm/clusters/bridged-device-basic-information.js +188 -32
- package/dist/esm/clusters/bridged-device-basic-information.js.map +2 -2
- package/dist/esm/clusters/channel.d.ts +115 -124
- package/dist/esm/clusters/channel.d.ts.map +1 -1
- package/dist/esm/clusters/channel.js +15 -16
- package/dist/esm/clusters/channel.js.map +1 -1
- package/dist/esm/clusters/color-control.d.ts +3076 -1366
- package/dist/esm/clusters/color-control.d.ts.map +1 -1
- package/dist/esm/clusters/color-control.js +424 -358
- package/dist/esm/clusters/color-control.js.map +2 -2
- package/dist/esm/clusters/commissioner-control.d.ts +268 -0
- package/dist/esm/clusters/commissioner-control.d.ts.map +1 -0
- package/dist/esm/clusters/commissioner-control.js +174 -0
- package/dist/esm/clusters/commissioner-control.js.map +6 -0
- package/dist/esm/clusters/content-control.d.ts +497 -221
- package/dist/esm/clusters/content-control.d.ts.map +1 -1
- package/dist/esm/clusters/content-control.js +60 -42
- package/dist/esm/clusters/content-control.js.map +2 -2
- package/dist/esm/clusters/content-launcher.d.ts +248 -215
- package/dist/esm/clusters/content-launcher.d.ts.map +1 -1
- package/dist/esm/clusters/content-launcher.js +16 -15
- package/dist/esm/clusters/content-launcher.js.map +1 -1
- package/dist/esm/clusters/device-energy-management-mode.d.ts +76 -333
- package/dist/esm/clusters/device-energy-management-mode.d.ts.map +1 -1
- package/dist/esm/clusters/device-energy-management-mode.js +26 -80
- package/dist/esm/clusters/device-energy-management-mode.js.map +1 -1
- package/dist/esm/clusters/device-energy-management.d.ts +1299 -930
- package/dist/esm/clusters/device-energy-management.d.ts.map +1 -1
- package/dist/esm/clusters/device-energy-management.js +189 -160
- package/dist/esm/clusters/device-energy-management.js.map +2 -2
- package/dist/esm/clusters/dishwasher-alarm.d.ts +14 -17
- package/dist/esm/clusters/dishwasher-alarm.d.ts.map +1 -1
- package/dist/esm/clusters/dishwasher-alarm.js +3 -4
- package/dist/esm/clusters/dishwasher-alarm.js.map +1 -1
- package/dist/esm/clusters/dishwasher-mode.d.ts +65 -105
- package/dist/esm/clusters/dishwasher-mode.d.ts.map +1 -1
- package/dist/esm/clusters/dishwasher-mode.js +13 -25
- package/dist/esm/clusters/dishwasher-mode.js.map +1 -1
- package/dist/esm/clusters/door-lock.d.ts +2751 -5427
- package/dist/esm/clusters/door-lock.d.ts.map +1 -1
- package/dist/esm/clusters/door-lock.js +482 -804
- package/dist/esm/clusters/door-lock.js.map +2 -2
- package/dist/esm/clusters/ecosystem-information.d.ts +186 -0
- package/dist/esm/clusters/ecosystem-information.d.ts.map +1 -0
- package/dist/esm/clusters/ecosystem-information.js +134 -0
- package/dist/esm/clusters/ecosystem-information.js.map +6 -0
- package/dist/esm/clusters/electrical-energy-measurement.d.ts +363 -368
- package/dist/esm/clusters/electrical-energy-measurement.d.ts.map +1 -1
- package/dist/esm/clusters/electrical-energy-measurement.js +15 -16
- package/dist/esm/clusters/electrical-energy-measurement.js.map +1 -1
- package/dist/esm/clusters/energy-evse-mode.d.ts +92 -330
- package/dist/esm/clusters/energy-evse-mode.d.ts.map +1 -1
- package/dist/esm/clusters/energy-evse-mode.js +25 -79
- package/dist/esm/clusters/energy-evse-mode.js.map +1 -1
- package/dist/esm/clusters/energy-evse.d.ts +557 -273
- package/dist/esm/clusters/energy-evse.d.ts.map +1 -1
- package/dist/esm/clusters/energy-evse.js +107 -55
- package/dist/esm/clusters/energy-evse.js.map +1 -1
- package/dist/esm/clusters/energy-preference.d.ts +76 -76
- package/dist/esm/clusters/energy-preference.d.ts.map +1 -1
- package/dist/esm/clusters/energy-preference.js +15 -18
- package/dist/esm/clusters/energy-preference.js.map +1 -1
- package/dist/esm/clusters/ethernet-network-diagnostics.d.ts +3 -9
- package/dist/esm/clusters/ethernet-network-diagnostics.d.ts.map +1 -1
- package/dist/esm/clusters/ethernet-network-diagnostics.js +1 -3
- package/dist/esm/clusters/ethernet-network-diagnostics.js.map +1 -1
- package/dist/esm/clusters/fan-control.d.ts +12 -12
- package/dist/esm/clusters/fan-control.js +4 -4
- package/dist/esm/clusters/fixed-label.d.ts +7 -2
- package/dist/esm/clusters/fixed-label.d.ts.map +1 -1
- package/dist/esm/clusters/fixed-label.js.map +1 -1
- package/dist/esm/clusters/flow-measurement.d.ts +4 -4
- package/dist/esm/clusters/flow-measurement.d.ts.map +1 -1
- package/dist/esm/clusters/flow-measurement.js +6 -6
- package/dist/esm/clusters/flow-measurement.js.map +1 -1
- package/dist/esm/clusters/general-commissioning.d.ts +1416 -111
- package/dist/esm/clusters/general-commissioning.d.ts.map +1 -1
- package/dist/esm/clusters/general-commissioning.js +274 -56
- package/dist/esm/clusters/general-commissioning.js.map +2 -2
- package/dist/esm/clusters/general-diagnostics.d.ts +115 -122
- package/dist/esm/clusters/general-diagnostics.d.ts.map +1 -1
- package/dist/esm/clusters/general-diagnostics.js +31 -33
- package/dist/esm/clusters/general-diagnostics.js.map +1 -1
- package/dist/esm/clusters/group-key-management.d.ts +72 -82
- package/dist/esm/clusters/group-key-management.d.ts.map +1 -1
- package/dist/esm/clusters/group-key-management.js +19 -22
- package/dist/esm/clusters/group-key-management.js.map +1 -1
- package/dist/esm/clusters/groups.d.ts +9 -6
- package/dist/esm/clusters/groups.d.ts.map +1 -1
- package/dist/esm/clusters/groups.js +3 -2
- package/dist/esm/clusters/groups.js.map +1 -1
- package/dist/esm/clusters/icd-management.d.ts +223 -66
- package/dist/esm/clusters/icd-management.d.ts.map +1 -1
- package/dist/esm/clusters/icd-management.js +61 -23
- package/dist/esm/clusters/icd-management.js.map +2 -2
- package/dist/esm/clusters/identify.d.ts +12 -13
- package/dist/esm/clusters/identify.d.ts.map +1 -1
- package/dist/esm/clusters/identify.js +9 -10
- package/dist/esm/clusters/identify.js.map +1 -1
- package/dist/esm/clusters/illuminance-measurement.d.ts +7 -8
- package/dist/esm/clusters/illuminance-measurement.d.ts.map +1 -1
- package/dist/esm/clusters/illuminance-measurement.js +9 -10
- package/dist/esm/clusters/illuminance-measurement.js.map +1 -1
- package/dist/esm/clusters/index.d.ts +11 -1
- package/dist/esm/clusters/index.d.ts.map +1 -1
- package/dist/esm/clusters/index.js +36 -3
- package/dist/esm/clusters/index.js.map +1 -1
- package/dist/esm/clusters/joint-fabric-datastore-cluster.d.ts +1239 -0
- package/dist/esm/clusters/joint-fabric-datastore-cluster.d.ts.map +1 -0
- package/dist/esm/clusters/joint-fabric-datastore-cluster.js +470 -0
- package/dist/esm/clusters/joint-fabric-datastore-cluster.js.map +6 -0
- package/dist/esm/clusters/joint-fabric-pki.d.ts +174 -0
- package/dist/esm/clusters/joint-fabric-pki.d.ts.map +1 -0
- package/dist/esm/clusters/joint-fabric-pki.js +100 -0
- package/dist/esm/clusters/joint-fabric-pki.js.map +6 -0
- package/dist/esm/clusters/keypad-input.d.ts +2 -2
- package/dist/esm/clusters/laundry-dryer-controls.d.ts +6 -7
- package/dist/esm/clusters/laundry-dryer-controls.d.ts.map +1 -1
- package/dist/esm/clusters/laundry-dryer-controls.js +6 -10
- package/dist/esm/clusters/laundry-dryer-controls.js.map +1 -1
- package/dist/esm/clusters/laundry-washer-controls.d.ts +74 -62
- package/dist/esm/clusters/laundry-washer-controls.d.ts.map +1 -1
- package/dist/esm/clusters/laundry-washer-controls.js +26 -25
- package/dist/esm/clusters/laundry-washer-controls.js.map +1 -1
- package/dist/esm/clusters/laundry-washer-mode.d.ts +69 -109
- package/dist/esm/clusters/laundry-washer-mode.d.ts.map +1 -1
- package/dist/esm/clusters/laundry-washer-mode.js +14 -26
- package/dist/esm/clusters/laundry-washer-mode.js.map +1 -1
- package/dist/esm/clusters/level-control.d.ts +209 -70
- package/dist/esm/clusters/level-control.d.ts.map +1 -1
- package/dist/esm/clusters/level-control.js +45 -12
- package/dist/esm/clusters/level-control.js.map +1 -1
- package/dist/esm/clusters/localization-configuration.d.ts +5 -6
- package/dist/esm/clusters/localization-configuration.d.ts.map +1 -1
- package/dist/esm/clusters/localization-configuration.js +5 -6
- package/dist/esm/clusters/localization-configuration.js.map +1 -1
- package/dist/esm/clusters/media-input.d.ts +9 -6
- package/dist/esm/clusters/media-input.d.ts.map +1 -1
- package/dist/esm/clusters/media-input.js +3 -2
- package/dist/esm/clusters/media-input.js.map +1 -1
- package/dist/esm/clusters/media-playback.d.ts +29 -24
- package/dist/esm/clusters/media-playback.d.ts.map +1 -1
- package/dist/esm/clusters/media-playback.js +5 -4
- package/dist/esm/clusters/media-playback.js.map +1 -1
- package/dist/esm/clusters/microwave-oven-control.d.ts +54 -48
- package/dist/esm/clusters/microwave-oven-control.d.ts.map +1 -1
- package/dist/esm/clusters/microwave-oven-control.js +19 -17
- package/dist/esm/clusters/microwave-oven-control.js.map +1 -1
- package/dist/esm/clusters/microwave-oven-mode.d.ts +63 -69
- package/dist/esm/clusters/microwave-oven-mode.d.ts.map +1 -1
- package/dist/esm/clusters/microwave-oven-mode.js +14 -11
- package/dist/esm/clusters/microwave-oven-mode.js.map +1 -1
- package/dist/esm/clusters/mode-base.d.ts +27 -46
- package/dist/esm/clusters/mode-base.d.ts.map +1 -1
- package/dist/esm/clusters/mode-base.js +9 -10
- package/dist/esm/clusters/mode-base.js.map +1 -1
- package/dist/esm/clusters/mode-select.d.ts +33 -27
- package/dist/esm/clusters/mode-select.d.ts.map +1 -1
- package/dist/esm/clusters/mode-select.js +14 -13
- package/dist/esm/clusters/mode-select.js.map +1 -1
- package/dist/esm/clusters/network-commissioning.d.ts +263 -240
- package/dist/esm/clusters/network-commissioning.d.ts.map +1 -1
- package/dist/esm/clusters/network-commissioning.js +46 -39
- package/dist/esm/clusters/network-commissioning.js.map +1 -1
- package/dist/esm/clusters/occupancy-sensing.d.ts +1002 -63
- package/dist/esm/clusters/occupancy-sensing.d.ts.map +1 -1
- package/dist/esm/clusters/occupancy-sensing.js +287 -65
- package/dist/esm/clusters/occupancy-sensing.js.map +2 -2
- package/dist/esm/clusters/on-off.d.ts +18 -24
- package/dist/esm/clusters/on-off.d.ts.map +1 -1
- package/dist/esm/clusters/on-off.js +3 -4
- package/dist/esm/clusters/on-off.js.map +1 -1
- package/dist/esm/clusters/operational-credentials.d.ts +98 -85
- package/dist/esm/clusters/operational-credentials.d.ts.map +1 -1
- package/dist/esm/clusters/operational-credentials.js +56 -49
- package/dist/esm/clusters/operational-credentials.js.map +1 -1
- package/dist/esm/clusters/operational-state.d.ts +136 -57
- package/dist/esm/clusters/operational-state.d.ts.map +1 -1
- package/dist/esm/clusters/operational-state.js +63 -37
- package/dist/esm/clusters/operational-state.js.map +2 -2
- package/dist/esm/clusters/ota-software-update-provider.d.ts +43 -42
- package/dist/esm/clusters/ota-software-update-provider.d.ts.map +1 -1
- package/dist/esm/clusters/ota-software-update-provider.js +20 -19
- package/dist/esm/clusters/ota-software-update-provider.js.map +1 -1
- package/dist/esm/clusters/ota-software-update-requestor.d.ts +6 -10
- package/dist/esm/clusters/ota-software-update-requestor.d.ts.map +1 -1
- package/dist/esm/clusters/ota-software-update-requestor.js +4 -6
- package/dist/esm/clusters/ota-software-update-requestor.js.map +1 -1
- package/dist/esm/clusters/oven-cavity-operational-state.d.ts +44 -154
- package/dist/esm/clusters/oven-cavity-operational-state.d.ts.map +1 -1
- package/dist/esm/clusters/oven-cavity-operational-state.js +41 -166
- package/dist/esm/clusters/oven-cavity-operational-state.js.map +1 -1
- package/dist/esm/clusters/oven-mode.d.ts +79 -349
- package/dist/esm/clusters/oven-mode.d.ts.map +1 -1
- package/dist/esm/clusters/oven-mode.js +26 -89
- package/dist/esm/clusters/oven-mode.js.map +1 -1
- package/dist/esm/clusters/power-source.d.ts +169 -44
- package/dist/esm/clusters/power-source.d.ts.map +1 -1
- package/dist/esm/clusters/power-source.js +40 -16
- package/dist/esm/clusters/power-source.js.map +1 -1
- package/dist/esm/clusters/pressure-measurement.js +2 -2
- package/dist/esm/clusters/pressure-measurement.js.map +1 -1
- package/dist/esm/clusters/pump-configuration-and-control.d.ts +73 -63
- package/dist/esm/clusters/pump-configuration-and-control.d.ts.map +1 -1
- package/dist/esm/clusters/pump-configuration-and-control.js +19 -20
- package/dist/esm/clusters/pump-configuration-and-control.js.map +1 -1
- package/dist/esm/clusters/refrigerator-alarm.d.ts +2 -1
- package/dist/esm/clusters/refrigerator-alarm.d.ts.map +1 -1
- package/dist/esm/clusters/refrigerator-alarm.js.map +1 -1
- package/dist/esm/clusters/refrigerator-and-temperature-controlled-cabinet-mode.d.ts +59 -91
- package/dist/esm/clusters/refrigerator-and-temperature-controlled-cabinet-mode.d.ts.map +1 -1
- package/dist/esm/clusters/refrigerator-and-temperature-controlled-cabinet-mode.js +12 -20
- package/dist/esm/clusters/refrigerator-and-temperature-controlled-cabinet-mode.js.map +1 -1
- package/dist/esm/clusters/relative-humidity-measurement.js +1 -1
- package/dist/esm/clusters/relative-humidity-measurement.js.map +1 -1
- package/dist/esm/clusters/rvc-clean-mode.d.ts +59 -103
- package/dist/esm/clusters/rvc-clean-mode.d.ts.map +1 -1
- package/dist/esm/clusters/rvc-clean-mode.js +11 -15
- package/dist/esm/clusters/rvc-clean-mode.js.map +1 -1
- package/dist/esm/clusters/rvc-operational-state.d.ts +81 -25
- package/dist/esm/clusters/rvc-operational-state.d.ts.map +1 -1
- package/dist/esm/clusters/rvc-operational-state.js +49 -20
- package/dist/esm/clusters/rvc-operational-state.js.map +1 -1
- package/dist/esm/clusters/rvc-run-mode.d.ts +85 -129
- package/dist/esm/clusters/rvc-run-mode.d.ts.map +1 -1
- package/dist/esm/clusters/rvc-run-mode.js +16 -15
- package/dist/esm/clusters/rvc-run-mode.js.map +1 -1
- package/dist/esm/clusters/scenes-management.d.ts +328 -181
- package/dist/esm/clusters/scenes-management.d.ts.map +1 -1
- package/dist/esm/clusters/scenes-management.js +37 -22
- package/dist/esm/clusters/scenes-management.js.map +1 -1
- package/dist/esm/clusters/service-area.d.ts +2052 -0
- package/dist/esm/clusters/service-area.d.ts.map +1 -0
- package/dist/esm/clusters/service-area.js +562 -0
- package/dist/esm/clusters/service-area.js.map +6 -0
- package/dist/esm/clusters/smoke-co-alarm.d.ts +10 -18
- package/dist/esm/clusters/smoke-co-alarm.d.ts.map +1 -1
- package/dist/esm/clusters/smoke-co-alarm.js +2 -3
- package/dist/esm/clusters/smoke-co-alarm.js.map +1 -1
- package/dist/esm/clusters/switch.d.ts +478 -191
- package/dist/esm/clusters/switch.d.ts.map +1 -1
- package/dist/esm/clusters/switch.js +145 -57
- package/dist/esm/clusters/switch.js.map +1 -1
- package/dist/esm/clusters/target-navigator.d.ts +1 -1
- package/dist/esm/clusters/target-navigator.js +1 -1
- package/dist/esm/clusters/thermostat.d.ts +3877 -830
- package/dist/esm/clusters/thermostat.d.ts.map +1 -1
- package/dist/esm/clusters/thermostat.js +842 -160
- package/dist/esm/clusters/thermostat.js.map +2 -2
- package/dist/esm/clusters/thread-border-router-management.d.ts +711 -0
- package/dist/esm/clusters/thread-border-router-management.d.ts.map +1 -0
- package/dist/esm/clusters/thread-border-router-management.js +245 -0
- package/dist/esm/clusters/thread-border-router-management.js.map +6 -0
- package/dist/esm/clusters/thread-network-diagnostics.d.ts +81 -55
- package/dist/esm/clusters/thread-network-diagnostics.d.ts.map +1 -1
- package/dist/esm/clusters/thread-network-diagnostics.js +32 -21
- package/dist/esm/clusters/thread-network-diagnostics.js.map +1 -1
- package/dist/esm/clusters/thread-network-directory.d.ts +250 -0
- package/dist/esm/clusters/thread-network-directory.d.ts.map +1 -0
- package/dist/esm/clusters/thread-network-directory.js +167 -0
- package/dist/esm/clusters/thread-network-directory.js.map +6 -0
- package/dist/esm/clusters/time-synchronization.d.ts +101 -76
- package/dist/esm/clusters/time-synchronization.d.ts.map +1 -1
- package/dist/esm/clusters/time-synchronization.js +30 -23
- package/dist/esm/clusters/time-synchronization.js.map +1 -1
- package/dist/esm/clusters/unit-localization.d.ts +3 -4
- package/dist/esm/clusters/unit-localization.d.ts.map +1 -1
- package/dist/esm/clusters/unit-localization.js.map +1 -1
- package/dist/esm/clusters/user-label.d.ts +2 -1
- package/dist/esm/clusters/user-label.d.ts.map +1 -1
- package/dist/esm/clusters/user-label.js.map +1 -1
- package/dist/esm/clusters/water-heater-management.d.ts +1371 -0
- package/dist/esm/clusters/water-heater-management.d.ts.map +1 -0
- package/dist/esm/clusters/water-heater-management.js +325 -0
- package/dist/esm/clusters/water-heater-management.js.map +6 -0
- package/dist/esm/clusters/water-heater-mode.d.ts +491 -0
- package/dist/esm/clusters/water-heater-mode.d.ts.map +1 -0
- package/dist/esm/clusters/water-heater-mode.js +175 -0
- package/dist/esm/clusters/water-heater-mode.js.map +6 -0
- package/dist/esm/clusters/water-tank-level-monitoring.d.ts +162 -0
- package/dist/esm/clusters/water-tank-level-monitoring.d.ts.map +1 -0
- package/dist/esm/clusters/water-tank-level-monitoring.js +27 -0
- package/dist/esm/clusters/water-tank-level-monitoring.js.map +6 -0
- package/dist/esm/clusters/wi-fi-network-diagnostics.d.ts +20 -27
- package/dist/esm/clusters/wi-fi-network-diagnostics.d.ts.map +1 -1
- package/dist/esm/clusters/wi-fi-network-diagnostics.js +6 -8
- package/dist/esm/clusters/wi-fi-network-diagnostics.js.map +1 -1
- package/dist/esm/clusters/wi-fi-network-management.d.ts +91 -0
- package/dist/esm/clusters/wi-fi-network-management.d.ts.map +1 -0
- package/dist/esm/clusters/wi-fi-network-management.js +102 -0
- package/dist/esm/clusters/wi-fi-network-management.js.map +6 -0
- package/dist/esm/clusters/window-covering.d.ts +66 -78
- package/dist/esm/clusters/window-covering.d.ts.map +1 -1
- package/dist/esm/clusters/window-covering.js +26 -37
- package/dist/esm/clusters/window-covering.js.map +1 -1
- package/dist/esm/globals/AtomicAttributeStatus.d.ts +34 -0
- package/dist/esm/globals/AtomicAttributeStatus.d.ts.map +1 -0
- package/dist/esm/globals/AtomicAttributeStatus.js +26 -0
- package/dist/esm/globals/AtomicAttributeStatus.js.map +6 -0
- package/dist/esm/globals/AtomicRequestType.d.ts +24 -0
- package/dist/esm/globals/AtomicRequestType.d.ts.map +1 -0
- package/dist/esm/globals/AtomicRequestType.js +15 -0
- package/dist/esm/globals/AtomicRequestType.js.map +6 -0
- package/dist/esm/globals/Locationdesc.d.ts +79 -0
- package/dist/esm/globals/Locationdesc.d.ts.map +1 -0
- package/dist/esm/globals/Locationdesc.js +69 -0
- package/dist/esm/globals/Locationdesc.js.map +6 -0
- package/dist/esm/globals/Priority.d.ts +1 -1
- package/dist/esm/globals/Semtag.d.ts +6 -6
- package/dist/esm/globals/Semtag.js +4 -4
- package/dist/esm/globals/SoftwareVersionCertificationStatus.d.ts +1 -1
- package/dist/esm/globals/Status.d.ts +18 -3
- package/dist/esm/globals/Status.d.ts.map +1 -1
- package/dist/esm/globals/Status.js +3 -1
- package/dist/esm/globals/Status.js.map +1 -1
- package/dist/esm/globals/Tod.d.ts +2 -2
- package/dist/esm/globals/index.d.ts +3 -0
- package/dist/esm/globals/index.d.ts.map +1 -1
- package/dist/esm/globals/index.js +3 -0
- package/dist/esm/globals/index.js.map +1 -1
- package/dist/esm/schema/QrCodeSchema.d.ts.map +1 -1
- package/dist/esm/schema/QrCodeSchema.js +4 -1
- package/dist/esm/schema/QrCodeSchema.js.map +1 -1
- package/package.json +5 -5
- package/src/clusters/access-control.ts +926 -171
- package/src/clusters/actions.ts +12 -11
- package/src/clusters/administrator-commissioning.ts +54 -35
- package/src/clusters/alarm-base.ts +3 -4
- package/src/clusters/application-launcher.ts +22 -7
- package/src/clusters/ballast-configuration.ts +7 -7
- package/src/clusters/basic-information.ts +29 -21
- package/src/clusters/bridged-device-basic-information.ts +264 -41
- package/src/clusters/channel.ts +20 -17
- package/src/clusters/color-control.ts +589 -426
- package/src/clusters/commissioner-control.ts +282 -0
- package/src/clusters/content-control.ts +48 -54
- package/src/clusters/content-launcher.ts +16 -15
- package/src/clusters/device-energy-management-mode.ts +63 -161
- package/src/clusters/device-energy-management.ts +246 -193
- package/src/clusters/dishwasher-alarm.ts +5 -5
- package/src/clusters/dishwasher-mode.ts +46 -87
- package/src/clusters/door-lock.ts +786 -1235
- package/src/clusters/ecosystem-information.ts +200 -0
- package/src/clusters/electrical-energy-measurement.ts +15 -16
- package/src/clusters/energy-evse-mode.ts +81 -158
- package/src/clusters/energy-evse.ts +138 -72
- package/src/clusters/energy-preference.ts +34 -28
- package/src/clusters/ethernet-network-diagnostics.ts +1 -3
- package/src/clusters/fan-control.ts +5 -5
- package/src/clusters/fixed-label.ts +7 -2
- package/src/clusters/flow-measurement.ts +6 -6
- package/src/clusters/general-commissioning.ts +396 -96
- package/src/clusters/general-diagnostics.ts +31 -33
- package/src/clusters/group-key-management.ts +22 -24
- package/src/clusters/groups.ts +3 -2
- package/src/clusters/icd-management.ts +88 -31
- package/src/clusters/identify.ts +9 -10
- package/src/clusters/illuminance-measurement.ts +9 -10
- package/src/clusters/index.ts +14 -1
- package/src/clusters/joint-fabric-datastore-cluster.ts +657 -0
- package/src/clusters/joint-fabric-pki.ts +202 -0
- package/src/clusters/keypad-input.ts +2 -2
- package/src/clusters/laundry-dryer-controls.ts +6 -10
- package/src/clusters/laundry-washer-controls.ts +28 -27
- package/src/clusters/laundry-washer-mode.ts +49 -90
- package/src/clusters/level-control.ts +45 -12
- package/src/clusters/localization-configuration.ts +5 -6
- package/src/clusters/media-input.ts +3 -2
- package/src/clusters/media-playback.ts +9 -7
- package/src/clusters/microwave-oven-control.ts +19 -17
- package/src/clusters/microwave-oven-mode.ts +42 -61
- package/src/clusters/mode-base.ts +16 -33
- package/src/clusters/mode-select.ts +17 -14
- package/src/clusters/network-commissioning.ts +47 -40
- package/src/clusters/occupancy-sensing.ts +433 -72
- package/src/clusters/on-off.ts +6 -8
- package/src/clusters/operational-credentials.ts +54 -47
- package/src/clusters/operational-state.ts +136 -58
- package/src/clusters/ota-software-update-provider.ts +23 -23
- package/src/clusters/ota-software-update-requestor.ts +4 -6
- package/src/clusters/oven-cavity-operational-state.ts +43 -171
- package/src/clusters/oven-mode.ts +76 -178
- package/src/clusters/power-source.ts +45 -21
- package/src/clusters/pressure-measurement.ts +2 -2
- package/src/clusters/pump-configuration-and-control.ts +35 -23
- package/src/clusters/refrigerator-alarm.ts +2 -1
- package/src/clusters/refrigerator-and-temperature-controlled-cabinet-mode.ts +41 -78
- package/src/clusters/relative-humidity-measurement.ts +1 -1
- package/src/clusters/rvc-clean-mode.ts +42 -101
- package/src/clusters/rvc-operational-state.ts +87 -25
- package/src/clusters/rvc-run-mode.ts +62 -126
- package/src/clusters/scenes-management.ts +38 -23
- package/src/clusters/service-area.ts +904 -0
- package/src/clusters/smoke-co-alarm.ts +6 -12
- package/src/clusters/switch.ts +177 -78
- package/src/clusters/target-navigator.ts +1 -1
- package/src/clusters/thermostat.ts +1245 -214
- package/src/clusters/thread-border-router-management.ts +355 -0
- package/src/clusters/thread-network-diagnostics.ts +34 -21
- package/src/clusters/thread-network-directory.ts +256 -0
- package/src/clusters/time-synchronization.ts +30 -23
- package/src/clusters/unit-localization.ts +3 -4
- package/src/clusters/user-label.ts +2 -1
- package/src/clusters/water-heater-management.ts +457 -0
- package/src/clusters/water-heater-mode.ts +301 -0
- package/src/clusters/water-tank-level-monitoring.ts +50 -0
- package/src/clusters/wi-fi-network-diagnostics.ts +6 -8
- package/src/clusters/wi-fi-network-management.ts +119 -0
- package/src/clusters/window-covering.ts +26 -37
- package/src/globals/AtomicAttributeStatus.ts +41 -0
- package/src/globals/AtomicRequestType.ts +27 -0
- package/src/globals/Locationdesc.ts +88 -0
- package/src/globals/Priority.ts +1 -1
- package/src/globals/Semtag.ts +6 -6
- package/src/globals/SoftwareVersionCertificationStatus.ts +1 -1
- package/src/globals/Status.ts +20 -3
- package/src/globals/Tod.ts +2 -2
- package/src/globals/index.ts +3 -0
- package/src/schema/QrCodeSchema.ts +7 -2
- package/dist/cjs/clusters/pulse-width-modulation.d.ts +0 -2023
- package/dist/cjs/clusters/pulse-width-modulation.d.ts.map +0 -1
- package/dist/cjs/clusters/pulse-width-modulation.js +0 -51
- package/dist/cjs/clusters/pulse-width-modulation.js.map +0 -6
- package/dist/esm/clusters/pulse-width-modulation.d.ts +0 -2023
- package/dist/esm/clusters/pulse-width-modulation.d.ts.map +0 -1
- package/dist/esm/clusters/pulse-width-modulation.js +0 -31
- package/dist/esm/clusters/pulse-width-modulation.js.map +0 -6
- package/src/clusters/pulse-width-modulation.ts +0 -54
|
@@ -0,0 +1,1371 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright 2022-2025 Matter.js Authors
|
|
4
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
*/
|
|
6
|
+
/*** THIS FILE IS GENERATED, DO NOT EDIT ***/
|
|
7
|
+
import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
|
|
8
|
+
import { Attribute, FixedAttribute, Command, Event } from "../cluster/Cluster.js";
|
|
9
|
+
import { BitFlag } from "../schema/BitmapSchema.js";
|
|
10
|
+
import { TypeFromSchema } from "../tlv/TlvSchema.js";
|
|
11
|
+
import { Identity } from "#general";
|
|
12
|
+
export declare namespace WaterHeaterManagement {
|
|
13
|
+
/**
|
|
14
|
+
* These are optional features supported by WaterHeaterManagementCluster.
|
|
15
|
+
*
|
|
16
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.4
|
|
17
|
+
*/
|
|
18
|
+
enum Feature {
|
|
19
|
+
/**
|
|
20
|
+
* EnergyManagement (EM)
|
|
21
|
+
*
|
|
22
|
+
* Allows energy management control of the tank
|
|
23
|
+
*/
|
|
24
|
+
EnergyManagement = "EnergyManagement",
|
|
25
|
+
/**
|
|
26
|
+
* TankPercent (TP)
|
|
27
|
+
*
|
|
28
|
+
* Supports monitoring the percentage of hot water in the tank
|
|
29
|
+
*/
|
|
30
|
+
TankPercent = "TankPercent"
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.1
|
|
34
|
+
*/
|
|
35
|
+
const WaterHeaterHeatSource: {
|
|
36
|
+
/**
|
|
37
|
+
* Immersion Heating Element 1
|
|
38
|
+
*/
|
|
39
|
+
immersionElement1: BitFlag;
|
|
40
|
+
/**
|
|
41
|
+
* Immersion Heating Element 2
|
|
42
|
+
*/
|
|
43
|
+
immersionElement2: BitFlag;
|
|
44
|
+
/**
|
|
45
|
+
* Heat pump Heating
|
|
46
|
+
*/
|
|
47
|
+
heatPump: BitFlag;
|
|
48
|
+
/**
|
|
49
|
+
* Boiler Heating (e.g. Gas or Oil)
|
|
50
|
+
*/
|
|
51
|
+
boiler: BitFlag;
|
|
52
|
+
/**
|
|
53
|
+
* Other Heating
|
|
54
|
+
*/
|
|
55
|
+
other: BitFlag;
|
|
56
|
+
};
|
|
57
|
+
/**
|
|
58
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.2
|
|
59
|
+
*/
|
|
60
|
+
enum BoostState {
|
|
61
|
+
/**
|
|
62
|
+
* Boost is not currently active
|
|
63
|
+
*/
|
|
64
|
+
Inactive = 0,
|
|
65
|
+
/**
|
|
66
|
+
* Boost is currently active
|
|
67
|
+
*/
|
|
68
|
+
Active = 1
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3
|
|
72
|
+
*/
|
|
73
|
+
const TlvWaterHeaterBoostInfo: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
74
|
+
/**
|
|
75
|
+
* This field shall indicate the time period, in seconds, for which the boost state is activated.
|
|
76
|
+
*
|
|
77
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.1
|
|
78
|
+
*/
|
|
79
|
+
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
80
|
+
/**
|
|
81
|
+
* This field shall indicate whether the boost state shall be automatically canceled once the hot water has
|
|
82
|
+
* reached either:
|
|
83
|
+
*
|
|
84
|
+
* • the set point temperature (from the thermostat cluster)
|
|
85
|
+
*
|
|
86
|
+
* • the TemporarySetpoint temperature (if specified)
|
|
87
|
+
*
|
|
88
|
+
* • the TargetPercentage (if specified).
|
|
89
|
+
*
|
|
90
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.2
|
|
91
|
+
*/
|
|
92
|
+
oneShot: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
93
|
+
/**
|
|
94
|
+
* This field shall indicate that the consumer wants the water to be heated quickly. This may cause multiple
|
|
95
|
+
* heat sources to be activated (e.g. a heat pump and direct electric immersion heating element).
|
|
96
|
+
*
|
|
97
|
+
* The choice of which heat sources are activated is manufacturer specific.
|
|
98
|
+
*
|
|
99
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.3
|
|
100
|
+
*/
|
|
101
|
+
emergencyBoost: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
102
|
+
/**
|
|
103
|
+
* This field shall indicate the target temperature to which the water will be heated.
|
|
104
|
+
*
|
|
105
|
+
* If included, it shall be used instead of the thermostat cluster set point temperature whilst the boost state
|
|
106
|
+
* is activated.
|
|
107
|
+
*
|
|
108
|
+
* The value of this field shall be within the constraints of the MinHeatSetpointLimit and MaxHeatSetpointLimit
|
|
109
|
+
* attributes (inclusive), of the thermostat cluster.
|
|
110
|
+
*
|
|
111
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.4
|
|
112
|
+
*/
|
|
113
|
+
temporarySetpoint: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
114
|
+
/**
|
|
115
|
+
* This field shall indicate the target percentage of hot water in the tank that the TankPercentage attribute
|
|
116
|
+
* must reach before the heating is switched off.
|
|
117
|
+
*
|
|
118
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.5
|
|
119
|
+
*/
|
|
120
|
+
targetPercentage: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
121
|
+
/**
|
|
122
|
+
* This field shall indicate the percentage to which the hot water in the tank shall be allowed to fall before
|
|
123
|
+
* again beginning to reheat it.
|
|
124
|
+
*
|
|
125
|
+
* For example if the TargetPercentage was 80%, and the TargetReheat was 40%, then after initial heating to 80%
|
|
126
|
+
* hot water, the tank may have hot water drawn off until only 40% hot water remains. At this point the heater
|
|
127
|
+
* will begin to heat back up to 80% of hot water. If this field and the OneShot field were both omitted,
|
|
128
|
+
* heating would begin again after any water draw which reduced the TankPercentage below 80%.
|
|
129
|
+
*
|
|
130
|
+
* This field shall be less than or equal to the TargetPercentage field.
|
|
131
|
+
*
|
|
132
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.6
|
|
133
|
+
*/
|
|
134
|
+
targetReheat: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
135
|
+
}>;
|
|
136
|
+
/**
|
|
137
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3
|
|
138
|
+
*/
|
|
139
|
+
interface WaterHeaterBoostInfo extends TypeFromSchema<typeof TlvWaterHeaterBoostInfo> {
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* Input to the WaterHeaterManagement boost command
|
|
143
|
+
*
|
|
144
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.8.1
|
|
145
|
+
*/
|
|
146
|
+
const TlvBoostRequest: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
147
|
+
boostInfo: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
148
|
+
/**
|
|
149
|
+
* This field shall indicate the time period, in seconds, for which the boost state is activated.
|
|
150
|
+
*
|
|
151
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.1
|
|
152
|
+
*/
|
|
153
|
+
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
154
|
+
/**
|
|
155
|
+
* This field shall indicate whether the boost state shall be automatically canceled once the hot water has
|
|
156
|
+
* reached either:
|
|
157
|
+
*
|
|
158
|
+
* • the set point temperature (from the thermostat cluster)
|
|
159
|
+
*
|
|
160
|
+
* • the TemporarySetpoint temperature (if specified)
|
|
161
|
+
*
|
|
162
|
+
* • the TargetPercentage (if specified).
|
|
163
|
+
*
|
|
164
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.2
|
|
165
|
+
*/
|
|
166
|
+
oneShot: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
167
|
+
/**
|
|
168
|
+
* This field shall indicate that the consumer wants the water to be heated quickly. This may cause multiple
|
|
169
|
+
* heat sources to be activated (e.g. a heat pump and direct electric immersion heating element).
|
|
170
|
+
*
|
|
171
|
+
* The choice of which heat sources are activated is manufacturer specific.
|
|
172
|
+
*
|
|
173
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.3
|
|
174
|
+
*/
|
|
175
|
+
emergencyBoost: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
176
|
+
/**
|
|
177
|
+
* This field shall indicate the target temperature to which the water will be heated.
|
|
178
|
+
*
|
|
179
|
+
* If included, it shall be used instead of the thermostat cluster set point temperature whilst the boost state
|
|
180
|
+
* is activated.
|
|
181
|
+
*
|
|
182
|
+
* The value of this field shall be within the constraints of the MinHeatSetpointLimit and MaxHeatSetpointLimit
|
|
183
|
+
* attributes (inclusive), of the thermostat cluster.
|
|
184
|
+
*
|
|
185
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.4
|
|
186
|
+
*/
|
|
187
|
+
temporarySetpoint: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
188
|
+
/**
|
|
189
|
+
* This field shall indicate the target percentage of hot water in the tank that the TankPercentage attribute
|
|
190
|
+
* must reach before the heating is switched off.
|
|
191
|
+
*
|
|
192
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.5
|
|
193
|
+
*/
|
|
194
|
+
targetPercentage: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
195
|
+
/**
|
|
196
|
+
* This field shall indicate the percentage to which the hot water in the tank shall be allowed to fall before
|
|
197
|
+
* again beginning to reheat it.
|
|
198
|
+
*
|
|
199
|
+
* For example if the TargetPercentage was 80%, and the TargetReheat was 40%, then after initial heating to 80%
|
|
200
|
+
* hot water, the tank may have hot water drawn off until only 40% hot water remains. At this point the heater
|
|
201
|
+
* will begin to heat back up to 80% of hot water. If this field and the OneShot field were both omitted,
|
|
202
|
+
* heating would begin again after any water draw which reduced the TankPercentage below 80%.
|
|
203
|
+
*
|
|
204
|
+
* This field shall be less than or equal to the TargetPercentage field.
|
|
205
|
+
*
|
|
206
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.6
|
|
207
|
+
*/
|
|
208
|
+
targetReheat: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
209
|
+
}>>;
|
|
210
|
+
}>;
|
|
211
|
+
/**
|
|
212
|
+
* Input to the WaterHeaterManagement boost command
|
|
213
|
+
*
|
|
214
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.8.1
|
|
215
|
+
*/
|
|
216
|
+
interface BoostRequest extends TypeFromSchema<typeof TlvBoostRequest> {
|
|
217
|
+
}
|
|
218
|
+
/**
|
|
219
|
+
* Body of the WaterHeaterManagement boostStarted event
|
|
220
|
+
*
|
|
221
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.9.1
|
|
222
|
+
*/
|
|
223
|
+
const TlvBoostStartedEvent: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
224
|
+
boostInfo: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
225
|
+
/**
|
|
226
|
+
* This field shall indicate the time period, in seconds, for which the boost state is activated.
|
|
227
|
+
*
|
|
228
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.1
|
|
229
|
+
*/
|
|
230
|
+
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
231
|
+
/**
|
|
232
|
+
* This field shall indicate whether the boost state shall be automatically canceled once the hot water has
|
|
233
|
+
* reached either:
|
|
234
|
+
*
|
|
235
|
+
* • the set point temperature (from the thermostat cluster)
|
|
236
|
+
*
|
|
237
|
+
* • the TemporarySetpoint temperature (if specified)
|
|
238
|
+
*
|
|
239
|
+
* • the TargetPercentage (if specified).
|
|
240
|
+
*
|
|
241
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.2
|
|
242
|
+
*/
|
|
243
|
+
oneShot: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
244
|
+
/**
|
|
245
|
+
* This field shall indicate that the consumer wants the water to be heated quickly. This may cause multiple
|
|
246
|
+
* heat sources to be activated (e.g. a heat pump and direct electric immersion heating element).
|
|
247
|
+
*
|
|
248
|
+
* The choice of which heat sources are activated is manufacturer specific.
|
|
249
|
+
*
|
|
250
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.3
|
|
251
|
+
*/
|
|
252
|
+
emergencyBoost: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
253
|
+
/**
|
|
254
|
+
* This field shall indicate the target temperature to which the water will be heated.
|
|
255
|
+
*
|
|
256
|
+
* If included, it shall be used instead of the thermostat cluster set point temperature whilst the boost state
|
|
257
|
+
* is activated.
|
|
258
|
+
*
|
|
259
|
+
* The value of this field shall be within the constraints of the MinHeatSetpointLimit and MaxHeatSetpointLimit
|
|
260
|
+
* attributes (inclusive), of the thermostat cluster.
|
|
261
|
+
*
|
|
262
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.4
|
|
263
|
+
*/
|
|
264
|
+
temporarySetpoint: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
265
|
+
/**
|
|
266
|
+
* This field shall indicate the target percentage of hot water in the tank that the TankPercentage attribute
|
|
267
|
+
* must reach before the heating is switched off.
|
|
268
|
+
*
|
|
269
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.5
|
|
270
|
+
*/
|
|
271
|
+
targetPercentage: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
272
|
+
/**
|
|
273
|
+
* This field shall indicate the percentage to which the hot water in the tank shall be allowed to fall before
|
|
274
|
+
* again beginning to reheat it.
|
|
275
|
+
*
|
|
276
|
+
* For example if the TargetPercentage was 80%, and the TargetReheat was 40%, then after initial heating to 80%
|
|
277
|
+
* hot water, the tank may have hot water drawn off until only 40% hot water remains. At this point the heater
|
|
278
|
+
* will begin to heat back up to 80% of hot water. If this field and the OneShot field were both omitted,
|
|
279
|
+
* heating would begin again after any water draw which reduced the TankPercentage below 80%.
|
|
280
|
+
*
|
|
281
|
+
* This field shall be less than or equal to the TargetPercentage field.
|
|
282
|
+
*
|
|
283
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.6
|
|
284
|
+
*/
|
|
285
|
+
targetReheat: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
286
|
+
}>>;
|
|
287
|
+
}>;
|
|
288
|
+
/**
|
|
289
|
+
* Body of the WaterHeaterManagement boostStarted event
|
|
290
|
+
*
|
|
291
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.9.1
|
|
292
|
+
*/
|
|
293
|
+
interface BoostStartedEvent extends TypeFromSchema<typeof TlvBoostStartedEvent> {
|
|
294
|
+
}
|
|
295
|
+
/**
|
|
296
|
+
* A WaterHeaterManagementCluster supports these elements if it supports feature EnergyManagement.
|
|
297
|
+
*/
|
|
298
|
+
const EnergyManagementComponent: {
|
|
299
|
+
readonly attributes: {
|
|
300
|
+
/**
|
|
301
|
+
* Indicates the volume of water that the hot water tank can hold (in units of Litres). This allows an
|
|
302
|
+
* energy management system to estimate the required heating energy needed to reach the target temperature.
|
|
303
|
+
*
|
|
304
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.3
|
|
305
|
+
*/
|
|
306
|
+
readonly tankVolume: Attribute<number, any>;
|
|
307
|
+
/**
|
|
308
|
+
* Indicates the estimated heat energy needed to raise the water temperature to the target setpoint. This
|
|
309
|
+
* can be computed by taking the specific heat capacity of water (4182 J/kg °C) and by knowing the current
|
|
310
|
+
* temperature of the water, the tank volume and target temperature.
|
|
311
|
+
*
|
|
312
|
+
* For example, if the target temperature was 60°C, the current temperature was 20°C and the tank volume
|
|
313
|
+
* was 100L:
|
|
314
|
+
*
|
|
315
|
+
* Mass of water = 1kg per Litre
|
|
316
|
+
*
|
|
317
|
+
* Total Mass = 100 x 1kg = 100kg
|
|
318
|
+
*
|
|
319
|
+
* Δ Temperature = (target temperature - current temperature)
|
|
320
|
+
*
|
|
321
|
+
* = (60°C - 20°C) = 40°C
|
|
322
|
+
*
|
|
323
|
+
* Energy required to
|
|
324
|
+
*
|
|
325
|
+
* heat the water to 60°C = 4182 x 40 x 100 = 16,728,000 J
|
|
326
|
+
*
|
|
327
|
+
* Converting Joules in to Wh of heat (divide by 3600):
|
|
328
|
+
*
|
|
329
|
+
* If the TankPercent feature is supported, then this estimate shall also take into account the percentage
|
|
330
|
+
* of the water in the tank which is already hot.
|
|
331
|
+
*
|
|
332
|
+
* NOTE
|
|
333
|
+
*
|
|
334
|
+
* The electrical energy required to heat the water depends on the heating system used to heat the water.
|
|
335
|
+
* For example, a direct electric immersion heating element can be close to 100% efficient, so the
|
|
336
|
+
* electrical energy needed to heat the hot water is nearly the same as the EstimatedHeatEnergyRequired.
|
|
337
|
+
* However some forms of heating, such as an air-source heat pump which extracts heat from ambient air,
|
|
338
|
+
* requires much less electrical energy to heat hot water. Heat pumps can be produce 3kWh of heat output
|
|
339
|
+
* for 1kWh of electrical energy input. The conversion between heat energy and electrical energy is outside
|
|
340
|
+
* the scope of this cluster.
|
|
341
|
+
*
|
|
342
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.4
|
|
343
|
+
*/
|
|
344
|
+
readonly estimatedHeatRequired: Attribute<number | bigint, any>;
|
|
345
|
+
};
|
|
346
|
+
};
|
|
347
|
+
/**
|
|
348
|
+
* A WaterHeaterManagementCluster supports these elements if it supports feature TankPercent.
|
|
349
|
+
*/
|
|
350
|
+
const TankPercentComponent: {
|
|
351
|
+
readonly attributes: {
|
|
352
|
+
/**
|
|
353
|
+
* Indicates an approximate level of hot water stored in the tank, which might help consumers understand
|
|
354
|
+
* the amount of hot water remaining in the tank. The accuracy of this attribute is manufacturer specific.
|
|
355
|
+
*
|
|
356
|
+
* In most hot water tanks, there is a stratification effect where the hot water layer rests above a cooler
|
|
357
|
+
* layer of water below. For this reason cold water is fed in at the bottom of the tank and the hot water
|
|
358
|
+
* is drawn from the top.
|
|
359
|
+
*
|
|
360
|
+
* Some water tanks might use multiple temperature probes to estimate the level of the hot water layer. A
|
|
361
|
+
* water heater with multiple temperature probes is likely to implement an algorithm to estimate the hot
|
|
362
|
+
* water tank percentage by taking into account the temperature values of each probe to determine the
|
|
363
|
+
* height of the hot water.
|
|
364
|
+
*
|
|
365
|
+
* However it might be possible with a single temperature probe to estimate how much hot water is left
|
|
366
|
+
* using a simpler algorithm:
|
|
367
|
+
*
|
|
368
|
+
* For example, if the target temperature was 60°C, the CurrentTemperature was 40°C from a single
|
|
369
|
+
* temperature probe measuring the average water temperature and the temperature of incoming cold water
|
|
370
|
+
* (COLD_WATER_TEMP) was assumed to be 20°C:
|
|
371
|
+
*
|
|
372
|
+
* TankPercentage = int(((current temperature - COLD_WATER_TEMP) / (target temperature - COLD_WATER_TEMP))
|
|
373
|
+
* * 100)
|
|
374
|
+
*
|
|
375
|
+
* TankPercentage = min( max(TankPercentage,0), 100)
|
|
376
|
+
*
|
|
377
|
+
* TankPercentage = 50%
|
|
378
|
+
*
|
|
379
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.5
|
|
380
|
+
*/
|
|
381
|
+
readonly tankPercentage: Attribute<number, any>;
|
|
382
|
+
};
|
|
383
|
+
};
|
|
384
|
+
/**
|
|
385
|
+
* These elements and properties are present in all WaterHeaterManagement clusters.
|
|
386
|
+
*/
|
|
387
|
+
const Base: {
|
|
388
|
+
readonly id: 148;
|
|
389
|
+
readonly name: "WaterHeaterManagement";
|
|
390
|
+
readonly revision: 2;
|
|
391
|
+
readonly features: {
|
|
392
|
+
/**
|
|
393
|
+
* EnergyManagement
|
|
394
|
+
*
|
|
395
|
+
* Allows energy management control of the tank
|
|
396
|
+
*/
|
|
397
|
+
readonly energyManagement: BitFlag;
|
|
398
|
+
/**
|
|
399
|
+
* TankPercent
|
|
400
|
+
*
|
|
401
|
+
* Supports monitoring the percentage of hot water in the tank
|
|
402
|
+
*/
|
|
403
|
+
readonly tankPercent: BitFlag;
|
|
404
|
+
};
|
|
405
|
+
readonly attributes: {
|
|
406
|
+
/**
|
|
407
|
+
* Indicates the heat sources that the water heater can call on for heating. If a bit is set then the water
|
|
408
|
+
* heater supports the corresponding heat source.
|
|
409
|
+
*
|
|
410
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.1
|
|
411
|
+
*/
|
|
412
|
+
readonly heaterTypes: FixedAttribute<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
413
|
+
/**
|
|
414
|
+
* Immersion Heating Element 1
|
|
415
|
+
*/
|
|
416
|
+
immersionElement1: BitFlag;
|
|
417
|
+
/**
|
|
418
|
+
* Immersion Heating Element 2
|
|
419
|
+
*/
|
|
420
|
+
immersionElement2: BitFlag;
|
|
421
|
+
/**
|
|
422
|
+
* Heat pump Heating
|
|
423
|
+
*/
|
|
424
|
+
heatPump: BitFlag;
|
|
425
|
+
/**
|
|
426
|
+
* Boiler Heating (e.g. Gas or Oil)
|
|
427
|
+
*/
|
|
428
|
+
boiler: BitFlag;
|
|
429
|
+
/**
|
|
430
|
+
* Other Heating
|
|
431
|
+
*/
|
|
432
|
+
other: BitFlag;
|
|
433
|
+
}>, any>;
|
|
434
|
+
/**
|
|
435
|
+
* Indicates if the water heater is heating water. If a bit is set then the corresponding heat source is
|
|
436
|
+
* active.
|
|
437
|
+
*
|
|
438
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.2
|
|
439
|
+
*/
|
|
440
|
+
readonly heatDemand: Attribute<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
441
|
+
/**
|
|
442
|
+
* Immersion Heating Element 1
|
|
443
|
+
*/
|
|
444
|
+
immersionElement1: BitFlag;
|
|
445
|
+
/**
|
|
446
|
+
* Immersion Heating Element 2
|
|
447
|
+
*/
|
|
448
|
+
immersionElement2: BitFlag;
|
|
449
|
+
/**
|
|
450
|
+
* Heat pump Heating
|
|
451
|
+
*/
|
|
452
|
+
heatPump: BitFlag;
|
|
453
|
+
/**
|
|
454
|
+
* Boiler Heating (e.g. Gas or Oil)
|
|
455
|
+
*/
|
|
456
|
+
boiler: BitFlag;
|
|
457
|
+
/**
|
|
458
|
+
* Other Heating
|
|
459
|
+
*/
|
|
460
|
+
other: BitFlag;
|
|
461
|
+
}>, any>;
|
|
462
|
+
/**
|
|
463
|
+
* Indicates whether the Boost, as triggered by a Boost command, is currently
|
|
464
|
+
*
|
|
465
|
+
* Active or Inactive.
|
|
466
|
+
*
|
|
467
|
+
* See Boost and CancelBoost commands for more details.
|
|
468
|
+
*
|
|
469
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.6
|
|
470
|
+
*/
|
|
471
|
+
readonly boostState: Attribute<BoostState, any>;
|
|
472
|
+
};
|
|
473
|
+
readonly commands: {
|
|
474
|
+
/**
|
|
475
|
+
* Allows a client to request that the water heater is put into a Boost state.
|
|
476
|
+
*
|
|
477
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.8.1
|
|
478
|
+
*/
|
|
479
|
+
readonly boost: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
480
|
+
boostInfo: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
481
|
+
/**
|
|
482
|
+
* This field shall indicate the time period, in seconds, for which the boost state is activated.
|
|
483
|
+
*
|
|
484
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.1
|
|
485
|
+
*/
|
|
486
|
+
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
487
|
+
/**
|
|
488
|
+
* This field shall indicate whether the boost state shall be automatically canceled once the hot water has
|
|
489
|
+
* reached either:
|
|
490
|
+
*
|
|
491
|
+
* • the set point temperature (from the thermostat cluster)
|
|
492
|
+
*
|
|
493
|
+
* • the TemporarySetpoint temperature (if specified)
|
|
494
|
+
*
|
|
495
|
+
* • the TargetPercentage (if specified).
|
|
496
|
+
*
|
|
497
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.2
|
|
498
|
+
*/
|
|
499
|
+
oneShot: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
500
|
+
/**
|
|
501
|
+
* This field shall indicate that the consumer wants the water to be heated quickly. This may cause multiple
|
|
502
|
+
* heat sources to be activated (e.g. a heat pump and direct electric immersion heating element).
|
|
503
|
+
*
|
|
504
|
+
* The choice of which heat sources are activated is manufacturer specific.
|
|
505
|
+
*
|
|
506
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.3
|
|
507
|
+
*/
|
|
508
|
+
emergencyBoost: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
509
|
+
/**
|
|
510
|
+
* This field shall indicate the target temperature to which the water will be heated.
|
|
511
|
+
*
|
|
512
|
+
* If included, it shall be used instead of the thermostat cluster set point temperature whilst the boost state
|
|
513
|
+
* is activated.
|
|
514
|
+
*
|
|
515
|
+
* The value of this field shall be within the constraints of the MinHeatSetpointLimit and MaxHeatSetpointLimit
|
|
516
|
+
* attributes (inclusive), of the thermostat cluster.
|
|
517
|
+
*
|
|
518
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.4
|
|
519
|
+
*/
|
|
520
|
+
temporarySetpoint: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
521
|
+
/**
|
|
522
|
+
* This field shall indicate the target percentage of hot water in the tank that the TankPercentage attribute
|
|
523
|
+
* must reach before the heating is switched off.
|
|
524
|
+
*
|
|
525
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.5
|
|
526
|
+
*/
|
|
527
|
+
targetPercentage: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
528
|
+
/**
|
|
529
|
+
* This field shall indicate the percentage to which the hot water in the tank shall be allowed to fall before
|
|
530
|
+
* again beginning to reheat it.
|
|
531
|
+
*
|
|
532
|
+
* For example if the TargetPercentage was 80%, and the TargetReheat was 40%, then after initial heating to 80%
|
|
533
|
+
* hot water, the tank may have hot water drawn off until only 40% hot water remains. At this point the heater
|
|
534
|
+
* will begin to heat back up to 80% of hot water. If this field and the OneShot field were both omitted,
|
|
535
|
+
* heating would begin again after any water draw which reduced the TankPercentage below 80%.
|
|
536
|
+
*
|
|
537
|
+
* This field shall be less than or equal to the TargetPercentage field.
|
|
538
|
+
*
|
|
539
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.6
|
|
540
|
+
*/
|
|
541
|
+
targetReheat: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
542
|
+
}>>;
|
|
543
|
+
}>, void, any>;
|
|
544
|
+
/**
|
|
545
|
+
* Allows a client to cancel an ongoing Boost operation. This command has no payload.
|
|
546
|
+
*
|
|
547
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.8.2
|
|
548
|
+
*/
|
|
549
|
+
readonly cancelBoost: Command<void, void, any>;
|
|
550
|
+
};
|
|
551
|
+
readonly events: {
|
|
552
|
+
/**
|
|
553
|
+
* This event shall be generated whenever a Boost command is accepted.
|
|
554
|
+
*
|
|
555
|
+
* The corresponding structure fields within the WaterHeaterBoostInfoStruct are copied from the Boost
|
|
556
|
+
* command.
|
|
557
|
+
*
|
|
558
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.9.1
|
|
559
|
+
*/
|
|
560
|
+
readonly boostStarted: Event<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
561
|
+
boostInfo: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
562
|
+
/**
|
|
563
|
+
* This field shall indicate the time period, in seconds, for which the boost state is activated.
|
|
564
|
+
*
|
|
565
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.1
|
|
566
|
+
*/
|
|
567
|
+
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
568
|
+
/**
|
|
569
|
+
* This field shall indicate whether the boost state shall be automatically canceled once the hot water has
|
|
570
|
+
* reached either:
|
|
571
|
+
*
|
|
572
|
+
* • the set point temperature (from the thermostat cluster)
|
|
573
|
+
*
|
|
574
|
+
* • the TemporarySetpoint temperature (if specified)
|
|
575
|
+
*
|
|
576
|
+
* • the TargetPercentage (if specified).
|
|
577
|
+
*
|
|
578
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.2
|
|
579
|
+
*/
|
|
580
|
+
oneShot: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
581
|
+
/**
|
|
582
|
+
* This field shall indicate that the consumer wants the water to be heated quickly. This may cause multiple
|
|
583
|
+
* heat sources to be activated (e.g. a heat pump and direct electric immersion heating element).
|
|
584
|
+
*
|
|
585
|
+
* The choice of which heat sources are activated is manufacturer specific.
|
|
586
|
+
*
|
|
587
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.3
|
|
588
|
+
*/
|
|
589
|
+
emergencyBoost: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
590
|
+
/**
|
|
591
|
+
* This field shall indicate the target temperature to which the water will be heated.
|
|
592
|
+
*
|
|
593
|
+
* If included, it shall be used instead of the thermostat cluster set point temperature whilst the boost state
|
|
594
|
+
* is activated.
|
|
595
|
+
*
|
|
596
|
+
* The value of this field shall be within the constraints of the MinHeatSetpointLimit and MaxHeatSetpointLimit
|
|
597
|
+
* attributes (inclusive), of the thermostat cluster.
|
|
598
|
+
*
|
|
599
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.4
|
|
600
|
+
*/
|
|
601
|
+
temporarySetpoint: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
602
|
+
/**
|
|
603
|
+
* This field shall indicate the target percentage of hot water in the tank that the TankPercentage attribute
|
|
604
|
+
* must reach before the heating is switched off.
|
|
605
|
+
*
|
|
606
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.5
|
|
607
|
+
*/
|
|
608
|
+
targetPercentage: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
609
|
+
/**
|
|
610
|
+
* This field shall indicate the percentage to which the hot water in the tank shall be allowed to fall before
|
|
611
|
+
* again beginning to reheat it.
|
|
612
|
+
*
|
|
613
|
+
* For example if the TargetPercentage was 80%, and the TargetReheat was 40%, then after initial heating to 80%
|
|
614
|
+
* hot water, the tank may have hot water drawn off until only 40% hot water remains. At this point the heater
|
|
615
|
+
* will begin to heat back up to 80% of hot water. If this field and the OneShot field were both omitted,
|
|
616
|
+
* heating would begin again after any water draw which reduced the TankPercentage below 80%.
|
|
617
|
+
*
|
|
618
|
+
* This field shall be less than or equal to the TargetPercentage field.
|
|
619
|
+
*
|
|
620
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.6
|
|
621
|
+
*/
|
|
622
|
+
targetReheat: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
623
|
+
}>>;
|
|
624
|
+
}>, any>;
|
|
625
|
+
/**
|
|
626
|
+
* This event shall be generated whenever the BoostState transitions from Active to Inactive.
|
|
627
|
+
*
|
|
628
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.9.2
|
|
629
|
+
*/
|
|
630
|
+
readonly boostEnded: Event<void, any>;
|
|
631
|
+
};
|
|
632
|
+
/**
|
|
633
|
+
* This metadata controls which WaterHeaterManagementCluster elements matter.js activates for specific feature
|
|
634
|
+
* combinations.
|
|
635
|
+
*/
|
|
636
|
+
readonly extensions: readonly [{
|
|
637
|
+
readonly flags: {
|
|
638
|
+
readonly energyManagement: true;
|
|
639
|
+
};
|
|
640
|
+
readonly component: {
|
|
641
|
+
readonly attributes: {
|
|
642
|
+
/**
|
|
643
|
+
* Indicates the volume of water that the hot water tank can hold (in units of Litres). This allows an
|
|
644
|
+
* energy management system to estimate the required heating energy needed to reach the target temperature.
|
|
645
|
+
*
|
|
646
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.3
|
|
647
|
+
*/
|
|
648
|
+
readonly tankVolume: Attribute<number, any>;
|
|
649
|
+
/**
|
|
650
|
+
* Indicates the estimated heat energy needed to raise the water temperature to the target setpoint. This
|
|
651
|
+
* can be computed by taking the specific heat capacity of water (4182 J/kg °C) and by knowing the current
|
|
652
|
+
* temperature of the water, the tank volume and target temperature.
|
|
653
|
+
*
|
|
654
|
+
* For example, if the target temperature was 60°C, the current temperature was 20°C and the tank volume
|
|
655
|
+
* was 100L:
|
|
656
|
+
*
|
|
657
|
+
* Mass of water = 1kg per Litre
|
|
658
|
+
*
|
|
659
|
+
* Total Mass = 100 x 1kg = 100kg
|
|
660
|
+
*
|
|
661
|
+
* Δ Temperature = (target temperature - current temperature)
|
|
662
|
+
*
|
|
663
|
+
* = (60°C - 20°C) = 40°C
|
|
664
|
+
*
|
|
665
|
+
* Energy required to
|
|
666
|
+
*
|
|
667
|
+
* heat the water to 60°C = 4182 x 40 x 100 = 16,728,000 J
|
|
668
|
+
*
|
|
669
|
+
* Converting Joules in to Wh of heat (divide by 3600):
|
|
670
|
+
*
|
|
671
|
+
* If the TankPercent feature is supported, then this estimate shall also take into account the percentage
|
|
672
|
+
* of the water in the tank which is already hot.
|
|
673
|
+
*
|
|
674
|
+
* NOTE
|
|
675
|
+
*
|
|
676
|
+
* The electrical energy required to heat the water depends on the heating system used to heat the water.
|
|
677
|
+
* For example, a direct electric immersion heating element can be close to 100% efficient, so the
|
|
678
|
+
* electrical energy needed to heat the hot water is nearly the same as the EstimatedHeatEnergyRequired.
|
|
679
|
+
* However some forms of heating, such as an air-source heat pump which extracts heat from ambient air,
|
|
680
|
+
* requires much less electrical energy to heat hot water. Heat pumps can be produce 3kWh of heat output
|
|
681
|
+
* for 1kWh of electrical energy input. The conversion between heat energy and electrical energy is outside
|
|
682
|
+
* the scope of this cluster.
|
|
683
|
+
*
|
|
684
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.4
|
|
685
|
+
*/
|
|
686
|
+
readonly estimatedHeatRequired: Attribute<number | bigint, any>;
|
|
687
|
+
};
|
|
688
|
+
};
|
|
689
|
+
}, {
|
|
690
|
+
readonly flags: {
|
|
691
|
+
readonly tankPercent: true;
|
|
692
|
+
};
|
|
693
|
+
readonly component: {
|
|
694
|
+
readonly attributes: {
|
|
695
|
+
/**
|
|
696
|
+
* Indicates an approximate level of hot water stored in the tank, which might help consumers understand
|
|
697
|
+
* the amount of hot water remaining in the tank. The accuracy of this attribute is manufacturer specific.
|
|
698
|
+
*
|
|
699
|
+
* In most hot water tanks, there is a stratification effect where the hot water layer rests above a cooler
|
|
700
|
+
* layer of water below. For this reason cold water is fed in at the bottom of the tank and the hot water
|
|
701
|
+
* is drawn from the top.
|
|
702
|
+
*
|
|
703
|
+
* Some water tanks might use multiple temperature probes to estimate the level of the hot water layer. A
|
|
704
|
+
* water heater with multiple temperature probes is likely to implement an algorithm to estimate the hot
|
|
705
|
+
* water tank percentage by taking into account the temperature values of each probe to determine the
|
|
706
|
+
* height of the hot water.
|
|
707
|
+
*
|
|
708
|
+
* However it might be possible with a single temperature probe to estimate how much hot water is left
|
|
709
|
+
* using a simpler algorithm:
|
|
710
|
+
*
|
|
711
|
+
* For example, if the target temperature was 60°C, the CurrentTemperature was 40°C from a single
|
|
712
|
+
* temperature probe measuring the average water temperature and the temperature of incoming cold water
|
|
713
|
+
* (COLD_WATER_TEMP) was assumed to be 20°C:
|
|
714
|
+
*
|
|
715
|
+
* TankPercentage = int(((current temperature - COLD_WATER_TEMP) / (target temperature - COLD_WATER_TEMP))
|
|
716
|
+
* * 100)
|
|
717
|
+
*
|
|
718
|
+
* TankPercentage = min( max(TankPercentage,0), 100)
|
|
719
|
+
*
|
|
720
|
+
* TankPercentage = 50%
|
|
721
|
+
*
|
|
722
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.5
|
|
723
|
+
*/
|
|
724
|
+
readonly tankPercentage: Attribute<number, any>;
|
|
725
|
+
};
|
|
726
|
+
};
|
|
727
|
+
}];
|
|
728
|
+
};
|
|
729
|
+
/**
|
|
730
|
+
* @see {@link Cluster}
|
|
731
|
+
*/
|
|
732
|
+
const ClusterInstance: MutableCluster<{
|
|
733
|
+
readonly id: 148;
|
|
734
|
+
readonly name: "WaterHeaterManagement";
|
|
735
|
+
readonly revision: 2;
|
|
736
|
+
readonly features: {
|
|
737
|
+
/**
|
|
738
|
+
* EnergyManagement
|
|
739
|
+
*
|
|
740
|
+
* Allows energy management control of the tank
|
|
741
|
+
*/
|
|
742
|
+
readonly energyManagement: BitFlag;
|
|
743
|
+
/**
|
|
744
|
+
* TankPercent
|
|
745
|
+
*
|
|
746
|
+
* Supports monitoring the percentage of hot water in the tank
|
|
747
|
+
*/
|
|
748
|
+
readonly tankPercent: BitFlag;
|
|
749
|
+
};
|
|
750
|
+
readonly attributes: {
|
|
751
|
+
/**
|
|
752
|
+
* Indicates the heat sources that the water heater can call on for heating. If a bit is set then the water
|
|
753
|
+
* heater supports the corresponding heat source.
|
|
754
|
+
*
|
|
755
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.1
|
|
756
|
+
*/
|
|
757
|
+
readonly heaterTypes: FixedAttribute<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
758
|
+
/**
|
|
759
|
+
* Immersion Heating Element 1
|
|
760
|
+
*/
|
|
761
|
+
immersionElement1: BitFlag;
|
|
762
|
+
/**
|
|
763
|
+
* Immersion Heating Element 2
|
|
764
|
+
*/
|
|
765
|
+
immersionElement2: BitFlag;
|
|
766
|
+
/**
|
|
767
|
+
* Heat pump Heating
|
|
768
|
+
*/
|
|
769
|
+
heatPump: BitFlag;
|
|
770
|
+
/**
|
|
771
|
+
* Boiler Heating (e.g. Gas or Oil)
|
|
772
|
+
*/
|
|
773
|
+
boiler: BitFlag;
|
|
774
|
+
/**
|
|
775
|
+
* Other Heating
|
|
776
|
+
*/
|
|
777
|
+
other: BitFlag;
|
|
778
|
+
}>, any>;
|
|
779
|
+
/**
|
|
780
|
+
* Indicates if the water heater is heating water. If a bit is set then the corresponding heat source is
|
|
781
|
+
* active.
|
|
782
|
+
*
|
|
783
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.2
|
|
784
|
+
*/
|
|
785
|
+
readonly heatDemand: Attribute<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
786
|
+
/**
|
|
787
|
+
* Immersion Heating Element 1
|
|
788
|
+
*/
|
|
789
|
+
immersionElement1: BitFlag;
|
|
790
|
+
/**
|
|
791
|
+
* Immersion Heating Element 2
|
|
792
|
+
*/
|
|
793
|
+
immersionElement2: BitFlag;
|
|
794
|
+
/**
|
|
795
|
+
* Heat pump Heating
|
|
796
|
+
*/
|
|
797
|
+
heatPump: BitFlag;
|
|
798
|
+
/**
|
|
799
|
+
* Boiler Heating (e.g. Gas or Oil)
|
|
800
|
+
*/
|
|
801
|
+
boiler: BitFlag;
|
|
802
|
+
/**
|
|
803
|
+
* Other Heating
|
|
804
|
+
*/
|
|
805
|
+
other: BitFlag;
|
|
806
|
+
}>, any>;
|
|
807
|
+
/**
|
|
808
|
+
* Indicates whether the Boost, as triggered by a Boost command, is currently
|
|
809
|
+
*
|
|
810
|
+
* Active or Inactive.
|
|
811
|
+
*
|
|
812
|
+
* See Boost and CancelBoost commands for more details.
|
|
813
|
+
*
|
|
814
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.6
|
|
815
|
+
*/
|
|
816
|
+
readonly boostState: Attribute<BoostState, any>;
|
|
817
|
+
};
|
|
818
|
+
readonly commands: {
|
|
819
|
+
/**
|
|
820
|
+
* Allows a client to request that the water heater is put into a Boost state.
|
|
821
|
+
*
|
|
822
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.8.1
|
|
823
|
+
*/
|
|
824
|
+
readonly boost: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
825
|
+
boostInfo: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
826
|
+
/**
|
|
827
|
+
* This field shall indicate the time period, in seconds, for which the boost state is activated.
|
|
828
|
+
*
|
|
829
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.1
|
|
830
|
+
*/
|
|
831
|
+
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
832
|
+
/**
|
|
833
|
+
* This field shall indicate whether the boost state shall be automatically canceled once the hot water has
|
|
834
|
+
* reached either:
|
|
835
|
+
*
|
|
836
|
+
* • the set point temperature (from the thermostat cluster)
|
|
837
|
+
*
|
|
838
|
+
* • the TemporarySetpoint temperature (if specified)
|
|
839
|
+
*
|
|
840
|
+
* • the TargetPercentage (if specified).
|
|
841
|
+
*
|
|
842
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.2
|
|
843
|
+
*/
|
|
844
|
+
oneShot: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
845
|
+
/**
|
|
846
|
+
* This field shall indicate that the consumer wants the water to be heated quickly. This may cause multiple
|
|
847
|
+
* heat sources to be activated (e.g. a heat pump and direct electric immersion heating element).
|
|
848
|
+
*
|
|
849
|
+
* The choice of which heat sources are activated is manufacturer specific.
|
|
850
|
+
*
|
|
851
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.3
|
|
852
|
+
*/
|
|
853
|
+
emergencyBoost: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
854
|
+
/**
|
|
855
|
+
* This field shall indicate the target temperature to which the water will be heated.
|
|
856
|
+
*
|
|
857
|
+
* If included, it shall be used instead of the thermostat cluster set point temperature whilst the boost state
|
|
858
|
+
* is activated.
|
|
859
|
+
*
|
|
860
|
+
* The value of this field shall be within the constraints of the MinHeatSetpointLimit and MaxHeatSetpointLimit
|
|
861
|
+
* attributes (inclusive), of the thermostat cluster.
|
|
862
|
+
*
|
|
863
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.4
|
|
864
|
+
*/
|
|
865
|
+
temporarySetpoint: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
866
|
+
/**
|
|
867
|
+
* This field shall indicate the target percentage of hot water in the tank that the TankPercentage attribute
|
|
868
|
+
* must reach before the heating is switched off.
|
|
869
|
+
*
|
|
870
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.5
|
|
871
|
+
*/
|
|
872
|
+
targetPercentage: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
873
|
+
/**
|
|
874
|
+
* This field shall indicate the percentage to which the hot water in the tank shall be allowed to fall before
|
|
875
|
+
* again beginning to reheat it.
|
|
876
|
+
*
|
|
877
|
+
* For example if the TargetPercentage was 80%, and the TargetReheat was 40%, then after initial heating to 80%
|
|
878
|
+
* hot water, the tank may have hot water drawn off until only 40% hot water remains. At this point the heater
|
|
879
|
+
* will begin to heat back up to 80% of hot water. If this field and the OneShot field were both omitted,
|
|
880
|
+
* heating would begin again after any water draw which reduced the TankPercentage below 80%.
|
|
881
|
+
*
|
|
882
|
+
* This field shall be less than or equal to the TargetPercentage field.
|
|
883
|
+
*
|
|
884
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.6
|
|
885
|
+
*/
|
|
886
|
+
targetReheat: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
887
|
+
}>>;
|
|
888
|
+
}>, void, any>;
|
|
889
|
+
/**
|
|
890
|
+
* Allows a client to cancel an ongoing Boost operation. This command has no payload.
|
|
891
|
+
*
|
|
892
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.8.2
|
|
893
|
+
*/
|
|
894
|
+
readonly cancelBoost: Command<void, void, any>;
|
|
895
|
+
};
|
|
896
|
+
readonly events: {
|
|
897
|
+
/**
|
|
898
|
+
* This event shall be generated whenever a Boost command is accepted.
|
|
899
|
+
*
|
|
900
|
+
* The corresponding structure fields within the WaterHeaterBoostInfoStruct are copied from the Boost
|
|
901
|
+
* command.
|
|
902
|
+
*
|
|
903
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.9.1
|
|
904
|
+
*/
|
|
905
|
+
readonly boostStarted: Event<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
906
|
+
boostInfo: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
907
|
+
/**
|
|
908
|
+
* This field shall indicate the time period, in seconds, for which the boost state is activated.
|
|
909
|
+
*
|
|
910
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.1
|
|
911
|
+
*/
|
|
912
|
+
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
913
|
+
/**
|
|
914
|
+
* This field shall indicate whether the boost state shall be automatically canceled once the hot water has
|
|
915
|
+
* reached either:
|
|
916
|
+
*
|
|
917
|
+
* • the set point temperature (from the thermostat cluster)
|
|
918
|
+
*
|
|
919
|
+
* • the TemporarySetpoint temperature (if specified)
|
|
920
|
+
*
|
|
921
|
+
* • the TargetPercentage (if specified).
|
|
922
|
+
*
|
|
923
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.2
|
|
924
|
+
*/
|
|
925
|
+
oneShot: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
926
|
+
/**
|
|
927
|
+
* This field shall indicate that the consumer wants the water to be heated quickly. This may cause multiple
|
|
928
|
+
* heat sources to be activated (e.g. a heat pump and direct electric immersion heating element).
|
|
929
|
+
*
|
|
930
|
+
* The choice of which heat sources are activated is manufacturer specific.
|
|
931
|
+
*
|
|
932
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.3
|
|
933
|
+
*/
|
|
934
|
+
emergencyBoost: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
935
|
+
/**
|
|
936
|
+
* This field shall indicate the target temperature to which the water will be heated.
|
|
937
|
+
*
|
|
938
|
+
* If included, it shall be used instead of the thermostat cluster set point temperature whilst the boost state
|
|
939
|
+
* is activated.
|
|
940
|
+
*
|
|
941
|
+
* The value of this field shall be within the constraints of the MinHeatSetpointLimit and MaxHeatSetpointLimit
|
|
942
|
+
* attributes (inclusive), of the thermostat cluster.
|
|
943
|
+
*
|
|
944
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.4
|
|
945
|
+
*/
|
|
946
|
+
temporarySetpoint: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
947
|
+
/**
|
|
948
|
+
* This field shall indicate the target percentage of hot water in the tank that the TankPercentage attribute
|
|
949
|
+
* must reach before the heating is switched off.
|
|
950
|
+
*
|
|
951
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.5
|
|
952
|
+
*/
|
|
953
|
+
targetPercentage: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
954
|
+
/**
|
|
955
|
+
* This field shall indicate the percentage to which the hot water in the tank shall be allowed to fall before
|
|
956
|
+
* again beginning to reheat it.
|
|
957
|
+
*
|
|
958
|
+
* For example if the TargetPercentage was 80%, and the TargetReheat was 40%, then after initial heating to 80%
|
|
959
|
+
* hot water, the tank may have hot water drawn off until only 40% hot water remains. At this point the heater
|
|
960
|
+
* will begin to heat back up to 80% of hot water. If this field and the OneShot field were both omitted,
|
|
961
|
+
* heating would begin again after any water draw which reduced the TankPercentage below 80%.
|
|
962
|
+
*
|
|
963
|
+
* This field shall be less than or equal to the TargetPercentage field.
|
|
964
|
+
*
|
|
965
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.6
|
|
966
|
+
*/
|
|
967
|
+
targetReheat: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
968
|
+
}>>;
|
|
969
|
+
}>, any>;
|
|
970
|
+
/**
|
|
971
|
+
* This event shall be generated whenever the BoostState transitions from Active to Inactive.
|
|
972
|
+
*
|
|
973
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.9.2
|
|
974
|
+
*/
|
|
975
|
+
readonly boostEnded: Event<void, any>;
|
|
976
|
+
};
|
|
977
|
+
/**
|
|
978
|
+
* This metadata controls which WaterHeaterManagementCluster elements matter.js activates for specific feature
|
|
979
|
+
* combinations.
|
|
980
|
+
*/
|
|
981
|
+
readonly extensions: readonly [{
|
|
982
|
+
readonly flags: {
|
|
983
|
+
readonly energyManagement: true;
|
|
984
|
+
};
|
|
985
|
+
readonly component: {
|
|
986
|
+
readonly attributes: {
|
|
987
|
+
/**
|
|
988
|
+
* Indicates the volume of water that the hot water tank can hold (in units of Litres). This allows an
|
|
989
|
+
* energy management system to estimate the required heating energy needed to reach the target temperature.
|
|
990
|
+
*
|
|
991
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.3
|
|
992
|
+
*/
|
|
993
|
+
readonly tankVolume: Attribute<number, any>;
|
|
994
|
+
/**
|
|
995
|
+
* Indicates the estimated heat energy needed to raise the water temperature to the target setpoint. This
|
|
996
|
+
* can be computed by taking the specific heat capacity of water (4182 J/kg °C) and by knowing the current
|
|
997
|
+
* temperature of the water, the tank volume and target temperature.
|
|
998
|
+
*
|
|
999
|
+
* For example, if the target temperature was 60°C, the current temperature was 20°C and the tank volume
|
|
1000
|
+
* was 100L:
|
|
1001
|
+
*
|
|
1002
|
+
* Mass of water = 1kg per Litre
|
|
1003
|
+
*
|
|
1004
|
+
* Total Mass = 100 x 1kg = 100kg
|
|
1005
|
+
*
|
|
1006
|
+
* Δ Temperature = (target temperature - current temperature)
|
|
1007
|
+
*
|
|
1008
|
+
* = (60°C - 20°C) = 40°C
|
|
1009
|
+
*
|
|
1010
|
+
* Energy required to
|
|
1011
|
+
*
|
|
1012
|
+
* heat the water to 60°C = 4182 x 40 x 100 = 16,728,000 J
|
|
1013
|
+
*
|
|
1014
|
+
* Converting Joules in to Wh of heat (divide by 3600):
|
|
1015
|
+
*
|
|
1016
|
+
* If the TankPercent feature is supported, then this estimate shall also take into account the percentage
|
|
1017
|
+
* of the water in the tank which is already hot.
|
|
1018
|
+
*
|
|
1019
|
+
* NOTE
|
|
1020
|
+
*
|
|
1021
|
+
* The electrical energy required to heat the water depends on the heating system used to heat the water.
|
|
1022
|
+
* For example, a direct electric immersion heating element can be close to 100% efficient, so the
|
|
1023
|
+
* electrical energy needed to heat the hot water is nearly the same as the EstimatedHeatEnergyRequired.
|
|
1024
|
+
* However some forms of heating, such as an air-source heat pump which extracts heat from ambient air,
|
|
1025
|
+
* requires much less electrical energy to heat hot water. Heat pumps can be produce 3kWh of heat output
|
|
1026
|
+
* for 1kWh of electrical energy input. The conversion between heat energy and electrical energy is outside
|
|
1027
|
+
* the scope of this cluster.
|
|
1028
|
+
*
|
|
1029
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.4
|
|
1030
|
+
*/
|
|
1031
|
+
readonly estimatedHeatRequired: Attribute<number | bigint, any>;
|
|
1032
|
+
};
|
|
1033
|
+
};
|
|
1034
|
+
}, {
|
|
1035
|
+
readonly flags: {
|
|
1036
|
+
readonly tankPercent: true;
|
|
1037
|
+
};
|
|
1038
|
+
readonly component: {
|
|
1039
|
+
readonly attributes: {
|
|
1040
|
+
/**
|
|
1041
|
+
* Indicates an approximate level of hot water stored in the tank, which might help consumers understand
|
|
1042
|
+
* the amount of hot water remaining in the tank. The accuracy of this attribute is manufacturer specific.
|
|
1043
|
+
*
|
|
1044
|
+
* In most hot water tanks, there is a stratification effect where the hot water layer rests above a cooler
|
|
1045
|
+
* layer of water below. For this reason cold water is fed in at the bottom of the tank and the hot water
|
|
1046
|
+
* is drawn from the top.
|
|
1047
|
+
*
|
|
1048
|
+
* Some water tanks might use multiple temperature probes to estimate the level of the hot water layer. A
|
|
1049
|
+
* water heater with multiple temperature probes is likely to implement an algorithm to estimate the hot
|
|
1050
|
+
* water tank percentage by taking into account the temperature values of each probe to determine the
|
|
1051
|
+
* height of the hot water.
|
|
1052
|
+
*
|
|
1053
|
+
* However it might be possible with a single temperature probe to estimate how much hot water is left
|
|
1054
|
+
* using a simpler algorithm:
|
|
1055
|
+
*
|
|
1056
|
+
* For example, if the target temperature was 60°C, the CurrentTemperature was 40°C from a single
|
|
1057
|
+
* temperature probe measuring the average water temperature and the temperature of incoming cold water
|
|
1058
|
+
* (COLD_WATER_TEMP) was assumed to be 20°C:
|
|
1059
|
+
*
|
|
1060
|
+
* TankPercentage = int(((current temperature - COLD_WATER_TEMP) / (target temperature - COLD_WATER_TEMP))
|
|
1061
|
+
* * 100)
|
|
1062
|
+
*
|
|
1063
|
+
* TankPercentage = min( max(TankPercentage,0), 100)
|
|
1064
|
+
*
|
|
1065
|
+
* TankPercentage = 50%
|
|
1066
|
+
*
|
|
1067
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.7.5
|
|
1068
|
+
*/
|
|
1069
|
+
readonly tankPercentage: Attribute<number, any>;
|
|
1070
|
+
};
|
|
1071
|
+
};
|
|
1072
|
+
}];
|
|
1073
|
+
}, []>;
|
|
1074
|
+
/**
|
|
1075
|
+
* This cluster is used to allow clients to control the operation of a hot water heating appliance so that it can
|
|
1076
|
+
* be used with energy management.
|
|
1077
|
+
*
|
|
1078
|
+
* Heating of hot water is one of the main energy uses in homes, and when coupled with the Energy Management
|
|
1079
|
+
* cluster, it can help consumers save cost (e.g. using power at cheaper times or from local solar PV generation).
|
|
1080
|
+
*
|
|
1081
|
+
* WaterHeaterManagementCluster supports optional features that you can enable with the
|
|
1082
|
+
* WaterHeaterManagementCluster.with() factory method.
|
|
1083
|
+
*
|
|
1084
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5
|
|
1085
|
+
*/
|
|
1086
|
+
interface Cluster extends Identity<typeof ClusterInstance> {
|
|
1087
|
+
}
|
|
1088
|
+
const Cluster: Cluster;
|
|
1089
|
+
/**
|
|
1090
|
+
* @see {@link Complete}
|
|
1091
|
+
*/
|
|
1092
|
+
const CompleteInstance: MutableCluster<{
|
|
1093
|
+
readonly id: import("#general").Branded<148, "ClusterId">;
|
|
1094
|
+
readonly name: "WaterHeaterManagement";
|
|
1095
|
+
readonly revision: 2;
|
|
1096
|
+
readonly features: {
|
|
1097
|
+
/**
|
|
1098
|
+
* EnergyManagement
|
|
1099
|
+
*
|
|
1100
|
+
* Allows energy management control of the tank
|
|
1101
|
+
*/
|
|
1102
|
+
readonly energyManagement: BitFlag;
|
|
1103
|
+
/**
|
|
1104
|
+
* TankPercent
|
|
1105
|
+
*
|
|
1106
|
+
* Supports monitoring the percentage of hot water in the tank
|
|
1107
|
+
*/
|
|
1108
|
+
readonly tankPercent: BitFlag;
|
|
1109
|
+
};
|
|
1110
|
+
readonly attributes: {
|
|
1111
|
+
readonly tankVolume: Attribute<number, any> & {
|
|
1112
|
+
readonly optional: true;
|
|
1113
|
+
readonly isConditional: true;
|
|
1114
|
+
readonly optionalIf: [] | import("../cluster/Cluster.js").ConditionalFeatureList<import("../schema/BitmapSchema.js").BitSchema>;
|
|
1115
|
+
readonly mandatoryIf: [] | [{
|
|
1116
|
+
energyManagement: boolean;
|
|
1117
|
+
}];
|
|
1118
|
+
};
|
|
1119
|
+
readonly estimatedHeatRequired: Attribute<number | bigint, any> & {
|
|
1120
|
+
readonly optional: true;
|
|
1121
|
+
readonly isConditional: true;
|
|
1122
|
+
readonly optionalIf: [] | import("../cluster/Cluster.js").ConditionalFeatureList<import("../schema/BitmapSchema.js").BitSchema>;
|
|
1123
|
+
readonly mandatoryIf: [] | [{
|
|
1124
|
+
energyManagement: boolean;
|
|
1125
|
+
}];
|
|
1126
|
+
};
|
|
1127
|
+
readonly tankPercentage: Attribute<number, any> & {
|
|
1128
|
+
readonly optional: true;
|
|
1129
|
+
readonly isConditional: true;
|
|
1130
|
+
readonly optionalIf: [] | import("../cluster/Cluster.js").ConditionalFeatureList<import("../schema/BitmapSchema.js").BitSchema>;
|
|
1131
|
+
readonly mandatoryIf: [] | [{
|
|
1132
|
+
tankPercent: boolean;
|
|
1133
|
+
}];
|
|
1134
|
+
};
|
|
1135
|
+
readonly heaterTypes: FixedAttribute<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
1136
|
+
/**
|
|
1137
|
+
* Immersion Heating Element 1
|
|
1138
|
+
*/
|
|
1139
|
+
immersionElement1: BitFlag;
|
|
1140
|
+
/**
|
|
1141
|
+
* Immersion Heating Element 2
|
|
1142
|
+
*/
|
|
1143
|
+
immersionElement2: BitFlag;
|
|
1144
|
+
/**
|
|
1145
|
+
* Heat pump Heating
|
|
1146
|
+
*/
|
|
1147
|
+
heatPump: BitFlag;
|
|
1148
|
+
/**
|
|
1149
|
+
* Boiler Heating (e.g. Gas or Oil)
|
|
1150
|
+
*/
|
|
1151
|
+
boiler: BitFlag;
|
|
1152
|
+
/**
|
|
1153
|
+
* Other Heating
|
|
1154
|
+
*/
|
|
1155
|
+
other: BitFlag;
|
|
1156
|
+
}>, any>;
|
|
1157
|
+
readonly heatDemand: Attribute<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
1158
|
+
/**
|
|
1159
|
+
* Immersion Heating Element 1
|
|
1160
|
+
*/
|
|
1161
|
+
immersionElement1: BitFlag;
|
|
1162
|
+
/**
|
|
1163
|
+
* Immersion Heating Element 2
|
|
1164
|
+
*/
|
|
1165
|
+
immersionElement2: BitFlag;
|
|
1166
|
+
/**
|
|
1167
|
+
* Heat pump Heating
|
|
1168
|
+
*/
|
|
1169
|
+
heatPump: BitFlag;
|
|
1170
|
+
/**
|
|
1171
|
+
* Boiler Heating (e.g. Gas or Oil)
|
|
1172
|
+
*/
|
|
1173
|
+
boiler: BitFlag;
|
|
1174
|
+
/**
|
|
1175
|
+
* Other Heating
|
|
1176
|
+
*/
|
|
1177
|
+
other: BitFlag;
|
|
1178
|
+
}>, any>;
|
|
1179
|
+
readonly boostState: Attribute<BoostState, any>;
|
|
1180
|
+
readonly clusterRevision: Attribute<number, never>;
|
|
1181
|
+
readonly featureMap: Attribute<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
1182
|
+
/**
|
|
1183
|
+
* EnergyManagement
|
|
1184
|
+
*
|
|
1185
|
+
* Allows energy management control of the tank
|
|
1186
|
+
*/
|
|
1187
|
+
readonly energyManagement: BitFlag;
|
|
1188
|
+
/**
|
|
1189
|
+
* TankPercent
|
|
1190
|
+
*
|
|
1191
|
+
* Supports monitoring the percentage of hot water in the tank
|
|
1192
|
+
*/
|
|
1193
|
+
readonly tankPercent: BitFlag;
|
|
1194
|
+
}>, never>;
|
|
1195
|
+
readonly attributeList: Attribute<import("../index.js").AttributeId[], never>;
|
|
1196
|
+
readonly acceptedCommandList: Attribute<import("../index.js").CommandId[], never>;
|
|
1197
|
+
readonly generatedCommandList: Attribute<import("../index.js").CommandId[], never>;
|
|
1198
|
+
};
|
|
1199
|
+
readonly commands: {
|
|
1200
|
+
/**
|
|
1201
|
+
* Allows a client to request that the water heater is put into a Boost state.
|
|
1202
|
+
*
|
|
1203
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.8.1
|
|
1204
|
+
*/
|
|
1205
|
+
readonly boost: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1206
|
+
boostInfo: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1207
|
+
/**
|
|
1208
|
+
* This field shall indicate the time period, in seconds, for which the boost state is activated.
|
|
1209
|
+
*
|
|
1210
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.1
|
|
1211
|
+
*/
|
|
1212
|
+
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1213
|
+
/**
|
|
1214
|
+
* This field shall indicate whether the boost state shall be automatically canceled once the hot water has
|
|
1215
|
+
* reached either:
|
|
1216
|
+
*
|
|
1217
|
+
* • the set point temperature (from the thermostat cluster)
|
|
1218
|
+
*
|
|
1219
|
+
* • the TemporarySetpoint temperature (if specified)
|
|
1220
|
+
*
|
|
1221
|
+
* • the TargetPercentage (if specified).
|
|
1222
|
+
*
|
|
1223
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.2
|
|
1224
|
+
*/
|
|
1225
|
+
oneShot: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
1226
|
+
/**
|
|
1227
|
+
* This field shall indicate that the consumer wants the water to be heated quickly. This may cause multiple
|
|
1228
|
+
* heat sources to be activated (e.g. a heat pump and direct electric immersion heating element).
|
|
1229
|
+
*
|
|
1230
|
+
* The choice of which heat sources are activated is manufacturer specific.
|
|
1231
|
+
*
|
|
1232
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.3
|
|
1233
|
+
*/
|
|
1234
|
+
emergencyBoost: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
1235
|
+
/**
|
|
1236
|
+
* This field shall indicate the target temperature to which the water will be heated.
|
|
1237
|
+
*
|
|
1238
|
+
* If included, it shall be used instead of the thermostat cluster set point temperature whilst the boost state
|
|
1239
|
+
* is activated.
|
|
1240
|
+
*
|
|
1241
|
+
* The value of this field shall be within the constraints of the MinHeatSetpointLimit and MaxHeatSetpointLimit
|
|
1242
|
+
* attributes (inclusive), of the thermostat cluster.
|
|
1243
|
+
*
|
|
1244
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.4
|
|
1245
|
+
*/
|
|
1246
|
+
temporarySetpoint: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1247
|
+
/**
|
|
1248
|
+
* This field shall indicate the target percentage of hot water in the tank that the TankPercentage attribute
|
|
1249
|
+
* must reach before the heating is switched off.
|
|
1250
|
+
*
|
|
1251
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.5
|
|
1252
|
+
*/
|
|
1253
|
+
targetPercentage: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1254
|
+
/**
|
|
1255
|
+
* This field shall indicate the percentage to which the hot water in the tank shall be allowed to fall before
|
|
1256
|
+
* again beginning to reheat it.
|
|
1257
|
+
*
|
|
1258
|
+
* For example if the TargetPercentage was 80%, and the TargetReheat was 40%, then after initial heating to 80%
|
|
1259
|
+
* hot water, the tank may have hot water drawn off until only 40% hot water remains. At this point the heater
|
|
1260
|
+
* will begin to heat back up to 80% of hot water. If this field and the OneShot field were both omitted,
|
|
1261
|
+
* heating would begin again after any water draw which reduced the TankPercentage below 80%.
|
|
1262
|
+
*
|
|
1263
|
+
* This field shall be less than or equal to the TargetPercentage field.
|
|
1264
|
+
*
|
|
1265
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.6
|
|
1266
|
+
*/
|
|
1267
|
+
targetReheat: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1268
|
+
}>>;
|
|
1269
|
+
}>, void, any>;
|
|
1270
|
+
/**
|
|
1271
|
+
* Allows a client to cancel an ongoing Boost operation. This command has no payload.
|
|
1272
|
+
*
|
|
1273
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.8.2
|
|
1274
|
+
*/
|
|
1275
|
+
readonly cancelBoost: Command<void, void, any>;
|
|
1276
|
+
};
|
|
1277
|
+
readonly events: {
|
|
1278
|
+
/**
|
|
1279
|
+
* This event shall be generated whenever a Boost command is accepted.
|
|
1280
|
+
*
|
|
1281
|
+
* The corresponding structure fields within the WaterHeaterBoostInfoStruct are copied from the Boost
|
|
1282
|
+
* command.
|
|
1283
|
+
*
|
|
1284
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.9.1
|
|
1285
|
+
*/
|
|
1286
|
+
readonly boostStarted: Event<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1287
|
+
boostInfo: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1288
|
+
/**
|
|
1289
|
+
* This field shall indicate the time period, in seconds, for which the boost state is activated.
|
|
1290
|
+
*
|
|
1291
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.1
|
|
1292
|
+
*/
|
|
1293
|
+
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1294
|
+
/**
|
|
1295
|
+
* This field shall indicate whether the boost state shall be automatically canceled once the hot water has
|
|
1296
|
+
* reached either:
|
|
1297
|
+
*
|
|
1298
|
+
* • the set point temperature (from the thermostat cluster)
|
|
1299
|
+
*
|
|
1300
|
+
* • the TemporarySetpoint temperature (if specified)
|
|
1301
|
+
*
|
|
1302
|
+
* • the TargetPercentage (if specified).
|
|
1303
|
+
*
|
|
1304
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.2
|
|
1305
|
+
*/
|
|
1306
|
+
oneShot: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
1307
|
+
/**
|
|
1308
|
+
* This field shall indicate that the consumer wants the water to be heated quickly. This may cause multiple
|
|
1309
|
+
* heat sources to be activated (e.g. a heat pump and direct electric immersion heating element).
|
|
1310
|
+
*
|
|
1311
|
+
* The choice of which heat sources are activated is manufacturer specific.
|
|
1312
|
+
*
|
|
1313
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.3
|
|
1314
|
+
*/
|
|
1315
|
+
emergencyBoost: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
1316
|
+
/**
|
|
1317
|
+
* This field shall indicate the target temperature to which the water will be heated.
|
|
1318
|
+
*
|
|
1319
|
+
* If included, it shall be used instead of the thermostat cluster set point temperature whilst the boost state
|
|
1320
|
+
* is activated.
|
|
1321
|
+
*
|
|
1322
|
+
* The value of this field shall be within the constraints of the MinHeatSetpointLimit and MaxHeatSetpointLimit
|
|
1323
|
+
* attributes (inclusive), of the thermostat cluster.
|
|
1324
|
+
*
|
|
1325
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.4
|
|
1326
|
+
*/
|
|
1327
|
+
temporarySetpoint: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1328
|
+
/**
|
|
1329
|
+
* This field shall indicate the target percentage of hot water in the tank that the TankPercentage attribute
|
|
1330
|
+
* must reach before the heating is switched off.
|
|
1331
|
+
*
|
|
1332
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.5
|
|
1333
|
+
*/
|
|
1334
|
+
targetPercentage: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1335
|
+
/**
|
|
1336
|
+
* This field shall indicate the percentage to which the hot water in the tank shall be allowed to fall before
|
|
1337
|
+
* again beginning to reheat it.
|
|
1338
|
+
*
|
|
1339
|
+
* For example if the TargetPercentage was 80%, and the TargetReheat was 40%, then after initial heating to 80%
|
|
1340
|
+
* hot water, the tank may have hot water drawn off until only 40% hot water remains. At this point the heater
|
|
1341
|
+
* will begin to heat back up to 80% of hot water. If this field and the OneShot field were both omitted,
|
|
1342
|
+
* heating would begin again after any water draw which reduced the TankPercentage below 80%.
|
|
1343
|
+
*
|
|
1344
|
+
* This field shall be less than or equal to the TargetPercentage field.
|
|
1345
|
+
*
|
|
1346
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.6.3.6
|
|
1347
|
+
*/
|
|
1348
|
+
targetReheat: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1349
|
+
}>>;
|
|
1350
|
+
}>, any>;
|
|
1351
|
+
/**
|
|
1352
|
+
* This event shall be generated whenever the BoostState transitions from Active to Inactive.
|
|
1353
|
+
*
|
|
1354
|
+
* @see {@link MatterSpecification.v13.Cluster} § 9.5.9.2
|
|
1355
|
+
*/
|
|
1356
|
+
readonly boostEnded: Event<void, any>;
|
|
1357
|
+
};
|
|
1358
|
+
}, []>;
|
|
1359
|
+
/**
|
|
1360
|
+
* This cluster supports all WaterHeaterManagement features. It may support illegal feature combinations.
|
|
1361
|
+
*
|
|
1362
|
+
* If you use this cluster you must manually specify which features are active and ensure the set of active
|
|
1363
|
+
* features is legal per the Matter specification.
|
|
1364
|
+
*/
|
|
1365
|
+
interface Complete extends Identity<typeof CompleteInstance> {
|
|
1366
|
+
}
|
|
1367
|
+
const Complete: Complete;
|
|
1368
|
+
}
|
|
1369
|
+
export type WaterHeaterManagementCluster = WaterHeaterManagement.Cluster;
|
|
1370
|
+
export declare const WaterHeaterManagementCluster: WaterHeaterManagement.Cluster;
|
|
1371
|
+
//# sourceMappingURL=water-heater-management.d.ts.map
|