Skip to content

Commit

Permalink
Reflect ledc API changes in Docs (#7612)
Browse files Browse the repository at this point in the history
* Update ledc.rst

API has changed with #6570

* Update ledc.rst

Fix whitespace

Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
  • Loading branch information
TheNitek and P-R-O-C-H-Y authored Dec 21, 2022
1 parent a6fefb2 commit a95ce27
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/source/api/ledc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This function is used to setup the LEDC channel frequency and resolution.

.. code-block:: arduino
double ledcSetup(uint8_t channel, double freq, uint8_t resolution_bits);
uint32_t ledcSetup(uint8_t channel, uint32_t freq, uint8_t resolution_bits);
* ``channel`` select LEDC channel to config.
* ``freq`` select frequency of pwm.
Expand Down Expand Up @@ -71,7 +71,7 @@ This function is used to get configured frequency for the LEDC channel.

.. code-block:: arduino
double ledcReadFreq(uint8_t chan);
uint32_t ledcReadFreq(uint8_t chan);
* ``chan`` select the LEDC channel to read the configured frequency.

Expand All @@ -84,7 +84,7 @@ This function is used to setup the LEDC channel to 50 % PWM tone on selected fre

.. code-block:: arduino
double ledcWriteTone(uint8_t chan, double freq);
uint32_t ledcWriteTone(uint8_t chan, uint32_t freq);
* ``chan`` select LEDC channel.
* ``freq`` select frequency of pwm signal.
Expand All @@ -99,7 +99,7 @@ This function is used to setup the LEDC channel to specific note.

.. code-block:: arduino
double ledcWriteNote(uint8_t chan, note_t note, uint8_t octave);
uint32_t ledcWriteNote(uint8_t chan, note_t note, uint8_t octave);
* ``chan`` select LEDC channel.
* ``note`` select note to be set.
Expand Down Expand Up @@ -144,7 +144,7 @@ This function is used to set frequency for the LEDC channel.

.. code-block:: arduino
double ledcChangeFrequency(uint8_t chan, double freq, uint8_t bit_num);
uint32_t ledcChangeFrequency(uint8_t chan, uint32_t freq, uint8_t bit_num);
* ``channel`` select LEDC channel.
* ``freq`` select frequency of pwm.
Expand Down

0 comments on commit a95ce27

Please sign in to comment.