Timer

@Generated(value = ["GoogleHomePlatformCodegen"])
interface Timer : TimerTrait.Attributes, MatterTrait, TimerCommands

API for the Timer trait. This trait can be used to control a built-in timer on a device, such as starting a new timer on a sprinkler, and pausing and canceling the timer.

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

Inherited functions
From com.google.home.google.TimerCommands
suspend Unit
timerAdjust(adjustmentTimeSeconds: Int)

Adjusts the device timer duration.
BatchableCommand<Unit>
timerAdjustBatchable(adjustmentTimeSeconds: Int)

The batchable version of timerAdjust command.
suspend Unit

Cancels the device timer.
BatchableCommand<Unit>

The batchable version of timerCancel command.
suspend Unit

Pauses the device timer.
BatchableCommand<Unit>

The batchable version of timerPause command.
suspend Unit

Resumes the device timer.
BatchableCommand<Unit>

The batchable version of timerResume command.
suspend Unit
timerStart(timerTimeSeconds: Int)

Starts a new device timer.
BatchableCommand<Unit>
timerStartBatchable(timerTimeSeconds: Int)

The batchable version of timerStart command.
From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties
From com.google.home.google.TimerTrait.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.
Boolean?

Indicates whether the device supports one-way (true) or two-way (false) communication.
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.
Int?

The largest timer setting, in seconds, that is available on the device.
Boolean?

Indicates that an active timer exists but is currently paused.
Int?

The remaining number of seconds on the timer.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: Timer.Attribute): Boolean

supports

fun supports(command: Timer.Command): Boolean

Public properties

factory

open val factory: TraitFactory<Timer>