Dock

@Generated(value = ["GoogleHomePlatformCodegen"])
interface Dock : DockTrait.Attributes, MatterTrait, DockCommands


API for the Dock trait. This trait is designed for self-mobile devices, such as robotic vacuum cleaners, that can be commanded to return for charging.

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

Inherited functions

From com.google.home.google.DockCommands
suspend Unit

Docks the device.

BatchableCommand<Unit>

The batchable version of dock command.

From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties

From com.google.home.google.DockTrait.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

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 connected to the docking station.

From com.google.home.Trait

Public functions

supports

fun supports(attribute: Dock.Attribute): Boolean

supports

fun supports(command: Dock.Command): Boolean

Public properties

factory

open val factoryTraitFactory<Dock>