Chapter 2. API Reference
• channel: RMT channel
• idle_out_en: Pointer to accept value of enable idle.
• level: Pointer to accept value of output signal’s level in idle state for specified channel.
esp_err_t rmt_get_status(rmt_channel_t channel, uint32_t *status)
Get RMT status.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
• status: Pointer to accept channel status. Please refer to RMT_CHnSTATUS_REG(n=0~7) in
rmt_reg.h for more details of each field.
esp_err_t rmt_set_rx_intr_en(rmt_channel_t channel, bool en)
Set RMT RX interrupt enable.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
• en: enable or disable RX interrupt.
esp_err_t rmt_set_err_intr_en(rmt_channel_t channel, bool en)
Set RMT RX error interrupt enable.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
• en: enable or disable RX err interrupt.
esp_err_t rmt_set_tx_intr_en(rmt_channel_t channel, bool en)
Set RMT TX interrupt enable.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
• en: enable or disable TX interrupt.
esp_err_t rmt_set_tx_thr_intr_en(rmt_channel_t channel, bool en, uint16_t evt_thresh)
Set RMT TX threshold event interrupt enable.
An interrupt will be triggered when the number of transmitted items reaches the threshold value
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
• en: enable or disable TX event interrupt.
• evt_thresh: RMT event interrupt threshold value
esp_err_t rmt_set_gpio(rmt_channel_t channel, rmt_mode_t mode, gpio_num_t gpio_num, bool in-
vert_signal)
Configure the GPIO used by RMT channel.
Return
• ESP_ERR_INVALID_ARG Configure RMT GPIO failed because of wrong parameter
• ESP_OK Configure RMT GPIO successfully
Espressif Systems 348
Submit Document Feedback
Release v4.4
To Next Page