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

Namespaces

 addon_manager
 
 addon_panel
 
 auth
 
 binary_sensor
 
 config_flow
 
 const
 
 coordinator
 
 diagnostics
 
 discovery
 
 entity
 
 handler
 
 http
 
 ingress
 
 issues
 
 repairs
 
 sensor
 
 system_health
 
 update
 
 websocket_api
 

Classes

class  APIEndpointSettings
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
str hostname_from_addon_slug (str addon_slug)
 
bool is_hassio (HomeAssistant hass)
 
str valid_addon (Any value)
 

Variables

 __all__
 
 __dir__
 
 __getattr__
 
 _DEPRECATED_HassioServiceInfo
 
 _LOGGER
 
 ATTR_NAME
 
 breaks_in_ha_version
 
 check_if_deprecated_constant
 
 CONF_FRONTEND_REPO
 
 CONFIG_SCHEMA
 
 default
 
 dir_with_deprecated_constants
 
 extra
 
 get_supervisor_ip
 
 HARDWARE_INTEGRATIONS
 
 MAP_SERVICE_API
 
 module_globals
 
 module_globals_keys
 
 PLATFORMS
 
 SCHEMA_ADDON
 
 SCHEMA_ADDON_STDIN
 
 SCHEMA_BACKUP_FULL
 
 SCHEMA_BACKUP_PARTIAL
 
 SCHEMA_NO_DATA
 
 SCHEMA_RESTORE_FULL
 
 SCHEMA_RESTORE_PARTIAL
 
 SERVICE_ADDON_RESTART
 
 SERVICE_ADDON_START
 
 SERVICE_ADDON_STDIN
 
 SERVICE_ADDON_STOP
 
 SERVICE_ADDON_UPDATE
 
 SERVICE_BACKUP_FULL
 
 SERVICE_BACKUP_PARTIAL
 
 SERVICE_HOST_REBOOT
 
 SERVICE_HOST_SHUTDOWN
 
 SERVICE_RESTORE_FULL
 
 SERVICE_RESTORE_PARTIAL
 
 STORAGE_KEY
 
 STORAGE_VERSION
 
 VALID_ADDON_SLUG
 

Detailed Description

Support for Hass.io.

Function Documentation

◆ async_setup()

bool homeassistant.components.hassio.async_setup ( HomeAssistant  hass,
ConfigType  config 
) 
Set up the Hass.io component.

Definition at line 310 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.hassio.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
) 
Set up a config entry.

Definition at line 552 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.hassio.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
) 
Unload a config entry.

Definition at line 564 of file __init__.py.

◆ hostname_from_addon_slug()

str homeassistant.components.hassio.hostname_from_addon_slug ( str  addon_slug) 
Return hostname of add-on.

Definition at line 292 of file __init__.py.

◆ is_hassio()

bool homeassistant.components.hassio.is_hassio ( HomeAssistant  hass) 
Return true if Hass.io is loaded.

Async friendly.

Definition at line 302 of file __init__.py.

◆ valid_addon()

str homeassistant.components.hassio.valid_addon ( Any  value) 
Validate value is a valid addon slug.

Definition at line 173 of file __init__.py.

Variable Documentation

◆ __all__

homeassistant.components.hassio.__all__
private

Definition at line 579 of file __init__.py.

◆ __dir__

homeassistant.components.hassio.__dir__
private

Definition at line 576 of file __init__.py.

◆ __getattr__

homeassistant.components.hassio.__getattr__
private

Definition at line 575 of file __init__.py.

◆ _DEPRECATED_HassioServiceInfo

homeassistant.components.hassio._DEPRECATED_HassioServiceInfo
private

Definition at line 138 of file __init__.py.

◆ _LOGGER

homeassistant.components.hassio._LOGGER
private

Definition at line 133 of file __init__.py.

◆ ATTR_NAME

homeassistant.components.hassio.ATTR_NAME

Definition at line 194 of file __init__.py.

◆ breaks_in_ha_version

homeassistant.components.hassio.breaks_in_ha_version

Definition at line 136 of file __init__.py.

◆ check_if_deprecated_constant

homeassistant.components.hassio.check_if_deprecated_constant

Definition at line 575 of file __init__.py.

◆ CONF_FRONTEND_REPO

homeassistant.components.hassio.CONF_FRONTEND_REPO

Definition at line 151 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.hassio.CONFIG_SCHEMA

Definition at line 153 of file __init__.py.

◆ default

homeassistant.components.hassio.default

