#include <template_fan.h>

Inheritance diagram for esphome::template_::TemplateFan:

Public Member Functions
	TemplateFan ()

void	setup () override

void	dump_config () override

void	set_has_direction (bool has_direction)

void	set_has_oscillating (bool has_oscillating)

void	set_speed_count (int count)

void	set_preset_modes (std::initializer_list< const char * > presets)

fan::FanTraits	get_traits () override

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

virtual float	get_setup_priority () const
	priority of setup().

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.

bool	is_idle () const
	Check if this component is idle.

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_warning (const LogString *message)

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 LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time)

Public Member Functions inherited from esphome::fan::Fan
FanCall	turn_on ()

FanCall	turn_off ()

FanCall	toggle ()

FanCall	make_call ()

void	add_on_state_callback (std::function< void()> &&callback)
	Register a callback that will be called each time the state changes.

void	publish_state ()

void	set_restore_mode (FanRestoreMode restore_mode)
	Set the restore mode of this fan.

const char *	get_preset_mode () const
	Get the current preset mode (returns pointer to string stored in traits, or nullptr if not set)

bool	has_preset_mode () const
	Check if a preset mode is currently active.

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)

ESPDEPRECATED("Use get_icon_ref() instead for better performance (avoids string copy). Will be removed in ESPHome 2026.5.0", "2025.11.0") std 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)

uint32_t	get_preference_hash ()
	Get a unique hash for storing preferences/settings for this entity.

Protected Member Functions
void	control (const fan::FanCall &call) override

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 Member Functions inherited from esphome::fan::Fan
optional< FanRestoreState >	restore_state_ ()

void	save_state_ ()

void	dump_traits_ (const char tag, const char prefix)

bool	set_preset_mode_ (const char *preset_mode)
	Set the preset mode (finds and stores pointer from traits). Returns true if changed.

bool	set_preset_mode_ (const std::string &preset_mode)
	Set the preset mode (finds and stores pointer from traits). Returns true if changed.

void	clear_preset_mode_ ()
	Clear the preset mode.

const char *	find_preset_mode_ (const char *preset_mode)
	Find and return the matching preset mode pointer from traits, or nullptr if not found.

Protected Member Functions inherited from esphome::EntityBase
StringRef	get_object_id_ref_for_api_ () const

void	calc_object_id_ ()

bool	is_object_id_dynamic_ () const
	Check if the object_id is dynamic (changes with MAC suffix)

Protected Attributes
bool	has_oscillating_ {false}

bool	has_direction_ {false}

int	speed_count_ {0}

fan::FanTraits	traits_

std::vector< const char * >	preset_modes_ {}

Protected Attributes inherited from esphome::Component
const LogString *	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.

Protected Attributes inherited from esphome::fan::Fan
friend	FanCall

CallbackManager< void()>	state_callback_ {}

ESPPreferenceObject	rtc_

FanRestoreMode	restore_mode_

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_

Additional Inherited Members
Data Fields inherited from esphome::fan::Fan
bool	state {false}
	The current on/off state of the fan.

bool	oscillating {false}
	The current oscillation state of the fan.

int	speed {0}
	The current fan speed level.

FanDirection	direction {FanDirection::FORWARD}
	The current direction of the fan.

Detailed Description

Definition at line 9 of file template_fan.h.

Constructor & Destructor Documentation

◆ TemplateFan()

esphome::template_::TemplateFan::TemplateFan ( )

inline

Definition at line 11 of file template_fan.h.

Member Function Documentation

◆ control()

void esphome::template_::TemplateFan::control ( const fan::FanCall & call )

overrideprotectedvirtual

Implements esphome::fan::Fan.

Definition at line 23 of file template_fan.cpp.

◆ dump_config()

void esphome::template_::TemplateFan::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 21 of file template_fan.cpp.

◆ get_traits()

fan::FanTraits esphome::template_::TemplateFan::get_traits ( )

inlineoverridevirtual

Implements esphome::fan::Fan.

Definition at line 18 of file template_fan.h.

◆ set_has_direction()

void esphome::template_::TemplateFan::set_has_direction ( bool has_direction )

inline

Definition at line 14 of file template_fan.h.

◆ set_has_oscillating()

void esphome::template_::TemplateFan::set_has_oscillating ( bool has_oscillating )

inline

Definition at line 15 of file template_fan.h.

◆ set_preset_modes()

void esphome::template_::TemplateFan::set_preset_modes ( std::initializer_list< const char * > presets )

inline

Definition at line 17 of file template_fan.h.

◆ set_speed_count()

void esphome::template_::TemplateFan::set_speed_count ( int count )

inline

Definition at line 16 of file template_fan.h.

◆ setup()

void esphome::template_::TemplateFan::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file template_fan.cpp.

Field Documentation

◆ has_direction_

bool esphome::template_::TemplateFan::has_direction_ {false}

protected

Definition at line 24 of file template_fan.h.

◆ has_oscillating_

bool esphome::template_::TemplateFan::has_oscillating_ {false}

protected

Definition at line 23 of file template_fan.h.

◆ preset_modes_

std::vector<const char *> esphome::template_::TemplateFan::preset_modes_ {}

protected

Definition at line 27 of file template_fan.h.

◆ speed_count_

int esphome::template_::TemplateFan::speed_count_ {0}

protected

Definition at line 25 of file template_fan.h.

◆ traits_

fan::FanTraits esphome::template_::TemplateFan::traits_

protected

Definition at line 26 of file template_fan.h.

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

esphome/components/template/fan/template_fan.h
esphome/components/template/fan/template_fan.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TemplateFan()

Member Function Documentation

◆ control()

◆ dump_config()

◆ get_traits()

◆ set_has_direction()

◆ set_has_oscillating()

◆ set_preset_modes()

◆ set_speed_count()

◆ setup()

Field Documentation

◆ has_direction_

◆ has_oscillating_

◆ preset_modes_

◆ speed_count_

◆ traits_