mirror of
https://github.com/home-assistant/core
synced 2024-08-31 05:57:13 +02:00
234 lines
6.9 KiB
Python
234 lines
6.9 KiB
Python
"""The motionEye integration."""
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
import logging
|
|
from typing import Any, Callable
|
|
|
|
from motioneye_client.client import (
|
|
MotionEyeClient,
|
|
MotionEyeClientError,
|
|
MotionEyeClientInvalidAuthError,
|
|
)
|
|
from motioneye_client.const import KEY_CAMERAS, KEY_ID, KEY_NAME
|
|
|
|
from homeassistant.components.camera.const import DOMAIN as CAMERA_DOMAIN
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import CONF_URL
|
|
from homeassistant.core import HomeAssistant, callback
|
|
from homeassistant.exceptions import ConfigEntryAuthFailed, ConfigEntryNotReady
|
|
from homeassistant.helpers import device_registry as dr
|
|
from homeassistant.helpers.dispatcher import (
|
|
async_dispatcher_connect,
|
|
async_dispatcher_send,
|
|
)
|
|
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
|
|
|
|
from .const import (
|
|
CONF_ADMIN_PASSWORD,
|
|
CONF_ADMIN_USERNAME,
|
|
CONF_CLIENT,
|
|
CONF_COORDINATOR,
|
|
CONF_SURVEILLANCE_PASSWORD,
|
|
CONF_SURVEILLANCE_USERNAME,
|
|
DEFAULT_SCAN_INTERVAL,
|
|
DOMAIN,
|
|
MOTIONEYE_MANUFACTURER,
|
|
SIGNAL_CAMERA_ADD,
|
|
)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
PLATFORMS = [CAMERA_DOMAIN]
|
|
|
|
|
|
def create_motioneye_client(
|
|
*args: Any,
|
|
**kwargs: Any,
|
|
) -> MotionEyeClient:
|
|
"""Create a MotionEyeClient."""
|
|
return MotionEyeClient(*args, **kwargs)
|
|
|
|
|
|
def get_motioneye_device_identifier(
|
|
config_entry_id: str, camera_id: int
|
|
) -> tuple[str, str]:
|
|
"""Get the identifiers for a motionEye device."""
|
|
return (DOMAIN, f"{config_entry_id}_{camera_id}")
|
|
|
|
|
|
def get_motioneye_entity_unique_id(
|
|
config_entry_id: str, camera_id: int, entity_type: str
|
|
) -> str:
|
|
"""Get the unique_id for a motionEye entity."""
|
|
return f"{config_entry_id}_{camera_id}_{entity_type}"
|
|
|
|
|
|
def get_camera_from_cameras(
|
|
camera_id: int, data: dict[str, Any]
|
|
) -> dict[str, Any] | None:
|
|
"""Get an individual camera dict from a multiple cameras data response."""
|
|
for camera in data.get(KEY_CAMERAS) or []:
|
|
if camera.get(KEY_ID) == camera_id:
|
|
val: dict[str, Any] = camera
|
|
return val
|
|
return None
|
|
|
|
|
|
def is_acceptable_camera(camera: dict[str, Any] | None) -> bool:
|
|
"""Determine if a camera dict is acceptable."""
|
|
return bool(camera and KEY_ID in camera and KEY_NAME in camera)
|
|
|
|
|
|
@callback
|
|
def listen_for_new_cameras(
|
|
hass: HomeAssistant,
|
|
entry: ConfigEntry,
|
|
add_func: Callable,
|
|
) -> None:
|
|
"""Listen for new cameras."""
|
|
|
|
entry.async_on_unload(
|
|
async_dispatcher_connect(
|
|
hass,
|
|
SIGNAL_CAMERA_ADD.format(entry.entry_id),
|
|
add_func,
|
|
)
|
|
)
|
|
|
|
|
|
@callback
|
|
def _add_camera(
|
|
hass: HomeAssistant,
|
|
device_registry: dr.DeviceRegistry,
|
|
client: MotionEyeClient,
|
|
entry: ConfigEntry,
|
|
camera_id: int,
|
|
camera: dict[str, Any],
|
|
device_identifier: tuple[str, str, int],
|
|
) -> None:
|
|
"""Add a motionEye camera to hass."""
|
|
|
|
device_registry.async_get_or_create(
|
|
config_entry_id=entry.entry_id,
|
|
identifiers={device_identifier},
|
|
manufacturer=MOTIONEYE_MANUFACTURER,
|
|
model=MOTIONEYE_MANUFACTURER,
|
|
name=camera[KEY_NAME],
|
|
)
|
|
|
|
async_dispatcher_send(
|
|
hass,
|
|
SIGNAL_CAMERA_ADD.format(entry.entry_id),
|
|
camera,
|
|
)
|
|
|
|
|
|
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|
"""Set up motionEye from a config entry."""
|
|
hass.data.setdefault(DOMAIN, {})
|
|
|
|
client = create_motioneye_client(
|
|
entry.data[CONF_URL],
|
|
admin_username=entry.data.get(CONF_ADMIN_USERNAME),
|
|
admin_password=entry.data.get(CONF_ADMIN_PASSWORD),
|
|
surveillance_username=entry.data.get(CONF_SURVEILLANCE_USERNAME),
|
|
surveillance_password=entry.data.get(CONF_SURVEILLANCE_PASSWORD),
|
|
)
|
|
|
|
try:
|
|
await client.async_client_login()
|
|
except MotionEyeClientInvalidAuthError as exc:
|
|
await client.async_client_close()
|
|
raise ConfigEntryAuthFailed from exc
|
|
except MotionEyeClientError as exc:
|
|
await client.async_client_close()
|
|
raise ConfigEntryNotReady from exc
|
|
|
|
@callback
|
|
async def async_update_data() -> dict[str, Any] | None:
|
|
try:
|
|
return await client.async_get_cameras()
|
|
except MotionEyeClientError as exc:
|
|
raise UpdateFailed("Error communicating with API") from exc
|
|
|
|
coordinator = DataUpdateCoordinator(
|
|
hass,
|
|
_LOGGER,
|
|
name=DOMAIN,
|
|
update_method=async_update_data,
|
|
update_interval=DEFAULT_SCAN_INTERVAL,
|
|
)
|
|
hass.data[DOMAIN][entry.entry_id] = {
|
|
CONF_CLIENT: client,
|
|
CONF_COORDINATOR: coordinator,
|
|
}
|
|
|
|
current_cameras: set[tuple[str, str, int]] = set()
|
|
device_registry = await dr.async_get_registry(hass)
|
|
|
|
@callback
|
|
def _async_process_motioneye_cameras() -> None:
|
|
"""Process motionEye camera additions and removals."""
|
|
inbound_camera: set[tuple[str, str, int]] = set()
|
|
if KEY_CAMERAS not in coordinator.data:
|
|
return
|
|
|
|
for camera in coordinator.data[KEY_CAMERAS]:
|
|
if not is_acceptable_camera(camera):
|
|
return
|
|
camera_id = camera[KEY_ID]
|
|
device_identifier = get_motioneye_device_identifier(
|
|
entry.entry_id, camera_id
|
|
)
|
|
inbound_camera.add(device_identifier)
|
|
|
|
if device_identifier in current_cameras:
|
|
continue
|
|
current_cameras.add(device_identifier)
|
|
_add_camera(
|
|
hass,
|
|
device_registry,
|
|
client,
|
|
entry,
|
|
camera_id,
|
|
camera,
|
|
device_identifier,
|
|
)
|
|
|
|
# Ensure every device associated with this config entry is still in the list of
|
|
# motionEye cameras, otherwise remove the device (and thus entities).
|
|
for device_entry in dr.async_entries_for_config_entry(
|
|
device_registry, entry.entry_id
|
|
):
|
|
for identifier in device_entry.identifiers:
|
|
if identifier in inbound_camera:
|
|
break
|
|
else:
|
|
device_registry.async_remove_device(device_entry.id)
|
|
|
|
async def setup_then_listen() -> None:
|
|
await asyncio.gather(
|
|
*[
|
|
hass.config_entries.async_forward_entry_setup(entry, platform)
|
|
for platform in PLATFORMS
|
|
]
|
|
)
|
|
entry.async_on_unload(
|
|
coordinator.async_add_listener(_async_process_motioneye_cameras)
|
|
)
|
|
await coordinator.async_refresh()
|
|
|
|
hass.async_create_task(setup_then_listen())
|
|
return True
|
|
|
|
|
|
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|
"""Unload a config entry."""
|
|
unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
|
|
if unload_ok:
|
|
config_data = hass.data[DOMAIN].pop(entry.entry_id)
|
|
await config_data[CONF_CLIENT].async_client_close()
|
|
|
|
return unload_ok
|