Drone.Supervisor (ex_drone v0.3.0)

Dynamic supervisor for drone vehicle processes.

Each drone is started as a child Drone.Vehicle process under this supervisor. Processes are looked up by name via the Drone.Vehicle.Registry.

Prefer Drone.connect/2 / Drone.disconnect/1 over calling this module directly unless you are embedding vehicles in a custom supervision tree.

Examples

{:ok, _pid} = Drone.Supervisor.start_link([])

{:ok, _vehicle} =
  Drone.Supervisor.start_vehicle(
    name: :alpha,
    adapter: :sim
  )

:ok = Drone.Supervisor.stop_vehicle(:alpha)

Summary

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

start_link(opts \\ [])

Starts the dynamic supervisor (named Drone.Supervisor).

start_vehicle(opts)

Starts a Drone.Vehicle child under this supervisor.

stop_vehicle(name)

Terminates the vehicle registered under name.

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

start_link(opts \\ [])

@spec start_link(keyword()) :: GenServer.on_start()

Starts the dynamic supervisor (named Drone.Supervisor).

Parameters

opts (keyword()) — forwarded to DynamicSupervisor.start_link/3 (usually empty; the process is registered as __MODULE__)

Returns

GenServer.on_start().

Examples

{:ok, _pid} = Drone.Supervisor.start_link([])

start_vehicle(opts)

@spec start_vehicle(keyword()) :: Supervisor.on_start_child()

Starts a Drone.Vehicle child under this supervisor.

Parameters

opts (keyword()) — same options as Drone.Vehicle.start_link/1 (:name, :adapter, :safety, plus adapter opts)

Returns

Supervisor.on_start_child() ({:ok, pid} \| {:error, reason}).

Examples

{:ok, _pid} =
  Drone.Supervisor.start_vehicle(
    name: :sim_1,
    adapter: :sim,
    battery: 100
  )

stop_vehicle(name)

@spec stop_vehicle(atom()) :: :ok | {:error, :not_found}

Terminates the vehicle registered under name.

Parameters

name (atom()) — vehicle name from start_vehicle/1

Returns

:ok — child terminated
{:error, :not_found} — no process registered under that name

Examples

:ok = Drone.Supervisor.stop_vehicle(:sim_1)
{:error, :not_found} = Drone.Supervisor.stop_vehicle(:missing)