Chapter 2. API Reference
Note The auto-stop feature is implemented in hardware on particular targets (i.e. those with
SOC_RMT_SUPPORT_TX_LOOP_AUTOSTOP defined). Otherwise, the auto-stop feature is imple-
mented in software via the interrupt.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
• en: enable bit
esp_err_t rmt_memory_rw_rst(rmt_channel_t channel)
Reset RMT TX/RX memory index.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
void rmt_set_intr_enable_mask(uint32_t mask)
Set mask value to RMT interrupt enable register.
Parameters
• mask: Bit mask to set to the register
void rmt_clr_intr_enable_mask(uint32_t mask)
Clear mask value to RMT interrupt enable register.
Parameters
• mask: Bit mask to clear the register
esp_err_t rmt_set_pin(rmt_channel_t channel, rmt_mode_t mode, gpio_num_t gpio_num)
Set RMT pin.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
• mode: TX or RX mode for RMT
• gpio_num: GPIO number to transmit or receive the signal.
Structures
struct rmt_tx_config_t
Data struct of RMT TX configure parameters.
Public Members
uint32_t carrier_freq_hz
RMT carrier frequency
rmt_carrier_level_t carrier_level
Level of the RMT output, when the carrier is applied
rmt_idle_level_t idle_level
RMT idle level
uint8_t carrier_duty_percent
RMT carrier duty (%)
uint32_t loop_count
Maximum loop count
Espressif Systems 353
Submit Document Feedback
Release v4.4