BB.Camera.AVF.Test.StubBot (bb_camera_avf v0.1.0)

Copy Markdown View Source

A robot whose camera is driven by BB.Camera.FFmpeg.Test.StubBackend.

Everything but the bytes is real: the real driver, the real hub, the real framer and the real capture bounds. Only the thing that would have been ffmpeg is replaced, so a test can decide exactly what the camera produces and when.

The stub reports to whatever process is registered as :bb_camera_avf_stub_observer, because the DSL is compiled long before any test process exists.

The width comes from a parameter, so a test can reconfigure the camera the way a robot actually does. Its default is the width every other test expects.

Summary

Functions

Returns default parameter values.

Returns the parameter schema for validation.

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

Returns the optimised robot representation.

Starts the robot's supervision tree.

Functions

__bb_default_parameters__()

@spec __bb_default_parameters__() :: [{[atom()], term()}]

Returns default parameter values.

Returns a list of {path, value} tuples for parameters that have defaults.

__bb_parameter_schema__()

@spec __bb_parameter_schema__() :: [{[atom()], keyword()}]

Returns the parameter schema for validation.

The schema is a list of {path, opts} tuples where opts is a keyword list compatible with Spark.Options.

child_spec(opts \\ [])

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

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

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.Camera.AVF.Test.StubBot.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.