Merge pull request #23 from IoTLabs-pl/wmbusmeters-1.20.0

wmbusmeters 1.20.0

Author: kassie1551

README.md

@@ -36,8 +36,22 @@ wmbus_common:
     drivers:
       - apator162
       - amiplus
+    # or specify drivers and their fields to be loaded
+    drivers:
+      - name: apator162
+        fields:
+          - total_m3
+      - amiplus
+      - name: sensostar
+        fields:
+          - total_kwh
+      - waterstarm
 ```
 
+If you use `wmbus_meter` component, you may not need to configure `wmbus_common` component, as it will be automatically included as a dependency. Dependent components will automatically load required drivers and fields based on their configuration, so specifying them on this level is redundant.
+
+However, if you want to load specific drivers or fields that are not required by any dependent component, you should specify them in `wmbus_common` configuration.
+
 `wmbusmeters` is included as a git subtree. To sync version from upstream repository, run:
 
 ```bash
@@ -69,6 +83,9 @@ wmbus_meter:
 `mode` parameter is optional and allows to filter received packets by mode. It can be set to `T1` or `C1`. If not set, all packets will be processed.
 `key` parameter is optional and allows to decrypt packets using AES-128-CBC encryption. It should be provided as hexadecimal or ASCII encoded string. If not set, packets will be processed as unencrypted.
 
+**Attention!**
+By default, component will not load any fields to reduce memory footprint. If you need specific fields (or all fields) you can specify them in `wmbus_common` component configuration. Only specified fields will be available in `meter` variable in `on_telegram` trigger, will be serialized with `as_json` method etc.
+
 Component provides `on_telegram` trigger that can be used to send data to a remote server or process it in any other way. It can be used to send data to MQTT broker, HTTP server, or any other service. `meter` variable is available in the following lambdas.
 Additionally, `wmbus_meter.send_telegram_with_mqtt` action can be used to send JSON-encoded meter data to MQTT broker. It requires `mqtt` component to be configured in ESPHome.
 
@@ -97,6 +114,8 @@ On the `wmbus_meter` platform, you can use the following sensors to provide data
       field: timestamp
   ```
 
+When you use `sensor` and `text_sensor` platforms, required fields will be automatically loaded for corresponding driver, so you don't need to specify them in `wmbus_common` component configuration.
+
 For both `sensor` and `text_sensor`, all config from generic [Sensor](https://esphome.io/components/sensor/index.html) and [Text Sensor](https://esphome.io/components/text_sensor/index.html) components is available, so you can use filters, icons, etc.
 
 ## `wmbus_radio`

components/wmbus_common/.wmbusmeters_tag

@@ -1 +1 @@
-1.19.0
+1.20.0

components/wmbus_common/__init__.py

@@ -1,63 +1,89 @@
+from pathlib import Path
+
 import esphome.config_validation as cv
-from esphome.const import SOURCE_FILE_EXTENSIONS, CONF_ID
-from esphome.loader import get_component, ComponentManifest
 from esphome import codegen as cg
-from pathlib import Path
+from esphome.const import CONF_ID, CONF_NAME, SOURCE_FILE_EXTENSIONS
+from esphome.core import CORE
+from esphome.yaml_util import ESPHomeDumper
+
+from .driver_loader import CppDriver, Driver, DriverManager
 
 CODEOWNERS = ["@kubasaw"]
+CONF_ALL = "all"
 CONF_DRIVERS = "drivers"
+CONF_FIELDS = "fields"
+
+CURRENT_DIR = Path(__file__).parent
+SOURCE_FILE_EXTENSIONS.add(".cc")
+
 
 wmbus_common_ns = cg.esphome_ns.namespace("wmbus_common")
 WMBusCommon = wmbus_common_ns.class_("WMBusCommon", cg.Component)
 
-SOURCE_FILE_EXTENSIONS.add(".cc")
-
-_ALWAYS_EXCLUDED = {"auto", "unknown"}
 
-AVAILABLE_DRIVERS = sorted(
-    name
-    for f in Path(__file__).parent.glob("driver_*.cc")
-    if (name := f.stem.removeprefix("driver_")) not in _ALWAYS_EXCLUDED
+ESPHomeDumper.add_multi_representer(
+    Driver, lambda s, v: s.represent_stringify(v.name)
 )
 
-_registered_drivers = set()
 
+def maybe_all(replacements):
+    def validator(v):
+        if v == CONF_ALL:
+            return replacements
+        else:
+            return v
+
+    return validator
 
-validate_driver = cv.All(
-    cv.one_of(*AVAILABLE_DRIVERS, lower=True, space="_"),
-    lambda driver: _registered_drivers.add(driver) or driver,
-)
 
+def driver_field_validator(conf):
+    driver = conf[CONF_NAME]
+
+    conf[CONF_FIELDS] = cv.All(
+        maybe_all(driver.available_fields),
+        [driver.request_field],
+    )(conf[CONF_FIELDS])
+
+    return conf
+
+
+DRIVER_ENTRY_SCHEMA = cv.maybe_simple_value(
+    {
+        cv.Required(CONF_NAME): cv.All(
+            cv.one_of(*DriverManager.available_drivers), DriverManager.request_driver
+        ),
+        cv.Optional(CONF_FIELDS, default=CONF_ALL): cv.valid,
+    },
+    driver_field_validator,
+    key=CONF_NAME,
+)
 
 CONFIG_SCHEMA = cv.Schema(
     {
         cv.GenerateID(): cv.declare_id(WMBusCommon),
-        cv.Optional(CONF_DRIVERS): cv.All(
-            lambda x: AVAILABLE_DRIVERS if x == "all" else x,
-            [validate_driver],
+        cv.Optional(CONF_DRIVERS, default=[]): cv.All(
+            maybe_all(DriverManager.available_drivers), [DRIVER_ENTRY_SCHEMA]
         ),
     }
 )
 
 
-class WMBusComponentManifest(ComponentManifest):
-    @property
-    def resources(self):
-        exclude_drivers = set(AVAILABLE_DRIVERS) - _registered_drivers
-        if _registered_drivers:
-            exclude_drivers |= _ALWAYS_EXCLUDED
-        else:
-            exclude_drivers |= _ALWAYS_EXCLUDED - {"unknown"}
-
-        exclude_files = {f"driver_{name}.cc" for name in exclude_drivers}
-        resources = [fr for fr in super().resources if fr.resource not in exclude_files]
-        return resources
-
-
 async def to_code(config):
-    cg.add_define("WMBUSMETERS_TAG", Path(__file__).with_name('.wmbusmeters_tag').read_text())
+    cg.add_define(
+        "WMBUSMETERS_TAG",
+        CURRENT_DIR.joinpath(".wmbusmeters_tag").read_text(),
+    )
 
-    get_component("wmbus_common").__class__ = WMBusComponentManifest
+    target_dir = CORE.relative_src_path("wmbusmeters_drivers")
+    DriverManager.sync_to_directory(target_dir)
 
     var = cg.new_Pvariable(config[CONF_ID])
     await cg.register_component(var, config)
+
+
+def FILTER_SOURCE_FILES() -> list[str]:
+    return [
+        d.source_path.name
+        for d in DriverManager._all_drivers.values()
+        if isinstance(d, CppDriver)
+    ]

components/wmbus_common/driver_abbb23.cc

@@ -24,13 +24,13 @@ namespace
         Driver(MeterInfo &mi, DriverInfo &di);
     };
 
-    static bool ok = registerDriver([](DriverInfo&di)
+    static bool ok = staticRegisterDriver([](DriverInfo&di)
     {
         di.setName("abbb23");
         di.setDefaultFields("name,id,total_energy_consumption_kwh,timestamp");
         di.setMeterType(MeterType::ElectricityMeter);
         di.addLinkMode(LinkMode::T1);
-        di.addDetection(MANUFACTURER_ABB,  0x02,  0x20);
+        di.addMVT(MANUFACTURER_ABB,  0x02,  0x20);
         di.setConstructor([](MeterInfo& mi, DriverInfo& di){ return shared_ptr<Meter>(new Driver(mi, di)); });
     });
 

components/wmbus_common/driver_aerius.cc

@@ -24,13 +24,13 @@ namespace
         Driver(MeterInfo &mi, DriverInfo &di);
     };
 
-    static bool ok = registerDriver([](DriverInfo&di)
+    static bool ok = staticRegisterDriver([](DriverInfo&di)
     {
         di.setName("aerius");
         di.setDefaultFields("name,id,total_m3,timestamp");
         di.setMeterType(MeterType::GasMeter);
         di.addLinkMode(LinkMode::T1);
-        di.addDetection(MANUFACTURER_DME, 0x03, 0x30);
+        di.addMVT(MANUFACTURER_DME, 0x03, 0x30);
         di.setConstructor([](MeterInfo& mi, DriverInfo& di){ return shared_ptr<Meter>(new Driver(mi, di)); });
     });
 

components/wmbus_common/driver_amiplus.cc

@@ -1,5 +1,5 @@
 /*
- Copyright (C) 2019-2022 Fredrik Öhrström (gpl-3.0-or-later)
+ Copyright (C) 2019-2025 Fredrik Öhrström (gpl-3.0-or-later)
 
  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
@@ -24,21 +24,22 @@ namespace
         Driver(MeterInfo &mi, DriverInfo &di);
     };
 
-    static bool ok = registerDriver([](DriverInfo&di)
+    static bool ok = staticRegisterDriver([](DriverInfo&di)
     {
         di.setName("amiplus");
         di.setDefaultFields("name,id,total_energy_consumption_kwh,current_power_consumption_kw,total_energy_production_kwh,current_power_production_kw,voltage_at_phase_1_v,voltage_at_phase_2_v,voltage_at_phase_3_v,total_energy_consumption_tariff_1_kwh,total_energy_consumption_tariff_2_kwh,total_energy_consumption_tariff_3_kwh,total_energy_production_tariff_1_kwh,total_energy_production_tariff_2_kwh,total_energy_production_tariff_3_kwh,timestamp");
         di.setMeterType(MeterType::ElectricityMeter);
         di.addLinkMode(LinkMode::T1);
-        di.addDetection(MANUFACTURER_APA,  0x02,  0x02);
-        di.addDetection(MANUFACTURER_DEV,  0x37,  0x02);
-        di.addDetection(MANUFACTURER_DEV,  0x02,  0x00);
-        di.addDetection(MANUFACTURER_DEV,  0x02,  0x01);
+        di.addMVT(MANUFACTURER_APA,  0x02,  0x02);
+        di.addMVT(MANUFACTURER_DEV,  0x37,  0x02);
+        di.addMVT(MANUFACTURER_DEV,  0x02,  0x00);
+        di.addMVT(MANUFACTURER_DEV,  0x02,  0x01);
+        di.addMVT(MANUFACTURER_NES,  0x02,  0x03);
         // Apator Otus 1/3 seems to use both, depending on a frame.
         // Frames with APA are successfully decoded by this driver
         // Frames with APT are not - and their content is unknown - perhaps it broadcasts two data formats?
-        di.addDetection(MANUFACTURER_APA,  0x02,  0x01);
-        //di.addDetection(MANUFACTURER_APT,  0x02,  0x01);
+        di.addMVT(MANUFACTURER_APA,  0x02,  0x01);
+        //di.addMVT(MANUFACTURER_APT,  0x02,  0x01);
         di.setConstructor([](MeterInfo& mi, DriverInfo& di){ return shared_ptr<Meter>(new Driver(mi, di)); });
     });
 
@@ -91,29 +92,35 @@ namespace
             "Voltage at phase L1.",
             DEFAULT_PRINT_PROPERTIES,
             Quantity::Voltage,
-            VifScaling::None, DifSignedness::Signed,
+            VifScaling::Auto, DifSignedness::Signed,
             FieldMatcher::build()
-            .set(DifVifKey("0AFDC9FC01"))
+            .set(MeasurementType::Instantaneous)
+            .set(VIFRange::Voltage)
+            .add(VIFCombinable::AtPhase1)
             );
 
         addNumericFieldWithExtractor(
             "voltage_at_phase_2",
             "Voltage at phase L2.",
             DEFAULT_PRINT_PROPERTIES,
             Quantity::Voltage,
-            VifScaling::None, DifSignedness::Signed,
+            VifScaling::Auto, DifSignedness::Signed,
             FieldMatcher::build()
-            .set(DifVifKey("0AFDC9FC02"))
+            .set(MeasurementType::Instantaneous)
+            .set(VIFRange::Voltage)
+            .add(VIFCombinable::AtPhase2)
             );
 
         addNumericFieldWithExtractor(
             "voltage_at_phase_3",
             "Voltage at phase L3.",
             DEFAULT_PRINT_PROPERTIES,
             Quantity::Voltage,
-            VifScaling::None, DifSignedness::Signed,
+            VifScaling::Auto, DifSignedness::Signed,
             FieldMatcher::build()
-            .set(DifVifKey("0AFDC9FC03"))
+            .set(MeasurementType::Instantaneous)
+            .set(VIFRange::Voltage)
+            .add(VIFCombinable::AtPhase3)
             );
 
         addStringFieldWithExtractor(
@@ -232,3 +239,13 @@ namespace
 // telegram=|3e44b6108707320001027a380030052f2f0C7830253390066D6872141239400E031891690000000E833C9265010000000B2B2602000BAB3C0000002F2F2F2F|
 // {"_":"telegram","current_power_consumption_kw": 0.226,"current_power_production_kw": 0,"device_date_time": "2024-09-18 20:50:40","id": "00320787","media": "electricity","meter": "amiplus","name": "MyElectricity4","timestamp": "1111-11-11T11:11:11Z","total_energy_consumption_kwh": 699.118,"total_energy_production_kwh": 16.592}
 // |MyElectricity4;00320787;699.118;0.226;16.592;0;null;null;null;null;null;null;null;null;null;1111-11-11 11:11.11
+
+// Test: MyElectricity5 amiplus 56914504 NOKEY
+// telegram=|9e4401060445915601027a3d0390052f2f066dc076091935800c78044591560e032088300000008e10032088300000008e20030000000000008e30030000000000008e8010030000000000000e833c2702000000008e10833c2702000000008e20833c0000000000008e30833c0000000000008e8010833c0000000000000afdc8fc0136240afdc8fc0262240afdc8fc0389222f2f2f2f2f2f2f2f2f2f2f2f|
+// {"_":"telegram","media":"electricity","meter":"amiplus","name":"MyElectricity5","id":"56914504","total_energy_consumption_kwh":308.82,"total_energy_consumption_tariff_1_kwh":308.82,"total_energy_consumption_tariff_2_kwh":0,"total_energy_consumption_tariff_3_kwh":0,"total_energy_production_kwh":0.227,"total_energy_production_tariff_1_kwh":0.227,"total_energy_production_tariff_2_kwh":0,"total_energy_production_tariff_3_kwh":0,"voltage_at_phase_1_v":243.6,"voltage_at_phase_2_v":246.2,"voltage_at_phase_3_v":228.9,"device_date_time":"2024-05-25 09:54:00","timestamp":"1111-11-11T11:11:11Z"}
+// |MyElectricity5;56914504;308.82;null;0.227;null;243.6;246.2;228.9;308.82;0;0;0.227;0;0;1111-11-11 11:11.11
+
+// Test: MyElectricity6 amiplus 00086426 NOKEY
+// telegram=|8E44B3382664080003027A090080052F2F_066D37090E2232050C78266408000AFDC9FC0142020AFDC9FC0240020AFDC9FC0338028E30833C0000000000008E20833C0000000000008E10833C0000000000000BABC8FC100000008E10030750030000008E20035379060000008E30030000000000000B2B1307000BAB3C0000002F2F2F2F2F2F2F2F2F2F2F2F2F2F2F2F|
+// {"_": "telegram","current_power_consumption_kw": 0.713,"current_power_production_kw": 0,"device_date_time": "2025-02-02 14:09:55","id": "00086426","media": "electricity","meter": "amiplus","name": "MyElectricity6","timestamp": "1111-11-11T11:11:11Z","total_energy_consumption_tariff_1_kwh": 35.007,"total_energy_consumption_tariff_2_kwh": 67.953,"total_energy_consumption_tariff_3_kwh": 0,"total_energy_production_tariff_1_kwh": 0,"total_energy_production_tariff_2_kwh": 0,"total_energy_production_tariff_3_kwh": 0,"voltage_at_phase_1_v": 242,"voltage_at_phase_2_v": 240,"voltage_at_phase_3_v": 238}
+// |MyElectricity6;00086426;null;0.713;null;0;242;240;238;35.007;67.953;0;0;0;0;1111-11-11 11:11.11

components/wmbus_common/driver_apator08.cc

@@ -28,14 +28,14 @@ namespace
         void processContent(Telegram *t);
     };
 
-    static bool ok = registerDriver([](DriverInfo&di)
+    static bool ok = staticRegisterDriver([](DriverInfo&di)
     {
         di.setName("apator08");
         di.setDefaultFields("name,id,total_m3,timestamp");
         di.setMeterType(MeterType::WaterMeter);
         di.addLinkMode(LinkMode::T1);
-        di.addDetection(MANUFACTURER_APT, 0x03,  0x03);
-        di.addDetection(MANUFACTURER_APT, 0x0F, 0x0F);
+        di.addMVT(MANUFACTURER_APT, 0x03,  0x03);
+        di.addMVT(MANUFACTURER_APT, 0x0F, 0x0F);
         di.usesProcessContent();
         di.setConstructor([](MeterInfo& mi, DriverInfo& di){ return shared_ptr<Meter>(new Driver(mi, di)); });
     });

components/wmbus_common/driver_apator162.cc

@@ -28,16 +28,16 @@ namespace
         int registerSize(int c);
     };
 
-    static bool ok = registerDriver([](DriverInfo&di)
+    static bool ok = staticRegisterDriver([](DriverInfo&di)
     {
         di.setName("apator162");
         di.setDefaultFields("name,id,total_m3,timestamp");
         di.setMeterType(MeterType::WaterMeter);
         di.addLinkMode(LinkMode::T1);
         di.addLinkMode(LinkMode::C1);
-        di.addDetection(MANUFACTURER_APA,  0x06,  0x05);
-        di.addDetection(MANUFACTURER_APA,  0x07,  0x05);
-        di.addDetection(0x8614 /*APT?*/, 0x07,  0x05); // Older version of telegram that is not understood!
+        di.addMVT(MANUFACTURER_APA,  0x06,  0x05);
+        di.addMVT(MANUFACTURER_APA,  0x07,  0x05);
+        di.addMVT(0x8614 /*APT?*/, 0x07,  0x05); // Older version of telegram that is not understood!
         di.usesProcessContent();
         di.setConstructor([](MeterInfo& mi, DriverInfo& di){ return shared_ptr<Meter>(new Driver(mi, di)); });
     });

components/wmbus_common/driver_apator172.cc

@@ -28,12 +28,12 @@ namespace
         void processContent(Telegram *t);
     };
 
-    static bool ok = registerDriver([](DriverInfo&di)
+    static bool ok = staticRegisterDriver([](DriverInfo&di)
     {
         di.setName("apator172");
         di.setDefaultFields("name,id,total_m3,timestamp");
         di.setMeterType(MeterType::WaterMeter);
-        di.addDetection(0x8614 /*APT?*/,  0x11,  0x04);
+        di.addMVT(0x8614 /*APT?*/,  0x11,  0x04);
         di.usesProcessContent();
         di.setConstructor([](MeterInfo& mi, DriverInfo& di){ return shared_ptr<Meter>(new Driver(mi, di)); });
     });

components/wmbus_common/driver_apatoreitn.cc

@@ -28,16 +28,16 @@ namespace
         std::string dateToString(uchar date_lo, uchar date_hi);
     };
 
-    static bool ok = registerDriver([](DriverInfo&di)
+    static bool ok = staticRegisterDriver([](DriverInfo&di)
     {
         // Note: this supports only E.ITN 30.51 at the moment.
         // E.ITN 30.60 should be similar, as it is covered via the same datasheet
         // http://www.apator.com/uploads/files/Produkty/Podzielnik_kosztow_ogrzewania/i-pl-021-2016-e-itn-30-51-30-6.pdf
         di.setName("apatoreitn");
         di.setDefaultFields("name,id,current_hca,previous_hca,current_date,season_start_date,esb_date,temp_room_avg_c,temp_room_prev_avg_c,timestamp");
         di.setMeterType(MeterType::HeatCostAllocationMeter);
-        di.addDetection(MANUFACTURER_APA, 0x08,  0x04);
-        di.addDetection(MANUFACTURER_APT, 0x08,  0x04);
+        di.addMVT(MANUFACTURER_APA, 0x08,  0x04);
+        di.addMVT(MANUFACTURER_APT, 0x08,  0x04);
         di.usesProcessContent();
         di.setConstructor([](MeterInfo& mi, DriverInfo& di){ return shared_ptr<Meter>(new Driver(mi, di)); });
     });