doc: clarify num_symbols in the tx done event data

Closes https://github.com/espressif/esp-idf/issues/10435
pull/10546/head
morris 2022-12-27 11:36:01 +08:00
rodzic 77d220c8e8
commit 26467f63cd
2 zmienionych plików z 3 dodań i 2 usunięć

Wyświetl plik

@ -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;
/**

Wyświetl plik

@ -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`: