#include <number_sensor.h>

Inheritance diagram for esphome::number::NumberSensor:

Public Member Functions
	NumberSensor (Number *source)

void	setup () override

void	dump_config () override

Public Member Functions inherited from esphome::sensor::Sensor
	Sensor ()

int8_t	get_accuracy_decimals ()
	Get the accuracy in decimals, using the manual override if set.

void	set_accuracy_decimals (int8_t accuracy_decimals)
	Manually set the accuracy in decimals.

bool	has_accuracy_decimals () const
	Check if the accuracy in decimals has been manually set.

StateClass	get_state_class ()
	Get the state class, using the manual override if set.

void	set_state_class (StateClass state_class)
	Manually set the state class.

bool	get_force_update () const
	Get whether force update mode is enabled.

void	set_force_update (bool force_update)
	Set force update mode.

void	add_filter (Filter *filter)
	Add a filter to the filter chain. Will be appended to the back.

void	add_filters (std::initializer_list< Filter * > filters)
	Add a list of vectors to the back of the filter chain.

void	set_filters (std::initializer_list< Filter * > filters)
	Clear the filters and replace them by filters.

void	clear_filters ()
	Clear the entire filter chain.

float	get_state () const
	Getter-syntax for .state.

float	get_raw_state () const
	Getter-syntax for .raw_state.

void	publish_state (float state)
	Publish a new state to the front-end.

template<typename F >
void	add_on_state_callback (F &&callback)
	Add a callback that will be called every time a filtered value arrives.

template<typename F >
void	add_on_raw_state_callback (F &&callback)
	Add a callback that will be called every time the sensor sends a raw value.

	ESPDEPRECATED ("Use get_raw_state() instead of .raw_state. Will be removed in 2026.10.0", "2026.4.0") float raw_state

void	internal_send_state_to_frontend (float state)

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

bool	has_own_name () const

uint32_t	get_object_id_hash () const

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.

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)

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.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *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 ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const char *name, uint32_t length=5000)
	Set warning status flag and automatically clear it after a timeout.

void	status_momentary_error (const char *name, uint32_t length=5000)
	Set error status flag and automatically clear it after a timeout.

bool	has_overridden_loop () const

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

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Protected Attributes
Number *	source_

Protected Attributes inherited from esphome::sensor::Sensor
LazyCallbackManager< void(float)>	raw_callback_
	Storage for raw state callbacks.

LazyCallbackManager< void(float)>	callback_
	Storage for filtered state callbacks.

Filter *	filter_list_ {nullptr}
	Store all active filters.

int8_t	accuracy_decimals_ {-1}
	Accuracy in decimals (-1 = not set)

StateClass	state_class_ {STATE_CLASS_NONE}
	State class (STATE_CLASS_NONE = not set)

struct esphome::sensor::Sensor::SensorFlags	sensor_flags_

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

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

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 Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

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

ComponentRuntimeStats	runtime_stats_

Additional Inherited Members
Data Fields inherited from esphome::sensor::Sensor
float	state
	This member variable stores the last state that has passed through all filters.

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 Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

virtual void	call_setup ()

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

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 id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

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

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

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

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 id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

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

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

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

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.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Detailed Description

Definition at line 9 of file number_sensor.h.

Constructor & Destructor Documentation

◆ NumberSensor()

esphome::number::NumberSensor::NumberSensor ( Number * source )

inlineexplicit

Definition at line 11 of file number_sensor.h.

Member Function Documentation

◆ dump_config()

void esphome::number::NumberSensor::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 14 of file number_sensor.cpp.

◆ setup()

void esphome::number::NumberSensor::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 8 of file number_sensor.cpp.

Field Documentation

◆ source_

Number* esphome::number::NumberSensor::source_

protected

Definition at line 16 of file number_sensor.h.

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

esphome/components/number/sensor/number_sensor.h
esphome/components/number/sensor/number_sensor.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members