Skip to main content

AxisConfig

Struct AxisConfig 

Source
pub struct AxisConfig { /* private fields */ }
Expand description

Unit conversion for a rotary/linear axis with a known encoder resolution.

Stores the encoder’s counts-per-revolution and an optional user-unit scale (e.g. 360.0 for degrees, 5.0 for mm-per-rev on a ballscrew). All conversion methods are pure arithmetic — no state, no side effects.

§Examples

use autocore_std::ethercat::AxisConfig;

// Revolutions (default)
let cfg = AxisConfig::new(12_800);
assert_eq!(cfg.rev(0.125), 1_600);
assert_eq!(cfg.rev(1.0), 12_800);

// Degrees
let deg = AxisConfig::new(12_800).with_user_scale(360.0);
assert_eq!(deg.user(45.0), 1_600);
assert_eq!(deg.user(360.0), 12_800);

// mm on a 5 mm/rev ballscrew
let mm = AxisConfig::new(12_800).with_user_scale(5.0);
assert_eq!(mm.user(5.0), 12_800);
assert_eq!(mm.user(2.5), 6_400);

Implementations§

Source§

impl AxisConfig

Source

pub const fn new(counts_per_rev: u32) -> Self

Create from encoder resolution (e.g. 12_800 counts/rev). Default user units = revolutions (1.0 user unit = 1 revolution).

Source

pub const fn with_user_scale(self, user_per_rev: f64) -> Self

Set user-units-per-revolution for application-specific units.

  • Degrees: .with_user_scale(360.0)
  • mm on 5 mm/rev ballscrew: .with_user_scale(5.0)
Source

pub fn rev(&self, revolutions: f64) -> i32

Convert revolutions to encoder counts (position).

Source

pub fn rps(&self, rev_per_sec: f64) -> u32

Convert rev/s to counts/s (velocity).

Source

pub fn rps2(&self, rev_per_sec2: f64) -> u32

Convert rev/s² to counts/s² (acceleration).

Source

pub fn user(&self, units: f64) -> i32

Convert user units to encoder counts (position).

Source

pub fn user_per_s(&self, units_per_sec: f64) -> u32

Convert user-units/s to counts/s (velocity).

Source

pub fn user_per_s2(&self, units_per_sec2: f64) -> u32

Convert user-units/s² to counts/s² (acceleration).

Source

pub fn to_rev(&self, counts: i32) -> f64

Convert encoder counts to revolutions.

Source

pub fn to_rps(&self, counts_per_sec: u32) -> f64

Convert counts/s to rev/s.

Source

pub fn to_user(&self, counts: i32) -> f64

Convert encoder counts to user units.

Source

pub fn to_user_per_s(&self, counts_per_sec: u32) -> f64

Convert counts/s to user-units/s.

Trait Implementations§

Source§

impl Clone for AxisConfig

Source§

fn clone(&self) -> AxisConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for AxisConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Copy for AxisConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V