AsyncWebServerLogging doesnt compile on ESP8266

[tanishqmanuja]

Platform

ESP8266

IDE / Tooling

PlatformIO

What happened?

First encountered this while compiling this on esphome@dev.

Main cause is that I disable serial logging on esp8266.

Stack Trace

Useful Snippet

mini/ESPAsyncWebServer/src/AsyncWebSocket.h:32,
                 from .piolibdeps/dimled-mini/ESPAsyncWebServer/src/ESPAsyncWebServer.h:1589,
                 from src/esphome/components/web_server_base/web_server_base.h:15,
                 from src/esphome/components/captive_portal/captive_portal.h:13,
                 from src/esphome/components/captive_portal/captive_portal.cpp:1:
.piolibdeps/dimled-mini/ESPAsyncWebServer/src/AsyncWebSocket.h: In constructor 'AsyncWebSocketControl::AsyncWebSocketControl(uint8_t, const uint8_t*, size_t, bool)':
.piolibdeps/dimled-mini/ESPAsyncWebServer/src/AsyncWebServerLogging.h:101:37: error: 'Serial' was not declared in this scope
  101 | #define async_ws_log_e(format, ...) Serial.printf_P(PSTR("E async_ws %d: " format "\n"), __LINE__, ##__VA_ARGS__)
      |                                     ^~~~~~
.piolibdeps/dimled-mini/ESPAsyncWebServer/src/AsyncWebSocket.h:86:9: note: in expansion of macro 'async_ws_log_e'
   86 |         async_ws_log_e("Failed to allocate");
      |         ^~~~~~~~~~~~~~
Compiling .pioenvs/dimled-mini/src/esphome/components/ddp/ddp_light_effect.cpp.o
Compiling .pioenvs/dimled-mini/src/esphome/components/ddp/ddp_light_effect_base.cpp.o
*** [.pioenvs/dimled-mini/src/esphome/components/captive_portal/captive_portal.cpp.o] Error 1
========================= [FAILED] Took 34.56 seconds =========================

Full Logs: https://github.com/tqlabs-in/dimled-mini/actions/runs/21462827254/job/61831213713

Minimal Reproductible Example (MRE)

Actual code is Internally generated via esphome. But this is the cause I guess

web_server:

logger:
  baud_rate: 0

I confirm that:

• I have read the documentation.
• I have searched for similar discussions.
• I have searched for similar issues.
• I have looked at the examples.
• I have upgraded to the lasted version of ESPAsyncWebServer (and AsyncTCP for ESP32).

[mathieucarbou]

@tanishqmanuja : please open an issue in esphome repository and notify @bdraco: he is the dev in charge of 8266 support and he did a fix recently here: #371. Maybe he missed an include, or, you need in your esphome config to correctly specify to use platform Arduino ?

I will leave it open for now but please cross-reference the issues when you will have open one in esphome repo.

Thanks 🙏

[tanishqmanuja]

@mathieucarbou, he is aware and will pick this up shortly. No need for downstream issue on esphome repo as it can be fixed from here by tweaking the logging macros.

[ssieb]

The problem is that in a lot of cases we want to disable Serial (esphome/esphome#12736) to use those pins for something else. But the web server logging expects that to exist.

[mathieucarbou]

The problem is that in a lot of cases we want to disable Serial (esphome/esphome#12736) to use those pins for something else. But the web server logging expects that to exist.

I totally understand but this is something to settle within esphome team I guess and then @bdraco will be able to open a PR here or in esphome to fix.

What he fixed regarding 8266 is ok in a general use case. Now indeed if you are using uart 0 for something else or shutting it down, it won't work.

FYI asycws allows you to define your own header to implement your own logging macro. We made an extensible logging layer so that users can reimplement them.

Just look at the code and you will see that here: https://github.com/ESP32Async/ESPAsyncWebServer/blob/main/src/AsyncWebServerLogging.h#L6

So one possibly is also to shutdown logging by providing a custom layer or just redirect to something else than Serial.

[mathieucarbou]

@mathieucarbou, he is aware and will pick this up shortly. No need for downstream issue on esphome repo as it can be fixed from here by tweaking the logging macros.

Yes, that, or see my previous answer.

We do support a macro flag so that users can provide their own macro definitions for logging in a header.

For really specific use cases that could sometimes be a better choice.

[tanishqmanuja]

Actually there are multiple ways to tackle this. One is exactly what you mentioned above and other could be what can be done inside esphome itself.

Since @bdraco would be in better position to tell, I will wait for his comment and open a separate issue in esphome if needed.

[bdraco]

Traveling, I'll take a look on Sunday when I get to my destination and come up with a solution (or before if flights cooperate... or don't)