Inheritance diagram for homeassistant.components.hassio.addon_manager.AddonManager:

[legend]

Public Member Functions
None	__init__ (self, HomeAssistant hass, logging.Logger logger, str addon_name, str addon_slug)

None	async_configure_addon (self, dict[str, Any] addon_config)

None	async_create_backup (self)

dict	async_get_addon_discovery_info (self)

AddonInfo	async_get_addon_info (self)

AddonState	async_get_addon_state (self, InstalledAddonComplete addon_info)

None	async_install_addon (self)

None	async_restart_addon (self)

asyncio.Task	async_schedule_install_addon (self, bool catch_error=False)

asyncio.Task	async_schedule_install_setup_addon (self, dict[str, Any] addon_config, bool catch_error=False)

asyncio.Task	async_schedule_restart_addon (self, bool catch_error=False)

asyncio.Task	async_schedule_setup_addon (self, dict[str, Any] addon_config, bool catch_error=False)

asyncio.Task	async_schedule_start_addon (self, bool catch_error=False)

asyncio.Task	async_schedule_update_addon (self, bool catch_error=False)

None	async_set_addon_options (self, dict config)

None	async_start_addon (self)

None	async_stop_addon (self)

None	async_uninstall_addon (self)

None	async_update_addon (self)

bool	task_in_progress (self)

Public Attributes
	addon_name

	addon_slug

Private Member Functions
asyncio.Task	_async_schedule_addon_operation (self, *Callable funcs, bool catch_error=False)

None	_check_addon_available (self, AddonInfo addon_info)

Private Attributes
	_hass

	_install_task

	_logger

	_restart_task

	_start_task

	_supervisor_client

	_update_task

Detailed Description

Manage the add-on.

Methods may raise AddonError.
Only one instance of this class may exist per add-on
to keep track of running add-on tasks.

Definition at line 88 of file addon_manager.py.

Constructor & Destructor Documentation

◆ init()

None homeassistant.components.hassio.addon_manager.AddonManager.__init__	(		self,
		HomeAssistant	hass,
		logging.Logger	logger,
		str	addon_name,
		str	addon_slug
	)

Manage the add-on.

Methods may raise AddonError.
Only one instance of this class may exist per add-on
to keep track of running add-on tasks.

Set up the add-on manager.

Definition at line 96 of file addon_manager.py.

Member Function Documentation

◆ _async_schedule_addon_operation()

asyncio.Task homeassistant.components.hassio.addon_manager.AddonManager._async_schedule_addon_operation	(		self,
		*Callable	funcs,
		bool	catch_error = `False`
	)

private

Schedule an add-on task.

Definition at line 377 of file addon_manager.py.

◆ _check_addon_available()

None homeassistant.components.hassio.addon_manager.AddonManager._check_addon_available	(		self,
		AddonInfo	addon_info
	)

private

Check if the managed add-on is available.

Definition at line 192 of file addon_manager.py.

◆ async_configure_addon()

None homeassistant.components.hassio.addon_manager.AddonManager.async_configure_addon	(		self,
		dict[str, Any]	addon_config
	)

Configure the manager add-on, if needed.

Definition at line 257 of file addon_manager.py.

◆ async_create_backup()

None homeassistant.components.hassio.addon_manager.AddonManager.async_create_backup ( self )

Create a partial backup of the managed add-on.

Definition at line 245 of file addon_manager.py.

◆ async_get_addon_discovery_info()

dict homeassistant.components.hassio.addon_manager.AddonManager.async_get_addon_discovery_info ( self )

Return add-on discovery info.

Definition at line 127 of file addon_manager.py.

◆ async_get_addon_info()

AddonInfo homeassistant.components.hassio.addon_manager.AddonManager.async_get_addon_info ( self )

Return and cache manager add-on info.

Definition at line 144 of file addon_manager.py.

◆ async_get_addon_state()

AddonState homeassistant.components.hassio.addon_manager.AddonManager.async_get_addon_state	(		self,
		InstalledAddonComplete	addon_info
	)

Return the current state of the managed add-on.

Definition at line 172 of file addon_manager.py.

◆ async_install_addon()

None homeassistant.components.hassio.addon_manager.AddonManager.async_install_addon ( self )

Install the managed add-on.

Definition at line 198 of file addon_manager.py.

◆ async_restart_addon()

None homeassistant.components.hassio.addon_manager.AddonManager.async_restart_addon ( self )

Restart the managed add-on.

Definition at line 235 of file addon_manager.py.

◆ async_schedule_install_addon()

asyncio.Task homeassistant.components.hassio.addon_manager.AddonManager.async_schedule_install_addon	(		self,
		bool	catch_error = `False`
	)

Schedule a task that installs the managed add-on.

Only schedule a new install task if the there's no running task.

Definition at line 271 of file addon_manager.py.

◆ async_schedule_install_setup_addon()

asyncio.Task homeassistant.components.hassio.addon_manager.AddonManager.async_schedule_install_setup_addon	(		self,
		dict[str, Any]	addon_config,
		bool	catch_error = `False`
	)

Schedule a task that installs and sets up the managed add-on.