Definition at line 194 of file __init__.py.

◆ dir_with_deprecated_constants

homeassistant.components.hassio.dir_with_deprecated_constants

Definition at line 577 of file __init__.py.

◆ extra

homeassistant.components.hassio.extra

Definition at line 155 of file __init__.py.

◆ get_supervisor_ip

homeassistant.components.hassio.get_supervisor_ip

Definition at line 135 of file __init__.py.

◆ HARDWARE_INTEGRATIONS

homeassistant.components.hassio.HARDWARE_INTEGRATIONS

Definition at line 274 of file __init__.py.

◆ MAP_SERVICE_API

homeassistant.components.hassio.MAP_SERVICE_API

Definition at line 238 of file __init__.py.

◆ module_globals

homeassistant.components.hassio.module_globals

Definition at line 575 of file __init__.py.

◆ module_globals_keys

homeassistant.components.hassio.module_globals_keys

Definition at line 577 of file __init__.py.

◆ PLATFORMS

homeassistant.components.hassio.PLATFORMS

Definition at line 149 of file __init__.py.

◆ SCHEMA_ADDON

homeassistant.components.hassio.SCHEMA_ADDON

Definition at line 185 of file __init__.py.

◆ SCHEMA_ADDON_STDIN

homeassistant.components.hassio.SCHEMA_ADDON_STDIN

Definition at line 187 of file __init__.py.

◆ SCHEMA_BACKUP_FULL

homeassistant.components.hassio.SCHEMA_BACKUP_FULL

Definition at line 191 of file __init__.py.

◆ SCHEMA_BACKUP_PARTIAL

homeassistant.components.hassio.SCHEMA_BACKUP_PARTIAL

Definition at line 205 of file __init__.py.

◆ SCHEMA_NO_DATA

homeassistant.components.hassio.SCHEMA_NO_DATA

Definition at line 183 of file __init__.py.

◆ SCHEMA_RESTORE_FULL

homeassistant.components.hassio.SCHEMA_RESTORE_FULL

Definition at line 213 of file __init__.py.

◆ SCHEMA_RESTORE_PARTIAL

homeassistant.components.hassio.SCHEMA_RESTORE_PARTIAL

Definition at line 220 of file __init__.py.

◆ SERVICE_ADDON_RESTART

homeassistant.components.hassio.SERVICE_ADDON_RESTART

Definition at line 160 of file __init__.py.

◆ SERVICE_ADDON_START

homeassistant.components.hassio.SERVICE_ADDON_START

Definition at line 158 of file __init__.py.

◆ SERVICE_ADDON_STDIN

homeassistant.components.hassio.SERVICE_ADDON_STDIN

Definition at line 162 of file __init__.py.

◆ SERVICE_ADDON_STOP

homeassistant.components.hassio.SERVICE_ADDON_STOP

Definition at line 159 of file __init__.py.

◆ SERVICE_ADDON_UPDATE

homeassistant.components.hassio.SERVICE_ADDON_UPDATE

Definition at line 161 of file __init__.py.

◆ SERVICE_BACKUP_FULL

homeassistant.components.hassio.SERVICE_BACKUP_FULL

Definition at line 165 of file __init__.py.

◆ SERVICE_BACKUP_PARTIAL

homeassistant.components.hassio.SERVICE_BACKUP_PARTIAL

Definition at line 166 of file __init__.py.

◆ SERVICE_HOST_REBOOT

homeassistant.components.hassio.SERVICE_HOST_REBOOT

Definition at line 164 of file __init__.py.

◆ SERVICE_HOST_SHUTDOWN

homeassistant.components.hassio.SERVICE_HOST_SHUTDOWN

Definition at line 163 of file __init__.py.

◆ SERVICE_RESTORE_FULL

homeassistant.components.hassio.SERVICE_RESTORE_FULL

Definition at line 167 of file __init__.py.

◆ SERVICE_RESTORE_PARTIAL

homeassistant.components.hassio.SERVICE_RESTORE_PARTIAL

Definition at line 168 of file __init__.py.

◆ STORAGE_KEY

homeassistant.components.hassio.STORAGE_KEY

Definition at line 144 of file __init__.py.

◆ STORAGE_VERSION

homeassistant.components.hassio.STORAGE_VERSION

Definition at line 145 of file __init__.py.

◆ VALID_ADDON_SLUG

homeassistant.components.hassio.VALID_ADDON_SLUG

Definition at line 170 of file __init__.py.