diff --git a/docs/source/api/timer.rst b/docs/source/api/timer.rst index d253b6794f9..7a97feaabce 100644 --- a/docs/source/api/timer.rst +++ b/docs/source/api/timer.rst @@ -48,10 +48,10 @@ This function is used to end timer. * ``timer`` timer struct. -timerSetConfig +timerGetConfig ************** -This function is used to configure initialized timer (timerBegin() called). +This function is used to get configuration of initialized timer (timerBegin() called). .. code-block:: arduino @@ -62,6 +62,18 @@ This function is used to configure initialized timer (timerBegin() called). This function will return ``configuration`` as uint32_t number. This can be translated by inserting it to struct ``timer_cfg_t.val``. +timerSetConfig +************** + +This function is used to configure initialized timer (timerBegin() called). + +.. code-block:: arduino + + void timerSetConfig(hw_timer_t *timer, uint32_t config); + +* ``timer`` timer struct. +* ``config`` configuration as uint32_t number. Use configuration struct ``timer_cfg_t`` and pass ``timer_cfg_t.val`` as ``config`` paramater. + timerAttachInterrupt ******************** @@ -372,4 +384,4 @@ Repeat timer example: Watchdog timer example: .. literalinclude:: ../../../libraries/ESP32/examples/Timer/WatchdogTimer/WatchdogTimer.ino - :language: arduino \ No newline at end of file + :language: arduino