update_entity.h

Go to the documentation of this file.

#pragma once

#include "esphome/core/automation.h"
#include "esphome/core/component.h"
#include "esphome/core/entity_base.h"

namespace esphome {
namespace update {

struct UpdateInfo {
  std::string latest_version;
  std::string current_version;
  std::string title;
  std::string summary;
  std::string release_url;
  std::string firmware_url;
  std::string md5;
  bool has_progress{false};
  float progress;
};

enum UpdateState : uint8_t {
  UPDATE_STATE_UNKNOWN,
  UPDATE_STATE_NO_UPDATE,
  UPDATE_STATE_AVAILABLE,
  UPDATE_STATE_INSTALLING,
};

class UpdateEntity : public EntityBase, public EntityBase_DeviceClass {
 public:
  bool has_state() const { return this->has_state_; }

  void publish_state();

  void perform() { this->perform(false); }
  virtual void perform(bool force) = 0;
  virtual void check() = 0;

  const UpdateInfo &update_info = update_info_;
  const UpdateState &state = state_;

  void add_on_state_callback(std::function<void()> &&callback) { this->state_callback_.add(std::move(callback)); }

 protected:
  UpdateState state_{UPDATE_STATE_UNKNOWN};
  UpdateInfo update_info_;
  bool has_state_{false};

  CallbackManager<void()> state_callback_{};
};

}  // namespace update
}  // namespace esphome