Skip to main content

Esc

Struct Esc 

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

Maps a normalized throttle to an electronic speed controller’s RC pulse width.

An ESC reads the same RC pulse a servo does, with the pulse width setting motor output. Esc::bidirectional uses the common reversible scheme: 1000 microseconds full reverse, 1500 neutral, 2000 full forward, so a throttle in [-1, 1] maps linearly across it.

§Examples

use pamoja_kit::Esc;

let esc = Esc::bidirectional();
assert_eq!(esc.pulse(0.0), 1500); // neutral
assert_eq!(esc.pulse(1.0), 2000); // full forward
assert_eq!(esc.pulse(-1.0), 1000); // full reverse
assert_eq!(esc.pulse(0.5), 1750);

Implementations§

Source§

impl Esc

Source

pub fn bidirectional() -> Self

Returns the standard reversible ESC map: 1000 / 1500 / 2000 microseconds.

§Returns

The bidirectional map.

Source

pub fn new(min_us: u16, neutral_us: u16, max_us: u16) -> Self

Creates a map from explicit reverse, neutral, and forward pulse widths.

§Arguments
  • min_us - the pulse width at full reverse.
  • neutral_us - the pulse width at rest.
  • max_us - the pulse width at full forward.
§Returns

The map.

Source

pub fn pulse(&self, throttle: f32) -> u16

Returns the pulse width for a throttle.

§Arguments
  • throttle - the demand in [-1, 1], clamped; negative reverses, positive drives forward.
§Returns

The pulse width in microseconds.

Trait Implementations§

Source§

impl Clone for Esc

Source§

fn clone(&self) -> Esc

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Esc

Source§

impl Debug for Esc

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Esc

§

impl RefUnwindSafe for Esc

§

impl Send for Esc

§

impl Sync for Esc

§

impl Unpin for Esc

§

impl UnsafeUnpin for Esc

§

impl UnwindSafe for Esc

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, 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.