Add sensor platform to Bring integration (#126642)

* Add sensor platform to Bring integration * Add more tests * unignore typedef check * Update language sensor * update snapshot * changes * add entities Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com> * add units * lowercase * snapshot --------- Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
2025-11-09 19:09:32 +00:00 · 2024-09-24 22:55:48 +02:00
parent c66e2dc076
commit 20030ab604
17 changed files with 910 additions and 9 deletions
--- a/homeassistant/components/bring/sensor.py
+++ b/homeassistant/components/bring/sensor.py
@@ -0,0 +1,121 @@
+"""Sensor platform for the Bring! integration."""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+from dataclasses import dataclass
+from enum import StrEnum
+
+from bring_api import BringUserSettingsResponse
+from bring_api.const import BRING_SUPPORTED_LOCALES
+
+from homeassistant.components.sensor import (
+    SensorDeviceClass,
+    SensorEntity,
+    SensorEntityDescription,
+)
+from homeassistant.const import EntityCategory
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+from homeassistant.helpers.typing import StateType
+
+from . import BringConfigEntry
+from .const import UNIT_ITEMS
+from .coordinator import BringData, BringDataUpdateCoordinator
+from .entity import BringBaseEntity
+from .util import list_language, sum_attributes
+
+
+@dataclass(kw_only=True, frozen=True)
+class BringSensorEntityDescription(SensorEntityDescription):
+    """Bring Sensor Description."""
+
+    value_fn: Callable[[BringData, BringUserSettingsResponse], StateType]
+
+
+class BringSensor(StrEnum):
+    """Bring sensors."""
+
+    URGENT = "urgent"
+    CONVENIENT = "convenient"
+    DISCOUNTED = "discounted"
+    LIST_LANGUAGE = "list_language"
+
+
+SENSOR_DESCRIPTIONS: tuple[BringSensorEntityDescription, ...] = (
+    BringSensorEntityDescription(
+        key=BringSensor.URGENT,
+        translation_key=BringSensor.URGENT,
+        value_fn=lambda lst, _: sum_attributes(lst, "urgent"),
+        native_unit_of_measurement=UNIT_ITEMS,
+    ),
+    BringSensorEntityDescription(
+        key=BringSensor.CONVENIENT,
+        translation_key=BringSensor.CONVENIENT,
+        value_fn=lambda lst, _: sum_attributes(lst, "convenient"),
+        native_unit_of_measurement=UNIT_ITEMS,
+    ),
+    BringSensorEntityDescription(
+        key=BringSensor.DISCOUNTED,
+        translation_key=BringSensor.DISCOUNTED,
+        value_fn=lambda lst, _: sum_attributes(lst, "discounted"),
+        native_unit_of_measurement=UNIT_ITEMS,
+    ),
+    BringSensorEntityDescription(
+        key=BringSensor.LIST_LANGUAGE,
+        translation_key=BringSensor.LIST_LANGUAGE,
+        value_fn=(
+            lambda lst, settings: x.lower()
+            if (x := list_language(lst["listUuid"], settings))
+            else None
+        ),
+        entity_category=EntityCategory.DIAGNOSTIC,
+        options=[x.lower() for x in BRING_SUPPORTED_LOCALES],
+        device_class=SensorDeviceClass.ENUM,
+    ),
+)
+
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    config_entry: BringConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Set up the sensor platform."""
+    coordinator = config_entry.runtime_data
+
+    async_add_entities(
+        BringSensorEntity(
+            coordinator,
+            bring_list,
+            description,
+        )
+        for description in SENSOR_DESCRIPTIONS
+        for bring_list in coordinator.data.values()
+    )
+
+
+class BringSensorEntity(BringBaseEntity, SensorEntity):
+    """A sensor entity."""
+
+    entity_description: BringSensorEntityDescription
+
+    def __init__(
+        self,
+        coordinator: BringDataUpdateCoordinator,
+        bring_list: BringData,
+        entity_description: BringSensorEntityDescription,
+    ) -> None:
+        """Initialize the entity."""
+        super().__init__(coordinator, bring_list)
+        self.entity_description = entity_description
+        self._attr_unique_id = f"{coordinator.config_entry.unique_id}_{self._list_uuid}_{self.entity_description.key}"
+
+    @property
+    def native_value(self) -> StateType:
+        """Return the state of the sensor."""
+
+        return self.entity_description.value_fn(
+            self.coordinator.data[self._list_uuid],
+            self.coordinator.user_settings,
+        )