13#if !defined(USE_ESP32) && defined(USE_ARDUINO)
14#include "StreamString.h"
31#ifdef USE_WEBSERVER_LOCAL
32#if USE_WEBSERVER_VERSION == 2
34#elif USE_WEBSERVER_VERSION == 3
42static const char *
const TAG =
"web_server";
44#ifdef USE_WEBSERVER_PRIVATE_NETWORK_ACCESS
45static const char *
const HEADER_PNA_NAME =
"Private-Network-Access-Name";
46static const char *
const HEADER_PNA_ID =
"Private-Network-Access-ID";
47static const char *
const HEADER_CORS_REQ_PNA =
"Access-Control-Request-Private-Network";
48static const char *
const HEADER_CORS_ALLOW_PNA =
"Access-Control-Allow-Private-Network";
52static UrlMatch match_url(
const char *url_ptr,
size_t url_len,
bool only_domain) {
56 if (url_len < 2 || url_ptr[0] !=
'/') {
61 const char *start = url_ptr + 1;
62 const char *
end = url_ptr + url_len;
65 const char *domain_end = (
const char *) memchr(start,
'/',
end - start);
73 match.domain_len = domain_end - start;
81 if (domain_end + 1 >=
end) {
85 const char *id_start = domain_end + 1;
86 const char *id_end = (
const char *) memchr(id_start,
'/',
end - id_start);
91 match.id_len =
end - id_start;
97 match.id_len = id_end - id_start;
100 if (id_end + 1 <
end) {
101 match.method = id_end + 1;
102 match.method_len =
end - (id_end + 1);
108#if !defined(USE_ESP32) && defined(USE_ARDUINO)
111 DeferredEvent item(source, message_generator);
119 this->deferred_queue_.push_back(item);
126 if (this->send(
message.c_str(),
"state") != DISCARDED) {
138 ESP_LOGW(TAG,
"Closing stuck EventSource connection after %" PRIu16
" failed sends",
157 if (this->count() == 0)
165 if (source ==
nullptr)
167 if (event_type ==
nullptr)
169 if (message_generator ==
nullptr)
172 if (0 != strcmp(event_type,
"state_detail_all") && 0 != strcmp(event_type,
"state")) {
173 ESP_LOGE(TAG,
"Can't defer non-state event");
183 if (this->send(
message.c_str(),
"state") == DISCARDED) {
193 uint32_t reconnect) {
194 this->send(
message, event,
id, reconnect);
214 uint32_t reconnect) {
224 es->onConnect([
this, es](AsyncEventSourceClient *client) { this->
on_client_connect_(es); });
228 es->handleRequest(request);
233 ws->
defer([ws, source]() {
239#ifdef USE_WEBSERVER_SORTING
242 JsonObject root = builder.
root();
243 root[
"name"] = group.second.name;
244 root[
"sorting_weight"] = group.second.weight;
266 this->remove(source);
274#ifdef USE_WEBSERVER_CSS_INCLUDE
277#ifdef USE_WEBSERVER_JS_INCLUDE
283 JsonObject root = builder.
root();
287#if defined(USE_WEBSERVER_OTA_DISABLED) || !defined(USE_WEBSERVER_OTA)
306 [
this](
int level,
const char *tag,
const char *
message,
size_t message_len) {
333#ifdef USE_WEBSERVER_LOCAL
336 AsyncWebServerResponse *response = request->beginResponse(200,
"text/html", INDEX_GZ,
sizeof(INDEX_GZ));
338 AsyncWebServerResponse *response = request->beginResponse_P(200,
"text/html", INDEX_GZ,
sizeof(INDEX_GZ));
340 response->addHeader(
"Content-Encoding",
"gzip");
341 request->send(response);
343#elif USE_WEBSERVER_VERSION >= 2
346 AsyncWebServerResponse *response =
349 AsyncWebServerResponse *response =
353 request->send(response);
357#ifdef USE_WEBSERVER_PRIVATE_NETWORK_ACCESS
359 AsyncWebServerResponse *response = request->beginResponse(200,
"");
360 response->addHeader(HEADER_CORS_ALLOW_PNA,
"true");
361 response->addHeader(HEADER_PNA_NAME,
App.
get_name().c_str());
363 response->addHeader(HEADER_PNA_ID, mac.c_str());
364 request->send(response);
368#ifdef USE_WEBSERVER_CSS_INCLUDE
371 AsyncWebServerResponse *response =
374 AsyncWebServerResponse *response =
377 response->addHeader(
"Content-Encoding",
"gzip");
378 request->send(response);
382#ifdef USE_WEBSERVER_JS_INCLUDE
385 AsyncWebServerResponse *response =
388 AsyncWebServerResponse *response =
391 response->addHeader(
"Content-Encoding",
"gzip");
392 request->send(response);
397static void set_json_id(JsonObject &root,
EntityBase *obj,
const char *prefix,
JsonDetail start_config) {
400 snprintf(id_buf,
sizeof(id_buf),
"%s-%s", prefix, object_id.c_str());
408 root[
"is_disabled_by_default"] = is_disabled;
415static void set_json_value(JsonObject &root, EntityBase *obj,
const char *prefix,
const T &value,
417 set_json_id(root, obj, prefix, start_config);
418 root[
"value"] = value;
422static void set_json_icon_state_value(JsonObject &root, EntityBase *obj,
const char *prefix,
const std::string &
state,
424 set_json_value(root, obj, prefix, value, start_config);
425 root[
"state"] =
state;
429static JsonDetail get_request_detail(AsyncWebServerRequest *request) {
430 auto *param = request->getParam(
"detail");
446 auto detail = get_request_detail(request);
447 std::string data = this->
sensor_json(obj, obj->state, detail);
448 request->send(200,
"application/json", data.c_str());
462 JsonObject root = builder.
root();
468 set_json_icon_state_value(root, obj,
"sensor",
state, value, start_config);
471 if (!uom_ref.empty())
472 root[
"uom"] = uom_ref;
479#ifdef USE_TEXT_SENSOR
491 auto detail = get_request_detail(request);
493 request->send(200,
"application/json", data.c_str());
510 JsonObject root = builder.
root();
512 set_json_icon_state_value(root, obj,
"text_sensor", value, value, start_config);
532 if (request->method() == HTTP_GET && match.
method_empty()) {
533 auto detail = get_request_detail(request);
534 std::string data = this->
switch_json(obj, obj->state, detail);
535 request->send(200,
"application/json", data.c_str());
540 enum SwitchAction { NONE, TOGGLE, TURN_ON, TURN_OFF };
541 SwitchAction action = NONE;
551 if (action != NONE) {
552 this->
defer([obj, action]() {
583 JsonObject root = builder.
root();
585 set_json_icon_state_value(root, obj,
"switch", value ?
"ON" :
"OFF", value, start_config);
600 if (request->method() == HTTP_GET && match.
method_empty()) {
601 auto detail = get_request_detail(request);
603 request->send(200,
"application/json", data.c_str());
605 this->
defer([obj]() { obj->press(); });
623 JsonObject root = builder.
root();
625 set_json_id(root, obj,
"button", start_config);
634#ifdef USE_BINARY_SENSOR
646 auto detail = get_request_detail(request);
648 request->send(200,
"application/json", data.c_str());
664 JsonObject root = builder.
root();
666 set_json_icon_state_value(root, obj,
"binary_sensor", value ?
"ON" :
"OFF", value, start_config);
686 if (request->method() == HTTP_GET && match.
method_empty()) {
687 auto detail = get_request_detail(request);
688 std::string data = this->
fan_json(obj, detail);
689 request->send(200,
"application/json", data.c_str());
691 this->
defer([obj]() { obj->toggle().perform(); });
698 if (request->hasParam(
"oscillation")) {
699 auto speed = request->getParam(
"oscillation")->value();
703 call.set_oscillating(
true);
706 call.set_oscillating(
false);
709 call.set_oscillating(!obj->oscillating);
733 JsonObject root = builder.
root();
735 set_json_icon_state_value(root, obj,
"fan", obj->
state ?
"ON" :
"OFF", obj->
state, start_config);
737 if (traits.supports_speed()) {
738 root[
"speed_level"] = obj->
speed;
739 root[
"speed_count"] = traits.supported_speed_count();
762 if (request->method() == HTTP_GET && match.
method_empty()) {
763 auto detail = get_request_detail(request);
764 std::string data = this->
light_json(obj, detail);
765 request->send(200,
"application/json", data.c_str());
767 this->
defer([obj]() { obj->toggle().perform(); });
770 auto call = obj->turn_on();
789 auto call = obj->turn_off();
808 JsonObject root = builder.
root();
810 set_json_value(root, obj,
"light", obj->
remote_values.
is_on() ?
"ON" :
"OFF", start_config);
814 JsonArray opt = root[
"effects"].to<JsonArray>();
817 opt.add(option->get_name());
837 if (request->method() == HTTP_GET && match.
method_empty()) {
838 auto detail = get_request_detail(request);
839 std::string data = this->
cover_json(obj, detail);
840 request->send(200,
"application/json", data.c_str());
844 auto call = obj->make_call();
847 static const struct {
858 for (
const auto &method : METHODS) {
860 (
call.*method.action)();
871 auto traits = obj->get_traits();
872 if ((request->hasParam(
"position") && !traits.get_supports_position()) ||
873 (request->hasParam(
"tilt") && !traits.get_supports_tilt())) {
895 JsonObject root = builder.
root();
904 root[
"tilt"] = obj->
tilt;
920 for (
auto *obj :
App.get_numbers()) {
924 if (request->method() == HTTP_GET && match.
method_empty()) {
925 auto detail = get_request_detail(request);
926 std::string data = this->
number_json(obj, obj->state, detail);
927 request->send(200,
"application/json", data.c_str());
935 auto call = obj->make_call();
953 JsonObject root = builder.
root();
957 std::string val_str = std::isnan(value)
960 std::string state_str = std::isnan(value) ?
"NA"
963 set_json_icon_state_value(root, obj,
"number", state_str, val_str, start_config);
971 if (!uom_ref.empty())
972 root[
"uom"] = uom_ref;
980#ifdef USE_DATETIME_DATE
987 for (
auto *obj :
App.get_dates()) {
990 if (request->method() == HTTP_GET && match.
method_empty()) {
991 auto detail = get_request_detail(request);
992 std::string data = this->
date_json(obj, detail);
993 request->send(200,
"application/json", data.c_str());
1001 auto call = obj->make_call();
1003 if (!request->hasParam(
"value")) {
1025 JsonObject root = builder.
root();
1028 set_json_icon_state_value(root, obj,
"date", value, value, start_config);
1037#ifdef USE_DATETIME_TIME
1044 for (
auto *obj :
App.get_times()) {
1047 if (request->method() == HTTP_GET && match.
method_empty()) {
1048 auto detail = get_request_detail(request);
1049 std::string data = this->
time_json(obj, detail);
1050 request->send(200,
"application/json", data.c_str());
1058 auto call = obj->make_call();
1060 if (!request->hasParam(
"value")) {
1081 JsonObject root = builder.
root();
1084 set_json_icon_state_value(root, obj,
"time", value, value, start_config);
1093#ifdef USE_DATETIME_DATETIME
1100 for (
auto *obj :
App.get_datetimes()) {
1103 if (request->method() == HTTP_GET && match.
method_empty()) {
1104 auto detail = get_request_detail(request);
1106 request->send(200,
"application/json", data.c_str());
1114 auto call = obj->make_call();
1116 if (!request->hasParam(
"value")) {
1137 JsonObject root = builder.
root();
1141 set_json_icon_state_value(root, obj,
"datetime", value, value, start_config);
1157 for (
auto *obj :
App.get_texts()) {
1161 if (request->method() == HTTP_GET && match.
method_empty()) {
1162 auto detail = get_request_detail(request);
1163 std::string data = this->
text_json(obj, obj->state, detail);
1164 request->send(200,
"application/json", data.c_str());
1172 auto call = obj->make_call();
1190 JsonObject root = builder.
root();
1193 set_json_icon_state_value(root, obj,
"text",
state, value, start_config);
1213 for (
auto *obj :
App.get_selects()) {
1217 if (request->method() == HTTP_GET && match.
method_empty()) {
1218 auto detail = get_request_detail(request);
1219 std::string data = this->
select_json(obj, obj->
has_state() ? obj->current_option() :
"", detail);
1220 request->send(200,
"application/json", data.c_str());
1229 auto call = obj->make_call();
1248 JsonObject root = builder.
root();
1250 set_json_icon_state_value(root, obj,
"select", value, value, start_config);
1252 JsonArray opt = root[
"option"].to<JsonArray>();
1264#define PSTR_LOCAL(mode_s) ESPHOME_strncpy_P(buf, (ESPHOME_PGM_P) ((mode_s)), 15)
1273 for (
auto *obj :
App.get_climates()) {
1277 if (request->method() == HTTP_GET && match.
method_empty()) {
1278 auto detail = get_request_detail(request);
1280 request->send(200,
"application/json", data.c_str());
1289 auto call = obj->make_call();
1318 JsonObject root = builder.
root();
1319 set_json_id(root, obj,
"climate", start_config);
1322 int8_t current_accuracy = traits.get_current_temperature_accuracy_decimals();
1326 JsonArray opt = root[
"modes"].to<JsonArray>();
1329 if (!traits.get_supported_custom_fan_modes().empty()) {
1330 JsonArray opt = root[
"fan_modes"].to<JsonArray>();
1335 if (!traits.get_supported_custom_fan_modes().empty()) {
1336 JsonArray opt = root[
"custom_fan_modes"].to<JsonArray>();
1337 for (
auto const &
custom_fan_mode : traits.get_supported_custom_fan_modes())
1340 if (traits.get_supports_swing_modes()) {
1341 JsonArray opt = root[
"swing_modes"].to<JsonArray>();
1342 for (
auto swing_mode : traits.get_supported_swing_modes())
1346 JsonArray opt = root[
"presets"].to<JsonArray>();
1350 if (!traits.get_supported_custom_presets().empty() && obj->
has_custom_preset()) {
1351 JsonArray opt = root[
"custom_presets"].to<JsonArray>();
1352 for (
auto const &
custom_preset : traits.get_supported_custom_presets())
1358 bool has_state =
false;
1359 root[
"mode"] = PSTR_LOCAL(climate_mode_to_string(obj->
mode));
1362 root[
"step"] = traits.get_visual_target_temperature_step();
1364 root[
"action"] = PSTR_LOCAL(climate_action_to_string(obj->
action));
1365 root[
"state"] = root[
"action"];
1369 root[
"fan_mode"] = PSTR_LOCAL(climate_fan_mode_to_string(obj->
fan_mode.
value()));
1375 root[
"preset"] = PSTR_LOCAL(climate_preset_to_string(obj->
preset.
value()));
1377 if (!traits.get_supported_custom_presets().empty() && obj->
has_custom_preset()) {
1380 if (traits.get_supports_swing_modes()) {
1381 root[
"swing_mode"] = PSTR_LOCAL(climate_swing_mode_to_string(obj->
swing_mode));
1387 root[
"current_temperature"] =
"NA";
1401 root[
"state"] = root[
"target_temperature"];
1420 if (request->method() == HTTP_GET && match.
method_empty()) {
1421 auto detail = get_request_detail(request);
1422 std::string data = this->
lock_json(obj, obj->state, detail);
1423 request->send(200,
"application/json", data.c_str());
1428 enum LockAction { NONE, LOCK, UNLOCK, OPEN };
1429 LockAction action = NONE;
1439 if (action != NONE) {
1440 this->
defer([obj, action]() {
1471 JsonObject root = builder.
root();
1493 if (request->method() == HTTP_GET && match.
method_empty()) {
1494 auto detail = get_request_detail(request);
1495 std::string data = this->
valve_json(obj, detail);
1496 request->send(200,
"application/json", data.c_str());
1500 auto call = obj->make_call();
1503 static const struct {
1514 for (
const auto &method : METHODS) {
1516 (
call.*method.action)();
1527 auto traits = obj->get_traits();
1528 if (request->hasParam(
"position") && !traits.get_supports_position()) {
1549 JsonObject root = builder.
root();
1565#ifdef USE_ALARM_CONTROL_PANEL
1576 if (request->method() == HTTP_GET && match.
method_empty()) {
1577 auto detail = get_request_detail(request);
1579 request->send(200,
"application/json", data.c_str());
1583 auto call = obj->make_call();
1587 static const struct {
1599 for (
const auto &method : METHODS) {
1601 (
call.*method.action)();
1632 JsonObject root = builder.
root();
1635 set_json_icon_state_value(root, obj,
"alarm-control-panel", PSTR_LOCAL(alarm_control_panel_state_to_string(value)),
1636 value, start_config);
1659 auto detail = get_request_detail(request);
1660 std::string data = this->
event_json(obj,
"", detail);
1661 request->send(200,
"application/json", data.c_str());
1668static std::string get_event_type(
event::Event *event) {
1669 const char *last_type =
event ?
event->get_last_event_type() :
nullptr;
1670 return last_type ? last_type :
"";
1683 JsonObject root = builder.
root();
1685 set_json_id(root, obj,
"event", start_config);
1686 if (!event_type.empty()) {
1687 root[
"event_type"] = event_type;
1690 JsonArray event_types = root[
"event_types"].to<JsonArray>();
1692 event_types.add(event_type);
1708 return "UPDATE AVAILABLE";
1710 return "INSTALLING";
1724 if (request->method() == HTTP_GET && match.
method_empty()) {
1725 auto detail = get_request_detail(request);
1726 std::string data = this->
update_json(obj, detail);
1727 request->send(200,
"application/json", data.c_str());
1736 this->
defer([obj]()
mutable { obj->perform(); });
1753 JsonObject root = builder.
root();
1771 const auto &url = request->url();
1772 const auto method = request->method();
1775 static const char *
const STATIC_URLS[] = {
1777#if !defined(USE_ESP32) && defined(USE_ARDUINO)
1780#ifdef USE_WEBSERVER_CSS_INCLUDE
1783#ifdef USE_WEBSERVER_JS_INCLUDE
1788 for (
const auto &static_url : STATIC_URLS) {
1789 if (url == static_url)
1793#ifdef USE_WEBSERVER_PRIVATE_NETWORK_ACCESS
1794 if (method == HTTP_OPTIONS && request->hasHeader(HEADER_CORS_REQ_PNA))
1799 UrlMatch match = match_url(url.c_str(), url.length(),
true);
1804 bool is_get = method == HTTP_GET;
1805 bool is_post = method == HTTP_POST;
1806 bool is_get_or_post = is_get || is_post;
1808 if (!is_get_or_post)
1812 static const char *
const GET_ONLY_DOMAINS[] = {
1816#ifdef USE_BINARY_SENSOR
1819#ifdef USE_TEXT_SENSOR
1827 static const char *
const GET_POST_DOMAINS[] = {
1846#ifdef USE_DATETIME_DATE
1849#ifdef USE_DATETIME_TIME
1852#ifdef USE_DATETIME_DATETIME
1870#ifdef USE_ALARM_CONTROL_PANEL
1871 "alarm_control_panel",
1880 for (
const auto &domain : GET_ONLY_DOMAINS) {
1887 if (is_get_or_post) {
1888 for (
const auto &domain : GET_POST_DOMAINS) {
1897 const auto &url = request->url();
1905#if !defined(USE_ESP32) && defined(USE_ARDUINO)
1906 if (url ==
"/events") {
1907 this->
events_.add_new_client(
this, request);
1912#ifdef USE_WEBSERVER_CSS_INCLUDE
1913 if (url ==
"/0.css") {
1919#ifdef USE_WEBSERVER_JS_INCLUDE
1920 if (url ==
"/0.js") {
1926#ifdef USE_WEBSERVER_PRIVATE_NETWORK_ACCESS
1927 if (request->method() == HTTP_OPTIONS && request->hasHeader(HEADER_CORS_REQ_PNA)) {
1934 UrlMatch match = match_url(url.c_str(), url.length(),
false);
1937 struct ComponentRoute {
1942 static const ComponentRoute ROUTES[] = {
1952#ifdef USE_BINARY_SENSOR
1961#ifdef USE_TEXT_SENSOR
1970#ifdef USE_DATETIME_DATE
1973#ifdef USE_DATETIME_TIME
1976#ifdef USE_DATETIME_DATETIME
1994#ifdef USE_ALARM_CONTROL_PANEL
2003 for (
const auto &route : ROUTES) {
2005 (this->*route.handler)(request, match);
2011 ESP_LOGV(TAG,
"Request for unknown URL: %s", url.c_str());
2012 request->send(404,
"text/plain",
"Not Found");
2018#ifdef USE_WEBSERVER_SORTING
2021 if (this->
sorting_groups_.find(this->sorting_entitys_[entity].group_id) != this->sorting_groups_.end()) {
2028#ifdef USE_WEBSERVER_SORTING
std::string get_comment() const
Get the comment of this Application set by pre_setup().
const std::string & get_friendly_name() const
Get the friendly name of this Application set by pre_setup().
const std::string & get_name() const
Get the name of this Application set by pre_setup().
auto & get_binary_sensors() const
void set_interval(const std::string &name, uint32_t interval, std::function< void()> &&f)
Set an interval function with a unique name.
void defer(const std::string &name, std::function< void()> &&f)
Defer a callback to the next loop() call.
void begin(bool include_internal=false)
static void register_controller(Controller *controller)
Register a controller to receive entity state updates.
StringRef get_device_class_ref() const
Get the device class as StringRef.
StringRef get_unit_of_measurement_ref() const
Get the unit of measurement as StringRef.
const StringRef & get_name() const
StringRef get_icon_ref() const
bool is_disabled_by_default() const
std::string get_object_id() const
EntityCategory get_entity_category() const
AlarmControlPanelCall & arm_night()
AlarmControlPanelCall & disarm()
AlarmControlPanelCall & arm_away()
AlarmControlPanelCall & arm_home()
AlarmControlPanelCall & arm_vacation()
Base class for all binary_sensor-type classes.
ClimateDevice - This is the base class for all climate integrations.
ClimateMode mode
The active mode of the climate device.
optional< ClimateFanMode > fan_mode
The active fan mode of the climate device.
ClimateTraits get_traits()
Get the traits of this climate device with all overrides applied.
float target_temperature
The target temperature of the climate device.
const char * get_custom_fan_mode() const
Get the active custom fan mode (read-only access).
ClimateSwingMode swing_mode
The active swing mode of the climate device.
float target_temperature_low
The minimum target temperature of the climate device, for climate devices with split target temperatu...
const char * get_custom_preset() const
Get the active custom preset (read-only access).
bool has_custom_preset() const
Check if a custom preset is currently active.
float current_temperature
The current temperature of the climate device, as reported from the integration.
ClimateAction action
The active state of the climate device.
bool has_custom_fan_mode() const
Check if a custom fan mode is currently active.
optional< ClimatePreset > preset
The active preset of the climate device.
float target_temperature_high
The maximum target temperature of the climate device, for climate devices with split target temperatu...
int8_t get_target_temperature_accuracy_decimals() const
CoverCall & set_command_toggle()
Set the command to toggle the cover.
CoverCall & set_command_open()
Set the command to open the cover.
CoverCall & set_command_close()
Set the command to close the cover.
CoverCall & set_command_stop()
Set the command to stop the cover.
Base class for all cover devices.
CoverOperation current_operation
The current operation of the cover (idle, opening, closing).
float tilt
The current tilt value of the cover from 0.0 to 1.0.
float position
The position of the cover from 0.0 (fully closed) to 1.0 (fully open).
bool is_fully_closed() const
Helper method to check if the cover is fully closed. Equivalent to comparing .position against 0....
virtual CoverTraits get_traits()=0
bool get_supports_position() const
bool get_supports_tilt() const
const FixedVector< const char * > & get_event_types() const
Return the event types supported by this event.
virtual FanTraits get_traits()=0
bool oscillating
The current oscillation state of the fan.
bool state
The current on/off state of the fan.
int speed
The current fan speed level.
bool supports_oscillation() const
Return if this fan supports oscillation.
Builder class for creating JSON documents without lambdas.
bool is_on() const
Get the binary true/false state of these light color values.
static void dump_json(LightState &state, JsonObject root)
Dump the state of a light as JSON.
This class represents the communication layer between the front-end MQTT layer and the hardware outpu...
LightColorValues remote_values
The remote color values reported to the frontend.
const FixedVector< LightEffect * > & get_effects() const
Get all effects for this light state.
Base class for all locks.
void add_on_log_callback(std::function< void(uint8_t, const char *, const char *, size_t)> &&callback)
Register a callback that will be called for every log message sent.
Base-class for all numbers.
float get_min_value() const
float get_max_value() const
NumberMode get_mode() const
value_type const & value() const
Base-class for all selects.
const FixedVector< const char * > & get_options() const
Base-class for all sensors.
int8_t get_accuracy_decimals()
Get the accuracy in decimals, using the manual override if set.
Base class for all switches.
virtual bool assumed_state()
Return whether this switch uses an assumed state - i.e.
Base-class for all text inputs.
TextMode get_mode() const
int get_max_length() const
std::string get_pattern() const
int get_min_length() const
const UpdateState & state
const UpdateInfo & update_info
ValveCall & set_command_close()
Set the command to close the valve.
ValveCall & set_command_toggle()
Set the command to toggle the valve.
ValveCall & set_command_stop()
Set the command to stop the valve.
ValveCall & set_command_open()
Set the command to open the valve.
Base class for all valve devices.
bool is_fully_closed() const
Helper method to check if the valve is fully closed. Equivalent to comparing .position against 0....
float position
The position of the valve from 0.0 (fully closed) to 1.0 (fully open).
ValveOperation current_operation
The current operation of the valve (idle, opening, closing).
virtual ValveTraits get_traits()=0
bool get_supports_position() const
void process_deferred_queue_()
void try_send_nodefer(const char *message, const char *event=nullptr, uint32_t id=0, uint32_t reconnect=0)
static constexpr uint16_t MAX_CONSECUTIVE_SEND_FAILURES
uint16_t consecutive_send_failures_
void deq_push_back_with_dedup_(void *source, message_generator_t *message_generator)
void deferrable_send_state(void *source, const char *event_type, message_generator_t *message_generator)
ListEntitiesIterator entities_iterator_
std::vector< DeferredEvent > deferred_queue_
void on_client_connect_(DeferredUpdateEventSource *source)
void add_new_client(WebServer *ws, AsyncWebServerRequest *request)
void deferrable_send_state(void *source, const char *event_type, message_generator_t *message_generator)
void try_send_nodefer(const char *message, const char *event=nullptr, uint32_t id=0, uint32_t reconnect=0)
void on_client_disconnect_(DeferredUpdateEventSource *source)
This class allows users to create a web server with their ESP nodes.
void setup() override
Setup the internal web server and register handlers.
void on_update(update::UpdateEntity *obj) override
static std::string text_sensor_all_json_generator(WebServer *web_server, void *source)
std::string light_json(light::LightState *obj, JsonDetail start_config)
Dump the light state as a JSON string.
std::string date_json(datetime::DateEntity *obj, JsonDetail start_config)
Dump the date state with its value as a JSON string.
std::string get_config_json()
Return the webserver configuration as JSON.
std::map< EntityBase *, SortingComponents > sorting_entitys_
static std::string binary_sensor_state_json_generator(WebServer *web_server, void *source)
void on_text_update(text::Text *obj) override
std::string binary_sensor_json(binary_sensor::BinarySensor *obj, bool value, JsonDetail start_config)
Dump the binary sensor state with its value as a JSON string.
static std::string button_state_json_generator(WebServer *web_server, void *source)
static std::string lock_all_json_generator(WebServer *web_server, void *source)
void on_light_update(light::LightState *obj) override
static std::string date_all_json_generator(WebServer *web_server, void *source)
std::string update_json(update::UpdateEntity *obj, JsonDetail start_config)
Dump the update state with its value as a JSON string.
void on_cover_update(cover::Cover *obj) override
static std::string text_state_json_generator(WebServer *web_server, void *source)
void handle_select_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a select request under '/select/<id>'.
std::string number_json(number::Number *obj, float value, JsonDetail start_config)
Dump the number state with its value as a JSON string.
static std::string event_state_json_generator(WebServer *web_server, void *source)
std::string cover_json(cover::Cover *obj, JsonDetail start_config)
Dump the cover state as a JSON string.
static std::string datetime_all_json_generator(WebServer *web_server, void *source)
static std::string sensor_all_json_generator(WebServer *web_server, void *source)
bool isRequestHandlerTrivial() const override
This web handle is not trivial.
WebServer(web_server_base::WebServerBase *base)
std::string text_sensor_json(text_sensor::TextSensor *obj, const std::string &value, JsonDetail start_config)
Dump the text sensor state with its value as a JSON string.
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>'.
void parse_light_param_uint_(AsyncWebServerRequest *request, const char *param_name, T &call, Ret(T::*setter)(uint32_t), uint32_t scale=1)
std::string select_json(select::Select *obj, const char *value, JsonDetail start_config)
Dump the select state with its value as a JSON string.
void dump_config() override
std::string button_json(button::Button *obj, JsonDetail start_config)
Dump the button details with its value as a JSON string.
std::string valve_json(valve::Valve *obj, JsonDetail start_config)
Dump the valve state as a JSON string.
void handle_button_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a button request under '/button/<id>/press'.
void on_date_update(datetime::DateEntity *obj) override
std::string text_json(text::Text *obj, const std::string &value, JsonDetail start_config)
Dump the text state with its value as a JSON string.
void on_number_update(number::Number *obj) override
void add_entity_config(EntityBase *entity, float weight, uint64_t group)
std::string datetime_json(datetime::DateTimeEntity *obj, JsonDetail start_config)
Dump the datetime state with its value as a JSON string.
void handle_css_request(AsyncWebServerRequest *request)
Handle included css request under '/0.css'.
static std::string sensor_state_json_generator(WebServer *web_server, void *source)
void on_valve_update(valve::Valve *obj) override
void on_climate_update(climate::Climate *obj) override
static std::string switch_state_json_generator(WebServer *web_server, void *source)
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 std::string event_all_json_generator(WebServer *web_server, void *source)
static std::string climate_state_json_generator(WebServer *web_server, void *source)
void on_binary_sensor_update(binary_sensor::BinarySensor *obj) override
static std::string number_all_json_generator(WebServer *web_server, void *source)
void handle_text_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a text input request under '/text/<id>'.
void handle_cover_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a cover request under '/cover/<id>/<open/close/stop/set>'.
static std::string date_state_json_generator(WebServer *web_server, void *source)
static std::string valve_all_json_generator(WebServer *web_server, void *source)
static std::string text_all_json_generator(WebServer *web_server, void *source)
void on_switch_update(switch_::Switch *obj) override
web_server_base::WebServerBase * base_
static std::string binary_sensor_all_json_generator(WebServer *web_server, void *source)
static std::string light_state_json_generator(WebServer *web_server, void *source)
void handle_lock_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a lock request under '/lock/<id>/</lock/unlock/open>'.
void on_alarm_control_panel_update(alarm_control_panel::AlarmControlPanel *obj) override
static std::string light_all_json_generator(WebServer *web_server, void *source)
std::string switch_json(switch_::Switch *obj, bool value, JsonDetail start_config)
Dump the switch state with its value as a JSON string.
void handle_text_sensor_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a text sensor request under '/text_sensor/<id>'.
std::string sensor_json(sensor::Sensor *obj, float value, JsonDetail start_config)
Dump the sensor state with its value as a JSON string.
void handle_date_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a date request under '/date/<id>'.
static std::string cover_all_json_generator(WebServer *web_server, void *source)
void handle_sensor_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a sensor request under '/sensor/<id>'.
static std::string text_sensor_state_json_generator(WebServer *web_server, void *source)
void handle_number_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a number request under '/number/<id>'.
static std::string alarm_control_panel_state_json_generator(WebServer *web_server, void *source)
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 set_js_include(const char *js_include)
Set local path to the script that's embedded in the index page.
static std::string fan_state_json_generator(WebServer *web_server, void *source)
static std::string update_state_json_generator(WebServer *web_server, void *source)
void handleRequest(AsyncWebServerRequest *request) override
Override the web handler's handleRequest method.
static std::string climate_all_json_generator(WebServer *web_server, void *source)
void on_datetime_update(datetime::DateTimeEntity *obj) override
std::string event_json(event::Event *obj, const std::string &event_type, JsonDetail start_config)
Dump the event details with its value as a JSON string.
std::string time_json(datetime::TimeEntity *obj, JsonDetail start_config)
Dump the time state with its value as a JSON string.
void handle_fan_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a fan request under '/fan/<id>/</turn_on/turn_off/toggle>'.
static std::string cover_state_json_generator(WebServer *web_server, void *source)
static std::string lock_state_json_generator(WebServer *web_server, void *source)
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 std::string alarm_control_panel_all_json_generator(WebServer *web_server, void *source)
static std::string number_state_json_generator(WebServer *web_server, void *source)
void handle_time_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a time request under '/time/<id>'.
void on_sensor_update(sensor::Sensor *obj) override
std::map< uint64_t, SortingGroup > sorting_groups_
void set_css_include(const char *css_include)
Set local path to the script that's embedded in the index page.
static std::string valve_state_json_generator(WebServer *web_server, void *source)
bool canHandle(AsyncWebServerRequest *request) const override
Override the web handler's canHandle method.
std::string lock_json(lock::Lock *obj, lock::LockState value, JsonDetail start_config)
Dump the lock state with its value as a JSON string.
void on_event(event::Event *obj) override
void handle_pna_cors_request(AsyncWebServerRequest *request)
std::string fan_json(fan::Fan *obj, JsonDetail start_config)
Dump the fan state as a JSON string.
void on_fan_update(fan::Fan *obj) override
void parse_light_param_(AsyncWebServerRequest *request, const char *param_name, T &call, Ret(T::*setter)(float), float scale=1.0f)
void handle_datetime_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a datetime request under '/datetime/<id>'.
void parse_string_param_(AsyncWebServerRequest *request, const char *param_name, T &call, Ret(T::*setter)(const std::string &))
void parse_float_param_(AsyncWebServerRequest *request, const char *param_name, T &call, Ret(T::*setter)(float))
void handle_alarm_control_panel_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a alarm_control_panel request under '/alarm_control_panel/<id>'.
static std::string time_state_json_generator(WebServer *web_server, void *source)
void on_lock_update(lock::Lock *obj) override
static std::string button_all_json_generator(WebServer *web_server, void *source)
static std::string select_state_json_generator(WebServer *web_server, void *source)
float get_setup_priority() const override
MQTT setup priority.
void parse_int_param_(AsyncWebServerRequest *request, const char *param_name, T &call, Ret(T::*setter)(int))
void on_select_update(select::Select *obj) override
void on_time_update(datetime::TimeEntity *obj) override
static std::string update_all_json_generator(WebServer *web_server, void *source)
void handle_update_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a update request under '/update/<id>'.
std::string climate_json(climate::Climate *obj, JsonDetail start_config)
Dump the climate details.
static std::string fan_all_json_generator(WebServer *web_server, void *source)
static std::string switch_all_json_generator(WebServer *web_server, void *source)
static std::string time_all_json_generator(WebServer *web_server, void *source)
void add_sorting_group(uint64_t group_id, const std::string &group_name, float weight)
static std::string select_all_json_generator(WebServer *web_server, void *source)
const char * css_include_
static std::string datetime_state_json_generator(WebServer *web_server, void *source)
void handle_climate_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a climate request under '/climate/<id>'.
std::string alarm_control_panel_json(alarm_control_panel::AlarmControlPanel *obj, alarm_control_panel::AlarmControlPanelState value, JsonDetail start_config)
Dump the alarm_control_panel state with its value as a JSON string.
void on_text_sensor_update(text_sensor::TextSensor *obj) override
void add_handler(AsyncWebHandler *handler)
uint16_t get_port() const
ClimateSwingMode swing_mode
@ CLIMATE_SUPPORTS_TWO_POINT_TARGET_TEMPERATURE
@ CLIMATE_SUPPORTS_CURRENT_TEMPERATURE
@ CLIMATE_SUPPORTS_ACTION
@ CLIMATE_REQUIRES_TWO_POINT_TARGET_TEMPERATURE
const LogString * climate_swing_mode_to_string(ClimateSwingMode swing_mode)
Convert the given ClimateSwingMode to a human-readable string.
const LogString * climate_preset_to_string(ClimatePreset preset)
Convert the given PresetMode to a human-readable string.
ClimatePreset
Enum for all preset modes NOTE: If adding values, update ClimatePresetMask in climate_traits....
const LogString * climate_fan_mode_to_string(ClimateFanMode fan_mode)
Convert the given ClimateFanMode to a human-readable string.
ClimateMode
Enum for all modes a climate device can be in.
const LogString * climate_mode_to_string(ClimateMode mode)
Convert the given ClimateMode to a human-readable string.
ClimateFanMode
NOTE: If adding values, update ClimateFanModeMask in climate_traits.h to use the new last value.
const char * cover_operation_to_str(CoverOperation op)
LockState
Enum for all states a lock can be in.
const char * lock_state_to_string(LockState state)
const char * get_use_address()
Get the active network hostname.
@ UPDATE_STATE_INSTALLING
const char * valve_operation_to_str(ValveOperation op)
std::string(WebServer *, void *) message_generator_t
Providing packet encoding functions for exchanging data with a remote host.
std::string value_accuracy_to_string(float value, int8_t accuracy_decimals)
Create a string from a value and an accuracy in decimals.
ParseOnOffState parse_on_off(const char *str, const char *on, const char *off)
Parse a string that contains either on, off or toggle.
std::string value_accuracy_with_uom_to_string(float value, int8_t accuracy_decimals, StringRef unit_of_measurement)
Create a string from a value, an accuracy in decimals, and a unit of measurement.
std::string get_mac_address_pretty()
Get the device MAC address as a string, in colon-separated uppercase hex notation.
int8_t step_to_accuracy_decimals(float step)
Derive accuracy in decimals from an increment step.
std::string str_sprintf(const char *fmt,...)
uint32_t IRAM_ATTR HOT millis()
Application App
Global storage of Application pointer - only one Application can exist.
std::string current_version
std::string latest_version
Internal helper struct that is used to parse incoming URLs.
const char * domain
Pointer to domain within URL, for example "sensor".
bool valid
Whether this match is valid.
bool id_equals_entity(EntityBase *entity) const
bool method_empty() const
bool domain_equals(const char *str) const
bool method_equals(const char *str) const
friend class DeferredUpdateEventSource
const size_t ESPHOME_WEBSERVER_INDEX_HTML_SIZE
const size_t ESPHOME_WEBSERVER_CSS_INCLUDE_SIZE
const size_t ESPHOME_WEBSERVER_JS_INCLUDE_SIZE