BB.MCP.CommandRobot (bb_mcp v0.3.3)

Copy Markdown View Source

A robot with a command that keeps running until it is told to stop, for exercising the tools that list and cancel in-flight commands.

Summary

Functions

Execute the arm command.

Returns a child specification for starting this robot under a supervisor.

Execute the linger command.

Returns the optimised robot representation.

Starts the robot's supervision tree.

Functions

arm(goal \\ [])

@spec arm(keyword()) :: {:ok, pid()} | {:error, term()}

Execute the arm command.

Returns

  • {:ok, pid()} - Command started, use BB.Command.await/2 for the result
  • {:error, term()} - Command could not be started

Example

{:ok, cmd} = arm(goal_args)
{:ok, result} = BB.Command.await(cmd)

child_spec(opts \\ [])

@spec child_spec(Keyword.t()) :: Supervisor.child_spec()

Returns a child specification for starting this robot under a supervisor.

linger(goal \\ [])

@spec linger(keyword()) :: {:ok, pid()} | {:error, term()}

Execute the linger command.

Arguments

  • notify: :any (required)

Returns

  • {:ok, pid()} - Command started, use BB.Command.await/2 for the result
  • {:error, term()} - Command could not be started

Example

{:ok, cmd} = linger(goal_args)
{:ok, result} = BB.Command.await(cmd)

robot()

@spec robot() :: BB.Robot.t()

Returns the optimised robot representation.

This struct is built at compile-time from the DSL definition and contains:

  • All physical values converted to SI base units (floats)
  • Flat maps for O(1) lookup of links, joints, sensors, and actuators
  • Pre-computed topology metadata for efficient traversal

Examples

robot = Elixir.BB.MCP.CommandRobot.robot()
{:ok, link} = BB.Robot.get_link(robot, :base_link)
{:ok, joint} = BB.Robot.get_joint(robot, :shoulder)

start_link(opts \\ [])

@spec start_link(Keyword.t()) :: Supervisor.on_start()

Starts the robot's supervision tree.

Options

All options are passed through to sensor and actuator child processes.