Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,7 @@ omit =
homeassistant/components/climate/radiotherm.py
homeassistant/components/climate/sensibo.py
homeassistant/components/climate/touchline.py
homeassistant/components/climate/venstar.py
homeassistant/components/cover/garadget.py
homeassistant/components/cover/homematic.py
homeassistant/components/cover/knx.py
Expand Down
278 changes: 278 additions & 0 deletions homeassistant/components/climate/venstar.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,278 @@
"""
Support for Venstar WiFi Thermostats.

For more details about this platform, please refer to the documentation at
https://home-assistant.io/components/climate.venstar/
"""
import logging
import voluptuous as vol

from homeassistant.components.climate import (
STATE_COOL, STATE_HEAT, STATE_AUTO,
ClimateDevice, PLATFORM_SCHEMA,
SUPPORT_TARGET_TEMPERATURE, SUPPORT_TARGET_HUMIDITY,
SUPPORT_FAN_MODE, SUPPORT_OPERATION_MODE,
SUPPORT_TARGET_TEMPERATURE_HIGH,
SUPPORT_TARGET_TEMPERATURE_LOW,
ATTR_OPERATION_MODE,
ATTR_TARGET_TEMP_HIGH, ATTR_TARGET_TEMP_LOW)

from homeassistant.const import (
CONF_HOST, CONF_PASSWORD, CONF_SSL, CONF_USERNAME, CONF_TIMEOUT,
TEMP_FAHRENHEIT, ATTR_TEMPERATURE, TEMP_CELSIUS,
PRECISION_WHOLE, STATE_ON, STATE_OFF)

import homeassistant.helpers.config_validation as cv

REQUIREMENTS = ['venstarcolortouch==0.5']

_LOGGER = logging.getLogger(__name__)

DEFAULT_SSL = False
ATTR_FAN_STATE = 'fan_state'
ATTR_HVAC_STATE = 'hvac_state'
VALID_FAN_STATES = [STATE_ON, STATE_AUTO]
VALID_THERMOSTAT_MODES = [STATE_HEAT, STATE_COOL, STATE_OFF, STATE_AUTO]


PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Required(CONF_HOST): cv.string,
vol.Optional(CONF_USERNAME): cv.string,
vol.Optional(CONF_PASSWORD): cv.string,
vol.Optional(CONF_SSL, default=DEFAULT_SSL): cv.boolean,
vol.Optional(CONF_TIMEOUT, default=5):
vol.All(vol.Coerce(int), vol.Range(min=1))
})


def setup_platform(hass, config, add_devices, discovery_info=None):
"""Set up the Venstar thermostat."""
username = config.get(CONF_USERNAME)
password = config.get(CONF_PASSWORD)
host = config.get(CONF_HOST)
if config.get(CONF_SSL):
proto = 'https'
else:
proto = 'http'
timeout = config.get(CONF_TIMEOUT)

import venstarcolortouch
client = venstarcolortouch.VenstarColorTouch(addr=host,
timeout=timeout,
user=username,
password=password,
proto=proto)

add_devices([VenstarThermostat(client)], True)


class VenstarThermostat(ClimateDevice):
"""Representation of a Venstar thermostat."""

def __init__(self, client):
"""Initialize the thermostat."""
self._client = client

def update(self):
"""Update the data from the thermostat."""
info_success = self._client.update_info()
sensor_success = self._client.update_sensors()
if not info_success or not sensor_success:
_LOGGER.error("Failed to update data from your Thermostat.")

# Thermostat config
@property
def supported_features(self):
"""Return the list of supported features."""
features = (SUPPORT_TARGET_TEMPERATURE |
SUPPORT_FAN_MODE |
SUPPORT_OPERATION_MODE)

if self._client.mode == self._client.MODE_AUTO:
features |= (SUPPORT_TARGET_TEMPERATURE_HIGH |
SUPPORT_TARGET_TEMPERATURE_LOW)

if self._client.hum_active == 1:
features |= SUPPORT_TARGET_HUMIDITY

return features

@property
def name(self):
"""Return the name of the thermostat."""
return self._client.name

@property
def precision(self):
"""Return the precision of the system.

Venstar temperature values are passed back and forth in the
API as whole degrees C or F.
"""
return PRECISION_WHOLE

@property
def temperature_unit(self):
"""Return the unit of measurement, as defined by the API."""
if self._client.tempunits == self._client.TEMPUNITS_F:
return TEMP_FAHRENHEIT
else:
return TEMP_CELSIUS

@property
def fan_list(self):
"""Return the list of available fan modes."""
return VALID_FAN_STATES

@property
def operation_list(self):
"""Return the list of available operation modes."""
return VALID_THERMOSTAT_MODES

