import logging import os import re import esphome.codegen as cg import esphome.config_validation as cv from esphome import automation, pins from esphome.const import ( CONF_ARDUINO_VERSION, CONF_BOARD, CONF_BOARD_FLASH_MODE, CONF_BUILD_PATH, CONF_COMMENT, CONF_ESPHOME, CONF_INCLUDES, CONF_LIBRARIES, CONF_NAME, CONF_ON_BOOT, CONF_ON_LOOP, CONF_ON_SHUTDOWN, CONF_PLATFORM, CONF_PLATFORMIO_OPTIONS, CONF_PRIORITY, CONF_PROJECT, CONF_TRIGGER_ID, CONF_ESP8266_RESTORE_FROM_FLASH, ARDUINO_VERSION_ESP8266, ARDUINO_VERSION_ESP32, CONF_VERSION, ESP_PLATFORMS, ) from esphome.core import CORE, coroutine_with_priority from esphome.helpers import copy_file_if_changed, walk_files _LOGGER = logging.getLogger(__name__) BUILD_FLASH_MODES = ["qio", "qout", "dio", "dout"] StartupTrigger = cg.esphome_ns.class_( "StartupTrigger", cg.Component, automation.Trigger.template() ) ShutdownTrigger = cg.esphome_ns.class_( "ShutdownTrigger", cg.Component, automation.Trigger.template() ) LoopTrigger = cg.esphome_ns.class_( "LoopTrigger", cg.Component, automation.Trigger.template() ) VERSION_REGEX = re.compile(r"^[0-9]+\.[0-9]+\.[0-9]+(?:[ab]\d+)?$") CONF_NAME_ADD_MAC_SUFFIX = "name_add_mac_suffix" def validate_board(value): if CORE.is_esp8266: board_pins = pins.ESP8266_BOARD_PINS elif CORE.is_esp32: board_pins = pins.ESP32_BOARD_PINS else: raise NotImplementedError if value not in board_pins: raise cv.Invalid( "Could not find board '{}'. Valid boards are {}".format( value, ", ".join(sorted(board_pins.keys())) ) ) return value validate_platform = cv.one_of(*ESP_PLATFORMS, upper=True) PLATFORMIO_ESP8266_LUT = { **ARDUINO_VERSION_ESP8266, # Keep this in mind when updating the recommended version: # * New framework historically have had some regressions, especially for WiFi, BLE and the # bootloader system. The new version needs to be thoroughly validated before changing the # recommended version as otherwise a bunch of devices could be bricked # * The docker images need to be updated to ship the new recommended version, in order not # to DDoS platformio servers. # Update this file: https://github.com/esphome/esphome-docker-base/blob/main/platformio.ini "RECOMMENDED": ARDUINO_VERSION_ESP8266["2.7.4"], "LATEST": "espressif8266", "DEV": ARDUINO_VERSION_ESP8266["dev"], } PLATFORMIO_ESP32_LUT = { **ARDUINO_VERSION_ESP32, # See PLATFORMIO_ESP8266_LUT for considerations when changing the recommended version "RECOMMENDED": ARDUINO_VERSION_ESP32["1.0.6"], "LATEST": "espressif32", "DEV": ARDUINO_VERSION_ESP32["dev"], } def validate_arduino_version(value): value = cv.string_strict(value) value_ = value.upper() if CORE.is_esp8266: if ( VERSION_REGEX.match(value) is not None and value_ not in PLATFORMIO_ESP8266_LUT ): raise cv.Invalid( "Unfortunately the arduino framework version '{}' is unsupported " "at this time. You can override this by manually using " "espressif8266@".format(value) ) if value_ in PLATFORMIO_ESP8266_LUT: return PLATFORMIO_ESP8266_LUT[value_] return value if CORE.is_esp32: if ( VERSION_REGEX.match(value) is not None and value_ not in PLATFORMIO_ESP32_LUT ): raise cv.Invalid( "Unfortunately the arduino framework version '{}' is unsupported " "at this time. You can override this by manually using " "espressif32@".format(value) ) if value_ in PLATFORMIO_ESP32_LUT: return PLATFORMIO_ESP32_LUT[value_] return value raise NotImplementedError def default_build_path(): return CORE.name VALID_INCLUDE_EXTS = {".h", ".hpp", ".tcc", ".ino", ".cpp", ".c"} def valid_include(value): try: return cv.directory(value) except cv.Invalid: pass value = cv.file_(value) _, ext = os.path.splitext(value) if ext not in VALID_INCLUDE_EXTS: raise cv.Invalid( "Include has invalid file extension {} - valid extensions are {}" "".format(ext, ", ".join(VALID_INCLUDE_EXTS)) ) return value def valid_project_name(value: str): if value.count(".") != 1: raise cv.Invalid("project name needs to have a namespace") value = value.replace(" ", "_") return value CONFIG_SCHEMA = cv.Schema( { cv.Required(CONF_NAME): cv.valid_name, cv.Required(CONF_PLATFORM): cv.one_of("ESP8266", "ESP32", upper=True), cv.Required(CONF_BOARD): validate_board, cv.Optional(CONF_COMMENT): cv.string, cv.Optional( CONF_ARDUINO_VERSION, default="recommended" ): validate_arduino_version, cv.Optional(CONF_BUILD_PATH, default=default_build_path): cv.string, cv.Optional(CONF_PLATFORMIO_OPTIONS, default={}): cv.Schema( { cv.string_strict: cv.Any([cv.string], cv.string), } ), cv.SplitDefault(CONF_ESP8266_RESTORE_FROM_FLASH, esp8266=False): cv.All( cv.only_on_esp8266, cv.boolean ), cv.SplitDefault(CONF_BOARD_FLASH_MODE, esp8266="dout"): cv.one_of( *BUILD_FLASH_MODES, lower=True ), cv.Optional(CONF_ON_BOOT): automation.validate_automation( { cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(StartupTrigger), cv.Optional(CONF_PRIORITY, default=600.0): cv.float_, } ), cv.Optional(CONF_ON_SHUTDOWN): automation.validate_automation( { cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(ShutdownTrigger), } ), cv.Optional(CONF_ON_LOOP): automation.validate_automation( { cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(LoopTrigger), } ), cv.Optional(CONF_INCLUDES, default=[]): cv.ensure_list(valid_include), cv.Optional(CONF_LIBRARIES, default=[]): cv.ensure_list(cv.string_strict), cv.Optional(CONF_NAME_ADD_MAC_SUFFIX, default=False): cv.boolean, cv.Optional(CONF_PROJECT): cv.Schema( { cv.Required(CONF_NAME): cv.All(cv.string_strict, valid_project_name), cv.Required(CONF_VERSION): cv.string_strict, } ), cv.Optional("esphome_core_version"): cv.invalid( "The esphome_core_version option has been " "removed in 1.13 - the esphome core source " "files are now bundled with ESPHome." ), } ) PRELOAD_CONFIG_SCHEMA = cv.Schema( { cv.Required(CONF_NAME): cv.valid_name, cv.Required(CONF_PLATFORM): validate_platform, }, extra=cv.ALLOW_EXTRA, ) PRELOAD_CONFIG_SCHEMA2 = PRELOAD_CONFIG_SCHEMA.extend( { cv.Required(CONF_BOARD): validate_board, cv.Optional(CONF_BUILD_PATH, default=default_build_path): cv.string, } ) def preload_core_config(config): core_key = "esphome" if "esphomeyaml" in config: _LOGGER.warning( "The esphomeyaml section has been renamed to esphome in 1.11.0. " "Please replace 'esphomeyaml:' in your configuration with 'esphome:'." ) config[CONF_ESPHOME] = config.pop("esphomeyaml") core_key = "esphomeyaml" if CONF_ESPHOME not in config: raise cv.RequiredFieldInvalid("required key not provided", CONF_ESPHOME) with cv.prepend_path(core_key): out = PRELOAD_CONFIG_SCHEMA(config[CONF_ESPHOME]) CORE.name = out[CONF_NAME] CORE.esp_platform = out[CONF_PLATFORM] with cv.prepend_path(core_key): out2 = PRELOAD_CONFIG_SCHEMA2(config[CONF_ESPHOME]) CORE.board = out2[CONF_BOARD] CORE.build_path = CORE.relative_config_path(out2[CONF_BUILD_PATH]) def include_file(path, basename): parts = basename.split(os.path.sep) dst = CORE.relative_src_path(*parts) copy_file_if_changed(path, dst) _, ext = os.path.splitext(path) if ext in [".h", ".hpp", ".tcc"]: # Header, add include statement cg.add_global(cg.RawStatement(f'#include "{basename}"')) @coroutine_with_priority(-1000.0) async def add_includes(includes): # Add includes at the very end, so that the included files can access global variables for include in includes: path = CORE.relative_config_path(include) if os.path.isdir(path): # Directory, copy tree for p in walk_files(path): basename = os.path.relpath(p, os.path.dirname(path)) include_file(p, basename) else: # Copy file basename = os.path.basename(path) include_file(path, basename) @coroutine_with_priority(-1000.0) async def _esp8266_add_lwip_type(): # If any component has already set this, do not change it if any( flag.startswith("-DPIO_FRAMEWORK_ARDUINO_LWIP2_") for flag in CORE.build_flags ): return # Default for platformio is LWIP2_LOW_MEMORY with: # - MSS=536 # - LWIP_FEATURES enabled # - this only adds some optional features like IP incoming packet reassembly and NAPT # see also: # https://github.com/esp8266/Arduino/blob/master/tools/sdk/lwip2/include/lwipopts.h # Instead we use LWIP2_HIGHER_BANDWIDTH_LOW_FLASH with: # - MSS=1460 # - LWIP_FEATURES disabled (because we don't need them) # Other projects like Tasmota & ESPEasy also use this cg.add_build_flag("-DPIO_FRAMEWORK_ARDUINO_LWIP2_HIGHER_BANDWIDTH_LOW_FLASH") @coroutine_with_priority(30.0) async def _add_automations(config): for conf in config.get(CONF_ON_BOOT, []): trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], conf.get(CONF_PRIORITY)) await cg.register_component(trigger, conf) await automation.build_automation(trigger, [], conf) for conf in config.get(CONF_ON_SHUTDOWN, []): trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID]) await cg.register_component(trigger, conf) await automation.build_automation(trigger, [], conf) for conf in config.get(CONF_ON_LOOP, []): trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID]) await cg.register_component(trigger, conf) await automation.build_automation(trigger, [], conf) @coroutine_with_priority(100.0) async def to_code(config): cg.add_global(cg.global_ns.namespace("esphome").using) cg.add( cg.App.pre_setup( config[CONF_NAME], cg.RawExpression('__DATE__ ", " __TIME__'), config[CONF_NAME_ADD_MAC_SUFFIX], ) ) CORE.add_job(_add_automations, config) # Set LWIP build constants for ESP8266 if CORE.is_esp8266: CORE.add_job(_esp8266_add_lwip_type) cg.add_build_flag("-fno-exceptions") # Libraries for lib in config[CONF_LIBRARIES]: if "@" in lib: name, vers = lib.split("@", 1) cg.add_library(name, vers) else: cg.add_library(lib, None) cg.add_build_flag("-Wno-unused-variable") cg.add_build_flag("-Wno-unused-but-set-variable") cg.add_build_flag("-Wno-sign-compare") if config.get(CONF_ESP8266_RESTORE_FROM_FLASH, False): cg.add_define("USE_ESP8266_PREFERENCES_FLASH") if config[CONF_INCLUDES]: CORE.add_job(add_includes, config[CONF_INCLUDES]) cg.add_define("ESPHOME_BOARD", CORE.board) if CONF_PROJECT in config: cg.add_define("ESPHOME_PROJECT_NAME", config[CONF_PROJECT][CONF_NAME]) cg.add_define("ESPHOME_PROJECT_VERSION", config[CONF_PROJECT][CONF_VERSION])