RvcOperationalStateCommands

interface RvcOperationalStateCommands

Known direct subclasses
RvcOperationalState

API for the RvcOperationalState trait.


Summary

Public functions

suspend RvcOperationalStateTrait.GoHomeCommand.Response

Send the device to its home base.

suspend RvcOperationalStateTrait.PauseCommand.Response

Pause the device if possible, based on the current operation underway.

suspend RvcOperationalStateTrait.ResumeCommand.Response

Resume operation if the device is in a state where it can be resumed.

Public functions

goHome

suspend fun goHome(): RvcOperationalStateTrait.GoHomeCommand.Response

Send the device to its home base.

Returns
RvcOperationalStateTrait.GoHomeCommand.Response

The result of the completed GoHome command.

pause

suspend fun pause(): RvcOperationalStateTrait.PauseCommand.Response

Pause the device if possible, based on the current operation underway.

Returns
RvcOperationalStateTrait.PauseCommand.Response

The result of the completed Pause command.

resume

suspend fun resume(): RvcOperationalStateTrait.ResumeCommand.Response

Resume operation if the device is in a state where it can be resumed.

Returns
RvcOperationalStateTrait.ResumeCommand.Response

The result of the completed Resume command.