Merge pull request #100 from fboundy/dev

3.6.1 - Redact sensitive info from logs

README.md

@@ -1,4 +1,4 @@
-# PV Opt: Home Assistant Solar/Battery Optimiser v3.6.0
+# PV Opt: Home Assistant Solar/Battery Optimiser v3.6.1
 
 Solar / Battery Charging Optimisation for Home Assistant. This appDaemon application attempts to optimise charging and discharging of a home solar/battery system to minimise cost electricity cost on a daily basis using freely available solar forecast data from SolCast. This is particularly beneficial for Octopus Agile but is also benefeficial for other time-of-use tariffs such as Octopus Flux or simple Economy 7.
 

apps/pv_opt/config/config.yaml

@@ -27,6 +27,7 @@ pv_opt:
 
   # If true the current config in HA will be over-written with that in the config.yaml. 
   overwrite_ha_on_restart: true
+  redact_personal_data_from_log: true
 
   consumption_history_days: 2
 

apps/pv_opt/pv_opt.py

@@ -10,6 +10,7 @@
 import pvpy as pv
 import numpy as np
 from numpy import nan
+import re
 
 
 # import pvpy as pv
@@ -19,13 +20,14 @@
 #
 USE_TARIFF = True
 
-VERSION = "3.6.0"
+VERSION = "3.6.1"
 DEBUG = False
 
 DATE_TIME_FORMAT_LONG = "%Y-%m-%d %H:%M:%S%z"
 DATE_TIME_FORMAT_SHORT = "%d-%b %H:%M"
 TIME_FORMAT = "%H:%M"
 
+REDACT_REGEX = ["[0-9]{2}m[0-9]{7}_[0-9]{13}", "a_[0-f]{8}"]
 
 EVENT_TRIGGER = "PV_OPT"
 DEBUG_TRIGGER = "PV_DEBUG"
@@ -276,6 +278,8 @@ def initialize(self):
         # self.log(self.args)
         self.inverter_type = self.args.pop("inverter_type", "SOLIS_SOLAX_MODBUS")
         self.device_name = self.args.pop("device_name", "solis")
+        self.redact = self.args.pop("edact_personal_data_from_log", True)
+
         self._load_inverter()
 
         self.change_items = {}
@@ -328,6 +332,17 @@ def initialize(self):
                     f"  {id} {self.handles[id]}  {self.info_listen_state(self.handles[id])}"
                 )
 
+    def redact_for_log(self, entity_id):
+        if self.redact:
+            e = entity_id
+            for pattern in REDACT_REGEX:
+                x = re.search(pattern, e)
+                if x:
+                    e = re.sub(pattern, "*" * len(x.group()), e)
+            return e
+        else:
+            return entity_id
+
     def _estimate_capacity(self):
         if "id_battery_charge_power" in self.config:
             df = pd.DataFrame(
@@ -547,7 +562,9 @@ def _load_contract(self):
 
                     for imp_exp in IMPEXP:
                         for entity in entities[imp_exp]:
-                            self.log(f"    Found {imp_exp} entity {entity}")
+                            self.log(
+                                f"    Found {imp_exp} entity {self.redact_for_log(entity)}"
+                            )
 
                     tariffs = {x: None for x in IMPEXP}
                     for imp_exp in IMPEXP:
@@ -706,7 +723,9 @@ def _load_saving_events(self):
                 if ("octoplus_saving_session_events" in name)
             ][0]
             self.log("")
-            self.log(f"Found Octopus Savings Events entity: {saving_events_entity}")
+            self.log(
+                f"Found Octopus Savings Events entity: {self.redact_for_log(saving_events_entity)}"
+            )
 
             available_events = self.get_state(saving_events_entity, attribute="all")[
                 "attributes"