fan_traits.h

Go to the documentation of this file.

#pragma once
 
#include <cstring>
#include <vector>
#include <initializer_list>
 
namespace esphome {
 
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; }
  const std::vector<const char *> &supported_preset_modes() const { return this->preset_modes_; }
  void set_supported_preset_modes(std::initializer_list<const char *> preset_modes) {
    this->preset_modes_ = preset_modes;
  }
  void set_supported_preset_modes(const std::vector<const char *> &preset_modes) { this->preset_modes_ = preset_modes; }
 
  // Deleted overloads to catch incorrect std::string usage at compile time with clear error messages
  void set_supported_preset_modes(const std::vector<std::string> &preset_modes) = delete;
  void set_supported_preset_modes(std::initializer_list<std::string> preset_modes) = delete;
 
  bool supports_preset_modes() const { return !this->preset_modes_.empty(); }
  const char *find_preset_mode(const char *preset_mode) const {
    return this->find_preset_mode(preset_mode, preset_mode ? strlen(preset_mode) : 0);
  }
  const char *find_preset_mode(const char *preset_mode, size_t len) const {
    if (preset_mode == nullptr || len == 0)
      return nullptr;
    for (const char *mode : this->preset_modes_) {
      if (strncmp(mode, preset_mode, len) == 0 && mode[len] == '\0') {
        return mode;  // Return pointer from traits
      }
    }
    return nullptr;
  }
 
 protected:
  bool oscillation_{false};
  bool speed_{false};
  bool direction_{false};
  int speed_count_{};
  std::vector<const char *> preset_modes_{};
};
 
}  // namespace fan
}  // namespace esphome