Home Assistant Unofficial Reference 2024.12.1
Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
homeassistant.components.number.NumberEntity Class Reference

Inherits homeassistant.helpers.entity.Entity, cached_properties, and CACHED_PROPERTIES_WITH_ATTR_.

Inherited by homeassistant.components.airgradient.number.AirGradientNumber, homeassistant.components.apsystems.number.ApSystemsMaxOutputNumber, homeassistant.components.baf.number.BAFNumber, homeassistant.components.bmw_connected_drive.number.BMWNumber, homeassistant.components.deconz.number.DeconzNumber, homeassistant.components.demo.number.DemoNumber, homeassistant.components.ecobee.number.EcobeeCompressorMinTemp, homeassistant.components.ecobee.number.EcobeeVentilatorMinTime, homeassistant.components.ecoforest.number.EcoforestNumberEntity, homeassistant.components.ecovacs.number.EcovacsNumberEntity, homeassistant.components.enphase_envoy.number.EnvoyRelayNumberEntity, homeassistant.components.enphase_envoy.number.EnvoyStorageSettingsNumberEntity, homeassistant.components.eq3btsmart.number.Eq3NumberEntity, homeassistant.components.esphome.number.EsphomeNumber, homeassistant.components.ezviz.number.EzvizNumber, homeassistant.components.fjaraskupan.number.PeriodicVentingTime, homeassistant.components.flexit_bacnet.number.FlexitNumber, homeassistant.components.flux_led.number.FluxConfigNumber, homeassistant.components.flux_led.number.FluxSpeedNumber, homeassistant.components.fully_kiosk.number.FullyNumberEntity, homeassistant.components.gardena_bluetooth.number.GardenaBluetoothNumber, homeassistant.components.gardena_bluetooth.number.GardenaBluetoothRemainingOpenSetNumber, homeassistant.components.goodwe.number.InverterNumberEntity, homeassistant.components.home_connect.number.HomeConnectNumberEntity, homeassistant.components.homekit_controller.number.HomeKitNumber, homeassistant.components.homewizard.number.HWEnergyNumberEntity, homeassistant.components.husqvarna_automower.number.AutomowerNumberEntity, homeassistant.components.husqvarna_automower.number.WorkAreaNumberEntity, homeassistant.components.intellifire.number.IntellifireFlameControlEntity, homeassistant.components.iron_os.number.IronOSNumberEntity, homeassistant.components.isy994.number.ISYAuxControlNumberEntity, homeassistant.components.isy994.number.ISYVariableNumberEntity, homeassistant.components.juicenet.number.JuiceNetNumber, homeassistant.components.kostal_plenticore.number.PlenticoreDataNumber, homeassistant.components.lamarzocco.number.LaMarzoccoKeyNumberEntity, homeassistant.components.lamarzocco.number.LaMarzoccoNumberEntity, homeassistant.components.lametric.number.LaMetricNumberEntity, homeassistant.components.lektrico.number.LektricoNumber, homeassistant.components.lg_thinq.number.ThinQNumberEntity, homeassistant.components.matter.number.MatterNumber, homeassistant.components.melnor.number.MelnorZoneNumber, homeassistant.components.motionmount.number.MotionMountExtension, homeassistant.components.motionmount.number.MotionMountTurn, homeassistant.components.myuplink.number.MyUplinkNumber, homeassistant.components.nexia.number.NexiaFanSpeedEntity, homeassistant.components.nibe_heatpump.number.Number, homeassistant.components.number.RestoreNumber, homeassistant.components.overkiz.number.OverkizNumber, homeassistant.components.plugwise.number.PlugwiseNumberEntity, homeassistant.components.rainbird.number.RainDelayNumber, homeassistant.components.renson.number.RensonNumber, homeassistant.components.reolink.number.ReolinkChimeNumberEntity, homeassistant.components.reolink.number.ReolinkHostNumberEntity, homeassistant.components.reolink.number.ReolinkNumberEntity, homeassistant.components.ring.number.RingNumber, homeassistant.components.rituals_perfume_genie.number.RitualsNumberEntity, homeassistant.components.roborock.number.RoborockNumberEntity, homeassistant.components.sabnzbd.number.SabnzbdNumber, homeassistant.components.screenlogic.number.ScreenLogicNumber, homeassistant.components.sensibo.number.SensiboNumber, homeassistant.components.shelly.number.RpcNumber, homeassistant.components.sleepiq.number.SleepIQNumberEntity, homeassistant.components.sonos.number.SonosLevelEntity, homeassistant.components.tailwind.number.TailwindNumberEntity, homeassistant.components.technove.number.TechnoVENumberEntity, homeassistant.components.template.number.TemplateNumber, homeassistant.components.template.number.TriggerNumberEntity, homeassistant.components.tesla_fleet.number.TeslaFleetEnergyInfoNumberSensorEntity, homeassistant.components.tesla_fleet.number.TeslaFleetVehicleNumberEntity, homeassistant.components.teslemetry.number.TeslemetryEnergyInfoNumberSensorEntity, homeassistant.components.teslemetry.number.TeslemetryVehicleNumberEntity, homeassistant.components.tessie.number.TessieEnergyInfoNumberSensorEntity, homeassistant.components.tessie.number.TessieNumberEntity, homeassistant.components.tolo.number.ToloNumberEntity, homeassistant.components.tplink.number.TPLinkNumberEntity, homeassistant.components.tuya.number.TuyaNumberEntity, homeassistant.components.unifiprotect.number.ProtectNumbers, homeassistant.components.v2c.number.V2CSettingsNumberEntity, homeassistant.components.vallox.number.ValloxNumberEntity, homeassistant.components.vicare.number.ViCareNumber, homeassistant.components.wallbox.number.WallboxNumber, homeassistant.components.wiz.number.WizSpeedNumber, homeassistant.components.wled.number.WLEDNumber, homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity, homeassistant.components.yamaha_musiccast.number.NumberCapability, homeassistant.components.yolink.number.YoLinkNumberTypeConfigEntity, and homeassistant.components.zwave_me.number.ZWaveMeNumber.

