OvenCavityOperationalState

interface OvenCavityOperationalState : OvenCavityOperationalStateTrait.Attributes, MatterTrait, OvenCavityOperationalStateCommands

API for the OvenCavityOperationalState trait. This trait provides an interface for monitoring the operational state of an oven.

Summary

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

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

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

`suspend OvenCavityOperationalStateTrait.PauseCommand.Response`	`pause()` Pause the oven if possible, based on the current operation underway.
`suspend OvenCavityOperationalStateTrait.ResumeCommand.Response`	`resume()` Resume operation if the oven is in a state where it can be resumed.
`suspend OvenCavityOperationalStateTrait.StartCommand.Response`	`start()` Start the oven if it is in a state where it can be started.
`suspend OvenCavityOperationalStateTrait.StopCommand.Response`	`stop()` Stop the oven if possible, based on the current operation underway.

suspend Unit

forceRead()

`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.
`UInt?`	`countdownTime` The estimated time, in seconds, before the operation completes.
`UByte?`	`currentPhase` The current phase of operation being performed by the oven.
`UInt`	`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.
`OvenCavityOperationalStateTrait.ErrorStateStruct?`	`operationalError` The details of any current error condition being experienced by the oven when the `operationalState` attribute is `Error`.
`OvenCavityOperationalStateTrait.OperationalStateEnum?`	`operationalState` The current operational state of the oven.
`List<OvenCavityOperationalStateTrait.OperationalStateStruct>?`	`operationalStateList` The set of possible operational states that the oven exposes.
`List<String>?`	`phaseList` The set of phases that the oven can go through for the selected function or mode.

Trait.TraitMetadata

metadata

fun supports(attribute: OvenCavityOperationalState.Attribute): Boolean

fun supports(command: OvenCavityOperationalState.Command): Boolean

open val factory: TraitFactory<OvenCavityOperationalState>