cover.h

Go to the documentation of this file.

#pragma once

#include "esphome/core/component.h"
#include "esphome/core/entity_base.h"
#include "esphome/core/helpers.h"
#include "esphome/core/preferences.h"
#include "cover_traits.h"

namespace esphome {
namespace cover {

const extern float COVER_OPEN;
const extern float COVER_CLOSED;

#define LOG_COVER(prefix, type, obj) \
  if ((obj) != nullptr) { \
    ESP_LOGCONFIG(TAG, "%s%s '%s'", prefix, LOG_STR_LITERAL(type), (obj)->get_name().c_str()); \
    auto traits_ = (obj)->get_traits(); \
    if (traits_.get_is_assumed_state()) { \
      ESP_LOGCONFIG(TAG, "%s  Assumed State: YES", prefix); \
    } \
    if (!(obj)->get_device_class().empty()) { \
      ESP_LOGCONFIG(TAG, "%s  Device Class: '%s'", prefix, (obj)->get_device_class().c_str()); \
    } \
  }

class Cover;

class CoverCall {
 public:
  CoverCall(Cover *parent);

  CoverCall &set_command(const char *command);
  CoverCall &set_command_open();
  CoverCall &set_command_close();
  CoverCall &set_command_stop();
  CoverCall &set_command_toggle();
  CoverCall &set_position(float position);
  CoverCall &set_tilt(float tilt);
  CoverCall &set_stop(bool stop);

  void perform();

  const optional<float> &get_position() const;
  bool get_stop() const;
  const optional<float> &get_tilt() const;
  const optional<bool> &get_toggle() const;

 protected:
  void validate_();

  Cover *parent_;
  bool stop_{false};
  optional<float> position_{};
  optional<float> tilt_{};
  optional<bool> toggle_{};
};

struct CoverRestoreState {
  float position;
  float tilt;

  CoverCall to_call(Cover *cover);
  void apply(Cover *cover);
} __attribute__((packed));

enum CoverOperation : uint8_t {
  COVER_OPERATION_IDLE = 0,
  COVER_OPERATION_OPENING,
  COVER_OPERATION_CLOSING,
};

const char *cover_operation_to_str(CoverOperation op);

class Cover : public EntityBase, public EntityBase_DeviceClass {
 public:
  explicit Cover();

  CoverOperation current_operation{COVER_OPERATION_IDLE};
  float position;
  float tilt{COVER_OPEN};

  CoverCall make_call();
  ESPDEPRECATED("open() is deprecated, use make_call().set_command_open().perform() instead.", "2021.9")
  void open();
  ESPDEPRECATED("close() is deprecated, use make_call().set_command_close().perform() instead.", "2021.9")
  void close();
  ESPDEPRECATED("stop() is deprecated, use make_call().set_command_stop().perform() instead.", "2021.9")
  void stop();

  void add_on_state_callback(std::function<void()> &&f);

  void publish_state(bool save = true);

  virtual CoverTraits get_traits() = 0;

  bool is_fully_open() const;
  bool is_fully_closed() const;

 protected:
  friend CoverCall;

  virtual void control(const CoverCall &call) = 0;

  optional<CoverRestoreState> restore_state_();

  CallbackManager<void()> state_callback_{};

  ESPPreferenceObject rtc_;
};

}  // namespace cover
}  // namespace esphome