ValveConfigurationAndControlTrait.Attributes
@Generated(value = ["GoogleHomePlatformCodegen"])
interface ValveConfigurationAndControlTrait.Attributes : ClusterStruct
ValveConfigurationAndControl |
API for the ValveConfigurationAndControl trait. |
Attributes for the ValveConfigurationAndControl 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. |
ULong? |
The UTC time when the valve will close, depending on value of the |
UShort |
The revision of the server cluster specification supported by the cluster instance. |
UByte? |
The current level of the valve as a percentage value, between fully closed and fully open. |
ValveConfigurationAndControlTrait.ValveStateEnum? |
The current state of the valve. |
UInt? |
The default duration, in seconds, for which the valve will remain open, if a value for the |
UByte? |
The default value used for the |
ValveConfigurationAndControlTrait.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. |
UByte? |
The step size supported by the valve. |
UInt? |
The total duration, in seconds, for which the valve will remain open for the current opening. |
UInt? |
The remaining duration, in seconds, until the valve closes. |
UByte? |
The target level of the valve as a percentage value, between fully closed and fully open. |
ValveConfigurationAndControlTrait.ValveStateEnum? |
The target state, while changing the state, of the valve. |
ValveConfigurationAndControlTrait.ValveFaultBitmap? |
Any faults registered by the valve. |
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.
autoCloseTime
val autoCloseTime: ULong?
The UTC time when the valve will close, depending on value of the openDuration attribute.
Access type: Read
clusterRevision
val clusterRevision: UShort
The revision of the server cluster specification supported by the cluster instance.
currentLevel
val currentLevel: UByte?
The current level of the valve as a percentage value, between fully closed and fully open.
Access type: Read
currentState
val currentState: ValveConfigurationAndControlTrait.ValveStateEnum?
The current state of the valve.
Access type: Read
defaultOpenDuration
val defaultOpenDuration: UInt?
The default duration, in seconds, for which the valve will remain open, if a value for the openDuration parameter is not present in the Open command.
Access type: Write
defaultOpenLevel
val defaultOpenLevel: UByte?
The default value used for the targetLevel attribute, when a valve transitions from the closed to the open state, caused by an Open command, if a value for the targetLevel parameter isn't present in the Open command.
Access type: Write
featureMap
val featureMap: ValveConfigurationAndControlTrait.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.
openDuration
val openDuration: UInt?
The total duration, in seconds, for which the valve will remain open for the current opening.
Access type: Read
remainingDuration
val remainingDuration: UInt?
The remaining duration, in seconds, until the valve closes.
Access type: Read
targetLevel
val targetLevel: UByte?
The target level of the valve as a percentage value, between fully closed and fully open.
Access type: Read
targetState
val targetState: ValveConfigurationAndControlTrait.ValveStateEnum?
The target state, while changing the state, of the valve.
Access type: Read
valveFault
val valveFault: ValveConfigurationAndControlTrait.ValveFaultBitmap?
Any faults registered by the valve.
Access type: Read