Merge pull request smarthomeNG#1028 from Morg42/smartmeter

smartmeter: add docs, improve webif

Author: Morg42

smartmeter/__init__.py

@@ -115,6 +115,9 @@ def __init__(self, sh):
         # load parameters from config
         self._load_parameters()
 
+        self.discovery_logs = {}
+        self.item_file = None
+
         # quit if errors on parameter read
         if not self._init_complete:
             return
@@ -133,6 +136,8 @@ def discover(self, protocol=None) -> bool:
         else:
             disc_protos = [protocol]
 
+        self.discovery_logs = {proto: None for proto in disc_protos}
+
         for proto in disc_protos:
             if self._get_module(proto).discover(self._config):
                 self.logger.info(f'discovery of {protocol} was successful')
@@ -141,6 +146,7 @@ def discover(self, protocol=None) -> bool:
                     self.proto_detected = True
                 return True
             else:
+                self.discovery_logs[proto] = self._config.pop('discover_log', '')
                 self.logger.info(f'discovery of {protocol} was unsuccessful')
 
         return False
@@ -166,7 +172,7 @@ def query(self, assign_values: bool = True, protocol=None) -> dict:
         try:
             result = ref.query(self._config)
             if not result:
-                self.logger.warning('no results from smartmeter query received')
+                self.logger.info('no results from smartmeter query received')
             else:
                 self.logger.debug(f'got result: {result}')
                 if assign_values:
@@ -191,6 +197,7 @@ def create_items(self, data: dict = {}, file: str = '') -> bool:
         if not data:
             return False
 
+        # try to get smartmeter serial, fallback to time string
         try:
             id = data['1-0:96.1.0*255'][0]['value']
         except (KeyError, IndexError, AttributeError):
@@ -239,6 +246,7 @@ def create_items(self, data: dict = {}, file: str = '') -> bool:
 
         try:
             yaml_save(file, {id: result})
+            self.item_file = file
         except Exception as e:
             self.logger.warning(f'saving item file {file} failed with error: {e}')
             return False

smartmeter/dlms.py

@@ -31,6 +31,8 @@
 import logging
 import time
 import serial
+import io
+
 try:
     import serial_asyncio
     ASYNC_IMPORTED = True
@@ -240,6 +242,52 @@ def format_time(timedelta: float) -> str:
         return f"{timedelta * 10 ** 9:.2f} ns"
 
 
+#
+# string logger
+#
+
+
+class StringLogger():
+
+    def __init__(self):
+        ### Create the logger
+        self.logger = logging.getLogger('sml_string_logger')
+        self.logger.setLevel(logging.DEBUG)
+
+        ### Setup the console handler with a StringIO object
+        self.log_capture_string = io.StringIO()
+        self.ch = logging.StreamHandler(self.log_capture_string)
+        self.ch.setLevel(logging.DEBUG)
+
+        ### Optionally add a formatter
+        formatter = logging.Formatter('%(levelname)s: %(message)s')
+        self.ch.setFormatter(formatter)
+
+        ### Add the console handler to the logger
+        self.logger.addHandler(self.ch)
+
+    def __call__(self):
+        return self.log_capture_string.getvalue()
+
+    def close(self):
+        self.log_capture_string.close()
+
+    def debug(self, *args, **kwargs):
+        self.logger.debug(*args, **kwargs)
+
+    def info(self, *args, **kwargs):
+        self.logger.info(*args, **kwargs)
+
+    def warning(self, *args, **kwargs):
+        self.logger.warning(*args, **kwargs)
+
+    def error(self, *args, **kwargs):
+        self.logger.error(*args, **kwargs)
+
+    def critical(self, *args, **kwargs):
+        self.logger.critical(*args, **kwargs)
+
+
 # TODO: asyncio for DLMS disabled until real testing has succeeded
 # #
 # # asyncio reader
@@ -519,7 +567,7 @@ def get_sock(self):
         host = self.config.get('host')
         port = self.config.get('port')
         timeout = self.config.get('timeout', 2)
-        baudrate = self.config.get('DLMS', {'baudate_min': 300}).get('baudrate_min', 300)
+        baudrate = self.config.get('DLMS', {}).get('baudrate_min', 300)
 
         if TESTING:
             self.target = '(test input)'
@@ -539,7 +587,7 @@ def get_sock(self):
                     timeout=timeout
                 )
                 if not serial_port == self.sock.name:
-                    logger.debug(f"Asked for {serial_port} as serial port, but really using now {sock.name}")
+                    logger.debug(f"Asked for {serial_port} as serial port, but really using now {self.sock.name}")
                 self.target = f'serial://{self.sock.name}'
 
             except FileNotFoundError:
