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

Public Member Functions

None __init__ (self, AvmWrapper avm_wrapper, str device_friendly_name)
 
None async_install (self, str|None version, bool backup, **Any kwargs)
 
str|None installed_version (self)
 
str|None latest_version (self)
 
str|None release_url (self)
 
- Public Member Functions inherited from homeassistant.components.fritz.entity.FritzBoxBaseCoordinatorEntity
None __init__ (self, AvmWrapper avm_wrapper, str device_name, FritzEntityDescription description)
 
None async_added_to_hass (self)
 
DeviceInfo device_info (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.fritz.coordinator.AvmWrapper
dict[str, Any] async_add_port_mapping (self, str con_type, Any port_mapping)
 
ConnectionInfo async_get_connection_info (self)
 
dict[str, Any] async_get_num_port_mapping (self, str con_type)
 
dict[str, Any] async_get_port_mapping (self, str con_type, int index)
 
dict[str, Any] async_get_upnp_configuration (self)
 
dict[str, Any] async_get_wan_link_properties (self)
 
dict[str, Any] async_get_wlan_configuration (self, int index)
 
bool async_ipv6_active (self)
 
dict[str, Any] async_set_allow_wan_access (self, str ip_address, bool turn_on)
 
dict[str, Any] async_set_deflection_enable (self, int index, bool turn_on)
 
dict[str, Any] async_set_wlan_configuration (self, int index, bool turn_on)
 
dict[str, Any] async_wake_on_lan (self, str mac_address)
 
- Public Member Functions inherited from homeassistant.components.fritz.coordinator.FritzBoxTools
None __init__ (self, HomeAssistant hass, str password, int port, str username=DEFAULT_USERNAME, str host=DEFAULT_HOST, bool use_tls=DEFAULT_SSL)
 
Callable[[], None] async_register_entity_updates (self, str key, Callable[[FritzStatus, StateType], Any] update_fn)
 
None async_scan_devices (self, datetime|None now=None)
 
None async_send_signal_device_update (self, bool new_device)
 
None async_setup (self, MappingProxyType[str, Any]|None options=None)
 
None async_trigger_cleanup (self)
 
bool async_trigger_firmware_update (self)
 
None async_trigger_reboot (self)
 
None async_trigger_reconnect (self)
 
None async_trigger_set_guest_password (self, str|None password, int length)
 
dict[int, dict[str, Any]] async_update_call_deflections (self)
 
str current_firmware (self)
 
dict[str, FritzDevicedevices (self)
 
str|None latest_firmware (self)
 
str mac (self)
 
bool manage_device_info (self, Device dev_info, str dev_mac, bool consider_home)
 
str model (self)
 
None service_fritzbox (self, ServiceCall service_call, ConfigEntry config_entry)
 
None setup (self)
 
str signal_device_new (self)
 
str signal_device_update (self)
 
str unique_id (self)
 
bool update_available (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- Public Member Functions inherited from homeassistant.components.update.UpdateEntity
None async_clear_skipped (self)
 
None async_install_with_progress (self, str|None version, bool backup)
 
None async_internal_added_to_hass (self)
 
str|None async_release_notes (self)
 
None async_skip (self)
 
bool auto_update (self)
 
UpdateDeviceClass|None device_class (self)
 
int display_precision (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool|int|None in_progress (self)
 
None install (self, str|None version, bool backup, **Any kwargs)
 
str|None release_notes (self)
 
str|None release_summary (self)
 
str|None state (self)
 
dict[str, Any]|None state_attributes (self)
 
UpdateEntityFeature supported_features (self)
 
UpdateEntityFeature supported_features_compat (self)
 
str|None title (self)
 
int|float|None update_percentage (self)
 
bool version_is_newer (self, str latest_version, str installed_version)
 
- Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (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_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
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)
 
DeviceInfo|None device_info (self)
 
bool enabled (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)
 
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)
 

Static Private Attributes

 _attr_entity_category = EntityCategory.CONFIG
 
 _attr_supported_features = UpdateEntityFeature.INSTALL
 
string _attr_title = "FRITZ!OS"
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.fritz.entity.FritzBoxBaseCoordinatorEntity
 entity_description
 
- Public Attributes inherited from homeassistant.components.fritz.coordinator.FritzBoxTools
 connection
 
 device_conn_type
 
 device_is_router
 
 fritz_guest_wifi
 
 fritz_hosts
 
 fritz_status
 
 has_call_deflections
 
 hass
 
 host
 
 mesh_role
 
 password
 
 port
 
 use_tls
 
 username
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- Public Attributes inherited from homeassistant.components.update.UpdateEntity
 installed_version
 
- 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.update.UpdateEntity
 bool
 
 int
 
 None
 
 UpdateEntityFeature
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Mixin for update entity specific attributes.

Definition at line 43 of file update.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.fritz.update.FritzBoxUpdateEntity.__init__ (   self,
AvmWrapper  avm_wrapper,
str  device_friendly_name 
)
Init FRITZ!Box connectivity class.

Definition at line 51 of file update.py.

Member Function Documentation

◆ async_install()

None homeassistant.components.fritz.update.FritzBoxUpdateEntity.async_install (   self,
str | None  version,
bool  backup,
**Any   kwargs 
)
Install an update.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 79 of file update.py.

◆ installed_version()

str | None homeassistant.components.fritz.update.FritzBoxUpdateEntity.installed_version (   self)
Version currently in use.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 63 of file update.py.

◆ latest_version()

str | None homeassistant.components.fritz.update.FritzBoxUpdateEntity.latest_version (   self)
Latest version available for install.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 68 of file update.py.

◆ release_url()

str | None homeassistant.components.fritz.update.FritzBoxUpdateEntity.release_url (   self)
URL to the full release notes of the latest version available.

Reimplemented from homeassistant.components.update.UpdateEntity.

Definition at line 75 of file update.py.

Member Data Documentation

◆ _attr_entity_category

homeassistant.components.fritz.update.FritzBoxUpdateEntity._attr_entity_category = EntityCategory.CONFIG
staticprivate

Definition at line 46 of file update.py.

◆ _attr_supported_features

homeassistant.components.fritz.update.FritzBoxUpdateEntity._attr_supported_features = UpdateEntityFeature.INSTALL
staticprivate

Definition at line 47 of file update.py.

◆ _attr_title

string homeassistant.components.fritz.update.FritzBoxUpdateEntity._attr_title = "FRITZ!OS"
staticprivate

Definition at line 48 of file update.py.


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