2.2 (#28)

Author: spacemanspiff2007

readme.md

@@ -18,6 +18,9 @@ from energy meters and report the values through mqtt.
 
 
 # Changelog
+#### 2.2 (2023-03-31)
+- Small config improvements
+
 #### 2.1 (2023-03-27)
 - Additional obis id for serial number matching
 - Improved serial reading a bit

src/sml2mqtt/__version__.py

@@ -1 +1 @@
-__version__ = '2.1'
+__version__ = '2.2'

src/sml2mqtt/device/sml_device.py

@@ -147,28 +147,33 @@ def _setup_sml_values(self, device_config: Optional[SmlDeviceConfig], frame_valu
         log_level = logging.DEBUG if not CMD_ARGS.analyze else logging.INFO
         values_config: Dict[str, SmlValueConfig] = device_config.values if device_config is not None else {}
 
-        for obis_id in frame_values:
+        from_frame = frozenset(frame_values) - self.skip_values
+        from_config = frozenset(values_config)
+        default_cfg = from_frame - from_config
+
+        # create entries where we don't have a user config
+        for obis_id in sorted(default_cfg):
+            self.log.log(log_level, f'Creating default value handler for {obis_id}')
+            self.sml_values[obis_id] = SmlValue(
+                self.device_id, obis_id, self.mqtt_device.create_child(obis_id),
+                workarounds=[], transformations=[], filters=sml2mqtt.sml_value.filter_from_config(None)
+            )
+
+        # create entries which are defined by the user
+        for obis_id, value_config in sorted(values_config.items()):
+            # little helper to catch config errors
             if obis_id in self.skip_values:
-                continue
-
-            value_config = values_config.get(obis_id)
-
-            if device_config is None or value_config is None:
-                self.log.log(log_level, f'Creating default value handler for {obis_id}')
-                value = SmlValue(
-                    self.device_id, obis_id, self.mqtt_device.create_child(obis_id),
-                    workarounds=[], transformations=[], filters=sml2mqtt.sml_value.filter_from_config(None)
-                )
-            else:
-                self.log.log(log_level, f'Creating value handler from config for {obis_id}')
-                value = SmlValue(
-                    self.device_id, obis_id, self.mqtt_device.create_child(obis_id).set_config(value_config.mqtt),
-                    workarounds=sml2mqtt.sml_value.workaround_from_config(value_config.workarounds),
-                    transformations=sml2mqtt.sml_value.transform_from_config(value_config.transformations),
-                    filters=sml2mqtt.sml_value.filter_from_config(value_config.filters),
-                )
-
-            self.sml_values[obis_id] = value
+                self.log.warning(f'Config for {obis_id:s} found but {obis_id:s} is also marked to be skipped')
+            if obis_id not in frame_values:
+                self.log.warning(f'Config for {obis_id:s} found but {obis_id:s} was not reported by the frame')
+
+            self.log.log(log_level, f'Creating value handler from config for {obis_id}')
+            self.sml_values[obis_id] = SmlValue(
+                self.device_id, obis_id, self.mqtt_device.create_child(obis_id).set_config(value_config.mqtt),
+                workarounds=sml2mqtt.sml_value.workaround_from_config(value_config.workarounds),
+                transformations=sml2mqtt.sml_value.transform_from_config(value_config.transformations),
+                filters=sml2mqtt.sml_value.filter_from_config(value_config.filters),
+            )
 
     def serial_data_timeout(self):
         if self.set_status(DeviceStatus.MSG_TIMEOUT):
@@ -264,7 +269,16 @@ def process_frame(self, frame: SmlFrame):
                 frame_values.pop(drop_obis, None)
 
         for obis_id, frame_value in frame_values.items():
-            self.sml_values[obis_id].set_value(frame_value, frame_values)
+            if (sml_value := self.sml_values.get(obis_id)) is not None:
+                sml_value.set_value(frame_value, frame_values)
+            else:
+                # This can only happen if the device does not report all values with the initial frame
+                # The user then has to skip the obis ids or manually add them to the configuration
+                self.log.error('Unexpected obis id received!')
+                for line in frame_value.format_msg().splitlines():
+                    self.log.error(line)
+                self.set_status(DeviceStatus.ERROR)
+                return None
 
         # There was no Error -> OK
         self.set_status(DeviceStatus.OK)

tests/device/frames/test_frame_1.py

@@ -39,22 +39,15 @@ async def test_frame_no_config(device: TestingDevice, no_serial, caplog, monkeyp
     assert msg == sml_frame_1_analyze + """
 Found obis id 0100600100ff in the sml frame
 No configuration found for 0a0149534b0005020de2
-Creating default value handler for 010060320101
 Creating default value handler for 0100010800ff
 Creating default value handler for 0100100700ff
+Creating default value handler for 010060320101
 testing/0a0149534b0005020de2/010060320101: ISK (QOS: 0, retain: False)
 testing/0a0149534b0005020de2/0100010800ff: 253.9177 (QOS: 0, retain: False)
 testing/0a0149534b0005020de2/0100100700ff: 272 (QOS: 0, retain: False)
 OK
 testing/0a0149534b0005020de2/status: OK (QOS: 0, retain: False)
 
-testing/0a0149534b0005020de2/010060320101 (010060320101):
-  raw value: ISK
-  pub value: ISK
-  filters:
-    - <Every: 120>
-    - <OnChange>
-
 testing/0a0149534b0005020de2/0100010800ff (0100010800ff):
   raw value: 253.9177
   pub value: 253.9177
@@ -69,6 +62,13 @@ async def test_frame_no_config(device: TestingDevice, no_serial, caplog, monkeyp
     - <Every: 120>
     - <OnChange>
 
+testing/0a0149534b0005020de2/010060320101 (010060320101):
+  raw value: ISK
+  pub value: ISK
+  filters:
+    - <Every: 120>
+    - <OnChange>
+
 SHUTDOWN
 testing/0a0149534b0005020de2/status: SHUTDOWN (QOS: 0, retain: False)"""