ESPHome 2026.11.0-dev
Loading...
Searching...
No Matches
esphome::fan Namespace Reference

Data Structures

class  CycleSpeedAction
 
class  Fan
 
class  FanCall
 
class  FanDirectionSetTrigger
 
class  FanOscillatingSetTrigger
 
class  FanPresetSetTrigger
 
struct  FanRestoreState
 
class  FanSpeedSetTrigger
 
class  FanTraits
 
class  FanTurnOffTrigger
 
class  FanTurnOnTrigger
 

Typedefs

using FanPresetModes = ConstVector<const char *, true>
 Preset modes: a flash table from codegen, or an owned copy set at runtime.
 

Enumerations

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

Functions

 ESPHOME_LOG_TAG (TAG, "fan")
 
 PROGMEM_STRING_TABLE (FanDirectionStrings, "FORWARD", "REVERSE", "UNKNOWN")
 
const LogString * fan_direction_to_string (FanDirection direction)
 
struct esphome::fan::FanRestoreState __attribute__ ((packed))
 

Variables

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

Typedef Documentation

◆ FanPresetModes

using esphome::fan::FanPresetModes = ConstVector<const char *, true>

Preset modes: a flash table from codegen, or an owned copy set at runtime.

Definition at line 12 of file fan_traits.h.

Enumeration Type Documentation

◆ FanDirection

enum class esphome::fan::FanDirection
strong

Simple enum to represent the direction of a fan.

Enumerator
FORWARD 
REVERSE 

Definition at line 21 of file fan.h.

◆ FanRestoreMode

enum class esphome::fan::FanRestoreMode
strong

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 24 of file fan.h.

Function Documentation

◆ __attribute__()

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

◆ ESPHOME_LOG_TAG()

esphome::fan::ESPHOME_LOG_TAG ( TAG ,
"fan"  )

◆ fan_direction_to_string()

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

Definition at line 20 of file fan.cpp.

◆ PROGMEM_STRING_TABLE()

esphome::fan::PROGMEM_STRING_TABLE ( FanDirectionStrings ,
"FORWARD" ,
"REVERSE" ,
"UNKNOWN"  )

Variable Documentation

◆ __attribute__

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

◆ RESTORE_STATE_VERSION

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

Definition at line 232 of file fan.cpp.