Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.hassio.const Namespace Reference

Variables

string ADDONS_COORDINATOR = "hassio_addons_coordinator"
 
string ATTR_ADDON = "addon"
 
string ATTR_ADDONS = "addons"
 
string ATTR_ADMIN = "admin"
 
string ATTR_AUTO_UPDATE = "auto_update"
 
string ATTR_CHANGELOG = "changelog"
 
string ATTR_COMPRESSED = "compressed"
 
string ATTR_CONFIG = "config"
 
string ATTR_CPU_PERCENT = "cpu_percent"
 
string ATTR_DATA = "data"
 
string ATTR_DISCOVERY = "discovery"
 
string ATTR_ENABLE = "enable"
 
string ATTR_ENDPOINT = "endpoint"
 
string ATTR_FOLDERS = "folders"
 
string ATTR_HEALTHY = "healthy"
 
string ATTR_HOMEASSISTANT = "homeassistant"
 
string ATTR_HOMEASSISTANT_EXCLUDE_DATABASE = "homeassistant_exclude_database"
 
string ATTR_INPUT = "input"
 
string ATTR_ISSUES = "issues"
 
string ATTR_LOCATION = "location"
 
string ATTR_MEMORY_PERCENT = "memory_percent"
 
string ATTR_MESSAGE = "message"
 
string ATTR_METHOD = "method"
 
string ATTR_PANELS = "panels"
 
string ATTR_PASSWORD = "password"
 
string ATTR_REPOSITORY = "repository"
 
string ATTR_RESULT = "result"
 
string ATTR_SESSION_DATA_USER_ID = "user_id"
 
string ATTR_SLUG = "slug"
 
string ATTR_STARTED = "started"
 
string ATTR_STATE = "state"
 
string ATTR_SUGGESTIONS = "suggestions"
 
string ATTR_SUPPORTED = "supported"
 
string ATTR_TIMEOUT = "timeout"
 
string ATTR_TITLE = "title"
 
string ATTR_UNHEALTHY = "unhealthy"
 
string ATTR_UNHEALTHY_REASONS = "unhealthy_reasons"
 
string ATTR_UNSUPPORTED = "unsupported"
 
string ATTR_UNSUPPORTED_REASONS = "unsupported_reasons"
 
string ATTR_UPDATE_KEY = "update_key"
 
string ATTR_URL = "url"
 
string ATTR_USERNAME = "username"
 
string ATTR_UUID = "uuid"
 
string ATTR_VERSION = "version"
 
string ATTR_VERSION_LATEST = "version_latest"
 
string ATTR_WS_EVENT = "event"
 
string CONTAINER_CHANGELOG = "changelog"
 
string CONTAINER_INFO = "info"
 
string CONTAINER_STATS = "stats"
 
string CORE_CONTAINER = "homeassistant"
 
string DATA_ADDONS_CHANGELOGS = "hassio_addons_changelogs"
 
string DATA_ADDONS_INFO = "hassio_addons_info"
 
string DATA_ADDONS_STATS = "hassio_addons_stats"
 
string DATA_CORE_INFO = "hassio_core_info"
 
string DATA_CORE_STATS = "hassio_core_stats"
 
string DATA_HOST_INFO = "hassio_host_info"
 
string DATA_INFO = "hassio_info"
 
string DATA_KEY_ADDONS = "addons"
 
string DATA_KEY_CORE = "core"
 
string DATA_KEY_HOST = "host"
 
string DATA_KEY_OS = "os"
 
string DATA_KEY_SUPERVISOR = "supervisor"
 
string DATA_KEY_SUPERVISOR_ISSUES = "supervisor_issues"
 
string DATA_NETWORK_INFO = "hassio_network_info"
 
string DATA_OS_INFO = "hassio_os_info"
 
string DATA_STORE = "hassio_store"
 
string DATA_SUPERVISOR_INFO = "hassio_supervisor_info"
 
string DATA_SUPERVISOR_STATS = "hassio_supervisor_stats"
 
string DOMAIN = "hassio"
 
string EVENT_HEALTH_CHANGED = "health_changed"
 
string EVENT_ISSUE_CHANGED = "issue_changed"
 
string EVENT_ISSUE_REMOVED = "issue_removed"
 
string EVENT_SUPERVISOR_EVENT = "supervisor_event"
 
string EVENT_SUPERVISOR_UPDATE = "supervisor_update"
 
string EVENT_SUPPORTED_CHANGED = "supported_changed"
 
 HASSIO_UPDATE_INTERVAL = timedelta(minutes=5)
 
string ISSUE_KEY_ADDON_BOOT_FAIL = "issue_addon_boot_fail"
 
