mirror of
https://github.com/home-assistant/core.git
synced 2025-07-19 19:27:45 +00:00
Add hydrological alert sensor to IMGW-PIB integration (#148848)
This commit is contained in:
Maciej Bieniek
GitHub
parent
fe8384719d
commit
ce4a811b96
@ -1,6 +1,9 @@
|
||||
{
|
||||
"entity": {
|
||||
"sensor": {
|
||||
"hydrological_alert": {
|
||||
"default": "mdi:alert-octagon-outline"
|
||||
},
|
||||
"water_flow": {
|
||||
"default": "mdi:waves-arrow-right"
|
||||
},
|
||||
|
||||
@ -4,7 +4,9 @@ from __future__ import annotations
|
||||
|
||||
from collections.abc import Callable
|
||||
from dataclasses import dataclass
|
||||
from typing import Any
|
||||
|
||||
from imgw_pib.const import HYDROLOGICAL_ALERTS_MAP, NO_ALERT
|
||||
from imgw_pib.model import HydrologicalData
|
||||
|
||||
from homeassistant.components.sensor import (
|
||||
@ -28,14 +30,36 @@ from .entity import ImgwPibEntity
|
||||
PARALLEL_UPDATES = 0
|
||||
|
||||
|
||||
def gen_alert_attributes(data: HydrologicalData) -> dict[str, Any] | None:
|
||||
"""Generate attributes for the alert entity."""
|
||||
if data.hydrological_alert.value == NO_ALERT:
|
||||
return None
|
||||
|
||||
return {
|
||||
"level": data.hydrological_alert.level,
|
||||
"probability": data.hydrological_alert.probability,
|
||||
"valid_from": data.hydrological_alert.valid_from,
|
||||
"valid_to": data.hydrological_alert.valid_to,
|
||||
}
|
||||
|
||||
|
||||
@dataclass(frozen=True, kw_only=True)
|
||||
class ImgwPibSensorEntityDescription(SensorEntityDescription):
|
||||
"""IMGW-PIB sensor entity description."""
|
||||
|
||||
value: Callable[[HydrologicalData], StateType]
|
||||
attrs: Callable[[HydrologicalData], dict[str, Any] | None] | None = None
|
||||
|
||||
|
||||
SENSOR_TYPES: tuple[ImgwPibSensorEntityDescription, ...] = (
|
||||
ImgwPibSensorEntityDescription(
|
||||
key="hydrological_alert",
|
||||
translation_key="hydrological_alert",
|
||||
device_class=SensorDeviceClass.ENUM,
|
||||
options=list(HYDROLOGICAL_ALERTS_MAP.values()),
|
||||
value=lambda data: data.hydrological_alert.value,
|
||||
attrs=gen_alert_attributes,
|
||||
),
|
||||
ImgwPibSensorEntityDescription(
|
||||
key="water_flow",
|
||||
translation_key="water_flow",
|
||||
@ -109,3 +133,11 @@ class ImgwPibSensorEntity(ImgwPibEntity, SensorEntity):
|
||||
def native_value(self) -> StateType:
|
||||
"""Return the value reported by the sensor."""
|
||||
return self.entity_description.value(self.coordinator.data)
|
||||
|
||||
@property
|
||||
def extra_state_attributes(self) -> dict[str, Any] | None:
|
||||
"""Return the state attributes."""
|
||||
if self.entity_description.attrs:
|
||||
return self.entity_description.attrs(self.coordinator.data)
|
||||
|
||||
return None
|
||||
|
||||
@ -21,6 +21,41 @@
|
||||
},
|
||||
"entity": {
|
||||
"sensor": {
|
||||
"hydrological_alert": {
|
||||
"name": "Hydrological alert",
|
||||
"state": {
|
||||
"no_alert": "No alert",
|
||||
"hydrological_drought": "Hydrological drought",
|
||||
"rapid_water_level_rise": "Rapid water level rise"
|
||||
},
|
||||
"state_attributes": {
|
||||
"level": {
|
||||
"name": "Level",
|
||||
"state": {
|
||||
"none": "None",
|
||||
"orange": "Orange",
|
||||
"red": "Red",
|
||||
"yellow": "Yellow"
|
||||
}
|
||||
},
|
||||
"options": {
|
||||
"state": {
|
||||
"no_alert": "[%key:component::imgw_pib::entity::sensor::hydrological_alert::state::no_alert%]",
|
||||
"hydrological_drought": "[%key:component::imgw_pib::entity::sensor::hydrological_alert::state::hydrological_drought%]",
|
||||
"rapid_water_level_rise": "[%key:component::imgw_pib::entity::sensor::hydrological_alert::state::rapid_water_level_rise%]"
|
||||
}
|
||||
},
|
||||
"probability": {
|
||||
"name": "Probability"
|
||||
},
|
||||
"valid_from": {
|
||||
"name": "Valid from"
|
||||
},
|
||||
"valid_to": {
|
||||
"name": "Valid to"
|
||||
}
|
||||
}
|
||||
},
|
||||
"water_flow": {
|
||||
"name": "Water flow"
|
||||
},
|
||||
|
||||
@ -4,7 +4,7 @@ from collections.abc import Generator
|
||||
from datetime import UTC, datetime
|
||||
from unittest.mock import AsyncMock, patch
|
||||
|
||||
from imgw_pib import NO_ALERT, Alert, HydrologicalData, SensorData
|
||||
from imgw_pib import Alert, HydrologicalData, SensorData
|
||||
import pytest
|
||||
|
||||
from homeassistant.components.imgw_pib.const import DOMAIN
|
||||
@ -25,7 +25,13 @@ HYDROLOGICAL_DATA = HydrologicalData(
|
||||
water_temperature_measurement_date=datetime(2024, 4, 27, 10, 10, tzinfo=UTC),
|
||||
water_flow=SensorData(name="Water Flow", value=123.45),
|
||||
water_flow_measurement_date=datetime(2024, 4, 27, 10, 5, tzinfo=UTC),
|
||||
hydrological_alert=Alert(value=NO_ALERT),
|
||||
hydrological_alert=Alert(
|
||||
value="rapid_water_level_rise",
|
||||
valid_from=datetime(2024, 4, 27, 7, 0, tzinfo=UTC),
|
||||
valid_to=datetime(2024, 4, 28, 11, 0, tzinfo=UTC),
|
||||
level="yellow",
|
||||
probability=80,
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
|
||||
@ -35,11 +35,11 @@
|
||||
'value': None,
|
||||
}),
|
||||
'hydrological_alert': dict({
|
||||
'level': None,
|
||||
'probability': None,
|
||||
'valid_from': None,
|
||||
'valid_to': None,
|
||||
'value': 'no_alert',
|
||||
'level': 'yellow',
|
||||
'probability': 80,
|
||||
'valid_from': '2024-04-27T07:00:00+00:00',
|
||||
'valid_to': '2024-04-28T11:00:00+00:00',
|
||||
'value': 'rapid_water_level_rise',
|
||||
}),
|
||||
'latitude': None,
|
||||
'longitude': None,
|
||||
|
||||
@ -1,4 +1,69 @@
|
||||
# serializer version: 1
|
||||
# name: test_sensor[sensor.river_name_station_name_hydrological_alert-entry]
|
||||
EntityRegistryEntrySnapshot({
|
||||
'aliases': set({
|
||||
}),
|
||||
'area_id': None,
|
||||
'capabilities': dict({
|
||||
'options': list([
|
||||
'no_alert',
|
||||
'hydrological_drought',
|
||||
'rapid_water_level_rise',
|
||||
]),
|
||||
}),
|
||||
'config_entry_id': <ANY>,
|
||||
'config_subentry_id': <ANY>,
|
||||
'device_class': None,
|
||||
'device_id': <ANY>,
|
||||
'disabled_by': None,
|
||||
'domain': 'sensor',
|
||||
'entity_category': None,
|
||||
'entity_id': 'sensor.river_name_station_name_hydrological_alert',
|
||||
'has_entity_name': True,
|
||||
'hidden_by': None,
|
||||
'icon': None,
|
||||
'id': <ANY>,
|
||||
'labels': set({
|
||||
}),
|
||||
'name': None,
|
||||
'options': dict({
|
||||
}),
|
||||
'original_device_class': <SensorDeviceClass.ENUM: 'enum'>,
|
||||
'original_icon': None,
|
||||
'original_name': 'Hydrological alert',
|
||||
'platform': 'imgw_pib',
|
||||
'previous_unique_id': None,
|
||||
'suggested_object_id': None,
|
||||
'supported_features': 0,
|
||||
'translation_key': 'hydrological_alert',
|
||||
'unique_id': '123_hydrological_alert',
|
||||
'unit_of_measurement': None,
|
||||
})
|
||||
# ---
|
||||
# name: test_sensor[sensor.river_name_station_name_hydrological_alert-state]
|
||||
StateSnapshot({
|
||||
'attributes': ReadOnlyDict({
|
||||
'attribution': 'Data provided by IMGW-PIB',
|
||||
'device_class': 'enum',
|
||||
'friendly_name': 'River Name (Station Name) Hydrological alert',
|
||||
'level': 'yellow',
|
||||
'options': list([
|
||||
'no_alert',
|
||||
'hydrological_drought',
|
||||
'rapid_water_level_rise',
|
||||
]),
|
||||
'probability': 80,
|
||||
'valid_from': datetime.datetime(2024, 4, 27, 7, 0, tzinfo=datetime.timezone.utc),
|
||||
'valid_to': datetime.datetime(2024, 4, 28, 11, 0, tzinfo=datetime.timezone.utc),
|
||||
}),
|
||||
'context': <ANY>,
|
||||
'entity_id': 'sensor.river_name_station_name_hydrological_alert',
|
||||
'last_changed': <ANY>,
|
||||
'last_reported': <ANY>,
|
||||
'last_updated': <ANY>,
|
||||
'state': 'rapid_water_level_rise',
|
||||
})
|
||||
# ---
|
||||
# name: test_sensor[sensor.river_name_station_name_water_flow-entry]
|
||||
EntityRegistryEntrySnapshot({
|
||||
'aliases': set({
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user