Update itron driver.

2022-10-11 09:31:20 +02:00 · 2022-10-11 09:31:20 +02:00 · 1e31290622
commit 1e31290622
--- a/src/driver_itron.cc
+++ b/src/driver_itron.cc
@ -17,193 +17,129 @@

 #include"meters_common_implementation.h"

-using namespace std;
-
-struct MeterItron : public virtual MeterCommonImplementation
+namespace
 {
-    MeterItron(MeterInfo &mi, DriverInfo &di);
+    struct Driver : public virtual MeterCommonImplementation
+    {
+        Driver(MeterInfo &mi, DriverInfo &di);
+    };

-private:
+    static bool ok = registerDriver([](DriverInfo&di)
+    {
+        di.setName("itron");
+        di.setDefaultFields("name,id,total_m3,target_m3,timestamp");
+        di.setMeterType(MeterType::WaterMeter);
+        di.addLinkMode(LinkMode::T1);
+        di.addDetection(MANUFACTURER_ITW,  0x07,  0x03);
+        di.addDetection(MANUFACTURER_ITW,  0x07,  0x33);
+        di.setConstructor([](MeterInfo& mi, DriverInfo& di){ return shared_ptr<Meter>(new Driver(mi, di)); });
+    });

-    double total_water_consumption_m3_ {};
-    string meter_date_;
-    double target_water_consumption_m3_ {};
-    string target_date_;
-    string unknown_a_;
-    string unknown_b_;
-    string enhanced_id_;
-};
+    Driver::Driver(MeterInfo &mi, DriverInfo &di) : MeterCommonImplementation(mi, di)
+    {
+        setMeterType(MeterType::WaterMeter);

-static bool ok = registerDriver([](DriverInfo&di)
-{
-    di.setName("itron");
-    di.setMeterType(MeterType::WaterMeter);
-    di.addLinkMode(LinkMode::T1);
-    di.addDetection(MANUFACTURER_ITW,  0x07,  0x03);
-    di.addDetection(MANUFACTURER_ITW,  0x07,  0x33);
-    di.setConstructor([](MeterInfo& mi, DriverInfo& di){ return shared_ptr<Meter>(new MeterItron(mi, di)); });
-});
+        setExpectedTPLSecurityMode(TPLSecurityMode::AES_CBC_IV);

-MeterItron::MeterItron(MeterInfo &mi, DriverInfo &di) : MeterCommonImplementation(mi, di)
-{
-    setMeterType(MeterType::WaterMeter);
+        addLinkMode(LinkMode::T1);

-    setExpectedTPLSecurityMode(TPLSecurityMode::AES_CBC_IV);
+        addOptionalCommonFields();
+        addOptionalFlowRelatedFields();

-    addLinkMode(LinkMode::T1);
-
-    addOptionalCommonFields();
-    addOptionalFlowRelatedFields();
-
-    addNumericFieldWithExtractor(
-        "total",
-        Quantity::Volume,
-        NoDifVifKey,
-        VifScaling::Auto,
-        MeasurementType::Instantaneous,
-        VIFRange::Volume,
-        StorageNr(0),
-        TariffNr(0),
-        IndexNr(1),
-        PrintProperty::JSON | PrintProperty::FIELD | PrintProperty::IMPORTANT,
-        "The total water consumption recorded by this meter.",
-        SET_FUNC(total_water_consumption_m3_, Unit::M3),
-        GET_FUNC(total_water_consumption_m3_, Unit::M3));
-
-    addStringFieldWithExtractor(
-        "meter_date",
-        Quantity::Text,
-        NoDifVifKey,
-        MeasurementType::Instantaneous,
-        VIFRange::DateTime,
-        StorageNr(0),
-        TariffNr(0),
-        IndexNr(1),
-        PrintProperty::JSON,
-        "Date when measurement was recorded.",
-        SET_STRING_FUNC(meter_date_),
-        GET_STRING_FUNC(meter_date_));
-
-    addNumericFieldWithExtractor(
-        "target",
-        Quantity::Volume,
-        NoDifVifKey,
-        VifScaling::Auto,
-        MeasurementType::Instantaneous,
-        VIFRange::Volume,
-        StorageNr(1),
-        TariffNr(0),
-        IndexNr(1),
-        PrintProperty::JSON | PrintProperty::FIELD | PrintProperty::IMPORTANT,
-        "The total water consumption recorded at the beginning of this month.",
-        SET_FUNC(target_water_consumption_m3_, Unit::M3),
-        GET_FUNC(target_water_consumption_m3_, Unit::M3));
-
-    addStringFieldWithExtractor(
-        "target_date",
-        Quantity::Text,
-        NoDifVifKey,
-        MeasurementType::Instantaneous,
-        VIFRange::Date,
-        StorageNr(1),
-        TariffNr(0),
-        IndexNr(1),
-        PrintProperty::JSON,
-        "Date when target water consumption was recorded.",
-        SET_STRING_FUNC(target_date_),
-        GET_STRING_FUNC(target_date_));
-
-    addStringFieldWithExtractor(
-        "enhanced_id",
-        Quantity::Text,
-        DifVifKey("0E79"),
-        MeasurementType::Instantaneous,
-        VIFRange::EnhancedIdentification,
-        StorageNr(0),
-        TariffNr(0),
-        IndexNr(1),
-        PrintProperty::JSON | PrintProperty::OPTIONAL,
-        "Enhanced meter id.",
-        SET_STRING_FUNC(enhanced_id_),
-        GET_STRING_FUNC(enhanced_id_));
-
-    addStringFieldWithExtractorAndLookup(
-        "unknown_a",
-        Quantity::Text,
-        DifVifKey("047F"),
-        MeasurementType::Instantaneous,
-        VIFRange::Any,
-        AnyStorageNr,
-        AnyTariffNr,
-        IndexNr(1),
-        PrintProperty::JSON | PrintProperty::OPTIONAL,
-        "Unknown flags.",
-        SET_STRING_FUNC(unknown_a_),
-        GET_STRING_FUNC(unknown_a_),
-         {
+        addStringFieldWithExtractorAndLookup(
+            "status",
+            "Status and error flags.",
+            PrintProperty::JSON | PrintProperty::FIELD | PrintProperty::OPTIONAL,
+            FieldMatcher::build()
+            .set(MeasurementType::Instantaneous)
+            .set(VIFRange::ErrorFlags)
+            .add(VIFCombinable::RecordErrorCodeMeterToController),
            {
                {
-                    "WOOTA",
-                    Translate::Type::BitToString,
-                    0xffffffff,
-                    "",
                    {
-                    }
+                        "ERROR_FLAGS",
+                        Translate::Type::BitToString,
+                        0xffffff,
+                        "OK",
+                        {
+                            // No known layout for field
+                        }
+                    },
                },
-            },
-         });
+            });