string ISSUE_KEY_ADDON_DETACHED_ADDON_MISSING = "issue_addon_detached_addon_missing"
 
string ISSUE_KEY_ADDON_DETACHED_ADDON_REMOVED = "issue_addon_detached_addon_removed"
 
string ISSUE_KEY_SYSTEM_DOCKER_CONFIG = "issue_system_docker_config"
 
string PLACEHOLDER_KEY_ADDON = "addon"
 
string PLACEHOLDER_KEY_ADDON_URL = "addon_url"
 
string PLACEHOLDER_KEY_COMPONENTS = "components"
 
string PLACEHOLDER_KEY_REFERENCE = "reference"
 
int REQUEST_REFRESH_DELAY = 10
 
string SUPERVISOR_CONTAINER = "hassio_supervisor"
 
string UPDATE_KEY_SUPERVISOR = "supervisor"
 
string WS_ID = "id"
 
string WS_TYPE = "type"
 
string WS_TYPE_API = "supervisor/api"
 
string WS_TYPE_EVENT = "supervisor/event"
 
string WS_TYPE_SUBSCRIBE = "supervisor/subscribe"
 
string X_AUTH_TOKEN = "X-Supervisor-Token"
 
string X_HASS_IS_ADMIN = "X-Hass-Is-Admin"
 
string X_HASS_SOURCE = "X-Hass-Source"
 
string X_HASS_USER_ID = "X-Hass-User-ID"
 
string X_INGRESS_PATH = "X-Ingress-Path"
 

Detailed Description

Hass.io const variables.

Variable Documentation

◆ ADDONS_COORDINATOR

string homeassistant.components.hassio.const.ADDONS_COORDINATOR = "hassio_addons_coordinator"

Definition at line 64 of file const.py.

◆ ATTR_ADDON

string homeassistant.components.hassio.const.ATTR_ADDON = "addon"

Definition at line 8 of file const.py.

◆ ATTR_ADDONS

string homeassistant.components.hassio.const.ATTR_ADDONS = "addons"

Definition at line 9 of file const.py.

◆ ATTR_ADMIN

string homeassistant.components.hassio.const.ATTR_ADMIN = "admin"

Definition at line 10 of file const.py.

◆ ATTR_AUTO_UPDATE

string homeassistant.components.hassio.const.ATTR_AUTO_UPDATE = "auto_update"

Definition at line 81 of file const.py.

◆ ATTR_CHANGELOG

string homeassistant.components.hassio.const.ATTR_CHANGELOG = "changelog"

Definition at line 85 of file const.py.

◆ ATTR_COMPRESSED

string homeassistant.components.hassio.const.ATTR_COMPRESSED = "compressed"

Definition at line 11 of file const.py.

◆ ATTR_CONFIG

string homeassistant.components.hassio.const.ATTR_CONFIG = "config"

Definition at line 12 of file const.py.

◆ ATTR_CPU_PERCENT

string homeassistant.components.hassio.const.ATTR_CPU_PERCENT = "cpu_percent"

Definition at line 84 of file const.py.

◆ ATTR_DATA

string homeassistant.components.hassio.const.ATTR_DATA = "data"

Definition at line 13 of file const.py.

◆ ATTR_DISCOVERY

string homeassistant.components.hassio.const.ATTR_DISCOVERY = "discovery"

Definition at line 15 of file const.py.

◆ ATTR_ENABLE

string homeassistant.components.hassio.const.ATTR_ENABLE = "enable"

Definition at line 16 of file const.py.

◆ ATTR_ENDPOINT

string homeassistant.components.hassio.const.ATTR_ENDPOINT = "endpoint"

Definition at line 17 of file const.py.

◆ ATTR_FOLDERS

string homeassistant.components.hassio.const.ATTR_FOLDERS = "folders"

Definition at line 18 of file const.py.

◆ ATTR_HEALTHY

string homeassistant.components.hassio.const.ATTR_HEALTHY = "healthy"

Definition at line 19 of file const.py.

◆ ATTR_HOMEASSISTANT

string homeassistant.components.hassio.const.ATTR_HOMEASSISTANT = "homeassistant"

Definition at line 20 of file const.py.

◆ ATTR_HOMEASSISTANT_EXCLUDE_DATABASE

string homeassistant.components.hassio.const.ATTR_HOMEASSISTANT_EXCLUDE_DATABASE = "homeassistant_exclude_database"

Definition at line 21 of file const.py.

◆ ATTR_INPUT

string homeassistant.components.hassio.const.ATTR_INPUT = "input"

Definition at line 22 of file const.py.

◆ ATTR_ISSUES

string homeassistant.components.hassio.const.ATTR_ISSUES = "issues"

Definition at line 23 of file const.py.

◆ ATTR_LOCATION

string homeassistant.components.hassio.const.ATTR_LOCATION = "location"

Definition at line 86 of file const.py.

◆ ATTR_MEMORY_PERCENT

string homeassistant.components.hassio.const.ATTR_MEMORY_PERCENT = "memory_percent"

Definition at line 87 of file const.py.

◆ ATTR_MESSAGE

string homeassistant.components.hassio.const.ATTR_MESSAGE = "message"

Definition at line 24 of file const.py.

◆ ATTR_METHOD

string homeassistant.components.hassio.const.ATTR_METHOD = "method"

Definition at line 25 of file const.py.

◆ ATTR_PANELS

string homeassistant.components.hassio.const.ATTR_PANELS = "panels"

Definition at line 26 of file const.py.

◆ ATTR_PASSWORD

string homeassistant.components.hassio.const.ATTR_PASSWORD = "password"

Definition at line 27 of file const.py.

◆ ATTR_REPOSITORY

string homeassistant.components.hassio.const.ATTR_REPOSITORY = "repository"

Definition at line 92 of file const.py.

◆ ATTR_RESULT

string homeassistant.components.hassio.const.ATTR_RESULT = "result"

Definition at line 28 of file const.py.

◆ ATTR_SESSION_DATA_USER_ID

string homeassistant.components.hassio.const.ATTR_SESSION_DATA_USER_ID = "user_id"

Definition at line 14 of file const.py.

◆ ATTR_SLUG

string homeassistant.components.hassio.const.ATTR_SLUG = "slug"

Definition at line 88 of file const.py.

◆ ATTR_STARTED

string homeassistant.components.hassio.const.ATTR_STARTED = "started"

Definition at line 90 of file const.py.

◆ ATTR_STATE

string homeassistant.components.hassio.const.ATTR_STATE = "state"

Definition at line 89 of file const.py.

◆ ATTR_SUGGESTIONS

string homeassistant.components.hassio.const.ATTR_SUGGESTIONS = "suggestions"

Definition at line 29 of file const.py.

◆ ATTR_SUPPORTED

string homeassistant.components.hassio.const.ATTR_SUPPORTED = "supported"

Definition at line 30 of file const.py.

◆ ATTR_TIMEOUT

string homeassistant.components.hassio.const.ATTR_TIMEOUT = "timeout"

Definition at line 31 of file const.py.

◆ ATTR_TITLE

string homeassistant.components.hassio.const.ATTR_TITLE = "title"

Definition at line 32 of file const.py.

◆ ATTR_UNHEALTHY

string homeassistant.components.hassio.const.ATTR_UNHEALTHY = "unhealthy"

Definition at line 33 of file const.py.

◆ ATTR_UNHEALTHY_REASONS

string homeassistant.components.hassio.const.ATTR_UNHEALTHY_REASONS = "unhealthy_reasons"

Definition at line 34 of file const.py.

◆ ATTR_UNSUPPORTED

string homeassistant.components.hassio.const.ATTR_UNSUPPORTED = "unsupported"

Definition at line 35 of file const.py.

◆ ATTR_UNSUPPORTED_REASONS

string homeassistant.components.hassio.const.ATTR_UNSUPPORTED_REASONS = "unsupported_reasons"

Definition at line 36 of file const.py.

◆ ATTR_UPDATE_KEY

string homeassistant.components.hassio.const.ATTR_UPDATE_KEY = "update_key"

Definition at line 37 of file const.py.

◆ ATTR_URL

string homeassistant.components.hassio.const.ATTR_URL = "url"

Definition at line 91 of file const.py.

◆ ATTR_USERNAME

string homeassistant.components.hassio.const.ATTR_USERNAME = "username"

Definition at line 38 of file const.py.

◆ ATTR_UUID

string homeassistant.components.hassio.const.ATTR_UUID = "uuid"

Definition at line 39 of file const.py.

◆ ATTR_VERSION

string homeassistant.components.hassio.const.ATTR_VERSION = "version"

Definition at line 82 of file const.py.

◆ ATTR_VERSION_LATEST

string homeassistant.components.hassio.const.ATTR_VERSION_LATEST = "version_latest"

Definition at line 83 of file const.py.

◆ ATTR_WS_EVENT

string homeassistant.components.hassio.const.ATTR_WS_EVENT = "event"

Definition at line 40 of file const.py.

◆ CONTAINER_CHANGELOG

string homeassistant.components.hassio.const.CONTAINER_CHANGELOG = "changelog"

Definition at line 115 of file const.py.

◆ CONTAINER_INFO

string homeassistant.components.hassio.const.CONTAINER_INFO = "info"

Definition at line 116 of file const.py.

◆ CONTAINER_STATS

string homeassistant.components.hassio.const.CONTAINER_STATS = "stats"

Definition at line 114 of file const.py.

◆ CORE_CONTAINER

string homeassistant.components.hassio.const.CORE_CONTAINER = "homeassistant"

Definition at line 111 of file const.py.

◆ DATA_ADDONS_CHANGELOGS

string homeassistant.components.hassio.const.DATA_ADDONS_CHANGELOGS = "hassio_addons_changelogs"

Definition at line 76 of file const.py.

◆ DATA_ADDONS_INFO

string homeassistant.components.hassio.const.DATA_ADDONS_INFO = "hassio_addons_info"

Definition at line 77 of file const.py.

◆ DATA_ADDONS_STATS

string homeassistant.components.hassio.const.DATA_ADDONS_STATS = "hassio_addons_stats"

Definition at line 78 of file const.py.

◆ DATA_CORE_INFO

string homeassistant.components.hassio.const.DATA_CORE_INFO = "hassio_core_info"

Definition at line 67 of file const.py.

◆ DATA_CORE_STATS

string homeassistant.components.hassio.const.DATA_CORE_STATS = "hassio_core_stats"

Definition at line 68 of file const.py.

◆ DATA_HOST_INFO

string homeassistant.components.hassio.const.DATA_HOST_INFO = "hassio_host_info"

Definition at line 69 of file const.py.

◆ DATA_INFO

string homeassistant.components.hassio.const.DATA_INFO = "hassio_info"

Definition at line 71 of file const.py.

◆ DATA_KEY_ADDONS

string homeassistant.components.hassio.const.DATA_KEY_ADDONS = "addons"

Definition at line 94 of file const.py.

◆ DATA_KEY_CORE

string homeassistant.components.hassio.const.DATA_KEY_CORE = "core"

Definition at line 97 of file const.py.

◆ DATA_KEY_HOST

string homeassistant.components.hassio.const.DATA_KEY_HOST = "host"

Definition at line 98 of file const.py.

◆ DATA_KEY_OS

string homeassistant.components.hassio.const.DATA_KEY_OS = "os"

Definition at line 95 of file const.py.

◆ DATA_KEY_SUPERVISOR

string homeassistant.components.hassio.const.DATA_KEY_SUPERVISOR = "supervisor"

Definition at line 96 of file const.py.

◆ DATA_KEY_SUPERVISOR_ISSUES

string homeassistant.components.hassio.const.DATA_KEY_SUPERVISOR_ISSUES = "supervisor_issues"

Definition at line 99 of file const.py.

◆ DATA_NETWORK_INFO

string homeassistant.components.hassio.const.DATA_NETWORK_INFO = "hassio_network_info"

Definition at line 73 of file const.py.

◆ DATA_OS_INFO

string homeassistant.components.hassio.const.DATA_OS_INFO = "hassio_os_info"

Definition at line 72 of file const.py.

◆ DATA_STORE

string homeassistant.components.hassio.const.DATA_STORE = "hassio_store"

Definition at line 70 of file const.py.

◆ DATA_SUPERVISOR_INFO

string homeassistant.components.hassio.const.DATA_SUPERVISOR_INFO = "hassio_supervisor_info"

Definition at line 74 of file const.py.

◆ DATA_SUPERVISOR_STATS

string homeassistant.components.hassio.const.DATA_SUPERVISOR_STATS = "hassio_supervisor_stats"

Definition at line 75 of file const.py.

◆ DOMAIN

string homeassistant.components.hassio.const.DOMAIN = "hassio"

Definition at line 6 of file const.py.

◆ EVENT_HEALTH_CHANGED

string homeassistant.components.hassio.const.EVENT_HEALTH_CHANGED = "health_changed"

Definition at line 57 of file const.py.

◆ EVENT_ISSUE_CHANGED

string homeassistant.components.hassio.const.EVENT_ISSUE_CHANGED = "issue_changed"

Definition at line 59 of file const.py.

◆ EVENT_ISSUE_REMOVED

string homeassistant.components.hassio.const.EVENT_ISSUE_REMOVED = "issue_removed"

Definition at line 60 of file const.py.

◆ EVENT_SUPERVISOR_EVENT

string homeassistant.components.hassio.const.EVENT_SUPERVISOR_EVENT = "supervisor_event"

Definition at line 55 of file const.py.

◆ EVENT_SUPERVISOR_UPDATE

