Skip to content

GitLab

A
arduino-esp32
Unverified Commit 6b33cbb6 authored by Pedro Minatel's avatar Pedro Minatel Committed by GitHub
Browse files
Options

Fixed the countUp description (#7590)

parent 1d595fd3
Hide whitespace changes
Inline Side-by-side
Showing with 5 additions and 7 deletions
docs/source/api/timer.rst
View file @ 6b33cbb6
########## #####
Timer Timer
########## #####
About About
----- -----
...@@ -19,7 +19,7 @@ ESP32-S3 4 ...@@ -19,7 +19,7 @@ ESP32-S3 4
========= ================ ========= ================
Arduino-ESP32 Timer API Arduino-ESP32 Timer API
---------------------------- -----------------------
timerBegin timerBegin
********** **********
...@@ -31,11 +31,9 @@ This function is used to configure the timer. After successful setup the timer w ...@@ -31,11 +31,9 @@ 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.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment