#include <template_valve.h>

Inheritance diagram for esphome::template_::TemplateValve:

Public Member Functions
	TemplateValve ()

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

Trigger *	get_open_trigger () const

Trigger *	get_close_trigger () const

Trigger *	get_stop_trigger () const

Trigger *	get_toggle_trigger () const

Trigger< float > *	get_position_trigger () const

void	set_optimistic (bool optimistic)

void	set_assumed_state (bool assumed_state)

void	set_has_stop (bool has_stop)

void	set_has_position (bool has_position)

void	set_has_toggle (bool has_toggle)

void	set_restore_mode (TemplateValveRestoreMode restore_mode)

void	setup () override

void	loop () override

void	dump_config () override

float	get_setup_priority () const override

Public Member Functions inherited from esphome::valve::Valve
	Valve ()

ValveCall	make_call ()
	Construct a new valve call used to control the valve.

void	add_on_state_callback (std::function< void()> &&f)

void	publish_state (bool save=true)
	Publish the current state of the valve.

bool	is_fully_open () const
	Helper method to check if the valve is fully open. Equivalent to comparing .position against 1.0.

bool	is_fully_closed () const
	Helper method to check if the valve is fully closed. Equivalent to comparing .position against 0.0.

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)

StringRef	get_icon_ref () const

uint32_t	get_device_id () const

void	set_device (Device *device)

bool	has_state () const

void	set_has_state (bool state)

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

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

StringRef	get_device_class_ref () const
	Get the device class as StringRef.

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().

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

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=nullptr)

void	status_set_error (const char *message=nullptr)

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.

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

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Member Functions
void	control (const valve::ValveCall &call) override

valve::ValveTraits	get_traits () override

void	stop_prev_trigger_ ()

Protected Member Functions inherited from esphome::valve::Valve
optional< ValveRestoreState >	restore_state_ ()

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

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_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

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

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

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

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

bool	cancel_interval (const char *name)

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.

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.

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

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

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

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

bool	cancel_timeout (const char *name)

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

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

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

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

Protected Attributes
TemplateValveRestoreMode	restore_mode_ {VALVE_NO_RESTORE}

optional< std::function< optional< float >()> >	state_f_

bool	assumed_state_ {false}

bool	optimistic_ {false}

Trigger *	open_trigger_

Trigger *	close_trigger_

bool	has_stop_ {false}

bool	has_toggle_ {false}

Trigger *	stop_trigger_

Trigger *	toggle_trigger_

Trigger *	prev_command_trigger_ {nullptr}

Trigger< float > *	position_trigger_

bool	has_position_ {false}

Protected Attributes inherited from esphome::valve::Valve
friend	ValveCall

CallbackManager< void()>	state_callback_ {}

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_ {}

Device *	device_ {}

struct esphome::EntityBase::EntityFlags	flags_

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

Protected Attributes inherited from esphome::Component
const char *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

Additional Inherited Members
Data Fields inherited from esphome::valve::Valve
ValveOperation	current_operation {VALVE_OPERATION_IDLE}
	The current operation of the valve (idle, opening, closing).

float	position
	The position of the valve from 0.0 (fully closed) to 1.0 (fully open).

Detailed Description

Definition at line 16 of file template_valve.h.

Constructor & Destructor Documentation

◆ TemplateValve()

esphome::template_::TemplateValve::TemplateValve ( )

Definition at line 11 of file template_valve.cpp.

Member Function Documentation

◆ control()

void esphome::template_::TemplateValve::control ( const valve::ValveCall & call )

overrideprotectedvirtual

Implements esphome::valve::Valve.

Definition at line 74 of file template_valve.cpp.

◆ dump_config()

void esphome::template_::TemplateValve::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 66 of file template_valve.cpp.

◆ get_close_trigger()

Trigger * esphome::template_::TemplateValve::get_close_trigger ( ) const

Definition at line 62 of file template_valve.cpp.

◆ get_open_trigger()

Trigger * esphome::template_::TemplateValve::get_open_trigger ( ) const

Definition at line 61 of file template_valve.cpp.

◆ get_position_trigger()

Trigger< float > * esphome::template_::TemplateValve::get_position_trigger ( ) const

Definition at line 118 of file template_valve.cpp.

◆ get_setup_priority()

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

overridevirtual

Reimplemented from esphome::Component.

Definition at line 59 of file template_valve.cpp.

◆ get_stop_trigger()

Trigger * esphome::template_::TemplateValve::get_stop_trigger ( ) const

Definition at line 63 of file template_valve.cpp.

◆ get_toggle_trigger()

