float_output.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/core/component.h"
#include "esphome/core/defines.h"
#include "binary_output.h"
 
namespace esphome::output {
 
#ifdef USE_OUTPUT_FLOAT_POWER_SCALING
#define LOG_FLOAT_OUTPUT(this) \
  LOG_BINARY_OUTPUT(this) \
  if (this->max_power_ != 1.0f) { \
    ESP_LOGCONFIG(TAG, "  Max Power: %.1f%%", this->max_power_ * 100.0f); \
  } \
  if (this->min_power_ != 0.0f) { \
    ESP_LOGCONFIG(TAG, "  Min Power: %.1f%%", this->min_power_ * 100.0f); \
  }
#else
#define LOG_FLOAT_OUTPUT(this) LOG_BINARY_OUTPUT(this)
#endif
 
class FloatOutput : public BinaryOutput {
 public:
#ifdef USE_OUTPUT_FLOAT_POWER_SCALING
  void set_max_power(float max_power);
 
  void set_min_power(float min_power);
 
  void set_zero_means_zero(bool zero_means_zero) { this->zero_means_zero_ = zero_means_zero; }
#else
  // Compile-time guards for users calling these methods from lambdas (documented usage at
  // https://esphome.io/components/output/#output-set_min_power_action). When power scaling
  // is compiled out, these template stubs fail to compile with an actionable error pointing
  // at the user's lambda. Templating on a default-false bool means static_assert only fires
  // on instantiation (i.e. when the user actually calls the method), not on every parse.
  template<bool _use_output_float_power_scaling = false> void set_max_power(float max_power) {
    static_assert(_use_output_float_power_scaling,
                  "set_max_power() requires USE_OUTPUT_FLOAT_POWER_SCALING. "
                  "To enable it, add 'max_power: 100%' (or any value) to one output entry in your YAML — "
                  "the codegen will then keep the scaling fields. "
                  "See https://esphome.io/components/output/ for details.");
  }
  template<bool _use_output_float_power_scaling = false> void set_min_power(float min_power) {
    static_assert(_use_output_float_power_scaling,
                  "set_min_power() requires USE_OUTPUT_FLOAT_POWER_SCALING. "
                  "To enable it, add 'min_power: 0%' (or any value) to one output entry in your YAML — "
                  "the codegen will then keep the scaling fields. "
                  "See https://esphome.io/components/output/ for details.");
  }
  template<bool _use_output_float_power_scaling = false> void set_zero_means_zero(bool zero_means_zero) {
    static_assert(_use_output_float_power_scaling,
                  "set_zero_means_zero() requires USE_OUTPUT_FLOAT_POWER_SCALING. "
                  "To enable it, add 'zero_means_zero: true' to one output entry in your YAML.");
  }
#endif
 
  void set_level(float state);
 
  virtual void update_frequency(float frequency) {}
 
  // ========== INTERNAL METHODS ==========
  // (In most use cases you won't need these)
 
#ifdef USE_OUTPUT_FLOAT_POWER_SCALING
  float get_max_power() const { return this->max_power_; }
 
  float get_min_power() const { return this->min_power_; }
#else
  float get_max_power() const { return 1.0f; }
 
  float get_min_power() const { return 0.0f; }
#endif
 
 protected:
  void write_state(bool state) override;
  virtual void write_state(float state) = 0;
 
#ifdef USE_OUTPUT_FLOAT_POWER_SCALING
  float max_power_{1.0f};
  float min_power_{0.0f};
  bool zero_means_zero_{false};
#endif
};
 
}  // namespace esphome::output