fix: logging, prediction update, multiple bugs (#584)

* Fix logging configuration issues that made logging stop operation. Switch to Loguru
  logging (from Python logging). Enable console and file logging with different log levels.
  Add logging documentation.

* Fix logging configuration and EOS configuration out of sync. Added tracking support
  for nested value updates of Pydantic models. This used to update the logging configuration
  when the EOS configurationm for logging is changed. Should keep logging config and EOS
  config in sync as long as all changes to the EOS logging configuration are done by
  set_nested_value(), which is the case for the REST API.

* Fix energy management task looping endlessly after the second update when trying to update
  the last_update datetime.

* Fix get_nested_value() to correctly take values from the dicts in a Pydantic model instance.

* Fix usage of model classes instead of model instances in nested value access when evaluation
  the value type that is associated to each key.

* Fix illegal json format in prediction documentation for PVForecastAkkudoktor provider.

* Fix documentation qirks and add EOS Connect to integrations.

* Support deprecated fields in configuration in documentation generation and EOSdash.

* Enhance EOSdash demo to show BrightSky humidity data (that is often missing)

* Update documentation reference to German EOS installation videos.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>

scripts/generate_config_md.py

@@ -4,22 +4,20 @@
 import argparse
 import json
 import os
+import re
 import sys
 import textwrap
 from pathlib import Path
 from typing import Any, Union
 
+from loguru import logger
 from pydantic.fields import ComputedFieldInfo, FieldInfo
 from pydantic_core import PydanticUndefined
 
 from akkudoktoreos.config.config import ConfigEOS, GeneralSettings, get_config
-from akkudoktoreos.core.logging import get_logger
 from akkudoktoreos.core.pydantic import PydanticBaseModel
 from akkudoktoreos.utils.docs import get_model_structure_from_examples
 
-logger = get_logger(__name__)
-
-
 documented_types: set[PydanticBaseModel] = set()
 undocumented_types: dict[PydanticBaseModel, tuple[str, list[str]]] = dict()
 
@@ -145,6 +143,7 @@ def generate_config_table_md(
         field_type = field_info.annotation if regular_field else field_info.return_type
         default_value = get_default_value(field_info, regular_field)
         description = field_info.description if field_info.description else "-"
+        deprecated = field_info.deprecated if field_info.deprecated else None
         read_only = "rw" if regular_field else "ro"
         type_name = get_type_name(field_type)
 
@@ -154,6 +153,11 @@ def generate_config_table_md(
                 env_entry = f"| `{prefix}{config_name}` "
             else:
                 env_entry = "| "
+        if deprecated:
+            if isinstance(deprecated, bool):
+                description = "Deprecated!"
+            else:
+                description = deprecated
         table += f"| {field_name} {env_entry}| `{type_name}` | `{read_only}` | `{default_value}` | {description} |\n"
 
         inner_types: dict[PydanticBaseModel, tuple[str, list[str]]] = dict()
@@ -259,7 +263,7 @@ def generate_config_md(config_eos: ConfigEOS) -> str:
     markdown = "# Configuration Table\n\n"
 
     # Generate tables for each top level config
-    for field_name, field_info in config_eos.model_fields.items():
+    for field_name, field_info in config_eos.__class__.model_fields.items():
         field_type = field_info.annotation
         markdown += generate_config_table_md(
             field_type, [field_name], f"EOS_{field_name.upper()}__", True
@@ -279,6 +283,13 @@ def generate_config_md(config_eos: ConfigEOS) -> str:
     markdown = markdown.rstrip("\n")
     markdown += "\n"
 
+    # Assure log path does not leak to documentation
+    markdown = re.sub(
+        r'(?<=["\'])/[^"\']*/output/eos\.log(?=["\'])',
+        '/home/user/.local/share/net.akkudoktoreos.net/output/eos.log',
+        markdown
+    )
+
     return markdown
 
 

scripts/generate_openapi.py

@@ -42,6 +42,9 @@ def generate_openapi() -> dict:
     general = openapi_spec["components"]["schemas"]["ConfigEOS"]["properties"]["general"]["default"]
     general["config_file_path"] = "/home/user/.config/net.akkudoktoreos.net/EOS.config.json"
     general["config_folder_path"] = "/home/user/.config/net.akkudoktoreos.net"
+    # Fix file path for logging settings to not show local/test file path
+    logging = openapi_spec["components"]["schemas"]["ConfigEOS"]["properties"]["logging"]["default"]
+    logging["file_path"] = "/home/user/.local/share/net.akkudoktoreos.net/output/eos.log"
 
     return openapi_spec