WindowCoveringTrait.Attributes
@Generated(value = ["GoogleHomePlatformCodegen"])
interface WindowCoveringTrait.Attributes : ClusterStruct
WindowCovering |
API for the WindowCovering trait. |
Attributes for the WindowCovering 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. |
WindowCoveringTrait.ConfigStatus? |
Configuration and status information for the window covering. |
UShort? |
The distance of the window covering from the fully-open position, in centimeters. |
UShort? |
The position of the window covering as a percentage with a minimum step of 0.01%. |
UByte? |
The position of the window covering as a percentage with a 1% default step. |
UShort? |
The current tilt position of the window covering, in degrees. |
UShort? |
The position of the window covering as a percentage with a minimal step of 0.01%. |
UByte? |
The position of the window covering as a percentage with a 1% default step. |
WindowCoveringTrait.EndProductType? |
With the WindowCovering.Type, this specifies the subtype of window covering. |
WindowCoveringTrait.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. |
UShort? |
The closed limit when tilting the window covering, in tenths of a degree. |
UShort? |
The closed limit when lifting the window covering, in tenths of a degree. |
UShort? |
The open limit for lifting the window covering, in centimeters. |
UShort? |
The open limit for tilting the window covering, in tenths of a degree. |
WindowCoveringTrait.Mode? |
Allows configuration of the window covering, such as: reversing the motor direction, or placing the motor into maintenance mode. |
UShort? |
The total number of lift or slide actuations applied to the window covering since it was installed. |
UShort? |
The total number of tilt actuations applied to the window covering since it was installed. |
WindowCoveringTrait.OperationalStatus? |
Indicates currently ongoing operations and applies to all types of devices. |
UShort? |
The maximum possible encoder position for setting the height of the window covering, in centimeters. |
UShort? |
The maximum possible encoder position for setting the angle of the window covering. |
WindowCoveringTrait.SafetyStatus? |
Reflects the state of the safety sensors and the common issues preventing movements. |
UShort? |
The lift position which the window covering is moving to, as a percentage. |
UShort? |
The tilt position which the window covering is moving to, as a percentage. |
WindowCoveringTrait.Type? |
The type of window covering. |
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.
configStatus
val configStatus: WindowCoveringTrait.ConfigStatus?
Configuration and status information for the window covering.
Access type: Read
currentPositionLift
val currentPositionLift: UShort?
The distance of the window covering from the fully-open position, in centimeters.
Access type: Read
currentPositionLiftPercent100ths
val currentPositionLiftPercent100ths: UShort?
The position of the window covering as a percentage with a minimum step of 0.01%. For example, 10000 equals 100.00%.
Access type: Read
currentPositionLiftPercentage
val currentPositionLiftPercentage: UByte?
The position of the window covering as a percentage with a 1% default step. This attribute is equivalent to currentPositionLiftPercent100ths attribute divided by 100.
Access type: Read
currentPositionTilt
val currentPositionTilt: UShort?
The current tilt position of the window covering, in degrees.
Access type: Read
currentPositionTiltPercent100ths
val currentPositionTiltPercent100ths: UShort?
The position of the window covering as a percentage with a minimal step of 0.01%. For example, 10000 equals 100.00%.
Access type: Read
currentPositionTiltPercentage
val currentPositionTiltPercentage: UByte?
The position of the window covering as a percentage with a 1% default step. This attribute is equivalent to currentPositionTiltPercent100ths attribute divided by 100.
Access type: Read
endProductType
val endProductType: WindowCoveringTrait.EndProductType?
With the WindowCovering.Type, this specifies the subtype of window covering.
Access type: Read
featureMap
val featureMap: WindowCoveringTrait.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.
installedClosedLimitLift
val installedClosedLimitLift: UShort?
The closed limit when tilting the window covering, in tenths of a degree.
Access type: Read
installedClosedLimitTilt
val installedClosedLimitTilt: UShort?
The closed limit when lifting the window covering, in tenths of a degree.
Access type: Read
installedOpenLimitLift
val installedOpenLimitLift: UShort?
The open limit for lifting the window covering, in centimeters.
Access type: Read
installedOpenLimitTilt
val installedOpenLimitTilt: UShort?
The open limit for tilting the window covering, in tenths of a degree.
Access type: Read
mode
val mode: WindowCoveringTrait.Mode?
Allows configuration of the window covering, such as: reversing the motor direction, or placing the motor into maintenance mode.
Access type: Write
numberOfActuationsLift
val numberOfActuationsLift: UShort?
The total number of lift or slide actuations applied to the window covering since it was installed.
Access type: Read
numberOfActuationsTilt
val numberOfActuationsTilt: UShort?
The total number of tilt actuations applied to the window covering since it was installed.
Access type: Read
operationalStatus
val operationalStatus: WindowCoveringTrait.OperationalStatus?
Indicates currently ongoing operations and applies to all types of devices.
Access type: Read
physicalClosedLimitLift
val physicalClosedLimitLift: UShort?
The maximum possible encoder position for setting the height of the window covering, in centimeters.
Access type: Read
physicalClosedLimitTilt
val physicalClosedLimitTilt: UShort?
The maximum possible encoder position for setting the angle of the window covering.
Access type: Read
safetyStatus
val safetyStatus: WindowCoveringTrait.SafetyStatus?
Reflects the state of the safety sensors and the common issues preventing movements.
Access type: Read
targetPositionLiftPercent100ths
val targetPositionLiftPercent100ths: UShort?
The lift position which the window covering is moving to, as a percentage.
Access type: Read
targetPositionTiltPercent100ths
val targetPositionTiltPercent100ths: UShort?
The tilt position which the window covering is moving to, as a percentage.
Access type: Read