Collaboration diagram for homeassistant.components.number.NumberEntity:
[legend]

Public Member Functions

None __init_subclass__ (cls, **Any kwargs)
 
None async_internal_added_to_hass (self)
 
None async_registry_entry_updated (self)
 
None async_set_native_value (self, float value)
 
None async_set_value (self, float value)
 
dict[str, Any] capability_attributes (self)
 
float convert_to_native_value (self, float value)
 
NumberDeviceClass|None device_class (self)
 
float max_value (self)
 
float min_value (self)
 
NumberMode mode (self)
 
float native_max_value (self)
 
float native_min_value (self)
 
float|None native_step (self)
 
str|None native_unit_of_measurement (self)
 
float|None native_value (self)
 
None set_native_value (self, float value)
 
None set_value (self, float value)
 
float|None state (self)
 
float step (self)
 
str|None unit_of_measurement (self)
 
float|None value (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, str] translation_placeholders (self)
 
str|None unique_id (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 

Public Attributes

 device_class
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Static Public Attributes

 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Private Member Functions

float _calculate_step (self, float min_value, float max_value)
 
float _convert_to_state_value (self, float value, Callable[[float, int], float] method, NumberDeviceClass|None device_class)
 
bool _default_to_device_class_name (self)
 

Private Attributes

 _number_option_unit_of_measurement
 

Static Private Attributes

 _deprecated_number_entity_reported
 
 _entity_component_unrecorded_attributes
 

Detailed Description

Representation of a Number entity.

Definition at line 181 of file __init__.py.

Member Function Documentation

◆ __init_subclass__()

None homeassistant.components.number.NumberEntity.__init_subclass__ (   cls,
**Any  kwargs 
) 
Post initialisation processing.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 205 of file __init__.py.

◆ _calculate_step()

float homeassistant.components.number.NumberEntity._calculate_step (   self,
float  min_value,
float  max_value 
)
private 
Return the increment/decrement step.

Definition at line 332 of file __init__.py.

◆ _convert_to_state_value()

float homeassistant.components.number.NumberEntity._convert_to_state_value (   self,
float  value,
Callable[[float, int], float]  method,
NumberDeviceClass | None  device_class 
)
private 
Convert a value in the number's native unit to the configured unit.

Definition at line 432 of file __init__.py.

◆ _default_to_device_class_name()

bool homeassistant.components.number.NumberEntity._default_to_device_class_name (   self)
private 
Return True if an unnamed entity should be named by its device class.

For numbers this is True if the entity has a device class.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 258 of file __init__.py.

◆ async_internal_added_to_hass()

None homeassistant.components.number.NumberEntity.async_internal_added_to_hass (   self) 
Call when the number entity is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 234 of file __init__.py.

◆ async_registry_entry_updated()

None homeassistant.components.number.NumberEntity.async_registry_entry_updated (   self) 
Run when the entity registry entry has been updated.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 488 of file __init__.py.

◆ async_set_native_value()

None homeassistant.components.number.NumberEntity.async_set_native_value (   self,
float  value 
) 
Set new value.

Reimplemented in homeassistant.components.zha.number.ZhaNumber, homeassistant.components.yolink.number.YoLinkNumberTypeConfigEntity, homeassistant.components.yamaha_musiccast.number.NumberCapability, homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity, homeassistant.components.wyoming.number.WyomingSatelliteVolumeMultiplierNumber, homeassistant.components.wyoming.number.WyomingSatelliteAutoGainNumber, homeassistant.components.wled.number.WLEDNumber, homeassistant.components.wiz.number.WizSpeedNumber, homeassistant.components.wallbox.number.WallboxNumber, homeassistant.components.vallox.number.ValloxNumberEntity, homeassistant.components.v2c.number.V2CSettingsNumberEntity, homeassistant.components.unifiprotect.number.ProtectNumbers, homeassistant.components.tplink.number.TPLinkNumberEntity, homeassistant.components.tessie.number.TessieEnergyInfoNumberSensorEntity, homeassistant.components.tessie.number.TessieNumberEntity, homeassistant.components.teslemetry.number.TeslemetryEnergyInfoNumberSensorEntity, homeassistant.components.teslemetry.number.TeslemetryVehicleNumberEntity, homeassistant.components.tesla_fleet.number.TeslaFleetEnergyInfoNumberSensorEntity, homeassistant.components.tesla_fleet.number.TeslaFleetVehicleNumberEntity, homeassistant.components.template.number.TriggerNumberEntity, homeassistant.components.template.number.TemplateNumber, homeassistant.components.technove.number.TechnoVENumberEntity, homeassistant.components.tailwind.number.TailwindNumberEntity, homeassistant.components.sleepiq.number.SleepIQNumberEntity, homeassistant.components.shelly.number.RpcNumber, homeassistant.components.shelly.number.BlockSleepingNumber, homeassistant.components.sensibo.number.SensiboNumber, homeassistant.components.screenlogic.number.ScreenLogicSCGNumber, homeassistant.components.screenlogic.number.ScreenLogicChemistryNumber, homeassistant.components.screenlogic.number.ScreenLogicNumber, homeassistant.components.sabnzbd.number.SabnzbdNumber, homeassistant.components.roborock.number.RoborockNumberEntity, homeassistant.components.rituals_perfume_genie.number.RitualsNumberEntity, homeassistant.components.ring.number.RingNumber, homeassistant.components.reolink.number.ReolinkChimeNumberEntity, homeassistant.components.reolink.number.ReolinkHostNumberEntity, homeassistant.components.reolink.number.ReolinkNumberEntity, homeassistant.components.renson.number.RensonNumber, homeassistant.components.rainbird.number.RainDelayNumber, homeassistant.components.plugwise.number.PlugwiseNumberEntity, homeassistant.components.overkiz.number.OverkizNumber, homeassistant.components.nibe_heatpump.number.Number, homeassistant.components.nexia.number.NexiaFanSpeedEntity, homeassistant.components.myuplink.number.MyUplinkNumber, homeassistant.components.mqtt.number.MqttNumber, homeassistant.components.motionmount.number.MotionMountTurn, homeassistant.components.motionmount.number.MotionMountExtension, homeassistant.components.melnor.number.MelnorZoneNumber, homeassistant.components.matter.number.MatterNumber, homeassistant.components.lg_thinq.number.ThinQNumberEntity, homeassistant.components.lektrico.number.LektricoNumber, homeassistant.components.lametric.number.LaMetricNumberEntity, homeassistant.components.lamarzocco.number.LaMarzoccoKeyNumberEntity, homeassistant.components.lamarzocco.number.LaMarzoccoNumberEntity, homeassistant.components.kostal_plenticore.number.PlenticoreDataNumber, homeassistant.components.knx.number.KNXNumber, homeassistant.components.juicenet.number.JuiceNetNumber, homeassistant.components.isy994.number.ISYBacklightNumberEntity, homeassistant.components.isy994.number.ISYVariableNumberEntity, homeassistant.components.isy994.number.ISYAuxControlNumberEntity, homeassistant.components.iron_os.number.IronOSNumberEntity, homeassistant.components.intellifire.number.IntellifireFlameControlEntity, homeassistant.components.husqvarna_automower.number.WorkAreaNumberEntity, homeassistant.components.husqvarna_automower.number.AutomowerNumberEntity, homeassistant.components.hunterdouglas_powerview.number.PowerViewNumber, homeassistant.components.homewizard.number.HWEnergyNumberEntity, homeassistant.components.homekit_controller.number.HomeKitNumber, homeassistant.components.home_connect.number.HomeConnectNumberEntity, homeassistant.components.goodwe.number.InverterNumberEntity, homeassistant.components.gardena_bluetooth.number.GardenaBluetoothRemainingOpenSetNumber, homeassistant.components.gardena_bluetooth.number.GardenaBluetoothNumber, homeassistant.components.fully_kiosk.number.FullyNumberEntity, homeassistant.components.flux_led.number.FluxConfigNumber, homeassistant.components.flux_led.number.FluxSpeedNumber, homeassistant.components.flexit_bacnet.number.FlexitNumber, homeassistant.components.fjaraskupan.number.PeriodicVentingTime, homeassistant.components.esphome.number.EsphomeNumber, homeassistant.components.eq3btsmart.number.Eq3NumberEntity, homeassistant.components.enphase_envoy.number.EnvoyStorageSettingsNumberEntity, homeassistant.components.enphase_envoy.number.EnvoyRelayNumberEntity, homeassistant.components.ecoforest.number.EcoforestNumberEntity, homeassistant.components.demo.number.DemoNumber, homeassistant.components.deconz.number.DeconzNumber, homeassistant.components.bmw_connected_drive.number.BMWNumber, homeassistant.components.baf.number.BAFNumber, homeassistant.components.apsystems.number.ApSystemsMaxOutputNumber, and homeassistant.components.airgradient.number.AirGradientNumber.

Definition at line 418 of file __init__.py.

◆ async_set_value()

None homeassistant.components.number.NumberEntity.async_set_value (   self,
float  value 
) 
Set new value.

Definition at line 428 of file __init__.py.

◆ capability_attributes()

dict[str, Any] homeassistant.components.number.NumberEntity.capability_attributes (   self) 
Return capability attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 242 of file __init__.py.

◆ convert_to_native_value()

float homeassistant.components.number.NumberEntity.convert_to_native_value (   self,
float  value 
) 
Convert a value to the number's native unit.

Definition at line 466 of file __init__.py.

◆ device_class()

NumberDeviceClass | None homeassistant.components.number.NumberEntity.device_class (   self) 
Return the class of this entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 266 of file __init__.py.

◆ max_value()

float homeassistant.components.number.NumberEntity.max_value (   self) 
Return the maximum value.

Definition at line 308 of file __init__.py.

◆ min_value()

float homeassistant.components.number.NumberEntity.min_value (   self) 
Return the minimum value.

Definition at line 288 of file __init__.py.

◆ mode()

NumberMode homeassistant.components.number.NumberEntity.mode (   self) 
Return the mode of the entity.

Definition at line 344 of file __init__.py.

◆ native_max_value()

float homeassistant.components.number.NumberEntity.native_max_value (   self) 
Return the maximum value.

Reimplemented in homeassistant.components.zha.number.ZhaNumber, homeassistant.components.wallbox.number.WallboxNumber, homeassistant.components.tessie.number.TessieNumberEntity, homeassistant.components.template.number.TriggerNumberEntity, homeassistant.components.technove.number.TechnoVENumberEntity, homeassistant.components.juicenet.number.JuiceNetNumber, homeassistant.components.iron_os.number.IronOSNumberEntity, homeassistant.components.homekit_controller.number.HomeKitNumber, homeassistant.components.flux_led.number.FluxMusicSegmentsNumber, homeassistant.components.flux_led.number.FluxMusicPixelsPerSegmentNumber, homeassistant.components.flux_led.number.FluxSegmentsNumber, and homeassistant.components.flux_led.number.FluxPixelsPerSegmentNumber.

Definition at line 295 of file __init__.py.

◆ native_min_value()

float homeassistant.components.number.NumberEntity.native_min_value (   self) 
Return the minimum value.

Reimplemented in homeassistant.components.zha.number.ZhaNumber, homeassistant.components.wallbox.number.WallboxNumber, homeassistant.components.tessie.number.TessieNumberEntity, homeassistant.components.template.number.TriggerNumberEntity, and homeassistant.components.homekit_controller.number.HomeKitNumber.

Definition at line 275 of file __init__.py.

◆ native_step()

float | None homeassistant.components.number.NumberEntity.native_step (   self) 
Return the increment/decrement step.

Reimplemented in homeassistant.components.zha.number.ZhaNumber, homeassistant.components.template.number.TriggerNumberEntity, and homeassistant.components.homekit_controller.number.HomeKitNumber.

Definition at line 315 of file __init__.py.

◆ native_unit_of_measurement()

str | None homeassistant.components.number.NumberEntity.native_unit_of_measurement (   self) 
Return the unit of measurement of the entity, if any.

Reimplemented in homeassistant.components.zha.number.ZhaNumber.

Definition at line 362 of file __init__.py.

◆ native_value()

float | None homeassistant.components.number.NumberEntity.native_value (   self) 
Return the value reported by the number.

Reimplemented in homeassistant.components.zwave_me.number.ZWaveMeNumber, homeassistant.components.zha.number.ZhaNumber, homeassistant.components.yamaha_musiccast.number.NumberCapability, homeassistant.components.wled.number.WLEDNumber, homeassistant.components.wallbox.number.WallboxNumber, homeassistant.components.vallox.number.ValloxNumberEntity, homeassistant.components.v2c.number.V2CSettingsNumberEntity, homeassistant.components.tuya.number.TuyaNumberEntity, homeassistant.components.tolo.number.ToloNumberEntity, homeassistant.components.tessie.number.TessieNumberEntity, homeassistant.components.template.number.TriggerNumberEntity, homeassistant.components.technove.number.TechnoVENumberEntity, homeassistant.components.tailwind.number.TailwindNumberEntity, homeassistant.components.sonos.number.SonosLevelEntity, homeassistant.components.shelly.number.RpcNumber, homeassistant.components.shelly.number.BlockSleepingNumber, homeassistant.components.sensibo.number.SensiboNumber, homeassistant.components.screenlogic.number.ScreenLogicNumber, homeassistant.components.sabnzbd.number.SabnzbdNumber, homeassistant.components.roborock.number.RoborockNumberEntity, homeassistant.components.rituals_perfume_genie.number.RitualsNumberEntity, homeassistant.components.reolink.number.ReolinkChimeNumberEntity, homeassistant.components.reolink.number.ReolinkHostNumberEntity, homeassistant.components.reolink.number.ReolinkNumberEntity, homeassistant.components.rainbird.number.RainDelayNumber, homeassistant.components.plugwise.number.PlugwiseNumberEntity, homeassistant.components.overkiz.number.OverkizNumber, homeassistant.components.nexia.number.NexiaFanSpeedEntity, homeassistant.components.myuplink.number.MyUplinkNumber, homeassistant.components.motionmount.number.MotionMountTurn, homeassistant.components.motionmount.number.MotionMountExtension, homeassistant.components.melnor.number.MelnorZoneNumber, homeassistant.components.lektrico.number.LektricoNumber, homeassistant.components.lametric.number.LaMetricNumberEntity, homeassistant.components.lamarzocco.number.LaMarzoccoKeyNumberEntity, homeassistant.components.lamarzocco.number.LaMarzoccoNumberEntity, homeassistant.components.kostal_plenticore.number.PlenticoreDataNumber, homeassistant.components.knx.number.KNXNumber, homeassistant.components.juicenet.number.JuiceNetNumber, homeassistant.components.isy994.number.ISYVariableNumberEntity, homeassistant.components.isy994.number.ISYAuxControlNumberEntity, homeassistant.components.iron_os.number.IronOSNumberEntity, homeassistant.components.intellifire.number.IntellifireFlameControlEntity, homeassistant.components.husqvarna_automower.number.WorkAreaNumberEntity, homeassistant.components.husqvarna_automower.number.AutomowerNumberEntity, homeassistant.components.homewizard.number.HWEnergyNumberEntity, homeassistant.components.homekit_controller.number.HomeKitNumber, homeassistant.components.fully_kiosk.number.FullyNumberEntity, homeassistant.components.flux_led.number.FluxMusicSegmentsNumber, homeassistant.components.flux_led.number.FluxMusicPixelsPerSegmentNumber, homeassistant.components.flux_led.number.FluxSegmentsNumber, homeassistant.components.flux_led.number.FluxPixelsPerSegmentNumber, homeassistant.components.flux_led.number.FluxSpeedNumber, homeassistant.components.flexit_bacnet.number.FlexitNumber, homeassistant.components.fjaraskupan.number.PeriodicVentingTime, homeassistant.components.ezviz.number.EzvizNumber, homeassistant.components.esphome.number.EsphomeNumber, homeassistant.components.eq3btsmart.number.Eq3NumberEntity, homeassistant.components.enphase_envoy.number.EnvoyStorageSettingsNumberEntity, homeassistant.components.enphase_envoy.number.EnvoyRelayNumberEntity, homeassistant.components.ecoforest.number.EcoforestNumberEntity, homeassistant.components.deconz.number.DeconzNumber, homeassistant.components.bmw_connected_drive.number.BMWNumber, and homeassistant.components.airgradient.number.AirGradientNumber.

Definition at line 402 of file __init__.py.

◆ set_native_value()

None homeassistant.components.number.NumberEntity.set_native_value (   self,
float  value 
) 
Set new value.

Reimplemented in homeassistant.components.zwave_me.number.ZWaveMeNumber, homeassistant.components.vicare.number.ViCareNumber, homeassistant.components.tuya.number.TuyaNumberEntity, homeassistant.components.tolo.number.ToloNumberEntity, homeassistant.components.sonos.number.SonosLevelEntity, homeassistant.components.ezviz.number.EzvizNumber, homeassistant.components.ecobee.number.EcobeeCompressorMinTemp, and homeassistant.components.ecobee.number.EcobeeVentilatorMinTime.

Definition at line 414 of file __init__.py.

◆ set_value()

None homeassistant.components.number.NumberEntity.set_value (   self,
float  value 
) 
Set new value.

Definition at line 423 of file __init__.py.

◆ state()

float | None homeassistant.components.number.NumberEntity.state (   self) 
Return the entity state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 357 of file __init__.py.

◆ step()

float homeassistant.components.number.NumberEntity.step (   self) 
Return the increment/decrement step.

Definition at line 328 of file __init__.py.

◆ unit_of_measurement()

str | None homeassistant.components.number.NumberEntity.unit_of_measurement (   self) 
Return the unit of measurement of the entity, after unit conversion.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 372 of file __init__.py.

◆ value()

float | None homeassistant.components.number.NumberEntity.value (   self) 
Return the entity value to represent the entity state.

Definition at line 408 of file __init__.py.

Member Data Documentation

◆ _deprecated_number_entity_reported

homeassistant.components.number.NumberEntity._deprecated_number_entity_reported
staticprivate

Definition at line 202 of file __init__.py.

◆ _entity_component_unrecorded_attributes

homeassistant.components.number.NumberEntity._entity_component_unrecorded_attributes
staticprivate

Definition at line 184 of file __init__.py.

◆ _number_option_unit_of_measurement

homeassistant.components.number.NumberEntity._number_option_unit_of_measurement
private

Definition at line 500 of file __init__.py.

◆ device_class

homeassistant.components.number.NumberEntity.device_class

Definition at line 383 of file __init__.py.

◆ None

homeassistant.components.number.NumberEntity.None
static

Definition at line 193 of file __init__.py.

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