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

Namespaces

 const
 
 exposed_entities
 
 logbook
 
 repairs
 
 scene
 
 system_health
 
 trigger
 
 triggers
 

Functions

None _async_stop (HomeAssistant hass, bool restart)
 
None async_set_stop_handler (HomeAssistant hass, Callable[[HomeAssistant, bool], Coroutine[Any, Any, None]] stop_handler)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string ATTR_ENTRY_ID = "entry_id"
 
string ATTR_SAFE_MODE = "safe_mode"
 
 SCHEMA_RELOAD_CONFIG_ENTRY
 
 SCHEMA_RESTART = vol.Schema({vol.Optional(ATTR_SAFE_MODE, default=False): bool})
 
 SCHEMA_UPDATE_ENTITY = vol.Schema({ATTR_ENTITY_ID: cv.entity_ids})
 
string SERVICE_CHECK_CONFIG = "check_config"
 
string SERVICE_RELOAD_ALL = "reload_all"
 
string SERVICE_RELOAD_CONFIG_ENTRY = "reload_config_entry"
 
string SERVICE_RELOAD_CORE_CONFIG = "reload_core_config"
 
string SERVICE_RELOAD_CUSTOM_TEMPLATES = "reload_custom_templates"
 
string SERVICE_SET_LOCATION = "set_location"
 
string SERVICE_UPDATE_ENTITY = "update_entity"
 
tuple SHUTDOWN_SERVICES = (SERVICE_HOMEASSISTANT_STOP, SERVICE_HOMEASSISTANT_RESTART)
 

Detailed Description

Integration providing core pieces of infrastructure.

Function Documentation

◆ _async_stop()

None homeassistant.components.homeassistant._async_stop ( HomeAssistant  hass,
bool  restart 
)
private
Stop home assistant.

Definition at line 392 of file __init__.py.

◆ async_set_stop_handler()

None homeassistant.components.homeassistant.async_set_stop_handler ( HomeAssistant  hass,
Callable[[HomeAssistant, bool], Coroutine[Any, Any, None]]  stop_handler 
)
Set function which is called by the stop and restart services.

Definition at line 400 of file __init__.py.

◆ async_setup()

bool homeassistant.components.homeassistant.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up general services related to Home Assistant.

Definition at line 85 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 62 of file __init__.py.

◆ ATTR_ENTRY_ID

string homeassistant.components.homeassistant.ATTR_ENTRY_ID = "entry_id"

Definition at line 59 of file __init__.py.

◆ ATTR_SAFE_MODE

string homeassistant.components.homeassistant.ATTR_SAFE_MODE = "safe_mode"

Definition at line 60 of file __init__.py.

◆ SCHEMA_RELOAD_CONFIG_ENTRY

homeassistant.components.homeassistant.SCHEMA_RELOAD_CONFIG_ENTRY
Initial value:
1 = vol.All(
2  vol.Schema(
3  {
4  vol.Optional(ATTR_ENTRY_ID): str,
5  **cv.ENTITY_SERVICE_FIELDS,
6  },
7  ),
8  cv.has_at_least_one_key(ATTR_ENTRY_ID, *cv.ENTITY_SERVICE_FIELDS),
9 )

Definition at line 71 of file __init__.py.

◆ SCHEMA_RESTART

homeassistant.components.homeassistant.SCHEMA_RESTART = vol.Schema({vol.Optional(ATTR_SAFE_MODE, default=False): bool})

Definition at line 80 of file __init__.py.

◆ SCHEMA_UPDATE_ENTITY

homeassistant.components.homeassistant.SCHEMA_UPDATE_ENTITY = vol.Schema({ATTR_ENTITY_ID: cv.entity_ids})

Definition at line 70 of file __init__.py.

◆ SERVICE_CHECK_CONFIG

string homeassistant.components.homeassistant.SERVICE_CHECK_CONFIG = "check_config"

Definition at line 66 of file __init__.py.

◆ SERVICE_RELOAD_ALL

string homeassistant.components.homeassistant.SERVICE_RELOAD_ALL = "reload_all"

Definition at line 69 of file __init__.py.

◆ SERVICE_RELOAD_CONFIG_ENTRY

string homeassistant.components.homeassistant.SERVICE_RELOAD_CONFIG_ENTRY = "reload_config_entry"

Definition at line 64 of file __init__.py.

◆ SERVICE_RELOAD_CORE_CONFIG

string homeassistant.components.homeassistant.SERVICE_RELOAD_CORE_CONFIG = "reload_core_config"

Definition at line 63 of file __init__.py.

◆ SERVICE_RELOAD_CUSTOM_TEMPLATES

string homeassistant.components.homeassistant.SERVICE_RELOAD_CUSTOM_TEMPLATES = "reload_custom_templates"

Definition at line 65 of file __init__.py.

◆ SERVICE_SET_LOCATION

string homeassistant.components.homeassistant.SERVICE_SET_LOCATION = "set_location"

Definition at line 68 of file __init__.py.

◆ SERVICE_UPDATE_ENTITY

string homeassistant.components.homeassistant.SERVICE_UPDATE_ENTITY = "update_entity"

Definition at line 67 of file __init__.py.

◆ SHUTDOWN_SERVICES

tuple homeassistant.components.homeassistant.SHUTDOWN_SERVICES = (SERVICE_HOMEASSISTANT_STOP, SERVICE_HOMEASSISTANT_RESTART)

Definition at line 82 of file __init__.py.