Chapter 2. API Reference
• channel: RMT channel .
• src: Pointer to the raw data.
• src_size: The size of the raw data.
• wait_tx_done: Set true to wait all data send done.
rmt_tx_end_callback_t rmt_register_tx_end_callback(rmt_tx_end_fn_t function, void *arg)
Registers a callback that will be called when transmission ends.
Called by rmt_driver_isr_default in interrupt context.
Note Requires rmt_driver_install to install the default ISR handler.
Return the previous callback settings (members will be set to NULL if there was none)
Parameters
• function: Function to be called from the default interrupt handler or NULL.
• arg: Argument which will be provided to the callback when it is called.
esp_err_t rmt_set_rx_thr_intr_en(rmt_channel_t channel, bool en, uint16_t evt_thresh)
Set RMT RX threshold event interrupt enable.
An interrupt will be triggered when the number of received items reaches the threshold value
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
• en: enable or disable RX event interrupt.
• evt_thresh: RMT event interrupt threshold value
esp_err_t rmt_add_channel_to_group(rmt_channel_t channel)
Add channel into a synchronous group (channels in the same group can start transaction simultaneously)
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
esp_err_t rmt_remove_channel_from_group(rmt_channel_t channel)
Remove channel out of a group.
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
esp_err_t rmt_set_tx_loop_count(rmt_channel_t channel, uint32_t count)
Set loop count threshold value for RMT TX channel.
When tx loop count reaches this value, an ISR callback will notify user
Return
• ESP_ERR_INVALID_ARG Parameter error
• ESP_OK Success
Parameters
• channel: RMT channel
• count: loop count, 1 ~ 1023
esp_err_t rmt_enable_tx_loop_autostop(rmt_channel_t channel, bool en)
Enable or disable the feature that when loop count reaches the threshold, RMT will stop transmitting.
• When the loop auto-stop feature is enabled will halt RMT transmission after the loop count reaches a
certain threshold
• When disabled, the RMT transmission continue indefinitely until halted by the users
Espressif Systems 352
Submit Document Feedback
Release v4.4
To Next Page
Loading...