postlund · MichaelB2018 · Mar 17, 2026 · Apr 2, 2026
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,25 @@
 # Changelog
 
+**Version 2.0.0**
+
+* Added UI config flow with manual setup and SSDP auto-discovery
+* Added options flow for configurable scan interval and motion timeout
+* Added DataUpdateCoordinator for centralized polling
+* Added temperature sensor support
+* Added firmware version diagnostic sensor
+* Added device info (manufacturer, model, firmware version, hardware version)
+* Added diagnostics support with sensitive data redaction
+* Added English translations
+* Migrated from legacy platform setup to modern integration architecture
+* Automatic migration from YAML configuration to config entries
+* Bumped minimum Home Assistant version to 2024.4.0
+
+*Fixes:*
+* Fixed deprecated `DEVICE_CLASS_*` imports causing load failure on HA 2025.1+ ([Upstream #18](https://github.com/postlund/dlink_hnap/issues/18))
+* Fixed excessive error logging when device is in power-saving mode or unreachable ([Upstream #12](https://github.com/postlund/dlink_hnap/issues/12))
+* Fixed missing device health/availability indication ([Upstream #17](https://github.com/postlund/dlink_hnap/issues/17))
+* Fixed compatibility issues with Home Assistant 2025.2.x ([Upstream #21](https://github.com/postlund/dlink_hnap/issues/21))
+
 **Version 0.2.0**
 
 * Added support for water leakage sensor (DCH-S160)

diff --git a/README.md b/README.md
@@ -1,36 +1,115 @@
-![Validate with hassfest](https://github.com/postlund/dlink_hnap/workflows/Validate%20with%20hassfest/badge.svg)
-![HACS Validation](https://github.com/postlund/dlink_hnap/workflows/HACS%20Validation/badge.svg)
-[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/custom-components/hacs)
+[![Validate with hassfest](https://github.com/MichaelB2018/dlink_hnap/actions/workflows/hassfest.yaml/badge.svg)](https://github.com/MichaelB2018/dlink_hnap/actions/workflows/hassfest.yaml)
+[![HACS Validation](https://github.com/MichaelB2018/dlink_hnap/actions/workflows/validate.yaml/badge.svg)](https://github.com/MichaelB2018/dlink_hnap/actions/workflows/validate.yaml)
+[![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg)](https://github.com/custom-components/hacs)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
 
 # D-Link HNAP
 
-This is an experimental integration to Home Assistant supporting D-Link devices. It communicates
-locally with the devices, i.e. no cloud needed, but only supports polling.
+A [Home Assistant](https://www.home-assistant.io/) custom integration for D-Link sensors using the HNAP protocol.
 
-The following devices are supported:
+This repository is a community-maintained fork of the original integration. Upstream improvements have not been merged, so releases are published here for users who want the maintained version.
 
-* Motion Sensor (DCH-S150)
-* Water Leakage Sensor (DCH-S160 and DCH-S161)
+**Key features:**
 
-*DISCLAIMER: Currently I don't use any of these devices. So I cannot test the integration. It is
-provided as reference and for the community to maintain. Please send PRs!*
+- **100% local** — communicates directly with devices on your network, no cloud or internet required
+- **UI configurable** — full config flow with step-by-step setup from the Home Assistant UI
+- **Auto-discovery** — automatically finds D-Link devices on your network via SSDP
+- **Automatic capability detection** — probes the device and creates only the entities it supports
+- **Configurable options** — adjust polling interval and motion timeout from the UI without restarting
+- **Device info** — registers devices with manufacturer, model, firmware version, and hardware version
+- **Diagnostics** — built-in diagnostics download with automatic redaction of sensitive data
+- **YAML migration** — legacy YAML configurations are automatically imported as config entries
+
+## Supported Devices
+
+| Device | Model | Capabilities |
+| ------ | ----- | ------------ |
+| Motion Sensor | DCH-S150 | Motion detection |
+| Water Leakage Sensor | DCH-S160, DCH-S161 | Water detection, Temperature |
+
+Other D-Link HNAP-compatible devices may also work. The integration automatically detects which capabilities a device supports by querying its available SOAP actions.
+
+## Entities
+
+The integration auto-creates entities based on device capabilities:
+
+| Entity | Type | Device Class | Description |
+| ------ | ---- | ------------ | ----------- |
+| Water Detected | Binary Sensor | `moisture` | `on` when water is detected. Only created for devices with water detection capability. |
+| Motion Detected | Binary Sensor | `motion` | `on` when motion is detected, turns `off` after the configured motion timeout. Only created for devices with motion detection capability. |
+| Temperature | Sensor | `temperature` | Current temperature reading in °C. Only created for devices that report temperature. |
+| Firmware Version | Sensor | *(diagnostic)* | Reports the device firmware version. Always created for all devices. |
+
+All entities are associated with a **device** in the Home Assistant device registry, showing manufacturer (D-Link), model, firmware version, and hardware version.
 
 ## Installation
 
 ### HACS _(preferred method)_
 
-This integration is available in the default repository list, just search for it!
+1. Open HACS in your Home Assistant instance
+2. Go to **Integrations** and open the three-dot menu
+3. Select **Custom repositories**
+4. Add `https://github.com/MichaelB2018/dlink_hnap` as category **Integration**
+5. Search for **D-Link HNAP** in HACS and click **Download**
+6. Restart Home Assistant
 
 ### Manual install
 
-Place the `custom_components` folder in your configuration directory
-(or add its contents to an existing `custom_components` folder).
+1. Copy the `custom_components/dlink_hnap` folder into your Home Assistant `config/custom_components/` directory
+2. Restart Home Assistant
 
 ## Configuration
 
-This integration does not support config flows yet, so you need to add
-it in `configuration.yaml`:
+### UI Setup (recommended)
+
+1. In Home Assistant, go to **Settings** → **Devices & Services**
+2. Click **+ Add Integration** (bottom right)
+3. Search for **D-Link HNAP**
+4. Fill in the connection details:
+
+| Field | Description |
+| ----- | ----------- |
+| **Host** | IP address or hostname of the D-Link device (e.g. `192.168.1.50`) |
+| **Username** | Authentication username — almost always `Admin` (pre-filled) |
+| **Password** | The PIN code printed on the device label |
+
+5. Click **Submit** — the integration will connect to the device, verify credentials, and detect capabilities
+6. Entities are created automatically based on what the device supports
+
+> **Tip:** The PIN code is typically printed on a label on the back or bottom of the device.
+
+### SSDP Auto-Discovery
+
+If a D-Link device is on your local network, Home Assistant will automatically discover it via SSDP. When discovered:
+
+1. A notification appears: *"D-Link device discovered"*
+2. Click the notification or go to **Settings** → **Devices & Services**
+3. You'll see the discovered device — click **Configure**
+4. Enter the **Username** and **PIN code** (password)
+5. Click **Submit** to complete setup
+
+### Options
+
+After a device is configured, you can adjust settings without restarting:
+
+1. Go to **Settings** → **Devices & Services**
+2. Find the **D-Link HNAP** integration and click **Configure**
+3. Adjust the options:
+
+| Option | Default | Range | Description |
+| ------ | ------- | ----- | ----------- |
+| **Update interval** | 30 seconds | 5–300 seconds | How frequently the device is polled for new data. Lower values give faster updates but increase network traffic. |
+| **Motion timeout** | 30 seconds | 5–600 seconds | How long after the last detected motion before the motion sensor entity turns `off`. Only relevant for motion-capable devices. |
+
+4. Click **Submit** — changes take effect immediately (the integration reloads automatically)
+
+## Legacy YAML Configuration *(deprecated)*
+
+> ⚠️ **YAML configuration is deprecated and will be removed in a future version.**
+> Existing YAML configurations are **automatically migrated** to UI config entries on the next restart.
+> After migration, you can safely remove the `dlink_hnap` entries from your `configuration.yaml`.
+
+The legacy YAML format is shown below for reference only:
 
 ```yaml
 binary_sensor:
@@ -49,13 +128,76 @@ binary_sensor:
     password: 123456
 ```
 
-Here are the configuration options:
+<details>
+<summary>Legacy YAML configuration options</summary>
+
+| Key | Required | Type | Default | Description |
+| --- | -------- | ---- | ------- | ----------- |
+| `name` | No | string | `D-Link Motion Sensor` | Name for the sensor |
+| `type` | **Yes** | string | | Sensor type: `motion` or `water` |
+| `host` | **Yes** | string | | IP address of the device |
+| `username` | No | string | `Admin` | Username for authentication |
+| `password` | **Yes** | string | | PIN code printed on the device |
+| `timeout` | No | int | `35` | Seconds before motion sensor turns `off` after last trigger (motion only) |
+
+</details>
+
+## Diagnostics
+
+This integration supports Home Assistant's built-in diagnostics feature:
+
+1. Go to **Settings** → **Devices & Services** → **D-Link HNAP**
+2. Click on the device
+3. Click the three-dot menu (⋮) → **Download diagnostics**
+
+The diagnostics file includes:
+- Configuration entry data (with password redacted)
+- Configured options (scan interval, motion timeout)
+- Detected device capabilities
+- Current device data (with serial number redacted)
+
+## Troubleshooting
+
+| Problem | Solution |
+| ------- | -------- |
+| **"Failed to connect"** during setup | Verify the IP address is correct and the device is powered on and reachable. Try pinging the device. |
+| **"Invalid username or password"** | The password is the numeric PIN code on the device label, not a user-chosen password. Username is almost always `Admin`. |
+| **Entities not appearing** | The integration only creates entities for capabilities the device reports. Check diagnostics to see detected capabilities. |
+| **Motion sensor stuck on** | Increase the motion timeout in Options. The sensor turns `off` only after no motion is detected for the configured timeout period. |
+| **Stale data / slow updates** | Decrease the scan interval in Options (minimum 5 seconds). Note that very low values increase network traffic. |
+| **Device becomes unavailable** | The device may have changed IP address. Delete and re-add the integration with the new IP, or assign a static IP/DHCP reservation. |
+
+## How It Works
+
+This integration communicates with D-Link devices using the **HNAP** (Home Network Administration Protocol) over SOAP/HTTP. The protocol flow is:
+
+1. **Authentication** — A challenge-response handshake using HMAC-MD5, establishing a session cookie
+2. **Capability detection** — Queries the device's supported SOAP actions to determine which sensors are available
+3. **Polling** — Periodically fetches sensor data (water state, motion events, temperature) based on detected capabilities
+
+All communication happens locally on your network. No data is sent to the cloud.
+
+## Resolved Issues
+
+Version 2.0.0 addresses the following open issues:
+
+| Issue | Description | How it's resolved |
+| ----- | ----------- | ----------------- |
+| [Upstream #18](https://github.com/postlund/dlink_hnap/issues/18) | 2025.1.b5 failed to load sensor | Removed deprecated `DEVICE_CLASS_MOTION` / `DEVICE_CLASS_MOISTURE` imports; fully rewritten with modern `BinarySensorDeviceClass` enums |
+| [Upstream #21](https://github.com/postlund/dlink_hnap/issues/21) | DLink HNAP issues with HA 2025.2.x | Complete rewrite resolves all compatibility issues with modern Home Assistant |
+| [Upstream #12](https://github.com/postlund/dlink_hnap/issues/12) | Excessive errors when device is in power-saving mode | `DataUpdateCoordinator` rate-limits error logging; proper `CannotConnect` → `UpdateFailed` handling avoids log spam; configurable scan interval reduces poll frequency |
+| [Upstream #17](https://github.com/postlund/dlink_hnap/issues/17) | No device health / offline indication | `DataUpdateCoordinator` automatically marks entities as **unavailable** when the device can't be reached — standard HA device health pattern |
+| [Upstream #20](https://github.com/postlund/dlink_hnap/issues/20) | DCH-S162 not working | Automatic capability detection probes each device's SOAP actions, so any HNAP-compatible device should work. *(Note: The DCH-S162 may use a different protocol — cannot verify without hardware)* |
+
+Not yet addressed: [Upstream #11](https://github.com/postlund/dlink_hnap/issues/11) (Battery attribute) — The SOAP action name for battery state is unknown. Contributions from users with battery-powered devices (DCH-S161) are welcome.
+
+## Credits
+
+- **[Pierre Ståhl](https://github.com/postlund)** — Original author of the integration and HNAP protocol implementation
+- **[Kyle Cackett](https://github.com/kyle-cackett)** — Bug fixes and compatibility updates
+- **[Roger Selwyn](https://github.com/RogerSelwyn)** — Contributions
+- **[MichaelB2018](https://github.com/MichaelB2018)** — Maintained fork releases, v2.0.0 architecture update, config flow, SSDP discovery, coordinator, options flow, temperature sensor, diagnostics, and modern HA architecture
+
+## License
 
-key | optional | type | default | description
--- | -- | -- | -- | --
-`name` | True | string | D-Link Motion Sensor | Name for the sensor
-`type` | False | string | | Sensor type: motion or water
-`host` | False | string | | IP address to sensor
-`username` | True | string | Admin | Username for authentication (always Admin)
-`password` | False | int | | PIN code written on the device
-`timeout` | True | int | 35 | Amount of seconds before sensor going to `off` after *last* motion (only used when `type` is `motion`)
+This project is licensed under the [MIT License](LICENSE).
diff --git a/custom_components/dlink_hnap/__init__.py b/custom_components/dlink_hnap/__init__.py
@@ -1 +1,72 @@
 """D-Link HNAP integration."""
+from __future__ import annotations
+
+import logging
+from typing import Any
+
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
+from homeassistant.core import HomeAssistant
+
+from .const import DOMAIN, PLATFORMS
+from .coordinator import HNAPDataUpdateCoordinator
+
+_LOGGER = logging.getLogger(__name__)
+
+
+async def async_setup(hass: HomeAssistant, config: dict[str, Any]) -> bool:
+    """Set up D-Link HNAP from YAML (import to config entry)."""
+    hass.data.setdefault(DOMAIN, {})
+
+    # Check for legacy YAML binary_sensor platform config and import it
+    if "binary_sensor" in config:
+        for platform_config in config["binary_sensor"]:
+            if platform_config.get("platform") != DOMAIN:
+                continue
+
+            _LOGGER.info(
+                "Migrating D-Link HNAP YAML configuration to config entry"
+            )
+            hass.async_create_task(
+                hass.config_entries.flow.async_init(
+                    DOMAIN,
+                    context={"source": "import"},
+                    data={
+                        CONF_HOST: platform_config[CONF_HOST],
+                        CONF_USERNAME: platform_config.get(CONF_USERNAME, "Admin"),
+                        CONF_PASSWORD: platform_config[CONF_PASSWORD],
+                    },
+                )
+            )
+
+    return True
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Set up D-Link HNAP from a config entry."""
+    coordinator = HNAPDataUpdateCoordinator(hass, entry)
+    await coordinator.async_config_entry_first_refresh()
+
+    hass.data.setdefault(DOMAIN, {})
+    hass.data[DOMAIN][entry.entry_id] = coordinator
+
+    await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
+
+    entry.async_on_unload(entry.add_update_listener(_async_update_listener))
+
+    return True
+
+
+async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Unload a D-Link HNAP config entry."""
+    unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
+
+    if unload_ok:
+        hass.data[DOMAIN].pop(entry.entry_id, None)
+
+    return unload_ok
+
+
+async def _async_update_listener(hass: HomeAssistant, entry: ConfigEntry) -> None:
+    """Handle options update — reload the config entry."""
+    await hass.config_entries.async_reload(entry.entry_id)