core/homeassistant/components/netatmo/light.py

"""Support for the Netatmo camera lights."""
from __future__ import annotations

import logging
from typing import Any, cast

from pyatmo import modules as NaModules

from homeassistant.components.light import ATTR_BRIGHTNESS, ColorMode, LightEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.dispatcher import async_dispatcher_connect
from homeassistant.helpers.entity_platform import AddEntitiesCallback

from .const import (
    CONF_URL_CONTROL,
    CONF_URL_SECURITY,
    DOMAIN,
    EVENT_TYPE_LIGHT_MODE,
    NETATMO_CREATE_CAMERA_LIGHT,
    NETATMO_CREATE_LIGHT,
    WEBHOOK_LIGHT_MODE,
    WEBHOOK_PUSH_TYPE,
)
from .data_handler import HOME, SIGNAL_NAME, NetatmoDevice
from .netatmo_entity_base import NetatmoBase

_LOGGER = logging.getLogger(__name__)


async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Set up the Netatmo camera light platform."""

    @callback
    def _create_camera_light_entity(netatmo_device: NetatmoDevice) -> None:
        if not hasattr(netatmo_device.device, "floodlight"):
            return

        entity = NetatmoCameraLight(netatmo_device)
        async_add_entities([entity])

    entry.async_on_unload(
        async_dispatcher_connect(
            hass, NETATMO_CREATE_CAMERA_LIGHT, _create_camera_light_entity
        )
    )

    @callback
    def _create_entity(netatmo_device: NetatmoDevice) -> None:
        if not hasattr(netatmo_device.device, "brightness"):
            return

        entity = NetatmoLight(netatmo_device)
        _LOGGER.debug("Adding light %s", entity)
        async_add_entities([entity])

    entry.async_on_unload(
        async_dispatcher_connect(hass, NETATMO_CREATE_LIGHT, _create_entity)
    )


class NetatmoCameraLight(NetatmoBase, LightEntity):
    """Representation of a Netatmo Presence camera light."""

    _attr_has_entity_name = True

    def __init__(
        self,
        netatmo_device: NetatmoDevice,
    ) -> None:
        """Initialize a Netatmo Presence camera light."""
        LightEntity.__init__(self)
        super().__init__(netatmo_device.data_handler)

        self._camera = cast(NaModules.NOC, netatmo_device.device)
        self._id = self._camera.entity_id
        self._home_id = self._camera.home.entity_id
        self._device_name = self._camera.name
        self._model = self._camera.device_type
        self._config_url = CONF_URL_SECURITY
        self._is_on = False
        self._attr_unique_id = f"{self._id}-light"

        self._signal_name = f"{HOME}-{self._home_id}"
        self._publishers.extend(
            [
                {
                    "name": HOME,
                    "home_id": self._camera.home.entity_id,
                    SIGNAL_NAME: self._signal_name,
                },
            ]
        )

    async def async_added_to_hass(self) -> None:
        """Entity created."""
        await super().async_added_to_hass()

        self.async_on_remove(
            async_dispatcher_connect(
                self.hass,
                f"signal-{DOMAIN}-webhook-{EVENT_TYPE_LIGHT_MODE}",
                self.handle_event,
            )
        )

    @callback
    def handle_event(self, event: dict) -> None:
        """Handle webhook events."""
        data = event["data"]

        if not data.get("camera_id"):
            return

        if (
            data["home_id"] == self._home_id
            and data["camera_id"] == self._id
            and data[WEBHOOK_PUSH_TYPE] == WEBHOOK_LIGHT_MODE
        ):
            self._is_on = bool(data["sub_type"] == "on")

            self.async_write_ha_state()
            return

    @property
    def available(self) -> bool:
        """If the webhook is not established, mark as unavailable."""
        return bool(self.data_handler.webhook)

    @property
    def is_on(self) -> bool:
        """Return true if light is on."""
        return self._is_on

    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn camera floodlight on."""
        _LOGGER.debug("Turn camera '%s' on", self.name)
        await self._camera.async_floodlight_on()

    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn camera floodlight into auto mode."""
        _LOGGER.debug("Turn camera '%s' to auto mode", self.name)
        await self._camera.async_floodlight_auto()

    @callback
    def async_update_callback(self) -> None:
        """Update the entity's state."""
        self._is_on = bool(self._camera.floodlight == "on")


class NetatmoLight(NetatmoBase, LightEntity):
    """Representation of a dimmable light by Legrand/BTicino."""

    def __init__(
        self,
        netatmo_device: NetatmoDevice,
    ) -> None:
        """Initialize a Netatmo light."""
        super().__init__(netatmo_device.data_handler)

        self._dimmer = cast(NaModules.NLFN, netatmo_device.device)
        self._id = self._dimmer.entity_id
        self._home_id = self._dimmer.home.entity_id
        self._device_name = self._dimmer.name
        self._attr_name = f"{self._device_name}"
        self._model = self._dimmer.device_type
        self._config_url = CONF_URL_CONTROL
        self._attr_brightness = 0
        self._attr_unique_id = f"{self._id}-light"

        self._attr_supported_color_modes: set[str] = set()

        if not self._attr_supported_color_modes and self._dimmer.brightness is not None:
            self._attr_supported_color_modes.add(ColorMode.BRIGHTNESS)

        self._signal_name = f"{HOME}-{self._home_id}"
        self._publishers.extend(
            [
                {
                    "name": HOME,
                    "home_id": self._dimmer.home.entity_id,
                    SIGNAL_NAME: self._signal_name,
                },
            ]
        )

    @property
    def is_on(self) -> bool:
        """Return true if light is on."""
        return self._dimmer.on is True

    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn light on."""
        _LOGGER.debug("Turn light '%s' on", self.name)
        if ATTR_BRIGHTNESS in kwargs:
            await self._dimmer.async_set_brightness(kwargs[ATTR_BRIGHTNESS])

        else:
            await self._dimmer.async_on()

    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn light off."""
        _LOGGER.debug("Turn light '%s' off", self.name)
        await self._dimmer.async_off()

    @callback
    def async_update_callback(self) -> None:
        """Update the entity's state."""
        if self._dimmer.brightness is not None:
            # Netatmo uses a range of [0, 100] to control brightness
            self._attr_brightness = round((self._dimmer.brightness / 100) * 255)
        else:
            self._attr_brightness = None