mirror of
https://github.com/esphome/esphome.git
synced 2026-02-18 15:35:59 -07:00
115 lines
3.7 KiB
Python
115 lines
3.7 KiB
Python
import hashlib
|
|
|
|
from esphome import automation, codegen as cg, config_validation as cv
|
|
from esphome.const import (
|
|
CONF_ID,
|
|
CONF_INITIAL_VALUE,
|
|
CONF_RESTORE_VALUE,
|
|
CONF_TYPE,
|
|
CONF_VALUE,
|
|
)
|
|
from esphome.core import CoroPriority, coroutine_with_priority
|
|
from esphome.types import ConfigType
|
|
|
|
CODEOWNERS = ["@esphome/core"]
|
|
globals_ns = cg.esphome_ns.namespace("globals")
|
|
GlobalsComponent = globals_ns.class_("GlobalsComponent", cg.Component)
|
|
RestoringGlobalsComponent = globals_ns.class_(
|
|
"RestoringGlobalsComponent", cg.PollingComponent
|
|
)
|
|
RestoringGlobalStringComponent = globals_ns.class_(
|
|
"RestoringGlobalStringComponent", cg.PollingComponent
|
|
)
|
|
GlobalVarSetAction = globals_ns.class_("GlobalVarSetAction", automation.Action)
|
|
|
|
CONF_MAX_RESTORE_DATA_LENGTH = "max_restore_data_length"
|
|
|
|
# Base schema fields shared by both variants
|
|
_BASE_SCHEMA = {
|
|
cv.Required(CONF_ID): cv.declare_id(GlobalsComponent),
|
|
cv.Required(CONF_TYPE): cv.string_strict,
|
|
cv.Optional(CONF_INITIAL_VALUE): cv.string_strict,
|
|
cv.Optional(CONF_MAX_RESTORE_DATA_LENGTH): cv.int_range(0, 254),
|
|
}
|
|
|
|
# Non-restoring globals: regular Component (no polling needed)
|
|
_NON_RESTORING_SCHEMA = cv.Schema(
|
|
{
|
|
**_BASE_SCHEMA,
|
|
cv.Optional(CONF_RESTORE_VALUE, default=False): cv.boolean,
|
|
}
|
|
).extend(cv.COMPONENT_SCHEMA)
|
|
|
|
# Restoring globals: PollingComponent with configurable update_interval
|
|
_RESTORING_SCHEMA = cv.Schema(
|
|
{
|
|
**_BASE_SCHEMA,
|
|
cv.Optional(CONF_RESTORE_VALUE, default=True): cv.boolean,
|
|
}
|
|
).extend(cv.polling_component_schema("1s"))
|
|
|
|
|
|
def _globals_schema(config: ConfigType) -> ConfigType:
|
|
"""Select schema based on restore_value setting."""
|
|
if config.get(CONF_RESTORE_VALUE, False):
|
|
return _RESTORING_SCHEMA(config)
|
|
return _NON_RESTORING_SCHEMA(config)
|
|
|
|
|
|
MULTI_CONF = True
|
|
CONFIG_SCHEMA = _globals_schema
|
|
|
|
|
|
# Run with low priority so that namespaces are registered first
|
|
@coroutine_with_priority(CoroPriority.LATE)
|
|
async def to_code(config):
|
|
type_ = cg.RawExpression(config[CONF_TYPE])
|
|
restore = config[CONF_RESTORE_VALUE]
|
|
|
|
# Special casing the strings to their own class with a different save/restore mechanism
|
|
if str(type_) == "std::string" and restore:
|
|
template_args = cg.TemplateArguments(
|
|
type_, config.get(CONF_MAX_RESTORE_DATA_LENGTH, 63) + 1
|
|
)
|
|
type = RestoringGlobalStringComponent
|
|
else:
|
|
template_args = cg.TemplateArguments(type_)
|
|
type = RestoringGlobalsComponent if restore else GlobalsComponent
|
|
|
|
res_type = type.template(template_args)
|
|
initial_value = None
|
|
if CONF_INITIAL_VALUE in config:
|
|
initial_value = cg.RawExpression(config[CONF_INITIAL_VALUE])
|
|
|
|
rhs = type.new(template_args, initial_value)
|
|
glob = cg.Pvariable(config[CONF_ID], rhs, res_type)
|
|
await cg.register_component(glob, config)
|
|
|
|
if restore:
|
|
value = config[CONF_ID].id
|
|
if isinstance(value, str):
|
|
value = value.encode()
|
|
hash_ = int(hashlib.md5(value).hexdigest()[:8], 16)
|
|
cg.add(glob.set_name_hash(hash_))
|
|
|
|
|
|
@automation.register_action(
|
|
"globals.set",
|
|
GlobalVarSetAction,
|
|
cv.Schema(
|
|
{
|
|
cv.Required(CONF_ID): cv.use_id(GlobalsComponent),
|
|
cv.Required(CONF_VALUE): cv.templatable(cv.string_strict),
|
|
}
|
|
),
|
|
)
|
|
async def globals_set_to_code(config, action_id, template_arg, args):
|
|
full_id, paren = await cg.get_variable_with_full_id(config[CONF_ID])
|
|
template_arg = cg.TemplateArguments(full_id.type, *template_arg)
|
|
var = cg.new_Pvariable(action_id, template_arg, paren)
|
|
templ = await cg.templatable(
|
|
config[CONF_VALUE], args, None, to_exp=cg.RawExpression
|
|
)
|
|
cg.add(var.set_value(templ))
|
|
return var
|