ESPHome  2022.5.1
Public Member Functions | Protected Attributes
esphome::fan::FanTraits Class Reference

#include <fan_traits.h>

Public Member Functions

 FanTraits ()=default
 
 FanTraits (bool oscillation, bool speed, bool direction, int speed_count)
 
bool supports_oscillation () const
 Return if this fan supports oscillation. More...
 
void set_oscillation (bool oscillation)
 Set whether this fan supports oscillation. More...
 
bool supports_speed () const
 Return if this fan supports speed modes. More...
 
void set_speed (bool speed)
 Set whether this fan supports speed levels. More...
 
int supported_speed_count () const
 Return how many speed levels the fan has. More...
 
void set_supported_speed_count (int speed_count)
 Set how many speed levels this fan has. More...
 
bool supports_direction () const
 Return if this fan supports changing direction. More...
 
void set_direction (bool direction)
 Set whether this fan supports changing direction. More...
 

Protected Attributes

bool oscillation_ {false}
 
bool speed_ {false}
 
bool direction_ {false}
 
int speed_count_ {}
 

Detailed Description

Definition at line 6 of file fan_traits.h.

Constructor & Destructor Documentation

◆ FanTraits() [1/2]

esphome::fan::FanTraits::FanTraits ( )
default

◆ FanTraits() [2/2]

esphome::fan::FanTraits::FanTraits ( bool  oscillation,
bool  speed,
bool  direction,
int  speed_count 
)
inline

Definition at line 9 of file fan_traits.h.

Member Function Documentation

◆ set_direction()

void esphome::fan::FanTraits::set_direction ( bool  direction)
inline

Set whether this fan supports changing direction.

Definition at line 27 of file fan_traits.h.

◆ set_oscillation()

void esphome::fan::FanTraits::set_oscillation ( bool  oscillation)
inline

Set whether this fan supports oscillation.

Definition at line 15 of file fan_traits.h.

◆ set_speed()

void esphome::fan::FanTraits::set_speed ( bool  speed)
inline

Set whether this fan supports speed levels.

Definition at line 19 of file fan_traits.h.

◆ set_supported_speed_count()

void esphome::fan::FanTraits::set_supported_speed_count ( int  speed_count)
inline

Set how many speed levels this fan has.

Definition at line 23 of file fan_traits.h.

◆ supported_speed_count()

int esphome::fan::FanTraits::supported_speed_count ( ) const
inline

Return how many speed levels the fan has.

Definition at line 21 of file fan_traits.h.

◆ supports_direction()

bool esphome::fan::FanTraits::supports_direction ( ) const
inline

Return if this fan supports changing direction.

Definition at line 25 of file fan_traits.h.

◆ supports_oscillation()

bool esphome::fan::FanTraits::supports_oscillation ( ) const
inline

Return if this fan supports oscillation.

Definition at line 13 of file fan_traits.h.

◆ supports_speed()

bool esphome::fan::FanTraits::supports_speed ( ) const
inline

Return if this fan supports speed modes.

Definition at line 17 of file fan_traits.h.

Field Documentation

◆ direction_

bool esphome::fan::FanTraits::direction_ {false}
protected

Definition at line 32 of file fan_traits.h.

◆ oscillation_

bool esphome::fan::FanTraits::oscillation_ {false}
protected

Definition at line 30 of file fan_traits.h.

◆ speed_

bool esphome::fan::FanTraits::speed_ {false}
protected

Definition at line 31 of file fan_traits.h.

◆ speed_count_

int esphome::fan::FanTraits::speed_count_ {}
protected

Definition at line 33 of file fan_traits.h.


The documentation for this class was generated from the following file: