ESPHome  2024.10.2
Data Structures | Namespaces | Enumerations | Functions | Variables
fan.h File Reference

Go to the source code of this file.

Data Structures

class  esphome::fan::FanCall
 
struct  esphome::fan::FanRestoreState
 
class  esphome::fan::Fan
 

Namespaces

 esphome
 Implementation of SPI Controller mode.
 
 esphome::fan
 

Enumerations

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

Functions

const LogString * esphome::fan::fan_direction_to_string (FanDirection direction)
 
struct esphome::fan::FanRestoreState esphome::fan::__attribute__ ((packed))
 
FanCall to_call (Fan &fan)
 Convert this struct to a fan call that can be performed. More...
 
void apply (Fan &fan)
 Apply these settings to the fan. More...
 

Variables

bool state
 
int speed
 
bool oscillating
 
FanDirection direction
 
uint8_t preset_mode
 
esphome::fan::Fan esphome::fan::__attribute__
 

Function Documentation

◆ apply()

void __attribute__::apply ( Fan &  fan)

Apply these settings to the fan.

◆ to_call()

FanCall __attribute__::to_call ( Fan &  fan)

Convert this struct to a fan call that can be performed.

Variable Documentation

◆ direction

FanDirection direction

Definition at line 37 of file fan.h.

◆ oscillating

bool oscillating

Definition at line 36 of file fan.h.

◆ preset_mode

uint8_t preset_mode

Definition at line 38 of file fan.h.

◆ speed

int speed

Definition at line 35 of file fan.h.

◆ state

bool state

Definition at line 34 of file fan.h.