2023-09-01 04:02:26 +02:00
|
|
|
import gzip
|
2019-04-17 12:06:00 +02:00
|
|
|
import esphome.codegen as cg
|
|
|
|
|
import esphome.config_validation as cv
|
2019-06-09 17:03:51 +02:00
|
|
|
from esphome.components import web_server_base
|
|
|
|
|
from esphome.components.web_server_base import CONF_WEB_SERVER_BASE_ID
|
2019-10-13 14:27:44 +02:00
|
|
|
from esphome.const import (
|
2021-03-07 20:03:16 +01:00
|
|
|
CONF_CSS_INCLUDE,
|
|
|
|
|
CONF_CSS_URL,
|
|
|
|
|
CONF_ID,
|
|
|
|
|
CONF_JS_INCLUDE,
|
|
|
|
|
CONF_JS_URL,
|
|
|
|
|
CONF_PORT,
|
|
|
|
|
CONF_AUTH,
|
|
|
|
|
CONF_USERNAME,
|
|
|
|
|
CONF_PASSWORD,
|
2021-11-29 16:52:20 +01:00
|
|
|
CONF_INCLUDE_INTERNAL,
|
2021-11-10 20:31:22 +01:00
|
|
|
CONF_OTA,
|
2023-06-21 23:58:49 +02:00
|
|
|
CONF_LOG,
|
2022-03-08 03:02:24 +01:00
|
|
|
CONF_VERSION,
|
|
|
|
|
CONF_LOCAL,
|
2021-03-07 20:03:16 +01:00
|
|
|
)
|
2021-08-26 05:34:39 +02:00
|
|
|
from esphome.core import CORE, coroutine_with_priority
|
2019-04-17 12:06:00 +02:00
|
|
|
|
2021-03-07 20:03:16 +01:00
|
|
|
AUTO_LOAD = ["json", "web_server_base"]
|
2019-04-17 12:06:00 +02:00
|
|
|
|
2021-03-07 20:03:16 +01:00
|
|
|
web_server_ns = cg.esphome_ns.namespace("web_server")
|
|
|
|
|
WebServer = web_server_ns.class_("WebServer", cg.Component, cg.Controller)
|
2019-04-17 12:06:00 +02:00
|
|
|
|
2022-03-08 03:02:24 +01:00
|
|
|
|
|
|
|
|
def default_url(config):
|
|
|
|
|
config = config.copy()
|
|
|
|
|
if config[CONF_VERSION] == 1:
|
|
|
|
|
if not (CONF_CSS_URL in config):
|
|
|
|
|
config[CONF_CSS_URL] = "https://esphome.io/_static/webserver-v1.min.css"
|
|
|
|
|
if not (CONF_JS_URL in config):
|
|
|
|
|
config[CONF_JS_URL] = "https://esphome.io/_static/webserver-v1.min.js"
|
|
|
|
|
if config[CONF_VERSION] == 2:
|
|
|
|
|
if not (CONF_CSS_URL in config):
|
|
|
|
|
config[CONF_CSS_URL] = ""
|
|
|
|
|
if not (CONF_JS_URL in config):
|
|
|
|
|
config[CONF_JS_URL] = "https://oi.esphome.io/v2/www.js"
|
|
|
|
|
return config
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def validate_local(config):
|
|
|
|
|
if CONF_LOCAL in config and config[CONF_VERSION] == 1:
|
|
|
|
|
raise cv.Invalid("'local' is not supported in version 1")
|
|
|
|
|
return config
|
|
|
|
|
|
|
|
|
|
|
2023-07-12 02:08:03 +02:00
|
|
|
def validate_ota(config):
|
|
|
|
|
if CORE.using_esp_idf and config[CONF_OTA]:
|
|
|
|
|
raise cv.Invalid("Enabling 'ota' is not supported for IDF framework yet")
|
|
|
|
|
return config
|
|
|
|
|
|
|
|
|
|
|
2021-12-22 08:08:54 +01:00
|
|
|
CONFIG_SCHEMA = cv.All(
|
|
|
|
|
cv.Schema(
|
|
|
|
|
{
|
|
|
|
|
cv.GenerateID(): cv.declare_id(WebServer),
|
|
|
|
|
cv.Optional(CONF_PORT, default=80): cv.port,
|
2022-03-08 03:02:24 +01:00
|
|
|
cv.Optional(CONF_VERSION, default=2): cv.one_of(1, 2),
|
|
|
|
|
cv.Optional(CONF_CSS_URL): cv.string,
|
2021-12-22 08:08:54 +01:00
|
|
|
cv.Optional(CONF_CSS_INCLUDE): cv.file_,
|
2022-03-08 03:02:24 +01:00
|
|
|
cv.Optional(CONF_JS_URL): cv.string,
|
2021-12-22 08:08:54 +01:00
|
|
|
cv.Optional(CONF_JS_INCLUDE): cv.file_,
|
|
|
|
|
cv.Optional(CONF_AUTH): cv.Schema(
|
|
|
|
|
{
|
|
|
|
|
cv.Required(CONF_USERNAME): cv.All(
|
|
|
|
|
cv.string_strict, cv.Length(min=1)
|
|
|
|
|
),
|
|
|
|
|
cv.Required(CONF_PASSWORD): cv.All(
|
|
|
|
|
cv.string_strict, cv.Length(min=1)
|
|
|
|
|
),
|
|
|
|
|
}
|
|
|
|
|
),
|
|
|
|
|
cv.GenerateID(CONF_WEB_SERVER_BASE_ID): cv.use_id(
|
|
|
|
|
web_server_base.WebServerBase
|
|
|
|
|
),
|
|
|
|
|
cv.Optional(CONF_INCLUDE_INTERNAL, default=False): cv.boolean,
|
2023-07-12 02:08:03 +02:00
|
|
|
cv.SplitDefault(
|
2023-09-05 00:16:08 +02:00
|
|
|
CONF_OTA,
|
|
|
|
|
esp8266=True,
|
|
|
|
|
esp32_arduino=True,
|
|
|
|
|
esp32_idf=False,
|
|
|
|
|
bk72xx=True,
|
|
|
|
|
rtl87xx=True,
|
2023-07-12 02:08:03 +02:00
|
|
|
): cv.boolean,
|
2023-06-21 23:58:49 +02:00
|
|
|
cv.Optional(CONF_LOG, default=True): cv.boolean,
|
2022-03-08 03:02:24 +01:00
|
|
|
cv.Optional(CONF_LOCAL): cv.boolean,
|
|
|
|
|
}
|
2021-12-22 08:08:54 +01:00
|
|
|
).extend(cv.COMPONENT_SCHEMA),
|
2023-09-05 00:16:08 +02:00
|
|
|
cv.only_on(["esp32", "esp8266", "bk72xx", "rtl87xx"]),
|
2022-03-08 03:02:24 +01:00
|
|
|
default_url,
|
|
|
|
|
validate_local,
|
2023-07-12 02:08:03 +02:00
|
|
|
validate_ota,
|
2021-12-22 08:08:54 +01:00
|
|
|
)
|
2019-04-17 12:06:00 +02:00
|
|
|
|
|
|
|
|
|
2023-06-19 03:51:19 +02:00
|
|
|
def build_index_html(config) -> str:
|
|
|
|
|
html = "<!DOCTYPE html><html><head><meta charset=UTF-8><link rel=icon href=data:>"
|
|
|
|
|
css_include = config.get(CONF_CSS_INCLUDE)
|
|
|
|
|
js_include = config.get(CONF_JS_INCLUDE)
|
|
|
|
|
if css_include:
|
|
|
|
|
html += "<link rel=stylesheet href=/0.css>"
|
|
|
|
|
if config[CONF_CSS_URL]:
|
|
|
|
|
html += f'<link rel=stylesheet href="{config[CONF_CSS_URL]}">'
|
|
|
|
|
html += "</head><body>"
|
|
|
|
|
if js_include:
|
|
|
|
|
html += "<script type=module src=/0.js></script>"
|
|
|
|
|
html += "<esp-app></esp-app>"
|
|
|
|
|
if config[CONF_JS_URL]:
|
|
|
|
|
html += f'<script src="{config[CONF_JS_URL]}"></script>'
|
|
|
|
|
html += "</body></html>"
|
|
|
|
|
return html
|
|
|
|
|
|
|
|
|
|
|
2023-09-01 04:02:26 +02:00
|
|
|
def add_resource_as_progmem(
|
|
|
|
|
resource_name: str, content: str, compress: bool = True
|
|
|
|
|
) -> None:
|
2023-06-19 03:51:19 +02:00
|
|
|
"""Add a resource to progmem."""
|
|
|
|
|
content_encoded = content.encode("utf-8")
|
2023-09-01 04:02:26 +02:00
|
|
|
if compress:
|
|
|
|
|
content_encoded = gzip.compress(content_encoded)
|
2023-06-19 03:51:19 +02:00
|
|
|
content_encoded_size = len(content_encoded)
|
|
|
|
|
bytes_as_int = ", ".join(str(x) for x in content_encoded)
|
|
|
|
|
uint8_t = f"const uint8_t ESPHOME_WEBSERVER_{resource_name}[{content_encoded_size}] PROGMEM = {{{bytes_as_int}}}"
|
|
|
|
|
size_t = (
|
|
|
|
|
f"const size_t ESPHOME_WEBSERVER_{resource_name}_SIZE = {content_encoded_size}"
|
|
|
|
|
)
|
|
|
|
|
cg.add_global(cg.RawExpression(uint8_t))
|
|
|
|
|
cg.add_global(cg.RawExpression(size_t))
|
|
|
|
|
|
|
|
|
|
|
2019-04-17 12:06:00 +02:00
|
|
|
@coroutine_with_priority(40.0)
|
2021-05-23 22:10:30 +02:00
|
|
|
async def to_code(config):
|
|
|
|
|
paren = await cg.get_variable(config[CONF_WEB_SERVER_BASE_ID])
|
2019-06-09 17:03:51 +02:00
|
|
|
|
|
|
|
|
var = cg.new_Pvariable(config[CONF_ID], paren)
|
2021-05-23 22:10:30 +02:00
|
|
|
await cg.register_component(var, config)
|
2019-04-22 21:56:30 +02:00
|
|
|
|
2021-11-10 20:55:45 +01:00
|
|
|
cg.add_define("USE_WEBSERVER")
|
2023-06-19 03:51:19 +02:00
|
|
|
version = config[CONF_VERSION]
|
2021-11-10 20:55:45 +01:00
|
|
|
|
2019-06-09 17:03:51 +02:00
|
|
|
cg.add(paren.set_port(config[CONF_PORT]))
|
2021-10-31 21:33:04 +01:00
|
|
|
cg.add_define("USE_WEBSERVER")
|
2022-01-24 00:34:38 +01:00
|
|
|
cg.add_define("USE_WEBSERVER_PORT", config[CONF_PORT])
|
2023-06-19 03:51:19 +02:00
|
|
|
cg.add_define("USE_WEBSERVER_VERSION", version)
|
|
|
|
|
if version == 2:
|
2023-09-01 04:02:26 +02:00
|
|
|
# Don't compress the index HTML as the data sizes are almost the same.
|
|
|
|
|
add_resource_as_progmem("INDEX_HTML", build_index_html(config), compress=False)
|
2023-06-19 03:51:19 +02:00
|
|
|
else:
|
|
|
|
|
cg.add(var.set_css_url(config[CONF_CSS_URL]))
|
|
|
|
|
cg.add(var.set_js_url(config[CONF_JS_URL]))
|
2021-11-10 20:31:22 +01:00
|
|
|
cg.add(var.set_allow_ota(config[CONF_OTA]))
|
2023-06-21 23:58:49 +02:00
|
|
|
cg.add(var.set_expose_log(config[CONF_LOG]))
|
2019-10-13 14:27:44 +02:00
|
|
|
if CONF_AUTH in config:
|
2021-09-28 02:53:38 +02:00
|
|
|
cg.add(paren.set_auth_username(config[CONF_AUTH][CONF_USERNAME]))
|
|
|
|
|
cg.add(paren.set_auth_password(config[CONF_AUTH][CONF_PASSWORD]))
|
2020-02-20 13:05:10 +01:00
|
|
|
if CONF_CSS_INCLUDE in config:
|
2022-03-08 03:02:24 +01:00
|
|
|
cg.add_define("USE_WEBSERVER_CSS_INCLUDE")
|
2021-08-26 05:34:39 +02:00
|
|
|
path = CORE.relative_config_path(config[CONF_CSS_INCLUDE])
|
2023-06-19 03:51:19 +02:00
|
|
|
with open(file=path, encoding="utf-8") as css_file:
|
|
|
|
|
add_resource_as_progmem("CSS_INCLUDE", css_file.read())
|
2020-02-20 13:05:10 +01:00
|
|
|
if CONF_JS_INCLUDE in config:
|
2022-03-08 03:02:24 +01:00
|
|
|
cg.add_define("USE_WEBSERVER_JS_INCLUDE")
|
2021-08-26 05:34:39 +02:00
|
|
|
path = CORE.relative_config_path(config[CONF_JS_INCLUDE])
|
2023-06-19 03:51:19 +02:00
|
|
|
with open(file=path, encoding="utf-8") as js_file:
|
|
|
|
|
add_resource_as_progmem("JS_INCLUDE", js_file.read())
|
2021-11-29 16:52:20 +01:00
|
|
|
cg.add(var.set_include_internal(config[CONF_INCLUDE_INTERNAL]))
|
2022-03-08 03:02:24 +01:00
|
|
|
if CONF_LOCAL in config and config[CONF_LOCAL]:
|
|
|
|
|
cg.add_define("USE_WEBSERVER_LOCAL")
|
