adafruit-mirror/arduino-esp32
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fixed the countUp description (#7590)

Browse source
This commit is contained in:
Pedro Minatel 2022-12-14 11:14:10 +00:00 committed by GitHub
parent 1d595fd35c
commit 6b33cbb648
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/source/api/timer.rst
View file

@ -1,6 +1,6 @@
########## #####
Timer Timer
########## #####
About About
----- -----
@ -19,7 +19,7 @@ ESP32-S3 4
========= ================ ========= ================
Arduino-ESP32 Timer API Arduino-ESP32 Timer API
---------------------------- -----------------------
timerBegin timerBegin
********** **********
@ -31,10 +31,8 @@ This function is used to configure the timer. After successful setup the timer w
hw_timer_t * timerBegin(uint8_t num, uint16_t divider, bool countUp); hw_timer_t * timerBegin(uint8_t num, uint16_t divider, bool countUp);
* ``num`` select timer number. * ``num`` select timer number.
* ``divider`` select timer divider. * ``divider`` select timer divider. Sets how quickly the timer counter is “ticking”.
* ``resolution`` select timer resolution. * ``countUp`` select timer direction. Sets if the counter should be incrementing or decrementing.
* range is 1-14 bits (1-20 bits for ESP32).
This function will return ``timer`` structure if configuration is successful. This function will return ``timer`` structure if configuration is successful.
If ``NULL`` is returned, error occurs and the timer was not configured. If ``NULL`` is returned, error occurs and the timer was not configured.