Skip to content

Reflect ledc API changes in Docs #7612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 21, 2022
Merged

Reflect ledc API changes in Docs #7612

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bcc3fd0
Update ledc.rst
TheNitek Dec 21, 2022
510af2f
Update ledc.rst
TheNitek Dec 21, 2022
4c8b5df
Merge branch 'master' into patch-1
P-R-O-C-H-Y Dec 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/source/api/ledc.rst
View file
Open in desktop
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