Home Assistant Unofficial Reference 2024.12.1
Classes | Functions | Variables
homeassistant.components.hassio.coordinator Namespace Reference

Classes

class  HassioDataUpdateCoordinator
 

Functions

None async_register_addons_in_dev_reg (str entry_id, dr.DeviceRegistry dev_reg, list[dict[str, Any]] addons)
 
None async_register_core_in_dev_reg (str entry_id, dr.DeviceRegistry dev_reg, dict[str, Any] core_dict)
 
None async_register_host_in_dev_reg (str entry_id, dr.DeviceRegistry dev_reg)
 
None async_register_os_in_dev_reg (str entry_id, dr.DeviceRegistry dev_reg, dict[str, Any] os_dict)
 
None async_register_supervisor_in_dev_reg (str entry_id, dr.DeviceRegistry dev_reg, dict[str, Any] supervisor_dict)
 
None async_remove_addons_from_dev_reg (dr.DeviceRegistry dev_reg, set[str] addons)
 
def get_addons_changelogs (HomeAssistant hass)
 
dict[str, dict[str, Any]]|None get_addons_info (HomeAssistant hass)
 
dict[str, Any] get_addons_stats (HomeAssistant hass)
 
dict[str, Any]|None get_core_info (HomeAssistant hass)
 
dict[str, Any] get_core_stats (HomeAssistant hass)
 
dict[str, Any]|None get_host_info (HomeAssistant hass)
 
dict[str, Any]|None get_info (HomeAssistant hass)
 
SupervisorIssues|None get_issues_info (HomeAssistant hass)
 
dict[str, Any]|None get_network_info (HomeAssistant hass)
 
dict[str, Any]|None get_os_info (HomeAssistant hass)
 
dict[str, Any]|None get_store (HomeAssistant hass)
 
dict[str, Any]|None get_supervisor_info (HomeAssistant hass)
 
dict[str, Any] get_supervisor_stats (HomeAssistant hass)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 

Detailed Description

Data for Hass.io.

Function Documentation

◆ async_register_addons_in_dev_reg()

None homeassistant.components.hassio.coordinator.async_register_addons_in_dev_reg ( str  entry_id,
dr.DeviceRegistry  dev_reg,
list[dict[str, Any]]   addons 
) 
Register addons in the device registry.

Definition at line 198 of file coordinator.py.

◆ async_register_core_in_dev_reg()

None homeassistant.components.hassio.coordinator.async_register_core_in_dev_reg ( str  entry_id,
dr.DeviceRegistry  dev_reg,
dict[str, Any]  core_dict 
) 
Register OS in the device registry.

Definition at line 249 of file coordinator.py.

◆ async_register_host_in_dev_reg()

None homeassistant.components.hassio.coordinator.async_register_host_in_dev_reg ( str  entry_id,
dr.DeviceRegistry  dev_reg 
) 
Register host in the device registry.

Definition at line 233 of file coordinator.py.

◆ async_register_os_in_dev_reg()

None homeassistant.components.hassio.coordinator.async_register_os_in_dev_reg ( str  entry_id,
dr.DeviceRegistry  dev_reg,
dict[str, Any]   os_dict 
) 
Register OS in the device registry.

Definition at line 217 of file coordinator.py.

◆ async_register_supervisor_in_dev_reg()

None homeassistant.components.hassio.coordinator.async_register_supervisor_in_dev_reg ( str  entry_id,
dr.DeviceRegistry  dev_reg,
dict[str, Any]  supervisor_dict 
) 
Register OS in the device registry.

Definition at line 267 of file coordinator.py.

◆ async_remove_addons_from_dev_reg()

None homeassistant.components.hassio.coordinator.async_remove_addons_from_dev_reg ( dr.DeviceRegistry  dev_reg,
set[str]   addons 
) 
Remove addons from the device registry.

Definition at line 285 of file coordinator.py.

◆ get_addons_changelogs()

def homeassistant.components.hassio.coordinator.get_addons_changelogs ( HomeAssistant  hass) 
Return Addons changelogs.

Async friendly.

Definition at line 159 of file coordinator.py.

◆ get_addons_info()

dict[str, dict[str, Any]] | None homeassistant.components.hassio.coordinator.get_addons_info ( HomeAssistant  hass) 
Return Addons info.

Async friendly.

Definition at line 119 of file coordinator.py.

◆ get_addons_stats()

dict[str, Any] homeassistant.components.hassio.coordinator.get_addons_stats ( HomeAssistant  hass) 
Return Addons stats.

Async friendly.

Definition at line 129 of file coordinator.py.

◆ get_core_info()

dict[str, Any] | None homeassistant.components.hassio.coordinator.get_core_info ( HomeAssistant  hass) 
Return Home Assistant Core information from Supervisor.

Async friendly.

Definition at line 179 of file coordinator.py.

◆ get_core_stats()

dict[str, Any] homeassistant.components.hassio.coordinator.get_core_stats ( HomeAssistant  hass) 
Return core stats.

Async friendly.

Definition at line 139 of file coordinator.py.

◆ get_host_info()

dict[str, Any] | None homeassistant.components.hassio.coordinator.get_host_info ( HomeAssistant  hass) 
Return generic host information.

Async friendly.

Definition at line 79 of file coordinator.py.

◆ get_info()

dict[str, Any] | None homeassistant.components.hassio.coordinator.get_info ( HomeAssistant  hass) 
Return generic information from Supervisor.

Async friendly.

Definition at line 69 of file coordinator.py.

◆ get_issues_info()

SupervisorIssues | None homeassistant.components.hassio.coordinator.get_issues_info ( HomeAssistant  hass) 
Return Supervisor issues info.

Async friendly.

Definition at line 189 of file coordinator.py.

◆ get_network_info()

dict[str, Any] | None homeassistant.components.hassio.coordinator.get_network_info ( HomeAssistant  hass) 
Return Host Network information.

Async friendly.

Definition at line 109 of file coordinator.py.

◆ get_os_info()

dict[str, Any] | None homeassistant.components.hassio.coordinator.get_os_info ( HomeAssistant  hass) 
Return OS information.

Async friendly.

Definition at line 169 of file coordinator.py.

◆ get_store()

dict[str, Any] | None homeassistant.components.hassio.coordinator.get_store ( HomeAssistant  hass) 
Return store information.

Async friendly.

Definition at line 89 of file coordinator.py.

◆ get_supervisor_info()

dict[str, Any] | None homeassistant.components.hassio.coordinator.get_supervisor_info ( HomeAssistant  hass) 
Return Supervisor information.

Async friendly.

Definition at line 99 of file coordinator.py.

◆ get_supervisor_stats()

dict[str, Any] homeassistant.components.hassio.coordinator.get_supervisor_stats ( HomeAssistant  hass) 
Return supervisor stats.

Async friendly.

Definition at line 149 of file coordinator.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.hassio.coordinator._LOGGER = logging.getLogger(__name__)
private

Definition at line 64 of file coordinator.py.