BB.Igniter (bb v0.15.3)

Copy Markdown View Source

Helpers for writing Igniter installers for BB add-on packages.

Only available when :igniter is loaded.

Summary

Functions

Adds a controller entry to the robot's controllers do … end section.

Adds a nested group hierarchy to the robot's parameters do … end section.

Adds a bridge entry to the robot's parameters do … end section.

Returns the robot module to operate on.

Ensures the robot's child spec in the application module carries the given opts.

Functions

add_controller(igniter, robot_module, name, code)

@spec add_controller(Igniter.t(), module(), atom(), String.t()) :: Igniter.t()

Adds a controller entry to the robot's controllers do … end section.

code is the full DSL call as a string, e.g.

controller :dynamixel, {BB.Servo.Robotis.Controller, port: ...}

The section is created if it doesn't already exist. Idempotent on name: if a controller with the same name is already present, the igniter is returned unchanged.

add_param_group(igniter, robot_module, group_path, body_code)

@spec add_param_group(Igniter.t(), module(), [atom(), ...], String.t()) :: Igniter.t()

Adds a nested group hierarchy to the robot's parameters do … end section.

group_path is a list of atoms describing the path of nested groups to create, e.g. [:config, :feetech] produces:

group :config do
  group :feetech do
    <body_code>
  end
end

body_code is the contents of the innermost group (typically one or more param ... declarations) as a string.

The parameters section and intermediate groups are created as needed. Idempotent: if the full group path already exists, the body is not added a second time (so manually-edited param contents are preserved).

add_parameter_bridge(igniter, robot_module, name, code)

@spec add_parameter_bridge(Igniter.t(), module(), atom(), String.t()) :: Igniter.t()

Adds a bridge entry to the robot's parameters do … end section.

code is the full DSL call as a string, e.g.

bridge :robotis_bridge, {BB.Servo.Robotis.Bridge, controller: :dynamixel}

The section is created if it doesn't already exist. Idempotent on name.

robot_module(igniter)

@spec robot_module(Igniter.t()) :: module()

Returns the robot module to operate on.

Resolution order:

  1. The --robot option from igniter.args.options (parsed module name)
  2. {AppPrefix}.Robot (e.g. MyApp.Robot)

Add robot: :string (and ideally aliases: [r: :robot]) to your task's schema to support the --robot flag.

set_robot_opts(igniter, robot_module, opts)

@spec set_robot_opts(Igniter.t(), module(), keyword()) :: Igniter.t()

Ensures the robot's child spec in the application module carries the given opts.

For new robot children, the opts are inserted directly. For existing children, the existing opts are replaced. This is a coarse operation; if multiple installers need to set different keys, the last one to run wins.