8c78a210ef
Add waterfurnace platform This adds support for waterfurnace geothermal systems. This is implemented as a component as there will eventually be some active control elements. This is not done as a climate platform because geothermal systems work best when set at a constant temperature as they are tuned to keep within 0.5 degrees F of a setpoint, and large temperature shifts are slow and expensive. This is done in the Data + Sensors model, with the Data component having a regular update thread. That thread needs to call the read() function at least every 30 seconds otherwise the underlying websocket is closed by the server.
114 lines
3.5 KiB
Python
114 lines
3.5 KiB
Python
"""
|
|
Support for Waterfurnace.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/sensor.waterfurnace/
|
|
"""
|
|
import asyncio
|
|
|
|
from homeassistant.components.sensor import ENTITY_ID_FORMAT
|
|
from homeassistant.components.waterfurnace import (
|
|
DOMAIN as WF_DOMAIN, UPDATE_TOPIC
|
|
)
|
|
from homeassistant.const import TEMP_FAHRENHEIT
|
|
from homeassistant.core import callback
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.util import slugify
|
|
|
|
|
|
class WFSensorConfig(object):
|
|
"""Water Furnace Sensor configuration."""
|
|
|
|
def __init__(self, friendly_name, field, icon="mdi:guage",
|
|
unit_of_measurement=None):
|
|
"""Initialize configuration."""
|
|
self.friendly_name = friendly_name
|
|
self.field = field
|
|
self.icon = icon
|
|
self.unit_of_measurement = unit_of_measurement
|
|
|
|
|
|
SENSORS = [
|
|
WFSensorConfig("Furnace Mode", "mode"),
|
|
WFSensorConfig("Total Power", "totalunitpower", "mdi:flash", "W"),
|
|
WFSensorConfig("Active Setpoint", "tstatactivesetpoint",
|
|
"mdi:thermometer", TEMP_FAHRENHEIT),
|
|
WFSensorConfig("Leaving Air", "leavingairtemp",
|
|
"mdi:thermometer", TEMP_FAHRENHEIT),
|
|
WFSensorConfig("Room Temp", "tstatroomtemp",
|
|
"mdi:thermometer", TEMP_FAHRENHEIT),
|
|
WFSensorConfig("Loop Temp", "enteringwatertemp",
|
|
"mdi:thermometer", TEMP_FAHRENHEIT),
|
|
WFSensorConfig("Humidity Set Point", "tstathumidsetpoint",
|
|
"mdi:water-percent", "%"),
|
|
WFSensorConfig("Humidity", "tstatrelativehumidity",
|
|
"mdi:water-percent", "%"),
|
|
]
|
|
|
|
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
"""Set up the Waterfurnace sensor."""
|
|
if discovery_info is None:
|
|
return
|
|
|
|
sensors = []
|
|
client = hass.data[WF_DOMAIN]
|
|
for sconfig in SENSORS:
|
|
sensors.append(WaterFurnaceSensor(client, sconfig))
|
|
|
|
add_devices(sensors)
|
|
|
|
|
|
class WaterFurnaceSensor(Entity):
|
|
"""Implementing the Waterfurnace sensor."""
|
|
|
|
def __init__(self, client, config):
|
|
"""Initialize the sensor."""
|
|
self.client = client
|
|
self._name = config.friendly_name
|
|
self._attr = config.field
|
|
self._state = None
|
|
self._icon = config.icon
|
|
self._unit_of_measurement = config.unit_of_measurement
|
|
|
|
# This ensures that the sensors are isolated per waterfurnace unit
|
|
self.entity_id = ENTITY_ID_FORMAT.format(
|
|
'wf_{}_{}'.format(slugify(self.client.unit), slugify(self._attr)))
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return self._name
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the sensor."""
|
|
return self._state
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Return icon."""
|
|
return self._icon
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""Return the units of measurement."""
|
|
return self._unit_of_measurement
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""Return the polling state."""
|
|
return False
|
|
|
|
@asyncio.coroutine
|
|
def async_added_to_hass(self):
|
|
"""Register callbacks."""
|
|
self.hass.helpers.dispatcher.async_dispatcher_connect(
|
|
UPDATE_TOPIC, self.async_update_callback)
|
|
|
|
@callback
|
|
def async_update_callback(self):
|
|
"""Update state."""
|
|
if self.client.data is not None:
|
|
self._state = getattr(self.client.data, self._attr, None)
|
|
self.async_schedule_update_ha_state()
|