Function esp_idf_sys::esp_timer_dump

source ยท
pub unsafe extern "C" fn esp_timer_dump(
    stream: *mut FILE,
) -> esp_err_t
Expand description

@brief Dump the list of timers to a stream

If CONFIG_ESP_TIMER_PROFILING option is enabled, this prints the list of all the existing timers. Otherwise, only the list active timers is printed.

The format is:

name period alarm times_armed times_triggered total_callback_run_time

where:

name โ€” timer name (if CONFIG_ESP_TIMER_PROFILING is defined), or timer pointer period โ€” period of timer, in microseconds, or 0 for one-shot timer alarm - time of the next alarm, in microseconds since boot, or 0 if the timer is not started

The following fields are printed if CONFIG_ESP_TIMER_PROFILING is defined:

times_armed โ€” number of times the timer was armed via esp_timer_start_X times_triggered - number of times the callback was called total_callback_run_time - total time taken by callback to execute, across all calls

@param stream stream (such as stdout) to dump the information to @return - ESP_OK on success - ESP_ERR_NO_MEM if can not allocate temporary buffer for the output