camera.py

Go to the documentation of this file.

"""Support for viewing the camera feed from a DoorBird video doorbell."""
 
from __future__ import annotations
 
import datetime
import logging
 
import aiohttp
 
from homeassistant.components.camera import Camera, CameraEntityFeature
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
import homeassistant.util.dt as dt_util
 
from .entity import DoorBirdEntity
from .models import DoorBirdConfigEntry, DoorBirdData
 
_LAST_VISITOR_INTERVAL = datetime.timedelta(minutes=2)
_LAST_MOTION_INTERVAL = datetime.timedelta(seconds=30)
_LIVE_INTERVAL = datetime.timedelta(seconds=45)
_LOGGER = logging.getLogger(__name__)
_TIMEOUT = 15  # seconds
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: DoorBirdConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the DoorBird camera platform."""
    door_bird_data = config_entry.runtime_data
    device = door_bird_data.door_station.device
 
    async_add_entities(
        [
            DoorBirdCamera(
                door_bird_data,
                device.live_image_url,
                "live",
                _LIVE_INTERVAL,
                device.rtsp_live_video_url,
            ),
            DoorBirdCamera(
                door_bird_data,
                device.history_image_url(1, "doorbell"),
                "last_ring",
                _LAST_VISITOR_INTERVAL,
            ),
            DoorBirdCamera(
                door_bird_data,
                device.history_image_url(1, "motionsensor"),
                "last_motion",
                _LAST_MOTION_INTERVAL,
            ),
        ]
    )
 
 
class DoorBirdCamera(DoorBirdEntity, Camera):
    """The camera on a DoorBird device."""
 
    def __init__(
        self,
        door_bird_data: DoorBirdData,
        url: str,
        camera_id: str,
        interval: datetime.timedelta,
        stream_url: str | None = None,
    ) -> None:
        """Initialize the camera on a DoorBird device."""
        super().__init__(door_bird_data)
        self._url_url = url
        self._stream_url_stream_url = stream_url
        self._attr_translation_key_attr_translation_key = camera_id
        self._last_image_last_image: bytes | None = None
        if self._stream_url_stream_url:
            self._attr_supported_features_attr_supported_features = CameraEntityFeature.STREAM
        self._interval_interval = interval
        self._last_update_last_update = datetime.datetime.min
        self._attr_unique_id_attr_unique_id = f"{self._mac_addr}_{camera_id}"
 
    async def stream_source(self) -> str | None:
        """Return the stream source."""
        return self._stream_url_stream_url
 
    async def async_camera_image(
        self, width: int | None = None, height: int | None = None
    ) -> bytes | None:
        """Pull a still image from the camera."""
        now = dt_util.utcnow()
 
        if self._last_image_last_image and now - self._last_update_last_update < self._interval_interval:
            return self._last_image_last_image
 
        try:
            self._last_image_last_image = await self._door_station_door_station.device.get_image(
                self._url_url, timeout=_TIMEOUT
            )
        except TimeoutError:
            _LOGGER.error("DoorBird %s: Camera image timed out", self.namename)
            return self._last_image_last_image
        except aiohttp.ClientError as error:
            _LOGGER.error(
                "DoorBird %s: Error getting camera image: %s", self.namename, error
            )
            return self._last_image_last_image
 
        self._last_update_last_update = now
        return self._last_image_last_image
 
    async def async_added_to_hass(self) -> None:
        """Subscribe to events."""
        await super().async_added_to_hass()
        event_to_entity_id = self._door_bird_data_door_bird_data.event_entity_ids
        for event in self._door_station_door_station.events:
            event_to_entity_id[event] = self.entity_identity_id
 
    async def async_will_remove_from_hass(self) -> None:
        """Unsubscribe from events."""
        event_to_entity_id = self._door_bird_data_door_bird_data.event_entity_ids
        for event in self._door_station_door_station.events:
            # If the clear api was called, the events may not be in the dict
            event_to_entity_id.pop(event, None)
        await super().async_will_remove_from_hass()