iobroker.poolcontrol 1.3.24 → 1.3.25

package/README.md

@@ -11,161 +11,199 @@
 
 ## Description
 
-The adapter ioBroker.poolcontrol is used for controlling and monitoring pool systems.
-It enables automation of pump, temperature, and solar control as well as energy consumption analysis.
+The adapter ioBroker.poolcontrol is used for controlling, monitoring and analyzing pool systems.
+
+It provides automation for pumps, heating, solar and photovoltaic control as well as monitoring, diagnostics, chemistry analysis and energy evaluations.
 
 ---
 
 ## Features
 
+### Control & Automation
+
 - **Pump Control**
   - Operating modes: Automatic, Automatic (PV), Manual, Time Control, Off
-  - Automatic (PV) controls the pump depending on photovoltaic surplus
-  - Error detection (no power consumption, power despite “OFF”, overload)
+  - Error detection (no power consumption, power despite OFF, overload)
   - Safety functions (frost protection, overheating protection)
-  - Pump power recommendation for variable-speed pumps
-  
-- **Temperature Management**
-  - Up to 6 sensors (surface, bottom, flow, return, collector, outside temperature)
-  - Daily minimum / maximum
-  - Hourly change
-  - Differences (e.g., collector – air, surface – bottom, flow – return)
+  - Priority ownership and helper coordination
+  - Pump power recommendations for variable-speed pumps
+  - Learning functions for power and flow behavior (`pump.learning.*`)
+
+- **Time Control**
+  - Up to 3 freely configurable weekly time windows
+  - Persistent configuration values
+  - Protection against overwriting during updates
 
 - **Solar Control**
-  - On/off thresholds with hysteresis
-  - Collector warning (with automatic reset at 10% below threshold)
-  - Optional speech output on warning
-
-- **Heating / Heat Pump Control (new, test phase)**
-  - Automatic control of heating rod or heat pump based on pool temperature
-  - Target temperature and maximum safety temperature configurable
-  - Active only when:
-    - pool season is active
-    - pump mode **Automatic**
-    - maintenance mode is not active
-  - Priority logic:
-    - Maintenance mode fully blocks heating control
-    - Heating does not interfere with manual or time-based pump modes
-  - Configurable pump overrun time after heating ends
-  - Ownership protection:
-    - The pump is only switched off if it was previously switched on by the heatHelper itself
-  - Supports:
-    - switchable sockets **or**
-    - boolean control states of external heating systems
-  - Internal status and diagnostic section under `heat.*`
-  - Purely controlling, **no chemistry or solar logic**
-  
-  **Note:**  
-  This function is currently in a **test phase**.  
-  The logic is fully implemented but should initially only be used by interested test users.
+  - Collector on/off thresholds with hysteresis
+  - Collector warning threshold
+  - Optional speech output for warnings
+  - Automatic reset logic
+
+- **Solar Extended**
+  - Separate control for external solar actuators
+  - Delta on/off thresholds
+  - Maximum pool temperature limits
+  - Diagnostic and reason states
+  - Priority and block logic
+  - Status section under `solar.extended.*`
 
 - **Photovoltaic Control (since v0.6.0)**
-  - Automatic pump control based on PV generation and household consumption
-  - Start logic: surplus ≥ (pump rated power + safety margin)
+  - Pump control based on PV surplus and household consumption
+  - Start logic using configurable surplus margins
   - Optional overrun during cloudy phases
-  - Ignore if daily circulation target reached
-  - Configuration via two foreign object IDs (power_generated_id, power_house_id)
-  - New pump mode “Automatic (PV)”
+  - Ignore mode when circulation target is reached
+  - Supports external energy object IDs
+  - Pump mode: `Automatic (PV)`
+
+- **Heating / Heat Pump Control (test phase)**
+  - Automatic control of heating rod or heat pump
+  - Configurable target and safety temperatures
+  - Optional pump prerun and overrun
+  - Ownership protection
+  - Maintenance blocking logic
+  - Supports switchable outputs and boolean states
+  - Internal status and diagnostics under `heat.*`
+  - No chemistry or solar logic
 
