/*
Copyright (C) 2017-2020 Fredrik Öhrström
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 .
*/
#ifndef METER_H_
#define METER_H_
#include"util.h"
#include"units.h"
#include"wmbus.h"
#include
#include
#define LIST_OF_METERS \
X(amiplus, T1_bit, Electricity, AMIPLUS, Amiplus) \
X(apator08, T1_bit, Water, APATOR08, Apator08) \
X(apator162, C1_bit|T1_bit, Water, APATOR162, Apator162) \
X(cma12w, C1_bit|T1_bit, TempHygro, CMA12W, CMa12w) \
X(ebzwmbe, T1_bit, Electricity, EBZWMBE, EBZWMBE) \
X(eurisii, T1_bit, HeatCostAllocation, EURISII, EurisII) \
X(ehzp, T1_bit, Electricity, EHZP, EHZP) \
X(esyswm, T1_bit, Electricity, ESYSWM, ESYSWM) \
X(flowiq3100, C1_bit, Water, FLOWIQ3100, FlowIQ3100) \
X(fhkvdataiii, T1_bit, HeatCostAllocation, FHKVDATAIII, FHKVDataIII) \
X(hydrus, T1_bit, Water, HYDRUS, Hydrus) \
X(hydrodigit, T1_bit, Water, HYDRODIGIT, Hydrodigit) \
X(iperl, T1_bit, Water, IPERL, Iperl) \
X(izar, T1_bit, Water, IZAR, Izar) \
X(lansensm, T1_bit, Smoke, LANSENSM, LansenSM) \
X(lansenth, T1_bit, TempHygro, LANSENTH, LansenTH) \
X(lansendw, T1_bit, DoorWindow, LANSENDW, LansenDW) \
X(lansenpu, T1_bit, Pulse, LANSENPU, LansenPU) \
X(mkradio3, T1_bit, Water, MKRADIO3, MKRadio3) \
X(multical21, C1_bit, Water, MULTICAL21, Multical21) \
X(multical302,C1_bit, Heat, MULTICAL302, Multical302) \
X(omnipower, C1_bit, Electricity, OMNIPOWER, Omnipower) \
X(rfmamb, T1_bit, TempHygro, RFMAMB, RfmAmb) \
X(rfmtx1, T1_bit, Water, RFMTX1, RfmTX1) \
X(q400, T1_bit, Water, Q400, Q400) \
X(qcaloric, C1_bit, HeatCostAllocation, QCALORIC, QCaloric) \
X(supercom587,T1_bit, Water, SUPERCOM587, Supercom587) \
X(vario451, T1_bit, Heat, VARIO451, Vario451) \
X(waterstarm, C1_bit|T1_bit, Water,WATERSTARM, WaterstarM) \
enum class MeterType {
#define X(mname,linkmode,info,type,cname) type,
LIST_OF_METERS
#undef X
UNKNOWN
};
using namespace std;
typedef unsigned char uchar;
struct MeterInfo
{
string name;
string type;
string id;
string key;
LinkModeSet link_modes;
vector shells;
vector jsons; // Additional static jsons that are added to each message.
MeterInfo(string n, string t, string i, string k, LinkModeSet lms, vector &s, vector &j)
{
name = n;
type = t;
id = i;
key = k;
shells = s;
jsons = j;
link_modes = lms;
}
};
struct Meter
{
// This meter listens to these ids.
virtual vector ids() = 0;
// This meter can report these fields, like total_m3, temp_c.
virtual vector fields() = 0;
virtual string meterName() = 0;
virtual string name() = 0;
virtual MeterType type() = 0;
virtual vector media() = 0;
virtual WMBus *bus() = 0;
virtual string datetimeOfUpdateHumanReadable() = 0;
virtual string datetimeOfUpdateRobot() = 0;
virtual void onUpdate(function cb) = 0;
virtual int numUpdates() = 0;
virtual void printMeter(Telegram *t,
string *human_readable,
string *fields, char separator,
string *json,
vector *envs,
vector *more_json,
vector *selected_fields) = 0;
// The handleTelegram expects an input_frame where the DLL crcs have been removed.
bool handleTelegram(vector input_frame);
virtual bool isTelegramForMe(Telegram *t) = 0;
virtual MeterKeys *meterKeys() = 0;
virtual bool isExpectedVersion(int version) = 0;
// Dynamically access all data received for the meter.
virtual std::vector getRecords() = 0;
virtual double getRecordAsDouble(std::string record) = 0;
virtual uint16_t getRecordAsUInt16(std::string record) = 0;
virtual void addConversions(std::vector cs) = 0;
virtual void addShell(std::string cmdline) = 0;
virtual vector &shellCmdlines() = 0;
virtual ~Meter() = default;
};
struct WaterMeter : public virtual Meter
{
virtual double totalWaterConsumption(Unit u); // m3
virtual bool hasTotalWaterConsumption();
virtual double targetWaterConsumption(Unit u); // m3
virtual bool hasTargetWaterConsumption();
virtual double maxFlow(Unit u); // m3/s
virtual bool hasMaxFlow();
virtual double flowTemperature(Unit u); // °C
virtual bool hasFlowTemperature();
virtual double externalTemperature(Unit u); // °C
virtual bool hasExternalTemperature();
virtual string statusHumanReadable();
virtual string status();
virtual string timeDry();
virtual string timeReversed();
virtual string timeLeaking();
virtual string timeBursting();
};
struct HeatMeter : public virtual Meter
{
virtual double totalEnergyConsumption(Unit u); // kwh
virtual double currentPeriodEnergyConsumption(Unit u); // kwh
virtual double previousPeriodEnergyConsumption(Unit u); // kwh
virtual double currentPowerConsumption(Unit u); // kw
virtual double totalVolume(Unit u); // m3
};
struct ElectricityMeter : public virtual Meter
{
virtual double totalEnergyConsumption(Unit u); // kwh
virtual double currentPowerConsumption(Unit u); // kw
virtual double totalEnergyProduction(Unit u); // kwh
virtual double currentPowerProduction(Unit u); // kw
};
struct HeatCostMeter : public virtual Meter
{
virtual double currentConsumption(Unit u);
virtual string setDate();
virtual double consumptionAtSetDate(Unit u);
};
struct TempMeter : public virtual Meter
{
virtual double currentTemperature(Unit u) = 0; // °C
virtual ~TempMeter() = default;
};
struct HygroMeter : public virtual Meter
{
virtual double currentRelativeHumidity() = 0; // RH
virtual ~HygroMeter() = default;
};
struct TempHygroMeter : public virtual TempMeter, public virtual HygroMeter
{
virtual ~TempHygroMeter() = default;
};
struct SmokeDetector : public virtual Meter
{
virtual bool smokeDetected() = 0;
virtual ~SmokeDetector() = default;
};
struct DoorWindowDetector : public virtual Meter
{
virtual bool open() = 0;
virtual ~DoorWindowDetector() = default;
};
struct PulseCounter : public virtual Meter
{
virtual double counterA() = 0;
virtual double counterB() = 0;
virtual ~PulseCounter() = default;
};
struct GenericMeter : public virtual Meter {
};
string toMeterName(MeterType mt);
MeterType toMeterType(string& type);
LinkModeSet toMeterLinkModeSet(string& type);
unique_ptr createMultical21(WMBus *bus, MeterInfo &m);
unique_ptr createFlowIQ3100(WMBus *bus, MeterInfo &m);
unique_ptr createMultical302(WMBus *bus, MeterInfo &m);
unique_ptr createVario451(WMBus *bus, MeterInfo &m);
unique_ptr createWaterstarM(WMBus *bus, MeterInfo &m);
unique_ptr createOmnipower(WMBus *bus, MeterInfo &m);
unique_ptr createAmiplus(WMBus *bus, MeterInfo &m);
unique_ptr createSupercom587(WMBus *bus, MeterInfo &m);
unique_ptr createMKRadio3(WMBus *bus, MeterInfo &m);
unique_ptr createApator08(WMBus *bus, MeterInfo &m);
unique_ptr createApator162(WMBus *bus, MeterInfo &m);
unique_ptr createIperl(WMBus *bus, MeterInfo &m);
unique_ptr createHydrus(WMBus *bus, MeterInfo &m);
unique_ptr createHydrodigit(WMBus *bus, MeterInfo &m);
unique_ptr createIzar(WMBus *bus, MeterInfo &m);
unique_ptr createQ400(WMBus *bus, MeterInfo &m);
unique_ptr createQCaloric(WMBus *bus, MeterInfo &m);
unique_ptr createEurisII(WMBus *bus, MeterInfo &m);
unique_ptr createFHKVDataIII(WMBus *bus, MeterInfo &m);
unique_ptr createLansenTH(WMBus *bus, MeterInfo &m);
unique_ptr createLansenSM(WMBus *bus, MeterInfo &m);
unique_ptr createLansenPU(WMBus *bus, MeterInfo &m);
unique_ptr createLansenDW(WMBus *bus, MeterInfo &m);
unique_ptr createCMa12w(WMBus *bus, MeterInfo &m);
unique_ptr createRfmAmb(WMBus *bus, MeterInfo &m);
unique_ptr createRfmTX1(WMBus *bus, MeterInfo &m);
unique_ptr createEHZP(WMBus *bus, MeterInfo &m);
unique_ptr createESYSWM(WMBus *bus, MeterInfo &m);
unique_ptr createEBZWMBE(WMBus *bus, MeterInfo &m);
GenericMeter *createGeneric(WMBus *bus, MeterInfo &m);
#endif