Skip to main content

get_up

Signature:

BoosterRobot.get_up(
*,
on_done: Callable[[TaskHandle[None]], None] | None = None,
on_status_change: Callable[[TaskHandle[None]], None] | None = None,
) -> TaskHandle[None]

Description:

Asynchronously triggers the robot stand-up task.

Parameters:

Parameter

Type

Default

Description

on_done

Callable[[TaskHandle[None]], None] | None

None

Callback invoked when the task enters a terminal state.

on_status_change

Callable[[TaskHandle[None]], None] | None

None

Callback invoked when the task status changes.

Returns:

TaskHandle[None], see "Tasks and Subscriptions / TaskHandle"

This task cannot be cancelled; cancel() always returns False.

Raises:

RuntimeError: A task in the same group is already running, the robot is executing another action, or stand-up startup failed.

Example:

from boosteros.robots.booster import BoosterRobot

robot = BoosterRobot()
handle = robot.get_up()
status = handle.wait(timeout=30.0)
print(status)
# Example output: 'SUCCEEDED'