water_heater.py

"""Water heater entity for nibe uplink."""
from __future__ import annotations

import asyncio
import logging
from collections import OrderedDict

import aiohttp
from homeassistant.components.water_heater import (
    ENTITY_ID_FORMAT,
    STATE_ECO,
    STATE_HEAT_PUMP,
    STATE_HIGH_DEMAND,
    SUPPORT_OPERATION_MODE,
    WaterHeaterEntity,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import STATE_OFF, TEMP_CELSIUS
from homeassistant.core import HomeAssistant
from nibeuplink import get_active_hotwater
from nibeuplink.types import HotWaterSystem

from . import NibeData, NibeSystem
from .const import DATA_NIBE_ENTRIES
from .const import DOMAIN as DOMAIN_NIBE
from .entity import NibeEntity

PARALLEL_UPDATES = 0
_LOGGER = logging.getLogger(__name__)

OPERATION_AUTO = "auto"
OPERATION_BOOST_ONE_TIME = "boost_one_time"
OPERATION_BOOST_THREE_HOURS = "boost_three_hours"
OPERATION_BOOST_SIX_HOUR = "boost_six_hours"
OPERATION_BOOST_TWELVE_HOURS = "boost_twelve_hours"

NIBE_STATE_TO_HA = {
    "economy": {
        "state": STATE_ECO,
        "start": "start_temperature_water_economy",
        "stop": "stop_temperature_water_economy",
    },
    "normal": {
        "state": STATE_HEAT_PUMP,
        "start": "start_temperature_water_normal",
        "stop": "stop_temperature_water_normal",
    },
    "luxuary": {
        "state": STATE_HIGH_DEMAND,
        "start": "start_temperature_water_luxary",
        "stop": "stop_temperature_water_luxary",
    },
}

NIBE_BOOST_TO_OPERATION = {
    0: OPERATION_AUTO,
    1: OPERATION_BOOST_THREE_HOURS,
    2: OPERATION_BOOST_SIX_HOUR,
    3: OPERATION_BOOST_TWELVE_HOURS,
    4: OPERATION_BOOST_ONE_TIME,
}

HA_BOOST_TO_NIBE = {v: k for k, v in NIBE_BOOST_TO_OPERATION.items()}


async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities
):
    """Set up the climate device based on a config entry."""
    data: NibeData = hass.data[DATA_NIBE_ENTRIES][entry.entry_id]
    uplink = data.uplink
    systems = data.systems

    entities = []

    async def add_active(system: NibeSystem):
        hwsyses = await get_active_hotwater(uplink, system.system_id)
        for hwsys in hwsyses.values():
            entities.append(NibeWaterHeater(system, hwsys))

    await asyncio.gather(*[add_active(system) for system in systems.values()])

    async_add_entities(entities, True)


class NibeWaterHeater(NibeEntity, WaterHeaterEntity):
    """Water heater entity."""

    def __init__(self, system: NibeSystem, hwsys: HotWaterSystem):
        """Init."""
        parameters = {
            hwsys.hot_water_charging,
            hwsys.hot_water_comfort_mode,
            hwsys.hot_water_top,
            hwsys.start_temperature_water_economy,
            hwsys.start_temperature_water_normal,
            hwsys.start_temperature_water_luxary,
            hwsys.stop_temperature_water_economy,
            hwsys.stop_temperature_water_normal,
            hwsys.stop_temperature_water_luxary,
            hwsys.hot_water_boost,
        }
        super().__init__(system, parameters)

        self._attr_name = hwsys.name
        self._attr_current_operation = STATE_OFF
        self._attr_unique_id = "{}_{}_{}".format(
            system.system_id,
            hwsys.hot_water_charging,
            hwsys.hot_water_production,
        )
        self._attr_supported_features = SUPPORT_OPERATION_MODE
        self._attr_operation_list = list(NIBE_BOOST_TO_OPERATION.values())
        self._current_state = STATE_OFF
        self._hwsys = hwsys

        self.entity_id = ENTITY_ID_FORMAT.format(f"{DOMAIN_NIBE}_{hwsys.name}")

        self.parse_data()

    @property
    def temperature_unit(self):
        """Return temperature unit."""
        return self.get_unit(self._hwsys.hot_water_charging, TEMP_CELSIUS)

    @property
    def extra_state_attributes(self):
        """Return extra state attributes."""
        data = OrderedDict()
        data["current_temperature"] = self.current_temperature
        data["target_temp_low"] = self.target_temperature_low
        data["target_temp_high"] = self.target_temperature_high
        return data

    @property
    def available(self):
        """Return if entity is available."""
        value = self.get_value(self._hwsys.hot_water_charging)
        return value is not None

    @property
    def is_on(self):
        """Is the entity on."""
        return self._is_on

    @property
    def state(self):
        """Return the current state."""
        if self._is_on:
            return self._current_state
        else:
            return STATE_OFF

    @property
    def current_temperature(self):
        """Returrn current temperature."""
        return self.get_float(self._hwsys.hot_water_charging)

    def get_float_named(self, name):
        """Return a float attribute for system."""
        parameter_id = getattr(self._hwsys, name, None)
        return self.get_float(parameter_id)

    def get_float_operation(self, name):
        """Return a float based on operation mode."""
        if self._attr_current_operation == OPERATION_AUTO:
            mode = self.get_value(self._hwsys.hot_water_comfort_mode)
        else:
            mode = "luxuary"
        if mode in NIBE_STATE_TO_HA:
            return self.get_float_named(NIBE_STATE_TO_HA[mode][name])
        else:
            return None

    @property
    def target_temperature_high(self):
        """Return the target high temperature."""
        return self.get_float_operation("stop")

    @property
    def target_temperature_low(self):
        """Return the target low temperature."""
        return self.get_float_operation("start")

    async def async_set_operation_mode(self, operation_mode):
        """Set new target operation mode."""
        if operation_mode == OPERATION_BOOST_ONE_TIME:
            boost = 1
        elif operation_mode == OPERATION_AUTO:
            boost = 0
        else:
            raise Exception(
                f"Operation mode {operation_mode} not supported in nibe api"
            )

        try:
            await self._uplink.put_parameter(
                self._system_id,
                self._hwsys.hot_water_boost,
                boost,
            )
        except aiohttp.client_exceptions.ClientResponseError as e:
            raise Exception(f"Failed to set hot water boost to {boost}") from e

    def parse_data(self):
        """Parse data values."""
        super().parse_data()

        if "Hot Water" in self._system.statuses:
            self._is_on = True
        else:
            self._is_on = False

        mode = self.get_value(self._hwsys.hot_water_comfort_mode)
        if mode in NIBE_STATE_TO_HA:
            self._current_state = NIBE_STATE_TO_HA[mode]["state"]
        else:
            self._current_state = STATE_OFF

        boost = self.get_raw(self._hwsys.hot_water_boost)
        if boost in NIBE_BOOST_TO_OPERATION:
            self._attr_current_operation = NIBE_BOOST_TO_OPERATION[boost]
        else:
            self._attr_current_operation = None