Struct Pwm

pub struct Pwm<const FREQ: u32> { /* private fields */ }

Implementations

impl<const FREQ: u32> Pwm<FREQ>

pub fn new(ch: PwmChannel) -> Self

Creates a new PWM instance with the specified channel.

Arguments

• ch - The PWM channel to initialize.

Returns

A new Pwm instance configured for the given channel and frequency.

pub fn enable(&self)

Enables the PWM output on the specified channel.

pub fn disable(&self)

Disables the PWM output on the specified channel.

pub fn set_polarity(&self, p: PwmPolarity)

Sets the polarity of the PWM output on the specified channel.

Arguments

• p - The polarity to set (ActiveHigh or ActiveLow).

pub fn get_duty(&self) -> u16

Retrieves the current duty cycle of the PWM output on the specified channel.

Returns

The current duty cycle as a u16.

pub fn get_duty_time(&self) -> TimerDurationU32<FREQ>

Retrieves the current duty cycle of the PWM output on the specified channel and converts it to a duration.

Returns

The current duty cycle as a TimerDurationU32.

pub fn set_duty(&self, duty: u16)

Sets the duty cycle of the PWM output on the specified channel.

Arguments

• duty - The duty cycle to set.

pub fn set_duty_time(&self, duty: TimerDurationU32<FREQ>)

Sets the duty cycle of the PWM output on the specified channel from a duration.

Arguments

• duty - The duty cycle duration.

pub fn get_max_duty(&self) -> u16

Retrieves the maximum duty cycle value of the PWM output.

Returns

The maximum duty cycle as a u16. If 0 is returned, it means the max duty cycle is 2^16.

pub fn get_period(&self) -> TimerDurationU32<FREQ>

Retrieves the current period of the PWM output as a duration.

Returns

The current period as a TimerDurationU32.

pub fn set_period(&self, period: TimerDurationU32<FREQ>)

Sets the PWM frequency for the PWM output from a duration.

Arguments

• period - The desired period as a TimerDurationU32.

Trait Implementations

impl<const FREQ: u32> Clone for Pwm<FREQ>

fn clone(&self) -> Pwm<FREQ>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const FREQ: u32> Debug for Pwm<FREQ>

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

Formats the value using the given formatter.

impl<const FREQ: u32> Drop for Pwm<FREQ>

fn drop(&mut self)

Executes the destructor for this type.

impl<const FREQ: u32> ErrorType for Pwm<FREQ>

type Error = Infallible

Error type

impl<const FREQ: u32> SetDutyCycle for Pwm<FREQ>

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