#include <template_switch.h>

Inheritance diagram for esphome::template_::TemplateSwitch:

Public Member Functions
	TemplateSwitch ()

void	setup () override

void	dump_config () override

void	set_state_lambda (std::function< optional< bool >()> &&f)

Trigger *	get_turn_on_trigger () const

Trigger *	get_turn_off_trigger () const

void	set_optimistic (bool optimistic)

void	set_assumed_state (bool assumed_state)

void	loop () override

float	get_setup_priority () const override

Public Member Functions inherited from esphome::switch_::Switch
	Switch ()

void	publish_state (bool state)
	Publish a state to the front-end from the back-end. More...

void	turn_on ()
	Turn this switch on. More...

void	turn_off ()
	Turn this switch off. More...

void	toggle ()
	Toggle this switch. More...

void	set_inverted (bool inverted)
	Set whether the state should be treated as inverted. More...

void	add_on_state_callback (std::function< void(bool)> &&callback)
	Set callback for state changes. More...

optional< bool >	get_initial_state ()
	Returns the initial state of the switch, as persisted previously, or empty if never persisted. More...

optional< bool >	get_initial_state_with_restore_mode ()
	Returns the initial state of the switch, after applying restore mode rules. More...

bool	is_inverted () const

void	set_restore_mode (SwitchRestoreMode restore_mode)

Public Member Functions inherited from esphome::EntityBase
const StringRef &	get_name () const

void	set_name (const char *name)

bool	has_own_name () const

std::string	get_object_id () const

void	set_object_id (const char *object_id)

uint32_t	get_object_id_hash ()

bool	is_internal () const

void	set_internal (bool internal)

bool	is_disabled_by_default () const

void	set_disabled_by_default (bool disabled_by_default)

EntityCategory	get_entity_category () const

void	set_entity_category (EntityCategory entity_category)

std::string	get_icon () const

void	set_icon (const char *icon)

Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string	get_device_class ()
	Get the device class, using the manual override if set. More...

void	set_device_class (const char *device_class)
	Manually set the device class. More...

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop(). More...

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed. More...

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning (const char *message="unspecified")

void	status_set_error (const char *message="unspecified")

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const char *source)
	Set where this component was loaded from for some debug messages. More...

const char *	get_component_source () const
	Get the integration where this component was declared as a string. More...

Protected Member Functions
bool	assumed_state () override

void	write_state (bool state) override

Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t	hash_base ()
	The hash_base() function has been deprecated. More...

void	calc_object_id_ ()

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

void	set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a unique name. More...

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function. More...

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name. More...

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function. More...

void	set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a unique name. More...

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function. More...

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call. More...

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty. More...

Protected Attributes
optional< std::function< optional< bool >)> >	f_

bool	optimistic_ {false}

bool	assumed_state_ {false}

Trigger *	turn_on_trigger_

Trigger *	turn_off_trigger_

Trigger *	prev_trigger_ {nullptr}

Protected Attributes inherited from esphome::switch_::Switch
CallbackManager< void(bool)>	state_callback_ {}

bool	inverted_ {false}

Deduplicator< bool >	publish_dedup_

ESPPreferenceObject	rtc_

Protected Attributes inherited from esphome::EntityBase
StringRef	name_

const char *	object_id_c_str_ {nullptr}

const char *	icon_c_str_ {nullptr}

uint32_t	object_id_hash_

bool	has_own_name_ {false}

bool	internal_ {false}

bool	disabled_by_default_ {false}

EntityCategory	entity_category_ {ENTITY_CATEGORY_NONE}

Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char *	device_class_ {nullptr}
	Device class override. More...

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component. More...

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

Additional Inherited Members
Data Fields inherited from esphome::switch_::Switch
bool	state
	The current reported state of the binary sensor. More...

SwitchRestoreMode	restore_mode {SWITCH_RESTORE_DEFAULT_OFF}
	Indicates whether or not state is to be retrieved from flash and how. More...

Detailed Description

Definition at line 10 of file template_switch.h.

Constructor & Destructor Documentation

◆ TemplateSwitch()

esphome::template_::TemplateSwitch::TemplateSwitch ( )

Definition at line 9 of file template_switch.cpp.

Member Function Documentation

◆ assumed_state()

bool esphome::template_::TemplateSwitch::assumed_state ( )

overrideprotectedvirtual

Reimplemented from esphome::switch_::Switch.

Definition at line 37 of file template_switch.cpp.

◆ dump_config()

void esphome::template_::TemplateSwitch::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 55 of file template_switch.cpp.

◆ get_setup_priority()

float esphome::template_::TemplateSwitch::get_setup_priority ( ) const

overridevirtual

Reimplemented from esphome::Component.

Definition at line 39 of file template_switch.cpp.

◆ get_turn_off_trigger()

Trigger * esphome::template_::TemplateSwitch::get_turn_off_trigger ( ) const

Definition at line 41 of file template_switch.cpp.

◆ get_turn_on_trigger()

Trigger * esphome::template_::TemplateSwitch::get_turn_on_trigger ( ) const

Definition at line 40 of file template_switch.cpp.

◆ loop()

void esphome::template_::TemplateSwitch::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 11 of file template_switch.cpp.

◆ set_assumed_state()

void esphome::template_::TemplateSwitch::set_assumed_state ( bool assumed_state )

Definition at line 59 of file template_switch.cpp.

◆ set_optimistic()

void esphome::template_::TemplateSwitch::set_optimistic ( bool optimistic )

Definition at line 36 of file template_switch.cpp.

◆ set_state_lambda()

void esphome::template_::TemplateSwitch::set_state_lambda ( std::function< optional< bool >()> && f )

Definition at line 38 of file template_switch.cpp.

◆ setup()

void esphome::template_::TemplateSwitch::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 42 of file template_switch.cpp.

◆ write_state()

void esphome::template_::TemplateSwitch::write_state ( bool state )

overrideprotectedvirtual

Implements esphome::switch_::Switch.

Definition at line 20 of file template_switch.cpp.

Field Documentation

◆ assumed_state_

bool esphome::template_::TemplateSwitch::assumed_state_ {false}

protected

Definition at line 33 of file template_switch.h.

◆ f_

optional<std::function<optional<bool>)> > esphome::template_::TemplateSwitch::f_

protected

Definition at line 31 of file template_switch.h.

◆ optimistic_

bool esphome::template_::TemplateSwitch::optimistic_ {false}

protected

Definition at line 32 of file template_switch.h.

◆ prev_trigger_

Trigger* esphome::template_::TemplateSwitch::prev_trigger_ {nullptr}

protected

Definition at line 36 of file template_switch.h.

◆ turn_off_trigger_

Trigger* esphome::template_::TemplateSwitch::turn_off_trigger_

protected

Definition at line 35 of file template_switch.h.

◆ turn_on_trigger_

Trigger* esphome::template_::TemplateSwitch::turn_on_trigger_

protected

Definition at line 34 of file template_switch.h.

The documentation for this class was generated from the following files:

/opt/build/esphome/esphome/components/template/switch/template_switch.h
/opt/build/esphome/esphome/components/template/switch/template_switch.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TemplateSwitch()

Member Function Documentation

◆ assumed_state()

◆ dump_config()

◆ get_setup_priority()

◆ get_turn_off_trigger()

◆ get_turn_on_trigger()

◆ loop()

◆ set_assumed_state()

◆ set_optimistic()

◆ set_state_lambda()

◆ setup()

◆ write_state()

Field Documentation

◆ assumed_state_

◆ f_

◆ optimistic_

◆ prev_trigger_

◆ turn_off_trigger_

◆ turn_on_trigger_