Base-class for all numbers. More...

#include <number.h>

Inheritance diagram for esphome::number::Number:

Public Member Functions
void	publish_state (float state)

NumberCall	make_call ()

void	add_on_state_callback (std::function< void(float)> &&callback)

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

void	set_name (const char *name)

void	set_name (const char *name, uint32_t object_id_hash)
	Set name with pre-computed object_id hash (avoids runtime hash calculation) Use hash=0 for dynamic names that need runtime calculation.

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

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)

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.

Data Fields
float	state

NumberTraits	traits

Protected Member Functions
virtual void	control (float value)=0
	Set the value of the number, this is a virtual method that each number integration must implement.

Protected Member Functions inherited from esphome::EntityBase
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
LazyCallbackManager< void(float)>	state_callback_

Protected Attributes inherited from esphome::EntityBase
StringRef	name_

const char *	icon_c_str_ {nullptr}

uint32_t	object_id_hash_ {}

Device *	device_ {}

struct esphome::EntityBase::EntityFlags	flags_

Detailed Description

Base-class for all numbers.

A number can use publish_state to send out a new value.

Definition at line 29 of file number.h.

Member Function Documentation

◆ add_on_state_callback()

void esphome::number::Number::add_on_state_callback ( std::function< void(float)> && callback )

Definition at line 32 of file number.cpp.

◆ control()

virtual void esphome::number::Number::control ( float value )

protectedpure virtual

Set the value of the number, this is a virtual method that each number integration must implement.

This method is called by the NumberCall.

Parameters

value The value as validated by the NumberCall.

Implemented in esphome::atm90e32::ATM90E32Number, esphome::bl0940::CalibrationNumber, esphome::copy::CopyNumber, esphome::demo::DemoNumber, esphome::homeassistant::HomeassistantNumber, esphome::ld2410::GateThresholdNumber, esphome::ld2410::LightThresholdNumber, esphome::ld2410::MaxDistanceTimeoutNumber, esphome::ld2412::GateThresholdNumber, esphome::ld2412::LightThresholdNumber, esphome::ld2412::MaxDistanceTimeoutNumber, esphome::ld2420::LD2420GateSelectNumber, esphome::ld2420::LD2420MaxDistanceNumber, esphome::ld2420::LD2420MinDistanceNumber, esphome::ld2420::LD2420MoveSensFactorNumber, esphome::ld2420::LD2420MoveThresholdNumbers, esphome::ld2420::LD2420StillSensFactorNumber, esphome::ld2420::LD2420StillThresholdNumbers, esphome::ld2420::LD2420TimeoutNumber, esphome::ld2450::PresenceTimeoutNumber, esphome::ld2450::ZoneCoordinateNumber, esphome::lvgl::LVGLNumber, esphome::micronova::MicroNovaNumber, esphome::modbus_controller::ModbusNumber, esphome::opentherm::OpenthermNumber, esphome::seeed_mr24hpc1::CustomModeNumber, esphome::seeed_mr24hpc1::CustomUnmanTimeNumber, esphome::seeed_mr24hpc1::ExistenceThresholdNumber, esphome::seeed_mr24hpc1::MotionThresholdNumber, esphome::seeed_mr24hpc1::MotionToRestTimeNumber, esphome::seeed_mr24hpc1::MotionTriggerTimeNumber, esphome::seeed_mr24hpc1::SensitivityNumber, esphome::sprinkler::SprinklerControllerNumber, esphome::template_::TemplateNumber, and esphome::tuya::TuyaNumber.

◆ make_call()

NumberCall esphome::number::Number::make_call ( )

inline

Definition at line 35 of file number.h.

◆ publish_state()

void esphome::number::Number::publish_state ( float state )

Definition at line 22 of file number.cpp.

Field Documentation

◆ state

float esphome::number::Number::state

Definition at line 31 of file number.h.

◆ state_callback_

LazyCallbackManager<void(float)> esphome::number::Number::state_callback_

protected

Definition at line 52 of file number.h.

◆ traits

NumberTraits esphome::number::Number::traits

Definition at line 39 of file number.h.

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

esphome/components/number/number.h
esphome/components/number/number.cpp

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes