alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: explicitly note that timer alarms are not recurring

Browse Source 
Merges https://github.com/espressif/esp-idf/pull/1740
This commit is contained in:
Stefan Tauner 2018-03-18 18:30:11 +01:00 committed by Ivan Grokhotkov
parent 38daa1e716
commit 757c1d6739
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/en/api-reference/peripherals/timer.rst
View 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`.