From 757c1d673953da15fa12a22fb3c6a2d3c82636fe Mon Sep 17 00:00:00 2001 From: Stefan Tauner Date: Sun, 18 Mar 2018 18:30:11 +0100 Subject: [PATCH] docs: explicitly note that timer alarms are not recurring Merges https://github.com/espressif/esp-idf/pull/1740 --- docs/en/api-reference/peripherals/timer.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/en/api-reference/peripherals/timer.rst b/docs/en/api-reference/peripherals/timer.rst index 2d7a057cb..03f093da7 100644 --- a/docs/en/api-reference/peripherals/timer.rst +++ b/docs/en/api-reference/peripherals/timer.rst @@ -67,7 +67,8 @@ After the alarm is enabled and the timer reaches the alarm value, depending on c .. note:: - The alarm will be triggered immediately, if an alarm value is set and the timer has already passed this value. + * The alarm will be triggered immediately, if an alarm value is set and the timer has already passed this value. + * Once triggered the alarm will be disabled automatically and needs to be re-armed to trigger again. To check what alarm value has been set up, call :cpp:func:`timer_get_alarm_value`.