diff --git a/homeassistant/components/fan/significant_change.py b/homeassistant/components/fan/significant_change.py new file mode 100644 index 00000000000..19c43522f35 --- /dev/null +++ b/homeassistant/components/fan/significant_change.py @@ -0,0 +1,55 @@ +"""Helper to test significant Fan state changes.""" +from __future__ import annotations + +from typing import Any + +from homeassistant.core import HomeAssistant, callback +from homeassistant.helpers.significant_change import ( + check_absolute_change, + check_valid_float, +) + +from . import ATTR_PERCENTAGE, ATTR_PERCENTAGE_STEP + +INSIGNIFICANT_ATTRIBUTES: set[str] = {ATTR_PERCENTAGE_STEP} + + +@callback +def async_check_significant_change( + hass: HomeAssistant, + old_state: str, + old_attrs: dict, + new_state: str, + new_attrs: dict, + **kwargs: Any, +) -> bool | None: + """Test if state significantly changed.""" + if old_state != new_state: + return True + + old_attrs_s = set(old_attrs.items()) + new_attrs_s = set(new_attrs.items()) + changed_attrs: set[str] = {item[0] for item in old_attrs_s ^ new_attrs_s} + + for attr_name in changed_attrs: + if attr_name in INSIGNIFICANT_ATTRIBUTES: + continue + + if attr_name != ATTR_PERCENTAGE: + return True + + old_attr_value = old_attrs.get(attr_name) + new_attr_value = new_attrs.get(attr_name) + if new_attr_value is None or not check_valid_float(new_attr_value): + # New attribute value is invalid, ignore it + continue + + if old_attr_value is None or not check_valid_float(old_attr_value): + # Old attribute value was invalid, we should report again + return True + + if check_absolute_change(old_attr_value, new_attr_value, 1.0): + return True + + # no significant attribute change detected + return False diff --git a/tests/components/fan/test_significant_change.py b/tests/components/fan/test_significant_change.py new file mode 100644 index 00000000000..764abb6e8ee --- /dev/null +++ b/tests/components/fan/test_significant_change.py @@ -0,0 +1,51 @@ +"""Test the Fan significant change platform.""" +import pytest + +from homeassistant.components.fan import ( + ATTR_DIRECTION, + ATTR_OSCILLATING, + ATTR_PERCENTAGE, + ATTR_PERCENTAGE_STEP, + ATTR_PRESET_MODE, +) +from homeassistant.components.fan.significant_change import ( + async_check_significant_change, +) + + +async def test_significant_state_change() -> None: + """Detect Fan significant state changes.""" + attrs = {} + assert not async_check_significant_change(None, "on", attrs, "on", attrs) + assert async_check_significant_change(None, "on", attrs, "off", attrs) + + +@pytest.mark.parametrize( + ("old_attrs", "new_attrs", "expected_result"), + [ + ({ATTR_PERCENTAGE_STEP: "1"}, {ATTR_PERCENTAGE_STEP: "2"}, False), + ({ATTR_PERCENTAGE: 1}, {ATTR_PERCENTAGE: 2}, True), + ({ATTR_PERCENTAGE: 1}, {ATTR_PERCENTAGE: 1.9}, False), + ({ATTR_PERCENTAGE: "invalid"}, {ATTR_PERCENTAGE: 1}, True), + ({ATTR_PERCENTAGE: 1}, {ATTR_PERCENTAGE: "invalid"}, False), + ({ATTR_DIRECTION: "front"}, {ATTR_DIRECTION: "front"}, False), + ({ATTR_DIRECTION: "front"}, {ATTR_DIRECTION: "back"}, True), + ({ATTR_OSCILLATING: True}, {ATTR_OSCILLATING: True}, False), + ({ATTR_OSCILLATING: True}, {ATTR_OSCILLATING: False}, True), + ({ATTR_PRESET_MODE: "auto"}, {ATTR_PRESET_MODE: "auto"}, False), + ({ATTR_PRESET_MODE: "auto"}, {ATTR_PRESET_MODE: "whoosh"}, True), + ( + {ATTR_PRESET_MODE: "auto", ATTR_OSCILLATING: True}, + {ATTR_PRESET_MODE: "auto", ATTR_OSCILLATING: False}, + True, + ), + ], +) +async def test_significant_atributes_change( + old_attrs: dict, new_attrs: dict, expected_result: bool +) -> None: + """Detect Fan significant attribute changes.""" + assert ( + async_check_significant_change(None, "state", old_attrs, "state", new_attrs) + == expected_result + )