Packages

bb

0.6.0
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 message sensor imu.ex
Raw

lib/bb/message/sensor/imu.ex 

# SPDX-FileCopyrightText: 2025 James Harton
#
# SPDX-License-Identifier: Apache-2.0
defmodule BB.Message.Sensor.Imu do
  @moduledoc """
  Inertial Measurement Unit data.
  ## Fields
  - `orientation` - Orientation as `{:quaternion, x, y, z, w}`
  - `angular_velocity` - Angular velocity as `{:vec3, x, y, z}` in rad/s
  - `linear_acceleration` - Linear acceleration as `{:vec3, x, y, z}` in m/s²
  ## Examples
      alias BB.Message.Sensor.Imu
      alias BB.Message.{Vec3, Quaternion}
      {:ok, msg} = Imu.new(:imu_link,
        orientation: Quaternion.identity(),
        angular_velocity: Vec3.zero(),
        linear_acceleration: Vec3.new(0.0, 0.0, 9.81)
      )
  """
  import BB.Message.Option
  defstruct [:orientation, :angular_velocity, :linear_acceleration]
  use BB.Message,
    schema: [
      orientation: [type: quaternion_type(), required: true, doc: "Orientation as quaternion"],
      angular_velocity: [type: vec3_type(), required: true, doc: "Angular velocity in rad/s"],
      linear_acceleration: [
        type: vec3_type(),
        required: true,
        doc: "Linear acceleration in m/s²"
      ]
    ]
  @type t :: %__MODULE__{
          orientation: BB.Message.Quaternion.t(),
          angular_velocity: BB.Message.Vec3.t(),
          linear_acceleration: BB.Message.Vec3.t()
        }
end