Add ANNOUNCING state to media_player. (#6691)

esphome/components/media_player/__init__.py

@@ -51,12 +51,16 @@ VolumeSetAction = media_player_ns.class_(
 
 CONF_ON_PLAY = "on_play"
 CONF_ON_PAUSE = "on_pause"
+CONF_ON_ANNOUNCEMENT = "on_announcement"
 CONF_MEDIA_URL = "media_url"
 
 StateTrigger = media_player_ns.class_("StateTrigger", automation.Trigger.template())
 IdleTrigger = media_player_ns.class_("IdleTrigger", automation.Trigger.template())
 PlayTrigger = media_player_ns.class_("PlayTrigger", automation.Trigger.template())
 PauseTrigger = media_player_ns.class_("PauseTrigger", automation.Trigger.template())
+AnnoucementTrigger = media_player_ns.class_(
+    "AnnouncementTrigger", automation.Trigger.template()
+)
 IsIdleCondition = media_player_ns.class_("IsIdleCondition", automation.Condition)
 IsPlayingCondition = media_player_ns.class_("IsPlayingCondition", automation.Condition)
 
@@ -75,6 +79,9 @@ async def setup_media_player_core_(var, config):
     for conf in config.get(CONF_ON_PAUSE, []):
         trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
         await automation.build_automation(trigger, [], conf)
+    for conf in config.get(CONF_ON_ANNOUNCEMENT, []):
+        trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
+        await automation.build_automation(trigger, [], conf)
 
 
 async def register_media_player(var, config):
@@ -106,6 +113,11 @@ MEDIA_PLAYER_SCHEMA = cv.ENTITY_BASE_SCHEMA.extend(
                 cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(PauseTrigger),
             }
         ),
+        cv.Optional(CONF_ON_ANNOUNCEMENT): automation.validate_automation(
+            {
+                cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(AnnoucementTrigger),
+            }
+        ),
     }
 )
 

esphome/components/media_player/automation.h

@@ -52,6 +52,7 @@ class StateTrigger : public Trigger<> {
 MEDIA_PLAYER_SIMPLE_STATE_TRIGGER(IdleTrigger, IDLE)
 MEDIA_PLAYER_SIMPLE_STATE_TRIGGER(PlayTrigger, PLAYING)
 MEDIA_PLAYER_SIMPLE_STATE_TRIGGER(PauseTrigger, PAUSED)
+MEDIA_PLAYER_SIMPLE_STATE_TRIGGER(AnnouncementTrigger, ANNOUNCING)
 
 template<typename... Ts> class IsIdleCondition : public Condition<Ts...>, public Parented<MediaPlayer> {
  public:

esphome/components/media_player/media_player.cpp

@@ -15,6 +15,8 @@ const char *media_player_state_to_string(MediaPlayerState state) {
       return "PLAYING";
     case MEDIA_PLAYER_STATE_PAUSED:
       return "PAUSED";
+    case MEDIA_PLAYER_STATE_ANNOUNCING:
+      return "ANNOUNCING";
     case MEDIA_PLAYER_STATE_NONE:
     default:
       return "UNKNOWN";
@@ -68,6 +70,9 @@ void MediaPlayerCall::perform() {
   if (this->volume_.has_value()) {
     ESP_LOGD(TAG, "  Volume: %.2f", this->volume_.value());
   }
+  if (this->announcement_.has_value()) {
+    ESP_LOGD(TAG, " Announcement: %s", this->announcement_.value() ? "yes" : "no");
+  }
   this->parent_->control(*this);
 }
 
@@ -108,6 +113,11 @@ MediaPlayerCall &MediaPlayerCall::set_volume(float volume) {
   return *this;
 }
 
+MediaPlayerCall &MediaPlayerCall::set_announcement(bool announce) {
+  this->announcement_ = announce;
+  return *this;
+}
+
 void MediaPlayer::add_on_state_callback(std::function<void()> &&callback) {
   this->state_callback_.add(std::move(callback));
 }

esphome/components/media_player/media_player.h

@@ -10,7 +10,8 @@ enum MediaPlayerState : uint8_t {
   MEDIA_PLAYER_STATE_NONE = 0,
   MEDIA_PLAYER_STATE_IDLE = 1,
   MEDIA_PLAYER_STATE_PLAYING = 2,
-  MEDIA_PLAYER_STATE_PAUSED = 3
+  MEDIA_PLAYER_STATE_PAUSED = 3,
+  MEDIA_PLAYER_STATE_ANNOUNCING = 4
 };
 const char *media_player_state_to_string(MediaPlayerState state);
 
@@ -51,12 +52,14 @@ class MediaPlayerCall {
   MediaPlayerCall &set_media_url(const std::string &url);
 
   MediaPlayerCall &set_volume(float volume);
+  MediaPlayerCall &set_announcement(bool announce);
 
   void perform();
 
   const optional<MediaPlayerCommand> &get_command() const { return command_; }
   const optional<std::string> &get_media_url() const { return media_url_; }
   const optional<float> &get_volume() const { return volume_; }
+  const optional<bool> &get_announcement() const { return announcement_; }
 
  protected:
   void validate_();
@@ -64,6 +67,7 @@ class MediaPlayerCall {
   optional<MediaPlayerCommand> command_;
   optional<std::string> media_url_;
   optional<float> volume_;
+  optional<bool> announcement_;
 };
 
 class MediaPlayer : public EntityBase {