homeassistant.components.config.entity_registry Namespace Reference

Functions
bool	async_setup (HomeAssistant hass)
None	websocket_get_entities (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_get_entity (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_list_entities (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_list_entities_for_display (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_remove_entity (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)
None	websocket_update_entity (HomeAssistant hass, websocket_api.ActiveConnection connection, dict[str, Any] msg)

Variables
	_ENTITY_CATEGORIES_JSON = json_dumps(er.ENTITY_CATEGORY_INDEX_TO_VALUE)

Detailed Description

HTTP views to interact with the entity registry.

Function Documentation

async_setup()

bool homeassistant.components.config.entity_registry.async_setup

(

HomeAssistant

hass

)

Enable the Entity Registry views.

Definition at line 22 of file entity_registry.py.

websocket_get_entities()

None homeassistant.components.config.entity_registry.websocket_get_entities	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle get entity registry entries command.

Async friendly.

Definition at line 126 of file entity_registry.py.

websocket_get_entity()

None homeassistant.components.config.entity_registry.websocket_get_entity	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle get entity registry entry command.

Async friendly.

Definition at line 97 of file entity_registry.py.

websocket_list_entities()

None homeassistant.components.config.entity_registry.websocket_list_entities	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle list registry entries command.

Definition at line 36 of file entity_registry.py.

websocket_list_entities_for_display()

None homeassistant.components.config.entity_registry.websocket_list_entities_for_display	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle list registry entries command.

Definition at line 66 of file entity_registry.py.

websocket_remove_entity()

None homeassistant.components.config.entity_registry.websocket_remove_entity	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle remove entity websocket command.

Async friendly.

Definition at line 300 of file entity_registry.py.

websocket_update_entity()

None homeassistant.components.config.entity_registry.websocket_update_entity	(	HomeAssistant	hass,
		websocket_api.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle update entity websocket command.

Async friendly.

Definition at line 190 of file entity_registry.py.

Variable Documentation

_ENTITY_CATEGORIES_JSON

homeassistant.components.config.entity_registry._ENTITY_CATEGORIES_JSON = json_dumps(er.ENTITY_CATEGORY_INDEX_TO_VALUE)

private

Definition at line 60 of file entity_registry.py.