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

Public Member Functions

None __init__ (self, HomeAssistant hass, TriggerUpdateCoordinator coordinator, dict config)
 
None async_set_native_value (self, float value)
 
int native_max_value (self)
 
int native_min_value (self)
 
int native_step (self)
 
float|None native_value (self)
 
- 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)
 
str|None native_unit_of_measurement (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, 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)
 

Static Public Attributes

 domain = NUMBER_DOMAIN
 
tuple extra_template_keys
 
- Static Public Attributes inherited from homeassistant.components.number.NumberEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Private Attributes

 _attr_native_unit_of_measurement
 
 _attr_native_value
 
 _command_set_value
 

Additional Inherited Members

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

Detailed Description

Number entity based on trigger data.

Definition at line 218 of file number.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.template.number.TriggerNumberEntity.__init__ (   self,
HomeAssistant  hass,
TriggerUpdateCoordinator  coordinator,
dict  config 
)
Initialize the entity.

Definition at line 229 of file number.py.

Member Function Documentation

◆ async_set_native_value()

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

Reimplemented from homeassistant.components.number.NumberEntity.

Definition at line 273 of file number.py.

◆ native_max_value()

int homeassistant.components.template.number.TriggerNumberEntity.native_max_value (   self)
Return the maximum value.

Reimplemented from homeassistant.components.number.NumberEntity.

Definition at line 260 of file number.py.

◆ native_min_value()

int homeassistant.components.template.number.TriggerNumberEntity.native_min_value (   self)
Return the minimum value.

Reimplemented from homeassistant.components.number.NumberEntity.

Definition at line 253 of file number.py.

◆ native_step()

int homeassistant.components.template.number.TriggerNumberEntity.native_step (   self)
Return the increment/decrement step.

Reimplemented from homeassistant.components.number.NumberEntity.

Definition at line 267 of file number.py.

◆ native_value()

float | None homeassistant.components.template.number.TriggerNumberEntity.native_value (   self)
Return the currently selected option.

Reimplemented from homeassistant.components.number.NumberEntity.

Definition at line 248 of file number.py.

Member Data Documentation

◆ _attr_native_unit_of_measurement

homeassistant.components.template.number.TriggerNumberEntity._attr_native_unit_of_measurement
private

Definition at line 245 of file number.py.

◆ _attr_native_value

homeassistant.components.template.number.TriggerNumberEntity._attr_native_value
private

Definition at line 276 of file number.py.

◆ _command_set_value

homeassistant.components.template.number.TriggerNumberEntity._command_set_value
private

Definition at line 238 of file number.py.

◆ domain

homeassistant.components.template.number.TriggerNumberEntity.domain = NUMBER_DOMAIN
static

Definition at line 221 of file number.py.

◆ extra_template_keys

tuple homeassistant.components.template.number.TriggerNumberEntity.extra_template_keys
static
Initial value:
= (
CONF_STATE,
CONF_STEP,
CONF_MIN,
CONF_MAX,
)

Definition at line 222 of file number.py.


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