Multiple devices support for opentherm_gw (#22932)
* Breaking change: Rewrite opentherm_gw to add support for more than one OpenTherm Gateway. Breaks config layout and child entity ids and adds a required parameter to all service calls (gateway_id). * Add schema and parameter description for service opentherm_gw.reset_gateway. * Add optional name attribute in config to be used for friendly names. Fix bugs in binary_sensor and climate platforms. * pylint fixes * Remove unused variables. * Update manifest.json, remove REQUIREMENTS from .py file * Update CODEOWNERS * Address issues that were brought up (requested changes): - Move imports to module level - Change certain functions from async to sync - Move constants to const.py (new file) - Call gateway setup from outside of __init__() - Move validation of monitored_variables to config schema * Address requested changes: - Make module imports relative - Move more functions from async to sync, decorate with @callback where necessary - Remove monitored_variables option, add all sensors by default
This commit is contained in:
mvn23
Martin Hjelmare
parent
d9f2a406f6
commit
43a6be6471
8 changed files with 486 additions and 519 deletions
|
|
@ -2,175 +2,55 @@
|
|||
import logging
|
||||
|
||||
from homeassistant.components.sensor import ENTITY_ID_FORMAT
|
||||
from homeassistant.const import DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS
|
||||
from homeassistant.core import callback
|
||||
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
||||
from homeassistant.helpers.entity import Entity, async_generate_entity_id
|
||||
|
||||
from . import DATA_GW_VARS, DATA_OPENTHERM_GW, SIGNAL_OPENTHERM_GW_UPDATE
|
||||
from .const import DATA_GATEWAYS, DATA_OPENTHERM_GW, SENSOR_INFO
|
||||
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
UNIT_BAR = 'bar'
|
||||
UNIT_HOUR = 'h'
|
||||
UNIT_KW = 'kW'
|
||||
UNIT_L_MIN = 'L/min'
|
||||
UNIT_PERCENT = '%'
|
||||
|
||||
|
||||
async def async_setup_platform(
|
||||
hass, config, async_add_entities, discovery_info=None):
|
||||
"""Set up the OpenTherm Gateway sensors."""
|
||||
if discovery_info is None:
|
||||
return
|
||||
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_TOTAL_BURNER_STARTS: [
|
||||
None, None, "Total 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_TOTAL_BURNER_HOURS: [
|
||||
None, UNIT_HOUR, "Total 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"],
|
||||
gw_vars.OTGW_MODE: [None, None, "Gateway/Monitor Mode"],
|
||||
gw_vars.OTGW_DHW_OVRD: [None, None, "Gateway Hot Water Override Mode"],
|
||||
gw_vars.OTGW_ABOUT: [None, None, "Gateway Firmware Version"],
|
||||
gw_vars.OTGW_BUILD: [None, None, "Gateway Firmware Build"],
|
||||
gw_vars.OTGW_CLOCKMHZ: [None, None, "Gateway Clock Speed"],
|
||||
gw_vars.OTGW_LED_A: [None, None, "Gateway LED A Mode"],
|
||||
gw_vars.OTGW_LED_B: [None, None, "Gateway LED B Mode"],
|
||||
gw_vars.OTGW_LED_C: [None, None, "Gateway LED C Mode"],
|
||||
gw_vars.OTGW_LED_D: [None, None, "Gateway LED D Mode"],
|
||||
gw_vars.OTGW_LED_E: [None, None, "Gateway LED E Mode"],
|
||||
gw_vars.OTGW_LED_F: [None, None, "Gateway LED F Mode"],
|
||||
gw_vars.OTGW_GPIO_A: [None, None, "Gateway GPIO A Mode"],
|
||||
gw_vars.OTGW_GPIO_B: [None, None, "Gateway GPIO B Mode"],
|
||||
gw_vars.OTGW_SB_TEMP: [
|
||||
DEVICE_CLASS_TEMPERATURE, TEMP_CELSIUS,
|
||||
"Gateway Setback Temperature"],
|
||||
gw_vars.OTGW_SETP_OVRD_MODE: [
|
||||
None, None, "Gateway Room Setpoint Override Mode"],
|
||||
gw_vars.OTGW_SMART_PWR: [None, None, "Gateway Smart Power Mode"],
|
||||
gw_vars.OTGW_THRM_DETECT: [None, None, "Gateway Thermostat Detection"],
|
||||
gw_vars.OTGW_VREF: [None, None, "Gateway Reference Voltage Setting"],
|
||||
}
|
||||
gw_dev = hass.data[DATA_OPENTHERM_GW][DATA_GATEWAYS][discovery_info]
|
||||
sensors = []
|
||||
for var in discovery_info:
|
||||
device_class = sensor_info[var][0]
|
||||
unit = sensor_info[var][1]
|
||||
friendly_name = sensor_info[var][2]
|
||||
entity_id = async_generate_entity_id(ENTITY_ID_FORMAT, var, hass=hass)
|
||||
sensors.append(
|
||||
OpenThermSensor(entity_id, var, device_class, unit, friendly_name))
|
||||
for var, info in SENSOR_INFO.items():
|
||||
device_class = info[0]
|
||||
unit = info[1]
|
||||
friendly_name_format = info[2]
|
||||
sensors.append(OpenThermSensor(gw_dev, var, device_class, unit,
|
||||
friendly_name_format))
|
||||
async_add_entities(sensors)
|
||||
|
||||
|
||||
class OpenThermSensor(Entity):
|
||||
"""Representation of an OpenTherm Gateway sensor."""
|
||||
|
||||
def __init__(self, entity_id, var, device_class, unit, friendly_name):
|
||||
def __init__(self, gw_dev, var, device_class, unit, friendly_name_format):
|
||||
"""Initialize the OpenTherm Gateway sensor."""
|
||||
self.entity_id = entity_id
|
||||
self.entity_id = async_generate_entity_id(
|
||||
ENTITY_ID_FORMAT, '{}_{}'.format(var, gw_dev.gw_id),
|
||||
hass=gw_dev.hass)
|
||||
self._gateway = gw_dev
|
||||
self._var = var
|
||||
self._value = None
|
||||
self._device_class = device_class
|
||||
self._unit = unit
|
||||
self._friendly_name = friendly_name
|
||||
self._friendly_name = friendly_name_format.format(gw_dev.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,
|
||||
async_dispatcher_connect(self.hass, self._gateway.update_signal,
|
||||
self.receive_report)
|
||||
|
||||
async def receive_report(self, status):
|
||||
@callback
|
||||
def receive_report(self, status):
|
||||
"""Handle status updates from the component."""
|
||||
value = status.get(self._var)
|
||||
if isinstance(value, float):
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue