embassy-stm32

Crates

git

Versions

stm32f412rg

Flavors

embassy_stm32::timer::simple_pwm

Struct SimplePwmChannel

Source
pub struct SimplePwmChannel<'d, T: GeneralInstance4Channel> { /* private fields */ }
Expand description

A single channel of a pwm, obtained from SimplePwm::split, SimplePwm::channel, SimplePwm::ch1, etc.

It is not possible to change the pwm frequency because the frequency configuration is shared with all four channels.

Implementations§

Source§

impl<'d, T: GeneralInstance4Channel> SimplePwmChannel<'d, T>

Source

pub fn enable(&mut self)

Enable the given channel.

Source

pub fn disable(&mut self)

Disable the given channel.

Source

pub fn is_enabled(&self) -> bool

Check whether given channel is enabled

Source

pub fn max_duty_cycle(&self) -> u16

Get max duty value.

This value depends on the configured frequency and the timer’s clock rate from RCC.

Source

pub fn set_duty_cycle(&mut self, duty: u16)

Set the duty for a given channel.

The value ranges from 0 for 0% duty, to max_duty_cycle for 100% duty, both included.

Source

pub fn set_duty_cycle_fully_off(&mut self)

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

Source

pub fn set_duty_cycle_fully_on(&mut self)

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

Source

pub fn set_duty_cycle_fraction(&mut self, num: u16, denom: u16)

Set the duty cycle to num / denom.

The caller is responsible for ensuring that num is less than or equal to denom, and that denom is not zero.

Source

pub fn set_duty_cycle_percent(&mut self, percent: u8)

Set the duty cycle to percent / 100

The caller is responsible for ensuring that percent is less than or equal to 100.

Source

pub fn current_duty_cycle(&self) -> u16

Get the duty for a given channel.

The value ranges from 0 for 0% duty, to max_duty_cycle for 100% duty, both included.

Source

pub fn set_polarity(&mut self, polarity: OutputPolarity)

Set the output polarity for a given channel.

Source

pub fn set_output_compare_mode(&mut self, mode: OutputCompareMode)

Set the output compare mode for a given channel.

Trait Implementations§

Source§

impl<'d, T: GeneralInstance4Channel> ErrorType for SimplePwmChannel<'d, T>

Source§

type Error = Infallible

Error type
Source§

impl<'d, T: GeneralInstance4Channel> SetDutyCycle for SimplePwmChannel<'d, T>

Source§

fn max_duty_cycle(&self) -> u16

Get the maximum duty cycle value. Read more
Source§

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

Set the duty cycle to duty / max_duty. Read more
Source§

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

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

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

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

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

Set the duty cycle to num / denom. Read more
Source§

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

Set the duty cycle to percent / 100 Read more

Auto Trait Implementations§

§

impl<'d, T> Freeze for SimplePwmChannel<'d, T>
where T: Freeze,

§

impl<'d, T> RefUnwindSafe for SimplePwmChannel<'d, T>
where T: RefUnwindSafe,

§

impl<'d, T> Send for SimplePwmChannel<'d, T>
where T: Send,

§

impl<'d, T> Sync for SimplePwmChannel<'d, T>
where T: Sync,

§

impl<'d, T> Unpin for SimplePwmChannel<'d, T>
where T: Unpin,

§

impl<'d, T> !UnwindSafe for SimplePwmChannel<'d, T>

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