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

Public Member Functions

None __init__ (self, HomeAssistant hass, AvmWrapper avm_wrapper, str device_friendly_name, str ssid)
 
None async_added_to_hass (self)
 
bytes|None async_image (self)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.fritz.entity.FritzBoxBaseEntity
None __init__ (self, AvmWrapper avm_wrapper, str device_name)
 
DeviceInfo device_info (self)
 
str mac_address (self)
 
- Public Member Functions inherited from homeassistant.components.image.ImageEntity
None __init__ (self, HomeAssistant hass, bool verify_ssl=False)
 
None async_update_token (self)
 
str content_type (self)
 
str|None entity_picture (self)
 
bytes|None image (self)
 
datetime|None image_last_updated (self)
 
str|None|UndefinedType image_url (self)
 
str|None state (self)
 
dict[str, str|Nonestate_attributes (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)
 
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)
 

Private Member Functions

bytes _fetch_image (self)
 

Private Attributes

 _attr_image_last_updated
 
 _attr_name
 
 _attr_unique_id
 
 _current_qr_bytes
 

Static Private Attributes

string _attr_content_type = "image/png"
 
 _attr_entity_category = EntityCategory.DIAGNOSTIC
 
bool _attr_has_entity_name = True
 
bool _attr_should_poll = True
 

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.components.image.ImageEntity
 bool
 
 None
 
 str
 
 UndefinedType
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Implementation of the FritzBox guest wifi QR code image entity.

Definition at line 45 of file image.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.fritz.image.FritzGuestWifiQRImage.__init__ (   self,
HomeAssistant  hass,
AvmWrapper  avm_wrapper,
str  device_friendly_name,
str  ssid 
)
Initialize the image entity.

Definition at line 53 of file image.py.

Member Function Documentation

◆ _fetch_image()

bytes homeassistant.components.fritz.image.FritzGuestWifiQRImage._fetch_image (   self)
private
Fetch the QR code from the Fritz!Box.

Definition at line 67 of file image.py.

◆ async_added_to_hass()

None homeassistant.components.fritz.image.FritzGuestWifiQRImage.async_added_to_hass (   self)
Fetch and set initial data and state.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 77 of file image.py.

◆ async_image()

bytes | None homeassistant.components.fritz.image.FritzGuestWifiQRImage.async_image (   self)
Return bytes of image.

Reimplemented from homeassistant.components.image.ImageEntity.

Definition at line 99 of file image.py.

◆ async_update()

None homeassistant.components.fritz.image.FritzGuestWifiQRImage.async_update (   self)
Update the image entity data.

Definition at line 82 of file image.py.

Member Data Documentation

◆ _attr_content_type

string homeassistant.components.fritz.image.FritzGuestWifiQRImage._attr_content_type = "image/png"
staticprivate

Definition at line 48 of file image.py.

◆ _attr_entity_category

homeassistant.components.fritz.image.FritzGuestWifiQRImage._attr_entity_category = EntityCategory.DIAGNOSTIC
staticprivate

Definition at line 49 of file image.py.

◆ _attr_has_entity_name

bool homeassistant.components.fritz.image.FritzGuestWifiQRImage._attr_has_entity_name = True
staticprivate

Definition at line 50 of file image.py.

◆ _attr_image_last_updated

homeassistant.components.fritz.image.FritzGuestWifiQRImage._attr_image_last_updated
private

Definition at line 80 of file image.py.

◆ _attr_name

homeassistant.components.fritz.image.FritzGuestWifiQRImage._attr_name
private

Definition at line 61 of file image.py.

◆ _attr_should_poll

bool homeassistant.components.fritz.image.FritzGuestWifiQRImage._attr_should_poll = True
staticprivate

Definition at line 51 of file image.py.

◆ _attr_unique_id

homeassistant.components.fritz.image.FritzGuestWifiQRImage._attr_unique_id
private

Definition at line 62 of file image.py.

◆ _current_qr_bytes

homeassistant.components.fritz.image.FritzGuestWifiQRImage._current_qr_bytes
private

Definition at line 79 of file image.py.


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