Struct gd32vf103xx_hal::pwm::PwmTimer[−][src]

pub struct PwmTimer<TIMER, REMAP> { /* fields omitted */ }

Expand description

PWM TIMER configuration.

To create a new PWM TIMER you should choose a timer and a REMAP mode from NoRemap, PartialRemap1, PartialRemap2 or FullRemap. The tuple provided should contains only the pins you will use.

use gd32vf103xx_hal as hal;
use hal::pac::{Peripherals, TIMER0};
use hal::gpio::GpioExt;
use hal::rcu::RcuExt;
use hal::afio::AfioExt;
use hal::pwm::{PwmTimer, Channel, NoRemap};
use embedded_hal::Pwm;

// ...
let dp = Peripherals::take().unwrap();
let mut rcu = dp.RCU.configure().freeze();

let gpioa = dp.GPIOA.split(&mut rcu);
let pa9 = gpioa.pa9.into_alternate_push_pull();
let pa10 = gpioa.pa10.into_alternate_push_pull();

let mut afio = dp.AFIO.constrain(&mut rcu);
let timer0 = dp.TIMER0;
let mut pwm_t0 = PwmTimer::<TIMER0, NoRemap>::new(
    timer0, (None, Some(&pa9), Some(&pa10), None), &mut rcu, &mut afio);

let max = pwm_t0.get_max_duty();
pwm_t0.set_period(100.hz());
pwm_t0.set_duty(Channel::CH0, max / 4); // 25% duty cycle
pwm_t0.enable(Channel::CH0);

Implementations

impl<REMAP: Into<u8>> PwmTimer<TIMER0, REMAP>

pub fn new(
    timer: TIMER0,
    pins: impl Pins<TIMER0, REMAP>,
    rcu: &mut Rcu,
    afio: &mut Afio
) -> PwmTimer<TIMER0, REMAP>

impl<REMAP: Into<u8> + Into<bool>> PwmTimer<TIMER1, REMAP>

pub fn new<R: Into<u8> + Into<bool>>(
    timer: TIMER1,
    pins: impl Pins<TIMER1, REMAP>,
    rcu: &mut Rcu,
    afio: &mut Afio
) -> PwmTimer<TIMER1, REMAP>

impl<REMAP: Into<u8> + Into<bool>> PwmTimer<TIMER2, REMAP>

pub fn new<R: Into<u8> + Into<bool>>(
    timer: TIMER2,
    pins: impl Pins<TIMER2, REMAP>,
    rcu: &mut Rcu,
    afio: &mut Afio
) -> PwmTimer<TIMER2, REMAP>

impl<REMAP: Into<u8> + Into<bool>> PwmTimer<TIMER3, REMAP>

pub fn new<R: Into<u8> + Into<bool>>(
    timer: TIMER3,
    pins: impl Pins<TIMER3, REMAP>,
    rcu: &mut Rcu,
    afio: &mut Afio
) -> PwmTimer<TIMER3, REMAP>

impl<REMAP: Into<u8> + Into<bool>> PwmTimer<TIMER4, REMAP>

pub fn new<R: Into<u8> + Into<bool>>(
    timer: TIMER4,
    pins: impl Pins<TIMER4, REMAP>,
    rcu: &mut Rcu,
    afio: &mut Afio
) -> PwmTimer<TIMER4, REMAP>

Trait Implementations

impl<REMAP> Pwm for PwmTimer<TIMER0, REMAP>

type Channel = Channel

Enumeration of channels that can be used with this Pwm interface Read more

type Time = Hertz

A time unit that can be converted into a human time unit (e.g. seconds)

type Duty = u16

Type for the duty methods Read more

fn disable(&mut self, channel: Self::Channel)

Disables a PWM channel

fn enable(&mut self, channel: Self::Channel)

Enables a PWM channel

fn get_period(&self) -> Self::Time

Returns the current PWM period

fn get_duty(&self, channel: Self::Channel) -> Self::Duty

Returns the current duty cycle

fn get_max_duty(&self) -> Self::Duty

Returns the maximum duty cycle value

fn set_duty(&mut self, channel: Self::Channel, duty: Self::Duty)

Sets a new duty cycle

fn set_period<P>(&mut self, period: P) where
P: Into<Self::Time>,

Sets a new PWM period

impl<REMAP> Pwm for PwmTimer<TIMER1, REMAP>

type Channel = Channel

Enumeration of channels that can be used with this Pwm interface Read more

