ESPHome  2021.11.3
Data Structures | Enumerations | Functions | Variables
esphome::climate Namespace Reference

Data Structures

class  Climate
 ClimateDevice - This is the base class for all climate integrations. More...
 
class  ClimateCall
 This class is used to encode all control actions on a climate device. More...
 
struct  ClimateDeviceRestoreState
 Struct used to save the state of the climate device in restore memory. More...
 
class  ClimateTraits
 This class contains all static data for climate devices. More...
 
class  ControlAction
 

Enumerations

enum  ClimateMode : uint8_t {
  CLIMATE_MODE_OFF = 0, CLIMATE_MODE_HEAT_COOL = 1, CLIMATE_MODE_COOL = 2, CLIMATE_MODE_HEAT = 3,
  CLIMATE_MODE_FAN_ONLY = 4, CLIMATE_MODE_DRY = 5, CLIMATE_MODE_AUTO = 6
}
 Enum for all modes a climate device can be in. More...
 
enum  ClimateAction : uint8_t {
  CLIMATE_ACTION_OFF = 0, CLIMATE_ACTION_COOLING = 2, CLIMATE_ACTION_HEATING = 3, CLIMATE_ACTION_IDLE = 4,
  CLIMATE_ACTION_DRYING = 5, CLIMATE_ACTION_FAN = 6
}
 Enum for the current action of the climate device. Values match those of ClimateMode. More...
 
enum  ClimateFanMode : uint8_t {
  CLIMATE_FAN_ON = 0, CLIMATE_FAN_OFF = 1, CLIMATE_FAN_AUTO = 2, CLIMATE_FAN_LOW = 3,
  CLIMATE_FAN_MEDIUM = 4, CLIMATE_FAN_HIGH = 5, CLIMATE_FAN_MIDDLE = 6, CLIMATE_FAN_FOCUS = 7,
  CLIMATE_FAN_DIFFUSE = 8
}
 
enum  ClimateSwingMode : uint8_t { CLIMATE_SWING_OFF = 0, CLIMATE_SWING_BOTH = 1, CLIMATE_SWING_VERTICAL = 2, CLIMATE_SWING_HORIZONTAL = 3 }
 Enum for all modes a climate swing can be in. More...
 
enum  ClimatePreset : uint8_t {
  CLIMATE_PRESET_NONE = 0, CLIMATE_PRESET_HOME = 1, CLIMATE_PRESET_AWAY = 2, CLIMATE_PRESET_BOOST = 3,
  CLIMATE_PRESET_COMFORT = 4, CLIMATE_PRESET_ECO = 5, CLIMATE_PRESET_SLEEP = 6, CLIMATE_PRESET_ACTIVITY = 7
}
 Enum for all modes a climate swing can be in. More...
 

Functions

template<typename T1 , typename T2 >
bool set_alternative (optional< T1 > &dst, optional< T2 > &alt, const T1 &src)
 
struct esphome::climate::ClimateDeviceRestoreState __attribute__ ((packed))
 
const LogString * climate_mode_to_string (ClimateMode mode)
 Convert the given ClimateMode to a human-readable string. More...
 
const LogString * climate_action_to_string (ClimateAction action)
 Convert the given ClimateAction to a human-readable string. More...
 
const LogString * climate_fan_mode_to_string (ClimateFanMode mode)
 Convert the given ClimateFanMode to a human-readable string. More...
 
const LogString * climate_swing_mode_to_string (ClimateSwingMode mode)
 Convert the given ClimateSwingMode to a human-readable string. More...
 
const LogString * climate_preset_to_string (ClimatePreset preset)
 Convert the given ClimateSwingMode to a human-readable string. More...
 

Variables

esphome::climate::Climate __attribute__
 

Enumeration Type Documentation

◆ ClimateAction

Enum for the current action of the climate device. Values match those of ClimateMode.

Enumerator
CLIMATE_ACTION_OFF 

The climate device is off (inactive or no power)

CLIMATE_ACTION_COOLING 

The climate device is actively cooling.

CLIMATE_ACTION_HEATING 

The climate device is actively heating.

CLIMATE_ACTION_IDLE 

The climate device is idle (monitoring climate but no action needed)

CLIMATE_ACTION_DRYING 

The climate device is drying.

CLIMATE_ACTION_FAN 

The climate device is in fan only mode.

Definition at line 31 of file climate_mode.h.

◆ ClimateFanMode

Enumerator
CLIMATE_FAN_ON 

