tmc51x0::AccelerationValue Struct Reference

Self-describing acceleration value with explicit unit. More...

#include <tmc51x0_types.hpp>

Public Member Functions
	AccelerationValue ()=default
	Default constructor.
constexpr	AccelerationValue (float v, Unit u) noexcept
	Construct with value and unit.

Static Public Member Functions
static constexpr AccelerationValue	FromSteps (float v) noexcept
static constexpr AccelerationValue	FromRevPerSec (float v) noexcept
static constexpr AccelerationValue	FromRad (float v) noexcept
static constexpr AccelerationValue	FromDeg (float v) noexcept
static constexpr AccelerationValue	FromMm (float v) noexcept

Public Attributes
float	value {0.0f}
	Acceleration magnitude.
Unit	unit {Unit::Steps}
	Acceleration unit (per second²)

Detailed Description

Self-describing acceleration value with explicit unit.

Carries both the acceleration value and its unit, eliminating ambiguity in configuration and ensuring proper unit conversions throughout the driver.

AccelerationValue accel = {50.0f, Unit::RevPerSec};
AccelerationValue accel2 = AccelerationValue::FromRevPerSec(50.0f);

Constructor & Destructor Documentation

AccelerationValue() [1/2]

tmc51x0::AccelerationValue::AccelerationValue ( )

default

Default constructor.

AccelerationValue() [2/2]

constexpr tmc51x0::AccelerationValue::AccelerationValue ( float v, Unit u )

inlineconstexprnoexcept

Construct with value and unit.

Member Function Documentation

FromDeg()

static constexpr AccelerationValue tmc51x0::AccelerationValue::FromDeg ( float v )

inlinestaticconstexprnoexcept

FromMm()

static constexpr AccelerationValue tmc51x0::AccelerationValue::FromMm ( float v )

inlinestaticconstexprnoexcept

FromRad()

static constexpr AccelerationValue tmc51x0::AccelerationValue::FromRad ( float v )

inlinestaticconstexprnoexcept

FromRevPerSec()

static constexpr AccelerationValue tmc51x0::AccelerationValue::FromRevPerSec ( float v )

inlinestaticconstexprnoexcept

FromSteps()

static constexpr AccelerationValue tmc51x0::AccelerationValue::FromSteps ( float v )

inlinestaticconstexprnoexcept

Member Data Documentation

unit

Unit tmc51x0::AccelerationValue::unit {Unit::Steps}

Acceleration unit (per second²)

value

float tmc51x0::AccelerationValue::value {0.0f}

Acceleration magnitude.

---

The documentation for this struct was generated from the following file:

• tmc51x0_types.hpp