mirror of
https://github.com/esphome/esphome.git
synced 2024-09-07 00:59:08 +02:00
255 lines
9.6 KiB
Python
255 lines
9.6 KiB
Python
import logging
|
|
import os
|
|
import re
|
|
import subprocess
|
|
|
|
import voluptuous as vol
|
|
|
|
import esphomeyaml.config_validation as cv
|
|
from esphomeyaml import automation, core, pins
|
|
from esphomeyaml.const import CONF_ARDUINO_VERSION, CONF_BOARD, CONF_BOARD_FLASH_MODE, \
|
|
CONF_BRANCH, CONF_BUILD_PATH, CONF_COMMIT, CONF_ESPHOMELIB_VERSION, CONF_ESPHOMEYAML, \
|
|
CONF_LOCAL, CONF_NAME, CONF_ON_BOOT, CONF_ON_LOOP, CONF_ON_SHUTDOWN, CONF_PLATFORM, \
|
|
CONF_PRIORITY, CONF_REPOSITORY, CONF_TAG, CONF_TRIGGER_ID, CONF_USE_CUSTOM_CODE, \
|
|
ESPHOMELIB_VERSION, ESP_PLATFORM_ESP32, ESP_PLATFORM_ESP8266, ARDUINO_VERSION_ESP8266_DEV, \
|
|
ARDUINO_VERSION_ESP32_DEV
|
|
from esphomeyaml.core import ESPHomeYAMLError
|
|
from esphomeyaml.helpers import App, NoArg, Pvariable, add, const_char_p, esphomelib_ns, \
|
|
relative_path
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
LIBRARY_URI_REPO = u'https://github.com/OttoWinter/esphomelib.git'
|
|
|
|
BUILD_FLASH_MODES = ['qio', 'qout', 'dio', 'dout']
|
|
StartupTrigger = esphomelib_ns.StartupTrigger
|
|
ShutdownTrigger = esphomelib_ns.ShutdownTrigger
|
|
LoopTrigger = esphomelib_ns.LoopTrigger
|
|
|
|
VERSION_REGEX = re.compile(r'^[0-9]+\.[0-9]+\.[0-9]+(?:-beta)?(?:-alpha)?$')
|
|
|
|
|
|
def validate_board(value):
|
|
if core.ESP_PLATFORM == ESP_PLATFORM_ESP8266:
|
|
board_pins = pins.ESP8266_BOARD_PINS
|
|
elif core.ESP_PLATFORM == ESP_PLATFORM_ESP32:
|
|
board_pins = pins.ESP32_BOARD_PINS
|
|
else:
|
|
raise NotImplementedError
|
|
|
|
if value not in board_pins:
|
|
raise vol.Invalid(u"Could not find board '{}'. Valid boards are {}".format(
|
|
value, u', '.join(pins.ESP8266_BOARD_PINS.keys())))
|
|
return value
|
|
|
|
|
|
def validate_simple_esphomelib_version(value):
|
|
value = cv.string_strict(value)
|
|
if value.upper() == 'LATEST':
|
|
return {
|
|
CONF_REPOSITORY: LIBRARY_URI_REPO,
|
|
CONF_TAG: 'v' + ESPHOMELIB_VERSION,
|
|
}
|
|
elif value.upper() == 'DEV':
|
|
return {
|
|
CONF_REPOSITORY: LIBRARY_URI_REPO,
|
|
CONF_BRANCH: 'master'
|
|
}
|
|
elif VERSION_REGEX.match(value) is not None:
|
|
return {
|
|
CONF_REPOSITORY: LIBRARY_URI_REPO,
|
|
CONF_TAG: 'v' + value,
|
|
}
|
|
return value
|
|
|
|
|
|
def validate_local_esphomelib_version(value):
|
|
value = cv.directory(value)
|
|
path = relative_path(value)
|
|
library_json = os.path.join(path, 'library.json')
|
|
if not os.path.exists(library_json):
|
|
raise vol.Invalid(u"Could not find '{}' file. '{}' does not seem to point to an "
|
|
u"esphomelib copy.".format(library_json, value))
|
|
return value
|
|
|
|
|
|
def validate_commit(value):
|
|
value = cv.string(value)
|
|
if re.match(r"^[0-9a-f]{7,}$", value) is None:
|
|
raise vol.Invalid("Commit option only accepts commit hashes in hex format.")
|
|
return value
|
|
|
|
|
|
ESPHOMELIB_VERSION_SCHEMA = vol.Any(
|
|
validate_simple_esphomelib_version,
|
|
vol.Schema({
|
|
vol.Required(CONF_LOCAL): validate_local_esphomelib_version,
|
|
}),
|
|
vol.All(
|
|
vol.Schema({
|
|
vol.Optional(CONF_REPOSITORY, default=LIBRARY_URI_REPO): cv.string,
|
|
vol.Optional(CONF_COMMIT): validate_commit,
|
|
vol.Optional(CONF_BRANCH): cv.string,
|
|
vol.Optional(CONF_TAG): cv.string,
|
|
}),
|
|
cv.has_at_most_one_key(CONF_COMMIT, CONF_BRANCH, CONF_TAG)
|
|
),
|
|
)
|
|
|
|
|
|
def validate_platform(value):
|
|
value = cv.string(value)
|
|
if value.upper() in ('ESP8266', 'ESPRESSIF8266'):
|
|
return ESP_PLATFORM_ESP8266
|
|
if value.upper() in ('ESP32', 'ESPRESSIF32'):
|
|
return ESP_PLATFORM_ESP32
|
|
raise vol.Invalid(u"Invalid platform '{}'. Only options are ESP8266 and ESP32. Please note "
|
|
u"the old way to use the latest arduino framework version has been split up "
|
|
u"into the arduino_version configuration option.".format(value))
|
|
|
|
|
|
PLATFORMIO_ESP8266_LUT = {
|
|
'2.4.2': 'espressif8266@1.8.0',
|
|
'2.4.1': 'espressif8266@1.7.3',
|
|
'2.4.0': 'espressif8266@1.6.0',
|
|
'2.3.0': 'espressif8266@1.5.0',
|
|
'RECOMMENDED': 'espressif8266@>=1.8.0',
|
|
'LATEST': 'espressif8266',
|
|
'DEV': ARDUINO_VERSION_ESP8266_DEV,
|
|
}
|
|
|
|
PLATFORMIO_ESP32_LUT = {
|
|
'1.0.0': 'espressif32@1.3.0',
|
|
'RECOMMENDED': 'espressif32@>=1.3.0',
|
|
'LATEST': 'espressif32',
|
|
'DEV': ARDUINO_VERSION_ESP32_DEV,
|
|
}
|
|
|
|
|
|
def validate_arduino_version(value):
|
|
value = cv.string_strict(value)
|
|
value_ = value.upper()
|
|
if core.ESP_PLATFORM == ESP_PLATFORM_ESP8266:
|
|
if VERSION_REGEX.match(value) is not None and value_ not in PLATFORMIO_ESP8266_LUT:
|
|
raise vol.Invalid("Unfortunately the arduino framework version '{}' is unsupported "
|
|
"at this time. You can override this by manually using "
|
|
"espressif8266@<platformio version>")
|
|
if value_ in PLATFORMIO_ESP8266_LUT:
|
|
return PLATFORMIO_ESP8266_LUT[value_]
|
|
return value
|
|
elif core.ESP_PLATFORM == ESP_PLATFORM_ESP32:
|
|
if VERSION_REGEX.match(value) is not None and value_ not in PLATFORMIO_ESP32_LUT:
|
|
raise vol.Invalid("Unfortunately the arduino framework version '{}' is unsupported "
|
|
"at this time. You can override this by manually using "
|
|
"espressif32@<platformio version>")
|
|
if value_ in PLATFORMIO_ESP32_LUT:
|
|
return PLATFORMIO_ESP32_LUT[value_]
|
|
return value
|
|
else:
|
|
raise NotImplementedError
|
|
|
|
|
|
def default_build_path():
|
|
return core.NAME
|
|
|
|
|
|
CONFIG_SCHEMA = vol.Schema({
|
|
vol.Required(CONF_NAME): cv.valid_name,
|
|
vol.Required(CONF_PLATFORM): vol.All(vol.Upper, cv.one_of('ESP8266', 'ESPRESSIF8266',
|
|
'ESP32', 'ESPRESSIF32')),
|
|
vol.Required(CONF_BOARD): validate_board,
|
|
vol.Optional(CONF_ESPHOMELIB_VERSION, default='latest'): ESPHOMELIB_VERSION_SCHEMA,
|
|
vol.Optional(CONF_ARDUINO_VERSION, default='recommended'): validate_arduino_version,
|
|
vol.Optional(CONF_USE_CUSTOM_CODE, default=False): cv.boolean,
|
|
vol.Optional(CONF_BUILD_PATH, default=default_build_path): cv.string,
|
|
|
|
vol.Optional(CONF_BOARD_FLASH_MODE): vol.All(vol.Lower, cv.one_of(*BUILD_FLASH_MODES)),
|
|
vol.Optional(CONF_ON_BOOT): vol.All(cv.ensure_list, [automation.validate_automation({
|
|
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_variable_id(StartupTrigger),
|
|
vol.Optional(CONF_PRIORITY): vol.Coerce(float),
|
|
})]),
|
|
vol.Optional(CONF_ON_SHUTDOWN): vol.All(cv.ensure_list, [automation.validate_automation({
|
|
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_variable_id(ShutdownTrigger),
|
|
})]),
|
|
vol.Optional(CONF_ON_LOOP): vol.All(cv.ensure_list, [automation.validate_automation({
|
|
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_variable_id(LoopTrigger),
|
|
})]),
|
|
|
|
vol.Optional('library_uri'): cv.invalid("The library_uri option has been removed in 1.8.0 and "
|
|
"was moved into the esphomelib_version option.")
|
|
})
|
|
|
|
|
|
def preload_core_config(config):
|
|
if CONF_ESPHOMEYAML not in config:
|
|
raise ESPHomeYAMLError(u"No esphomeyaml section in config")
|
|
core_conf = config[CONF_ESPHOMEYAML]
|
|
if CONF_PLATFORM not in core_conf:
|
|
raise ESPHomeYAMLError("esphomeyaml.platform not specified.")
|
|
if CONF_BOARD not in core_conf:
|
|
raise ESPHomeYAMLError("esphomeyaml.board not specified.")
|
|
if CONF_NAME not in core_conf:
|
|
raise ESPHomeYAMLError("esphomeyaml.name not specified.")
|
|
|
|
try:
|
|
core.ESP_PLATFORM = validate_platform(core_conf[CONF_PLATFORM])
|
|
core.BOARD = validate_board(core_conf[CONF_BOARD])
|
|
core.NAME = cv.valid_name(core_conf[CONF_NAME])
|
|
except vol.Invalid as e:
|
|
raise ESPHomeYAMLError(unicode(e))
|
|
|
|
|
|
def run_command(*args):
|
|
p = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
|
stdout, stderr = p.communicate()
|
|
rc = p.returncode
|
|
return rc, stdout, stderr
|
|
|
|
|
|
def update_esphomelib_repo(config):
|
|
esphomelib_version = config[CONF_ESPHOMELIB_VERSION]
|
|
if CONF_REPOSITORY not in esphomelib_version:
|
|
return
|
|
|
|
build_path = relative_path(config[CONF_BUILD_PATH])
|
|
esphomelib_path = os.path.join(build_path, '.piolibdeps', 'esphomelib')
|
|
is_default_branch = all(x not in esphomelib_version
|
|
for x in (CONF_BRANCH, CONF_TAG, CONF_COMMIT))
|
|
if not (CONF_BRANCH in esphomelib_version or is_default_branch):
|
|
# Git commit hash or tag cannot be updated
|
|
return
|
|
|
|
rc, _, _ = run_command('git', '-C', esphomelib_path, '--help')
|
|
if rc != 0:
|
|
# git not installed or repo not downloaded yet
|
|
return
|
|
rc, _, _ = run_command('git', '-C', esphomelib_path, 'diff-index', '--quiet', 'HEAD', '--')
|
|
if rc != 0:
|
|
# local changes, cannot update
|
|
_LOGGER.warn("Local changes in esphomelib copy from git. Will not auto-update.")
|
|
return
|
|
rc, _, _ = run_command('git', '-C', esphomelib_path, 'pull')
|
|
if rc != 0:
|
|
_LOGGER.warn("Couldn't auto-update local git copy of esphomelib.")
|
|
return
|
|
|
|
|
|
def to_code(config):
|
|
add(App.set_name(config[CONF_NAME]))
|
|
|
|
for conf in config.get(CONF_ON_BOOT, []):
|
|
rhs = App.register_component(StartupTrigger.new(conf.get(CONF_PRIORITY)))
|
|
trigger = Pvariable(conf[CONF_TRIGGER_ID], rhs)
|
|
automation.build_automation(trigger, NoArg, conf)
|
|
|
|
for conf in config.get(CONF_ON_SHUTDOWN, []):
|
|
trigger = Pvariable(conf[CONF_TRIGGER_ID], ShutdownTrigger.new())
|
|
automation.build_automation(trigger, const_char_p, conf)
|
|
|
|
for conf in config.get(CONF_ON_LOOP, []):
|
|
rhs = App.register_component(LoopTrigger.new())
|
|
trigger = Pvariable(conf[CONF_TRIGGER_ID], rhs)
|
|
automation.build_automation(trigger, NoArg, conf)
|
|
|
|
update_esphomelib_repo(config)
|