valve.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/log.h"
#include "esphome/core/preferences.h"
#include "valve_traits.h"
 
namespace esphome {
namespace valve {
 
const extern float VALVE_OPEN;
const extern float VALVE_CLOSED;
 
#define LOG_VALVE(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_ref().empty()) { \
      ESP_LOGCONFIG(TAG, "%s  Device Class: '%s'", prefix, (obj)->get_device_class_ref().c_str()); \
    } \
  }
 
class Valve;
 
class ValveCall {
 public:
  ValveCall(Valve *parent);
 
  ValveCall &set_command(const char *command);
  ValveCall &set_command_open();
  ValveCall &set_command_close();
  ValveCall &set_command_stop();
  ValveCall &set_command_toggle();
  ValveCall &set_position(float position);
  ValveCall &set_stop(bool stop);
 
  void perform();
 
  const optional<float> &get_position() const;
  bool get_stop() const;
  const optional<bool> &get_toggle() const;
 
 protected:
  void validate_();
 
  Valve *parent_;
  bool stop_{false};
  optional<float> position_{};
  optional<bool> toggle_{};
};
 
struct ValveRestoreState {
  float position;
 
  ValveCall to_call(Valve *valve);
  void apply(Valve *valve);
} __attribute__((packed));
 
enum ValveOperation : uint8_t {
  VALVE_OPERATION_IDLE = 0,
  VALVE_OPERATION_OPENING,
  VALVE_OPERATION_CLOSING,
};
 
const LogString *valve_operation_to_str(ValveOperation op);
 
class Valve : public EntityBase, public EntityBase_DeviceClass {
 public:
  explicit Valve();
 
  ValveOperation current_operation{VALVE_OPERATION_IDLE};
  float position;
 
  ValveCall make_call();
 
  void add_on_state_callback(std::function<void()> &&f);
 
  void publish_state(bool save = true);
 
  virtual ValveTraits get_traits() = 0;
 
  bool is_fully_open() const;
  bool is_fully_closed() const;
 
 protected:
  friend ValveCall;
 
  virtual void control(const ValveCall &call) = 0;
 
  optional<ValveRestoreState> restore_state_();
 
  CallbackManager<void()> state_callback_{};
 
  ESPPreferenceObject rtc_;
};
 
}  // namespace valve
}  // namespace esphome