mirror of
https://github.com/esphome/esphome.git
synced 2025-10-04 11:02:19 +01:00
e1732c4945
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Keith Burzinski <kbx81x@gmail.com>
100 lines
3.1 KiB
Python
100 lines
3.1 KiB
Python
from esphome import automation
|
|
import esphome.codegen as cg
|
|
from esphome.components import lock
|
|
import esphome.config_validation as cv
|
|
from esphome.const import (
|
|
CONF_ASSUMED_STATE,
|
|
CONF_ID,
|
|
CONF_LAMBDA,
|
|
CONF_LOCK_ACTION,
|
|
CONF_OPEN_ACTION,
|
|
CONF_OPTIMISTIC,
|
|
CONF_STATE,
|
|
CONF_UNLOCK_ACTION,
|
|
)
|
|
|
|
from .. import template_ns
|
|
|
|
TemplateLock = template_ns.class_("TemplateLock", lock.Lock, cg.Component)
|
|
|
|
TemplateLockPublishAction = template_ns.class_(
|
|
"TemplateLockPublishAction",
|
|
automation.Action,
|
|
cg.Parented.template(TemplateLock),
|
|
)
|
|
|
|
|
|
def validate(config):
|
|
if not config[CONF_OPTIMISTIC] and (
|
|
CONF_LOCK_ACTION not in config or CONF_UNLOCK_ACTION not in config
|
|
):
|
|
raise cv.Invalid(
|
|
"Either optimistic mode must be enabled, or lock_action and unlock_action must be set, "
|
|
"to handle the lock being changed."
|
|
)
|
|
return config
|
|
|
|
|
|
CONFIG_SCHEMA = cv.All(
|
|
lock.lock_schema(TemplateLock)
|
|
.extend(
|
|
{
|
|
cv.Optional(CONF_LAMBDA): cv.returning_lambda,
|
|
cv.Optional(CONF_OPTIMISTIC, default=False): cv.boolean,
|
|
cv.Optional(CONF_ASSUMED_STATE, default=False): cv.boolean,
|
|
cv.Optional(CONF_UNLOCK_ACTION): automation.validate_automation(
|
|
single=True
|
|
),
|
|
cv.Optional(CONF_LOCK_ACTION): automation.validate_automation(single=True),
|
|
cv.Optional(CONF_OPEN_ACTION): automation.validate_automation(single=True),
|
|
}
|
|
)
|
|
.extend(cv.COMPONENT_SCHEMA),
|
|
validate,
|
|
)
|
|
|
|
|
|
async def to_code(config):
|
|
var = await lock.new_lock(config)
|
|
await cg.register_component(var, config)
|
|
|
|
if CONF_LAMBDA in config:
|
|
template_ = await cg.process_lambda(
|
|
config[CONF_LAMBDA], [], return_type=cg.optional.template(lock.LockState)
|
|
)
|
|
cg.add(var.set_state_lambda(template_))
|
|
if CONF_UNLOCK_ACTION in config:
|
|
await automation.build_automation(
|
|
var.get_unlock_trigger(), [], config[CONF_UNLOCK_ACTION]
|
|
)
|
|
if CONF_LOCK_ACTION in config:
|
|
await automation.build_automation(
|
|
var.get_lock_trigger(), [], config[CONF_LOCK_ACTION]
|
|
)
|
|
if CONF_OPEN_ACTION in config:
|
|
await automation.build_automation(
|
|
var.get_open_trigger(), [], config[CONF_OPEN_ACTION]
|
|
)
|
|
cg.add(var.traits.set_supports_open(CONF_OPEN_ACTION in config))
|
|
cg.add(var.traits.set_assumed_state(config[CONF_ASSUMED_STATE]))
|
|
cg.add(var.set_optimistic(config[CONF_OPTIMISTIC]))
|
|
|
|
|
|
@automation.register_action(
|
|
"lock.template.publish",
|
|
TemplateLockPublishAction,
|
|
cv.maybe_simple_value(
|
|
{
|
|
cv.GenerateID(): cv.use_id(TemplateLock),
|
|
cv.Required(CONF_STATE): cv.templatable(lock.validate_lock_state),
|
|
},
|
|
key=CONF_STATE,
|
|
),
|
|
)
|
|
async def lock_template_publish_to_code(config, action_id, template_arg, args):
|
|
var = cg.new_Pvariable(action_id, template_arg)
|
|
await cg.register_parented(var, config[CONF_ID])
|
|
template_ = await cg.templatable(config[CONF_STATE], args, lock.LockState)
|
|
cg.add(var.set_state(template_))
|
|
return var
|