DeviceEnergyManagement

interface DeviceEnergyManagement : DeviceEnergyManagementTrait.Attributes, MatterTrait, DeviceEnergyManagementCommands


API for the DeviceEnergyManagement trait. This trait provides an interface for managing the energy consumption of an energy smart appliance (ESA).

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public properties

open TraitFactory<DeviceEnergyManagement>

Inherited functions

From com.google.home.matter.standard.DeviceEnergyManagementCommands
suspend Unit

Allows a client, such as an EMS, to cancel an ongoing power adjustment request.

suspend Unit

Allows an EMS to request cancellation of a previous adjustment request made in a StartTimeAdjustRequest, ModifyForecastRequest, or RequestConstraintBasedForecast command.

suspend Unit

Allows an EMS to modify a forecast within the limits allowed by the ESA.

suspend Unit

Allows a client to temporarily pause an operation and reduce the energy demand on the ESA.

suspend Unit
powerAdjustRequest(
    power: Long,
    duration: UInt,
    cause: DeviceEnergyManagementTrait.AdjustmentCauseEnum
)

Allows a client, such as an EMS, to request an adjustment in the power consumption of an ESA for a specified duration.

suspend Unit

Allows an EMS to request the ESA to recompute its forecast based on power and time constraints.

suspend Unit

Allows a client to cancel the PauseRequest command and enable the resumption of the previous operation.

suspend Unit

Allows a client to adjust the start time of a forecast sequence that has not yet started operation.

From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties

From com.google.home.matter.standard.DeviceEnergyManagementTrait.Attributes
Long?

The maximum electrical power, in milliwatts, that the ESA can consume when it's on.

Long?

The minimum electrical power, in milliwatts, that the ESA can consume when it's on.

List<UInt>

A list of client-generated commands which are supported by this cluster server instance.

List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

UShort

The revision of the server cluster specification supported by the cluster instance.

Boolean?

Indicates whether the ESA is classified as a generator or a load.

DeviceEnergyManagementTrait.EsaStateEnum?

The current state of the ESA.

DeviceEnergyManagementTrait.EsaTypeEnum?

The type of the ESA, which enables an EMS to determine how the ESA consumes, generates, and stores the energy.

DeviceEnergyManagementTrait.Feature

Whether the server supports zero or more optional cluster features.

DeviceEnergyManagementTrait.ForecastStruct?

Allows an ESA to share its intended forecast with a client, such as an EMS.

List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

DeviceEnergyManagementTrait.OptOutStateEnum?

Indicates whether the ESA has opted out of energy management.

List<DeviceEnergyManagementTrait.PowerAdjustStruct>?

Indicates how the ESA can be adjusted at the current time.

From com.google.home.Trait

Public functions

supports

fun supports(attribute: DeviceEnergyManagement.Attribute): Boolean

supports

fun supports(command: DeviceEnergyManagement.Command): Boolean

Public properties