SwitchTrait.Attributes
interface SwitchTrait.Attributes
Switch |
API for the Switch trait. |
Attributes for the Switch cluster.
Summary
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. |
UByte? |
The current position of the switch. |
SwitchTrait.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 maximum number of consecutive presses that can be detected and reported by a momentary switch which supports multi-press. |
UByte? |
The maximum number of positions the switch has. |
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.
currentPosition
val currentPosition: UByte?
The current position of the switch. The default position is 0. The valid range of values is 0 to [numberOfPositions]-1.
Access type: Read
featureMap
val featureMap: SwitchTrait.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.
multiPressMax
val multiPressMax: UByte?
The maximum number of consecutive presses that can be detected and reported by a momentary switch which supports multi-press.
Access type: Read
numberOfPositions
val numberOfPositions: UByte?
The maximum number of positions the switch has. A switch must have a minimum of two positions.
Access type: Read