ESPHome  2021.11.4
Data Structures | Enumerations | Functions | Variables
esphome::fan Namespace Reference

Data Structures

class  CycleSpeedAction
 
class  FanIsOffCondition
 
class  FanIsOnCondition
 
class  FanSpeedSetTrigger
 
class  FanState
 
class  FanStateCall
 
class  FanTraits
 
class  FanTurnOffTrigger
 
class  FanTurnOnTrigger
 
class  ToggleAction
 
class  TurnOffAction
 
class  TurnOnAction
 

Enumerations

enum  FanDirection { FAN_DIRECTION_FORWARD = 0, FAN_DIRECTION_REVERSE = 1 }
 Simple enum to represent the direction of a fan. More...
 

Functions

FanSpeed speed_level_to_enum (int speed_level, int supported_speed_levels)
 
int speed_enum_to_level (FanSpeed speed, int supported_speed_levels)
 
 ESPDEPRECATED ("FanSpeed and speed_level_to_enum() are deprecated.", "2021.9") FanSpeed speed_level_to_enum(int speed_level
 
 ESPDEPRECATED ("FanSpeed and speed_enum_to_level() are deprecated.", "2021.9") int speed_enum_to_level(FanSpeed speed
 
enum ESPDEPRECATED ("FanSpeed is deprecated.", "2021.9") FanSpeed
 Simple enum to represent the speed of a fan. - DEPRECATED - Will be deleted soon. More...
 

Variables

int supported_speed_levels
 

Enumeration Type Documentation

◆ FanDirection

Simple enum to represent the direction of a fan.

Enumerator
FAN_DIRECTION_FORWARD 
FAN_DIRECTION_REVERSE 

Definition at line 21 of file fan_state.h.

Function Documentation

◆ ESPDEPRECATED() [1/3]

esphome::fan::ESPDEPRECATED ( "FanSpeed and speed_level_to_enum() are deprecated."  ,
"2021.9"   
)

◆ ESPDEPRECATED() [2/3]

esphome::fan::ESPDEPRECATED ( "FanSpeed and speed_enum_to_level() are deprecated."  ,
"2021.9"   
)

◆ ESPDEPRECATED() [3/3]

enum esphome::fan::ESPDEPRECATED ( "FanSpeed is deprecated."  ,
"2021.9"   
)

Simple enum to represent the speed of a fan. - DEPRECATED - Will be deleted soon.

< The fan is running on low speed.

< The fan is running on medium speed.

< The fan is running on high/full speed.

Definition at line 14 of file fan_state.h.

◆ speed_enum_to_level()

int esphome::fan::speed_enum_to_level ( FanSpeed  speed,
int  supported_speed_levels 
)

Definition at line 16 of file fan_helpers.cpp.

◆ speed_level_to_enum()

FanSpeed esphome::fan::speed_level_to_enum ( int  speed_level,
int  supported_speed_levels 
)

Definition at line 10 of file fan_helpers.cpp.

Variable Documentation

◆ supported_speed_levels

int esphome::fan::supported_speed_levels

Definition at line 12 of file fan_helpers.h.