Speaker support (#4743)

esphome/components/speaker/__init__.py

@@ -0,0 +1,87 @@
+from esphome import automation
+import esphome.config_validation as cv
+import esphome.codegen as cg
+
+from esphome.automation import maybe_simple_id
+from esphome.const import CONF_ID, CONF_DATA
+from esphome.core import CORE
+from esphome.coroutine import coroutine_with_priority
+
+
+CODEOWNERS = ["@jesserockz"]
+
+IS_PLATFORM_COMPONENT = True
+
+speaker_ns = cg.esphome_ns.namespace("speaker")
+
+Speaker = speaker_ns.class_("Speaker")
+
+PlayAction = speaker_ns.class_(
+    "PlayAction", automation.Action, cg.Parented.template(Speaker)
+)
+StopAction = speaker_ns.class_(
+    "StopAction", automation.Action, cg.Parented.template(Speaker)
+)
+
+IsPlayingCondition = speaker_ns.class_("IsPlayingCondition", automation.Condition)
+
+
+async def setup_speaker_core_(var, config):
+    pass
+
+
+async def register_speaker(var, config):
+    if not CORE.has_id(config[CONF_ID]):
+        var = cg.Pvariable(config[CONF_ID], var)
+    await setup_speaker_core_(var, config)
+
+
+SPEAKER_SCHEMA = cv.Schema({})
+
+
+SPEAKER_AUTOMATION_SCHEMA = maybe_simple_id({cv.GenerateID(): cv.use_id(Speaker)})
+
+
+async def speaker_action(config, action_id, template_arg, args):
+    var = cg.new_Pvariable(action_id, template_arg)
+    await cg.register_parented(var, config[CONF_ID])
+    return var
+
+
+@automation.register_action(
+    "speaker.play",
+    PlayAction,
+    cv.maybe_simple_value(
+        {
+            cv.GenerateID(): cv.use_id(Speaker),
+            cv.Required(CONF_DATA): cv.templatable(cv.ensure_list(cv.hex_uint8_t)),
+        },
+        key=CONF_DATA,
+    ),
+)
+async def speaker_play_action(config, action_id, template_arg, args):
+    var = cg.new_Pvariable(action_id, template_arg)
+    await cg.register_parented(var, config[CONF_ID])
+    data = config[CONF_DATA]
+
+    if cg.is_template(data):
+        templ = await cg.templatable(data, args, cg.std_vector.template(cg.uint8))
+        cg.add(var.set_data_template(templ))
+    else:
+        cg.add(var.set_data_static(data))
+    return var
+
+
+automation.register_action("speaker.stop", StopAction, SPEAKER_AUTOMATION_SCHEMA)(
+    speaker_action
+)
+
+automation.register_condition(
+    "speaker.is_playing", IsPlayingCondition, SPEAKER_AUTOMATION_SCHEMA
+)(speaker_action)
+
+
+@coroutine_with_priority(100.0)
+async def to_code(config):
+    cg.add_global(speaker_ns.using)
+    cg.add_define("USE_SPEAKER")

esphome/components/speaker/automation.h

@@ -0,0 +1,48 @@
+#pragma once
+
+#include "esphome/core/automation.h"
+#include "speaker.h"
+
+#include <vector>
+
+namespace esphome {
+namespace speaker {
+
+template<typename... Ts> class PlayAction : public Action<Ts...>, public Parented<Speaker> {
+ public:
+  void set_data_template(std::function<std::vector<uint8_t>(Ts...)> func) {
+    this->data_func_ = func;
+    this->static_ = false;
+  }
+  void set_data_static(const std::vector<uint8_t> &data) {
+    this->data_static_ = data;
+    this->static_ = true;
+  }
+
+  void play(Ts... x) override {
+    if (this->static_) {
+      this->parent_->play(this->data_static_);
+    } else {
+      auto val = this->data_func_(x...);
+      this->parent_->play(val);
+    }
+  }
+
+ protected:
+  bool static_{false};
+  std::function<std::vector<uint8_t>(Ts...)> data_func_{};
+  std::vector<uint8_t> data_static_{};
+};
+
+template<typename... Ts> class StopAction : public Action<Ts...>, public Parented<Speaker> {
+ public:
+  void play(Ts... x) override { this->parent_->stop(); }
+};
+
+template<typename... Ts> class IsPlayingCondition : public Condition<Ts...>, public Parented<Speaker> {
+ public:
+  bool check(Ts... x) override { return this->parent_->is_running(); }
+};
+
+}  // namespace speaker
+}  // namespace esphome

esphome/components/speaker/speaker.h

@@ -0,0 +1,27 @@
+#pragma once
+
+namespace esphome {
+namespace speaker {
+
+enum State : uint8_t {
+  STATE_STOPPED = 0,
+  STATE_STARTING,
+  STATE_RUNNING,
+  STATE_STOPPING,
+};
+
+class Speaker {
+ public:
+  virtual bool play(const uint8_t *data, size_t length) = 0;
+  virtual bool play(const std::vector<uint8_t> &data) { return this->play(data.data(), data.size()); }
+
+  virtual void stop() = 0;
+
+  bool is_running() const { return this->state_ == STATE_RUNNING; }
+
+ protected:
+  State state_{STATE_STOPPED};
+};
+
+}  // namespace speaker
+}  // namespace esphome