Skip to content

Commit 6b33cbb

Browse files
authored
Fixed the countUp description (espressif#7590)
1 parent 1d595fd commit 6b33cbb

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

docs/source/api/timer.rst

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
##########
1+
#####
22
Timer
3-
##########
3+
#####
44

55
About
66
-----
@@ -19,7 +19,7 @@ ESP32-S3 4
1919
========= ================
2020

2121
Arduino-ESP32 Timer API
22-
----------------------------
22+
-----------------------
2323

2424
timerBegin
2525
**********
@@ -31,11 +31,9 @@ This function is used to configure the timer. After successful setup the timer w
3131
hw_timer_t * timerBegin(uint8_t num, uint16_t divider, bool countUp);
3232
3333
* ``num`` select timer number.
34-
* ``divider`` select timer divider.
35-
* ``resolution`` select timer resolution.
34+
* ``divider`` select timer divider. Sets how quickly the timer counter is “ticking”.
35+
* ``countUp`` select timer direction. Sets if the counter should be incrementing or decrementing.
3636

37-
* range is 1-14 bits (1-20 bits for ESP32).
38-
3937
This function will return ``timer`` structure if configuration is successful.
4038
If ``NULL`` is returned, error occurs and the timer was not configured.
4139

0 commit comments

Comments
 (0)