Struct esp_idf_hal::rmt::RxRmtDriver

source ·
pub struct RxRmtDriver<'d> { /* private fields */ }
Expand description

The RMT receiver.

Use RxRmtDriver::start() to receive pulses.

See the rmt module for more information.

Implementations§

source§

impl<'d> RxRmtDriver<'d>

source

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().

source

pub fn channel(&self) -> rmt_channel_t

source

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

Start receiving

source

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

Stop receiving

source

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

Trait Implementations§

source§

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

source§

fn drop(&mut self)

Stop receiving and release the driver.

source§

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

Auto Trait Implementations§

§

impl<'d> Freeze for RxRmtDriver<'d>

§

impl<'d> RefUnwindSafe for RxRmtDriver<'d>

§

impl<'d> !Sync for RxRmtDriver<'d>

§

impl<'d> Unpin for RxRmtDriver<'d>

§

impl<'d> !UnwindSafe for RxRmtDriver<'d>

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
§

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.
§

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

Performs the conversion.