RvcRunModeCommands

interface RvcRunModeCommands

Known direct subclasses
RvcRunMode

API for the RvcRunMode trait.


Summary

Public functions

suspend RvcRunModeTrait.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.

Public functions

changeToMode

suspend fun changeToMode(newMode: UByte): RvcRunModeTrait.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 RvcRunMode.ModeOptionStruct.

Returns
RvcRunModeTrait.ChangeToModeCommand.Response

The result of the completed ChangeToMode command.