mirror of
https://github.com/home-assistant/core
synced 2024-09-03 08:14:07 +02:00
![Erik Montnemery](/assets/img/avatar_default.png)
* Add WS API for removing a config entry from a device * Address review comments * Address review comments * Remove entity cleanup from ConfigEntries * Update + add tests * Improve comments in test * Add negative test * Refactor according to review comments * Add back async_remove_config_entry_device * Remove unnecessary error handling * Simplify error handling
143 lines
4.7 KiB
Python
143 lines
4.7 KiB
Python
"""HTTP views to interact with the device registry."""
|
|
import voluptuous as vol
|
|
|
|
from homeassistant import loader
|
|
from homeassistant.components import websocket_api
|
|
from homeassistant.components.websocket_api.decorators import require_admin
|
|
from homeassistant.core import HomeAssistant, callback
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
from homeassistant.helpers.device_registry import DeviceEntryDisabler, async_get
|
|
|
|
WS_TYPE_LIST = "config/device_registry/list"
|
|
SCHEMA_WS_LIST = websocket_api.BASE_COMMAND_MESSAGE_SCHEMA.extend(
|
|
{vol.Required("type"): WS_TYPE_LIST}
|
|
)
|
|
|
|
WS_TYPE_UPDATE = "config/device_registry/update"
|
|
SCHEMA_WS_UPDATE = websocket_api.BASE_COMMAND_MESSAGE_SCHEMA.extend(
|
|
{
|
|
vol.Required("type"): WS_TYPE_UPDATE,
|
|
vol.Required("device_id"): str,
|
|
vol.Optional("area_id"): vol.Any(str, None),
|
|
vol.Optional("name_by_user"): vol.Any(str, None),
|
|
# We only allow setting disabled_by user via API.
|
|
# No Enum support like this in voluptuous, use .value
|
|
vol.Optional("disabled_by"): vol.Any(DeviceEntryDisabler.USER.value, None),
|
|
}
|
|
)
|
|
|
|
|
|
async def async_setup(hass):
|
|
"""Enable the Device Registry views."""
|
|
websocket_api.async_register_command(
|
|
hass, WS_TYPE_LIST, websocket_list_devices, SCHEMA_WS_LIST
|
|
)
|
|
websocket_api.async_register_command(
|
|
hass, WS_TYPE_UPDATE, websocket_update_device, SCHEMA_WS_UPDATE
|
|
)
|
|
websocket_api.async_register_command(
|
|
hass, websocket_remove_config_entry_from_device
|
|
)
|
|
return True
|
|
|
|
|
|
@callback
|
|
def websocket_list_devices(hass, connection, msg):
|
|
"""Handle list devices command."""
|
|
registry = async_get(hass)
|
|
connection.send_message(
|
|
websocket_api.result_message(
|
|
msg["id"], [_entry_dict(entry) for entry in registry.devices.values()]
|
|
)
|
|
)
|
|
|
|
|
|
@require_admin
|
|
@callback
|
|
def websocket_update_device(hass, connection, msg):
|
|
"""Handle update area websocket command."""
|
|
registry = async_get(hass)
|
|
|
|
msg.pop("type")
|
|
msg_id = msg.pop("id")
|
|
|
|
if msg.get("disabled_by") is not None:
|
|
msg["disabled_by"] = DeviceEntryDisabler(msg["disabled_by"])
|
|
|
|
entry = registry.async_update_device(**msg)
|
|
|
|
connection.send_message(websocket_api.result_message(msg_id, _entry_dict(entry)))
|
|
|
|
|
|
@websocket_api.require_admin
|
|
@websocket_api.websocket_command(
|
|
{
|
|
"type": "config/device_registry/remove_config_entry",
|
|
"device_id": str,
|
|
"config_entry_id": str,
|
|
}
|
|
)
|
|
@websocket_api.async_response
|
|
async def websocket_remove_config_entry_from_device(
|
|
hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict
|
|
) -> None:
|
|
"""Remove config entry from a device."""
|
|
registry = async_get(hass)
|
|
config_entry_id = msg["config_entry_id"]
|
|
device_id = msg["device_id"]
|
|
|
|
if (config_entry := hass.config_entries.async_get_entry(config_entry_id)) is None:
|
|
raise HomeAssistantError("Unknown config entry")
|
|
|
|
if not config_entry.supports_remove_device:
|
|
raise HomeAssistantError("Config entry does not support device removal")
|
|
|
|
if (device_entry := registry.async_get(device_id)) is None:
|
|
raise HomeAssistantError("Unknown device")
|
|
|
|
if config_entry_id not in device_entry.config_entries:
|
|
raise HomeAssistantError("Config entry not in device")
|
|
|
|
try:
|
|
integration = await loader.async_get_integration(hass, config_entry.domain)
|
|
component = integration.get_component()
|
|
except (ImportError, loader.IntegrationNotFound) as exc:
|
|
raise HomeAssistantError("Integration not found") from exc
|
|
|
|
if not await component.async_remove_config_entry_device(
|
|
hass, config_entry, device_entry
|
|
):
|
|
raise HomeAssistantError(
|
|
"Failed to remove device entry, rejected by integration"
|
|
)
|
|
|
|
entry = registry.async_update_device(
|
|
device_id, remove_config_entry_id=config_entry_id
|
|
)
|
|
|
|
entry_as_dict = _entry_dict(entry) if entry else None
|
|
|
|
connection.send_message(websocket_api.result_message(msg["id"], entry_as_dict))
|
|
|
|
|
|
@callback
|
|
def _entry_dict(entry):
|
|
"""Convert entry to API format."""
|
|
return {
|
|
"area_id": entry.area_id,
|
|
"configuration_url": entry.configuration_url,
|
|
"config_entries": list(entry.config_entries),
|
|
"connections": list(entry.connections),
|
|
"disabled_by": entry.disabled_by,
|
|
"entry_type": entry.entry_type,
|
|
"id": entry.id,
|
|
"identifiers": list(entry.identifiers),
|
|
"manufacturer": entry.manufacturer,
|
|
"model": entry.model,
|
|
"name_by_user": entry.name_by_user,
|
|
"name": entry.name,
|
|
"sw_version": entry.sw_version,
|
|
"hw_version": entry.hw_version,
|
|
"via_device_id": entry.via_device_id,
|
|
}
|