esp32,esp8266: Fix ESP32 log levels, esp.osdebug() documentation

[projectgus]

• Fix regression in esp.osdebug() functionality, closes esp32: Can't change log level since IDF 5.0 update. #12815
• Correct the documentation for this function.

As part of the first fix, the ESP32 binary file unfortunately gets 20KB larger as it was being built without INFO level logging functions. The DEBUG and VERBOSE levels still aren't compiled in by default, enabling these requires a custom build with different sdkconfig (have added documentation for this).

Binary sizes, ESP32_GENERIC board:

Max log level	Size	Compared to "Error"
Error	1642112
Info	1662208	+20,096 (101.2%)
Debug	1697808	+55,696 (103.4%)
Verbose	1706336	+64,224 (103.9%)

This work was funded through GitHub Sponsors.

[jimmo]

Thanks @projectgus , looks good!

I had missed (when reporting #12815) that the docs were wrong for esp8266 also. Good fix!

[projectgus]

I had missed (when reporting #12815) that the docs were wrong for esp8266 also. Good fix!

It might be one to look at breaking in MP 2.0, as it's really a different function on each of the ports: on esp8266 it's setting the destination UART for os_printf(), and on esp32 it's setting the minimum log level threshold.

(We could also implement runtime redirecting of ESP-IDF logs to another UART, but it's probably not a hugely important feature either... and it would still be a different API on esp8266.)

[dpgeorge]

The changes below are not fully correct.

On esp8266 the behaviour for osdebug(uart_no) is:

• pass None to disable debug logging
• pass an integer UART number to enable logging on that UART

For esp32 it's osdebug(uart_no, level=LOG_DEBUG) with:

• uart_no is None to disable logging
• otherwise logging is enabled and the optional level specifies the level, with default LOG_LOCAL_LEVEL which I think is LOG_DEBUG (?)

[projectgus]

@dpgeorge This also wasn't quite right, for a simple function it has a lot of complexities!

Have pushed a new commit which I've re-tested to double check behaviour matches docs..

[dpgeorge]

Thanks!