Home Assistant Unofficial Reference 2024.12.1
__init__.py File Reference

Go to the source code of this file.

Classes

class  homeassistant.components.configurator.Configurator
 

Namespaces

 homeassistant.components.configurator
 

Functions

dict[str, Configurator] homeassistant.components.configurator._get_requests (HomeAssistant hass)
 
None homeassistant.components.configurator.async_notify_errors (HomeAssistant hass, str request_id, str error)
 
str homeassistant.components.configurator.async_request_config (HomeAssistant hass, str name, ConfiguratorCallback|None callback=None, str|None description=None, str|None description_image=None, str|None submit_caption=None, list[dict[str, str]]|None fields=None, str|None link_name=None, str|None link_url=None, str|None entity_picture=None)
 
None homeassistant.components.configurator.async_request_done (HomeAssistant hass, str request_id)
 
bool homeassistant.components.configurator.async_setup (HomeAssistant hass, ConfigType config)
 
None homeassistant.components.configurator.notify_errors (HomeAssistant hass, str request_id, str error)
 
str homeassistant.components.configurator.request_config (HomeAssistant hass, *Any args, **Any kwargs)
 
None homeassistant.components.configurator.request_done (HomeAssistant hass, str request_id)
 

Variables

string homeassistant.components.configurator._KEY_INSTANCE = "configurator"
 
string homeassistant.components.configurator.ATTR_CONFIGURE_ID = "configure_id"
 
string homeassistant.components.configurator.ATTR_DESCRIPTION = "description"
 
string homeassistant.components.configurator.ATTR_DESCRIPTION_IMAGE = "description_image"
 
string homeassistant.components.configurator.ATTR_ERRORS = "errors"
 
string homeassistant.components.configurator.ATTR_FIELDS = "fields"
 
string homeassistant.components.configurator.ATTR_LINK_NAME = "link_name"
 
string homeassistant.components.configurator.ATTR_LINK_URL = "link_url"
 
string homeassistant.components.configurator.ATTR_SUBMIT_CAPTION = "submit_caption"
 
 homeassistant.components.configurator.CONFIG_SCHEMA = cv.empty_config_schema(DOMAIN)
 
 homeassistant.components.configurator.ConfiguratorCallback
 
string homeassistant.components.configurator.DATA_REQUESTS = "configurator_requests"
 
string homeassistant.components.configurator.DOMAIN = "configurator"
 
string homeassistant.components.configurator.ENTITY_ID_FORMAT = DOMAIN + ".{}"
 
string homeassistant.components.configurator.SERVICE_CONFIGURE = "configure"
 
string homeassistant.components.configurator.STATE_CONFIGURE = "configure"
 
string homeassistant.components.configurator.STATE_CONFIGURED = "configured"