Struct esp_idf_hal::rmt::RxRmtDriver

pub struct RxRmtDriver<'d> { /* private fields */ }

The RMT receiver.

Use RxRmtDriver::start() to receive pulses.

See the rmt module for more information.

Implementations

impl<'d> RxRmtDriver<'d>

pub fn new<C: RmtChannel>( _channel: impl Peripheral<P = C> + 'd, pin: impl Peripheral<P = impl InputPin> + 'd, config: &ReceiveConfig, ring_buf_size: usize, ) -> Result<Self, EspError>

Initialise the rmt module with the specified pin, channel and configuration.

To uninstall the driver just drop it.

Internally this calls rmt_config() and rmt_driver_install().

pub fn channel(&self) -> rmt_channel_t

pub fn start(&self) -> Result<(), EspError>

Start receiving

pub fn stop(&self) -> Result<(), EspError>

Stop receiving

pub fn receive( &mut self, buf: &mut [(Pulse, Pulse)], ticks_to_wait: TickType_t, ) -> Result<Receive, EspError>

Trait Implementations

impl<'d> Drop for RxRmtDriver<'d>

fn drop(&mut self)

Stop receiving and release the driver.

impl<'d> Send for RxRmtDriver<'d>