-- **Time Control**
-  - Up to 3 freely configurable time windows per week
+- **Additional Actuators**
+  - Lighting control
+  - Extra pumps
+  - Follow-pump devices
+  - Automatic ON/OFF depending on pump operation
+  - Validation of external target states
+  - Suitable for UV systems, water features and auxiliary systems
+
+
+### Monitoring & Diagnostics
+
+- **Temperature Management**
+  - Up to 6 sensors:
+    - surface
+    - ground / bottom
+    - flow
+    - return
+    - collector
+    - outside temperature
+  - Daily min/max values
+  - Hourly changes
+  - Temperature differences
+  - Last valid value tracking
+  - Source monitoring and diagnostics
+  - Recovery logic for missing updates
+  - Source status evaluation
 
 - **Runtime & Circulation**
-  - Counts runtime (today, total)
-  - Calculates daily circulation and remaining volume
-  - Backwash reminder with configurable interval (e.g., every 7 days)
-  - Display of last backwash including date
+  - Runtime counters (today / total)
+  - Circulation calculation and remaining volume
+  - Runtime self-healing
+  - Backwash reminder system
+  - Last backwash tracking
   - Automatic reset after completed backwash
-  - PV mode considers circulation status (e.g., “Ignore when circulation reached”)
+  - PV integration for circulation targets
 
-- **Consumption & Costs**
-  - Evaluation of an external kWh meter
-  - Daily, weekly, monthly and yearly consumption
-  - Calculation of electricity costs based on configurable price  
+- **Pressure Sensor Integration (since v0.7.x)**
+  - Real-time pressure measurement
+  - Trend analysis
+  - Learning average values
+  - Self-learning min/max ranges
+  - Diagnostic states
+  - Pressure history and evaluation
+  - Support for external sensors and PoolControl PressureBox
+  - Informational only (no automatic control)
 
-**Note:**  
-Details about the behavior of consumption and cost values (e.g., after restarts or when changing the electricity meter) can be found here:  
+- **SystemCheck**
+  - Diagnostic and debug area
+  - Monitoring of selected subsystems
+  - Internal debug log
+  - Manual log clearing
+  - Intended for analysis and troubleshooting
 
