esp-idf-hal 0.46.1

A Hardware abstraction layer for Espressif's ESP family of microcontrollers based on the ESP-IDF framework.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

use core::ptr;

use esp_idf_sys::*;

use super::RawEncoder;
use crate::rmt::Symbol;

/// A copy encoder copies the provided symbols from the user space into the driver layer.
///
/// It is usually used to encode non-`mut` data, i.e. data that does not change at runtime
/// after initialization, such as the leading code in the IR protocol.
///
/// For custom [`Encoder`](crate::rmt::encoder::Encoder) this type is essential to
/// copy the generated symbols into the RMT driver.
#[derive(Debug)]
pub struct CopyEncoder {
    handle: rmt_encoder_handle_t,
}

impl CopyEncoder {
    /// Constructs a new copy encoder with default configuration.
    pub fn new() -> Result<Self, EspError> {
        Self::with_config(&rmt_copy_encoder_config_t {})
    }

    /// Constructs a new copy encoder with the provided configuration.
    pub fn with_config(config: &rmt_copy_encoder_config_t) -> Result<Self, EspError> {
        let mut handle: rmt_encoder_handle_t = ptr::null_mut();
        esp!(unsafe { rmt_new_copy_encoder(config, &mut handle) })?;
        Ok(Self { handle })
    }
}

impl Drop for CopyEncoder {
    fn drop(&mut self) {
        // This is calling encoder->del(encoder);
        unsafe { rmt_del_encoder(self.handle) };
    }
}

impl RawEncoder for CopyEncoder {
    type Item = Symbol;

    fn handle(&mut self) -> &mut rmt_encoder_t {
        unsafe { &mut *self.handle }
    }
}