ModeSelectCommands

@Generated(value = ["GoogleHomePlatformCodegen"])
interface ModeSelectCommands

Known direct subclasses
ModeSelect

API for the ModeSelect trait.

Summary

Public functions
suspend Unit
changeToMode(newMode: UByte)

Change the mode of the device's cluster instance, and set the currentMode attribute of the device's cluster instance.
BatchableCommand<Unit>

The batchable version of changeToMode command.

Public functions

changeToMode

suspend fun changeToMode(newMode: UByte): Unit

Change the mode of the device's cluster instance, and set the currentMode attribute of the device's cluster instance.

Parameters
newMode: UByte

The mode to set the cluster instance to. This must be one of the values in ModeOptionStruct.

changeToModeBatchable

fun changeToModeBatchable(newMode: UByte): BatchableCommand<Unit>

The batchable version of changeToMode command.

Change the mode of the device's cluster instance, and set the currentMode attribute of the device's cluster instance.

Parameters
newMode: UByte

The mode to set the cluster instance to. This must be one of the values in ModeOptionStruct.
Returns
BatchableCommand<Unit>

BatchableCommand