New script modes POC (#1168)

Co-authored-by: Guillermo Ruffino <glm.net@gmail.com>

esphome/components/script/__init__.py

@@ -2,7 +2,7 @@ import esphome.codegen as cg
 import esphome.config_validation as cv
 from esphome import automation
 from esphome.automation import maybe_simple_id
-from esphome.const import CONF_ID
+from esphome.const import CONF_ID, CONF_MODE
 
 script_ns = cg.esphome_ns.namespace('script')
 Script = script_ns.class_('Script', automation.Trigger.template())
@@ -10,10 +10,47 @@ ScriptExecuteAction = script_ns.class_('ScriptExecuteAction', automation.Action)
 ScriptStopAction = script_ns.class_('ScriptStopAction', automation.Action)
 ScriptWaitAction = script_ns.class_('ScriptWaitAction', automation.Action, cg.Component)
 IsRunningCondition = script_ns.class_('IsRunningCondition', automation.Condition)
+SingleScript = script_ns.class_('SingleScript', Script)
+RestartScript = script_ns.class_('RestartScript', Script)
+QueueingScript = script_ns.class_('QueueingScript', Script, cg.Component)
+ParallelScript = script_ns.class_('ParallelScript', Script)
+
+CONF_SINGLE = 'single'
+CONF_RESTART = 'restart'
+CONF_QUEUE = 'queue'
+CONF_PARALLEL = 'parallel'
+CONF_MAX_RUNS = 'max_runs'
+
+SCRIPT_MODES = {
+    CONF_SINGLE: SingleScript,
+    CONF_RESTART: RestartScript,
+    CONF_QUEUE: QueueingScript,
+    CONF_PARALLEL: ParallelScript,
+}
+
+
+def check_max_runs(value):
+    if CONF_MAX_RUNS not in value:
+        return value
+    if value[CONF_MODE] not in [CONF_QUEUE, CONF_PARALLEL]:
+        raise cv.Invalid("The option 'max_runs' is only valid in 'queue' and 'parallel' mode.",
+                         path=[CONF_MAX_RUNS])
+    return value
+
+
+def assign_declare_id(value):
+    value = value.copy()
+    value[CONF_ID] = cv.declare_id(SCRIPT_MODES[value[CONF_MODE]])(value[CONF_ID])
+    return value
+
 
 CONFIG_SCHEMA = automation.validate_automation({
-    cv.Required(CONF_ID): cv.declare_id(Script),
-})
+    # Don't declare id as cv.declare_id yet, because the ID type
+    # dpeends on the mode. Will be checked later with assign_declare_id
+    cv.Required(CONF_ID): cv.string_strict,
+    cv.Optional(CONF_MODE, default=CONF_SINGLE): cv.one_of(*SCRIPT_MODES, lower=True),
+    cv.Optional(CONF_MAX_RUNS): cv.positive_int,
+}, extra_validators=cv.All(check_max_runs, assign_declare_id))
 
 
 def to_code(config):
@@ -21,6 +58,15 @@ def to_code(config):
     triggers = []
     for conf in config:
         trigger = cg.new_Pvariable(conf[CONF_ID])
+        # Add a human-readable name to the script
+        cg.add(trigger.set_name(conf[CONF_ID].id))
+
+        if CONF_MAX_RUNS in conf:
+            cg.add(trigger.set_max_runs(conf[CONF_MAX_RUNS]))
+
+        if conf[CONF_MODE] == CONF_QUEUE:
+            yield cg.register_component(trigger, conf)
+
         triggers.append((trigger, conf))
 
     for trigger, conf in triggers: