feat: add segment utilization settings toggle

itsDNNS · itsDNNS · commit 6637533be856 · 2026-03-10T18:52:31.000+01:00
diff --git a/app/blueprints/segment_bp.py b/app/blueprints/segment_bp.py
@@ -43,6 +43,8 @@ def api_segment_utilization():
         return jsonify({"error": t.get("seg_unavailable", "Configuration unavailable.")}), 503
     if config.get("modem_type") != "fritzbox":
         return jsonify({"error": t.get("seg_unsupported_driver", "This view is only available for FRITZ!Box cable devices.")}), 400
+    if not config.is_segment_utilization_enabled():
+        return jsonify({"error": t.get("seg_disabled", "Segment utilization is disabled in Settings.")}), 400
 
     storage = _get_storage()
     if not storage:
diff --git a/app/collectors/__init__.py b/app/collectors/__init__.py
@@ -112,11 +112,13 @@ def discover_collectors(config_mgr, storage, event_detector, mqtt_pub, web, anal
         # Segment utilization collector (FritzBox only)
         if modem_type == "fritzbox":
             from .segment_utilization import SegmentUtilizationCollector
-            collectors.append(SegmentUtilizationCollector(
+            segment_collector = SegmentUtilizationCollector(
                 config_mgr=config_mgr,
                 storage=storage,
                 web=web,
-            ))
+            )
+            if segment_collector.is_enabled():
+                collectors.append(segment_collector)
 
     # ── Module collectors ──
     module_loader = web.get_module_loader() if hasattr(web, 'get_module_loader') else None
diff --git a/app/collectors/segment_utilization.py b/app/collectors/segment_utilization.py
@@ -37,7 +37,7 @@ def name(self):
         return "segment_utilization"
 
     def is_enabled(self):
-        return self._config.get("modem_type") == "fritzbox"
+        return self._config.get("modem_type") == "fritzbox" and self._config.is_segment_utilization_enabled()
 
     def collect(self):
         url = self._config.get("modem_url")
diff --git a/app/config.py b/app/config.py
@@ -37,6 +37,7 @@
     "admin_password": "",
     "demo_mode": False,
     "gaming_quality_enabled": True,
+    "segment_utilization_enabled": True,
     "notify_webhook_url": "",
     "notify_webhook_token": "",
     "notify_min_severity": "warning",
@@ -74,6 +75,7 @@
     "booked_upload": "BOOKED_UPLOAD",
     "demo_mode": "DEMO_MODE",
     "gaming_quality_enabled": "GAMING_QUALITY_ENABLED",
+    "segment_utilization_enabled": "SEGMENT_UTILIZATION_ENABLED",
     "bnetz_enabled": "BNETZ_ENABLED",
     "notify_webhook_url": "NOTIFY_WEBHOOK_URL",
     "notify_webhook_token": "NOTIFY_WEBHOOK_TOKEN",
@@ -103,7 +105,7 @@
 }
 
 INT_KEYS = {"poll_interval", "web_port", "history_days", "notify_cooldown", "health_hysteresis"}
-BOOL_KEYS = {"demo_mode", "gaming_quality_enabled"}
+BOOL_KEYS = {"demo_mode", "gaming_quality_enabled", "segment_utilization_enabled"}
 
 URL_KEYS = {"modem_url", "bqm_url", "speedtest_tracker_url", "notify_webhook_url"}
 _ALLOWED_URL_SCHEMES = {"http", "https"}
@@ -334,6 +336,13 @@ def is_gaming_quality_enabled(self):
             val = val.lower() in ("true", "1", "yes")
         return bool(val) or self.is_demo_mode()
 
+    def is_segment_utilization_enabled(self):
+        """True if FRITZ!Box segment utilization is enabled."""
+        val = self.get("segment_utilization_enabled")
+        if isinstance(val, str):
+            val = val.lower() in ("true", "1", "yes")
+        return bool(val)
+
     def is_bnetz_enabled(self):
         """True if BNetzA broadband measurement feature is enabled."""
         val = self.get("bnetz_enabled")
