Trait drv8825::traits::SetStepMode

pub trait SetStepMode {
    type Error;
    type StepMode: StepMode;

    const SETUP_TIME: Duration<u32, 1, 1000000000>;
    const HOLD_TIME: Duration<u32, 1, 1000000000>;

    fn apply_mode_config(
        &mut self,
        step_mode: Self::StepMode
    ) -> Result<(), Self::Error>;
    fn enable_driver(&mut self) -> Result<(), Self::Error>;
}

Implemented by drivers that support controlling the microstepping mode

Required Associated Types

type Error

The error that can occur while using this trait

type StepMode: StepMode

The type that defines the microstepping mode

This crate includes a number of enums that can be used for this purpose.

Required Associated Constants

const SETUP_TIME: Duration<u32, 1, 1000000000>

The time the mode signals need to be held before re-enabling the driver

const HOLD_TIME: Duration<u32, 1, 1000000000>

The time the mode signals need to be held after re-enabling the driver

Required Methods

fn apply_mode_config(
    &mut self,
    step_mode: Self::StepMode
) -> Result<(), Self::Error>

Apply the new step mode configuration

Typically this puts the driver into reset and sets the mode pins according to the new step mode.

fn enable_driver(&mut self) -> Result<(), Self::Error>

Re-enable the driver after the mode has been set

Implementors

impl<'r, T> SetStepMode for RefMut<'r, T> where
    T: SetStepMode, 

const SETUP_TIME: Duration<u32, 1, 1000000000> = T::SETUP_TIME

const HOLD_TIME: Duration<u32, 1, 1000000000> = T::HOLD_TIME

type Error = <T as SetStepMode>::Error

type StepMode = <T as SetStepMode>::StepMode

impl<Driver, Timer, Profile, Convert, const TIMER_HZ: u32> SetStepMode for SoftwareMotionControl<Driver, Timer, Profile, Convert, TIMER_HZ> where
    Driver: SetStepMode,
    Profile: MotionProfile, 

const SETUP_TIME: Duration<u32, 1, 1000000000> = Driver::SETUP_TIME

const HOLD_TIME: Duration<u32, 1, 1000000000> = Driver::HOLD_TIME

type Error = BusyError<<Driver as SetStepMode>::Error>

type StepMode = <Driver as SetStepMode>::StepMode

impl<Reset, Mode0, Mode1, Mode2, Step, Dir, OutputPinError> SetStepMode for DRV8825<(), (), (), Reset, Mode0, Mode1, Mode2, Step, Dir> where
    Reset: OutputPin<Error = OutputPinError>,
    Mode0: OutputPin<Error = OutputPinError>,
    Mode1: OutputPin<Error = OutputPinError>,
    Mode2: OutputPin<Error = OutputPinError>, 

const SETUP_TIME: Duration<u32, 1, 1000000000> = Nanoseconds::from_ticks(650)

const HOLD_TIME: Duration<u32, 1, 1000000000> = Nanoseconds::from_ticks(650)

type Error = OutputPinError

type StepMode = StepMode32