developers.home-assistant/docs/core/entity/number.md

title, sidebar_label

title	sidebar_label
Number Entity	Number

A number is an entity that allows the user to input an arbitrary value to an integration. Derive entity platforms from homeassistant.components.number.NumberEntity

Properties

:::tip Properties should always only return information from memory and not do I/O (like network requests). Implement update() or async_update() to fetch data. :::

Name	Type	Default	Description
device_class	string	None	Type of number.
mode	string	auto	Defines how the number should be displayed in the UI. It's recommended to use the default auto. Can be box or slider to force a display mode.
native_max_value	float	100	The maximum accepted value in the number's native_unit_of_measurement (inclusive)
native_min_value	float	0	The minimum accepted value in the number's native_unit_of_measurement (inclusive)
native_step	float	See below	Defines the resolution of the values, i.e. the smallest increment or decrement in the number's
native_value	float	Required	The value of the number in the number's native_unit_of_measurement.
native_unit_of_measurement

Other properties that are common to all entities such as icon, name etc are also applicable.

The default step value is dynamically chosen based on the range (max - min) values. If the difference between max_value and min_value is greater than 1.0, then the default step is 1.0. If, however, the range is smaller, then the step is iteratively divided by 10 until it becomes lower than the range.

Available device classes

If specifying a device class, your number entity will need to also return the correct unit of measurement.

Type	Supported units	Description
apparent_power	VA	Apparent power
aqi		Air Quality Index
atmospheric_pressure	cbar, bar, hPa, inHg, kPa, mbar, Pa, psi	Atmospheric pressure, statistics will be stored in Pa.
battery	%	Percentage of battery that is left
carbon_dioxide	ppm	Concentration of carbon dioxide.
carbon_monoxide	ppm	Concentration of carbon monoxide.
current	A	Current
data_rate	bit/s, kbit/s, Mbit/s, Gbit/s, B/s, kB/s, MB/s, GB/s, KiB/s, MiB/s, GiB/s	Data rate
data_size	bit, kbit, Mbit, Gbit, B, kB, MB, GB, TB, PB, EB, ZB, YB, KiB, MiB, GiB, TiB, PiB, EiB, ZiB, YiB	Data size
distance	km, m, cm, mm, mi, yd, in	Generic distance
energy	Wh, kWh, MWh	Energy. Represents power over time. Not to be confused with power.
frequency	Hz, kHz, MHz, GHz	Frequency
gas	m³, ft³	Volume of gas. Gas consumption measured as energy in kWh instead of a volume should be classified as energy.
humidity	%	Relative humidity
illuminance	lx, lm	Light level
irradiance	W/m², BTU/(h⋅ft²)	Irradiance
moisture	%	Moisture
monetary	ISO 4217	Monetary value with a currency.
nitrogen_dioxide	µg/m³	Concentration of nitrogen dioxide
nitrogen_monoxide	µg/m³	Concentration of nitrogen monoxide
nitrous_oxide	µg/m³	Concentration of nitrous oxide
ozone	µg/m³	Concentration of ozone
pm1	µg/m³	Concentration of particulate matter less than 1 micrometer
pm25	µg/m³	Concentration of particulate matter less than 2.5 micrometers
pm10	µg/m³	Concentration of particulate matter less than 10 micrometers
power	W, kW	Power.
power_factor	%	Power Factor
precipitation	cm, in, mm	Precipitation
precipitation_intensity	in/d, in/h, mm/d, mm/h	Precipitation intensity
pressure	cbar, bar, hPa, inHg, kPa, mbar, Pa, psi	Pressure.
reactive_power	var	Reactive power
signal_strength	dB, dBm	Signal strength
sound_pressure	dB, dBA	Sound pressure
speed	ft/s, in/d, in/h, km/h, kn, m/s, mph, mm/d	Generic speed
sulphur_dioxide	µg/m³	Concentration of sulphure dioxide
temperature	°C, °F	Temperature.
volatile_organic_compounds	µg/m³	Concentration of volatile organic compounds
voltage	V	Voltage
volume	L, mL, gal, fl. oz., m³, ft³	Generic volume
water	L, gal, m³, ft³	Water consumption
weight	kg, g, mg, µg, oz, lb	Generic mass; weight is used instead of mass to fit with every day language.
wind_speed	ft/s, km/h, kn, m/s, mph	Wind speed

Restoring number states

Numbers which restore the state after restart or reload should not extend RestoreEntity because that does not store the native_value, but instead the state which may have been modifed by the number base entity. Numbers which restore the state should extend RestoreNumber and call await self.async_get_last_number_data from async_added_to_hass to get access to the stored native_min_value, native_max_value, native_step, native_unit_of_measurement and native_value.

Methods

Set value

Called when the user or an automation wants to update the value.

class MyNumber(NumberEntity):
    # Implement one of these methods.

    def set_native_value(self, value: float) -> None:
        """Update the current value."""

    async def async_set_native_value(self, value: float) -> None:
        """Update the current value."""