@@ -969,7 +1017,7 @@ def parse(self, data: str) -> dict:
         return result
 
 
-def query(config, discover: bool = False) -> Union[dict, None]:
+def query(config, discover: bool = False, logger=logger) -> Union[dict, None]:
     """
     This function will
     1. open a serial communication line to the smartmeter
@@ -1022,14 +1070,16 @@ def discover(config: dict) -> bool:
     # reduced baud rates or changed parameters, but there would need to be
     # the need for this.
     # For now, let's see how well this works...
-    result = query(config, discover=True)
+    str_log = StringLogger()
+    result = query(config, discover=True, logger=str_log)
 
     # result should have one key 'readout' with the full answer and a separate
     # key for every read OBIS code. If no OBIS codes are read/converted, we can
     # not be sure this is really DLMS, so we check for at least one OBIS code.
     if result:
         return len(result) > 1
     else:
+        config['discover_log'] = str_log()
         return False
 
 
@@ -1107,7 +1157,7 @@ def discover(config: dict) -> bool:
     logger.info("This is Smartmeter Plugin, DLMS module, running in standalone mode")
     logger.info("==================================================================")
 
-    result = query(config)
+    result = discover(config)
 
     if not result:
         logger.info(f"No results from query, maybe a problem with the serial port '{config['serial_port']}' given.")

smartmeter/requirements.txt

@@ -1,2 +1,3 @@
 pyserial>=3.2.1
-SmlLib>=1.3
+smllib>=1.3
+pyserial-asyncio

smartmeter/sml.py

@@ -31,6 +31,8 @@
 import errno
 import logging
 import serial
+import io
+
 try:
     import serial_asyncio
     ASYNC_IMPORTED = True
@@ -90,6 +92,7 @@ class SmartPluginWebIf():
 if __name__ == '__main__':
     logger = logging.getLogger(__name__)
     logger.debug(f"init standalone {__name__}")
+
 else:
     logger = logging.getLogger(__name__)
     logger.debug(f"init plugin component {__name__}")
@@ -152,6 +155,53 @@ def format_time(timedelta):
     elif timedelta > 0.000000001:
         return f"{timedelta * 1000000000.0:.2f} ns"
 
+
+#
+# string logger
+#
+
+
+class StringLogger():
+
+    def __init__(self):
+        ### Create the logger
+        self.logger = logging.getLogger('sml_string_logger')
+        self.logger.setLevel(logging.DEBUG)
+
+        ### Setup the console handler with a StringIO object
+        self.log_capture_string = io.StringIO()
+        self.ch = logging.StreamHandler(self.log_capture_string)
+        self.ch.setLevel(logging.DEBUG)
+
+        ### Optionally add a formatter
+        formatter = logging.Formatter('%(levelname)s: %(message)s')
+        self.ch.setFormatter(formatter)
+
+        ### Add the console handler to the logger
+        self.logger.addHandler(self.ch)
+
+    def __call__(self):
+        return self.log_capture_string.getvalue()
+
+    def close(self):
+        self.log_capture_string.close()
+
+    def debug(self, *args, **kwargs):
+        self.logger.debug(*args, **kwargs)
+
+    def info(self, *args, **kwargs):
+        self.logger.info(*args, **kwargs)
+
+    def warning(self, *args, **kwargs):
+        self.logger.warning(*args, **kwargs)
+
+    def error(self, *args, **kwargs):
+        self.logger.error(*args, **kwargs)
+
+    def critical(self, *args, **kwargs):
+        self.logger.critical(*args, **kwargs)
+
+
 #
 # asyncio reader
 #
@@ -307,7 +357,7 @@ def __init__(self, logger, config: dict):
         self.target = '(not set)'
         self.buffersize = config.get('sml', {'buffersize': 1024}).get('buffersize', 1024)
 
-        logger.debug(f"config='{config}'")
+        self.logger.debug(f"config='{config}'")
 
     def __call__(self) -> bytes:
 
@@ -316,7 +366,7 @@ def __call__(self) -> bytes:
         #
         locked = self.lock.acquire(blocking=False)
         if not locked:
-            logger.error('could not get lock for serial/network access. Is another scheduled/manual action still active?')
+            self.logger.error('could not get lock for serial/network access. Is another scheduled/manual action still active?')
             return b''
 
         try:  # lock release
@@ -325,7 +375,7 @@ def __call__(self) -> bytes:
             if not self.sock:
                 # error already logged, just go
                 return b''
-            logger.debug(f"time to open {self.target}: {format_time(time.time() - runtime)}")
+            self.logger.debug(f"time to open {self.target}: {format_time(time.time() - runtime)}")
 
             #
             # read data from device
@@ -334,13 +384,13 @@ def __call__(self) -> bytes:
             try:
                 response = self.read()
                 if len(response) == 0:
-                    logger.error('reading data from device returned 0 bytes!')
+                    self.logger.info('reading data from device returned 0 bytes!')
                     return b''
                 else:
-                    logger.debug(f'read {len(response)} bytes')
+                    self.logger.debug(f'read {len(response)} bytes')
 
             except Exception as e:
-                logger.error(f'reading data from {self.target} failed with error: {e}')
+                self.logger.error(f'reading data from {self.target} failed with error: {e}')
 
         except Exception:
             # passthrough, this is only for releasing the lock
@@ -428,41 +478,41 @@ def get_sock(self):
                         timeout=self.timeout
                     )
                     if not self.serial_port == self.sock.name:
-                        logger.debug(f"Asked for {self.serial_port} as serial port, but really using now {self.sock.name}")
+                        self.logger.debug(f"Asked for {self.serial_port} as serial port, but really using now {self.sock.name}")
                     self.target = f'serial://{self.sock.name}'
 
                 except FileNotFoundError:
-                    logger.error(f"Serial port '{self.serial_port}' does not exist, please check your port")
+                    self.logger.error(f"Serial port '{self.serial_port}' does not exist, please check your port")
                     return None, ''
                 except serial.SerialException:
                     if self.sock is None:
                         if count < 3:
                             # count += 1
-                            logger.error(f"Serial port '{self.serial_port}' could not be opened, retrying {count}/3...")
+                            self.logger.error(f"Serial port '{self.serial_port}' could not be opened, retrying {count}/3...")
                             time.sleep(3)
                             continue
                         else:
-                            logger.error(f"Serial port '{self.serial_port}' could not be opened")
+                            self.logger.error(f"Serial port '{self.serial_port}' could not be opened")
                     else:
-                        logger.error(f"Serial port '{self.serial_port}' could be opened but somehow not accessed")
+                        self.logger.error(f"Serial port '{self.serial_port}' could be opened but somehow not accessed")
                     return None, ''
                 except OSError:
-                    logger.error(f"Serial port '{self.serial_port}' does not exist, please check the spelling")
+                    self.logger.error(f"Serial port '{self.serial_port}' does not exist, please check the spelling")
                     return None, ''
                 except Exception as e:
-                    logger.error(f"unforeseen error occurred: '{e}'")
+                    self.logger.error(f"unforeseen error occurred: '{e}'")
                     return None, ''
 
             if self.sock is None:
                 if count == 3:
-                    logger.error("retries unsuccessful, serial port could not be opened, giving up.")
+                    self.logger.error("retries unsuccessful, serial port could not be opened, giving up.")
                 else:
                     # this should not happen...
-                    logger.error("retries unsuccessful or unforeseen error occurred, serial object was not initialized.")
+                    self.logger.error("retries unsuccessful or unforeseen error occurred, serial object was not initialized.")
                 return None, ''
 
             if not self.sock.is_open:
-                logger.error(f"serial port '{self.serial_port}' could not be opened with given parameters, maybe wrong baudrate?")
+                self.logger.error(f"serial port '{self.serial_port}' could not be opened with given parameters, maybe wrong baudrate?")
                 return None, ''
 
         elif self.host:
@@ -476,7 +526,7 @@ def get_sock(self):
             self.target = f'tcp://{self.host}:{self.port}'
 
         else:
-            logger.error('neither serialport nor host/port was given, no action possible.')
+            self.logger.error('neither serialport nor host/port was given, no action possible.')
             return None, ''
 
 
@@ -592,7 +642,7 @@ def parse(self, data: bytes) -> dict:
         return self.fp()
 
 
-def query(config) -> dict:
+def query(config, logger=logger) -> dict:
     """
     This function will
     1. open a serial communication line to the smartmeter
@@ -653,7 +703,11 @@ def discover(config: dict) -> bool:
     # reduced baud rates or changed parameters, but there would need to be
     # the need for this.
     # For now, let's see how well this works...
-    return bool(query(config))
+    str_log = StringLogger()
+    result = bool(query(config, str_log))
+    if not result:
+        config['discover_log'] = str_log()
+    return result
 
 
 if __name__ == '__main__':
@@ -718,8 +772,8 @@ def discover(config: dict) -> bool:
     logger.info("This is Smartmeter Plugin, SML module, running in standalone mode")
     logger.info("==================================================================")
 
-    result = query(config)
-
+    result = discover(config)
+        
     if not result:
         logger.info(f"No results from query, maybe a problem with the serial port '{config['serial_port']}' given.")
     elif len(result) > 1: