OnOffTrait.Attributes

interface OnOffTrait.Attributes

Known direct subclasses
OnOff

API for the OnOff trait.


Attributes for the OnOff 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.

OnOffTrait.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.

Boolean?

When set to true, prevents the global scene from being destroyed by subsequent off or on commands.

UShort?

The length of time (in 0.1 seconds) that the onOff attribute is false before allowing another OnWithTimedOff command to turn the device back on.

Boolean?

Whether the device type implemented on the endpoint is turned off (false) or turned on (true).

UShort?

The length of time (in 0.1 seconds) that the onOff attribute is true before changing to false when using the OnWithTimedOff command.

OnOffTrait.StartUpOnOffEnum?

The desired startup behavior of a device when supplied with power.

Public properties

acceptedCommandList

val acceptedCommandListList<UInt>

A list of client-generated commands which are supported by this cluster server instance.

attributeList

val attributeListList<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

clusterRevision

val clusterRevisionUShort

The revision of the server cluster specification supported by the cluster instance.

featureMap

val featureMapOnOffTrait.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 generatedCommandListList<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

globalSceneControl

val globalSceneControlBoolean?

When set to true, prevents the global scene from being destroyed by subsequent off or on commands.

Access type: Read

offWaitTime

val offWaitTimeUShort?

The length of time (in 0.1 seconds) that the onOff attribute is false before allowing another OnWithTimedOff command to turn the device back on.

Access type: Write

onOff

val onOffBoolean?

Whether the device type implemented on the endpoint is turned off (false) or turned on (true).

Access type: Read

onTime

val onTimeUShort?

The length of time (in 0.1 seconds) that the onOff attribute is true before changing to false when using the OnWithTimedOff command.

Access type: Write

startUpOnOff

val startUpOnOffOnOffTrait.StartUpOnOffEnum?

The desired startup behavior of a device when supplied with power. If not set, the onOff attribute is set to its previous value.

Access type: Write