From 94acda2a31f7a0470f86b716d6e8c2c76aadee87 Mon Sep 17 00:00:00 2001 From: Matthew Treinish Date: Wed, 3 Aug 2016 00:56:08 -0400 Subject: [PATCH] Add AC mode to heat_control component (#2719) This commit adds a new option to the heat_control component, ac_mode. When set to true, this treats the toggle device as a cooler instead of a heater. The concept being if you have a window or in-wall ac unit that doesn't have a built-in thermostat having the home assistant implemented thermostat would be as useful as for space heaters. --- .../components/thermostat/heat_control.py | 47 +++++++--- .../thermostat/test_heat_control.py | 90 +++++++++++++++++++ 2 files changed, 123 insertions(+), 14 deletions(-) diff --git a/homeassistant/components/thermostat/heat_control.py b/homeassistant/components/thermostat/heat_control.py index 3d5190bcc2f..831f1dd41b9 100644 --- a/homeassistant/components/thermostat/heat_control.py +++ b/homeassistant/components/thermostat/heat_control.py @@ -11,7 +11,7 @@ import homeassistant.helpers.config_validation as cv import homeassistant.util as util from homeassistant.components import switch from homeassistant.components.thermostat import ( - STATE_HEAT, STATE_IDLE, ThermostatDevice) + STATE_HEAT, STATE_COOL, STATE_IDLE, ThermostatDevice) from homeassistant.const import ( ATTR_UNIT_OF_MEASUREMENT, TEMP_CELSIUS, TEMP_FAHRENHEIT) from homeassistant.helpers.event import track_state_change @@ -27,6 +27,7 @@ CONF_SENSOR = 'target_sensor' CONF_MIN_TEMP = 'min_temp' CONF_MAX_TEMP = 'max_temp' CONF_TARGET_TEMP = 'target_temp' +CONF_AC_MODE = 'ac_mode' _LOGGER = logging.getLogger(__name__) @@ -38,6 +39,7 @@ PLATFORM_SCHEMA = vol.Schema({ vol.Optional(CONF_MIN_TEMP): vol.Coerce(float), vol.Optional(CONF_MAX_TEMP): vol.Coerce(float), vol.Optional(CONF_TARGET_TEMP): vol.Coerce(float), + vol.Optional(CONF_AC_MODE): vol.Coerce(bool), }) @@ -49,9 +51,10 @@ def setup_platform(hass, config, add_devices, discovery_info=None): min_temp = config.get(CONF_MIN_TEMP) max_temp = config.get(CONF_MAX_TEMP) target_temp = config.get(CONF_TARGET_TEMP) + ac_mode = config.get(CONF_AC_MODE) add_devices([HeatControl(hass, name, heater_entity_id, sensor_entity_id, - min_temp, max_temp, target_temp)]) + min_temp, max_temp, target_temp, ac_mode)]) # pylint: disable=too-many-instance-attributes, abstract-method @@ -60,11 +63,12 @@ class HeatControl(ThermostatDevice): # pylint: disable=too-many-arguments def __init__(self, hass, name, heater_entity_id, sensor_entity_id, - min_temp, max_temp, target_temp): + min_temp, max_temp, target_temp, ac_mode): """Initialize the thermostat.""" self.hass = hass self._name = name self.heater_entity_id = heater_entity_id + self.ac_mode = ac_mode self._active = False self._cur_temp = None @@ -102,7 +106,12 @@ class HeatControl(ThermostatDevice): @property def operation(self): """Return current operation ie. heat, cool, idle.""" - return STATE_HEAT if self._active and self._is_heating else STATE_IDLE + if self.ac_mode: + cooling = self._active and self._is_device_active + return STATE_COOL if cooling else STATE_IDLE + else: + heating = self._active and self._is_device_active + return STATE_HEAT if heating else STATE_IDLE @property def target_temperature(self): @@ -178,17 +187,27 @@ class HeatControl(ThermostatDevice): if not self._active: return - too_cold = self._target_temp - self._cur_temp > TOL_TEMP - is_heating = self._is_heating + if self.ac_mode: + too_hot = self._cur_temp - self._target_temp > TOL_TEMP + is_cooling = self._is_device_active + if too_hot and not is_cooling: + _LOGGER.info('Turning on AC %s', self.heater_entity_id) + switch.turn_on(self.hass, self.heater_entity_id) + elif not too_hot and is_cooling: + _LOGGER.info('Turning off AC %s', self.heater_entity_id) + switch.turn_off(self.hass, self.heater_entity_id) + else: + too_cold = self._target_temp - self._cur_temp > TOL_TEMP + is_heating = self._is_device_active - if too_cold and not is_heating: - _LOGGER.info('Turning on heater %s', self.heater_entity_id) - switch.turn_on(self.hass, self.heater_entity_id) - elif not too_cold and is_heating: - _LOGGER.info('Turning off heater %s', self.heater_entity_id) - switch.turn_off(self.hass, self.heater_entity_id) + if too_cold and not is_heating: + _LOGGER.info('Turning on heater %s', self.heater_entity_id) + switch.turn_on(self.hass, self.heater_entity_id) + elif not too_cold and is_heating: + _LOGGER.info('Turning off heater %s', self.heater_entity_id) + switch.turn_off(self.hass, self.heater_entity_id) @property - def _is_heating(self): - """If the heater is currently heating.""" + def _is_device_active(self): + """If the toggleable device is currently active.""" return switch.is_on(self.hass, self.heater_entity_id) diff --git a/tests/components/thermostat/test_heat_control.py b/tests/components/thermostat/test_heat_control.py index ca3572d1710..8ab571ce56b 100644 --- a/tests/components/thermostat/test_heat_control.py +++ b/tests/components/thermostat/test_heat_control.py @@ -206,3 +206,93 @@ class TestThermostatHeatControl(unittest.TestCase): self.hass.services.register('switch', SERVICE_TURN_ON, log_call) self.hass.services.register('switch', SERVICE_TURN_OFF, log_call) + + +class TestThermostatHeatControlACMode(unittest.TestCase): + """Test the Heat Control thermostat.""" + + def setUp(self): # pylint: disable=invalid-name + """Setup things to be run when tests are started.""" + self.hass = get_test_home_assistant() + self.hass.config.temperature_unit = TEMP_CELSIUS + thermostat.setup(self.hass, {'thermostat': { + 'platform': 'heat_control', + 'name': 'test', + 'heater': ENT_SWITCH, + 'target_sensor': ENT_SENSOR, + 'ac_mode': True + }}) + + def tearDown(self): # pylint: disable=invalid-name + """Stop down everything that was started.""" + self.hass.stop() + + def test_set_target_temp_ac_off(self): + """Test if target temperature turn ac off.""" + self._setup_switch(True) + self._setup_sensor(25) + self.hass.pool.block_till_done() + thermostat.set_temperature(self.hass, 30) + self.hass.pool.block_till_done() + self.assertEqual(1, len(self.calls)) + call = self.calls[0] + self.assertEqual('switch', call.domain) + self.assertEqual(SERVICE_TURN_OFF, call.service) + self.assertEqual(ENT_SWITCH, call.data['entity_id']) + + def test_set_target_temp_ac_on(self): + """Test if target temperature turn ac on.""" + self._setup_switch(False) + self._setup_sensor(30) + self.hass.pool.block_till_done() + thermostat.set_temperature(self.hass, 25) + self.hass.pool.block_till_done() + self.assertEqual(1, len(self.calls)) + call = self.calls[0] + self.assertEqual('switch', call.domain) + self.assertEqual(SERVICE_TURN_ON, call.service) + self.assertEqual(ENT_SWITCH, call.data['entity_id']) + + def test_set_temp_change_ac_off(self): + """Test if temperature change turn ac off.""" + self._setup_switch(True) + thermostat.set_temperature(self.hass, 30) + self.hass.pool.block_till_done() + self._setup_sensor(25) + self.hass.pool.block_till_done() + self.assertEqual(1, len(self.calls)) + call = self.calls[0] + self.assertEqual('switch', call.domain) + self.assertEqual(SERVICE_TURN_OFF, call.service) + self.assertEqual(ENT_SWITCH, call.data['entity_id']) + + def test_temp_change_ac_on(self): + """Test if temperature change turn ac on.""" + self._setup_switch(False) + thermostat.set_temperature(self.hass, 25) + self.hass.pool.block_till_done() + self._setup_sensor(30) + self.hass.pool.block_till_done() + self.assertEqual(1, len(self.calls)) + call = self.calls[0] + self.assertEqual('switch', call.domain) + self.assertEqual(SERVICE_TURN_ON, call.service) + self.assertEqual(ENT_SWITCH, call.data['entity_id']) + + def _setup_sensor(self, temp, unit=TEMP_CELSIUS): + """Setup the test sensor.""" + self.hass.states.set(ENT_SENSOR, temp, { + ATTR_UNIT_OF_MEASUREMENT: unit + }) + + def _setup_switch(self, is_on): + """Setup the test switch.""" + self.hass.states.set(ENT_SWITCH, STATE_ON if is_on else STATE_OFF) + self.calls = [] + + def log_call(call): + """Log service calls.""" + self.calls.append(call) + + self.hass.services.register('switch', SERVICE_TURN_ON, log_call) + self.hass.services.register('switch', SERVICE_TURN_OFF, log_call)