Preparing for public release

2026-01-19 14:02:06 +02:00
parent 4b6b3b3822
commit 75753494ab
19 changed files with 1040 additions and 17 deletions
@@ -0,0 +1,124 @@
+---
+layout: default
+title: Configuration
+nav_order: 3
+---
+
+# Configuration
+
+## Finding Your Heat Pump URL
+
+The integration requires the URL to your heat pump's status API. The format is typically:
+
+```
+http://<HEAT_PUMP_IP>/installedplugin/com.innova.pdc/<VERSION>/server/index.php?Action=GetStatus
+```
+
+### Method 1: Browser Developer Tools
+
+1. Access your heat pump's web interface in a browser
+2. Open browser developer tools (F12)
+3. Navigate to the **Network** tab
+4. Refresh the page or navigate the heat pump interface
+5. Look for requests to `index.php?Action=GetStatus`
+6. Copy the full URL
+
+![Finding URL in DevTools](assets/images/devtools-network.png)
+*Use browser developer tools to find the correct API URL*
+
+### Method 2: Common URL Patterns
+
+Try these common URL patterns (replace IP with your heat pump's IP):
+
+```
+http://192.168.1.100/installedplugin/com.innova.pdc/2.0.10/server/index.php?Action=GetStatus
+http://192.168.1.100/installedplugin/com.innova.pdc/3.0.49/server/index.php?Action=GetStatus
+```
+
+### Verify Your URL
+
+Open the URL in a browser. You should see a JSON response like:
+
+```json
+{
+  "success": true,
+  "sw": { "V": "3.0.49" },
+  "RESULT": {
+    "status": {
+      "watert1": 32.1,
+      "watert2": 32.0,
+      "heating": true,
+      ...
+    }
+  }
+}
+```
+
+![JSON Response](assets/images/json-response.png)
+*Expected JSON response when accessing the URL*
+
+## Configuration Wizard
+
+### Step 1: Enter URL
+
+When adding the integration, enter your heat pump URL:
+
+![Enter URL](assets/images/config-url.png)
+*Enter the heat pump status URL*
+
+### Step 2: Set Update Interval
+
+Optionally configure the update interval (default: 3 seconds):
+
+| Setting | Description | Recommended |
+|---------|-------------|-------------|
+| 1-2 seconds | Very frequent updates | High network load |
+| 3 seconds | Default, good balance | Recommended |
+| 5-10 seconds | Less frequent | Low network load |
+
+![Update Interval](assets/images/config-interval.png)
+*Configure the polling interval*
+
+### Step 3: Confirm Configuration
+
+Review and confirm your settings:
+
+![Confirm Config](assets/images/config-confirm.png)
+*Review configuration before completing setup*
+
+## Configuration Options
+
+After initial setup, you can modify options:
+
+1. Go to **Settings** > **Devices & Services**
+2. Find "Heat Pump Monitor"
+3. Click **Configure**
+
+![Reconfigure](assets/images/reconfigure.png)
+*Access configuration options after setup*
+
+## Entity Customization
+
+After setup, you may want to customize entities:
+
+### Rename Entities
+
+1. Go to **Settings** > **Devices & Services**
+2. Click on the Heat Pump device
+3. Click on an entity
+4. Change the name as desired
+
+![Rename Entity](assets/images/rename-entity.png)
+*Customize entity names*
+
+### Hide Unused Entities
+
+If some sensors don't apply to your setup:
+
+1. Click on the entity
+2. Toggle "Enable" off
+
+## Next Steps
+
+- [Set up the dashboard](dashboard.md)
+- [Troubleshoot issues](troubleshooting.md)