Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.template.number.TemplateNumber Class Reference
Inheritance diagram for homeassistant.components.template.number.TemplateNumber:
[legend]
Collaboration diagram for homeassistant.components.template.number.TemplateNumber:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass, config, str|None unique_id)
 
None async_set_native_value (self, float value)
 
- Public Member Functions inherited from homeassistant.components.template.template_entity.TemplateEntity
None __init__ (self, HomeAssistant hass, *Template|None availability_template=None, Template|None icon_template=None, Template|None entity_picture_template=None, dict[str, Template]|None attribute_templates=None, ConfigType|None config=None, str|None fallback_name=None, str|None unique_id=None)
 
None add_template_attribute (self, str attribute, Template template, Callable[[Any], Any]|None validator=None, Callable[[Any], None]|None on_update=None, bool none_on_template_error=False)
 
None async_added_to_hass (self)
 
None async_run_script (self, Script script, *_VarsType|None run_variables=None, Context|None context=None)
 
CALLBACK_TYPE async_start_preview (self, Callable[[str|None, Mapping[str, Any]|None, dict[str, bool|set[str]]|None, str|None,], None,] preview_callback)
 
None async_update (self)
 
str|None referenced_blueprint (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_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, strtranslation_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 Member Functions inherited from homeassistant.components.number.NumberEntity
None __init_subclass__ (cls, **Any kwargs)
 
None async_internal_added_to_hass (self)
 
None async_registry_entry_updated (self)
 
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)
 

Private Member Functions

None _async_setup_templates (self)
 

Private Attributes

 _attr_assumed_state
 
 _attr_device_info
 
 _attr_native_max_value
 
 _attr_native_min_value
 
 _attr_native_step
 
 _attr_native_unit_of_measurement
 
 _attr_native_value
 
 _command_set_value
 
 _max_value_template
 
 _min_value_template
 
 _optimistic
 
 _step_template
 
 _value_template
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.template.template_entity.TemplateEntity
 entity_id
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Public Attributes inherited from homeassistant.components.number.NumberEntity
 device_class
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.components.number.NumberEntity
 None
 

Detailed Description

Representation of a template number.

Definition at line 142 of file number.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.template.number.TemplateNumber.__init__ (   self,
HomeAssistant  hass,
  config,
str | None  unique_id 
)
Initialize the number.

Definition at line 147 of file number.py.

Member Function Documentation

◆ _async_setup_templates()

None homeassistant.components.template.number.TemplateNumber._async_setup_templates (   self)
private
Set up templates.

Reimplemented from homeassistant.components.template.template_entity.TemplateEntity.

Definition at line 175 of file number.py.

◆ async_set_native_value()

None homeassistant.components.template.number.TemplateNumber.async_set_native_value (   self,
float  value 
)
Set value of the number.

Reimplemented from homeassistant.components.number.NumberEntity.

Definition at line 205 of file number.py.

Member Data Documentation

◆ _attr_assumed_state

homeassistant.components.template.number.TemplateNumber._attr_assumed_state
private

Definition at line 164 of file number.py.

◆ _attr_device_info

homeassistant.components.template.number.TemplateNumber._attr_device_info
private

Definition at line 169 of file number.py.

◆ _attr_native_max_value

homeassistant.components.template.number.TemplateNumber._attr_native_max_value
private

Definition at line 168 of file number.py.

◆ _attr_native_min_value

homeassistant.components.template.number.TemplateNumber._attr_native_min_value
private

Definition at line 167 of file number.py.

◆ _attr_native_step

homeassistant.components.template.number.TemplateNumber._attr_native_step
private

Definition at line 166 of file number.py.

◆ _attr_native_unit_of_measurement

homeassistant.components.template.number.TemplateNumber._attr_native_unit_of_measurement
private

Definition at line 165 of file number.py.

◆ _attr_native_value

homeassistant.components.template.number.TemplateNumber._attr_native_value
private

Definition at line 208 of file number.py.

◆ _attr_should_poll

bool homeassistant.components.template.number.TemplateNumber._attr_should_poll = False
staticprivate

Definition at line 145 of file number.py.

◆ _command_set_value

homeassistant.components.template.number.TemplateNumber._command_set_value
private

Definition at line 157 of file number.py.

◆ _max_value_template

homeassistant.components.template.number.TemplateNumber._max_value_template
private

Definition at line 163 of file number.py.

◆ _min_value_template

homeassistant.components.template.number.TemplateNumber._min_value_template
private

Definition at line 162 of file number.py.

◆ _optimistic

homeassistant.components.template.number.TemplateNumber._optimistic
private

Definition at line 164 of file number.py.

◆ _step_template

homeassistant.components.template.number.TemplateNumber._step_template
private

Definition at line 161 of file number.py.

◆ _value_template

homeassistant.components.template.number.TemplateNumber._value_template
private

Definition at line 156 of file number.py.


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