Skip to main content

Sequencer

Struct Sequencer 

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

A position in a drive sequence, walked one step at a time.

Holding the index into the pattern, a sequencer turns each step into the next coil pattern to apply, wrapping around the cycle so it can run indefinitely in either direction.

§Examples

use pamoja_actuators::stepper::{Direction, Drive, Sequencer};

let mut sequencer = Sequencer::new(Drive::HalfStep);
assert_eq!(sequencer.coils(), 0b1000);
assert_eq!(sequencer.step(Direction::Forward), 0b1100);

// One full electrical cycle returns to the start.
for _ in 1..Drive::HalfStep.step_count() {
    sequencer.step(Direction::Forward);
}
assert_eq!(sequencer.coils(), 0b1000);

Implementations§

Source§

impl Sequencer

Source

pub fn new(drive: Drive) -> Sequencer

Creates a sequencer at the start of a drive pattern.

§Arguments
  • drive - the drive pattern to walk.
§Returns

A sequencer whose current pattern is the first in the drive.

Source

pub fn coils(&self) -> u8

Returns the coil pattern at the current position.

§Returns

The four-bit coil pattern to apply now.

Source

pub fn step(&mut self, direction: Direction) -> u8

Advances one step in direction and returns the new coil pattern.

The index wraps around the cycle, so stepping forever in either direction is well defined.

§Arguments
  • direction - which way to step.
§Returns

The coil pattern to apply after the step.

Source

pub fn drive(&self) -> Drive

Returns the drive pattern this sequencer walks.

Trait Implementations§

Source§

impl Clone for Sequencer

Source§

fn clone(&self) -> Sequencer

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 Sequencer

Source§

impl Debug for Sequencer

Source§

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

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

impl Eq for Sequencer

Source§

impl PartialEq for Sequencer

Source§

fn eq(&self, other: &Sequencer) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Sequencer

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