* First draft of XKNX module for Home-Assistant * XKNX does now take path of xknx.yaml as parameter * small fix, telegram_received_callback has different signature * changed method of registering callbacks of devices * removed non async command lines from xknx * telegram_received_cb not needed within HASS module * updated requirements * Configuration if XKNX should connect via Routing or Tunneling * bumping version to 0.6.1 * small fix within xknx plugin * bumped version * XKNX-Switches are now BinarySensors and Logic from Sensor was moved to BinarySensor * renamed Outlet to Switch * pylint * configuration of KNX lights via HASS config, yay! * changed name of attribute * Added configuration for xknx to switch component * added support for sensors within hass configuration * added support for climate within hass configuration * Thermostat -> Climate * added configuration support for binary_sensors * renamed Shutter to Cover * added configuration support for cover * restructured file structure according to HASS requirements * pylint * pylint * pylint * pylint * pylint * pylint * updated version * pylint * pylint * pylint * added setpoint support for climate devices * devices are now in a different module * more asyncio :-) * pydocstyle * pydocstyle * added actions to binary_sensor * allow more than one automation * readded requirement * Modifications suggested by hound * Modifications suggested by hound * Modifications suggested by hound * Modifications suggested by hound * xknx now imported as local import * hound *sigh* * lint * 'fixed' coverage. * next try for getting gen_requirements_all.py working * removed blank line * XKNX 0.7.1 with logging functionality, replaced some print() calls with _LOGGER * updated requirements_all.txt * Fixes issue https://github.com/XKNX/xknx/issues/51 * https://github.com/XKNX/xknx/issues/52 added raw access to KNX bus from HASS component. * bumped version - 0.7.3 contains some bugfixes * bumped version - 0.7.3 contains some bugfixes * setting setpoint within climate device has to be async * bumped version to 0.7.4 * bumped version * https://github.com/XKNX/xknx/issues/48 Adding HVAC support. * pylint suggestions * Made target temperature and set point required attributes * renamed value_type to type within sensor configuration * Issue https://github.com/XKNX/xknx/issues/52 : added filter functionality for not flooding the event bus. * suggestions by pylint * Added notify support for knx platform. * logging error if discovery_info is None. * review suggestions by @armills * line too long * Using discovery_info to notifiy component which devices should be added. * moved XKNX automation to main level. * renamed xknx component to knx. * reverted change within .coveragerc * changed dependency * updated docstrings. * updated version of xknx within requirements_all.txt * moved requirement to correct position * renamed configuration attribute * added @callback-decorator and async_prefix. * added @callback decorator and async_ prefix to register_callbacks functions * fixed typo * pylint suggestions * added angle position and invert_position and invert_angle to cover.knx * typo * bumped version within requirements_all.txt * bumped version * Added support for HVAC controller status
182 lines
6.7 KiB
Python
182 lines
6.7 KiB
Python
"""
|
|
Support for KNX/IP climate devices.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/climate.knx/
|
|
"""
|
|
import asyncio
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.knx import DATA_KNX, ATTR_DISCOVER_DEVICES
|
|
from homeassistant.components.climate import PLATFORM_SCHEMA, ClimateDevice
|
|
from homeassistant.const import CONF_NAME, TEMP_CELSIUS, ATTR_TEMPERATURE
|
|
from homeassistant.core import callback
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
CONF_SETPOINT_ADDRESS = 'setpoint_address'
|
|
CONF_TEMPERATURE_ADDRESS = 'temperature_address'
|
|
CONF_TARGET_TEMPERATURE_ADDRESS = 'target_temperature_address'
|
|
CONF_OPERATION_MODE_ADDRESS = 'operation_mode_address'
|
|
CONF_OPERATION_MODE_STATE_ADDRESS = 'operation_mode_state_address'
|
|
CONF_CONTROLLER_STATUS_ADDRESS = 'controller_status_address'
|
|
CONF_CONTROLLER_STATUS_STATE_ADDRESS = 'controller_status_state_address'
|
|
CONF_OPERATION_MODE_FROST_PROTECTION_ADDRESS = \
|
|
'operation_mode_frost_protection_address'
|
|
CONF_OPERATION_MODE_NIGHT_ADDRESS = 'operation_mode_night_address'
|
|
CONF_OPERATION_MODE_COMFORT_ADDRESS = 'operation_mode_comfort_address'
|
|
|
|
DEFAULT_NAME = 'KNX Climate'
|
|
DEPENDENCIES = ['knx']
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
vol.Required(CONF_SETPOINT_ADDRESS): cv.string,
|
|
vol.Required(CONF_TEMPERATURE_ADDRESS): cv.string,
|
|
vol.Required(CONF_TARGET_TEMPERATURE_ADDRESS): cv.string,
|
|
vol.Optional(CONF_OPERATION_MODE_ADDRESS): cv.string,
|
|
vol.Optional(CONF_OPERATION_MODE_STATE_ADDRESS): cv.string,
|
|
vol.Optional(CONF_CONTROLLER_STATUS_ADDRESS): cv.string,
|
|
vol.Optional(CONF_CONTROLLER_STATUS_STATE_ADDRESS): cv.string,
|
|
vol.Optional(CONF_OPERATION_MODE_FROST_PROTECTION_ADDRESS): cv.string,
|
|
vol.Optional(CONF_OPERATION_MODE_NIGHT_ADDRESS): cv.string,
|
|
vol.Optional(CONF_OPERATION_MODE_COMFORT_ADDRESS): cv.string,
|
|
})
|
|
|
|
|
|
@asyncio.coroutine
|
|
def async_setup_platform(hass, config, add_devices,
|
|
discovery_info=None):
|
|
"""Set up climate(s) for KNX platform."""
|
|
if DATA_KNX not in hass.data \
|
|
or not hass.data[DATA_KNX].initialized:
|
|
return False
|
|
|
|
if discovery_info is not None:
|
|
async_add_devices_discovery(hass, discovery_info, add_devices)
|
|
else:
|
|
async_add_devices_config(hass, config, add_devices)
|
|
|
|
return True
|
|
|
|
|
|
@callback
|
|
def async_add_devices_discovery(hass, discovery_info, add_devices):
|
|
"""Set up climates for KNX platform configured within plattform."""
|
|
entities = []
|
|
for device_name in discovery_info[ATTR_DISCOVER_DEVICES]:
|
|
device = hass.data[DATA_KNX].xknx.devices[device_name]
|
|
entities.append(KNXClimate(hass, device))
|
|
add_devices(entities)
|
|
|
|
|
|
@callback
|
|
def async_add_devices_config(hass, config, add_devices):
|
|
"""Set up climate for KNX platform configured within plattform."""
|
|
import xknx
|
|
climate = xknx.devices.Climate(
|
|
hass.data[DATA_KNX].xknx,
|
|
name=config.get(CONF_NAME),
|
|
group_address_temperature=config.get(
|
|
CONF_TEMPERATURE_ADDRESS),
|
|
group_address_target_temperature=config.get(
|
|
CONF_TARGET_TEMPERATURE_ADDRESS),
|
|
group_address_setpoint=config.get(
|
|
CONF_SETPOINT_ADDRESS),
|
|
group_address_operation_mode=config.get(
|
|
CONF_OPERATION_MODE_ADDRESS),
|
|
group_address_operation_mode_state=config.get(
|
|
CONF_OPERATION_MODE_STATE_ADDRESS),
|
|
group_address_controller_status=config.get(
|
|
CONF_CONTROLLER_STATUS_ADDRESS),
|
|
group_address_controller_status_state=config.get(
|
|
CONF_CONTROLLER_STATUS_STATE_ADDRESS),
|
|
group_address_operation_mode_protection=config.get(
|
|
CONF_OPERATION_MODE_FROST_PROTECTION_ADDRESS),
|
|
group_address_operation_mode_night=config.get(
|
|
CONF_OPERATION_MODE_NIGHT_ADDRESS),
|
|
group_address_operation_mode_comfort=config.get(
|
|
CONF_OPERATION_MODE_COMFORT_ADDRESS))
|
|
hass.data[DATA_KNX].xknx.devices.add(climate)
|
|
add_devices([KNXClimate(hass, climate)])
|
|
|
|
|
|
class KNXClimate(ClimateDevice):
|
|
"""Representation of a KNX climate."""
|
|
|
|
def __init__(self, hass, device):
|
|
"""Initialization of KNXClimate."""
|
|
self.device = device
|
|
self.hass = hass
|
|
self.async_register_callbacks()
|
|
|
|
self._unit_of_measurement = TEMP_CELSIUS
|
|
self._away = False # not yet supported
|
|
self._is_fan_on = False # not yet supported
|
|
|
|
def async_register_callbacks(self):
|
|
"""Register callbacks to update hass after device was changed."""
|
|
@asyncio.coroutine
|
|
def after_update_callback(device):
|
|
"""Callback after device was updated."""
|
|
# pylint: disable=unused-argument
|
|
yield from self.async_update_ha_state()
|
|
self.device.register_device_updated_cb(after_update_callback)
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the KNX device."""
|
|
return self.device.name
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""No polling needed within KNX."""
|
|
return False
|
|
|
|
@property
|
|
def temperature_unit(self):
|
|
"""Return the unit of measurement."""
|
|
return self._unit_of_measurement
|
|
|
|
@property
|
|
def current_temperature(self):
|
|
"""Return the current temperature."""
|
|
return self.device.temperature
|
|
|
|
@property
|
|
def target_temperature(self):
|
|
"""Return the temperature we try to reach."""
|
|
if self.device.supports_target_temperature:
|
|
return self.device.target_temperature
|
|
return None
|
|
|
|
@asyncio.coroutine
|
|
def async_set_temperature(self, **kwargs):
|
|
"""Set new target temperature."""
|
|
temperature = kwargs.get(ATTR_TEMPERATURE)
|
|
if temperature is None:
|
|
return
|
|
if self.device.supports_target_temperature:
|
|
yield from self.device.set_target_temperature(temperature)
|
|
|
|
@property
|
|
def current_operation(self):
|
|
"""Return current operation ie. heat, cool, idle."""
|
|
if self.device.supports_operation_mode:
|
|
return self.device.operation_mode.value
|
|
return None
|
|
|
|
@property
|
|
def operation_list(self):
|
|
"""Return the list of available operation modes."""
|
|
return [operation_mode.value for
|
|
operation_mode in
|
|
self.device.get_supported_operation_modes()]
|
|
|
|
@asyncio.coroutine
|
|
def async_set_operation_mode(self, operation_mode):
|
|
"""Set operation mode."""
|
|
if self.device.supports_operation_mode:
|
|
from xknx.knx import HVACOperationMode
|
|
knx_operation_mode = HVACOperationMode(operation_mode)
|
|
yield from self.device.set_operation_mode(knx_operation_mode)
|