DeviceEnergyManagementMode

interface DeviceEnergyManagementMode : DeviceEnergyManagementModeTrait.Attributes, MatterTrait, Updatable, DeviceEnergyManagementModeCommands

API for the DeviceEnergyManagementMode trait. Defines additional mode tags and namespaced enumerated values for device energy management devices.

Summary

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

Public functions
`Boolean`	`supports(attribute: DeviceEnergyManagementMode.Attribute)`
`Boolean`	`supports(command: DeviceEnergyManagementMode.Command)`

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

suspend DeviceEnergyManagementModeTrait.ChangeToModeCommand.Response

changeToMode(newMode: UByte)

Change device modes.

suspend Unit

forceRead()

suspend DeviceEnergyManagementMode

update(
    optimisticReturn: (DeviceEnergyManagementMode) -> Unit,
    init: DeviceEnergyManagementModeTrait.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?`	`currentMode` The current mode of the device energy management device.
`DeviceEnergyManagementModeTrait.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.
`UByte?`	`onMode` The value of the `currentMode` that depends on the state of an `OnOff` cluster on the same device energy management endpoint.
`UByte?`	`startUpMode` The desired startup mode for the device energy management device when it is supplied with power.
`List<DeviceEnergyManagementModeTrait.ModeOptionStruct>?`	`supportedModes` The modes supported by the device energy management device.

Trait.TraitMetadata

metadata

fun supports(attribute: DeviceEnergyManagementMode.Attribute): Boolean

fun supports(command: DeviceEnergyManagementMode.Command): Boolean

open val factory: TraitFactory<DeviceEnergyManagementMode>

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-12-06 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