9b7780edf0
* Starting work on ecoal boiler controller iface. * Sending some values/states to controller. * Basic status parsing, and simple settings. * Platform configuration. * Temp sensors seems be working. * Switch from separate h/m/s to datetime. * Vocabulary updates. * secondary_central_heating_pump -> central_heating_pump2 * Pumps as switches. * Optional enabling pumps via config. * requests==2.20.1 added to REQUIREMENTS. * Optional enabling temp sensors from configuration yaml. * autopep8, black, pylint. * flake8. * pydocstyle * All style checkers again. * requests==2.20.1 required by homeassistant.components.sensor.ecoal_boiler. * Verify / set switches in update(). Code cleanup. * script/lint + travis issues. * Cleanup, imperative mood. * pylint, travis. * Updated .coveragerc. * Using configuration consts from homeassistant.const * typo. * Replace global ECOAL_CONTR with hass.data[DATA_ECOAL_BOILER]. Remove requests from REQUIREMENTS. * Killed .update()/reread_update() in Entities __init__()s. Removed debug/comments. * Removed debug/comments. * script/lint fixes. * script/gen_requirements_all.py run. * Travis fixes. * Configuration now validated. * Split controller code to separate package. * Replace in module docs with link to https://home-assistant.io . * Correct component module path in .coveragerc. More vals from const.py. Use dict[key] for required config keys. Check if credentials are correct during component setup. Renamed add_devices to add_entities. * Sensor/switch depends on ecoal_boiler component. EcoalSwitch inherits from SwitchDevice. Killed same as default should_poll(). Remove not neede schedule_update_ha_state() calls from turn_on/off. * lint fixes. * Move sensors/switches configuration to component setup. * Lint fixes. * Invalidating ecoal iface cache instead of force read in turn_on/off(). * Fail component setup before adding any platform entities. Kill NOTE. * Disallow setting entity names from config file, use code defined default names. * Rework configuration file to use monitored_conditions like in rainmachine component. * Killed pylint exception. Log error when connection to controller fails. * A few fixes. * Linted.
85 lines
2.5 KiB
Python
85 lines
2.5 KiB
Python
"""
|
|
Allows to configuration ecoal (esterownik.pl) pumps as switches.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/switch.ecoal_boiler/
|
|
"""
|
|
import logging
|
|
from typing import Optional
|
|
|
|
from homeassistant.components.switch import SwitchDevice
|
|
from homeassistant.components.ecoal_boiler import (
|
|
DATA_ECOAL_BOILER, AVAILABLE_PUMPS, )
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DEPENDENCIES = ['ecoal_boiler']
|
|
|
|
|
|
def setup_platform(hass, config, add_entities, discovery_info=None):
|
|
"""Set up switches based on ecoal interface."""
|
|
if discovery_info is None:
|
|
return
|
|
ecoal_contr = hass.data[DATA_ECOAL_BOILER]
|
|
switches = []
|
|
for pump_id in discovery_info:
|
|
name = AVAILABLE_PUMPS[pump_id]
|
|
switches.append(EcoalSwitch(ecoal_contr, name, pump_id))
|
|
add_entities(switches, True)
|
|
|
|
|
|
class EcoalSwitch(SwitchDevice):
|
|
"""Representation of Ecoal switch."""
|
|
|
|
def __init__(self, ecoal_contr, name, state_attr):
|
|
"""
|
|
Initialize switch.
|
|
|
|
Sets HA switch to state as read from controller.
|
|
"""
|
|
self._ecoal_contr = ecoal_contr
|
|
self._name = name
|
|
self._state_attr = state_attr
|
|
# Ecoalcotroller holds convention that same postfix is used
|
|
# to set attribute
|
|
# set_<attr>()
|
|
# as attribute name in status instance:
|
|
# status.<attr>
|
|
self._contr_set_fun = getattr(self._ecoal_contr, "set_" + state_attr)
|
|
# No value set, will be read from controller instead
|
|
self._state = None
|
|
|
|
@property
|
|
def name(self) -> Optional[str]:
|
|
"""Return the name of the switch."""
|
|
return self._name
|
|
|
|
def update(self):
|
|
"""Fetch new state data for the sensor.
|
|
|
|
This is the only method that should fetch new data for Home Assistant.
|
|
"""
|
|
status = self._ecoal_contr.get_cached_status()
|
|
self._state = getattr(status, self._state_attr)
|
|
|
|
def invalidate_ecoal_cache(self):
|
|
"""Invalidate ecoal interface cache.
|
|
|
|
Forces that next read from ecaol interface to not use cache.
|
|
"""
|
|
self._ecoal_contr.status = None
|
|
|
|
@property
|
|
def is_on(self) -> bool:
|
|
"""Return true if device is on."""
|
|
return self._state
|
|
|
|
def turn_on(self, **kwargs) -> None:
|
|
"""Turn the device on."""
|
|
self._contr_set_fun(1)
|
|
self.invalidate_ecoal_cache()
|
|
|
|
def turn_off(self, **kwargs) -> None:
|
|
"""Turn the device off."""
|
|
self._contr_set_fun(0)
|
|
self.invalidate_ecoal_cache()
|