@matter/types 0.13.0-alpha.0-20250329-cd36948da → 0.13.0-alpha.0-20250330-df5a17eba
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 +250 -250
- package/dist/cjs/clusters/access-control.js +39 -39
- package/dist/cjs/clusters/account-login.d.ts +29 -29
- package/dist/cjs/clusters/account-login.js +11 -11
- package/dist/cjs/clusters/actions.d.ts +108 -108
- package/dist/cjs/clusters/actions.js +39 -39
- package/dist/cjs/clusters/administrator-commissioning.d.ts +51 -51
- package/dist/cjs/clusters/administrator-commissioning.js +12 -12
- package/dist/cjs/clusters/air-quality.d.ts +5 -5
- package/dist/cjs/clusters/air-quality.js +1 -1
- package/dist/cjs/clusters/alarm-base.d.ts +43 -43
- package/dist/cjs/clusters/alarm-base.js +14 -14
- package/dist/cjs/clusters/application-basic.d.ts +16 -16
- package/dist/cjs/clusters/application-basic.js +10 -10
- package/dist/cjs/clusters/application-launcher.d.ts +99 -99
- package/dist/cjs/clusters/application-launcher.js +13 -13
- package/dist/cjs/clusters/audio-output.d.ts +37 -37
- package/dist/cjs/clusters/audio-output.js +8 -8
- package/dist/cjs/clusters/ballast-configuration.d.ts +23 -23
- package/dist/cjs/clusters/ballast-configuration.js +17 -17
- package/dist/cjs/clusters/basic-information.d.ts +54 -54
- package/dist/cjs/clusters/basic-information.js +34 -34
- package/dist/cjs/clusters/binding.d.ts +12 -12
- package/dist/cjs/clusters/binding.js +5 -5
- package/dist/cjs/clusters/boolean-state-configuration.d.ts +92 -92
- package/dist/cjs/clusters/boolean-state-configuration.js +18 -18
- package/dist/cjs/clusters/boolean-state.d.ts +7 -7
- package/dist/cjs/clusters/boolean-state.js +3 -3
- package/dist/cjs/clusters/bridged-device-basic-information.d.ts +102 -102
- package/dist/cjs/clusters/bridged-device-basic-information.js +28 -28
- package/dist/cjs/clusters/channel.d.ts +559 -559
- package/dist/cjs/clusters/channel.js +73 -73
- package/dist/cjs/clusters/color-control.d.ts +658 -658
- package/dist/cjs/clusters/color-control.js +116 -116
- 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 +26 -26
- package/dist/cjs/clusters/concentration-measurement.js +11 -11
- package/dist/cjs/clusters/content-app-observer.d.ts +17 -17
- package/dist/cjs/clusters/content-app-observer.js +6 -6
- package/dist/cjs/clusters/content-control.d.ts +356 -356
- package/dist/cjs/clusters/content-control.js +58 -58
- package/dist/cjs/clusters/content-launcher.d.ts +475 -475
- package/dist/cjs/clusters/content-launcher.js +39 -39
- package/dist/cjs/clusters/descriptor.d.ts +28 -28
- package/dist/cjs/clusters/descriptor.js +8 -8
- package/dist/cjs/clusters/device-energy-management-mode.d.ts +43 -43
- package/dist/cjs/clusters/device-energy-management-mode.js +8 -8
- package/dist/cjs/clusters/device-energy-management.d.ts +544 -544
- package/dist/cjs/clusters/device-energy-management.js +87 -87
- package/dist/cjs/clusters/diagnostic-logs.d.ts +33 -33
- package/dist/cjs/clusters/diagnostic-logs.js +8 -8
- package/dist/cjs/clusters/dishwasher-alarm.d.ts +57 -57
- package/dist/cjs/clusters/dishwasher-alarm.js +14 -14
- package/dist/cjs/clusters/dishwasher-mode.d.ts +42 -42
- package/dist/cjs/clusters/dishwasher-mode.js +8 -8
- package/dist/cjs/clusters/door-lock.d.ts +1350 -1350
- package/dist/cjs/clusters/door-lock.js +229 -229
- package/dist/cjs/clusters/ecosystem-information.d.ts +27 -27
- package/dist/cjs/clusters/ecosystem-information.js +12 -12
- package/dist/cjs/clusters/electrical-energy-measurement.d.ts +275 -275
- package/dist/cjs/clusters/electrical-energy-measurement.js +25 -25
- package/dist/cjs/clusters/electrical-power-measurement.d.ts +199 -199
- package/dist/cjs/clusters/electrical-power-measurement.js +39 -39
- package/dist/cjs/clusters/energy-evse-mode.d.ts +43 -43
- package/dist/cjs/clusters/energy-evse-mode.js +8 -8
- package/dist/cjs/clusters/energy-evse.d.ts +323 -323
- package/dist/cjs/clusters/energy-evse.js +73 -73
- package/dist/cjs/clusters/energy-preference.d.ts +49 -49
- package/dist/cjs/clusters/energy-preference.js +9 -9
- package/dist/cjs/clusters/ethernet-network-diagnostics.d.ts +31 -31
- package/dist/cjs/clusters/ethernet-network-diagnostics.js +10 -10
- package/dist/cjs/clusters/fan-control.d.ts +67 -67
- package/dist/cjs/clusters/fan-control.js +17 -17
- package/dist/cjs/clusters/fixed-label.d.ts +2 -2
- package/dist/cjs/clusters/fixed-label.js +1 -1
- package/dist/cjs/clusters/flow-measurement.d.ts +5 -5
- package/dist/cjs/clusters/flow-measurement.js +4 -4
- package/dist/cjs/clusters/general-commissioning.d.ts +104 -104
- package/dist/cjs/clusters/general-commissioning.js +25 -25
- package/dist/cjs/clusters/general-diagnostics.d.ts +174 -174
- package/dist/cjs/clusters/general-diagnostics.js +40 -40
- package/dist/cjs/clusters/group-key-management.d.ts +119 -119
- package/dist/cjs/clusters/group-key-management.js +23 -23
- package/dist/cjs/clusters/groups.d.ts +78 -78
- package/dist/cjs/clusters/groups.js +21 -21
- package/dist/cjs/clusters/icd-management.d.ts +131 -131
- package/dist/cjs/clusters/icd-management.js +29 -29
- package/dist/cjs/clusters/identify.d.ts +16 -16
- package/dist/cjs/clusters/identify.js +6 -6
- package/dist/cjs/clusters/illuminance-measurement.d.ts +7 -7
- package/dist/cjs/clusters/illuminance-measurement.js +5 -5
- package/dist/cjs/clusters/joint-fabric-datastore-cluster.d.ts +175 -175
- package/dist/cjs/clusters/joint-fabric-datastore-cluster.js +62 -62
- package/dist/cjs/clusters/joint-fabric-pki.d.ts +14 -14
- package/dist/cjs/clusters/joint-fabric-pki.js +5 -5
- package/dist/cjs/clusters/keypad-input.d.ts +16 -16
- package/dist/cjs/clusters/keypad-input.js +3 -3
- package/dist/cjs/clusters/label.d.ts +10 -10
- package/dist/cjs/clusters/label.js +3 -3
- package/dist/cjs/clusters/laundry-dryer-controls.d.ts +4 -4
- package/dist/cjs/clusters/laundry-dryer-controls.js +2 -2
- package/dist/cjs/clusters/laundry-washer-controls.d.ts +23 -23
- package/dist/cjs/clusters/laundry-washer-controls.js +6 -6
- package/dist/cjs/clusters/laundry-washer-mode.d.ts +43 -43
- package/dist/cjs/clusters/laundry-washer-mode.js +8 -8
- package/dist/cjs/clusters/level-control.d.ts +307 -307
- package/dist/cjs/clusters/level-control.js +33 -33
- package/dist/cjs/clusters/localization-configuration.d.ts +3 -3
- package/dist/cjs/clusters/localization-configuration.js +2 -2
- package/dist/cjs/clusters/low-power.d.ts +2 -2
- package/dist/cjs/clusters/low-power.js +1 -1
- package/dist/cjs/clusters/media-input.d.ts +47 -47
- package/dist/cjs/clusters/media-input.js +11 -11
- package/dist/cjs/clusters/media-playback.d.ts +385 -385
- package/dist/cjs/clusters/media-playback.js +57 -57
- package/dist/cjs/clusters/messages.d.ts +154 -154
- package/dist/cjs/clusters/messages.js +38 -38
- package/dist/cjs/clusters/microwave-oven-control.d.ts +63 -63
- package/dist/cjs/clusters/microwave-oven-control.js +17 -17
- package/dist/cjs/clusters/microwave-oven-mode.d.ts +39 -39
- package/dist/cjs/clusters/microwave-oven-mode.js +7 -7
- package/dist/cjs/clusters/mode-base.d.ts +59 -59
- package/dist/cjs/clusters/mode-base.js +13 -13
- package/dist/cjs/clusters/mode-select.d.ts +51 -51
- package/dist/cjs/clusters/mode-select.js +13 -13
- package/dist/cjs/clusters/network-commissioning.d.ts +325 -325
- package/dist/cjs/clusters/network-commissioning.js +46 -46
- package/dist/cjs/clusters/occupancy-sensing.d.ts +78 -78
- package/dist/cjs/clusters/occupancy-sensing.js +20 -20
- package/dist/cjs/clusters/on-off.d.ts +103 -103
- package/dist/cjs/clusters/on-off.js +19 -19
- package/dist/cjs/clusters/operational-credentials.d.ts +94 -94
- package/dist/cjs/clusters/operational-credentials.js +34 -34
- package/dist/cjs/clusters/operational-state.d.ts +67 -67
- package/dist/cjs/clusters/operational-state.js +21 -21
- package/dist/cjs/clusters/ota-software-update-provider.d.ts +61 -61
- package/dist/cjs/clusters/ota-software-update-provider.js +25 -25
- package/dist/cjs/clusters/ota-software-update-requestor.d.ts +72 -72
- package/dist/cjs/clusters/ota-software-update-requestor.js +25 -25
- package/dist/cjs/clusters/oven-cavity-operational-state.d.ts +9 -9
- package/dist/cjs/clusters/oven-cavity-operational-state.js +8 -8
- package/dist/cjs/clusters/oven-mode.d.ts +49 -49
- package/dist/cjs/clusters/oven-mode.js +8 -8
- package/dist/cjs/clusters/power-source-configuration.d.ts +2 -2
- package/dist/cjs/clusters/power-source-configuration.js +1 -1
- package/dist/cjs/clusters/power-source.d.ts +155 -155
- package/dist/cjs/clusters/power-source.js +41 -41
- package/dist/cjs/clusters/power-topology.d.ts +8 -8
- package/dist/cjs/clusters/power-topology.js +2 -2
- package/dist/cjs/clusters/pressure-measurement.d.ts +25 -25
- package/dist/cjs/clusters/pressure-measurement.js +9 -9
- package/dist/cjs/clusters/proxy-configuration.d.ts +8 -8
- package/dist/cjs/clusters/proxy-configuration.js +3 -3
- package/dist/cjs/clusters/proxy-discovery.d.ts +10 -10
- package/dist/cjs/clusters/proxy-discovery.js +4 -4
- package/dist/cjs/clusters/pump-configuration-and-control.d.ts +189 -189
- package/dist/cjs/clusters/pump-configuration-and-control.js +57 -57
- package/dist/cjs/clusters/refrigerator-alarm.d.ts +43 -43
- package/dist/cjs/clusters/refrigerator-alarm.js +11 -11
- package/dist/cjs/clusters/refrigerator-and-temperature-controlled-cabinet-mode.d.ts +41 -41
- package/dist/cjs/clusters/refrigerator-and-temperature-controlled-cabinet-mode.js +8 -8
- package/dist/cjs/clusters/relative-humidity-measurement.d.ts +5 -5
- package/dist/cjs/clusters/relative-humidity-measurement.js +4 -4
- package/dist/cjs/clusters/resource-monitoring.d.ts +20 -20
- package/dist/cjs/clusters/resource-monitoring.js +7 -7
- package/dist/cjs/clusters/rvc-clean-mode.d.ts +43 -43
- package/dist/cjs/clusters/rvc-clean-mode.js +8 -8
- package/dist/cjs/clusters/rvc-operational-state.d.ts +44 -44
- package/dist/cjs/clusters/rvc-operational-state.js +15 -15
- package/dist/cjs/clusters/rvc-run-mode.d.ts +50 -50
- package/dist/cjs/clusters/rvc-run-mode.js +8 -8
- package/dist/cjs/clusters/scenes-management.d.ts +246 -246
- package/dist/cjs/clusters/scenes-management.js +70 -70
- package/dist/cjs/clusters/service-area.d.ts +128 -128
- package/dist/cjs/clusters/service-area.js +26 -26
- package/dist/cjs/clusters/smoke-co-alarm.d.ts +135 -135
- package/dist/cjs/clusters/smoke-co-alarm.js +30 -30
- package/dist/cjs/clusters/software-diagnostics.d.ts +53 -53
- package/dist/cjs/clusters/software-diagnostics.js +14 -14
- package/dist/cjs/clusters/switch.d.ts +105 -105
- package/dist/cjs/clusters/switch.js +23 -23
- package/dist/cjs/clusters/target-navigator.d.ts +30 -30
- package/dist/cjs/clusters/target-navigator.js +10 -10
- package/dist/cjs/clusters/temperature-control.d.ts +45 -45
- package/dist/cjs/clusters/temperature-control.js +12 -12
- package/dist/cjs/clusters/temperature-measurement.d.ts +5 -5
- package/dist/cjs/clusters/temperature-measurement.js +4 -4
- package/dist/cjs/clusters/thermostat-user-interface-configuration.d.ts +7 -7
- package/dist/cjs/clusters/thermostat-user-interface-configuration.js +3 -3
- package/dist/cjs/clusters/thermostat.d.ts +515 -515
- package/dist/cjs/clusters/thermostat.js +114 -114
- package/dist/cjs/clusters/thread-border-router-management.d.ts +58 -58
- package/dist/cjs/clusters/thread-border-router-management.js +14 -14
- package/dist/cjs/clusters/thread-network-diagnostics.d.ts +359 -359
- package/dist/cjs/clusters/thread-network-diagnostics.js +108 -108
- package/dist/cjs/clusters/thread-network-directory.d.ts +27 -27
- package/dist/cjs/clusters/thread-network-directory.js +11 -11
- package/dist/cjs/clusters/time-format-localization.d.ts +12 -12
- package/dist/cjs/clusters/time-format-localization.js +3 -3
- package/dist/cjs/clusters/time-synchronization.d.ts +245 -245
- package/dist/cjs/clusters/time-synchronization.js +47 -47
- package/dist/cjs/clusters/unit-localization.d.ts +6 -6
- package/dist/cjs/clusters/unit-localization.js +1 -1
- package/dist/cjs/clusters/user-label.d.ts +2 -2
- package/dist/cjs/clusters/user-label.js +1 -1
- package/dist/cjs/clusters/valid-proxies.d.ts +7 -7
- package/dist/cjs/clusters/valid-proxies.js +2 -2
- package/dist/cjs/clusters/valve-configuration-and-control.d.ts +80 -80
- package/dist/cjs/clusters/valve-configuration-and-control.js +22 -22
- package/dist/cjs/clusters/wake-on-lan.d.ts +3 -3
- package/dist/cjs/clusters/wake-on-lan.js +2 -2
- package/dist/cjs/clusters/water-heater-management.d.ts +91 -91
- package/dist/cjs/clusters/water-heater-management.js +16 -16
- package/dist/cjs/clusters/water-heater-mode.d.ts +42 -42
- package/dist/cjs/clusters/water-heater-mode.js +8 -8
- package/dist/cjs/clusters/wi-fi-network-diagnostics.d.ts +69 -69
- package/dist/cjs/clusters/wi-fi-network-diagnostics.js +20 -20
- package/dist/cjs/clusters/wi-fi-network-management.d.ts +6 -6
- package/dist/cjs/clusters/wi-fi-network-management.js +3 -3
- package/dist/cjs/clusters/window-covering.d.ts +183 -183
- package/dist/cjs/clusters/window-covering.js +49 -49
- package/dist/cjs/globals/AtomicAttributeStatus.d.ts +4 -4
- package/dist/cjs/globals/AtomicAttributeStatus.js +2 -2
- package/dist/cjs/globals/AtomicRequestType.d.ts +1 -1
- package/dist/cjs/globals/Locationdesc.d.ts +5 -5
- package/dist/cjs/globals/Locationdesc.js +3 -3
- package/dist/cjs/globals/MeasurementAccuracy.d.ts +5 -5
- package/dist/cjs/globals/MeasurementAccuracy.js +3 -3
- package/dist/cjs/globals/MeasurementAccuracyRange.d.ts +10 -10
- package/dist/cjs/globals/MeasurementAccuracyRange.js +8 -8
- package/dist/cjs/globals/MeasurementType.d.ts +1 -1
- package/dist/cjs/globals/Priority.d.ts +1 -1
- package/dist/cjs/globals/Semtag.d.ts +6 -6
- package/dist/cjs/globals/Semtag.js +4 -4
- package/dist/cjs/globals/SoftwareVersionCertificationStatus.d.ts +1 -1
- package/dist/cjs/globals/Status.d.ts +33 -33
- package/dist/cjs/globals/Tod.d.ts +2 -2
- package/dist/cjs/globals/WildcardPathFlags.d.ts +1 -1
- package/dist/esm/clusters/access-control.d.ts +250 -250
- package/dist/esm/clusters/access-control.js +39 -39
- package/dist/esm/clusters/account-login.d.ts +29 -29
- package/dist/esm/clusters/account-login.js +11 -11
- package/dist/esm/clusters/actions.d.ts +108 -108
- package/dist/esm/clusters/actions.js +39 -39
- package/dist/esm/clusters/administrator-commissioning.d.ts +51 -51
- package/dist/esm/clusters/administrator-commissioning.js +12 -12
- package/dist/esm/clusters/air-quality.d.ts +5 -5
- package/dist/esm/clusters/air-quality.js +1 -1
- package/dist/esm/clusters/alarm-base.d.ts +43 -43
- package/dist/esm/clusters/alarm-base.js +14 -14
- package/dist/esm/clusters/application-basic.d.ts +16 -16
- package/dist/esm/clusters/application-basic.js +10 -10
- package/dist/esm/clusters/application-launcher.d.ts +99 -99
- package/dist/esm/clusters/application-launcher.js +13 -13
- package/dist/esm/clusters/audio-output.d.ts +37 -37
- package/dist/esm/clusters/audio-output.js +8 -8
- package/dist/esm/clusters/ballast-configuration.d.ts +23 -23
- package/dist/esm/clusters/ballast-configuration.js +17 -17
- package/dist/esm/clusters/basic-information.d.ts +54 -54
- package/dist/esm/clusters/basic-information.js +34 -34
- package/dist/esm/clusters/binding.d.ts +12 -12
- package/dist/esm/clusters/binding.js +5 -5
- package/dist/esm/clusters/boolean-state-configuration.d.ts +92 -92
- package/dist/esm/clusters/boolean-state-configuration.js +18 -18
- package/dist/esm/clusters/boolean-state.d.ts +7 -7
- package/dist/esm/clusters/boolean-state.js +3 -3
- package/dist/esm/clusters/bridged-device-basic-information.d.ts +102 -102
- package/dist/esm/clusters/bridged-device-basic-information.js +28 -28
- package/dist/esm/clusters/channel.d.ts +559 -559
- package/dist/esm/clusters/channel.js +73 -73
- package/dist/esm/clusters/color-control.d.ts +658 -658
- package/dist/esm/clusters/color-control.js +116 -116
- 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 +26 -26
- package/dist/esm/clusters/concentration-measurement.js +11 -11
- package/dist/esm/clusters/content-app-observer.d.ts +17 -17
- package/dist/esm/clusters/content-app-observer.js +6 -6
- package/dist/esm/clusters/content-control.d.ts +356 -356
- package/dist/esm/clusters/content-control.js +58 -58
- package/dist/esm/clusters/content-launcher.d.ts +475 -475
- package/dist/esm/clusters/content-launcher.js +39 -39
- package/dist/esm/clusters/descriptor.d.ts +28 -28
- package/dist/esm/clusters/descriptor.js +8 -8
- package/dist/esm/clusters/device-energy-management-mode.d.ts +43 -43
- package/dist/esm/clusters/device-energy-management-mode.js +8 -8
- package/dist/esm/clusters/device-energy-management.d.ts +544 -544
- package/dist/esm/clusters/device-energy-management.js +87 -87
- package/dist/esm/clusters/diagnostic-logs.d.ts +33 -33
- package/dist/esm/clusters/diagnostic-logs.js +8 -8
- package/dist/esm/clusters/dishwasher-alarm.d.ts +57 -57
- package/dist/esm/clusters/dishwasher-alarm.js +14 -14
- package/dist/esm/clusters/dishwasher-mode.d.ts +42 -42
- package/dist/esm/clusters/dishwasher-mode.js +8 -8
- package/dist/esm/clusters/door-lock.d.ts +1350 -1350
- package/dist/esm/clusters/door-lock.js +229 -229
- package/dist/esm/clusters/ecosystem-information.d.ts +27 -27
- package/dist/esm/clusters/ecosystem-information.js +12 -12
- package/dist/esm/clusters/electrical-energy-measurement.d.ts +275 -275
- package/dist/esm/clusters/electrical-energy-measurement.js +25 -25
- package/dist/esm/clusters/electrical-power-measurement.d.ts +199 -199
- package/dist/esm/clusters/electrical-power-measurement.js +39 -39
- package/dist/esm/clusters/energy-evse-mode.d.ts +43 -43
- package/dist/esm/clusters/energy-evse-mode.js +8 -8
- package/dist/esm/clusters/energy-evse.d.ts +323 -323
- package/dist/esm/clusters/energy-evse.js +73 -73
- package/dist/esm/clusters/energy-preference.d.ts +49 -49
- package/dist/esm/clusters/energy-preference.js +9 -9
- package/dist/esm/clusters/ethernet-network-diagnostics.d.ts +31 -31
- package/dist/esm/clusters/ethernet-network-diagnostics.js +10 -10
- package/dist/esm/clusters/fan-control.d.ts +67 -67
- package/dist/esm/clusters/fan-control.js +17 -17
- package/dist/esm/clusters/fixed-label.d.ts +2 -2
- package/dist/esm/clusters/fixed-label.js +1 -1
- package/dist/esm/clusters/flow-measurement.d.ts +5 -5
- package/dist/esm/clusters/flow-measurement.js +4 -4
- package/dist/esm/clusters/general-commissioning.d.ts +104 -104
- package/dist/esm/clusters/general-commissioning.js +25 -25
- package/dist/esm/clusters/general-diagnostics.d.ts +174 -174
- package/dist/esm/clusters/general-diagnostics.js +40 -40
- package/dist/esm/clusters/group-key-management.d.ts +119 -119
- package/dist/esm/clusters/group-key-management.js +23 -23
- package/dist/esm/clusters/groups.d.ts +78 -78
- package/dist/esm/clusters/groups.js +21 -21
- package/dist/esm/clusters/icd-management.d.ts +131 -131
- package/dist/esm/clusters/icd-management.js +29 -29
- package/dist/esm/clusters/identify.d.ts +16 -16
- package/dist/esm/clusters/identify.js +6 -6
- package/dist/esm/clusters/illuminance-measurement.d.ts +7 -7
- package/dist/esm/clusters/illuminance-measurement.js +5 -5
- package/dist/esm/clusters/joint-fabric-datastore-cluster.d.ts +175 -175
- package/dist/esm/clusters/joint-fabric-datastore-cluster.js +62 -62
- package/dist/esm/clusters/joint-fabric-pki.d.ts +14 -14
- package/dist/esm/clusters/joint-fabric-pki.js +5 -5
- package/dist/esm/clusters/keypad-input.d.ts +16 -16
- package/dist/esm/clusters/keypad-input.js +3 -3
- package/dist/esm/clusters/label.d.ts +10 -10
- package/dist/esm/clusters/label.js +3 -3
- package/dist/esm/clusters/laundry-dryer-controls.d.ts +4 -4
- package/dist/esm/clusters/laundry-dryer-controls.js +2 -2
- package/dist/esm/clusters/laundry-washer-controls.d.ts +23 -23
- package/dist/esm/clusters/laundry-washer-controls.js +6 -6
- package/dist/esm/clusters/laundry-washer-mode.d.ts +43 -43
- package/dist/esm/clusters/laundry-washer-mode.js +8 -8
- package/dist/esm/clusters/level-control.d.ts +307 -307
- package/dist/esm/clusters/level-control.js +33 -33
- package/dist/esm/clusters/localization-configuration.d.ts +3 -3
- package/dist/esm/clusters/localization-configuration.js +2 -2
- package/dist/esm/clusters/low-power.d.ts +2 -2
- package/dist/esm/clusters/low-power.js +1 -1
- package/dist/esm/clusters/media-input.d.ts +47 -47
- package/dist/esm/clusters/media-input.js +11 -11
- package/dist/esm/clusters/media-playback.d.ts +385 -385
- package/dist/esm/clusters/media-playback.js +57 -57
- package/dist/esm/clusters/messages.d.ts +154 -154
- package/dist/esm/clusters/messages.js +38 -38
- package/dist/esm/clusters/microwave-oven-control.d.ts +63 -63
- package/dist/esm/clusters/microwave-oven-control.js +17 -17
- package/dist/esm/clusters/microwave-oven-mode.d.ts +39 -39
- package/dist/esm/clusters/microwave-oven-mode.js +7 -7
- package/dist/esm/clusters/mode-base.d.ts +59 -59
- package/dist/esm/clusters/mode-base.js +13 -13
- package/dist/esm/clusters/mode-select.d.ts +51 -51
- package/dist/esm/clusters/mode-select.js +13 -13
- package/dist/esm/clusters/network-commissioning.d.ts +325 -325
- package/dist/esm/clusters/network-commissioning.js +46 -46
- package/dist/esm/clusters/occupancy-sensing.d.ts +78 -78
- package/dist/esm/clusters/occupancy-sensing.js +20 -20
- package/dist/esm/clusters/on-off.d.ts +103 -103
- package/dist/esm/clusters/on-off.js +19 -19
- package/dist/esm/clusters/operational-credentials.d.ts +94 -94
- package/dist/esm/clusters/operational-credentials.js +34 -34
- package/dist/esm/clusters/operational-state.d.ts +67 -67
- package/dist/esm/clusters/operational-state.js +21 -21
- package/dist/esm/clusters/ota-software-update-provider.d.ts +61 -61
- package/dist/esm/clusters/ota-software-update-provider.js +25 -25
- package/dist/esm/clusters/ota-software-update-requestor.d.ts +72 -72
- package/dist/esm/clusters/ota-software-update-requestor.js +25 -25
- package/dist/esm/clusters/oven-cavity-operational-state.d.ts +9 -9
- package/dist/esm/clusters/oven-cavity-operational-state.js +8 -8
- package/dist/esm/clusters/oven-mode.d.ts +49 -49
- package/dist/esm/clusters/oven-mode.js +8 -8
- package/dist/esm/clusters/power-source-configuration.d.ts +2 -2
- package/dist/esm/clusters/power-source-configuration.js +1 -1
- package/dist/esm/clusters/power-source.d.ts +155 -155
- package/dist/esm/clusters/power-source.js +41 -41
- package/dist/esm/clusters/power-topology.d.ts +8 -8
- package/dist/esm/clusters/power-topology.js +2 -2
- package/dist/esm/clusters/pressure-measurement.d.ts +25 -25
- package/dist/esm/clusters/pressure-measurement.js +9 -9
- package/dist/esm/clusters/proxy-configuration.d.ts +8 -8
- package/dist/esm/clusters/proxy-configuration.js +3 -3
- package/dist/esm/clusters/proxy-discovery.d.ts +10 -10
- package/dist/esm/clusters/proxy-discovery.js +4 -4
- package/dist/esm/clusters/pump-configuration-and-control.d.ts +189 -189
- package/dist/esm/clusters/pump-configuration-and-control.js +57 -57
- package/dist/esm/clusters/refrigerator-alarm.d.ts +43 -43
- package/dist/esm/clusters/refrigerator-alarm.js +11 -11
- package/dist/esm/clusters/refrigerator-and-temperature-controlled-cabinet-mode.d.ts +41 -41
- package/dist/esm/clusters/refrigerator-and-temperature-controlled-cabinet-mode.js +8 -8
- package/dist/esm/clusters/relative-humidity-measurement.d.ts +5 -5
- package/dist/esm/clusters/relative-humidity-measurement.js +4 -4
- package/dist/esm/clusters/resource-monitoring.d.ts +20 -20
- package/dist/esm/clusters/resource-monitoring.js +7 -7
- package/dist/esm/clusters/rvc-clean-mode.d.ts +43 -43
- package/dist/esm/clusters/rvc-clean-mode.js +8 -8
- package/dist/esm/clusters/rvc-operational-state.d.ts +44 -44
- package/dist/esm/clusters/rvc-operational-state.js +15 -15
- package/dist/esm/clusters/rvc-run-mode.d.ts +50 -50
- package/dist/esm/clusters/rvc-run-mode.js +8 -8
- package/dist/esm/clusters/scenes-management.d.ts +246 -246
- package/dist/esm/clusters/scenes-management.js +70 -70
- package/dist/esm/clusters/service-area.d.ts +128 -128
- package/dist/esm/clusters/service-area.js +26 -26
- package/dist/esm/clusters/smoke-co-alarm.d.ts +135 -135
- package/dist/esm/clusters/smoke-co-alarm.js +30 -30
- package/dist/esm/clusters/software-diagnostics.d.ts +53 -53
- package/dist/esm/clusters/software-diagnostics.js +14 -14
- package/dist/esm/clusters/switch.d.ts +105 -105
- package/dist/esm/clusters/switch.js +23 -23
- package/dist/esm/clusters/target-navigator.d.ts +30 -30
- package/dist/esm/clusters/target-navigator.js +10 -10
- package/dist/esm/clusters/temperature-control.d.ts +45 -45
- package/dist/esm/clusters/temperature-control.js +12 -12
- package/dist/esm/clusters/temperature-measurement.d.ts +5 -5
- package/dist/esm/clusters/temperature-measurement.js +4 -4
- package/dist/esm/clusters/thermostat-user-interface-configuration.d.ts +7 -7
- package/dist/esm/clusters/thermostat-user-interface-configuration.js +3 -3
- package/dist/esm/clusters/thermostat.d.ts +515 -515
- package/dist/esm/clusters/thermostat.js +114 -114
- package/dist/esm/clusters/thread-border-router-management.d.ts +58 -58
- package/dist/esm/clusters/thread-border-router-management.js +14 -14
- package/dist/esm/clusters/thread-network-diagnostics.d.ts +359 -359
- package/dist/esm/clusters/thread-network-diagnostics.js +108 -108
- package/dist/esm/clusters/thread-network-directory.d.ts +27 -27
- package/dist/esm/clusters/thread-network-directory.js +11 -11
- package/dist/esm/clusters/time-format-localization.d.ts +12 -12
- package/dist/esm/clusters/time-format-localization.js +3 -3
- package/dist/esm/clusters/time-synchronization.d.ts +245 -245
- package/dist/esm/clusters/time-synchronization.js +47 -47
- package/dist/esm/clusters/unit-localization.d.ts +6 -6
- package/dist/esm/clusters/unit-localization.js +1 -1
- package/dist/esm/clusters/user-label.d.ts +2 -2
- package/dist/esm/clusters/user-label.js +1 -1
- package/dist/esm/clusters/valid-proxies.d.ts +7 -7
- package/dist/esm/clusters/valid-proxies.js +2 -2
- package/dist/esm/clusters/valve-configuration-and-control.d.ts +80 -80
- package/dist/esm/clusters/valve-configuration-and-control.js +22 -22
- package/dist/esm/clusters/wake-on-lan.d.ts +3 -3
- package/dist/esm/clusters/wake-on-lan.js +2 -2
- package/dist/esm/clusters/water-heater-management.d.ts +91 -91
- package/dist/esm/clusters/water-heater-management.js +16 -16
- package/dist/esm/clusters/water-heater-mode.d.ts +42 -42
- package/dist/esm/clusters/water-heater-mode.js +8 -8
- package/dist/esm/clusters/wi-fi-network-diagnostics.d.ts +69 -69
- package/dist/esm/clusters/wi-fi-network-diagnostics.js +20 -20
- package/dist/esm/clusters/wi-fi-network-management.d.ts +6 -6
- package/dist/esm/clusters/wi-fi-network-management.js +3 -3
- package/dist/esm/clusters/window-covering.d.ts +183 -183
- package/dist/esm/clusters/window-covering.js +49 -49
- package/dist/esm/globals/AtomicAttributeStatus.d.ts +4 -4
- package/dist/esm/globals/AtomicAttributeStatus.js +2 -2
- package/dist/esm/globals/AtomicRequestType.d.ts +1 -1
- package/dist/esm/globals/Locationdesc.d.ts +5 -5
- package/dist/esm/globals/Locationdesc.js +3 -3
- package/dist/esm/globals/MeasurementAccuracy.d.ts +5 -5
- package/dist/esm/globals/MeasurementAccuracy.js +3 -3
- package/dist/esm/globals/MeasurementAccuracyRange.d.ts +10 -10
- package/dist/esm/globals/MeasurementAccuracyRange.js +8 -8
- package/dist/esm/globals/MeasurementType.d.ts +1 -1
- package/dist/esm/globals/Priority.d.ts +1 -1
- package/dist/esm/globals/Semtag.d.ts +6 -6
- package/dist/esm/globals/Semtag.js +4 -4
- package/dist/esm/globals/SoftwareVersionCertificationStatus.d.ts +1 -1
- package/dist/esm/globals/Status.d.ts +33 -33
- package/dist/esm/globals/Tod.d.ts +2 -2
- package/dist/esm/globals/WildcardPathFlags.d.ts +1 -1
- package/package.json +5 -5
- package/src/clusters/access-control.ts +72 -72
- package/src/clusters/account-login.ts +22 -22
- package/src/clusters/actions.ts +86 -86
- package/src/clusters/administrator-commissioning.ts +20 -20
- package/src/clusters/air-quality.ts +4 -4
- package/src/clusters/alarm-base.ts +22 -22
- package/src/clusters/application-basic.ts +14 -14
- package/src/clusters/application-launcher.ts +28 -28
- package/src/clusters/audio-output.ts +17 -17
- package/src/clusters/ballast-configuration.ts +20 -20
- package/src/clusters/basic-information.ts +47 -47
- package/src/clusters/binding.ts +8 -8
- package/src/clusters/boolean-state-configuration.ts +31 -31
- package/src/clusters/boolean-state.ts +6 -6
- package/src/clusters/bridged-device-basic-information.ts +38 -38
- package/src/clusters/channel.ts +111 -111
- package/src/clusters/color-control.ts +168 -168
- package/src/clusters/commissioner-control.ts +15 -15
- package/src/clusters/concentration-measurement.ts +15 -15
- package/src/clusters/content-app-observer.ts +12 -12
- package/src/clusters/content-control.ts +96 -96
- package/src/clusters/content-launcher.ts +69 -69
- package/src/clusters/descriptor.ts +13 -13
- package/src/clusters/device-energy-management-mode.ts +28 -28
- package/src/clusters/device-energy-management.ts +136 -136
- package/src/clusters/diagnostic-logs.ts +26 -26
- package/src/clusters/dishwasher-alarm.ts +24 -24
- package/src/clusters/dishwasher-mode.ts +27 -27
- package/src/clusters/door-lock.ts +378 -378
- package/src/clusters/ecosystem-information.ts +17 -17
- package/src/clusters/electrical-energy-measurement.ts +39 -39
- package/src/clusters/electrical-power-measurement.ts +53 -53
- package/src/clusters/energy-evse-mode.ts +28 -28
- package/src/clusters/energy-evse.ts +109 -109
- package/src/clusters/energy-preference.ts +19 -19
- package/src/clusters/ethernet-network-diagnostics.ts +13 -13
- package/src/clusters/fan-control.ts +30 -30
- package/src/clusters/fixed-label.ts +2 -2
- package/src/clusters/flow-measurement.ts +5 -5
- package/src/clusters/general-commissioning.ts +45 -45
- package/src/clusters/general-diagnostics.ts +66 -66
- package/src/clusters/group-key-management.ts +45 -45
- package/src/clusters/groups.ts +44 -44
- package/src/clusters/icd-management.ts +50 -50
- package/src/clusters/identify.ts +14 -14
- package/src/clusters/illuminance-measurement.ts +7 -7
- package/src/clusters/joint-fabric-datastore-cluster.ts +82 -82
- package/src/clusters/joint-fabric-pki.ts +12 -12
- package/src/clusters/keypad-input.ts +11 -11
- package/src/clusters/label.ts +5 -5
- package/src/clusters/laundry-dryer-controls.ts +4 -4
- package/src/clusters/laundry-washer-controls.ts +11 -11
- package/src/clusters/laundry-washer-mode.ts +28 -28
- package/src/clusters/level-control.ts +50 -50
- package/src/clusters/localization-configuration.ts +3 -3
- package/src/clusters/low-power.ts +2 -2
- package/src/clusters/media-input.ts +20 -20
- package/src/clusters/media-playback.ts +91 -91
- package/src/clusters/messages.ts +61 -61
- package/src/clusters/microwave-oven-control.ts +23 -23
- package/src/clusters/microwave-oven-mode.ts +25 -25
- package/src/clusters/mode-base.ts +37 -37
- package/src/clusters/mode-select.ts +22 -22
- package/src/clusters/network-commissioning.ts +76 -76
- package/src/clusters/occupancy-sensing.ts +29 -29
- package/src/clusters/on-off.ts +33 -33
- package/src/clusters/operational-credentials.ts +65 -65
- package/src/clusters/operational-state.ts +34 -34
- package/src/clusters/ota-software-update-provider.ts +39 -39
- package/src/clusters/ota-software-update-requestor.ts +55 -55
- package/src/clusters/oven-cavity-operational-state.ts +9 -9
- package/src/clusters/oven-mode.ts +34 -34
- package/src/clusters/power-source-configuration.ts +2 -2
- package/src/clusters/power-source.ts +59 -59
- package/src/clusters/power-topology.ts +4 -4
- package/src/clusters/pressure-measurement.ts +11 -11
- package/src/clusters/proxy-configuration.ts +6 -6
- package/src/clusters/proxy-discovery.ts +7 -7
- package/src/clusters/pump-configuration-and-control.ts +69 -69
- package/src/clusters/refrigerator-alarm.ts +18 -18
- package/src/clusters/refrigerator-and-temperature-controlled-cabinet-mode.ts +26 -26
- package/src/clusters/relative-humidity-measurement.ts +5 -5
- package/src/clusters/resource-monitoring.ts +13 -13
- package/src/clusters/rvc-clean-mode.ts +28 -28
- package/src/clusters/rvc-operational-state.ts +26 -26
- package/src/clusters/rvc-run-mode.ts +35 -35
- package/src/clusters/scenes-management.ts +112 -112
- package/src/clusters/service-area.ts +50 -50
- package/src/clusters/smoke-co-alarm.ts +66 -66
- package/src/clusters/software-diagnostics.ts +20 -20
- package/src/clusters/switch.ts +45 -45
- package/src/clusters/target-navigator.ts +20 -20
- package/src/clusters/temperature-control.ts +19 -19
- package/src/clusters/temperature-measurement.ts +5 -5
- package/src/clusters/thermostat-user-interface-configuration.ts +7 -7
- package/src/clusters/thermostat.ts +172 -172
- package/src/clusters/thread-border-router-management.ts +23 -23
- package/src/clusters/thread-network-diagnostics.ts +125 -125
- package/src/clusters/thread-network-directory.ts +22 -22
- package/src/clusters/time-format-localization.ts +7 -7
- package/src/clusters/time-synchronization.ts +81 -81
- package/src/clusters/unit-localization.ts +4 -4
- package/src/clusters/user-label.ts +2 -2
- package/src/clusters/valid-proxies.ts +7 -7
- package/src/clusters/valve-configuration-and-control.ts +35 -35
- package/src/clusters/wake-on-lan.ts +3 -3
- package/src/clusters/water-heater-management.ts +26 -26
- package/src/clusters/water-heater-mode.ts +27 -27
- package/src/clusters/wi-fi-network-diagnostics.ts +32 -32
- package/src/clusters/wi-fi-network-management.ts +6 -6
- package/src/clusters/window-covering.ts +68 -68
- package/src/globals/AtomicAttributeStatus.ts +4 -4
- package/src/globals/AtomicRequestType.ts +1 -1
- package/src/globals/Locationdesc.ts +5 -5
- package/src/globals/MeasurementAccuracy.ts +5 -5
- package/src/globals/MeasurementAccuracyRange.ts +10 -10
- package/src/globals/MeasurementType.ts +1 -1
- package/src/globals/Priority.ts +1 -1
- package/src/globals/Semtag.ts +6 -6
- package/src/globals/SoftwareVersionCertificationStatus.ts +1 -1
- package/src/globals/Status.ts +33 -33
- package/src/globals/Tod.ts +2 -2
- package/src/globals/WildcardPathFlags.ts +1 -1
|
@@ -13,7 +13,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
13
13
|
/**
|
|
14
14
|
* These are optional features supported by DeviceEnergyManagementCluster.
|
|
15
15
|
*
|
|
16
|
-
* @see {@link MatterSpecification.
|
|
16
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4
|
|
17
17
|
*/
|
|
18
18
|
enum Feature {
|
|
19
19
|
/**
|
|
@@ -34,7 +34,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
34
34
|
* discharging (and re-charging) of the vehicle if the EVSE and vehicle support the V2X feature of the EVSE
|
|
35
35
|
* cluster of the associated EVSE device.
|
|
36
36
|
*
|
|
37
|
-
* @see {@link MatterSpecification.
|
|
37
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.1
|
|
38
38
|
*/
|
|
39
39
|
PowerAdjustment = "PowerAdjustment",
|
|
40
40
|
/**
|
|
@@ -77,7 +77,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
77
77
|
*
|
|
78
78
|
* The ESA indicates its power adjustment range and its nominal power consumption as part of its Forecast.
|
|
79
79
|
*
|
|
80
|
-
* @see {@link MatterSpecification.
|
|
80
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.2
|
|
81
81
|
*/
|
|
82
82
|
PowerForecastReporting = "PowerForecastReporting",
|
|
83
83
|
/**
|
|
@@ -96,7 +96,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
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.
|
|
98
98
|
*
|
|
99
|
-
* @see {@link MatterSpecification.
|
|
99
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.3
|
|
100
100
|
*/
|
|
101
101
|
StateForecastReporting = "StateForecastReporting",
|
|
102
102
|
/**
|
|
@@ -120,7 +120,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
120
120
|
* It does this by sending a StartTimeAdjustRequest to the washing machine to request delaying the start of the
|
|
121
121
|
* washing cycle.
|
|
122
122
|
*
|
|
123
|
-
* @see {@link MatterSpecification.
|
|
123
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.4
|
|
124
124
|
*/
|
|
125
125
|
StartTimeAdjustment = "StartTimeAdjustment",
|
|
126
126
|
/**
|
|
@@ -145,7 +145,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
145
145
|
* It does this by sending a PauseRequest to the washing machine to request pausing the current step of the
|
|
146
146
|
* forecast power usage for a period to allow other home loads to finish before resuming the washing cycle.
|
|
147
147
|
*
|
|
148
|
-
* @see {@link MatterSpecification.
|
|
148
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.5
|
|
149
149
|
*/
|
|
150
150
|
Pausable = "Pausable",
|
|
151
151
|
/**
|
|
@@ -174,7 +174,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
174
174
|
* lower power consumption (within the solar excess power) which requires the heat pump to run for a longer
|
|
175
175
|
* duration to achieve its required energy demand.
|
|
176
176
|
*
|
|
177
|
-
* @see {@link MatterSpecification.
|
|
177
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.6
|
|
178
178
|
*/
|
|
179
179
|
ForecastAdjustment = "ForecastAdjustment",
|
|
180
180
|
/**
|
|
@@ -202,12 +202,12 @@ export declare namespace DeviceEnergyManagement {
|
|
|
202
202
|
* NominalPower consumption during the constraint period, which may require it to decrease its charge rate
|
|
203
203
|
* outside the constraint period to achieve its required energy demand.
|
|
204
204
|
*
|
|
205
|
-
* @see {@link MatterSpecification.
|
|
205
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.7
|
|
206
206
|
*/
|
|
207
207
|
ConstraintBasedAdjustment = "ConstraintBasedAdjustment"
|
|
208
208
|
}
|
|
209
209
|
/**
|
|
210
|
-
* @see {@link MatterSpecification.
|
|
210
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10
|
|
211
211
|
*/
|
|
212
212
|
const TlvPowerAdjust: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
213
213
|
/**
|
|
@@ -216,7 +216,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
216
216
|
* Note that this is a signed value. Negative values indicate power flows out of the node (e.g. discharging a
|
|
217
217
|
* battery).
|
|
218
218
|
*
|
|
219
|
-
* @see {@link MatterSpecification.
|
|
219
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.1
|
|
220
220
|
*/
|
|
221
221
|
minPower: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
222
222
|
/**
|
|
@@ -235,7 +235,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
235
235
|
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W. Here
|
|
236
236
|
* power is flowing into the node when charging. As such the MinPower becomes 0W and MaxPower becomes 2000W.
|
|
237
237
|
*
|
|
238
|
-
* @see {@link MatterSpecification.
|
|
238
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.2
|
|
239
239
|
*/
|
|
240
240
|
maxPower: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
241
241
|
/**
|
|
@@ -243,7 +243,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
243
243
|
* adjustment. Manufacturers may use this to as an anti-cycling capability to avoid controllers from rapidly
|
|
244
244
|
* making power adjustments.
|
|
245
245
|
*
|
|
246
|
-
* @see {@link MatterSpecification.
|
|
246
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.3
|
|
247
247
|
*/
|
|
248
248
|
minDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
249
249
|
/**
|
|
@@ -251,17 +251,17 @@ export declare namespace DeviceEnergyManagement {
|
|
|
251
251
|
* adjustment. Manufacturers may use this to protect the user experience, to avoid over heating of the ESA,
|
|
252
252
|
* ensuring that there is sufficient headroom to use or store energy in the ESA or for any other reason.
|
|
253
253
|
*
|
|
254
|
-
* @see {@link MatterSpecification.
|
|
254
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.4
|
|
255
255
|
*/
|
|
256
256
|
maxDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
257
257
|
}>;
|
|
258
258
|
/**
|
|
259
|
-
* @see {@link MatterSpecification.
|
|
259
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10
|
|
260
260
|
*/
|
|
261
261
|
interface PowerAdjust extends TypeFromSchema<typeof TlvPowerAdjust> {
|
|
262
262
|
}
|
|
263
263
|
/**
|
|
264
|
-
* @see {@link MatterSpecification.
|
|
264
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.8
|
|
265
265
|
*/
|
|
266
266
|
enum PowerAdjustReason {
|
|
267
267
|
/**
|
|
@@ -278,7 +278,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
278
278
|
GridOptimizationAdjustment = 2
|
|
279
279
|
}
|
|
280
280
|
/**
|
|
281
|
-
* @see {@link MatterSpecification.
|
|
281
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.11
|
|
282
282
|
*/
|
|
283
283
|
const TlvPowerAdjustCapability: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
284
284
|
/**
|
|
@@ -297,7 +297,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
297
297
|
*
|
|
298
298
|
* In this example the list of PowerAdjustStructs allows multiple scenarios to be offered as follows:
|
|
299
299
|
*
|
|
300
|
-
* @see {@link MatterSpecification.
|
|
300
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.12
|
|
301
301
|
*/
|
|
302
302
|
powerAdjustCapability: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
303
303
|
/**
|
|
@@ -306,7 +306,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
306
306
|
* Note that this is a signed value. Negative values indicate power flows out of the node (e.g. discharging a
|
|
307
307
|
* battery).
|
|
308
308
|
*
|
|
309
|
-
* @see {@link MatterSpecification.
|
|
309
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.1
|
|
310
310
|
*/
|
|
311
311
|
minPower: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
312
312
|
/**
|
|
@@ -325,7 +325,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
325
325
|
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W. Here
|
|
326
326
|
* power is flowing into the node when charging. As such the MinPower becomes 0W and MaxPower becomes 2000W.
|
|
327
327
|
*
|
|
328
|
-
* @see {@link MatterSpecification.
|
|
328
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.2
|
|
329
329
|
*/
|
|
330
330
|
maxPower: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
331
331
|
/**
|
|
@@ -333,7 +333,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
333
333
|
* adjustment. Manufacturers may use this to as an anti-cycling capability to avoid controllers from rapidly
|
|
334
334
|
* making power adjustments.
|
|
335
335
|
*
|
|
336
|
-
* @see {@link MatterSpecification.
|
|
336
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.3
|
|
337
337
|
*/
|
|
338
338
|
minDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
339
339
|
/**
|
|
@@ -341,19 +341,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
341
341
|
* adjustment. Manufacturers may use this to protect the user experience, to avoid over heating of the ESA,
|
|
342
342
|
* ensuring that there is sufficient headroom to use or store energy in the ESA or for any other reason.
|
|
343
343
|
*
|
|
344
|
-
* @see {@link MatterSpecification.
|
|
344
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.4
|
|
345
345
|
*/
|
|
346
346
|
maxDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
347
347
|
}>[] | null>;
|
|
348
348
|
cause: import("../tlv/TlvObject.js").FieldType<PowerAdjustReason>;
|
|
349
349
|
}>;
|
|
350
350
|
/**
|
|
351
|
-
* @see {@link MatterSpecification.
|
|
351
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.11
|
|
352
352
|
*/
|
|
353
353
|
interface PowerAdjustCapability extends TypeFromSchema<typeof TlvPowerAdjustCapability> {
|
|
354
354
|
}
|
|
355
355
|
/**
|
|
356
|
-
* @see {@link MatterSpecification.
|
|
356
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.6
|
|
357
357
|
*/
|
|
358
358
|
enum AdjustmentCause {
|
|
359
359
|
/**
|
|
@@ -368,7 +368,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
368
368
|
/**
|
|
369
369
|
* Input to the DeviceEnergyManagement powerAdjustRequest command
|
|
370
370
|
*
|
|
371
|
-
* @see {@link MatterSpecification.
|
|
371
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1
|
|
372
372
|
*/
|
|
373
373
|
const TlvPowerAdjustRequest: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
374
374
|
/**
|
|
@@ -377,7 +377,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
377
377
|
* This value shall be between the MinPower and MaxPower fields of the PowerAdjustStruct in the
|
|
378
378
|
* PowerAdjustmentCapability attribute.
|
|
379
379
|
*
|
|
380
|
-
* @see {@link MatterSpecification.
|
|
380
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.1
|
|
381
381
|
*/
|
|
382
382
|
power: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
383
383
|
/**
|
|
@@ -386,25 +386,25 @@ export declare namespace DeviceEnergyManagement {
|
|
|
386
386
|
* This value shall be between the MinDuration and MaxDuration fields of the PowerAdjustStruct in the
|
|
387
387
|
* PowerAdjustmentCapability attribute.
|
|
388
388
|
*
|
|
389
|
-
* @see {@link MatterSpecification.
|
|
389
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.2
|
|
390
390
|
*/
|
|
391
391
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
392
392
|
/**
|
|
393
393
|
* This field shall indicate the cause of the request from the EMS.
|
|
394
394
|
*
|
|
395
|
-
* @see {@link MatterSpecification.
|
|
395
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.3
|
|
396
396
|
*/
|
|
397
397
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
398
398
|
}>;
|
|
399
399
|
/**
|
|
400
400
|
* Input to the DeviceEnergyManagement powerAdjustRequest command
|
|
401
401
|
*
|
|
402
|
-
* @see {@link MatterSpecification.
|
|
402
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1
|
|
403
403
|
*/
|
|
404
404
|
interface PowerAdjustRequest extends TypeFromSchema<typeof TlvPowerAdjustRequest> {
|
|
405
405
|
}
|
|
406
406
|
/**
|
|
407
|
-
* @see {@link MatterSpecification.
|
|
407
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.5
|
|
408
408
|
*/
|
|
409
409
|
enum Cause {
|
|
410
410
|
/**
|
|
@@ -431,19 +431,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
431
431
|
/**
|
|
432
432
|
* Body of the DeviceEnergyManagement powerAdjustEnd event
|
|
433
433
|
*
|
|
434
|
-
* @see {@link MatterSpecification.
|
|
434
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2
|
|
435
435
|
*/
|
|
436
436
|
const TlvPowerAdjustEndEvent: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
437
437
|
/**
|
|
438
438
|
* This field shall indicate the reason why the power adjustment session ended.
|
|
439
439
|
*
|
|
440
|
-
* @see {@link MatterSpecification.
|
|
440
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.1
|
|
441
441
|
*/
|
|
442
442
|
cause: import("../tlv/TlvObject.js").FieldType<Cause>;
|
|
443
443
|
/**
|
|
444
444
|
* This field shall indicate the number of seconds that the power adjustment session lasted before ending.
|
|
445
445
|
*
|
|
446
|
-
* @see {@link MatterSpecification.
|
|
446
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.2
|
|
447
447
|
*/
|
|
448
448
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
449
449
|
/**
|
|
@@ -453,19 +453,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
453
453
|
* battery inverter that was requested to discharge it would have a negative EnergyUse value. If this was a
|
|
454
454
|
* normal load that was turned on, then it will have positive value.
|
|
455
455
|
*
|
|
456
|
-
* @see {@link MatterSpecification.
|
|
456
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.3
|
|
457
457
|
*/
|
|
458
458
|
energyUse: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
459
459
|
}>;
|
|
460
460
|
/**
|
|
461
461
|
* Body of the DeviceEnergyManagement powerAdjustEnd event
|
|
462
462
|
*
|
|
463
|
-
* @see {@link MatterSpecification.
|
|
463
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2
|
|
464
464
|
*/
|
|
465
465
|
interface PowerAdjustEndEvent extends TypeFromSchema<typeof TlvPowerAdjustEndEvent> {
|
|
466
466
|
}
|
|
467
467
|
/**
|
|
468
|
-
* @see {@link MatterSpecification.
|
|
468
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.1
|
|
469
469
|
*/
|
|
470
470
|
enum CostType {
|
|
471
471
|
/**
|
|
@@ -473,7 +473,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
473
473
|
*
|
|
474
474
|
* This value shall indicate that the cost is related to the financial cost to provide the energy.
|
|
475
475
|
*
|
|
476
|
-
* @see {@link MatterSpecification.
|
|
476
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.1.1
|
|
477
477
|
*/
|
|
478
478
|
Financial = 0,
|
|
479
479
|
/**
|
|
@@ -481,7 +481,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
481
481
|
*
|
|
482
482
|
* This value shall indicate that the cost is related to greenhouse gas emissions (in grams of CO2e).
|
|
483
483
|
*
|
|
484
|
-
* @see {@link MatterSpecification.
|
|
484
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.1.2
|
|
485
485
|
*/
|
|
486
486
|
GhgEmissions = 1,
|
|
487
487
|
/**
|
|
@@ -493,7 +493,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
493
493
|
* hospital. Or the consumer may feel inconvenienced by the fact that they need to wait for the washing machine
|
|
494
494
|
* to finish its load so that they can use it again.
|
|
495
495
|
*
|
|
496
|
-
* @see {@link MatterSpecification.
|
|
496
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.1.3
|
|
497
497
|
*/
|
|
498
498
|
Comfort = 2,
|
|
499
499
|
/**
|
|
@@ -504,7 +504,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
504
504
|
*
|
|
505
505
|
* This is expressed in degrees Celsius.
|
|
506
506
|
*
|
|
507
|
-
* @see {@link MatterSpecification.
|
|
507
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.1.4
|
|
508
508
|
*/
|
|
509
509
|
Temperature = 3
|
|
510
510
|
}
|
|
@@ -512,13 +512,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
512
512
|
* This indicates a generic mechanism for expressing cost to run an appliance, in terms of financial, GHG emissions,
|
|
513
513
|
* comfort value etc.
|
|
514
514
|
*
|
|
515
|
-
* @see {@link MatterSpecification.
|
|
515
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9
|
|
516
516
|
*/
|
|
517
517
|
const TlvCost: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
518
518
|
/**
|
|
519
519
|
* This field shall indicate the type of cost being represented (see CostTypeEnum).
|
|
520
520
|
*
|
|
521
|
-
* @see {@link MatterSpecification.
|
|
521
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.1
|
|
522
522
|
*/
|
|
523
523
|
costType: import("../tlv/TlvObject.js").FieldType<CostType>;
|
|
524
524
|
/**
|
|
@@ -527,14 +527,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
527
527
|
*
|
|
528
528
|
* For example, if the Value was -302 and DecimalPoints was 2, then this would represent a benefit of 3.02.
|
|
529
529
|
*
|
|
530
|
-
* @see {@link MatterSpecification.
|
|
530
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.2
|
|
531
531
|
*/
|
|
532
532
|
value: import("../tlv/TlvObject.js").FieldType<number>;
|
|
533
533
|
/**
|
|
534
534
|
* This field shall indicate the number of digits to the right of the decimal point in the Value field. For
|
|
535
535
|
* example, if the Value was 102 and DecimalPoints was 2, then this would represent a cost of 1.02.
|
|
536
536
|
*
|
|
537
|
-
* @see {@link MatterSpecification.
|
|
537
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.3
|
|
538
538
|
*/
|
|
539
539
|
decimalPoints: import("../tlv/TlvObject.js").FieldType<number>;
|
|
540
540
|
/**
|
|
@@ -543,7 +543,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
543
543
|
*
|
|
544
544
|
* This is an optional field. It shall be included if CostType is Financial.
|
|
545
545
|
*
|
|
546
|
-
* @see {@link MatterSpecification.
|
|
546
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.4
|
|
547
547
|
*/
|
|
548
548
|
currency: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
549
549
|
}>;
|
|
@@ -551,32 +551,32 @@ export declare namespace DeviceEnergyManagement {
|
|
|
551
551
|
* This indicates a generic mechanism for expressing cost to run an appliance, in terms of financial, GHG emissions,
|
|
552
552
|
* comfort value etc.
|
|
553
553
|
*
|
|
554
|
-
* @see {@link MatterSpecification.
|
|
554
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9
|
|
555
555
|
*/
|
|
556
556
|
interface Cost extends TypeFromSchema<typeof TlvCost> {
|
|
557
557
|
}
|
|
558
558
|
/**
|
|
559
559
|
* This indicates a specific stage of an ESA’s operation.
|
|
560
560
|
*
|
|
561
|
-
* @see {@link MatterSpecification.
|
|
561
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14
|
|
562
562
|
*/
|
|
563
563
|
const TlvSlot: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
564
564
|
/**
|
|
565
565
|
* This field shall indicate the minimum time (in seconds) that the appliance expects to be in this slot for.
|
|
566
566
|
*
|
|
567
|
-
* @see {@link MatterSpecification.
|
|
567
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.1
|
|
568
568
|
*/
|
|
569
569
|
minDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
570
570
|
/**
|
|
571
571
|
* This field shall indicate the maximum time (in seconds) that the appliance expects to be in this slot for.
|
|
572
572
|
*
|
|
573
|
-
* @see {@link MatterSpecification.
|
|
573
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.2
|
|
574
574
|
*/
|
|
575
575
|
maxDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
576
576
|
/**
|
|
577
577
|
* This field shall indicate the expected time (in seconds) that the appliance expects to be in this slot for.
|
|
578
578
|
*
|
|
579
|
-
* @see {@link MatterSpecification.
|
|
579
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.3
|
|
580
580
|
*/
|
|
581
581
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
582
582
|
/**
|
|
@@ -589,7 +589,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
589
589
|
*
|
|
590
590
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
591
591
|
*
|
|
592
|
-
* @see {@link MatterSpecification.
|
|
592
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.4
|
|
593
593
|
*/
|
|
594
594
|
elapsedSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
595
595
|
/**
|
|
@@ -605,13 +605,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
605
605
|
*
|
|
606
606
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
607
607
|
*
|
|
608
|
-
* @see {@link MatterSpecification.
|
|
608
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.5
|
|
609
609
|
*/
|
|
610
610
|
remainingSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
611
611
|
/**
|
|
612
612
|
* This field shall indicate whether this slot can be paused.
|
|
613
613
|
*
|
|
614
|
-
* @see {@link MatterSpecification.
|
|
614
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.6
|
|
615
615
|
*/
|
|
616
616
|
slotIsPausable: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
617
617
|
/**
|
|
@@ -619,13 +619,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
619
619
|
* controllers trying to pause ESAs for short periods and then resuming operation in a cyclic fashion which may
|
|
620
620
|
* damage or cause excess energy to be consumed with restarting of an operation.
|
|
621
621
|
*
|
|
622
|
-
* @see {@link MatterSpecification.
|
|
622
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.7
|
|
623
623
|
*/
|
|
624
624
|
minPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
625
625
|
/**
|
|
626
626
|
* This field shall indicate the longest period that the slot can be paused for.
|
|
627
627
|
*
|
|
628
|
-
* @see {@link MatterSpecification.
|
|
628
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.8
|
|
629
629
|
*/
|
|
630
630
|
maxPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
631
631
|
/**
|
|
@@ -648,7 +648,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
648
648
|
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
649
649
|
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
650
650
|
*
|
|
651
|
-
* @see {@link MatterSpecification.
|
|
651
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.9
|
|
652
652
|
*/
|
|
653
653
|
manufacturerEsaState: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
654
654
|
/**
|
|
@@ -656,7 +656,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
656
656
|
* considered the average value over the slot, and some variation from this would be expected (for example, as
|
|
657
657
|
* it is ramping up).
|
|
658
658
|
*
|
|
659
|
-
* @see {@link MatterSpecification.
|
|
659
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.10
|
|
660
660
|
*/
|
|
661
661
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
662
662
|
/**
|
|
@@ -665,7 +665,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
665
665
|
*
|
|
666
666
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
667
667
|
*
|
|
668
|
-
* @see {@link MatterSpecification.
|
|
668
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.11
|
|
669
669
|
*/
|
|
670
670
|
minPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
671
671
|
/**
|
|
@@ -674,7 +674,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
674
674
|
*
|
|
675
675
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
676
676
|
*
|
|
677
|
-
* @see {@link MatterSpecification.
|
|
677
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.12
|
|
678
678
|
*/
|
|
679
679
|
maxPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
680
680
|
/**
|
|
@@ -682,7 +682,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
682
682
|
*
|
|
683
683
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative energy.
|
|
684
684
|
*
|
|
685
|
-
* @see {@link MatterSpecification.
|
|
685
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.13
|
|
686
686
|
*/
|
|
687
687
|
nominalEnergy: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
688
688
|
/**
|
|
@@ -705,13 +705,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
705
705
|
* If the ESA cannot calculate its cost for any reason (such as losing its connection to a Price server) it may
|
|
706
706
|
* omit this field. This is treated as extra meta data that an EMS may use to optimize a system.
|
|
707
707
|
*
|
|
708
|
-
* @see {@link MatterSpecification.
|
|
708
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.14
|
|
709
709
|
*/
|
|
710
710
|
costs: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
711
711
|
/**
|
|
712
712
|
* This field shall indicate the type of cost being represented (see CostTypeEnum).
|
|
713
713
|
*
|
|
714
|
-
* @see {@link MatterSpecification.
|
|
714
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.1
|
|
715
715
|
*/
|
|
716
716
|
costType: import("../tlv/TlvObject.js").FieldType<CostType>;
|
|
717
717
|
/**
|
|
@@ -720,14 +720,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
720
720
|
*
|
|
721
721
|
* For example, if the Value was -302 and DecimalPoints was 2, then this would represent a benefit of 3.02.
|
|
722
722
|
*
|
|
723
|
-
* @see {@link MatterSpecification.
|
|
723
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.2
|
|
724
724
|
*/
|
|
725
725
|
value: import("../tlv/TlvObject.js").FieldType<number>;
|
|
726
726
|
/**
|
|
727
727
|
* This field shall indicate the number of digits to the right of the decimal point in the Value field. For
|
|
728
728
|
* example, if the Value was 102 and DecimalPoints was 2, then this would represent a cost of 1.02.
|
|
729
729
|
*
|
|
730
|
-
* @see {@link MatterSpecification.
|
|
730
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.3
|
|
731
731
|
*/
|
|
732
732
|
decimalPoints: import("../tlv/TlvObject.js").FieldType<number>;
|
|
733
733
|
/**
|
|
@@ -736,7 +736,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
736
736
|
*
|
|
737
737
|
* This is an optional field. It shall be included if CostType is Financial.
|
|
738
738
|
*
|
|
739
|
-
* @see {@link MatterSpecification.
|
|
739
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.4
|
|
740
740
|
*/
|
|
741
741
|
currency: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
742
742
|
}>[]>;
|
|
@@ -747,7 +747,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
747
747
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
748
748
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
749
749
|
*
|
|
750
|
-
* @see {@link MatterSpecification.
|
|
750
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.15
|
|
751
751
|
*/
|
|
752
752
|
minPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
753
753
|
/**
|
|
@@ -757,7 +757,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
757
757
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
758
758
|
* indicate it could be switched on to charge, but this would be the maximum power limit it can be set to.
|
|
759
759
|
*
|
|
760
|
-
* @see {@link MatterSpecification.
|
|
760
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.16
|
|
761
761
|
*/
|
|
762
762
|
maxPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
763
763
|
/**
|
|
@@ -769,7 +769,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
769
769
|
*
|
|
770
770
|
* For example, a heat pump compressor may have a minimum cycle time of order a few minutes.
|
|
771
771
|
*
|
|
772
|
-
* @see {@link MatterSpecification.
|
|
772
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.17
|
|
773
773
|
*/
|
|
774
774
|
minDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
775
775
|
/**
|
|
@@ -781,19 +781,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
781
781
|
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
782
782
|
* MaxPowerAdjustment power level).
|
|
783
783
|
*
|
|
784
|
-
* @see {@link MatterSpecification.
|
|
784
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.18
|
|
785
785
|
*/
|
|
786
786
|
maxDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
787
787
|
}>;
|
|
788
788
|
/**
|
|
789
789
|
* This indicates a specific stage of an ESA’s operation.
|
|
790
790
|
*
|
|
791
|
-
* @see {@link MatterSpecification.
|
|
791
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14
|
|
792
792
|
*/
|
|
793
793
|
interface Slot extends TypeFromSchema<typeof TlvSlot> {
|
|
794
794
|
}
|
|
795
795
|
/**
|
|
796
|
-
* @see {@link MatterSpecification.
|
|
796
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.7
|
|
797
797
|
*/
|
|
798
798
|
enum ForecastUpdateReason {
|
|
799
799
|
/**
|
|
@@ -818,7 +818,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
818
818
|
*
|
|
819
819
|
* feature and instead report its internal state.
|
|
820
820
|
*
|
|
821
|
-
* @see {@link MatterSpecification.
|
|
821
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13
|
|
822
822
|
*/
|
|
823
823
|
const TlvForecast: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
824
824
|
/**
|
|
@@ -831,33 +831,33 @@ export declare namespace DeviceEnergyManagement {
|
|
|
831
831
|
*
|
|
832
832
|
* The value of ForecastID is allowed to wrap.
|
|
833
833
|
*
|
|
834
|
-
* @see {@link MatterSpecification.
|
|
834
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.1
|
|
835
835
|
*/
|
|
836
836
|
forecastId: import("../tlv/TlvObject.js").FieldType<number>;
|
|
837
837
|
/**
|
|
838
838
|
* This field shall indicate which element of the Slots list is currently active in the Forecast sequence. A
|
|
839
839
|
* null value indicates that the sequence has not yet started.
|
|
840
840
|
*
|
|
841
|
-
* @see {@link MatterSpecification.
|
|
841
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.2
|
|
842
842
|
*/
|
|
843
843
|
activeSlotNumber: import("../tlv/TlvObject.js").FieldType<number | null>;
|
|
844
844
|
/**
|
|
845
845
|
* This field shall indicate the planned start time, in UTC, for the entire Forecast.
|
|
846
846
|
*
|
|
847
|
-
* @see {@link MatterSpecification.
|
|
847
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.3
|
|
848
848
|
*/
|
|
849
849
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
850
850
|
/**
|
|
851
851
|
* This field shall indicate the planned end time, in UTC, for the entire Forecast.
|
|
852
852
|
*
|
|
853
|
-
* @see {@link MatterSpecification.
|
|
853
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.4
|
|
854
854
|
*/
|
|
855
855
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
856
856
|
/**
|
|
857
857
|
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A null
|
|
858
858
|
* value indicates that it can be started immediately.
|
|
859
859
|
*
|
|
860
|
-
* @see {@link MatterSpecification.
|
|
860
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.5
|
|
861
861
|
*/
|
|
862
862
|
earliestStartTime: import("../tlv/TlvObject.js").OptionalFieldType<number | null>;
|
|
863
863
|
/**
|
|
@@ -866,7 +866,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
866
866
|
* e.g. for an EVSE charging session, this may indicate the departure time for the vehicle, by which time the
|
|
867
867
|
* charging session must end.
|
|
868
868
|
*
|
|
869
|
-
* @see {@link MatterSpecification.
|
|
869
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.6
|
|
870
870
|
*/
|
|
871
871
|
latestEndTime: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
872
872
|
/**
|
|
@@ -874,7 +874,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
874
874
|
* this flag and if it is false, then none of the slots contain SlotIsPausable set to true. This can save a
|
|
875
875
|
* client from having to check each slot in the list.
|
|
876
876
|
*
|
|
877
|
-
* @see {@link MatterSpecification.
|
|
877
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.7
|
|
878
878
|
*/
|
|
879
879
|
isPausable: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
880
880
|
/**
|
|
@@ -882,25 +882,25 @@ export declare namespace DeviceEnergyManagement {
|
|
|
882
882
|
*
|
|
883
883
|
* It shall contain at least 1 entry, and a maximum of 10.
|
|
884
884
|
*
|
|
885
|
-
* @see {@link MatterSpecification.
|
|
885
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.8
|
|
886
886
|
*/
|
|
887
887
|
slots: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
888
888
|
/**
|
|
889
889
|
* This field shall indicate the minimum time (in seconds) that the appliance expects to be in this slot for.
|
|
890
890
|
*
|
|
891
|
-
* @see {@link MatterSpecification.
|
|
891
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.1
|
|
892
892
|
*/
|
|
893
893
|
minDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
894
894
|
/**
|
|
895
895
|
* This field shall indicate the maximum time (in seconds) that the appliance expects to be in this slot for.
|
|
896
896
|
*
|
|
897
|
-
* @see {@link MatterSpecification.
|
|
897
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.2
|
|
898
898
|
*/
|
|
899
899
|
maxDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
900
900
|
/**
|
|
901
901
|
* This field shall indicate the expected time (in seconds) that the appliance expects to be in this slot for.
|
|
902
902
|
*
|
|
903
|
-
* @see {@link MatterSpecification.
|
|
903
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.3
|
|
904
904
|
*/
|
|
905
905
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
906
906
|
/**
|
|
@@ -913,7 +913,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
913
913
|
*
|
|
914
914
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
915
915
|
*
|
|
916
|
-
* @see {@link MatterSpecification.
|
|
916
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.4
|
|
917
917
|
*/
|
|
918
918
|
elapsedSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
919
919
|
/**
|
|
@@ -929,13 +929,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
929
929
|
*
|
|
930
930
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
931
931
|
*
|
|
932
|
-
* @see {@link MatterSpecification.
|
|
932
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.5
|
|
933
933
|
*/
|
|
934
934
|
remainingSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
935
935
|
/**
|
|
936
936
|
* This field shall indicate whether this slot can be paused.
|
|
937
937
|
*
|
|
938
|
-
* @see {@link MatterSpecification.
|
|
938
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.6
|
|
939
939
|
*/
|
|
940
940
|
slotIsPausable: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
941
941
|
/**
|
|
@@ -943,13 +943,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
943
943
|
* controllers trying to pause ESAs for short periods and then resuming operation in a cyclic fashion which may
|
|
944
944
|
* damage or cause excess energy to be consumed with restarting of an operation.
|
|
945
945
|
*
|
|
946
|
-
* @see {@link MatterSpecification.
|
|
946
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.7
|
|
947
947
|
*/
|
|
948
948
|
minPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
949
949
|
/**
|
|
950
950
|
* This field shall indicate the longest period that the slot can be paused for.
|
|
951
951
|
*
|
|
952
|
-
* @see {@link MatterSpecification.
|
|
952
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.8
|
|
953
953
|
*/
|
|
954
954
|
maxPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
955
955
|
/**
|
|
@@ -972,7 +972,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
972
972
|
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
973
973
|
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
974
974
|
*
|
|
975
|
-
* @see {@link MatterSpecification.
|
|
975
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.9
|
|
976
976
|
*/
|
|
977
977
|
manufacturerEsaState: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
978
978
|
/**
|
|
@@ -980,7 +980,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
980
980
|
* considered the average value over the slot, and some variation from this would be expected (for example, as
|
|
981
981
|
* it is ramping up).
|
|
982
982
|
*
|
|
983
|
-
* @see {@link MatterSpecification.
|
|
983
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.10
|
|
984
984
|
*/
|
|
985
985
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
986
986
|
/**
|
|
@@ -989,7 +989,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
989
989
|
*
|
|
990
990
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
991
991
|
*
|
|
992
|
-
* @see {@link MatterSpecification.
|
|
992
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.11
|
|
993
993
|
*/
|
|
994
994
|
minPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
995
995
|
/**
|
|
@@ -998,7 +998,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
998
998
|
*
|
|
999
999
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
1000
1000
|
*
|
|
1001
|
-
* @see {@link MatterSpecification.
|
|
1001
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.12
|
|
1002
1002
|
*/
|
|
1003
1003
|
maxPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1004
1004
|
/**
|
|
@@ -1006,7 +1006,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1006
1006
|
*
|
|
1007
1007
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative energy.
|
|
1008
1008
|
*
|
|
1009
|
-
* @see {@link MatterSpecification.
|
|
1009
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.13
|
|
1010
1010
|
*/
|
|
1011
1011
|
nominalEnergy: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1012
1012
|
/**
|
|
@@ -1029,13 +1029,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1029
1029
|
* If the ESA cannot calculate its cost for any reason (such as losing its connection to a Price server) it may
|
|
1030
1030
|
* omit this field. This is treated as extra meta data that an EMS may use to optimize a system.
|
|
1031
1031
|
*
|
|
1032
|
-
* @see {@link MatterSpecification.
|
|
1032
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.14
|
|
1033
1033
|
*/
|
|
1034
1034
|
costs: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1035
1035
|
/**
|
|
1036
1036
|
* This field shall indicate the type of cost being represented (see CostTypeEnum).
|
|
1037
1037
|
*
|
|
1038
|
-
* @see {@link MatterSpecification.
|
|
1038
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.1
|
|
1039
1039
|
*/
|
|
1040
1040
|
costType: import("../tlv/TlvObject.js").FieldType<CostType>;
|
|
1041
1041
|
/**
|
|
@@ -1044,14 +1044,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1044
1044
|
*
|
|
1045
1045
|
* For example, if the Value was -302 and DecimalPoints was 2, then this would represent a benefit of 3.02.
|
|
1046
1046
|
*
|
|
1047
|
-
* @see {@link MatterSpecification.
|
|
1047
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.2
|
|
1048
1048
|
*/
|
|
1049
1049
|
value: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1050
1050
|
/**
|
|
1051
1051
|
* This field shall indicate the number of digits to the right of the decimal point in the Value field. For
|
|
1052
1052
|
* example, if the Value was 102 and DecimalPoints was 2, then this would represent a cost of 1.02.
|
|
1053
1053
|
*
|
|
1054
|
-
* @see {@link MatterSpecification.
|
|
1054
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.3
|
|
1055
1055
|
*/
|
|
1056
1056
|
decimalPoints: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1057
1057
|
/**
|
|
@@ -1060,7 +1060,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1060
1060
|
*
|
|
1061
1061
|
* This is an optional field. It shall be included if CostType is Financial.
|
|
1062
1062
|
*
|
|
1063
|
-
* @see {@link MatterSpecification.
|
|
1063
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.4
|
|
1064
1064
|
*/
|
|
1065
1065
|
currency: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1066
1066
|
}>[]>;
|
|
@@ -1071,7 +1071,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1071
1071
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
1072
1072
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
1073
1073
|
*
|
|
1074
|
-
* @see {@link MatterSpecification.
|
|
1074
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.15
|
|
1075
1075
|
*/
|
|
1076
1076
|
minPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1077
1077
|
/**
|
|
@@ -1081,7 +1081,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1081
1081
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
1082
1082
|
* indicate it could be switched on to charge, but this would be the maximum power limit it can be set to.
|
|
1083
1083
|
*
|
|
1084
|
-
* @see {@link MatterSpecification.
|
|
1084
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.16
|
|
1085
1085
|
*/
|
|
1086
1086
|
maxPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1087
1087
|
/**
|
|
@@ -1093,7 +1093,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1093
1093
|
*
|
|
1094
1094
|
* For example, a heat pump compressor may have a minimum cycle time of order a few minutes.
|
|
1095
1095
|
*
|
|
1096
|
-
* @see {@link MatterSpecification.
|
|
1096
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.17
|
|
1097
1097
|
*/
|
|
1098
1098
|
minDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1099
1099
|
/**
|
|
@@ -1105,14 +1105,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1105
1105
|
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
1106
1106
|
* MaxPowerAdjustment power level).
|
|
1107
1107
|
*
|
|
1108
|
-
* @see {@link MatterSpecification.
|
|
1108
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.18
|
|
1109
1109
|
*/
|
|
1110
1110
|
maxDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1111
1111
|
}>[]>;
|
|
1112
1112
|
/**
|
|
1113
1113
|
* This field shall contain the reason the current Forecast was generated.
|
|
1114
1114
|
*
|
|
1115
|
-
* @see {@link MatterSpecification.
|
|
1115
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.9
|
|
1116
1116
|
*/
|
|
1117
1117
|
forecastUpdateReason: import("../tlv/TlvObject.js").FieldType<ForecastUpdateReason>;
|
|
1118
1118
|
}>;
|
|
@@ -1125,12 +1125,12 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1125
1125
|
*
|
|
1126
1126
|
* feature and instead report its internal state.
|
|
1127
1127
|
*
|
|
1128
|
-
* @see {@link MatterSpecification.
|
|
1128
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13
|
|
1129
1129
|
*/
|
|
1130
1130
|
interface Forecast extends TypeFromSchema<typeof TlvForecast> {
|
|
1131
1131
|
}
|
|
1132
1132
|
/**
|
|
1133
|
-
* @see {@link MatterSpecification.
|
|
1133
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.4
|
|
1134
1134
|
*/
|
|
1135
1135
|
enum OptOutState {
|
|
1136
1136
|
/**
|
|
@@ -1153,7 +1153,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1153
1153
|
/**
|
|
1154
1154
|
* Input to the DeviceEnergyManagement pauseRequest command
|
|
1155
1155
|
*
|
|
1156
|
-
* @see {@link MatterSpecification.
|
|
1156
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4
|
|
1157
1157
|
*/
|
|
1158
1158
|
const TlvPauseRequest: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
1159
1159
|
/**
|
|
@@ -1161,47 +1161,47 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1161
1161
|
* MinPauseDuration and MaxPauseDuration indicated in the ActiveSlotNumber index in the Slots list in the
|
|
1162
1162
|
* Forecast.
|
|
1163
1163
|
*
|
|
1164
|
-
* @see {@link MatterSpecification.
|
|
1164
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4.1
|
|
1165
1165
|
*/
|
|
1166
1166
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1167
1167
|
/**
|
|
1168
1168
|
* This field shall indicate the cause of the request from the EMS.
|
|
1169
1169
|
*
|
|
1170
|
-
* @see {@link MatterSpecification.
|
|
1170
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4.2
|
|
1171
1171
|
*/
|
|
1172
1172
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
1173
1173
|
}>;
|
|
1174
1174
|
/**
|
|
1175
1175
|
* Input to the DeviceEnergyManagement pauseRequest command
|
|
1176
1176
|
*
|
|
1177
|
-
* @see {@link MatterSpecification.
|
|
1177
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4
|
|
1178
1178
|
*/
|
|
1179
1179
|
interface PauseRequest extends TypeFromSchema<typeof TlvPauseRequest> {
|
|
1180
1180
|
}
|
|
1181
1181
|
/**
|
|
1182
1182
|
* Body of the DeviceEnergyManagement resumed event
|
|
1183
1183
|
*
|
|
1184
|
-
* @see {@link MatterSpecification.
|
|
1184
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.4
|
|
1185
1185
|
*/
|
|
1186
1186
|
const TlvResumedEvent: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
1187
1187
|
/**
|
|
1188
1188
|
* This field shall indicate the reason why the pause ended.
|
|
1189
1189
|
*
|
|
1190
|
-
* @see {@link MatterSpecification.
|
|
1190
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.4.1
|
|
1191
1191
|
*/
|
|
1192
1192
|
cause: import("../tlv/TlvObject.js").FieldType<Cause>;
|
|
1193
1193
|
}>;
|
|
1194
1194
|
/**
|
|
1195
1195
|
* Body of the DeviceEnergyManagement resumed event
|
|
1196
1196
|
*
|
|
1197
|
-
* @see {@link MatterSpecification.
|
|
1197
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.4
|
|
1198
1198
|
*/
|
|
1199
1199
|
interface ResumedEvent extends TypeFromSchema<typeof TlvResumedEvent> {
|
|
1200
1200
|
}
|
|
1201
1201
|
/**
|
|
1202
1202
|
* Input to the DeviceEnergyManagement startTimeAdjustRequest command
|
|
1203
1203
|
*
|
|
1204
|
-
* @see {@link MatterSpecification.
|
|
1204
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3
|
|
1205
1205
|
*/
|
|
1206
1206
|
const TlvStartTimeAdjustRequest: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
1207
1207
|
/**
|
|
@@ -1214,25 +1214,25 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1214
1214
|
* This value shall be after the EarliestStartTime in the Forecast attribute. The new EndTime, that can be
|
|
1215
1215
|
* computed from the RequestedStartTime and the Forecast sequence duration, shall be before the LatestEndTime.
|
|
1216
1216
|
*
|
|
1217
|
-
* @see {@link MatterSpecification.
|
|
1217
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3.1
|
|
1218
1218
|
*/
|
|
1219
1219
|
requestedStartTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1220
1220
|
/**
|
|
1221
1221
|
* This field shall indicate the cause of the request from the EMS.
|
|
1222
1222
|
*
|
|
1223
|
-
* @see {@link MatterSpecification.
|
|
1223
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3.2
|
|
1224
1224
|
*/
|
|
1225
1225
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
1226
1226
|
}>;
|
|
1227
1227
|
/**
|
|
1228
1228
|
* Input to the DeviceEnergyManagement startTimeAdjustRequest command
|
|
1229
1229
|
*
|
|
1230
|
-
* @see {@link MatterSpecification.
|
|
1230
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3
|
|
1231
1231
|
*/
|
|
1232
1232
|
interface StartTimeAdjustRequest extends TypeFromSchema<typeof TlvStartTimeAdjustRequest> {
|
|
1233
1233
|
}
|
|
1234
1234
|
/**
|
|
1235
|
-
* @see {@link MatterSpecification.
|
|
1235
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15
|
|
1236
1236
|
*/
|
|
1237
1237
|
const TlvSlotAdjustment: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
1238
1238
|
/**
|
|
@@ -1240,7 +1240,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1240
1240
|
* be less than the actual length of the Slots list (implicitly it must be in the range 0 to 9 based on the
|
|
1241
1241
|
* maximum length of the Slots list constraint).
|
|
1242
1242
|
*
|
|
1243
|
-
* @see {@link MatterSpecification.
|
|
1243
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.1
|
|
1244
1244
|
*/
|
|
1245
1245
|
slotIndex: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1246
1246
|
/**
|
|
@@ -1250,7 +1250,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1250
1250
|
* This is a signed value and can be used to indicate charging or discharging. If the ESA does NOT support PFR
|
|
1251
1251
|
* this value shall be ignored by the ESA.
|
|
1252
1252
|
*
|
|
1253
|
-
* @see {@link MatterSpecification.
|
|
1253
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.2
|
|
1254
1254
|
*/
|
|
1255
1255
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1256
1256
|
/**
|
|
@@ -1258,32 +1258,32 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1258
1258
|
* slot duration to. It MUST be between the MinDurationAdjustment and MaxDurationAdjustment for the slot as
|
|
1259
1259
|
* advertised by the ESA.
|
|
1260
1260
|
*
|
|
1261
|
-
* @see {@link MatterSpecification.
|
|
1261
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.3
|
|
1262
1262
|
*/
|
|
1263
1263
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1264
1264
|
}>;
|
|
1265
1265
|
/**
|
|
1266
|
-
* @see {@link MatterSpecification.
|
|
1266
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15
|
|
1267
1267
|
*/
|
|
1268
1268
|
interface SlotAdjustment extends TypeFromSchema<typeof TlvSlotAdjustment> {
|
|
1269
1269
|
}
|
|
1270
1270
|
/**
|
|
1271
1271
|
* Input to the DeviceEnergyManagement modifyForecastRequest command
|
|
1272
1272
|
*
|
|
1273
|
-
* @see {@link MatterSpecification.
|
|
1273
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6
|
|
1274
1274
|
*/
|
|
1275
1275
|
const TlvModifyForecastRequest: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
1276
1276
|
/**
|
|
1277
1277
|
* This field shall indicate the ForecastID that is to be modified.
|
|
1278
1278
|
*
|
|
1279
|
-
* @see {@link MatterSpecification.
|
|
1279
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.1
|
|
1280
1280
|
*/
|
|
1281
1281
|
forecastId: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1282
1282
|
/**
|
|
1283
1283
|
* This field shall contain a list of SlotAdjustment parameters that should be modified in the corresponding
|
|
1284
1284
|
* Forecast with matching ForecastID.
|
|
1285
1285
|
*
|
|
1286
|
-
* @see {@link MatterSpecification.
|
|
1286
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.2
|
|
1287
1287
|
*/
|
|
1288
1288
|
slotAdjustments: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1289
1289
|
/**
|
|
@@ -1291,7 +1291,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1291
1291
|
* be less than the actual length of the Slots list (implicitly it must be in the range 0 to 9 based on the
|
|
1292
1292
|
* maximum length of the Slots list constraint).
|
|
1293
1293
|
*
|
|
1294
|
-
* @see {@link MatterSpecification.
|
|
1294
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.1
|
|
1295
1295
|
*/
|
|
1296
1296
|
slotIndex: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1297
1297
|
/**
|
|
@@ -1301,7 +1301,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1301
1301
|
* This is a signed value and can be used to indicate charging or discharging. If the ESA does NOT support PFR
|
|
1302
1302
|
* this value shall be ignored by the ESA.
|
|
1303
1303
|
*
|
|
1304
|
-
* @see {@link MatterSpecification.
|
|
1304
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.2
|
|
1305
1305
|
*/
|
|
1306
1306
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1307
1307
|
/**
|
|
@@ -1309,21 +1309,21 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1309
1309
|
* slot duration to. It MUST be between the MinDurationAdjustment and MaxDurationAdjustment for the slot as
|
|
1310
1310
|
* advertised by the ESA.
|
|
1311
1311
|
*
|
|
1312
|
-
* @see {@link MatterSpecification.
|
|
1312
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.3
|
|
1313
1313
|
*/
|
|
1314
1314
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1315
1315
|
}>[]>;
|
|
1316
1316
|
/**
|
|
1317
1317
|
* This field shall indicate the cause of the request from the EMS.
|
|
1318
1318
|
*
|
|
1319
|
-
* @see {@link MatterSpecification.
|
|
1319
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.3
|
|
1320
1320
|
*/
|
|
1321
1321
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
1322
1322
|
}>;
|
|
1323
1323
|
/**
|
|
1324
1324
|
* Input to the DeviceEnergyManagement modifyForecastRequest command
|
|
1325
1325
|
*
|
|
1326
|
-
* @see {@link MatterSpecification.
|
|
1326
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6
|
|
1327
1327
|
*/
|
|
1328
1328
|
interface ModifyForecastRequest extends TypeFromSchema<typeof TlvModifyForecastRequest> {
|
|
1329
1329
|
}
|
|
@@ -1332,7 +1332,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1332
1332
|
* perhaps excess solar PV). The format allows the client to suggest that the ESA can either turn up its energy
|
|
1333
1333
|
* consumption, or turn down its energy consumption during this period.
|
|
1334
1334
|
*
|
|
1335
|
-
* @see {@link MatterSpecification.
|
|
1335
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16
|
|
1336
1336
|
*/
|
|
1337
1337
|
const TlvConstraints: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
1338
1338
|
/**
|
|
@@ -1341,13 +1341,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1341
1341
|
*
|
|
1342
1342
|
* This value is in UTC and MUST be in the future.
|
|
1343
1343
|
*
|
|
1344
|
-
* @see {@link MatterSpecification.
|
|
1344
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.1
|
|
1345
1345
|
*/
|
|
1346
1346
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1347
1347
|
/**
|
|
1348
1348
|
* This field shall indicate the duration of the constraint in seconds.
|
|
1349
1349
|
*
|
|
1350
|
-
* @see {@link MatterSpecification.
|
|
1350
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.2
|
|
1351
1351
|
*/
|
|
1352
1352
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1353
1353
|
/**
|
|
@@ -1357,7 +1357,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1357
1357
|
*
|
|
1358
1358
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
1359
1359
|
*
|
|
1360
|
-
* @see {@link MatterSpecification.
|
|
1360
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.3
|
|
1361
1361
|
*/
|
|
1362
1362
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1363
1363
|
/**
|
|
@@ -1366,7 +1366,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1366
1366
|
*
|
|
1367
1367
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
1368
1368
|
*
|
|
1369
|
-
* @see {@link MatterSpecification.
|
|
1369
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.4
|
|
1370
1370
|
*/
|
|
1371
1371
|
maximumEnergy: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1372
1372
|
/**
|
|
@@ -1379,7 +1379,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1379
1379
|
*
|
|
1380
1380
|
* Note that the mapping between values and operation is manufacturer specific.
|
|
1381
1381
|
*
|
|
1382
|
-
* @see {@link MatterSpecification.
|
|
1382
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.5
|
|
1383
1383
|
*/
|
|
1384
1384
|
loadControl: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1385
1385
|
}>;
|
|
@@ -1388,14 +1388,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1388
1388
|
* perhaps excess solar PV). The format allows the client to suggest that the ESA can either turn up its energy
|
|
1389
1389
|
* consumption, or turn down its energy consumption during this period.
|
|
1390
1390
|
*
|
|
1391
|
-
* @see {@link MatterSpecification.
|
|
1391
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16
|
|
1392
1392
|
*/
|
|
1393
1393
|
interface Constraints extends TypeFromSchema<typeof TlvConstraints> {
|
|
1394
1394
|
}
|
|
1395
1395
|
/**
|
|
1396
1396
|
* Input to the DeviceEnergyManagement requestConstraintBasedForecast command
|
|
1397
1397
|
*
|
|
1398
|
-
* @see {@link MatterSpecification.
|
|
1398
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7
|
|
1399
1399
|
*/
|
|
1400
1400
|
const TlvRequestConstraintBasedForecastRequest: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
1401
1401
|
/**
|
|
@@ -1414,7 +1414,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1414
1414
|
*
|
|
1415
1415
|
* trol field as follows:
|
|
1416
1416
|
*
|
|
1417
|
-
* @see {@link MatterSpecification.
|
|
1417
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7.1
|
|
1418
1418
|
*/
|
|
1419
1419
|
constraints: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1420
1420
|
/**
|
|
@@ -1423,13 +1423,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1423
1423
|
*
|
|
1424
1424
|
* This value is in UTC and MUST be in the future.
|
|
1425
1425
|
*
|
|
1426
|
-
* @see {@link MatterSpecification.
|
|
1426
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.1
|
|
1427
1427
|
*/
|
|
1428
1428
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1429
1429
|
/**
|
|
1430
1430
|
* This field shall indicate the duration of the constraint in seconds.
|
|
1431
1431
|
*
|
|
1432
|
-
* @see {@link MatterSpecification.
|
|
1432
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.2
|
|
1433
1433
|
*/
|
|
1434
1434
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1435
1435
|
/**
|
|
@@ -1439,7 +1439,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1439
1439
|
*
|
|
1440
1440
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
1441
1441
|
*
|
|
1442
|
-
* @see {@link MatterSpecification.
|
|
1442
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.3
|
|
1443
1443
|
*/
|
|
1444
1444
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1445
1445
|
/**
|
|
@@ -1448,7 +1448,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1448
1448
|
*
|
|
1449
1449
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
1450
1450
|
*
|
|
1451
|
-
* @see {@link MatterSpecification.
|
|
1451
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.4
|
|
1452
1452
|
*/
|
|
1453
1453
|
maximumEnergy: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1454
1454
|
/**
|
|
@@ -1461,26 +1461,26 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1461
1461
|
*
|
|
1462
1462
|
* Note that the mapping between values and operation is manufacturer specific.
|
|
1463
1463
|
*
|
|
1464
|
-
* @see {@link MatterSpecification.
|
|
1464
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.5
|
|
1465
1465
|
*/
|
|
1466
1466
|
loadControl: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1467
1467
|
}>[]>;
|
|
1468
1468
|
/**
|
|
1469
1469
|
* This field shall indicate the cause of the request from the EMS.
|
|
1470
1470
|
*
|
|
1471
|
-
* @see {@link MatterSpecification.
|
|
1471
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7.2
|
|
1472
1472
|
*/
|
|
1473
1473
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
1474
1474
|
}>;
|
|
1475
1475
|
/**
|
|
1476
1476
|
* Input to the DeviceEnergyManagement requestConstraintBasedForecast command
|
|
1477
1477
|
*
|
|
1478
|
-
* @see {@link MatterSpecification.
|
|
1478
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7
|
|
1479
1479
|
*/
|
|
1480
1480
|
interface RequestConstraintBasedForecastRequest extends TypeFromSchema<typeof TlvRequestConstraintBasedForecastRequest> {
|
|
1481
1481
|
}
|
|
1482
1482
|
/**
|
|
1483
|
-
* @see {@link MatterSpecification.
|
|
1483
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.2
|
|
1484
1484
|
*/
|
|
1485
1485
|
enum EsaType {
|
|
1486
1486
|
/**
|
|
@@ -1545,7 +1545,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1545
1545
|
Other = 255
|
|
1546
1546
|
}
|
|
1547
1547
|
/**
|
|
1548
|
-
* @see {@link MatterSpecification.
|
|
1548
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.3
|
|
1549
1549
|
*/
|
|
1550
1550
|
enum EsaState {
|
|
1551
1551
|
/**
|
|
@@ -1589,7 +1589,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1589
1589
|
*
|
|
1590
1590
|
* • When it changes from null to any other value and vice versa.
|
|
1591
1591
|
*
|
|
1592
|
-
* @see {@link MatterSpecification.
|
|
1592
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.6
|
|
1593
1593
|
*/
|
|
1594
1594
|
readonly powerAdjustmentCapability: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1595
1595
|
/**
|
|
@@ -1608,7 +1608,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1608
1608
|
*
|
|
1609
1609
|
* In this example the list of PowerAdjustStructs allows multiple scenarios to be offered as follows:
|
|
1610
1610
|
*
|
|
1611
|
-
* @see {@link MatterSpecification.
|
|
1611
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.12
|
|
1612
1612
|
*/
|
|
1613
1613
|
powerAdjustCapability: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1614
1614
|
/**
|
|
@@ -1617,7 +1617,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1617
1617
|
* Note that this is a signed value. Negative values indicate power flows out of the node (e.g. discharging a
|
|
1618
1618
|
* battery).
|
|
1619
1619
|
*
|
|
1620
|
-
* @see {@link MatterSpecification.
|
|
1620
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.1
|
|
1621
1621
|
*/
|
|
1622
1622
|
minPower: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
1623
1623
|
/**
|
|
@@ -1636,7 +1636,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1636
1636
|
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W. Here
|
|
1637
1637
|
* power is flowing into the node when charging. As such the MinPower becomes 0W and MaxPower becomes 2000W.
|
|
1638
1638
|
*
|
|
1639
|
-
* @see {@link MatterSpecification.
|
|
1639
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.2
|
|
1640
1640
|
*/
|
|
1641
1641
|
maxPower: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
1642
1642
|
/**
|
|
@@ -1644,7 +1644,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1644
1644
|
* adjustment. Manufacturers may use this to as an anti-cycling capability to avoid controllers from rapidly
|
|
1645
1645
|
* making power adjustments.
|
|
1646
1646
|
*
|
|
1647
|
-
* @see {@link MatterSpecification.
|
|
1647
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.3
|
|
1648
1648
|
*/
|
|
1649
1649
|
minDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1650
1650
|
/**
|
|
@@ -1652,7 +1652,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1652
1652
|
* adjustment. Manufacturers may use this to protect the user experience, to avoid over heating of the ESA,
|
|
1653
1653
|
* ensuring that there is sufficient headroom to use or store energy in the ESA or for any other reason.
|
|
1654
1654
|
*
|
|
1655
|
-
* @see {@link MatterSpecification.
|
|
1655
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.4
|
|
1656
1656
|
*/
|
|
1657
1657
|
maxDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1658
1658
|
}>[] | null>;
|
|
@@ -1663,7 +1663,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1663
1663
|
/**
|
|
1664
1664
|
* Allows a client to request an adjustment in the power consumption of an ESA for a specified duration.
|
|
1665
1665
|
*
|
|
1666
|
-
* @see {@link MatterSpecification.
|
|
1666
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1
|
|
1667
1667
|
*/
|
|
1668
1668
|
readonly powerAdjustRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1669
1669
|
/**
|
|
@@ -1672,7 +1672,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1672
1672
|
* This value shall be between the MinPower and MaxPower fields of the PowerAdjustStruct in the
|
|
1673
1673
|
* PowerAdjustmentCapability attribute.
|
|
1674
1674
|
*
|
|
1675
|
-
* @see {@link MatterSpecification.
|
|
1675
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.1
|
|
1676
1676
|
*/
|
|
1677
1677
|
power: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
1678
1678
|
/**
|
|
@@ -1681,20 +1681,20 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1681
1681
|
* This value shall be between the MinDuration and MaxDuration fields of the PowerAdjustStruct in the
|
|
1682
1682
|
* PowerAdjustmentCapability attribute.
|
|
1683
1683
|
*
|
|
1684
|
-
* @see {@link MatterSpecification.
|
|
1684
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.2
|
|
1685
1685
|
*/
|
|
1686
1686
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1687
1687
|
/**
|
|
1688
1688
|
* This field shall indicate the cause of the request from the EMS.
|
|
1689
1689
|
*
|
|
1690
|
-
* @see {@link MatterSpecification.
|
|
1690
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.3
|
|
1691
1691
|
*/
|
|
1692
1692
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
1693
1693
|
}>, void, any>;
|
|
1694
1694
|
/**
|
|
1695
1695
|
* Allows a client to cancel an ongoing PowerAdjustmentRequest operation.
|
|
1696
1696
|
*
|
|
1697
|
-
* @see {@link MatterSpecification.
|
|
1697
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.2
|
|
1698
1698
|
*/
|
|
1699
1699
|
readonly cancelPowerAdjustRequest: Command<void, void, any>;
|
|
1700
1700
|
};
|
|
@@ -1702,25 +1702,25 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1702
1702
|
/**
|
|
1703
1703
|
* This event shall be generated when the Power Adjustment session is started.
|
|
1704
1704
|
*
|
|
1705
|
-
* @see {@link MatterSpecification.
|
|
1705
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.1
|
|
1706
1706
|
*/
|
|
1707
1707
|
readonly powerAdjustStart: Event<void, any>;
|
|
1708
1708
|
/**
|
|
1709
1709
|
* This event shall be generated when the Power Adjustment session ends.
|
|
1710
1710
|
*
|
|
1711
|
-
* @see {@link MatterSpecification.
|
|
1711
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2
|
|
1712
1712
|
*/
|
|
1713
1713
|
readonly powerAdjustEnd: Event<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1714
1714
|
/**
|
|
1715
1715
|
* This field shall indicate the reason why the power adjustment session ended.
|
|
1716
1716
|
*
|
|
1717
|
-
* @see {@link MatterSpecification.
|
|
1717
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.1
|
|
1718
1718
|
*/
|
|
1719
1719
|
cause: import("../tlv/TlvObject.js").FieldType<Cause>;
|
|
1720
1720
|
/**
|
|
1721
1721
|
* This field shall indicate the number of seconds that the power adjustment session lasted before ending.
|
|
1722
1722
|
*
|
|
1723
|
-
* @see {@link MatterSpecification.
|
|
1723
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.2
|
|
1724
1724
|
*/
|
|
1725
1725
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1726
1726
|
/**
|
|
@@ -1730,7 +1730,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1730
1730
|
* battery inverter that was requested to discharge it would have a negative EnergyUse value. If this was a
|
|
1731
1731
|
* normal load that was turned on, then it will have positive value.
|
|
1732
1732
|
*
|
|
1733
|
-
* @see {@link MatterSpecification.
|
|
1733
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.3
|
|
1734
1734
|
*/
|
|
1735
1735
|
energyUse: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
1736
1736
|
}>, any>;
|
|
@@ -1763,7 +1763,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1763
1763
|
* • As a result of a change in the opt-out status which in turn may cause the ESA to recalculate its
|
|
1764
1764
|
* forecast.
|
|
1765
1765
|
*
|
|
1766
|
-
* @see {@link MatterSpecification.
|
|
1766
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.7
|
|
1767
1767
|
*/
|
|
1768
1768
|
readonly forecast: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1769
1769
|
/**
|
|
@@ -1776,33 +1776,33 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1776
1776
|
*
|
|
1777
1777
|
* The value of ForecastID is allowed to wrap.
|
|
1778
1778
|
*
|
|
1779
|
-
* @see {@link MatterSpecification.
|
|
1779
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.1
|
|
1780
1780
|
*/
|
|
1781
1781
|
forecastId: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1782
1782
|
/**
|
|
1783
1783
|
* This field shall indicate which element of the Slots list is currently active in the Forecast sequence. A
|
|
1784
1784
|
* null value indicates that the sequence has not yet started.
|
|
1785
1785
|
*
|
|
1786
|
-
* @see {@link MatterSpecification.
|
|
1786
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.2
|
|
1787
1787
|
*/
|
|
1788
1788
|
activeSlotNumber: import("../tlv/TlvObject.js").FieldType<number | null>;
|
|
1789
1789
|
/**
|
|
1790
1790
|
* This field shall indicate the planned start time, in UTC, for the entire Forecast.
|
|
1791
1791
|
*
|
|
1792
|
-
* @see {@link MatterSpecification.
|
|
1792
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.3
|
|
1793
1793
|
*/
|
|
1794
1794
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1795
1795
|
/**
|
|
1796
1796
|
* This field shall indicate the planned end time, in UTC, for the entire Forecast.
|
|
1797
1797
|
*
|
|
1798
|
-
* @see {@link MatterSpecification.
|
|
1798
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.4
|
|
1799
1799
|
*/
|
|
1800
1800
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1801
1801
|
/**
|
|
1802
1802
|
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A null
|
|
1803
1803
|
* value indicates that it can be started immediately.
|
|
1804
1804
|
*
|
|
1805
|
-
* @see {@link MatterSpecification.
|
|
1805
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.5
|
|
1806
1806
|
*/
|
|
1807
1807
|
earliestStartTime: import("../tlv/TlvObject.js").OptionalFieldType<number | null>;
|
|
1808
1808
|
/**
|
|
@@ -1811,7 +1811,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1811
1811
|
* e.g. for an EVSE charging session, this may indicate the departure time for the vehicle, by which time the
|
|
1812
1812
|
* charging session must end.
|
|
1813
1813
|
*
|
|
1814
|
-
* @see {@link MatterSpecification.
|
|
1814
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.6
|
|
1815
1815
|
*/
|
|
1816
1816
|
latestEndTime: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1817
1817
|
/**
|
|
@@ -1819,7 +1819,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1819
1819
|
* this flag and if it is false, then none of the slots contain SlotIsPausable set to true. This can save a
|
|
1820
1820
|
* client from having to check each slot in the list.
|
|
1821
1821
|
*
|
|
1822
|
-
* @see {@link MatterSpecification.
|
|
1822
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.7
|
|
1823
1823
|
*/
|
|
1824
1824
|
isPausable: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
1825
1825
|
/**
|
|
@@ -1827,25 +1827,25 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1827
1827
|
*
|
|
1828
1828
|
* It shall contain at least 1 entry, and a maximum of 10.
|
|
1829
1829
|
*
|
|
1830
|
-
* @see {@link MatterSpecification.
|
|
1830
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.8
|
|
1831
1831
|
*/
|
|
1832
1832
|
slots: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1833
1833
|
/**
|
|
1834
1834
|
* This field shall indicate the minimum time (in seconds) that the appliance expects to be in this slot for.
|
|
1835
1835
|
*
|
|
1836
|
-
* @see {@link MatterSpecification.
|
|
1836
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.1
|
|
1837
1837
|
*/
|
|
1838
1838
|
minDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1839
1839
|
/**
|
|
1840
1840
|
* This field shall indicate the maximum time (in seconds) that the appliance expects to be in this slot for.
|
|
1841
1841
|
*
|
|
1842
|
-
* @see {@link MatterSpecification.
|
|
1842
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.2
|
|
1843
1843
|
*/
|
|
1844
1844
|
maxDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1845
1845
|
/**
|
|
1846
1846
|
* This field shall indicate the expected time (in seconds) that the appliance expects to be in this slot for.
|
|
1847
1847
|
*
|
|
1848
|
-
* @see {@link MatterSpecification.
|
|
1848
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.3
|
|
1849
1849
|
*/
|
|
1850
1850
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1851
1851
|
/**
|
|
@@ -1858,7 +1858,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1858
1858
|
*
|
|
1859
1859
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
1860
1860
|
*
|
|
1861
|
-
* @see {@link MatterSpecification.
|
|
1861
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.4
|
|
1862
1862
|
*/
|
|
1863
1863
|
elapsedSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1864
1864
|
/**
|
|
@@ -1874,13 +1874,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1874
1874
|
*
|
|
1875
1875
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
1876
1876
|
*
|
|
1877
|
-
* @see {@link MatterSpecification.
|
|
1877
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.5
|
|
1878
1878
|
*/
|
|
1879
1879
|
remainingSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1880
1880
|
/**
|
|
1881
1881
|
* This field shall indicate whether this slot can be paused.
|
|
1882
1882
|
*
|
|
1883
|
-
* @see {@link MatterSpecification.
|
|
1883
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.6
|
|
1884
1884
|
*/
|
|
1885
1885
|
slotIsPausable: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
1886
1886
|
/**
|
|
@@ -1888,13 +1888,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1888
1888
|
* controllers trying to pause ESAs for short periods and then resuming operation in a cyclic fashion which may
|
|
1889
1889
|
* damage or cause excess energy to be consumed with restarting of an operation.
|
|
1890
1890
|
*
|
|
1891
|
-
* @see {@link MatterSpecification.
|
|
1891
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.7
|
|
1892
1892
|
*/
|
|
1893
1893
|
minPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1894
1894
|
/**
|
|
1895
1895
|
* This field shall indicate the longest period that the slot can be paused for.
|
|
1896
1896
|
*
|
|
1897
|
-
* @see {@link MatterSpecification.
|
|
1897
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.8
|
|
1898
1898
|
*/
|
|
1899
1899
|
maxPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1900
1900
|
/**
|
|
@@ -1917,7 +1917,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1917
1917
|
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
1918
1918
|
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
1919
1919
|
*
|
|
1920
|
-
* @see {@link MatterSpecification.
|
|
1920
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.9
|
|
1921
1921
|
*/
|
|
1922
1922
|
manufacturerEsaState: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1923
1923
|
/**
|
|
@@ -1925,7 +1925,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1925
1925
|
* considered the average value over the slot, and some variation from this would be expected (for example, as
|
|
1926
1926
|
* it is ramping up).
|
|
1927
1927
|
*
|
|
1928
|
-
* @see {@link MatterSpecification.
|
|
1928
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.10
|
|
1929
1929
|
*/
|
|
1930
1930
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1931
1931
|
/**
|
|
@@ -1934,7 +1934,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1934
1934
|
*
|
|
1935
1935
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
1936
1936
|
*
|
|
1937
|
-
* @see {@link MatterSpecification.
|
|
1937
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.11
|
|
1938
1938
|
*/
|
|
1939
1939
|
minPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1940
1940
|
/**
|
|
@@ -1943,7 +1943,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1943
1943
|
*
|
|
1944
1944
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
1945
1945
|
*
|
|
1946
|
-
* @see {@link MatterSpecification.
|
|
1946
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.12
|
|
1947
1947
|
*/
|
|
1948
1948
|
maxPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1949
1949
|
/**
|
|
@@ -1951,7 +1951,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1951
1951
|
*
|
|
1952
1952
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative energy.
|
|
1953
1953
|
*
|
|
1954
|
-
* @see {@link MatterSpecification.
|
|
1954
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.13
|
|
1955
1955
|
*/
|
|
1956
1956
|
nominalEnergy: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
1957
1957
|
/**
|
|
@@ -1974,13 +1974,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1974
1974
|
* If the ESA cannot calculate its cost for any reason (such as losing its connection to a Price server) it may
|
|
1975
1975
|
* omit this field. This is treated as extra meta data that an EMS may use to optimize a system.
|
|
1976
1976
|
*
|
|
1977
|
-
* @see {@link MatterSpecification.
|
|
1977
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.14
|
|
1978
1978
|
*/
|
|
1979
1979
|
costs: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1980
1980
|
/**
|
|
1981
1981
|
* This field shall indicate the type of cost being represented (see CostTypeEnum).
|
|
1982
1982
|
*
|
|
1983
|
-
* @see {@link MatterSpecification.
|
|
1983
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.1
|
|
1984
1984
|
*/
|
|
1985
1985
|
costType: import("../tlv/TlvObject.js").FieldType<CostType>;
|
|
1986
1986
|
/**
|
|
@@ -1989,14 +1989,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
1989
1989
|
*
|
|
1990
1990
|
* For example, if the Value was -302 and DecimalPoints was 2, then this would represent a benefit of 3.02.
|
|
1991
1991
|
*
|
|
1992
|
-
* @see {@link MatterSpecification.
|
|
1992
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.2
|
|
1993
1993
|
*/
|
|
1994
1994
|
value: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1995
1995
|
/**
|
|
1996
1996
|
* This field shall indicate the number of digits to the right of the decimal point in the Value field. For
|
|
1997
1997
|
* example, if the Value was 102 and DecimalPoints was 2, then this would represent a cost of 1.02.
|
|
1998
1998
|
*
|
|
1999
|
-
* @see {@link MatterSpecification.
|
|
1999
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.3
|
|
2000
2000
|
*/
|
|
2001
2001
|
decimalPoints: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2002
2002
|
/**
|
|
@@ -2005,7 +2005,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2005
2005
|
*
|
|
2006
2006
|
* This is an optional field. It shall be included if CostType is Financial.
|
|
2007
2007
|
*
|
|
2008
|
-
* @see {@link MatterSpecification.
|
|
2008
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.4
|
|
2009
2009
|
*/
|
|
2010
2010
|
currency: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
2011
2011
|
}>[]>;
|
|
@@ -2016,7 +2016,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2016
2016
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
2017
2017
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
2018
2018
|
*
|
|
2019
|
-
* @see {@link MatterSpecification.
|
|
2019
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.15
|
|
2020
2020
|
*/
|
|
2021
2021
|
minPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
2022
2022
|
/**
|
|
@@ -2026,7 +2026,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2026
2026
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
2027
2027
|
* indicate it could be switched on to charge, but this would be the maximum power limit it can be set to.
|
|
2028
2028
|
*
|
|
2029
|
-
* @see {@link MatterSpecification.
|
|
2029
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.16
|
|
2030
2030
|
*/
|
|
2031
2031
|
maxPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
2032
2032
|
/**
|
|
@@ -2038,7 +2038,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2038
2038
|
*
|
|
2039
2039
|
* For example, a heat pump compressor may have a minimum cycle time of order a few minutes.
|
|
2040
2040
|
*
|
|
2041
|
-
* @see {@link MatterSpecification.
|
|
2041
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.17
|
|
2042
2042
|
*/
|
|
2043
2043
|
minDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
2044
2044
|
/**
|
|
@@ -2050,14 +2050,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2050
2050
|
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
2051
2051
|
* MaxPowerAdjustment power level).
|
|
2052
2052
|
*
|
|
2053
|
-
* @see {@link MatterSpecification.
|
|
2053
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.18
|
|
2054
2054
|
*/
|
|
2055
2055
|
maxDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
2056
2056
|
}>[]>;
|
|
2057
2057
|
/**
|
|
2058
2058
|
* This field shall contain the reason the current Forecast was generated.
|
|
2059
2059
|
*
|
|
2060
|
-
* @see {@link MatterSpecification.
|
|
2060
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.9
|
|
2061
2061
|
*/
|
|
2062
2062
|
forecastUpdateReason: import("../tlv/TlvObject.js").FieldType<ForecastUpdateReason>;
|
|
2063
2063
|
}> | null, any>;
|
|
@@ -2101,7 +2101,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2101
2101
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
2102
2102
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
2103
2103
|
*
|
|
2104
|
-
* @see {@link MatterSpecification.
|
|
2104
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.8
|
|
2105
2105
|
*/
|
|
2106
2106
|
readonly optOutState: Attribute<OptOutState, any>;
|
|
2107
2107
|
};
|
|
@@ -2114,7 +2114,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2114
2114
|
/**
|
|
2115
2115
|
* Allows a client to temporarily pause an operation and reduce the ESAs energy demand.
|
|
2116
2116
|
*
|
|
2117
|
-
* @see {@link MatterSpecification.
|
|
2117
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4
|
|
2118
2118
|
*/
|
|
2119
2119
|
readonly pauseRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2120
2120
|
/**
|
|
@@ -2122,20 +2122,20 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2122
2122
|
* MinPauseDuration and MaxPauseDuration indicated in the ActiveSlotNumber index in the Slots list in the
|
|
2123
2123
|
* Forecast.
|
|
2124
2124
|
*
|
|
2125
|
-
* @see {@link MatterSpecification.
|
|
2125
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4.1
|
|
2126
2126
|
*/
|
|
2127
2127
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2128
2128
|
/**
|
|
2129
2129
|
* This field shall indicate the cause of the request from the EMS.
|
|
2130
2130
|
*
|
|
2131
|
-
* @see {@link MatterSpecification.
|
|
2131
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4.2
|
|
2132
2132
|
*/
|
|
2133
2133
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
2134
2134
|
}>, void, any>;
|
|
2135
2135
|
/**
|
|
2136
2136
|
* Allows a client to cancel the PauseRequest command and enable earlier resumption of operation.
|
|
2137
2137
|
*
|
|
2138
|
-
* @see {@link MatterSpecification.
|
|
2138
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.5
|
|
2139
2139
|
*/
|
|
2140
2140
|
readonly resumeRequest: Command<void, void, any>;
|
|
2141
2141
|
};
|
|
@@ -2143,19 +2143,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2143
2143
|
/**
|
|
2144
2144
|
* This event shall be generated when the ESA enters the Paused state. There is no data for this event.
|
|
2145
2145
|
*
|
|
2146
|
-
* @see {@link MatterSpecification.
|
|
2146
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.3
|
|
2147
2147
|
*/
|
|
2148
2148
|
readonly paused: Event<void, any>;
|
|
2149
2149
|
/**
|
|
2150
2150
|
* This event shall be generated when the ESA leaves the Paused state and resumes operation.
|
|
2151
2151
|
*
|
|
2152
|
-
* @see {@link MatterSpecification.
|
|
2152
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.4
|
|
2153
2153
|
*/
|
|
2154
2154
|
readonly resumed: Event<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2155
2155
|
/**
|
|
2156
2156
|
* This field shall indicate the reason why the pause ended.
|
|
2157
2157
|
*
|
|
2158
|
-
* @see {@link MatterSpecification.
|
|
2158
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.4.1
|
|
2159
2159
|
*/
|
|
2160
2160
|
cause: import("../tlv/TlvObject.js").FieldType<Cause>;
|
|
2161
2161
|
}>, any>;
|
|
@@ -2170,7 +2170,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2170
2170
|
* Allows a client to adjust the start time of a Forecast sequence that has not yet started operation (i.e.
|
|
2171
2171
|
* where the current Forecast StartTime is in the future).
|
|
2172
2172
|
*
|
|
2173
|
-
* @see {@link MatterSpecification.
|
|
2173
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3
|
|
2174
2174
|
*/
|
|
2175
2175
|
readonly startTimeAdjustRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2176
2176
|
/**
|
|
@@ -2183,13 +2183,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2183
2183
|
* This value shall be after the EarliestStartTime in the Forecast attribute. The new EndTime, that can be
|
|
2184
2184
|
* computed from the RequestedStartTime and the Forecast sequence duration, shall be before the LatestEndTime.
|
|
2185
2185
|
*
|
|
2186
|
-
* @see {@link MatterSpecification.
|
|
2186
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3.1
|
|
2187
2187
|
*/
|
|
2188
2188
|
requestedStartTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2189
2189
|
/**
|
|
2190
2190
|
* This field shall indicate the cause of the request from the EMS.
|
|
2191
2191
|
*
|
|
2192
|
-
* @see {@link MatterSpecification.
|
|
2192
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3.2
|
|
2193
2193
|
*/
|
|
2194
2194
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
2195
2195
|
}>, void, any>;
|
|
@@ -2203,20 +2203,20 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2203
2203
|
/**
|
|
2204
2204
|
* Allows a client to modify a Forecast within the limits allowed by the ESA.
|
|
2205
2205
|
*
|
|
2206
|
-
* @see {@link MatterSpecification.
|
|
2206
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6
|
|
2207
2207
|
*/
|
|
2208
2208
|
readonly modifyForecastRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2209
2209
|
/**
|
|
2210
2210
|
* This field shall indicate the ForecastID that is to be modified.
|
|
2211
2211
|
*
|
|
2212
|
-
* @see {@link MatterSpecification.
|
|
2212
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.1
|
|
2213
2213
|
*/
|
|
2214
2214
|
forecastId: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2215
2215
|
/**
|
|
2216
2216
|
* This field shall contain a list of SlotAdjustment parameters that should be modified in the corresponding
|
|
2217
2217
|
* Forecast with matching ForecastID.
|
|
2218
2218
|
*
|
|
2219
|
-
* @see {@link MatterSpecification.
|
|
2219
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.2
|
|
2220
2220
|
*/
|
|
2221
2221
|
slotAdjustments: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2222
2222
|
/**
|
|
@@ -2224,7 +2224,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2224
2224
|
* be less than the actual length of the Slots list (implicitly it must be in the range 0 to 9 based on the
|
|
2225
2225
|
* maximum length of the Slots list constraint).
|
|
2226
2226
|
*
|
|
2227
|
-
* @see {@link MatterSpecification.
|
|
2227
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.1
|
|
2228
2228
|
*/
|
|
2229
2229
|
slotIndex: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2230
2230
|
/**
|
|
@@ -2234,7 +2234,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2234
2234
|
* This is a signed value and can be used to indicate charging or discharging. If the ESA does NOT support PFR
|
|
2235
2235
|
* this value shall be ignored by the ESA.
|
|
2236
2236
|
*
|
|
2237
|
-
* @see {@link MatterSpecification.
|
|
2237
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.2
|
|
2238
2238
|
*/
|
|
2239
2239
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
2240
2240
|
/**
|
|
@@ -2242,14 +2242,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2242
2242
|
* slot duration to. It MUST be between the MinDurationAdjustment and MaxDurationAdjustment for the slot as
|
|
2243
2243
|
* advertised by the ESA.
|
|
2244
2244
|
*
|
|
2245
|
-
* @see {@link MatterSpecification.
|
|
2245
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.3
|
|
2246
2246
|
*/
|
|
2247
2247
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2248
2248
|
}>[]>;
|
|
2249
2249
|
/**
|
|
2250
2250
|
* This field shall indicate the cause of the request from the EMS.
|
|
2251
2251
|
*
|
|
2252
|
-
* @see {@link MatterSpecification.
|
|
2252
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.3
|
|
2253
2253
|
*/
|
|
2254
2254
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
2255
2255
|
}>, void, any>;
|
|
@@ -2263,7 +2263,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2263
2263
|
/**
|
|
2264
2264
|
* Allows a client to ask the ESA to recompute its Forecast based on power and time constraints.
|
|
2265
2265
|
*
|
|
2266
|
-
* @see {@link MatterSpecification.
|
|
2266
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7
|
|
2267
2267
|
*/
|
|
2268
2268
|
readonly requestConstraintBasedForecast: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2269
2269
|
/**
|
|
@@ -2282,7 +2282,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2282
2282
|
*
|
|
2283
2283
|
* trol field as follows:
|
|
2284
2284
|
*
|
|
2285
|
-
* @see {@link MatterSpecification.
|
|
2285
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7.1
|
|
2286
2286
|
*/
|
|
2287
2287
|
constraints: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2288
2288
|
/**
|
|
@@ -2291,13 +2291,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2291
2291
|
*
|
|
2292
2292
|
* This value is in UTC and MUST be in the future.
|
|
2293
2293
|
*
|
|
2294
|
-
* @see {@link MatterSpecification.
|
|
2294
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.1
|
|
2295
2295
|
*/
|
|
2296
2296
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2297
2297
|
/**
|
|
2298
2298
|
* This field shall indicate the duration of the constraint in seconds.
|
|
2299
2299
|
*
|
|
2300
|
-
* @see {@link MatterSpecification.
|
|
2300
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.2
|
|
2301
2301
|
*/
|
|
2302
2302
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2303
2303
|
/**
|
|
@@ -2307,7 +2307,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2307
2307
|
*
|
|
2308
2308
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
2309
2309
|
*
|
|
2310
|
-
* @see {@link MatterSpecification.
|
|
2310
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.3
|
|
2311
2311
|
*/
|
|
2312
2312
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
2313
2313
|
/**
|
|
@@ -2316,7 +2316,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2316
2316
|
*
|
|
2317
2317
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
2318
2318
|
*
|
|
2319
|
-
* @see {@link MatterSpecification.
|
|
2319
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.4
|
|
2320
2320
|
*/
|
|
2321
2321
|
maximumEnergy: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
2322
2322
|
/**
|
|
@@ -2329,14 +2329,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2329
2329
|
*
|
|
2330
2330
|
* Note that the mapping between values and operation is manufacturer specific.
|
|
2331
2331
|
*
|
|
2332
|
-
* @see {@link MatterSpecification.
|
|
2332
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.5
|
|
2333
2333
|
*/
|
|
2334
2334
|
loadControl: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
2335
2335
|
}>[]>;
|
|
2336
2336
|
/**
|
|
2337
2337
|
* This field shall indicate the cause of the request from the EMS.
|
|
2338
2338
|
*
|
|
2339
|
-
* @see {@link MatterSpecification.
|
|
2339
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7.2
|
|
2340
2340
|
*/
|
|
2341
2341
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
2342
2342
|
}>, void, any>;
|
|
@@ -2352,7 +2352,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2352
2352
|
* Allows a client to request cancellation of a previous adjustment request in a StartTimeAdjustRequest,
|
|
2353
2353
|
* ModifyForecastRequest or RequestConstraintBasedForecast command.
|
|
2354
2354
|
*
|
|
2355
|
-
* @see {@link MatterSpecification.
|
|
2355
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.8
|
|
2356
2356
|
*/
|
|
2357
2357
|
readonly cancelRequest: Command<void, void, any>;
|
|
2358
2358
|
};
|
|
@@ -2383,7 +2383,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2383
2383
|
* control the discharging (and re-charging) of the vehicle if the EVSE and vehicle support the V2X feature
|
|
2384
2384
|
* of the EVSE cluster of the associated EVSE device.
|
|
2385
2385
|
*
|
|
2386
|
-
* @see {@link MatterSpecification.
|
|
2386
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.1
|
|
2387
2387
|
*/
|
|
2388
2388
|
readonly powerAdjustment: BitFlag;
|
|
2389
2389
|
/**
|
|
@@ -2427,7 +2427,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2427
2427
|
*
|
|
2428
2428
|
* The ESA indicates its power adjustment range and its nominal power consumption as part of its Forecast.
|
|
2429
2429
|
*
|
|
2430
|
-
* @see {@link MatterSpecification.
|
|
2430
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.2
|
|
2431
2431
|
*/
|
|
2432
2432
|
readonly powerForecastReporting: BitFlag;
|
|
2433
2433
|
/**
|
|
@@ -2446,7 +2446,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2446
2446
|
* Once the EMS has built a model of the state vs observed power consumption, it may request a forecast
|
|
2447
2447
|
* adjustment for particular times of the day, encouraging the ESA to use power at alternative times.
|
|
2448
2448
|
*
|
|
2449
|
-
* @see {@link MatterSpecification.
|
|
2449
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.3
|
|
2450
2450
|
*/
|
|
2451
2451
|
readonly stateForecastReporting: BitFlag;
|
|
2452
2452
|
/**
|
|
@@ -2471,7 +2471,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2471
2471
|
* It does this by sending a StartTimeAdjustRequest to the washing machine to request delaying the start of
|
|
2472
2472
|
* the washing cycle.
|
|
2473
2473
|
*
|
|
2474
|
-
* @see {@link MatterSpecification.
|
|
2474
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.4
|
|
2475
2475
|
*/
|
|
2476
2476
|
readonly startTimeAdjustment: BitFlag;
|
|
2477
2477
|
/**
|
|
@@ -2496,7 +2496,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2496
2496
|
* It does this by sending a PauseRequest to the washing machine to request pausing the current step of the
|
|
2497
2497
|
* forecast power usage for a period to allow other home loads to finish before resuming the washing cycle.
|
|
2498
2498
|
*
|
|
2499
|
-
* @see {@link MatterSpecification.
|
|
2499
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.5
|
|
2500
2500
|
*/
|
|
2501
2501
|
readonly pausable: BitFlag;
|
|
2502
2502
|
/**
|
|
@@ -2527,7 +2527,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2527
2527
|
* at a lower power consumption (within the solar excess power) which requires the heat pump to run for a
|
|
2528
2528
|
* longer duration to achieve its required energy demand.
|
|
2529
2529
|
*
|
|
2530
|
-
* @see {@link MatterSpecification.
|
|
2530
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.6
|
|
2531
2531
|
*/
|
|
2532
2532
|
readonly forecastAdjustment: BitFlag;
|
|
2533
2533
|
/**
|
|
@@ -2555,7 +2555,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2555
2555
|
* NominalPower consumption during the constraint period, which may require it to decrease its charge rate
|
|
2556
2556
|
* outside the constraint period to achieve its required energy demand.
|
|
2557
2557
|
*
|
|
2558
|
-
* @see {@link MatterSpecification.
|
|
2558
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.7
|
|
2559
2559
|
*/
|
|
2560
2560
|
readonly constraintBasedAdjustment: BitFlag;
|
|
2561
2561
|
};
|
|
@@ -2574,7 +2574,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2574
2574
|
* typical best use of energy. For example, an EVSE may not always have an EV plugged in, so knowing the
|
|
2575
2575
|
* type of ESA that is being controlled can allow advanced energy management strategies.
|
|
2576
2576
|
*
|
|
2577
|
-
* @see {@link MatterSpecification.
|
|
2577
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.1
|
|
2578
2578
|
*/
|
|
2579
2579
|
readonly esaType: FixedAttribute<EsaType, any>;
|
|
2580
2580
|
/**
|
|
@@ -2596,7 +2596,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2596
2596
|
*
|
|
2597
2597
|
* Example:
|
|
2598
2598
|
*
|
|
2599
|
-
* @see {@link MatterSpecification.
|
|
2599
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.2
|
|
2600
2600
|
*/
|
|
2601
2601
|
readonly esaCanGenerate: FixedAttribute<boolean, any>;
|
|
2602
2602
|
/**
|
|
@@ -2610,7 +2610,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2610
2610
|
* for example to avoid the EMS accidentally starting or stopping the appliance when it is being serviced or
|
|
2611
2611
|
* tested.
|
|
2612
2612
|
*
|
|
2613
|
-
* @see {@link MatterSpecification.
|
|
2613
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.3
|
|
2614
2614
|
*/
|
|
2615
2615
|
readonly esaState: Attribute<EsaState, any>;
|
|
2616
2616
|
/**
|
|
@@ -2623,7 +2623,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2623
2623
|
* in the home, the AbsMinPower will be a negative number representing the maximum power that the ESA can
|
|
2624
2624
|
* discharge its internal battery.
|
|
2625
2625
|
*
|
|
2626
|
-
* @see {@link MatterSpecification.
|
|
2626
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.4
|
|
2627
2627
|
*/
|
|
2628
2628
|
readonly absMinPower: Attribute<number | bigint, any>;
|
|
2629
2629
|
/**
|
|
@@ -2636,7 +2636,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2636
2636
|
* For example, a battery storage inverter that can charge its battery at a maximum power of 2000W and can
|
|
2637
2637
|
* discharge the battery at a maximum power of 3000W, would have a AbsMinPower: -3000, AbsMaxPower: 2000W.
|
|
2638
2638
|
*
|
|
2639
|
-
* @see {@link MatterSpecification.
|
|
2639
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.5
|
|
2640
2640
|
*/
|
|
2641
2641
|
readonly absMaxPower: Attribute<number | bigint, any>;
|
|
2642
2642
|
};
|
|
@@ -2665,7 +2665,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2665
2665
|
*
|
|
2666
2666
|
* • When it changes from null to any other value and vice versa.
|
|
2667
2667
|
*
|
|
2668
|
-
* @see {@link MatterSpecification.
|
|
2668
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.6
|
|
2669
2669
|
*/
|
|
2670
2670
|
readonly powerAdjustmentCapability: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2671
2671
|
/**
|
|
@@ -2684,7 +2684,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2684
2684
|
*
|
|
2685
2685
|
* In this example the list of PowerAdjustStructs allows multiple scenarios to be offered as follows:
|
|
2686
2686
|
*
|
|
2687
|
-
* @see {@link MatterSpecification.
|
|
2687
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.12
|
|
2688
2688
|
*/
|
|
2689
2689
|
powerAdjustCapability: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2690
2690
|
/**
|
|
@@ -2693,7 +2693,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2693
2693
|
* Note that this is a signed value. Negative values indicate power flows out of the node (e.g. discharging a
|
|
2694
2694
|
* battery).
|
|
2695
2695
|
*
|
|
2696
|
-
* @see {@link MatterSpecification.
|
|
2696
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.1
|
|
2697
2697
|
*/
|
|
2698
2698
|
minPower: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
2699
2699
|
/**
|
|
@@ -2712,7 +2712,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2712
2712
|
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W. Here
|
|
2713
2713
|
* power is flowing into the node when charging. As such the MinPower becomes 0W and MaxPower becomes 2000W.
|
|
2714
2714
|
*
|
|
2715
|
-
* @see {@link MatterSpecification.
|
|
2715
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.2
|
|
2716
2716
|
*/
|
|
2717
2717
|
maxPower: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
2718
2718
|
/**
|
|
@@ -2720,7 +2720,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2720
2720
|
* adjustment. Manufacturers may use this to as an anti-cycling capability to avoid controllers from rapidly
|
|
2721
2721
|
* making power adjustments.
|
|
2722
2722
|
*
|
|
2723
|
-
* @see {@link MatterSpecification.
|
|
2723
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.3
|
|
2724
2724
|
*/
|
|
2725
2725
|
minDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2726
2726
|
/**
|
|
@@ -2728,7 +2728,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2728
2728
|
* adjustment. Manufacturers may use this to protect the user experience, to avoid over heating of the ESA,
|
|
2729
2729
|
* ensuring that there is sufficient headroom to use or store energy in the ESA or for any other reason.
|
|
2730
2730
|
*
|
|
2731
|
-
* @see {@link MatterSpecification.
|
|
2731
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.4
|
|
2732
2732
|
*/
|
|
2733
2733
|
maxDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2734
2734
|
}>[] | null>;
|
|
@@ -2739,7 +2739,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2739
2739
|
/**
|
|
2740
2740
|
* Allows a client to request an adjustment in the power consumption of an ESA for a specified duration.
|
|
2741
2741
|
*
|
|
2742
|
-
* @see {@link MatterSpecification.
|
|
2742
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1
|
|
2743
2743
|
*/
|
|
2744
2744
|
readonly powerAdjustRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2745
2745
|
/**
|
|
@@ -2748,7 +2748,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2748
2748
|
* This value shall be between the MinPower and MaxPower fields of the PowerAdjustStruct in the
|
|
2749
2749
|
* PowerAdjustmentCapability attribute.
|
|
2750
2750
|
*
|
|
2751
|
-
* @see {@link MatterSpecification.
|
|
2751
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.1
|
|
2752
2752
|
*/
|
|
2753
2753
|
power: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
2754
2754
|
/**
|
|
@@ -2757,20 +2757,20 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2757
2757
|
* This value shall be between the MinDuration and MaxDuration fields of the PowerAdjustStruct in the
|
|
2758
2758
|
* PowerAdjustmentCapability attribute.
|
|
2759
2759
|
*
|
|
2760
|
-
* @see {@link MatterSpecification.
|
|
2760
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.2
|
|
2761
2761
|
*/
|
|
2762
2762
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2763
2763
|
/**
|
|
2764
2764
|
* This field shall indicate the cause of the request from the EMS.
|
|
2765
2765
|
*
|
|
2766
|
-
* @see {@link MatterSpecification.
|
|
2766
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.3
|
|
2767
2767
|
*/
|
|
2768
2768
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
2769
2769
|
}>, void, any>;
|
|
2770
2770
|
/**
|
|
2771
2771
|
* Allows a client to cancel an ongoing PowerAdjustmentRequest operation.
|
|
2772
2772
|
*
|
|
2773
|
-
* @see {@link MatterSpecification.
|
|
2773
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.2
|
|
2774
2774
|
*/
|
|
2775
2775
|
readonly cancelPowerAdjustRequest: Command<void, void, any>;
|
|
2776
2776
|
};
|
|
@@ -2778,25 +2778,25 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2778
2778
|
/**
|
|
2779
2779
|
* This event shall be generated when the Power Adjustment session is started.
|
|
2780
2780
|
*
|
|
2781
|
-
* @see {@link MatterSpecification.
|
|
2781
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.1
|
|
2782
2782
|
*/
|
|
2783
2783
|
readonly powerAdjustStart: Event<void, any>;
|
|
2784
2784
|
/**
|
|
2785
2785
|
* This event shall be generated when the Power Adjustment session ends.
|
|
2786
2786
|
*
|
|
2787
|
-
* @see {@link MatterSpecification.
|
|
2787
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2
|
|
2788
2788
|
*/
|
|
2789
2789
|
readonly powerAdjustEnd: Event<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2790
2790
|
/**
|
|
2791
2791
|
* This field shall indicate the reason why the power adjustment session ended.
|
|
2792
2792
|
*
|
|
2793
|
-
* @see {@link MatterSpecification.
|
|
2793
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.1
|
|
2794
2794
|
*/
|
|
2795
2795
|
cause: import("../tlv/TlvObject.js").FieldType<Cause>;
|
|
2796
2796
|
/**
|
|
2797
2797
|
* This field shall indicate the number of seconds that the power adjustment session lasted before ending.
|
|
2798
2798
|
*
|
|
2799
|
-
* @see {@link MatterSpecification.
|
|
2799
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.2
|
|
2800
2800
|
*/
|
|
2801
2801
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2802
2802
|
/**
|
|
@@ -2806,7 +2806,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2806
2806
|
* battery inverter that was requested to discharge it would have a negative EnergyUse value. If this was a
|
|
2807
2807
|
* normal load that was turned on, then it will have positive value.
|
|
2808
2808
|
*
|
|
2809
|
-
* @see {@link MatterSpecification.
|
|
2809
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.3
|
|
2810
2810
|
*/
|
|
2811
2811
|
energyUse: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
2812
2812
|
}>, any>;
|
|
@@ -2839,7 +2839,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2839
2839
|
* • As a result of a change in the opt-out status which in turn may cause the ESA to recalculate its
|
|
2840
2840
|
* forecast.
|
|
2841
2841
|
*
|
|
2842
|
-
* @see {@link MatterSpecification.
|
|
2842
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.7
|
|
2843
2843
|
*/
|
|
2844
2844
|
readonly forecast: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2845
2845
|
/**
|
|
@@ -2852,33 +2852,33 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2852
2852
|
*
|
|
2853
2853
|
* The value of ForecastID is allowed to wrap.
|
|
2854
2854
|
*
|
|
2855
|
-
* @see {@link MatterSpecification.
|
|
2855
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.1
|
|
2856
2856
|
*/
|
|
2857
2857
|
forecastId: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2858
2858
|
/**
|
|
2859
2859
|
* This field shall indicate which element of the Slots list is currently active in the Forecast sequence. A
|
|
2860
2860
|
* null value indicates that the sequence has not yet started.
|
|
2861
2861
|
*
|
|
2862
|
-
* @see {@link MatterSpecification.
|
|
2862
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.2
|
|
2863
2863
|
*/
|
|
2864
2864
|
activeSlotNumber: import("../tlv/TlvObject.js").FieldType<number | null>;
|
|
2865
2865
|
/**
|
|
2866
2866
|
* This field shall indicate the planned start time, in UTC, for the entire Forecast.
|
|
2867
2867
|
*
|
|
2868
|
-
* @see {@link MatterSpecification.
|
|
2868
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.3
|
|
2869
2869
|
*/
|
|
2870
2870
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2871
2871
|
/**
|
|
2872
2872
|
* This field shall indicate the planned end time, in UTC, for the entire Forecast.
|
|
2873
2873
|
*
|
|
2874
|
-
* @see {@link MatterSpecification.
|
|
2874
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.4
|
|
2875
2875
|
*/
|
|
2876
2876
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2877
2877
|
/**
|
|
2878
2878
|
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A null
|
|
2879
2879
|
* value indicates that it can be started immediately.
|
|
2880
2880
|
*
|
|
2881
|
-
* @see {@link MatterSpecification.
|
|
2881
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.5
|
|
2882
2882
|
*/
|
|
2883
2883
|
earliestStartTime: import("../tlv/TlvObject.js").OptionalFieldType<number | null>;
|
|
2884
2884
|
/**
|
|
@@ -2887,7 +2887,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2887
2887
|
* e.g. for an EVSE charging session, this may indicate the departure time for the vehicle, by which time the
|
|
2888
2888
|
* charging session must end.
|
|
2889
2889
|
*
|
|
2890
|
-
* @see {@link MatterSpecification.
|
|
2890
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.6
|
|
2891
2891
|
*/
|
|
2892
2892
|
latestEndTime: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
2893
2893
|
/**
|
|
@@ -2895,7 +2895,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2895
2895
|
* this flag and if it is false, then none of the slots contain SlotIsPausable set to true. This can save a
|
|
2896
2896
|
* client from having to check each slot in the list.
|
|
2897
2897
|
*
|
|
2898
|
-
* @see {@link MatterSpecification.
|
|
2898
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.7
|
|
2899
2899
|
*/
|
|
2900
2900
|
isPausable: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
2901
2901
|
/**
|
|
@@ -2903,25 +2903,25 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2903
2903
|
*
|
|
2904
2904
|
* It shall contain at least 1 entry, and a maximum of 10.
|
|
2905
2905
|
*
|
|
2906
|
-
* @see {@link MatterSpecification.
|
|
2906
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.8
|
|
2907
2907
|
*/
|
|
2908
2908
|
slots: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2909
2909
|
/**
|
|
2910
2910
|
* This field shall indicate the minimum time (in seconds) that the appliance expects to be in this slot for.
|
|
2911
2911
|
*
|
|
2912
|
-
* @see {@link MatterSpecification.
|
|
2912
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.1
|
|
2913
2913
|
*/
|
|
2914
2914
|
minDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2915
2915
|
/**
|
|
2916
2916
|
* This field shall indicate the maximum time (in seconds) that the appliance expects to be in this slot for.
|
|
2917
2917
|
*
|
|
2918
|
-
* @see {@link MatterSpecification.
|
|
2918
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.2
|
|
2919
2919
|
*/
|
|
2920
2920
|
maxDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2921
2921
|
/**
|
|
2922
2922
|
* This field shall indicate the expected time (in seconds) that the appliance expects to be in this slot for.
|
|
2923
2923
|
*
|
|
2924
|
-
* @see {@link MatterSpecification.
|
|
2924
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.3
|
|
2925
2925
|
*/
|
|
2926
2926
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2927
2927
|
/**
|
|
@@ -2934,7 +2934,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2934
2934
|
*
|
|
2935
2935
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
2936
2936
|
*
|
|
2937
|
-
* @see {@link MatterSpecification.
|
|
2937
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.4
|
|
2938
2938
|
*/
|
|
2939
2939
|
elapsedSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2940
2940
|
/**
|
|
@@ -2950,13 +2950,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2950
2950
|
*
|
|
2951
2951
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
2952
2952
|
*
|
|
2953
|
-
* @see {@link MatterSpecification.
|
|
2953
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.5
|
|
2954
2954
|
*/
|
|
2955
2955
|
remainingSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2956
2956
|
/**
|
|
2957
2957
|
* This field shall indicate whether this slot can be paused.
|
|
2958
2958
|
*
|
|
2959
|
-
* @see {@link MatterSpecification.
|
|
2959
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.6
|
|
2960
2960
|
*/
|
|
2961
2961
|
slotIsPausable: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
2962
2962
|
/**
|
|
@@ -2964,13 +2964,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2964
2964
|
* controllers trying to pause ESAs for short periods and then resuming operation in a cyclic fashion which may
|
|
2965
2965
|
* damage or cause excess energy to be consumed with restarting of an operation.
|
|
2966
2966
|
*
|
|
2967
|
-
* @see {@link MatterSpecification.
|
|
2967
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.7
|
|
2968
2968
|
*/
|
|
2969
2969
|
minPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
2970
2970
|
/**
|
|
2971
2971
|
* This field shall indicate the longest period that the slot can be paused for.
|
|
2972
2972
|
*
|
|
2973
|
-
* @see {@link MatterSpecification.
|
|
2973
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.8
|
|
2974
2974
|
*/
|
|
2975
2975
|
maxPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
2976
2976
|
/**
|
|
@@ -2993,7 +2993,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
2993
2993
|
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
2994
2994
|
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
2995
2995
|
*
|
|
2996
|
-
* @see {@link MatterSpecification.
|
|
2996
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.9
|
|
2997
2997
|
*/
|
|
2998
2998
|
manufacturerEsaState: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
2999
2999
|
/**
|
|
@@ -3001,7 +3001,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3001
3001
|
* considered the average value over the slot, and some variation from this would be expected (for example, as
|
|
3002
3002
|
* it is ramping up).
|
|
3003
3003
|
*
|
|
3004
|
-
* @see {@link MatterSpecification.
|
|
3004
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.10
|
|
3005
3005
|
*/
|
|
3006
3006
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3007
3007
|
/**
|
|
@@ -3010,7 +3010,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3010
3010
|
*
|
|
3011
3011
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
3012
3012
|
*
|
|
3013
|
-
* @see {@link MatterSpecification.
|
|
3013
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.11
|
|
3014
3014
|
*/
|
|
3015
3015
|
minPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3016
3016
|
/**
|
|
@@ -3019,7 +3019,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3019
3019
|
*
|
|
3020
3020
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
3021
3021
|
*
|
|
3022
|
-
* @see {@link MatterSpecification.
|
|
3022
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.12
|
|
3023
3023
|
*/
|
|
3024
3024
|
maxPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3025
3025
|
/**
|
|
@@ -3027,7 +3027,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3027
3027
|
*
|
|
3028
3028
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative energy.
|
|
3029
3029
|
*
|
|
3030
|
-
* @see {@link MatterSpecification.
|
|
3030
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.13
|
|
3031
3031
|
*/
|
|
3032
3032
|
nominalEnergy: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3033
3033
|
/**
|
|
@@ -3050,13 +3050,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3050
3050
|
* If the ESA cannot calculate its cost for any reason (such as losing its connection to a Price server) it may
|
|
3051
3051
|
* omit this field. This is treated as extra meta data that an EMS may use to optimize a system.
|
|
3052
3052
|
*
|
|
3053
|
-
* @see {@link MatterSpecification.
|
|
3053
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.14
|
|
3054
3054
|
*/
|
|
3055
3055
|
costs: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3056
3056
|
/**
|
|
3057
3057
|
* This field shall indicate the type of cost being represented (see CostTypeEnum).
|
|
3058
3058
|
*
|
|
3059
|
-
* @see {@link MatterSpecification.
|
|
3059
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.1
|
|
3060
3060
|
*/
|
|
3061
3061
|
costType: import("../tlv/TlvObject.js").FieldType<CostType>;
|
|
3062
3062
|
/**
|
|
@@ -3065,14 +3065,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3065
3065
|
*
|
|
3066
3066
|
* For example, if the Value was -302 and DecimalPoints was 2, then this would represent a benefit of 3.02.
|
|
3067
3067
|
*
|
|
3068
|
-
* @see {@link MatterSpecification.
|
|
3068
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.2
|
|
3069
3069
|
*/
|
|
3070
3070
|
value: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3071
3071
|
/**
|
|
3072
3072
|
* This field shall indicate the number of digits to the right of the decimal point in the Value field. For
|
|
3073
3073
|
* example, if the Value was 102 and DecimalPoints was 2, then this would represent a cost of 1.02.
|
|
3074
3074
|
*
|
|
3075
|
-
* @see {@link MatterSpecification.
|
|
3075
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.3
|
|
3076
3076
|
*/
|
|
3077
3077
|
decimalPoints: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3078
3078
|
/**
|
|
@@ -3081,7 +3081,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3081
3081
|
*
|
|
3082
3082
|
* This is an optional field. It shall be included if CostType is Financial.
|
|
3083
3083
|
*
|
|
3084
|
-
* @see {@link MatterSpecification.
|
|
3084
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.4
|
|
3085
3085
|
*/
|
|
3086
3086
|
currency: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
3087
3087
|
}>[]>;
|
|
@@ -3092,7 +3092,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3092
3092
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
3093
3093
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
3094
3094
|
*
|
|
3095
|
-
* @see {@link MatterSpecification.
|
|
3095
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.15
|
|
3096
3096
|
*/
|
|
3097
3097
|
minPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3098
3098
|
/**
|
|
@@ -3102,7 +3102,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3102
3102
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
3103
3103
|
* indicate it could be switched on to charge, but this would be the maximum power limit it can be set to.
|
|
3104
3104
|
*
|
|
3105
|
-
* @see {@link MatterSpecification.
|
|
3105
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.16
|
|
3106
3106
|
*/
|
|
3107
3107
|
maxPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3108
3108
|
/**
|
|
@@ -3114,7 +3114,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3114
3114
|
*
|
|
3115
3115
|
* For example, a heat pump compressor may have a minimum cycle time of order a few minutes.
|
|
3116
3116
|
*
|
|
3117
|
-
* @see {@link MatterSpecification.
|
|
3117
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.17
|
|
3118
3118
|
*/
|
|
3119
3119
|
minDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
3120
3120
|
/**
|
|
@@ -3126,14 +3126,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3126
3126
|
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
3127
3127
|
* MaxPowerAdjustment power level).
|
|
3128
3128
|
*
|
|
3129
|
-
* @see {@link MatterSpecification.
|
|
3129
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.18
|
|
3130
3130
|
*/
|
|
3131
3131
|
maxDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
3132
3132
|
}>[]>;
|
|
3133
3133
|
/**
|
|
3134
3134
|
* This field shall contain the reason the current Forecast was generated.
|
|
3135
3135
|
*
|
|
3136
|
-
* @see {@link MatterSpecification.
|
|
3136
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.9
|
|
3137
3137
|
*/
|
|
3138
3138
|
forecastUpdateReason: import("../tlv/TlvObject.js").FieldType<ForecastUpdateReason>;
|
|
3139
3139
|
}> | null, any>;
|
|
@@ -3166,7 +3166,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3166
3166
|
* • As a result of a change in the opt-out status which in turn may cause the ESA to recalculate its
|
|
3167
3167
|
* forecast.
|
|
3168
3168
|
*
|
|
3169
|
-
* @see {@link MatterSpecification.
|
|
3169
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.7
|
|
3170
3170
|
*/
|
|
3171
3171
|
readonly forecast: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3172
3172
|
/**
|
|
@@ -3179,33 +3179,33 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3179
3179
|
*
|
|
3180
3180
|
* The value of ForecastID is allowed to wrap.
|
|
3181
3181
|
*
|
|
3182
|
-
* @see {@link MatterSpecification.
|
|
3182
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.1
|
|
3183
3183
|
*/
|
|
3184
3184
|
forecastId: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3185
3185
|
/**
|
|
3186
3186
|
* This field shall indicate which element of the Slots list is currently active in the Forecast sequence. A
|
|
3187
3187
|
* null value indicates that the sequence has not yet started.
|
|
3188
3188
|
*
|
|
3189
|
-
* @see {@link MatterSpecification.
|
|
3189
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.2
|
|
3190
3190
|
*/
|
|
3191
3191
|
activeSlotNumber: import("../tlv/TlvObject.js").FieldType<number | null>;
|
|
3192
3192
|
/**
|
|
3193
3193
|
* This field shall indicate the planned start time, in UTC, for the entire Forecast.
|
|
3194
3194
|
*
|
|
3195
|
-
* @see {@link MatterSpecification.
|
|
3195
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.3
|
|
3196
3196
|
*/
|
|
3197
3197
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3198
3198
|
/**
|
|
3199
3199
|
* This field shall indicate the planned end time, in UTC, for the entire Forecast.
|
|
3200
3200
|
*
|
|
3201
|
-
* @see {@link MatterSpecification.
|
|
3201
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.4
|
|
3202
3202
|
*/
|
|
3203
3203
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3204
3204
|
/**
|
|
3205
3205
|
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A null
|
|
3206
3206
|
* value indicates that it can be started immediately.
|
|
3207
3207
|
*
|
|
3208
|
-
* @see {@link MatterSpecification.
|
|
3208
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.5
|
|
3209
3209
|
*/
|
|
3210
3210
|
earliestStartTime: import("../tlv/TlvObject.js").OptionalFieldType<number | null>;
|
|
3211
3211
|
/**
|
|
@@ -3214,7 +3214,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3214
3214
|
* e.g. for an EVSE charging session, this may indicate the departure time for the vehicle, by which time the
|
|
3215
3215
|
* charging session must end.
|
|
3216
3216
|
*
|
|
3217
|
-
* @see {@link MatterSpecification.
|
|
3217
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.6
|
|
3218
3218
|
*/
|
|
3219
3219
|
latestEndTime: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
3220
3220
|
/**
|
|
@@ -3222,7 +3222,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3222
3222
|
* this flag and if it is false, then none of the slots contain SlotIsPausable set to true. This can save a
|
|
3223
3223
|
* client from having to check each slot in the list.
|
|
3224
3224
|
*
|
|
3225
|
-
* @see {@link MatterSpecification.
|
|
3225
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.7
|
|
3226
3226
|
*/
|
|
3227
3227
|
isPausable: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
3228
3228
|
/**
|
|
@@ -3230,25 +3230,25 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3230
3230
|
*
|
|
3231
3231
|
* It shall contain at least 1 entry, and a maximum of 10.
|
|
3232
3232
|
*
|
|
3233
|
-
* @see {@link MatterSpecification.
|
|
3233
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.8
|
|
3234
3234
|
*/
|
|
3235
3235
|
slots: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3236
3236
|
/**
|
|
3237
3237
|
* This field shall indicate the minimum time (in seconds) that the appliance expects to be in this slot for.
|
|
3238
3238
|
*
|
|
3239
|
-
* @see {@link MatterSpecification.
|
|
3239
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.1
|
|
3240
3240
|
*/
|
|
3241
3241
|
minDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3242
3242
|
/**
|
|
3243
3243
|
* This field shall indicate the maximum time (in seconds) that the appliance expects to be in this slot for.
|
|
3244
3244
|
*
|
|
3245
|
-
* @see {@link MatterSpecification.
|
|
3245
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.2
|
|
3246
3246
|
*/
|
|
3247
3247
|
maxDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3248
3248
|
/**
|
|
3249
3249
|
* This field shall indicate the expected time (in seconds) that the appliance expects to be in this slot for.
|
|
3250
3250
|
*
|
|
3251
|
-
* @see {@link MatterSpecification.
|
|
3251
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.3
|
|
3252
3252
|
*/
|
|
3253
3253
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3254
3254
|
/**
|
|
@@ -3261,7 +3261,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3261
3261
|
*
|
|
3262
3262
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
3263
3263
|
*
|
|
3264
|
-
* @see {@link MatterSpecification.
|
|
3264
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.4
|
|
3265
3265
|
*/
|
|
3266
3266
|
elapsedSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3267
3267
|
/**
|
|
@@ -3277,13 +3277,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3277
3277
|
*
|
|
3278
3278
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
3279
3279
|
*
|
|
3280
|
-
* @see {@link MatterSpecification.
|
|
3280
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.5
|
|
3281
3281
|
*/
|
|
3282
3282
|
remainingSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3283
3283
|
/**
|
|
3284
3284
|
* This field shall indicate whether this slot can be paused.
|
|
3285
3285
|
*
|
|
3286
|
-
* @see {@link MatterSpecification.
|
|
3286
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.6
|
|
3287
3287
|
*/
|
|
3288
3288
|
slotIsPausable: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
3289
3289
|
/**
|
|
@@ -3291,13 +3291,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3291
3291
|
* controllers trying to pause ESAs for short periods and then resuming operation in a cyclic fashion which may
|
|
3292
3292
|
* damage or cause excess energy to be consumed with restarting of an operation.
|
|
3293
3293
|
*
|
|
3294
|
-
* @see {@link MatterSpecification.
|
|
3294
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.7
|
|
3295
3295
|
*/
|
|
3296
3296
|
minPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
3297
3297
|
/**
|
|
3298
3298
|
* This field shall indicate the longest period that the slot can be paused for.
|
|
3299
3299
|
*
|
|
3300
|
-
* @see {@link MatterSpecification.
|
|
3300
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.8
|
|
3301
3301
|
*/
|
|
3302
3302
|
maxPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
3303
3303
|
/**
|
|
@@ -3320,7 +3320,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3320
3320
|
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
3321
3321
|
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
3322
3322
|
*
|
|
3323
|
-
* @see {@link MatterSpecification.
|
|
3323
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.9
|
|
3324
3324
|
*/
|
|
3325
3325
|
manufacturerEsaState: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
3326
3326
|
/**
|
|
@@ -3328,7 +3328,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3328
3328
|
* considered the average value over the slot, and some variation from this would be expected (for example, as
|
|
3329
3329
|
* it is ramping up).
|
|
3330
3330
|
*
|
|
3331
|
-
* @see {@link MatterSpecification.
|
|
3331
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.10
|
|
3332
3332
|
*/
|
|
3333
3333
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3334
3334
|
/**
|
|
@@ -3337,7 +3337,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3337
3337
|
*
|
|
3338
3338
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
3339
3339
|
*
|
|
3340
|
-
* @see {@link MatterSpecification.
|
|
3340
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.11
|
|
3341
3341
|
*/
|
|
3342
3342
|
minPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3343
3343
|
/**
|
|
@@ -3346,7 +3346,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3346
3346
|
*
|
|
3347
3347
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
3348
3348
|
*
|
|
3349
|
-
* @see {@link MatterSpecification.
|
|
3349
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.12
|
|
3350
3350
|
*/
|
|
3351
3351
|
maxPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3352
3352
|
/**
|
|
@@ -3354,7 +3354,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3354
3354
|
*
|
|
3355
3355
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative energy.
|
|
3356
3356
|
*
|
|
3357
|
-
* @see {@link MatterSpecification.
|
|
3357
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.13
|
|
3358
3358
|
*/
|
|
3359
3359
|
nominalEnergy: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3360
3360
|
/**
|
|
@@ -3377,13 +3377,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3377
3377
|
* If the ESA cannot calculate its cost for any reason (such as losing its connection to a Price server) it may
|
|
3378
3378
|
* omit this field. This is treated as extra meta data that an EMS may use to optimize a system.
|
|
3379
3379
|
*
|
|
3380
|
-
* @see {@link MatterSpecification.
|
|
3380
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.14
|
|
3381
3381
|
*/
|
|
3382
3382
|
costs: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3383
3383
|
/**
|
|
3384
3384
|
* This field shall indicate the type of cost being represented (see CostTypeEnum).
|
|
3385
3385
|
*
|
|
3386
|
-
* @see {@link MatterSpecification.
|
|
3386
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.1
|
|
3387
3387
|
*/
|
|
3388
3388
|
costType: import("../tlv/TlvObject.js").FieldType<CostType>;
|
|
3389
3389
|
/**
|
|
@@ -3392,14 +3392,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3392
3392
|
*
|
|
3393
3393
|
* For example, if the Value was -302 and DecimalPoints was 2, then this would represent a benefit of 3.02.
|
|
3394
3394
|
*
|
|
3395
|
-
* @see {@link MatterSpecification.
|
|
3395
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.2
|
|
3396
3396
|
*/
|
|
3397
3397
|
value: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3398
3398
|
/**
|
|
3399
3399
|
* This field shall indicate the number of digits to the right of the decimal point in the Value field. For
|
|
3400
3400
|
* example, if the Value was 102 and DecimalPoints was 2, then this would represent a cost of 1.02.
|
|
3401
3401
|
*
|
|
3402
|
-
* @see {@link MatterSpecification.
|
|
3402
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.3
|
|
3403
3403
|
*/
|
|
3404
3404
|
decimalPoints: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3405
3405
|
/**
|
|
@@ -3408,7 +3408,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3408
3408
|
*
|
|
3409
3409
|
* This is an optional field. It shall be included if CostType is Financial.
|
|
3410
3410
|
*
|
|
3411
|
-
* @see {@link MatterSpecification.
|
|
3411
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.4
|
|
3412
3412
|
*/
|
|
3413
3413
|
currency: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
3414
3414
|
}>[]>;
|
|
@@ -3419,7 +3419,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3419
3419
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
3420
3420
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
3421
3421
|
*
|
|
3422
|
-
* @see {@link MatterSpecification.
|
|
3422
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.15
|
|
3423
3423
|
*/
|
|
3424
3424
|
minPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3425
3425
|
/**
|
|
@@ -3429,7 +3429,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3429
3429
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
3430
3430
|
* indicate it could be switched on to charge, but this would be the maximum power limit it can be set to.
|
|
3431
3431
|
*
|
|
3432
|
-
* @see {@link MatterSpecification.
|
|
3432
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.16
|
|
3433
3433
|
*/
|
|
3434
3434
|
maxPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3435
3435
|
/**
|
|
@@ -3441,7 +3441,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3441
3441
|
*
|
|
3442
3442
|
* For example, a heat pump compressor may have a minimum cycle time of order a few minutes.
|
|
3443
3443
|
*
|
|
3444
|
-
* @see {@link MatterSpecification.
|
|
3444
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.17
|
|
3445
3445
|
*/
|
|
3446
3446
|
minDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
3447
3447
|
/**
|
|
@@ -3453,14 +3453,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3453
3453
|
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
3454
3454
|
* MaxPowerAdjustment power level).
|
|
3455
3455
|
*
|
|
3456
|
-
* @see {@link MatterSpecification.
|
|
3456
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.18
|
|
3457
3457
|
*/
|
|
3458
3458
|
maxDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
3459
3459
|
}>[]>;
|
|
3460
3460
|
/**
|
|
3461
3461
|
* This field shall contain the reason the current Forecast was generated.
|
|
3462
3462
|
*
|
|
3463
|
-
* @see {@link MatterSpecification.
|
|
3463
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.9
|
|
3464
3464
|
*/
|
|
3465
3465
|
forecastUpdateReason: import("../tlv/TlvObject.js").FieldType<ForecastUpdateReason>;
|
|
3466
3466
|
}> | null, any>;
|
|
@@ -3504,7 +3504,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3504
3504
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
3505
3505
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
3506
3506
|
*
|
|
3507
|
-
* @see {@link MatterSpecification.
|
|
3507
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.8
|
|
3508
3508
|
*/
|
|
3509
3509
|
readonly optOutState: Attribute<OptOutState, any>;
|
|
3510
3510
|
};
|
|
@@ -3547,7 +3547,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3547
3547
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
3548
3548
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
3549
3549
|
*
|
|
3550
|
-
* @see {@link MatterSpecification.
|
|
3550
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.8
|
|
3551
3551
|
*/
|
|
3552
3552
|
readonly optOutState: Attribute<OptOutState, any>;
|
|
3553
3553
|
};
|
|
@@ -3590,7 +3590,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3590
3590
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
3591
3591
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
3592
3592
|
*
|
|
3593
|
-
* @see {@link MatterSpecification.
|
|
3593
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.8
|
|
3594
3594
|
*/
|
|
3595
3595
|
readonly optOutState: Attribute<OptOutState, any>;
|
|
3596
3596
|
};
|
|
@@ -3633,7 +3633,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3633
3633
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
3634
3634
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
3635
3635
|
*
|
|
3636
|
-
* @see {@link MatterSpecification.
|
|
3636
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.8
|
|
3637
3637
|
*/
|
|
3638
3638
|
readonly optOutState: Attribute<OptOutState, any>;
|
|
3639
3639
|
};
|
|
@@ -3676,7 +3676,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3676
3676
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
3677
3677
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
3678
3678
|
*
|
|
3679
|
-
* @see {@link MatterSpecification.
|
|
3679
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.8
|
|
3680
3680
|
*/
|
|
3681
3681
|
readonly optOutState: Attribute<OptOutState, any>;
|
|
3682
3682
|
};
|
|
@@ -3690,7 +3690,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3690
3690
|
/**
|
|
3691
3691
|
* Allows a client to temporarily pause an operation and reduce the ESAs energy demand.
|
|
3692
3692
|
*
|
|
3693
|
-
* @see {@link MatterSpecification.
|
|
3693
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4
|
|
3694
3694
|
*/
|
|
3695
3695
|
readonly pauseRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3696
3696
|
/**
|
|
@@ -3698,20 +3698,20 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3698
3698
|
* MinPauseDuration and MaxPauseDuration indicated in the ActiveSlotNumber index in the Slots list in the
|
|
3699
3699
|
* Forecast.
|
|
3700
3700
|
*
|
|
3701
|
-
* @see {@link MatterSpecification.
|
|
3701
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4.1
|
|
3702
3702
|
*/
|
|
3703
3703
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3704
3704
|
/**
|
|
3705
3705
|
* This field shall indicate the cause of the request from the EMS.
|
|
3706
3706
|
*
|
|
3707
|
-
* @see {@link MatterSpecification.
|
|
3707
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4.2
|
|
3708
3708
|
*/
|
|
3709
3709
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
3710
3710
|
}>, void, any>;
|
|
3711
3711
|
/**
|
|
3712
3712
|
* Allows a client to cancel the PauseRequest command and enable earlier resumption of operation.
|
|
3713
3713
|
*
|
|
3714
|
-
* @see {@link MatterSpecification.
|
|
3714
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.5
|
|
3715
3715
|
*/
|
|
3716
3716
|
readonly resumeRequest: Command<void, void, any>;
|
|
3717
3717
|
};
|
|
@@ -3719,19 +3719,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3719
3719
|
/**
|
|
3720
3720
|
* This event shall be generated when the ESA enters the Paused state. There is no data for this event.
|
|
3721
3721
|
*
|
|
3722
|
-
* @see {@link MatterSpecification.
|
|
3722
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.3
|
|
3723
3723
|
*/
|
|
3724
3724
|
readonly paused: Event<void, any>;
|
|
3725
3725
|
/**
|
|
3726
3726
|
* This event shall be generated when the ESA leaves the Paused state and resumes operation.
|
|
3727
3727
|
*
|
|
3728
|
-
* @see {@link MatterSpecification.
|
|
3728
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.4
|
|
3729
3729
|
*/
|
|
3730
3730
|
readonly resumed: Event<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3731
3731
|
/**
|
|
3732
3732
|
* This field shall indicate the reason why the pause ended.
|
|
3733
3733
|
*
|
|
3734
|
-
* @see {@link MatterSpecification.
|
|
3734
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.4.1
|
|
3735
3735
|
*/
|
|
3736
3736
|
cause: import("../tlv/TlvObject.js").FieldType<Cause>;
|
|
3737
3737
|
}>, any>;
|
|
@@ -3747,7 +3747,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3747
3747
|
* Allows a client to adjust the start time of a Forecast sequence that has not yet started operation (i.e.
|
|
3748
3748
|
* where the current Forecast StartTime is in the future).
|
|
3749
3749
|
*
|
|
3750
|
-
* @see {@link MatterSpecification.
|
|
3750
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3
|
|
3751
3751
|
*/
|
|
3752
3752
|
readonly startTimeAdjustRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3753
3753
|
/**
|
|
@@ -3760,13 +3760,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3760
3760
|
* This value shall be after the EarliestStartTime in the Forecast attribute. The new EndTime, that can be
|
|
3761
3761
|
* computed from the RequestedStartTime and the Forecast sequence duration, shall be before the LatestEndTime.
|
|
3762
3762
|
*
|
|
3763
|
-
* @see {@link MatterSpecification.
|
|
3763
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3.1
|
|
3764
3764
|
*/
|
|
3765
3765
|
requestedStartTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3766
3766
|
/**
|
|
3767
3767
|
* This field shall indicate the cause of the request from the EMS.
|
|
3768
3768
|
*
|
|
3769
|
-
* @see {@link MatterSpecification.
|
|
3769
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3.2
|
|
3770
3770
|
*/
|
|
3771
3771
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
3772
3772
|
}>, void, any>;
|
|
@@ -3781,20 +3781,20 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3781
3781
|
/**
|
|
3782
3782
|
* Allows a client to modify a Forecast within the limits allowed by the ESA.
|
|
3783
3783
|
*
|
|
3784
|
-
* @see {@link MatterSpecification.
|
|
3784
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6
|
|
3785
3785
|
*/
|
|
3786
3786
|
readonly modifyForecastRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3787
3787
|
/**
|
|
3788
3788
|
* This field shall indicate the ForecastID that is to be modified.
|
|
3789
3789
|
*
|
|
3790
|
-
* @see {@link MatterSpecification.
|
|
3790
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.1
|
|
3791
3791
|
*/
|
|
3792
3792
|
forecastId: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3793
3793
|
/**
|
|
3794
3794
|
* This field shall contain a list of SlotAdjustment parameters that should be modified in the corresponding
|
|
3795
3795
|
* Forecast with matching ForecastID.
|
|
3796
3796
|
*
|
|
3797
|
-
* @see {@link MatterSpecification.
|
|
3797
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.2
|
|
3798
3798
|
*/
|
|
3799
3799
|
slotAdjustments: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3800
3800
|
/**
|
|
@@ -3802,7 +3802,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3802
3802
|
* be less than the actual length of the Slots list (implicitly it must be in the range 0 to 9 based on the
|
|
3803
3803
|
* maximum length of the Slots list constraint).
|
|
3804
3804
|
*
|
|
3805
|
-
* @see {@link MatterSpecification.
|
|
3805
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.1
|
|
3806
3806
|
*/
|
|
3807
3807
|
slotIndex: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3808
3808
|
/**
|
|
@@ -3812,7 +3812,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3812
3812
|
* This is a signed value and can be used to indicate charging or discharging. If the ESA does NOT support PFR
|
|
3813
3813
|
* this value shall be ignored by the ESA.
|
|
3814
3814
|
*
|
|
3815
|
-
* @see {@link MatterSpecification.
|
|
3815
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.2
|
|
3816
3816
|
*/
|
|
3817
3817
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3818
3818
|
/**
|
|
@@ -3820,14 +3820,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3820
3820
|
* slot duration to. It MUST be between the MinDurationAdjustment and MaxDurationAdjustment for the slot as
|
|
3821
3821
|
* advertised by the ESA.
|
|
3822
3822
|
*
|
|
3823
|
-
* @see {@link MatterSpecification.
|
|
3823
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.3
|
|
3824
3824
|
*/
|
|
3825
3825
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3826
3826
|
}>[]>;
|
|
3827
3827
|
/**
|
|
3828
3828
|
* This field shall indicate the cause of the request from the EMS.
|
|
3829
3829
|
*
|
|
3830
|
-
* @see {@link MatterSpecification.
|
|
3830
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.3
|
|
3831
3831
|
*/
|
|
3832
3832
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
3833
3833
|
}>, void, any>;
|
|
@@ -3842,7 +3842,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3842
3842
|
/**
|
|
3843
3843
|
* Allows a client to ask the ESA to recompute its Forecast based on power and time constraints.
|
|
3844
3844
|
*
|
|
3845
|
-
* @see {@link MatterSpecification.
|
|
3845
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7
|
|
3846
3846
|
*/
|
|
3847
3847
|
readonly requestConstraintBasedForecast: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3848
3848
|
/**
|
|
@@ -3861,7 +3861,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3861
3861
|
*
|
|
3862
3862
|
* trol field as follows:
|
|
3863
3863
|
*
|
|
3864
|
-
* @see {@link MatterSpecification.
|
|
3864
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7.1
|
|
3865
3865
|
*/
|
|
3866
3866
|
constraints: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3867
3867
|
/**
|
|
@@ -3870,13 +3870,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3870
3870
|
*
|
|
3871
3871
|
* This value is in UTC and MUST be in the future.
|
|
3872
3872
|
*
|
|
3873
|
-
* @see {@link MatterSpecification.
|
|
3873
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.1
|
|
3874
3874
|
*/
|
|
3875
3875
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3876
3876
|
/**
|
|
3877
3877
|
* This field shall indicate the duration of the constraint in seconds.
|
|
3878
3878
|
*
|
|
3879
|
-
* @see {@link MatterSpecification.
|
|
3879
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.2
|
|
3880
3880
|
*/
|
|
3881
3881
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3882
3882
|
/**
|
|
@@ -3886,7 +3886,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3886
3886
|
*
|
|
3887
3887
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
3888
3888
|
*
|
|
3889
|
-
* @see {@link MatterSpecification.
|
|
3889
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.3
|
|
3890
3890
|
*/
|
|
3891
3891
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3892
3892
|
/**
|
|
@@ -3895,7 +3895,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3895
3895
|
*
|
|
3896
3896
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
3897
3897
|
*
|
|
3898
|
-
* @see {@link MatterSpecification.
|
|
3898
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.4
|
|
3899
3899
|
*/
|
|
3900
3900
|
maximumEnergy: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
3901
3901
|
/**
|
|
@@ -3908,14 +3908,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3908
3908
|
*
|
|
3909
3909
|
* Note that the mapping between values and operation is manufacturer specific.
|
|
3910
3910
|
*
|
|
3911
|
-
* @see {@link MatterSpecification.
|
|
3911
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.5
|
|
3912
3912
|
*/
|
|
3913
3913
|
loadControl: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
3914
3914
|
}>[]>;
|
|
3915
3915
|
/**
|
|
3916
3916
|
* This field shall indicate the cause of the request from the EMS.
|
|
3917
3917
|
*
|
|
3918
|
-
* @see {@link MatterSpecification.
|
|
3918
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7.2
|
|
3919
3919
|
*/
|
|
3920
3920
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
3921
3921
|
}>, void, any>;
|
|
@@ -3931,7 +3931,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3931
3931
|
* Allows a client to request cancellation of a previous adjustment request in a StartTimeAdjustRequest,
|
|
3932
3932
|
* ModifyForecastRequest or RequestConstraintBasedForecast command.
|
|
3933
3933
|
*
|
|
3934
|
-
* @see {@link MatterSpecification.
|
|
3934
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.8
|
|
3935
3935
|
*/
|
|
3936
3936
|
readonly cancelRequest: Command<void, void, any>;
|
|
3937
3937
|
};
|
|
@@ -3946,7 +3946,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3946
3946
|
* Allows a client to request cancellation of a previous adjustment request in a StartTimeAdjustRequest,
|
|
3947
3947
|
* ModifyForecastRequest or RequestConstraintBasedForecast command.
|
|
3948
3948
|
*
|
|
3949
|
-
* @see {@link MatterSpecification.
|
|
3949
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.8
|
|
3950
3950
|
*/
|
|
3951
3951
|
readonly cancelRequest: Command<void, void, any>;
|
|
3952
3952
|
};
|
|
@@ -3961,7 +3961,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
3961
3961
|
* Allows a client to request cancellation of a previous adjustment request in a StartTimeAdjustRequest,
|
|
3962
3962
|
* ModifyForecastRequest or RequestConstraintBasedForecast command.
|
|
3963
3963
|
*
|
|
3964
|
-
* @see {@link MatterSpecification.
|
|
3964
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.8
|
|
3965
3965
|
*/
|
|
3966
3966
|
readonly cancelRequest: Command<void, void, any>;
|
|
3967
3967
|
};
|
|
@@ -4014,7 +4014,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4014
4014
|
* control the discharging (and re-charging) of the vehicle if the EVSE and vehicle support the V2X feature
|
|
4015
4015
|
* of the EVSE cluster of the associated EVSE device.
|
|
4016
4016
|
*
|
|
4017
|
-
* @see {@link MatterSpecification.
|
|
4017
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.1
|
|
4018
4018
|
*/
|
|
4019
4019
|
readonly powerAdjustment: BitFlag;
|
|
4020
4020
|
/**
|
|
@@ -4058,7 +4058,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4058
4058
|
*
|
|
4059
4059
|
* The ESA indicates its power adjustment range and its nominal power consumption as part of its Forecast.
|
|
4060
4060
|
*
|
|
4061
|
-
* @see {@link MatterSpecification.
|
|
4061
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.2
|
|
4062
4062
|
*/
|
|
4063
4063
|
readonly powerForecastReporting: BitFlag;
|
|
4064
4064
|
/**
|
|
@@ -4077,7 +4077,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4077
4077
|
* Once the EMS has built a model of the state vs observed power consumption, it may request a forecast
|
|
4078
4078
|
* adjustment for particular times of the day, encouraging the ESA to use power at alternative times.
|
|
4079
4079
|
*
|
|
4080
|
-
* @see {@link MatterSpecification.
|
|
4080
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.3
|
|
4081
4081
|
*/
|
|
4082
4082
|
readonly stateForecastReporting: BitFlag;
|
|
4083
4083
|
/**
|
|
@@ -4102,7 +4102,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4102
4102
|
* It does this by sending a StartTimeAdjustRequest to the washing machine to request delaying the start of
|
|
4103
4103
|
* the washing cycle.
|
|
4104
4104
|
*
|
|
4105
|
-
* @see {@link MatterSpecification.
|
|
4105
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.4
|
|
4106
4106
|
*/
|
|
4107
4107
|
readonly startTimeAdjustment: BitFlag;
|
|
4108
4108
|
/**
|
|
@@ -4127,7 +4127,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4127
4127
|
* It does this by sending a PauseRequest to the washing machine to request pausing the current step of the
|
|
4128
4128
|
* forecast power usage for a period to allow other home loads to finish before resuming the washing cycle.
|
|
4129
4129
|
*
|
|
4130
|
-
* @see {@link MatterSpecification.
|
|
4130
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.5
|
|
4131
4131
|
*/
|
|
4132
4132
|
readonly pausable: BitFlag;
|
|
4133
4133
|
/**
|
|
@@ -4158,7 +4158,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4158
4158
|
* at a lower power consumption (within the solar excess power) which requires the heat pump to run for a
|
|
4159
4159
|
* longer duration to achieve its required energy demand.
|
|
4160
4160
|
*
|
|
4161
|
-
* @see {@link MatterSpecification.
|
|
4161
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.6
|
|
4162
4162
|
*/
|
|
4163
4163
|
readonly forecastAdjustment: BitFlag;
|
|
4164
4164
|
/**
|
|
@@ -4186,7 +4186,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4186
4186
|
* NominalPower consumption during the constraint period, which may require it to decrease its charge rate
|
|
4187
4187
|
* outside the constraint period to achieve its required energy demand.
|
|
4188
4188
|
*
|
|
4189
|
-
* @see {@link MatterSpecification.
|
|
4189
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.7
|
|
4190
4190
|
*/
|
|
4191
4191
|
readonly constraintBasedAdjustment: BitFlag;
|
|
4192
4192
|
};
|
|
@@ -4205,7 +4205,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4205
4205
|
* typical best use of energy. For example, an EVSE may not always have an EV plugged in, so knowing the
|
|
4206
4206
|
* type of ESA that is being controlled can allow advanced energy management strategies.
|
|
4207
4207
|
*
|
|
4208
|
-
* @see {@link MatterSpecification.
|
|
4208
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.1
|
|
4209
4209
|
*/
|
|
4210
4210
|
readonly esaType: FixedAttribute<EsaType, any>;
|
|
4211
4211
|
/**
|
|
@@ -4227,7 +4227,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4227
4227
|
*
|
|
4228
4228
|
* Example:
|
|
4229
4229
|
*
|
|
4230
|
-
* @see {@link MatterSpecification.
|
|
4230
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.2
|
|
4231
4231
|
*/
|
|
4232
4232
|
readonly esaCanGenerate: FixedAttribute<boolean, any>;
|
|
4233
4233
|
/**
|
|
@@ -4241,7 +4241,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4241
4241
|
* for example to avoid the EMS accidentally starting or stopping the appliance when it is being serviced or
|
|
4242
4242
|
* tested.
|
|
4243
4243
|
*
|
|
4244
|
-
* @see {@link MatterSpecification.
|
|
4244
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.3
|
|
4245
4245
|
*/
|
|
4246
4246
|
readonly esaState: Attribute<EsaState, any>;
|
|
4247
4247
|
/**
|
|
@@ -4254,7 +4254,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4254
4254
|
* in the home, the AbsMinPower will be a negative number representing the maximum power that the ESA can
|
|
4255
4255
|
* discharge its internal battery.
|
|
4256
4256
|
*
|
|
4257
|
-
* @see {@link MatterSpecification.
|
|
4257
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.4
|
|
4258
4258
|
*/
|
|
4259
4259
|
readonly absMinPower: Attribute<number | bigint, any>;
|
|
4260
4260
|
/**
|
|
@@ -4267,7 +4267,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4267
4267
|
* For example, a battery storage inverter that can charge its battery at a maximum power of 2000W and can
|
|
4268
4268
|
* discharge the battery at a maximum power of 3000W, would have a AbsMinPower: -3000, AbsMaxPower: 2000W.
|
|
4269
4269
|
*
|
|
4270
|
-
* @see {@link MatterSpecification.
|
|
4270
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.5
|
|
4271
4271
|
*/
|
|
4272
4272
|
readonly absMaxPower: Attribute<number | bigint, any>;
|
|
4273
4273
|
};
|
|
@@ -4296,7 +4296,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4296
4296
|
*
|
|
4297
4297
|
* • When it changes from null to any other value and vice versa.
|
|
4298
4298
|
*
|
|
4299
|
-
* @see {@link MatterSpecification.
|
|
4299
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.6
|
|
4300
4300
|
*/
|
|
4301
4301
|
readonly powerAdjustmentCapability: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4302
4302
|
/**
|
|
@@ -4315,7 +4315,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4315
4315
|
*
|
|
4316
4316
|
* In this example the list of PowerAdjustStructs allows multiple scenarios to be offered as follows:
|
|
4317
4317
|
*
|
|
4318
|
-
* @see {@link MatterSpecification.
|
|
4318
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.12
|
|
4319
4319
|
*/
|
|
4320
4320
|
powerAdjustCapability: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4321
4321
|
/**
|
|
@@ -4324,7 +4324,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4324
4324
|
* Note that this is a signed value. Negative values indicate power flows out of the node (e.g. discharging a
|
|
4325
4325
|
* battery).
|
|
4326
4326
|
*
|
|
4327
|
-
* @see {@link MatterSpecification.
|
|
4327
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.1
|
|
4328
4328
|
*/
|
|
4329
4329
|
minPower: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
4330
4330
|
/**
|
|
@@ -4343,7 +4343,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4343
4343
|
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W. Here
|
|
4344
4344
|
* power is flowing into the node when charging. As such the MinPower becomes 0W and MaxPower becomes 2000W.
|
|
4345
4345
|
*
|
|
4346
|
-
* @see {@link MatterSpecification.
|
|
4346
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.2
|
|
4347
4347
|
*/
|
|
4348
4348
|
maxPower: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
4349
4349
|
/**
|
|
@@ -4351,7 +4351,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4351
4351
|
* adjustment. Manufacturers may use this to as an anti-cycling capability to avoid controllers from rapidly
|
|
4352
4352
|
* making power adjustments.
|
|
4353
4353
|
*
|
|
4354
|
-
* @see {@link MatterSpecification.
|
|
4354
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.3
|
|
4355
4355
|
*/
|
|
4356
4356
|
minDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4357
4357
|
/**
|
|
@@ -4359,7 +4359,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4359
4359
|
* adjustment. Manufacturers may use this to protect the user experience, to avoid over heating of the ESA,
|
|
4360
4360
|
* ensuring that there is sufficient headroom to use or store energy in the ESA or for any other reason.
|
|
4361
4361
|
*
|
|
4362
|
-
* @see {@link MatterSpecification.
|
|
4362
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.4
|
|
4363
4363
|
*/
|
|
4364
4364
|
maxDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4365
4365
|
}>[] | null>;
|
|
@@ -4370,7 +4370,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4370
4370
|
/**
|
|
4371
4371
|
* Allows a client to request an adjustment in the power consumption of an ESA for a specified duration.
|
|
4372
4372
|
*
|
|
4373
|
-
* @see {@link MatterSpecification.
|
|
4373
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1
|
|
4374
4374
|
*/
|
|
4375
4375
|
readonly powerAdjustRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4376
4376
|
/**
|
|
@@ -4379,7 +4379,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4379
4379
|
* This value shall be between the MinPower and MaxPower fields of the PowerAdjustStruct in the
|
|
4380
4380
|
* PowerAdjustmentCapability attribute.
|
|
4381
4381
|
*
|
|
4382
|
-
* @see {@link MatterSpecification.
|
|
4382
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.1
|
|
4383
4383
|
*/
|
|
4384
4384
|
power: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
4385
4385
|
/**
|
|
@@ -4388,20 +4388,20 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4388
4388
|
* This value shall be between the MinDuration and MaxDuration fields of the PowerAdjustStruct in the
|
|
4389
4389
|
* PowerAdjustmentCapability attribute.
|
|
4390
4390
|
*
|
|
4391
|
-
* @see {@link MatterSpecification.
|
|
4391
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.2
|
|
4392
4392
|
*/
|
|
4393
4393
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4394
4394
|
/**
|
|
4395
4395
|
* This field shall indicate the cause of the request from the EMS.
|
|
4396
4396
|
*
|
|
4397
|
-
* @see {@link MatterSpecification.
|
|
4397
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.3
|
|
4398
4398
|
*/
|
|
4399
4399
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
4400
4400
|
}>, void, any>;
|
|
4401
4401
|
/**
|
|
4402
4402
|
* Allows a client to cancel an ongoing PowerAdjustmentRequest operation.
|
|
4403
4403
|
*
|
|
4404
|
-
* @see {@link MatterSpecification.
|
|
4404
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.2
|
|
4405
4405
|
*/
|
|
4406
4406
|
readonly cancelPowerAdjustRequest: Command<void, void, any>;
|
|
4407
4407
|
};
|
|
@@ -4409,25 +4409,25 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4409
4409
|
/**
|
|
4410
4410
|
* This event shall be generated when the Power Adjustment session is started.
|
|
4411
4411
|
*
|
|
4412
|
-
* @see {@link MatterSpecification.
|
|
4412
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.1
|
|
4413
4413
|
*/
|
|
4414
4414
|
readonly powerAdjustStart: Event<void, any>;
|
|
4415
4415
|
/**
|
|
4416
4416
|
* This event shall be generated when the Power Adjustment session ends.
|
|
4417
4417
|
*
|
|
4418
|
-
* @see {@link MatterSpecification.
|
|
4418
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2
|
|
4419
4419
|
*/
|
|
4420
4420
|
readonly powerAdjustEnd: Event<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4421
4421
|
/**
|
|
4422
4422
|
* This field shall indicate the reason why the power adjustment session ended.
|
|
4423
4423
|
*
|
|
4424
|
-
* @see {@link MatterSpecification.
|
|
4424
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.1
|
|
4425
4425
|
*/
|
|
4426
4426
|
cause: import("../tlv/TlvObject.js").FieldType<Cause>;
|
|
4427
4427
|
/**
|
|
4428
4428
|
* This field shall indicate the number of seconds that the power adjustment session lasted before ending.
|
|
4429
4429
|
*
|
|
4430
|
-
* @see {@link MatterSpecification.
|
|
4430
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.2
|
|
4431
4431
|
*/
|
|
4432
4432
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4433
4433
|
/**
|
|
@@ -4437,7 +4437,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4437
4437
|
* battery inverter that was requested to discharge it would have a negative EnergyUse value. If this was a
|
|
4438
4438
|
* normal load that was turned on, then it will have positive value.
|
|
4439
4439
|
*
|
|
4440
|
-
* @see {@link MatterSpecification.
|
|
4440
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.3
|
|
4441
4441
|
*/
|
|
4442
4442
|
energyUse: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
4443
4443
|
}>, any>;
|
|
@@ -4470,7 +4470,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4470
4470
|
* • As a result of a change in the opt-out status which in turn may cause the ESA to recalculate its
|
|
4471
4471
|
* forecast.
|
|
4472
4472
|
*
|
|
4473
|
-
* @see {@link MatterSpecification.
|
|
4473
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.7
|
|
4474
4474
|
*/
|
|
4475
4475
|
readonly forecast: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4476
4476
|
/**
|
|
@@ -4483,33 +4483,33 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4483
4483
|
*
|
|
4484
4484
|
* The value of ForecastID is allowed to wrap.
|
|
4485
4485
|
*
|
|
4486
|
-
* @see {@link MatterSpecification.
|
|
4486
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.1
|
|
4487
4487
|
*/
|
|
4488
4488
|
forecastId: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4489
4489
|
/**
|
|
4490
4490
|
* This field shall indicate which element of the Slots list is currently active in the Forecast sequence. A
|
|
4491
4491
|
* null value indicates that the sequence has not yet started.
|
|
4492
4492
|
*
|
|
4493
|
-
* @see {@link MatterSpecification.
|
|
4493
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.2
|
|
4494
4494
|
*/
|
|
4495
4495
|
activeSlotNumber: import("../tlv/TlvObject.js").FieldType<number | null>;
|
|
4496
4496
|
/**
|
|
4497
4497
|
* This field shall indicate the planned start time, in UTC, for the entire Forecast.
|
|
4498
4498
|
*
|
|
4499
|
-
* @see {@link MatterSpecification.
|
|
4499
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.3
|
|
4500
4500
|
*/
|
|
4501
4501
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4502
4502
|
/**
|
|
4503
4503
|
* This field shall indicate the planned end time, in UTC, for the entire Forecast.
|
|
4504
4504
|
*
|
|
4505
|
-
* @see {@link MatterSpecification.
|
|
4505
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.4
|
|
4506
4506
|
*/
|
|
4507
4507
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4508
4508
|
/**
|
|
4509
4509
|
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A null
|
|
4510
4510
|
* value indicates that it can be started immediately.
|
|
4511
4511
|
*
|
|
4512
|
-
* @see {@link MatterSpecification.
|
|
4512
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.5
|
|
4513
4513
|
*/
|
|
4514
4514
|
earliestStartTime: import("../tlv/TlvObject.js").OptionalFieldType<number | null>;
|
|
4515
4515
|
/**
|
|
@@ -4518,7 +4518,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4518
4518
|
* e.g. for an EVSE charging session, this may indicate the departure time for the vehicle, by which time the
|
|
4519
4519
|
* charging session must end.
|
|
4520
4520
|
*
|
|
4521
|
-
* @see {@link MatterSpecification.
|
|
4521
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.6
|
|
4522
4522
|
*/
|
|
4523
4523
|
latestEndTime: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
4524
4524
|
/**
|
|
@@ -4526,7 +4526,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4526
4526
|
* this flag and if it is false, then none of the slots contain SlotIsPausable set to true. This can save a
|
|
4527
4527
|
* client from having to check each slot in the list.
|
|
4528
4528
|
*
|
|
4529
|
-
* @see {@link MatterSpecification.
|
|
4529
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.7
|
|
4530
4530
|
*/
|
|
4531
4531
|
isPausable: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
4532
4532
|
/**
|
|
@@ -4534,25 +4534,25 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4534
4534
|
*
|
|
4535
4535
|
* It shall contain at least 1 entry, and a maximum of 10.
|
|
4536
4536
|
*
|
|
4537
|
-
* @see {@link MatterSpecification.
|
|
4537
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.8
|
|
4538
4538
|
*/
|
|
4539
4539
|
slots: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4540
4540
|
/**
|
|
4541
4541
|
* This field shall indicate the minimum time (in seconds) that the appliance expects to be in this slot for.
|
|
4542
4542
|
*
|
|
4543
|
-
* @see {@link MatterSpecification.
|
|
4543
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.1
|
|
4544
4544
|
*/
|
|
4545
4545
|
minDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4546
4546
|
/**
|
|
4547
4547
|
* This field shall indicate the maximum time (in seconds) that the appliance expects to be in this slot for.
|
|
4548
4548
|
*
|
|
4549
|
-
* @see {@link MatterSpecification.
|
|
4549
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.2
|
|
4550
4550
|
*/
|
|
4551
4551
|
maxDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4552
4552
|
/**
|
|
4553
4553
|
* This field shall indicate the expected time (in seconds) that the appliance expects to be in this slot for.
|
|
4554
4554
|
*
|
|
4555
|
-
* @see {@link MatterSpecification.
|
|
4555
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.3
|
|
4556
4556
|
*/
|
|
4557
4557
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4558
4558
|
/**
|
|
@@ -4565,7 +4565,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4565
4565
|
*
|
|
4566
4566
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
4567
4567
|
*
|
|
4568
|
-
* @see {@link MatterSpecification.
|
|
4568
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.4
|
|
4569
4569
|
*/
|
|
4570
4570
|
elapsedSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4571
4571
|
/**
|
|
@@ -4581,13 +4581,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4581
4581
|
*
|
|
4582
4582
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
4583
4583
|
*
|
|
4584
|
-
* @see {@link MatterSpecification.
|
|
4584
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.5
|
|
4585
4585
|
*/
|
|
4586
4586
|
remainingSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4587
4587
|
/**
|
|
4588
4588
|
* This field shall indicate whether this slot can be paused.
|
|
4589
4589
|
*
|
|
4590
|
-
* @see {@link MatterSpecification.
|
|
4590
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.6
|
|
4591
4591
|
*/
|
|
4592
4592
|
slotIsPausable: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
4593
4593
|
/**
|
|
@@ -4595,13 +4595,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4595
4595
|
* controllers trying to pause ESAs for short periods and then resuming operation in a cyclic fashion which may
|
|
4596
4596
|
* damage or cause excess energy to be consumed with restarting of an operation.
|
|
4597
4597
|
*
|
|
4598
|
-
* @see {@link MatterSpecification.
|
|
4598
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.7
|
|
4599
4599
|
*/
|
|
4600
4600
|
minPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
4601
4601
|
/**
|
|
4602
4602
|
* This field shall indicate the longest period that the slot can be paused for.
|
|
4603
4603
|
*
|
|
4604
|
-
* @see {@link MatterSpecification.
|
|
4604
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.8
|
|
4605
4605
|
*/
|
|
4606
4606
|
maxPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
4607
4607
|
/**
|
|
@@ -4624,7 +4624,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4624
4624
|
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
4625
4625
|
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
4626
4626
|
*
|
|
4627
|
-
* @see {@link MatterSpecification.
|
|
4627
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.9
|
|
4628
4628
|
*/
|
|
4629
4629
|
manufacturerEsaState: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
4630
4630
|
/**
|
|
@@ -4632,7 +4632,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4632
4632
|
* considered the average value over the slot, and some variation from this would be expected (for example, as
|
|
4633
4633
|
* it is ramping up).
|
|
4634
4634
|
*
|
|
4635
|
-
* @see {@link MatterSpecification.
|
|
4635
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.10
|
|
4636
4636
|
*/
|
|
4637
4637
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
4638
4638
|
/**
|
|
@@ -4641,7 +4641,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4641
4641
|
*
|
|
4642
4642
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
4643
4643
|
*
|
|
4644
|
-
* @see {@link MatterSpecification.
|
|
4644
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.11
|
|
4645
4645
|
*/
|
|
4646
4646
|
minPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
4647
4647
|
/**
|
|
@@ -4650,7 +4650,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4650
4650
|
*
|
|
4651
4651
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
4652
4652
|
*
|
|
4653
|
-
* @see {@link MatterSpecification.
|
|
4653
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.12
|
|
4654
4654
|
*/
|
|
4655
4655
|
maxPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
4656
4656
|
/**
|
|
@@ -4658,7 +4658,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4658
4658
|
*
|
|
4659
4659
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative energy.
|
|
4660
4660
|
*
|
|
4661
|
-
* @see {@link MatterSpecification.
|
|
4661
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.13
|
|
4662
4662
|
*/
|
|
4663
4663
|
nominalEnergy: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
4664
4664
|
/**
|
|
@@ -4681,13 +4681,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4681
4681
|
* If the ESA cannot calculate its cost for any reason (such as losing its connection to a Price server) it may
|
|
4682
4682
|
* omit this field. This is treated as extra meta data that an EMS may use to optimize a system.
|
|
4683
4683
|
*
|
|
4684
|
-
* @see {@link MatterSpecification.
|
|
4684
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.14
|
|
4685
4685
|
*/
|
|
4686
4686
|
costs: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4687
4687
|
/**
|
|
4688
4688
|
* This field shall indicate the type of cost being represented (see CostTypeEnum).
|
|
4689
4689
|
*
|
|
4690
|
-
* @see {@link MatterSpecification.
|
|
4690
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.1
|
|
4691
4691
|
*/
|
|
4692
4692
|
costType: import("../tlv/TlvObject.js").FieldType<CostType>;
|
|
4693
4693
|
/**
|
|
@@ -4696,14 +4696,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4696
4696
|
*
|
|
4697
4697
|
* For example, if the Value was -302 and DecimalPoints was 2, then this would represent a benefit of 3.02.
|
|
4698
4698
|
*
|
|
4699
|
-
* @see {@link MatterSpecification.
|
|
4699
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.2
|
|
4700
4700
|
*/
|
|
4701
4701
|
value: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4702
4702
|
/**
|
|
4703
4703
|
* This field shall indicate the number of digits to the right of the decimal point in the Value field. For
|
|
4704
4704
|
* example, if the Value was 102 and DecimalPoints was 2, then this would represent a cost of 1.02.
|
|
4705
4705
|
*
|
|
4706
|
-
* @see {@link MatterSpecification.
|
|
4706
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.3
|
|
4707
4707
|
*/
|
|
4708
4708
|
decimalPoints: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4709
4709
|
/**
|
|
@@ -4712,7 +4712,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4712
4712
|
*
|
|
4713
4713
|
* This is an optional field. It shall be included if CostType is Financial.
|
|
4714
4714
|
*
|
|
4715
|
-
* @see {@link MatterSpecification.
|
|
4715
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.4
|
|
4716
4716
|
*/
|
|
4717
4717
|
currency: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
4718
4718
|
}>[]>;
|
|
@@ -4723,7 +4723,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4723
4723
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
4724
4724
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
4725
4725
|
*
|
|
4726
|
-
* @see {@link MatterSpecification.
|
|
4726
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.15
|
|
4727
4727
|
*/
|
|
4728
4728
|
minPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
4729
4729
|
/**
|
|
@@ -4733,7 +4733,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4733
4733
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
4734
4734
|
* indicate it could be switched on to charge, but this would be the maximum power limit it can be set to.
|
|
4735
4735
|
*
|
|
4736
|
-
* @see {@link MatterSpecification.
|
|
4736
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.16
|
|
4737
4737
|
*/
|
|
4738
4738
|
maxPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
4739
4739
|
/**
|
|
@@ -4745,7 +4745,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4745
4745
|
*
|
|
4746
4746
|
* For example, a heat pump compressor may have a minimum cycle time of order a few minutes.
|
|
4747
4747
|
*
|
|
4748
|
-
* @see {@link MatterSpecification.
|
|
4748
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.17
|
|
4749
4749
|
*/
|
|
4750
4750
|
minDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
4751
4751
|
/**
|
|
@@ -4757,14 +4757,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4757
4757
|
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
4758
4758
|
* MaxPowerAdjustment power level).
|
|
4759
4759
|
*
|
|
4760
|
-
* @see {@link MatterSpecification.
|
|
4760
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.18
|
|
4761
4761
|
*/
|
|
4762
4762
|
maxDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
4763
4763
|
}>[]>;
|
|
4764
4764
|
/**
|
|
4765
4765
|
* This field shall contain the reason the current Forecast was generated.
|
|
4766
4766
|
*
|
|
4767
|
-
* @see {@link MatterSpecification.
|
|
4767
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.9
|
|
4768
4768
|
*/
|
|
4769
4769
|
forecastUpdateReason: import("../tlv/TlvObject.js").FieldType<ForecastUpdateReason>;
|
|
4770
4770
|
}> | null, any>;
|
|
@@ -4797,7 +4797,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4797
4797
|
* • As a result of a change in the opt-out status which in turn may cause the ESA to recalculate its
|
|
4798
4798
|
* forecast.
|
|
4799
4799
|
*
|
|
4800
|
-
* @see {@link MatterSpecification.
|
|
4800
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.7
|
|
4801
4801
|
*/
|
|
4802
4802
|
readonly forecast: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4803
4803
|
/**
|
|
@@ -4810,33 +4810,33 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4810
4810
|
*
|
|
4811
4811
|
* The value of ForecastID is allowed to wrap.
|
|
4812
4812
|
*
|
|
4813
|
-
* @see {@link MatterSpecification.
|
|
4813
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.1
|
|
4814
4814
|
*/
|
|
4815
4815
|
forecastId: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4816
4816
|
/**
|
|
4817
4817
|
* This field shall indicate which element of the Slots list is currently active in the Forecast sequence. A
|
|
4818
4818
|
* null value indicates that the sequence has not yet started.
|
|
4819
4819
|
*
|
|
4820
|
-
* @see {@link MatterSpecification.
|
|
4820
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.2
|
|
4821
4821
|
*/
|
|
4822
4822
|
activeSlotNumber: import("../tlv/TlvObject.js").FieldType<number | null>;
|
|
4823
4823
|
/**
|
|
4824
4824
|
* This field shall indicate the planned start time, in UTC, for the entire Forecast.
|
|
4825
4825
|
*
|
|
4826
|
-
* @see {@link MatterSpecification.
|
|
4826
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.3
|
|
4827
4827
|
*/
|
|
4828
4828
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4829
4829
|
/**
|
|
4830
4830
|
* This field shall indicate the planned end time, in UTC, for the entire Forecast.
|
|
4831
4831
|
*
|
|
4832
|
-
* @see {@link MatterSpecification.
|
|
4832
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.4
|
|
4833
4833
|
*/
|
|
4834
4834
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4835
4835
|
/**
|
|
4836
4836
|
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A null
|
|
4837
4837
|
* value indicates that it can be started immediately.
|
|
4838
4838
|
*
|
|
4839
|
-
* @see {@link MatterSpecification.
|
|
4839
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.5
|
|
4840
4840
|
*/
|
|
4841
4841
|
earliestStartTime: import("../tlv/TlvObject.js").OptionalFieldType<number | null>;
|
|
4842
4842
|
/**
|
|
@@ -4845,7 +4845,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4845
4845
|
* e.g. for an EVSE charging session, this may indicate the departure time for the vehicle, by which time the
|
|
4846
4846
|
* charging session must end.
|
|
4847
4847
|
*
|
|
4848
|
-
* @see {@link MatterSpecification.
|
|
4848
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.6
|
|
4849
4849
|
*/
|
|
4850
4850
|
latestEndTime: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
4851
4851
|
/**
|
|
@@ -4853,7 +4853,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4853
4853
|
* this flag and if it is false, then none of the slots contain SlotIsPausable set to true. This can save a
|
|
4854
4854
|
* client from having to check each slot in the list.
|
|
4855
4855
|
*
|
|
4856
|
-
* @see {@link MatterSpecification.
|
|
4856
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.7
|
|
4857
4857
|
*/
|
|
4858
4858
|
isPausable: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
4859
4859
|
/**
|
|
@@ -4861,25 +4861,25 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4861
4861
|
*
|
|
4862
4862
|
* It shall contain at least 1 entry, and a maximum of 10.
|
|
4863
4863
|
*
|
|
4864
|
-
* @see {@link MatterSpecification.
|
|
4864
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.8
|
|
4865
4865
|
*/
|
|
4866
4866
|
slots: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4867
4867
|
/**
|
|
4868
4868
|
* This field shall indicate the minimum time (in seconds) that the appliance expects to be in this slot for.
|
|
4869
4869
|
*
|
|
4870
|
-
* @see {@link MatterSpecification.
|
|
4870
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.1
|
|
4871
4871
|
*/
|
|
4872
4872
|
minDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4873
4873
|
/**
|
|
4874
4874
|
* This field shall indicate the maximum time (in seconds) that the appliance expects to be in this slot for.
|
|
4875
4875
|
*
|
|
4876
|
-
* @see {@link MatterSpecification.
|
|
4876
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.2
|
|
4877
4877
|
*/
|
|
4878
4878
|
maxDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4879
4879
|
/**
|
|
4880
4880
|
* This field shall indicate the expected time (in seconds) that the appliance expects to be in this slot for.
|
|
4881
4881
|
*
|
|
4882
|
-
* @see {@link MatterSpecification.
|
|
4882
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.3
|
|
4883
4883
|
*/
|
|
4884
4884
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4885
4885
|
/**
|
|
@@ -4892,7 +4892,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4892
4892
|
*
|
|
4893
4893
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
4894
4894
|
*
|
|
4895
|
-
* @see {@link MatterSpecification.
|
|
4895
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.4
|
|
4896
4896
|
*/
|
|
4897
4897
|
elapsedSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4898
4898
|
/**
|
|
@@ -4908,13 +4908,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4908
4908
|
*
|
|
4909
4909
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
4910
4910
|
*
|
|
4911
|
-
* @see {@link MatterSpecification.
|
|
4911
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.5
|
|
4912
4912
|
*/
|
|
4913
4913
|
remainingSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4914
4914
|
/**
|
|
4915
4915
|
* This field shall indicate whether this slot can be paused.
|
|
4916
4916
|
*
|
|
4917
|
-
* @see {@link MatterSpecification.
|
|
4917
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.6
|
|
4918
4918
|
*/
|
|
4919
4919
|
slotIsPausable: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
4920
4920
|
/**
|
|
@@ -4922,13 +4922,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4922
4922
|
* controllers trying to pause ESAs for short periods and then resuming operation in a cyclic fashion which may
|
|
4923
4923
|
* damage or cause excess energy to be consumed with restarting of an operation.
|
|
4924
4924
|
*
|
|
4925
|
-
* @see {@link MatterSpecification.
|
|
4925
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.7
|
|
4926
4926
|
*/
|
|
4927
4927
|
minPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
4928
4928
|
/**
|
|
4929
4929
|
* This field shall indicate the longest period that the slot can be paused for.
|
|
4930
4930
|
*
|
|
4931
|
-
* @see {@link MatterSpecification.
|
|
4931
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.8
|
|
4932
4932
|
*/
|
|
4933
4933
|
maxPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
4934
4934
|
/**
|
|
@@ -4951,7 +4951,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4951
4951
|
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
4952
4952
|
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
4953
4953
|
*
|
|
4954
|
-
* @see {@link MatterSpecification.
|
|
4954
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.9
|
|
4955
4955
|
*/
|
|
4956
4956
|
manufacturerEsaState: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
4957
4957
|
/**
|
|
@@ -4959,7 +4959,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4959
4959
|
* considered the average value over the slot, and some variation from this would be expected (for example, as
|
|
4960
4960
|
* it is ramping up).
|
|
4961
4961
|
*
|
|
4962
|
-
* @see {@link MatterSpecification.
|
|
4962
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.10
|
|
4963
4963
|
*/
|
|
4964
4964
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
4965
4965
|
/**
|
|
@@ -4968,7 +4968,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4968
4968
|
*
|
|
4969
4969
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
4970
4970
|
*
|
|
4971
|
-
* @see {@link MatterSpecification.
|
|
4971
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.11
|
|
4972
4972
|
*/
|
|
4973
4973
|
minPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
4974
4974
|
/**
|
|
@@ -4977,7 +4977,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4977
4977
|
*
|
|
4978
4978
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
4979
4979
|
*
|
|
4980
|
-
* @see {@link MatterSpecification.
|
|
4980
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.12
|
|
4981
4981
|
*/
|
|
4982
4982
|
maxPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
4983
4983
|
/**
|
|
@@ -4985,7 +4985,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
4985
4985
|
*
|
|
4986
4986
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative energy.
|
|
4987
4987
|
*
|
|
4988
|
-
* @see {@link MatterSpecification.
|
|
4988
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.13
|
|
4989
4989
|
*/
|
|
4990
4990
|
nominalEnergy: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
4991
4991
|
/**
|
|
@@ -5008,13 +5008,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5008
5008
|
* If the ESA cannot calculate its cost for any reason (such as losing its connection to a Price server) it may
|
|
5009
5009
|
* omit this field. This is treated as extra meta data that an EMS may use to optimize a system.
|
|
5010
5010
|
*
|
|
5011
|
-
* @see {@link MatterSpecification.
|
|
5011
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.14
|
|
5012
5012
|
*/
|
|
5013
5013
|
costs: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
5014
5014
|
/**
|
|
5015
5015
|
* This field shall indicate the type of cost being represented (see CostTypeEnum).
|
|
5016
5016
|
*
|
|
5017
|
-
* @see {@link MatterSpecification.
|
|
5017
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.1
|
|
5018
5018
|
*/
|
|
5019
5019
|
costType: import("../tlv/TlvObject.js").FieldType<CostType>;
|
|
5020
5020
|
/**
|
|
@@ -5023,14 +5023,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5023
5023
|
*
|
|
5024
5024
|
* For example, if the Value was -302 and DecimalPoints was 2, then this would represent a benefit of 3.02.
|
|
5025
5025
|
*
|
|
5026
|
-
* @see {@link MatterSpecification.
|
|
5026
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.2
|
|
5027
5027
|
*/
|
|
5028
5028
|
value: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5029
5029
|
/**
|
|
5030
5030
|
* This field shall indicate the number of digits to the right of the decimal point in the Value field. For
|
|
5031
5031
|
* example, if the Value was 102 and DecimalPoints was 2, then this would represent a cost of 1.02.
|
|
5032
5032
|
*
|
|
5033
|
-
* @see {@link MatterSpecification.
|
|
5033
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.3
|
|
5034
5034
|
*/
|
|
5035
5035
|
decimalPoints: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5036
5036
|
/**
|
|
@@ -5039,7 +5039,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5039
5039
|
*
|
|
5040
5040
|
* This is an optional field. It shall be included if CostType is Financial.
|
|
5041
5041
|
*
|
|
5042
|
-
* @see {@link MatterSpecification.
|
|
5042
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.4
|
|
5043
5043
|
*/
|
|
5044
5044
|
currency: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
5045
5045
|
}>[]>;
|
|
@@ -5050,7 +5050,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5050
5050
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
5051
5051
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
5052
5052
|
*
|
|
5053
|
-
* @see {@link MatterSpecification.
|
|
5053
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.15
|
|
5054
5054
|
*/
|
|
5055
5055
|
minPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
5056
5056
|
/**
|
|
@@ -5060,7 +5060,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5060
5060
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
5061
5061
|
* indicate it could be switched on to charge, but this would be the maximum power limit it can be set to.
|
|
5062
5062
|
*
|
|
5063
|
-
* @see {@link MatterSpecification.
|
|
5063
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.16
|
|
5064
5064
|
*/
|
|
5065
5065
|
maxPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
5066
5066
|
/**
|
|
@@ -5072,7 +5072,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5072
5072
|
*
|
|
5073
5073
|
* For example, a heat pump compressor may have a minimum cycle time of order a few minutes.
|
|
5074
5074
|
*
|
|
5075
|
-
* @see {@link MatterSpecification.
|
|
5075
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.17
|
|
5076
5076
|
*/
|
|
5077
5077
|
minDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
5078
5078
|
/**
|
|
@@ -5084,14 +5084,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5084
5084
|
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
5085
5085
|
* MaxPowerAdjustment power level).
|
|
5086
5086
|
*
|
|
5087
|
-
* @see {@link MatterSpecification.
|
|
5087
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.18
|
|
5088
5088
|
*/
|
|
5089
5089
|
maxDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
5090
5090
|
}>[]>;
|
|
5091
5091
|
/**
|
|
5092
5092
|
* This field shall contain the reason the current Forecast was generated.
|
|
5093
5093
|
*
|
|
5094
|
-
* @see {@link MatterSpecification.
|
|
5094
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.9
|
|
5095
5095
|
*/
|
|
5096
5096
|
forecastUpdateReason: import("../tlv/TlvObject.js").FieldType<ForecastUpdateReason>;
|
|
5097
5097
|
}> | null, any>;
|
|
@@ -5135,7 +5135,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5135
5135
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
5136
5136
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
5137
5137
|
*
|
|
5138
|
-
* @see {@link MatterSpecification.
|
|
5138
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.8
|
|
5139
5139
|
*/
|
|
5140
5140
|
readonly optOutState: Attribute<OptOutState, any>;
|
|
5141
5141
|
};
|
|
@@ -5178,7 +5178,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5178
5178
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
5179
5179
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
5180
5180
|
*
|
|
5181
|
-
* @see {@link MatterSpecification.
|
|
5181
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.8
|
|
5182
5182
|
*/
|
|
5183
5183
|
readonly optOutState: Attribute<OptOutState, any>;
|
|
5184
5184
|
};
|
|
@@ -5221,7 +5221,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5221
5221
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
5222
5222
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
5223
5223
|
*
|
|
5224
|
-
* @see {@link MatterSpecification.
|
|
5224
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.8
|
|
5225
5225
|
*/
|
|
5226
5226
|
readonly optOutState: Attribute<OptOutState, any>;
|
|
5227
5227
|
};
|
|
@@ -5264,7 +5264,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5264
5264
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
5265
5265
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
5266
5266
|
*
|
|
5267
|
-
* @see {@link MatterSpecification.
|
|
5267
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.8
|
|
5268
5268
|
*/
|
|
5269
5269
|
readonly optOutState: Attribute<OptOutState, any>;
|
|
5270
5270
|
};
|
|
@@ -5307,7 +5307,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5307
5307
|
* If the ESA is in the LocalOptOut, GridOptOut, or NoOptOut states, the device is still permitted to
|
|
5308
5308
|
* optimize its own energy usage, for example, using tariff information it may obtain.
|
|
5309
5309
|
*
|
|
5310
|
-
* @see {@link MatterSpecification.
|
|
5310
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.8
|
|
5311
5311
|
*/
|
|
5312
5312
|
readonly optOutState: Attribute<OptOutState, any>;
|
|
5313
5313
|
};
|
|
@@ -5321,7 +5321,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5321
5321
|
/**
|
|
5322
5322
|
* Allows a client to temporarily pause an operation and reduce the ESAs energy demand.
|
|
5323
5323
|
*
|
|
5324
|
-
* @see {@link MatterSpecification.
|
|
5324
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4
|
|
5325
5325
|
*/
|
|
5326
5326
|
readonly pauseRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
5327
5327
|
/**
|
|
@@ -5329,20 +5329,20 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5329
5329
|
* MinPauseDuration and MaxPauseDuration indicated in the ActiveSlotNumber index in the Slots list in the
|
|
5330
5330
|
* Forecast.
|
|
5331
5331
|
*
|
|
5332
|
-
* @see {@link MatterSpecification.
|
|
5332
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4.1
|
|
5333
5333
|
*/
|
|
5334
5334
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5335
5335
|
/**
|
|
5336
5336
|
* This field shall indicate the cause of the request from the EMS.
|
|
5337
5337
|
*
|
|
5338
|
-
* @see {@link MatterSpecification.
|
|
5338
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4.2
|
|
5339
5339
|
*/
|
|
5340
5340
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
5341
5341
|
}>, void, any>;
|
|
5342
5342
|
/**
|
|
5343
5343
|
* Allows a client to cancel the PauseRequest command and enable earlier resumption of operation.
|
|
5344
5344
|
*
|
|
5345
|
-
* @see {@link MatterSpecification.
|
|
5345
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.5
|
|
5346
5346
|
*/
|
|
5347
5347
|
readonly resumeRequest: Command<void, void, any>;
|
|
5348
5348
|
};
|
|
@@ -5350,19 +5350,19 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5350
5350
|
/**
|
|
5351
5351
|
* This event shall be generated when the ESA enters the Paused state. There is no data for this event.
|
|
5352
5352
|
*
|
|
5353
|
-
* @see {@link MatterSpecification.
|
|
5353
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.3
|
|
5354
5354
|
*/
|
|
5355
5355
|
readonly paused: Event<void, any>;
|
|
5356
5356
|
/**
|
|
5357
5357
|
* This event shall be generated when the ESA leaves the Paused state and resumes operation.
|
|
5358
5358
|
*
|
|
5359
|
-
* @see {@link MatterSpecification.
|
|
5359
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.4
|
|
5360
5360
|
*/
|
|
5361
5361
|
readonly resumed: Event<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
5362
5362
|
/**
|
|
5363
5363
|
* This field shall indicate the reason why the pause ended.
|
|
5364
5364
|
*
|
|
5365
|
-
* @see {@link MatterSpecification.
|
|
5365
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.4.1
|
|
5366
5366
|
*/
|
|
5367
5367
|
cause: import("../tlv/TlvObject.js").FieldType<Cause>;
|
|
5368
5368
|
}>, any>;
|
|
@@ -5378,7 +5378,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5378
5378
|
* Allows a client to adjust the start time of a Forecast sequence that has not yet started operation (i.e.
|
|
5379
5379
|
* where the current Forecast StartTime is in the future).
|
|
5380
5380
|
*
|
|
5381
|
-
* @see {@link MatterSpecification.
|
|
5381
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3
|
|
5382
5382
|
*/
|
|
5383
5383
|
readonly startTimeAdjustRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
5384
5384
|
/**
|
|
@@ -5391,13 +5391,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5391
5391
|
* This value shall be after the EarliestStartTime in the Forecast attribute. The new EndTime, that can be
|
|
5392
5392
|
* computed from the RequestedStartTime and the Forecast sequence duration, shall be before the LatestEndTime.
|
|
5393
5393
|
*
|
|
5394
|
-
* @see {@link MatterSpecification.
|
|
5394
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3.1
|
|
5395
5395
|
*/
|
|
5396
5396
|
requestedStartTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5397
5397
|
/**
|
|
5398
5398
|
* This field shall indicate the cause of the request from the EMS.
|
|
5399
5399
|
*
|
|
5400
|
-
* @see {@link MatterSpecification.
|
|
5400
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3.2
|
|
5401
5401
|
*/
|
|
5402
5402
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
5403
5403
|
}>, void, any>;
|
|
@@ -5412,20 +5412,20 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5412
5412
|
/**
|
|
5413
5413
|
* Allows a client to modify a Forecast within the limits allowed by the ESA.
|
|
5414
5414
|
*
|
|
5415
|
-
* @see {@link MatterSpecification.
|
|
5415
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6
|
|
5416
5416
|
*/
|
|
5417
5417
|
readonly modifyForecastRequest: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
5418
5418
|
/**
|
|
5419
5419
|
* This field shall indicate the ForecastID that is to be modified.
|
|
5420
5420
|
*
|
|
5421
|
-
* @see {@link MatterSpecification.
|
|
5421
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.1
|
|
5422
5422
|
*/
|
|
5423
5423
|
forecastId: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5424
5424
|
/**
|
|
5425
5425
|
* This field shall contain a list of SlotAdjustment parameters that should be modified in the corresponding
|
|
5426
5426
|
* Forecast with matching ForecastID.
|
|
5427
5427
|
*
|
|
5428
|
-
* @see {@link MatterSpecification.
|
|
5428
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.2
|
|
5429
5429
|
*/
|
|
5430
5430
|
slotAdjustments: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
5431
5431
|
/**
|
|
@@ -5433,7 +5433,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5433
5433
|
* be less than the actual length of the Slots list (implicitly it must be in the range 0 to 9 based on the
|
|
5434
5434
|
* maximum length of the Slots list constraint).
|
|
5435
5435
|
*
|
|
5436
|
-
* @see {@link MatterSpecification.
|
|
5436
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.1
|
|
5437
5437
|
*/
|
|
5438
5438
|
slotIndex: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5439
5439
|
/**
|
|
@@ -5443,7 +5443,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5443
5443
|
* This is a signed value and can be used to indicate charging or discharging. If the ESA does NOT support PFR
|
|
5444
5444
|
* this value shall be ignored by the ESA.
|
|
5445
5445
|
*
|
|
5446
|
-
* @see {@link MatterSpecification.
|
|
5446
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.2
|
|
5447
5447
|
*/
|
|
5448
5448
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
5449
5449
|
/**
|
|
@@ -5451,14 +5451,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5451
5451
|
* slot duration to. It MUST be between the MinDurationAdjustment and MaxDurationAdjustment for the slot as
|
|
5452
5452
|
* advertised by the ESA.
|
|
5453
5453
|
*
|
|
5454
|
-
* @see {@link MatterSpecification.
|
|
5454
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.3
|
|
5455
5455
|
*/
|
|
5456
5456
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5457
5457
|
}>[]>;
|
|
5458
5458
|
/**
|
|
5459
5459
|
* This field shall indicate the cause of the request from the EMS.
|
|
5460
5460
|
*
|
|
5461
|
-
* @see {@link MatterSpecification.
|
|
5461
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.3
|
|
5462
5462
|
*/
|
|
5463
5463
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
5464
5464
|
}>, void, any>;
|
|
@@ -5473,7 +5473,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5473
5473
|
/**
|
|
5474
5474
|
* Allows a client to ask the ESA to recompute its Forecast based on power and time constraints.
|
|
5475
5475
|
*
|
|
5476
|
-
* @see {@link MatterSpecification.
|
|
5476
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7
|
|
5477
5477
|
*/
|
|
5478
5478
|
readonly requestConstraintBasedForecast: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
5479
5479
|
/**
|
|
@@ -5492,7 +5492,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5492
5492
|
*
|
|
5493
5493
|
* trol field as follows:
|
|
5494
5494
|
*
|
|
5495
|
-
* @see {@link MatterSpecification.
|
|
5495
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7.1
|
|
5496
5496
|
*/
|
|
5497
5497
|
constraints: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
5498
5498
|
/**
|
|
@@ -5501,13 +5501,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5501
5501
|
*
|
|
5502
5502
|
* This value is in UTC and MUST be in the future.
|
|
5503
5503
|
*
|
|
5504
|
-
* @see {@link MatterSpecification.
|
|
5504
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.1
|
|
5505
5505
|
*/
|
|
5506
5506
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5507
5507
|
/**
|
|
5508
5508
|
* This field shall indicate the duration of the constraint in seconds.
|
|
5509
5509
|
*
|
|
5510
|
-
* @see {@link MatterSpecification.
|
|
5510
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.2
|
|
5511
5511
|
*/
|
|
5512
5512
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5513
5513
|
/**
|
|
@@ -5517,7 +5517,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5517
5517
|
*
|
|
5518
5518
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
5519
5519
|
*
|
|
5520
|
-
* @see {@link MatterSpecification.
|
|
5520
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.3
|
|
5521
5521
|
*/
|
|
5522
5522
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
5523
5523
|
/**
|
|
@@ -5526,7 +5526,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5526
5526
|
*
|
|
5527
5527
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
5528
5528
|
*
|
|
5529
|
-
* @see {@link MatterSpecification.
|
|
5529
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.4
|
|
5530
5530
|
*/
|
|
5531
5531
|
maximumEnergy: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
5532
5532
|
/**
|
|
@@ -5539,14 +5539,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5539
5539
|
*
|
|
5540
5540
|
* Note that the mapping between values and operation is manufacturer specific.
|
|
5541
5541
|
*
|
|
5542
|
-
* @see {@link MatterSpecification.
|
|
5542
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.5
|
|
5543
5543
|
*/
|
|
5544
5544
|
loadControl: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
5545
5545
|
}>[]>;
|
|
5546
5546
|
/**
|
|
5547
5547
|
* This field shall indicate the cause of the request from the EMS.
|
|
5548
5548
|
*
|
|
5549
|
-
* @see {@link MatterSpecification.
|
|
5549
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7.2
|
|
5550
5550
|
*/
|
|
5551
5551
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
5552
5552
|
}>, void, any>;
|
|
@@ -5562,7 +5562,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5562
5562
|
* Allows a client to request cancellation of a previous adjustment request in a StartTimeAdjustRequest,
|
|
5563
5563
|
* ModifyForecastRequest or RequestConstraintBasedForecast command.
|
|
5564
5564
|
*
|
|
5565
|
-
* @see {@link MatterSpecification.
|
|
5565
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.8
|
|
5566
5566
|
*/
|
|
5567
5567
|
readonly cancelRequest: Command<void, void, any>;
|
|
5568
5568
|
};
|
|
@@ -5577,7 +5577,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5577
5577
|
* Allows a client to request cancellation of a previous adjustment request in a StartTimeAdjustRequest,
|
|
5578
5578
|
* ModifyForecastRequest or RequestConstraintBasedForecast command.
|
|
5579
5579
|
*
|
|
5580
|
-
* @see {@link MatterSpecification.
|
|
5580
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.8
|
|
5581
5581
|
*/
|
|
5582
5582
|
readonly cancelRequest: Command<void, void, any>;
|
|
5583
5583
|
};
|
|
@@ -5592,7 +5592,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5592
5592
|
* Allows a client to request cancellation of a previous adjustment request in a StartTimeAdjustRequest,
|
|
5593
5593
|
* ModifyForecastRequest or RequestConstraintBasedForecast command.
|
|
5594
5594
|
*
|
|
5595
|
-
* @see {@link MatterSpecification.
|
|
5595
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.8
|
|
5596
5596
|
*/
|
|
5597
5597
|
readonly cancelRequest: Command<void, void, any>;
|
|
5598
5598
|
};
|
|
@@ -5670,7 +5670,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5670
5670
|
* Per the Matter specification you cannot use {@link DeviceEnergyManagementCluster} without enabling certain
|
|
5671
5671
|
* feature combinations. You must use the {@link with} factory method to obtain a working cluster.
|
|
5672
5672
|
*
|
|
5673
|
-
* @see {@link MatterSpecification.
|
|
5673
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2
|
|
5674
5674
|
*/
|
|
5675
5675
|
interface Cluster extends Identity<typeof ClusterInstance> {
|
|
5676
5676
|
}
|
|
@@ -5701,7 +5701,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5701
5701
|
* control the discharging (and re-charging) of the vehicle if the EVSE and vehicle support the V2X feature
|
|
5702
5702
|
* of the EVSE cluster of the associated EVSE device.
|
|
5703
5703
|
*
|
|
5704
|
-
* @see {@link MatterSpecification.
|
|
5704
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.1
|
|
5705
5705
|
*/
|
|
5706
5706
|
readonly powerAdjustment: BitFlag;
|
|
5707
5707
|
/**
|
|
@@ -5745,7 +5745,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5745
5745
|
*
|
|
5746
5746
|
* The ESA indicates its power adjustment range and its nominal power consumption as part of its Forecast.
|
|
5747
5747
|
*
|
|
5748
|
-
* @see {@link MatterSpecification.
|
|
5748
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.2
|
|
5749
5749
|
*/
|
|
5750
5750
|
readonly powerForecastReporting: BitFlag;
|
|
5751
5751
|
/**
|
|
@@ -5764,7 +5764,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5764
5764
|
* Once the EMS has built a model of the state vs observed power consumption, it may request a forecast
|
|
5765
5765
|
* adjustment for particular times of the day, encouraging the ESA to use power at alternative times.
|
|
5766
5766
|
*
|
|
5767
|
-
* @see {@link MatterSpecification.
|
|
5767
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.3
|
|
5768
5768
|
*/
|
|
5769
5769
|
readonly stateForecastReporting: BitFlag;
|
|
5770
5770
|
/**
|
|
@@ -5789,7 +5789,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5789
5789
|
* It does this by sending a StartTimeAdjustRequest to the washing machine to request delaying the start of
|
|
5790
5790
|
* the washing cycle.
|
|
5791
5791
|
*
|
|
5792
|
-
* @see {@link MatterSpecification.
|
|
5792
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.4
|
|
5793
5793
|
*/
|
|
5794
5794
|
readonly startTimeAdjustment: BitFlag;
|
|
5795
5795
|
/**
|
|
@@ -5814,7 +5814,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5814
5814
|
* It does this by sending a PauseRequest to the washing machine to request pausing the current step of the
|
|
5815
5815
|
* forecast power usage for a period to allow other home loads to finish before resuming the washing cycle.
|
|
5816
5816
|
*
|
|
5817
|
-
* @see {@link MatterSpecification.
|
|
5817
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.5
|
|
5818
5818
|
*/
|
|
5819
5819
|
readonly pausable: BitFlag;
|
|
5820
5820
|
/**
|
|
@@ -5845,7 +5845,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5845
5845
|
* at a lower power consumption (within the solar excess power) which requires the heat pump to run for a
|
|
5846
5846
|
* longer duration to achieve its required energy demand.
|
|
5847
5847
|
*
|
|
5848
|
-
* @see {@link MatterSpecification.
|
|
5848
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.6
|
|
5849
5849
|
*/
|
|
5850
5850
|
readonly forecastAdjustment: BitFlag;
|
|
5851
5851
|
/**
|
|
@@ -5873,7 +5873,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5873
5873
|
* NominalPower consumption during the constraint period, which may require it to decrease its charge rate
|
|
5874
5874
|
* outside the constraint period to achieve its required energy demand.
|
|
5875
5875
|
*
|
|
5876
|
-
* @see {@link MatterSpecification.
|
|
5876
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.4.7
|
|
5877
5877
|
*/
|
|
5878
5878
|
readonly constraintBasedAdjustment: BitFlag;
|
|
5879
5879
|
};
|
|
@@ -5895,7 +5895,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5895
5895
|
*
|
|
5896
5896
|
* In this example the list of PowerAdjustStructs allows multiple scenarios to be offered as follows:
|
|
5897
5897
|
*
|
|
5898
|
-
* @see {@link MatterSpecification.
|
|
5898
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.12
|
|
5899
5899
|
*/
|
|
5900
5900
|
powerAdjustCapability: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
5901
5901
|
/**
|
|
@@ -5904,7 +5904,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5904
5904
|
* Note that this is a signed value. Negative values indicate power flows out of the node (e.g. discharging a
|
|
5905
5905
|
* battery).
|
|
5906
5906
|
*
|
|
5907
|
-
* @see {@link MatterSpecification.
|
|
5907
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.1
|
|
5908
5908
|
*/
|
|
5909
5909
|
minPower: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
5910
5910
|
/**
|
|
@@ -5923,7 +5923,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5923
5923
|
* In another example, if a battery storage inverter can charge its internal battery, between 0W and 2000W. Here
|
|
5924
5924
|
* power is flowing into the node when charging. As such the MinPower becomes 0W and MaxPower becomes 2000W.
|
|
5925
5925
|
*
|
|
5926
|
-
* @see {@link MatterSpecification.
|
|
5926
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.2
|
|
5927
5927
|
*/
|
|
5928
5928
|
maxPower: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
5929
5929
|
/**
|
|
@@ -5931,7 +5931,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5931
5931
|
* adjustment. Manufacturers may use this to as an anti-cycling capability to avoid controllers from rapidly
|
|
5932
5932
|
* making power adjustments.
|
|
5933
5933
|
*
|
|
5934
|
-
* @see {@link MatterSpecification.
|
|
5934
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.3
|
|
5935
5935
|
*/
|
|
5936
5936
|
minDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5937
5937
|
/**
|
|
@@ -5939,7 +5939,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5939
5939
|
* adjustment. Manufacturers may use this to protect the user experience, to avoid over heating of the ESA,
|
|
5940
5940
|
* ensuring that there is sufficient headroom to use or store energy in the ESA or for any other reason.
|
|
5941
5941
|
*
|
|
5942
|
-
* @see {@link MatterSpecification.
|
|
5942
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.10.4
|
|
5943
5943
|
*/
|
|
5944
5944
|
maxDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5945
5945
|
}>[] | null>;
|
|
@@ -5963,33 +5963,33 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5963
5963
|
*
|
|
5964
5964
|
* The value of ForecastID is allowed to wrap.
|
|
5965
5965
|
*
|
|
5966
|
-
* @see {@link MatterSpecification.
|
|
5966
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.1
|
|
5967
5967
|
*/
|
|
5968
5968
|
forecastId: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5969
5969
|
/**
|
|
5970
5970
|
* This field shall indicate which element of the Slots list is currently active in the Forecast sequence. A
|
|
5971
5971
|
* null value indicates that the sequence has not yet started.
|
|
5972
5972
|
*
|
|
5973
|
-
* @see {@link MatterSpecification.
|
|
5973
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.2
|
|
5974
5974
|
*/
|
|
5975
5975
|
activeSlotNumber: import("../tlv/TlvObject.js").FieldType<number | null>;
|
|
5976
5976
|
/**
|
|
5977
5977
|
* This field shall indicate the planned start time, in UTC, for the entire Forecast.
|
|
5978
5978
|
*
|
|
5979
|
-
* @see {@link MatterSpecification.
|
|
5979
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.3
|
|
5980
5980
|
*/
|
|
5981
5981
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5982
5982
|
/**
|
|
5983
5983
|
* This field shall indicate the planned end time, in UTC, for the entire Forecast.
|
|
5984
5984
|
*
|
|
5985
|
-
* @see {@link MatterSpecification.
|
|
5985
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.4
|
|
5986
5986
|
*/
|
|
5987
5987
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
5988
5988
|
/**
|
|
5989
5989
|
* This field shall indicate the earliest start time, in UTC, that the entire Forecast can be shifted to. A null
|
|
5990
5990
|
* value indicates that it can be started immediately.
|
|
5991
5991
|
*
|
|
5992
|
-
* @see {@link MatterSpecification.
|
|
5992
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.5
|
|
5993
5993
|
*/
|
|
5994
5994
|
earliestStartTime: import("../tlv/TlvObject.js").OptionalFieldType<number | null>;
|
|
5995
5995
|
/**
|
|
@@ -5998,7 +5998,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
5998
5998
|
* e.g. for an EVSE charging session, this may indicate the departure time for the vehicle, by which time the
|
|
5999
5999
|
* charging session must end.
|
|
6000
6000
|
*
|
|
6001
|
-
* @see {@link MatterSpecification.
|
|
6001
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.6
|
|
6002
6002
|
*/
|
|
6003
6003
|
latestEndTime: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
6004
6004
|
/**
|
|
@@ -6006,7 +6006,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6006
6006
|
* this flag and if it is false, then none of the slots contain SlotIsPausable set to true. This can save a
|
|
6007
6007
|
* client from having to check each slot in the list.
|
|
6008
6008
|
*
|
|
6009
|
-
* @see {@link MatterSpecification.
|
|
6009
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.7
|
|
6010
6010
|
*/
|
|
6011
6011
|
isPausable: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
6012
6012
|
/**
|
|
@@ -6014,25 +6014,25 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6014
6014
|
*
|
|
6015
6015
|
* It shall contain at least 1 entry, and a maximum of 10.
|
|
6016
6016
|
*
|
|
6017
|
-
* @see {@link MatterSpecification.
|
|
6017
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.8
|
|
6018
6018
|
*/
|
|
6019
6019
|
slots: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
6020
6020
|
/**
|
|
6021
6021
|
* This field shall indicate the minimum time (in seconds) that the appliance expects to be in this slot for.
|
|
6022
6022
|
*
|
|
6023
|
-
* @see {@link MatterSpecification.
|
|
6023
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.1
|
|
6024
6024
|
*/
|
|
6025
6025
|
minDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6026
6026
|
/**
|
|
6027
6027
|
* This field shall indicate the maximum time (in seconds) that the appliance expects to be in this slot for.
|
|
6028
6028
|
*
|
|
6029
|
-
* @see {@link MatterSpecification.
|
|
6029
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.2
|
|
6030
6030
|
*/
|
|
6031
6031
|
maxDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6032
6032
|
/**
|
|
6033
6033
|
* This field shall indicate the expected time (in seconds) that the appliance expects to be in this slot for.
|
|
6034
6034
|
*
|
|
6035
|
-
* @see {@link MatterSpecification.
|
|
6035
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.3
|
|
6036
6036
|
*/
|
|
6037
6037
|
defaultDuration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6038
6038
|
/**
|
|
@@ -6045,7 +6045,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6045
6045
|
*
|
|
6046
6046
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
6047
6047
|
*
|
|
6048
|
-
* @see {@link MatterSpecification.
|
|
6048
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.4
|
|
6049
6049
|
*/
|
|
6050
6050
|
elapsedSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6051
6051
|
/**
|
|
@@ -6061,13 +6061,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6061
6061
|
*
|
|
6062
6062
|
* When the Forecast attribute is read, then this value shall be the most recent value.
|
|
6063
6063
|
*
|
|
6064
|
-
* @see {@link MatterSpecification.
|
|
6064
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.5
|
|
6065
6065
|
*/
|
|
6066
6066
|
remainingSlotTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6067
6067
|
/**
|
|
6068
6068
|
* This field shall indicate whether this slot can be paused.
|
|
6069
6069
|
*
|
|
6070
|
-
* @see {@link MatterSpecification.
|
|
6070
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.6
|
|
6071
6071
|
*/
|
|
6072
6072
|
slotIsPausable: import("../tlv/TlvObject.js").OptionalFieldType<boolean>;
|
|
6073
6073
|
/**
|
|
@@ -6075,13 +6075,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6075
6075
|
* controllers trying to pause ESAs for short periods and then resuming operation in a cyclic fashion which may
|
|
6076
6076
|
* damage or cause excess energy to be consumed with restarting of an operation.
|
|
6077
6077
|
*
|
|
6078
|
-
* @see {@link MatterSpecification.
|
|
6078
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.7
|
|
6079
6079
|
*/
|
|
6080
6080
|
minPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
6081
6081
|
/**
|
|
6082
6082
|
* This field shall indicate the longest period that the slot can be paused for.
|
|
6083
6083
|
*
|
|
6084
|
-
* @see {@link MatterSpecification.
|
|
6084
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.8
|
|
6085
6085
|
*/
|
|
6086
6086
|
maxPauseDuration: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
6087
6087
|
/**
|
|
@@ -6104,7 +6104,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6104
6104
|
* along with observed power drawn to predict the power draw from the appliance and potentially ask it to modify
|
|
6105
6105
|
* its timing via one of the adjustment request commands, or adjust other ESAs power to compensate.
|
|
6106
6106
|
*
|
|
6107
|
-
* @see {@link MatterSpecification.
|
|
6107
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.9
|
|
6108
6108
|
*/
|
|
6109
6109
|
manufacturerEsaState: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
6110
6110
|
/**
|
|
@@ -6112,7 +6112,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6112
6112
|
* considered the average value over the slot, and some variation from this would be expected (for example, as
|
|
6113
6113
|
* it is ramping up).
|
|
6114
6114
|
*
|
|
6115
|
-
* @see {@link MatterSpecification.
|
|
6115
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.10
|
|
6116
6116
|
*/
|
|
6117
6117
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
6118
6118
|
/**
|
|
@@ -6121,7 +6121,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6121
6121
|
*
|
|
6122
6122
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
6123
6123
|
*
|
|
6124
|
-
* @see {@link MatterSpecification.
|
|
6124
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.11
|
|
6125
6125
|
*/
|
|
6126
6126
|
minPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
6127
6127
|
/**
|
|
@@ -6130,7 +6130,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6130
6130
|
*
|
|
6131
6131
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative power.
|
|
6132
6132
|
*
|
|
6133
|
-
* @see {@link MatterSpecification.
|
|
6133
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.12
|
|
6134
6134
|
*/
|
|
6135
6135
|
maxPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
6136
6136
|
/**
|
|
@@ -6138,7 +6138,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6138
6138
|
*
|
|
6139
6139
|
* Some appliances (e.g. battery inverters which can charge and discharge) may have a negative energy.
|
|
6140
6140
|
*
|
|
6141
|
-
* @see {@link MatterSpecification.
|
|
6141
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.13
|
|
6142
6142
|
*/
|
|
6143
6143
|
nominalEnergy: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
6144
6144
|
/**
|
|
@@ -6161,13 +6161,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6161
6161
|
* If the ESA cannot calculate its cost for any reason (such as losing its connection to a Price server) it may
|
|
6162
6162
|
* omit this field. This is treated as extra meta data that an EMS may use to optimize a system.
|
|
6163
6163
|
*
|
|
6164
|
-
* @see {@link MatterSpecification.
|
|
6164
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.14
|
|
6165
6165
|
*/
|
|
6166
6166
|
costs: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
6167
6167
|
/**
|
|
6168
6168
|
* This field shall indicate the type of cost being represented (see CostTypeEnum).
|
|
6169
6169
|
*
|
|
6170
|
-
* @see {@link MatterSpecification.
|
|
6170
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.1
|
|
6171
6171
|
*/
|
|
6172
6172
|
costType: import("../tlv/TlvObject.js").FieldType<CostType>;
|
|
6173
6173
|
/**
|
|
@@ -6176,14 +6176,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6176
6176
|
*
|
|
6177
6177
|
* For example, if the Value was -302 and DecimalPoints was 2, then this would represent a benefit of 3.02.
|
|
6178
6178
|
*
|
|
6179
|
-
* @see {@link MatterSpecification.
|
|
6179
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.2
|
|
6180
6180
|
*/
|
|
6181
6181
|
value: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6182
6182
|
/**
|
|
6183
6183
|
* This field shall indicate the number of digits to the right of the decimal point in the Value field. For
|
|
6184
6184
|
* example, if the Value was 102 and DecimalPoints was 2, then this would represent a cost of 1.02.
|
|
6185
6185
|
*
|
|
6186
|
-
* @see {@link MatterSpecification.
|
|
6186
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.3
|
|
6187
6187
|
*/
|
|
6188
6188
|
decimalPoints: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6189
6189
|
/**
|
|
@@ -6192,7 +6192,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6192
6192
|
*
|
|
6193
6193
|
* This is an optional field. It shall be included if CostType is Financial.
|
|
6194
6194
|
*
|
|
6195
|
-
* @see {@link MatterSpecification.
|
|
6195
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.9.4
|
|
6196
6196
|
*/
|
|
6197
6197
|
currency: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
6198
6198
|
}>[]>;
|
|
@@ -6203,7 +6203,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6203
6203
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
6204
6204
|
* indicate it could be switched on to charge, but this would be the minimum power limit it can be set to.
|
|
6205
6205
|
*
|
|
6206
|
-
* @see {@link MatterSpecification.
|
|
6206
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.15
|
|
6207
6207
|
*/
|
|
6208
6208
|
minPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
6209
6209
|
/**
|
|
@@ -6213,7 +6213,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6213
6213
|
* the slot indicates a NominalPower of 0W (indicating it is expecting to be off), this allows an ESA to
|
|
6214
6214
|
* indicate it could be switched on to charge, but this would be the maximum power limit it can be set to.
|
|
6215
6215
|
*
|
|
6216
|
-
* @see {@link MatterSpecification.
|
|
6216
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.16
|
|
6217
6217
|
*/
|
|
6218
6218
|
maxPowerAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
6219
6219
|
/**
|
|
@@ -6225,7 +6225,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6225
6225
|
*
|
|
6226
6226
|
* For example, a heat pump compressor may have a minimum cycle time of order a few minutes.
|
|
6227
6227
|
*
|
|
6228
|
-
* @see {@link MatterSpecification.
|
|
6228
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.17
|
|
6229
6229
|
*/
|
|
6230
6230
|
minDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
6231
6231
|
/**
|
|
@@ -6237,14 +6237,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6237
6237
|
* which can be discharged, it may equally indicate the maximum time the battery could be discharged for (at the
|
|
6238
6238
|
* MaxPowerAdjustment power level).
|
|
6239
6239
|
*
|
|
6240
|
-
* @see {@link MatterSpecification.
|
|
6240
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.14.18
|
|
6241
6241
|
*/
|
|
6242
6242
|
maxDurationAdjustment: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
6243
6243
|
}>[]>;
|
|
6244
6244
|
/**
|
|
6245
6245
|
* This field shall contain the reason the current Forecast was generated.
|
|
6246
6246
|
*
|
|
6247
|
-
* @see {@link MatterSpecification.
|
|
6247
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.13.9
|
|
6248
6248
|
*/
|
|
6249
6249
|
forecastUpdateReason: import("../tlv/TlvObject.js").FieldType<ForecastUpdateReason>;
|
|
6250
6250
|
}> | null, any> & {
|
|
@@ -6287,7 +6287,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6287
6287
|
* typical best use of energy. For example, an EVSE may not always have an EV plugged in, so knowing the
|
|
6288
6288
|
* type of ESA that is being controlled can allow advanced energy management strategies.
|
|
6289
6289
|
*
|
|
6290
|
-
* @see {@link MatterSpecification.
|
|
6290
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.1
|
|
6291
6291
|
*/
|
|
6292
6292
|
readonly esaType: FixedAttribute<EsaType, any>;
|
|
6293
6293
|
/**
|
|
@@ -6309,7 +6309,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6309
6309
|
*
|
|
6310
6310
|
* Example:
|
|
6311
6311
|
*
|
|
6312
|
-
* @see {@link MatterSpecification.
|
|
6312
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.2
|
|
6313
6313
|
*/
|
|
6314
6314
|
readonly esaCanGenerate: FixedAttribute<boolean, any>;
|
|
6315
6315
|
/**
|
|
@@ -6323,7 +6323,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6323
6323
|
* for example to avoid the EMS accidentally starting or stopping the appliance when it is being serviced or
|
|
6324
6324
|
* tested.
|
|
6325
6325
|
*
|
|
6326
|
-
* @see {@link MatterSpecification.
|
|
6326
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.3
|
|
6327
6327
|
*/
|
|
6328
6328
|
readonly esaState: Attribute<EsaState, any>;
|
|
6329
6329
|
/**
|
|
@@ -6336,7 +6336,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6336
6336
|
* in the home, the AbsMinPower will be a negative number representing the maximum power that the ESA can
|
|
6337
6337
|
* discharge its internal battery.
|
|
6338
6338
|
*
|
|
6339
|
-
* @see {@link MatterSpecification.
|
|
6339
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.4
|
|
6340
6340
|
*/
|
|
6341
6341
|
readonly absMinPower: Attribute<number | bigint, any>;
|
|
6342
6342
|
/**
|
|
@@ -6349,7 +6349,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6349
6349
|
* For example, a battery storage inverter that can charge its battery at a maximum power of 2000W and can
|
|
6350
6350
|
* discharge the battery at a maximum power of 3000W, would have a AbsMinPower: -3000, AbsMaxPower: 2000W.
|
|
6351
6351
|
*
|
|
6352
|
-
* @see {@link MatterSpecification.
|
|
6352
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.8.5
|
|
6353
6353
|
*/
|
|
6354
6354
|
readonly absMaxPower: Attribute<number | bigint, any>;
|
|
6355
6355
|
};
|
|
@@ -6361,7 +6361,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6361
6361
|
* This value shall be between the MinPower and MaxPower fields of the PowerAdjustStruct in the
|
|
6362
6362
|
* PowerAdjustmentCapability attribute.
|
|
6363
6363
|
*
|
|
6364
|
-
* @see {@link MatterSpecification.
|
|
6364
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.1
|
|
6365
6365
|
*/
|
|
6366
6366
|
power: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
6367
6367
|
/**
|
|
@@ -6370,13 +6370,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6370
6370
|
* This value shall be between the MinDuration and MaxDuration fields of the PowerAdjustStruct in the
|
|
6371
6371
|
* PowerAdjustmentCapability attribute.
|
|
6372
6372
|
*
|
|
6373
|
-
* @see {@link MatterSpecification.
|
|
6373
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.2
|
|
6374
6374
|
*/
|
|
6375
6375
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6376
6376
|
/**
|
|
6377
6377
|
* This field shall indicate the cause of the request from the EMS.
|
|
6378
6378
|
*
|
|
6379
|
-
* @see {@link MatterSpecification.
|
|
6379
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.1.3
|
|
6380
6380
|
*/
|
|
6381
6381
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
6382
6382
|
}>, void, any> & {
|
|
@@ -6406,13 +6406,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6406
6406
|
* This value shall be after the EarliestStartTime in the Forecast attribute. The new EndTime, that can be
|
|
6407
6407
|
* computed from the RequestedStartTime and the Forecast sequence duration, shall be before the LatestEndTime.
|
|
6408
6408
|
*
|
|
6409
|
-
* @see {@link MatterSpecification.
|
|
6409
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3.1
|
|
6410
6410
|
*/
|
|
6411
6411
|
requestedStartTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6412
6412
|
/**
|
|
6413
6413
|
* This field shall indicate the cause of the request from the EMS.
|
|
6414
6414
|
*
|
|
6415
|
-
* @see {@link MatterSpecification.
|
|
6415
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.3.2
|
|
6416
6416
|
*/
|
|
6417
6417
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
6418
6418
|
}>, void, any> & {
|
|
@@ -6429,13 +6429,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6429
6429
|
* MinPauseDuration and MaxPauseDuration indicated in the ActiveSlotNumber index in the Slots list in the
|
|
6430
6430
|
* Forecast.
|
|
6431
6431
|
*
|
|
6432
|
-
* @see {@link MatterSpecification.
|
|
6432
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4.1
|
|
6433
6433
|
*/
|
|
6434
6434
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6435
6435
|
/**
|
|
6436
6436
|
* This field shall indicate the cause of the request from the EMS.
|
|
6437
6437
|
*
|
|
6438
|
-
* @see {@link MatterSpecification.
|
|
6438
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.4.2
|
|
6439
6439
|
*/
|
|
6440
6440
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
6441
6441
|
}>, void, any> & {
|
|
@@ -6458,14 +6458,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6458
6458
|
/**
|
|
6459
6459
|
* This field shall indicate the ForecastID that is to be modified.
|
|
6460
6460
|
*
|
|
6461
|
-
* @see {@link MatterSpecification.
|
|
6461
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.1
|
|
6462
6462
|
*/
|
|
6463
6463
|
forecastId: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6464
6464
|
/**
|
|
6465
6465
|
* This field shall contain a list of SlotAdjustment parameters that should be modified in the corresponding
|
|
6466
6466
|
* Forecast with matching ForecastID.
|
|
6467
6467
|
*
|
|
6468
|
-
* @see {@link MatterSpecification.
|
|
6468
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.2
|
|
6469
6469
|
*/
|
|
6470
6470
|
slotAdjustments: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
6471
6471
|
/**
|
|
@@ -6473,7 +6473,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6473
6473
|
* be less than the actual length of the Slots list (implicitly it must be in the range 0 to 9 based on the
|
|
6474
6474
|
* maximum length of the Slots list constraint).
|
|
6475
6475
|
*
|
|
6476
|
-
* @see {@link MatterSpecification.
|
|
6476
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.1
|
|
6477
6477
|
*/
|
|
6478
6478
|
slotIndex: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6479
6479
|
/**
|
|
@@ -6483,7 +6483,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6483
6483
|
* This is a signed value and can be used to indicate charging or discharging. If the ESA does NOT support PFR
|
|
6484
6484
|
* this value shall be ignored by the ESA.
|
|
6485
6485
|
*
|
|
6486
|
-
* @see {@link MatterSpecification.
|
|
6486
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.2
|
|
6487
6487
|
*/
|
|
6488
6488
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
6489
6489
|
/**
|
|
@@ -6491,14 +6491,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6491
6491
|
* slot duration to. It MUST be between the MinDurationAdjustment and MaxDurationAdjustment for the slot as
|
|
6492
6492
|
* advertised by the ESA.
|
|
6493
6493
|
*
|
|
6494
|
-
* @see {@link MatterSpecification.
|
|
6494
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.15.3
|
|
6495
6495
|
*/
|
|
6496
6496
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6497
6497
|
}>[]>;
|
|
6498
6498
|
/**
|
|
6499
6499
|
* This field shall indicate the cause of the request from the EMS.
|
|
6500
6500
|
*
|
|
6501
|
-
* @see {@link MatterSpecification.
|
|
6501
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.6.3
|
|
6502
6502
|
*/
|
|
6503
6503
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
6504
6504
|
}>, void, any> & {
|
|
@@ -6526,7 +6526,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6526
6526
|
*
|
|
6527
6527
|
* trol field as follows:
|
|
6528
6528
|
*
|
|
6529
|
-
* @see {@link MatterSpecification.
|
|
6529
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7.1
|
|
6530
6530
|
*/
|
|
6531
6531
|
constraints: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
6532
6532
|
/**
|
|
@@ -6535,13 +6535,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6535
6535
|
*
|
|
6536
6536
|
* This value is in UTC and MUST be in the future.
|
|
6537
6537
|
*
|
|
6538
|
-
* @see {@link MatterSpecification.
|
|
6538
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.1
|
|
6539
6539
|
*/
|
|
6540
6540
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6541
6541
|
/**
|
|
6542
6542
|
* This field shall indicate the duration of the constraint in seconds.
|
|
6543
6543
|
*
|
|
6544
|
-
* @see {@link MatterSpecification.
|
|
6544
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.2
|
|
6545
6545
|
*/
|
|
6546
6546
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6547
6547
|
/**
|
|
@@ -6551,7 +6551,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6551
6551
|
*
|
|
6552
6552
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
6553
6553
|
*
|
|
6554
|
-
* @see {@link MatterSpecification.
|
|
6554
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.3
|
|
6555
6555
|
*/
|
|
6556
6556
|
nominalPower: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
6557
6557
|
/**
|
|
@@ -6560,7 +6560,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6560
6560
|
*
|
|
6561
6561
|
* This is a signed value and can be used to indicate charging or discharging.
|
|
6562
6562
|
*
|
|
6563
|
-
* @see {@link MatterSpecification.
|
|
6563
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.4
|
|
6564
6564
|
*/
|
|
6565
6565
|
maximumEnergy: import("../tlv/TlvObject.js").OptionalFieldType<number | bigint>;
|
|
6566
6566
|
/**
|
|
@@ -6573,14 +6573,14 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6573
6573
|
*
|
|
6574
6574
|
* Note that the mapping between values and operation is manufacturer specific.
|
|
6575
6575
|
*
|
|
6576
|
-
* @see {@link MatterSpecification.
|
|
6576
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.7.16.5
|
|
6577
6577
|
*/
|
|
6578
6578
|
loadControl: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
6579
6579
|
}>[]>;
|
|
6580
6580
|
/**
|
|
6581
6581
|
* This field shall indicate the cause of the request from the EMS.
|
|
6582
6582
|
*
|
|
6583
|
-
* @see {@link MatterSpecification.
|
|
6583
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.9.7.2
|
|
6584
6584
|
*/
|
|
6585
6585
|
cause: import("../tlv/TlvObject.js").FieldType<AdjustmentCause>;
|
|
6586
6586
|
}>, void, any> & {
|
|
@@ -6617,13 +6617,13 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6617
6617
|
/**
|
|
6618
6618
|
* This field shall indicate the reason why the power adjustment session ended.
|
|
6619
6619
|
*
|
|
6620
|
-
* @see {@link MatterSpecification.
|
|
6620
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.1
|
|
6621
6621
|
*/
|
|
6622
6622
|
cause: import("../tlv/TlvObject.js").FieldType<Cause>;
|
|
6623
6623
|
/**
|
|
6624
6624
|
* This field shall indicate the number of seconds that the power adjustment session lasted before ending.
|
|
6625
6625
|
*
|
|
6626
|
-
* @see {@link MatterSpecification.
|
|
6626
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.2
|
|
6627
6627
|
*/
|
|
6628
6628
|
duration: import("../tlv/TlvObject.js").FieldType<number>;
|
|
6629
6629
|
/**
|
|
@@ -6633,7 +6633,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6633
6633
|
* battery inverter that was requested to discharge it would have a negative EnergyUse value. If this was a
|
|
6634
6634
|
* normal load that was turned on, then it will have positive value.
|
|
6635
6635
|
*
|
|
6636
|
-
* @see {@link MatterSpecification.
|
|
6636
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.2.3
|
|
6637
6637
|
*/
|
|
6638
6638
|
energyUse: import("../tlv/TlvObject.js").FieldType<number | bigint>;
|
|
6639
6639
|
}>, any> & {
|
|
@@ -6656,7 +6656,7 @@ export declare namespace DeviceEnergyManagement {
|
|
|
6656
6656
|
/**
|
|
6657
6657
|
* This field shall indicate the reason why the pause ended.
|
|
6658
6658
|
*
|
|
6659
|
-
* @see {@link MatterSpecification.
|
|
6659
|
+
* @see {@link MatterSpecification.v14.Cluster} § 9.2.10.4.1
|
|
6660
6660
|
*/
|
|
6661
6661
|
cause: import("../tlv/TlvObject.js").FieldType<Cause>;
|
|
6662
6662
|
}>, any> & {
|