]> granicus.if.org Git - esp-idf/commitdiff
docs: explicitly note that timer alarms are not recurring
authorStefan Tauner <stefan.tauner@gmx.at>
Sun, 18 Mar 2018 17:30:11 +0000 (18:30 +0100)
committerIvan Grokhotkov <ivan@espressif.com>
Mon, 19 Mar 2018 03:56:57 +0000 (11:56 +0800)
Merges https://github.com/espressif/esp-idf/pull/1740

docs/en/api-reference/peripherals/timer.rst

index 2d7a057cb07264909e180199b427090b7896344a..03f093da7743a62adecab6ebf5416dbd42805961 100644 (file)
@@ -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`.