Struct esp_idf_hal::rmt::Pulse

pub struct Pulse {
    pub ticks: PulseTicks,
    pub pin_state: PinState,
}

A Pulse contains a pin state and a tick count, used in creating a Signal.

The real time duration of a tick depends on the [Config::clock_divider] setting.

You can create a Pulse with a [Duration] by using Pulse::new_with_duration.

Example

let pulse = Pulse::new(PinState::High, PulseTicks::new(32));

Fields

ticks: PulseTicks

pin_state: PinState

Implementations

impl Pulse

pub const fn zero() -> Self

pub const fn new(pin_state: PinState, ticks: PulseTicks) -> Self

pub fn new_with_duration( ticks_hz: Hertz, pin_state: PinState, duration: &Duration, ) -> Result<Self, EspError>

Create a Pulse using a [Duration].

The ticks frequency, which depends on the clock divider set on the channel within a [Transmit]. To get the frequency for the ticks_hz argument, use [Transmit::counter_clock()].

Example

let tx = Transmit::new(led, channel, &config)?;
let ticks_hz = tx.counter_clock()?;
let pulse = Pulse::new_with_duration(ticks_hz, PinState::High, Duration::from_nanos(500))?;

Trait Implementations

impl Clone for Pulse

fn clone(&self) -> Pulse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pulse

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

Formats the value using the given formatter.

impl Default for Pulse

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Pulse

fn eq(&self, other: &Pulse) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Pulse

impl Eq for Pulse

impl StructuralPartialEq for Pulse