LevelControlTrait.Attributes
interface LevelControlTrait.Attributes
LevelControl |
API for the LevelControl trait. |
Attributes for the LevelControl 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. |
UShort? |
The frequency at which the device is at |
UByte? |
The current level of the device, which is device dependent. |
UByte? |
The movement rate (in units per second) when a |
LevelControlTrait.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 maximum value that can be assigned to the |
UByte? |
The maximum value that can be assigned to the |
UShort? |
The minimum value that can be assigned to the |
UByte? |
The minimum value that can be assigned to the |
UShort? |
The time taken (in 0.1 seconds) to move the |
UByte? |
The value that the |
UShort? |
The time taken (in 0.1 seconds) to move to or from the target level when |
UShort? |
The time taken (in 0.1 seconds) to move the |
LevelControlTrait.OptionsBitmap? |
A bitmap that determines the default behavior of some cluster commands. |
UShort? |
The time remaining (in 0.1 seconds) until the current command is complete. |
UByte? |
The desired startup level for a device when it is supplied with power, which is reflected in the |
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.
currentFrequency
val currentFrequency: UShort?
The frequency at which the device is at currentLevel. A value of 0 means the frequency is unknown. Cannot be less than the minFrequency or greater than the maxFrequency.
Access type: Read
currentLevel
val currentLevel: UByte?
The current level of the device, which is device dependent. For example, a level for a light may mean the brightness level. Cannot be less than the minLevel or greater than the maxLevel.
Access type: Read
defaultMoveRate
val defaultMoveRate: UByte?
The movement rate (in units per second) when a move command is reeceived with a rate parameter of null.
Access type: Write
featureMap
val featureMap: LevelControlTrait.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.
maxFrequency
val maxFrequency: UShort?
The maximum value that can be assigned to the currentFrequency attribute. This value is always greater than or equal to minFrequency. A value of 0 means undefined.
Access type: Read
maxLevel
val maxLevel: UByte?
The maximum value that can be assigned to the currentLevel attribute.
Access type: Read
minFrequency
val minFrequency: UShort?
The minimum value that can be assigned to the currentFrequency attribute. This value is always less than or equal to maxFrequency. A value of 0 means undefined.
Access type: Read
minLevel
val minLevel: UByte?
The minimum value that can be assigned to the currentLevel attribute.
Access type: Read
offTransitionTime
val offTransitionTime: UShort?
The time taken (in 0.1 seconds) to move the currentLevel from the maxLevel to the minLevel when an on command is received by an OnOff cluster on the same endpoint. If not implemented or defined, onOffTransitionTime is used instead.
Access type: Write
onLevel
val onLevel: UByte?
The value that the currentLevel attribute is set to when the onOff attribute of the OnOff cluster is set to true as a result of processing an OnOff cluster command. Cannot be less than the minLevel or greater than the maxLevel.
Access type: Write
onOffTransitionTime
val onOffTransitionTime: UShort?
The time taken (in 0.1 seconds) to move to or from the target level when on or off commands are received by an OnOff cluster on the same endpoint. Not supported for devices that are not able to transition at a variable rate.
Access type: Write
onTransitionTime
val onTransitionTime: UShort?
The time taken (in 0.1 seconds) to move the currentLevel from the minLevel to the maxLevel when an on command is received by an OnOff cluster on the same endpoint. If not implemented or defined, onOffTransitionTime is used instead.
Access type: Write
options
val options: LevelControlTrait.OptionsBitmap?
A bitmap that determines the default behavior of some cluster commands. This should only be changed during commissioning. See LevelControlTrait.OptionsBitmap for more information.
Access type: Write
remainingTime
val remainingTime: UShort?
The time remaining (in 0.1 seconds) until the current command is complete.
Access type: Read
startUpCurrentLevel
val startUpCurrentLevel: UByte?
The desired startup level for a device when it is supplied with power, which is reflected in the currentLevel attribute. A value of 0 sets currentLevel to minLevel. A value of null, or a device reboot from an OTA, sets currentLevel to its previous value. Any other value sets currentLevel to that value.
Access type: Write