alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 10:46:02 -04:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

doc: clarify num_symbols in the tx done event data

Browse Source 
Closes https://github.com/espressif/esp-idf/issues/10435
This commit is contained in:
morris 2022-12-27 11:36:01 +08:00
parent 77d220c8e8
commit 26467f63cd
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
components/driver/include/driver/rmt_types.h
View File

@ -34,7 +34,8 @@ typedef struct rmt_encoder_t *rmt_encoder_handle_t;
* @brief Type of RMT TX done event data
*/
typedef struct {
size_t num_symbols; /*!< The number of transmitted RMT symbols (only one round is counted if it's a loop transmission) */
size_t num_symbols; /*!< The number of transmitted RMT symbols, including one EOF symbol, which is appended by the driver to mark the end of a transmission.
For a loop transmission, this value only counts for one round. */
} rmt_tx_done_event_data_t;
/**

2
docs/en/api-reference/peripherals/rmt.rst
View File

@ -187,7 +187,7 @@ In the callback function, users can fetch the event specific data that is filled
The TX done event data is defined in :cpp:type:`rmt_tx_done_event_data_t`:
- :cpp:member:`rmt_tx_done_event_data_t::num_symbols` tells the number of transmitted RMT symbols. This also reflects the size of encoding artifacts.
- :cpp:member:`rmt_tx_done_event_data_t::num_symbols` tells the number of transmitted RMT symbols. This also reflects the size of encoding artifacts. Please note, this value will count in the EOF symbol as well, which is appended by the driver, to mark the end of one transaction.
The RX complete event data is defined in :cpp:type:`rmt_rx_done_event_data_t`: