Skip to content

wait_enabled

Runs in the client Sends nothing to the robot

Wait until the robot is enabled. It waits until the robot's status shows it enabled, and sends no command: enable it with enable(), or call enable(wait=True) to do both. It returns at once when the robot is already enabled.

While an error is latched, the robot refuses to enable (enable() raises CommandRejected): this call then runs into its timeout. Call clear_errors() first.

Syntax

robot.wait_enabled(timeout=10.0)

Arguments

Name Type Default Description
timeout float | None 10.0 Seconds to wait at most. None waits as long as it takes.

Returns

Nothing.

Examples

robot.enable()
robot.wait_enabled()

Exceptions

  • RobotTimeout: The robot did not report itself enabled within timeout.
  • RobotConnectionError: The client is not connected, or lost its connection while waiting.

See also