-    addStringFieldWithExtractorAndLookup(
-        "unknown_b",
-        Quantity::Text,
-        DifVifKey("027F"),
-        MeasurementType::Instantaneous,
-        VIFRange::Any,
-        AnyStorageNr,
-        AnyTariffNr,
-        IndexNr(1),
-        PrintProperty::JSON | PrintProperty::OPTIONAL,
-        "Unknown flags.",
-        SET_STRING_FUNC(unknown_b_),
-        GET_STRING_FUNC(unknown_b_),
-         {
+        addNumericFieldWithExtractor(
+            "target",
+             "The total water consumption recorded at the end of previous billing period.",
+            PrintProperty::JSON | PrintProperty::FIELD | PrintProperty::IMPORTANT,
+            Quantity::Volume,
+            VifScaling::Auto,
+            FieldMatcher::build()
+            .set(MeasurementType::Instantaneous)
+            .set(VIFRange::Volume)
+            .set(StorageNr(1))
+            );
+
+        addStringFieldWithExtractor(
+            "target_date",
+            "Date when previous billing period ended.",
+            PrintProperty::JSON | PrintProperty::OPTIONAL,
+            FieldMatcher::build()
+            .set(MeasurementType::Instantaneous)
+            .set(VIFRange::Date)
+            .set(StorageNr(1))
+            );
+
+        addStringFieldWithExtractorAndLookup(
+            "unknown_a",
+            "Unknown flags.",
+            PrintProperty::JSON | PrintProperty::OPTIONAL,
+            FieldMatcher::build()
+            .set(DifVifKey("047F")),
            {
                {
-                    "WOOTB",
-                    Translate::Type::BitToString,
-                    0xffff,
-                    "",
                    {
-                    }
+                        "WOOTA",
+                        Translate::Type::BitToString,
+                        0xffffffff,
+                        "",
+                        {
+                            // No known layout for field
+                        }
+                    },
                },
-            },
-         });
+            });

