homeassistant.components.config.category_registry Namespace Reference

Functions
dict[str, Any]	_entry_dict (cr.CategoryEntry entry)
bool	async_setup (HomeAssistant hass)
None	websocket_create_category (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	websocket_delete_category (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	websocket_list_categories (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	websocket_update_category (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)

Detailed Description

Websocket API to interact with the category registry.

Function Documentation

_entry_dict()

dict[str, Any] homeassistant.components.config.category_registry._entry_dict ( cr.CategoryEntry  entry )

private

Convert entry to API format.

Definition at line 129 of file category_registry.py.

async_setup()

bool homeassistant.components.config.category_registry.async_setup

(

HomeAssistant

hass

)

Register the category registry WS commands.

Definition at line 14 of file category_registry.py.

websocket_create_category()

None homeassistant.components.config.category_registry.websocket_create_category	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg
	)

Create category command.

Definition at line 54 of file category_registry.py.

websocket_delete_category()

None homeassistant.components.config.category_registry.websocket_delete_category	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg
	)

Delete category command.

Definition at line 81 of file category_registry.py.

websocket_list_categories()

None homeassistant.components.config.category_registry.websocket_list_categories	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle list categories command.

Definition at line 30 of file category_registry.py.

websocket_update_category()

None homeassistant.components.config.category_registry.websocket_update_category	(	HomeAssistant	hass,
		ActiveConnection	connection,
		dict[str, Any]	msg
	)

Handle update category websocket command.

Definition at line 108 of file category_registry.py.