diff --git a/app/i18n/de.json b/app/i18n/de.json
@@ -567,6 +567,8 @@
   "modules_available": "Verfügbar",
   "modules_requires_fritzbox": "Benötigt FRITZ!Box",
   "modules_managed_in": "Verwaltet unter",
+  "segment_utilization_enabled_label": "Segment-Auslastung erfassen",
+  "segment_utilization_enabled_hint": "Zeigt die Ansicht Segment-Auslastung an und fragt alle 5 Minuten die FRITZ!Box-Segmentlast ab.",
   "active_issues": "Aktive Probleme",
   "report_bug": "Fehler melden",
   "support_kofi_title": "Unterstützen auf Ko-fi",
@@ -760,6 +762,7 @@
   "seg_range_30d": "30d",
   "seg_range_all": "Alle",
   "seg_note": "Die Auslastungswerte sind Schaetzungen der FRITZ!Box und koennen von der tatsaechlichen Segmentauslastung abweichen.",
+  "seg_disabled": "Segment-Auslastung ist in den Einstellungen deaktiviert.",
   "seg_unsupported_driver": "Diese Ansicht ist nur fuer FRITZ!Box-Kabelgeraete verfuegbar.",
   "seg_unavailable": "Konfiguration nicht verfuegbar.",
   "seg_correlation_ds": "Segment DS Last (%)",
diff --git a/app/i18n/en.json b/app/i18n/en.json
@@ -567,6 +567,8 @@
   "modules_available": "Available",
   "modules_requires_fritzbox": "Requires FRITZ!Box",
   "modules_managed_in": "Managed in",
+  "segment_utilization_enabled_label": "Collect segment utilization",
+  "segment_utilization_enabled_hint": "Show the Segment Utilization view and poll FRITZ!Box segment load data every 5 minutes.",
   "active_issues": "Active Issues",
   "report_bug": "Report a bug",
   "support_kofi_title": "Support on Ko-fi",
@@ -760,6 +762,7 @@
   "seg_range_30d": "30d",
   "seg_range_all": "All",
   "seg_note": "Segment utilization values are estimates provided by the FRITZ!Box and may differ from actual CMTS-wide load.",
+  "seg_disabled": "Segment utilization is disabled in Settings.",
   "seg_unsupported_driver": "This view is only available for FRITZ!Box cable devices.",
   "seg_unavailable": "Configuration unavailable.",
   "seg_correlation_ds": "Segment DS Load (%)",
diff --git a/app/i18n/es.json b/app/i18n/es.json
@@ -562,6 +562,8 @@
   "modules_available": "Disponible",
   "modules_requires_fritzbox": "Requiere FRITZ!Box",
   "modules_managed_in": "Se gestiona en",
+  "segment_utilization_enabled_label": "Recopilar utilizacion del segmento",
+  "segment_utilization_enabled_hint": "Muestra la vista de utilizacion del segmento y consulta los datos de carga del segmento FRITZ!Box cada 5 minutos.",
   "active_issues": "Problemas activos",
   "report_bug": "Reportar un error",
   "support_kofi_title": "Apoyar en Ko-fi",
@@ -755,6 +757,7 @@
   "seg_range_30d": "30d",
   "seg_range_all": "Todo",
   "seg_note": "Los valores de utilizacion del segmento son estimaciones de la FRITZ!Box y pueden diferir de la carga real del CMTS.",
+  "seg_disabled": "La utilizacion del segmento esta desactivada en Configuracion.",
   "seg_unsupported_driver": "Esta vista solo esta disponible para dispositivos cable FRITZ!Box.",
   "seg_unavailable": "Configuracion no disponible.",
   "seg_correlation_ds": "Carga segmento DS (%)",
