ZoneManagement

@Generated(value = ["GoogleHomePlatformCodegen"])
interface ZoneManagement : ZoneManagementTrait.Attributes, MatterTrait, Updatable, ZoneManagementCommands

API for the ZoneManagement trait. This trait provides an interface to manage regions of interest, known as zones, which can be defined by either the manufacturer or the end user. This is a minimalistic custom version of the ZoneManagement standard Matter cluster, and provides functionality for some of the zone settings.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Descriptor enum for this event's fields.

Descriptor enum for this event's fields.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<ZoneManagement>

Inherited functions
From com.google.home.TraitStateInvalidation
suspend Unit
From com.google.home.Updatable
suspend ZoneManagement
update(optimisticReturn: (ZoneManagement) -> Unit, init: ZoneManagementTrait.MutableAttributes.() -> Unit)

Creates a mutable copy of an object and calls the given function to mutate it, then saves it and returns a new immutable copy with the updated state.
From com.google.home.matter.standard.ZoneManagementCommands
suspend Unit

Creates or updates a zone trigger.
BatchableCommand<Unit>

The batchable version of createOrUpdateTrigger command.
suspend ZoneManagementTrait.CreateTwoDCartesianZoneCommand.Response

Creates and stores a two-dimensional Cartesian zone.
BatchableCommand<ZoneManagementTrait.CreateTwoDCartesianZoneCommand.Response>

The batchable version of createTwoDCartesianZone command.
suspend Unit

Removes a zone trigger.
BatchableCommand<Unit>

The batchable version of removeTrigger command.
suspend Unit
removeZone(zoneId: UShort)

Removes the user-defined zone indicated by the ZoneID.
BatchableCommand<Unit>

The batchable version of removeZone command.
suspend Unit

Updates a stored two-dimensional Cartesian zone.
BatchableCommand<Unit>

The batchable version of updateTwoDCartesianZone command.
From com.google.home.matter.standard.ZoneManagementTrait.Attributes
open StructDescriptor

Returns the descriptor for the struct.
open Any?

Returns the value of the field for the given tag ID.

Inherited properties
From com.google.home.Trait
Trait.TraitMetadata
From com.google.home.matter.standard.ZoneManagementTrait.Attributes
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.
ZoneManagementTrait.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 user-defined zones supported.
UByte?

The maximum number of zones supported.
UByte?

The sensitivity of the underlying zone triggering detection mechanism.
UByte?

The maximum sensitivity level supported.
List<ZoneManagementTrait.ZoneTriggerControlStruct>?

Specifies all currently defined triggers controlling the generation of ZoneTriggered and ZoneStopped events.
ZoneManagementTrait.TwoDCartesianVertexStruct?

The maximum X and Y points that are allowed for TwoD Cartesian Zones.
List<ZoneManagementTrait.ZoneInformationStruct>?

All currently defined zones as a list of ZoneInformationStruct.

Public functions

supports

fun supports(attribute: ZoneManagement.Attribute): Boolean

supports

fun supports(command: ZoneManagement.Command): Boolean

Public properties

factory

open val factory: TraitFactory<ZoneManagement>