Home-IoT/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2024-11-14 02:58:11 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Replace framework version_hint with source option (#2529)

Browse source
This commit is contained in:
Oxan van Leeuwen 2021-10-15 22:07:05 +02:00 committed by Jesse Hills
parent 98755f3621
commit 4dd1bf920d
No known key found for this signature in database
GPG key ID: BEAAE804EFD8E83A
3 changed files with 97 additions and 123 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

138
esphome/components/esp32/__init__.py
View file

@ -7,6 +7,7 @@ from esphome.helpers import write_file_if_changed
from esphome.const import ( from esphome.const import (
CONF_BOARD, CONF_BOARD,
CONF_FRAMEWORK, CONF_FRAMEWORK,
CONF_SOURCE,
CONF_TYPE, CONF_TYPE,
CONF_VARIANT, CONF_VARIANT,
CONF_VERSION, CONF_VERSION,
@ -53,7 +54,7 @@ def set_core_data(config):
elif conf[CONF_TYPE] == FRAMEWORK_ARDUINO: elif conf[CONF_TYPE] == FRAMEWORK_ARDUINO:
CORE.data[KEY_CORE][KEY_TARGET_FRAMEWORK] = "arduino" CORE.data[KEY_CORE][KEY_TARGET_FRAMEWORK] = "arduino"
CORE.data[KEY_CORE][KEY_FRAMEWORK_VERSION] = cv.Version.parse( CORE.data[KEY_CORE][KEY_FRAMEWORK_VERSION] = cv.Version.parse(
config[CONF_FRAMEWORK][CONF_VERSION_HINT] config[CONF_FRAMEWORK][CONF_VERSION]
) )
CORE.data[KEY_ESP32][KEY_BOARD] = config[CONF_BOARD] CORE.data[KEY_ESP32][KEY_BOARD] = config[CONF_BOARD]
CORE.data[KEY_ESP32][KEY_VARIANT] = config[CONF_VARIANT] CORE.data[KEY_ESP32][KEY_VARIANT] = config[CONF_VARIANT]
@ -94,6 +95,13 @@ def _format_framework_arduino_version(ver: cv.Version) -> str:
return f"~3.{ver.major}{ver.minor:02d}{ver.patch:02d}.0" return f"~3.{ver.major}{ver.minor:02d}{ver.patch:02d}.0"
def _format_framework_espidf_version(ver: cv.Version) -> str:
# format the given arduino (https://github.com/espressif/esp-idf/releases) version to
# a PIO platformio/framework-espidf value
# List of package versions: https://api.registry.platformio.org/v3/packages/platformio/tool/framework-espidf
return f"~3.{ver.major}{ver.minor:02d}{ver.patch:02d}.0"
# NOTE: Keep this in mind when updating the recommended version: # NOTE: Keep this in mind when updating the recommended version:
# * New framework historically have had some regressions, especially for WiFi. # * New framework historically have had some regressions, especially for WiFi.
# The new version needs to be thoroughly validated before changing the # The new version needs to be thoroughly validated before changing the
@ -123,119 +131,97 @@ ESP_IDF_PLATFORM_VERSION = cv.Version(3, 3, 2)
def _arduino_check_versions(value): def _arduino_check_versions(value):
value = value.copy() value = value.copy()
lookups = { lookups = {
"dev": ("https://github.com/espressif/arduino-esp32.git", cv.Version(2, 0, 0)), "dev": (cv.Version(2, 0, 0), "https://github.com/espressif/arduino-esp32.git"),
"latest": ("", cv.Version(1, 0, 3)), "latest": (cv.Version(1, 0, 6), None),
"recommended": ( "recommended": (RECOMMENDED_ARDUINO_FRAMEWORK_VERSION, None),
_format_framework_arduino_version(RECOMMENDED_ARDUINO_FRAMEWORK_VERSION),
RECOMMENDED_ARDUINO_FRAMEWORK_VERSION,
),
} }
ver_value = value[CONF_VERSION]
default_ver_hint = None
if ver_value.lower() in lookups:
default_ver_hint = str(lookups[ver_value.lower()][1])
ver_value = lookups[ver_value.lower()][0]
else:
with cv.suppress_invalid():
ver = cv.Version.parse(cv.version_number(value))
if ver <= cv.Version(1, 0, 3):
ver_value = f"~2.{ver.major}{ver.minor:02d}{ver.patch:02d}.0"
else:
ver_value = f"~3.{ver.major}{ver.minor:02d}{ver.patch:02d}.0"
default_ver_hint = str(ver)
value[CONF_VERSION] = ver_value
if CONF_VERSION_HINT not in value and default_ver_hint is None: if value[CONF_VERSION] in lookups:
raise cv.Invalid("Needs a version hint to understand the framework version") if CONF_SOURCE in value:
raise cv.Invalid(
ver_hint_s = value.get(CONF_VERSION_HINT, default_ver_hint) "Framework version needs to be explicitly specified when custom source is used."
value[CONF_VERSION_HINT] = ver_hint_s
plat_ver = value.get(CONF_PLATFORM_VERSION, ARDUINO_PLATFORM_VERSION)
value[CONF_PLATFORM_VERSION] = str(plat_ver)
if cv.Version.parse(ver_hint_s) != RECOMMENDED_ARDUINO_FRAMEWORK_VERSION:
_LOGGER.warning(
"The selected arduino framework version is not the recommended one"
) )
version, source = lookups[value[CONF_VERSION]]
else:
version = cv.Version.parse(cv.version_number(value[CONF_VERSION]))
source = value.get(CONF_SOURCE, None)
value[CONF_VERSION] = str(version)
value[CONF_SOURCE] = source or _format_framework_arduino_version(version)
platform_version = value.get(CONF_PLATFORM_VERSION, ARDUINO_PLATFORM_VERSION)
value[CONF_PLATFORM_VERSION] = str(platform_version)
if version != RECOMMENDED_ARDUINO_FRAMEWORK_VERSION:
_LOGGER.warning( _LOGGER.warning(
"If there are connectivity or build issues please remove the manual version" "The selected Arduino framework version is not the recommended one. "
"If there are connectivity or build issues please remove the manual version."
) )
return value return value
def _format_framework_espidf_version(ver: cv.Version) -> str:
# format the given arduino (https://github.com/espressif/esp-idf/releases) version to
# a PIO platformio/framework-espidf value
# List of package versions: https://api.registry.platformio.org/v3/packages/platformio/tool/framework-espidf
return f"~3.{ver.major}{ver.minor:02d}{ver.patch:02d}.0"
def _esp_idf_check_versions(value): def _esp_idf_check_versions(value):
value = value.copy() value = value.copy()
lookups = { lookups = {
"dev": ("https://github.com/espressif/esp-idf.git", cv.Version(4, 3, 1)), "dev": (cv.Version(4, 3, 1), "https://github.com/espressif/esp-idf.git"),
"latest": ("", cv.Version(4, 3, 0)), "latest": (cv.Version(4, 3, 0), None),
"recommended": ( "recommended": (RECOMMENDED_ESP_IDF_FRAMEWORK_VERSION, None),
_format_framework_espidf_version(RECOMMENDED_ESP_IDF_FRAMEWORK_VERSION),
RECOMMENDED_ESP_IDF_FRAMEWORK_VERSION,
),
} }
ver_value = value[CONF_VERSION]
default_ver_hint = None if value[CONF_VERSION] in lookups:
if ver_value.lower() in lookups: if CONF_SOURCE in value:
default_ver_hint = str(lookups[ver_value.lower()][1]) raise cv.Invalid(
ver_value = lookups[ver_value.lower()][0] "Framework version needs to be explicitly specified when custom source is used."
)
version, source = lookups[value[CONF_VERSION]]
else: else:
with cv.suppress_invalid(): version = cv.Version.parse(cv.version_number(value[CONF_VERSION]))
ver = cv.Version.parse(cv.version_number(value)) source = value.get(CONF_SOURCE, None)
ver_value = f"~3.{ver.major}{ver.minor:02d}{ver.patch:02d}.0"
default_ver_hint = str(ver)
value[CONF_VERSION] = ver_value
if CONF_VERSION_HINT not in value and default_ver_hint is None: if version < cv.Version(4, 0, 0):
raise cv.Invalid("Needs a version hint to understand the framework version") raise cv.Invalid("Only ESP-IDF 4.0+ is supported.")
ver_hint_s = value.get(CONF_VERSION_HINT, default_ver_hint) value[CONF_VERSION] = str(version)
value[CONF_VERSION_HINT] = ver_hint_s value[CONF_SOURCE] = source or _format_framework_espidf_version(version)
if cv.Version.parse(ver_hint_s) < cv.Version(4, 0, 0):
raise cv.Invalid("Only ESP-IDF 4.0+ is supported") platform_version = value.get(CONF_PLATFORM_VERSION, ESP_IDF_PLATFORM_VERSION)
if cv.Version.parse(ver_hint_s) != RECOMMENDED_ESP_IDF_FRAMEWORK_VERSION: value[CONF_PLATFORM_VERSION] = str(platform_version)
if version != RECOMMENDED_ARDUINO_FRAMEWORK_VERSION:
_LOGGER.warning( _LOGGER.warning(
"The selected esp-idf framework version is not the recommended one" "The selected ESP-IDF framework version is not the recommended one. "
"If there are connectivity or build issues please remove the manual version."
) )
_LOGGER.warning(
"If there are connectivity or build issues please remove the manual version"
)
plat_ver = value.get(CONF_PLATFORM_VERSION, ESP_IDF_PLATFORM_VERSION)
value[CONF_PLATFORM_VERSION] = str(plat_ver)
return value return value
CONF_VERSION_HINT = "version_hint"
CONF_PLATFORM_VERSION = "platform_version" CONF_PLATFORM_VERSION = "platform_version"
ARDUINO_FRAMEWORK_SCHEMA = cv.All( ARDUINO_FRAMEWORK_SCHEMA = cv.All(
cv.Schema( cv.Schema(
{ {
cv.Optional(CONF_VERSION, default="recommended"): cv.string_strict, cv.Optional(CONF_VERSION, default="recommended"): cv.string_strict,
cv.Optional(CONF_VERSION_HINT): cv.version_number, cv.Optional(CONF_SOURCE): cv.string_strict,
cv.Optional(CONF_PLATFORM_VERSION): cv.string_strict, cv.Optional(CONF_PLATFORM_VERSION): cv.string_strict,
} }
), ),
_arduino_check_versions, _arduino_check_versions,
) )
CONF_SDKCONFIG_OPTIONS = "sdkconfig_options" CONF_SDKCONFIG_OPTIONS = "sdkconfig_options"
ESP_IDF_FRAMEWORK_SCHEMA = cv.All( ESP_IDF_FRAMEWORK_SCHEMA = cv.All(
cv.Schema( cv.Schema(
{ {
cv.Optional(CONF_VERSION, default="recommended"): cv.string_strict, cv.Optional(CONF_VERSION, default="recommended"): cv.string_strict,
cv.Optional(CONF_VERSION_HINT): cv.version_number, cv.Optional(CONF_SOURCE): cv.string_strict,
cv.Optional(CONF_PLATFORM_VERSION): cv.string_strict,
cv.Optional(CONF_SDKCONFIG_OPTIONS, default={}): { cv.Optional(CONF_SDKCONFIG_OPTIONS, default={}): {
cv.string_strict: cv.string_strict cv.string_strict: cv.string_strict
}, },
cv.Optional(CONF_PLATFORM_VERSION): cv.string_strict,
cv.Optional(CONF_ADVANCED, default={}): cv.Schema( cv.Optional(CONF_ADVANCED, default={}): cv.Schema(
{ {
cv.Optional(CONF_IGNORE_EFUSE_MAC_CRC, default=False): cv.boolean, cv.Optional(CONF_IGNORE_EFUSE_MAC_CRC, default=False): cv.boolean,
@ -293,7 +279,7 @@ async def to_code(config):
cg.add_build_flag("-Wno-nonnull-compare") cg.add_build_flag("-Wno-nonnull-compare")
cg.add_platformio_option( cg.add_platformio_option(
"platform_packages", "platform_packages",
[f"platformio/framework-espidf @ {conf[CONF_VERSION]}"], [f"platformio/framework-espidf @ {conf[CONF_SOURCE]}"],
) )
add_idf_sdkconfig_option("CONFIG_PARTITION_TABLE_SINGLE_APP", False) add_idf_sdkconfig_option("CONFIG_PARTITION_TABLE_SINGLE_APP", False)
add_idf_sdkconfig_option("CONFIG_PARTITION_TABLE_CUSTOM", True) add_idf_sdkconfig_option("CONFIG_PARTITION_TABLE_CUSTOM", True)
@ -323,7 +309,7 @@ async def to_code(config):
cg.add_build_flag("-DUSE_ESP32_FRAMEWORK_ARDUINO") cg.add_build_flag("-DUSE_ESP32_FRAMEWORK_ARDUINO")
cg.add_platformio_option( cg.add_platformio_option(
"platform_packages", "platform_packages",
[f"platformio/framework-arduinoespressif32 @ {conf[CONF_VERSION]}"], [f"platformio/framework-arduinoespressif32 @ {conf[CONF_SOURCE]}"],
) )
cg.add_platformio_option("board_build.partitions", "partitions.csv") cg.add_platformio_option("board_build.partitions", "partitions.csv")

81
esphome/components/esp8266/__init__.py
View file

@ -4,6 +4,7 @@ from esphome.const import (
CONF_BOARD, CONF_BOARD,
CONF_BOARD_FLASH_MODE, CONF_BOARD_FLASH_MODE,
CONF_FRAMEWORK, CONF_FRAMEWORK,
CONF_SOURCE,
CONF_VERSION, CONF_VERSION,
KEY_CORE, KEY_CORE,
KEY_FRAMEWORK_VERSION, KEY_FRAMEWORK_VERSION,
@ -31,7 +32,7 @@ def set_core_data(config):
CORE.data[KEY_CORE][KEY_TARGET_PLATFORM] = "esp8266" CORE.data[KEY_CORE][KEY_TARGET_PLATFORM] = "esp8266"
CORE.data[KEY_CORE][KEY_TARGET_FRAMEWORK] = "arduino" CORE.data[KEY_CORE][KEY_TARGET_FRAMEWORK] = "arduino"
CORE.data[KEY_CORE][KEY_FRAMEWORK_VERSION] = cv.Version.parse( CORE.data[KEY_CORE][KEY_FRAMEWORK_VERSION] = cv.Version.parse(
config[CONF_FRAMEWORK][CONF_VERSION_HINT] config[CONF_FRAMEWORK][CONF_VERSION]
) )
CORE.data[KEY_ESP8266][KEY_BOARD] = config[CONF_BOARD] CORE.data[KEY_ESP8266][KEY_BOARD] = config[CONF_BOARD]
return config return config
@ -70,66 +71,50 @@ ARDUINO_3_PLATFORM_VERSION = cv.Version(3, 0, 2)
def _arduino_check_versions(value): def _arduino_check_versions(value):
value = value.copy() value = value.copy()
lookups = { lookups = {
"dev": ("https://github.com/esp8266/Arduino.git", cv.Version(3, 0, 2)), "dev": (cv.Version(3, 0, 2), "https://github.com/esp8266/Arduino.git"),
"latest": ("", cv.Version(3, 0, 2)), "latest": (cv.Version(3, 0, 2), None),
"recommended": ( "recommended": (RECOMMENDED_ARDUINO_FRAMEWORK_VERSION, None),
_format_framework_arduino_version(RECOMMENDED_ARDUINO_FRAMEWORK_VERSION),
RECOMMENDED_ARDUINO_FRAMEWORK_VERSION,
),
} }
ver_value = value[CONF_VERSION]
default_ver_hint = None
if ver_value.lower() in lookups:
default_ver_hint = str(lookups[ver_value.lower()][1])
ver_value = lookups[ver_value.lower()][0]
else:
with cv.suppress_invalid():
ver = cv.Version.parse(cv.version_number(value))
if ver <= cv.Version(2, 4, 1):
ver_value = f"~1.{ver.major}{ver.minor:02d}{ver.patch:02d}.0"
elif ver <= cv.Version(2, 6, 2):
ver_value = f"~2.{ver.major}{ver.minor:02d}{ver.patch:02d}.0"
else:
ver_value = f"~3.{ver.major}{ver.minor:02d}{ver.patch:02d}.0"
default_ver_hint = str(ver)
value[CONF_VERSION] = ver_value if value[CONF_VERSION] in lookups:
if CONF_SOURCE in value:
if CONF_VERSION_HINT not in value and default_ver_hint is None: raise cv.Invalid(
raise cv.Invalid("Needs a version hint to understand the framework version") "Framework version needs to be explicitly specified when custom source is used."
ver_hint_s = value.get(CONF_VERSION_HINT, default_ver_hint)
value[CONF_VERSION_HINT] = ver_hint_s
plat_ver = value.get(CONF_PLATFORM_VERSION)
if plat_ver is None:
ver_hint = cv.Version.parse(ver_hint_s)
if ver_hint >= cv.Version(3, 0, 0):
plat_ver = ARDUINO_3_PLATFORM_VERSION
elif ver_hint >= cv.Version(2, 5, 0):
plat_ver = ARDUINO_2_PLATFORM_VERSION
else:
plat_ver = cv.Version(1, 8, 0)
value[CONF_PLATFORM_VERSION] = str(plat_ver)
if cv.Version.parse(ver_hint_s) != RECOMMENDED_ARDUINO_FRAMEWORK_VERSION:
_LOGGER.warning(
"The selected arduino framework version is not the recommended one"
) )
version, source = lookups[value[CONF_VERSION]]
else:
version = cv.Version.parse(cv.version_number(value[CONF_VERSION]))
source = value.get(CONF_SOURCE, None)
value[CONF_VERSION] = str(version)
value[CONF_SOURCE] = source or _format_framework_arduino_version(version)
platform_version = value.get(CONF_PLATFORM_VERSION)
if platform_version is None:
if version >= cv.Version(3, 0, 0):
platform_version = ARDUINO_3_PLATFORM_VERSION
elif version >= cv.Version(2, 5, 0):
platform_version = ARDUINO_2_PLATFORM_VERSION
else:
platform_version = cv.Version(1, 8, 0)
value[CONF_PLATFORM_VERSION] = str(platform_version)
if version != RECOMMENDED_ARDUINO_FRAMEWORK_VERSION:
_LOGGER.warning( _LOGGER.warning(
"If there are connectivity or build issues please remove the manual version" "The selected Arduino framework version is not the recommended one. "
"If there are connectivity or build issues please remove the manual version."
) )
return value return value
CONF_VERSION_HINT = "version_hint"
CONF_PLATFORM_VERSION = "platform_version" CONF_PLATFORM_VERSION = "platform_version"
ARDUINO_FRAMEWORK_SCHEMA = cv.All( ARDUINO_FRAMEWORK_SCHEMA = cv.All(
cv.Schema( cv.Schema(
{ {
cv.Optional(CONF_VERSION, default="recommended"): cv.string_strict, cv.Optional(CONF_VERSION, default="recommended"): cv.string_strict,
cv.Optional(CONF_VERSION_HINT): cv.version_number, cv.Optional(CONF_SOURCE): cv.string_strict,
cv.Optional(CONF_PLATFORM_VERSION): cv.string_strict, cv.Optional(CONF_PLATFORM_VERSION): cv.string_strict,
} }
), ),
@ -167,7 +152,7 @@ async def to_code(config):
cg.add_build_flag("-DUSE_ESP8266_FRAMEWORK_ARDUINO") cg.add_build_flag("-DUSE_ESP8266_FRAMEWORK_ARDUINO")
cg.add_platformio_option( cg.add_platformio_option(
"platform_packages", "platform_packages",
[f"platformio/framework-arduinoespressif8266 @ {conf[CONF_VERSION]}"], [f"platformio/framework-arduinoespressif8266 @ {conf[CONF_SOURCE]}"],
) )
cg.add_platformio_option( cg.add_platformio_option(
"platform", f"platformio/espressif8266 @ {conf[CONF_PLATFORM_VERSION]}" "platform", f"platformio/espressif8266 @ {conf[CONF_PLATFORM_VERSION]}"

11
esphome/core/config.py
View file

@ -23,6 +23,7 @@ from esphome.const import (
CONF_PLATFORMIO_OPTIONS, CONF_PLATFORMIO_OPTIONS,
CONF_PRIORITY, CONF_PRIORITY,
CONF_PROJECT, CONF_PROJECT,
CONF_SOURCE,
CONF_TRIGGER_ID, CONF_TRIGGER_ID,
CONF_TYPE, CONF_TYPE,
CONF_VERSION, CONF_VERSION,
@ -181,10 +182,12 @@ def preload_core_config(config, result):
if CONF_BOARD_FLASH_MODE in conf: if CONF_BOARD_FLASH_MODE in conf:
plat_conf[CONF_BOARD_FLASH_MODE] = conf.pop(CONF_BOARD_FLASH_MODE) plat_conf[CONF_BOARD_FLASH_MODE] = conf.pop(CONF_BOARD_FLASH_MODE)
if CONF_ARDUINO_VERSION in conf: if CONF_ARDUINO_VERSION in conf:
plat_conf[CONF_FRAMEWORK] = { plat_conf[CONF_FRAMEWORK] = {CONF_TYPE: "arduino"}
CONF_TYPE: "arduino", try:
CONF_VERSION: conf.pop(CONF_ARDUINO_VERSION), cv.Version.parse(conf[CONF_ARDUINO_VERSION])
} plat_conf[CONF_FRAMEWORK][CONF_VERSION] = conf.pop(CONF_ARDUINO_VERSION)
except ValueError:
plat_conf[CONF_FRAMEWORK][CONF_SOURCE] = conf.pop(CONF_ARDUINO_VERSION)
if CONF_BOARD in conf: if CONF_BOARD in conf:
plat_conf[CONF_BOARD] = conf.pop(CONF_BOARD) plat_conf[CONF_BOARD] = conf.pop(CONF_BOARD)
# Insert generated target platform config to main config # Insert generated target platform config to main config