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

Data Structures

class  CycleSpeedAction
 
class  Fan
 
class  FanCall
 
class  FanIsOffCondition
 
class  FanIsOnCondition
 
struct  FanRestoreState
 
class  FanSpeedSetTrigger
 
class  FanTraits
 
class  FanTurnOffTrigger
 
class  FanTurnOnTrigger
 
class  ToggleAction
 
class  TurnOffAction
 
class  TurnOnAction
 

Enumerations

enum  FanDirection { FanDirection::FORWARD = 0, FanDirection::REVERSE = 1 }
 Simple enum to represent the direction of a fan. More...
 
enum  FanRestoreMode {
  FanRestoreMode::NO_RESTORE, FanRestoreMode::ALWAYS_OFF, FanRestoreMode::ALWAYS_ON, FanRestoreMode::RESTORE_DEFAULT_OFF,
  FanRestoreMode::RESTORE_DEFAULT_ON, FanRestoreMode::RESTORE_INVERTED_DEFAULT_OFF, FanRestoreMode::RESTORE_INVERTED_DEFAULT_ON
}
 Restore mode of a fan. More...
 

Functions

const LogString * fan_direction_to_string (FanDirection direction)
 
struct esphome::fan::FanRestoreState __attribute__ ((packed))
 
enum ESPDEPRECATED ("LegacyFanDirection members are deprecated, use FanDirection instead.", "2022.2") LegacyFanDirection
 

Variables

constexpr uint32_t RESTORE_STATE_VERSION = 0x71700ABA
 
esphome::fan::Fan __attribute__
 

Enumeration Type Documentation

◆ FanDirection

Simple enum to represent the direction of a fan.

Enumerator
FORWARD 
REVERSE 

Definition at line 20 of file fan.h.

◆ FanRestoreMode

Restore mode of a fan.

Enumerator
NO_RESTORE 
ALWAYS_OFF 
ALWAYS_ON 
RESTORE_DEFAULT_OFF 
RESTORE_DEFAULT_ON 
RESTORE_INVERTED_DEFAULT_OFF 
RESTORE_INVERTED_DEFAULT_ON 

Definition at line 23 of file fan.h.

Function Documentation

◆ __attribute__()

struct esphome::fan::FanRestoreState esphome::fan::__attribute__ ( (packed)  )

◆ ESPDEPRECATED()

enum esphome::fan::ESPDEPRECATED ( "LegacyFanDirection members are  deprecated,
use FanDirection instead."  ,
"2022.2"   
)

Definition at line 9 of file fan_state.h.

◆ fan_direction_to_string()

const LogString * esphome::fan::fan_direction_to_string ( FanDirection  direction)

Definition at line 9 of file fan.cpp.

Variable Documentation

◆ __attribute__

esphome::fan::Fan esphome::fan::__attribute__

◆ RESTORE_STATE_VERSION

constexpr uint32_t esphome::fan::RESTORE_STATE_VERSION = 0x71700ABA

Definition at line 105 of file fan.cpp.