LEDC documentation is for development not released version

leahmedwards
Posts: 1
Joined: Thu Nov 02, 2023 3:29 pm

LEDC documentation is for development not released version

Postby leahmedwards » Wed Nov 08, 2023 7:59 pm

I was running into some problems with using the LED Control (LEDC) library for Arduino-ESP32 on my TinyPico. Specifically, I could use most but not all of the functions that were documented: those such as ledcFade (https://espressif-docs.readthedocs-host ... l#ledcfade) gave me an error saying that the function did not exist.

After a bit of poking around in my library files, I realised that the documentation https://github.com/espressif/arduino-es ... i/ledc.rst is for the development version https://github.com/espressif/arduino-es ... edc.c#L345, but some functions are not yet in the release version https://github.com/espressif/arduino-es ... hal-ledc.c.

What is the rationale behind this? Could a notice be displayed on the page explaining this?

Thanks,

Leah

lbernstone
Posts: 826
Joined: Mon Jul 22, 2019 3:20 pm

Re: LEDC documentation is for development not released version

Postby lbernstone » Wed Nov 08, 2023 9:52 pm

The documentation tracks master, which is currently running the alpha version of 3.0.0, an entirely new API for many peripherals. You won't get all the pretty layouts, but the source for the documentation is at https://github.com/espressif/arduino-es ... ocs/source and you can then choose your specific version.

Who is online

Users browsing this forum: Majestic-12 [Bot] and 132 guests