From 81c77942ebe5977c542f1a1f383e3776694c451c Mon Sep 17 00:00:00 2001 From: Diogo Gomes Date: Wed, 13 Jan 2021 15:42:28 +0000 Subject: [PATCH] Update the Utility Meter sensor status on HA start (#44765) * fix status on HA start * better coverage and fix * fix test * address review --- .../components/utility_meter/sensor.py | 21 +++-- tests/components/utility_meter/test_sensor.py | 89 ++++++++++++++++++- 2 files changed, 101 insertions(+), 9 deletions(-) diff --git a/homeassistant/components/utility_meter/sensor.py b/homeassistant/components/utility_meter/sensor.py index 6b25ec7d123..e8d551ba280 100644 --- a/homeassistant/components/utility_meter/sensor.py +++ b/homeassistant/components/utility_meter/sensor.py @@ -169,7 +169,11 @@ class UtilityMeterSensor(RestoreEntity): new_state = event.data.get("new_state") if new_state is None: return - if self._tariff == new_state.state: + + self._change_status(new_state.state) + + def _change_status(self, tariff): + if self._tariff == tariff: self._collecting = async_track_state_change_event( self.hass, [self._sensor_source_id], self.async_reading ) @@ -271,25 +275,26 @@ class UtilityMeterSensor(RestoreEntity): self._last_reset = dt_util.parse_datetime( state.attributes.get(ATTR_LAST_RESET) ) - self.async_write_ha_state() - if state.attributes.get(ATTR_STATUS) == PAUSED: - # Fake cancellation function to init the meter paused + if state.attributes.get(ATTR_STATUS) == COLLECTING: + # Fake cancellation function to init the meter in similar state self._collecting = lambda: None @callback def async_source_tracking(event): """Wait for source to be ready, then start meter.""" if self._tariff_entity is not None: - _LOGGER.debug("Track %s", self._tariff_entity) + _LOGGER.debug( + "<%s> tracks utility meter %s", self.name, self._tariff_entity + ) async_track_state_change_event( self.hass, [self._tariff_entity], self.async_tariff_change ) tariff_entity_state = self.hass.states.get(self._tariff_entity) - if self._tariff != tariff_entity_state.state: - return + self._change_status(tariff_entity_state.state) + return - _LOGGER.debug("tracking source: %s", self._sensor_source_id) + _LOGGER.debug("<%s> collecting from %s", self.name, self._sensor_source_id) self._collecting = async_track_state_change_event( self.hass, [self._sensor_source_id], self.async_reading ) diff --git a/tests/components/utility_meter/test_sensor.py b/tests/components/utility_meter/test_sensor.py index bd34238592c..24938b1e818 100644 --- a/tests/components/utility_meter/test_sensor.py +++ b/tests/components/utility_meter/test_sensor.py @@ -11,16 +11,23 @@ from homeassistant.components.utility_meter.const import ( SERVICE_CALIBRATE_METER, SERVICE_SELECT_TARIFF, ) +from homeassistant.components.utility_meter.sensor import ( + ATTR_LAST_RESET, + ATTR_STATUS, + COLLECTING, + PAUSED, +) from homeassistant.const import ( ATTR_ENTITY_ID, ATTR_UNIT_OF_MEASUREMENT, ENERGY_KILO_WATT_HOUR, EVENT_HOMEASSISTANT_START, ) +from homeassistant.core import State from homeassistant.setup import async_setup_component import homeassistant.util.dt as dt_util -from tests.common import async_fire_time_changed +from tests.common import async_fire_time_changed, mock_restore_cache @contextmanager @@ -55,6 +62,21 @@ async def test_state(hass): ) await hass.async_block_till_done() + state = hass.states.get("sensor.energy_bill_onpeak") + assert state is not None + assert state.state == "0" + assert state.attributes.get("status") == COLLECTING + + state = hass.states.get("sensor.energy_bill_midpeak") + assert state is not None + assert state.state == "0" + assert state.attributes.get("status") == PAUSED + + state = hass.states.get("sensor.energy_bill_offpeak") + assert state is not None + assert state.state == "0" + assert state.attributes.get("status") == PAUSED + now = dt_util.utcnow() + timedelta(seconds=10) with patch("homeassistant.util.dt.utcnow", return_value=now): hass.states.async_set( @@ -68,14 +90,17 @@ async def test_state(hass): state = hass.states.get("sensor.energy_bill_onpeak") assert state is not None assert state.state == "1" + assert state.attributes.get("status") == COLLECTING state = hass.states.get("sensor.energy_bill_midpeak") assert state is not None assert state.state == "0" + assert state.attributes.get("status") == PAUSED state = hass.states.get("sensor.energy_bill_offpeak") assert state is not None assert state.state == "0" + assert state.attributes.get("status") == PAUSED await hass.services.async_call( DOMAIN, @@ -99,14 +124,17 @@ async def test_state(hass): state = hass.states.get("sensor.energy_bill_onpeak") assert state is not None assert state.state == "1" + assert state.attributes.get("status") == PAUSED state = hass.states.get("sensor.energy_bill_midpeak") assert state is not None assert state.state == "0" + assert state.attributes.get("status") == PAUSED state = hass.states.get("sensor.energy_bill_offpeak") assert state is not None assert state.state == "3" + assert state.attributes.get("status") == COLLECTING await hass.services.async_call( DOMAIN, @@ -131,6 +159,65 @@ async def test_state(hass): assert state.state == "0.123" +async def test_restore_state(hass): + """Test utility sensor restore state.""" + config = { + "utility_meter": { + "energy_bill": { + "source": "sensor.energy", + "tariffs": ["onpeak", "midpeak", "offpeak"], + } + } + } + mock_restore_cache( + hass, + [ + State( + "sensor.energy_bill_onpeak", + "3", + attributes={ + ATTR_STATUS: PAUSED, + ATTR_LAST_RESET: "2020-12-21T00:00:00.013073+00:00", + }, + ), + State( + "sensor.energy_bill_offpeak", + "6", + attributes={ + ATTR_STATUS: COLLECTING, + ATTR_LAST_RESET: "2020-12-21T00:00:00.013073+00:00", + }, + ), + ], + ) + + assert await async_setup_component(hass, DOMAIN, config) + assert await async_setup_component(hass, SENSOR_DOMAIN, config) + await hass.async_block_till_done() + + # restore from cache + state = hass.states.get("sensor.energy_bill_onpeak") + assert state.state == "3" + assert state.attributes.get("status") == PAUSED + + state = hass.states.get("sensor.energy_bill_offpeak") + assert state.state == "6" + assert state.attributes.get("status") == COLLECTING + + # utility_meter is loaded, now set sensors according to utility_meter: + hass.bus.async_fire(EVENT_HOMEASSISTANT_START) + await hass.async_block_till_done() + + state = hass.states.get("utility_meter.energy_bill") + assert state.state == "onpeak" + + state = hass.states.get("sensor.energy_bill_onpeak") + assert state.attributes.get("status") == COLLECTING + + state = hass.states.get("sensor.energy_bill_offpeak") + assert state.attributes.get("status") == PAUSED + + async def test_net_consumption(hass): """Test utility sensor state.""" config = {