Merge pull request #23 from azebro/main

Add configurable reporting interval and live reporting features

Author: azebro

CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+## [1.2.0] - 2026-03-07
+
+### Changed
+
+- Refactor code structure for improved readability and maintainability
+
+## [1.1.1] - 2026-03-05
+
+### Added
+
+- Proactive midnight reset for daily energy accumulators
+
+### Changed
+
+- Reorder datetime imports for improved clarity
+- Refactor code structure for improved readability and maintainability
+
+### Documentation
+
+- Document `sensor.tigo_max_power` and Page 3 (Panel Power) in pv_production dashboard
+
+## [1.1.0] - Previous release
+
+See [v1.1.0 tag](https://github.com/azebro/pytap/releases/tag/v1.1.0).
+
+## [1.0.0] - Initial release
+
+See [v1.0.0 tag](https://github.com/azebro/pytap/releases/tag/v1.0.0).

custom_components/pytap/__init__.py

@@ -15,10 +15,12 @@
 from homeassistant.helpers import entity_registry as er
 
 from .const import (
+    CONF_LIVE_REPORTING,
     CONF_MODULE_BARCODE,
     CONF_MODULE_PEAK_POWER,
     CONF_MODULE_STRING,
     CONF_MODULES,
+    DEFAULT_LIVE_REPORTING,
     DEFAULT_PEAK_POWER,
     DEFAULT_STRING_NAME,
     DOMAIN,
@@ -32,7 +34,8 @@
 # Bumped from 1 → 2 when voltage/current were split into in/out variants.
 # Bumped from 2 → 3 when module string labels became mandatory.
 # Bumped from 3 → 4 when module peak_power became mandatory in config.
-CONFIG_ENTRY_VERSION = 4
+# Bumped from 4 → 5 when live_reporting toggle was added.
+CONFIG_ENTRY_VERSION = 5
 
 # Old unique IDs that were replaced by the _in/_out split.
 _LEGACY_UNIQUE_ID_RENAMES: dict[str, str] = {
@@ -103,6 +106,7 @@ async def async_migrate_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     v1 → v2: voltage/current sensors split into _in/_out variants.
     v2 → v3: module string labels are mandatory.
     v3 → v4: module peak power is added with default value.
+    v4 → v5: live_reporting toggle added (default True).
     """
     if entry.version == 1:
         _LOGGER.info(
@@ -150,6 +154,16 @@ async def async_migrate_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
         new_data = {**entry.data, CONF_MODULES: updated_modules}
         hass.config_entries.async_update_entry(entry, data=new_data, version=4)
 
+    if entry.version == 4:
+        _LOGGER.info(
+            "Migrating PyTap config entry %s from version 4 to 5",
+            entry.entry_id,
+        )
+        new_data = {**entry.data}
+        if CONF_LIVE_REPORTING not in new_data:
+            new_data[CONF_LIVE_REPORTING] = DEFAULT_LIVE_REPORTING
+        hass.config_entries.async_update_entry(entry, data=new_data, version=5)
+
     return True
 
 

custom_components/pytap/config_flow.py

@@ -5,7 +5,8 @@
 rather than a comma-separated text blob.
 
 Flow: user (host/port) → modules_menu → add_module (repeat) → finish
-Options: init (menu) → add_module / remove_module → done
+Options: init (menu) → add_module / remove_module / change_connection /
+         change_reporting → done
 """
 
 from __future__ import annotations
@@ -27,13 +28,17 @@
 import voluptuous as vol
 
 from .const import (
+    CONF_LIVE_REPORTING,
     CONF_MODULE_BARCODE,
     CONF_MODULE_NAME,
     CONF_MODULE_PEAK_POWER,
     CONF_MODULE_STRING,
     CONF_MODULES,
+    CONF_WRITE_INTERVAL,
+    DEFAULT_LIVE_REPORTING,
     DEFAULT_PEAK_POWER,
     DEFAULT_PORT,
+    DEFAULT_WRITE_INTERVAL,
     DOMAIN,
 )
 
@@ -109,7 +114,7 @@ def _modules_description(modules: list[dict[str, Any]]) -> str:
 class PyTapConfigFlow(ConfigFlow, domain=DOMAIN):
     """Handle a config flow for PyTap."""
 
-    VERSION = 4
+    VERSION = 5
 
     def __init__(self) -> None:
         """Initialize the config flow."""
@@ -242,7 +247,13 @@ async def async_step_init(
         """Show the options menu: change connection / add / remove / done."""
         return self.async_show_menu(
             step_id="init",
-            menu_options=["change_connection", "add_module", "remove_module", "done"],
+            menu_options=[
+                "change_connection",
+                "change_reporting",
+                "add_module",
+                "remove_module",
+                "done",
+            ],
             description_placeholders={
                 "modules_list": _modules_description(self._modules),
             },
@@ -308,6 +319,54 @@ async def async_step_change_connection(
             errors=errors,
         )
 
+    async def async_step_change_reporting(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Allow the user to change reporting settings.
+
+        Presents a 'Live reporting' checkbox (default ON) that delivers
+        readings as they arrive.  When unchecked, a write_interval field
+        appears and readings are cached, then pushed as a time-weighted
+        average every ``write_interval`` seconds.
+        """
+        if user_input is not None:
+            new_data = {**self._config_entry.data}
+            live = user_input.get(CONF_LIVE_REPORTING, DEFAULT_LIVE_REPORTING)
+            new_data[CONF_LIVE_REPORTING] = live
+            if live:
+                # Live mode — clear any stored interval
+                new_data.pop(CONF_WRITE_INTERVAL, None)
+            else:
+                new_data[CONF_WRITE_INTERVAL] = user_input.get(
+                    CONF_WRITE_INTERVAL, DEFAULT_WRITE_INTERVAL
+                )
+            self.hass.config_entries.async_update_entry(
+                self._config_entry, data=new_data
+            )
+            return await self.async_step_init()
+
+        current_live = self._config_entry.data.get(
+            CONF_LIVE_REPORTING, DEFAULT_LIVE_REPORTING
+        )
+        current_write_interval = self._config_entry.data.get(
+            CONF_WRITE_INTERVAL, DEFAULT_WRITE_INTERVAL
+        )
+        schema = vol.Schema(
+            {
+                vol.Optional(
+                    CONF_LIVE_REPORTING, default=current_live
+                ): bool,
+                vol.Optional(
+                    CONF_WRITE_INTERVAL, default=current_write_interval
+                ): vol.All(vol.Coerce(int), vol.Range(min=5, max=300)),
+            }
+        )
+
+        return self.async_show_form(
+            step_id="change_reporting",
+            data_schema=schema,
+        )
+
     async def async_step_add_module(
         self, user_input: dict[str, Any] | None = None
     ) -> ConfigFlowResult:

custom_components/pytap/const.py

@@ -7,6 +7,8 @@
 CONF_HOST = "host"
 CONF_PORT = "port"
 CONF_MODULES = "modules"
+CONF_LIVE_REPORTING = "live_reporting"
+CONF_WRITE_INTERVAL = "write_interval"
 
 # Module dict keys
 CONF_MODULE_STRING = "string"
@@ -19,6 +21,8 @@
 DEFAULT_STRING_NAME = "Default"
 DEFAULT_PEAK_POWER = 455
 DEFAULT_SCAN_INTERVAL = 30
+DEFAULT_LIVE_REPORTING = True
+DEFAULT_WRITE_INTERVAL = 30
 RECONNECT_TIMEOUT = 60
 RECONNECT_DELAY = 5
 RECONNECT_RETRIES = 0