Add Fritz sensors (#50055)

Co-authored-by: J. Nick Koston <nick@koston.org>

.coveragerc

@@ -334,6 +334,7 @@ omit =
     homeassistant/components/fritz/common.py
     homeassistant/components/fritz/const.py
     homeassistant/components/fritz/device_tracker.py
+    homeassistant/components/fritz/sensor.py
     homeassistant/components/fritzbox_callmonitor/__init__.py
     homeassistant/components/fritzbox_callmonitor/const.py
     homeassistant/components/fritzbox_callmonitor/base.py

homeassistant/components/fritz/const.py

@@ -2,7 +2,7 @@
 
 DOMAIN = "fritz"
 
-PLATFORMS = ["binary_sensor", "device_tracker"]
+PLATFORMS = ["binary_sensor", "device_tracker", "sensor"]
 
 DATA_FRITZ = "fritz_data"
 
@@ -17,3 +17,5 @@ ERROR_CONNECTION_ERROR = "connection_error"
 ERROR_UNKNOWN = "unknown_error"
 
 TRACKER_SCAN_INTERVAL = 30
+
+UPTIME_DEVIATION = 5

homeassistant/components/fritz/sensor.py

@@ -0,0 +1,141 @@
+"""AVM FRITZ!Box binary sensors."""
+from __future__ import annotations
+
+import datetime
+import logging
+
+from fritzconnection.core.exceptions import FritzConnectionException
+
+from homeassistant.components.binary_sensor import BinarySensorEntity
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import DEVICE_CLASS_TIMESTAMP
+from homeassistant.core import HomeAssistant
+from homeassistant.util.dt import utcnow
+
+from .common import FritzBoxBaseEntity, FritzBoxTools
+from .const import DOMAIN, UPTIME_DEVIATION
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def _retrieve_uptime_state(status, last_value):
+    """Return uptime from device."""
+    delta_uptime = utcnow() - datetime.timedelta(seconds=status.uptime)
+
+    if (
+        not last_value
+        or abs(
+            (delta_uptime - datetime.datetime.fromisoformat(last_value)).total_seconds()
+        )
+        > UPTIME_DEVIATION
+    ):
+        return delta_uptime.replace(microsecond=0).isoformat()
+
+    return last_value
+
+
+def _retrieve_external_ip_state(status, last_value):
+    """Return external ip from device."""
+    return status.external_ip
+
+
+SENSOR_NAME = 0
+SENSOR_DEVICE_CLASS = 1
+SENSOR_ICON = 2
+SENSOR_STATE_PROVIDER = 3
+
+# sensor_type: [name, device_class, icon, state_provider]
+SENSOR_DATA = {
+    "external_ip": [
+        "External IP",
+        None,
+        "mdi:earth",
+        _retrieve_external_ip_state,
+    ],
+    "uptime": ["Uptime", DEVICE_CLASS_TIMESTAMP, None, _retrieve_uptime_state],
+}
+
+
+async def async_setup_entry(
+    hass: HomeAssistant, entry: ConfigEntry, async_add_entities
+) -> None:
+    """Set up entry."""
+    _LOGGER.debug("Setting up FRITZ!Box sensors")
+    fritzbox_tools = hass.data[DOMAIN][entry.entry_id]
+
+    if "WANIPConn1" not in fritzbox_tools.connection.services:
+        # Only routers are supported at the moment
+        return
+
+    for sensor_type in SENSOR_DATA:
+        async_add_entities(
+            [FritzBoxSensor(fritzbox_tools, entry.title, sensor_type)],
+            True,
+        )
+
+
+class FritzBoxSensor(FritzBoxBaseEntity, BinarySensorEntity):
+    """Define FRITZ!Box connectivity class."""
+
+    def __init__(
+        self, fritzbox_tools: FritzBoxTools, device_friendlyname: str, sensor_type: str
+    ) -> None:
+        """Init FRITZ!Box connectivity class."""
+        self._sensor_data = SENSOR_DATA[sensor_type]
+        self._unique_id = f"{fritzbox_tools.unique_id}-{sensor_type}"
+        self._name = f"{device_friendlyname} {self._sensor_data[SENSOR_NAME]}"
+        self._is_available = True
+        self._last_value: str | None = None
+        self._state: str | None = None
+        super().__init__(fritzbox_tools, device_friendlyname)
+
+    @property
+    def _state_provider(self):
+        """Return the state provider for the binary sensor."""
+        return self._sensor_data[SENSOR_STATE_PROVIDER]
+
+    @property
+    def name(self):
+        """Return name."""
+        return self._name
+
+    @property
+    def device_class(self) -> str | None:
+        """Return device class."""
+        return self._sensor_data[SENSOR_DEVICE_CLASS]
+
+    @property
+    def icon(self):
+        """Return icon."""
+        return self._sensor_data[SENSOR_ICON]
+
+    @property
+    def unique_id(self):
+        """Return unique id."""
+        return self._unique_id
+
+    @property
+    def state(self) -> str | None:
+        """Return the state of the sensor."""
+        return self._state
+
+    @property
+    def available(self) -> bool:
+        """Return availability."""
+        return self._is_available
+
+    def update(self) -> None:
+        """Update data."""
+        _LOGGER.debug("Updating FRITZ!Box sensors")
+
+        try:
+            status = self._fritzbox_tools.fritzstatus
+            self._is_available = True
+
+            self._state = self._last_value = self._state_provider(
+                status, self._last_value
+            )
+
+        except FritzConnectionException:
+            _LOGGER.error("Error getting the state from the FRITZ!Box", exc_info=True)
+            self._is_available = False