type Time = Hertz

A time unit that can be converted into a human time unit (e.g. seconds)

type Duty = u16

Type for the duty methods Read more

fn disable(&mut self, channel: Self::Channel)

Disables a PWM channel

fn enable(&mut self, channel: Self::Channel)

Enables a PWM channel

fn get_period(&self) -> Self::Time

Returns the current PWM period

fn get_duty(&self, channel: Self::Channel) -> Self::Duty

Returns the current duty cycle

fn get_max_duty(&self) -> Self::Duty

Returns the maximum duty cycle value

fn set_duty(&mut self, channel: Self::Channel, duty: Self::Duty)

Sets a new duty cycle

fn set_period<P>(&mut self, period: P) where
P: Into<Self::Time>,

Sets a new PWM period

impl<REMAP> Pwm for PwmTimer<TIMER2, REMAP>

type Channel = Channel

Enumeration of channels that can be used with this Pwm interface Read more

type Time = Hertz

A time unit that can be converted into a human time unit (e.g. seconds)

type Duty = u16

Type for the duty methods Read more

fn disable(&mut self, channel: Self::Channel)

Disables a PWM channel

fn enable(&mut self, channel: Self::Channel)

Enables a PWM channel

fn get_period(&self) -> Self::Time

Returns the current PWM period

fn get_duty(&self, channel: Self::Channel) -> Self::Duty

Returns the current duty cycle

fn get_max_duty(&self) -> Self::Duty

Returns the maximum duty cycle value

fn set_duty(&mut self, channel: Self::Channel, duty: Self::Duty)

Sets a new duty cycle

fn set_period<P>(&mut self, period: P) where
P: Into<Self::Time>,

Sets a new PWM period

impl<REMAP> Pwm for PwmTimer<TIMER3, REMAP>

type Channel = Channel

Enumeration of channels that can be used with this Pwm interface Read more

type Time = Hertz

A time unit that can be converted into a human time unit (e.g. seconds)

type Duty = u16

Type for the duty methods Read more

fn disable(&mut self, channel: Self::Channel)

Disables a PWM channel

fn enable(&mut self, channel: Self::Channel)

Enables a PWM channel

fn get_period(&self) -> Self::Time

Returns the current PWM period

fn get_duty(&self, channel: Self::Channel) -> Self::Duty

Returns the current duty cycle

fn get_max_duty(&self) -> Self::Duty

Returns the maximum duty cycle value

fn set_duty(&mut self, channel: Self::Channel, duty: Self::Duty)

Sets a new duty cycle

fn set_period<P>(&mut self, period: P) where
P: Into<Self::Time>,

Sets a new PWM period

impl<REMAP> Pwm for PwmTimer<TIMER4, REMAP>

type Channel = Channel

Enumeration of channels that can be used with this Pwm interface Read more

type Time = Hertz

A time unit that can be converted into a human time unit (e.g. seconds)

type Duty = u16

Type for the duty methods Read more

fn disable(&mut self, channel: Self::Channel)

Disables a PWM channel

fn enable(&mut self, channel: Self::Channel)

Enables a PWM channel

fn get_period(&self) -> Self::Time

Returns the current PWM period

fn get_duty(&self, channel: Self::Channel) -> Self::Duty

Returns the current duty cycle

fn get_max_duty(&self) -> Self::Duty

Returns the maximum duty cycle value

fn set_duty(&mut self, channel: Self::Channel, duty: Self::Duty)

Sets a new duty cycle

fn set_period<P>(&mut self, period: P) where
P: Into<Self::Time>,

Sets a new PWM period

Auto Trait Implementations

impl<TIMER, REMAP> RefUnwindSafe for PwmTimer<TIMER, REMAP> where
REMAP: RefUnwindSafe,
TIMER: RefUnwindSafe,

impl<TIMER, REMAP> Send for PwmTimer<TIMER, REMAP> where
REMAP: Send,
TIMER: Send,

impl<TIMER, REMAP> Sync for PwmTimer<TIMER, REMAP> where
REMAP: Sync,
TIMER: Sync,

impl<TIMER, REMAP> Unpin for PwmTimer<TIMER, REMAP> where
REMAP: Unpin,
TIMER: Unpin,

impl<TIMER, REMAP> UnwindSafe for PwmTimer<TIMER, REMAP> where
REMAP: UnwindSafe,
TIMER: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

Performs the conversion.

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.