diff --git a/app/i18n/fr.json b/app/i18n/fr.json
@@ -559,6 +559,8 @@
   "modules_available": "Disponible",
   "modules_requires_fritzbox": "Nécessite FRITZ!Box",
   "modules_managed_in": "Géré dans",
+  "segment_utilization_enabled_label": "Collecter l'utilisation du segment",
+  "segment_utilization_enabled_hint": "Affiche la vue d'utilisation du segment et interroge la charge du segment FRITZ!Box toutes les 5 minutes.",
   "active_issues": "Problèmes actifs",
   "report_bug": "Signaler un bug",
   "support_kofi_title": "Soutenir sur Ko-fi",
@@ -752,6 +754,7 @@
   "seg_range_30d": "30j",
   "seg_range_all": "Tout",
   "seg_note": "Les valeurs d'utilisation du segment sont des estimations de la FRITZ!Box et peuvent differer de la charge reelle du CMTS.",
+  "seg_disabled": "L'utilisation du segment est désactivée dans les paramètres.",
   "seg_unsupported_driver": "Cette vue n'est disponible que pour les appareils cable FRITZ!Box.",
   "seg_unavailable": "Configuration non disponible.",
   "seg_correlation_ds": "Charge segment DS (%)",
diff --git a/app/i18n/template.json b/app/i18n/template.json
@@ -535,6 +535,8 @@
   "modules_available": "",
   "modules_requires_fritzbox": "",
   "modules_managed_in": "",
+  "segment_utilization_enabled_label": "",
+  "segment_utilization_enabled_hint": "",
   "active_issues": "",
   "report_bug": "",
   "support_kofi_title": "",
@@ -704,5 +706,6 @@
   "localization": "",
   "localization_desc": "",
   "dashboard_features": "",
-  "dashboard_features_desc": ""
+  "dashboard_features_desc": "",
+  "seg_disabled": ""
 }
diff --git a/app/templates/index.html b/app/templates/index.html
@@ -101,7 +101,7 @@
                     <i data-lucide="git-compare-arrows"></i> {{ t.get('docsight.comparison.title', 'Before/After Comparison') }}
                 </a>
                 {% endif %}
-                {% if is_fritzbox %}
+                {% if is_fritzbox and segment_utilization_enabled %}
                 <a class="nav-item" data-view="segment-utilization" data-nav-icon="gauge" data-nav-title="{{ t.seg_title }}">
                     <i data-lucide="gauge"></i> {{ t.seg_title }}
                 </a>
