mirror of
https://github.com/esphome/esphome.git
synced 2025-11-16 23:05:46 +00:00
106 lines
2.9 KiB
Python
106 lines
2.9 KiB
Python
import logging
|
|
|
|
import esphome.codegen as cg
|
|
from esphome.components import web_server_base
|
|
from esphome.components.web_server_base import CONF_WEB_SERVER_BASE_ID
|
|
from esphome.config_helpers import filter_source_files_from_platform
|
|
import esphome.config_validation as cv
|
|
from esphome.const import (
|
|
CONF_AP,
|
|
CONF_ID,
|
|
PLATFORM_BK72XX,
|
|
PLATFORM_ESP32,
|
|
PLATFORM_ESP8266,
|
|
PLATFORM_LN882X,
|
|
PLATFORM_RTL87XX,
|
|
PlatformFramework,
|
|
)
|
|
from esphome.core import CORE, coroutine_with_priority
|
|
from esphome.coroutine import CoroPriority
|
|
import esphome.final_validate as fv
|
|
from esphome.types import ConfigType
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
def AUTO_LOAD() -> list[str]:
|
|
auto_load = ["web_server_base", "ota.web_server"]
|
|
if CORE.using_esp_idf:
|
|
auto_load.append("socket")
|
|
return auto_load
|
|
|
|
|
|
DEPENDENCIES = ["wifi"]
|
|
CODEOWNERS = ["@esphome/core"]
|
|
|
|
captive_portal_ns = cg.esphome_ns.namespace("captive_portal")
|
|
CaptivePortal = captive_portal_ns.class_("CaptivePortal", cg.Component)
|
|
|
|
CONFIG_SCHEMA = cv.All(
|
|
cv.Schema(
|
|
{
|
|
cv.GenerateID(): cv.declare_id(CaptivePortal),
|
|
cv.GenerateID(CONF_WEB_SERVER_BASE_ID): cv.use_id(
|
|
web_server_base.WebServerBase
|
|
),
|
|
}
|
|
).extend(cv.COMPONENT_SCHEMA),
|
|
cv.only_on(
|
|
[
|
|
PLATFORM_ESP32,
|
|
PLATFORM_ESP8266,
|
|
PLATFORM_BK72XX,
|
|
PLATFORM_LN882X,
|
|
PLATFORM_RTL87XX,
|
|
]
|
|
),
|
|
)
|
|
|
|
|
|
def _final_validate(config: ConfigType) -> ConfigType:
|
|
full_config = fv.full_config.get()
|
|
wifi_conf = full_config.get("wifi")
|
|
|
|
if wifi_conf is None:
|
|
# This shouldn't happen due to DEPENDENCIES = ["wifi"], but check anyway
|
|
raise cv.Invalid("Captive portal requires the wifi component to be configured")
|
|
|
|
if CONF_AP not in wifi_conf:
|
|
_LOGGER.warning(
|
|
"Captive portal is enabled but no WiFi AP is configured. "
|
|
"The captive portal will not be accessible. "
|
|
"Add 'ap:' to your WiFi configuration to enable the captive portal."
|
|
)
|
|
|
|
return config
|
|
|
|
|
|
FINAL_VALIDATE_SCHEMA = _final_validate
|
|
|
|
|
|
@coroutine_with_priority(CoroPriority.CAPTIVE_PORTAL)
|
|
async def to_code(config):
|
|
paren = await cg.get_variable(config[CONF_WEB_SERVER_BASE_ID])
|
|
|
|
var = cg.new_Pvariable(config[CONF_ID], paren)
|
|
await cg.register_component(var, config)
|
|
cg.add_define("USE_CAPTIVE_PORTAL")
|
|
|
|
if CORE.using_arduino:
|
|
if CORE.is_esp32:
|
|
cg.add_library("ESP32 Async UDP", None)
|
|
cg.add_library("DNSServer", None)
|
|
cg.add_library("WiFi", None)
|
|
if CORE.is_esp8266:
|
|
cg.add_library("DNSServer", None)
|
|
if CORE.is_libretiny:
|
|
cg.add_library("DNSServer", None)
|
|
|
|
|
|
# Only compile the ESP-IDF DNS server when using ESP-IDF framework
|
|
FILTER_SOURCE_FILES = filter_source_files_from_platform(
|
|
{
|
|
"dns_server_esp32_idf.cpp": {PlatformFramework.ESP32_IDF},
|
|
}
|
|
)
|