ESPHome 2026.2.1
Loading...
Searching...
No Matches
esphome::template_ Namespace Reference

Data Structures

struct  AlarmSensor
 
class  BaseTemplateSelect
 
struct  Empty
 
struct  SensorDataStore
 
struct  SensorInfo
 
class  TemplateAlarmControlPanel
 
class  TemplateBinaryOutput
 
class  TemplateBinarySensor
 
class  TemplateButton
 
class  TemplateCover
 
class  TemplateDate
 
class  TemplateDateTime
 
class  TemplateEvent
 
class  TemplateFan
 
class  TemplateFloatOutput
 
class  TemplateLock
 
class  TemplateLockPublishAction
 
class  TemplateNumber
 
class  TemplateSelect
 Base template select class - used when no set_action is configured. More...
 
class  TemplateSelectWithSetAction
 Template select with set_action trigger - only instantiated when set_action is configured. More...
 
class  TemplateSensor
 
class  TemplateSwitch
 
class  TemplateText
 
class  TemplateTextSaverBase
 
class  TemplateTextSensor
 
class  TemplateTime
 
class  TemplateValve
 
class  TemplateValvePublishAction
 
class  TemplateWaterHeater
 
class  TemplateWaterHeaterPublishAction
 
class  TextSaver
 

Enumerations

enum  BinarySensorFlags : uint16_t {
  BINARY_SENSOR_MODE_NORMAL = 1 << 0 , BINARY_SENSOR_MODE_BYPASS_ARMED_HOME = 1 << 1 , BINARY_SENSOR_MODE_BYPASS_ARMED_NIGHT = 1 << 2 , BINARY_SENSOR_MODE_CHIME = 1 << 3 ,
  BINARY_SENSOR_MODE_BYPASS_AUTO = 1 << 4
}
 
enum  AlarmSensorType : uint8_t { ALARM_SENSOR_TYPE_DELAYED = 0 , ALARM_SENSOR_TYPE_INSTANT , ALARM_SENSOR_TYPE_DELAYED_FOLLOWER , ALARM_SENSOR_TYPE_INSTANT_ALWAYS }
 
enum  TemplateAlarmControlPanelRestoreMode { ALARM_CONTROL_PANEL_ALWAYS_DISARMED , ALARM_CONTROL_PANEL_RESTORE_DEFAULT_DISARMED }
 
enum  TemplateCoverRestoreMode { COVER_NO_RESTORE , COVER_RESTORE , COVER_RESTORE_AND_CALL }
 
enum  TemplateValveRestoreMode { VALVE_NO_RESTORE , VALVE_RESTORE , VALVE_RESTORE_AND_CALL }
 
enum  TemplateWaterHeaterRestoreMode { WATER_HEATER_NO_RESTORE , WATER_HEATER_RESTORE , WATER_HEATER_RESTORE_AND_CALL }
 

Functions

 PROGMEM_STRING_TABLE (AlarmSensorTypeStrings, "delayed", "instant", "delayed_follower", "instant_always")
 
void dump_config_helper (BaseTemplateSelect *sel_comp, bool optimistic, bool has_lambda, const size_t initial_option_index, bool restore_value)
 
void setup_initial (BaseTemplateSelect *sel_comp, size_t initial_index)
 
void setup_with_restore (BaseTemplateSelect *sel_comp, ESPPreferenceObject &pref, size_t initial_index)
 
void update_lambda (BaseTemplateSelect *sel_comp, const optional< std::string > &val)
 

Enumeration Type Documentation

◆ AlarmSensorType

Enumerator
ALARM_SENSOR_TYPE_DELAYED 
ALARM_SENSOR_TYPE_INSTANT 
ALARM_SENSOR_TYPE_DELAYED_FOLLOWER 
ALARM_SENSOR_TYPE_INSTANT_ALWAYS 

Definition at line 29 of file template_alarm_control_panel.h.

◆ BinarySensorFlags

Enumerator
BINARY_SENSOR_MODE_NORMAL 
BINARY_SENSOR_MODE_BYPASS_ARMED_HOME 
BINARY_SENSOR_MODE_BYPASS_ARMED_NIGHT 
BINARY_SENSOR_MODE_CHIME 
BINARY_SENSOR_MODE_BYPASS_AUTO 

Definition at line 21 of file template_alarm_control_panel.h.

◆ TemplateAlarmControlPanelRestoreMode

Enumerator
ALARM_CONTROL_PANEL_ALWAYS_DISARMED 
ALARM_CONTROL_PANEL_RESTORE_DEFAULT_DISARMED 

Definition at line 38 of file template_alarm_control_panel.h.

◆ TemplateCoverRestoreMode

Enumerator
COVER_NO_RESTORE 
COVER_RESTORE 
COVER_RESTORE_AND_CALL 

Definition at line 10 of file template_cover.h.

◆ TemplateValveRestoreMode

Enumerator
VALVE_NO_RESTORE 
VALVE_RESTORE 
VALVE_RESTORE_AND_CALL 

Definition at line 10 of file template_valve.h.

◆ TemplateWaterHeaterRestoreMode

Enumerator
WATER_HEATER_NO_RESTORE 
WATER_HEATER_RESTORE 
WATER_HEATER_RESTORE_AND_CALL 

Definition at line 10 of file template_water_heater.h.

Function Documentation

◆ dump_config_helper()

void esphome::template_::dump_config_helper ( BaseTemplateSelect * sel_comp,
bool optimistic,
bool has_lambda,
const size_t initial_option_index,
bool restore_value )

Definition at line 8 of file template_select.cpp.

◆ PROGMEM_STRING_TABLE()

esphome::template_::PROGMEM_STRING_TABLE ( AlarmSensorTypeStrings ,
"delayed" ,
"instant" ,
"delayed_follower" ,
"instant_always"  )

◆ setup_initial()

void esphome::template_::setup_initial ( BaseTemplateSelect * sel_comp,
size_t initial_index )

Definition at line 22 of file template_select.cpp.

◆ setup_with_restore()

void esphome::template_::setup_with_restore ( BaseTemplateSelect * sel_comp,
ESPPreferenceObject & pref,
size_t initial_index )

Definition at line 27 of file template_select.cpp.

◆ update_lambda()

void esphome::template_::update_lambda ( BaseTemplateSelect * sel_comp,
const optional< std::string > & val )

Definition at line 38 of file template_select.cpp.