Skip to content

Fix rain count sensors' state class of Ecowitt #158204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joostlek merged 9 commits into from
Jan 5, 2026
Merged

Fix rain count sensors' state class of Ecowitt #158204

Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4943275
Revert "Fix state classes of Ecowitt rain sensors (#157409)"
upsuper Dec 7, 2025
ed20026
Revert "Remove state class for rolling window in ecowitt (#155812)"
upsuper Dec 7, 2025
0bb5c1d
Revert "Change rain count state_class to 'Total' (ecowitt) (#155358)"
upsuper Dec 7, 2025
5f3040a
Fix rain count sensors' state class of Ecowitt
upsuper Dec 7, 2025
000c9ff
fix fmt
upsuper Dec 7, 2025
c5755e7
address review comments
upsuper Dec 8, 2025
620e29c
Merge branch 'dev' into ecowitt-rain-state-class
upsuper Dec 10, 2025
5d8a17c
use comprehensive list
upsuper Dec 10, 2025
a825a5c
Merge branch 'dev' into ecowitt-rain-state-class
upsuper Dec 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions homeassistant/components/ecowitt/sensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

import dataclasses
from datetime import datetime
import re
from typing import Final

from aioecowitt import EcoWittSensor, EcoWittSensorTypes
Expand Down Expand Up @@ -57,6 +58,12 @@
)


# Hourly and 24h rain count sensors are rolling window sensors
_ROLLING_WINDOW_RAIN_COUNT_SENSOR = re.compile(
"(?:hourly|last24h)rain(?:in|mm)|(?:last24)?hrain_piezo(?:mm)?"
)


ECOWITT_SENSORS_MAPPING: Final = {
EcoWittSensorTypes.HUMIDITY: SensorEntityDescription(
key="HUMIDITY",
Expand Down Expand Up @@ -151,12 +158,14 @@
key="RAIN_COUNT_MM",
native_unit_of_measurement=UnitOfPrecipitationDepth.MILLIMETERS,
device_class=SensorDeviceClass.PRECIPITATION,
state_class=SensorStateClass.TOTAL_INCREASING,
suggested_display_precision=1,
),
EcoWittSensorTypes.RAIN_COUNT_INCHES: SensorEntityDescription(
key="RAIN_COUNT_INCHES",
native_unit_of_measurement=UnitOfPrecipitationDepth.INCHES,
device_class=SensorDeviceClass.PRECIPITATION,
state_class=SensorStateClass.TOTAL_INCREASING,
suggested_display_precision=2,
),
EcoWittSensorTypes.RAIN_RATE_MM: SensorEntityDescription(
Expand Down Expand Up @@ -285,14 +294,11 @@ def _new_sensor(sensor: EcoWittSensor) -> None:
name=sensor.name,
)

# Only total rain needs state class for long-term statistics
if sensor.key in (
"totalrainin",
"totalrainmm",
):
# Rolling window sensors must use measurement state classes
if _ROLLING_WINDOW_RAIN_COUNT_SENSOR.fullmatch(sensor.key):
description = dataclasses.replace(
description,
state_class=SensorStateClass.TOTAL_INCREASING,
state_class=SensorStateClass.MEASUREMENT,
)

Copy link

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This logic for detecting and overriding state classes for rolling window sensors lacks test coverage. Given the critical nature of state class assignments for long-term statistics (as mentioned in the PR description), tests should be added to verify:

  1. Rolling window sensors (matching the regex) correctly get MEASUREMENT state class
  2. Non-rolling window rain count sensors correctly retain TOTAL_INCREASING state class
  3. The regex pattern matches all expected sensor key formats (hourlyrainmm, hourlyrainin, last24hrainmm, last24hrainin, hrain_piezo variants, etc.)

Consider adding tests in tests/components/ecowitt/test_sensor.py following the Home Assistant testing patterns with fixtures and snapshots.

Copilot uses AI. Check for mistakes.
Copy link
Contributor

@epenet epenet Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For sure ecowitt tests are extremely limited!
I strongly suggest to add snapshot tests (maybe in a preliminary PR?) to ensure this is properly tested and follow-up PRs do not accidentaly mess it up.

async_add_entities([EcowittSensorEntity(sensor, description)])
Expand Down
Loading