# `BB.Jido.TestRobot`
[🔗](https://github.com/beam-bots/bb_jido/blob/main/test/support/test_robot.ex#L5)

A minimal robot for testing bb_jido.

# `arm`

```elixir
@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`

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

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

# `disarm`

```elixir
@spec disarm(keyword()) :: {:ok, pid()} | {:error, term()}
```

Execute the `disarm` command.

## Returns

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

## Example

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

# `robot`

```elixir
@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.Jido.TestRobot.robot()
    link = BB.Robot.get_link(robot, :base_link)
    joint = BB.Robot.get_joint(robot, :shoulder)

# `start_link`

```elixir
@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.

# `test_fail`

```elixir
@spec test_fail(keyword()) :: {:ok, pid()} | {:error, term()}
```

Execute the `test_fail` command.

## Returns

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

## Example

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

# `test_succeed`

```elixir
@spec test_succeed(keyword()) :: {:ok, pid()} | {:error, term()}
```

Execute the `test_succeed` command.

## Returns

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

## Example

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

---

*Consult [api-reference.md](api-reference.md) for complete listing*