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

Public Member Functions

None __init__ (self, IHCController ihc_controller, str controller_id, str name, int ihc_id, product=None)
 
def async_added_to_hass (self)
 
def extra_state_attributes (self)
 
def name (self)
 
def on_ihc_change (self, ihc_id, value)
 
def unique_id (self)
 
- 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)
 
bool available (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)
 
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 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)
 

Public Attributes

 controller_id
 
 device_id
 
 device_model
 
 device_name
 
 ihc_controller
 
 ihc_id
 
 ihc_name
 
 ihc_note
 
 ihc_position
 
 suggested_area
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Attributes

 _name
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

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

Detailed Description

Base class for all IHC devices.

All IHC devices have an associated IHC resource. IHCEntity handled the
registration of the IHC controller callback when the IHC resource changes.
Derived classes must implement the on_ihc_change method

Definition at line 14 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ihc.entity.IHCEntity.__init__ (   self,
IHCController  ihc_controller,
str  controller_id,
str  name,
int  ihc_id,
  product = None 
)
Initialize IHC attributes.

Definition at line 24 of file entity.py.

Member Function Documentation

◆ async_added_to_hass()

def homeassistant.components.ihc.entity.IHCEntity.async_added_to_hass (   self)
Add callback for IHC changes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 57 of file entity.py.

◆ extra_state_attributes()

def homeassistant.components.ihc.entity.IHCEntity.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 73 of file entity.py.

◆ name()

def homeassistant.components.ihc.entity.IHCEntity.name (   self)
Return the device name.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 63 of file entity.py.

◆ on_ihc_change()

def homeassistant.components.ihc.entity.IHCEntity.on_ihc_change (   self,
  ihc_id,
  value 
)
Handle IHC resource change.

Derived classes must overwrite this to do device specific stuff.

Reimplemented in homeassistant.components.ihc.switch.IHCSwitch, homeassistant.components.ihc.sensor.IHCSensor, homeassistant.components.ihc.light.IhcLight, and homeassistant.components.ihc.binary_sensor.IHCBinarySensor.

Definition at line 88 of file entity.py.

◆ unique_id()

def homeassistant.components.ihc.entity.IHCEntity.unique_id (   self)
Return a unique ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 68 of file entity.py.

Member Data Documentation

◆ _attr_should_poll

bool homeassistant.components.ihc.entity.IHCEntity._attr_should_poll = False
staticprivate

Definition at line 22 of file entity.py.

◆ _name

homeassistant.components.ihc.entity.IHCEntity._name
private

Definition at line 34 of file entity.py.

◆ controller_id

homeassistant.components.ihc.entity.IHCEntity.controller_id

Definition at line 36 of file entity.py.

◆ device_id

homeassistant.components.ihc.entity.IHCEntity.device_id

Definition at line 37 of file entity.py.

◆ device_model

homeassistant.components.ihc.entity.IHCEntity.device_model

Definition at line 51 of file entity.py.

◆ device_name

homeassistant.components.ihc.entity.IHCEntity.device_name

Definition at line 48 of file entity.py.

◆ ihc_controller

homeassistant.components.ihc.entity.IHCEntity.ihc_controller

Definition at line 33 of file entity.py.

◆ ihc_id

homeassistant.components.ihc.entity.IHCEntity.ihc_id

Definition at line 35 of file entity.py.

◆ ihc_name

homeassistant.components.ihc.entity.IHCEntity.ihc_name

Definition at line 40 of file entity.py.

◆ ihc_note

homeassistant.components.ihc.entity.IHCEntity.ihc_note

Definition at line 41 of file entity.py.

◆ ihc_position

homeassistant.components.ihc.entity.IHCEntity.ihc_position

Definition at line 42 of file entity.py.

◆ suggested_area

homeassistant.components.ihc.entity.IHCEntity.suggested_area

Definition at line 38 of file entity.py.


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