OperationalStateTrait.Attributes
@Generated(value = ["GoogleHomePlatformCodegen"])
interface OperationalStateTrait.Attributes : ClusterStruct
OperationalState |
API for the OperationalState trait. |
Attributes for the OperationalState cluster.
Summary
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
Returns the value of the field for the given tag ID. |
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. |
UInt? |
The estimated time, in seconds, before the operation completes. |
UByte? |
The current phase of operation being performed by the server. |
OperationalStateTrait.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. |
OperationalStateTrait.ErrorStateStruct? |
The details of any current error condition being experienced by the device when the |
OperationalStateTrait.OperationalStateEnum? |
The current operational state of the device. |
List<OperationalStateTrait.OperationalStateStruct>? |
The set of possible operational states that the device exposes. |
List<String>? |
The set of phases that the device can go through for the selected function or mode. |
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
acceptedCommandList
val acceptedCommandList: List<UInt>
A list of client-generated commands which are supported by this cluster server instance.
attributeList
val attributeList: List<UInt>
A list of the attribute IDs of the attributes supported by the cluster instance.
clusterRevision
val clusterRevision: UShort
The revision of the server cluster specification supported by the cluster instance.
countdownTime
val countdownTime: UInt?
The estimated time, in seconds, before the operation completes.
Access type: Read
currentPhase
val currentPhase: UByte?
The current phase of operation being performed by the server.
Access type: Read
featureMap
val featureMap: OperationalStateTrait.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 generatedCommandList: List<UInt>
A list of server-generated commands (server to client) which are supported by this cluster server instance.
operationalError
val operationalError: OperationalStateTrait.ErrorStateStruct?
The details of any current error condition being experienced by the device when the operationalState attribute is Error.
Access type: Read
operationalState
val operationalState: OperationalStateTrait.OperationalStateEnum?
The current operational state of the device.
Access type: Read
operationalStateList
val operationalStateList: List<OperationalStateTrait.OperationalStateStruct>?
The set of possible operational states that the device exposes.
Access type: Read