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

Public Member Functions

None __init__ (self, Node|Group|Variable|Program node, DeviceInfo|None device_info=None)
 
None async_get_zwave_parameter (self, Any parameter)
 
None async_rename_node (self, str name)
 
None async_send_node_command (self, str command)
 
None async_send_raw_node_command (self, str command, Any|None value=None, str|None unit_of_measurement=None, Any|None parameters=None)
 
None async_set_zwave_parameter (self, Any parameter, Any|None value, int|None size)
 
bool available (self)
 
dict extra_state_attributes (self)
 
- Public Member Functions inherited from homeassistant.components.isy994.entity.ISYEntity
None async_added_to_hass (self)
 
None async_on_control (self, NodeProperty event)
 
None async_on_update (self, NodeProperty event)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
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_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
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)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (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)
 
StateType state (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)
 
str|None unit_of_measurement (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)
 

Private Attributes

 _attr_has_entity_name
 
 _attr_name
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a ISY Nodebase (Node/Group) entity.

Definition at line 89 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.isy994.entity.ISYNodeEntity.__init__ (   self,
Node | Group | Variable | Program  node,
DeviceInfo | None   device_info = None 
)
Initialize the ISY/IoX node entity.

Reimplemented from homeassistant.components.isy994.entity.ISYEntity.

Definition at line 92 of file entity.py.

Member Function Documentation

◆ async_get_zwave_parameter()

None homeassistant.components.isy994.entity.ISYNodeEntity.async_get_zwave_parameter (   self,
Any  parameter 
)
Respond to an entity service command to request a Z-Wave device parameter from the ISY.

Definition at line 153 of file entity.py.

◆ async_rename_node()

None homeassistant.components.isy994.entity.ISYNodeEntity.async_rename_node (   self,
str  name 
)
Respond to an entity service command to rename a node on the ISY.

Definition at line 174 of file entity.py.

◆ async_send_node_command()

None homeassistant.components.isy994.entity.ISYNodeEntity.async_send_node_command (   self,
str  command 
)
Respond to an entity service command call.

Definition at line 131 of file entity.py.

◆ async_send_raw_node_command()

None homeassistant.components.isy994.entity.ISYNodeEntity.async_send_raw_node_command (   self,
str  command,
Any | None   value = None,
str | None   unit_of_measurement = None,
Any | None   parameters = None 
)
Respond to an entity service raw command call.

Definition at line 139 of file entity.py.

◆ async_set_zwave_parameter()

None homeassistant.components.isy994.entity.ISYNodeEntity.async_set_zwave_parameter (   self,
Any  parameter,
Any | None  value,
int | None   size 
)
Respond to an entity service command to set a Z-Wave device parameter via the ISY.

Definition at line 162 of file entity.py.

◆ available()

bool homeassistant.components.isy994.entity.ISYNodeEntity.available (   self)
Return entity availability.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.isy994.sensor.ISYAuxSensorEntity.

Definition at line 104 of file entity.py.

◆ extra_state_attributes()

dict homeassistant.components.isy994.entity.ISYNodeEntity.extra_state_attributes (   self)
Get the state attributes for the device.

The 'aux_properties' in the pyisy Node class are combined with the
other attributes which have been picked up from the event stream and
the combined result are returned as the device state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.isy994.light.ISYLightEntity, and homeassistant.components.isy994.binary_sensor.ISYBinarySensorHeartbeat.

Definition at line 109 of file entity.py.

Member Data Documentation

◆ _attr_has_entity_name

homeassistant.components.isy994.entity.ISYNodeEntity._attr_has_entity_name
private

Definition at line 100 of file entity.py.

◆ _attr_name

homeassistant.components.isy994.entity.ISYNodeEntity._attr_name
private

Definition at line 101 of file entity.py.


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