Version 1.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 MadOne
+Copyright (c) 2024 OStrama
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,20 +1,46 @@
+This is the successor of the integration from MadOne.
+MadOne and OStrama are working together on this version.
+
+# With version 1.0.0 we consolidate both versions. 
+# In this version this will have the following impact:
+(For updates from 1.0.0 to newer versions, this procedure is not longer needed.)
+
+## For users of MadOne's original weishaupt_modbus integration:
+ * Remove the Heatpump configuration.
+ * In HACS remove the integration completely
+ * Restart Home Assistant
+ * Add this Repository to HACS as descriped in Installation
+ * 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, change the default prefix entry in the configuration dialog from
+     weishaupt_wbb
+   to
+     weishaupt_modbus
+
+
+## For users of OStrama's weishaupt_wbb integration:
+ * Uninstall existing "weishaupt_wbb" installation, answer "integration and all entities of it will be deleted" with"yes"
+ * Restart home assistant
+ * Install new weishaupt_wbb integration
+ * You will get a new integration with the same name
+ * the sensor entities will be the same than before
+
+All modbus parameters of this integration are concentrated in the file hpconst.py as a set of object lists.
+This allows generic setup of all entities and a more easy completion of messages and entity behavior
+
 # Weishaupt_modbus
 
-This integration lets you monitor and controll your weishaupt heatpump through modbus.
+This integration lets you monitor and control your weishaupt heatpump through modbus.
 This is how it might look:
-![Bildschirmfoto vom 2024-07-31 21-41-56](https://github.com/user-attachments/assets/3fde9b18-f9ea-4e75-94ee-25ef6f799dcf)
+![image](https://github.com/user-attachments/assets/00e7b8fa-1779-428d-9361-7c66e228c2c6)
 
 ## Installation
 
-### Install through HACS 
-
-- Not working yet
-
 ### HACS (manually add Repository)
 
 Add this repository to HACS.
 * In the HACS GUI, select "Custom repositories"
-* Enter the following repository URL: https://github.com/MadOne/weishaupt_modbus/releases
+* Enter the following repository URL: https://github.com/OStrama/weishaupt_modbus/releases
 * Category: Integration
 * After adding the integration, restart Home Assistant.
 * Now under Configuration -> Integrations, "Weishaupt Modbus Integration" should be available.
@@ -38,11 +64,40 @@ 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)
+
+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 power mapping file
+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 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 change the name of the used file by reconfiguring the integration and change only the file name. It may be necessary to restart home assistant after changing the filename.
+When no file is available, a new file with the defined name will be created that contains the parameters read out from the graphs found in the documentation of WBB 12 in a manual way. Thsi file can be used as a template for another typer of heatpump.
+(Note: It would be great if you could provide files from other types of heatpumps to us, so that we can integrate them in further versions ;-))
 
-Just enter the IP of your Weishaupt heatpump. Port should be ok at default unless you changed it in the Heatpump configuration.
 
 You have to enable modbus in your heatpump settings. 
 
+## Setting up the HeatPump
+
+In order to use this integration you have to enable modbus in your heatpump.
+Go to:
+User -> Settings (second Page) -> Modbus TCP
+
+**Parameter: On**
+
+**Network**: Here you have 2 options. Either you place the IP of your HomeAssistent to exclusively allow this ip to connect to the heatpump via ModBus or you place your network to allow all the IPs in that range.
+For example: **192.168.178.123** (Home Assistant IP) or 192.168.178.0 for all ips between 192.168.178.1 and 192.167.178.254.
+Option 1 is the savest but Option 2 enables you to connect to the heatpump from multiple devices(developing machine, or maybe my possibly upcomming dedicated android app?). I suggest to go for option 1 (HomeAssistant IP).
+
+**Netmask**: Select the netmask of your network. This will be **255.255.255.000** for you otherwise you would know the correct one ;)
+
+# Disclaimer
+The developers of this integration are not affiliated with Weishaupt. They have created the integration as open source in their spare time on the basis of publicly accessible information. 
+The use of the integration is at the user's own risk and responsibility. The developers are not liable for any damages arising from the use of the integration.
 
-ToDo: Pictures and explanation of how to enable modbus

custom_components/weishaupt_modbus/__init__.py

@@ -1,39 +1,95 @@
-"""Weishaupt Modbus Integration."""
+"""init."""
+
+import warnings
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import HomeAssistant
+from homeassistant.const import CONF_PREFIX
 
-from .const import DOMAIN
+from .const import (
+    CONST,
+    CONF_DEVICE_POSTFIX,
+    CONF_KENNFELD_FILE,
+    CONF_HK2,
+    CONF_HK3,
+    CONF_HK4,
+    CONF_HK5,
+    CONF_NAME_DEVICE_PREFIX,
+    CONF_NAME_TOPIC_PREFIX,
+)
+from .modbusobject import ModbusAPI
 
 PLATFORMS: list[str] = [
     "number",
     "select",
     "sensor",
-    "switch",
+    #    "switch",
 ]
 
 
 # Return boolean to indicate that initialization was successful.
 # return True
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
-    """Set up Hello World from a config entry."""
+    """Set up entry."""
     # Store an instance of the "connecting" class that does the work of speaking
     # with your actual devices.
     # hass.data.setdefault(DOMAIN, {})[entry.entry_id] = hub.Hub(hass, entry.data["host"])
+    mbapi = ModbusAPI(entry)
+    await mbapi.connect()
+    entry.runtime_data = mbapi
 
     # This creates each HA object for each platform your device requires.
     # It's done by calling the `async_setup_entry` function in each platform module.
     await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
     return True
 
 
+async def async_migrate_entry(hass: HomeAssistant, config_entry: ConfigEntry):
+    """Migrate old entry."""
+    if config_entry.version > 3:
+        # This means the user has downgraded from a future version
+        return False
+
+    # to ensure all update paths we have to check every version to not overwrite existing entries
+    if config_entry.version < 4:
+        warnings.warn("Old Version detected")
+        new_data = {**config_entry.data}
+
+    if config_entry.version < 2:
+        warnings.warn("Version <2 detected")
+        new_data[CONF_PREFIX] = CONST.DEF_PREFIX
+        new_data[CONF_DEVICE_POSTFIX] = ""
+        new_data[CONF_KENNFELD_FILE] = CONST.DEF_KENNFELDFILE
+    if config_entry.version < 3:
+        warnings.warn("Version <3 detected")
+        new_data[CONF_HK2] = False
+        new_data[CONF_HK3] = False
+        new_data[CONF_HK4] = False
+        new_data[CONF_HK5] = False
+    if config_entry.version < 4:
+        warnings.warn("Version <4 detected")
+        new_data[CONF_NAME_DEVICE_PREFIX] = False
+        new_data[CONF_NAME_TOPIC_PREFIX] = False
+
+        hass.config_entries.async_update_entry(
+            config_entry, data=new_data, minor_version=1, version=4
+        )
+        warnings.warn("Config entries updated to version 4")
+
+    return True
+
+
 async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
-    """Unload a config entry."""
+    """Unload entry."""
     # This is called when an entry/configured device is to be removed. The class
     # needs to unload itself, and remove callbacks. See the classes for further
     # details
+    entry.runtime_data.close()
     unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
     if unload_ok:
-        hass.data[DOMAIN].pop(entry.entry_id)
+        try:
+            hass.data[CONST.DOMAIN].pop(entry.entry_id)
+        except KeyError:
+            warnings.warn("KeyError: " + str(CONST.DOMAIN))
 
     return unload_ok