Chapter 2. API Reference
esp_err_t rmt_rx_stop(rmt_channel_t channel)
Set RMT stop receiving data.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
esp_err_t rmt_tx_memory_reset(rmt_channel_t channel)
Reset RMT TX memory.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
esp_err_t rmt_rx_memory_reset(rmt_channel_t channel)
Reset RMT RX memory.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
esp_err_t rmt_set_memory_owner(rmt_channel_t channel, rmt_mem_owner_t owner)
Set RMT memory owner.
Note Setting memroy is only valid for RX channel.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
• owner: To set when the transmitter or receiver can process the memory of channel.
esp_err_t rmt_get_memory_owner(rmt_channel_t channel, rmt_mem_owner_t *owner)
Get RMT memory owner.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
• owner: Pointer to get memory owner.
esp_err_t rmt_set_tx_loop_mode(rmt_channel_t channel, bool loop_en)
Set RMT tx loop mode.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
• loop_en: Enable RMT transmitter loop sending mode. If set true, transmitter will continue send-
ing from the first data to the last data in channel over and over again in a loop.
esp_err_t rmt_get_tx_loop_mode(rmt_channel_t channel, bool *loop_en)
Get RMT tx loop mode.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Espressif Systems 346
Submit Document Feedback
Release v4.4