ArmDisarm

@Generated(value = ["GoogleHomePlatformCodegen"])
interface ArmDisarm : ArmDisarmTrait.Attributes, MatterTrait, ArmDisarmCommands


API for the ArmDisarm trait. This trait supports arming and disarming, as used in security systems.

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<ArmDisarm>

Inherited functions

From com.google.home.google.ArmDisarmCommands
suspend Unit

Sets the alarm level of the device.

BatchableCommand<Unit>

The batchable version of armDisarm command.

From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties

From com.google.home.google.ArmDisarmTrait.Attributes
List<UInt>

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

ArmDisarmTrait.ArmState?

Current arm state of the device.

List<UInt>

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

ArmDisarmTrait.AvailableArmLevels?

The supported security levels of the device.

UShort

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

String?

The current security level.

Long?

The Epoch Unix timestamp of when an active entry allowance expires, before which the user must enter a pin to prevent the alarm from sounding.

Long?

The Epoch Unix timestamp of when an active exit allowance expires, before which the user must leave the house if the device is arming.

UInt?

Number of seconds before the currentArmLevel takes effect.

UInt

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?

Indicates if the device is currently armed.

String?

The level from availableArmLevels that the device will enter after an exit countdown completes.

From com.google.home.Trait

Public functions

supports

fun supports(attribute: ArmDisarm.Attribute): Boolean

supports

fun supports(command: ArmDisarm.Command): Boolean

Public properties

factory

open val factoryTraitFactory<ArmDisarm>