ZoneManagementTrait.Attributes

@Generated(value = ["GoogleHomePlatformCodegen"])
interface ZoneManagementTrait.Attributes : ClusterStruct

Known direct subclasses

ZoneManagement

ZoneManagement

API for the ZoneManagement trait.

Attributes for the ZoneManagement cluster.

Summary

Public functions
`open StructDescriptor`	`@HomeExperimentalGenericApi getDescriptor()` Returns the descriptor for the struct.
`open Any?`	`@HomeExperimentalGenericApi getFieldValueById(tagId: UInt)` Returns the value of the field for the given tag ID.

Public properties
`List<UInt>`	`acceptedCommandList` A list of client-generated commands which are supported by this cluster server instance.
`List<UInt>`	`attributeList` A list of the attribute IDs of the attributes supported by the cluster instance.
`UShort`	`clusterRevision` The revision of the server cluster specification supported by the cluster instance.
`ZoneManagementTrait.Feature`	`featureMap` Whether the server supports zero or more optional cluster features.
`List<UInt>`	`generatedCommandList` A list of server-generated commands (server to client) which are supported by this cluster server instance.
`UByte?`	`maxUserDefinedZones`
`UByte?`	`maxZones`
`UByte?`	`sensitivity`
`UByte?`	`sensitivityMax`
`List<ZoneManagementTrait.ZoneTriggerControlStruct>?`	`triggers`
`ZoneManagementTrait.TwoDCartesianVertexStruct?`	`twoDCartesianMax` The maximum X and Y points that are allowed for TwoD Cartesian Zones.
`List<ZoneManagementTrait.ZoneInformationStruct>?`	`zones` All currently defined zones as a list of `ZoneInformationStruct`.

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.

clusterRevision

val clusterRevision: UShort

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

featureMap

val featureMap: ZoneManagementTrait.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.

maxUserDefinedZones

val maxUserDefinedZones: UByte?

maxZones

val maxZones: UByte?

sensitivity

val sensitivity: UByte?

sensitivityMax

val sensitivityMax: UByte?

triggers

val triggers: List<ZoneManagementTrait.ZoneTriggerControlStruct>?

twoDCartesianMax

val twoDCartesianMax: ZoneManagementTrait.TwoDCartesianVertexStruct?

The maximum X and Y points that are allowed for TwoD Cartesian Zones.

Access type: Read

zones

val zones: List<ZoneManagementTrait.ZoneInformationStruct>?

All currently defined zones as a list of ZoneInformationStruct. Use the commands from this cluster to add, update, or remove entries from this list.

Access type: Read