ClosureControlTrait.Attributes
@Generated(value = ["GoogleHomePlatformCodegen"])
interface ClosureControlTrait.Attributes : ClusterStruct
ClosureControl |
API for the ClosureControl trait. |
Attributes for the ClosureControl 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 remaining, in seconds, before the operation is complete. |
List<ClosureControlTrait.ClosureErrorEnum>? |
A list of active errors. |
ClosureControlTrait.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. |
ClosureControlTrait.LatchControlModesBitmap? |
Whether the latch mechanism can be latched or unlatched remotely. |
ClosureControlTrait.MainStateEnum? |
The current operational state of the closure. |
ClosureControlTrait.OverallCurrentStateStruct? |
The current |
ClosureControlTrait.OverallTargetStateStruct? |
The |
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 remaining, in seconds, before the operation is complete. A value of 0 means that the operation has completed. A value of null means that there is no time defined until the operation is complete.
Access type: Read
currentErrorList
val currentErrorList: List<ClosureControlTrait.ClosureErrorEnum>?
A list of active errors. An empty list indicates that there are no active errors.
Access type: Read
featureMap
val featureMap: ClosureControlTrait.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.
latchControlModes
val latchControlModes: ClosureControlTrait.LatchControlModesBitmap?
Whether the latch mechanism can be latched or unlatched remotely.
Access type: Read
mainState
val mainState: ClosureControlTrait.MainStateEnum?
The current operational state of the closure.
Access type: Read
overallCurrentState
val overallCurrentState: ClosureControlTrait.OverallCurrentStateStruct?
The current Position, Latch, and Speed states, whichever are applicable based on the feature flags set. A null value means that the states are not known.
Access type: Read
overallTargetState
val overallTargetState: ClosureControlTrait.OverallTargetStateStruct?
The TargetPosition, TargetLatch, TargetSpeed values, whichever are applicable according to the feature flags set. A null value means that the values are not known.
Access type: Read