fan_traits.h

Go to the documentation of this file.

#include <set>
#include <utility>
 
#pragma once
 
namespace esphome {
 
#ifdef USE_API
namespace api {
class APIConnection;
}  // namespace api
#endif
 
namespace fan {
 
class FanTraits {
 public:
  FanTraits() = default;
  FanTraits(bool oscillation, bool speed, bool direction, int speed_count)
      : oscillation_(oscillation), speed_(speed), direction_(direction), speed_count_(speed_count) {}
 
  bool supports_oscillation() const { return this->oscillation_; }
  void set_oscillation(bool oscillation) { this->oscillation_ = oscillation; }
  bool supports_speed() const { return this->speed_; }
  void set_speed(bool speed) { this->speed_ = speed; }
  int supported_speed_count() const { return this->speed_count_; }
  void set_supported_speed_count(int speed_count) { this->speed_count_ = speed_count; }
  bool supports_direction() const { return this->direction_; }
  void set_direction(bool direction) { this->direction_ = direction; }
  std::set<std::string> supported_preset_modes() const { return this->preset_modes_; }
  void set_supported_preset_modes(const std::set<std::string> &preset_modes) { this->preset_modes_ = preset_modes; }
  bool supports_preset_modes() const { return !this->preset_modes_.empty(); }
 
 protected:
#ifdef USE_API
  // The API connection is a friend class to access internal methods
  friend class api::APIConnection;
  // This method returns a reference to the internal preset modes set.
  // It is used by the API to avoid copying data when encoding messages.
  // Warning: Do not use this method outside of the API connection code.
  // It returns a reference to internal data that can be invalidated.
  const std::set<std::string> &supported_preset_modes_for_api_() const { return this->preset_modes_; }
#endif
  bool oscillation_{false};
  bool speed_{false};
  bool direction_{false};
  int speed_count_{};
  std::set<std::string> preset_modes_{};
};
 
}  // namespace fan
}  // namespace esphome