2018-04-01 06:53:37 +00:00
|
|
|
/*
|
2019-02-24 13:08:51 +00:00
|
|
|
Copyright (C) 2017-2019 Fredrik Öhrström
|
2018-04-01 06:53:37 +00:00
|
|
|
|
|
|
|
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/>.
|
|
|
|
*/
|
2017-08-09 10:00:11 +00:00
|
|
|
|
|
|
|
#ifndef METER_H_
|
|
|
|
#define METER_H_
|
|
|
|
|
|
|
|
#include"util.h"
|
2019-05-04 11:07:37 +00:00
|
|
|
#include"units.h"
|
2017-08-09 10:00:11 +00:00
|
|
|
#include"wmbus.h"
|
|
|
|
|
|
|
|
#include<string>
|
|
|
|
#include<vector>
|
|
|
|
|
2019-05-04 08:52:18 +00:00
|
|
|
#define LIST_OF_METERS \
|
|
|
|
X(amiplus, T1, Electricity, AMIPLUS, Amiplus) \
|
|
|
|
X(apator162, T1, Water, APATOR162, Apator162) \
|
|
|
|
X(flowiq3100, C1, Water, FLOWIQ3100, Multical21) \
|
|
|
|
X(iperl, T1, Water, IPERL, Iperl) \
|
|
|
|
X(mkradio3, T1, Water, MKRADIO3, MKRadio3) \
|
|
|
|
X(multical21, C1, Water, MULTICAL21, Multical21) \
|
|
|
|
X(multical302,C1, Heat, MULTICAL302, Multical302) \
|
|
|
|
X(omnipower, C1, Electricity, OMNIPOWER, Omnipower) \
|
|
|
|
X(qcaloric, C1, HeatCostAllocation, QCALORIC, QCaloric) \
|
|
|
|
X(supercom587,T1, Water, SUPERCOM587, Supercom587) \
|
|
|
|
X(vario451, T1, Heat, VARIO451, Vario451) \
|
|
|
|
|
|
|
|
|
|
|
|
enum class MeterType {
|
|
|
|
#define X(mname,linkmode,info,type,cname) type,
|
2018-03-05 10:29:25 +00:00
|
|
|
LIST_OF_METERS
|
|
|
|
#undef X
|
2019-05-04 08:52:18 +00:00
|
|
|
UNKNOWN
|
2018-03-05 10:29:25 +00:00
|
|
|
};
|
|
|
|
|
2017-08-09 10:00:11 +00:00
|
|
|
using namespace std;
|
|
|
|
|
|
|
|
typedef unsigned char uchar;
|
|
|
|
|
|
|
|
struct Meter {
|
2019-03-05 20:19:05 +00:00
|
|
|
virtual vector<string> ids() = 0;
|
2019-05-04 08:52:18 +00:00
|
|
|
virtual string meterName() = 0;
|
2017-08-09 10:00:11 +00:00
|
|
|
virtual string name() = 0;
|
2018-03-05 10:29:25 +00:00
|
|
|
virtual MeterType type() = 0;
|
2019-03-05 20:19:05 +00:00
|
|
|
virtual vector<int> media() = 0;
|
2018-03-05 10:29:25 +00:00
|
|
|
virtual WMBus *bus() = 0;
|
2018-11-01 16:17:23 +00:00
|
|
|
virtual LinkMode requiredLinkMode() = 0;
|
2018-03-05 10:29:25 +00:00
|
|
|
|
|
|
|
virtual string datetimeOfUpdateHumanReadable() = 0;
|
|
|
|
virtual string datetimeOfUpdateRobot() = 0;
|
|
|
|
|
2019-03-05 20:19:05 +00:00
|
|
|
virtual void onUpdate(function<void(Telegram*t,Meter*)> cb) = 0;
|
2018-03-05 10:29:25 +00:00
|
|
|
virtual int numUpdates() = 0;
|
2017-09-02 21:26:57 +00:00
|
|
|
|
2019-03-05 20:19:05 +00:00
|
|
|
virtual void printMeter(Telegram *t,
|
2019-03-05 17:38:54 +00:00
|
|
|
string *human_readable,
|
2018-11-02 12:50:12 +00:00
|
|
|
string *fields, char separator,
|
|
|
|
string *json,
|
|
|
|
vector<string> *envs) = 0;
|
2018-03-05 10:29:25 +00:00
|
|
|
|
|
|
|
virtual bool isTelegramForMe(Telegram *t) = 0;
|
|
|
|
virtual bool useAes() = 0;
|
|
|
|
virtual vector<uchar> key() = 0;
|
2018-04-20 09:42:46 +00:00
|
|
|
|
|
|
|
// Dynamically access all data received for the meter.
|
|
|
|
virtual std::vector<std::string> getRecords() = 0;
|
|
|
|
virtual double getRecordAsDouble(std::string record) = 0;
|
|
|
|
virtual uint16_t getRecordAsUInt16(std::string record) = 0;
|
2018-12-28 17:35:32 +00:00
|
|
|
|
2019-05-04 11:55:52 +00:00
|
|
|
virtual void addConversions(std::vector<Unit> cs) = 0;
|
|
|
|
|
2018-12-28 17:35:32 +00:00
|
|
|
virtual ~Meter() = default;
|
2018-03-05 10:29:25 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct WaterMeter : public virtual Meter {
|
2018-04-20 09:42:46 +00:00
|
|
|
virtual double totalWaterConsumption() = 0; // m3
|
2017-09-02 21:26:57 +00:00
|
|
|
virtual bool hasTotalWaterConsumption() = 0;
|
2018-04-20 09:42:46 +00:00
|
|
|
virtual double targetWaterConsumption() = 0; // m3
|
2017-09-02 21:26:57 +00:00
|
|
|
virtual bool hasTargetWaterConsumption() = 0;
|
2018-04-20 09:42:46 +00:00
|
|
|
virtual double maxFlow() = 0;
|
2018-03-05 10:29:25 +00:00
|
|
|
virtual bool hasMaxFlow() = 0;
|
2018-11-29 21:25:50 +00:00
|
|
|
virtual double flowTemperature() = 0; // °C
|
|
|
|
virtual bool hasFlowTemperature() = 0;
|
|
|
|
virtual double externalTemperature() = 0; // °C
|
|
|
|
virtual bool hasExternalTemperature() = 0;
|
2017-09-02 21:26:57 +00:00
|
|
|
|
2017-08-30 18:08:02 +00:00
|
|
|
virtual string statusHumanReadable() = 0;
|
2017-08-31 08:58:39 +00:00
|
|
|
virtual string status() = 0;
|
|
|
|
virtual string timeDry() = 0;
|
|
|
|
virtual string timeReversed() = 0;
|
|
|
|
virtual string timeLeaking() = 0;
|
|
|
|
virtual string timeBursting() = 0;
|
2018-03-05 10:29:25 +00:00
|
|
|
};
|
2017-08-09 10:00:11 +00:00
|
|
|
|
2018-03-05 10:29:25 +00:00
|
|
|
struct HeatMeter : public virtual Meter {
|
2019-05-04 11:07:37 +00:00
|
|
|
virtual double totalEnergyConsumption(Unit u) = 0; // kwh
|
|
|
|
virtual double currentPeriodEnergyConsumption(Unit u) = 0; // kwh
|
|
|
|
virtual double previousPeriodEnergyConsumption(Unit u) = 0; // kwh
|
|
|
|
virtual double currentPowerConsumption(Unit u) = 0; // kw
|
|
|
|
virtual double totalVolume(Unit u) = 0; // m3
|
2017-08-09 10:00:11 +00:00
|
|
|
};
|
|
|
|
|
2018-03-16 10:48:04 +00:00
|
|
|
struct ElectricityMeter : public virtual Meter {
|
2018-04-20 09:42:46 +00:00
|
|
|
virtual double totalEnergyConsumption() = 0; // kwh
|
|
|
|
virtual double currentPowerConsumption() = 0; // kw
|
2019-03-20 21:16:45 +00:00
|
|
|
virtual double totalEnergyProduction() = 0; // kwh
|
|
|
|
virtual double currentPowerProduction() = 0; // kw
|
2018-03-16 10:48:04 +00:00
|
|
|
};
|
|
|
|
|
2019-02-17 20:47:23 +00:00
|
|
|
struct HeatCostMeter : public virtual Meter {
|
2019-03-01 14:41:11 +00:00
|
|
|
virtual double currentConsumption() = 0;
|
|
|
|
virtual string setDate() = 0;
|
|
|
|
virtual double consumptionAtSetDate() = 0;
|
2019-02-17 20:47:23 +00:00
|
|
|
};
|
|
|
|
|
2018-04-20 09:42:46 +00:00
|
|
|
struct GenericMeter : public virtual Meter {
|
|
|
|
};
|
2018-03-05 10:29:25 +00:00
|
|
|
|
2019-05-04 08:52:18 +00:00
|
|
|
string toMeterName(MeterType mt);
|
2019-02-23 12:41:17 +00:00
|
|
|
MeterType toMeterType(string& type);
|
|
|
|
LinkMode toMeterLinkMode(string& type);
|
2019-02-23 13:08:56 +00:00
|
|
|
unique_ptr<WaterMeter> createMultical21(WMBus *bus, string& name, string& id, string& key);
|
|
|
|
unique_ptr<WaterMeter> createFlowIQ3100(WMBus *bus, string& name, string& id, string& key);
|
2019-02-23 12:41:17 +00:00
|
|
|
unique_ptr<HeatMeter> createMultical302(WMBus *bus, string& name, string& id, string& key);
|
2019-05-04 06:52:25 +00:00
|
|
|
unique_ptr<HeatMeter> createVario451(WMBus *bus, string& name, string& id, string& key);
|
2019-02-23 12:41:17 +00:00
|
|
|
unique_ptr<ElectricityMeter> createOmnipower(WMBus *bus, string& name, string& id, string& key);
|
2019-03-19 19:53:44 +00:00
|
|
|
unique_ptr<ElectricityMeter> createAmiplus(WMBus *bus, string& name, string& id, string& key);
|
2019-02-23 12:41:17 +00:00
|
|
|
unique_ptr<WaterMeter> createSupercom587(WMBus *bus, string& name, string& id, string& key);
|
2019-04-27 11:31:13 +00:00
|
|
|
unique_ptr<WaterMeter> createMKRadio3(WMBus *bus, string& name, string& id, string& key);
|
2019-03-15 12:05:54 +00:00
|
|
|
unique_ptr<WaterMeter> createApator162(WMBus *bus, string& name, string& id, string& key);
|
2019-02-23 12:41:17 +00:00
|
|
|
unique_ptr<WaterMeter> createIperl(WMBus *bus, string& name, string& id, string& key);
|
|
|
|
unique_ptr<HeatCostMeter> createQCaloric(WMBus *bus, string& name, string& id, string& key);
|
|
|
|
GenericMeter *createGeneric(WMBus *bus, string& name, string& id, string& key);
|
2017-08-09 10:00:11 +00:00
|
|
|
|
|
|
|
#endif
|