Skip to main content

get_mode

Signature:

BoosterRobot.get_mode() -> RobotModeName

Description:

Get the robot's current mode.

Parameters:

No parameters.

Returns:

RobotModeName, see "Robot Metadata / RobotModeName"

Raises:

RuntimeError: Failed to query the robot's current mode.

Example:

from boosteros.robots.booster import BoosterRobot

robot = BoosterRobot()
mode = robot.get_mode()
print(mode)
# Example output: prepare