EnergyPreferenceTrait.Attributes

interface EnergyPreferenceTrait.Attributes

Known direct subclasses
EnergyPreference

API for the EnergyPreference trait.


Attributes for the EnergyPreference cluster.

Summary

Public properties

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.

UByte?

The current preference of the user for balancing different priorities during device use.

UByte?

The current preference of the user for how quickly a device should enter low power mode.

List<EnergyPreferenceTrait.BalanceStruct>?

A list of at least two BalanceStructs, each representing a step along a linear scale of relative priorities.

List<EnergyPreferenceTrait.EnergyPriorityEnum>?

Two extremes for interpreting the values in the energyBalances attribute.

EnergyPreferenceTrait.Feature

Whether the server supports zero or more optional cluster features.

List<UInt>

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

List<EnergyPreferenceTrait.BalanceStruct>?

A list of at least two BalanceStructs, each representing a condition or set of conditions for the device to enter low-power mode.

Public properties

acceptedCommandList

val acceptedCommandListList<UInt>

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

attributeList

val attributeListList<UInt>

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

clusterRevision

val clusterRevisionUShort

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

currentEnergyBalance

val currentEnergyBalanceUByte?

The current preference of the user for balancing different priorities during device use. The value of this attribute is the 0-based index into the energyBalances attribute for the currently selected balance.

Access type: Write

currentLowPowerModeSensitivity

val currentLowPowerModeSensitivityUByte?

The current preference of the user for how quickly a device should enter low power mode. The value of this attribute is the 0-based index into the lowPowerModeSensitivities attribute for the currently selected sensitivity.

Access type: Write

energyBalances

val energyBalancesList<EnergyPreferenceTrait.BalanceStruct>?

A list of at least two BalanceStructs, each representing a step along a linear scale of relative priorities.

Access type: Read

energyPriorities

val energyPrioritiesList<EnergyPreferenceTrait.EnergyPriorityEnum>?

Two extremes for interpreting the values in the energyBalances attribute. These two priorities are in opposition to each other, for example Comfort versus Efficiency or Speed versus WaterConsumption.

Access type: Read

featureMap

val featureMapEnergyPreferenceTrait.Feature

Whether the server supports zero or more optional cluster features. A cluster feature is a set of cluster elements that are mandatory or optional for a defined feature of the cluster. If a cluster feature is supported by the cluster instance, then the corresponding bit is set to 1, otherwise the bit is set to 0 (zero).

generatedCommandList

val generatedCommandListList<UInt>

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

lowPowerModeSensitivities

val lowPowerModeSensitivitiesList<EnergyPreferenceTrait.BalanceStruct>?

A list of at least two BalanceStructs, each representing a condition or set of conditions for the device to enter low-power mode.

Access type: Read