camera.py

Go to the documentation of this file.

"""Support for the Environment Canada radar imagery."""
 
from __future__ import annotations
 
import voluptuous as vol
 
from homeassistant.components.camera import Camera
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import (
    AddEntitiesCallback,
    async_get_current_platform,
)
from homeassistant.helpers.typing import VolDictType
from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
from . import device_info
from .const import ATTR_OBSERVATION_TIME, DOMAIN
 
SERVICE_SET_RADAR_TYPE = "set_radar_type"
SET_RADAR_TYPE_SCHEMA: VolDictType = {
    vol.Required("radar_type"): vol.In(["Auto", "Rain", "Snow"]),
}
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Add a weather entity from a config_entry."""
    coordinator = hass.data[DOMAIN][config_entry.entry_id]["radar_coordinator"]
    async_add_entities([ECCamera(coordinator)])
 
    platform = async_get_current_platform()
    platform.async_register_entity_service(
        SERVICE_SET_RADAR_TYPE,
        SET_RADAR_TYPE_SCHEMA,
        "async_set_radar_type",
    )
 
 
class ECCamera(CoordinatorEntity, Camera):
    """Implementation of an Environment Canada radar camera."""
 
    _attr_has_entity_name = True
    _attr_translation_key = "radar"
 
    def __init__(self, coordinator):
        """Initialize the camera."""
        super().__init__(coordinator)
        Camera.__init__(self)
 
        self.radar_objectradar_object = coordinator.ec_data
        self._attr_unique_id_attr_unique_id = f"{coordinator.config_entry.unique_id}-radar"
        self._attr_attribution_attr_attribution = self.radar_objectradar_object.metadata["attribution"]
        self._attr_entity_registry_enabled_default_attr_entity_registry_enabled_default = False
        self._attr_device_info_attr_device_info = device_info(coordinator.config_entry)
 
        self.content_typecontent_type = "image/gif"
 
    def camera_image(
        self, width: int | None = None, height: int | None = None
    ) -> bytes | None:
        """Return bytes of camera image."""
        self._attr_extra_state_attributes_attr_extra_state_attributes = {
            ATTR_OBSERVATION_TIME: self.radar_objectradar_object.timestamp,
        }
        return self.radar_objectradar_object.image
 
    async def async_set_radar_type(self, radar_type: str):
        """Set the type of radar to retrieve."""
        self.radar_objectradar_object.precip_type = radar_type.lower()
        await self.radar_objectradar_object.update()