Skip to content

Commit 2c71406

Browse files
authored
Text correction of timer.rst (espressif#8074)
* Update timer.rst Changed text because of an inconsistence between title and text explaining the timerGetConfig function. I don't know if the method timerSetConfig really exists. * Update timer.rst Add informations about timerSetConfig function.
1 parent 266eea7 commit 2c71406

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

docs/source/api/timer.rst

+15-3
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ This function is used to end timer.
4848
4949
* ``timer`` timer struct.
5050

51-
timerSetConfig
51+
timerGetConfig
5252
**************
5353

54-
This function is used to configure initialized timer (timerBegin() called).
54+
This function is used to get configuration of initialized timer (timerBegin() called).
5555

5656
.. code-block:: arduino
5757
@@ -62,6 +62,18 @@ This function is used to configure initialized timer (timerBegin() called).
6262
This function will return ``configuration`` as uint32_t number.
6363
This can be translated by inserting it to struct ``timer_cfg_t.val``.
6464

65+
timerSetConfig
66+
**************
67+
68+
This function is used to configure initialized timer (timerBegin() called).
69+
70+
.. code-block:: arduino
71+
72+
void timerSetConfig(hw_timer_t *timer, uint32_t config);
73+
74+
* ``timer`` timer struct.
75+
* ``config`` configuration as uint32_t number. Use configuration struct ``timer_cfg_t`` and pass ``timer_cfg_t.val`` as ``config`` paramater.
76+
6577
timerAttachInterrupt
6678
********************
6779

@@ -372,4 +384,4 @@ Repeat timer example:
372384
Watchdog timer example:
373385

374386
.. literalinclude:: ../../../libraries/ESP32/examples/Timer/WatchdogTimer/WatchdogTimer.ino
375-
:language: arduino
387+
:language: arduino

0 commit comments

Comments
 (0)