ClosureDimensionTrait.Attributes
@Generated(value = ["GoogleHomePlatformCodegen"])
interface ClosureDimensionTrait.Attributes : ClusterStruct
ClosureDimension |
API for the ClosureDimension trait. |
Attributes for the ClosureDimension 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. |
ClosureDimensionTrait.DimensionStateStruct? |
The current state of the closure dimension, including its |
ClosureDimensionTrait.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. |
ClosureDimensionTrait.LatchControlModesBitmap? |
Whether the latch mechanism can be latched or unlatched remotely, as defined in the |
ClosureDimensionTrait.RangePercent100thsStruct? |
The range of possible values for the |
ClosureDimensionTrait.ModulationTypeEnum? |
The modulation type of the closure dimension, as defined in the |
ClosureDimensionTrait.OverflowEnum? |
The overflow direction of the closure, as defined in the |
UShort? |
The minimal acceptable change to the |
ClosureDimensionTrait.RotationAxisEnum? |
The axis of rotation for the closure dimension, as defined in the |
UShort? |
The size of a single step, in hundredths of a percent. |
ClosureDimensionTrait.DimensionStateStruct? |
The target state of the closure dimension, including its |
ClosureDimensionTrait.TranslationDirectionEnum? |
The direction of translation for the closure dimension, as defined in the |
ClosureDimensionTrait.ClosureUnitEnum? |
The unit related to the position of the closure, where the unit is defined in |
ClosureDimensionTrait.UnitRangeStruct? |
The physical range of the closure's movement, expressed as minimum and maximum values of the unit of measurement. |
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.
currentState
val currentState: ClosureDimensionTrait.DimensionStateStruct?
The current state of the closure dimension, including its Latch, Position, and Speed, as defined in the DimensionStateStruct.
Access type: Read
featureMap
val featureMap: ClosureDimensionTrait.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: ClosureDimensionTrait.LatchControlModesBitmap?
Whether the latch mechanism can be latched or unlatched remotely, as defined in the LatchControlModesBitmap.
Access type: Read
limitRange
val limitRange: ClosureDimensionTrait.RangePercent100thsStruct?
The range of possible values for the Position field in the CurrentState attribute.
Access type: Read
modulationType
val modulationType: ClosureDimensionTrait.ModulationTypeEnum?
The modulation type of the closure dimension, as defined in the ModulationTypeEnum.
Access type: Read
overflow
val overflow: ClosureDimensionTrait.OverflowEnum?
The overflow direction of the closure, as defined in the OverflowEnum.
Access type: Read
resolution
val resolution: UShort?
The minimal acceptable change to the Position field of the targetState and currentState attributes. Resolution gives a collection of valid current position points over a linear ruler. A resolution of 100% means that the associated dimension cannot be placed in an intermediate position because its position is binary.
Access type: Read
rotationAxis
val rotationAxis: ClosureDimensionTrait.RotationAxisEnum?
The axis of rotation for the closure dimension, as defined in the RotationAxisEnum.
Access type: Read
stepValue
val stepValue: UShort?
The size of a single step, in hundredths of a percent. The value of this attribute is an integer multiple of the resolution attribute.
Access type: Read
targetState
val targetState: ClosureDimensionTrait.DimensionStateStruct?
The target state of the closure dimension, including its Latch, Position, and Speed, as defined in the DimensionStateStruct.
Access type: Read
translationDirection
val translationDirection: ClosureDimensionTrait.TranslationDirectionEnum?
The direction of translation for the closure dimension, as defined in the TranslationDirectionEnum.
Access type: Read
unit
val unit: ClosureDimensionTrait.ClosureUnitEnum?
The unit related to the position of the closure, where the unit is defined in ClosureUnitEnum.
Access type: Read
unitRange
val unitRange: ClosureDimensionTrait.UnitRangeStruct?
The physical range of the closure's movement, expressed as minimum and maximum values of the unit of measurement. The unit of measurement is specified by the unit attribute. The unit range is determined by the values stored in the min and max fields of the UnitRangeStruct.
Access type: Read