Merge branch 'main' of github.com:OStrama/weishaupt_modbus

Author: MadOne

README.md

@@ -7,11 +7,10 @@ MadOne and OStrama are working together on this version.
 ## For users of MadOne's original weishaupt_modbus integration:
  * When doing nothing than simply installing the integration, the long term statistics will be split into new entities,
    since the sensor domain is different.
- * To avoid this, edit the file "const.py" in the integration's directory as follows:
-   replace the string
-     PREFIX = "weishaupt_wbb"
-   by
-     PREFIX = "weishaupt_modbus"
+ * To avoid this, change the default prefix entry in the configuration dialog from
+     weishaupt_wbb
+   to
+     weishaupt_modbus
    please do not change the intents or any other parts of the file to avoid issues
 
 ## For users of OStrama's weishaupt_wbb integration:
@@ -61,12 +60,18 @@ custom_components
 ```
 ## Configuration
 
-![Bildschirmfoto vom 2024-07-31 21-46-18](https://github.com/user-attachments/assets/45ad403e-c721-40bd-b723-95fe05fca5c5)
+![image](https://github.com/user-attachments/assets/8549938f-a059-4a92-988c-ba329f3cd758)
 
-Just enter the IP of your Weishaupt heatpump. Port should be ok at default unless you changed it in the Heatpump configuration.
+The only mandatory parameter is the IP-Address of your heatpump. The port should be ok at default unless you changed it in the Heatpump configuration.
+
+The "prefix" should only be changed when migrating from MadOnes original integration to this one to avoid splitting of sensor history
+
+The "Device Postfix" has a default value of "". It can be used to add multiple heat pumps to one home assistant. For compatibility this should be left empty. If you want to add another heat pump, use a name that help to identify the devices.
+
+The "Kennfeld-File" can be choosen to read in the right power mapping according to your type of heat pump:
 
 The heat power "Wärmeleistung" is calculated from the "Leistungsanforderung" in dependency of outside temperature and water temperature. 
-This is type specific. The data stored in the integration fit to a WBB 12. If you have another heat pump please update the "weishaupt_wbb_kennfeld.json" file according to the graphs foudn in the documentation of your heat pump. In the given file the data have been read out from the graphs found in the documentation in a manual way.
+This is type specific. The data stored in the integration fit to a WBB 12. If the file you've parameterized does not exist, the integration will create a file that fits for a WBB12. If you have another heat pump please update the Kennfeld-File file according to the graphs found in the documentation of your heat pump and restart Home Assistant. In the given file the data have been read out from the graphs found in the documentation in a manual way.
 
 
 You have to enable modbus in your heatpump settings. 

custom_components/weishaupt_modbus/__init__.py

@@ -1,5 +1,7 @@
 """init."""
 
+import warnings
+
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
 
@@ -39,6 +41,9 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     entry.runtime_data.close()
     unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
     if unload_ok:
-        hass.data[CONST.DOMAIN].pop(entry.entry_id)
+        try:
+            hass.data[CONST.DOMAIN].pop(entry.entry_id)
+        except KeyError:
+            warnings.warn("KeyError: " + CONST.DOMAIN)
 
     return unload_ok

custom_components/weishaupt_modbus/config_flow.py

@@ -5,16 +5,22 @@
 import voluptuous as vol
 
 from homeassistant import config_entries, exceptions
-from homeassistant.const import CONF_HOST, CONF_PORT
+from homeassistant.const import CONF_HOST, CONF_PORT, CONF_PREFIX
 from homeassistant.core import HomeAssistant
 import homeassistant.helpers.config_validation as cv
 
 # from . import wp
-from .const import CONST
+from .const import CONST, CONF_DEVICE_POSTFIX, CONF_KENNFELD_FILE
 
 # DATA_SCHEMA = vol.Schema({("host"): str, ("port"): cv.port})
 DATA_SCHEMA = vol.Schema(
-    {vol.Required(CONF_HOST): str, vol.Optional(CONF_PORT, default="502"): cv.port}
+    {
+        vol.Required(CONF_HOST): str,
+        vol.Optional(CONF_PORT, default="502"): cv.port,
+        vol.Optional(CONF_PREFIX, default=CONST.DEF_PREFIX): str,
+        vol.Optional(CONF_DEVICE_POSTFIX, default=""): str,
+        vol.Optional(CONF_KENNFELD_FILE, default=CONST.DEF_KENNFELDFILE): str,
+    }
 )
 
 

custom_components/weishaupt_modbus/const.py

@@ -12,17 +12,20 @@
     UnitOfVolumeFlowRate,
 )
 
+CONF_DEVICE_POSTFIX = "Device-Postfix"
+CONF_KENNFELD_FILE = "Kennfeld-File"
+
 
 @dataclass(frozen=True)
 class MainConstants:
     """Main constants."""
 
     DOMAIN = "weishaupt_modbus"
-    SCAN_INTERVAL = timedelta(minutes=1)
+    SCAN_INTERVAL = timedelta(seconds=30)
     UNIQUE_ID = "unique_id"
     APPID = 100
-    KENNFELDFILE = "weishaupt_wbb_kennfeld.json"
-    PREFIX = "weishaupt_wbb"
+    DEF_KENNFELDFILE = "weishaupt_wbb_kennfeld.json"
+    DEF_PREFIX = "weishaupt_wbb"
 
 
 CONST = MainConstants()

custom_components/weishaupt_modbus/entities.py

@@ -14,7 +14,7 @@
     SensorEntity,
     SensorStateClass,
 )
-from homeassistant.const import CONF_PORT
+from homeassistant.const import CONF_PORT, CONF_PREFIX, CONF_DOMAIN
 from homeassistant.core import callback
 from homeassistant.helpers.device_registry import DeviceInfo
 
@@ -24,7 +24,7 @@
     DataUpdateCoordinator,
 )
 
-from .const import CONST, FORMATS, TYPES  # , DOMAIN
+from .const import CONST, FORMATS, TYPES, CONF_DEVICE_POSTFIX  # , DOMAIN
 from .hpconst import DEVICES, TEMPRANGE_STD
 from .items import ModbusItem
 from .kennfeld import PowerMap
@@ -101,7 +101,7 @@ def __init__(self, hass, my_api, modbusitems):
             # Name of the data. For logging purposes.
             name="weishaupt-coordinator",
             # Polling interval. Will only be polled if there are subscribers.
-            update_interval=timedelta(seconds=30),
+            update_interval=CONST.SCAN_INTERVAL,
             # Set always_update to `False` if the data returned from the
             # api can be compared via `__eq__` to avoid duplicate updates
             # being dispatched to listeners
@@ -239,8 +239,23 @@ def __init__(self, config_entry, modbus_item, modbus_api) -> None:
         self._config_entry = config_entry
         self._modbus_item = modbus_item
         self._attr_name = self._modbus_item.name
-        self._attr_unique_id = CONST.PREFIX + self._modbus_item.name
-        self._dev_device = self._modbus_item.device
+
+        dev_postfix = ""
+        try:
+            dev_postfix = "_" + self._config_entry.data[CONF_DEVICE_POSTFIX]
+        except KeyError:
+            warnings.warn("Device postfix not defined, use default: ")
+
+        dev_prefix = CONST.DEF_PREFIX
+        try:
+            dev_prefix = "_" + self._config_entry.data[CONF_PREFIX]
+        except KeyError:
+            warnings.warn("Device prefix not defined, use default: " + CONST.DEF_PREFIX)
+
+        self._attr_unique_id = (
+            dev_prefix + self._modbus_item.name + dev_postfix
+        )  # CONST.PREFIX + self._modbus_item.name
+        self._dev_device = self._modbus_item.device + dev_postfix
         self._modbus_api = modbus_api
 
         if self._modbus_item._format != FORMATS.STATUS:
@@ -388,10 +403,11 @@ class MyCalcSensorEntity(MySensorEntity):
     """
 
     # calculates output from map
-    my_map = PowerMap()
+    my_map = None
 
     def __init__(self, config_entry, modbus_item, coordinator, idx) -> None:
         MySensorEntity.__init__(self, config_entry, modbus_item, coordinator, idx)
+        self.my_map = PowerMap(self._config_entry)
 
     @callback
     def _handle_coordinator_update(self) -> None:

custom_components/weishaupt_modbus/kennfeld.py

@@ -6,7 +6,7 @@
 from numpy.polynomial import Chebyshev
 # from scipy.interpolate import CubicSpline
 
-from .const import CONST
+from .const import CONF_KENNFELD_FILE
 
 
 class PowerMap:
@@ -71,19 +71,26 @@ class PowerMap:
 
     interp_y = []
 
-    def __init__(self) -> None:
+    _config_entry = None
+
+    def __init__(self, config_entry) -> None:
         """Initialise the PowerMap class."""
         # try to load values from json file
+        self._config_entry = config_entry
 
         try:
-            openfile = open(CONST.KENNFELDFILE, "r", encoding="utf-8")
+            openfile = open(
+                self._config_entry.data[CONF_KENNFELD_FILE], "r", encoding="utf-8"
+            )
         except IOError:
             kennfeld = {
                 "known_x": self.known_x,
                 "known_y": self.known_y,
                 "known_t": self.known_t,
             }
-            with open(CONST.KENNFELDFILE, "w", encoding="utf-8") as outfile:
+            with open(
+                self._config_entry.data[CONF_KENNFELD_FILE], "w", encoding="utf-8"
+            ) as outfile:
                 json.dump(kennfeld, outfile)
         else:
             json_object = json.load(openfile)