Dispense

@Generated(value = ["GoogleHomePlatformCodegen"])
interface Dispense : DispenseTrait.Attributes, MatterTrait, DispenseCommands

API for the Dispense trait. This trait supports devices dispensing a specified amount of one or more physical items.

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

Inherited functions
From com.google.home.google.DispenseCommands
suspend DispenseTrait.DispenseCommand.Response
dispense(
    item: String,
    amount: Float,
    unit: DispenseTrait.Unit,
    presetName: String
)

Start or stop dispensing.
BatchableCommand<DispenseTrait.DispenseCommand.Response>
dispenseBatchable(
    item: String,
    amount: Float,
    unit: DispenseTrait.Unit,
    presetName: String
)

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

Inherited properties
From com.google.home.google.DispenseTrait.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.
List<DispenseTrait.DispenseItem>?

States of the items that the device can dispense.
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.
List<DispenseTrait.DispensableItem>?

Contains information on all the items that the device can dispense.
List<DispenseTrait.Preset>?

Presets supported by the device.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: Dispense.Attribute): Boolean

supports

fun supports(command: Dispense.Command): Boolean

Public properties

factory

open val factory: TraitFactory<Dispense>