#include <demo_valve.h>

Inheritance diagram for esphome::demo::DemoValve:

Public Member Functions
valve::ValveTraits	get_traits () override

void	set_type (DemoValveType type)

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

bool	has_own_name () const

ESPDEPRECATED("object_id mangles names and all object_id methods are planned for removal " "(see https://github.com/esphome/backlog/issues/76). " "Now is the time to stop using object_id. If still needed, use get_object_id_to() " "which will remain available longer. get_object_id() will be removed in 2026.7.0", "2025.12.0") std uint32_t	get_object_id_hash ()

StringRef	get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const
	Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.

size_t	write_object_id_to (char *buf, size_t buf_size) const
	Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.

bool	is_internal () const

	ESPDEPRECATED ("set_internal() is undefined behavior at runtime — components and Home Assistant are NOT " "notified. Use the 'internal:' YAML key instead. Will be removed in 2027.3.0.", "2026.3.0") void set_internal(bool internal)

bool	is_disabled_by_default () const

EntityCategory	get_entity_category () const

const char *	get_device_class_to (std::span< char, MAX_DEVICE_CLASS_LENGTH > buffer) const

template<typename T = int>
StringRef	get_device_class_ref () const

template<typename T = int>
std::string	get_device_class () const

	ESPDEPRECATED ("Use get_device_class_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") StringRef get_device_class_ref() const

ESPDEPRECATED("Use get_device_class_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") std StringRef	get_unit_of_measurement_ref () const

ESPDEPRECATED("Use get_unit_of_measurement_ref() instead for better performance (avoids string copy). Will be " "removed in ESPHome 2026.9.0", "2026.3.0") std const char *	get_icon_to (std::span< char, MAX_ICON_LENGTH > buffer) const
	Get the unit of measurement as std::string (deprecated, prefer get_unit_of_measurement_ref())

template<typename T = int>
StringRef	get_icon_ref () const

template<typename T = int>
std::string	get_icon () const

	ESPDEPRECATED ("Use get_icon_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") StringRef get_icon_ref() const

ESPDEPRECATED("Use get_icon_to() instead. Will be removed in ESPHome 2026.9.0", "2026.3.0") std uint32_t	get_device_id () const

Device *	get_device () const

bool	has_state () const

void	set_has_state (bool state)

	ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash()
	Get a unique hash for storing preferences/settings for this entity.

template<typename T >
ESPPreferenceObject	make_entity_preference (uint32_t version=0)
	Create a preference object for storing this entity's state/settings.

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

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

Protected Member Functions inherited from esphome::EntityBase
friend	void::setup ()

friend	void::original_setup ()

void	configure_entity_ (const char *name, uint32_t object_id_hash, uint32_t entity_fields)
	Combined entity setup from codegen: set name, object_id hash, entity string indices, and flags.

void	set_device_ (Device *device)

ESPPreferenceObject	make_entity_preference_ (size_t size, uint32_t version)
	Non-template helper for make_entity_preference() to avoid code bloat.

void	calc_object_id_ ()

Protected Attributes
DemoValveType	type_ {}

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

LazyCallbackManager< void()>	state_callback_ {}

ESPPreferenceObject	rtc_

Protected Attributes inherited from esphome::EntityBase
StringRef	name_

uint32_t	object_id_hash_ {}

Device *	device_ {}

struct esphome::EntityBase::EntityFlags	flags_

uint8_t	device_class_idx_ {}

uint8_t	uom_idx_ {}

uint8_t	icon_idx_ {}

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 13 of file demo_valve.h.

Member Function Documentation

◆ control()

void esphome::demo::DemoValve::control ( const valve::ValveCall & call )

inlineoverrideprotectedvirtual

Implements esphome::valve::Valve.

Definition at line 28 of file demo_valve.h.

◆ get_traits()

valve::ValveTraits esphome::demo::DemoValve::get_traits ( )

inlineoverridevirtual

Implements esphome::valve::Valve.

Definition at line 15 of file demo_valve.h.

◆ set_type()

void esphome::demo::DemoValve::set_type ( DemoValveType type )

inline

Definition at line 25 of file demo_valve.h.

Field Documentation

◆ type_

DemoValveType esphome::demo::DemoValve::type_ {}

protected

Definition at line 53 of file demo_valve.h.

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

esphome/components/demo/demo_valve.h

Public Member Functions

Protected Member Functions

Protected Attributes