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

Public Member Functions

None __init__ (self, device, logical)
 
def async_added_to_hass (self)
 
def extra_state_attributes (self)
 
def physical_address (self)
 
def type (self)
 
def type_id (self)
 
def vendor_id (self)
 
def vendor_name (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)
 
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)
 

Public Attributes

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

Private Member Functions

def _hdmi_cec_unavailable (self, callback_event)
 
def _set_attr_name (self)
 
def _update (self, device=None)
 

Private Attributes

 _attr_available
 
 _attr_icon
 
 _attr_name
 
 _device
 
 _logical_address
 

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

Representation of a HDMI CEC device entity.

Definition at line 30 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.hdmi_cec.entity.CecEntity.__init__ (   self,
  device,
  logical 
)

Member Function Documentation

◆ _hdmi_cec_unavailable()

def homeassistant.components.hdmi_cec.entity.CecEntity._hdmi_cec_unavailable (   self,
  callback_event 
)
private

Definition at line 56 of file entity.py.

◆ _set_attr_name()

def homeassistant.components.hdmi_cec.entity.CecEntity._set_attr_name (   self)
private
Set name.

Definition at line 43 of file entity.py.

◆ _update()

def homeassistant.components.hdmi_cec.entity.CecEntity._update (   self,
  device = None 
)
private
Device status changed, schedule an update.

Definition at line 67 of file entity.py.

◆ async_added_to_hass()

def homeassistant.components.hdmi_cec.entity.CecEntity.async_added_to_hass (   self)
Register HDMI callbacks after initialization.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 60 of file entity.py.

◆ extra_state_attributes()

def homeassistant.components.hdmi_cec.entity.CecEntity.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 98 of file entity.py.

◆ physical_address()

def homeassistant.components.hdmi_cec.entity.CecEntity.physical_address (   self)
Return the physical address of device in HDMI network.

Definition at line 83 of file entity.py.

◆ type()

def homeassistant.components.hdmi_cec.entity.CecEntity.type (   self)
Return a string representation of the device's type.

Definition at line 88 of file entity.py.

◆ type_id()

def homeassistant.components.hdmi_cec.entity.CecEntity.type_id (   self)
Return the type ID of device.

Definition at line 93 of file entity.py.

◆ vendor_id()

def homeassistant.components.hdmi_cec.entity.CecEntity.vendor_id (   self)
Return the ID of the device's vendor.

Definition at line 73 of file entity.py.

◆ vendor_name()

def homeassistant.components.hdmi_cec.entity.CecEntity.vendor_name (   self)
Return the name of the device's vendor.

Definition at line 78 of file entity.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.hdmi_cec.entity.CecEntity._attr_available
private

Definition at line 57 of file entity.py.

◆ _attr_icon

homeassistant.components.hdmi_cec.entity.CecEntity._attr_icon
private

Definition at line 41 of file entity.py.

◆ _attr_name

homeassistant.components.hdmi_cec.entity.CecEntity._attr_name
private

Definition at line 50 of file entity.py.

◆ _attr_should_poll

bool homeassistant.components.hdmi_cec.entity.CecEntity._attr_should_poll = False
staticprivate

Definition at line 33 of file entity.py.

◆ _device

homeassistant.components.hdmi_cec.entity.CecEntity._device
private

Definition at line 37 of file entity.py.

◆ _logical_address

homeassistant.components.hdmi_cec.entity.CecEntity._logical_address
private

Definition at line 38 of file entity.py.

◆ entity_id

homeassistant.components.hdmi_cec.entity.CecEntity.entity_id

Definition at line 39 of file entity.py.


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