Trigger * esphome::template_::TemplateValve::get_toggle_trigger ( ) const

Definition at line 64 of file template_valve.cpp.

◆ get_traits()

ValveTraits esphome::template_::TemplateValve::get_traits ( )

overrideprotectedvirtual

Implements esphome::valve::Valve.

Definition at line 109 of file template_valve.cpp.

◆ loop()

void esphome::template_::TemplateValve::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 38 of file template_valve.cpp.

◆ set_assumed_state()

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

Definition at line 57 of file template_valve.cpp.

◆ set_has_position()

void esphome::template_::TemplateValve::set_has_position ( bool has_position )

Definition at line 122 of file template_valve.cpp.

◆ set_has_stop()

void esphome::template_::TemplateValve::set_has_stop ( bool has_stop )

Definition at line 120 of file template_valve.cpp.

◆ set_has_toggle()

void esphome::template_::TemplateValve::set_has_toggle ( bool has_toggle )

Definition at line 121 of file template_valve.cpp.

◆ set_optimistic()

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

Definition at line 56 of file template_valve.cpp.

◆ set_restore_mode()

void esphome::template_::TemplateValve::set_restore_mode ( TemplateValveRestoreMode restore_mode )

inline

Definition at line 31 of file template_valve.h.

◆ set_state_lambda()

void esphome::template_::TemplateValve::set_state_lambda ( std::function< optional< float >()> && f )

Definition at line 58 of file template_valve.cpp.

◆ setup()

void esphome::template_::TemplateValve::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 18 of file template_valve.cpp.

◆ stop_prev_trigger_()

void esphome::template_::TemplateValve::stop_prev_trigger_ ( )

protected

Definition at line 124 of file template_valve.cpp.

Field Documentation

◆ assumed_state_

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

protected

Definition at line 46 of file template_valve.h.

◆ close_trigger_

Trigger* esphome::template_::TemplateValve::close_trigger_

protected

Definition at line 49 of file template_valve.h.

◆ has_position_

bool esphome::template_::TemplateValve::has_position_ {false}

protected

Definition at line 56 of file template_valve.h.

◆ has_stop_

bool esphome::template_::TemplateValve::has_stop_ {false}

protected

Definition at line 50 of file template_valve.h.

◆ has_toggle_

bool esphome::template_::TemplateValve::has_toggle_ {false}

protected

Definition at line 51 of file template_valve.h.

◆ open_trigger_

Trigger* esphome::template_::TemplateValve::open_trigger_

protected

Definition at line 48 of file template_valve.h.

◆ optimistic_

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

protected

Definition at line 47 of file template_valve.h.

◆ position_trigger_

Trigger<float>* esphome::template_::TemplateValve::position_trigger_

protected

Definition at line 55 of file template_valve.h.

◆ prev_command_trigger_

Trigger* esphome::template_::TemplateValve::prev_command_trigger_ {nullptr}

protected

Definition at line 54 of file template_valve.h.

◆ restore_mode_

TemplateValveRestoreMode esphome::template_::TemplateValve::restore_mode_ {VALVE_NO_RESTORE}

protected

Definition at line 44 of file template_valve.h.

◆ state_f_

optional<std::function<optional<float>()> > esphome::template_::TemplateValve::state_f_

protected

Definition at line 45 of file template_valve.h.

◆ stop_trigger_

Trigger* esphome::template_::TemplateValve::stop_trigger_

protected

Definition at line 52 of file template_valve.h.

◆ toggle_trigger_

Trigger* esphome::template_::TemplateValve::toggle_trigger_

protected

Definition at line 53 of file template_valve.h.

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

esphome/components/template/valve/template_valve.h
esphome/components/template/valve/template_valve.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TemplateValve()

Member Function Documentation

◆ control()

◆ dump_config()

◆ get_close_trigger()

◆ get_open_trigger()

◆ get_position_trigger()

◆ get_setup_priority()

◆ get_stop_trigger()

◆ get_toggle_trigger()

◆ get_traits()

◆ loop()

◆ set_assumed_state()

◆ set_has_position()

◆ set_has_stop()

◆ set_has_toggle()

◆ set_optimistic()

◆ set_restore_mode()

◆ set_state_lambda()

◆ setup()

◆ stop_prev_trigger_()

Field Documentation

◆ assumed_state_

◆ close_trigger_

◆ has_position_

◆ has_stop_

◆ has_toggle_

◆ open_trigger_

◆ optimistic_

◆ position_trigger_

◆ prev_command_trigger_

◆ restore_mode_

◆ state_f_

◆ stop_trigger_

◆ toggle_trigger_