Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.unifi.image.UnifiImageEntity Class Reference
Inheritance diagram for homeassistant.components.unifi.image.UnifiImageEntity:
[legend]
Collaboration diagram for homeassistant.components.unifi.image.UnifiImageEntity:
[legend]

Public Member Functions

None __init__ (self, str obj_id, UnifiHub hub, UnifiEntityDescription[HandlerT, ApiItemT] description)
 
None async_update_state (self, ItemEvent event, str obj_id)
 
bytes|None image (self)
 
- Public Member Functions inherited from homeassistant.components.unifi.entity.UnifiEntity
None __init__ (self, str obj_id, UnifiHub hub, UnifiEntityDescription[HandlerT, ApiItemT] description)
 
None async_added_to_hass (self)
 
None async_event_callback (self, Event event)
 
None async_initiate_state (self)
 
None async_signal_options_updated (self)
 
None async_signal_reachable_callback (self)
 
None async_signalling_callback (self, ItemEvent event, str obj_id)
 
None async_update (self)
 
None remove_item (self, set keys)
 
- 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)
 
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)
 
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 Member Functions inherited from homeassistant.components.image.ImageEntity
None __init__ (self, HomeAssistant hass, bool verify_ssl=False)
 
bytes|None async_image (self)
 
None async_update_token (self)
 
str content_type (self)
 
str|None entity_picture (self)
 
datetime|None image_last_updated (self)
 
str|None|UndefinedType image_url (self)
 
str|None state (self)
 
dict[str, str|Nonestate_attributes (self)
 

Public Attributes

 current_image
 
 previous_value
 
- Public Attributes inherited from homeassistant.components.unifi.entity.UnifiEntity
 api
 
 entity_description
 
 hub
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Static Public Attributes

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

Private Attributes

 _attr_image_last_updated
 

Static Private Attributes

string _attr_content_type = "image/png"
 

Detailed Description

Base representation of a UniFi image.

Definition at line 78 of file image.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.unifi.image.UnifiImageEntity.__init__ (   self,
str  obj_id,
UnifiHub  hub,
UnifiEntityDescription[HandlerT, ApiItemT]  description 
)
Initiatlize UniFi Image entity.

Definition at line 87 of file image.py.

Member Function Documentation

◆ async_update_state()

None homeassistant.components.unifi.image.UnifiImageEntity.async_update_state (   self,
ItemEvent  event,
str  obj_id 
)
Update entity state.

Reimplemented from homeassistant.components.unifi.entity.UnifiEntity.

Definition at line 106 of file image.py.

◆ image()

bytes | None homeassistant.components.unifi.image.UnifiImageEntity.image (   self)
Return bytes of image.

Reimplemented from homeassistant.components.image.ImageEntity.

Definition at line 97 of file image.py.

Member Data Documentation

◆ _attr_content_type

string homeassistant.components.unifi.image.UnifiImageEntity._attr_content_type = "image/png"
staticprivate

Definition at line 82 of file image.py.

◆ _attr_image_last_updated

homeassistant.components.unifi.image.UnifiImageEntity._attr_image_last_updated
private

Definition at line 113 of file image.py.

◆ current_image

homeassistant.components.unifi.image.UnifiImageEntity.current_image

Definition at line 102 of file image.py.

◆ None

homeassistant.components.unifi.image.UnifiImageEntity.None
static

Definition at line 84 of file image.py.

◆ previous_value

homeassistant.components.unifi.image.UnifiImageEntity.previous_value

Definition at line 111 of file image.py.


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