-- [Documentation (English)](https://github.com/DasBo1975/ioBroker.poolcontrol/blob/main/docs/en/help.md)  
-- [Dokumentation (Deutsch)](https://github.com/DasBo1975/ioBroker.poolcontrol/blob/main/docs/de/help.md)
+
+### Analytics & Insights
 
 - **Statistics System**
-  - Section `analytics.statistics.*` with daily, weekly and monthly values
-  - Automatic calculation of min, max, average and runtime values
-  - Fully persistent data points (overinstall protection)
-  - HTML and JSON summaries per sensor and overall overview
+  - Daily / weekly / monthly statistics
+  - Min / max / average calculations
+  - Runtime evaluations
+  - Persistent states
+  - HTML and JSON summaries
+
+- **Solar Insights**
+  - Solar runtime analysis
+  - Efficiency calculations
+  - Diagnostic outputs
+  - Daily logbook
+  - HTML / JSON / text outputs
+  - Informational only (no control)
 
-- **Pressure Sensor Integration (since v0.7.x)**
-  - Real-time filter pressure measurement
-  - Trend analysis: rising / falling / stable
-  - Moving learning average (avg_bar)
-  - Self-learning min/max pressure values
-  - Diagnostic text + last update
-  - No automatic control – purely informational
-  - Normal pressure range configurable by the user
-
-- **AI System (from v0.8.0)**
-  - Modules: Weather hints (Open-Meteo), pool tips, daily summary, weekend report
-  - Automatic text outputs with optional speech output
-  - Hourly weather updates for continuous refresh
-  - Anti-spam system to avoid duplicate hints
-  
-  - **Forecast for Tomorrow (aiForecastHelper, from v0.8.0)**
-    - Automatically creates a daily weather forecast for the next day
-    - Analysis of temperature, weather situation, rain probability and wind strength
-    - Generates pool recommendations for the following day (e.g., close cover, little solar heat expected)
-    - Fully event-based and only requires Open-Meteo data from ioBroker geodata
-    - Separate switches under `ai.weather.switches.*` to enable/disable individual forecast functions
-    - Results stored under `ai.weather.outputs.forecast_text`
-
-  - **Chemistry Help (aiChemistryHelpHelper, from v0.8.x)**
-    - Interactive, purely informative AI help for water chemistry
-    - Selection of typical pool problems via selection field (e.g., pH too high/low, chlorine ineffective, green/cloudy water)
-    - Clear cause and solution descriptions as text output
-    - No automatic dosing
-    - No product recommendations
-    - No device control
-    - No speech output (purely visual information)
-    - Goal: understand causes and proceed systematically (measure → correct → filter → measure again)
-    - Data points under `ai.chemistry_help.*`
-
-- **Info System (since v0.7.x)**
-  - Adapter information system
-  - Seasonal greetings (Christmas, New Year’s Eve, New Year, Easter)
-  - Display of installed adapter version
-   
-- **Speech Outputs**
-  - Output via Alexa or Telegram
-  - Announcements on pump start/stop, errors or temperature thresholds
+- **Photovoltaic Insights**
+  - Runtime analysis
+  - Energy evaluations
+  - Savings calculations
+  - Starts and operating statistics
+  - HTML / JSON summaries
 
-- **SystemCheck (Diagnostic Section)**
-  - Internal diagnostic section for debug and monitoring functions
-  - Selection of area to monitor (e.g., pump, solar, temperature)
-  - Continuous log of the latest changes
-  - Manual log clearing possible
+- **VIS-ready Outputs**
+  - Structured text outputs
+  - HTML outputs
+  - JSON summaries
+  - Suitable for VIS / VIS2 / dashboards
 
-  This section is used exclusively for analysis and troubleshooting.  
-  In normal operation, monitoring should remain disabled.
 
-- **Additional Actuators**
-  - Follow-pump devices
-  - Automatic ON/OFF with pump operation
-  - Validation of external targets
-  - Suitable for UV, water features and auxiliary systems
+### Chemistry & AI
 
 - **Water Chemistry Analysis**
-  - pH evaluation with manual or external sources
-  - TDS analysis with trends (24h / 7d / 30d)
-  - ORP / Redox evaluation with pH reference support
+
+  **pH**
+  - Manual or external sources
+  - Measurement location logic
+  - Stabilization logic
+  - Manual mixing run support
+  - No automatic dosing
+
+  **TDS**
+  - Manual or external sources
+  - Trend evaluation (24h / 7d / 30d)
+  - Reference values
   - Measurement location logic
-  - Plausibility checks
   - HTML / JSON / text outputs
+
+  **ORP / Redox**
+  - ORP evaluation
+  - pH reference support
+  - Informational only
+  - No chlorine control
   - No automatic dosing
 
-- Source monitoring and diagnostics
-- Last valid value tracking
-- Recovery logic for missing updates
-- Source status monitoring
+- **AI System**
+  - Weather hints (Open-Meteo)
+  - Pool recommendations
+  - Daily summary
+  - Weekend report
+  - Forecast for tomorrow
+  - Optional speech outputs
+  - Duplicate context tracking
+
+- **Chemistry Help**
+  - Interactive chemistry assistance
+  - Typical pool problem selection
+  - Cause and solution explanations
+  - No automatic dosing
+  - No device control
+
+- **Speech Outputs**
+  - Alexa support
+  - Telegram support
+  - Notifications for pump, warnings and temperatures
+
+
+### Information System
+
+- Adapter information system
+- Seasonal greetings
+- Version information
+
 ---
 
 
@@ -188,7 +226,7 @@ Configuration is done via tabs in the Admin interface:
 - Statistics export function (CSV/Excel)
 - Diagnostic helper for automatic system checks
 - Own widgets for VIS/VIS2 (graphical pool and solar visualization)
-- Control of pool lighting, valves and counter-current systems
+- Dedicated control modules for valves and counter-current systems
 - Integration of additional sensor boxes (e.g., TempBox, PressureBox, LevelBox)
 - AI and voice assistant extension (pool daily report, tips, voice commands)
 
@@ -202,11 +240,24 @@ New features are added regularly – please refer to the changelog.
 ---
 
 ## Documentation
-- [help.md (detailed description and notes)](./help.md)
+
+### English
+- [Documentation / Help](https://github.com/DasBo1975/ioBroker.poolcontrol/blob/main/docs/en/help.md)
+- [Function Overview](https://github.com/DasBo1975/ioBroker.poolcontrol/blob/main/docs/en/function_overview.md)
+
+### Deutsch
+- [Dokumentation / Hilfe](https://github.com/DasBo1975/ioBroker.poolcontrol/blob/main/docs/de/help.md)
+- [Funktionsübersicht](https://github.com/DasBo1975/ioBroker.poolcontrol/blob/main/docs/de/funktionsuebersicht.md)
 
 ---
 
 ## Changelog
+### 1.3.25 (2026-05-26)
+
+- Updated README structure and feature overview
+- Synchronized German and English function overviews
+- Updated repository maintenance dependencies
+
 ### 1.3.24 (2026-05-26)
 
 - Updated release-script dependencies to current versions
@@ -259,14 +310,6 @@ Features:
 - Protection against invalid internal follow-pump targets
 - Persistent configuration values
 
-### 1.3.20 (2026-05-13)
-
-- Added runtime self-healing for missed pump start events.
-- Stabilized runtime and circulation calculations for delayed or filtered pump switch updates.
-- Fixed a rare synchronization issue where circulation counting could stop although pump live values were still available.
-- Protected time control states from being overwritten during adapter updates.
-- Preserved configured time windows, start/end times and weekdays during adapter reinstallations or updates.
-
 ## Archived Release History
 
 For older releases and archived version history see:

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "poolcontrol",
-    "version": "1.3.24",
+    "version": "1.3.25",
     "news": {
+      "1.3.25": {
+        "en": "Updated documentation and repository maintenance: improved README structure, synchronized function overviews and updated development dependencies",
+        "de": "Dokumentation und Repository-Wartung aktualisiert: README-Struktur verbessert, Funktionsübersichten synchronisiert und Entwicklungsabhängigkeiten aktualisiert",
+        "ru": "Обновленная документация и обслуживание репозитория: улучшенная структура README, синхронизированные обзоры функций и обновленные зависимости разработки.",
+        "pt": "Documentação atualizada e manutenção de repositório: estrutura README aprimorada, visões gerais de funções sincronizadas e dependências de desenvolvimento atualizadas",
+        "nl": "Bijgewerkte documentatie en repository-onderhoud: verbeterde README-structuur, gesynchroniseerde functieoverzichten en bijgewerkte ontwikkelingsafhankelijkheden",
+        "fr": "Documentation mise à jour et maintenance du référentiel : structure README améliorée, aperçus des fonctions synchronisés et dépendances de développement mises à jour",
+        "it": "Documentazione aggiornata e manutenzione del repository: struttura README migliorata, panoramiche delle funzioni sincronizzate e dipendenze di sviluppo aggiornate",
+        "es": "Documentación actualizada y mantenimiento del repositorio: estructura README mejorada, descripciones generales de funciones sincronizadas y dependencias de desarrollo actualizadas",
+        "pl": "Zaktualizowana dokumentacja i konserwacja repozytorium: ulepszona struktura README, zsynchronizowane przeglądy funkcji i zaktualizowane zależności programistyczne",
+        "uk": "Оновлена ​​документація та обслуговування репозиторію: покращена структура README, синхронізовані огляди функцій та оновлені залежності розробки",
+        "zh-cn": "更新的文档和存储库维护：改进的自述文件结构、同步的功能概述和更新的开发依赖项"
+      },
       "1.3.24": {
         "en": "Updated repository and maintainer components: updated release-script dependencies, improved README/changelog structure and reviewed repository checker suggestions",
         "de": "Repository- und Maintainer-Komponenten aktualisiert: Release-Script-Abhängigkeiten aktualisiert, README-/Changelog-Struktur verbessert und Repository-Checker-Hinweise überarbeitet",
@@ -54,19 +67,6 @@
         "pl": "Dodano nowe urządzenia podążające za pompą. Do trzech urządzeń zewnętrznych może teraz automatycznie podążać za pracą głównej pompy. Dodano sprawdzanie stanów docelowych (istnienie, typ boolean i możliwość zapisu). Dodano ochronę przed wewnętrznymi pętlami Follow-Pump.",
         "uk": "Додано нові пристрої, що слідують за насосом. До трьох зовнішніх пристроїв тепер можуть автоматично працювати разом з головним насосом. Додано перевірку цільових станів (існування, тип boolean та можливість запису). Додано захист від внутрішніх циклів Follow-Pump.",
         "zh-cn": "新增随泵运行设备。现在最多可让三个外部设备自动跟随主泵运行。增加了目标状态验证（存在性、布尔类型和可写性）。增加了内部 Follow-Pump 循环保护。"
-      },
-      "1.3.20": {
-        "en": "Added runtime self-healing for missed pump start events and protected time control states from being overwritten during adapter updates.",
-        "de": "Runtime-Selbstheilung für verpasste Pumpenstart-Ereignisse ergänzt und Zeitsteuerungs-Datenpunkte vor dem Überschreiben bei Adapter-Updates geschützt.",
-        "ru": "Добавлено самовосстановление во время выполнения для пропущенных событий запуска насоса и защищены состояния контроля времени от перезаписи во время обновлений адаптера.",
-        "pt": "Adicionada autocorreção em tempo de execução para eventos de inicialização de bomba perdidos e estados de controle de tempo protegidos contra substituição durante atualizações do adaptador.",
-        "nl": "Zelfherstel tijdens runtime toegevoegd voor gemiste pompstartgebeurtenissen en beschermde tijdcontrolestatussen tegen overschrijving tijdens adapterupdates.",
-        "fr": "Ajout de l'auto-réparation au moment de l'exécution pour les événements de démarrage de pompe manqués et des états de contrôle du temps protégés contre l'écrasement lors des mises à jour de l'adaptateur.",
-        "it": "Aggiunta l'autoriparazione del runtime per gli eventi di mancato avvio della pompa e gli stati di controllo temporale protetti dalla sovrascrittura durante gli aggiornamenti dell'adattatore.",
-        "es": "Se agregó autorreparación en tiempo de ejecución para eventos de inicio de bomba perdidos y estados de control de tiempo protegidos para que no se sobrescriban durante las actualizaciones del adaptador.",
-        "pl": "Dodano funkcję samonaprawy w czasie wykonywania w przypadku nieodebranych zdarzeń uruchomienia pompy i zabezpieczono stany kontroli czasu przed nadpisaniem podczas aktualizacji adaptera.",
-        "uk": "Додано самовідновлення під час виконання для пропущених подій запуску насоса та захищено стани керування часом від перезапису під час оновлення адаптера.",
-        "zh-cn": "添加了针对错过的泵启动事件的运行时自我修复，并保护时间控制状态在适配器更新期间不被覆盖。"
       }
     },
     "titleLang": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.poolcontrol",
-  "version": "1.3.24",
+  "version": "1.3.25",
   "description": "Steuerung & Automatisierung für den Pool (Pumpe, Heizung, Ventile, Sensoren).",
   "author": "DasBo1975 <dasbo1975@outlook.de>",
   "homepage": "https://github.com/DasBo1975/ioBroker.poolcontrol",
@@ -31,7 +31,7 @@
     "@iobroker/adapter-dev": "^1.5.0",
     "@iobroker/eslint-config": "^2.2.0",
     "@iobroker/testing": "^5.2.2",
-    "@types/node": ">=22",
+    "@types/node": "^22.0.0",
     "baseline-browser-mapping": "^2.8.32",
     "proxyquire": "^2.1.3"
   },