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

Public Member Functions

None __init__ (self, Variable node, str unique_id, NumberEntityDescription description, DeviceInfo device_info, bool init_entity=False)
 
None async_added_to_hass (self)
 
None async_on_update (self, NodeProperty event)
 
None async_set_native_value (self, float value)
 
dict[str, Any] extra_state_attributes (self)
 
float|int|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)
 
float native_max_value (self)
 
float native_min_value (self)
 
float|None native_step (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_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)
 
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 Attributes

 entity_description
 
- 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
 

Private Attributes

 _attr_device_info
 
 _attr_unique_id
 
 _change_handler
 
 _init_entity
 
 _node
 

Static Private Attributes

bool _attr_has_entity_name = False
 
bool _attr_should_poll = False
 

Additional Inherited Members

- 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
 

Detailed Description

Representation of an ISY variable as a number entity device.

Definition at line 184 of file number.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.isy994.number.ISYVariableNumberEntity.__init__ (   self,
Variable  node,
str  unique_id,
NumberEntityDescription  description,
DeviceInfo  device_info,
bool   init_entity = False 
)
Initialize the ISY variable number.

Definition at line 193 of file number.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.isy994.number.ISYVariableNumberEntity.async_added_to_hass (   self)
Subscribe to the node change events.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 212 of file number.py.

◆ async_on_update()

None homeassistant.components.isy994.number.ISYVariableNumberEntity.async_on_update (   self,
NodeProperty  event 
)
Handle the update event from the ISY Node.

Definition at line 217 of file number.py.

◆ async_set_native_value()

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

Reimplemented from homeassistant.components.number.NumberEntity.

Definition at line 237 of file number.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.isy994.number.ISYVariableNumberEntity.extra_state_attributes (   self)
Get the state attributes for the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 231 of file number.py.

◆ native_value()

float | int | None homeassistant.components.isy994.number.ISYVariableNumberEntity.native_value (   self)
Return the state of the variable.

Reimplemented from homeassistant.components.number.NumberEntity.

Definition at line 222 of file number.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.isy994.number.ISYVariableNumberEntity._attr_device_info
private

Definition at line 210 of file number.py.

◆ _attr_has_entity_name

bool homeassistant.components.isy994.number.ISYVariableNumberEntity._attr_has_entity_name = False
staticprivate

Definition at line 187 of file number.py.

◆ _attr_should_poll

bool homeassistant.components.isy994.number.ISYVariableNumberEntity._attr_should_poll = False
staticprivate

Definition at line 188 of file number.py.

◆ _attr_unique_id

homeassistant.components.isy994.number.ISYVariableNumberEntity._attr_unique_id
private

Definition at line 209 of file number.py.

◆ _change_handler

homeassistant.components.isy994.number.ISYVariableNumberEntity._change_handler
private

Definition at line 214 of file number.py.

◆ _init_entity

homeassistant.components.isy994.number.ISYVariableNumberEntity._init_entity
private

Definition at line 208 of file number.py.

◆ _node

homeassistant.components.isy994.number.ISYVariableNumberEntity._node
private

Definition at line 202 of file number.py.

◆ entity_description

homeassistant.components.isy994.number.ISYVariableNumberEntity.entity_description

Definition at line 203 of file number.py.


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