adafruit-mirror/arduino-esp32
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Reflect ledc API changes in Docs (#7612)

Browse source 
* Update ledc.rst

API has changed with https://github.com/espressif/arduino-esp32/pull/6570

* Update ledc.rst

Fix whitespace

Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
This commit is contained in:
Claus Näveke 2022-12-21 17:46:52 +01:00 committed by GitHub
parent a6fefb20fe
commit a95ce27ad7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/source/api/ledc.rst
View file

@ -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.
@ -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.
@ -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.
@ -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.
@ -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.