Packages

bb

0.22.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 state.ex
Raw

lib/bb/dsl/state.ex 

# SPDX-FileCopyrightText: 2025 James Harton

#

# SPDX-License-Identifier: Apache-2.0



defmodule BB.Dsl.State do

  @moduledoc """

  A custom operational state for the robot.



  States define the operational context the robot can be in (beyond the

  built-in `:idle`). Commands specify which states they can run in via

  `allowed_states`, and can transition the robot to new states via

  `next_state:` in their result.



  The `:idle` state is always implicitly available and is the default

  initial state.

  """



  defstruct __identifier__: nil,

            __spark_metadata__: nil,

            name: nil,

            doc: nil



  alias Spark.Dsl.Entity



  @type t :: %__MODULE__{

          __identifier__: any,

          __spark_metadata__: Entity.spark_meta(),

          name: atom,

          doc: String.t() | nil

        }

end