ExtendedOperationalState

@Generated(value = ["GoogleHomePlatformCodegen"])
interface ExtendedOperationalState : ExtendedOperationalStateTrait.Attributes, MatterTrait, ExtendedOperationalStateCommands

API for the ExtendedOperationalState trait. This trait represents any device that supports operating in specific zones, and has an ongoing duration for its operation which can be queried.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<ExtendedOperationalState>

Inherited functions
From com.google.home.google.ExtendedOperationalStateCommands
suspend Unit
startWithDuration(operationZones: List<String>, durationSeconds: UInt)

Start the device in one or more operation zones for the specified duration.
BatchableCommand<Unit>
startWithDurationBatchable(
    operationZones: List<String>,
    durationSeconds: UInt
)

The batchable version of startWithDuration command.
suspend Unit

Start the device in one or more operation zones.
BatchableCommand<Unit>

The batchable version of startWithOperationZones command.
From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties
From com.google.home.google.ExtendedOperationalStateTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.
List<String>?

Indicates operation zones in which the device is currently running, from the list of available zones.
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.
UInt?

Time remaining on current cycle, in seconds.
UInt

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.
UInt?

Indicates the maximum operation duration the device supports.
UInt?

Indicates the minimum operation duration the device supports.
Long?

Indicates expected operation completion time if the device was started with the startWithDuration command (Unix epoch timestamp in seconds).
List<String>?

Indicates supported zone names.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: ExtendedOperationalState.Attribute): Boolean

supports

fun supports(command: ExtendedOperationalState.Command): Boolean

Public properties

factory

open val factory: TraitFactory<ExtendedOperationalState>