# Current Values
@property
def current_temperature(self):
"""Return the current temperature."""
return self._client.get_indoor_temp()

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this do I/O? Or is the only I/O happening in the update_info() and update_sensor() methods?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No I/O here- only on update_sensor/update_info.


@property
def current_humidity(self):
"""Return the current humidity."""
return self._client.get_indoor_humidity()

@property
def current_operation(self):
"""Return current operation ie. heat, cool, idle."""
if self._client.mode == self._client.MODE_HEAT:
return STATE_HEAT
elif self._client.mode == self._client.MODE_COOL:
return STATE_COOL
elif self._client.mode == self._client.MODE_AUTO:
return STATE_AUTO
else:
return STATE_OFF

@property
def current_fan_mode(self):

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like there is no way of setting the fan to off. Is that correct?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes that's correct- only AUTO/ON are valid.

"""Return the fan setting."""
if self._client.fan == self._client.FAN_AUTO:
return STATE_AUTO
else:
return STATE_ON

@property
def device_state_attributes(self):
"""Return the optional state attributes."""
return {
ATTR_FAN_STATE: self._client.fanstate,
ATTR_HVAC_STATE: self._client.state
}

# Target Values
@property
def target_temperature(self):
"""Return the target temperature we try to reach."""
if self._client.mode == self._client.MODE_HEAT:
return self._client.heattemp
elif self._client.mode == self._client.MODE_COOL:
return self._client.cooltemp
else:
return None

@property
def target_temperature_low(self):
"""Return the lower bound temp if auto mode is on."""
if self._client.mode == self._client.MODE_AUTO:
return self._client.heattemp
else:
return None

@property
def target_temperature_high(self):
"""Return the upper bound temp if auto mode is on."""
if self._client.mode == self._client.MODE_AUTO:
return self._client.cooltemp
else:
return None

@property
def target_humidity(self):
"""Return the humidity we try to reach."""
return self._client.hum_setpoint

@property
def min_humidity(self):
"""Return the minimum humidity. Hardcoded to 0 in API."""
return 0

@property
def max_humidity(self):
"""Return the maximum humidity. Hardcoded to 60 in API."""
return 60

# Commands
def _set_operation_mode(self, operation_mode):
"""Change the operation mode (internal)."""
if operation_mode == STATE_HEAT:
success = self._client.set_mode(self._client.MODE_HEAT)
elif operation_mode == STATE_COOL:
success = self._client.set_mode(self._client.MODE_COOL)
elif operation_mode == STATE_AUTO:
success = self._client.set_mode(self._client.MODE_AUTO)
else:
success = self._client.set_mode(self._client.MODE_OFF)

if not success:
_LOGGER.error("Failed to change the "
"operation mode of your thermostat.")
return success

def set_temperature(self, **kwargs):
"""Set a new target temperature."""
set_temp = True
operation_mode = kwargs.get(ATTR_OPERATION_MODE, self._client.mode)
temp_low = kwargs.get(ATTR_TARGET_TEMP_LOW)
temp_high = kwargs.get(ATTR_TARGET_TEMP_HIGH)
temperature = kwargs.get(ATTR_TEMPERATURE)

if operation_mode != self._client.mode:
set_temp = self._set_operation_mode(operation_mode)

if set_temp:
if operation_mode == self._client.MODE_HEAT:
success = self._client.set_setpoints(temperature,
self._client.cooltemp)
elif operation_mode == self._client.MODE_COOL:
success = self._client.set_setpoints(self._client.heattemp,
temperature)
elif operation_mode == self._client.MODE_AUTO:
success = self._client.set_setpoints(temp_low, temp_high)
else:
_LOGGER.error("The thermostat is currently not "
"in a mode that supports target temperature.")

if not success:
_LOGGER.error("Failed to change the "
"temperature of your thermostat.")

def set_fan_mode(self, fan):
"""Set new target fan mode."""
if fan == STATE_ON:
success = self._client.set_fan(self._client.FAN_ON)
else:
success = self._client.set_fan(self._client.FAN_AUTO)

if not success:
_LOGGER.error("Failed to change the fan mode of your thermostat.")

def set_operation_mode(self, operation_mode):
"""Set new target operation mode."""
self._set_operation_mode(operation_mode)

def set_humidity(self, humidity):
"""Set new target humidity."""
success = self._client.set_hum_setpoint(humidity)

if not success:
_LOGGER.error("Failed to change the target "
"humidity level of your thermostat.")
3 changes: 3 additions & 0 deletions requirements_all.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1164,6 +1164,9 @@ user-agents==1.1.0
# homeassistant.components.camera.uvc
uvcclient==0.10.1

# homeassistant.components.climate.venstar
venstarcolortouch==0.5

# homeassistant.components.volvooncall
volvooncall==0.4.0

Expand Down