mirror of
https://github.com/home-assistant/core.git
synced 2025-11-08 02:19:31 +00:00
229 lines
7.8 KiB
Python
229 lines
7.8 KiB
Python
"""Support for Blink system camera."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Mapping
|
|
import logging
|
|
from typing import Any
|
|
|
|
from blinkpy.auth import UnauthorizedError
|
|
from blinkpy.camera import BlinkCamera as BlinkCameraAPI
|
|
from requests.exceptions import ChunkedEncodingError
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.camera import Camera
|
|
from homeassistant.const import CONF_FILE_PATH, CONF_FILENAME
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.exceptions import (
|
|
ConfigEntryAuthFailed,
|
|
HomeAssistantError,
|
|
ServiceValidationError,
|
|
)
|
|
from homeassistant.helpers import config_validation as cv, entity_platform
|
|
from homeassistant.helpers.device_registry import DeviceInfo
|
|
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
|
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
|
|
|
from .const import (
|
|
DEFAULT_BRAND,
|
|
DOMAIN,
|
|
SERVICE_RECORD,
|
|
SERVICE_SAVE_RECENT_CLIPS,
|
|
SERVICE_SAVE_VIDEO,
|
|
SERVICE_TRIGGER,
|
|
)
|
|
from .coordinator import BlinkConfigEntry, BlinkUpdateCoordinator
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
ATTR_VIDEO_CLIP = "video"
|
|
ATTR_IMAGE = "image"
|
|
PARALLEL_UPDATES = 1
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: BlinkConfigEntry,
|
|
async_add_entities: AddConfigEntryEntitiesCallback,
|
|
) -> None:
|
|
"""Set up a Blink Camera."""
|
|
|
|
coordinator = config_entry.runtime_data
|
|
entities = [
|
|
BlinkCamera(coordinator, name, camera)
|
|
for name, camera in coordinator.api.cameras.items()
|
|
]
|
|
|
|
async_add_entities(entities)
|
|
|
|
platform = entity_platform.async_get_current_platform()
|
|
platform.async_register_entity_service(SERVICE_RECORD, None, "record")
|
|
platform.async_register_entity_service(SERVICE_TRIGGER, None, "trigger_camera")
|
|
platform.async_register_entity_service(
|
|
SERVICE_SAVE_RECENT_CLIPS,
|
|
{vol.Required(CONF_FILE_PATH): cv.string},
|
|
"save_recent_clips",
|
|
)
|
|
platform.async_register_entity_service(
|
|
SERVICE_SAVE_VIDEO,
|
|
{vol.Required(CONF_FILENAME): cv.string},
|
|
"save_video",
|
|
)
|
|
|
|
|
|
class BlinkCamera(CoordinatorEntity[BlinkUpdateCoordinator], Camera):
|
|
"""An implementation of a Blink Camera."""
|
|
|
|
_attr_has_entity_name = True
|
|
_attr_name = None
|
|
|
|
def __init__(
|
|
self, coordinator: BlinkUpdateCoordinator, name, camera: BlinkCameraAPI
|
|
) -> None:
|
|
"""Initialize a camera."""
|
|
super().__init__(coordinator)
|
|
Camera.__init__(self)
|
|
self._camera = camera
|
|
self._attr_unique_id = f"{camera.serial}-camera"
|
|
self._attr_device_info = DeviceInfo(
|
|
identifiers={(DOMAIN, camera.serial)},
|
|
serial_number=camera.serial,
|
|
sw_version=camera.version,
|
|
name=name,
|
|
manufacturer=DEFAULT_BRAND,
|
|
model=camera.camera_type,
|
|
)
|
|
_LOGGER.debug("Initialized blink camera %s", self._camera.name)
|
|
|
|
@property
|
|
def extra_state_attributes(self) -> Mapping[str, Any] | None:
|
|
"""Return the camera attributes."""
|
|
return self._camera.attributes
|
|
|
|
async def async_enable_motion_detection(self) -> None:
|
|
"""Enable motion detection for the camera."""
|
|
try:
|
|
await self._camera.async_arm(True)
|
|
except TimeoutError as er:
|
|
raise HomeAssistantError(
|
|
translation_domain=DOMAIN,
|
|
translation_key="failed_arm",
|
|
) from er
|
|
except UnauthorizedError as er:
|
|
self.coordinator.config_entry.async_start_reauth(self.hass)
|
|
raise ConfigEntryAuthFailed("Blink authorization failed") from er
|
|
|
|
self._camera.motion_enabled = True
|
|
await self.coordinator.async_refresh()
|
|
|
|
async def async_disable_motion_detection(self) -> None:
|
|
"""Disable motion detection for the camera."""
|
|
try:
|
|
await self._camera.async_arm(False)
|
|
except TimeoutError as er:
|
|
raise HomeAssistantError(
|
|
translation_domain=DOMAIN,
|
|
translation_key="failed_disarm",
|
|
) from er
|
|
except UnauthorizedError as er:
|
|
self.coordinator.config_entry.async_start_reauth(self.hass)
|
|
raise ConfigEntryAuthFailed("Blink authorization failed") from er
|
|
|
|
self._camera.motion_enabled = False
|
|
await self.coordinator.async_refresh()
|
|
|
|
@property
|
|
def motion_detection_enabled(self) -> bool:
|
|
"""Return the state of the camera."""
|
|
return self._camera.arm
|
|
|
|
@property
|
|
def brand(self) -> str | None:
|
|
"""Return the camera brand."""
|
|
return DEFAULT_BRAND
|
|
|
|
async def record(self) -> None:
|
|
"""Trigger camera to record a clip."""
|
|
try:
|
|
await self._camera.record()
|
|
except TimeoutError as er:
|
|
raise HomeAssistantError(
|
|
translation_domain=DOMAIN,
|
|
translation_key="failed_clip",
|
|
) from er
|
|
except UnauthorizedError as er:
|
|
self.coordinator.config_entry.async_start_reauth(self.hass)
|
|
raise ConfigEntryAuthFailed("Blink authorization failed") from er
|
|
|
|
self.async_write_ha_state()
|
|
|
|
async def trigger_camera(self) -> None:
|
|
"""Trigger camera to take a snapshot."""
|
|
try:
|
|
await self._camera.snap_picture()
|
|
except TimeoutError as er:
|
|
raise HomeAssistantError(
|
|
translation_domain=DOMAIN,
|
|
translation_key="failed_snap",
|
|
) from er
|
|
except UnauthorizedError as er:
|
|
self.coordinator.config_entry.async_start_reauth(self.hass)
|
|
raise ConfigEntryAuthFailed("Blink authorization failed") from er
|
|
|
|
self.async_write_ha_state()
|
|
|
|
def camera_image(
|
|
self, width: int | None = None, height: int | None = None
|
|
) -> bytes | None:
|
|
"""Return a still image response from the camera."""
|
|
try:
|
|
return self._camera.image_from_cache
|
|
except ChunkedEncodingError:
|
|
_LOGGER.debug("Could not retrieve image for %s", self._camera.name)
|
|
return None
|
|
except TypeError:
|
|
_LOGGER.debug("No cached image for %s", self._camera.name)
|
|
return None
|
|
|
|
async def save_recent_clips(self, file_path) -> None:
|
|
"""Save multiple recent clips to output directory."""
|
|
if not self.hass.config.is_allowed_path(file_path):
|
|
raise ServiceValidationError(
|
|
translation_domain=DOMAIN,
|
|
translation_key="no_path",
|
|
translation_placeholders={"target": file_path},
|
|
)
|
|
|
|
try:
|
|
await self._camera.save_recent_clips(output_dir=file_path)
|
|
except OSError as err:
|
|
raise ServiceValidationError(
|
|
str(err),
|
|
translation_domain=DOMAIN,
|
|
translation_key="cant_write",
|
|
) from err
|
|
except UnauthorizedError as er:
|
|
self.coordinator.config_entry.async_start_reauth(self.hass)
|
|
raise ConfigEntryAuthFailed("Blink authorization failed") from er
|
|
|
|
async def save_video(self, filename) -> None:
|
|
"""Handle save video service calls."""
|
|
if not self.hass.config.is_allowed_path(filename):
|
|
raise ServiceValidationError(
|
|
translation_domain=DOMAIN,
|
|
translation_key="no_path",
|
|
translation_placeholders={"target": filename},
|
|
)
|
|
|
|
try:
|
|
await self._camera.video_to_file(filename)
|
|
except OSError as err:
|
|
raise ServiceValidationError(
|
|
str(err),
|
|
translation_domain=DOMAIN,
|
|
translation_key="cant_write",
|
|
) from err
|
|
except UnauthorizedError as er:
|
|
self.coordinator.config_entry.async_start_reauth(self.hass)
|
|
raise ConfigEntryAuthFailed("Blink authorization failed") from er
|