12 #include "StreamString.h" 29 #ifdef USE_WEBSERVER_LOCAL 30 #if USE_WEBSERVER_VERSION == 2 32 #elif USE_WEBSERVER_VERSION == 3 38 namespace web_server {
40 static const char *
const TAG =
"web_server";
42 #ifdef USE_WEBSERVER_PRIVATE_NETWORK_ACCESS 43 static const char *
const HEADER_PNA_NAME =
"Private-Network-Access-Name";
44 static const char *
const HEADER_PNA_ID =
"Private-Network-Access-ID";
45 static const char *
const HEADER_CORS_REQ_PNA =
"Access-Control-Request-Private-Network";
46 static const char *
const HEADER_CORS_ALLOW_PNA =
"Access-Control-Allow-Private-Network";
52 size_t domain_end = url.find(
'/', 1);
53 if (domain_end == std::string::npos)
55 match.
domain = url.substr(1, domain_end - 1);
60 if (url.length() == domain_end - 1)
62 size_t id_begin = domain_end + 1;
63 size_t id_end = url.find(
'/', id_begin);
65 if (id_end == std::string::npos) {
66 match.
id = url.substr(id_begin, url.length() - id_begin);
69 match.
id = url.substr(id_begin, id_end - id_begin);
70 size_t method_begin = id_end + 1;
71 match.
method = url.substr(method_begin, url.length() - method_begin);
82 #ifdef USE_WEBSERVER_CSS_INCLUDE 85 #ifdef USE_WEBSERVER_JS_INCLUDE 100 ESP_LOGCONFIG(TAG,
"Setting up web server...");
114 [
this](
int level,
const char *tag,
const char *message) { this->
events_.send(message,
"log",
millis()); });
128 std::function<void()> fn;
145 ESP_LOGCONFIG(TAG,
"Web Server:");
150 #ifdef USE_WEBSERVER_LOCAL 152 AsyncWebServerResponse *response = request->beginResponse_P(200,
"text/html", INDEX_GZ,
sizeof(INDEX_GZ));
153 response->addHeader(
"Content-Encoding",
"gzip");
154 request->send(response);
156 #elif USE_WEBSERVER_VERSION >= 2 158 AsyncWebServerResponse *response =
161 request->send(response);
165 #ifdef USE_WEBSERVER_PRIVATE_NETWORK_ACCESS 167 AsyncWebServerResponse *response = request->beginResponse(200,
"");
168 response->addHeader(HEADER_CORS_ALLOW_PNA,
"true");
169 response->addHeader(HEADER_PNA_NAME,
App.
get_name().c_str());
171 response->addHeader(HEADER_PNA_ID, mac.c_str());
172 request->send(response);
176 #ifdef USE_WEBSERVER_CSS_INCLUDE 178 AsyncWebServerResponse *response =
180 response->addHeader(
"Content-Encoding",
"gzip");
181 request->send(response);
185 #ifdef USE_WEBSERVER_JS_INCLUDE 187 AsyncWebServerResponse *response =
189 response->addHeader(
"Content-Encoding",
"gzip");
190 request->send(response);
194 #define set_json_id(root, obj, sensor, start_config) \ 195 (root)["id"] = sensor; \ 196 if (((start_config) == DETAIL_ALL)) { \ 197 (root)["name"] = (obj)->get_name(); \ 198 (root)["icon"] = (obj)->get_icon(); \ 199 (root)["entity_category"] = (obj)->get_entity_category(); \ 200 if ((obj)->is_disabled_by_default()) \ 201 (root)["is_disabled_by_default"] = (obj)->is_disabled_by_default(); \ 204 #define set_json_value(root, obj, sensor, value, start_config) \ 205 set_json_id((root), (obj), sensor, start_config); \ 206 (root)["value"] = value; 208 #define set_json_icon_state_value(root, obj, sensor, state, value, start_config) \ 209 set_json_value(root, obj, sensor, value, start_config); \ 210 (root)["state"] = state; 214 if (this->
events_.count() == 0)
220 if (obj->get_object_id() != match.
id)
223 request->send(200,
"application/json", data.c_str());
231 if (std::isnan(value)) {
238 set_json_icon_state_value(root, obj,
"sensor-" + obj->
get_object_id(),
state, value, start_config);
250 #ifdef USE_TEXT_SENSOR 252 if (this->
events_.count() == 0)
258 if (obj->get_object_id() != match.
id)
261 request->send(200,
"application/json", data.c_str());
269 set_json_icon_state_value(root, obj,
"text_sensor-" + obj->
get_object_id(), value, value, start_config);
281 if (this->
events_.count() == 0)
287 if (obj->get_object_id() != match.
id)
290 if (request->method() == HTTP_GET && match.
method.empty()) {
292 request->send(200,
"application/json", data.c_str());
293 }
else if (match.
method ==
"toggle") {
294 this->
schedule_([obj]() { obj->toggle(); });
296 }
else if (match.
method ==
"turn_on") {
297 this->
schedule_([obj]() { obj->turn_on(); });
299 }
else if (match.
method ==
"turn_off") {
300 this->
schedule_([obj]() { obj->turn_off(); });
311 set_json_icon_state_value(root, obj,
"switch-" + obj->
get_object_id(), value ?
"ON" :
"OFF", value, start_config);
325 if (obj->get_object_id() != match.
id)
327 if (match.
method ==
"press") {
328 this->
schedule_([obj]() { obj->press(); });
340 set_json_id(root, obj,
"button-" + obj->
get_object_id(), start_config);
350 #ifdef USE_BINARY_SENSOR 352 if (this->
events_.count() == 0)
358 if (obj->get_object_id() != match.
id)
361 request->send(200,
"application/json", data.c_str());
368 set_json_icon_state_value(root, obj,
"binary_sensor-" + obj->
get_object_id(), value ?
"ON" :
"OFF", value,
381 if (this->
events_.count() == 0)
387 if (obj->get_object_id() != match.
id)
390 if (request->method() == HTTP_GET && match.
method.empty()) {
392 request->send(200,
"application/json", data.c_str());
393 }
else if (match.
method ==
"toggle") {
394 this->
schedule_([obj]() { obj->toggle().perform(); });
396 }
else if (match.
method ==
"turn_on") {
397 auto call = obj->turn_on();
398 if (request->hasParam(
"speed_level")) {
399 auto speed_level = request->getParam(
"speed_level")->value();
400 auto val = parse_number<int>(speed_level.c_str());
401 if (!
val.has_value()) {
402 ESP_LOGW(TAG,
"Can't convert '%s' to number!", speed_level.c_str());
407 if (request->hasParam(
"oscillation")) {
408 auto speed = request->getParam(
"oscillation")->value();
412 call.set_oscillating(
true);
415 call.set_oscillating(
false);
418 call.set_oscillating(!obj->oscillating);
427 }
else if (match.
method ==
"turn_off") {
428 this->
schedule_([obj]() { obj->turn_off().perform(); });
442 if (traits.supports_speed()) {
443 root[
"speed_level"] = obj->
speed;
444 root[
"speed_count"] = traits.supported_speed_count();
459 if (this->
events_.count() == 0)
465 if (obj->get_object_id() != match.
id)
468 if (request->method() == HTTP_GET && match.
method.empty()) {
470 request->send(200,
"application/json", data.c_str());
471 }
else if (match.
method ==
"toggle") {
472 this->
schedule_([obj]() { obj->toggle().perform(); });
474 }
else if (match.
method ==
"turn_on") {
475 auto call = obj->turn_on();
476 if (request->hasParam(
"brightness")) {
477 auto brightness = parse_number<float>(request->getParam(
"brightness")->value().c_str());
478 if (brightness.has_value()) {
479 call.set_brightness(*brightness / 255.0f);
482 if (request->hasParam(
"r")) {
483 auto r = parse_number<float>(request->getParam(
"r")->value().c_str());
485 call.set_red(*r / 255.0f);
488 if (request->hasParam(
"g")) {
489 auto g = parse_number<float>(request->getParam(
"g")->value().c_str());
491 call.set_green(*g / 255.0f);
494 if (request->hasParam(
"b")) {
495 auto b = parse_number<float>(request->getParam(
"b")->value().c_str());
497 call.set_blue(*b / 255.0f);
500 if (request->hasParam(
"white_value")) {
501 auto white_value = parse_number<float>(request->getParam(
"white_value")->value().c_str());
502 if (white_value.has_value()) {
503 call.set_white(*white_value / 255.0f);
506 if (request->hasParam(
"color_temp")) {
507 auto color_temp = parse_number<float>(request->getParam(
"color_temp")->value().c_str());
508 if (color_temp.has_value()) {
509 call.set_color_temperature(*color_temp);
512 if (request->hasParam(
"flash")) {
513 auto flash = parse_number<uint32_t>(request->getParam(
"flash")->value().c_str());
514 if (flash.has_value()) {
515 call.set_flash_length(*flash * 1000);
518 if (request->hasParam(
"transition")) {
519 auto transition = parse_number<uint32_t>(request->getParam(
"transition")->value().c_str());
520 if (transition.has_value()) {
521 call.set_transition_length(*transition * 1000);
524 if (request->hasParam(
"effect")) {
525 const char *effect = request->getParam(
"effect")->value().c_str();
526 call.set_effect(effect);
531 }
else if (match.
method ==
"turn_off") {
532 auto call = obj->turn_off();
533 if (request->hasParam(
"transition")) {
534 auto transition = parse_number<uint32_t>(request->getParam(
"transition")->value().c_str());
535 if (transition.has_value()) {
536 call.set_transition_length(*transition * 1000);
550 set_json_id(root, obj,
"light-" + obj->
get_object_id(), start_config);
555 JsonArray opt = root.createNestedArray(
"effects");
558 opt.add(option->get_name());
570 if (this->
events_.count() == 0)
576 if (obj->get_object_id() != match.
id)
579 if (request->method() == HTTP_GET && match.
method.empty()) {
581 request->send(200,
"application/json", data.c_str());
585 auto call = obj->make_call();
586 if (match.
method ==
"open") {
587 call.set_command_open();
588 }
else if (match.
method ==
"close") {
589 call.set_command_close();
590 }
else if (match.
method ==
"stop") {
591 call.set_command_stop();
592 }
else if (match.
method ==
"toggle") {
593 call.set_command_toggle();
594 }
else if (match.
method !=
"set") {
599 auto traits = obj->get_traits();
600 if ((request->hasParam(
"position") && !traits.get_supports_position()) ||
601 (request->hasParam(
"tilt") && !traits.get_supports_tilt())) {
606 if (request->hasParam(
"position")) {
607 auto position = parse_number<float>(request->getParam(
"position")->value().c_str());
612 if (request->hasParam(
"tilt")) {
613 auto tilt = parse_number<float>(request->getParam(
"tilt")->value().c_str());
614 if (
tilt.has_value()) {
634 root[
"tilt"] = obj->
tilt;
646 if (this->
events_.count() == 0)
652 if (obj->get_object_id() != match.
id)
655 if (request->method() == HTTP_GET && match.
method.empty()) {
657 request->send(200,
"application/json", data.c_str());
660 if (match.
method !=
"set") {
665 auto call = obj->make_call();
666 if (request->hasParam(
"value")) {
667 auto value = parse_number<float>(request->getParam(
"value")->value().c_str());
668 if (value.has_value())
669 call.set_value(*value);
681 set_json_id(root, obj,
"number-" + obj->
get_object_id(), start_config);
696 if (std::isnan(value)) {
697 root[
"value"] =
"\"NaN\"";
698 root[
"state"] =
"NA";
704 root[
"state"] =
state;
710 #ifdef USE_DATETIME_DATE 712 if (this->
events_.count() == 0)
718 if (obj->get_object_id() != match.
id)
720 if (request->method() == HTTP_GET) {
722 request->send(200,
"application/json", data.c_str());
725 if (match.
method !=
"set") {
730 auto call = obj->make_call();
732 if (!request->hasParam(
"value")) {
737 if (request->hasParam(
"value")) {
738 std::string value = request->getParam(
"value")->value().c_str();
739 call.set_date(value);
751 set_json_id(root, obj,
"date-" + obj->
get_object_id(), start_config);
753 root[
"value"] = value;
754 root[
"state"] = value;
762 #endif // USE_DATETIME_DATE 764 #ifdef USE_DATETIME_TIME 766 if (this->
events_.count() == 0)
772 if (obj->get_object_id() != match.
id)
774 if (request->method() == HTTP_GET && match.
method.empty()) {
776 request->send(200,
"application/json", data.c_str());
779 if (match.
method !=
"set") {
784 auto call = obj->make_call();
786 if (!request->hasParam(
"value")) {
791 if (request->hasParam(
"value")) {
792 std::string value = request->getParam(
"value")->value().c_str();
793 call.set_time(value);
804 set_json_id(root, obj,
"time-" + obj->
get_object_id(), start_config);
806 root[
"value"] = value;
807 root[
"state"] = value;
815 #endif // USE_DATETIME_TIME 817 #ifdef USE_DATETIME_DATETIME 819 if (this->
events_.count() == 0)
825 if (obj->get_object_id() != match.
id)
827 if (request->method() == HTTP_GET && match.
method.empty()) {
829 request->send(200,
"application/json", data.c_str());
832 if (match.
method !=
"set") {
837 auto call = obj->make_call();
839 if (!request->hasParam(
"value")) {
844 if (request->hasParam(
"value")) {
845 std::string value = request->getParam(
"value")->value().c_str();
846 call.set_datetime(value);
857 set_json_id(root, obj,
"datetime-" + obj->
get_object_id(), start_config);
860 root[
"value"] = value;
861 root[
"state"] = value;
869 #endif // USE_DATETIME_DATETIME 873 if (this->
events_.count() == 0)
879 if (obj->get_object_id() != match.
id)
882 if (request->method() == HTTP_GET && match.
method.empty()) {
884 request->send(200,
"text/json", data.c_str());
887 if (match.
method !=
"set") {
892 auto call = obj->make_call();
893 if (request->hasParam(
"value")) {
894 String value = request->getParam(
"value")->value();
895 call.set_value(value.c_str());
907 set_json_id(root, obj,
"text-" + obj->
get_object_id(), start_config);
912 root[
"state"] =
"********";
914 root[
"state"] = value;
916 root[
"value"] = value;
929 if (this->
events_.count() == 0)
935 if (obj->get_object_id() != match.
id)
938 if (request->method() == HTTP_GET && match.
method.empty()) {
940 auto *param = request->getParam(
"detail");
941 if (param && param->value() ==
"all") {
944 std::string data = this->
select_json(obj, obj->state, detail);
945 request->send(200,
"application/json", data.c_str());
949 if (match.
method !=
"set") {
954 auto call = obj->make_call();
956 if (request->hasParam(
"option")) {
957 auto option = request->getParam(
"option")->value();
958 call.set_option(option.c_str());
969 set_json_icon_state_value(root, obj,
"select-" + obj->
get_object_id(), value, value, start_config);
971 JsonArray opt = root.createNestedArray(
"option");
984 #define PSTR_LOCAL(mode_s) strncpy_P(buf, (PGM_P) ((mode_s)), 15) 988 if (this->
events_.count() == 0)
994 if (obj->get_object_id() != match.
id)
997 if (request->method() == HTTP_GET && match.
method.empty()) {
999 request->send(200,
"application/json", data.c_str());
1003 if (match.
method !=
"set") {
1008 auto call = obj->make_call();
1010 if (request->hasParam(
"mode")) {
1011 auto mode = request->getParam(
"mode")->value();
1015 if (request->hasParam(
"target_temperature_high")) {
1016 auto target_temperature_high = parse_number<float>(request->getParam(
"target_temperature_high")->value().c_str());
1021 if (request->hasParam(
"target_temperature_low")) {
1022 auto target_temperature_low = parse_number<float>(request->getParam(
"target_temperature_low")->value().c_str());
1027 if (request->hasParam(
"target_temperature")) {
1028 auto target_temperature = parse_number<float>(request->getParam(
"target_temperature")->value().c_str());
1041 set_json_id(root, obj,
"climate-" + obj->
get_object_id(), start_config);
1044 int8_t current_accuracy = traits.get_current_temperature_accuracy_decimals();
1048 JsonArray opt = root.createNestedArray(
"modes");
1051 if (!traits.get_supported_custom_fan_modes().empty()) {
1052 JsonArray opt = root.createNestedArray(
"fan_modes");
1057 if (!traits.get_supported_custom_fan_modes().empty()) {
1058 JsonArray opt = root.createNestedArray(
"custom_fan_modes");
1059 for (
auto const &
custom_fan_mode : traits.get_supported_custom_fan_modes())
1062 if (traits.get_supports_swing_modes()) {
1063 JsonArray opt = root.createNestedArray(
"swing_modes");
1064 for (
auto swing_mode : traits.get_supported_swing_modes())
1068 JsonArray opt = root.createNestedArray(
"presets");
1073 JsonArray opt = root.createNestedArray(
"custom_presets");
1074 for (
auto const &
custom_preset : traits.get_supported_custom_presets())
1082 bool has_state =
false;
1086 root[
"step"] = traits.get_visual_target_temperature_step();
1087 if (traits.get_supports_action()) {
1089 root[
"state"] = root[
"action"];
1104 if (traits.get_supports_swing_modes()) {
1107 if (traits.get_supports_current_temperature()) {
1111 root[
"current_temperature"] =
"NA";
1114 if (traits.get_supports_two_point_target_temperature()) {
1124 root[
"state"] = root[
"target_temperature"];
1132 if (this->
events_.count() == 0)
1138 if (obj->get_object_id() != match.
id)
1141 if (request->method() == HTTP_GET && match.
method.empty()) {
1143 request->send(200,
"application/json", data.c_str());
1144 }
else if (match.
method ==
"lock") {
1145 this->
schedule_([obj]() { obj->lock(); });
1147 }
else if (match.
method ==
"unlock") {
1148 this->
schedule_([obj]() { obj->unlock(); });
1150 }
else if (match.
method ==
"open") {
1151 this->
schedule_([obj]() { obj->open(); });
1161 return json::build_json([
this, obj, value, start_config](JsonObject root) {
1175 if (this->
events_.count() == 0)
1181 if (obj->get_object_id() != match.
id)
1184 if (request->method() == HTTP_GET && match.
method.empty()) {
1186 request->send(200,
"application/json", data.c_str());
1190 auto call = obj->make_call();
1191 if (match.
method ==
"open") {
1192 call.set_command_open();
1193 }
else if (match.
method ==
"close") {
1194 call.set_command_close();
1195 }
else if (match.
method ==
"stop") {
1196 call.set_command_stop();
1197 }
else if (match.
method ==
"toggle") {
1198 call.set_command_toggle();
1199 }
else if (match.
method !=
"set") {
1204 auto traits = obj->get_traits();
1205 if (request->hasParam(
"position") && !traits.get_supports_position()) {
1210 if (request->hasParam(
"position")) {
1211 auto position = parse_number<float>(request->getParam(
"position")->value().c_str());
1238 #ifdef USE_ALARM_CONTROL_PANEL 1240 if (this->
events_.count() == 0)
1246 if (obj->get_object_id() != match.
id)
1249 if (request->method() == HTTP_GET && match.
method.empty()) {
1251 request->send(200,
"application/json", data.c_str());
1260 return json::build_json([
this, obj, value, start_config](JsonObject root) {
1262 set_json_icon_state_value(root, obj,
"alarm-control-panel-" + obj->
get_object_id(),
1280 set_json_id(root, obj,
"event-" + obj->
get_object_id(), start_config);
1281 if (!event_type.empty()) {
1282 root[
"event_type"] = event_type;
1285 JsonArray event_types = root.createNestedArray(
"event_types");
1287 event_types.add(event_type);
1297 if (this->
events_.count() == 0)
1303 if (obj->get_object_id() != match.
id)
1306 if (request->method() == HTTP_GET && match.
method.empty()) {
1308 request->send(200,
"application/json", data.c_str());
1312 if (match.
method !=
"install") {
1317 this->
schedule_([obj]()
mutable { obj->perform(); });
1325 set_json_id(root, obj,
"update-" + obj->
get_object_id(), start_config);
1327 switch (obj->
state) {
1329 root[
"state"] =
"NO UPDATE";
1332 root[
"state"] =
"UPDATE AVAILABLE";
1335 root[
"state"] =
"INSTALLING";
1338 root[
"state"] =
"UNKNOWN";
1355 if (request->url() ==
"/")
1358 #ifdef USE_WEBSERVER_CSS_INCLUDE 1359 if (request->url() ==
"/0.css")
1363 #ifdef USE_WEBSERVER_JS_INCLUDE 1364 if (request->url() ==
"/0.js")
1368 #ifdef USE_WEBSERVER_PRIVATE_NETWORK_ACCESS 1369 if (request->method() == HTTP_OPTIONS && request->hasHeader(HEADER_CORS_REQ_PNA)) {
1374 request->addInterestingHeader(HEADER_CORS_REQ_PNA);
1384 if (request->method() == HTTP_GET && match.
domain ==
"sensor")
1389 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"switch")
1394 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"button")
1398 #ifdef USE_BINARY_SENSOR 1399 if (request->method() == HTTP_GET && match.
domain ==
"binary_sensor")
1404 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"fan")
1409 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"light")
1413 #ifdef USE_TEXT_SENSOR 1414 if (request->method() == HTTP_GET && match.
domain ==
"text_sensor")
1419 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"cover")
1424 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"number")
1428 #ifdef USE_DATETIME_DATE 1429 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"date")
1433 #ifdef USE_DATETIME_TIME 1434 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"time")
1438 #ifdef USE_DATETIME_DATETIME 1439 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"datetime")
1444 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"text")
1449 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"select")
1454 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"climate")
1459 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"lock")
1464 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"valve")
1468 #ifdef USE_ALARM_CONTROL_PANEL 1469 if (request->method() == HTTP_GET && match.
domain ==
"alarm_control_panel")
1474 if ((request->method() == HTTP_POST || request->method() == HTTP_GET) && match.
domain ==
"update")
1481 if (request->url() ==
"/") {
1486 #ifdef USE_WEBSERVER_CSS_INCLUDE 1487 if (request->url() ==
"/0.css") {
1493 #ifdef USE_WEBSERVER_JS_INCLUDE 1494 if (request->url() ==
"/0.js") {
1500 #ifdef USE_WEBSERVER_PRIVATE_NETWORK_ACCESS 1501 if (request->method() == HTTP_OPTIONS && request->hasHeader(HEADER_CORS_REQ_PNA)) {
1509 if (match.
domain ==
"sensor") {
1516 if (match.
domain ==
"switch") {
1523 if (match.
domain ==
"button") {
1529 #ifdef USE_BINARY_SENSOR 1530 if (match.
domain ==
"binary_sensor") {
1537 if (match.
domain ==
"fan") {
1544 if (match.
domain ==
"light") {
1550 #ifdef USE_TEXT_SENSOR 1551 if (match.
domain ==
"text_sensor") {
1558 if (match.
domain ==
"cover") {
1565 if (match.
domain ==
"number") {
1571 #ifdef USE_DATETIME_DATE 1572 if (match.
domain ==
"date") {
1578 #ifdef USE_DATETIME_TIME 1579 if (match.
domain ==
"time") {
1585 #ifdef USE_DATETIME_DATETIME 1586 if (match.
domain ==
"datetime") {
1593 if (match.
domain ==
"text") {
1600 if (match.
domain ==
"select") {
1607 if (match.
domain ==
"climate") {
1614 if (match.
domain ==
"lock") {
1622 if (match.
domain ==
"valve") {
1628 #ifdef USE_ALARM_CONTROL_PANEL 1629 if (match.
domain ==
"alarm_control_panel") {
1637 if (match.
domain ==
"update") {
1656 this->
defer(std::move(f));
Base class for all switches.
value_type const & value() const
bool state
The current on/off state of the fan.
const size_t ESPHOME_WEBSERVER_CSS_INCLUDE_SIZE
ClimateSwingMode swing_mode
The active swing mode of the climate device.
float target_temperature_low
const std::vector< datetime::DateTimeEntity * > & get_datetimes()
void handle_pna_cors_request(AsyncWebServerRequest *request)
AlarmControlPanelState get_state() const
Get the state.
void handle_number_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a number request under '/number/<id>'.
This class represents the communication layer between the front-end MQTT layer and the hardware outpu...
bool oscillating
The current oscillation state of the fan.
void set_interval(const std::string &name, uint32_t interval, std::function< void()> &&f)
Set an interval function with a unique name.
std::string number_json(number::Number *obj, float value, JsonDetail start_config)
Dump the number state with its value as a JSON string.
std::string sensor_json(sensor::Sensor *obj, float value, JsonDetail start_config)
Dump the sensor state with its value as a JSON string.
void add_on_log_callback(std::function< void(int, const char *, const char *)> &&callback)
Register a callback that will be called for every log message sent.
void on_sensor_update(sensor::Sensor *obj, float state) override
bool is_on() const
Get the binary true/false state of these light color values.
Base class for all cover devices.
std::string value_accuracy_to_string(float value, int8_t accuracy_decimals)
Create a string from a value and an accuracy in decimals.
WebServer(web_server_base::WebServerBase *base)
void handleRequest(AsyncWebServerRequest *request) override
Override the web handler's handleRequest method.
TextMode get_mode() const
ClimatePreset
Enum for all preset modes.
void handle_time_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a time request under '/time/<id>'.
const std::vector< climate::Climate * > & get_climates()
float target_temperature
The target temperature of the climate device.
SemaphoreHandle_t to_schedule_lock_
std::string get_use_address()
Get the active network hostname.
void handle_binary_sensor_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a binary sensor request under '/binary_sensor/<id>'.
std::string select_json(select::Select *obj, const std::string &value, JsonDetail start_config)
Dump the select state with its value as a JSON string.
LockState state
The current reported state of the lock.
std::string get_device_class()
Get the device class, using the manual override if set.
const std::vector< update::UpdateEntity * > & get_updates()
const std::vector< alarm_control_panel::AlarmControlPanel * > & get_alarm_control_panels()
bool is_fully_closed() const
Helper method to check if the valve is fully closed. Equivalent to comparing .position against 0...
const char * lock_state_to_string(LockState state)
void handle_select_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a select request under '/select/<id>'.
const std::vector< valve::Valve * > & get_valves()
void handle_text_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a text input request under '/text/<id>'.
CoverOperation current_operation
The current operation of the cover (idle, opening, closing).
std::map< EntityBase *, SortingComponents > sorting_entitys_
float position
The position of the valve from 0.0 (fully closed) to 1.0 (fully open).
void handle_update_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a update request under '/update/<id>'.
const LogString * climate_mode_to_string(ClimateMode mode)
Convert the given ClimateMode to a human-readable string.
virtual FanTraits get_traits()=0
std::set< std::string > get_event_types() const
void handle_valve_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a valve request under '/valve/<id>/<open/close/stop/set>'.
const UpdateState & state
void defer(const std::string &name, std::function< void()> &&f)
Defer a callback to the next loop() call.
bool get_supports_position() const
ClimateMode mode
The active mode of the climate device.
void on_lock_update(lock::Lock *obj) override
virtual bool assumed_state()
Return whether this switch uses an assumed state - i.e.
std::string latest_version
std::string current_version
const std::string & get_friendly_name() const
Get the friendly name of this Application set by pre_setup().
void setup() override
Setup the internal web server and register handlers.
float target_temperature_high
The maximum target temperature of the climate device, for climate devices with split target temperatu...
float current_temperature
The current temperature of the climate device, as reported from the integration.
const std::vector< fan::Fan * > & get_fans()
void on_binary_sensor_update(binary_sensor::BinarySensor *obj, bool state) override
void handle_light_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a light request under '/light/<id>/</turn_on/turn_off/toggle>'.
bool isRequestHandlerTrivial() override
This web handle is not trivial.
void handle_lock_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a lock request under '/lock/<id>/</lock/unlock/open>'.
float target_temperature_high
void handle_button_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a button request under '/button/<id>/press'.
int get_max_length() const
Base-class for all text inputs.
bool supports_oscillation() const
Return if this fan supports oscillation.
void on_light_update(light::LightState *obj) override
virtual ValveTraits get_traits()=0
void on_event(event::Event *obj, const std::string &event_type) override
float tilt
The current tilt value of the cover from 0.0 to 1.0.
const std::vector< datetime::TimeEntity * > & get_times()
std::string get_object_id() const
uint32_t IRAM_ATTR HOT millis()
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.
ParseOnOffState parse_on_off(const char *str, const char *on, const char *off)
Parse a string that contains either on, off or toggle.
ClimateSwingMode swing_mode
const size_t ESPHOME_WEBSERVER_JS_INCLUDE_SIZE
Internal helper struct that is used to parse incoming URLs.
optional< std::string > custom_fan_mode
The active custom fan mode of the climate device.
virtual CoverTraits get_traits()=0
void handle_sensor_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a sensor request under '/sensor/<id>'.
const std::vector< lock::Lock * > & get_locks()
uint16_t get_port() const
void dump_config() override
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.
const size_t ESPHOME_WEBSERVER_INDEX_HTML_SIZE
std::string domain
The domain of the component, for example "sensor".
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.
std::string update_json(update::UpdateEntity *obj, JsonDetail start_config)
Dump the update state with its value as a JSON string.
void on_text_sensor_update(text_sensor::TextSensor *obj, const std::string &state) override
void add_handler(AsyncWebHandler *handler)
void set_css_include(const char *css_include)
Set local path to the script that's embedded in the index page.
void on_text_update(text::Text *obj, const std::string &state) override
const std::vector< button::Button * > & get_buttons()
void handle_switch_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a switch request under '/switch/<id>/</turn_on/turn_off/toggle>'.
const LogString * alarm_control_panel_state_to_string(AlarmControlPanelState state)
Returns a string representation of the state.
std::vector< std::string > get_options() const
optional< ClimatePreset > preset
The active preset of the climate device.
const UpdateInfo & update_info
UrlMatch match_url(const std::string &url, bool only_domain=false)
const std::vector< switch_::Switch * > & get_switches()
Base-class for all numbers.
std::string str_sprintf(const char *fmt,...)
const char * cover_operation_to_str(CoverOperation op)
int speed
The current fan speed level.
void handle_alarm_control_panel_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a alarm_control_panel request under '/alarm_control_panel/<id>'.
void handle_css_request(AsyncWebServerRequest *request)
Handle included css request under '/0.css'.
bool valid
Whether this match is valid.
BedjetMode mode
BedJet operating mode.
bool is_fully_closed() const
Helper method to check if the cover is fully closed. Equivalent to comparing .position against 0...
void on_select_update(select::Select *obj, const std::string &state, size_t index) override
ClimateTraits get_traits()
Get the traits of this climate device with all overrides applied.
std::string get_unit_of_measurement()
Get the unit of measurement, using the manual override if set.
std::string time_json(datetime::TimeEntity *obj, JsonDetail start_config)
Dump the time state with its value as a JSON string.
const std::vector< text_sensor::TextSensor * > & get_text_sensors()
const LogString * climate_preset_to_string(ClimatePreset preset)
Convert the given PresetMode to a human-readable string.
int8_t get_target_temperature_accuracy_decimals() const
const std::vector< sensor::Sensor * > & get_sensors()
Application App
Global storage of Application pointer - only one Application can exist.
const std::vector< binary_sensor::BinarySensor * > & get_binary_sensors()
const std::vector< LightEffect * > & get_effects() const
Get all effects for this light state.
void handle_datetime_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a datetime request under '/datetime/<id>'.
bool get_supports_position() const
int8_t step_to_accuracy_decimals(float step)
Derive accuracy in decimals from an increment step.
std::string switch_json(switch_::Switch *obj, bool value, JsonDetail start_config)
Dump the switch state with its value as a JSON string.
std::string build_json(const json_build_t &f)
Build a JSON string with the provided json build function.
void begin(bool include_internal=false)
const std::string & get_name() const
Get the name of this Application set by pre_setup().
void add_entity_to_sorting_list(EntityBase *entity, float weight)
std::string light_json(light::LightState *obj, JsonDetail start_config)
Dump the light state as a JSON string.
void on_valve_update(valve::Valve *obj) override
static void dump_json(LightState &state, JsonObject root)
Dump the state of a light as JSON.
const std::vector< text::Text * > & get_texts()
ClimateMode
Enum for all modes a climate device can be in.
void handle_index_request(AsyncWebServerRequest *request)
Handle an index request under '/'.
std::string valve_json(valve::Valve *obj, JsonDetail start_config)
Dump the valve state as a JSON string.
void on_time_update(datetime::TimeEntity *obj) override
void on_climate_update(climate::Climate *obj) override
const std::vector< cover::Cover * > & get_covers()
float get_setup_priority() const override
MQTT setup priority.
optional< std::string > custom_preset
The active custom preset mode of the climate device.
const LogString * climate_fan_mode_to_string(ClimateFanMode fan_mode)
Convert the given ClimateFanMode to a human-readable string.
optional< ClimateFanMode > fan_mode
The active fan mode of the climate device.
float position
The position of the cover from 0.0 (fully closed) to 1.0 (fully open).
void handle_fan_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a fan request under '/fan/<id>/</turn_on/turn_off/toggle>'.
std::string id
The id of the device that's being accessed, for example "living_room_fan".
const std::vector< light::LightState * > & get_lights()
void on_date_update(datetime::DateEntity *obj) override
std::string get_comment() const
Get the comment of this Application set by pre_setup().
std::string button_json(button::Button *obj, JsonDetail start_config)
Dump the button details with its value as a JSON string.
void on_cover_update(cover::Cover *obj) override
const char * valve_operation_to_str(ValveOperation op)
void handle_cover_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a cover request under '/cover/<id>/<open/close/stop/set>'.
void on_switch_update(switch_::Switch *obj, bool state) override
const char * css_include_
bool get_supports_tilt() const
void on_alarm_control_panel_update(alarm_control_panel::AlarmControlPanel *obj) override
void setup_controller(bool include_internal=false)
void on_datetime_update(datetime::DateTimeEntity *obj) override
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::string datetime_json(datetime::DateTimeEntity *obj, JsonDetail start_config)
Dump the datetime state with its value as a JSON string.
Base-class for all selects.
void on_fan_update(fan::Fan *obj) override
web_server_base::WebServerBase * base_
Implementation of SPI Controller mode.
float get_min_value() const
void on_number_update(number::Number *obj, float state) override
Base class for all valve devices.
std::string fan_json(fan::Fan *obj, JsonDetail start_config)
Dump the fan state as a JSON string.
ValveOperation current_operation
The current operation of the valve (idle, opening, closing).
Base class for all binary_sensor-type classes.
LightColorValues remote_values
The remote color values reported to the frontend.
LockState
Enum for all states a lock can be in.
NumberMode get_mode() const
void handle_climate_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a climate request under '/climate/<id>'.
int8_t get_accuracy_decimals()
Get the accuracy in decimals, using the manual override if set.
const std::vector< datetime::DateEntity * > & get_dates()
int get_min_length() const
const std::vector< select::Select * > & get_selects()
Base-class for all sensors.
std::string get_mac_address_pretty()
Get the device MAC address as a string, in colon-separated uppercase hex notation.
bool canHandle(AsyncWebServerRequest *request) override
Override the web handler's canHandle method.
AsyncEventSourceResponse AsyncEventSourceClient
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.
ListEntitiesIterator entities_iterator_
std::deque< std::function< void()> > to_schedule_
const std::vector< number::Number * > & get_numbers()
float get_max_value() const
const LogString * climate_action_to_string(ClimateAction action)
Convert the given ClimateAction to a human-readable string.
void on_update(update::UpdateEntity *obj) override
void handle_text_sensor_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a text sensor request under '/text_sensor/<id>'.
void schedule_(std::function< void()> &&f)
std::string lock_json(lock::Lock *obj, lock::LockState value, JsonDetail start_config)
Dump the lock state with its value as a JSON string.
std::string get_pattern() const
float target_temperature_low
The minimum target temperature of the climate device, for climate devices with split target temperatu...
std::string climate_json(climate::Climate *obj, JsonDetail start_config)
Dump the climate details.
std::string method
The method that's being called, for example "turn_on".
void handle_date_request(AsyncWebServerRequest *request, const UrlMatch &match)
Handle a date request under '/date/<id>'.
Base class for all locks.
ClimateAction action
The active state of the climate device.
ClimateDevice - This is the base class for all climate integrations.
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.
std::string cover_json(cover::Cover *obj, JsonDetail start_config)
Dump the cover state as a JSON string.
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.
const LogString * climate_swing_mode_to_string(ClimateSwingMode swing_mode)
Convert the given ClimateSwingMode to a human-readable string.