@@ -1790,7 +1790,7 @@ <h3 class="gaming-section-title">{{ t.gaming_genres_title }}</h3>
 {% endif %}
 
 {# ── Segment Utilization (FritzBox core feature) ── #}
-{% if is_fritzbox %}
+{% if is_fritzbox and segment_utilization_enabled %}
 <div id="view-segment-utilization" class="view">
     {% include "segment_utilization_tab.html" %}
 </div>
diff --git a/app/templates/settings/connection.html b/app/templates/settings/connection.html
@@ -79,4 +79,31 @@
             </div>
         </div>
     </div>
+
+    {% if config.modem_type == 'fritzbox' %}
+    <div class="settings-card glass">
+        <div class="card-header">
+            <div class="card-title-group">
+                <div class="card-icon purple">
+                    <i data-lucide="gauge"></i>
+                </div>
+                <div>
+                    <div class="card-title">{{ t.seg_title }}</div>
+                    <div class="card-subtitle">{{ t.seg_subtitle }}</div>
+                </div>
+            </div>
+        </div>
+        <div class="toggle-row">
+            <div class="toggle-info">
+                <span class="toggle-title">{{ t.segment_utilization_enabled_label }}</span>
+                <span class="toggle-desc">{{ t.segment_utilization_enabled_hint }}</span>
+            </div>
+            <input type="hidden" name="segment_utilization_enabled" value="false">
+            <label class="toggle">
+                <input type="checkbox" id="segment_utilization_enabled" name="segment_utilization_enabled" value="true" {% if config.segment_utilization_enabled %}checked{% endif %}>
+                <span class="toggle-slider"></span>
+            </label>
+        </div>
+    </div>
+    {% endif %}
 </div>
diff --git a/app/web.py b/app/web.py
@@ -619,6 +619,7 @@ def index():
     smokeping_configured = _config_manager.is_smokeping_configured() if _config_manager else False
     speedtest_configured = _config_manager.is_speedtest_configured() if _config_manager else False
     gaming_quality_enabled = _config_manager.is_gaming_quality_enabled() if _config_manager else False
+    segment_utilization_enabled = _config_manager.is_segment_utilization_enabled() if _config_manager else False
     is_fritzbox = (_config_manager.get("modem_type") == "fritzbox") if _config_manager else False
     bnetz_enabled = _config_manager.is_bnetz_enabled() if _config_manager else True
     state = get_state()
@@ -679,6 +680,7 @@ def _has_us_ofdma(analysis):
         device_info=dev_info,
         demo_mode=demo_mode,
         gaming_quality_enabled=gaming_quality_enabled,
+        segment_utilization_enabled=segment_utilization_enabled,
         gaming_index=gaming_index,
         is_fritzbox=is_fritzbox,
         bnetz_enabled=bnetz_enabled,
@@ -728,6 +730,7 @@ def settings():
     all_modules = _module_loader.get_modules() if _module_loader else []
     is_fritzbox = config.get("modem_type") == "fritzbox"
     gaming_quality_enabled = _config_manager.is_gaming_quality_enabled() if _config_manager else False
+    segment_utilization_enabled = _config_manager.is_segment_utilization_enabled() if _config_manager else False
     built_in_features = [
         {
             "id": "core.gaming_quality",
@@ -750,11 +753,15 @@ def settings():
                 "Cable segment utilization from FRITZ!Box monitoring. Requires FRITZ!OS 8.20 or newer on supported cable firmware.",
             ),
             "icon": "gauge",
-            "status_label": t.get(
-                "modules_available" if is_fritzbox else "modules_requires_fritzbox",
-                "Available" if is_fritzbox else "Requires FRITZ!Box",
+            "status_label": (
+                t.get("modules_requires_fritzbox", "Requires FRITZ!Box")
+                if not is_fritzbox else
+                t.get(
+                    "modules_enabled" if segment_utilization_enabled else "modules_disabled",
+                    "Enabled" if segment_utilization_enabled else "Disabled",
+                )
             ),
-            "status_class": "badge-success" if is_fritzbox else "badge-warning",
+            "status_class": "badge-warning" if not is_fritzbox else ("badge-success" if segment_utilization_enabled else "badge-muted"),
             "manage_section": "connection",
             "manage_label": t.get("step_modem", "Modem"),
         },
diff --git a/tests/modules/test_fritzbox_cable_collector.py b/tests/modules/test_fritzbox_cable_collector.py
@@ -34,6 +34,7 @@ def mock_config():
         "modem_user": "admin",
         "modem_password": "secret",
     }.get(k, d)
+    cfg.is_segment_utilization_enabled.return_value = True
     return cfg
 
 
@@ -62,6 +63,11 @@ def test_disabled_when_not_fritzbox(self, mock_config, mock_storage):
         c = SegmentUtilizationCollector(config_mgr=mock_config, storage=mock_storage, web=MagicMock())
         assert c.is_enabled() is False
 
+    def test_disabled_when_setting_off(self, mock_config, mock_storage):
+        mock_config.is_segment_utilization_enabled.return_value = False
+        c = SegmentUtilizationCollector(config_mgr=mock_config, storage=mock_storage, web=MagicMock())
+        assert c.is_enabled() is False
+
 
 class TestCollect:
     @patch("app.collectors.segment_utilization.requests")
diff --git a/tests/test_collectors.py b/tests/test_collectors.py
@@ -790,13 +790,15 @@ def _make_config_mgr(self, poll_interval=60, bnetz_watch=False):
         mgr.is_bqm_configured.return_value = True
         mgr.is_bnetz_watch_configured.return_value = bnetz_watch
         mgr.is_weather_configured.return_value = False
+        mgr.is_segment_utilization_enabled.return_value = True
         mgr.get_all.return_value = {
             "modem_type": "fritzbox",
             "modem_url": "http://fritz.box",
             "modem_user": "admin",
             "modem_password": "pass",
             "poll_interval": poll_interval,
         }
+        mgr.get.side_effect = lambda key, default=None: mgr.get_all.return_value.get(key, default)
         return mgr
 
     def _make_web_with_modules(self, module_specs):
@@ -893,6 +895,24 @@ def test_discover_no_modules_returns_modem_only(self, mock_load):
         assert "modem" in names
         assert "segment_utilization" in names
 
+    @patch("app.drivers.driver_registry.load_driver")
+    def test_discover_skips_segment_when_disabled(self, mock_load):
+        from app.collectors import discover_collectors
+
+        mock_load.return_value = MagicMock()
+        config_mgr = self._make_config_mgr()
+        config_mgr.is_segment_utilization_enabled.return_value = False
+        analyzer = MagicMock()
+
+        web = MagicMock(spec=[])
+
+        collectors = discover_collectors(
+            config_mgr, self._make_storage(), MagicMock(), None, web, analyzer
+        )
+        names = [c.name for c in collectors]
+        assert "modem" in names
+        assert "segment_utilization" not in names
+
     @patch("app.drivers.driver_registry.load_driver")
     def test_modem_collector_gets_poll_interval(self, mock_load):
         from app.collectors import discover_collectors
diff --git a/tests/test_config.py b/tests/test_config.py
@@ -204,6 +204,13 @@ def test_theme_validation(self, config):
         config.save({"theme": "invalid"})
         assert config.get_theme() == "dark"
 
+    def test_segment_utilization_enabled_defaults_true(self, config):
+        assert config.is_segment_utilization_enabled() is True
+
+    def test_segment_utilization_enabled_can_be_disabled(self, config):
+        config.save({"segment_utilization_enabled": False})
+        assert config.is_segment_utilization_enabled() is False
+
 
 class TestConfigUrlValidation:
     @pytest.mark.parametrize("url", [
diff --git a/tests/test_web.py b/tests/test_web.py
@@ -228,6 +228,30 @@ def test_settings_modules_lists_builtin_features(self, client):
         assert b"Segment Utilization" in resp.data
         assert b"Requires FRITZ!OS 8.20 or newer" in resp.data
 
+    def test_settings_connection_includes_segment_toggle_for_fritzbox(self, client):
+        resp = client.get("/settings?lang=en")
+        assert resp.status_code == 200
+        assert b"Collect segment utilization" in resp.data
+        assert b'name="segment_utilization_enabled"' in resp.data
+
+    def test_settings_modules_shows_segment_disabled_status(self, client, config_mgr):
+        config_mgr.save({"segment_utilization_enabled": False})
+        init_config(config_mgr)
+        resp = client.get("/settings?lang=en")
+        assert resp.status_code == 200
+        assert b"Segment Utilization" in resp.data
+        assert b"Disabled" in resp.data
+
+
+class TestIndexRoute:
+    def test_index_hides_segment_tab_when_disabled(self, client, config_mgr, sample_analysis):
+        config_mgr.save({"segment_utilization_enabled": False})
+        init_config(config_mgr)
+        update_state(analysis=sample_analysis)
+        resp = client.get("/?lang=en")
+        assert resp.status_code == 200
+        assert b'data-view="segment-utilization"' not in resp.data
+
 
 class TestHealthEndpoint:
     def test_health_waiting(self, client):
