ServiceArea

@Generated(value = ["GoogleHomePlatformCodegen"])
interface ServiceArea : ServiceAreaTrait.Attributes, MatterTrait, ServiceAreaCommands

API for the ServiceArea trait. This trait provides an interface for controlling the areas where a device should operate, for reporting the status at each area, and for querying the current area.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<ServiceArea>

Inherited functions
From com.google.home.matter.standard.ServiceAreaCommands
suspend ServiceAreaTrait.SelectAreasCommand.Response
selectAreas(newAreas: List<UInt>)

Selects the areas where the device should attempt to operate.
BatchableCommand<ServiceAreaTrait.SelectAreasCommand.Response>

The batchable version of selectAreas command.
suspend ServiceAreaTrait.SkipAreaCommand.Response
skipArea(skippedArea: UInt)

Indicates to the device that the area specified by the areaID field should be skipped.
BatchableCommand<ServiceAreaTrait.SkipAreaCommand.Response>
skipAreaBatchable(skippedArea: UInt)

The batchable version of skipArea command.
From com.google.home.matter.standard.ServiceAreaTrait.Attributes
open StructDescriptor

Returns the descriptor for the struct.
open Any?

Returns the value of the field for the given tag ID.
From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties
From com.google.home.matter.standard.ServiceAreaTrait.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.
UInt?

The area where the device is currently located, regardless of whether it is operating.
UInt?

The estimated Unix epoch time for completing service in the area, indicated by the currentArea attribute.
ServiceAreaTrait.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.
List<ServiceAreaTrait.ProgressStruct>?

The operating status of one or more areas.
List<UInt>?

The set of areas where the device should attempt to operate.
List<ServiceAreaTrait.AreaStruct>?

The list of supported service areas for the device.
List<ServiceAreaTrait.MapStruct>?

The list of supported maps for the device.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: ServiceArea.Attribute): Boolean

supports

fun supports(command: ServiceArea.Command): Boolean

Public properties

factory

open val factory: TraitFactory<ServiceArea>