Entity registry api update disable (#26015)
* Clean up entity registry WS commands * Allow updating disabled_by in entity registry * Allow changing disabled_by via API * Update tests/components/config/test_entity_registry.py Co-Authored-By: Robert Svensson <Kane610@users.noreply.github.com>
This commit is contained in:
1 parent
d4046cb6e4
commit
eba6caf8a1
4 files changed
+97
-53
No files matched your search
@@ -11,51 +11,18 @@ from homeassistant.components.websocket_api.decorators import (
|
||||
)
|
||||
from homeassistant.helpers import config_validation as cv
|
||||
|
||||
WS_TYPE_LIST = "config/entity_registry/list"
|
||||
SCHEMA_WS_LIST = websocket_api.BASE_COMMAND_MESSAGE_SCHEMA.extend(
|
||||
{vol.Required("type"): WS_TYPE_LIST}
|
||||
)
|
||||
|
||||
WS_TYPE_GET = "config/entity_registry/get"
|
||||
SCHEMA_WS_GET = websocket_api.BASE_COMMAND_MESSAGE_SCHEMA.extend(
|
||||
{vol.Required("type"): WS_TYPE_GET, vol.Required("entity_id"): cv.entity_id}
|
||||
)
|
||||
|
||||
WS_TYPE_UPDATE = "config/entity_registry/update"
|
||||
SCHEMA_WS_UPDATE = websocket_api.BASE_COMMAND_MESSAGE_SCHEMA.extend(
|
||||
{
|
||||
vol.Required("type"): WS_TYPE_UPDATE,
|
||||
vol.Required("entity_id"): cv.entity_id,
|
||||
# If passed in, we update value. Passing None will remove old value.
|
||||
vol.Optional("name"): vol.Any(str, None),
|
||||
vol.Optional("new_entity_id"): str,
|
||||
}
|
||||
)
|
||||
|
||||
WS_TYPE_REMOVE = "config/entity_registry/remove"
|
||||
SCHEMA_WS_REMOVE = websocket_api.BASE_COMMAND_MESSAGE_SCHEMA.extend(
|
||||
{vol.Required("type"): WS_TYPE_REMOVE, vol.Required("entity_id"): cv.entity_id}
|
||||
)
|
||||
|
||||
|
||||
async def async_setup(hass):
|
||||
"""Enable the Entity Registry views."""
|
||||
hass.components.websocket_api.async_register_command(
|
||||
WS_TYPE_LIST, websocket_list_entities, SCHEMA_WS_LIST
|
||||
)
|
||||
hass.components.websocket_api.async_register_command(
|
||||
WS_TYPE_GET, websocket_get_entity, SCHEMA_WS_GET
|
||||
)
|
||||
hass.components.websocket_api.async_register_command(
|
||||
WS_TYPE_UPDATE, websocket_update_entity, SCHEMA_WS_UPDATE
|
||||
)
|
||||
hass.components.websocket_api.async_register_command(
|
||||
WS_TYPE_REMOVE, websocket_remove_entity, SCHEMA_WS_REMOVE
|
||||
)
|
||||
hass.components.websocket_api.async_register_command(websocket_list_entities)
|
||||
hass.components.websocket_api.async_register_command(websocket_get_entity)
|
||||
hass.components.websocket_api.async_register_command(websocket_update_entity)
|
||||
hass.components.websocket_api.async_register_command(websocket_remove_entity)
|
||||
return True
|
||||
|
||||
|
||||
@async_response
|
||||
@websocket_api.websocket_command({vol.Required("type"): "config/entity_registry/list"})
|
||||
async def websocket_list_entities(hass, connection, msg):
|
||||
"""Handle list registry entries command.
|
||||
|
||||
@@ -70,6 +37,12 @@ async def websocket_list_entities(hass, connection, msg):
|
||||
|
||||
|
||||
@async_response
|
||||
@websocket_api.websocket_command(
|
||||
{
|
||||
vol.Required("type"): "config/entity_registry/get",
|
||||
vol.Required("entity_id"): cv.entity_id,
|
||||
}
|
||||
)
|
||||
async def websocket_get_entity(hass, connection, msg):
|
||||
"""Handle get entity registry entry command.
|
||||
|
||||
@@ -89,6 +62,17 @@ async def websocket_get_entity(hass, connection, msg):
|
||||
|
||||
@require_admin
|
||||
@async_response
|
||||
@websocket_api.websocket_command(
|
||||
{
|
||||
vol.Required("type"): "config/entity_registry/update",
|
||||
vol.Required("entity_id"): cv.entity_id,
|
||||
# If passed in, we update value. Passing None will remove old value.
|
||||
vol.Optional("name"): vol.Any(str, None),
|
||||
vol.Optional("new_entity_id"): str,
|
||||
# We only allow setting disabled_by user via API.
|
||||
vol.Optional("disabled_by"): vol.Any("user", None),
|
||||
}
|
||||
)
|
||||
async def websocket_update_entity(hass, connection, msg):
|
||||
"""Handle update entity websocket command.
|
||||
|
||||
@@ -107,6 +91,9 @@ async def websocket_update_entity(hass, connection, msg):
|
||||
if "name" in msg:
|
||||
changes["name"] = msg["name"]
|
||||
|
||||
if "disabled_by" in msg:
|
||||
changes["disabled_by"] = msg["disabled_by"]
|
||||
|
||||
if "new_entity_id" in msg and msg["new_entity_id"] != msg["entity_id"]:
|
||||
changes["new_entity_id"] = msg["new_entity_id"]
|
||||
if hass.states.get(msg["new_entity_id"]) is not None:
|
||||
@@ -132,6 +119,12 @@ async def websocket_update_entity(hass, connection, msg):
|
||||
|
||||
@require_admin
|
||||
@async_response
|
||||
@websocket_api.websocket_command(
|
||||
{
|
||||
vol.Required("type"): "config/entity_registry/remove",
|
||||
vol.Required("entity_id"): cv.entity_id,
|
||||
}
|
||||
)
|
||||
async def websocket_remove_entity(hass, connection, msg):
|
||||
"""Handle remove entity websocket command.
|
||||
|
||||
|
||||
Reference in new issue
Block a user