image.py

Go to the documentation of this file.

"""Demo image platform."""
 
from __future__ import annotations
 
from pathlib import Path
 
from homeassistant.components.image import ImageEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
from homeassistant.util import dt as dt_util
 
 
async def async_setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    async_add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up image entities."""
    async_add_entities(
        [
            DemoImage(
                hass,
                "kitchen_sink_image_001",
                "QR Code",
                "image/png",
                "qr_code.png",
            ),
        ]
    )
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the Everything but the Kitchen Sink config entry."""
    await async_setup_platform(hass, {}, async_add_entities)
 
 
class DemoImage(ImageEntity):
    """Representation of an image entity."""
 
    def __init__(
        self,
        hass: HomeAssistant,
        unique_id: str,
        name: str,
        content_type: str,
        image: str,
    ) -> None:
        """Initialize the image entity."""
        super().__init__(hass)
        self._attr_content_type_attr_content_type_attr_content_type = content_type
        self._attr_name_attr_name = name
        self._attr_unique_id_attr_unique_id = unique_id
        self._image_filename_image_filename = image
 
    async def async_added_to_hass(self):
        """Set the update time."""
        self._attr_image_last_updated_attr_image_last_updated = dt_util.utcnow()
 
    async def async_image(self) -> bytes | None:
        """Return bytes of image."""
        image_path = Path(__file__).parent / self._image_filename_image_filename
        return await self.hasshass.async_add_executor_job(image_path.read_bytes)