Struct syact::device::SoftwarePWM

pub struct SoftwarePWM<P: OutputPin + Send> { /* private fields */ }

A simple software-made PWM-signal

Implementations

impl<P: OutputPin + Send + 'static> SoftwarePWM<P>

pub fn new(pin: P) -> Self

Create a new software PWM-signal at the given pin. Make sure the pin is not already in use!

Setup

Once the setup function is called, the thread and the pin will be crated

pub fn with_freq(self, freq: Frequency) -> Self

Sets the frequency of the PWM-Signal inline

pub fn with_period_time(self, time: Time) -> Self

Sets the period time of the signal inline

pub fn pulse(pin: &mut P, t_ac: Time, t_in: Time) -> Result<(), P::Error>

Does a single pulse with the active time t_ac and inactive time t_in

pub fn get_times(&self) -> [Time; 2]

Get the current signal times (t_ac, t_in)

pub fn set_times(&mut self, t_ac: Time, t_in: Time)

Sets the signal times (t_ac, t_in)

pub fn get_period(&self) -> [Time; 2]

Get the signal times in period style (t_ac, t_per)

pub fn set_period(&mut self, t_ac: Time, t_per: Time)

Set the signal times in period style

• t_ac is the active time
• t_per is the full period time

Panics

The function panics if the given active time t_ac is bigger than the period time t_per

pub fn get_freq(&self) -> (Velocity, f32)

Get the signal times in frequency style (freq, factor)

• freq is the freqency of the signal, meaning how many pulses there are per second
• factor represents how much of the pulse is active time (values 0.0 to 1.0)

pub fn set_freq(&mut self, freq: Frequency, factor: f32)

Set the signal times in frequency style

• freq is the freqency of the signal, meaning how many pulses there are per second
• factor represents how much of the pulse is active time (values 0.0 to 1.0)

Panics

The function panics if the given factor is out of range

pub fn stop(&mut self) -> Result<(), Error>

Stops the PWM-Signal and deletes the thread, can be started again if desired with start()

Trait Implementations

impl<P: Debug + OutputPin + Send> Debug for SoftwarePWM<P>

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

Formats the value using the given formatter.

impl<P: OutputPin + Send + 'static> Dismantle for SoftwarePWM<P>

fn dismantle(&mut self) -> Result<(), Error>

Calls all required functions to assure the component will not occupy any more resources like pins or network connections, without dropping the value

fn dismantle_inline(self) -> Result<Self, Error>

where Self: Sized,

Calls dismantle() with an owned object

impl<P: OutputPin + Send> ErrorType for SoftwarePWM<P>

type Error = ErrorKind

Error type

impl<P: OutputPin + Send + 'static> SetDutyCycle for SoftwarePWM<P>

fn max_duty_cycle(&self) -> u16

Get the maximum duty cycle value.

fn set_duty_cycle(&mut self, duty: u16) -> Result<(), Self::Error>

Set the duty cycle to duty / max_duty.

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

Set the duty cycle to 0%, or always inactive.

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

Set the duty cycle to 100%, or always active.

fn set_duty_cycle_fraction( &mut self, num: u16, denom: u16 ) -> Result<(), Self::Error>

Set the duty cycle to num / denom.

fn set_duty_cycle_percent(&mut self, percent: u8) -> Result<(), Self::Error>

Set the duty cycle to percent / 100

impl<P: OutputPin + Send> Setup for SoftwarePWM<P>

fn setup(&mut self) -> Result<(), Error>

Calls all required functions to assure the components functionality

fn setup_inline(self) -> Result<Self, Error>

where Self: Sized,

Points to `setup``, helper function