-    addStringFieldWithExtractorAndLookup(
-        "status",
-        "Status and error flags.",
-        PrintProperty::JSON | PrintProperty::FIELD | PrintProperty::OPTIONAL,
-        FieldMatcher::build()
-        .set(DifVifKey("03FD971C"))
-        ,
-        {
+        addStringFieldWithExtractorAndLookup(
+            "unknown_b",
+            "Unknown flags.",
+            PrintProperty::JSON | PrintProperty::OPTIONAL,
+            FieldMatcher::build()
+            .set(DifVifKey("027F")),
            {
                {
-                    "ERROR_FLAGS",
-                    Translate::Type::BitToString,
-                    0xffffff,
-                    "OK",
                    {
-                        // No known layout for field
-                    }
+                        "WOOTB",
+                        Translate::Type::BitToString,
+                        0xffff,
+                        "",
+                        {
+                            // No known layout for field
+                        }
+                    },
                },
-            },
-        });
+            });

+    }
 }

 // Test: SomeWater itron 12345698 NOKEY
 // Comment: Test ITRON T1 telegram not encrypted, which has no 2f2f markers.
 // telegram=|384497269856341203077AD90000A0#0413FD110000066D2C1AA1D521004413300F0000426CBF2C047F0000060C027F862A0E79678372082100|
-// {"media":"water","meter":"itron","name":"SomeWater","id":"12345698","total_m3":4.605,"meter_date":"2022-01-21 01:26","target_m3":3.888,"target_date":"2021-12-31","enhanced_id":"002108728367","unknown_a":"WOOTA_C060000","unknown_b":"WOOTB_2A86","timestamp":"1111-11-11T11:11:11Z"}
-// |SomeWater;12345698;4.605000;3.888000;1111-11-11 11:11.11
+// {"media":"water","meter":"itron","name":"SomeWater","id":"12345698","enhanced_id":"002108728367","meter_datetime":"2022-01-21 01:26","total_m3":4.605,"target_m3":3.888,"target_date":"2021-12-31","unknown_a":"WOOTA_C060000","unknown_b":"WOOTB_2A86","timestamp":"1111-11-11T11:11:11Z"}
+// |SomeWater;12345698;4.605;3.888;1111-11-11 11:11.11
+
+// Test: MoreWater itron 18000056 NOKEY
+// telegram=|46449726560000183307725600001897263307AF0030052F2F_066D0E1015C82A000C13771252000C933C000000000B3B0400004C1361045200426CC12A03FD971C0000002F2F2F|
+// {"media":"water","meter":"itron","name":"MoreWater","id":"18000056","meter_datetime":"2022-10-08 21:16","total_m3":521.277,"total_backward_m3":0,"volume_flow_m3h":0.004,"status":"OK","target_m3":520.461,"target_date":"2022-10-01","timestamp":"1111-11-11T11:11:11Z"}
+// |MoreWater;18000056;521.277;520.461;1111-11-11 11:11.11
--- a/src/meters.cc
+++ b/src/meters.cc
@ -2973,6 +2973,15 @@ void MeterCommonImplementation::addOptionalCommonFields()
        .set(VIFRange::FabricationNo)
        );

+    addStringFieldWithExtractor(
+        "enhanced_id",
+        "Enhanced identification number.",
+        PrintProperty::JSON | PrintProperty::OPTIONAL,
+        FieldMatcher::build()
+        .set(MeasurementType::Instantaneous)
+        .set(VIFRange::EnhancedIdentification)
+        );
+
    addStringFieldWithExtractor(
        "software_version",
        "Software version.",