Packages

bb

0.17.1
0.22.1 0.22.0 0.21.0 0.20.3 0.20.2 0.20.1 0.20.0 0.19.0 0.18.0 0.17.1 0.17.0 0.16.0 0.15.4 0.15.3 0.15.2 0.15.1 0.15.0 0.14.0 0.13.2 0.13.1 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.1 0.2.0

Beam Bots - The framework for resilient robotics.

HexDocs

Current section

Files

Jump to
Readme
33 Versions
6 Dependencies
17 Dependants
Files
Activity
bb lib bb dsl command.ex
Raw

lib/bb/dsl/command.ex 

# SPDX-FileCopyrightText: 2025 James Harton

#

# SPDX-License-Identifier: Apache-2.0



defmodule BB.Dsl.Command do

  @moduledoc """

  A command that can be executed on the robot.



  Commands follow the Goal → Feedback → Result pattern, supporting:

  - Arguments with types and defaults

  - State machine integration via `allowed_states`

  - Configurable timeout

  - A handler module implementing the `BB.Command` behaviour

  """



  defstruct __identifier__: nil,

            __spark_metadata__: nil,

            name: nil,

            handler: nil,

            timeout: :infinity,

            allowed_states: [:idle],

            category: nil,

            cancel: [],

            arguments: []



  alias Spark.Dsl.Entity



  @type t :: %__MODULE__{

          __identifier__: any,

          __spark_metadata__: Entity.spark_meta(),

          name: atom,

          handler: module,

          timeout: timeout,

          allowed_states: [atom],

          category: atom | nil,

          cancel: [atom],

          arguments: [BB.Dsl.Command.Argument.t()]

        }

end