kopia lustrzana https://github.com/weetmuts/wmbusmeters
2929 wiersze
88 KiB
C++
2929 wiersze
88 KiB
C++
/*
|
|
Copyright (C) 2017-2022 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
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include"bus.h"
|
|
#include"config.h"
|
|
#include"meters.h"
|
|
#include"meter_detection.h"
|
|
#include"meters_common_implementation.h"
|
|
#include"units.h"
|
|
#include"wmbus.h"
|
|
#include"wmbus_utils.h"
|
|
|
|
#include<algorithm>
|
|
#include<cmath>
|
|
#include<limits>
|
|
#include<memory.h>
|
|
#include<numeric>
|
|
#include<stdexcept>
|
|
#include<time.h>
|
|
|
|
map<string, DriverInfo> *registered_drivers_ = NULL;
|
|
vector<DriverInfo*> *registered_drivers_list_ = NULL;
|
|
|
|
void verifyDriverLookupCreated()
|
|
{
|
|
if (registered_drivers_ == NULL)
|
|
{
|
|
registered_drivers_ = new map<string,DriverInfo>;
|
|
}
|
|
if (registered_drivers_list_ == NULL)
|
|
{
|
|
registered_drivers_list_ = new vector<DriverInfo*>;
|
|
}
|
|
}
|
|
|
|
DriverInfo *lookupDriver(string name)
|
|
{
|
|
verifyDriverLookupCreated();
|
|
if (registered_drivers_->count(name) == 1)
|
|
{
|
|
return &(*registered_drivers_)[name];
|
|
}
|
|
|
|
for (DriverInfo *di : *registered_drivers_list_)
|
|
{
|
|
for (DriverName &dn : di->nameAliases())
|
|
{
|
|
if (dn.str() == name)
|
|
{
|
|
return di;
|
|
}
|
|
}
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
vector<DriverInfo*> &allDrivers()
|
|
{
|
|
return *registered_drivers_list_;
|
|
}
|
|
|
|
void addRegisteredDriver(DriverInfo di)
|
|
{
|
|
verifyDriverLookupCreated();
|
|
if (registered_drivers_->count(di.name().str()) != 0)
|
|
{
|
|
error("Two drivers trying to register the name \"%s\"\n", di.name().str().c_str());
|
|
exit(1);
|
|
}
|
|
|
|
(*registered_drivers_)[di.name().str()] = di;
|
|
// The list elements points into the map.
|
|
(*registered_drivers_list_).push_back(lookupDriver(di.name().str()));
|
|
}
|
|
|
|
bool DriverInfo::detect(uint16_t mfct, uchar type, uchar version)
|
|
{
|
|
for (auto &dd : detect_)
|
|
{
|
|
if (dd.mfct == 0 && dd.type == 0 && dd.version == 0) continue; // Ignore drivers with no detection.
|
|
if (dd.mfct == mfct && dd.type == type && dd.version == version) return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
bool DriverInfo::isValidMedia(uchar type)
|
|
{
|
|
for (auto &dd : detect_)
|
|
{
|
|
if (dd.type == type) return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
bool DriverInfo::isCloseEnoughMedia(uchar type)
|
|
{
|
|
for (auto &dd : detect_)
|
|
{
|
|
if (isCloseEnough(dd.type, type)) return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
bool registerDriver(function<void(DriverInfo&)> setup)
|
|
{
|
|
DriverInfo di;
|
|
setup(di);
|
|
|
|
// Check that the driver name has not been registered before!
|
|
assert(lookupDriver(di.name().str()) == NULL);
|
|
|
|
// Check that no other driver also triggers on the same detection values.
|
|
for (auto &d : di.detect())
|
|
{
|
|
for (DriverInfo *p : allDrivers())
|
|
{
|
|
bool foo = p->detect(d.mfct, d.type, d.version);
|
|
if (foo)
|
|
{
|
|
error("Internal error: driver %s tried to register the same auto detect combo as driver %s alread has taken!\n",
|
|
di.name().str().c_str(), p->name().str().c_str());
|
|
}
|
|
}
|
|
}
|
|
|
|
// Everything looks, good install this driver.
|
|
addRegisteredDriver(di);
|
|
|
|
// This code is invoked from the static initializers of DriverInfos when starting
|
|
// wmbusmeters. Thus we do not yet know if the user has supplied --debug or similar setting.
|
|
// To debug this you have to uncomment the printf below.
|
|
// fprintf(stderr, "(STATIC) added driver: %s\n", n.c_str());
|
|
return true;
|
|
}
|
|
|
|
bool lookupDriverInfo(string& driver, DriverInfo *out_di)
|
|
{
|
|
DriverInfo *di = lookupDriver(driver);
|
|
if (di == NULL)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
*out_di = *di;
|
|
|
|
return true;
|
|
}
|
|
|
|
struct MeterManagerImplementation : public virtual MeterManager
|
|
{
|
|
private:
|
|
bool is_daemon_ {};
|
|
bool should_analyze_ {};
|
|
OutputFormat analyze_format_ {};
|
|
string analyze_driver_;
|
|
string analyze_key_;
|
|
bool analyze_verbose_;
|
|
vector<MeterInfo> meter_templates_;
|
|
vector<shared_ptr<Meter>> meters_;
|
|
vector<function<bool(AboutTelegram&,vector<uchar>)>> telegram_listeners_;
|
|
function<void(Telegram*t,Meter*)> on_meter_updated_;
|
|
|
|
public:
|
|
void addMeterTemplate(MeterInfo &mi)
|
|
{
|
|
meter_templates_.push_back(mi);
|
|
}
|
|
|
|
void addMeter(shared_ptr<Meter> meter)
|
|
{
|
|
meters_.push_back(meter);
|
|
meter->setIndex(meters_.size());
|
|
meter->onUpdate(on_meter_updated_);
|
|
}
|
|
|
|
Meter *lastAddedMeter()
|
|
{
|
|
return meters_.back().get();
|
|
}
|
|
|
|
void removeAllMeters()
|
|
{
|
|
meters_.clear();
|
|
}
|
|
|
|
void forEachMeter(std::function<void(Meter*)> cb)
|
|
{
|
|
for (auto &meter : meters_)
|
|
{
|
|
cb(meter.get());
|
|
}
|
|
}
|
|
|
|
bool hasAllMetersReceivedATelegram()
|
|
{
|
|
if (meters_.size() < meter_templates_.size()) return false;
|
|
|
|
for (auto &meter : meters_)
|
|
{
|
|
if (meter->numUpdates() == 0) return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool hasMeters()
|
|
{
|
|
return meters_.size() != 0 || meter_templates_.size() != 0;
|
|
}
|
|
|
|
void warnForUnknownDriver(string name, Telegram *t)
|
|
{
|
|
int mfct = t->dll_mfct;
|
|
int media = t->dll_type;
|
|
int version = t->dll_version;
|
|
uchar *id_b = t->dll_id_b;
|
|
|
|
if (t->tpl_id_found)
|
|
{
|
|
mfct = t->tpl_mfct;
|
|
media = t->tpl_type;
|
|
version = t->tpl_version;
|
|
id_b = t->tpl_id_b;
|
|
}
|
|
|
|
warning("(meter) %s: meter detection could not find driver for "
|
|
"id: %02x%02x%02x%02x mfct: (%s) %s (0x%02x) type: %s (0x%02x) ver: 0x%02x\n",
|
|
name.c_str(),
|
|
id_b[3], id_b[2], id_b[1], id_b[0],
|
|
manufacturerFlag(mfct).c_str(),
|
|
manufacturer(mfct).c_str(),
|
|
mfct,
|
|
mediaType(media, mfct).c_str(), media,
|
|
version);
|
|
|
|
|
|
warning("(meter) please consider opening an issue at https://github.com/weetmuts/wmbusmeters/\n");
|
|
warning("(meter) to add support for this unknown mfct,media,version combination\n");
|
|
}
|
|
|
|
bool handleTelegram(AboutTelegram &about, vector<uchar> input_frame, bool simulated)
|
|
{
|
|
if (should_analyze_)
|
|
{
|
|
analyzeTelegram(about, input_frame, simulated);
|
|
return true;
|
|
}
|
|
|
|
bool handled = false;
|
|
bool exact_id_match = false;
|
|
|
|
string ids;
|
|
for (auto &m : meters_)
|
|
{
|
|
bool h = m->handleTelegram(about, input_frame, simulated, &ids, &exact_id_match);
|
|
if (h) handled = true;
|
|
}
|
|
|
|
// If not properly handled, and there was no exact id match.
|
|
// then lets check if there is a template that can create a meter for it.
|
|
if (!handled && !exact_id_match)
|
|
{
|
|
debug("(meter) no meter handled %s checking %d templates.\n", ids.c_str(), meter_templates_.size());
|
|
// Not handled, maybe we have a template to create a new meter instance for this telegram?
|
|
Telegram t;
|
|
t.about = about;
|
|
bool ok = t.parseHeader(input_frame);
|
|
if (simulated) t.markAsSimulated();
|
|
|
|
if (ok)
|
|
{
|
|
ids = t.idsc;
|
|
for (auto &mi : meter_templates_)
|
|
{
|
|
if (MeterCommonImplementation::isTelegramForMeter(&t, NULL, &mi))
|
|
{
|
|
// We found a match, make a copy of the meter info.
|
|
MeterInfo meter_info = mi;
|
|
// Overwrite the wildcard pattern with the highest level id.
|
|
// The last id in the t.ids is the highest level id.
|
|
// For example: a telegram can have dll_id,tpl_id
|
|
// This will pick the tpl_id.
|
|
// Or a telegram can have a single dll_id,
|
|
// then the dll_id will be picked.
|
|
vector<string> tmp_ids;
|
|
tmp_ids.push_back(t.ids.back());
|
|
meter_info.ids = tmp_ids;
|
|
meter_info.idsc = t.ids.back();
|
|
|
|
if (meter_info.driver == MeterDriver::AUTO)
|
|
{
|
|
// Look up the proper meter driver!
|
|
DriverInfo di = pickMeterDriver(&t);
|
|
if (di.driver() == MeterDriver::UNKNOWN && di.name().str() == "")
|
|
{
|
|
if (should_analyze_ == false)
|
|
{
|
|
// We are not analyzing, so warn here.
|
|
warnForUnknownDriver(mi.name, &t);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
meter_info.driver = di.driver();
|
|
meter_info.driver_name = di.name();
|
|
}
|
|
}
|
|
// Now build a meter object with for this exact id.
|
|
auto meter = createMeter(&meter_info);
|
|
addMeter(meter);
|
|
string idsc = toIdsCommaSeparated(t.ids);
|
|
verbose("(meter) used meter template %s %s %s to match %s\n",
|
|
mi.name.c_str(),
|
|
mi.idsc.c_str(),
|
|
toString(mi.driver).c_str(),
|
|
idsc.c_str());
|
|
|
|
if (is_daemon_)
|
|
{
|
|
notice("(wmbusmeters) started meter %d (%s %s %s)\n",
|
|
meter->index(),
|
|
mi.name.c_str(),
|
|
meter_info.idsc.c_str(),
|
|
toString(mi.driver).c_str());
|
|
}
|
|
else
|
|
{
|
|
verbose("(meter) started meter %d (%s %s %s)\n",
|
|
meter->index(),
|
|
mi.name.c_str(),
|
|
meter_info.idsc.c_str(),
|
|
toString(mi.driver).c_str());
|
|
}
|
|
|
|
bool match = false;
|
|
bool h = meter->handleTelegram(about, input_frame, simulated, &ids, &match);
|
|
if (!match)
|
|
{
|
|
// Oups, we added a new meter object tailored for this telegram
|
|
// but it still did not match! This is probably an error in wmbusmeters!
|
|
warning("(meter) newly created meter (%s %s %s) did not match telegram! ",
|
|
"Please open an issue at https://github.com/weetmuts/wmbusmeters/\n",
|
|
meter->name().c_str(), meter->idsc().c_str(), meter->driverName().str().c_str());
|
|
}
|
|
else if (!h)
|
|
{
|
|
// Oups, we added a new meter object tailored for this telegram
|
|
// but it still did not handle it! This can happen if the wrong
|
|
// decryption key was used.
|
|
warning("(meter) newly created meter (%s %s %s) did not handle telegram!\n",
|
|
meter->name().c_str(), meter->idsc().c_str(), meter->driverName().str().c_str());
|
|
}
|
|
else
|
|
{
|
|
handled = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
for (auto f : telegram_listeners_)
|
|
{
|
|
f(about, input_frame);
|
|
}
|
|
if (isVerboseEnabled() && !handled)
|
|
{
|
|
verbose("(wmbus) telegram from %s ignored by all configured meters!\n", ids.c_str());
|
|
}
|
|
return handled;
|
|
}
|
|
|
|
void onTelegram(function<bool(AboutTelegram &about, vector<uchar>)> cb)
|
|
{
|
|
telegram_listeners_.push_back(cb);
|
|
}
|
|
|
|
void whenMeterUpdated(std::function<void(Telegram*t,Meter*)> cb)
|
|
{
|
|
on_meter_updated_ = cb;
|
|
}
|
|
|
|
void pollMeters(shared_ptr<BusManager> bus)
|
|
{
|
|
for (auto &m : meters_)
|
|
{
|
|
m->poll(bus);
|
|
}
|
|
}
|
|
|
|
void analyzeEnabled(bool b, OutputFormat f, string force_driver, string key, bool verbose)
|
|
{
|
|
should_analyze_ = b;
|
|
analyze_format_ = f;
|
|
if (force_driver != "auto")
|
|
{
|
|
analyze_driver_ = force_driver;
|
|
}
|
|
analyze_key_ = key;
|
|
analyze_verbose_ = verbose;
|
|
}
|
|
|
|
string findBestOldStyleDriver(MeterInfo &mi,
|
|
int *best_length,
|
|
int *best_understood,
|
|
Telegram &t,
|
|
AboutTelegram &about,
|
|
vector<uchar> &input_frame,
|
|
bool simulated,
|
|
string force)
|
|
{
|
|
vector<MeterDriver> old_drivers;
|
|
#define X(mname,linkmode,info,type,cname) old_drivers.push_back(MeterDriver::type);
|
|
LIST_OF_METERS
|
|
#undef X
|
|
|
|
string best_driver = "";
|
|
for (MeterDriver odr : old_drivers)
|
|
{
|
|
if (odr == MeterDriver::AUTO) continue;
|
|
if (odr == MeterDriver::UNKNOWN) continue;
|
|
string driver_name = toString(odr);
|
|
if (force != "")
|
|
{
|
|
if (driver_name != force) continue;
|
|
return driver_name;
|
|
}
|
|
|
|
if (force == "" &&
|
|
!isMeterDriverReasonableForMedia(odr, "", t.dll_type) &&
|
|
!isMeterDriverReasonableForMedia(odr, "", t.tpl_type))
|
|
{
|
|
// Sanity check, skip this driver since it is not relevant for this media.
|
|
continue;
|
|
}
|
|
|
|
debug("Testing old style driver %s...\n", driver_name.c_str());
|
|
mi.driver = odr;
|
|
mi.driver_name = DriverName("");
|
|
|
|
auto meter = createMeter(&mi);
|
|
|
|
bool match = false;
|
|
string id;
|
|
bool h = meter->handleTelegram(about, input_frame, simulated, &id, &match, &t);
|
|
if (!match)
|
|
{
|
|
debug("no match!\n");
|
|
}
|
|
else if (!h)
|
|
{
|
|
// Oups, we added a new meter object tailored for this telegram
|
|
// but it still did not handle it! This can happen if the wrong
|
|
// decryption key was used. But it is ok if analyzing....
|
|
debug("Newly created meter (%s %s %s) did not handle telegram!\n",
|
|
meter->name().c_str(), meter->idsc().c_str(), meter->driverName().str().c_str());
|
|
}
|
|
else
|
|
{
|
|
int l = 0;
|
|
int u = 0;
|
|
t.analyzeParse(OutputFormat::NONE, &l, &u);
|
|
if (analyze_verbose_ && force == "") printf("(verbose) old %02d/%02d %s\n", u, l, driver_name.c_str());
|
|
if (u > *best_understood)
|
|
{
|
|
*best_understood = u;
|
|
*best_length = l;
|
|
best_driver = driver_name;
|
|
if (analyze_verbose_ && force == "") printf("(verbose) old best so far: %s %02d/%02d\n", best_driver.c_str(), u, l);
|
|
}
|
|
}
|
|
}
|
|
return best_driver;
|
|
}
|
|
|
|
string findBestNewStyleDriver(MeterInfo &mi,
|
|
int *best_length,
|
|
int *best_understood,
|
|
Telegram &t,
|
|
AboutTelegram &about,
|
|
vector<uchar> &input_frame,
|
|
bool simulated,
|
|
string only)
|
|
{
|
|
string best_driver = "";
|
|
|
|
for (DriverInfo *ndr : allDrivers())
|
|
{
|
|
string driver_name = toString(*ndr);
|
|
if (only != "")
|
|
{
|
|
if (driver_name != only) continue;
|
|
return driver_name;
|
|
}
|
|
|
|
if (only == "" &&
|
|
!isMeterDriverReasonableForMedia(MeterDriver::AUTO, driver_name, t.dll_type) &&
|
|
!isMeterDriverReasonableForMedia(MeterDriver::AUTO, driver_name, t.tpl_type))
|
|
{
|
|
// Sanity check, skip this driver since it is not relevant for this media.
|
|
continue;
|
|
}
|
|
|
|
debug("Testing new style driver %s...\n", driver_name.c_str());
|
|
mi.driver = MeterDriver::UNKNOWN;
|
|
mi.driver_name = driver_name;
|
|
|
|
auto meter = createMeter(&mi);
|
|
|
|
bool match = false;
|
|
string id;
|
|
bool h = meter->handleTelegram(about, input_frame, simulated, &id, &match, &t);
|
|
|
|
if (!match)
|
|
{
|
|
debug("no match!\n");
|
|
}
|
|
else if (!h)
|
|
{
|
|
// Oups, we added a new meter object tailored for this telegram
|
|
// but it still did not handle it! This can happen if the wrong
|
|
// decryption key was used. But it is ok if analyzing....
|
|
debug("Newly created meter (%s %s %s) did not handle telegram!\n",
|
|
meter->name().c_str(), meter->idsc().c_str(), meter->driverName().str().c_str());
|
|
}
|
|
else
|
|
{
|
|
int l = 0;
|
|
int u = 0;
|
|
t.analyzeParse(OutputFormat::NONE, &l, &u);
|
|
if (analyze_verbose_ && only == "") printf("(verbose) new %02d/%02d %s\n", u, l, driver_name.c_str());
|
|
if (u > *best_understood)
|
|
{
|
|
*best_understood = u;
|
|
*best_length = l;
|
|
best_driver = ndr->name().str();
|
|
if (analyze_verbose_ && only == "") printf("(verbose) new best so far: %s %02d/%02d\n", best_driver.c_str(), u, l);
|
|
}
|
|
}
|
|
}
|
|
return best_driver;
|
|
}
|
|
|
|
void analyzeTelegram(AboutTelegram &about, vector<uchar> &input_frame, bool simulated)
|
|
{
|
|
Telegram t;
|
|
t.about = about;
|
|
|
|
bool ok = t.parseHeader(input_frame);
|
|
if (simulated) t.markAsSimulated();
|
|
t.markAsBeingAnalyzed();
|
|
|
|
if (!ok)
|
|
{
|
|
printf("Could not even analyze header, giving up.\n");
|
|
return;
|
|
}
|
|
|
|
if (meter_templates_.size() > 0)
|
|
{
|
|
error("You cannot specify a meter quadruple when analyzing.\n"
|
|
"Instead use --analyze=<format>:<driver>:<key>\n"
|
|
"where <formt> <driver> <key> are all optional.\n"
|
|
"E.g. --analyze=terminal:multical21:001122334455667788001122334455667788\n"
|
|
" --analyze=001122334455667788001122334455667788\n"
|
|
" --analyze\n");
|
|
}
|
|
|
|
// Overwrite the id with the id from the telegram to be analyzed.
|
|
MeterInfo mi;
|
|
mi.key = analyze_key_;
|
|
mi.ids.clear();
|
|
mi.ids.push_back(t.ids.back());
|
|
mi.idsc = t.ids.back();
|
|
|
|
// This will be the driver that will actually decode and print with.
|
|
string using_driver = "";
|
|
int using_length = 0;
|
|
int using_understood = 0;
|
|
|
|
// Driver that understands most of the telegram content.
|
|
string best_driver = "";
|
|
int best_length = 0;
|
|
int best_understood = 0;
|
|
|
|
int old_best_length = 0;
|
|
int old_best_understood = 0;
|
|
string best_old_driver = findBestOldStyleDriver(mi, &old_best_length, &old_best_understood, t, about, input_frame, simulated, "");
|
|
|
|
int new_best_length = 0;
|
|
int new_best_understood = 0;
|
|
string best_new_driver = findBestNewStyleDriver(mi, &new_best_length, &new_best_understood, t, about, input_frame, simulated, "");
|
|
|
|
mi.driver = MeterDriver::UNKNOWN;
|
|
mi.driver_name = DriverName("");
|
|
|
|
// Use the existing mapping from mfct/media/version to driver.
|
|
DriverInfo auto_di = pickMeterDriver(&t);
|
|
string auto_driver = auto_di.name().str();
|
|
if (auto_driver == "")
|
|
{
|
|
auto_driver = toString(auto_di.driver());
|
|
if (auto_driver == "unknown")
|
|
{
|
|
auto_driver = "";
|
|
}
|
|
}
|
|
|
|
// Will be non-empty if an explicit driver has been selected.
|
|
string force_driver = analyze_driver_;
|
|
int force_length = 0;
|
|
int force_understood = 0;
|
|
|
|
// If an auto driver is found and no other driver has been forced, use the auto driver.
|
|
if (force_driver == "" && auto_driver != "")
|
|
{
|
|
force_driver = auto_driver;
|
|
}
|
|
|
|
if (force_driver != "")
|
|
{
|
|
using_driver = findBestOldStyleDriver(mi, &force_length, &force_understood, t, about, input_frame, simulated,
|
|
force_driver);
|
|
|
|
if (using_driver != "")
|
|
{
|
|
mi.driver = toMeterDriver(using_driver);
|
|
mi.driver_name = DriverName("");
|
|
using_driver += "(driver should be upgraded)";
|
|
}
|
|
else
|
|
{
|
|
using_driver = findBestNewStyleDriver(mi, &force_length, &force_understood, t, about, input_frame, simulated,
|
|
force_driver);
|
|
mi.driver_name = using_driver;
|
|
mi.driver = MeterDriver::UNKNOWN;
|
|
}
|
|
using_length = force_length;
|
|
using_understood = force_understood;
|
|
}
|
|
|
|
if (old_best_understood > new_best_understood)
|
|
{
|
|
best_length = old_best_length;
|
|
best_understood = old_best_understood;
|
|
best_driver = best_old_driver+"(driver should be upgraded)";
|
|
if (using_driver == "")
|
|
{
|
|
mi.driver = toMeterDriver(best_old_driver);
|
|
mi.driver_name = DriverName("");
|
|
using_driver = best_driver;
|
|
using_length = best_length;
|
|
using_understood = best_understood;
|
|
}
|
|
}
|
|
else if (new_best_understood >= old_best_understood)
|
|
{
|
|
best_length = new_best_length;
|
|
best_understood = new_best_understood;
|
|
best_driver = best_new_driver;
|
|
if (using_driver == "")
|
|
{
|
|
mi.driver_name = best_new_driver;
|
|
mi.driver = MeterDriver::UNKNOWN;
|
|
using_driver = best_new_driver;
|
|
using_length = best_length;
|
|
using_understood = best_understood;
|
|
}
|
|
}
|
|
|
|
auto meter = createMeter(&mi);
|
|
|
|
bool match = false;
|
|
string id;
|
|
|
|
meter->handleTelegram(about, input_frame, simulated, &id, &match, &t);
|
|
|
|
int u = 0;
|
|
int l = 0;
|
|
|
|
string output = t.analyzeParse(analyze_format_, &u, &l);
|
|
|
|
string hr, fields, json;
|
|
vector<string> envs, more_json, selected_fields;
|
|
|
|
meter->printMeter(&t, &hr, &fields, '\t', &json,
|
|
&envs, &more_json, &selected_fields, true);
|
|
|
|
if (auto_driver == "")
|
|
{
|
|
auto_driver = "not found!";
|
|
}
|
|
|
|
printf("Auto driver : %s\n", auto_driver.c_str());
|
|
printf("Best driver : %s %02d/%02d\n", best_driver.c_str(), best_understood, best_length);
|
|
printf("Using driver : %s %02d/%02d\n", using_driver.c_str(), using_understood, using_length);
|
|
|
|
printf("%s\n", output.c_str());
|
|
|
|
printf("%s\n", json.c_str());
|
|
}
|
|
|
|
MeterManagerImplementation(bool daemon) : is_daemon_(daemon) {}
|
|
~MeterManagerImplementation() {}
|
|
};
|
|
|
|
shared_ptr<MeterManager> createMeterManager(bool daemon)
|
|
{
|
|
return shared_ptr<MeterManager>(new MeterManagerImplementation(daemon));
|
|
}
|
|
|
|
MeterCommonImplementation::MeterCommonImplementation(MeterInfo &mi,
|
|
string driver) :
|
|
driver_(driver), bus_(mi.bus), name_(mi.name), waiting_for_poll_response_sem_("waiting_for_poll_response")
|
|
{
|
|
ids_ = mi.ids;
|
|
idsc_ = toIdsCommaSeparated(ids_);
|
|
link_modes_ = mi.link_modes;
|
|
|
|
if (mi.key.length() > 0)
|
|
{
|
|
hex2bin(mi.key, &meter_keys_.confidentiality_key);
|
|
}
|
|
for (auto s : mi.shells) {
|
|
addShell(s);
|
|
}
|
|
for (auto j : mi.extra_constant_fields) {
|
|
addExtraConstantField(j);
|
|
}
|
|
}
|
|
|
|
MeterCommonImplementation::MeterCommonImplementation(MeterInfo &mi,
|
|
DriverInfo &di) :
|
|
type_(di.type()),
|
|
driver_(di.name().str()),
|
|
driver_name_(di.name()),
|
|
bus_(mi.bus),
|
|
name_(mi.name),
|
|
mfct_tpl_status_bits_(di.mfctTPLStatusBits()),
|
|
waiting_for_poll_response_sem_("waiting_for_poll_response")
|
|
{
|
|
ids_ = mi.ids;
|
|
idsc_ = toIdsCommaSeparated(ids_);
|
|
link_modes_ = mi.link_modes;
|
|
poll_interval_= mi.poll_interval;
|
|
|
|
if (mi.key.length() > 0)
|
|
{
|
|
hex2bin(mi.key, &meter_keys_.confidentiality_key);
|
|
}
|
|
for (auto s : mi.shells) {
|
|
addShell(s);
|
|
}
|
|
for (auto j : mi.extra_constant_fields) {
|
|
addExtraConstantField(j);
|
|
}
|
|
|
|
link_modes_.unionLinkModeSet(di.linkModes());
|
|
}
|
|
|
|
void MeterCommonImplementation::addConversions(std::vector<Unit> cs)
|
|
{
|
|
for (Unit c : cs)
|
|
{
|
|
conversions_.push_back(c);
|
|
}
|
|
}
|
|
|
|
void MeterCommonImplementation::addShell(string cmdline)
|
|
{
|
|
shell_cmdlines_.push_back(cmdline);
|
|
}
|
|
|
|
void MeterCommonImplementation::addExtraConstantField(string ecf)
|
|
{
|
|
extra_constant_fields_.push_back(ecf);
|
|
}
|
|
|
|
vector<string> &MeterCommonImplementation::shellCmdlines()
|
|
{
|
|
return shell_cmdlines_;
|
|
}
|
|
|
|
vector<string> &MeterCommonImplementation::meterExtraConstantFields()
|
|
{
|
|
return extra_constant_fields_;
|
|
}
|
|
|
|
MeterDriver MeterCommonImplementation::driver()
|
|
{
|
|
return toMeterDriver(driver_);
|
|
}
|
|
|
|
DriverName MeterCommonImplementation::driverName()
|
|
{
|
|
if (driver_name_.str() == "")
|
|
{
|
|
return DriverName(toString(driver()));
|
|
}
|
|
return driver_name_;
|
|
}
|
|
|
|
void MeterCommonImplementation::setMeterType(MeterType mt)
|
|
{
|
|
type_ = mt;
|
|
}
|
|
|
|
void MeterCommonImplementation::addLinkMode(LinkMode lm)
|
|
{
|
|
link_modes_.addLinkMode(lm);
|
|
}
|
|
|
|
void MeterCommonImplementation::addMfctTPLStatusBits(Translate::Lookup lookup)
|
|
{
|
|
mfct_tpl_status_bits_ = lookup;
|
|
}
|
|
|
|
void MeterCommonImplementation::addPrint(string vname, Quantity vquantity,
|
|
function<double(Unit)> getValueFunc, string help, PrintProperties pprops)
|
|
{
|
|
field_infos_.push_back(
|
|
FieldInfo(field_infos_.size(),
|
|
vname,
|
|
vquantity,
|
|
defaultUnitForQuantity(vquantity),
|
|
VifScaling::Auto,
|
|
FieldMatcher(),
|
|
help,
|
|
pprops,
|
|
getValueFunc,
|
|
NULL,
|
|
NULL,
|
|
NULL,
|
|
NoLookup
|
|
));
|
|
}
|
|
|
|
void MeterCommonImplementation::addPrint(string vname, Quantity vquantity, Unit unit,
|
|
function<double(Unit)> getValueFunc, string help, PrintProperties pprops)
|
|
{
|
|
field_infos_.push_back(
|
|
FieldInfo(field_infos_.size(),
|
|
vname,
|
|
vquantity,
|
|
unit,
|
|
VifScaling::Auto,
|
|
FieldMatcher(),
|
|
help,
|
|
pprops,
|
|
getValueFunc,
|
|
NULL,
|
|
NULL,
|
|
NULL,
|
|
NoLookup
|
|
));
|
|
}
|
|
|
|
void MeterCommonImplementation::addPrint(string vname, Quantity vquantity,
|
|
function<string()> getValueFunc,
|
|
string help, PrintProperties pprops)
|
|
{
|
|
field_infos_.push_back(
|
|
FieldInfo(field_infos_.size(),
|
|
vname,
|
|
vquantity,
|
|
defaultUnitForQuantity(vquantity),
|
|
VifScaling::Auto,
|
|
FieldMatcher(),
|
|
help,
|
|
pprops,
|
|
NULL,
|
|
getValueFunc,
|
|
NULL,
|
|
NULL,
|
|
NoLookup
|
|
));
|
|
}
|
|
|
|
void MeterCommonImplementation::addNumericFieldWithExtractor(
|
|
string vname,
|
|
Quantity vquantity,
|
|
DifVifKey dif_vif_key,
|
|
VifScaling vif_scaling,
|
|
MeasurementType mt,
|
|
VIFRange vi,
|
|
StorageNr s,
|
|
TariffNr t,
|
|
IndexNr i,
|
|
PrintProperties print_properties,
|
|
string help,
|
|
function<void(Unit,double)> setValueFunc,
|
|
function<double(Unit)> getValueFunc)
|
|
{
|
|
field_infos_.push_back(
|
|
FieldInfo(field_infos_.size(),
|
|
vname,
|
|
vquantity,
|
|
defaultUnitForQuantity(vquantity),
|
|
vif_scaling,
|
|
FieldMatcher::build().set(dif_vif_key).set(mt).set(vi).set(s).set(t).set(i),
|
|
help,
|
|
print_properties,
|
|
getValueFunc,
|
|
NULL,
|
|
setValueFunc,
|
|
NULL,
|
|
NoLookup
|
|
));
|
|
}
|
|
|
|
void MeterCommonImplementation::addNumericFieldWithExtractor(string vname,
|
|
string help,
|
|
PrintProperties print_properties,
|
|
Quantity vquantity,
|
|
VifScaling vif_scaling,
|
|
FieldMatcher matcher,
|
|
Unit use_unit)
|
|
{
|
|
field_infos_.push_back(
|
|
FieldInfo(field_infos_.size(),
|
|
vname,
|
|
vquantity,
|
|
use_unit == Unit::Unknown ? defaultUnitForQuantity(vquantity) : use_unit,
|
|
vif_scaling,
|
|
matcher,
|
|
help,
|
|
print_properties,
|
|
NULL,
|
|
NULL,
|
|
NULL,
|
|
NULL,
|
|
NoLookup
|
|
));
|
|
}
|
|
|
|
void MeterCommonImplementation::addNumericField(
|
|
string vname,
|
|
Quantity vquantity,
|
|
PrintProperties print_properties,
|
|
string help,
|
|
function<void(Unit,double)> setValueFunc,
|
|
function<double(Unit)> getValueFunc)
|
|
{
|
|
field_infos_.push_back(
|
|
FieldInfo(field_infos_.size(),
|
|
vname,
|
|
vquantity,
|
|
defaultUnitForQuantity(vquantity),
|
|
VifScaling::None,
|
|
FieldMatcher(),
|
|
help,
|
|
print_properties,
|
|
getValueFunc,
|
|
NULL,
|
|
setValueFunc,
|
|
NULL,
|
|
NoLookup
|
|
));
|
|
}
|
|
|
|
void MeterCommonImplementation::addStringFieldWithExtractor(
|
|
string vname,
|
|
Quantity vquantity,
|
|
DifVifKey dif_vif_key,
|
|
MeasurementType mt,
|
|
VIFRange vi,
|
|
StorageNr s,
|
|
TariffNr t,
|
|
IndexNr i,
|
|
PrintProperties print_properties,
|
|
string help,
|
|
function<void(string)> setValueFunc,
|
|
function<string()> getValueFunc)
|
|
{
|
|
field_infos_.push_back(
|
|
FieldInfo(field_infos_.size(),
|
|
vname,
|
|
vquantity,
|
|
defaultUnitForQuantity(vquantity),
|
|
VifScaling::None,
|
|
FieldMatcher::build().set(dif_vif_key).set(mt).set(vi).set(s).set(t).set(i),
|
|
help,
|
|
print_properties,
|
|
NULL,
|
|
getValueFunc,
|
|
NULL,
|
|
setValueFunc,
|
|
NoLookup
|
|
));
|
|
}
|
|
|
|
void MeterCommonImplementation::addStringFieldWithExtractor(string vname,
|
|
string help,
|
|
PrintProperties print_properties,
|
|
FieldMatcher matcher)
|
|
{
|
|
field_infos_.push_back(
|
|
FieldInfo(field_infos_.size(),
|
|
vname,
|
|
Quantity::Text,
|
|
defaultUnitForQuantity(Quantity::Text),
|
|
VifScaling::None,
|
|
matcher,
|
|
help,
|
|
print_properties,
|
|
NULL,
|
|
NULL,
|
|
NULL,
|
|
NULL,
|
|
NoLookup
|
|
));
|
|
}
|
|
|
|
void MeterCommonImplementation::addStringFieldWithExtractorAndLookup(
|
|
string vname,
|
|
Quantity vquantity,
|
|
DifVifKey dif_vif_key,
|
|
MeasurementType mt,
|
|
VIFRange vi,
|
|
StorageNr s,
|
|
TariffNr t,
|
|
IndexNr i,
|
|
PrintProperties print_properties,
|
|
string help,
|
|
function<void(string)> setValueFunc,
|
|
function<string()> getValueFunc,
|
|
Translate::Lookup lookup)
|
|
{
|
|
field_infos_.push_back(
|
|
FieldInfo(field_infos_.size(),
|
|
vname,
|
|
vquantity,
|
|
defaultUnitForQuantity(vquantity),
|
|
VifScaling::None,
|
|
FieldMatcher::build().set(dif_vif_key).set(mt).set(vi).set(s).set(t).set(i),
|
|
help,
|
|
print_properties,
|
|
NULL,
|
|
getValueFunc,
|
|
NULL,
|
|
setValueFunc,
|
|
lookup
|
|
));
|
|
}
|
|
|
|
void MeterCommonImplementation::addStringFieldWithExtractorAndLookup(string vname,
|
|
string help,
|
|
PrintProperties print_properties,
|
|
FieldMatcher matcher,
|
|
Translate::Lookup lookup)
|
|
{
|
|
field_infos_.push_back(
|
|
FieldInfo(field_infos_.size(),
|
|
vname,
|
|
Quantity::Text,
|
|
defaultUnitForQuantity(Quantity::Text),
|
|
VifScaling::None,
|
|
matcher,
|
|
help,
|
|
print_properties,
|
|
NULL,
|
|
NULL,
|
|
NULL,
|
|
NULL,
|
|
lookup
|
|
));
|
|
}
|
|
|
|
void MeterCommonImplementation::addStringField(string vname,
|
|
string help,
|
|
PrintProperties print_properties)
|
|
{
|
|
field_infos_.push_back(
|
|
FieldInfo(field_infos_.size(),
|
|
vname,
|
|
Quantity::Text,
|
|
defaultUnitForQuantity(Quantity::Text),
|
|
VifScaling::None,
|
|
FieldMatcher(),
|
|
help,
|
|
print_properties,
|
|
NULL,
|
|
NULL,
|
|
NULL,
|
|
NULL,
|
|
NoLookup
|
|
));
|
|
}
|
|
|
|
void MeterCommonImplementation::poll(shared_ptr<BusManager> bus_manager)
|
|
{
|
|
if (usesPolling())
|
|
{
|
|
// An valid poll interval must have been set!
|
|
if (pollInterval() <= 0) return;
|
|
|
|
time_t now = time(NULL);
|
|
time_t next_poll_time = timestampLastUpdate()+pollInterval();
|
|
if (now < next_poll_time)
|
|
{
|
|
// Not yet time to poll this meter.
|
|
return;
|
|
}
|
|
|
|
BusDevice *bus_device = bus_manager->findBus(bus());
|
|
|
|
if (!bus_device)
|
|
{
|
|
warning("(meter) warning! no bus specified for meter %s %s\n", name().c_str(), idsc().c_str());
|
|
return;
|
|
}
|
|
|
|
string id = ids().back();
|
|
if (id.length() != 2 && id.length() != 3 && id.length() != 8)
|
|
{
|
|
debug("(meter) not polling from bad id \"%s\" with wrong length\n", id.c_str());
|
|
return;
|
|
}
|
|
|
|
if (id.length() == 2 || id.length() == 3)
|
|
{
|
|
vector<uchar> idhex;
|
|
int idnum = atoi(id.c_str());
|
|
|
|
if (idnum < 0 || idnum > 250 || idhex.size() != 1)
|
|
{
|
|
debug("(meter) not polling from bad id \"%s\"\n", id.c_str());
|
|
return;
|
|
}
|
|
|
|
vector<uchar> buf;
|
|
buf.resize(5);
|
|
buf[0] = 0x10; // Start
|
|
buf[1] = 0x5b; // REQ_UD2
|
|
buf[2] = idhex[0];
|
|
uchar cs = 0;
|
|
for (int i=1; i<3; ++i) cs += buf[i];
|
|
buf[3] = cs; // checksum
|
|
buf[4] = 0x16; // Stop
|
|
|
|
verbose("(meter) polling %s %s (primary) with req ud2 on bus %s\n",
|
|
name().c_str(),
|
|
id.c_str(),
|
|
bus_device->busAlias().c_str(),id.c_str());
|
|
bus_device->serial()->send(buf);
|
|
}
|
|
|
|
if (id.length() == 8)
|
|
{
|
|
// A full secondary address 12345678 was specified.
|
|
|
|
vector<uchar> idhex;
|
|
bool ok = hex2bin(id, &idhex);
|
|
|
|
if (!ok || idhex.size() != 4)
|
|
{
|
|
debug("(meter) not polling from bad id \"%s\"\n", id.c_str());
|
|
return;
|
|
}
|
|
|
|
vector<uchar> buf;
|
|
buf.resize(17);
|
|
buf[0] = 0x68;
|
|
buf[1] = 0x0b;
|
|
buf[2] = 0x0b;
|
|
buf[3] = 0x68;
|
|
buf[4] = 0x73; // SND_UD
|
|
buf[5] = 0xfd; // address 253
|
|
buf[6] = 0x52; // ci 52
|
|
// Assuming we send id 12345678
|
|
buf[7] = idhex[3]; // id 78
|
|
buf[8] = idhex[2]; // id 56
|
|
buf[9] = idhex[1]; // id 34
|
|
buf[10] = idhex[0]; // id 12
|
|
// Use wildcards instead of exact matching here.
|
|
// TODO add selection based on these values as well.
|
|
buf[11] = 0xff; // mfct
|
|
buf[12] = 0xff; // mfct
|
|
buf[13] = 0xff; // version/generation
|
|
buf[14] = 0xff; // type/media/device
|
|
|
|
uchar cs = 0;
|
|
for (int i=4; i<15; ++i) cs += buf[i];
|
|
buf[15] = cs; // checksum
|
|
buf[16] = 0x16; // Stop
|
|
|
|
debug("(meter) secondary addressing bus %s to address %s\n", bus_device->busAlias().c_str(), id.c_str());
|
|
bus_device->serial()->send(buf);
|
|
|
|
usleep(1000*500);
|
|
|
|
buf.resize(5);
|
|
buf[0] = 0x10; // Start
|
|
buf[1] = 0x5b; // REQ_UD2
|
|
buf[2] = 0xfd; // 00 or address 253 previously setup
|
|
cs = 0;
|
|
for (int i=1; i<3; ++i) cs += buf[i];
|
|
buf[3] = cs; // checksum
|
|
buf[4] = 0x16; // Stop
|
|
|
|
verbose("(meter) polling %s %s (secondary) with req ud2 bus %s\n",
|
|
name().c_str(),
|
|
id.c_str(),
|
|
bus_device->busAlias().c_str());
|
|
bus_device->serial()->send(buf);
|
|
}
|
|
bool ok = waiting_for_poll_response_sem_.wait();
|
|
if (!ok)
|
|
{
|
|
warning("(meter) %s %s did not send a response!\n", name().c_str(), idsc().c_str());
|
|
}
|
|
}
|
|
}
|
|
|
|
vector<string>& MeterCommonImplementation::ids()
|
|
{
|
|
return ids_;
|
|
}
|
|
|
|
string MeterCommonImplementation::idsc()
|
|
{
|
|
return idsc_;
|
|
}
|
|
|
|
vector<FieldInfo> &MeterCommonImplementation::fieldInfos()
|
|
{
|
|
return field_infos_;
|
|
}
|
|
|
|
string MeterCommonImplementation::name()
|
|
{
|
|
return name_;
|
|
}
|
|
|
|
void MeterCommonImplementation::onUpdate(function<void(Telegram*,Meter*)> cb)
|
|
{
|
|
on_update_.push_back(cb);
|
|
}
|
|
|
|
int MeterCommonImplementation::numUpdates()
|
|
{
|
|
return num_updates_;
|
|
}
|
|
|
|
string MeterCommonImplementation::datetimeOfUpdateHumanReadable()
|
|
{
|
|
char datetime[40];
|
|
memset(datetime, 0, sizeof(datetime));
|
|
strftime(datetime, 20, "%Y-%m-%d %H:%M.%S", localtime(&datetime_of_update_));
|
|
return string(datetime);
|
|
}
|
|
|
|
string MeterCommonImplementation::datetimeOfUpdateRobot()
|
|
{
|
|
char datetime[40];
|
|
memset(datetime, 0, sizeof(datetime));
|
|
// This is the date time in the Greenwich timezone (Zulu time), dont get surprised!
|
|
strftime(datetime, sizeof(datetime), "%FT%TZ", gmtime(&datetime_of_update_));
|
|
return string(datetime);
|
|
}
|
|
|
|
string MeterCommonImplementation::unixTimestampOfUpdate()
|
|
{
|
|
char ut[40];
|
|
memset(ut, 0, sizeof(ut));
|
|
snprintf(ut, sizeof(ut)-1, "%lu", datetime_of_update_);
|
|
return string(ut);
|
|
}
|
|
|
|
time_t MeterCommonImplementation::timestampLastUpdate()
|
|
{
|
|
return datetime_of_update_;
|
|
}
|
|
|
|
void MeterCommonImplementation::setPollInterval(time_t interval)
|
|
{
|
|
poll_interval_ = interval;
|
|
if (usesPolling() && poll_interval_ == 0)
|
|
{
|
|
warning("(meter) %s %s needs polling but has no pollinterval set!\n", name().c_str(), idsc().c_str());
|
|
}
|
|
}
|
|
|
|
time_t MeterCommonImplementation::pollInterval()
|
|
{
|
|
return poll_interval_;
|
|
}
|
|
|
|
bool MeterCommonImplementation::usesPolling()
|
|
{
|
|
return link_modes_.has(LinkMode::MBUS) ||
|
|
link_modes_.has(LinkMode::C2) ||
|
|
link_modes_.has(LinkMode::T2) ||
|
|
link_modes_.has(LinkMode::S2);
|
|
}
|
|
|
|
bool driverNeedsPolling(MeterDriver d, DriverName& dn)
|
|
{
|
|
if (d != MeterDriver::UNKNOWN && d != MeterDriver::AUTO)
|
|
{
|
|
#define X(mname,linkmodes,info,driver,cname) if (d == MeterDriver::driver && 0 != ((linkmodes) & MBUS_bit)) return true;
|
|
LIST_OF_METERS
|
|
#undef X
|
|
return false;
|
|
}
|
|
|
|
DriverInfo *di = lookupDriver(dn.str());
|
|
|
|
if (di == NULL) return false;
|
|
|
|
// Return true for MBUS,S2,C2,T2 meters. Currently only mbus is implemented.
|
|
return di->linkModes().has(LinkMode::MBUS) ||
|
|
di->linkModes().has(LinkMode::C2) ||
|
|
di->linkModes().has(LinkMode::T2) ||
|
|
di->linkModes().has(LinkMode::S2);
|
|
}
|
|
|
|
const char *toString(MeterType type)
|
|
{
|
|
#define X(tname) if (type == MeterType::tname) return #tname;
|
|
LIST_OF_METER_TYPES
|
|
#undef X
|
|
return "unknown";
|
|
}
|
|
|
|
string toString(MeterDriver mt)
|
|
{
|
|
#define X(mname,link,info,type,cname) if (mt == MeterDriver::type) return #mname;
|
|
LIST_OF_METERS
|
|
#undef X
|
|
return "unknown";
|
|
}
|
|
|
|
string toString(DriverInfo &di)
|
|
{
|
|
if (di.driver() != MeterDriver::UNKNOWN &&
|
|
di.driver() != MeterDriver::AUTO) return toString(di.driver());
|
|
return di.name().str();
|
|
}
|
|
|
|
MeterDriver toMeterDriver(string& t)
|
|
{
|
|
#define X(mname,linkmodes,info,type,cname) if (t == #mname) return MeterDriver::type;
|
|
LIST_OF_METERS
|
|
#undef X
|
|
return MeterDriver::UNKNOWN;
|
|
}
|
|
|
|
LinkModeSet toMeterLinkModeSet(string& t)
|
|
{
|
|
#define X(mname,linkmodes,info,type,cname) if (t == #mname) return LinkModeSet(linkmodes);
|
|
LIST_OF_METERS
|
|
#undef X
|
|
return LinkModeSet();
|
|
}
|
|
|
|
LinkModeSet toMeterLinkModeSet(MeterDriver d)
|
|
{
|
|
#define X(mname,linkmodes,info,driver,cname) if (d == MeterDriver::driver) return LinkModeSet(linkmodes);
|
|
LIST_OF_METERS
|
|
#undef X
|
|
return LinkModeSet();
|
|
}
|
|
|
|
bool MeterCommonImplementation::isTelegramForMeter(Telegram *t, Meter *meter, MeterInfo *mi)
|
|
{
|
|
string name;
|
|
vector<string> ids;
|
|
string idsc;
|
|
MeterDriver driver;
|
|
|
|
assert((meter && !mi) ||
|
|
(!meter && mi));
|
|
|
|
if (meter)
|
|
{
|
|
name = meter->name();
|
|
ids = meter->ids();
|
|
idsc = meter->idsc();
|
|
driver = meter->driver();
|
|
}
|
|
else
|
|
{
|
|
name = mi->name;
|
|
ids = mi->ids;
|
|
idsc = mi->idsc;
|
|
driver = mi->driver;
|
|
}
|
|
|
|
debug("(meter) %s: for me? %s in %s\n", name.c_str(), t->idsc.c_str(), idsc.c_str());
|
|
|
|
bool used_wildcard = false;
|
|
bool id_match = doesIdsMatchExpressions(t->ids, ids, &used_wildcard);
|
|
|
|
if (!id_match) {
|
|
// The id must match.
|
|
debug("(meter) %s: not for me: not my id\n", name.c_str());
|
|
return false;
|
|
}
|
|
|
|
bool valid_driver = isMeterDriverValid(driver, t->dll_mfct, t->dll_type, t->dll_version);
|
|
if (!valid_driver && t->tpl_id_found)
|
|
{
|
|
valid_driver = isMeterDriverValid(driver, t->tpl_mfct, t->tpl_type, t->tpl_version);
|
|
}
|
|
|
|
if (!valid_driver && driver != MeterDriver::AUTO)
|
|
{
|
|
// Are we using the right driver? Perhaps not since
|
|
// this particular driver, mfct, media, version combo
|
|
// is not registered in the METER_DETECTION list in meters.h
|
|
|
|
if (used_wildcard)
|
|
{
|
|
// The match for the id was not exact, thus the user is listening using a wildcard
|
|
// to many meters and some received matched meter telegrams are not from the right meter type,
|
|
// ie their driver does not match. Lets just ignore telegrams that probably cannot be decoded properly.
|
|
verbose("(meter) ignoring telegram from %s since it matched a wildcard id rule but driver does not match.\n",
|
|
t->idsc.c_str());
|
|
return false;
|
|
}
|
|
|
|
// The match was exact, ie the user has actually specified 12345678 and foo as driver even
|
|
// though they do not match. Lets warn and then proceed. It is common that a user tries a
|
|
// new version of a meter with the old driver, thus it might not be a real error.
|
|
if (isVerboseEnabled() || isDebugEnabled() || !warned_for_telegram_before(t, t->dll_a))
|
|
{
|
|
string possible_drivers = t->autoDetectPossibleDrivers();
|
|
if (t->beingAnalyzed() == false)
|
|
{
|
|
warning("(meter) %s: meter detection did not match the selected driver %s! correct driver is: %s\n"
|
|
"(meter) Not printing this warning again for id: %02x%02x%02x%02x mfct: (%s) %s (0x%02x) type: %s (0x%02x) ver: 0x%02x\n",
|
|
name.c_str(),
|
|
toString(driver).c_str(),
|
|
possible_drivers.c_str(),
|
|
t->dll_id_b[3], t->dll_id_b[2], t->dll_id_b[1], t->dll_id_b[0],
|
|
manufacturerFlag(t->dll_mfct).c_str(),
|
|
manufacturer(t->dll_mfct).c_str(),
|
|
t->dll_mfct,
|
|
mediaType(t->dll_type, t->dll_mfct).c_str(), t->dll_type,
|
|
t->dll_version);
|
|
|
|
if (possible_drivers == "unknown!")
|
|
{
|
|
warning("(meter) please consider opening an issue at https://github.com/weetmuts/wmbusmeters/\n");
|
|
warning("(meter) to add support for this unknown mfct,media,version combination\n");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
debug("(meter) %s: yes for me\n", name.c_str());
|
|
return true;
|
|
}
|
|
|
|
MeterKeys *MeterCommonImplementation::meterKeys()
|
|
{
|
|
return &meter_keys_;
|
|
}
|
|
|
|
int MeterCommonImplementation::index()
|
|
{
|
|
return index_;
|
|
}
|
|
|
|
void MeterCommonImplementation::setIndex(int i)
|
|
{
|
|
index_ = i;
|
|
}
|
|
|
|
string MeterCommonImplementation::bus()
|
|
{
|
|
return bus_;
|
|
}
|
|
|
|
void MeterCommonImplementation::triggerUpdate(Telegram *t)
|
|
{
|
|
datetime_of_update_ = time(NULL);
|
|
num_updates_++;
|
|
for (auto &cb : on_update_) if (cb) cb(t, this);
|
|
t->handled = true;
|
|
}
|
|
|
|
string concatAllFields(Meter *m, Telegram *t, char c, vector<FieldInfo> &fields, vector<Unit> &cs, bool hr,
|
|
vector<string> *extra_constant_fields)
|
|
{
|
|
string s;
|
|
s = "";
|
|
s += m->name() + c;
|
|
if (t->ids.size() > 0)
|
|
{
|
|
s += t->ids.back() + c;
|
|
}
|
|
else
|
|
{
|
|
s += c;
|
|
}
|
|
for (FieldInfo &fi : fields)
|
|
{
|
|
if (fi.printProperties().hasFIELD())
|
|
{
|
|
if (fi.xuantity() == Quantity::Text)
|
|
{
|
|
s += m->getStringValue(&fi);
|
|
}
|
|
else
|
|
{
|
|
Unit u = replaceWithConversionUnit(fi.defaultUnit(), cs);
|
|
double v = m->getNumericValue(&fi, u);
|
|
if (hr) {
|
|
s += valueToString(v, u);
|
|
s += " "+unitToStringHR(u);
|
|
} else {
|
|
s += to_string(v);
|
|
}
|
|
}
|
|
s += c;
|
|
}
|
|
}
|
|
s += m->datetimeOfUpdateHumanReadable();
|
|
return s;
|
|
}
|
|
|
|
string findField(string key, vector<string> *extra_constant_fields)
|
|
{
|
|
key = key+"=";
|
|
for (string ecf : *extra_constant_fields)
|
|
{
|
|
if (startsWith(ecf, key))
|
|
{
|
|
return ecf.substr(key.length());
|
|
}
|
|
}
|
|
return "";
|
|
}
|
|
|
|
// Is the desired field one of the fields common to all meters and telegrams?
|
|
bool checkCommonField(string *buf, string field, Meter *m, Telegram *t, char c, bool human_readable)
|
|
{
|
|
if (field == "name")
|
|
{
|
|
*buf += m->name() + c;
|
|
return true;
|
|
}
|
|
if (field == "id")
|
|
{
|
|
*buf += t->ids.back() + c;
|
|
return true;
|
|
}
|
|
if (field == "timestamp")
|
|
{
|
|
*buf += m->datetimeOfUpdateHumanReadable() + c;
|
|
return true;
|
|
}
|
|
if (field == "timestamp_lt")
|
|
{
|
|
*buf += m->datetimeOfUpdateHumanReadable() + c;
|
|
return true;
|
|
}
|
|
if (field == "timestamp_utc")
|
|
{
|
|
*buf += m->datetimeOfUpdateRobot() + c;
|
|
return true;
|
|
}
|
|
if (field == "timestamp_ut")
|
|
{
|
|
*buf += m->unixTimestampOfUpdate() + c;
|
|
return true;
|
|
}
|
|
if (field == "device")
|
|
{
|
|
*buf += t->about.device + c;
|
|
return true;
|
|
}
|
|
if (field == "rssi_dbm")
|
|
{
|
|
*buf += to_string(t->about.rssi_dbm) + c;
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
// Is the desired field one of the meter printable fields?
|
|
bool checkPrintableField(string *buf, string field, Meter *m, Telegram *t, char c,
|
|
vector<FieldInfo> &fields, vector<Unit> &cs, bool human_readable)
|
|
{
|
|
for (FieldInfo &fi : fields)
|
|
{
|
|
if (fi.xuantity() == Quantity::Text)
|
|
{
|
|
// Strings are simply just print them.
|
|
if (field == fi.vname())
|
|
{
|
|
*buf += m->getStringValue(&fi) + c;
|
|
return true;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Doubles have to be converted into the proper unit.
|
|
string default_unit = unitToStringLowerCase(fi.defaultUnit());
|
|
string var = fi.vname()+"_"+default_unit;
|
|
if (field == var)
|
|
{
|
|
// Default unit.
|
|
*buf += valueToString(m->getNumericValue(&fi, fi.defaultUnit()), fi.defaultUnit());
|
|
if (human_readable)
|
|
{
|
|
*buf += " ";
|
|
*buf += unitToStringHR(fi.defaultUnit());
|
|
}
|
|
*buf += c;
|
|
return true;
|
|
}
|
|
else
|
|
{
|
|
// Added conversion unit.
|
|
Unit u = replaceWithConversionUnit(fi.defaultUnit(), cs);
|
|
if (u != fi.defaultUnit())
|
|
{
|
|
string unit = unitToStringLowerCase(u);
|
|
string var = fi.vname()+"_"+unit;
|
|
if (field == var)
|
|
{
|
|
*buf += valueToString(m->getNumericValue(&fi, u), u);
|
|
if (human_readable)
|
|
{
|
|
*buf += " ";
|
|
*buf += unitToStringHR(u);
|
|
}
|
|
*buf += c;
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
// Is the desired field one of the constant fields?
|
|
bool checkConstantField(string *buf, string field, char c, vector<string> *extra_constant_fields)
|
|
{
|
|
// Ok, lets look for extra constant fields and print any such static information.
|
|
string v = findField(field, extra_constant_fields);
|
|
if (v != "")
|
|
{
|
|
*buf += v + c;
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
string concatFields(Meter *m, Telegram *t, char c, vector<FieldInfo> &prints, vector<Unit> &cs, bool human_readable,
|
|
vector<string> *selected_fields, vector<string> *extra_constant_fields)
|
|
{
|
|
if (selected_fields == NULL || selected_fields->size() == 0)
|
|
{
|
|
// No global override, but is there a meter driver setting?
|
|
if (m->selectedFields().size() > 0)
|
|
{
|
|
selected_fields = &m->selectedFields();
|
|
}
|
|
else
|
|
{
|
|
return concatAllFields(m, t, c, prints, cs, human_readable, extra_constant_fields);
|
|
}
|
|
}
|
|
string buf = "";
|
|
|
|
for (string field : *selected_fields)
|
|
{
|
|
bool handled = checkCommonField(&buf, field, m, t, c, human_readable);
|
|
if (handled) continue;
|
|
|
|
handled = checkPrintableField(&buf, field, m, t, c, prints, cs, human_readable);
|
|
if (handled) continue;
|
|
|
|
handled = checkConstantField(&buf, field, c, extra_constant_fields);
|
|
if (handled) continue;
|
|
|
|
if (!handled)
|
|
{
|
|
buf += "?"+field+"?"+c;
|
|
}
|
|
}
|
|
if (buf.back() == c) buf.pop_back();
|
|
return buf;
|
|
}
|
|
|
|
bool MeterCommonImplementation::handleTelegram(AboutTelegram &about, vector<uchar> input_frame,
|
|
bool simulated, string *ids, bool *id_match, Telegram *out_analyzed)
|
|
{
|
|
Telegram t;
|
|
t.about = about;
|
|
bool ok = t.parseHeader(input_frame);
|
|
|
|
if (simulated) t.markAsSimulated();
|
|
if (out_analyzed != NULL) t.markAsBeingAnalyzed();
|
|
|
|
*ids = t.idsc;
|
|
|
|
if (!ok || !isTelegramForMeter(&t, this, NULL))
|
|
{
|
|
// This telegram is not intended for this meter.
|
|
return false;
|
|
}
|
|
|
|
*id_match = true;
|
|
verbose("(meter) %s(%d) %s handling telegram from %s\n", name().c_str(), index(), meterDriver().c_str(), t.ids.back().c_str());
|
|
|
|
if (isDebugEnabled())
|
|
{
|
|
string msg = bin2hex(input_frame);
|
|
debug("(meter) %s %s \"%s\"\n", name().c_str(), t.ids.back().c_str(), msg.c_str());
|
|
}
|
|
|
|
ok = t.parse(input_frame, &meter_keys_, true);
|
|
if (!ok)
|
|
{
|
|
if (out_analyzed != NULL) *out_analyzed = t;
|
|
// Ignoring telegram since it could not be parsed.
|
|
return false;
|
|
}
|
|
|
|
char log_prefix[256];
|
|
snprintf(log_prefix, 255, "(%s) log", meterDriver().c_str());
|
|
logTelegram(t.original, t.frame, t.header_size, t.suffix_size);
|
|
|
|
if (usesPolling())
|
|
{
|
|
waiting_for_poll_response_sem_.notify();
|
|
}
|
|
|
|
// Invoke standardized field extractors!
|
|
processFieldExtractors(&t);
|
|
// Invoke tailor made meter specific parsing!
|
|
processContent(&t);
|
|
// All done....
|
|
|
|
if (isDebugEnabled())
|
|
{
|
|
char log_prefix[256];
|
|
snprintf(log_prefix, 255, "(%s)", meterDriver().c_str());
|
|
t.explainParse(log_prefix, 0);
|
|
}
|
|
triggerUpdate(&t);
|
|
if (out_analyzed != NULL) *out_analyzed = t;
|
|
return true;
|
|
}
|
|
|
|
void MeterCommonImplementation::processFieldExtractors(Telegram *t)
|
|
{
|
|
// Iterate through the data content (dv_entries9 in the telegram.
|
|
for (auto &p : t->dv_entries)
|
|
{
|
|
DVEntry *dve = &p.second.second;
|
|
// We have telegram content, a dif-vif-value entry.
|
|
// Now check for a field info that wants to handle this telegram content entry.
|
|
for (FieldInfo &fi : field_infos_)
|
|
{
|
|
if (fi.hasMatcher() && fi.matches(dve))
|
|
{
|
|
// We have field that wants to handle this entry!
|
|
debug("(meters) using field info %s(%s)[%d] to extract %s\n",
|
|
fi.vname().c_str(),
|
|
toString(fi.xuantity()),
|
|
fi.index(),
|
|
dve->dif_vif_key.str().c_str());
|
|
|
|
dve->addFieldInfo(&fi);
|
|
fi.performExtraction(this, t, dve);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Iterate over the fields that has no matcher rule. Ie the field
|
|
// itself does the searching and matching.
|
|
for (FieldInfo &fi : field_infos_)
|
|
{
|
|
if (!fi.hasMatcher())
|
|
{
|
|
fi.performExtraction(this, t, NULL);
|
|
}
|
|
}
|
|
}
|
|
|
|
void MeterCommonImplementation::processContent(Telegram *t)
|
|
{
|
|
}
|
|
|
|
void MeterCommonImplementation::setNumericValue(FieldInfo *fi, Unit u, double v)
|
|
{
|
|
if (fi->hasSetNumericValueOverride())
|
|
{
|
|
// Use setter function to store value somewhere.
|
|
fi->setNumericValueOverride(u, v);
|
|
return;
|
|
}
|
|
|
|
// Store value in default meter location for numeric values.
|
|
string field_name_no_unit = fi->vname();
|
|
numeric_values_[pair<string,Quantity>(field_name_no_unit,fi->xuantity())] = NumericField(u, v, fi);
|
|
}
|
|
|
|
double MeterCommonImplementation::getNumericValue(FieldInfo *fi, Unit to)
|
|
{
|
|
if (fi->hasGetNumericValueOverride())
|
|
{
|
|
return fi->getNumericValueOverride(to);
|
|
}
|
|
|
|
string field_name_no_unit = fi->vname();
|
|
pair<string,Quantity> key(field_name_no_unit,fi->xuantity());
|
|
if (numeric_values_.count(key) == 0)
|
|
{
|
|
return std::numeric_limits<double>::quiet_NaN(); // This is translated into a null in the json.
|
|
}
|
|
NumericField &nf = numeric_values_[key];
|
|
return convert(nf.value, nf.unit, to);
|
|
}
|
|
|
|
void MeterCommonImplementation::setStringValue(FieldInfo *fi, string v)
|
|
{
|
|
if (fi->hasSetStringValueOverride())
|
|
{
|
|
fi->setStringValueOverride(v);
|
|
return;
|
|
}
|
|
|
|
string field_name_no_unit = fi->vname();
|
|
string_values_[field_name_no_unit] = StringField(v, fi);
|
|
}
|
|
|
|
string MeterCommonImplementation::getStringValue(FieldInfo *fi)
|
|
{
|
|
if (fi->hasGetStringValueOverride())
|
|
{
|
|
// There is a custom getter for this field. Use this instead.
|
|
return fi->getStringValueOverride();
|
|
}
|
|
|
|
// Fetch the string value from the default string storage in the meter.
|
|
string field_name_no_unit = fi->vname();
|
|
if (string_values_.count(field_name_no_unit) == 0)
|
|
{
|
|
return "null"; // This is translated to a real(non-string) null in the json.
|
|
}
|
|
StringField &sf = string_values_[field_name_no_unit];
|
|
string value = sf.value;
|
|
|
|
if (fi->printProperties().hasSTATUS())
|
|
{
|
|
// This is >THE< status field, only one is allowed.
|
|
// Look for other fields with the JOIN_INTO_STATUS marker.
|
|
// These other fields will not be printed, instead
|
|
// joined into this status field.
|
|
for (FieldInfo &f : field_infos_)
|
|
{
|
|
if (f.printProperties().hasJOININTOSTATUS())
|
|
{
|
|
string more = getStringValue(&f);
|
|
string joined = joinStatusStrings(value, more);
|
|
//printf("JOINING >%s< >%s< into >%s<\n", value.c_str(), more.c_str(), joined.c_str());
|
|
value = joined;
|
|
}
|
|
}
|
|
// Sort all found flags and remove any duplicates. A well designed meter decoder
|
|
// should not be able to generate duplicates.
|
|
value = sortStatusString(value);
|
|
}
|
|
|
|
return value;
|
|
}
|
|
|
|
string MeterCommonImplementation::decodeTPLStatusByte(uchar sts)
|
|
{
|
|
return ::decodeTPLStatusByteWithMfct(sts, mfct_tpl_status_bits_);
|
|
}
|
|
|
|
FieldInfo *MeterCommonImplementation::findFieldInfo(string vname)
|
|
{
|
|
FieldInfo *found = NULL;
|
|
for (FieldInfo &p : field_infos_)
|
|
{
|
|
if (p.vname() == vname)
|
|
{
|
|
found = &p;
|
|
break;
|
|
}
|
|
}
|
|
|
|
return found;
|
|
}
|
|
|
|
string MeterCommonImplementation::renderJsonOnlyDefaultUnit(string vname)
|
|
{
|
|
FieldInfo *fi = findFieldInfo(vname);
|
|
|
|
if (fi == NULL) return "unknown field "+vname;
|
|
return fi->renderJsonOnlyDefaultUnit(this);
|
|
}
|
|
|
|
string FieldInfo::renderJsonOnlyDefaultUnit(Meter *m)
|
|
{
|
|
return renderJson(m, NULL);
|
|
}
|
|
|
|
string FieldInfo::renderJsonText(Meter *m)
|
|
{
|
|
return renderJson(m, NULL);
|
|
}
|
|
|
|
string FieldInfo::generateFieldName(DVEntry *dve)
|
|
{
|
|
if (xuantity_ == Quantity::Text)
|
|
{
|
|
return vname();
|
|
}
|
|
|
|
string default_unit = unitToStringLowerCase(defaultUnit());
|
|
string var = vname();
|
|
|
|
return vname()+"_"+default_unit;
|
|
}
|
|
|
|
string FieldInfo::renderJson(Meter *m, vector<Unit> *conversions)
|
|
{
|
|
string s;
|
|
|
|
string default_unit = unitToStringLowerCase(defaultUnit());
|
|
string var = vname();
|
|
if (xuantity() == Quantity::Text)
|
|
{
|
|
string v = m->getStringValue(this);
|
|
if (v == "null")
|
|
{
|
|
// Yes, right now a meter cannot send a string value "something":"null" it will
|
|
// be translated into "something":null in the json, indicating that there is no value.
|
|
// This should not be a problem for now. Lets deal with it when a meter decides to send "null"
|
|
// as its version string for example.
|
|
s += "\""+var+"\":null";
|
|
}
|
|
else
|
|
{
|
|
// Normally the string values are quoted in json. TODO quote the value properly.
|
|
// A well crafted meter could send a version string with " and break the json format.
|
|
s += "\""+var+"\":\""+v+"\"";
|
|
}
|
|
}
|
|
else
|
|
{
|
|
s += "\""+var+"_"+default_unit+"\":"+valueToString(m->getNumericValue(this, defaultUnit()), defaultUnit());
|
|
|
|
if (conversions != NULL)
|
|
{
|
|
Unit u = replaceWithConversionUnit(defaultUnit(), *conversions);
|
|
if (u != defaultUnit())
|
|
{
|
|
string unit = unitToStringLowerCase(u);
|
|
// Appending extra conversion unit.
|
|
s += ",\""+var+"_"+unit+"\":"+valueToString(m->getNumericValue(this, u), u);
|
|
}
|
|
}
|
|
}
|
|
|
|
return s;
|
|
}
|
|
|
|
void MeterCommonImplementation::printMeter(Telegram *t,
|
|
string *human_readable,
|
|
string *fields, char separator,
|
|
string *json,
|
|
vector<string> *envs,
|
|
vector<string> *extra_constant_fields,
|
|
vector<string> *selected_fields,
|
|
bool pretty_print_json)
|
|
{
|
|
*human_readable = concatFields(this, t, '\t', field_infos_, conversions_, true, selected_fields, extra_constant_fields);
|
|
*fields = concatFields(this, t, separator, field_infos_, conversions_, false, selected_fields, extra_constant_fields);
|
|
|
|
string media;
|
|
if (t->tpl_id_found)
|
|
{
|
|
media = mediaTypeJSON(t->tpl_type, t->tpl_mfct);
|
|
}
|
|
else if (t->ell_id_found)
|
|
{
|
|
media = mediaTypeJSON(t->ell_type, t->ell_mfct);
|
|
}
|
|
else
|
|
{
|
|
media = mediaTypeJSON(t->dll_type, t->dll_mfct);
|
|
}
|
|
|
|
string indent = "";
|
|
string newline = "";
|
|
|
|
if (pretty_print_json)
|
|
{
|
|
indent = " ";
|
|
newline ="\n";
|
|
}
|
|
string s;
|
|
s += "{"+newline;
|
|
s += indent+"\"media\":\""+media+"\","+newline;
|
|
s += indent+"\"meter\":\""+meterDriver()+"\","+newline;
|
|
s += indent+"\"name\":\""+name()+"\","+newline;
|
|
if (t->ids.size() > 0)
|
|
{
|
|
s += indent+"\"id\":\""+t->ids.back()+"\","+newline;
|
|
}
|
|
else
|
|
{
|
|
s += indent+"\"id\":\"\","+newline;
|
|
}
|
|
|
|
// Iterate over the meter field infos...
|
|
for (FieldInfo& fi : field_infos_)
|
|
{
|
|
if (fi.printProperties().hasJSON())
|
|
{
|
|
// The field should be printed in the json. (Most usually should.)
|
|
bool found = false;
|
|
for (auto& i : t->dv_entries)
|
|
{
|
|
// Check each telegram dv entry.
|
|
DVEntry *dve = &i.second.second;
|
|
// Has the entry been matches to this field, then print it as json.
|
|
if (dve->hasFieldInfo(&fi))
|
|
{
|
|
debug("(meters) render field %s(%s)[%d] with dventry @%d key %s data %s\n",
|
|
fi.vname().c_str(), toString(fi.xuantity()), fi.index(),
|
|
dve->offset,
|
|
dve->dif_vif_key.str().c_str(),
|
|
dve->value.c_str());
|
|
string out = fi.renderJson(this, &conversions());
|
|
debug("(meters) %s\n", out.c_str());
|
|
s += indent+out+","+newline;
|
|
found = true;
|
|
}
|
|
}
|
|
if (!found && !fi.printProperties().hasOPTIONAL())
|
|
{
|
|
// No telegram entries found, but this field should be printed anyway.
|
|
// It will be printed with any value received from a previous telegram.
|
|
// Or if no value has been received, null.
|
|
s += indent+fi.renderJson(this, &conversions())+","+newline;
|
|
}
|
|
}
|
|
}
|
|
|
|
s += indent+"\"timestamp\":\""+datetimeOfUpdateRobot()+"\"";
|
|
|
|
if (t->about.device != "")
|
|
{
|
|
s += ","+newline;
|
|
s += indent+"\"device\":\""+t->about.device+"\","+newline;
|
|
s += indent+"\"rssi_dbm\":"+to_string(t->about.rssi_dbm);
|
|
}
|
|
for (string extra_field : meterExtraConstantFields())
|
|
{
|
|
s += ","+newline;
|
|
s += indent+makeQuotedJson(extra_field);
|
|
}
|
|
for (string extra_field : *extra_constant_fields)
|
|
{
|
|
s += ","+newline;
|
|
s += indent+makeQuotedJson(extra_field);
|
|
}
|
|
s += newline;
|
|
s += "}";
|
|
*json = s;
|
|
|
|
envs->push_back(string("METER_JSON=")+*json);
|
|
if (t->ids.size() > 0)
|
|
{
|
|
envs->push_back(string("METER_ID=")+t->ids.back());
|
|
}
|
|
else
|
|
{
|
|
envs->push_back(string("METER_ID="));
|
|
}
|
|
envs->push_back(string("METER_NAME=")+name());
|
|
envs->push_back(string("METER_MEDIA=")+media);
|
|
envs->push_back(string("METER_TYPE=")+meterDriver());
|
|
envs->push_back(string("METER_TIMESTAMP=")+datetimeOfUpdateRobot());
|
|
envs->push_back(string("METER_TIMESTAMP_UTC=")+datetimeOfUpdateRobot());
|
|
envs->push_back(string("METER_TIMESTAMP_UT=")+unixTimestampOfUpdate());
|
|
envs->push_back(string("METER_TIMESTAMP_LT=")+datetimeOfUpdateHumanReadable());
|
|
if (t->about.device != "")
|
|
{
|
|
envs->push_back(string("METER_DEVICE=")+t->about.device);
|
|
envs->push_back(string("METER_RSSI_DBM=")+to_string(t->about.rssi_dbm));
|
|
}
|
|
|
|
for (FieldInfo& fi : field_infos_)
|
|
{
|
|
if (fi.printProperties().hasJSON())
|
|
{
|
|
string default_unit = unitToStringUpperCase(fi.defaultUnit());
|
|
string var = fi.vname();
|
|
std::transform(var.begin(), var.end(), var.begin(), ::toupper);
|
|
if (fi.xuantity() == Quantity::Text)
|
|
{
|
|
string envvar = "METER_"+var+"="+getStringValue(&fi);
|
|
envs->push_back(envvar);
|
|
}
|
|
else
|
|
{
|
|
string envvar = "METER_"+var+"_"+default_unit+"="+valueToString(getNumericValue(&fi, fi.defaultUnit()), fi.defaultUnit());
|
|
envs->push_back(envvar);
|
|
|
|
Unit u = replaceWithConversionUnit(fi.defaultUnit(), conversions_);
|
|
if (u != fi.defaultUnit())
|
|
{
|
|
string unit = unitToStringUpperCase(u);
|
|
string envvar = "METER_"+var+"_"+unit+"="+valueToString(getNumericValue(&fi, u), u);
|
|
envs->push_back(envvar);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// If the configuration has supplied json_address=Roodroad 123
|
|
// then the env variable METER_address will available and have the content "Roodroad 123"
|
|
for (string add_json : meterExtraConstantFields())
|
|
{
|
|
envs->push_back(string("METER_")+add_json);
|
|
}
|
|
for (string extra_field : *extra_constant_fields)
|
|
{
|
|
envs->push_back(string("METER_")+extra_field);
|
|
}
|
|
}
|
|
|
|
void MeterCommonImplementation::setExpectedTPLSecurityMode(TPLSecurityMode tsm)
|
|
{
|
|
expected_tpl_sec_mode_ = tsm;
|
|
}
|
|
|
|
void MeterCommonImplementation::setExpectedELLSecurityMode(ELLSecurityMode dsm)
|
|
{
|
|
expected_ell_sec_mode_ = dsm;
|
|
}
|
|
|
|
TPLSecurityMode MeterCommonImplementation::expectedTPLSecurityMode()
|
|
{
|
|
return expected_tpl_sec_mode_;
|
|
}
|
|
|
|
ELLSecurityMode MeterCommonImplementation::expectedELLSecurityMode()
|
|
{
|
|
return expected_ell_sec_mode_;
|
|
}
|
|
|
|
void detectMeterDrivers(int manufacturer, int media, int version, vector<string> *drivers)
|
|
{
|
|
#define X(TY,MA,ME,VE) { if (manufacturer == MA && (media == ME || ME == -1) && (version == VE || VE == -1)) { drivers->push_back(toString(MeterDriver::TY)); }}
|
|
METER_DETECTION
|
|
#undef X
|
|
|
|
for (DriverInfo *p : allDrivers())
|
|
{
|
|
if (p->detect(manufacturer, media, version))
|
|
{
|
|
drivers->push_back(p->name().str());
|
|
}
|
|
}
|
|
}
|
|
|
|
bool isMeterDriverValid(MeterDriver type, int manufacturer, int media, int version)
|
|
{
|
|
#define X(TY,MA,ME,VE) { if (type == MeterDriver::TY && manufacturer == MA && (media == ME || ME == -1) && (version == VE || VE == -1)) { return true; }}
|
|
METER_DETECTION
|
|
#undef X
|
|
|
|
for (DriverInfo *p : allDrivers())
|
|
{
|
|
if (p->detect(manufacturer, media, version))
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
bool isMeterDriverReasonableForMedia(MeterDriver type, string driver_name, int media)
|
|
{
|
|
if (media == 0x37) return false; // Skip converter meter side since they do not give any useful information.
|
|
if (driver_name == "")
|
|
{
|
|
#define X(TY,MA,ME,VE) { if (type == MeterDriver::TY && isCloseEnough(media, ME)) { return true; }}
|
|
METER_DETECTION
|
|
#undef X
|
|
}
|
|
|
|
for (DriverInfo *p : allDrivers())
|
|
{
|
|
if (p->name().str() == driver_name && p->isValidMedia(media))
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
DriverInfo pickMeterDriver(Telegram *t)
|
|
{
|
|
int manufacturer = t->dll_mfct;
|
|
int media = t->dll_type;
|
|
int version = t->dll_version;
|
|
|
|
if (t->tpl_id_found)
|
|
{
|
|
manufacturer = t->tpl_mfct;
|
|
media = t->tpl_type;
|
|
version = t->tpl_version;
|
|
}
|
|
|
|
#define X(TY,MA,ME,VE) { if (manufacturer == MA && (media == ME || ME == -1) && (version == VE || VE == -1)) { return MeterDriver::TY; }}
|
|
METER_DETECTION
|
|
#undef X
|
|
|
|
for (DriverInfo *p : allDrivers())
|
|
{
|
|
if (p->detect(manufacturer, media, version))
|
|
{
|
|
return *p;
|
|
}
|
|
}
|
|
|
|
return MeterDriver::UNKNOWN;
|
|
}
|
|
|
|
shared_ptr<Meter> createMeter(MeterInfo *mi)
|
|
{
|
|
shared_ptr<Meter> newm;
|
|
|
|
const char *keymsg = (mi->key[0] == 0) ? "not-encrypted" : "encrypted";
|
|
|
|
DriverInfo *di = lookupDriver(mi->driver_name.str());
|
|
|
|
if (di != NULL)
|
|
{
|
|
shared_ptr<Meter> newm = di->construct(*mi);
|
|
newm->addConversions(mi->conversions);
|
|
newm->setPollInterval(mi->poll_interval);
|
|
if (mi->selected_fields.size() > 0)
|
|
{
|
|
newm->setSelectedFields(mi->selected_fields);
|
|
}
|
|
else
|
|
{
|
|
newm->setSelectedFields(di->defaultFields());
|
|
}
|
|
verbose("(meter) created %s %s %s %s\n",
|
|
mi->name.c_str(),
|
|
di->name().str().c_str(),
|
|
mi->idsc.c_str(),
|
|
keymsg);
|
|
return newm;
|
|
}
|
|
|
|
switch (mi->driver)
|
|
{
|
|
#define X(mname,link,info,driver,cname) \
|
|
case MeterDriver::driver: \
|
|
{ \
|
|
newm = create##cname(*mi); \
|
|
newm->addConversions(mi->conversions); \
|
|
newm->setPollInterval(mi->poll_interval); \
|
|
verbose("(meter) created %s " #mname " %s %s\n", \
|
|
mi->name.c_str(), mi->idsc.c_str(), keymsg); \
|
|
return newm; \
|
|
} \
|
|
break;
|
|
LIST_OF_METERS
|
|
#undef X
|
|
}
|
|
return newm;
|
|
}
|
|
|
|
bool is_driver_and_extras(string t, MeterDriver *out_driver, DriverName *out_driver_name, string *out_extras)
|
|
{
|
|
// piigth(jump=foo)
|
|
// multical21
|
|
DriverInfo di;
|
|
size_t ps = t.find('(');
|
|
size_t pe = t.find(')');
|
|
|
|
size_t te = 0; // Position after type end.
|
|
|
|
bool found_parentheses = (ps != string::npos && pe != string::npos);
|
|
|
|
if (!found_parentheses)
|
|
{
|
|
if (lookupDriverInfo(t, &di))
|
|
{
|
|
*out_driver_name = di.name();
|
|
// We found a registered driver.
|
|
*out_driver = MeterDriver::AUTO; // To go away!
|
|
*out_extras = "";
|
|
return true;
|
|
}
|
|
MeterDriver md = toMeterDriver(t);
|
|
if (md == MeterDriver::UNKNOWN) return false;
|
|
*out_driver = md;
|
|
*out_extras = "";
|
|
return true;
|
|
}
|
|
|
|
// Parentheses must be last.
|
|
if (! (ps > 0 && ps < pe && pe == t.length()-1)) return false;
|
|
te = ps;
|
|
|
|
string type = t.substr(0, te);
|
|
|
|
bool found = lookupDriverInfo(type, &di);
|
|
|
|
MeterDriver md = toMeterDriver(type);
|
|
if (found)
|
|
{
|
|
*out_driver_name = di.name();
|
|
}
|
|
else
|
|
{
|
|
if (md == MeterDriver::UNKNOWN) return false;
|
|
}
|
|
*out_driver = md;
|
|
|
|
string extras = t.substr(ps+1, pe-ps-1);
|
|
*out_extras = extras;
|
|
|
|
return true;
|
|
}
|
|
|
|
string MeterInfo::str()
|
|
{
|
|
string r;
|
|
r += toString(driver);
|
|
if (extras != "")
|
|
{
|
|
r += "("+extras+")";
|
|
}
|
|
r += ":";
|
|
if (bus != "") r += bus+":";
|
|
if (bps != 0) r += bps+":";
|
|
if (!link_modes.empty()) r += link_modes.hr()+":";
|
|
if (r.size() > 0) r.pop_back();
|
|
|
|
return r;
|
|
}
|
|
|
|
bool MeterInfo::parse(string n, string d, string i, string k)
|
|
{
|
|
clear();
|
|
|
|
name = n;
|
|
ids = splitMatchExpressions(i);
|
|
key = k;
|
|
bool driverextras_checked = false;
|
|
bool bus_checked = false;
|
|
bool bps_checked = false;
|
|
bool link_modes_checked = false;
|
|
|
|
// The : colon is forbidden inside the parts.
|
|
vector<string> parts = splitString(d, ':');
|
|
|
|
// Example piigth:MAIN:2400 // it is an mbus meter.
|
|
// c5isf:MAIN:2400:mbus // attached to mbus instead of t1
|
|
// multical21:c1
|
|
// telco:BUS2:c2
|
|
// driver ( extras ) : bus_alias : bps : linkmodes
|
|
|
|
for (auto& p : parts)
|
|
{
|
|
if (!driverextras_checked && is_driver_and_extras(p, &driver, &driver_name, &extras))
|
|
{
|
|
driverextras_checked = true;
|
|
}
|
|
else if (!bus_checked && isValidAlias(p) && !isValidBps(p) && !isValidLinkModes(p))
|
|
{
|
|
driverextras_checked = true;
|
|
bus_checked = true;
|
|
bus = p;
|
|
}
|
|
else if (!bps_checked && isValidBps(p) && !isValidLinkModes(p))
|
|
{
|
|
driverextras_checked = true;
|
|
bus_checked = true;
|
|
bps_checked = true;
|
|
bps = atoi(p.c_str());
|
|
}
|
|
else if (!link_modes_checked && isValidLinkModes(p))
|
|
{
|
|
driverextras_checked = true;
|
|
bus_checked = true;
|
|
bps_checked = true;
|
|
link_modes_checked = true;
|
|
link_modes = parseLinkModes(p);
|
|
}
|
|
else
|
|
{
|
|
// Unknown part....
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if (!link_modes_checked)
|
|
{
|
|
// No explicit link mode set, set to the default link modes
|
|
// that the meter can transmit on.
|
|
link_modes = toMeterLinkModeSet(driver);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
bool MeterInfo::usesPolling()
|
|
{
|
|
return link_modes.has(LinkMode::MBUS) ||
|
|
link_modes.has(LinkMode::C2) ||
|
|
link_modes.has(LinkMode::T2) ||
|
|
link_modes.has(LinkMode::S2);
|
|
}
|
|
|
|
bool isValidKey(string& key, MeterDriver mt)
|
|
{
|
|
if (key.length() == 0) return true;
|
|
if (key == "NOKEY") {
|
|
key = "";
|
|
return true;
|
|
}
|
|
if (mt == MeterDriver::IZAR ||
|
|
mt == MeterDriver::HYDRUS)
|
|
{
|
|
// These meters can either be OMS compatible 128 bit key (32 hex).
|
|
// Or using an older proprietary encryption with 64 bit keys (16 hex)
|
|
if (key.length() != 16 && key.length() != 32) return false;
|
|
}
|
|
else
|
|
{
|
|
// OMS compliant meters have 128 bit AES keys (32 hex).
|
|
// There is a deprecated DES mode, but I have not yet
|
|
// seen any telegram using that mode.
|
|
if (key.length() != 32) return false;
|
|
}
|
|
vector<uchar> tmp;
|
|
return hex2bin(key, &tmp);
|
|
}
|
|
|
|
|
|
void FieldInfo::performExtraction(Meter *m, Telegram *t, DVEntry *dve)
|
|
{
|
|
if (xuantity_ == Quantity::Text)
|
|
{
|
|
extractString(m, t, dve);
|
|
}
|
|
else
|
|
{
|
|
extractNumeric(m, t, dve);
|
|
}
|
|
}
|
|
|
|
bool FieldInfo::hasMatcher()
|
|
{
|
|
return matcher_.active == true;
|
|
}
|
|
|
|
bool FieldInfo::matches(DVEntry *dve)
|
|
{
|
|
return matcher_.matches(*dve);
|
|
}
|
|
|
|
DriverName MeterInfo::driverName()
|
|
{
|
|
if (driver_name.str() == "")
|
|
{
|
|
return DriverName(toString(driver));
|
|
}
|
|
return driver_name;
|
|
}
|
|
|
|
bool FieldInfo::extractNumeric(Meter *m, Telegram *t, DVEntry *dve)
|
|
{
|
|
bool found = false;
|
|
string key = matcher_.dif_vif_key.str();
|
|
|
|
if (dve == NULL)
|
|
{
|
|
if (key == "")
|
|
{
|
|
// Search for key.
|
|
bool ok = findKeyWithNr(matcher_.measurement_type,
|
|
matcher_.vif_range,
|
|
matcher_.storage_nr_from.intValue(),
|
|
matcher_.tariff_nr_from.intValue(),
|
|
matcher_.index_nr.intValue(),
|
|
&key,
|
|
&t->dv_entries);
|
|
// No entry was found.
|
|
if (!ok) return false;
|
|
}
|
|
// No entry with this key was found.
|
|
if (t->dv_entries.count(key) == 0) return false;
|
|
dve = &t->dv_entries[key].second;
|
|
}
|
|
assert(dve != NULL);
|
|
assert(key == "" || dve->dif_vif_key.str() == key);
|
|
|
|
// Generate the json field name:
|
|
string field_name = generateFieldName(dve);
|
|
|
|
double extracted_double_value = NAN;
|
|
if (dve->extractDouble(&extracted_double_value,
|
|
vifScaling() == VifScaling::Auto ||
|
|
vifScaling() == VifScaling::AutoSigned,
|
|
vifScaling() == VifScaling::NoneSigned ||
|
|
vifScaling() == VifScaling::AutoSigned))
|
|
{
|
|
Unit decoded_unit = defaultUnit();
|
|
if (matcher_.vif_range != VIFRange::Any &&
|
|
matcher_.vif_range != VIFRange::AnyVolumeVIF &&
|
|
matcher_.vif_range != VIFRange::AnyEnergyVIF &&
|
|
matcher_.vif_range != VIFRange::AnyPowerVIF &&
|
|
matcher_.vif_range != VIFRange::None)
|
|
{
|
|
decoded_unit = toDefaultUnit(matcher_.vif_range);
|
|
}
|
|
m->setNumericValue(this, decoded_unit, extracted_double_value);
|
|
t->addMoreExplanation(dve->offset, renderJson(m, &m->conversions()));
|
|
found = true;
|
|
}
|
|
return found;
|
|
}
|
|
|
|
static string add_tpl_status(string existing_status, Meter *m, Telegram *t)
|
|
{
|
|
string status = m->decodeTPLStatusByte(t->tpl_sts);
|
|
t->addMoreExplanation(t->tpl_sts_offset, "(%s)", status.c_str());
|
|
if (status != "OK")
|
|
{
|
|
if (existing_status != "OK")
|
|
{
|
|
// Join the statuses.
|
|
existing_status += " "+status;
|
|
}
|
|
else
|
|
{
|
|
// Overwrite OK.
|
|
existing_status = status;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// No change to the existing_status
|
|
}
|
|
|
|
return existing_status;
|
|
}
|
|
|
|
bool FieldInfo::extractString(Meter *m, Telegram *t, DVEntry *dve)
|
|
{
|
|
bool found = false;
|
|
string key = matcher_.dif_vif_key.str();
|
|
|
|
if (dve == NULL)
|
|
{
|
|
if (key == "")
|
|
{
|
|
if (!hasMatcher())
|
|
{
|
|
// There is no matcher, only use case is to capture JOIN_TPL_STATUS.
|
|
if (print_properties_.hasJOINTPLSTATUS())
|
|
{
|
|
string status = add_tpl_status("OK", m, t);
|
|
m->setStringValue(this, status);
|
|
return true;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Search for key.
|
|
bool ok = findKeyWithNr(matcher_.measurement_type,
|
|
matcher_.vif_range,
|
|
matcher_.storage_nr_from.intValue(),
|
|
matcher_.tariff_nr_from.intValue(),
|
|
matcher_.index_nr.intValue(),
|
|
&key,
|
|
&t->dv_entries);
|
|
// No entry was found.
|
|
if (!ok) return false;
|
|
}
|
|
}
|
|
// No entry with this key was found.
|
|
if (t->dv_entries.count(key) == 0) return false;
|
|
dve = &t->dv_entries[key].second;
|
|
}
|
|
assert(dve != NULL);
|
|
assert(key == "" || dve->dif_vif_key.str() == key);
|
|
|
|
// Generate the json field name:
|
|
string field_name = generateFieldName(dve);
|
|
|
|
uint64_t extracted_bits {};
|
|
if (lookup_.hasLookups() || (print_properties_.hasJOINTPLSTATUS()))
|
|
{
|
|
string translated_bits = "";
|
|
// The field has lookups, or the print property JOIN_TPL_STATUS is set,
|
|
// this means that we should create a string.
|
|
if (lookup_.hasLookups() && dve->extractLong(&extracted_bits))
|
|
{
|
|
translated_bits = lookup().translate(extracted_bits);
|
|
found = true;
|
|
}
|
|
|
|
if (print_properties_.hasJOINTPLSTATUS())
|
|
{
|
|
translated_bits = add_tpl_status(translated_bits, m, t);
|
|
}
|
|
|
|
if (found)
|
|
{
|
|
m->setStringValue(this, translated_bits);
|
|
t->addMoreExplanation(dve->offset, renderJsonText(m));
|
|
}
|
|
}
|
|
else if (matcher_.vif_range == VIFRange::DateTime)
|
|
{
|
|
struct tm datetime;
|
|
dve->extractDate(&datetime);
|
|
string extracted_device_date_time = strdatetime(&datetime);
|
|
m->setStringValue(this, extracted_device_date_time);
|
|
t->addMoreExplanation(dve->offset, renderJsonText(m));
|
|
found = true;
|
|
}
|
|
else if (matcher_.vif_range == VIFRange::Date)
|
|
{
|
|
struct tm date;
|
|
dve->extractDate(&date);
|
|
string extracted_device_date = strdate(&date);
|
|
m->setStringValue(this, extracted_device_date);
|
|
t->addMoreExplanation(dve->offset, renderJsonText(m));
|
|
found = true;
|
|
}
|
|
else if (matcher_.vif_range == VIFRange::EnhancedIdentification ||
|
|
matcher_.vif_range == VIFRange::FabricationNo ||
|
|
matcher_.vif_range == VIFRange::ModelVersion ||
|
|
matcher_.vif_range == VIFRange::SoftwareVersion ||
|
|
matcher_.vif_range == VIFRange::ParameterSet)
|
|
{
|
|
string extracted_id;
|
|
dve->extractReadableString(&extracted_id);
|
|
m->setStringValue(this, extracted_id);
|
|
t->addMoreExplanation(dve->offset, renderJsonText(m));
|
|
found = true;
|
|
}
|
|
else
|
|
{
|
|
error("Internal error: Cannot extract text string from vif %s in %s:%d\n",
|
|
toString(matcher_.vif_range),
|
|
__FILE__, __LINE__);
|
|
|
|
}
|
|
return found;
|
|
}
|
|
|
|
bool Address::parse(string &s)
|
|
{
|
|
// Example: 12345678
|
|
// or 12345678.M=PII.T=1B.V=01
|
|
// or 1234*
|
|
// or 1234*.PII
|
|
// or 1234*.V01
|
|
// or 12 // mbus primary
|
|
// or 0 // mbus primary
|
|
// or 250.MPII.T1B.V01 // mbus primary
|
|
|
|
id = "";
|
|
mbus_primary = false;
|
|
mfct = 0;
|
|
type = 0;
|
|
version = 0;
|
|
|
|
if (s.size() == 0) return false;
|
|
|
|
vector<string> parts = splitString(s, '.');
|
|
|
|
assert(parts.size() > 0);
|
|
|
|
if (!isValidMatchExpression(parts[0], true))
|
|
{
|
|
// Not a long id, so lets check if it is 0-250.
|
|
for (size_t i=0; i < parts[0].length(); ++i)
|
|
{
|
|
if (!isdigit(parts[0][i])) return false;
|
|
}
|
|
// All digits good.
|
|
int v = atoi(parts[0].c_str());
|
|
if (v < 0 || v > 250) return false;
|
|
// It is 0-250 which means it is an mbus primary address.
|
|
mbus_primary = true;
|
|
}
|
|
id = parts[0];
|
|
|
|
for (size_t i=1; i<parts[i].size(); ++i)
|
|
{
|
|
if (parts[i].size() == 4) // V=xy or T=xy
|
|
{
|
|
if (parts[i][1] != '=') return false;
|
|
|
|
vector<uchar> data;
|
|
bool ok = hex2bin(&parts[i][2], &data);
|
|
if (!ok) return false;
|
|
if (data.size() != 1) return false;
|
|
|
|
if (parts[i][0] == 'V')
|
|
{
|
|
version = data[0];
|
|
}
|
|
else if (parts[i][0] == 'T')
|
|
{
|
|
type = data[0];
|
|
}
|
|
else
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
else if (parts[i].size() == 5) // M=xyz
|
|
{
|
|
if (parts[i][1] != '=') return false;
|
|
if (parts[i][0] != 'M') return false;
|
|
|
|
bool ok = flagToManufacturer(&parts[i][2], &mfct);
|
|
if (!ok) return false;
|
|
}
|
|
else
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
void MeterCommonImplementation::addOptionalCommonFields()
|
|
{
|
|
addStringFieldWithExtractor(
|
|
"fabrication_no",
|
|
"Fabrication number.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::Instantaneous)
|
|
.set(VIFRange::FabricationNo)
|
|
);
|
|
|
|
addStringFieldWithExtractor(
|
|
"software_version",
|
|
"Software version.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::Instantaneous)
|
|
.set(VIFRange::SoftwareVersion)
|
|
);
|
|
|
|
addNumericFieldWithExtractor(
|
|
"operating_time",
|
|
"How long the meter has been collecting data.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
Quantity::Time,
|
|
VifScaling::Auto,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::Instantaneous)
|
|
.set(VIFRange::OperatingTime)
|
|
);
|
|
|
|
addNumericFieldWithExtractor(
|
|
"on_time",
|
|
"How long the meter has been powered up.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
Quantity::Time,
|
|
VifScaling::Auto,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::Instantaneous)
|
|
.set(VIFRange::OnTime)
|
|
);
|
|
|
|
addNumericFieldWithExtractor(
|
|
"on_time_at_error",
|
|
"How long the meter has been in an error state while powered up.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
Quantity::Time,
|
|
VifScaling::Auto,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::AtError)
|
|
.set(VIFRange::OnTime)
|
|
);
|
|
|
|
addStringFieldWithExtractor(
|
|
"meter_date",
|
|
"Date when the meter sent the telegram.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::Instantaneous)
|
|
.set(VIFRange::Date)
|
|
);
|
|
|
|
addStringFieldWithExtractor(
|
|
"meter_date_at_error",
|
|
"Date when the meter was in error.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::AtError)
|
|
.set(VIFRange::Date)
|
|
);
|
|
|
|
addStringFieldWithExtractor(
|
|
"meter_datetime",
|
|
"Date and time when the meter sent the telegram.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::Instantaneous)
|
|
.set(VIFRange::DateTime)
|
|
);
|
|
|
|
addStringFieldWithExtractor(
|
|
"meter_datetime_at_error",
|
|
"Date and time when the meter was in error.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::AtError)
|
|
.set(VIFRange::DateTime)
|
|
);
|
|
|
|
}
|
|
|
|
void MeterCommonImplementation::addOptionalFlowRelatedFields()
|
|
{
|
|
addNumericFieldWithExtractor(
|
|
"total",
|
|
"The total media volume consumption recorded by this meter.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
Quantity::Volume,
|
|
VifScaling::Auto,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::Instantaneous)
|
|
.set(VIFRange::Volume)
|
|
);
|
|
|
|
addNumericFieldWithExtractor(
|
|
"total_backward",
|
|
"The total media volume flowing backward.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
Quantity::Volume,
|
|
VifScaling::Auto,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::Instantaneous)
|
|
.set(VIFRange::Volume)
|
|
.add(VIFCombinable::BackwardFlow)
|
|
);
|
|
|
|
addNumericFieldWithExtractor(
|
|
"flow_temperature",
|
|
"Forward media temperature.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
Quantity::Temperature,
|
|
VifScaling::Auto,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::Instantaneous)
|
|
.set(VIFRange::FlowTemperature)
|
|
);
|
|
|
|
addNumericFieldWithExtractor(
|
|
"return_temperature",
|
|
"Return media temperature.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
Quantity::Temperature,
|
|
VifScaling::Auto,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::Instantaneous)
|
|
.set(VIFRange::ReturnTemperature)
|
|
);
|
|
|
|
addNumericFieldWithExtractor(
|
|
"flow_return_temperature_difference",
|
|
"The difference between flow and return media temperatures.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
Quantity::Temperature,
|
|
VifScaling::AutoSigned,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::Instantaneous)
|
|
.set(VIFRange::TemperatureDifference)
|
|
);
|
|
|
|
addNumericFieldWithExtractor(
|
|
"volume_flow",
|
|
"Media volume flow.",
|
|
PrintProperty::JSON | PrintProperty::OPTIONAL,
|
|
Quantity::Flow,
|
|
VifScaling::Auto,
|
|
FieldMatcher::build()
|
|
.set(MeasurementType::Instantaneous)
|
|
.set(VIFRange::VolumeFlow)
|
|
);
|
|
|
|
|
|
}
|