Struct Pulse 

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

A Pulse defines for how long the output pin should be high or low.

The duration is defined through the PulseTicks type.

The conversion from ticks to real time depends on the selected resolution of the RMT channel.

Example

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

You can create a Pulse with a Duration by using Pulse::new_with_duration:

use esp_idf_hal::rmt::{Pulse, PinState, PulseTicks};
use esp_idf_hal::units::FromValueType;

let ticks = 1_000_000.Hz(); // 1 MHz
let pulse = Pulse::new_with_duration(1_000_000.Hz(), PinState::High, Duration::from_nanos(300))?;

Fields

ticks: PulseTicks

pin_state: PinState

Implementations

impl Pulse

pub const fn zero() -> Self

Returns a low Pulse with zero ticks.

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

Create a Pulse using a pin state and a tick count.

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

Create a Pulse using a [Duration].

To convert the duration into ticks, the resolution (clock ticks) set for the RMT channel must be provided (TxChannelConfig::resolution).

Errors

If the duration is too long to be represented as ticks with the given resolution, an error with the code [ERR_EOVERFLOW] or ESP_ERR_INVALID_ARG will be returned.

Trait Implementations

impl Clone for Pulse

fn clone(&self) -> Pulse

Returns a duplicate 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

Tests for self and other values to be equal, and is used by ==.

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

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