Merge pull request #36 from 3dg1luk43/0.3.2

0.3.2

Author: 3dg1luk43

.gitignore

@@ -10,6 +10,6 @@ tests/__pycache__
 ha_washdata.code-workspace
 devtools/secrets.py
 .gitignore
-cycle_data
 custom_components/ha_washdata/test_data
-tests/repro/__pycache__
+tests/repro/__pycache__
+cycle_data

CHANGELOG.md

@@ -5,6 +5,26 @@ All notable changes to HA WashData will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.2] - 2026-01-02
+
+### Added
+- **Manual Control**: "Force End Cycle" button to manually terminate stuck cycles (treats as "Completed" and saves data).
+- **Reliability**: "Cycle Resurrection" logic to restore active cycle state after Home Assistant restarts.
+- **Reliability**: "Smart Resume" estimation to provide progress updates during "detecting..." phase based on historical averages.
+- **Smart Cycle Extension**: New feature to prevent premature cycle termination during long low-power phases (e.g., dishwasher drying).
+- **Statistics**: Energy (kWh) estimates added to Profile Statistics table.
+- **UI**: Added legends to profile graphs and scaled them up by 50% for better readability.
+- **Config Flow**: Split "Manage Data" into "Manage Cycles" and "Manage Profiles" menus for better usability.
+- **Config Flow**: Added ability to manually edit profile "Average Duration" for tuning Smart Extension.
+
+### Fixed
+- **Icons**: Fixed missing icon for "Cycle Program" select entity (now dynamically adapts to device type).
+- **Frontend**: Added missing "min" unit to "Time Remaining" display on card.
+- **Logic**: Improved filtering of "Ghost Cycles" (extremely short noise events).
+- **Bug**: Fixed JSON serialization error preventing status updates in some cases.
+- **Bug**: Ensure stats are immediately rebuilt after merging cycles.
+- **Translation Keys**: Corrected missing labels for "Smart Extension Threshold" and other advanced settings.
+
 ## [0.3.1] - 2024-12-31
 
 ### Added

README.md

@@ -8,9 +8,8 @@
 
 A Home Assistant custom component to monitor washing machines via smart sockets, learn power profiles, and estimate completion time using shape-correlation matching.
 
-
 > [!CAUTION]  
-> **ELECTRICAL SAFETY WARNING**: Using smart plugs such as Shelly or Sonoff with high-amperage appliances (washing machines, dryers, dishwriters) carries significant risk.  
+> **ELECTRICAL SAFETY WARNING**: Using smart plugs such as Shelly or Sonoff with high-amperage appliances (washing machines, dryers, dishwashers) carries significant risk.  
 > 
 > *   **Fire Hazard**: Cheap or low-rated smart plugs may overheat, melt, or catch fire under sustained high loads (heating/drying phases).  
 > *   **Rating Check**: Ensure your smart plug is rated for the **maximum peak power** of your appliance (often >2500W). Standard 10A plugs may fail; 16A+ or hardwired modules are recommended.  
@@ -21,7 +20,8 @@ A Home Assistant custom component to monitor washing machines via smart sockets,
 - **Multi-Device Support**: Track Washing Machines, Dryers, Dishwashers, or Coffee Machines with device-type tagging.
 - **Smart Cycle Detection**: Automatically detects starts/stops with **Predictive End** logic to finish faster when confidence is high.
 - **Power Spike Filtering**: Ignores brief boot spikes to prevent false starts.
-- **Shape-Correlation Matching**: Uses `numpy.corrcoef` with **Confidence Boosting** to distinguish similar cycles by their unique power curve signature.
+- **Shape-Correlation Matching**: Uses `numpy.corrcoef` with **Confidence Boosting** to distinguish similar cycles.
+- **Manual Training**: You define your profiles (e.g., "Cotton", "Quick") once; the system learns to recognize them thereafter. Integration **does not** auto-create profiles.
 - **Smart Time Estimation**: "Phase-aware" prediction detects variance (e.g., heating) and locks the countdown to prevent erratic jumps.
 - **Changeable Power Sensor**: Switch plugs without losing history.
 - **Minimal Status Card**: Optional custom Lovelace card.
@@ -36,49 +36,52 @@ A Home Assistant custom component to monitor washing machines via smart sockets,
 - **Auto-Maintenance**: Nightly cleanup - removes orphaned profiles, merges fragmented cycles.
 - **Export/Import**: Full configuration backup/restore with all settings and profiles via JSON.
 
-## Installation (via HACS)
+---
+
+## 📘 Basic User Guide
+
+Designed for new users to get up and running quickly.
+
+## 1. Installation (via HACS)
 
 1. In Home Assistant, open **HACS → Settings → Custom repositories**.
 2. Add `https://github.com/3dg1luk43/ha_washdata` as a **Integration** repository.
 3. Back in HACS, search for **HA WashData**, install, and **Restart Home Assistant**.
 
 Manual fallback (if not using HACS): copy `custom_components/ha_washdata` into your HA `custom_components` folder and restart.
 
-## Configuration
+### 2. Initial Setup
 
 1. Go to **Settings > Devices & Services**.
 2. Click **Add Integration** and search for **HA WashData**.
-3. Follow the configuration flow:
-   - Give your appliance a **Name**.
-   - Select the **Device Type** (Washing Machine, Dryer, Dishwasher, or Coffee Machine).
-   - Select the **Power Sensor** entity from your smart plug.
+3. Follow the wizard:
+   - **Name**: Name your appliance (e.g., "Washing Machine").
+   - **Device Type**: Select the type (Washer, Dryer, etc.) - this sets optimal defaults.
+   - **Power Sensor**: Choose the smart plug entity monitoring the power (Watts).
    - Set the **Minimum Power** threshold (default 2W).
-   - **Step 2 (Optional)**: You will be asked if you want to create your **First Profile** immediately (e.g., "Cotton"). This helps the system provide time estimates right away.
-   - *Note: Device Type automatically sets optimal defaults (e.g., 60s completion threshold for Coffee Machines).*
+   - **Step 2 (Optional)**: You will be asked if you want to create your **First Profile** immediately (e.g., "Cotton").
+     - *Tip*: If you create this profile, you can **manually select it** via the card controls while a cycle is running. This forces the system to use that profile's duration for accurate **time remaining** and **progress %** estimates immediately, even before the system learns to recognize it automatically.
 
-### Lovelace Status Card
+### 3. Add the Status Card
 
+To see the beautiful status card on your dashboard:
+1. Edit your Dashboard (Top right menu -> **Edit Dashboard**).
+2. Add Card
+3. Search for **WashData Tile Card** (or just "Wash") and select it.
+4. The visual editor will appear. Select entities for your target device.
+5. Click **Save**.
 
-After installation, you can add a minimal status card to your dashboard:
+### 4. Teach the Integration (Crucial Step!)
 
-1. Edit your dashboard → Add Card → Manual.
-2. Enter:
-   ```yaml
-   type: custom:ha-washdata-card
-   entity: sensor.washing_machine
-   title: "My Washer"
-   ```
-3. The card shows: Status icon, running state, current program, progress bar, and time remaining.
+**Important**: The integration **does not** automatically create profiles. You must teach it! It will not detect your programs "magically" until you define them.
 
-*The card is served from `/ha_washdata/ha-washdata-card.js`. If it doesn't appear, clear your browser cache or restart HA.*
+1. **Run a Cycle**: Use your appliance as normal. The integration will record it as an "Unknown" cycle and show "detecting...".
+2. **Create a Profile**: After the cycle finishes, go to **Manage Data & Profiles**.
+3. **Label the Cycle**: Select the recent cycle, click **Create Profile** (e.g., name it "Cotton 60"), and save.
 
-### UI & Parameter Tuning
+**Now** the integration knows what "Cotton 60" looks like. The next time you run this program, it will be detected automatically and you will get accurate time estimates. Repeat this for each of your common programs.
 
-1. After adding the integration, click **Configure** on the integration entry.
-2. **Settings**: Centralized page for all tunables (Min Power, Off Delay, Smoothing, etc.). Use **numerical text boxes** for precise control.
-3. **💡 Apply Suggestions**: Check this box at the top of Settings to refresh the form with recommended values from your machine's history; review then submit to save.
-4. **Progress Estimation**: Remaining time is anchored to the matched profile’s average duration; progress is derived from `elapsed / (elapsed + remaining)` to avoid jumpy percentages.
-5. **Manage Data & Profiles**: Access tools to rename profiles, label past cycles, or auto-label historical data.
+---
 
 ## How it Works
 
@@ -217,3 +220,4 @@ Access via **Configure → Settings**:
 ## License
 
 Non-commercial use only. See LICENSE file.
+

custom_components/ha_washdata/__init__.py

@@ -71,7 +71,7 @@
 
 _LOGGER = logging.getLogger(__name__)
 
-PLATFORMS: list[Platform] = [Platform.SENSOR, Platform.BINARY_SENSOR, Platform.SELECT]
+PLATFORMS: list[Platform] = [Platform.SENSOR, Platform.BINARY_SENSOR, Platform.SELECT, Platform.BUTTON]
 
 
 def _require_str(value: Any, name: str) -> str:

custom_components/ha_washdata/button.py

@@ -0,0 +1,45 @@
+"""Button platform for HA WashData."""
+from __future__ import annotations
+
+import logging
+from homeassistant.components.button import ButtonEntity
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+
+from .const import DOMAIN
+from .manager import WashDataManager
+
+_LOGGER = logging.getLogger(__name__)
+
+async def async_setup_entry(
+    hass: HomeAssistant,
+    entry: ConfigEntry,
+    async_add_entities: AddEntitiesCallback,
+) -> None:
+    """Set up the WashData button."""
+    manager: WashDataManager = hass.data[DOMAIN][entry.entry_id]
+    
+    async_add_entities([WashDataTerminateButton(manager, entry)])
+
+class WashDataTerminateButton(ButtonEntity):
+    """Button to force terminate the current cycle."""
+
+    _attr_has_entity_name = True
+    _attr_name = "Force End Cycle"
+    _attr_icon = "mdi:stop-circle-outline"
+
+    def __init__(self, manager: WashDataManager, entry: ConfigEntry) -> None:
+        """Initialize the button."""
+        self._manager = manager
+        self._entry = entry
+        self._attr_unique_id = f"{entry.entry_id}_force_end"
+        self._attr_device_info = {
+            "identifiers": {(DOMAIN, entry.entry_id)},
+            "name": entry.title,
+            "manufacturer": "HA WashData",
+        }
+
+    async def async_press(self) -> None:
+        """Handle the button press."""
+        await self._manager.async_terminate_cycle()