EnergyPreference

interface EnergyPreference : EnergyPreferenceTrait.Attributes, MatterTrait, Updatable

API for the EnergyPreference trait. This trait provides an interface to specify preferences for how devices should consume energy.

Summary

Nested types
`enum EnergyPreference.Attribute : Enum, Field` Descriptor enum for this trait's attributes.

Public functions
`Boolean`	`supports(attribute: EnergyPreference.Attribute)`

Public properties
`open TraitFactory<EnergyPreference>`	`factory`

suspend Unit

forceRead()

suspend EnergyPreference

update(optimisticReturn: (EnergyPreference) -> Unit, init: EnergyPreferenceTrait.MutableAttributes.() -> Unit)

Creates a mutable copy of an object and calls the given function to mutate it, then saves it and returns a new immutable copy with the updated state.

`List<UInt>`	`acceptedCommandList` A list of client-generated commands which are supported by this cluster server instance.
`List<UInt>`	`attributeList` A list of the attribute IDs of the attributes supported by the cluster instance.
`UShort`	`clusterRevision` The revision of the server cluster specification supported by the cluster instance.
`UByte?`	`currentEnergyBalance` The current preference of the user for balancing different priorities during device use.
`UByte?`	`currentLowPowerModeSensitivity` The current preference of the user for how quickly a device should enter low power mode.
`List<EnergyPreferenceTrait.BalanceStruct>?`	`energyBalances` A list of at least two `BalanceStructs`, each representing a step along a linear scale of relative priorities.
`List<EnergyPreferenceTrait.EnergyPriorityEnum>?`	`energyPriorities` Two extremes for interpreting the values in the `energyBalances` attribute.
`EnergyPreferenceTrait.Feature`	`featureMap` Whether the server supports zero or more optional cluster features.
`List<UInt>`	`generatedCommandList` A list of server-generated commands (server to client) which are supported by this cluster server instance.
`List<EnergyPreferenceTrait.BalanceStruct>?`	`lowPowerModeSensitivities` A list of at least two `BalanceStructs`, each representing a condition or set of conditions for the device to enter low-power mode.

Trait.TraitMetadata

metadata

fun supports(attribute: EnergyPreference.Attribute): Boolean

open val factory: TraitFactory<EnergyPreference>

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-10-28 UTC.

For devices
- Matter
  New IP-based smart home connectivity protocol that enables broad interoperability with many ecosystems
- Cloud-to-cloud
  Connect your cloud backend with the Smart Home API
- Find out which integration to build
  We’ll recommend an integration based on your device and needs
For apps, platforms & services
- Home APIs
  Access over 600M devices, hubs for Google Home and Matter infrastructure, and an automation engine powered by Google intelligence
Use cases
Business resources
Console
- Developer Console
- Support
- Stack Overflow
- Google Nest Community