ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
web_server.h
Go to the documentation of this file.
1#pragma once
2
3#include "list_entities.h"
4
8#ifdef USE_WEBSERVER
13#ifdef USE_LOGGER
15#endif
16
17#include <functional>
18#include <list>
19#include <map>
20#include <string>
21#include <utility>
22#include <vector>
23
24#if USE_WEBSERVER_VERSION >= 2
25extern const uint8_t ESPHOME_WEBSERVER_INDEX_HTML[] PROGMEM;
26extern const size_t ESPHOME_WEBSERVER_INDEX_HTML_SIZE;
27#endif
28
29#ifdef USE_WEBSERVER_CSS_INCLUDE
30extern const uint8_t ESPHOME_WEBSERVER_CSS_INCLUDE[] PROGMEM;
31extern const size_t ESPHOME_WEBSERVER_CSS_INCLUDE_SIZE;
32#endif
33
34#ifdef USE_WEBSERVER_JS_INCLUDE
35extern const uint8_t ESPHOME_WEBSERVER_JS_INCLUDE[] PROGMEM;
36extern const size_t ESPHOME_WEBSERVER_JS_INCLUDE_SIZE;
37#endif
38
39namespace esphome::web_server {
40
41// ESP-IDF cuts a log event here: nothing a browser log view needs is longer, and it bounds the
42// tail a stalled client keeps. The Arduino backend takes a C string and sends the whole line.
43constexpr size_t LOG_EVENT_MAX_LEN = 512;
44
45// Parameter names live in flash on ESP8266
47
48// All platforms need to defer actions to main loop thread.
49// Multi-core platforms need this for thread safety.
50// ESP8266 needs this because ESPAsyncWebServer callbacks run in "sys" context
51// (SDK system context), not "cont" context (continuation/main loop). Calling
52// yield() from sys context causes a panic in the Arduino core.
53#define DEFER_ACTION(capture, action) this->defer([capture]() mutable { action; })
54
60
62struct UrlMatch {
66#ifdef USE_DEVICES
68#endif
69 bool valid{false};
70 bool include_internal{false};
71
72 // Helper methods for string comparisons
73 bool domain_equals(const char *str) const { return this->domain == str; }
74 bool method_equals(const char *str) const { return this->method == str; }
75
76#ifdef USE_ESP8266
77 // Overloads for flash strings on ESP8266
78 bool domain_equals(const __FlashStringHelper *str) const { return this->domain == str; }
79 bool method_equals(const __FlashStringHelper *str) const { return this->method == str; }
80#endif
81
85};
86
87#ifdef USE_WEBSERVER_SORTING
89 float weight;
90 uint64_t group_id;
91};
92
94 std::string name;
95 float weight;
96};
97#endif
98
100
101/*
102 In order to defer updates in arduino mode, we need to create one AsyncEventSource per incoming request to /events.
103 This is because only minimal changes were made to the ESPAsyncWebServer lib_dep, it was undesirable to put deferred
104 update logic into that library. We need one deferred queue per connection so instead of one AsyncEventSource with
105 multiple clients, we have multiple event sources with one client each. This is slightly awkward which is why it's
106 implemented in a more straightforward way for ESP-IDF. Arduino platform will eventually go away and this workaround
107 can be forgotten.
108*/
109#if !defined(USE_ESP32) && defined(USE_ARDUINO)
111
113class DeferredUpdateEventSource final : public AsyncEventSource {
115
116 /*
117 This class holds a pointer to the source component that wants to publish a state event, and a pointer to a function
118 that will lazily generate that event. The two pointers allow dedup in the deferred queue if multiple publishes for
119 the same component are backed up, and take up only two pointers of memory. The entry in the deferred queue (a
120 std::vector) is the DeferredEvent instance itself (not a pointer to one elsewhere in heap) so still only two
121 pointers per entry (and no heap fragmentation). Even 100 backed up events (you'd have to have at least 100 sensors
122 publishing because of dedup) would take up only 0.8 kB.
123 */
124 struct DeferredEvent {
125 friend class DeferredUpdateEventSource;
126
127 protected:
128 void *source_;
129 message_generator_t *message_generator_;
130
131 public:
132 DeferredEvent(void *source, message_generator_t *message_generator)
133 : source_(source), message_generator_(message_generator) {}
134 bool operator==(const DeferredEvent &test) const {
135 return (source_ == test.source_ && message_generator_ == test.message_generator_);
136 }
137 };
138 static_assert(sizeof(DeferredEvent) == sizeof(void *) + sizeof(message_generator_t *),
139 "DeferredEvent should have no padding");
140
141 protected:
142 // surface a couple methods from the base class
143 using AsyncEventSource::handleRequest;
144 using AsyncEventSource::send;
145
147 // vector is used very specifically for its zero memory overhead even though items are popped from the front (memory
148 // footprint is more important than speed here)
149 std::vector<DeferredEvent> deferred_queue_;
152 static constexpr uint16_t MAX_CONSECUTIVE_SEND_FAILURES = 2500; // ~20 seconds at 125Hz loop rate
153
154 // helper for allowing only unique entries in the queue
155 void deq_push_back_with_dedup_(void *source, message_generator_t *message_generator);
156
158
159 public:
160 DeferredUpdateEventSource(WebServer *ws, const String &url)
161 : AsyncEventSource(url), entities_iterator_(ListEntitiesIterator(ws, this)), web_server_(ws) {}
162
163 void loop();
164
165 // detail_all events go out while entities are still being listed; state events wait until listing is done
166 void deferrable_send_state(void *source, bool detail_all, message_generator_t *message_generator);
167 // The old event name argument would otherwise convert to true
168 void deferrable_send_state(void *source, const char *event_type, message_generator_t *message_generator) = delete;
169 void try_send_nodefer(const char *message, size_t message_len, const char *event = nullptr, uint32_t id = 0,
170 uint32_t reconnect = 0);
171};
172
173class DeferredUpdateEventSourceList final : public std::list<DeferredUpdateEventSource *> {
174 friend class HeadAckedEventSourceResponse; // ESPAsyncWebServer 3.12.1 workaround, remove with it
175
176 protected:
179 void add_client_(WebServer *ws, AsyncClient *client); // ESPAsyncWebServer 3.12.1 workaround, remove with it
180
181 public:
183 bool loop();
184
185 void deferrable_send_state(void *source, bool detail_all, message_generator_t *message_generator);
186 // The old event name argument would otherwise convert to true
187 void deferrable_send_state(void *source, const char *event_type, message_generator_t *message_generator) = delete;
188 void try_send_nodefer(const char *message, size_t message_len, const char *event = nullptr, uint32_t id = 0,
189 uint32_t reconnect = 0);
190
191 void add_new_client(WebServer *ws, AsyncWebServerRequest *request);
192};
193#endif
194
204class WebServer final : public Component, public AsyncWebHandler {
205#if !defined(USE_ESP32) && defined(USE_ARDUINO)
207#endif
208
209 public:
211
212#if USE_WEBSERVER_VERSION == 1
218 void set_css_url(const char *css_url) { this->css_url_ = css_url; }
219
225 void set_js_url(const char *js_url) { this->js_url_ = js_url; }
226#endif
227
228#ifdef USE_WEBSERVER_CSS_INCLUDE
233 void set_css_include(const char *css_include) { this->css_include_ = css_include; }
234#endif
235
236#ifdef USE_WEBSERVER_JS_INCLUDE
241 void set_js_include(const char *js_include) { this->js_include_ = js_include; }
242#endif
243
249 void set_include_internal(bool include_internal) { include_internal_ = include_internal; }
254 void set_expose_log(bool expose_log) { this->expose_log_ = expose_log; }
255
256 // ========== INTERNAL METHODS ==========
257 // (In most use cases you won't need these)
259 void setup() override;
260 void loop() override;
261
262 void dump_config() override;
263
264#ifdef USE_LOGGER
265 void on_log(uint8_t level, const char *tag, const char *message, size_t message_len);
266#endif
267
269 float get_setup_priority() const override;
270
272 void handle_index_request(AsyncWebServerRequest *request);
273
274#ifdef USE_WEBSERVER_CAPTIVE
277 void start_captive();
278 void end_captive();
279 bool is_captive() const { return this->dns_.is_running(); }
280#endif
281
284
285#ifdef USE_WEBSERVER_CSS_INCLUDE
287 void handle_css_request(AsyncWebServerRequest *request);
288#endif
289
290#ifdef USE_WEBSERVER_JS_INCLUDE
292 void handle_js_request(AsyncWebServerRequest *request);
293#endif
294
295#ifdef USE_WEBSERVER_PRIVATE_NETWORK_ACCESS
296 // Handle Private Network Access CORS OPTIONS request
297 void handle_pna_cors_request(AsyncWebServerRequest *request);
298#endif
299
300#ifdef USE_SENSOR
303 void handle_sensor_request(AsyncWebServerRequest *request, const UrlMatch &match);
304
305 static void sensor_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
306 static void sensor_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
307#endif
308
309#ifdef USE_SWITCH
311
313 void handle_switch_request(AsyncWebServerRequest *request, const UrlMatch &match);
314
315 static void switch_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
316 static void switch_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
317#endif
318
319#ifdef USE_BUTTON
321 void handle_button_request(AsyncWebServerRequest *request, const UrlMatch &match);
322
323 // Buttons are stateless, so there is no button_state_json_generator
324 static void button_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
325#endif
326
327#ifdef USE_BINARY_SENSOR
329
331 void handle_binary_sensor_request(AsyncWebServerRequest *request, const UrlMatch &match);
332
333 static void binary_sensor_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
334 static void binary_sensor_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
335#endif
336
337#ifdef USE_FAN
338 void on_fan_update(fan::Fan *obj);
339
341 void handle_fan_request(AsyncWebServerRequest *request, const UrlMatch &match);
342
343 static void fan_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
344 static void fan_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
345#endif
346
347#ifdef USE_LIGHT
349
351 void handle_light_request(AsyncWebServerRequest *request, const UrlMatch &match);
352
353 static void light_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
354 static void light_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
355#endif
356
357#ifdef USE_TEXT_SENSOR
359
361 void handle_text_sensor_request(AsyncWebServerRequest *request, const UrlMatch &match);
362
363 static void text_sensor_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
364 static void text_sensor_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
365#endif
366
367#ifdef USE_COVER
368 void on_cover_update(cover::Cover *obj);
369
371 void handle_cover_request(AsyncWebServerRequest *request, const UrlMatch &match);
372
373 static void cover_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
374 static void cover_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
375#endif
376
377#ifdef USE_NUMBER
380 void handle_number_request(AsyncWebServerRequest *request, const UrlMatch &match);
381
382 static void number_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
383 static void number_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
384#endif
385
386#ifdef USE_DATETIME_DATE
389 void handle_date_request(AsyncWebServerRequest *request, const UrlMatch &match);
390
391 static void date_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
392 static void date_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
393#endif
394
395#ifdef USE_DATETIME_TIME
398 void handle_time_request(AsyncWebServerRequest *request, const UrlMatch &match);
399
400 static void time_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
401 static void time_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
402#endif
403
404#ifdef USE_DATETIME_DATETIME
407 void handle_datetime_request(AsyncWebServerRequest *request, const UrlMatch &match);
408
409 static void datetime_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
410 static void datetime_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
411#endif
412
413#ifdef USE_TEXT
414 void on_text_update(text::Text *obj);
416 void handle_text_request(AsyncWebServerRequest *request, const UrlMatch &match);
417
418 static void text_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
419 static void text_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
420#endif
421
422#ifdef USE_SELECT
425 void handle_select_request(AsyncWebServerRequest *request, const UrlMatch &match);
426
427 static void select_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
428 static void select_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
429#endif
430
431#ifdef USE_CLIMATE
434 void handle_climate_request(AsyncWebServerRequest *request, const UrlMatch &match);
435
436 static void climate_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
437 static void climate_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
438#endif
439
440#ifdef USE_LOCK
441 void on_lock_update(lock::Lock *obj);
442
444 void handle_lock_request(AsyncWebServerRequest *request, const UrlMatch &match);
445
446 static void lock_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
447 static void lock_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
448#endif
449
450#ifdef USE_VALVE
451 void on_valve_update(valve::Valve *obj);
452
454 void handle_valve_request(AsyncWebServerRequest *request, const UrlMatch &match);
455
456 static void valve_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
457 static void valve_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
458#endif
459
460#ifdef USE_ALARM_CONTROL_PANEL
462
464 void handle_alarm_control_panel_request(AsyncWebServerRequest *request, const UrlMatch &match);
465
466 static void alarm_control_panel_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
467 static void alarm_control_panel_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
468#endif
469
470#ifdef USE_WATER_HEATER
472
474 void handle_water_heater_request(AsyncWebServerRequest *request, const UrlMatch &match);
475
476 static void water_heater_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
477 static void water_heater_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
478#endif
479
480#ifdef USE_INFRARED
482 void handle_infrared_request(AsyncWebServerRequest *request, const UrlMatch &match);
483
484 static void infrared_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
485#endif
486#ifdef USE_RADIO_FREQUENCY
488 void handle_radio_frequency_request(AsyncWebServerRequest *request, const UrlMatch &match);
489
490 static void radio_frequency_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
491#endif
492
493#ifdef USE_MEDIA_PLAYER
494 // Not exposed over HTTP; the stub only satisfies ControllerContract
496#endif
497
498#ifdef USE_EVENT
499 void on_event(event::Event *obj);
500
501 static void event_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
502 static void event_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
503
505 void handle_event_request(AsyncWebServerRequest *request, const UrlMatch &match);
506#endif
507
508#ifdef USE_UPDATE
510
512 void handle_update_request(AsyncWebServerRequest *request, const UrlMatch &match);
513
514 static void update_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
515 static void update_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder);
516#endif
517
519 bool canHandle(AsyncWebServerRequest *request) const override;
521 void handleRequest(AsyncWebServerRequest *request) override;
523 bool isRequestHandlerTrivial() const override; // NOLINT(readability-identifier-naming)
524
525#ifdef USE_WEBSERVER_SORTING
526 void add_entity_config(EntityBase *entity, float weight, uint64_t group);
527 void add_sorting_group(uint64_t group_id, const std::string &group_name, float weight);
528
529 std::map<EntityBase *, SortingComponents> sorting_entitys_;
530 std::map<uint64_t, SortingGroup> sorting_groups_;
531#endif
532
533 bool include_internal_{false};
534
535 protected:
536 // Declared here so it packs into the padding after include_internal_
537 bool expose_log_{true};
538
539 // Out of line so the per-domain update callbacks stay small
540 // source stays the concrete entity pointer, since the generators cast it back to that type
541 template<typename T> void send_state_event_(T *obj, message_generator_t *generator) {
542 this->send_state_event_(obj, static_cast<const EntityBase *>(obj), generator);
543 }
544 void send_state_event_(void *source, const EntityBase *entity, message_generator_t *generator);
545
546 void add_sorting_info_(JsonObject &root, EntityBase *entity);
547
548#ifdef USE_LIGHT
549 // Helper to parse and apply a float parameter with optional scaling
550 template<typename T, typename Ret>
551 void parse_light_param_(AsyncWebServerRequest *request, ParamNameType param_name, T &call, Ret (T::*setter)(float),
552 float scale = 1.0f) {
553 auto value = parse_number<float>(request->arg(param_name).c_str());
554 if (value.has_value()) {
555 (call.*setter)(*value / scale);
556 }
557 }
558
559 // Helper to parse and apply a uint32_t parameter with optional scaling
560 template<typename T, typename Ret>
561 void parse_light_param_uint_(AsyncWebServerRequest *request, ParamNameType param_name, T &call,
562 Ret (T::*setter)(uint32_t), uint32_t scale = 1) {
563 auto value = parse_number<uint32_t>(request->arg(param_name).c_str());
564 if (value.has_value()) {
565 (call.*setter)(*value * scale);
566 }
567 }
568#endif
569
570 // Generic helper to parse and apply a numeric parameter
571 template<typename NumT, typename T, typename Ret>
572 void parse_num_param_(AsyncWebServerRequest *request, ParamNameType param_name, T &call, Ret (T::*setter)(NumT)) {
573 auto value = parse_number<NumT>(request->arg(param_name).c_str());
574 if (value.has_value()) {
575 (call.*setter)(*value);
576 }
577 }
578
579 // Generic helper to parse and apply a string parameter using const char* setter (avoids std::string allocation)
580 template<typename T, typename Ret>
581 void parse_cstr_param_(AsyncWebServerRequest *request, ParamNameType param_name, T &call,
582 Ret (T::*setter)(const char *, size_t)) {
583 if (request->hasArg(param_name)) {
584 const auto &value = request->arg(param_name);
585 (call.*setter)(value.c_str(), value.length());
586 }
587 }
588
589 // Generic helper to parse and apply a bool parameter
590 // Accepts: "on", "true", "1" (case-insensitive) as true
591 // Accepts: "off", "false", "0" (case-insensitive) as false
592 // Invalid values are ignored (setter not called)
593 template<typename T, typename Ret>
594 void parse_bool_param_(AsyncWebServerRequest *request, ParamNameType param_name, T &call, Ret (T::*setter)(bool)) {
595 const auto &param_value = request->arg(param_name);
596 // Arduino String has isEmpty() not empty(), use length() for cross-platform compatibility
597 if (param_value.length() > 0) { // NOLINT(readability-container-size-empty)
598 // First check on/off (default), then true/false (custom)
599 auto val = parse_on_off(param_value.c_str());
600 if (val == PARSE_NONE) {
601 val = parse_on_off(param_value.c_str(), "true", "false");
602 }
603 if (val == PARSE_ON || param_value == "1") {
604 (call.*setter)(true);
605 } else if (val == PARSE_OFF || param_value == "0") {
606 (call.*setter)(false);
607 }
608 // PARSE_NONE/PARSE_TOGGLE: ignore invalid values
609 }
610 }
611
613#ifdef USE_ESP32
614 AsyncEventSource events_{StringRef::from_lit("/events"), this};
615#elif USE_ARDUINO
617#endif
618#ifdef USE_WEBSERVER_CAPTIVE
619 void handle_not_found_(AsyncWebServerRequest *request);
621#endif
622
623#if USE_WEBSERVER_VERSION == 1
624 const char *css_url_{nullptr};
625 const char *js_url_{nullptr};
626#endif
627#ifdef USE_WEBSERVER_CSS_INCLUDE
628 const char *css_include_{nullptr};
629#endif
630#ifdef USE_WEBSERVER_JS_INCLUDE
631 const char *js_include_{nullptr};
632#endif
633
634 private:
635#ifdef USE_SENSOR
636 void sensor_json_(sensor::Sensor *obj, float value, JsonDetail start_config, json::JsonBuilder &builder);
637#endif
638#ifdef USE_SWITCH
639 void switch_json_(switch_::Switch *obj, bool value, JsonDetail start_config, json::JsonBuilder &builder);
640#endif
641#ifdef USE_BUTTON
642 void button_json_(button::Button *obj, JsonDetail start_config, json::JsonBuilder &builder);
643#endif
644#ifdef USE_BINARY_SENSOR
645 void binary_sensor_json_(binary_sensor::BinarySensor *obj, bool value, JsonDetail start_config,
646 json::JsonBuilder &builder);
647#endif
648#ifdef USE_FAN
649 void fan_json_(fan::Fan *obj, JsonDetail start_config, json::JsonBuilder &builder);
650#endif
651#ifdef USE_LIGHT
652 void light_json_(light::LightState *obj, JsonDetail start_config, json::JsonBuilder &builder);
653#endif
654#ifdef USE_TEXT_SENSOR
655 void text_sensor_json_(text_sensor::TextSensor *obj, const std::string &value, JsonDetail start_config,
656 json::JsonBuilder &builder);
657#endif
658#ifdef USE_COVER
659 void cover_json_(cover::Cover *obj, JsonDetail start_config, json::JsonBuilder &builder);
660#endif
661#ifdef USE_NUMBER
662 void number_json_(number::Number *obj, JsonDetail start_config, json::JsonBuilder &builder);
663#endif
664#ifdef USE_DATETIME_DATE
665 void date_json_(datetime::DateEntity *obj, JsonDetail start_config, json::JsonBuilder &builder);
666#endif
667#ifdef USE_DATETIME_TIME
668 void time_json_(datetime::TimeEntity *obj, JsonDetail start_config, json::JsonBuilder &builder);
669#endif
670#ifdef USE_DATETIME_DATETIME
671 void datetime_json_(datetime::DateTimeEntity *obj, JsonDetail start_config, json::JsonBuilder &builder);
672#endif
673#ifdef USE_TEXT
674 void text_json_(text::Text *obj, const std::string &value, JsonDetail start_config, json::JsonBuilder &builder);
675#endif
676#ifdef USE_SELECT
677 void select_json_(select::Select *obj, StringRef value, JsonDetail start_config, json::JsonBuilder &builder);
678#endif
679#ifdef USE_CLIMATE
680 void climate_json_(climate::Climate *obj, JsonDetail start_config, json::JsonBuilder &builder);
681#endif
682#ifdef USE_LOCK
683 void lock_json_(lock::Lock *obj, lock::LockState value, JsonDetail start_config, json::JsonBuilder &builder);
684#endif
685#ifdef USE_VALVE
686 void valve_json_(valve::Valve *obj, JsonDetail start_config, json::JsonBuilder &builder);
687#endif
688#ifdef USE_ALARM_CONTROL_PANEL
689 void alarm_control_panel_json_(alarm_control_panel::AlarmControlPanel *obj,
691 json::JsonBuilder &builder);
692#endif
693#ifdef USE_EVENT
694 void event_json_(event::Event *obj, StringRef event_type, JsonDetail start_config, json::JsonBuilder &builder);
695#endif
696#ifdef USE_WATER_HEATER
697 void water_heater_json_(water_heater::WaterHeater *obj, JsonDetail start_config, json::JsonBuilder &builder);
698#endif
699#ifdef USE_INFRARED
700 void infrared_json_(infrared::Infrared *obj, JsonDetail start_config, json::JsonBuilder &builder);
701#endif
702#ifdef USE_RADIO_FREQUENCY
703 void radio_frequency_json_(radio_frequency::RadioFrequency *obj, JsonDetail start_config, json::JsonBuilder &builder);
704#endif
705#ifdef USE_UPDATE
706 void update_json_(update::UpdateEntity *obj, JsonDetail start_config, json::JsonBuilder &builder);
707#endif
708};
709
710#ifdef USE_WEBSERVER_CAPTIVE
711extern WebServer *global_web_server; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
712#endif
713
714} // namespace esphome::web_server
715#endif
StringRef is a reference to a string owned by something else.
Definition string_ref.h:31
static constexpr StringRef from_lit(const CharT(&s)[N])
Definition string_ref.h:55
Base class for all binary_sensor-type classes.
Base class for all buttons.
Definition button.h:25
ClimateDevice - This is the base class for all climate integrations.
Definition climate.h:192
Base class for all cover devices.
Definition cover.h:115
Infrared - Base class for infrared remote control implementations.
Definition infrared.h:44
Builder class for creating JSON documents without lambdas.
Definition json_util.h:256
Buffer for JSON serialization that uses stack allocation for small payloads.
Definition json_util.h:36
This class represents the communication layer between the front-end MQTT layer and the hardware outpu...
Definition light_state.h:68
Base class for all locks.
Definition lock.h:112
Base-class for all numbers.
Definition number.h:29
RadioFrequency - Base class for radio frequency implementations.
Base-class for all selects.
Definition select.h:28
Base-class for all sensors.
Definition sensor.h:48
Base class for all switches.
Definition switch.h:43
Base-class for all text inputs.
Definition text.h:20
Base class for all valve devices.
Definition valve.h:102
DeferredUpdateEventSource(WebServer *ws, const String &url)
Definition web_server.h:160
static constexpr uint16_t MAX_CONSECUTIVE_SEND_FAILURES
Definition web_server.h:152
void deferrable_send_state(void *source, const char *event_type, message_generator_t *message_generator)=delete
void deq_push_back_with_dedup_(void *source, message_generator_t *message_generator)
void try_send_nodefer(const char *message, size_t message_len, const char *event=nullptr, uint32_t id=0, uint32_t reconnect=0)
void deferrable_send_state(void *source, bool detail_all, message_generator_t *message_generator)
std::vector< DeferredEvent > deferred_queue_
Definition web_server.h:149
void on_client_connect_(DeferredUpdateEventSource *source)
void try_send_nodefer(const char *message, size_t message_len, const char *event=nullptr, uint32_t id=0, uint32_t reconnect=0)
void add_new_client(WebServer *ws, AsyncWebServerRequest *request)
void deferrable_send_state(void *source, bool detail_all, message_generator_t *message_generator)
void on_client_disconnect_(DeferredUpdateEventSource *source)
void deferrable_send_state(void *source, const char *event_type, message_generator_t *message_generator)=delete
void add_client_(WebServer *ws, AsyncClient *client)
bool loop()
Returns true if there are event sources remaining (including pending cleanup).
This class allows users to create a web server with their ESP nodes.
Definition web_server.h:204
static void alarm_control_panel_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void setup() override
Setup the internal web server and register handlers.
void start_captive()
AP mode: DNS answers every name with the AP address and unknown URLs redirect to the interface.
void set_expose_log(bool expose_log)
Set whether or not the webserver should expose the Log.
Definition web_server.h:254
static void text_sensor_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
json::SerializationBuffer get_config_json()
Return the webserver configuration as JSON.
std::map< EntityBase *, SortingComponents > sorting_entitys_
Definition web_server.h:529
static void light_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void on_light_update(light::LightState *obj)
static void date_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void on_text_sensor_update(text_sensor::TextSensor *obj)
void on_lock_update(lock::Lock *obj)
void set_css_url(const char *css_url)
Set the URL to the CSS <link> that's sent to each client.
Definition web_server.h:218
void handle_select_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a select request under '/select/<id>'.
void on_date_update(datetime::DateEntity *obj)
static void event_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void on_log(uint8_t level, const char *tag, const char *message, size_t message_len)
static void cover_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void handle_water_heater_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a water_heater request under '/water_heater/<id>/<mode/set>'.
bool isRequestHandlerTrivial() const override
This web handle is not trivial.
WebServer(web_server_base::WebServerBase *base)
void handle_switch_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a switch request under '/switch/<id>/</turn_on/turn_off/toggle>'.
void handle_event_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a event request under '/event<id>'.
static void datetime_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void parse_light_param_uint_(AsyncWebServerRequest *request, ParamNameType param_name, T &call, Ret(T::*setter)(uint32_t), uint32_t scale=1)
Definition web_server.h:561
static void sensor_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
DeferredUpdateEventSourceList events_
Definition web_server.h:616
static void infrared_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void switch_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void handle_button_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a button request under '/button/<id>/press'.
void on_update(update::UpdateEntity *obj)
void add_entity_config(EntityBase *entity, float weight, uint64_t group)
void set_include_internal(bool include_internal)
Determine whether internal components should be displayed on the web server.
Definition web_server.h:249
void handle_radio_frequency_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a radio frequency request under '/radio_frequency/<id>/transmit'.
static void update_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void parse_light_param_(AsyncWebServerRequest *request, ParamNameType param_name, T &call, Ret(T::*setter)(float), float scale=1.0f)
Definition web_server.h:551
void handle_css_request(AsyncWebServerRequest *request)
Handle included css request under '/0.css'.
static void binary_sensor_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void water_heater_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void datetime_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void date_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void select_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void time_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void on_binary_sensor_update(binary_sensor::BinarySensor *obj)
void on_cover_update(cover::Cover *obj)
web_server_base::CaptiveDNS dns_
Definition web_server.h:620
static void number_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void on_fan_update(fan::Fan *obj)
void add_sorting_info_(JsonObject &root, EntityBase *entity)
void handle_light_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a light request under '/light/<id>/</turn_on/turn_off/toggle>'.
static void update_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void handle_text_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a text input request under '/text/<id>'.
void on_climate_update(climate::Climate *obj)
void handle_cover_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a cover request under '/cover/<id>/<open/close/stop/set>'.
void on_time_update(datetime::TimeEntity *obj)
static void event_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void switch_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void text_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void valve_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
web_server_base::WebServerBase * base_
Definition web_server.h:612
void on_event(event::Event *obj)
void handle_lock_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a lock request under '/lock/<id>/</lock/unlock/open>'.
void on_water_heater_update(water_heater::WaterHeater *obj)
void on_number_update(number::Number *obj)
static void fan_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void handle_text_sensor_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a text sensor request under '/text_sensor/<id>'.
static void select_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void parse_bool_param_(AsyncWebServerRequest *request, ParamNameType param_name, T &call, Ret(T::*setter)(bool))
Definition web_server.h:594
void handle_date_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a date request under '/date/<id>'.
void set_js_url(const char *js_url)
Set the URL to the script that's embedded in the index page.
Definition web_server.h:225
void handle_infrared_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle an infrared request under '/infrared/<id>/transmit'.
void handle_sensor_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a sensor request under '/sensor/<id>'.
void handle_number_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a number request under '/number/<id>'.
void handle_index_request(AsyncWebServerRequest *request)
Handle an index request under '/'.
void handle_js_request(AsyncWebServerRequest *request)
Handle included js request under '/0.js'.
void on_select_update(select::Select *obj)
void on_sensor_update(sensor::Sensor *obj)
void set_js_include(const char *js_include)
Set local path to the script that's embedded in the index page.
Definition web_server.h:241
static void text_sensor_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void radio_frequency_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void time_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void handleRequest(AsyncWebServerRequest *request) override
Override the web handler's handleRequest method.
void handle_fan_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a fan request under '/fan/<id>/</turn_on/turn_off/toggle>'.
static void button_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void parse_cstr_param_(AsyncWebServerRequest *request, ParamNameType param_name, T &call, Ret(T::*setter)(const char *, size_t))
Definition web_server.h:581
static void alarm_control_panel_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void number_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void on_switch_update(switch_::Switch *obj)
static void light_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void handle_valve_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a valve request under '/valve/<id>/<open/close/stop/set>'.
void handle_binary_sensor_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a binary sensor request under '/binary_sensor/<id>'.
static void lock_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void handle_time_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a time request under '/time/<id>'.
std::map< uint64_t, SortingGroup > sorting_groups_
Definition web_server.h:530
void set_css_include(const char *css_include)
Set local path to the script that's embedded in the index page.
Definition web_server.h:233
static void fan_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
bool canHandle(AsyncWebServerRequest *request) const override
Override the web handler's canHandle method.
void on_valve_update(valve::Valve *obj)
static void water_heater_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void on_datetime_update(datetime::DateTimeEntity *obj)
void send_state_event_(T *obj, message_generator_t *generator)
Definition web_server.h:541
void handle_pna_cors_request(AsyncWebServerRequest *request)
void on_alarm_control_panel_update(alarm_control_panel::AlarmControlPanel *obj)
void handle_datetime_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a datetime request under '/datetime/<id>'.
void on_text_update(text::Text *obj)
void handle_alarm_control_panel_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a alarm_control_panel request under '/alarm_control_panel/<id>'.
float get_setup_priority() const override
MQTT setup priority.
void handle_not_found_(AsyncWebServerRequest *request)
static void text_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void sensor_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void parse_num_param_(AsyncWebServerRequest *request, ParamNameType param_name, T &call, Ret(T::*setter)(NumT))
Definition web_server.h:572
static void climate_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void handle_update_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a update request under '/update/<id>'.
void on_media_player_update(media_player::MediaPlayer *)
Definition web_server.h:495
static void lock_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void add_sorting_group(uint64_t group_id, const std::string &group_name, float weight)
static void valve_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void cover_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void binary_sensor_all_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
static void climate_state_json_generator(WebServer *web_server, void *source, json::JsonBuilder &builder)
void handle_climate_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a climate request under '/climate/<id>'.
const LogString * message
Definition component.cpp:35
mopeka_std_values val[3]
LockState
Enum for all states a lock can be in.
Definition lock.h:22
ProgmemStr ParamNameType
Definition web_server.h:46
WebServer * global_web_server
constexpr size_t LOG_EVENT_MAX_LEN
Definition web_server.h:43
void(WebServer *, void *, json::JsonBuilder &) message_generator_t
Definition web_server.h:110
ParseOnOffState parse_on_off(const char *str, const char *on, const char *off)
Parse a string that contains either on, off or toggle.
Definition helpers.cpp:554
uint32_t value
Definition hal.cpp:41
optional< T > parse_number(const char *str)
Parse an unsigned decimal number from a null-terminated string.
Definition helpers.h:1430
@ PARSE_ON
Definition helpers.h:1819
@ PARSE_OFF
Definition helpers.h:1820
@ PARSE_NONE
Definition helpers.h:1818
const __FlashStringHelper * ProgmemStr
Definition progmem.h:31
static void uint32_t
Result of matching a URL against an entity.
Definition web_server.h:56
bool matched
True if entity matched the URL.
Definition web_server.h:57
bool action_is_empty
True if no action/method segment in URL.
Definition web_server.h:58
Internal helper struct that is used to parse incoming URLs.
Definition web_server.h:62
StringRef device_name
Device name within URL, empty for main device.
Definition web_server.h:67
bool valid
Whether this match is valid.
Definition web_server.h:69
bool domain_equals(const __FlashStringHelper *str) const
Definition web_server.h:78
EntityMatchResult match_entity(EntityBase *entity) const
Match entity by name; internal entities match only if include_internal is set Returns EntityMatchResu...
StringRef method
Method within URL, for example "turn_on".
Definition web_server.h:65
bool domain_equals(const char *str) const
Definition web_server.h:73
bool method_equals(const __FlashStringHelper *str) const
Definition web_server.h:79
bool method_equals(const char *str) const
Definition web_server.h:74
StringRef domain
Domain within URL, for example "sensor".
Definition web_server.h:63
StringRef id
Entity name/id within URL, for example "Temperature".
Definition web_server.h:64
bool include_internal
Whether internal entities may match, the web server's include_internal.
Definition web_server.h:70
const uint8_t ESPHOME_WEBSERVER_INDEX_HTML[] PROGMEM
Definition web_server.h:30
const size_t ESPHOME_WEBSERVER_INDEX_HTML_SIZE
const size_t ESPHOME_WEBSERVER_CSS_INCLUDE_SIZE
const size_t ESPHOME_WEBSERVER_JS_INCLUDE_SIZE