homeassistant.components.config.label_registry Namespace Reference

Functions
dict[str, Any]	_entry_dict (LabelEntry entry)
bool	async_setup (HomeAssistant hass)
None	websocket_create_label (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	websocket_delete_label (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	websocket_list_labels (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
None	websocket_update_label (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)

Variables
dictionary	SUPPORTED_LABEL_THEME_COLORS

Detailed Description

Websocket API to interact with the label registry.

Function Documentation

_entry_dict()

dict[str, Any] homeassistant.components.config.label_registry._entry_dict ( LabelEntry  entry )

private

Convert entry to API format.

Definition at line 156 of file label_registry.py.

async_setup()

bool homeassistant.components.config.label_registry.async_setup

(

HomeAssistant

hass

)

Register the Label Registry WS commands.

Definition at line 44 of file label_registry.py.

websocket_create_label()

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

Create label command.

Definition at line 83 of file label_registry.py.

websocket_delete_label()

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

Delete label command.

Definition at line 109 of file label_registry.py.

websocket_list_labels()

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

Handle list labels command.

Definition at line 59 of file label_registry.py.

websocket_update_label()

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

Handle update label websocket command.

Definition at line 137 of file label_registry.py.

Variable Documentation

SUPPORTED_LABEL_THEME_COLORS

dictionary homeassistant.components.config.label_registry.SUPPORTED_LABEL_THEME_COLORS

Initial value:

=  {
    "primary",
    "accent",
    "disabled",
    "red",
    "pink",
    "purple",
    "deep-purple",
    "indigo",
    "blue",
    "light-blue",
    "cyan",
    "teal",
    "green",
    "light-green",
    "lime",
    "yellow",
    "amber",
    "orange",
    "deep-orange",
    "brown",
    "light-grey",
    "grey",
    "dark-grey",
    "blue-grey",
    "black",
    "white",
}

Definition at line 13 of file label_registry.py.