From 5b0d8eb75e3eed0177ae6d4e3ee34c5333529b32 Mon Sep 17 00:00:00 2001
From: Lennard Beers <l.beers@outlook.de>
Date: Fri, 15 Nov 2024 19:03:37 +0100
Subject: [PATCH] Add sensor platform to eq3btsmart (#130438)

---
 .../components/eq3btsmart/__init__.py         |  1 +
 homeassistant/components/eq3btsmart/const.py  |  2 +
 .../components/eq3btsmart/icons.json          | 10 ++-
 homeassistant/components/eq3btsmart/sensor.py | 84 +++++++++++++++++++
 .../components/eq3btsmart/strings.json        |  8 ++
 5 files changed, 104 insertions(+), 1 deletion(-)
 create mode 100644 homeassistant/components/eq3btsmart/sensor.py

diff --git a/homeassistant/components/eq3btsmart/__init__.py b/homeassistant/components/eq3btsmart/__init__.py
index 84b27161edd..4493f944db3 100644
--- a/homeassistant/components/eq3btsmart/__init__.py
+++ b/homeassistant/components/eq3btsmart/__init__.py
@@ -22,6 +22,7 @@ PLATFORMS = [
     Platform.BINARY_SENSOR,
     Platform.CLIMATE,
     Platform.NUMBER,
+    Platform.SENSOR,
     Platform.SWITCH,
 ]
 
diff --git a/homeassistant/components/eq3btsmart/const.py b/homeassistant/components/eq3btsmart/const.py
index 78292940e60..a5f7ea2ff95 100644
--- a/homeassistant/components/eq3btsmart/const.py
+++ b/homeassistant/components/eq3btsmart/const.py
@@ -29,6 +29,8 @@ ENTITY_KEY_ECO = "eco"
 ENTITY_KEY_OFFSET = "offset"
 ENTITY_KEY_WINDOW_OPEN_TEMPERATURE = "window_open_temperature"
 ENTITY_KEY_WINDOW_OPEN_TIMEOUT = "window_open_timeout"
+ENTITY_KEY_VALVE = "valve"
+ENTITY_KEY_AWAY_UNTIL = "away_until"
 
 GET_DEVICE_TIMEOUT = 5  # seconds
 
diff --git a/homeassistant/components/eq3btsmart/icons.json b/homeassistant/components/eq3btsmart/icons.json
index e6eb7532f37..892352c2ea4 100644
--- a/homeassistant/components/eq3btsmart/icons.json
+++ b/homeassistant/components/eq3btsmart/icons.json
@@ -25,11 +25,19 @@
         "default": "mdi:timer-refresh"
       }
     },
+    "sensor": {
+      "away_until": {
+        "default": "mdi:home-export-outline"
+      },
+      "valve": {
+        "default": "mdi:pipe-valve"
+      }
+    },
     "switch": {
       "away": {
         "default": "mdi:home-account",
         "state": {
-          "on": "mdi:home-export"
+          "on": "mdi:home-export-outline"
         }
       },
       "lock": {
diff --git a/homeassistant/components/eq3btsmart/sensor.py b/homeassistant/components/eq3btsmart/sensor.py
new file mode 100644
index 00000000000..bd2605042f4
--- /dev/null
+++ b/homeassistant/components/eq3btsmart/sensor.py
@@ -0,0 +1,84 @@
+"""Platform for eq3 sensor entities."""
+
+from collections.abc import Callable
+from dataclasses import dataclass
+from datetime import datetime
+from typing import TYPE_CHECKING
+
+from eq3btsmart.models import Status
+
+from homeassistant.components.sensor import (
+    SensorDeviceClass,
+    SensorEntity,
+    SensorEntityDescription,
+)
+from homeassistant.components.sensor.const import SensorStateClass
+from homeassistant.const import PERCENTAGE
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+
+from . import Eq3ConfigEntry
+from .const import ENTITY_KEY_AWAY_UNTIL, ENTITY_KEY_VALVE
+from .entity import Eq3Entity
+
+
+@dataclass(frozen=True, kw_only=True)
+class Eq3SensorEntityDescription(SensorEntityDescription):
+    """Entity description for eq3 sensor entities."""
+
+    value_func: Callable[[Status], int | datetime | None]
+
+
+SENSOR_ENTITY_DESCRIPTIONS = [
+    Eq3SensorEntityDescription(
+        key=ENTITY_KEY_VALVE,
+        translation_key=ENTITY_KEY_VALVE,
+        value_func=lambda status: status.valve,
+        native_unit_of_measurement=PERCENTAGE,
+        state_class=SensorStateClass.MEASUREMENT,
+    ),
+    Eq3SensorEntityDescription(
+        key=ENTITY_KEY_AWAY_UNTIL,
+        translation_key=ENTITY_KEY_AWAY_UNTIL,
+        value_func=lambda status: (
+            status.away_until.value if status.away_until else None
+        ),
+        device_class=SensorDeviceClass.DATE,
+    ),
+]
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    entry: Eq3ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Set up the entry."""
+
+    async_add_entities(
+        Eq3SensorEntity(entry, entity_description)
+        for entity_description in SENSOR_ENTITY_DESCRIPTIONS
+    )
+
+
+class Eq3SensorEntity(Eq3Entity, SensorEntity):
+    """Base class for eq3 sensor entities."""
+
+    entity_description: Eq3SensorEntityDescription
+
+    def __init__(
+        self, entry: Eq3ConfigEntry, entity_description: Eq3SensorEntityDescription
+    ) -> None:
+        """Initialize the entity."""
+
+        super().__init__(entry, entity_description.key)
+        self.entity_description = entity_description
+
+    @property
+    def native_value(self) -> int | datetime | None:
+        """Return the value reported by the sensor."""
+
+        if TYPE_CHECKING:
+            assert self._thermostat.status is not None
+
+        return self.entity_description.value_func(self._thermostat.status)
diff --git a/homeassistant/components/eq3btsmart/strings.json b/homeassistant/components/eq3btsmart/strings.json
index acfd5082f45..ab363f4d752 100644
--- a/homeassistant/components/eq3btsmart/strings.json
+++ b/homeassistant/components/eq3btsmart/strings.json
@@ -42,6 +42,14 @@
         "name": "Window open timeout"
       }
     },
+    "sensor": {
+      "away_until": {
+        "name": "Away until"
+      },
+      "valve": {
+        "name": "Valve"
+      }
+    },
     "switch": {
       "lock": {
         "name": "Lock"