"""The test for the Ecobee thermostat module.""" import copy from http import HTTPStatus from unittest import mock from unittest.mock import MagicMock import pytest from homeassistant.components import climate from homeassistant.components.climate import ClimateEntityFeature from homeassistant.components.ecobee.climate import ECOBEE_AUX_HEAT_ONLY, Thermostat import homeassistant.const as const from homeassistant.const import ATTR_ENTITY_ID, ATTR_SUPPORTED_FEATURES, STATE_OFF from homeassistant.core import HomeAssistant from tests.components.ecobee import GENERIC_THERMOSTAT_INFO_WITH_HEATPUMP from tests.components.ecobee.common import setup_platform ENTITY_ID = "climate.ecobee" @pytest.fixture def ecobee_fixture(): """Set up ecobee mock.""" vals = { "name": "Ecobee", "modelNumber": "athenaSmart", "identifier": "abc", "program": { "climates": [ {"name": "Climate1", "climateRef": "c1"}, {"name": "Climate2", "climateRef": "c2"}, ], "currentClimateRef": "c1", }, "runtime": { "connected": True, "actualTemperature": 300, "actualHumidity": 15, "desiredHeat": 400, "desiredCool": 200, "desiredFanMode": "on", }, "settings": { "hvacMode": "auto", "heatStages": 1, "coolStages": 1, "fanMinOnTime": 10, "heatCoolMinDelta": 50, "holdAction": "nextTransition", }, "equipmentStatus": "fan", "events": [ { "name": "Event1", "running": True, "type": "hold", "holdClimateRef": "away", "endDate": "2017-01-01 10:00:00", "startDate": "2017-02-02 11:00:00", } ], } mock_ecobee = mock.Mock() mock_ecobee.__getitem__ = mock.Mock(side_effect=vals.__getitem__) mock_ecobee.__setitem__ = mock.Mock(side_effect=vals.__setitem__) return mock_ecobee @pytest.fixture(name="data") def data_fixture(ecobee_fixture): """Set up data mock.""" data = mock.Mock() data.ecobee.get_thermostat.return_value = ecobee_fixture return data @pytest.fixture(name="thermostat") def thermostat_fixture(data): """Set up ecobee thermostat object.""" thermostat = data.ecobee.get_thermostat(1) return Thermostat(data, 1, thermostat) async def test_name(thermostat) -> None: """Test name property.""" assert thermostat.device_info["name"] == "Ecobee" async def test_aux_heat_not_supported_by_default(hass: HomeAssistant) -> None: """Default setup should not support Aux heat.""" await setup_platform(hass, const.Platform.CLIMATE) state = hass.states.get(ENTITY_ID) assert ( state.attributes.get(ATTR_SUPPORTED_FEATURES) == ClimateEntityFeature.PRESET_MODE | ClimateEntityFeature.FAN_MODE | ClimateEntityFeature.TARGET_HUMIDITY | ClimateEntityFeature.TARGET_TEMPERATURE_RANGE | ClimateEntityFeature.TARGET_TEMPERATURE | ClimateEntityFeature.TURN_OFF | ClimateEntityFeature.TURN_ON ) async def test_aux_heat_supported_with_heat_pump(hass: HomeAssistant) -> None: """Aux Heat should be supported if thermostat has heatpump.""" mock_get_thermostat = mock.Mock() mock_get_thermostat.return_value = GENERIC_THERMOSTAT_INFO_WITH_HEATPUMP with mock.patch("pyecobee.Ecobee.get_thermostat", mock_get_thermostat): await setup_platform(hass, const.Platform.CLIMATE) state = hass.states.get(ENTITY_ID) assert ( state.attributes.get(ATTR_SUPPORTED_FEATURES) == ClimateEntityFeature.PRESET_MODE | ClimateEntityFeature.FAN_MODE | ClimateEntityFeature.TARGET_TEMPERATURE_RANGE | ClimateEntityFeature.TARGET_TEMPERATURE | ClimateEntityFeature.AUX_HEAT | ClimateEntityFeature.TURN_OFF | ClimateEntityFeature.TURN_ON ) async def test_current_temperature(ecobee_fixture, thermostat) -> None: """Test current temperature.""" assert thermostat.current_temperature == 30 ecobee_fixture["runtime"]["actualTemperature"] = HTTPStatus.NOT_FOUND assert thermostat.current_temperature == 40.4 async def test_target_temperature_low(ecobee_fixture, thermostat) -> None: """Test target low temperature.""" assert thermostat.target_temperature_low == 40 ecobee_fixture["runtime"]["desiredHeat"] = 502 assert thermostat.target_temperature_low == 50.2 async def test_target_temperature_high(ecobee_fixture, thermostat) -> None: """Test target high temperature.""" assert thermostat.target_temperature_high == 20 ecobee_fixture["runtime"]["desiredCool"] = 679 assert thermostat.target_temperature_high == 67.9 async def test_target_temperature(ecobee_fixture, thermostat) -> None: """Test target temperature.""" assert thermostat.target_temperature is None ecobee_fixture["settings"]["hvacMode"] = "heat" assert thermostat.target_temperature == 40 ecobee_fixture["settings"]["hvacMode"] = "cool" assert thermostat.target_temperature == 20 ecobee_fixture["settings"]["hvacMode"] = "auxHeatOnly" assert thermostat.target_temperature == 40 ecobee_fixture["settings"]["hvacMode"] = "off" assert thermostat.target_temperature is None async def test_desired_fan_mode(ecobee_fixture, thermostat) -> None: """Test desired fan mode property.""" assert thermostat.fan_mode == "on" ecobee_fixture["runtime"]["desiredFanMode"] = "auto" assert thermostat.fan_mode == "auto" async def test_fan(ecobee_fixture, thermostat) -> None: """Test fan property.""" assert thermostat.fan == const.STATE_ON ecobee_fixture["equipmentStatus"] = "" assert thermostat.fan == STATE_OFF ecobee_fixture["equipmentStatus"] = "heatPump, heatPump2" assert thermostat.fan == STATE_OFF async def test_hvac_mode(ecobee_fixture, thermostat) -> None: """Test current operation property.""" assert thermostat.hvac_mode == "heat_cool" ecobee_fixture["settings"]["hvacMode"] = "heat" assert thermostat.hvac_mode == "heat" ecobee_fixture["settings"]["hvacMode"] = "cool" assert thermostat.hvac_mode == "cool" ecobee_fixture["settings"]["hvacMode"] = "auxHeatOnly" assert thermostat.hvac_mode == "heat" ecobee_fixture["settings"]["hvacMode"] = "off" assert thermostat.hvac_mode == "off" async def test_hvac_modes(thermostat) -> None: """Test operation list property.""" assert ["heat_cool", "heat", "cool", "off"] == thermostat.hvac_modes async def test_hvac_mode2(ecobee_fixture, thermostat) -> None: """Test operation mode property.""" assert thermostat.hvac_mode == "heat_cool" ecobee_fixture["settings"]["hvacMode"] = "heat" assert thermostat.hvac_mode == "heat" async def test_extra_state_attributes(ecobee_fixture, thermostat) -> None: """Test device state attributes property.""" ecobee_fixture["equipmentStatus"] = "heatPump2" assert { "fan": "off", "climate_mode": "Climate1", "fan_min_on_time": 10, "equipment_running": "heatPump2", } == thermostat.extra_state_attributes ecobee_fixture["equipmentStatus"] = "auxHeat2" assert { "fan": "off", "climate_mode": "Climate1", "fan_min_on_time": 10, "equipment_running": "auxHeat2", } == thermostat.extra_state_attributes ecobee_fixture["equipmentStatus"] = "compCool1" assert { "fan": "off", "climate_mode": "Climate1", "fan_min_on_time": 10, "equipment_running": "compCool1", } == thermostat.extra_state_attributes ecobee_fixture["equipmentStatus"] = "" assert { "fan": "off", "climate_mode": "Climate1", "fan_min_on_time": 10, "equipment_running": "", } == thermostat.extra_state_attributes ecobee_fixture["equipmentStatus"] = "Unknown" assert { "fan": "off", "climate_mode": "Climate1", "fan_min_on_time": 10, "equipment_running": "Unknown", } == thermostat.extra_state_attributes ecobee_fixture["program"]["currentClimateRef"] = "c2" assert { "fan": "off", "climate_mode": "Climate2", "fan_min_on_time": 10, "equipment_running": "Unknown", } == thermostat.extra_state_attributes async def test_is_aux_heat_on(hass: HomeAssistant) -> None: """Test aux heat property is only enabled for auxHeatOnly.""" mock_get_thermostat = mock.Mock() mock_get_thermostat.return_value = copy.deepcopy( GENERIC_THERMOSTAT_INFO_WITH_HEATPUMP ) mock_get_thermostat.return_value["settings"]["hvacMode"] = "auxHeatOnly" with mock.patch("pyecobee.Ecobee.get_thermostat", mock_get_thermostat): await setup_platform(hass, const.Platform.CLIMATE) state = hass.states.get(ENTITY_ID) assert state.attributes[climate.ATTR_AUX_HEAT] == "on" async def test_is_aux_heat_off(hass: HomeAssistant) -> None: """Test aux heat property is only enabled for auxHeatOnly.""" mock_get_thermostat = mock.Mock() mock_get_thermostat.return_value = GENERIC_THERMOSTAT_INFO_WITH_HEATPUMP with mock.patch("pyecobee.Ecobee.get_thermostat", mock_get_thermostat): await setup_platform(hass, const.Platform.CLIMATE) state = hass.states.get(ENTITY_ID) assert state.attributes[climate.ATTR_AUX_HEAT] == "off" async def test_set_temperature(ecobee_fixture, thermostat, data) -> None: """Test set temperature.""" # Auto -> Auto data.reset_mock() thermostat.set_temperature(target_temp_low=20, target_temp_high=30) data.ecobee.set_hold_temp.assert_has_calls( [mock.call(1, 30, 20, "nextTransition", None)] ) # Auto -> Hold data.reset_mock() thermostat.set_temperature(temperature=20) data.ecobee.set_hold_temp.assert_has_calls( [mock.call(1, 25, 15, "nextTransition", None)] ) # Cool -> Hold data.reset_mock() ecobee_fixture["settings"]["hvacMode"] = "cool" thermostat.set_temperature(temperature=20.5) data.ecobee.set_hold_temp.assert_has_calls( [mock.call(1, 20.5, 20.5, "nextTransition", None)] ) # Heat -> Hold data.reset_mock() ecobee_fixture["settings"]["hvacMode"] = "heat" thermostat.set_temperature(temperature=20) data.ecobee.set_hold_temp.assert_has_calls( [mock.call(1, 20, 20, "nextTransition", None)] ) # Heat -> Auto data.reset_mock() ecobee_fixture["settings"]["hvacMode"] = "heat" thermostat.set_temperature(target_temp_low=20, target_temp_high=30) assert not data.ecobee.set_hold_temp.called async def test_set_hvac_mode(thermostat, data) -> None: """Test operation mode setter.""" data.reset_mock() thermostat.set_hvac_mode("heat_cool") data.ecobee.set_hvac_mode.assert_has_calls([mock.call(1, "auto")]) data.reset_mock() thermostat.set_hvac_mode("heat") data.ecobee.set_hvac_mode.assert_has_calls([mock.call(1, "heat")]) async def test_set_fan_min_on_time(thermostat, data) -> None: """Test fan min on time setter.""" data.reset_mock() thermostat.set_fan_min_on_time(15) data.ecobee.set_fan_min_on_time.assert_has_calls([mock.call(1, 15)]) data.reset_mock() thermostat.set_fan_min_on_time(20) data.ecobee.set_fan_min_on_time.assert_has_calls([mock.call(1, 20)]) async def test_resume_program(thermostat, data) -> None: """Test resume program.""" # False data.reset_mock() thermostat.resume_program(False) data.ecobee.resume_program.assert_has_calls([mock.call(1, "false")]) data.reset_mock() thermostat.resume_program(None) data.ecobee.resume_program.assert_has_calls([mock.call(1, "false")]) data.reset_mock() thermostat.resume_program(0) data.ecobee.resume_program.assert_has_calls([mock.call(1, "false")]) # True data.reset_mock() thermostat.resume_program(True) data.ecobee.resume_program.assert_has_calls([mock.call(1, "true")]) data.reset_mock() thermostat.resume_program(1) data.ecobee.resume_program.assert_has_calls([mock.call(1, "true")]) async def test_hold_preference(ecobee_fixture, thermostat) -> None: """Test hold preference.""" ecobee_fixture["settings"]["holdAction"] = "indefinite" assert thermostat.hold_preference() == "indefinite" for action in ["useEndTime2hour", "useEndTime4hour"]: ecobee_fixture["settings"]["holdAction"] = action assert thermostat.hold_preference() == "holdHours" for action in [ "nextPeriod", "askMe", ]: ecobee_fixture["settings"]["holdAction"] = action assert thermostat.hold_preference() == "nextTransition" def test_hold_hours(ecobee_fixture, thermostat) -> None: """Test hold hours preference.""" ecobee_fixture["settings"]["holdAction"] = "useEndTime2hour" assert thermostat.hold_hours() == 2 ecobee_fixture["settings"]["holdAction"] = "useEndTime4hour" assert thermostat.hold_hours() == 4 for action in [ "nextPeriod", "indefinite", "askMe", ]: ecobee_fixture["settings"]["holdAction"] = action assert thermostat.hold_hours() is None async def test_set_fan_mode_on(thermostat, data) -> None: """Test set fan mode to on.""" data.reset_mock() thermostat.set_fan_mode("on") data.ecobee.set_fan_mode.assert_has_calls( [mock.call(1, "on", "nextTransition", holdHours=None)] ) async def test_set_fan_mode_auto(thermostat, data) -> None: """Test set fan mode to auto.""" data.reset_mock() thermostat.set_fan_mode("auto") data.ecobee.set_fan_mode.assert_has_calls( [mock.call(1, "auto", "nextTransition", holdHours=None)] ) async def test_turn_aux_heat_on(hass: HomeAssistant, mock_ecobee: MagicMock) -> None: """Test when aux heat is set on. This must change the HVAC mode.""" mock_ecobee.get_thermostat.return_value = GENERIC_THERMOSTAT_INFO_WITH_HEATPUMP mock_ecobee.thermostats = [GENERIC_THERMOSTAT_INFO_WITH_HEATPUMP] await setup_platform(hass, const.Platform.CLIMATE) await hass.services.async_call( climate.DOMAIN, climate.SERVICE_SET_AUX_HEAT, {ATTR_ENTITY_ID: ENTITY_ID, climate.ATTR_AUX_HEAT: True}, blocking=True, ) assert mock_ecobee.set_hvac_mode.call_count == 1 assert mock_ecobee.set_hvac_mode.call_args == mock.call(0, ECOBEE_AUX_HEAT_ONLY) async def test_turn_aux_heat_off(hass: HomeAssistant, mock_ecobee: MagicMock) -> None: """Test when aux heat is tuned off. Must change HVAC mode back to last used.""" mock_ecobee.get_thermostat.return_value = GENERIC_THERMOSTAT_INFO_WITH_HEATPUMP mock_ecobee.thermostats = [GENERIC_THERMOSTAT_INFO_WITH_HEATPUMP] await setup_platform(hass, const.Platform.CLIMATE) await hass.services.async_call( climate.DOMAIN, climate.SERVICE_SET_AUX_HEAT, {ATTR_ENTITY_ID: ENTITY_ID, climate.ATTR_AUX_HEAT: False}, blocking=True, ) assert mock_ecobee.set_hvac_mode.call_count == 1 assert mock_ecobee.set_hvac_mode.call_args == mock.call(0, "auto")