BooleanStateConfigurationTrait.Attributes
@Generated(value = ["GoogleHomePlatformCodegen"])
interface BooleanStateConfigurationTrait.Attributes : ClusterStruct
BooleanStateConfiguration |
API for the BooleanStateConfiguration trait. |
Attributes for the BooleanStateConfiguration 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. |
BooleanStateConfigurationTrait.AlarmModeBitmap? |
Indicates which specific alarm modes are currently active. |
BooleanStateConfigurationTrait.AlarmModeBitmap? |
The alarm modes that will be emitted if the sensor is triggered. |
BooleanStateConfigurationTrait.AlarmModeBitmap? |
The alarms supported by the sensor. |
BooleanStateConfigurationTrait.AlarmModeBitmap? |
Indicates which specific alarm modes are currently suppressed. |
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 currently selected sensitivity level. |
UByte? |
The default sensitivity level selected by the manufacturer. |
BooleanStateConfigurationTrait.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. |
BooleanStateConfigurationTrait.SensorFaultBitmap? |
Indicates any faults registered by the device. |
UByte? |
Indicates the number of sensitivity levels supported by the device. |
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.
alarmsActive
val alarmsActive: BooleanStateConfigurationTrait.AlarmModeBitmap?
Indicates which specific alarm modes are currently active.
Access type: Read
alarmsEnabled
val alarmsEnabled: BooleanStateConfigurationTrait.AlarmModeBitmap?
The alarm modes that will be emitted if the sensor is triggered.
Access type: Read
alarmsSupported
val alarmsSupported: BooleanStateConfigurationTrait.AlarmModeBitmap?
The alarms supported by the sensor.
Access type: Read
alarmsSuppressed
val alarmsSuppressed: BooleanStateConfigurationTrait.AlarmModeBitmap?
Indicates which specific alarm modes are currently suppressed.
Access type: Read
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.
currentSensitivityLevel
val currentSensitivityLevel: UByte?
The currently selected sensitivity level.
Access type: Write
defaultSensitivityLevel
val defaultSensitivityLevel: UByte?
The default sensitivity level selected by the manufacturer.
Access type: Read
featureMap
val featureMap: BooleanStateConfigurationTrait.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.
sensorFault
val sensorFault: BooleanStateConfigurationTrait.SensorFaultBitmap?
Indicates any faults registered by the device.
Access type: Read
supportedSensitivityLevels
val supportedSensitivityLevels: UByte?
Indicates the number of sensitivity levels supported by the device.
Access type: Read