062fe79b3f
This adds support for the US variant of the Honeywell connected thermostat. The interface is super simple, so this doesn't add any external dependencies. It supports basic temperature, setpoint, and control. Issue #998 notes that the existing honeywell module doesn't work for US models, which is because they are totally different. In order to indicate to the honeywell platform module that the thermostat is a US-type, we key off of whether or not the thermostat id is provided. This is something that US people have (and require to identify one of potentially multiple thermostats in their account) and EU people will not.
268 lines
8.5 KiB
Python
268 lines
8.5 KiB
Python
"""
|
|
homeassistant.components.thermostat.honeywell
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
Adds support for Honeywell Round Connected and Honeywell Evohome thermostats.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/thermostat.honeywell/
|
|
"""
|
|
import logging
|
|
import socket
|
|
|
|
import requests
|
|
|
|
from homeassistant.components.thermostat import ThermostatDevice
|
|
from homeassistant.const import (CONF_USERNAME, CONF_PASSWORD, TEMP_CELCIUS,
|
|
TEMP_FAHRENHEIT)
|
|
|
|
REQUIREMENTS = ['evohomeclient==0.2.4']
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
CONF_AWAY_TEMP = "away_temperature"
|
|
US_SYSTEM_SWITCH_POSITIONS = {1: 'Heat',
|
|
2: 'Off',
|
|
3: 'Cool'}
|
|
US_BASEURL = 'https://mytotalconnectcomfort.com/portal'
|
|
|
|
|
|
def _setup_round(username, password, config, add_devices):
|
|
from evohomeclient import EvohomeClient
|
|
|
|
try:
|
|
away_temp = float(config.get(CONF_AWAY_TEMP, 16))
|
|
except ValueError:
|
|
_LOGGER.error("value entered for item %s should convert to a number",
|
|
CONF_AWAY_TEMP)
|
|
return False
|
|
|
|
evo_api = EvohomeClient(username, password)
|
|
|
|
try:
|
|
zones = evo_api.temperatures(force_refresh=True)
|
|
for i, zone in enumerate(zones):
|
|
add_devices([RoundThermostat(evo_api,
|
|
zone['id'],
|
|
i == 0,
|
|
away_temp)])
|
|
except socket.error:
|
|
_LOGGER.error(
|
|
"Connection error logging into the honeywell evohome web service"
|
|
)
|
|
return False
|
|
|
|
|
|
# pylint: disable=unused-argument
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
""" Sets up the honeywel thermostat. """
|
|
username = config.get(CONF_USERNAME)
|
|
password = config.get(CONF_PASSWORD)
|
|
thermostat_id = config.get('id')
|
|
|
|
if username is None or password is None:
|
|
_LOGGER.error("Missing required configuration items %s or %s",
|
|
CONF_USERNAME, CONF_PASSWORD)
|
|
return False
|
|
|
|
if thermostat_id:
|
|
add_devices([HoneywellUSThermostat(thermostat_id, username, password)])
|
|
else:
|
|
return _setup_round(username, password, config, add_devices)
|
|
|
|
|
|
class RoundThermostat(ThermostatDevice):
|
|
""" Represents a Honeywell Round Connected thermostat. """
|
|
|
|
# pylint: disable=too-many-instance-attributes
|
|
def __init__(self, device, zone_id, master, away_temp):
|
|
self.device = device
|
|
self._current_temperature = None
|
|
self._target_temperature = None
|
|
self._name = "round connected"
|
|
self._id = zone_id
|
|
self._master = master
|
|
self._is_dhw = False
|
|
self._away_temp = away_temp
|
|
self._away = False
|
|
self.update()
|
|
|
|
@property
|
|
def name(self):
|
|
""" Returns the name of the honeywell, if any. """
|
|
return self._name
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
""" Unit of measurement this thermostat expresses itself in. """
|
|
return TEMP_CELCIUS
|
|
|
|
@property
|
|
def current_temperature(self):
|
|
""" Returns the current temperature. """
|
|
return self._current_temperature
|
|
|
|
@property
|
|
def target_temperature(self):
|
|
""" Returns the temperature we try to reach. """
|
|
if self._is_dhw:
|
|
return None
|
|
return self._target_temperature
|
|
|
|
def set_temperature(self, temperature):
|
|
""" Set new target temperature """
|
|
self.device.set_temperature(self._name, temperature)
|
|
|
|
@property
|
|
def is_away_mode_on(self):
|
|
""" Returns if away mode is on. """
|
|
return self._away
|
|
|
|
def turn_away_mode_on(self):
|
|
""" Turns away on.
|
|
Evohome does have a proprietary away mode, but it doesn't really work
|
|
the way it should. For example: If you set a temperature manually
|
|
it doesn't get overwritten when away mode is switched on.
|
|
"""
|
|
self._away = True
|
|
self.device.set_temperature(self._name, self._away_temp)
|
|
|
|
def turn_away_mode_off(self):
|
|
""" Turns away off. """
|
|
self._away = False
|
|
self.device.cancel_temp_override(self._name)
|
|
|
|
def update(self):
|
|
try:
|
|
# Only refresh if this is the "master" device,
|
|
# others will pick up the cache
|
|
for val in self.device.temperatures(force_refresh=self._master):
|
|
if val['id'] == self._id:
|
|
data = val
|
|
|
|
except StopIteration:
|
|
_LOGGER.error("Did not receive any temperature data from the "
|
|
"evohomeclient API.")
|
|
return
|
|
|
|
self._current_temperature = data['temp']
|
|
self._target_temperature = data['setpoint']
|
|
if data['thermostat'] == "DOMESTIC_HOT_WATER":
|
|
self._name = "Hot Water"
|
|
self._is_dhw = True
|
|
else:
|
|
self._name = data['name']
|
|
self._is_dhw = False
|
|
|
|
|
|
class HoneywellUSThermostat(ThermostatDevice):
|
|
""" Represents a Honeywell US Thermostat. """
|
|
|
|
def __init__(self, ident, username, password):
|
|
self._ident = ident
|
|
self._username = username
|
|
self._password = password
|
|
self._session = requests.Session()
|
|
# Maybe this should be configurable?
|
|
self._timeout = 30
|
|
# Yeah, really.
|
|
self._session.headers['X-Requested-With'] = 'XMLHttpRequest'
|
|
self._update()
|
|
|
|
def _login(self):
|
|
self._session.get(US_BASEURL, timeout=self._timeout)
|
|
params = {'UserName': self._username,
|
|
'Password': self._password,
|
|
'RememberMe': 'false',
|
|
'timeOffset': 480}
|
|
resp = self._session.post(US_BASEURL, params=params,
|
|
timeout=self._timeout)
|
|
if resp.status_code != 200:
|
|
_LOGGER('Login failed for user %(user)s',
|
|
dict(user=self._username))
|
|
return False
|
|
else:
|
|
return True
|
|
|
|
def _get_data(self):
|
|
if not self._login():
|
|
return
|
|
url = '%s/Device/CheckDataSession/%s' % (US_BASEURL, self._ident)
|
|
resp = self._session.get(url, timeout=self._timeout)
|
|
if resp.status_code < 300:
|
|
return resp.json()
|
|
else:
|
|
return {'error': resp.status_code}
|
|
|
|
def _set_data(self, data):
|
|
if not self._login():
|
|
return
|
|
url = '%s/Device/SubmitControlScreenChanges' % US_BASEURL
|
|
data['DeviceID'] = self._ident
|
|
resp = self._session.post(url, data=data, timeout=self._timeout)
|
|
if resp.status_code < 300:
|
|
return resp.json()
|
|
else:
|
|
return {'error': resp.status_code}
|
|
|
|
def _update(self):
|
|
self._data = self._get_data()['latestData']
|
|
|
|
@property
|
|
def is_fan_on(self):
|
|
return self._data['fanData']['fanIsRunning']
|
|
|
|
@property
|
|
def name(self):
|
|
return 'honeywell'
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
unit = self._data['uiData']['DisplayUnits']
|
|
if unit == 'F':
|
|
return TEMP_FAHRENHEIT
|
|
else:
|
|
return TEMP_CELCIUS
|
|
|
|
@property
|
|
def current_temperature(self):
|
|
self._update()
|
|
return self._data['uiData']['DispTemperature']
|
|
|
|
@property
|
|
def target_temperature(self):
|
|
setpoint = US_SYSTEM_SWITCH_POSITIONS.get(
|
|
self._data['uiData']['SystemSwitchPosition'],
|
|
'Off')
|
|
return self._data['uiData']['%sSetpoint' % setpoint]
|
|
|
|
def set_temperature(self, temperature):
|
|
""" Set target temperature. """
|
|
data = {'SystemSwitch': None,
|
|
'HeatSetpoint': None,
|
|
'CoolSetpoint': None,
|
|
'HeatNextPeriod': None,
|
|
'CoolNextPeriod': None,
|
|
'StatusHeat': None,
|
|
'StatusCool': None,
|
|
'FanMode': None}
|
|
setpoint = US_SYSTEM_SWITCH_POSITIONS.get(
|
|
self._data['uiData']['SystemSwitchPosition'],
|
|
'Off')
|
|
data['%sSetpoint' % setpoint] = temperature
|
|
self._set_data(data)
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
""" Return device specific state attributes. """
|
|
fanmodes = {0: "auto",
|
|
1: "on",
|
|
2: "circulate"}
|
|
return {"fan": (self._data['fanData']['fanIsRunning'] and
|
|
'running' or 'idle'),
|
|
"fanmode": fanmodes[self._data['fanData']['fanMode']]}
|
|
|
|
def turn_away_mode_on(self):
|
|
pass
|
|
|
|
def turn_away_mode_off(self):
|
|
pass
|