@matter/types 0.13.0-alpha.0-20250318-c1aa38b08 → 0.13.0-alpha.0-20250323-770919c6a
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 +308 -313
- package/dist/cjs/clusters/access-control.d.ts.map +1 -1
- package/dist/cjs/clusters/access-control.js +57 -58
- package/dist/cjs/clusters/access-control.js.map +1 -1
- package/dist/cjs/clusters/account-login.d.ts +26 -26
- package/dist/cjs/clusters/account-login.js +27 -27
- package/dist/cjs/clusters/actions.d.ts +37 -37
- package/dist/cjs/clusters/actions.js +21 -21
- package/dist/cjs/clusters/activated-carbon-filter-monitoring.d.ts +2 -2
- package/dist/cjs/clusters/administrator-commissioning.d.ts +63 -63
- package/dist/cjs/clusters/administrator-commissioning.js +17 -17
- package/dist/cjs/clusters/alarm-base.d.ts +6 -6
- package/dist/cjs/clusters/alarm-base.js +6 -6
- package/dist/cjs/clusters/application-basic.d.ts +6 -7
- package/dist/cjs/clusters/application-basic.d.ts.map +1 -1
- package/dist/cjs/clusters/application-basic.js +2 -2
- package/dist/cjs/clusters/application-basic.js.map +1 -1
- package/dist/cjs/clusters/application-launcher.d.ts +61 -64
- package/dist/cjs/clusters/application-launcher.d.ts.map +1 -1
- package/dist/cjs/clusters/application-launcher.js +9 -10
- package/dist/cjs/clusters/application-launcher.js.map +1 -1
- package/dist/cjs/clusters/audio-output.d.ts +10 -10
- package/dist/cjs/clusters/audio-output.js +2 -2
- package/dist/cjs/clusters/ballast-configuration.d.ts +4 -4
- package/dist/cjs/clusters/ballast-configuration.js +4 -4
- package/dist/cjs/clusters/basic-information.d.ts +33 -34
- package/dist/cjs/clusters/basic-information.d.ts.map +1 -1
- package/dist/cjs/clusters/basic-information.js +33 -34
- package/dist/cjs/clusters/basic-information.js.map +1 -1
- package/dist/cjs/clusters/binding.d.ts +6 -6
- package/dist/cjs/clusters/binding.js +3 -3
- package/dist/cjs/clusters/boolean-state-configuration.d.ts +45 -46
- package/dist/cjs/clusters/boolean-state-configuration.d.ts.map +1 -1
- package/dist/cjs/clusters/boolean-state-configuration.js +9 -9
- package/dist/cjs/clusters/boolean-state-configuration.js.map +1 -1
- package/dist/cjs/clusters/bridged-device-basic-information.d.ts +62 -62
- package/dist/cjs/clusters/bridged-device-basic-information.js +16 -16
- package/dist/cjs/clusters/carbon-dioxide-concentration-measurement.d.ts +4 -4
- package/dist/cjs/clusters/carbon-monoxide-concentration-measurement.d.ts +2 -2
- package/dist/cjs/clusters/channel.d.ts +77 -77
- package/dist/cjs/clusters/channel.js +14 -14
- package/dist/cjs/clusters/color-control.d.ts +97 -102
- package/dist/cjs/clusters/color-control.d.ts.map +1 -1
- package/dist/cjs/clusters/color-control.js +29 -30
- package/dist/cjs/clusters/color-control.js.map +1 -1
- package/dist/cjs/clusters/commissioner-control.d.ts +16 -16
- package/dist/cjs/clusters/commissioner-control.js +5 -5
- package/dist/cjs/clusters/concentration-measurement.d.ts +6 -6
- package/dist/cjs/clusters/concentration-measurement.js +2 -2
- package/dist/cjs/clusters/content-app-observer.d.ts +6 -6
- package/dist/cjs/clusters/content-control.d.ts +181 -184
- package/dist/cjs/clusters/content-control.d.ts.map +1 -1
- package/dist/cjs/clusters/content-control.js +39 -40
- package/dist/cjs/clusters/content-control.js.map +1 -1
- package/dist/cjs/clusters/content-launcher.d.ts +137 -137
- package/dist/cjs/clusters/content-launcher.js +25 -25
- package/dist/cjs/clusters/descriptor.d.ts +30 -30
- package/dist/cjs/clusters/descriptor.js +8 -8
- package/dist/cjs/clusters/device-energy-management-mode.d.ts +25 -19
- package/dist/cjs/clusters/device-energy-management-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/device-energy-management-mode.js +6 -6
- package/dist/cjs/clusters/device-energy-management-mode.js.map +1 -1
- package/dist/cjs/clusters/device-energy-management.d.ts +452 -470
- package/dist/cjs/clusters/device-energy-management.d.ts.map +1 -1
- package/dist/cjs/clusters/device-energy-management.js +69 -71
- package/dist/cjs/clusters/device-energy-management.js.map +1 -1
- package/dist/cjs/clusters/diagnostic-logs.d.ts +24 -24
- package/dist/cjs/clusters/diagnostic-logs.js +11 -11
- package/dist/cjs/clusters/dishwasher-alarm.d.ts +6 -6
- package/dist/cjs/clusters/dishwasher-alarm.js +6 -6
- package/dist/cjs/clusters/dishwasher-mode.d.ts +23 -17
- package/dist/cjs/clusters/dishwasher-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/dishwasher-mode.js +6 -6
- package/dist/cjs/clusters/dishwasher-mode.js.map +1 -1
- package/dist/cjs/clusters/door-lock.d.ts +551 -534
- package/dist/cjs/clusters/door-lock.d.ts.map +1 -1
- package/dist/cjs/clusters/door-lock.js +102 -97
- package/dist/cjs/clusters/door-lock.js.map +1 -1
- package/dist/cjs/clusters/ecosystem-information.d.ts +161 -14
- package/dist/cjs/clusters/ecosystem-information.d.ts.map +1 -1
- package/dist/cjs/clusters/ecosystem-information.js +54 -10
- package/dist/cjs/clusters/ecosystem-information.js.map +1 -1
- package/dist/cjs/clusters/electrical-energy-measurement.d.ts +520 -557
- package/dist/cjs/clusters/electrical-energy-measurement.d.ts.map +1 -1
- package/dist/cjs/clusters/electrical-energy-measurement.js +35 -36
- package/dist/cjs/clusters/electrical-energy-measurement.js.map +1 -1
- package/dist/cjs/clusters/electrical-power-measurement.d.ts +88 -88
- package/dist/cjs/clusters/electrical-power-measurement.js +12 -12
- package/dist/cjs/clusters/energy-evse-mode.d.ts +27 -21
- package/dist/cjs/clusters/energy-evse-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/energy-evse-mode.js +6 -6
- package/dist/cjs/clusters/energy-evse-mode.js.map +1 -1
- package/dist/cjs/clusters/energy-evse.d.ts +295 -307
- package/dist/cjs/clusters/energy-evse.d.ts.map +1 -1
- package/dist/cjs/clusters/energy-evse.js +53 -56
- package/dist/cjs/clusters/energy-evse.js.map +1 -1
- package/dist/cjs/clusters/energy-preference.d.ts +29 -29
- package/dist/cjs/clusters/energy-preference.js +8 -8
- package/dist/cjs/clusters/ethernet-network-diagnostics.d.ts +8 -8
- package/dist/cjs/clusters/ethernet-network-diagnostics.js +2 -2
- package/dist/cjs/clusters/fan-control.d.ts +71 -71
- package/dist/cjs/clusters/fan-control.js +23 -23
- package/dist/cjs/clusters/fixed-label.d.ts +4 -4
- package/dist/cjs/clusters/formaldehyde-concentration-measurement.d.ts +2 -2
- package/dist/cjs/clusters/general-commissioning.d.ts +188 -191
- package/dist/cjs/clusters/general-commissioning.d.ts.map +1 -1
- package/dist/cjs/clusters/general-commissioning.js +59 -60
- package/dist/cjs/clusters/general-commissioning.js.map +1 -1
- package/dist/cjs/clusters/general-diagnostics.d.ts +116 -124
- package/dist/cjs/clusters/general-diagnostics.d.ts.map +1 -1
- package/dist/cjs/clusters/general-diagnostics.js +33 -35
- package/dist/cjs/clusters/general-diagnostics.js.map +1 -1
- package/dist/cjs/clusters/group-key-management.d.ts +20 -22
- package/dist/cjs/clusters/group-key-management.d.ts.map +1 -1
- package/dist/cjs/clusters/group-key-management.js +10 -11
- package/dist/cjs/clusters/group-key-management.js.map +1 -1
- package/dist/cjs/clusters/groups.d.ts +9 -10
- package/dist/cjs/clusters/groups.d.ts.map +1 -1
- package/dist/cjs/clusters/groups.js +2 -2
- package/dist/cjs/clusters/groups.js.map +1 -1
- package/dist/cjs/clusters/hepa-filter-monitoring.d.ts +2 -2
- package/dist/cjs/clusters/icd-management.d.ts +59 -62
- package/dist/cjs/clusters/icd-management.d.ts.map +1 -1
- package/dist/cjs/clusters/icd-management.js +19 -20
- package/dist/cjs/clusters/icd-management.js.map +1 -1
- package/dist/cjs/clusters/identify.d.ts +14 -14
- package/dist/cjs/clusters/identify.js +8 -8
- package/dist/cjs/clusters/illuminance-measurement.d.ts +2 -2
- package/dist/cjs/clusters/illuminance-measurement.js +2 -2
- package/dist/cjs/clusters/joint-fabric-datastore-cluster.d.ts +6 -6
- package/dist/cjs/clusters/joint-fabric-datastore-cluster.js +2 -2
- package/dist/cjs/clusters/joint-fabric-pki.d.ts +2 -2
- package/dist/cjs/clusters/joint-fabric-pki.js +2 -2
- package/dist/cjs/clusters/keypad-input.d.ts +13 -13
- package/dist/cjs/clusters/keypad-input.js +5 -5
- package/dist/cjs/clusters/laundry-dryer-controls.d.ts +4 -4
- package/dist/cjs/clusters/laundry-dryer-controls.js +4 -4
- package/dist/cjs/clusters/laundry-washer-controls.d.ts +40 -40
- package/dist/cjs/clusters/laundry-washer-controls.js +12 -12
- package/dist/cjs/clusters/laundry-washer-mode.d.ts +23 -17
- package/dist/cjs/clusters/laundry-washer-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/laundry-washer-mode.js +6 -6
- package/dist/cjs/clusters/laundry-washer-mode.js.map +1 -1
- package/dist/cjs/clusters/level-control.d.ts +56 -56
- package/dist/cjs/clusters/level-control.js +12 -12
- package/dist/cjs/clusters/localization-configuration.d.ts +4 -4
- package/dist/cjs/clusters/low-power.d.ts +2 -2
- package/dist/cjs/clusters/media-input.d.ts +2 -2
- package/dist/cjs/clusters/media-playback.d.ts +108 -108
- package/dist/cjs/clusters/media-playback.js +28 -28
- package/dist/cjs/clusters/messages.d.ts +12 -12
- package/dist/cjs/clusters/messages.js +4 -4
- package/dist/cjs/clusters/microwave-oven-control.d.ts +2 -2
- package/dist/cjs/clusters/microwave-oven-mode.d.ts +15 -15
- package/dist/cjs/clusters/microwave-oven-mode.js +5 -5
- package/dist/cjs/clusters/mode-base.d.ts +36 -36
- package/dist/cjs/clusters/mode-base.js +12 -12
- package/dist/cjs/clusters/mode-select.d.ts +39 -39
- package/dist/cjs/clusters/mode-select.js +11 -11
- package/dist/cjs/clusters/network-commissioning.d.ts +233 -238
- package/dist/cjs/clusters/network-commissioning.d.ts.map +1 -1
- package/dist/cjs/clusters/network-commissioning.js +47 -48
- package/dist/cjs/clusters/network-commissioning.js.map +1 -1
- package/dist/cjs/clusters/nitrogen-dioxide-concentration-measurement.d.ts +2 -2
- package/dist/cjs/clusters/occupancy-sensing.d.ts +37 -37
- package/dist/cjs/clusters/occupancy-sensing.js +11 -11
- package/dist/cjs/clusters/on-off.d.ts +119 -120
- package/dist/cjs/clusters/on-off.d.ts.map +1 -1
- package/dist/cjs/clusters/on-off.js +25 -25
- package/dist/cjs/clusters/on-off.js.map +1 -1
- package/dist/cjs/clusters/operational-credentials.d.ts +122 -124
- package/dist/cjs/clusters/operational-credentials.d.ts.map +1 -1
- package/dist/cjs/clusters/operational-credentials.js +74 -75
- package/dist/cjs/clusters/operational-credentials.js.map +1 -1
- package/dist/cjs/clusters/operational-state.d.ts +33 -33
- package/dist/cjs/clusters/operational-state.js +18 -18
- package/dist/cjs/clusters/ota-software-update-provider.d.ts +48 -48
- package/dist/cjs/clusters/ota-software-update-provider.js +25 -25
- package/dist/cjs/clusters/ota-software-update-requestor.d.ts +60 -62
- package/dist/cjs/clusters/ota-software-update-requestor.d.ts.map +1 -1
- package/dist/cjs/clusters/ota-software-update-requestor.js +30 -31
- package/dist/cjs/clusters/ota-software-update-requestor.js.map +1 -1
- package/dist/cjs/clusters/oven-cavity-operational-state.d.ts +10 -10
- package/dist/cjs/clusters/oven-cavity-operational-state.js +10 -10
- package/dist/cjs/clusters/oven-mode.d.ts +23 -17
- package/dist/cjs/clusters/oven-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/oven-mode.js +6 -6
- package/dist/cjs/clusters/oven-mode.js.map +1 -1
- package/dist/cjs/clusters/ozone-concentration-measurement.d.ts +4 -4
- package/dist/cjs/clusters/pm1-concentration-measurement.d.ts +2 -2
- package/dist/cjs/clusters/pm10-concentration-measurement.d.ts +2 -2
- package/dist/cjs/clusters/pm25-concentration-measurement.d.ts +2 -2
- package/dist/cjs/clusters/power-source-configuration.d.ts +5 -6
- package/dist/cjs/clusters/power-source-configuration.d.ts.map +1 -1
- package/dist/cjs/clusters/power-source-configuration.js +5 -6
- package/dist/cjs/clusters/power-source-configuration.js.map +1 -1
- package/dist/cjs/clusters/power-source.d.ts +98 -101
- package/dist/cjs/clusters/power-source.d.ts.map +1 -1
- package/dist/cjs/clusters/power-source.js +30 -31
- package/dist/cjs/clusters/power-source.js.map +1 -1
- package/dist/cjs/clusters/power-topology.d.ts +2 -2
- package/dist/cjs/clusters/pressure-measurement.d.ts +2 -2
- package/dist/cjs/clusters/proxy-discovery.d.ts +6 -6
- package/dist/cjs/clusters/proxy-discovery.js +2 -2
- package/dist/cjs/clusters/pump-configuration-and-control.d.ts +52 -52
- package/dist/cjs/clusters/pump-configuration-and-control.js +11 -11
- package/dist/cjs/clusters/radon-concentration-measurement.d.ts +4 -4
- package/dist/cjs/clusters/refrigerator-alarm.d.ts +8 -8
- package/dist/cjs/clusters/refrigerator-alarm.js +6 -6
- package/dist/cjs/clusters/refrigerator-and-temperature-controlled-cabinet-mode.d.ts +23 -17
- 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 +6 -6
- package/dist/cjs/clusters/refrigerator-and-temperature-controlled-cabinet-mode.js.map +1 -1
- package/dist/cjs/clusters/resource-monitoring.d.ts +8 -8
- package/dist/cjs/clusters/resource-monitoring.js +2 -2
- package/dist/cjs/clusters/rvc-clean-mode.d.ts +23 -17
- package/dist/cjs/clusters/rvc-clean-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/rvc-clean-mode.js +6 -6
- package/dist/cjs/clusters/rvc-clean-mode.js.map +1 -1
- package/dist/cjs/clusters/rvc-operational-state.d.ts +21 -21
- package/dist/cjs/clusters/rvc-operational-state.js +14 -14
- package/dist/cjs/clusters/rvc-run-mode.d.ts +23 -17
- package/dist/cjs/clusters/rvc-run-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/rvc-run-mode.js +6 -6
- package/dist/cjs/clusters/rvc-run-mode.js.map +1 -1
- package/dist/cjs/clusters/scenes-management.d.ts +125 -125
- package/dist/cjs/clusters/scenes-management.js +25 -25
- package/dist/cjs/clusters/scenes-management.js.map +1 -1
- package/dist/cjs/clusters/service-area.d.ts +56 -56
- package/dist/cjs/clusters/service-area.js +20 -20
- package/dist/cjs/clusters/service-area.js.map +1 -1
- package/dist/cjs/clusters/smoke-co-alarm.d.ts +45 -48
- package/dist/cjs/clusters/smoke-co-alarm.d.ts.map +1 -1
- package/dist/cjs/clusters/smoke-co-alarm.js +13 -14
- package/dist/cjs/clusters/smoke-co-alarm.js.map +1 -1
- package/dist/cjs/clusters/software-diagnostics.d.ts +20 -20
- package/dist/cjs/clusters/software-diagnostics.js +4 -4
- package/dist/cjs/clusters/switch.d.ts +26 -26
- package/dist/cjs/clusters/switch.js +8 -8
- package/dist/cjs/clusters/target-navigator.d.ts +2 -2
- package/dist/cjs/clusters/target-navigator.js +2 -2
- package/dist/cjs/clusters/temperature-control.d.ts +5 -5
- package/dist/cjs/clusters/thermostat-user-interface-configuration.d.ts +5 -5
- package/dist/cjs/clusters/thermostat-user-interface-configuration.js +3 -3
- package/dist/cjs/clusters/thermostat.d.ts +386 -357
- package/dist/cjs/clusters/thermostat.d.ts.map +1 -1
- package/dist/cjs/clusters/thermostat.js +98 -91
- package/dist/cjs/clusters/thermostat.js.map +1 -1
- package/dist/cjs/clusters/thread-border-router-management.d.ts +21 -25
- package/dist/cjs/clusters/thread-border-router-management.d.ts.map +1 -1
- package/dist/cjs/clusters/thread-border-router-management.js +4 -5
- package/dist/cjs/clusters/thread-border-router-management.js.map +1 -1
- package/dist/cjs/clusters/thread-network-diagnostics.d.ts +130 -134
- package/dist/cjs/clusters/thread-network-diagnostics.d.ts.map +1 -1
- package/dist/cjs/clusters/thread-network-diagnostics.js +42 -43
- package/dist/cjs/clusters/thread-network-diagnostics.js.map +1 -1
- package/dist/cjs/clusters/thread-network-directory.d.ts +6 -6
- package/dist/cjs/clusters/thread-network-directory.js +6 -6
- package/dist/cjs/clusters/time-format-localization.d.ts +8 -8
- package/dist/cjs/clusters/time-format-localization.js +2 -2
- package/dist/cjs/clusters/time-synchronization.d.ts +166 -166
- package/dist/cjs/clusters/time-synchronization.js +45 -45
- package/dist/cjs/clusters/total-volatile-organic-compounds-concentration-measurement.d.ts +2 -2
- package/dist/cjs/clusters/unit-localization.d.ts +11 -11
- package/dist/cjs/clusters/unit-localization.js +3 -3
- package/dist/cjs/clusters/valve-configuration-and-control.d.ts +29 -29
- package/dist/cjs/clusters/valve-configuration-and-control.js +10 -10
- package/dist/cjs/clusters/water-heater-management.d.ts +49 -49
- package/dist/cjs/clusters/water-heater-management.js +15 -15
- package/dist/cjs/clusters/water-heater-mode.d.ts +29 -23
- package/dist/cjs/clusters/water-heater-mode.d.ts.map +1 -1
- package/dist/cjs/clusters/water-heater-mode.js +8 -8
- package/dist/cjs/clusters/water-heater-mode.js.map +1 -1
- package/dist/cjs/clusters/water-tank-level-monitoring.d.ts +2 -2
- package/dist/cjs/clusters/wi-fi-network-diagnostics.d.ts +29 -29
- package/dist/cjs/clusters/wi-fi-network-diagnostics.js +9 -9
- package/dist/cjs/clusters/wi-fi-network-management.d.ts +30 -12
- package/dist/cjs/clusters/wi-fi-network-management.d.ts.map +1 -1
- package/dist/cjs/clusters/wi-fi-network-management.js +14 -10
- package/dist/cjs/clusters/wi-fi-network-management.js.map +1 -1
- package/dist/cjs/clusters/window-covering.d.ts +97 -97
- package/dist/cjs/clusters/window-covering.js +31 -31
- package/dist/cjs/common/StatusCode.d.ts +3 -0
- package/dist/cjs/common/StatusCode.d.ts.map +1 -1
- package/dist/cjs/common/StatusCode.js +3 -0
- package/dist/cjs/common/StatusCode.js.map +1 -1
- package/dist/cjs/globals/Locationdesc.d.ts +13 -13
- package/dist/cjs/globals/Locationdesc.js +13 -13
- package/dist/cjs/globals/MeasurementAccuracy.d.ts +3 -3
- package/dist/cjs/globals/MeasurementAccuracy.js +3 -3
- package/dist/cjs/globals/MeasurementAccuracyRange.d.ts +10 -10
- package/dist/cjs/globals/MeasurementAccuracyRange.js +6 -6
- package/dist/cjs/globals/Priority.d.ts +2 -2
- package/dist/cjs/globals/Semtag.d.ts.map +1 -1
- package/dist/cjs/globals/Status.d.ts +7 -7
- package/dist/cjs/globals/WildcardPathFlags.d.ts +2 -5
- package/dist/cjs/globals/WildcardPathFlags.d.ts.map +1 -1
- package/dist/cjs/globals/WildcardPathFlags.js +0 -3
- package/dist/cjs/globals/WildcardPathFlags.js.map +1 -1
- package/dist/cjs/tlv/TlvAny.d.ts.map +1 -1
- package/dist/cjs/tlv/TlvAny.js +6 -4
- package/dist/cjs/tlv/TlvAny.js.map +1 -1
- package/dist/cjs/tlv/TlvNullable.d.ts.map +1 -1
- package/dist/cjs/tlv/TlvNullable.js +3 -1
- package/dist/cjs/tlv/TlvNullable.js.map +1 -1
- package/dist/cjs/tlv/TlvObject.d.ts +1 -0
- package/dist/cjs/tlv/TlvObject.d.ts.map +1 -1
- package/dist/cjs/tlv/TlvObject.js +6 -0
- package/dist/cjs/tlv/TlvObject.js.map +1 -1
- package/dist/cjs/tlv/TlvString.d.ts +1 -1
- package/dist/cjs/tlv/TlvString.d.ts.map +1 -1
- package/dist/cjs/tlv/TlvString.js.map +1 -1
- package/dist/esm/clusters/access-control.d.ts +308 -313
- package/dist/esm/clusters/access-control.d.ts.map +1 -1
- package/dist/esm/clusters/access-control.js +57 -58
- package/dist/esm/clusters/access-control.js.map +1 -1
- package/dist/esm/clusters/account-login.d.ts +26 -26
- package/dist/esm/clusters/account-login.js +27 -27
- package/dist/esm/clusters/actions.d.ts +37 -37
- package/dist/esm/clusters/actions.js +21 -21
- package/dist/esm/clusters/activated-carbon-filter-monitoring.d.ts +2 -2
- package/dist/esm/clusters/administrator-commissioning.d.ts +63 -63
- package/dist/esm/clusters/administrator-commissioning.js +17 -17
- package/dist/esm/clusters/alarm-base.d.ts +6 -6
- package/dist/esm/clusters/alarm-base.js +6 -6
- package/dist/esm/clusters/application-basic.d.ts +6 -7
- package/dist/esm/clusters/application-basic.d.ts.map +1 -1
- package/dist/esm/clusters/application-basic.js +2 -2
- package/dist/esm/clusters/application-basic.js.map +1 -1
- package/dist/esm/clusters/application-launcher.d.ts +61 -64
- package/dist/esm/clusters/application-launcher.d.ts.map +1 -1
- package/dist/esm/clusters/application-launcher.js +9 -10
- package/dist/esm/clusters/application-launcher.js.map +1 -1
- package/dist/esm/clusters/audio-output.d.ts +10 -10
- package/dist/esm/clusters/audio-output.js +2 -2
- package/dist/esm/clusters/ballast-configuration.d.ts +4 -4
- package/dist/esm/clusters/ballast-configuration.js +4 -4
- package/dist/esm/clusters/basic-information.d.ts +33 -34
- package/dist/esm/clusters/basic-information.d.ts.map +1 -1
- package/dist/esm/clusters/basic-information.js +33 -34
- package/dist/esm/clusters/basic-information.js.map +1 -1
- package/dist/esm/clusters/binding.d.ts +6 -6
- package/dist/esm/clusters/binding.js +3 -3
- package/dist/esm/clusters/boolean-state-configuration.d.ts +45 -46
- package/dist/esm/clusters/boolean-state-configuration.d.ts.map +1 -1
- package/dist/esm/clusters/boolean-state-configuration.js +9 -9
- package/dist/esm/clusters/boolean-state-configuration.js.map +1 -1
- package/dist/esm/clusters/bridged-device-basic-information.d.ts +62 -62
- package/dist/esm/clusters/bridged-device-basic-information.js +16 -16
- package/dist/esm/clusters/carbon-dioxide-concentration-measurement.d.ts +4 -4
- package/dist/esm/clusters/carbon-monoxide-concentration-measurement.d.ts +2 -2
- package/dist/esm/clusters/channel.d.ts +77 -77
- package/dist/esm/clusters/channel.js +14 -14
- package/dist/esm/clusters/color-control.d.ts +97 -102
- package/dist/esm/clusters/color-control.d.ts.map +1 -1
- package/dist/esm/clusters/color-control.js +29 -30
- package/dist/esm/clusters/color-control.js.map +1 -1
- package/dist/esm/clusters/commissioner-control.d.ts +16 -16
- package/dist/esm/clusters/commissioner-control.js +5 -5
- package/dist/esm/clusters/concentration-measurement.d.ts +6 -6
- package/dist/esm/clusters/concentration-measurement.js +2 -2
- package/dist/esm/clusters/content-app-observer.d.ts +6 -6
- package/dist/esm/clusters/content-control.d.ts +181 -184
- package/dist/esm/clusters/content-control.d.ts.map +1 -1
- package/dist/esm/clusters/content-control.js +39 -40
- package/dist/esm/clusters/content-control.js.map +1 -1
- package/dist/esm/clusters/content-launcher.d.ts +137 -137
- package/dist/esm/clusters/content-launcher.js +25 -25
- package/dist/esm/clusters/descriptor.d.ts +30 -30
- package/dist/esm/clusters/descriptor.js +8 -8
- package/dist/esm/clusters/device-energy-management-mode.d.ts +25 -19
- package/dist/esm/clusters/device-energy-management-mode.d.ts.map +1 -1
- package/dist/esm/clusters/device-energy-management-mode.js +7 -7
- package/dist/esm/clusters/device-energy-management-mode.js.map +1 -1
- package/dist/esm/clusters/device-energy-management.d.ts +452 -470
- package/dist/esm/clusters/device-energy-management.d.ts.map +1 -1
- package/dist/esm/clusters/device-energy-management.js +69 -71
- package/dist/esm/clusters/device-energy-management.js.map +1 -1
- package/dist/esm/clusters/diagnostic-logs.d.ts +24 -24
- package/dist/esm/clusters/diagnostic-logs.js +11 -11
- package/dist/esm/clusters/dishwasher-alarm.d.ts +6 -6
- package/dist/esm/clusters/dishwasher-alarm.js +6 -6
- package/dist/esm/clusters/dishwasher-mode.d.ts +23 -17
- package/dist/esm/clusters/dishwasher-mode.d.ts.map +1 -1
- package/dist/esm/clusters/dishwasher-mode.js +7 -7
- package/dist/esm/clusters/dishwasher-mode.js.map +1 -1
- package/dist/esm/clusters/door-lock.d.ts +551 -534
- package/dist/esm/clusters/door-lock.d.ts.map +1 -1
- package/dist/esm/clusters/door-lock.js +103 -98
- package/dist/esm/clusters/door-lock.js.map +1 -1
- package/dist/esm/clusters/ecosystem-information.d.ts +161 -14
- package/dist/esm/clusters/ecosystem-information.d.ts.map +1 -1
- package/dist/esm/clusters/ecosystem-information.js +54 -10
- package/dist/esm/clusters/ecosystem-information.js.map +1 -1
- package/dist/esm/clusters/electrical-energy-measurement.d.ts +520 -557
- package/dist/esm/clusters/electrical-energy-measurement.d.ts.map +1 -1
- package/dist/esm/clusters/electrical-energy-measurement.js +35 -36
- package/dist/esm/clusters/electrical-energy-measurement.js.map +1 -1
- package/dist/esm/clusters/electrical-power-measurement.d.ts +88 -88
- package/dist/esm/clusters/electrical-power-measurement.js +12 -12
- package/dist/esm/clusters/energy-evse-mode.d.ts +27 -21
- package/dist/esm/clusters/energy-evse-mode.d.ts.map +1 -1
- package/dist/esm/clusters/energy-evse-mode.js +7 -7
- package/dist/esm/clusters/energy-evse-mode.js.map +1 -1
- package/dist/esm/clusters/energy-evse.d.ts +295 -307
- package/dist/esm/clusters/energy-evse.d.ts.map +1 -1
- package/dist/esm/clusters/energy-evse.js +53 -56
- package/dist/esm/clusters/energy-evse.js.map +1 -1
- package/dist/esm/clusters/energy-preference.d.ts +29 -29
- package/dist/esm/clusters/energy-preference.js +8 -8
- package/dist/esm/clusters/ethernet-network-diagnostics.d.ts +8 -8
- package/dist/esm/clusters/ethernet-network-diagnostics.js +2 -2
- package/dist/esm/clusters/fan-control.d.ts +71 -71
- package/dist/esm/clusters/fan-control.js +23 -23
- package/dist/esm/clusters/fixed-label.d.ts +4 -4
- package/dist/esm/clusters/formaldehyde-concentration-measurement.d.ts +2 -2
- package/dist/esm/clusters/general-commissioning.d.ts +188 -191
- package/dist/esm/clusters/general-commissioning.d.ts.map +1 -1
- package/dist/esm/clusters/general-commissioning.js +59 -60
- package/dist/esm/clusters/general-commissioning.js.map +1 -1
- package/dist/esm/clusters/general-diagnostics.d.ts +116 -124
- package/dist/esm/clusters/general-diagnostics.d.ts.map +1 -1
- package/dist/esm/clusters/general-diagnostics.js +33 -35
- package/dist/esm/clusters/general-diagnostics.js.map +1 -1
- package/dist/esm/clusters/group-key-management.d.ts +20 -22
- package/dist/esm/clusters/group-key-management.d.ts.map +1 -1
- package/dist/esm/clusters/group-key-management.js +10 -11
- package/dist/esm/clusters/group-key-management.js.map +1 -1
- package/dist/esm/clusters/groups.d.ts +9 -10
- package/dist/esm/clusters/groups.d.ts.map +1 -1
- package/dist/esm/clusters/groups.js +2 -2
- package/dist/esm/clusters/groups.js.map +1 -1
- package/dist/esm/clusters/hepa-filter-monitoring.d.ts +2 -2
- package/dist/esm/clusters/icd-management.d.ts +59 -62
- package/dist/esm/clusters/icd-management.d.ts.map +1 -1
- package/dist/esm/clusters/icd-management.js +19 -20
- package/dist/esm/clusters/icd-management.js.map +1 -1
- package/dist/esm/clusters/identify.d.ts +14 -14
- package/dist/esm/clusters/identify.js +8 -8
- package/dist/esm/clusters/illuminance-measurement.d.ts +2 -2
- package/dist/esm/clusters/illuminance-measurement.js +2 -2
- package/dist/esm/clusters/joint-fabric-datastore-cluster.d.ts +6 -6
- package/dist/esm/clusters/joint-fabric-datastore-cluster.js +2 -2
- package/dist/esm/clusters/joint-fabric-pki.d.ts +2 -2
- package/dist/esm/clusters/joint-fabric-pki.js +2 -2
- package/dist/esm/clusters/keypad-input.d.ts +13 -13
- package/dist/esm/clusters/keypad-input.js +5 -5
- package/dist/esm/clusters/laundry-dryer-controls.d.ts +4 -4
- package/dist/esm/clusters/laundry-dryer-controls.js +4 -4
- package/dist/esm/clusters/laundry-washer-controls.d.ts +40 -40
- package/dist/esm/clusters/laundry-washer-controls.js +12 -12
- package/dist/esm/clusters/laundry-washer-mode.d.ts +23 -17
- package/dist/esm/clusters/laundry-washer-mode.d.ts.map +1 -1
- package/dist/esm/clusters/laundry-washer-mode.js +7 -7
- package/dist/esm/clusters/laundry-washer-mode.js.map +1 -1
- package/dist/esm/clusters/level-control.d.ts +56 -56
- package/dist/esm/clusters/level-control.js +12 -12
- package/dist/esm/clusters/localization-configuration.d.ts +4 -4
- package/dist/esm/clusters/low-power.d.ts +2 -2
- package/dist/esm/clusters/media-input.d.ts +2 -2
- package/dist/esm/clusters/media-playback.d.ts +108 -108
- package/dist/esm/clusters/media-playback.js +28 -28
- package/dist/esm/clusters/messages.d.ts +12 -12
- package/dist/esm/clusters/messages.js +4 -4
- package/dist/esm/clusters/microwave-oven-control.d.ts +2 -2
- package/dist/esm/clusters/microwave-oven-mode.d.ts +15 -15
- package/dist/esm/clusters/microwave-oven-mode.js +5 -5
- package/dist/esm/clusters/mode-base.d.ts +36 -36
- package/dist/esm/clusters/mode-base.js +12 -12
- package/dist/esm/clusters/mode-select.d.ts +39 -39
- package/dist/esm/clusters/mode-select.js +11 -11
- package/dist/esm/clusters/network-commissioning.d.ts +233 -238
- package/dist/esm/clusters/network-commissioning.d.ts.map +1 -1
- package/dist/esm/clusters/network-commissioning.js +47 -48
- package/dist/esm/clusters/network-commissioning.js.map +1 -1
- package/dist/esm/clusters/nitrogen-dioxide-concentration-measurement.d.ts +2 -2
- package/dist/esm/clusters/occupancy-sensing.d.ts +37 -37
- package/dist/esm/clusters/occupancy-sensing.js +11 -11
- package/dist/esm/clusters/on-off.d.ts +119 -120
- package/dist/esm/clusters/on-off.d.ts.map +1 -1
- package/dist/esm/clusters/on-off.js +25 -25
- package/dist/esm/clusters/on-off.js.map +1 -1
- package/dist/esm/clusters/operational-credentials.d.ts +122 -124
- package/dist/esm/clusters/operational-credentials.d.ts.map +1 -1
- package/dist/esm/clusters/operational-credentials.js +74 -75
- package/dist/esm/clusters/operational-credentials.js.map +1 -1
- package/dist/esm/clusters/operational-state.d.ts +33 -33
- package/dist/esm/clusters/operational-state.js +18 -18
- package/dist/esm/clusters/ota-software-update-provider.d.ts +48 -48
- package/dist/esm/clusters/ota-software-update-provider.js +25 -25
- package/dist/esm/clusters/ota-software-update-requestor.d.ts +60 -62
- package/dist/esm/clusters/ota-software-update-requestor.d.ts.map +1 -1
- package/dist/esm/clusters/ota-software-update-requestor.js +30 -31
- package/dist/esm/clusters/ota-software-update-requestor.js.map +1 -1
- package/dist/esm/clusters/oven-cavity-operational-state.d.ts +10 -10
- package/dist/esm/clusters/oven-cavity-operational-state.js +10 -10
- package/dist/esm/clusters/oven-mode.d.ts +23 -17
- package/dist/esm/clusters/oven-mode.d.ts.map +1 -1
- package/dist/esm/clusters/oven-mode.js +7 -7
- package/dist/esm/clusters/oven-mode.js.map +1 -1
- package/dist/esm/clusters/ozone-concentration-measurement.d.ts +4 -4
- package/dist/esm/clusters/pm1-concentration-measurement.d.ts +2 -2
- package/dist/esm/clusters/pm10-concentration-measurement.d.ts +2 -2
- package/dist/esm/clusters/pm25-concentration-measurement.d.ts +2 -2
- package/dist/esm/clusters/power-source-configuration.d.ts +5 -6
- package/dist/esm/clusters/power-source-configuration.d.ts.map +1 -1
- package/dist/esm/clusters/power-source-configuration.js +5 -6
- package/dist/esm/clusters/power-source-configuration.js.map +1 -1
- package/dist/esm/clusters/power-source.d.ts +98 -101
- package/dist/esm/clusters/power-source.d.ts.map +1 -1
- package/dist/esm/clusters/power-source.js +30 -31
- package/dist/esm/clusters/power-source.js.map +1 -1
- package/dist/esm/clusters/power-topology.d.ts +2 -2
- package/dist/esm/clusters/pressure-measurement.d.ts +2 -2
- package/dist/esm/clusters/proxy-discovery.d.ts +6 -6
- package/dist/esm/clusters/proxy-discovery.js +2 -2
- package/dist/esm/clusters/pump-configuration-and-control.d.ts +52 -52
- package/dist/esm/clusters/pump-configuration-and-control.js +11 -11
- package/dist/esm/clusters/radon-concentration-measurement.d.ts +4 -4
- package/dist/esm/clusters/refrigerator-alarm.d.ts +8 -8
- package/dist/esm/clusters/refrigerator-alarm.js +6 -6
- package/dist/esm/clusters/refrigerator-and-temperature-controlled-cabinet-mode.d.ts +23 -17
- 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 +7 -7
- package/dist/esm/clusters/refrigerator-and-temperature-controlled-cabinet-mode.js.map +1 -1
- package/dist/esm/clusters/resource-monitoring.d.ts +8 -8
- package/dist/esm/clusters/resource-monitoring.js +2 -2
- package/dist/esm/clusters/rvc-clean-mode.d.ts +23 -17
- package/dist/esm/clusters/rvc-clean-mode.d.ts.map +1 -1
- package/dist/esm/clusters/rvc-clean-mode.js +7 -7
- package/dist/esm/clusters/rvc-clean-mode.js.map +1 -1
- package/dist/esm/clusters/rvc-operational-state.d.ts +21 -21
- package/dist/esm/clusters/rvc-operational-state.js +14 -14
- package/dist/esm/clusters/rvc-run-mode.d.ts +23 -17
- package/dist/esm/clusters/rvc-run-mode.d.ts.map +1 -1
- package/dist/esm/clusters/rvc-run-mode.js +7 -7
- package/dist/esm/clusters/rvc-run-mode.js.map +1 -1
- package/dist/esm/clusters/scenes-management.d.ts +125 -125
- package/dist/esm/clusters/scenes-management.js +25 -25
- package/dist/esm/clusters/scenes-management.js.map +1 -1
- package/dist/esm/clusters/service-area.d.ts +56 -56
- package/dist/esm/clusters/service-area.js +20 -20
- package/dist/esm/clusters/service-area.js.map +1 -1
- package/dist/esm/clusters/smoke-co-alarm.d.ts +45 -48
- package/dist/esm/clusters/smoke-co-alarm.d.ts.map +1 -1
- package/dist/esm/clusters/smoke-co-alarm.js +13 -14
- package/dist/esm/clusters/smoke-co-alarm.js.map +1 -1
- package/dist/esm/clusters/software-diagnostics.d.ts +20 -20
- package/dist/esm/clusters/software-diagnostics.js +4 -4
- package/dist/esm/clusters/switch.d.ts +26 -26
- package/dist/esm/clusters/switch.js +8 -8
- package/dist/esm/clusters/target-navigator.d.ts +2 -2
- package/dist/esm/clusters/target-navigator.js +2 -2
- package/dist/esm/clusters/temperature-control.d.ts +5 -5
- package/dist/esm/clusters/thermostat-user-interface-configuration.d.ts +5 -5
- package/dist/esm/clusters/thermostat-user-interface-configuration.js +3 -3
- package/dist/esm/clusters/thermostat.d.ts +386 -357
- package/dist/esm/clusters/thermostat.d.ts.map +1 -1
- package/dist/esm/clusters/thermostat.js +98 -91
- package/dist/esm/clusters/thermostat.js.map +1 -1
- package/dist/esm/clusters/thread-border-router-management.d.ts +21 -25
- package/dist/esm/clusters/thread-border-router-management.d.ts.map +1 -1
- package/dist/esm/clusters/thread-border-router-management.js +4 -5
- package/dist/esm/clusters/thread-border-router-management.js.map +1 -1
- package/dist/esm/clusters/thread-network-diagnostics.d.ts +130 -134
- package/dist/esm/clusters/thread-network-diagnostics.d.ts.map +1 -1
- package/dist/esm/clusters/thread-network-diagnostics.js +42 -43
- package/dist/esm/clusters/thread-network-diagnostics.js.map +1 -1
- package/dist/esm/clusters/thread-network-directory.d.ts +6 -6
- package/dist/esm/clusters/thread-network-directory.js +6 -6
- package/dist/esm/clusters/time-format-localization.d.ts +8 -8
- package/dist/esm/clusters/time-format-localization.js +2 -2
- package/dist/esm/clusters/time-synchronization.d.ts +166 -166
- package/dist/esm/clusters/time-synchronization.js +45 -45
- package/dist/esm/clusters/total-volatile-organic-compounds-concentration-measurement.d.ts +2 -2
- package/dist/esm/clusters/unit-localization.d.ts +11 -11
- package/dist/esm/clusters/unit-localization.js +3 -3
- package/dist/esm/clusters/valve-configuration-and-control.d.ts +29 -29
- package/dist/esm/clusters/valve-configuration-and-control.js +10 -10
- package/dist/esm/clusters/water-heater-management.d.ts +49 -49
- package/dist/esm/clusters/water-heater-management.js +15 -15
- package/dist/esm/clusters/water-heater-mode.d.ts +29 -23
- package/dist/esm/clusters/water-heater-mode.d.ts.map +1 -1
- package/dist/esm/clusters/water-heater-mode.js +9 -9
- package/dist/esm/clusters/water-heater-mode.js.map +1 -1
- package/dist/esm/clusters/water-tank-level-monitoring.d.ts +2 -2
- package/dist/esm/clusters/wi-fi-network-diagnostics.d.ts +29 -29
- package/dist/esm/clusters/wi-fi-network-diagnostics.js +9 -9
- package/dist/esm/clusters/wi-fi-network-management.d.ts +30 -12
- package/dist/esm/clusters/wi-fi-network-management.d.ts.map +1 -1
- package/dist/esm/clusters/wi-fi-network-management.js +14 -10
- package/dist/esm/clusters/wi-fi-network-management.js.map +1 -1
- package/dist/esm/clusters/window-covering.d.ts +97 -97
- package/dist/esm/clusters/window-covering.js +31 -31
- package/dist/esm/common/StatusCode.d.ts +3 -0
- package/dist/esm/common/StatusCode.d.ts.map +1 -1
- package/dist/esm/common/StatusCode.js +3 -0
- package/dist/esm/common/StatusCode.js.map +1 -1
- package/dist/esm/globals/Locationdesc.d.ts +13 -13
- package/dist/esm/globals/Locationdesc.js +13 -13
- package/dist/esm/globals/MeasurementAccuracy.d.ts +3 -3
- package/dist/esm/globals/MeasurementAccuracy.js +3 -3
- package/dist/esm/globals/MeasurementAccuracyRange.d.ts +10 -10
- package/dist/esm/globals/MeasurementAccuracyRange.js +6 -6
- package/dist/esm/globals/Priority.d.ts +2 -2
- package/dist/esm/globals/Semtag.d.ts.map +1 -1
- package/dist/esm/globals/Status.d.ts +7 -7
- package/dist/esm/globals/WildcardPathFlags.d.ts +2 -5
- package/dist/esm/globals/WildcardPathFlags.d.ts.map +1 -1
- package/dist/esm/globals/WildcardPathFlags.js +0 -3
- package/dist/esm/globals/WildcardPathFlags.js.map +1 -1
- package/dist/esm/tlv/TlvAny.d.ts.map +1 -1
- package/dist/esm/tlv/TlvAny.js +7 -5
- package/dist/esm/tlv/TlvAny.js.map +1 -1
- package/dist/esm/tlv/TlvNullable.d.ts.map +1 -1
- package/dist/esm/tlv/TlvNullable.js +3 -1
- package/dist/esm/tlv/TlvNullable.js.map +1 -1
- package/dist/esm/tlv/TlvObject.d.ts +1 -0
- package/dist/esm/tlv/TlvObject.d.ts.map +1 -1
- package/dist/esm/tlv/TlvObject.js +6 -0
- package/dist/esm/tlv/TlvObject.js.map +1 -1
- package/dist/esm/tlv/TlvString.d.ts +1 -1
- package/dist/esm/tlv/TlvString.d.ts.map +1 -1
- package/dist/esm/tlv/TlvString.js.map +1 -1
- package/package.json +5 -5
- package/src/clusters/access-control.ts +67 -68
- package/src/clusters/account-login.ts +26 -26
- package/src/clusters/actions.ts +34 -34
- package/src/clusters/activated-carbon-filter-monitoring.ts +2 -2
- package/src/clusters/administrator-commissioning.ts +23 -23
- package/src/clusters/alarm-base.ts +8 -8
- package/src/clusters/application-basic.ts +6 -7
- package/src/clusters/application-launcher.ts +13 -14
- package/src/clusters/audio-output.ts +6 -6
- package/src/clusters/ballast-configuration.ts +4 -4
- package/src/clusters/basic-information.ts +33 -34
- package/src/clusters/binding.ts +3 -3
- package/src/clusters/boolean-state-configuration.ts +15 -16
- package/src/clusters/bridged-device-basic-information.ts +20 -20
- package/src/clusters/carbon-dioxide-concentration-measurement.ts +4 -4
- package/src/clusters/carbon-monoxide-concentration-measurement.ts +2 -2
- package/src/clusters/channel.ts +19 -19
- package/src/clusters/color-control.ts +31 -32
- package/src/clusters/commissioner-control.ts +16 -16
- package/src/clusters/concentration-measurement.ts +4 -4
- package/src/clusters/content-app-observer.ts +6 -6
- package/src/clusters/content-control.ts +41 -42
- package/src/clusters/content-launcher.ts +31 -31
- package/src/clusters/descriptor.ts +14 -14
- package/src/clusters/device-energy-management-mode.ts +9 -9
- package/src/clusters/device-energy-management.ts +96 -99
- package/src/clusters/diagnostic-logs.ts +13 -13
- package/src/clusters/dishwasher-alarm.ts +8 -8
- package/src/clusters/dishwasher-mode.ts +7 -7
- package/src/clusters/door-lock.ts +168 -159
- package/src/clusters/ecosystem-information.ts +63 -16
- package/src/clusters/electrical-energy-measurement.ts +44 -45
- package/src/clusters/electrical-power-measurement.ts +14 -14
- package/src/clusters/energy-evse-mode.ts +11 -11
- package/src/clusters/energy-evse.ts +63 -66
- package/src/clusters/energy-preference.ts +13 -13
- package/src/clusters/ethernet-network-diagnostics.ts +6 -6
- package/src/clusters/fan-control.ts +25 -25
- package/src/clusters/fixed-label.ts +4 -4
- package/src/clusters/formaldehyde-concentration-measurement.ts +2 -2
- package/src/clusters/general-commissioning.ts +63 -64
- package/src/clusters/general-diagnostics.ts +35 -37
- package/src/clusters/group-key-management.ts +10 -11
- package/src/clusters/groups.ts +7 -8
- package/src/clusters/hepa-filter-monitoring.ts +2 -2
- package/src/clusters/icd-management.ts +27 -28
- package/src/clusters/identify.ts +12 -12
- package/src/clusters/illuminance-measurement.ts +2 -2
- package/src/clusters/joint-fabric-datastore-cluster.ts +4 -4
- package/src/clusters/joint-fabric-pki.ts +2 -2
- package/src/clusters/keypad-input.ts +8 -8
- package/src/clusters/laundry-dryer-controls.ts +4 -4
- package/src/clusters/laundry-washer-controls.ts +16 -16
- package/src/clusters/laundry-washer-mode.ts +7 -7
- package/src/clusters/level-control.ts +14 -14
- package/src/clusters/localization-configuration.ts +4 -4
- package/src/clusters/low-power.ts +2 -2
- package/src/clusters/media-input.ts +2 -2
- package/src/clusters/media-playback.ts +36 -36
- package/src/clusters/messages.ts +6 -6
- package/src/clusters/microwave-oven-control.ts +2 -2
- package/src/clusters/microwave-oven-mode.ts +5 -5
- package/src/clusters/mode-base.ts +14 -14
- package/src/clusters/mode-select.ts +18 -18
- package/src/clusters/network-commissioning.ts +49 -50
- package/src/clusters/nitrogen-dioxide-concentration-measurement.ts +2 -2
- package/src/clusters/occupancy-sensing.ts +15 -15
- package/src/clusters/on-off.ts +31 -32
- package/src/clusters/operational-credentials.ts +76 -77
- package/src/clusters/operational-state.ts +23 -23
- package/src/clusters/ota-software-update-provider.ts +25 -25
- package/src/clusters/ota-software-update-requestor.ts +36 -37
- package/src/clusters/oven-cavity-operational-state.ts +10 -10
- package/src/clusters/oven-mode.ts +7 -7
- package/src/clusters/ozone-concentration-measurement.ts +4 -4
- package/src/clusters/pm1-concentration-measurement.ts +2 -2
- package/src/clusters/pm10-concentration-measurement.ts +2 -2
- package/src/clusters/pm25-concentration-measurement.ts +2 -2
- package/src/clusters/power-source-configuration.ts +5 -6
- package/src/clusters/power-source.ts +34 -35
- package/src/clusters/power-topology.ts +2 -2
- package/src/clusters/pressure-measurement.ts +2 -2
- package/src/clusters/proxy-discovery.ts +4 -4
- package/src/clusters/pump-configuration-and-control.ts +28 -28
- package/src/clusters/radon-concentration-measurement.ts +4 -4
- package/src/clusters/refrigerator-alarm.ts +10 -10
- package/src/clusters/refrigerator-and-temperature-controlled-cabinet-mode.ts +7 -7
- package/src/clusters/resource-monitoring.ts +6 -6
- package/src/clusters/rvc-clean-mode.ts +7 -7
- package/src/clusters/rvc-operational-state.ts +17 -17
- package/src/clusters/rvc-run-mode.ts +7 -7
- package/src/clusters/scenes-management.ts +39 -39
- package/src/clusters/service-area.ts +24 -24
- package/src/clusters/smoke-co-alarm.ts +19 -20
- package/src/clusters/software-diagnostics.ts +8 -8
- package/src/clusters/switch.ts +10 -10
- package/src/clusters/target-navigator.ts +2 -2
- package/src/clusters/temperature-control.ts +5 -5
- package/src/clusters/thermostat-user-interface-configuration.ts +5 -5
- package/src/clusters/thermostat.ts +108 -97
- package/src/clusters/thread-border-router-management.ts +11 -12
- package/src/clusters/thread-network-diagnostics.ts +48 -50
- package/src/clusters/thread-network-directory.ts +6 -6
- package/src/clusters/time-format-localization.ts +4 -4
- package/src/clusters/time-synchronization.ts +50 -50
- package/src/clusters/total-volatile-organic-compounds-concentration-measurement.ts +2 -2
- package/src/clusters/unit-localization.ts +5 -5
- package/src/clusters/valve-configuration-and-control.ts +12 -12
- package/src/clusters/water-heater-management.ts +19 -19
- package/src/clusters/water-heater-mode.ts +11 -11
- package/src/clusters/water-tank-level-monitoring.ts +2 -2
- package/src/clusters/wi-fi-network-diagnostics.ts +11 -11
- package/src/clusters/wi-fi-network-management.ts +30 -12
- package/src/clusters/window-covering.ts +33 -33
- package/src/common/StatusCode.ts +3 -0
- package/src/globals/Locationdesc.ts +13 -13
- package/src/globals/MeasurementAccuracy.ts +3 -3
- package/src/globals/MeasurementAccuracyRange.ts +10 -10
- package/src/globals/Priority.ts +2 -2
- package/src/globals/Semtag.ts +1 -1
- package/src/globals/Status.ts +7 -7
- package/src/globals/WildcardPathFlags.ts +2 -5
- package/src/tlv/TlvAny.ts +7 -5
- package/src/tlv/TlvNullable.ts +10 -1
- package/src/tlv/TlvObject.ts +6 -0
- package/src/tlv/TlvString.ts +1 -1
|
@@ -19,10 +19,10 @@ export declare namespace DeviceEnergyManagement {
|
|
|
19
19
|
/**
|
|
20
20
|
* PowerAdjustment (PA)
|
|
21
21
|
*
|
|
22
|
-
* For Energy Smart Appliances (ESA) the definition of being 'smart' mandates that they can report their
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
22
|
+
* For Energy Smart Appliances (ESA) the definition of being 'smart' mandates that they can report their current
|
|
23
|
+
* power adjustment capability and have an EMS request a temporary adjustment. This may typically be to curtail
|
|
24
|
+
* power requirements during peak periods, but can also be used to turn on an ESA if there is excess renewable
|
|
25
|
+
* or local generation (Solar PV).
|
|
26
26
|
*
|
|
27
27
|
* For example, a home may have solar PV which often produces more power than the home requires, resulting in
|
|
28
28
|
* the excess power flowing into the grid. This excess power naturally fluctuates when clouds pass overhead and
|
|
@@ -90,8 +90,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
90
90
|
* An external observing EMS may have access to real-time meter readings, and could learn the typical power
|
|
91
91
|
* consumption based on the advertised internal state of the ESA.
|
|
92
92
|
*
|
|
93
|
-
* To enable this capability, the ESA shall report its internal operational state using an manufacturer
|
|
94
|
-
*
|
|
93
|
+
* To enable this capability, the ESA shall report its internal operational state using an manufacturer specific
|
|
94
|
+
* value.
|
|
95
95
|
*
|
|
96
96
|
* Once the EMS has built a model of the state vs observed power consumption, it may request a forecast
|
|
97
97
|
* adjustment for particular times of the day, encouraging the ESA to use power at alternative times.
|
|
@@ -102,14 +102,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
102
102
|
/**
|
|
103
103
|
* StartTimeAdjustment (STA)
|
|
104
104
|
*
|
|
105
|
-
* ESAs which support the Start Time Adjustment feature, allow an EMS to recommend a change to the start time
|
|
106
|
-
*
|
|
105
|
+
* ESAs which support the Start Time Adjustment feature, allow an EMS to recommend a change to the start time of
|
|
106
|
+
* the energy transfer that the ESA has previously suggested it would use.
|
|
107
107
|
*
|
|
108
108
|
* Washing machine example: A Washing Machine may have been set to start a wash cycle at 9pm when the variable
|
|
109
109
|
* tariff normally reduces.
|
|
110
110
|
*
|
|
111
|
-
* However, the EMS is aware that a grid event has occurred, making it cheaper to run the cycle at a later
|
|
112
|
-
*
|
|
111
|
+
* However, the EMS is aware that a grid event has occurred, making it cheaper to run the cycle at a later time,
|
|
112
|
+
* but the washing machine is not aware of this.
|
|
113
113
|
*
|
|
114
114
|
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the washing
|
|
115
115
|
* machine has a power profile suggesting it will start the wash cycle at 9pm, but the EMS now knows that the
|
|
@@ -151,28 +151,27 @@ export declare namespace DeviceEnergyManagement {
|
|
|
151
151
|
/**
|
|
152
152
|
* ForecastAdjustment (FA)
|
|
153
153
|
*
|
|
154
|
-
* ESAs which support the Forecast adjustment feature, allow an EMS to recommend a change to the start,
|
|
155
|
-
*
|
|
156
|
-
*
|
|
154
|
+
* ESAs which support the Forecast adjustment feature, allow an EMS to recommend a change to the start, duration
|
|
155
|
+
* and/or power level limits of the steps of the power profile that the ESA has previously suggested it would
|
|
156
|
+
* use.
|
|
157
157
|
*
|
|
158
158
|
* Heat pump and Solar PV example: A heat pump may have the ability to heat hot water as well as heating the
|
|
159
|
-
* home. The heat pump scheduling system may have determined that the home will be unoccupied during the day,
|
|
160
|
-
*
|
|
159
|
+
* home. The heat pump scheduling system may have determined that the home will be unoccupied during the day, or
|
|
160
|
+
* that the indoor temperature is above the set-point and so it knows that it will not need to heat the home.
|
|
161
161
|
*
|
|
162
162
|
* However, the hot water tank is likely to need to be reheated before the homeowner comes home in the evening.
|
|
163
163
|
* The heat pump is not aware that the property also has a solar PV inverter which is also an ESA that is
|
|
164
164
|
* communicating with the EMS.
|
|
165
165
|
*
|
|
166
166
|
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the heat pump
|
|
167
|
-
* has a power profile suggesting it needs to heat hot water around 6pm. The solar PV inverter has forecast
|
|
168
|
-
*
|
|
169
|
-
* down.
|
|
167
|
+
* has a power profile suggesting it needs to heat hot water around 6pm. The solar PV inverter has forecast that
|
|
168
|
+
* it will generate 3.6kW of power during the middle of the day and into the afternoon before the sun goes down.
|
|
170
169
|
*
|
|
171
170
|
* The EMS can then optimize the home considering other non-ESA loads and can ask the heat pump to heat the hot
|
|
172
171
|
* water around 3pm when it has forecast that excess solar power will be available.
|
|
173
172
|
*
|
|
174
|
-
* It does this by sending a ModifyForecastRequest to the heat pump and asks the heat pump to expect to run at
|
|
175
|
-
*
|
|
173
|
+
* It does this by sending a ModifyForecastRequest to the heat pump and asks the heat pump to expect to run at a
|
|
174
|
+
* lower power consumption (within the solar excess power) which requires the heat pump to run for a longer
|
|
176
175
|
* duration to achieve its required energy demand.
|
|
177
176
|
*
|
|
178
177
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.4.6
|
|
@@ -182,8 +181,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
182
181
|
* ConstraintBasedAdjustment (CON)
|
|
183
182
|
*
|
|
184
183
|
* ESAs which support the Constraint-Based Adjustment feature allow an EMS to inform the ESA of periods during
|
|
185
|
-
* which power usage should be modified (for example when the EMS has been made aware that the grid supplier
|
|
186
|
-
*
|
|
184
|
+
* which power usage should be modified (for example when the EMS has been made aware that the grid supplier has
|
|
185
|
+
* requested reduced energy usage due to overall peak grid demand)
|
|
187
186
|
*
|
|
188
187
|
* and may cause the ESA to modify the intended power profile has previously suggested it would use.
|
|
189
188
|
*
|
|
@@ -233,9 +232,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
233
232
|
* For example, if a battery storage inverter can discharge between 0 to 3000W towards a load, then power is
|
|
234
233
|
* flowing out of the node and is therefore negative. Its MinPower would be -3000W and its MaxPower would be 0W.
|
|
235
234
|
*
|
|
236
|
-
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W.
|
|
237
|
-
*
|
|
238
|
-
* 2000W.
|
|
235
|
+
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W. Here
|
|
236
|
+
* power is flowing into the node when charging. As such the MinPower becomes 0W and MaxPower becomes 2000W.
|
|
239
237
|
*
|
|
240
238
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.10.2
|
|
241
239
|
*/
|
|
@@ -287,8 +285,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
287
285
|
* This field shall indicate how the ESA can be adjusted at the current time.
|
|
288
286
|
*
|
|
289
287
|
* For example, a battery storage inverter may need to regulate its internal temperature, or the charging rate
|
|
290
|
-
* of the battery may be limited due to cold temperatures, or a change in the state of charge of the battery
|
|
291
|
-
*
|
|
288
|
+
* of the battery may be limited due to cold temperatures, or a change in the state of charge of the battery may
|
|
289
|
+
* mean that the maximum charging or discharging rate is limited.
|
|
292
290
|
*
|
|
293
291
|
* An empty list shall indicate that no power adjustment is currently possible.
|
|
294
292
|
*
|
|
@@ -324,9 +322,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
324
322
|
* For example, if a battery storage inverter can discharge between 0 to 3000W towards a load, then power is
|
|
325
323
|
* flowing out of the node and is therefore negative. Its MinPower would be -3000W and its MaxPower would be 0W.
|
|
326
324
|
*
|
|
327
|
-
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W.
|
|
328
|
-
*
|
|
329
|
-
* 2000W.
|
|
325
|
+
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W. Here
|
|
326
|
+
* power is flowing into the node when charging. As such the MinPower becomes 0W and MaxPower becomes 2000W.
|
|
330
327
|
*
|
|
331
328
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.10.2
|
|
332
329
|
*/
|
|
@@ -512,8 +509,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
512
509
|
Temperature = 3
|
|
513
510
|
}
|
|
514
511
|
/**
|
|
515
|
-
* This indicates a generic mechanism for expressing cost to run an appliance, in terms of financial, GHG
|
|
516
|
-
*
|
|
512
|
+
* This indicates a generic mechanism for expressing cost to run an appliance, in terms of financial, GHG emissions,
|
|
513
|
+
* comfort value etc.
|
|
517
514
|
*
|
|
518
515
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.9
|
|
519
516
|
*/
|
|
@@ -551,8 +548,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
551
548
|
currency: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
552
549
|
}>;
|
|
553
550
|
/**
|
|
554
|
-
* This indicates a generic mechanism for expressing cost to run an appliance, in terms of financial, GHG
|
|
555
|
-
*
|
|
551
|
+
* This indicates a generic mechanism for expressing cost to run an appliance, in terms of financial, GHG emissions,
|
|
552
|
+
* comfort value etc.
|
|
556
553
|
*
|
|
557
554
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.9
|
|
558
555
|
*/
|
|
@@ -583,9 +580,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
583
580
|
*/
|
|
584
581
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
585
582
|
/**
|
|
586
|
-
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot
|
|
587
|
-
*
|
|
588
|
-
*
|
|
583
|
+
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot has
|
|
584
|
+
* not yet been started, then it shall be 0. Once the slot has been completed, then this reflects how much time
|
|
585
|
+
* was spent in this slot.
|
|
589
586
|
*
|
|
590
587
|
* When subscribed to, a change in this field value shall NOT cause the Forecast attribute to be updated since
|
|
591
588
|
* this value may change every 1 second.
|
|
@@ -640,16 +637,16 @@ export declare namespace DeviceEnergyManagement {
|
|
|
640
637
|
* Some appliances, such as smart thermostats, may not know how much power is being drawn by the HVAC system,
|
|
641
638
|
* but do know what they have asked the HVAC system to do.
|
|
642
639
|
*
|
|
643
|
-
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they
|
|
644
|
-
*
|
|
645
|
-
*
|
|
640
|
+
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they may
|
|
641
|
+
* choose to use values between 0-100 as a percentage of compressor modulation, or could use these values as
|
|
642
|
+
* Enum states meaning heating with fan, heating without fan etc.
|
|
646
643
|
*
|
|
647
644
|
* NOTE An ESA shall always use the same value to represent the same operating state.
|
|
648
645
|
*
|
|
649
646
|
* By providing this information a smart EMS may be able to learn the observed power draw when the ESA is put
|
|
650
647
|
* into a specific state. It can potentially then use the ManufacturerESAState field in the Forecast attribute
|
|
651
|
-
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to
|
|
652
|
-
*
|
|
648
|
+
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
649
|
+
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
653
650
|
*
|
|
654
651
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.9
|
|
655
652
|
*/
|
|
@@ -663,8 +660,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
663
660
|
*/
|
|
664
661
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
665
662
|
/**
|
|
666
|
-
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during
|
|
667
|
-
*
|
|
663
|
+
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during a
|
|
664
|
+
* ramp up it may be 0W).
|
|
668
665
|
*
|
|
669
666
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
670
667
|
*
|
|
@@ -698,8 +695,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
698
695
|
* the cost as a result of shifting its energy. This can allow a demand side response service to be informed of
|
|
699
696
|
* the relative cost to use energy at a different time.
|
|
700
697
|
*
|
|
701
|
-
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be
|
|
702
|
-
*
|
|
698
|
+
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be shared
|
|
699
|
+
* by the energy appliance. These could be based on GHG emissions, comfort value for the consumer etc.
|
|
703
700
|
*
|
|
704
701
|
* For example, comfort could be expressed in abstract units or in currency. A water heater that is heated
|
|
705
702
|
* earlier in the day is likely to lose some of its heat before it is needed, which could require a top-up
|
|
@@ -746,8 +743,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
746
743
|
/**
|
|
747
744
|
* This field shall indicate the minimum power that the appliance can be requested to use.
|
|
748
745
|
*
|
|
749
|
-
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets.
|
|
750
|
-
*
|
|
746
|
+
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets. If
|
|
747
|
+
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
751
748
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
752
749
|
*
|
|
753
750
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.15
|
|
@@ -781,8 +778,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
781
778
|
* For example, if the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows
|
|
782
779
|
* an ESA to specify the maximum time it could be switched on for. This may allow a battery or water heater to
|
|
783
780
|
* indicate the maximum duration that it can charge for before becoming full. In the case of a battery inverter
|
|
784
|
-
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at
|
|
785
|
-
*
|
|
781
|
+
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
782
|
+
* MaxPowerAdjustment power level).
|
|
786
783
|
*
|
|
787
784
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.18
|
|
788
785
|
*/
|
|
@@ -857,8 +854,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
857
854
|
*/
|
|
858
855
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
859
856
|
/**
|
|
860
|
-
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A
|
|
861
|
-
*
|
|
857
|
+
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A null
|
|
858
|
+
* value indicates that it can be started immediately.
|
|
862
859
|
*
|
|
863
860
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.13.5
|
|
864
861
|
*/
|
|
@@ -907,9 +904,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
907
904
|
*/
|
|
908
905
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
909
906
|
/**
|
|
910
|
-
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot
|
|
911
|
-
*
|
|
912
|
-
*
|
|
907
|
+
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot has
|
|
908
|
+
* not yet been started, then it shall be 0. Once the slot has been completed, then this reflects how much time
|
|
909
|
+
* was spent in this slot.
|
|
913
910
|
*
|
|
914
911
|
* When subscribed to, a change in this field value shall NOT cause the Forecast attribute to be updated since
|
|
915
912
|
* this value may change every 1 second.
|
|
@@ -964,16 +961,16 @@ export declare namespace DeviceEnergyManagement {
|
|
|
964
961
|
* Some appliances, such as smart thermostats, may not know how much power is being drawn by the HVAC system,
|
|
965
962
|
* but do know what they have asked the HVAC system to do.
|
|
966
963
|
*
|
|
967
|
-
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they
|
|
968
|
-
*
|
|
969
|
-
*
|
|
964
|
+
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they may
|
|
965
|
+
* choose to use values between 0-100 as a percentage of compressor modulation, or could use these values as
|
|
966
|
+
* Enum states meaning heating with fan, heating without fan etc.
|
|
970
967
|
*
|
|
971
968
|
* NOTE An ESA shall always use the same value to represent the same operating state.
|
|
972
969
|
*
|
|
973
970
|
* By providing this information a smart EMS may be able to learn the observed power draw when the ESA is put
|
|
974
971
|
* into a specific state. It can potentially then use the ManufacturerESAState field in the Forecast attribute
|
|
975
|
-
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to
|
|
976
|
-
*
|
|
972
|
+
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
973
|
+
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
977
974
|
*
|
|
978
975
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.9
|
|
979
976
|
*/
|
|
@@ -987,8 +984,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
987
984
|
*/
|
|
988
985
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
989
986
|
/**
|
|
990
|
-
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during
|
|
991
|
-
*
|
|
987
|
+
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during a
|
|
988
|
+
* ramp up it may be 0W).
|
|
992
989
|
*
|
|
993
990
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
994
991
|
*
|
|
@@ -1022,8 +1019,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1022
1019
|
* the cost as a result of shifting its energy. This can allow a demand side response service to be informed of
|
|
1023
1020
|
* the relative cost to use energy at a different time.
|
|
1024
1021
|
*
|
|
1025
|
-
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be
|
|
1026
|
-
*
|
|
1022
|
+
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be shared
|
|
1023
|
+
* by the energy appliance. These could be based on GHG emissions, comfort value for the consumer etc.
|
|
1027
1024
|
*
|
|
1028
1025
|
* For example, comfort could be expressed in abstract units or in currency. A water heater that is heated
|
|
1029
1026
|
* earlier in the day is likely to lose some of its heat before it is needed, which could require a top-up
|
|
@@ -1070,8 +1067,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1070
1067
|
/**
|
|
1071
1068
|
* This field shall indicate the minimum power that the appliance can be requested to use.
|
|
1072
1069
|
*
|
|
1073
|
-
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets.
|
|
1074
|
-
*
|
|
1070
|
+
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets. If
|
|
1071
|
+
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
1075
1072
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
1076
1073
|
*
|
|
1077
1074
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.15
|
|
@@ -1105,8 +1102,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1105
1102
|
* For example, if the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows
|
|
1106
1103
|
* an ESA to specify the maximum time it could be switched on for. This may allow a battery or water heater to
|
|
1107
1104
|
* indicate the maximum duration that it can charge for before becoming full. In the case of a battery inverter
|
|
1108
|
-
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at
|
|
1109
|
-
*
|
|
1105
|
+
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
1106
|
+
* MaxPowerAdjustment power level).
|
|
1110
1107
|
*
|
|
1111
1108
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.18
|
|
1112
1109
|
*/
|
|
@@ -1208,8 +1205,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1208
1205
|
*/
|
|
1209
1206
|
const TlvStartTimeAdjustRequest: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
1210
1207
|
/**
|
|
1211
|
-
* This field shall indicate the requested start time, in UTC, that the client would like the appliance to
|
|
1212
|
-
*
|
|
1208
|
+
* This field shall indicate the requested start time, in UTC, that the client would like the appliance to shift
|
|
1209
|
+
* its Forecast to. This value MUST be in the future.
|
|
1213
1210
|
*
|
|
1214
1211
|
* A client can estimate the entire Forecast sequence duration by computing the EndTime - StartTime fields from
|
|
1215
1212
|
* the Forecast attribute, and therefore avoid scheduling the start time too late.
|
|
@@ -1339,8 +1336,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1339
1336
|
*/
|
|
1340
1337
|
const TlvConstraints: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
1341
1338
|
/**
|
|
1342
|
-
* This field shall indicate the start time of the constraint period that the client wishes the ESA to compute
|
|
1343
|
-
*
|
|
1339
|
+
* This field shall indicate the start time of the constraint period that the client wishes the ESA to compute a
|
|
1340
|
+
* new Forecast.
|
|
1344
1341
|
*
|
|
1345
1342
|
* This value is in UTC and MUST be in the future.
|
|
1346
1343
|
*
|
|
@@ -1355,8 +1352,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1355
1352
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1356
1353
|
/**
|
|
1357
1354
|
* This field shall indicate the nominal power that client wishes the ESA to operate at during the constrained
|
|
1358
|
-
* period. It MUST be between the AbsMinPower and AbsMaxPower attributes as advertised by the ESA if it
|
|
1359
|
-
*
|
|
1355
|
+
* period. It MUST be between the AbsMinPower and AbsMaxPower attributes as advertised by the ESA if it supports
|
|
1356
|
+
* PFR.
|
|
1360
1357
|
*
|
|
1361
1358
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
1362
1359
|
*
|
|
@@ -1364,8 +1361,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1364
1361
|
*/
|
|
1365
1362
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1366
1363
|
/**
|
|
1367
|
-
* This field shall indicate the maximum energy that can be transferred to or from the ESA during the
|
|
1368
|
-
*
|
|
1364
|
+
* This field shall indicate the maximum energy that can be transferred to or from the ESA during the constraint
|
|
1365
|
+
* period.
|
|
1369
1366
|
*
|
|
1370
1367
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
1371
1368
|
*
|
|
@@ -1377,8 +1374,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1377
1374
|
* during the constraint period.
|
|
1378
1375
|
*
|
|
1379
1376
|
* This is expressed as a signed value between -100 to +100. A value of 0 would indicate no bias to using more
|
|
1380
|
-
* or less energy. A negative value indicates a request to use less energy. A positive value indicates a
|
|
1381
|
-
*
|
|
1377
|
+
* or less energy. A negative value indicates a request to use less energy. A positive value indicates a request
|
|
1378
|
+
* to use more energy.
|
|
1382
1379
|
*
|
|
1383
1380
|
* Note that the mapping between values and operation is manufacturer specific.
|
|
1384
1381
|
*
|
|
@@ -1421,8 +1418,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1421
1418
|
*/
|
|
1422
1419
|
constraints: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1423
1420
|
/**
|
|
1424
|
-
* This field shall indicate the start time of the constraint period that the client wishes the ESA to compute
|
|
1425
|
-
*
|
|
1421
|
+
* This field shall indicate the start time of the constraint period that the client wishes the ESA to compute a
|
|
1422
|
+
* new Forecast.
|
|
1426
1423
|
*
|
|
1427
1424
|
* This value is in UTC and MUST be in the future.
|
|
1428
1425
|
*
|
|
@@ -1437,8 +1434,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1437
1434
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1438
1435
|
/**
|
|
1439
1436
|
* This field shall indicate the nominal power that client wishes the ESA to operate at during the constrained
|
|
1440
|
-
* period. It MUST be between the AbsMinPower and AbsMaxPower attributes as advertised by the ESA if it
|
|
1441
|
-
*
|
|
1437
|
+
* period. It MUST be between the AbsMinPower and AbsMaxPower attributes as advertised by the ESA if it supports
|
|
1438
|
+
* PFR.
|
|
1442
1439
|
*
|
|
1443
1440
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
1444
1441
|
*
|
|
@@ -1446,8 +1443,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1446
1443
|
*/
|
|
1447
1444
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1448
1445
|
/**
|
|
1449
|
-
* This field shall indicate the maximum energy that can be transferred to or from the ESA during the
|
|
1450
|
-
*
|
|
1446
|
+
* This field shall indicate the maximum energy that can be transferred to or from the ESA during the constraint
|
|
1447
|
+
* period.
|
|
1451
1448
|
*
|
|
1452
1449
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
1453
1450
|
*
|
|
@@ -1459,8 +1456,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1459
1456
|
* during the constraint period.
|
|
1460
1457
|
*
|
|
1461
1458
|
* This is expressed as a signed value between -100 to +100. A value of 0 would indicate no bias to using more
|
|
1462
|
-
* or less energy. A negative value indicates a request to use less energy. A positive value indicates a
|
|
1463
|
-
*
|
|
1459
|
+
* or less energy. A negative value indicates a request to use less energy. A positive value indicates a request
|
|
1460
|
+
* to use more energy.
|
|
1464
1461
|
*
|
|
1465
1462
|
* Note that the mapping between values and operation is manufacturer specific.
|
|
1466
1463
|
*
|
|
@@ -1599,8 +1596,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1599
1596
|
* This field shall indicate how the ESA can be adjusted at the current time.
|
|
1600
1597
|
*
|
|
1601
1598
|
* For example, a battery storage inverter may need to regulate its internal temperature, or the charging rate
|
|
1602
|
-
* of the battery may be limited due to cold temperatures, or a change in the state of charge of the battery
|
|
1603
|
-
*
|
|
1599
|
+
* of the battery may be limited due to cold temperatures, or a change in the state of charge of the battery may
|
|
1600
|
+
* mean that the maximum charging or discharging rate is limited.
|
|
1604
1601
|
*
|
|
1605
1602
|
* An empty list shall indicate that no power adjustment is currently possible.
|
|
1606
1603
|
*
|
|
@@ -1636,9 +1633,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1636
1633
|
* For example, if a battery storage inverter can discharge between 0 to 3000W towards a load, then power is
|
|
1637
1634
|
* flowing out of the node and is therefore negative. Its MinPower would be -3000W and its MaxPower would be 0W.
|
|
1638
1635
|
*
|
|
1639
|
-
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W.
|
|
1640
|
-
*
|
|
1641
|
-
* 2000W.
|
|
1636
|
+
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W. Here
|
|
1637
|
+
* power is flowing into the node when charging. As such the MinPower becomes 0W and MaxPower becomes 2000W.
|
|
1642
1638
|
*
|
|
1643
1639
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.10.2
|
|
1644
1640
|
*/
|
|
@@ -1753,8 +1749,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1753
1749
|
* A null value indicates that there is no forecast currently available (for example, a program has not yet
|
|
1754
1750
|
* been selected by the user).
|
|
1755
1751
|
*
|
|
1756
|
-
* A server may reset this value attribute to null on a reboot, and it does not need to persist any
|
|
1757
|
-
*
|
|
1752
|
+
* A server may reset this value attribute to null on a reboot, and it does not need to persist any previous
|
|
1753
|
+
* forecasts.
|
|
1758
1754
|
*
|
|
1759
1755
|
* Changes to this attribute shall only be marked as reportable in the following cases:
|
|
1760
1756
|
*
|
|
@@ -1803,8 +1799,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1803
1799
|
*/
|
|
1804
1800
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1805
1801
|
/**
|
|
1806
|
-
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A
|
|
1807
|
-
*
|
|
1802
|
+
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A null
|
|
1803
|
+
* value indicates that it can be started immediately.
|
|
1808
1804
|
*
|
|
1809
1805
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.13.5
|
|
1810
1806
|
*/
|
|
@@ -1853,9 +1849,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1853
1849
|
*/
|
|
1854
1850
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1855
1851
|
/**
|
|
1856
|
-
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot
|
|
1857
|
-
*
|
|
1858
|
-
*
|
|
1852
|
+
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot has
|
|
1853
|
+
* not yet been started, then it shall be 0. Once the slot has been completed, then this reflects how much time
|
|
1854
|
+
* was spent in this slot.
|
|
1859
1855
|
*
|
|
1860
1856
|
* When subscribed to, a change in this field value shall NOT cause the Forecast attribute to be updated since
|
|
1861
1857
|
* this value may change every 1 second.
|
|
@@ -1910,16 +1906,16 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1910
1906
|
* Some appliances, such as smart thermostats, may not know how much power is being drawn by the HVAC system,
|
|
1911
1907
|
* but do know what they have asked the HVAC system to do.
|
|
1912
1908
|
*
|
|
1913
|
-
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they
|
|
1914
|
-
*
|
|
1915
|
-
*
|
|
1909
|
+
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they may
|
|
1910
|
+
* choose to use values between 0-100 as a percentage of compressor modulation, or could use these values as
|
|
1911
|
+
* Enum states meaning heating with fan, heating without fan etc.
|
|
1916
1912
|
*
|
|
1917
1913
|
* NOTE An ESA shall always use the same value to represent the same operating state.
|
|
1918
1914
|
*
|
|
1919
1915
|
* By providing this information a smart EMS may be able to learn the observed power draw when the ESA is put
|
|
1920
1916
|
* into a specific state. It can potentially then use the ManufacturerESAState field in the Forecast attribute
|
|
1921
|
-
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to
|
|
1922
|
-
*
|
|
1917
|
+
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
1918
|
+
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
1923
1919
|
*
|
|
1924
1920
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.9
|
|
1925
1921
|
*/
|
|
@@ -1933,8 +1929,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1933
1929
|
*/
|
|
1934
1930
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1935
1931
|
/**
|
|
1936
|
-
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during
|
|
1937
|
-
*
|
|
1932
|
+
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during a
|
|
1933
|
+
* ramp up it may be 0W).
|
|
1938
1934
|
*
|
|
1939
1935
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
1940
1936
|
*
|
|
@@ -1968,8 +1964,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1968
1964
|
* the cost as a result of shifting its energy. This can allow a demand side response service to be informed of
|
|
1969
1965
|
* the relative cost to use energy at a different time.
|
|
1970
1966
|
*
|
|
1971
|
-
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be
|
|
1972
|
-
*
|
|
1967
|
+
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be shared
|
|
1968
|
+
* by the energy appliance. These could be based on GHG emissions, comfort value for the consumer etc.
|
|
1973
1969
|
*
|
|
1974
1970
|
* For example, comfort could be expressed in abstract units or in currency. A water heater that is heated
|
|
1975
1971
|
* earlier in the day is likely to lose some of its heat before it is needed, which could require a top-up
|
|
@@ -2016,8 +2012,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2016
2012
|
/**
|
|
2017
2013
|
* This field shall indicate the minimum power that the appliance can be requested to use.
|
|
2018
2014
|
*
|
|
2019
|
-
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets.
|
|
2020
|
-
*
|
|
2015
|
+
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets. If
|
|
2016
|
+
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
2021
2017
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
2022
2018
|
*
|
|
2023
2019
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.15
|
|
@@ -2051,8 +2047,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2051
2047
|
* For example, if the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows
|
|
2052
2048
|
* an ESA to specify the maximum time it could be switched on for. This may allow a battery or water heater to
|
|
2053
2049
|
* indicate the maximum duration that it can charge for before becoming full. In the case of a battery inverter
|
|
2054
|
-
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at
|
|
2055
|
-
*
|
|
2050
|
+
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
2051
|
+
* MaxPowerAdjustment power level).
|
|
2056
2052
|
*
|
|
2057
2053
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.18
|
|
2058
2054
|
*/
|
|
@@ -2074,19 +2070,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2074
2070
|
const PowerAdjustmentOrStartTimeAdjustmentOrPausableOrForecastAdjustmentOrConstraintBasedAdjustmentComponent: {
|
|
2075
2071
|
readonly attributes: {
|
|
2076
2072
|
/**
|
|
2077
|
-
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the
|
|
2078
|
-
*
|
|
2079
|
-
*
|
|
2073
|
+
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the user
|
|
2074
|
+
* to control this OptOutState. An EMS may subscribe to the OptOutState to get notified about changes in
|
|
2075
|
+
* operational state.
|
|
2080
2076
|
*
|
|
2081
2077
|
* If the ESA is in the LocalOptOut or OptOut states, so it cannot be controlled by an EMS for local
|
|
2082
2078
|
* optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
2083
|
-
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an
|
|
2084
|
-
*
|
|
2079
|
+
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an EMS
|
|
2080
|
+
* for grid optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
2085
2081
|
* GridOptimization.
|
|
2086
2082
|
*
|
|
2087
|
-
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is
|
|
2088
|
-
*
|
|
2089
|
-
*
|
|
2083
|
+
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is due
|
|
2084
|
+
* to a previous StartTimeAdjustRequest, ModifyForecastRequest or RequestConstraintBasedForecast command
|
|
2085
|
+
* that would now not be permitted due to the new Opt-out state
|
|
2090
2086
|
*
|
|
2091
2087
|
* attribute ForecastUpdateReason field currently contains a reason which is now opted out), the ESA shall
|
|
2092
2088
|
* behave as if it had received a CancelRequest command.
|
|
@@ -2098,10 +2094,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2098
2094
|
* ResumeRequest command.
|
|
2099
2095
|
*
|
|
2100
2096
|
* If the user changes the Opt-Out state of the ESA which currently has the ESAStateEnum with value
|
|
2101
|
-
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to
|
|
2102
|
-
*
|
|
2103
|
-
*
|
|
2104
|
-
* command.
|
|
2097
|
+
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to the
|
|
2098
|
+
* new Opt-out state (i.e. the Forecast attribute ForecastUpdateReason field currently contains a reason
|
|
2099
|
+
* which is now opted out), the ESA shall behave as if it had received a CancelPowerAdjustRequest command.
|
|
2105
2100
|
*
|
|
2106
2101
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
2107
2102
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
@@ -2179,8 +2174,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2179
2174
|
*/
|
|
2180
2175
|
readonly startTimeAdjustRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2181
2176
|
/**
|
|
2182
|
-
* This field shall indicate the requested start time, in UTC, that the client would like the appliance to
|
|
2183
|
-
*
|
|
2177
|
+
* This field shall indicate the requested start time, in UTC, that the client would like the appliance to shift
|
|
2178
|
+
* its Forecast to. This value MUST be in the future.
|
|
2184
2179
|
*
|
|
2185
2180
|
* A client can estimate the entire Forecast sequence duration by computing the EndTime - StartTime fields from
|
|
2186
2181
|
* the Forecast attribute, and therefore avoid scheduling the start time too late.
|
|
@@ -2291,8 +2286,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2291
2286
|
*/
|
|
2292
2287
|
constraints: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2293
2288
|
/**
|
|
2294
|
-
* This field shall indicate the start time of the constraint period that the client wishes the ESA to compute
|
|
2295
|
-
*
|
|
2289
|
+
* This field shall indicate the start time of the constraint period that the client wishes the ESA to compute a
|
|
2290
|
+
* new Forecast.
|
|
2296
2291
|
*
|
|
2297
2292
|
* This value is in UTC and MUST be in the future.
|
|
2298
2293
|
*
|
|
@@ -2307,8 +2302,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2307
2302
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2308
2303
|
/**
|
|
2309
2304
|
* This field shall indicate the nominal power that client wishes the ESA to operate at during the constrained
|
|
2310
|
-
* period. It MUST be between the AbsMinPower and AbsMaxPower attributes as advertised by the ESA if it
|
|
2311
|
-
*
|
|
2305
|
+
* period. It MUST be between the AbsMinPower and AbsMaxPower attributes as advertised by the ESA if it supports
|
|
2306
|
+
* PFR.
|
|
2312
2307
|
*
|
|
2313
2308
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
2314
2309
|
*
|
|
@@ -2316,8 +2311,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2316
2311
|
*/
|
|
2317
2312
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
2318
2313
|
/**
|
|
2319
|
-
* This field shall indicate the maximum energy that can be transferred to or from the ESA during the
|
|
2320
|
-
*
|
|
2314
|
+
* This field shall indicate the maximum energy that can be transferred to or from the ESA during the constraint
|
|
2315
|
+
* period.
|
|
2321
2316
|
*
|
|
2322
2317
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
2323
2318
|
*
|
|
@@ -2329,8 +2324,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2329
2324
|
* during the constraint period.
|
|
2330
2325
|
*
|
|
2331
2326
|
* This is expressed as a signed value between -100 to +100. A value of 0 would indicate no bias to using more
|
|
2332
|
-
* or less energy. A negative value indicates a request to use less energy. A positive value indicates a
|
|
2333
|
-
*
|
|
2327
|
+
* or less energy. A negative value indicates a request to use less energy. A positive value indicates a request
|
|
2328
|
+
* to use more energy.
|
|
2334
2329
|
*
|
|
2335
2330
|
* Note that the mapping between values and operation is manufacturer specific.
|
|
2336
2331
|
*
|
|
@@ -2374,8 +2369,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2374
2369
|
* PowerAdjustment
|
|
2375
2370
|
*
|
|
2376
2371
|
* For Energy Smart Appliances (ESA) the definition of being 'smart' mandates that they can report their
|
|
2377
|
-
* current power adjustment capability and have an EMS request a temporary adjustment. This may typically
|
|
2378
|
-
*
|
|
2372
|
+
* current power adjustment capability and have an EMS request a temporary adjustment. This may typically be
|
|
2373
|
+
* to curtail power requirements during peak periods, but can also be used to turn on an ESA if there is
|
|
2379
2374
|
* excess renewable or local generation (Solar PV).
|
|
2380
2375
|
*
|
|
2381
2376
|
* For example, a home may have solar PV which often produces more power than the home requires, resulting
|
|
@@ -2409,8 +2404,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2409
2404
|
* In some circumstances the ESA may allow the stage to be delayed or paused (subject to safety and
|
|
2410
2405
|
* manufacturer’s discretion and user preferences).
|
|
2411
2406
|
*
|
|
2412
|
-
* Typically, appliances with a heating element cannot have their power consumption adjusted and can only
|
|
2413
|
-
*
|
|
2407
|
+
* Typically, appliances with a heating element cannot have their power consumption adjusted and can only be
|
|
2408
|
+
* paused or delayed.
|
|
2414
2409
|
*
|
|
2415
2410
|
* Some ESAs may not be flexible other than a delayed cycle start (for example, once the washing cycle has
|
|
2416
2411
|
* been started then they run continuously until the cycle completes).
|
|
@@ -2466,9 +2461,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2466
2461
|
* However, the EMS is aware that a grid event has occurred, making it cheaper to run the cycle at a later
|
|
2467
2462
|
* time, but the washing machine is not aware of this.
|
|
2468
2463
|
*
|
|
2469
|
-
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the
|
|
2470
|
-
*
|
|
2471
|
-
*
|
|
2464
|
+
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the washing
|
|
2465
|
+
* machine has a power profile suggesting it will start the wash cycle at 9pm, but the EMS now knows that
|
|
2466
|
+
* the grid event means it will be cheaper to delay the start until 11pm.
|
|
2472
2467
|
*
|
|
2473
2468
|
* The EMS can then optimize the cost by asking the washing machine to delay starting the wash cycle until
|
|
2474
2469
|
* 11pm.
|
|
@@ -2491,9 +2486,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2491
2486
|
* However, the EMS becomes aware from the smart meter that the total home load on the grid is close to
|
|
2492
2487
|
* exceeding its allowed total grid load.
|
|
2493
2488
|
*
|
|
2494
|
-
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the
|
|
2495
|
-
*
|
|
2496
|
-
*
|
|
2489
|
+
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the washing
|
|
2490
|
+
* machine has a power profile suggesting its current step in the wash cycle is using power to heat the
|
|
2491
|
+
* water, but that this step can be paused.
|
|
2497
2492
|
*
|
|
2498
2493
|
* The EMS can then reduce the grid load by asking the washing machine to pause the wash cycle for a short
|
|
2499
2494
|
* duration.
|
|
@@ -2511,10 +2506,10 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2511
2506
|
* duration and/or power level limits of the steps of the power profile that the ESA has previously
|
|
2512
2507
|
* suggested it would use.
|
|
2513
2508
|
*
|
|
2514
|
-
* Heat pump and Solar PV example: A heat pump may have the ability to heat hot water as well as heating
|
|
2515
|
-
*
|
|
2516
|
-
*
|
|
2517
|
-
*
|
|
2509
|
+
* Heat pump and Solar PV example: A heat pump may have the ability to heat hot water as well as heating the
|
|
2510
|
+
* home. The heat pump scheduling system may have determined that the home will be unoccupied during the
|
|
2511
|
+
* day, or that the indoor temperature is above the set-point and so it knows that it will not need to heat
|
|
2512
|
+
* the home.
|
|
2518
2513
|
*
|
|
2519
2514
|
* However, the hot water tank is likely to need to be reheated before the homeowner comes home in the
|
|
2520
2515
|
* evening. The heat pump is not aware that the property also has a solar PV inverter which is also an ESA
|
|
@@ -2544,11 +2539,11 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2544
2539
|
*
|
|
2545
2540
|
* and may cause the ESA to modify the intended power profile has previously suggested it would use.
|
|
2546
2541
|
*
|
|
2547
|
-
* EVSE example: An EVSE scheduling system may have determined that the vehicle would be charged starting
|
|
2548
|
-
*
|
|
2542
|
+
* EVSE example: An EVSE scheduling system may have determined that the vehicle would be charged starting at
|
|
2543
|
+
* a moderate rate at 1am, so that it has enough charge by the time it is needed later that morning.
|
|
2549
2544
|
*
|
|
2550
|
-
* However, the DSR service provider has informed the EMS that due to high forecast winds it is now
|
|
2551
|
-
*
|
|
2545
|
+
* However, the DSR service provider has informed the EMS that due to high forecast winds it is now forecast
|
|
2546
|
+
* that there will be very cheap energy available from wind generation between 2am and 3am.
|
|
2552
2547
|
*
|
|
2553
2548
|
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the EVSE
|
|
2554
2549
|
* has a power profile suggesting it plans to start charging the vehicle at 1am.
|
|
@@ -2583,16 +2578,16 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2583
2578
|
*/
|
|
2584
2579
|
readonly esaType: FixedAttribute<EsaType, any>;
|
|
2585
2580
|
/**
|
|
2586
|
-
* Indicates whether the ESA is classed as a generator or load. This allows an EMS to understand whether
|
|
2587
|
-
*
|
|
2581
|
+
* Indicates whether the ESA is classed as a generator or load. This allows an EMS to understand whether the
|
|
2582
|
+
* power values reported by the ESA need to have their sign inverted when dealing with forecasts and
|
|
2588
2583
|
* adjustments.
|
|
2589
2584
|
*
|
|
2590
2585
|
* For example, a solar PV inverter (being a generator) may produce negative values to indicate generation
|
|
2591
2586
|
* (since power is flowing out of the node into the home), however a display showing the power to the
|
|
2592
2587
|
* consumers may need to present a positive solar production value to the consumer.
|
|
2593
2588
|
*
|
|
2594
|
-
* For example, a home battery storage system (BESS) which needs to charge the battery and then discharge
|
|
2595
|
-
*
|
|
2589
|
+
* For example, a home battery storage system (BESS) which needs to charge the battery and then discharge to
|
|
2590
|
+
* the home loads, would be classed as a generator. These types of devices shall have this field set to
|
|
2596
2591
|
* true. When generating its forecast or advertising its PowerAdjustmentCapability, the power values shall
|
|
2597
2592
|
* be negative to indicate discharging to the loads in the home, and positive to indicate when it is
|
|
2598
2593
|
* charging its battery.
|
|
@@ -2612,8 +2607,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2612
2607
|
* operational state.
|
|
2613
2608
|
*
|
|
2614
2609
|
* The ESA may have a local user interface to allow a service technician to put the ESA into Offline mode,
|
|
2615
|
-
* for example to avoid the EMS accidentally starting or stopping the appliance when it is being serviced
|
|
2616
|
-
*
|
|
2610
|
+
* for example to avoid the EMS accidentally starting or stopping the appliance when it is being serviced or
|
|
2611
|
+
* tested.
|
|
2617
2612
|
*
|
|
2618
2613
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.8.3
|
|
2619
2614
|
*/
|
|
@@ -2677,8 +2672,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2677
2672
|
* This field shall indicate how the ESA can be adjusted at the current time.
|
|
2678
2673
|
*
|
|
2679
2674
|
* For example, a battery storage inverter may need to regulate its internal temperature, or the charging rate
|
|
2680
|
-
* of the battery may be limited due to cold temperatures, or a change in the state of charge of the battery
|
|
2681
|
-
*
|
|
2675
|
+
* of the battery may be limited due to cold temperatures, or a change in the state of charge of the battery may
|
|
2676
|
+
* mean that the maximum charging or discharging rate is limited.
|
|
2682
2677
|
*
|
|
2683
2678
|
* An empty list shall indicate that no power adjustment is currently possible.
|
|
2684
2679
|
*
|
|
@@ -2714,9 +2709,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2714
2709
|
* For example, if a battery storage inverter can discharge between 0 to 3000W towards a load, then power is
|
|
2715
2710
|
* flowing out of the node and is therefore negative. Its MinPower would be -3000W and its MaxPower would be 0W.
|
|
2716
2711
|
*
|
|
2717
|
-
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W.
|
|
2718
|
-
*
|
|
2719
|
-
* 2000W.
|
|
2712
|
+
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W. Here
|
|
2713
|
+
* power is flowing into the node when charging. As such the MinPower becomes 0W and MaxPower becomes 2000W.
|
|
2720
2714
|
*
|
|
2721
2715
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.10.2
|
|
2722
2716
|
*/
|
|
@@ -2831,8 +2825,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2831
2825
|
* A null value indicates that there is no forecast currently available (for example, a program has not yet
|
|
2832
2826
|
* been selected by the user).
|
|
2833
2827
|
*
|
|
2834
|
-
* A server may reset this value attribute to null on a reboot, and it does not need to persist any
|
|
2835
|
-
*
|
|
2828
|
+
* A server may reset this value attribute to null on a reboot, and it does not need to persist any previous
|
|
2829
|
+
* forecasts.
|
|
2836
2830
|
*
|
|
2837
2831
|
* Changes to this attribute shall only be marked as reportable in the following cases:
|
|
2838
2832
|
*
|
|
@@ -2881,8 +2875,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2881
2875
|
*/
|
|
2882
2876
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2883
2877
|
/**
|
|
2884
|
-
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A
|
|
2885
|
-
*
|
|
2878
|
+
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A null
|
|
2879
|
+
* value indicates that it can be started immediately.
|
|
2886
2880
|
*
|
|
2887
2881
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.13.5
|
|
2888
2882
|
*/
|
|
@@ -2931,9 +2925,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2931
2925
|
*/
|
|
2932
2926
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2933
2927
|
/**
|
|
2934
|
-
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot
|
|
2935
|
-
*
|
|
2936
|
-
*
|
|
2928
|
+
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot has
|
|
2929
|
+
* not yet been started, then it shall be 0. Once the slot has been completed, then this reflects how much time
|
|
2930
|
+
* was spent in this slot.
|
|
2937
2931
|
*
|
|
2938
2932
|
* When subscribed to, a change in this field value shall NOT cause the Forecast attribute to be updated since
|
|
2939
2933
|
* this value may change every 1 second.
|
|
@@ -2988,16 +2982,16 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2988
2982
|
* Some appliances, such as smart thermostats, may not know how much power is being drawn by the HVAC system,
|
|
2989
2983
|
* but do know what they have asked the HVAC system to do.
|
|
2990
2984
|
*
|
|
2991
|
-
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they
|
|
2992
|
-
*
|
|
2993
|
-
*
|
|
2985
|
+
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they may
|
|
2986
|
+
* choose to use values between 0-100 as a percentage of compressor modulation, or could use these values as
|
|
2987
|
+
* Enum states meaning heating with fan, heating without fan etc.
|
|
2994
2988
|
*
|
|
2995
2989
|
* NOTE An ESA shall always use the same value to represent the same operating state.
|
|
2996
2990
|
*
|
|
2997
2991
|
* By providing this information a smart EMS may be able to learn the observed power draw when the ESA is put
|
|
2998
2992
|
* into a specific state. It can potentially then use the ManufacturerESAState field in the Forecast attribute
|
|
2999
|
-
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to
|
|
3000
|
-
*
|
|
2993
|
+
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
2994
|
+
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
3001
2995
|
*
|
|
3002
2996
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.9
|
|
3003
2997
|
*/
|
|
@@ -3011,8 +3005,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3011
3005
|
*/
|
|
3012
3006
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3013
3007
|
/**
|
|
3014
|
-
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during
|
|
3015
|
-
*
|
|
3008
|
+
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during a
|
|
3009
|
+
* ramp up it may be 0W).
|
|
3016
3010
|
*
|
|
3017
3011
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
3018
3012
|
*
|
|
@@ -3046,8 +3040,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3046
3040
|
* the cost as a result of shifting its energy. This can allow a demand side response service to be informed of
|
|
3047
3041
|
* the relative cost to use energy at a different time.
|
|
3048
3042
|
*
|
|
3049
|
-
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be
|
|
3050
|
-
*
|
|
3043
|
+
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be shared
|
|
3044
|
+
* by the energy appliance. These could be based on GHG emissions, comfort value for the consumer etc.
|
|
3051
3045
|
*
|
|
3052
3046
|
* For example, comfort could be expressed in abstract units or in currency. A water heater that is heated
|
|
3053
3047
|
* earlier in the day is likely to lose some of its heat before it is needed, which could require a top-up
|
|
@@ -3094,8 +3088,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3094
3088
|
/**
|
|
3095
3089
|
* This field shall indicate the minimum power that the appliance can be requested to use.
|
|
3096
3090
|
*
|
|
3097
|
-
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets.
|
|
3098
|
-
*
|
|
3091
|
+
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets. If
|
|
3092
|
+
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
3099
3093
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
3100
3094
|
*
|
|
3101
3095
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.15
|
|
@@ -3129,8 +3123,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3129
3123
|
* For example, if the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows
|
|
3130
3124
|
* an ESA to specify the maximum time it could be switched on for. This may allow a battery or water heater to
|
|
3131
3125
|
* indicate the maximum duration that it can charge for before becoming full. In the case of a battery inverter
|
|
3132
|
-
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at
|
|
3133
|
-
*
|
|
3126
|
+
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
3127
|
+
* MaxPowerAdjustment power level).
|
|
3134
3128
|
*
|
|
3135
3129
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.18
|
|
3136
3130
|
*/
|
|
@@ -3158,8 +3152,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3158
3152
|
* A null value indicates that there is no forecast currently available (for example, a program has not yet
|
|
3159
3153
|
* been selected by the user).
|
|
3160
3154
|
*
|
|
3161
|
-
* A server may reset this value attribute to null on a reboot, and it does not need to persist any
|
|
3162
|
-
*
|
|
3155
|
+
* A server may reset this value attribute to null on a reboot, and it does not need to persist any previous
|
|
3156
|
+
* forecasts.
|
|
3163
3157
|
*
|
|
3164
3158
|
* Changes to this attribute shall only be marked as reportable in the following cases:
|
|
3165
3159
|
*
|
|
@@ -3208,8 +3202,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3208
3202
|
*/
|
|
3209
3203
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3210
3204
|
/**
|
|
3211
|
-
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A
|
|
3212
|
-
*
|
|
3205
|
+
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A null
|
|
3206
|
+
* value indicates that it can be started immediately.
|
|
3213
3207
|
*
|
|
3214
3208
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.13.5
|
|
3215
3209
|
*/
|
|
@@ -3258,9 +3252,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3258
3252
|
*/
|
|
3259
3253
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3260
3254
|
/**
|
|
3261
|
-
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot
|
|
3262
|
-
*
|
|
3263
|
-
*
|
|
3255
|
+
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot has
|
|
3256
|
+
* not yet been started, then it shall be 0. Once the slot has been completed, then this reflects how much time
|
|
3257
|
+
* was spent in this slot.
|
|
3264
3258
|
*
|
|
3265
3259
|
* When subscribed to, a change in this field value shall NOT cause the Forecast attribute to be updated since
|
|
3266
3260
|
* this value may change every 1 second.
|
|
@@ -3315,16 +3309,16 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3315
3309
|
* Some appliances, such as smart thermostats, may not know how much power is being drawn by the HVAC system,
|
|
3316
3310
|
* but do know what they have asked the HVAC system to do.
|
|
3317
3311
|
*
|
|
3318
|
-
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they
|
|
3319
|
-
*
|
|
3320
|
-
*
|
|
3312
|
+
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they may
|
|
3313
|
+
* choose to use values between 0-100 as a percentage of compressor modulation, or could use these values as
|
|
3314
|
+
* Enum states meaning heating with fan, heating without fan etc.
|
|
3321
3315
|
*
|
|
3322
3316
|
* NOTE An ESA shall always use the same value to represent the same operating state.
|
|
3323
3317
|
*
|
|
3324
3318
|
* By providing this information a smart EMS may be able to learn the observed power draw when the ESA is put
|
|
3325
3319
|
* into a specific state. It can potentially then use the ManufacturerESAState field in the Forecast attribute
|
|
3326
|
-
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to
|
|
3327
|
-
*
|
|
3320
|
+
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
3321
|
+
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
3328
3322
|
*
|
|
3329
3323
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.9
|
|
3330
3324
|
*/
|
|
@@ -3338,8 +3332,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3338
3332
|
*/
|
|
3339
3333
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3340
3334
|
/**
|
|
3341
|
-
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during
|
|
3342
|
-
*
|
|
3335
|
+
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during a
|
|
3336
|
+
* ramp up it may be 0W).
|
|
3343
3337
|
*
|
|
3344
3338
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
3345
3339
|
*
|
|
@@ -3373,8 +3367,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3373
3367
|
* the cost as a result of shifting its energy. This can allow a demand side response service to be informed of
|
|
3374
3368
|
* the relative cost to use energy at a different time.
|
|
3375
3369
|
*
|
|
3376
|
-
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be
|
|
3377
|
-
*
|
|
3370
|
+
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be shared
|
|
3371
|
+
* by the energy appliance. These could be based on GHG emissions, comfort value for the consumer etc.
|
|
3378
3372
|
*
|
|
3379
3373
|
* For example, comfort could be expressed in abstract units or in currency. A water heater that is heated
|
|
3380
3374
|
* earlier in the day is likely to lose some of its heat before it is needed, which could require a top-up
|
|
@@ -3421,8 +3415,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3421
3415
|
/**
|
|
3422
3416
|
* This field shall indicate the minimum power that the appliance can be requested to use.
|
|
3423
3417
|
*
|
|
3424
|
-
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets.
|
|
3425
|
-
*
|
|
3418
|
+
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets. If
|
|
3419
|
+
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
3426
3420
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
3427
3421
|
*
|
|
3428
3422
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.15
|
|
@@ -3456,8 +3450,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3456
3450
|
* For example, if the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows
|
|
3457
3451
|
* an ESA to specify the maximum time it could be switched on for. This may allow a battery or water heater to
|
|
3458
3452
|
* indicate the maximum duration that it can charge for before becoming full. In the case of a battery inverter
|
|
3459
|
-
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at
|
|
3460
|
-
*
|
|
3453
|
+
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
3454
|
+
* MaxPowerAdjustment power level).
|
|
3461
3455
|
*
|
|
3462
3456
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.18
|
|
3463
3457
|
*/
|
|
@@ -3479,19 +3473,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3479
3473
|
readonly component: {
|
|
3480
3474
|
readonly attributes: {
|
|
3481
3475
|
/**
|
|
3482
|
-
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the
|
|
3483
|
-
*
|
|
3484
|
-
*
|
|
3476
|
+
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the user
|
|
3477
|
+
* to control this OptOutState. An EMS may subscribe to the OptOutState to get notified about changes in
|
|
3478
|
+
* operational state.
|
|
3485
3479
|
*
|
|
3486
3480
|
* If the ESA is in the LocalOptOut or OptOut states, so it cannot be controlled by an EMS for local
|
|
3487
3481
|
* optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
3488
|
-
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an
|
|
3489
|
-
*
|
|
3482
|
+
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an EMS
|
|
3483
|
+
* for grid optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
3490
3484
|
* GridOptimization.
|
|
3491
3485
|
*
|
|
3492
|
-
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is
|
|
3493
|
-
*
|
|
3494
|
-
*
|
|
3486
|
+
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is due
|
|
3487
|
+
* to a previous StartTimeAdjustRequest, ModifyForecastRequest or RequestConstraintBasedForecast command
|
|
3488
|
+
* that would now not be permitted due to the new Opt-out state
|
|
3495
3489
|
*
|
|
3496
3490
|
* attribute ForecastUpdateReason field currently contains a reason which is now opted out), the ESA shall
|
|
3497
3491
|
* behave as if it had received a CancelRequest command.
|
|
@@ -3503,10 +3497,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3503
3497
|
* ResumeRequest command.
|
|
3504
3498
|
*
|
|
3505
3499
|
* If the user changes the Opt-Out state of the ESA which currently has the ESAStateEnum with value
|
|
3506
|
-
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to
|
|
3507
|
-
*
|
|
3508
|
-
*
|
|
3509
|
-
* command.
|
|
3500
|
+
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to the
|
|
3501
|
+
* new Opt-out state (i.e. the Forecast attribute ForecastUpdateReason field currently contains a reason
|
|
3502
|
+
* which is now opted out), the ESA shall behave as if it had received a CancelPowerAdjustRequest command.
|
|
3510
3503
|
*
|
|
3511
3504
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
3512
3505
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
@@ -3523,19 +3516,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3523
3516
|
readonly component: {
|
|
3524
3517
|
readonly attributes: {
|
|
3525
3518
|
/**
|
|
3526
|
-
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the
|
|
3527
|
-
*
|
|
3528
|
-
*
|
|
3519
|
+
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the user
|
|
3520
|
+
* to control this OptOutState. An EMS may subscribe to the OptOutState to get notified about changes in
|
|
3521
|
+
* operational state.
|
|
3529
3522
|
*
|
|
3530
3523
|
* If the ESA is in the LocalOptOut or OptOut states, so it cannot be controlled by an EMS for local
|
|
3531
3524
|
* optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
3532
|
-
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an
|
|
3533
|
-
*
|
|
3525
|
+
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an EMS
|
|
3526
|
+
* for grid optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
3534
3527
|
* GridOptimization.
|
|
3535
3528
|
*
|
|
3536
|
-
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is
|
|
3537
|
-
*
|
|
3538
|
-
*
|
|
3529
|
+
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is due
|
|
3530
|
+
* to a previous StartTimeAdjustRequest, ModifyForecastRequest or RequestConstraintBasedForecast command
|
|
3531
|
+
* that would now not be permitted due to the new Opt-out state
|
|
3539
3532
|
*
|
|
3540
3533
|
* attribute ForecastUpdateReason field currently contains a reason which is now opted out), the ESA shall
|
|
3541
3534
|
* behave as if it had received a CancelRequest command.
|
|
@@ -3547,10 +3540,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3547
3540
|
* ResumeRequest command.
|
|
3548
3541
|
*
|
|
3549
3542
|
* If the user changes the Opt-Out state of the ESA which currently has the ESAStateEnum with value
|
|
3550
|
-
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to
|
|
3551
|
-
*
|
|
3552
|
-
*
|
|
3553
|
-
* command.
|
|
3543
|
+
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to the
|
|
3544
|
+
* new Opt-out state (i.e. the Forecast attribute ForecastUpdateReason field currently contains a reason
|
|
3545
|
+
* which is now opted out), the ESA shall behave as if it had received a CancelPowerAdjustRequest command.
|
|
3554
3546
|
*
|
|
3555
3547
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
3556
3548
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
@@ -3567,19 +3559,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3567
3559
|
readonly component: {
|
|
3568
3560
|
readonly attributes: {
|
|
3569
3561
|
/**
|
|
3570
|
-
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the
|
|
3571
|
-
*
|
|
3572
|
-
*
|
|
3562
|
+
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the user
|
|
3563
|
+
* to control this OptOutState. An EMS may subscribe to the OptOutState to get notified about changes in
|
|
3564
|
+
* operational state.
|
|
3573
3565
|
*
|
|
3574
3566
|
* If the ESA is in the LocalOptOut or OptOut states, so it cannot be controlled by an EMS for local
|
|
3575
3567
|
* optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
3576
|
-
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an
|
|
3577
|
-
*
|
|
3568
|
+
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an EMS
|
|
3569
|
+
* for grid optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
3578
3570
|
* GridOptimization.
|
|
3579
3571
|
*
|
|
3580
|
-
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is
|
|
3581
|
-
*
|
|
3582
|
-
*
|
|
3572
|
+
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is due
|
|
3573
|
+
* to a previous StartTimeAdjustRequest, ModifyForecastRequest or RequestConstraintBasedForecast command
|
|
3574
|
+
* that would now not be permitted due to the new Opt-out state
|
|
3583
3575
|
*
|
|
3584
3576
|
* attribute ForecastUpdateReason field currently contains a reason which is now opted out), the ESA shall
|
|
3585
3577
|
* behave as if it had received a CancelRequest command.
|
|
@@ -3591,10 +3583,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3591
3583
|
* ResumeRequest command.
|
|
3592
3584
|
*
|
|
3593
3585
|
* If the user changes the Opt-Out state of the ESA which currently has the ESAStateEnum with value
|
|
3594
|
-
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to
|
|
3595
|
-
*
|
|
3596
|
-
*
|
|
3597
|
-
* command.
|
|
3586
|
+
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to the
|
|
3587
|
+
* new Opt-out state (i.e. the Forecast attribute ForecastUpdateReason field currently contains a reason
|
|
3588
|
+
* which is now opted out), the ESA shall behave as if it had received a CancelPowerAdjustRequest command.
|
|
3598
3589
|
*
|
|
3599
3590
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
3600
3591
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
@@ -3611,19 +3602,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3611
3602
|
readonly component: {
|
|
3612
3603
|
readonly attributes: {
|
|
3613
3604
|
/**
|
|
3614
|
-
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the
|
|
3615
|
-
*
|
|
3616
|
-
*
|
|
3605
|
+
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the user
|
|
3606
|
+
* to control this OptOutState. An EMS may subscribe to the OptOutState to get notified about changes in
|
|
3607
|
+
* operational state.
|
|
3617
3608
|
*
|
|
3618
3609
|
* If the ESA is in the LocalOptOut or OptOut states, so it cannot be controlled by an EMS for local
|
|
3619
3610
|
* optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
3620
|
-
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an
|
|
3621
|
-
*
|
|
3611
|
+
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an EMS
|
|
3612
|
+
* for grid optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
3622
3613
|
* GridOptimization.
|
|
3623
3614
|
*
|
|
3624
|
-
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is
|
|
3625
|
-
*
|
|
3626
|
-
*
|
|
3615
|
+
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is due
|
|
3616
|
+
* to a previous StartTimeAdjustRequest, ModifyForecastRequest or RequestConstraintBasedForecast command
|
|
3617
|
+
* that would now not be permitted due to the new Opt-out state
|
|
3627
3618
|
*
|
|
3628
3619
|
* attribute ForecastUpdateReason field currently contains a reason which is now opted out), the ESA shall
|
|
3629
3620
|
* behave as if it had received a CancelRequest command.
|
|
@@ -3635,10 +3626,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3635
3626
|
* ResumeRequest command.
|
|
3636
3627
|
*
|
|
3637
3628
|
* If the user changes the Opt-Out state of the ESA which currently has the ESAStateEnum with value
|
|
3638
|
-
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to
|
|
3639
|
-
*
|
|
3640
|
-
*
|
|
3641
|
-
* command.
|
|
3629
|
+
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to the
|
|
3630
|
+
* new Opt-out state (i.e. the Forecast attribute ForecastUpdateReason field currently contains a reason
|
|
3631
|
+
* which is now opted out), the ESA shall behave as if it had received a CancelPowerAdjustRequest command.
|
|
3642
3632
|
*
|
|
3643
3633
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
3644
3634
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
@@ -3655,19 +3645,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3655
3645
|
readonly component: {
|
|
3656
3646
|
readonly attributes: {
|
|
3657
3647
|
/**
|
|
3658
|
-
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the
|
|
3659
|
-
*
|
|
3660
|
-
*
|
|
3648
|
+
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the user
|
|
3649
|
+
* to control this OptOutState. An EMS may subscribe to the OptOutState to get notified about changes in
|
|
3650
|
+
* operational state.
|
|
3661
3651
|
*
|
|
3662
3652
|
* If the ESA is in the LocalOptOut or OptOut states, so it cannot be controlled by an EMS for local
|
|
3663
3653
|
* optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
3664
|
-
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an
|
|
3665
|
-
*
|
|
3654
|
+
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an EMS
|
|
3655
|
+
* for grid optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
3666
3656
|
* GridOptimization.
|
|
3667
3657
|
*
|
|
3668
|
-
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is
|
|
3669
|
-
*
|
|
3670
|
-
*
|
|
3658
|
+
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is due
|
|
3659
|
+
* to a previous StartTimeAdjustRequest, ModifyForecastRequest or RequestConstraintBasedForecast command
|
|
3660
|
+
* that would now not be permitted due to the new Opt-out state
|
|
3671
3661
|
*
|
|
3672
3662
|
* attribute ForecastUpdateReason field currently contains a reason which is now opted out), the ESA shall
|
|
3673
3663
|
* behave as if it had received a CancelRequest command.
|
|
@@ -3679,10 +3669,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3679
3669
|
* ResumeRequest command.
|
|
3680
3670
|
*
|
|
3681
3671
|
* If the user changes the Opt-Out state of the ESA which currently has the ESAStateEnum with value
|
|
3682
|
-
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to
|
|
3683
|
-
*
|
|
3684
|
-
*
|
|
3685
|
-
* command.
|
|
3672
|
+
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to the
|
|
3673
|
+
* new Opt-out state (i.e. the Forecast attribute ForecastUpdateReason field currently contains a reason
|
|
3674
|
+
* which is now opted out), the ESA shall behave as if it had received a CancelPowerAdjustRequest command.
|
|
3686
3675
|
*
|
|
3687
3676
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
3688
3677
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
@@ -3762,8 +3751,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3762
3751
|
*/
|
|
3763
3752
|
readonly startTimeAdjustRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3764
3753
|
/**
|
|
3765
|
-
* This field shall indicate the requested start time, in UTC, that the client would like the appliance to
|
|
3766
|
-
*
|
|
3754
|
+
* This field shall indicate the requested start time, in UTC, that the client would like the appliance to shift
|
|
3755
|
+
* its Forecast to. This value MUST be in the future.
|
|
3767
3756
|
*
|
|
3768
3757
|
* A client can estimate the entire Forecast sequence duration by computing the EndTime - StartTime fields from
|
|
3769
3758
|
* the Forecast attribute, and therefore avoid scheduling the start time too late.
|
|
@@ -3876,8 +3865,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3876
3865
|
*/
|
|
3877
3866
|
constraints: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3878
3867
|
/**
|
|
3879
|
-
* This field shall indicate the start time of the constraint period that the client wishes the ESA to compute
|
|
3880
|
-
*
|
|
3868
|
+
* This field shall indicate the start time of the constraint period that the client wishes the ESA to compute a
|
|
3869
|
+
* new Forecast.
|
|
3881
3870
|
*
|
|
3882
3871
|
* This value is in UTC and MUST be in the future.
|
|
3883
3872
|
*
|
|
@@ -3892,8 +3881,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3892
3881
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3893
3882
|
/**
|
|
3894
3883
|
* This field shall indicate the nominal power that client wishes the ESA to operate at during the constrained
|
|
3895
|
-
* period. It MUST be between the AbsMinPower and AbsMaxPower attributes as advertised by the ESA if it
|
|
3896
|
-
*
|
|
3884
|
+
* period. It MUST be between the AbsMinPower and AbsMaxPower attributes as advertised by the ESA if it supports
|
|
3885
|
+
* PFR.
|
|
3897
3886
|
*
|
|
3898
3887
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
3899
3888
|
*
|
|
@@ -3901,8 +3890,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3901
3890
|
*/
|
|
3902
3891
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3903
3892
|
/**
|
|
3904
|
-
* This field shall indicate the maximum energy that can be transferred to or from the ESA during the
|
|
3905
|
-
*
|
|
3893
|
+
* This field shall indicate the maximum energy that can be transferred to or from the ESA during the constraint
|
|
3894
|
+
* period.
|
|
3906
3895
|
*
|
|
3907
3896
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
3908
3897
|
*
|
|
@@ -3914,8 +3903,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3914
3903
|
* during the constraint period.
|
|
3915
3904
|
*
|
|
3916
3905
|
* This is expressed as a signed value between -100 to +100. A value of 0 would indicate no bias to using more
|
|
3917
|
-
* or less energy. A negative value indicates a request to use less energy. A positive value indicates a
|
|
3918
|
-
*
|
|
3906
|
+
* or less energy. A negative value indicates a request to use less energy. A positive value indicates a request
|
|
3907
|
+
* to use more energy.
|
|
3919
3908
|
*
|
|
3920
3909
|
* Note that the mapping between values and operation is manufacturer specific.
|
|
3921
3910
|
*
|
|
@@ -4011,8 +4000,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4011
4000
|
* PowerAdjustment
|
|
4012
4001
|
*
|
|
4013
4002
|
* For Energy Smart Appliances (ESA) the definition of being 'smart' mandates that they can report their
|
|
4014
|
-
* current power adjustment capability and have an EMS request a temporary adjustment. This may typically
|
|
4015
|
-
*
|
|
4003
|
+
* current power adjustment capability and have an EMS request a temporary adjustment. This may typically be
|
|
4004
|
+
* to curtail power requirements during peak periods, but can also be used to turn on an ESA if there is
|
|
4016
4005
|
* excess renewable or local generation (Solar PV).
|
|
4017
4006
|
*
|
|
4018
4007
|
* For example, a home may have solar PV which often produces more power than the home requires, resulting
|
|
@@ -4046,8 +4035,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4046
4035
|
* In some circumstances the ESA may allow the stage to be delayed or paused (subject to safety and
|
|
4047
4036
|
* manufacturer’s discretion and user preferences).
|
|
4048
4037
|
*
|
|
4049
|
-
* Typically, appliances with a heating element cannot have their power consumption adjusted and can only
|
|
4050
|
-
*
|
|
4038
|
+
* Typically, appliances with a heating element cannot have their power consumption adjusted and can only be
|
|
4039
|
+
* paused or delayed.
|
|
4051
4040
|
*
|
|
4052
4041
|
* Some ESAs may not be flexible other than a delayed cycle start (for example, once the washing cycle has
|
|
4053
4042
|
* been started then they run continuously until the cycle completes).
|
|
@@ -4103,9 +4092,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4103
4092
|
* However, the EMS is aware that a grid event has occurred, making it cheaper to run the cycle at a later
|
|
4104
4093
|
* time, but the washing machine is not aware of this.
|
|
4105
4094
|
*
|
|
4106
|
-
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the
|
|
4107
|
-
*
|
|
4108
|
-
*
|
|
4095
|
+
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the washing
|
|
4096
|
+
* machine has a power profile suggesting it will start the wash cycle at 9pm, but the EMS now knows that
|
|
4097
|
+
* the grid event means it will be cheaper to delay the start until 11pm.
|
|
4109
4098
|
*
|
|
4110
4099
|
* The EMS can then optimize the cost by asking the washing machine to delay starting the wash cycle until
|
|
4111
4100
|
* 11pm.
|
|
@@ -4128,9 +4117,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4128
4117
|
* However, the EMS becomes aware from the smart meter that the total home load on the grid is close to
|
|
4129
4118
|
* exceeding its allowed total grid load.
|
|
4130
4119
|
*
|
|
4131
|
-
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the
|
|
4132
|
-
*
|
|
4133
|
-
*
|
|
4120
|
+
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the washing
|
|
4121
|
+
* machine has a power profile suggesting its current step in the wash cycle is using power to heat the
|
|
4122
|
+
* water, but that this step can be paused.
|
|
4134
4123
|
*
|
|
4135
4124
|
* The EMS can then reduce the grid load by asking the washing machine to pause the wash cycle for a short
|
|
4136
4125
|
* duration.
|
|
@@ -4148,10 +4137,10 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4148
4137
|
* duration and/or power level limits of the steps of the power profile that the ESA has previously
|
|
4149
4138
|
* suggested it would use.
|
|
4150
4139
|
*
|
|
4151
|
-
* Heat pump and Solar PV example: A heat pump may have the ability to heat hot water as well as heating
|
|
4152
|
-
*
|
|
4153
|
-
*
|
|
4154
|
-
*
|
|
4140
|
+
* Heat pump and Solar PV example: A heat pump may have the ability to heat hot water as well as heating the
|
|
4141
|
+
* home. The heat pump scheduling system may have determined that the home will be unoccupied during the
|
|
4142
|
+
* day, or that the indoor temperature is above the set-point and so it knows that it will not need to heat
|
|
4143
|
+
* the home.
|
|
4155
4144
|
*
|
|
4156
4145
|
* However, the hot water tank is likely to need to be reheated before the homeowner comes home in the
|
|
4157
4146
|
* evening. The heat pump is not aware that the property also has a solar PV inverter which is also an ESA
|
|
@@ -4181,11 +4170,11 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4181
4170
|
*
|
|
4182
4171
|
* and may cause the ESA to modify the intended power profile has previously suggested it would use.
|
|
4183
4172
|
*
|
|
4184
|
-
* EVSE example: An EVSE scheduling system may have determined that the vehicle would be charged starting
|
|
4185
|
-
*
|
|
4173
|
+
* EVSE example: An EVSE scheduling system may have determined that the vehicle would be charged starting at
|
|
4174
|
+
* a moderate rate at 1am, so that it has enough charge by the time it is needed later that morning.
|
|
4186
4175
|
*
|
|
4187
|
-
* However, the DSR service provider has informed the EMS that due to high forecast winds it is now
|
|
4188
|
-
*
|
|
4176
|
+
* However, the DSR service provider has informed the EMS that due to high forecast winds it is now forecast
|
|
4177
|
+
* that there will be very cheap energy available from wind generation between 2am and 3am.
|
|
4189
4178
|
*
|
|
4190
4179
|
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the EVSE
|
|
4191
4180
|
* has a power profile suggesting it plans to start charging the vehicle at 1am.
|
|
@@ -4220,16 +4209,16 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4220
4209
|
*/
|
|
4221
4210
|
readonly esaType: FixedAttribute<EsaType, any>;
|
|
4222
4211
|
/**
|
|
4223
|
-
* Indicates whether the ESA is classed as a generator or load. This allows an EMS to understand whether
|
|
4224
|
-
*
|
|
4212
|
+
* Indicates whether the ESA is classed as a generator or load. This allows an EMS to understand whether the
|
|
4213
|
+
* power values reported by the ESA need to have their sign inverted when dealing with forecasts and
|
|
4225
4214
|
* adjustments.
|
|
4226
4215
|
*
|
|
4227
4216
|
* For example, a solar PV inverter (being a generator) may produce negative values to indicate generation
|
|
4228
4217
|
* (since power is flowing out of the node into the home), however a display showing the power to the
|
|
4229
4218
|
* consumers may need to present a positive solar production value to the consumer.
|
|
4230
4219
|
*
|
|
4231
|
-
* For example, a home battery storage system (BESS) which needs to charge the battery and then discharge
|
|
4232
|
-
*
|
|
4220
|
+
* For example, a home battery storage system (BESS) which needs to charge the battery and then discharge to
|
|
4221
|
+
* the home loads, would be classed as a generator. These types of devices shall have this field set to
|
|
4233
4222
|
* true. When generating its forecast or advertising its PowerAdjustmentCapability, the power values shall
|
|
4234
4223
|
* be negative to indicate discharging to the loads in the home, and positive to indicate when it is
|
|
4235
4224
|
* charging its battery.
|
|
@@ -4249,8 +4238,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4249
4238
|
* operational state.
|
|
4250
4239
|
*
|
|
4251
4240
|
* The ESA may have a local user interface to allow a service technician to put the ESA into Offline mode,
|
|
4252
|
-
* for example to avoid the EMS accidentally starting or stopping the appliance when it is being serviced
|
|
4253
|
-
*
|
|
4241
|
+
* for example to avoid the EMS accidentally starting or stopping the appliance when it is being serviced or
|
|
4242
|
+
* tested.
|
|
4254
4243
|
*
|
|
4255
4244
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.8.3
|
|
4256
4245
|
*/
|
|
@@ -4314,8 +4303,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4314
4303
|
* This field shall indicate how the ESA can be adjusted at the current time.
|
|
4315
4304
|
*
|
|
4316
4305
|
* For example, a battery storage inverter may need to regulate its internal temperature, or the charging rate
|
|
4317
|
-
* of the battery may be limited due to cold temperatures, or a change in the state of charge of the battery
|
|
4318
|
-
*
|
|
4306
|
+
* of the battery may be limited due to cold temperatures, or a change in the state of charge of the battery may
|
|
4307
|
+
* mean that the maximum charging or discharging rate is limited.
|
|
4319
4308
|
*
|
|
4320
4309
|
* An empty list shall indicate that no power adjustment is currently possible.
|
|
4321
4310
|
*
|
|
@@ -4351,9 +4340,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4351
4340
|
* For example, if a battery storage inverter can discharge between 0 to 3000W towards a load, then power is
|
|
4352
4341
|
* flowing out of the node and is therefore negative. Its MinPower would be -3000W and its MaxPower would be 0W.
|
|
4353
4342
|
*
|
|
4354
|
-
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W.
|
|
4355
|
-
*
|
|
4356
|
-
* 2000W.
|
|
4343
|
+
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W. Here
|
|
4344
|
+
* power is flowing into the node when charging. As such the MinPower becomes 0W and MaxPower becomes 2000W.
|
|
4357
4345
|
*
|
|
4358
4346
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.10.2
|
|
4359
4347
|
*/
|
|
@@ -4468,8 +4456,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4468
4456
|
* A null value indicates that there is no forecast currently available (for example, a program has not yet
|
|
4469
4457
|
* been selected by the user).
|
|
4470
4458
|
*
|
|
4471
|
-
* A server may reset this value attribute to null on a reboot, and it does not need to persist any
|
|
4472
|
-
*
|
|
4459
|
+
* A server may reset this value attribute to null on a reboot, and it does not need to persist any previous
|
|
4460
|
+
* forecasts.
|
|
4473
4461
|
*
|
|
4474
4462
|
* Changes to this attribute shall only be marked as reportable in the following cases:
|
|
4475
4463
|
*
|
|
@@ -4518,8 +4506,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4518
4506
|
*/
|
|
4519
4507
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4520
4508
|
/**
|
|
4521
|
-
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A
|
|
4522
|
-
*
|
|
4509
|
+
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A null
|
|
4510
|
+
* value indicates that it can be started immediately.
|
|
4523
4511
|
*
|
|
4524
4512
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.13.5
|
|
4525
4513
|
*/
|
|
@@ -4568,9 +4556,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4568
4556
|
*/
|
|
4569
4557
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4570
4558
|
/**
|
|
4571
|
-
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot
|
|
4572
|
-
*
|
|
4573
|
-
*
|
|
4559
|
+
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot has
|
|
4560
|
+
* not yet been started, then it shall be 0. Once the slot has been completed, then this reflects how much time
|
|
4561
|
+
* was spent in this slot.
|
|
4574
4562
|
*
|
|
4575
4563
|
* When subscribed to, a change in this field value shall NOT cause the Forecast attribute to be updated since
|
|
4576
4564
|
* this value may change every 1 second.
|
|
@@ -4625,16 +4613,16 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4625
4613
|
* Some appliances, such as smart thermostats, may not know how much power is being drawn by the HVAC system,
|
|
4626
4614
|
* but do know what they have asked the HVAC system to do.
|
|
4627
4615
|
*
|
|
4628
|
-
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they
|
|
4629
|
-
*
|
|
4630
|
-
*
|
|
4616
|
+
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they may
|
|
4617
|
+
* choose to use values between 0-100 as a percentage of compressor modulation, or could use these values as
|
|
4618
|
+
* Enum states meaning heating with fan, heating without fan etc.
|
|
4631
4619
|
*
|
|
4632
4620
|
* NOTE An ESA shall always use the same value to represent the same operating state.
|
|
4633
4621
|
*
|
|
4634
4622
|
* By providing this information a smart EMS may be able to learn the observed power draw when the ESA is put
|
|
4635
4623
|
* into a specific state. It can potentially then use the ManufacturerESAState field in the Forecast attribute
|
|
4636
|
-
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to
|
|
4637
|
-
*
|
|
4624
|
+
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
4625
|
+
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
4638
4626
|
*
|
|
4639
4627
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.9
|
|
4640
4628
|
*/
|
|
@@ -4648,8 +4636,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4648
4636
|
*/
|
|
4649
4637
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
4650
4638
|
/**
|
|
4651
|
-
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during
|
|
4652
|
-
*
|
|
4639
|
+
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during a
|
|
4640
|
+
* ramp up it may be 0W).
|
|
4653
4641
|
*
|
|
4654
4642
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
4655
4643
|
*
|
|
@@ -4683,8 +4671,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4683
4671
|
* the cost as a result of shifting its energy. This can allow a demand side response service to be informed of
|
|
4684
4672
|
* the relative cost to use energy at a different time.
|
|
4685
4673
|
*
|
|
4686
|
-
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be
|
|
4687
|
-
*
|
|
4674
|
+
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be shared
|
|
4675
|
+
* by the energy appliance. These could be based on GHG emissions, comfort value for the consumer etc.
|
|
4688
4676
|
*
|
|
4689
4677
|
* For example, comfort could be expressed in abstract units or in currency. A water heater that is heated
|
|
4690
4678
|
* earlier in the day is likely to lose some of its heat before it is needed, which could require a top-up
|
|
@@ -4731,8 +4719,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4731
4719
|
/**
|
|
4732
4720
|
* This field shall indicate the minimum power that the appliance can be requested to use.
|
|
4733
4721
|
*
|
|
4734
|
-
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets.
|
|
4735
|
-
*
|
|
4722
|
+
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets. If
|
|
4723
|
+
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
4736
4724
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
4737
4725
|
*
|
|
4738
4726
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.15
|
|
@@ -4766,8 +4754,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4766
4754
|
* For example, if the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows
|
|
4767
4755
|
* an ESA to specify the maximum time it could be switched on for. This may allow a battery or water heater to
|
|
4768
4756
|
* indicate the maximum duration that it can charge for before becoming full. In the case of a battery inverter
|
|
4769
|
-
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at
|
|
4770
|
-
*
|
|
4757
|
+
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
4758
|
+
* MaxPowerAdjustment power level).
|
|
4771
4759
|
*
|
|
4772
4760
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.18
|
|
4773
4761
|
*/
|
|
@@ -4795,8 +4783,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4795
4783
|
* A null value indicates that there is no forecast currently available (for example, a program has not yet
|
|
4796
4784
|
* been selected by the user).
|
|
4797
4785
|
*
|
|
4798
|
-
* A server may reset this value attribute to null on a reboot, and it does not need to persist any
|
|
4799
|
-
*
|
|
4786
|
+
* A server may reset this value attribute to null on a reboot, and it does not need to persist any previous
|
|
4787
|
+
* forecasts.
|
|
4800
4788
|
*
|
|
4801
4789
|
* Changes to this attribute shall only be marked as reportable in the following cases:
|
|
4802
4790
|
*
|
|
@@ -4845,8 +4833,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4845
4833
|
*/
|
|
4846
4834
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4847
4835
|
/**
|
|
4848
|
-
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A
|
|
4849
|
-
*
|
|
4836
|
+
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A null
|
|
4837
|
+
* value indicates that it can be started immediately.
|
|
4850
4838
|
*
|
|
4851
4839
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.13.5
|
|
4852
4840
|
*/
|
|
@@ -4895,9 +4883,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4895
4883
|
*/
|
|
4896
4884
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4897
4885
|
/**
|
|
4898
|
-
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot
|
|
4899
|
-
*
|
|
4900
|
-
*
|
|
4886
|
+
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot has
|
|
4887
|
+
* not yet been started, then it shall be 0. Once the slot has been completed, then this reflects how much time
|
|
4888
|
+
* was spent in this slot.
|
|
4901
4889
|
*
|
|
4902
4890
|
* When subscribed to, a change in this field value shall NOT cause the Forecast attribute to be updated since
|
|
4903
4891
|
* this value may change every 1 second.
|
|
@@ -4952,16 +4940,16 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4952
4940
|
* Some appliances, such as smart thermostats, may not know how much power is being drawn by the HVAC system,
|
|
4953
4941
|
* but do know what they have asked the HVAC system to do.
|
|
4954
4942
|
*
|
|
4955
|
-
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they
|
|
4956
|
-
*
|
|
4957
|
-
*
|
|
4943
|
+
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they may
|
|
4944
|
+
* choose to use values between 0-100 as a percentage of compressor modulation, or could use these values as
|
|
4945
|
+
* Enum states meaning heating with fan, heating without fan etc.
|
|
4958
4946
|
*
|
|
4959
4947
|
* NOTE An ESA shall always use the same value to represent the same operating state.
|
|
4960
4948
|
*
|
|
4961
4949
|
* By providing this information a smart EMS may be able to learn the observed power draw when the ESA is put
|
|
4962
4950
|
* into a specific state. It can potentially then use the ManufacturerESAState field in the Forecast attribute
|
|
4963
|
-
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to
|
|
4964
|
-
*
|
|
4951
|
+
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
4952
|
+
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
4965
4953
|
*
|
|
4966
4954
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.9
|
|
4967
4955
|
*/
|
|
@@ -4975,8 +4963,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4975
4963
|
*/
|
|
4976
4964
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
4977
4965
|
/**
|
|
4978
|
-
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during
|
|
4979
|
-
*
|
|
4966
|
+
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during a
|
|
4967
|
+
* ramp up it may be 0W).
|
|
4980
4968
|
*
|
|
4981
4969
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
4982
4970
|
*
|
|
@@ -5010,8 +4998,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5010
4998
|
* the cost as a result of shifting its energy. This can allow a demand side response service to be informed of
|
|
5011
4999
|
* the relative cost to use energy at a different time.
|
|
5012
5000
|
*
|
|
5013
|
-
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be
|
|
5014
|
-
*
|
|
5001
|
+
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be shared
|
|
5002
|
+
* by the energy appliance. These could be based on GHG emissions, comfort value for the consumer etc.
|
|
5015
5003
|
*
|
|
5016
5004
|
* For example, comfort could be expressed in abstract units or in currency. A water heater that is heated
|
|
5017
5005
|
* earlier in the day is likely to lose some of its heat before it is needed, which could require a top-up
|
|
@@ -5058,8 +5046,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5058
5046
|
/**
|
|
5059
5047
|
* This field shall indicate the minimum power that the appliance can be requested to use.
|
|
5060
5048
|
*
|
|
5061
|
-
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets.
|
|
5062
|
-
*
|
|
5049
|
+
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets. If
|
|
5050
|
+
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
5063
5051
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
5064
5052
|
*
|
|
5065
5053
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.15
|
|
@@ -5093,8 +5081,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5093
5081
|
* For example, if the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows
|
|
5094
5082
|
* an ESA to specify the maximum time it could be switched on for. This may allow a battery or water heater to
|
|
5095
5083
|
* indicate the maximum duration that it can charge for before becoming full. In the case of a battery inverter
|
|
5096
|
-
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at
|
|
5097
|
-
*
|
|
5084
|
+
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
5085
|
+
* MaxPowerAdjustment power level).
|
|
5098
5086
|
*
|
|
5099
5087
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.18
|
|
5100
5088
|
*/
|
|
@@ -5116,19 +5104,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5116
5104
|
readonly component: {
|
|
5117
5105
|
readonly attributes: {
|
|
5118
5106
|
/**
|
|
5119
|
-
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the
|
|
5120
|
-
*
|
|
5121
|
-
*
|
|
5107
|
+
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the user
|
|
5108
|
+
* to control this OptOutState. An EMS may subscribe to the OptOutState to get notified about changes in
|
|
5109
|
+
* operational state.
|
|
5122
5110
|
*
|
|
5123
5111
|
* If the ESA is in the LocalOptOut or OptOut states, so it cannot be controlled by an EMS for local
|
|
5124
5112
|
* optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
5125
|
-
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an
|
|
5126
|
-
*
|
|
5113
|
+
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an EMS
|
|
5114
|
+
* for grid optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
5127
5115
|
* GridOptimization.
|
|
5128
5116
|
*
|
|
5129
|
-
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is
|
|
5130
|
-
*
|
|
5131
|
-
*
|
|
5117
|
+
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is due
|
|
5118
|
+
* to a previous StartTimeAdjustRequest, ModifyForecastRequest or RequestConstraintBasedForecast command
|
|
5119
|
+
* that would now not be permitted due to the new Opt-out state
|
|
5132
5120
|
*
|
|
5133
5121
|
* attribute ForecastUpdateReason field currently contains a reason which is now opted out), the ESA shall
|
|
5134
5122
|
* behave as if it had received a CancelRequest command.
|
|
@@ -5140,10 +5128,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5140
5128
|
* ResumeRequest command.
|
|
5141
5129
|
*
|
|
5142
5130
|
* If the user changes the Opt-Out state of the ESA which currently has the ESAStateEnum with value
|
|
5143
|
-
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to
|
|
5144
|
-
*
|
|
5145
|
-
*
|
|
5146
|
-
* command.
|
|
5131
|
+
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to the
|
|
5132
|
+
* new Opt-out state (i.e. the Forecast attribute ForecastUpdateReason field currently contains a reason
|
|
5133
|
+
* which is now opted out), the ESA shall behave as if it had received a CancelPowerAdjustRequest command.
|
|
5147
5134
|
*
|
|
5148
5135
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
5149
5136
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
@@ -5160,19 +5147,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5160
5147
|
readonly component: {
|
|
5161
5148
|
readonly attributes: {
|
|
5162
5149
|
/**
|
|
5163
|
-
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the
|
|
5164
|
-
*
|
|
5165
|
-
*
|
|
5150
|
+
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the user
|
|
5151
|
+
* to control this OptOutState. An EMS may subscribe to the OptOutState to get notified about changes in
|
|
5152
|
+
* operational state.
|
|
5166
5153
|
*
|
|
5167
5154
|
* If the ESA is in the LocalOptOut or OptOut states, so it cannot be controlled by an EMS for local
|
|
5168
5155
|
* optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
5169
|
-
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an
|
|
5170
|
-
*
|
|
5156
|
+
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an EMS
|
|
5157
|
+
* for grid optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
5171
5158
|
* GridOptimization.
|
|
5172
5159
|
*
|
|
5173
|
-
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is
|
|
5174
|
-
*
|
|
5175
|
-
*
|
|
5160
|
+
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is due
|
|
5161
|
+
* to a previous StartTimeAdjustRequest, ModifyForecastRequest or RequestConstraintBasedForecast command
|
|
5162
|
+
* that would now not be permitted due to the new Opt-out state
|
|
5176
5163
|
*
|
|
5177
5164
|
* attribute ForecastUpdateReason field currently contains a reason which is now opted out), the ESA shall
|
|
5178
5165
|
* behave as if it had received a CancelRequest command.
|
|
@@ -5184,10 +5171,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5184
5171
|
* ResumeRequest command.
|
|
5185
5172
|
*
|
|
5186
5173
|
* If the user changes the Opt-Out state of the ESA which currently has the ESAStateEnum with value
|
|
5187
|
-
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to
|
|
5188
|
-
*
|
|
5189
|
-
*
|
|
5190
|
-
* command.
|
|
5174
|
+
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to the
|
|
5175
|
+
* new Opt-out state (i.e. the Forecast attribute ForecastUpdateReason field currently contains a reason
|
|
5176
|
+
* which is now opted out), the ESA shall behave as if it had received a CancelPowerAdjustRequest command.
|
|
5191
5177
|
*
|
|
5192
5178
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
5193
5179
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
@@ -5204,19 +5190,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5204
5190
|
readonly component: {
|
|
5205
5191
|
readonly attributes: {
|
|
5206
5192
|
/**
|
|
5207
|
-
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the
|
|
5208
|
-
*
|
|
5209
|
-
*
|
|
5193
|
+
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the user
|
|
5194
|
+
* to control this OptOutState. An EMS may subscribe to the OptOutState to get notified about changes in
|
|
5195
|
+
* operational state.
|
|
5210
5196
|
*
|
|
5211
5197
|
* If the ESA is in the LocalOptOut or OptOut states, so it cannot be controlled by an EMS for local
|
|
5212
5198
|
* optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
5213
|
-
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an
|
|
5214
|
-
*
|
|
5199
|
+
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an EMS
|
|
5200
|
+
* for grid optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
5215
5201
|
* GridOptimization.
|
|
5216
5202
|
*
|
|
5217
|
-
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is
|
|
5218
|
-
*
|
|
5219
|
-
*
|
|
5203
|
+
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is due
|
|
5204
|
+
* to a previous StartTimeAdjustRequest, ModifyForecastRequest or RequestConstraintBasedForecast command
|
|
5205
|
+
* that would now not be permitted due to the new Opt-out state
|
|
5220
5206
|
*
|
|
5221
5207
|
* attribute ForecastUpdateReason field currently contains a reason which is now opted out), the ESA shall
|
|
5222
5208
|
* behave as if it had received a CancelRequest command.
|
|
@@ -5228,10 +5214,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5228
5214
|
* ResumeRequest command.
|
|
5229
5215
|
*
|
|
5230
5216
|
* If the user changes the Opt-Out state of the ESA which currently has the ESAStateEnum with value
|
|
5231
|
-
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to
|
|
5232
|
-
*
|
|
5233
|
-
*
|
|
5234
|
-
* command.
|
|
5217
|
+
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to the
|
|
5218
|
+
* new Opt-out state (i.e. the Forecast attribute ForecastUpdateReason field currently contains a reason
|
|
5219
|
+
* which is now opted out), the ESA shall behave as if it had received a CancelPowerAdjustRequest command.
|
|
5235
5220
|
*
|
|
5236
5221
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
5237
5222
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
@@ -5248,19 +5233,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5248
5233
|
readonly component: {
|
|
5249
5234
|
readonly attributes: {
|
|
5250
5235
|
/**
|
|
5251
|
-
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the
|
|
5252
|
-
*
|
|
5253
|
-
*
|
|
5236
|
+
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the user
|
|
5237
|
+
* to control this OptOutState. An EMS may subscribe to the OptOutState to get notified about changes in
|
|
5238
|
+
* operational state.
|
|
5254
5239
|
*
|
|
5255
5240
|
* If the ESA is in the LocalOptOut or OptOut states, so it cannot be controlled by an EMS for local
|
|
5256
5241
|
* optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
5257
|
-
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an
|
|
5258
|
-
*
|
|
5242
|
+
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an EMS
|
|
5243
|
+
* for grid optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
5259
5244
|
* GridOptimization.
|
|
5260
5245
|
*
|
|
5261
|
-
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is
|
|
5262
|
-
*
|
|
5263
|
-
*
|
|
5246
|
+
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is due
|
|
5247
|
+
* to a previous StartTimeAdjustRequest, ModifyForecastRequest or RequestConstraintBasedForecast command
|
|
5248
|
+
* that would now not be permitted due to the new Opt-out state
|
|
5264
5249
|
*
|
|
5265
5250
|
* attribute ForecastUpdateReason field currently contains a reason which is now opted out), the ESA shall
|
|
5266
5251
|
* behave as if it had received a CancelRequest command.
|
|
@@ -5272,10 +5257,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5272
5257
|
* ResumeRequest command.
|
|
5273
5258
|
*
|
|
5274
5259
|
* If the user changes the Opt-Out state of the ESA which currently has the ESAStateEnum with value
|
|
5275
|
-
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to
|
|
5276
|
-
*
|
|
5277
|
-
*
|
|
5278
|
-
* command.
|
|
5260
|
+
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to the
|
|
5261
|
+
* new Opt-out state (i.e. the Forecast attribute ForecastUpdateReason field currently contains a reason
|
|
5262
|
+
* which is now opted out), the ESA shall behave as if it had received a CancelPowerAdjustRequest command.
|
|
5279
5263
|
*
|
|
5280
5264
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
5281
5265
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
@@ -5292,19 +5276,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5292
5276
|
readonly component: {
|
|
5293
5277
|
readonly attributes: {
|
|
5294
5278
|
/**
|
|
5295
|
-
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the
|
|
5296
|
-
*
|
|
5297
|
-
*
|
|
5279
|
+
* Indicates the current Opt-Out state of the ESA. The ESA may have a local user interface to allow the user
|
|
5280
|
+
* to control this OptOutState. An EMS may subscribe to the OptOutState to get notified about changes in
|
|
5281
|
+
* operational state.
|
|
5298
5282
|
*
|
|
5299
5283
|
* If the ESA is in the LocalOptOut or OptOut states, so it cannot be controlled by an EMS for local
|
|
5300
5284
|
* optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
5301
|
-
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an
|
|
5302
|
-
*
|
|
5285
|
+
* LocalOptimization. If the ESA is in the GridOptOut or OptOut states, so it cannot be controlled by an EMS
|
|
5286
|
+
* for grid optimization reasons, it shall reject any commands which have the AdjustmentCauseEnum value
|
|
5303
5287
|
* GridOptimization.
|
|
5304
5288
|
*
|
|
5305
|
-
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is
|
|
5306
|
-
*
|
|
5307
|
-
*
|
|
5289
|
+
* If the user changes the Opt-Out state of the ESA which is currently operating with a Forecast that is due
|
|
5290
|
+
* to a previous StartTimeAdjustRequest, ModifyForecastRequest or RequestConstraintBasedForecast command
|
|
5291
|
+
* that would now not be permitted due to the new Opt-out state
|
|
5308
5292
|
*
|
|
5309
5293
|
* attribute ForecastUpdateReason field currently contains a reason which is now opted out), the ESA shall
|
|
5310
5294
|
* behave as if it had received a CancelRequest command.
|
|
@@ -5316,10 +5300,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5316
5300
|
* ResumeRequest command.
|
|
5317
5301
|
*
|
|
5318
5302
|
* If the user changes the Opt-Out state of the ESA which currently has the ESAStateEnum with value
|
|
5319
|
-
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to
|
|
5320
|
-
*
|
|
5321
|
-
*
|
|
5322
|
-
* command.
|
|
5303
|
+
* PowerAdjustActive due to a previous PowerAdjustRequest command that would now not be permitted due to the
|
|
5304
|
+
* new Opt-out state (i.e. the Forecast attribute ForecastUpdateReason field currently contains a reason
|
|
5305
|
+
* which is now opted out), the ESA shall behave as if it had received a CancelPowerAdjustRequest command.
|
|
5323
5306
|
*
|
|
5324
5307
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
5325
5308
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
@@ -5399,8 +5382,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5399
5382
|
*/
|
|
5400
5383
|
readonly startTimeAdjustRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
5401
5384
|
/**
|
|
5402
|
-
* This field shall indicate the requested start time, in UTC, that the client would like the appliance to
|
|
5403
|
-
*
|
|
5385
|
+
* This field shall indicate the requested start time, in UTC, that the client would like the appliance to shift
|
|
5386
|
+
* its Forecast to. This value MUST be in the future.
|
|
5404
5387
|
*
|
|
5405
5388
|
* A client can estimate the entire Forecast sequence duration by computing the EndTime - StartTime fields from
|
|
5406
5389
|
* the Forecast attribute, and therefore avoid scheduling the start time too late.
|
|
@@ -5513,8 +5496,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5513
5496
|
*/
|
|
5514
5497
|
constraints: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
5515
5498
|
/**
|
|
5516
|
-
* This field shall indicate the start time of the constraint period that the client wishes the ESA to compute
|
|
5517
|
-
*
|
|
5499
|
+
* This field shall indicate the start time of the constraint period that the client wishes the ESA to compute a
|
|
5500
|
+
* new Forecast.
|
|
5518
5501
|
*
|
|
5519
5502
|
* This value is in UTC and MUST be in the future.
|
|
5520
5503
|
*
|
|
@@ -5529,8 +5512,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5529
5512
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5530
5513
|
/**
|
|
5531
5514
|
* This field shall indicate the nominal power that client wishes the ESA to operate at during the constrained
|
|
5532
|
-
* period. It MUST be between the AbsMinPower and AbsMaxPower attributes as advertised by the ESA if it
|
|
5533
|
-
*
|
|
5515
|
+
* period. It MUST be between the AbsMinPower and AbsMaxPower attributes as advertised by the ESA if it supports
|
|
5516
|
+
* PFR.
|
|
5534
5517
|
*
|
|
5535
5518
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
5536
5519
|
*
|
|
@@ -5538,8 +5521,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5538
5521
|
*/
|
|
5539
5522
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
5540
5523
|
/**
|
|
5541
|
-
* This field shall indicate the maximum energy that can be transferred to or from the ESA during the
|
|
5542
|
-
*
|
|
5524
|
+
* This field shall indicate the maximum energy that can be transferred to or from the ESA during the constraint
|
|
5525
|
+
* period.
|
|
5543
5526
|
*
|
|
5544
5527
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
5545
5528
|
*
|
|
@@ -5551,8 +5534,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5551
5534
|
* during the constraint period.
|
|
5552
5535
|
*
|
|
5553
5536
|
* This is expressed as a signed value between -100 to +100. A value of 0 would indicate no bias to using more
|
|
5554
|
-
* or less energy. A negative value indicates a request to use less energy. A positive value indicates a
|
|
5555
|
-
*
|
|
5537
|
+
* or less energy. A negative value indicates a request to use less energy. A positive value indicates a request
|
|
5538
|
+
* to use more energy.
|
|
5556
5539
|
*
|
|
5557
5540
|
* Note that the mapping between values and operation is manufacturer specific.
|
|
5558
5541
|
*
|
|
@@ -5704,8 +5687,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5704
5687
|
* PowerAdjustment
|
|
5705
5688
|
*
|
|
5706
5689
|
* For Energy Smart Appliances (ESA) the definition of being 'smart' mandates that they can report their
|
|
5707
|
-
* current power adjustment capability and have an EMS request a temporary adjustment. This may typically
|
|
5708
|
-
*
|
|
5690
|
+
* current power adjustment capability and have an EMS request a temporary adjustment. This may typically be
|
|
5691
|
+
* to curtail power requirements during peak periods, but can also be used to turn on an ESA if there is
|
|
5709
5692
|
* excess renewable or local generation (Solar PV).
|
|
5710
5693
|
*
|
|
5711
5694
|
* For example, a home may have solar PV which often produces more power than the home requires, resulting
|
|
@@ -5739,8 +5722,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5739
5722
|
* In some circumstances the ESA may allow the stage to be delayed or paused (subject to safety and
|
|
5740
5723
|
* manufacturer’s discretion and user preferences).
|
|
5741
5724
|
*
|
|
5742
|
-
* Typically, appliances with a heating element cannot have their power consumption adjusted and can only
|
|
5743
|
-
*
|
|
5725
|
+
* Typically, appliances with a heating element cannot have their power consumption adjusted and can only be
|
|
5726
|
+
* paused or delayed.
|
|
5744
5727
|
*
|
|
5745
5728
|
* Some ESAs may not be flexible other than a delayed cycle start (for example, once the washing cycle has
|
|
5746
5729
|
* been started then they run continuously until the cycle completes).
|
|
@@ -5796,9 +5779,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5796
5779
|
* However, the EMS is aware that a grid event has occurred, making it cheaper to run the cycle at a later
|
|
5797
5780
|
* time, but the washing machine is not aware of this.
|
|
5798
5781
|
*
|
|
5799
|
-
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the
|
|
5800
|
-
*
|
|
5801
|
-
*
|
|
5782
|
+
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the washing
|
|
5783
|
+
* machine has a power profile suggesting it will start the wash cycle at 9pm, but the EMS now knows that
|
|
5784
|
+
* the grid event means it will be cheaper to delay the start until 11pm.
|
|
5802
5785
|
*
|
|
5803
5786
|
* The EMS can then optimize the cost by asking the washing machine to delay starting the wash cycle until
|
|
5804
5787
|
* 11pm.
|
|
@@ -5821,9 +5804,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5821
5804
|
* However, the EMS becomes aware from the smart meter that the total home load on the grid is close to
|
|
5822
5805
|
* exceeding its allowed total grid load.
|
|
5823
5806
|
*
|
|
5824
|
-
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the
|
|
5825
|
-
*
|
|
5826
|
-
*
|
|
5807
|
+
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the washing
|
|
5808
|
+
* machine has a power profile suggesting its current step in the wash cycle is using power to heat the
|
|
5809
|
+
* water, but that this step can be paused.
|
|
5827
5810
|
*
|
|
5828
5811
|
* The EMS can then reduce the grid load by asking the washing machine to pause the wash cycle for a short
|
|
5829
5812
|
* duration.
|
|
@@ -5841,10 +5824,10 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5841
5824
|
* duration and/or power level limits of the steps of the power profile that the ESA has previously
|
|
5842
5825
|
* suggested it would use.
|
|
5843
5826
|
*
|
|
5844
|
-
* Heat pump and Solar PV example: A heat pump may have the ability to heat hot water as well as heating
|
|
5845
|
-
*
|
|
5846
|
-
*
|
|
5847
|
-
*
|
|
5827
|
+
* Heat pump and Solar PV example: A heat pump may have the ability to heat hot water as well as heating the
|
|
5828
|
+
* home. The heat pump scheduling system may have determined that the home will be unoccupied during the
|
|
5829
|
+
* day, or that the indoor temperature is above the set-point and so it knows that it will not need to heat
|
|
5830
|
+
* the home.
|
|
5848
5831
|
*
|
|
5849
5832
|
* However, the hot water tank is likely to need to be reheated before the homeowner comes home in the
|
|
5850
5833
|
* evening. The heat pump is not aware that the property also has a solar PV inverter which is also an ESA
|
|
@@ -5874,11 +5857,11 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5874
5857
|
*
|
|
5875
5858
|
* and may cause the ESA to modify the intended power profile has previously suggested it would use.
|
|
5876
5859
|
*
|
|
5877
|
-
* EVSE example: An EVSE scheduling system may have determined that the vehicle would be charged starting
|
|
5878
|
-
*
|
|
5860
|
+
* EVSE example: An EVSE scheduling system may have determined that the vehicle would be charged starting at
|
|
5861
|
+
* a moderate rate at 1am, so that it has enough charge by the time it is needed later that morning.
|
|
5879
5862
|
*
|
|
5880
|
-
* However, the DSR service provider has informed the EMS that due to high forecast winds it is now
|
|
5881
|
-
*
|
|
5863
|
+
* However, the DSR service provider has informed the EMS that due to high forecast winds it is now forecast
|
|
5864
|
+
* that there will be very cheap energy available from wind generation between 2am and 3am.
|
|
5882
5865
|
*
|
|
5883
5866
|
* The EMS first requests the Forecast data from each of its registered ESAs. It determines that the EVSE
|
|
5884
5867
|
* has a power profile suggesting it plans to start charging the vehicle at 1am.
|
|
@@ -5900,8 +5883,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5900
5883
|
* This field shall indicate how the ESA can be adjusted at the current time.
|
|
5901
5884
|
*
|
|
5902
5885
|
* For example, a battery storage inverter may need to regulate its internal temperature, or the charging rate
|
|
5903
|
-
* of the battery may be limited due to cold temperatures, or a change in the state of charge of the battery
|
|
5904
|
-
*
|
|
5886
|
+
* of the battery may be limited due to cold temperatures, or a change in the state of charge of the battery may
|
|
5887
|
+
* mean that the maximum charging or discharging rate is limited.
|
|
5905
5888
|
*
|
|
5906
5889
|
* An empty list shall indicate that no power adjustment is currently possible.
|
|
5907
5890
|
*
|
|
@@ -5937,9 +5920,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5937
5920
|
* For example, if a battery storage inverter can discharge between 0 to 3000W towards a load, then power is
|
|
5938
5921
|
* flowing out of the node and is therefore negative. Its MinPower would be -3000W and its MaxPower would be 0W.
|
|
5939
5922
|
*
|
|
5940
|
-
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W.
|
|
5941
|
-
*
|
|
5942
|
-
* 2000W.
|
|
5923
|
+
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W. Here
|
|
5924
|
+
* power is flowing into the node when charging. As such the MinPower becomes 0W and MaxPower becomes 2000W.
|
|
5943
5925
|
*
|
|
5944
5926
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.10.2
|
|
5945
5927
|
*/
|
|
@@ -6004,8 +5986,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6004
5986
|
*/
|
|
6005
5987
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6006
5988
|
/**
|
|
6007
|
-
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A
|
|
6008
|
-
*
|
|
5989
|
+
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A null
|
|
5990
|
+
* value indicates that it can be started immediately.
|
|
6009
5991
|
*
|
|
6010
5992
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.13.5
|
|
6011
5993
|
*/
|
|
@@ -6054,9 +6036,9 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6054
6036
|
*/
|
|
6055
6037
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6056
6038
|
/**
|
|
6057
|
-
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot
|
|
6058
|
-
*
|
|
6059
|
-
*
|
|
6039
|
+
* This field shall indicate the time (in seconds) that has already elapsed whilst in this slot. If the slot has
|
|
6040
|
+
* not yet been started, then it shall be 0. Once the slot has been completed, then this reflects how much time
|
|
6041
|
+
* was spent in this slot.
|
|
6060
6042
|
*
|
|
6061
6043
|
* When subscribed to, a change in this field value shall NOT cause the Forecast attribute to be updated since
|
|
6062
6044
|
* this value may change every 1 second.
|
|
@@ -6111,16 +6093,16 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6111
6093
|
* Some appliances, such as smart thermostats, may not know how much power is being drawn by the HVAC system,
|
|
6112
6094
|
* but do know what they have asked the HVAC system to do.
|
|
6113
6095
|
*
|
|
6114
|
-
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they
|
|
6115
|
-
*
|
|
6116
|
-
*
|
|
6096
|
+
* Manufacturers can use this value to indicate a variety of states in an unspecified way. For example, they may
|
|
6097
|
+
* choose to use values between 0-100 as a percentage of compressor modulation, or could use these values as
|
|
6098
|
+
* Enum states meaning heating with fan, heating without fan etc.
|
|
6117
6099
|
*
|
|
6118
6100
|
* NOTE An ESA shall always use the same value to represent the same operating state.
|
|
6119
6101
|
*
|
|
6120
6102
|
* By providing this information a smart EMS may be able to learn the observed power draw when the ESA is put
|
|
6121
6103
|
* into a specific state. It can potentially then use the ManufacturerESAState field in the Forecast attribute
|
|
6122
|
-
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to
|
|
6123
|
-
*
|
|
6104
|
+
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
6105
|
+
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
6124
6106
|
*
|
|
6125
6107
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.9
|
|
6126
6108
|
*/
|
|
@@ -6134,8 +6116,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6134
6116
|
*/
|
|
6135
6117
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
6136
6118
|
/**
|
|
6137
|
-
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during
|
|
6138
|
-
*
|
|
6119
|
+
* This field shall indicate the lowest power that the appliance expects to use during this slot. (e.g. during a
|
|
6120
|
+
* ramp up it may be 0W).
|
|
6139
6121
|
*
|
|
6140
6122
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
6141
6123
|
*
|
|
@@ -6169,8 +6151,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6169
6151
|
* the cost as a result of shifting its energy. This can allow a demand side response service to be informed of
|
|
6170
6152
|
* the relative cost to use energy at a different time.
|
|
6171
6153
|
*
|
|
6172
|
-
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be
|
|
6173
|
-
*
|
|
6154
|
+
* The Costs field is a list of CostStruct structures which allows multiple CostTypeEnum and Values to be shared
|
|
6155
|
+
* by the energy appliance. These could be based on GHG emissions, comfort value for the consumer etc.
|
|
6174
6156
|
*
|
|
6175
6157
|
* For example, comfort could be expressed in abstract units or in currency. A water heater that is heated
|
|
6176
6158
|
* earlier in the day is likely to lose some of its heat before it is needed, which could require a top-up
|
|
@@ -6217,8 +6199,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6217
6199
|
/**
|
|
6218
6200
|
* This field shall indicate the minimum power that the appliance can be requested to use.
|
|
6219
6201
|
*
|
|
6220
|
-
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets.
|
|
6221
|
-
*
|
|
6202
|
+
* For example, some EVSEs cannot be switched on to charge below 6A which may equate to ~1.3kW in EU markets. If
|
|
6203
|
+
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
6222
6204
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
6223
6205
|
*
|
|
6224
6206
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.15
|
|
@@ -6252,8 +6234,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6252
6234
|
* For example, if the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows
|
|
6253
6235
|
* an ESA to specify the maximum time it could be switched on for. This may allow a battery or water heater to
|
|
6254
6236
|
* indicate the maximum duration that it can charge for before becoming full. In the case of a battery inverter
|
|
6255
|
-
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at
|
|
6256
|
-
*
|
|
6237
|
+
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
6238
|
+
* MaxPowerAdjustment power level).
|
|
6257
6239
|
*
|
|
6258
6240
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.7.14.18
|
|
6259
6241
|
*/
|
|
@@ -6309,16 +6291,16 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6309
6291
|
*/
|
|
6310
6292
|
readonly esaType: FixedAttribute<EsaType, any>;
|
|
6311
6293
|
/**
|
|
6312
|
-
* Indicates whether the ESA is classed as a generator or load. This allows an EMS to understand whether
|
|
6313
|
-
*
|
|
6294
|
+
* Indicates whether the ESA is classed as a generator or load. This allows an EMS to understand whether the
|
|
6295
|
+
* power values reported by the ESA need to have their sign inverted when dealing with forecasts and
|
|
6314
6296
|
* adjustments.
|
|
6315
6297
|
*
|
|
6316
6298
|
* For example, a solar PV inverter (being a generator) may produce negative values to indicate generation
|
|
6317
6299
|
* (since power is flowing out of the node into the home), however a display showing the power to the
|
|
6318
6300
|
* consumers may need to present a positive solar production value to the consumer.
|
|
6319
6301
|
*
|
|
6320
|
-
* For example, a home battery storage system (BESS) which needs to charge the battery and then discharge
|
|
6321
|
-
*
|
|
6302
|
+
* For example, a home battery storage system (BESS) which needs to charge the battery and then discharge to
|
|
6303
|
+
* the home loads, would be classed as a generator. These types of devices shall have this field set to
|
|
6322
6304
|
* true. When generating its forecast or advertising its PowerAdjustmentCapability, the power values shall
|
|
6323
6305
|
* be negative to indicate discharging to the loads in the home, and positive to indicate when it is
|
|
6324
6306
|
* charging its battery.
|
|
@@ -6338,8 +6320,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6338
6320
|
* operational state.
|
|
6339
6321
|
*
|
|
6340
6322
|
* The ESA may have a local user interface to allow a service technician to put the ESA into Offline mode,
|
|
6341
|
-
* for example to avoid the EMS accidentally starting or stopping the appliance when it is being serviced
|
|
6342
|
-
*
|
|
6323
|
+
* for example to avoid the EMS accidentally starting or stopping the appliance when it is being serviced or
|
|
6324
|
+
* tested.
|
|
6343
6325
|
*
|
|
6344
6326
|
* @see {@link MatterSpecification.v13.Cluster} § 9.2.8.3
|
|
6345
6327
|
*/
|
|
@@ -6415,8 +6397,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6415
6397
|
};
|
|
6416
6398
|
readonly startTimeAdjustRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
6417
6399
|
/**
|
|
6418
|
-
* This field shall indicate the requested start time, in UTC, that the client would like the appliance to
|
|
6419
|
-
*
|
|
6400
|
+
* This field shall indicate the requested start time, in UTC, that the client would like the appliance to shift
|
|
6401
|
+
* its Forecast to. This value MUST be in the future.
|
|
6420
6402
|
*
|
|
6421
6403
|
* A client can estimate the entire Forecast sequence duration by computing the EndTime - StartTime fields from
|
|
6422
6404
|
* the Forecast attribute, and therefore avoid scheduling the start time too late.
|
|
@@ -6548,8 +6530,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6548
6530
|
*/
|
|
6549
6531
|
constraints: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
6550
6532
|
/**
|
|
6551
|
-
* This field shall indicate the start time of the constraint period that the client wishes the ESA to compute
|
|
6552
|
-
*
|
|
6533
|
+
* This field shall indicate the start time of the constraint period that the client wishes the ESA to compute a
|
|
6534
|
+
* new Forecast.
|
|
6553
6535
|
*
|
|
6554
6536
|
* This value is in UTC and MUST be in the future.
|
|
6555
6537
|
*
|
|
@@ -6564,8 +6546,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6564
6546
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6565
6547
|
/**
|
|
6566
6548
|
* This field shall indicate the nominal power that client wishes the ESA to operate at during the constrained
|
|
6567
|
-
* period. It MUST be between the AbsMinPower and AbsMaxPower attributes as advertised by the ESA if it
|
|
6568
|
-
*
|
|
6549
|
+
* period. It MUST be between the AbsMinPower and AbsMaxPower attributes as advertised by the ESA if it supports
|
|
6550
|
+
* PFR.
|
|
6569
6551
|
*
|
|
6570
6552
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
6571
6553
|
*
|
|
@@ -6573,8 +6555,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6573
6555
|
*/
|
|
6574
6556
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
6575
6557
|
/**
|
|
6576
|
-
* This field shall indicate the maximum energy that can be transferred to or from the ESA during the
|
|
6577
|
-
*
|
|
6558
|
+
* This field shall indicate the maximum energy that can be transferred to or from the ESA during the constraint
|
|
6559
|
+
* period.
|
|
6578
6560
|
*
|
|
6579
6561
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
6580
6562
|
*
|
|
@@ -6586,8 +6568,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6586
6568
|
* during the constraint period.
|
|
6587
6569
|
*
|
|
6588
6570
|
* This is expressed as a signed value between -100 to +100. A value of 0 would indicate no bias to using more
|
|
6589
|
-
* or less energy. A negative value indicates a request to use less energy. A positive value indicates a
|
|
6590
|
-
*
|
|
6571
|
+
* or less energy. A negative value indicates a request to use less energy. A positive value indicates a request
|
|
6572
|
+
* to use more energy.
|
|
6591
6573
|
*
|
|
6592
6574
|
* Note that the mapping between values and operation is manufacturer specific.
|
|
6593
6575
|
*
|
|
@@ -6690,8 +6672,8 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6690
6672
|
/**
|
|
6691
6673
|
* This cluster supports all DeviceEnergyManagement features. It may support illegal feature combinations.
|
|
6692
6674
|
*
|
|
6693
|
-
* If you use this cluster you must manually specify which features are active and ensure the set of active
|
|
6694
|
-
*
|
|
6675
|
+
* If you use this cluster you must manually specify which features are active and ensure the set of active features
|
|
6676
|
+
* is legal per the Matter specification.
|
|
6695
6677
|
*/
|
|
6696
6678
|
interface Complete extends Identity<typeof CompleteInstance> {
|
|
6697
6679
|
}
|