Espressif ESP32-S2 - Page 253

Chapter 2. API Reference
• group_num: Timer group number, 0 for TIMERG0 or 1 for TIMERG1
• timer_num: Timer index, 0 for hw_timer[0] & 1 for hw_timer[1]
• counter_dir: Counting direction of timer, count-up or count-down
esp_err_t timer_set_auto_reload(timer_group_t group_num, timer_idx_t timer_num,
timer_autoreload_t reload)
Enable or disable counter reload function when alarm event occurs.
Return
• ESP_OK Success
• ESP_ERR_INVALID_ARG Parameter error
Parameters
• group_num: Timer group number, 0 for TIMERG0 or 1 for TIMERG1
• timer_num: Timer index, 0 for hw_timer[0] & 1 for hw_timer[1]
• reload: Counter reload mode.
esp_err_t timer_set_divider(timer_group_t group_num, timer_idx_t timer_num, uint32_t divider)
Set hardware divider of the source clock to the timer group. By default, the source clock is APB clock running
at 80 MHz. For more information, please check Chapter Reset and Clock in Chip Technical Reference Manual.
Return
• ESP_OK Success
• ESP_ERR_INVALID_ARG Parameter error
Parameters
• group_num: Timer group number, 0 for TIMERG0 or 1 for TIMERG1
• timer_num: Timer index, 0 for hw_timer[0] & 1 for hw_timer[1]
• divider: Timer clock divider value. The divider’s range is from from 2 to 65536.
esp_err_t timer_set_alarm_value(timer_group_t group_num, timer_idx_t timer_num, uint64_t
alarm_value)
Set timer alarm value.
Return
• ESP_OK Success
• ESP_ERR_INVALID_ARG Parameter error
Parameters
• group_num: Timer group, 0 for TIMERG0 or 1 for TIMERG1
• timer_num: Timer index, 0 for hw_timer[0] & 1 for hw_timer[1]
• alarm_value: A 64-bit value to set the alarm value.
esp_err_t timer_get_alarm_value(timer_group_t group_num, timer_idx_t timer_num, uint64_t
*alarm_value)
Get timer alarm value.
Return
• ESP_OK Success
• ESP_ERR_INVALID_ARG Parameter error
Parameters
• group_num: Timer group, 0 for TIMERG0 or 1 for TIMERG1
• timer_num: Timer index, 0 for hw_timer[0] & 1 for hw_timer[1]
• alarm_value: Pointer of A 64-bit value to accept the alarm value.
esp_err_t timer_set_alarm(timer_group_t group_num, timer_idx_t timer_num, timer_alarm_t
alarm_en)
Enable or disable generation of timer alarm events.
Return
• ESP_OK Success
• ESP_ERR_INVALID_ARG Parameter error
Parameters
• group_num: Timer group, 0 for TIMERG0 or 1 for TIMERG1
• timer_num: Timer index, 0 for hw_timer[0] & 1 for hw_timer[1]
• alarm_en: To enable or disable timer alarm function.
Espressif Systems 242
Submit Document Feedback
Release v4.4