The fan mode is set to On.

CLIMATE_FAN_OFF 

The fan mode is set to Off.

CLIMATE_FAN_AUTO 

The fan mode is set to Auto.

CLIMATE_FAN_LOW 

The fan mode is set to Low.

CLIMATE_FAN_MEDIUM 

The fan mode is set to Medium.

CLIMATE_FAN_HIGH 

The fan mode is set to High.

CLIMATE_FAN_MIDDLE 

The fan mode is set to Middle.

CLIMATE_FAN_FOCUS 

The fan mode is set to Focus.

CLIMATE_FAN_DIFFUSE 

The fan mode is set to Diffuse.

Definition at line 46 of file climate_mode.h.

◆ ClimateMode

Enum for all modes a climate device can be in.

Enumerator
CLIMATE_MODE_OFF 

The climate device is off.

CLIMATE_MODE_HEAT_COOL 

The climate device is set to heat/cool to reach the target temperature.

CLIMATE_MODE_COOL 

The climate device is set to cool to reach the target temperature.

CLIMATE_MODE_HEAT 

The climate device is set to heat to reach the target temperature.

CLIMATE_MODE_FAN_ONLY 

The climate device only has the fan enabled, no heating or cooling is taking place.

CLIMATE_MODE_DRY 

The climate device is set to dry/humidity mode.

CLIMATE_MODE_AUTO 

The climate device is adjusting the temperatre dynamically.

For example, the target temperature can be adjusted based on a schedule, or learned behavior. The target temperature can't be adjusted when in this mode.

Definition at line 10 of file climate_mode.h.

◆ ClimatePreset

Enum for all modes a climate swing can be in.

Enumerator
CLIMATE_PRESET_NONE 

No preset is active.

CLIMATE_PRESET_HOME 

Device is in home preset.

CLIMATE_PRESET_AWAY 

Device is in away preset.

CLIMATE_PRESET_BOOST 

Device is in boost preset.

CLIMATE_PRESET_COMFORT 

Device is in comfort preset.

CLIMATE_PRESET_ECO 

Device is running an energy-saving preset.

CLIMATE_PRESET_SLEEP 

Device is prepared for sleep.

CLIMATE_PRESET_ACTIVITY 

Device is reacting to activity (e.g., movement sensors)

Definition at line 80 of file climate_mode.h.

◆ ClimateSwingMode

Enum for all modes a climate swing can be in.

Enumerator
CLIMATE_SWING_OFF 

The swing mode is set to Off.

CLIMATE_SWING_BOTH 

The fan mode is set to Both.

CLIMATE_SWING_VERTICAL 

The fan mode is set to Vertical.

CLIMATE_SWING_HORIZONTAL 

The fan mode is set to Horizontal.

Definition at line 68 of file climate_mode.h.

Function Documentation

◆ __attribute__()

struct esphome::climate::ClimateDeviceRestoreState esphome::climate::__attribute__ ( (packed)  )

◆ climate_action_to_string()

const LogString * esphome::climate::climate_action_to_string ( ClimateAction  action)

Convert the given ClimateAction to a human-readable string.

Definition at line 26 of file climate_mode.cpp.

◆ climate_fan_mode_to_string()

const LogString * esphome::climate::climate_fan_mode_to_string ( ClimateFanMode  fan_mode)

Convert the given ClimateFanMode to a human-readable string.

Definition at line 45 of file climate_mode.cpp.

◆ climate_mode_to_string()

const LogString * esphome::climate::climate_mode_to_string ( ClimateMode  mode)

Convert the given ClimateMode to a human-readable string.

Definition at line 6 of file climate_mode.cpp.

◆ climate_preset_to_string()

const LogString * esphome::climate::climate_preset_to_string ( ClimatePreset  preset)

Convert the given ClimateSwingMode to a human-readable string.

Definition at line 85 of file climate_mode.cpp.

◆ climate_swing_mode_to_string()

const LogString * esphome::climate::climate_swing_mode_to_string ( ClimateSwingMode  swing_mode)

Convert the given ClimateSwingMode to a human-readable string.

Definition at line 70 of file climate_mode.cpp.

◆ set_alternative()

template<typename T1 , typename T2 >
bool esphome::climate::set_alternative ( optional< T1 > &  dst,
optional< T2 > &  alt,
const T1 &  src 
)

Definition at line 509 of file climate.cpp.

Variable Documentation

◆ __attribute__

esphome::climate::Climate esphome::climate::__attribute__