Only schedule a new install task if the there's no running task.

Definition at line 286 of file addon_manager.py.

◆ async_schedule_restart_addon()

asyncio.Task homeassistant.components.hassio.addon_manager.AddonManager.async_schedule_restart_addon	(		self,
		bool	catch_error = `False`
	)

Schedule a task that restarts the managed add-on.

Only schedule a new restart task if the there's no running task.

Definition at line 340 of file addon_manager.py.

◆ async_schedule_setup_addon()

asyncio.Task homeassistant.components.hassio.addon_manager.AddonManager.async_schedule_setup_addon	(		self,
		dict[str, Any]	addon_config,
		bool	catch_error = `False`
	)

Schedule a task that configures and starts the managed add-on.

Only schedule a new setup task if there's no running task.

Definition at line 353 of file addon_manager.py.

◆ async_schedule_start_addon()

asyncio.Task homeassistant.components.hassio.addon_manager.AddonManager.async_schedule_start_addon	(		self,
		bool	catch_error = `False`
	)

Schedule a task that starts the managed add-on.

Only schedule a new start task if the there's no running task.

Definition at line 325 of file addon_manager.py.

◆ async_schedule_update_addon()

asyncio.Task homeassistant.components.hassio.addon_manager.AddonManager.async_schedule_update_addon	(		self,
		bool	catch_error = `False`
	)

Schedule a task that updates and sets up the managed add-on.

Only schedule a new update task if the there's no running task.

Definition at line 311 of file addon_manager.py.

◆ async_set_addon_options()

None homeassistant.components.hassio.addon_manager.AddonManager.async_set_addon_options	(		self,
		dict	config
	)

Set manager add-on options.

Definition at line 186 of file addon_manager.py.

◆ async_start_addon()

None homeassistant.components.hassio.addon_manager.AddonManager.async_start_addon ( self )

Start the managed add-on.

Definition at line 230 of file addon_manager.py.

◆ async_stop_addon()

None homeassistant.components.hassio.addon_manager.AddonManager.async_stop_addon ( self )

Stop the managed add-on.

Definition at line 240 of file addon_manager.py.

◆ async_uninstall_addon()

None homeassistant.components.hassio.addon_manager.AddonManager.async_uninstall_addon ( self )

Uninstall the managed add-on.

Definition at line 207 of file addon_manager.py.

◆ async_update_addon()

None homeassistant.components.hassio.addon_manager.AddonManager.async_update_addon ( self )

Update the managed add-on if needed.

Definition at line 212 of file addon_manager.py.

◆ task_in_progress()

bool homeassistant.components.hassio.addon_manager.AddonManager.task_in_progress ( self )

Return True if any of the add-on tasks are in progress.

Definition at line 114 of file addon_manager.py.

Member Data Documentation

◆ _hass

homeassistant.components.hassio.addon_manager.AddonManager._hass

private

Definition at line 106 of file addon_manager.py.

◆ _install_task

homeassistant.components.hassio.addon_manager.AddonManager._install_task

private

Definition at line 280 of file addon_manager.py.

◆ _logger

homeassistant.components.hassio.addon_manager.AddonManager._logger

private

Definition at line 107 of file addon_manager.py.

◆ _restart_task

homeassistant.components.hassio.addon_manager.AddonManager._restart_task

private

Definition at line 347 of file addon_manager.py.

◆ _start_task

homeassistant.components.hassio.addon_manager.AddonManager._start_task

private

Definition at line 334 of file addon_manager.py.

◆ _supervisor_client

homeassistant.components.hassio.addon_manager.AddonManager._supervisor_client

private

Definition at line 112 of file addon_manager.py.

◆ _update_task

homeassistant.components.hassio.addon_manager.AddonManager._update_task

private

Definition at line 318 of file addon_manager.py.

◆ addon_name

homeassistant.components.hassio.addon_manager.AddonManager.addon_name

Definition at line 104 of file addon_manager.py.

◆ addon_slug

homeassistant.components.hassio.addon_manager.AddonManager.addon_slug

Definition at line 105 of file addon_manager.py.

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

core/homeassistant/components/hassio/addon_manager.py

Home Assistant Unofficial Reference 2024.12.1

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _async_schedule_addon_operation()

◆ _check_addon_available()

◆ async_configure_addon()

◆ async_create_backup()

◆ async_get_addon_discovery_info()

◆ async_get_addon_info()

◆ async_get_addon_state()

◆ async_install_addon()

◆ async_restart_addon()

◆ async_schedule_install_addon()

◆ async_schedule_install_setup_addon()

◆ async_schedule_restart_addon()

◆ async_schedule_setup_addon()

◆ async_schedule_start_addon()

◆ async_schedule_update_addon()

◆ async_set_addon_options()

◆ async_start_addon()

◆ async_stop_addon()

◆ async_uninstall_addon()

◆ async_update_addon()

◆ task_in_progress()

Member Data Documentation

◆ _hass

◆ _install_task

◆ _logger

◆ _restart_task

◆ _start_task

◆ _supervisor_client

◆ _update_task

◆ addon_name

◆ addon_slug

◆ init()