mirror of
https://github.com/home-assistant/core.git
synced 2025-08-04 13:15:18 +02:00
Add OpenTherm Gateway sensor platform.
This commit is contained in:
mvn23
@@ -8,15 +8,17 @@ import logging
|
|||||||
|
|
||||||
import voluptuous as vol
|
import voluptuous as vol
|
||||||
|
|
||||||
from homeassistant.const import (CONF_DEVICE, CONF_NAME, PRECISION_HALVES,
|
|
||||||
PRECISION_TENTHS, PRECISION_WHOLE)
|
|
||||||
from homeassistant.helpers.discovery import async_load_platform
|
from homeassistant.helpers.discovery import async_load_platform
|
||||||
from homeassistant.helpers.dispatcher import async_dispatcher_send
|
from homeassistant.helpers.dispatcher import async_dispatcher_send
|
||||||
|
from homeassistant.const import (CONF_DEVICE, CONF_MONITORED_VARIABLES,
|
||||||
|
CONF_NAME, PRECISION_HALVES, PRECISION_TENTHS,
|
||||||
|
PRECISION_WHOLE)
|
||||||
import homeassistant.helpers.config_validation as cv
|
import homeassistant.helpers.config_validation as cv
|
||||||
|
|
||||||
DOMAIN = 'opentherm_gw'
|
DOMAIN = 'opentherm_gw'
|
||||||
|
|
||||||
|
COMP_SENSOR = 'sensor'
|
||||||
|
|
||||||
CONF_CLIMATE = 'climate'
|
CONF_CLIMATE = 'climate'
|
||||||
CONF_FLOOR_TEMP = 'floor_temperature'
|
CONF_FLOOR_TEMP = 'floor_temperature'
|
||||||
CONF_PRECISION = 'precision'
|
CONF_PRECISION = 'precision'
|
||||||
@@ -38,6 +40,7 @@ CONFIG_SCHEMA = vol.Schema({
|
|||||||
DOMAIN: vol.Schema({
|
DOMAIN: vol.Schema({
|
||||||
vol.Required(CONF_DEVICE): cv.string,
|
vol.Required(CONF_DEVICE): cv.string,
|
||||||
vol.Optional(CONF_CLIMATE, default={}): CLIMATE_SCHEMA,
|
vol.Optional(CONF_CLIMATE, default={}): CLIMATE_SCHEMA,
|
||||||
|
vol.Optional(CONF_MONITORED_VARIABLES, default=[]): cv.ensure_list,
|
||||||
}),
|
}),
|
||||||
}, extra=vol.ALLOW_EXTRA)
|
}, extra=vol.ALLOW_EXTRA)
|
||||||
|
|
||||||
@@ -59,6 +62,8 @@ async def async_setup(hass, config):
|
|||||||
hass, conf[CONF_DEVICE], gateway))
|
hass, conf[CONF_DEVICE], gateway))
|
||||||
hass.async_create_task(async_load_platform(
|
hass.async_create_task(async_load_platform(
|
||||||
hass, 'climate', DOMAIN, conf.get(CONF_CLIMATE)))
|
hass, 'climate', DOMAIN, conf.get(CONF_CLIMATE)))
|
||||||
|
hass.async_create_task(setup_monitored_vars(
|
||||||
|
hass, conf.get(CONF_MONITORED_VARIABLES)))
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
||||||
@@ -72,3 +77,68 @@ async def connect_and_subscribe(hass, device_path, gateway):
|
|||||||
_LOGGER.debug("Received report: %s", status)
|
_LOGGER.debug("Received report: %s", status)
|
||||||
async_dispatcher_send(hass, SIGNAL_OPENTHERM_GW_UPDATE, status)
|
async_dispatcher_send(hass, SIGNAL_OPENTHERM_GW_UPDATE, status)
|
||||||
gateway.subscribe(handle_report)
|
gateway.subscribe(handle_report)
|
||||||
|
|
||||||
|
|
||||||
|
async def setup_monitored_vars(hass, monitored_vars):
|
||||||
|
"""Setup requested sensors."""
|
||||||
|
gw_vars = hass.data[DATA_OPENTHERM_GW][DATA_GW_VARS]
|
||||||
|
# Use dict to prepare for binary sensor support.
|
||||||
|
sensor_type_map = {
|
||||||
|
COMP_SENSOR: [
|
||||||
|
gw_vars.DATA_CONTROL_SETPOINT,
|
||||||
|
gw_vars.DATA_MASTER_MEMBERID,
|
||||||
|
gw_vars.DATA_SLAVE_MEMBERID,
|
||||||
|
gw_vars.DATA_SLAVE_OEM_FAULT,
|
||||||
|
gw_vars.DATA_COOLING_CONTROL,
|
||||||
|
gw_vars.DATA_CONTROL_SETPOINT_2,
|
||||||
|
gw_vars.DATA_ROOM_SETPOINT_OVRD,
|
||||||
|
gw_vars.DATA_SLAVE_MAX_RELATIVE_MOD,
|
||||||
|
gw_vars.DATA_SLAVE_MAX_CAPACITY,
|
||||||
|
gw_vars.DATA_SLAVE_MIN_MOD_LEVEL,
|
||||||
|
gw_vars.DATA_ROOM_SETPOINT,
|
||||||
|
gw_vars.DATA_REL_MOD_LEVEL,
|
||||||
|
gw_vars.DATA_CH_WATER_PRESS,
|
||||||
|
gw_vars.DATA_DHW_FLOW_RATE,
|
||||||
|
gw_vars.DATA_ROOM_SETPOINT_2,
|
||||||
|
gw_vars.DATA_ROOM_TEMP,
|
||||||
|
gw_vars.DATA_CH_WATER_TEMP,
|
||||||
|
gw_vars.DATA_DHW_TEMP,
|
||||||
|
gw_vars.DATA_OUTSIDE_TEMP,
|
||||||
|
gw_vars.DATA_RETURN_WATER_TEMP,
|
||||||
|
gw_vars.DATA_SOLAR_STORAGE_TEMP,
|
||||||
|
gw_vars.DATA_SOLAR_COLL_TEMP,
|
||||||
|
gw_vars.DATA_CH_WATER_TEMP_2,
|
||||||
|
gw_vars.DATA_DHW_TEMP_2,
|
||||||
|
gw_vars.DATA_EXHAUST_TEMP,
|
||||||
|
gw_vars.DATA_SLAVE_DHW_MAX_SETP,
|
||||||
|
gw_vars.DATA_SLAVE_DHW_MIN_SETP,
|
||||||
|
gw_vars.DATA_SLAVE_CH_MAX_SETP,
|
||||||
|
gw_vars.DATA_SLAVE_CH_MIN_SETP,
|
||||||
|
gw_vars.DATA_DHW_SETPOINT,
|
||||||
|
gw_vars.DATA_MAX_CH_SETPOINT,
|
||||||
|
gw_vars.DATA_OEM_DIAG,
|
||||||
|
gw_vars.DATA_CH_BURNER_STARTS,
|
||||||
|
gw_vars.DATA_CH_PUMP_STARTS,
|
||||||
|
gw_vars.DATA_DHW_PUMP_STARTS,
|
||||||
|
gw_vars.DATA_DHW_BURNER_STARTS,
|
||||||
|
gw_vars.DATA_CH_BURNER_HOURS,
|
||||||
|
gw_vars.DATA_CH_PUMP_HOURS,
|
||||||
|
gw_vars.DATA_DHW_PUMP_HOURS,
|
||||||
|
gw_vars.DATA_DHW_BURNER_HOURS,
|
||||||
|
gw_vars.DATA_MASTER_OT_VERSION,
|
||||||
|
gw_vars.DATA_SLAVE_OT_VERSION,
|
||||||
|
gw_vars.DATA_MASTER_PRODUCT_TYPE,
|
||||||
|
gw_vars.DATA_MASTER_PRODUCT_VERSION,
|
||||||
|
gw_vars.DATA_SLAVE_PRODUCT_TYPE,
|
||||||
|
gw_vars.DATA_SLAVE_PRODUCT_VERSION,
|
||||||
|
]
|
||||||
|
}
|
||||||
|
sensors = []
|
||||||
|
for var in monitored_vars:
|
||||||
|
if var in sensor_type_map[COMP_SENSOR]:
|
||||||
|
sensors.append(var)
|
||||||
|
else:
|
||||||
|
_LOGGER.error("Monitored variable not supported: %s", var)
|
||||||
|
if sensors:
|
||||||
|
hass.async_create_task(
|
||||||
|
async_load_platform(hass, COMP_SENSOR, DOMAIN, sensors))
|
||||||
|
|||||||
188
homeassistant/components/sensor/opentherm_gw.py
Normal file
188
homeassistant/components/sensor/opentherm_gw.py
Normal file
@@ -0,0 +1,188 @@
|
|||||||
|
"""
|
||||||
|
Support for OpenTherm Gateway sensors.
|
||||||
|
|
||||||
|
For more details about this platform, please refer to the documentation at
|
||||||
|
http://home-assistant.io/components/opentherm_gw/
|
||||||
|
"""
|
||||||
|
import logging
|
||||||
|
|
||||||
|
from homeassistant.components.opentherm_gw import (
|
||||||
|
DATA_GW_VARS, DATA_OPENTHERM_GW, SIGNAL_OPENTHERM_GW_UPDATE)
|
||||||
|
from homeassistant.components.sensor import ENTITY_ID_FORMAT
|
||||||
|
from homeassistant.const import DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS
|
||||||
|
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
||||||
|
from homeassistant.helpers.entity import Entity, async_generate_entity_id
|
||||||
|
|
||||||
|
UNIT_BAR = 'bar'
|
||||||
|
UNIT_HOUR = 'h'
|
||||||
|
UNIT_KW = 'kW'
|
||||||
|
UNIT_L_MIN = 'L/min'
|
||||||
|
UNIT_PERCENT = '%'
|
||||||
|
|
||||||
|
DEPENDENCIES = ['opentherm_gw']
|
||||||
|
|
||||||
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
async def async_setup_platform(hass, config, async_add_entities,
|
||||||
|
discovery_info=None):
|
||||||
|
"""Set up the OpenTherm Gateway sensors."""
|
||||||
|
gw_vars = hass.data[DATA_OPENTHERM_GW][DATA_GW_VARS]
|
||||||
|
sensor_info = {
|
||||||
|
# [device_class, unit, friendly_name]
|
||||||
|
gw_vars.DATA_CONTROL_SETPOINT: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS, "Control Setpoint"],
|
||||||
|
gw_vars.DATA_MASTER_MEMBERID: [None, None, "Thermostat Member ID"],
|
||||||
|
gw_vars.DATA_SLAVE_MEMBERID: [None, None, "Boiler Member ID"],
|
||||||
|
gw_vars.DATA_SLAVE_OEM_FAULT: [None, None, "Boiler OEM Fault Code"],
|
||||||
|
gw_vars.DATA_COOLING_CONTROL: [
|
||||||
|
None, UNIT_PERCENT, "Cooling Control Signal"],
|
||||||
|
gw_vars.DATA_CONTROL_SETPOINT_2: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS, "Control Setpoint 2"],
|
||||||
|
gw_vars.DATA_ROOM_SETPOINT_OVRD: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS, "Room Setpoint Override"],
|
||||||
|
gw_vars.DATA_SLAVE_MAX_RELATIVE_MOD: [
|
||||||
|
None, UNIT_PERCENT, "Boiler Maximum Relative Modulation"],
|
||||||
|
gw_vars.DATA_SLAVE_MAX_CAPACITY: [
|
||||||
|
None, UNIT_KW, "Boiler Maximum Capacity"],
|
||||||
|
gw_vars.DATA_SLAVE_MIN_MOD_LEVEL: [
|
||||||
|
None, UNIT_PERCENT, "Boiler Minimum Modulation Level"],
|
||||||
|
gw_vars.DATA_ROOM_SETPOINT: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS, "Room Setpoint"],
|
||||||
|
gw_vars.DATA_REL_MOD_LEVEL: [
|
||||||
|
None, UNIT_PERCENT, "Relative Modulation Level"],
|
||||||
|
gw_vars.DATA_CH_WATER_PRESS: [
|
||||||
|
None, UNIT_BAR, "Central Heating Water Pressure"],
|
||||||
|
gw_vars.DATA_DHW_FLOW_RATE: [None, UNIT_L_MIN, "Hot Water Flow Rate"],
|
||||||
|
gw_vars.DATA_ROOM_SETPOINT_2: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS, "Room Setpoint 2"],
|
||||||
|
gw_vars.DATA_ROOM_TEMP: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS, "Room Temperature"],
|
||||||
|
gw_vars.DATA_CH_WATER_TEMP: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS,
|
||||||
|
"Central Heating Water Temperature"],
|
||||||
|
gw_vars.DATA_DHW_TEMP: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS, "Hot Water Temperature"],
|
||||||
|
gw_vars.DATA_OUTSIDE_TEMP: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS, "Outside Temperature"],
|
||||||
|
gw_vars.DATA_RETURN_WATER_TEMP: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS,
|
||||||
|
"Return Water Temperature"],
|
||||||
|
gw_vars.DATA_SOLAR_STORAGE_TEMP: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS,
|
||||||
|
"Solar Storage Temperature"],
|
||||||
|
gw_vars.DATA_SOLAR_COLL_TEMP: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS,
|
||||||
|
"Solar Collector Temperature"],
|
||||||
|
gw_vars.DATA_CH_WATER_TEMP_2: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS,
|
||||||
|
"Central Heating 2 Water Temperature"],
|
||||||
|
gw_vars.DATA_DHW_TEMP_2: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS, "Hot Water 2 Temperature"],
|
||||||
|
gw_vars.DATA_EXHAUST_TEMP: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS, "Exhaust Temperature"],
|
||||||
|
gw_vars.DATA_SLAVE_DHW_MAX_SETP: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS,
|
||||||
|
"Hot Water Maximum Setpoint"],
|
||||||
|
gw_vars.DATA_SLAVE_DHW_MIN_SETP: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS,
|
||||||
|
"Hot Water Minimum Setpoint"],
|
||||||
|
gw_vars.DATA_SLAVE_CH_MAX_SETP: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS,
|
||||||
|
"Boiler Maximum Central Heating Setpoint"],
|
||||||
|
gw_vars.DATA_SLAVE_CH_MIN_SETP: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS,
|
||||||
|
"Boiler Minimum Central Heating Setpoint"],
|
||||||
|
gw_vars.DATA_DHW_SETPOINT: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS, "Hot Water Setpoint"],
|
||||||
|
gw_vars.DATA_MAX_CH_SETPOINT: [
|
||||||
|
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS,
|
||||||
|
"Maximum Central Heating Setpoint"],
|
||||||
|
gw_vars.DATA_OEM_DIAG: [None, None, "OEM Diagnostic Code"],
|
||||||
|
gw_vars.DATA_CH_BURNER_STARTS: [
|
||||||
|
None, None, "Central Heating Burner Starts"],
|
||||||
|
gw_vars.DATA_CH_PUMP_STARTS: [
|
||||||
|
None, None, "Central Heating Pump Starts"],
|
||||||
|
gw_vars.DATA_DHW_PUMP_STARTS: [None, None, "Hot Water Pump Starts"],
|
||||||
|
gw_vars.DATA_DHW_BURNER_STARTS: [
|
||||||
|
None, None, "Hot Water Burner Starts"],
|
||||||
|
gw_vars.DATA_CH_BURNER_HOURS: [
|
||||||
|
None, UNIT_HOUR, "Central Heating Burner Hours"],
|
||||||
|
gw_vars.DATA_CH_PUMP_HOURS: [
|
||||||
|
None, UNIT_HOUR, "Central Heating Pump Hours"],
|
||||||
|
gw_vars.DATA_DHW_PUMP_HOURS: [None, UNIT_HOUR, "Hot Water Pump Hours"],
|
||||||
|
gw_vars.DATA_DHW_BURNER_HOURS: [
|
||||||
|
None, UNIT_HOUR, "Hot Water Burner Hours"],
|
||||||
|
gw_vars.DATA_MASTER_OT_VERSION: [
|
||||||
|
None, None, "Thermostat OpenTherm Version"],
|
||||||
|
gw_vars.DATA_SLAVE_OT_VERSION: [
|
||||||
|
None, None, "Boiler OpenTherm Version"],
|
||||||
|
gw_vars.DATA_MASTER_PRODUCT_TYPE: [
|
||||||
|
None, None, "Thermostat Product Type"],
|
||||||
|
gw_vars.DATA_MASTER_PRODUCT_VERSION: [
|
||||||
|
None, None, "Thermostat Product Version"],
|
||||||
|
gw_vars.DATA_SLAVE_PRODUCT_TYPE: [None, None, "Boiler Product Type"],
|
||||||
|
gw_vars.DATA_SLAVE_PRODUCT_VERSION: [
|
||||||
|
None, None, "Boiler Product Version"],
|
||||||
|
}
|
||||||
|
sensors = []
|
||||||
|
for var in discovery_info:
|
||||||
|
device_class = sensor_info[var][0]
|
||||||
|
unit = sensor_info[var][1]
|
||||||
|
friendly_name = sensor_info[var][2]
|
||||||
|
sensors.append(
|
||||||
|
OpenThermSensor(hass, var, device_class, unit, friendly_name))
|
||||||
|
async_add_entities(sensors)
|
||||||
|
|
||||||
|
|
||||||
|
class OpenThermSensor(Entity):
|
||||||
|
"""Representation of an OpenTherm Gateway sensor."""
|
||||||
|
|
||||||
|
def __init__(self, hass, var, device_class, unit, friendly_name):
|
||||||
|
"""Initialize the sensor."""
|
||||||
|
self.entity_id = async_generate_entity_id(ENTITY_ID_FORMAT, var,
|
||||||
|
hass=hass)
|
||||||
|
self._var = var
|
||||||
|
self._value = None
|
||||||
|
self._device_class = device_class
|
||||||
|
self._unit = unit
|
||||||
|
self._friendly_name = friendly_name
|
||||||
|
|
||||||
|
async def async_added_to_hass(self):
|
||||||
|
"""Subscribe to updates from the component."""
|
||||||
|
_LOGGER.debug("Added OpenTherm Gateway sensor %s", self._friendly_name)
|
||||||
|
async_dispatcher_connect(self.hass, SIGNAL_OPENTHERM_GW_UPDATE,
|
||||||
|
self.receive_report)
|
||||||
|
|
||||||
|
async def receive_report(self, status):
|
||||||
|
"""Handle status updates from the component."""
|
||||||
|
value = status.get(self._var)
|
||||||
|
if isinstance(value, float):
|
||||||
|
value = '{:2.1f}'.format(value)
|
||||||
|
self._value = value
|
||||||
|
self.async_schedule_update_ha_state()
|
||||||
|
|
||||||
|
@property
|
||||||
|
def name(self):
|
||||||
|
"""Return the friendly name of the sensor."""
|
||||||
|
return self._friendly_name
|
||||||
|
|
||||||
|
@property
|
||||||
|
def device_class(self):
|
||||||
|
"""Return the device class."""
|
||||||
|
return self._device_class
|
||||||
|
|
||||||
|
@property
|
||||||
|
def state(self):
|
||||||
|
"""Return the state of the device."""
|
||||||
|
return self._value
|
||||||
|
|
||||||
|
@property
|
||||||
|
def unit_of_measurement(self):
|
||||||
|
"""Return the unit of measurement."""
|
||||||
|
return self._unit
|
||||||
|
|
||||||
|
@property
|
||||||
|
def should_poll(self):
|
||||||
|
"""Return False because entity pushes its state."""
|
||||||
|
return False
|
||||||
Reference in New Issue
Block a user