Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.hue.v2.entity.HueBaseEntity Class Reference
Inheritance diagram for homeassistant.components.hue.v2.entity.HueBaseEntity:
[legend]
Collaboration diagram for homeassistant.components.hue.v2.entity.HueBaseEntity:
[legend]

Public Member Functions

None __init__ (self, HueBridge bridge, BaseResourcesController controller, HueResource resource)
 
None async_added_to_hass (self)
 
bool available (self)
 
None on_update (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)
 
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)
 
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)
 
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

 bridge
 
 controller
 
 device
 
 logger
 
 resource
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

def _check_availability (self)
 
None _handle_event (self, EventType event_type, HueResource resource)
 

Private Attributes

 _attr_device_info
 
 _attr_unique_id
 
 _ignore_availability
 
 _last_state
 

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

Generic Entity Class for a Hue resource.

Definition at line 37 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.hue.v2.entity.HueBaseEntity.__init__ (   self,
HueBridge  bridge,
BaseResourcesController  controller,
HueResource  resource 
)
Initialize a generic Hue resource entity.

Definition at line 42 of file entity.py.

Member Function Documentation

◆ _check_availability()

def homeassistant.components.hue.v2.entity.HueBaseEntity._check_availability (   self)
private
Check availability of the device.

Definition at line 141 of file entity.py.

◆ _handle_event()

None homeassistant.components.hue.v2.entity.HueBaseEntity._handle_event (   self,
EventType  event_type,
HueResource  resource 
)
private
Handle status event for this resource (or it's parent).

Definition at line 126 of file entity.py.

◆ async_added_to_hass()

None homeassistant.components.hue.v2.entity.HueBaseEntity.async_added_to_hass (   self)
Call when entity is added.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.hue.v2.group.GroupedHueLight, and homeassistant.components.hue.scene.HueSceneEntityBase.

Definition at line 73 of file entity.py.

◆ available()

bool homeassistant.components.hue.v2.entity.HueBaseEntity.available (   self)
Return entity availability.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 105 of file entity.py.

◆ on_update()

None homeassistant.components.hue.v2.entity.HueBaseEntity.on_update (   self)
Call on update event.

Reimplemented in homeassistant.components.hue.v2.group.GroupedHueLight.

Definition at line 121 of file entity.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.hue.v2.entity.HueBaseEntity._attr_device_info
private

Definition at line 62 of file entity.py.

◆ _attr_should_poll

bool homeassistant.components.hue.v2.entity.HueBaseEntity._attr_should_poll = False
staticprivate

Definition at line 40 of file entity.py.

◆ _attr_unique_id

homeassistant.components.hue.v2.entity.HueBaseEntity._attr_unique_id
private

Definition at line 56 of file entity.py.

◆ _ignore_availability

homeassistant.components.hue.v2.entity.HueBaseEntity._ignore_availability
private

Definition at line 70 of file entity.py.

◆ _last_state

homeassistant.components.hue.v2.entity.HueBaseEntity._last_state
private

Definition at line 71 of file entity.py.

◆ bridge

homeassistant.components.hue.v2.entity.HueBaseEntity.bridge

Definition at line 49 of file entity.py.

◆ controller

homeassistant.components.hue.v2.entity.HueBaseEntity.controller

Definition at line 50 of file entity.py.

◆ device

homeassistant.components.hue.v2.entity.HueBaseEntity.device

Definition at line 52 of file entity.py.

◆ logger

homeassistant.components.hue.v2.entity.HueBaseEntity.logger

Definition at line 53 of file entity.py.

◆ resource

homeassistant.components.hue.v2.entity.HueBaseEntity.resource

Definition at line 51 of file entity.py.


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