RvcCleanModeCommands

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

Known direct subclasses
RvcCleanMode

API for the RvcCleanMode trait.

Summary

Public functions
suspend RvcCleanModeTrait.ChangeToModeCommand.Response
changeToMode(newMode: UByte)

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

The batchable version of changeToMode command.

Public functions

changeToMode

suspend fun changeToMode(newMode: UByte): RvcCleanModeTrait.ChangeToModeCommand.Response

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 RvcCleanMode.ModeOptionStruct.
Returns
RvcCleanModeTrait.ChangeToModeCommand.Response

The result of the completed ChangeToMode command.

changeToModeBatchable

fun changeToModeBatchable(newMode: UByte): BatchableCommand<RvcCleanModeTrait.ChangeToModeCommand.Response>

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 RvcCleanMode.ModeOptionStruct.
Returns
BatchableCommand<RvcCleanModeTrait.ChangeToModeCommand.Response>

BatchableCommand