string homeassistant.components.hassio.const.EVENT_SUPERVISOR_UPDATE = "supervisor_update"

Definition at line 56 of file const.py.

◆ EVENT_SUPPORTED_CHANGED

string homeassistant.components.hassio.const.EVENT_SUPPORTED_CHANGED = "supported_changed"

Definition at line 58 of file const.py.

◆ HASSIO_UPDATE_INTERVAL

homeassistant.components.hassio.const.HASSIO_UPDATE_INTERVAL = timedelta(minutes=5)

Definition at line 79 of file const.py.

◆ ISSUE_KEY_ADDON_BOOT_FAIL

string homeassistant.components.hassio.const.ISSUE_KEY_ADDON_BOOT_FAIL = "issue_addon_boot_fail"

Definition at line 106 of file const.py.

◆ ISSUE_KEY_ADDON_DETACHED_ADDON_MISSING

string homeassistant.components.hassio.const.ISSUE_KEY_ADDON_DETACHED_ADDON_MISSING = "issue_addon_detached_addon_missing"

Definition at line 108 of file const.py.

◆ ISSUE_KEY_ADDON_DETACHED_ADDON_REMOVED

string homeassistant.components.hassio.const.ISSUE_KEY_ADDON_DETACHED_ADDON_REMOVED = "issue_addon_detached_addon_removed"

Definition at line 109 of file const.py.

◆ ISSUE_KEY_SYSTEM_DOCKER_CONFIG

string homeassistant.components.hassio.const.ISSUE_KEY_SYSTEM_DOCKER_CONFIG = "issue_system_docker_config"

Definition at line 107 of file const.py.

◆ PLACEHOLDER_KEY_ADDON

string homeassistant.components.hassio.const.PLACEHOLDER_KEY_ADDON = "addon"

Definition at line 101 of file const.py.

◆ PLACEHOLDER_KEY_ADDON_URL

string homeassistant.components.hassio.const.PLACEHOLDER_KEY_ADDON_URL = "addon_url"

Definition at line 102 of file const.py.

◆ PLACEHOLDER_KEY_COMPONENTS

string homeassistant.components.hassio.const.PLACEHOLDER_KEY_COMPONENTS = "components"

Definition at line 104 of file const.py.

◆ PLACEHOLDER_KEY_REFERENCE

string homeassistant.components.hassio.const.PLACEHOLDER_KEY_REFERENCE = "reference"

Definition at line 103 of file const.py.

◆ REQUEST_REFRESH_DELAY

int homeassistant.components.hassio.const.REQUEST_REFRESH_DELAY = 10

Definition at line 129 of file const.py.

◆ SUPERVISOR_CONTAINER

string homeassistant.components.hassio.const.SUPERVISOR_CONTAINER = "hassio_supervisor"

Definition at line 112 of file const.py.

◆ UPDATE_KEY_SUPERVISOR

string homeassistant.components.hassio.const.UPDATE_KEY_SUPERVISOR = "supervisor"

Definition at line 62 of file const.py.

◆ WS_ID

string homeassistant.components.hassio.const.WS_ID = "id"

Definition at line 49 of file const.py.

◆ WS_TYPE

string homeassistant.components.hassio.const.WS_TYPE = "type"

Definition at line 48 of file const.py.

◆ WS_TYPE_API

string homeassistant.components.hassio.const.WS_TYPE_API = "supervisor/api"

Definition at line 51 of file const.py.

◆ WS_TYPE_EVENT

string homeassistant.components.hassio.const.WS_TYPE_EVENT = "supervisor/event"

Definition at line 52 of file const.py.

◆ WS_TYPE_SUBSCRIBE

string homeassistant.components.hassio.const.WS_TYPE_SUBSCRIBE = "supervisor/subscribe"

Definition at line 53 of file const.py.

◆ X_AUTH_TOKEN

string homeassistant.components.hassio.const.X_AUTH_TOKEN = "X-Supervisor-Token"

Definition at line 42 of file const.py.

◆ X_HASS_IS_ADMIN

string homeassistant.components.hassio.const.X_HASS_IS_ADMIN = "X-Hass-Is-Admin"

Definition at line 45 of file const.py.

◆ X_HASS_SOURCE

string homeassistant.components.hassio.const.X_HASS_SOURCE = "X-Hass-Source"

Definition at line 46 of file const.py.

◆ X_HASS_USER_ID

string homeassistant.components.hassio.const.X_HASS_USER_ID = "X-Hass-User-ID"

Definition at line 44 of file const.py.

◆ X_INGRESS_PATH

string homeassistant.components.hassio.const.X_INGRESS_PATH = "X-Ingress-Path"

Definition at line 43 of file const.py.