ETM-Schurig/powersync-plugins-modbus
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

changes requested by reviewer

Browse Source
This commit is contained in:
Boernsman 2021-04-29 16:34:45 +02:00 committed by Michael Zanetti
parent 9fde1e7473
commit c393bbcf19
9 changed files with 112 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
energymeters/README.md
View File

@ -11,5 +11,5 @@ Connect Modbus RTU based energy meters.
## Requirements ## Requirements
* The plugin 'nymea-plugin-energymeter' must be installed * The plugin 'nymea-plugin-energymeter' must be installed.
* At least one Modbus RTU interface must be setup. * At least one Modbus RTU interface must be setup.

2
energymeters/bg-etechmodbusregister.h
View File

@ -1,6 +1,6 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* Copyright 2013 - 2020, nymea GmbH * Copyright 2013 - 2021, nymea GmbH
* Contact: contact@nymea.io * Contact: contact@nymea.io
* *
* This file is part of nymea. * This file is part of nymea.

21
energymeters/energymeter.cpp
View File

@ -1,6 +1,6 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* Copyright 2013 - 2020, nymea GmbH * Copyright 2013 - 2021, nymea GmbH
* Contact: contact@nymea.io * Contact: contact@nymea.io
* *
* This file is part of nymea. * This file is part of nymea.
@ -42,12 +42,17 @@ EnergyMeter::EnergyMeter(ModbusRtuMaster *modbusMaster, int slaveAddress, const
} }
QUuid EnergyMeter::modbusRtuMasterUuid() ModbusRtuMaster *EnergyMeter::modbusMaster()
{ {
return m_modbusRtuMaster->modbusUuid(); return m_modbusRtuMaster;
} }
bool EnergyMeter::connected() void EnergyMeter::setModbusMaster(ModbusRtuMaster *modbusMaster)
{
m_modbusRtuMaster = modbusMaster;
}
bool EnergyMeter::connected() const
{ {
return m_connected; return m_connected;
} }
@ -112,6 +117,12 @@ bool EnergyMeter::getRegister(ModbusRegisterType type)
if (!m_modbusRegisters.contains(type)) if (!m_modbusRegisters.contains(type))
return false; return false;
if (!m_modbusRtuMaster)
return false;
if (!m_modbusRtuMaster->connected())
return false;
ModbusRegisterDescriptor descriptor = m_modbusRegisters.value(type); ModbusRegisterDescriptor descriptor = m_modbusRegisters.value(type);
ModbusRtuReply *reply = nullptr; ModbusRtuReply *reply = nullptr;
@ -199,6 +210,8 @@ bool EnergyMeter::getRegister(ModbusRegisterType type)
value.f /= 1000.00; value.f /= 1000.00;
} }
emit producedEnergyReceived(value.f); emit producedEnergyReceived(value.f);
} else {
qCWarning(dcEnergyMeters()) << "EnergyMeter: Modbus register type not handled" << type;
} }
}); });
return true; return true;

11
energymeters/energymeter.h
View File

@ -1,6 +1,6 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* Copyright 2013 - 2020, nymea GmbH * Copyright 2013 - 2021, nymea GmbH
* Contact: contact@nymea.io * Contact: contact@nymea.io
* *
* This file is part of nymea. * This file is part of nymea.
@ -43,8 +43,10 @@ class EnergyMeter : public QObject
public: public:
explicit EnergyMeter(ModbusRtuMaster *modbusMaster, int slaveAddress, const QHash<ModbusRegisterType, ModbusRegisterDescriptor> &modbusRegisters, QObject *parent = nullptr); explicit EnergyMeter(ModbusRtuMaster *modbusMaster, int slaveAddress, const QHash<ModbusRegisterType, ModbusRegisterDescriptor> &modbusRegisters, QObject *parent = nullptr);
QUuid modbusRtuMasterUuid(); ModbusRtuMaster *modbusMaster();
bool connected(); void setModbusMaster(ModbusRtuMaster *modbusMaster);
bool connected() const;
bool getVoltageL1(); bool getVoltageL1();
bool getVoltageL2(); bool getVoltageL2();
bool getVoltageL3(); bool getVoltageL3();
@ -87,9 +89,6 @@ signals:
void powerFactorReceived(double powerFactor); void powerFactorReceived(double powerFactor);
void producedEnergyReceived(double energy); void producedEnergyReceived(double energy);
void consumedEnergyReceived(double energy); void consumedEnergyReceived(double energy);
//private slot:
// void onRegisterReceived();
}; };
#endif // ENERGYMETER_H #endif // ENERGYMETER_H

2
energymeters/inepromodbusregister.h
View File

@ -1,6 +1,6 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* Copyright 2013 - 2020, nymea GmbH * Copyright 2013 - 2021, nymea GmbH
* Contact: contact@nymea.io * Contact: contact@nymea.io
* *
* This file is part of nymea. * This file is part of nymea.

60
energymeters/integrationpluginenergymeters.cpp
View File

@ -1,6 +1,6 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* Copyright 2013 - 2020, nymea GmbH * Copyright 2013 - 2021, nymea GmbH
* Contact: contact@nymea.io * Contact: contact@nymea.io
* *
* This file is part of nymea. * This file is part of nymea.
@ -95,15 +95,17 @@ void IntegrationPluginEnergyMeters::init()
connect(hardwareManager()->modbusRtuResource(), &ModbusRtuHardwareResource::modbusRtuMasterRemoved, this, [=] (const QUuid &modbusUuid){ connect(hardwareManager()->modbusRtuResource(), &ModbusRtuHardwareResource::modbusRtuMasterRemoved, this, [=] (const QUuid &modbusUuid){
qCDebug(dcEnergyMeters()) << "Modbus RTU master has been removed" << modbusUuid.toString(); qCDebug(dcEnergyMeters()) << "Modbus RTU master has been removed" << modbusUuid.toString();
// Check if there is any device using this resource Q_FOREACH(Thing *thing, myThings()) {
foreach (EnergyMeter * meter, m_energyMeters) { if (m_modbusUuidParamTypeIds.contains(thing->thingClassId())) {
if (meter->modbusRtuMasterUuid() == modbusUuid) { if (thing->paramValue(m_modbusUuidParamTypeIds.value(thing->thingClassId())) == modbusUuid) {
Thing *thing = m_energyMeters.key(meter);
if (!thing)
return;
qCWarning(dcEnergyMeters()) << "Modbus RTU hardware resource removed for" << thing << ". The thing will not be functional any more until a new resource has been configured for it."; qCWarning(dcEnergyMeters()) << "Modbus RTU hardware resource removed for" << thing << ". The thing will not be functional any more until a new resource has been configured for it.";
thing->setStateValue(m_connectionStateTypeIds[thing->thingClassId()], false); thing->setStateValue(m_connectionStateTypeIds[thing->thingClassId()], false);
EnergyMeter *meter = m_energyMeters.value(thing);
if (!meter)
return;
meter->setModbusMaster(nullptr);
}
} }
} }
}); });
@ -119,8 +121,10 @@ void IntegrationPluginEnergyMeters::discoverThings(ThingDiscoveryInfo *info)
return; return;
} }
if (m_connectionStateTypeIds.contains(info->thingClassId())) { if (!m_connectionStateTypeIds.contains(info->thingClassId())) {
int slaveAddress = info->params().paramValue(m_discoverySlaveAddressParamTypeIds.value(info->thingClassId())).toInt(); Q_ASSERT_X(false, "discoverThings", QString("Unhandled thingClassId: %1").arg(info->thingClassId().toString()).toUtf8());
}
uint slaveAddress = info->params().paramValue(m_discoverySlaveAddressParamTypeIds.value(info->thingClassId())).toUInt();
if (slaveAddress > 254 || slaveAddress == 0) { if (slaveAddress > 254 || slaveAddress == 0) {
info->finish(Thing::ThingErrorInvalidParameter, tr("Modbus slave address must be between 1 and 254")); info->finish(Thing::ThingErrorInvalidParameter, tr("Modbus slave address must be between 1 and 254"));
return; return;
@ -139,9 +143,6 @@ void IntegrationPluginEnergyMeters::discoverThings(ThingDiscoveryInfo *info)
} }
info->finish(Thing::ThingErrorNoError); info->finish(Thing::ThingErrorNoError);
return; return;
} else {
Q_ASSERT_X(false, "discoverThings", QString("Unhandled thingClassId: %1").arg(info->thingClassId().toString()).toUtf8());
}
} }
void IntegrationPluginEnergyMeters::setupThing(ThingSetupInfo *info) void IntegrationPluginEnergyMeters::setupThing(ThingSetupInfo *info)
@ -149,19 +150,21 @@ void IntegrationPluginEnergyMeters::setupThing(ThingSetupInfo *info)
Thing *thing = info->thing(); Thing *thing = info->thing();
qCDebug(dcEnergyMeters()) << "Setup thing" << thing->name(); qCDebug(dcEnergyMeters()) << "Setup thing" << thing->name();
if (m_connectionStateTypeIds.contains(thing->thingClassId())) { if (!m_connectionStateTypeIds.contains(thing->thingClassId())) {
Q_ASSERT_X(false, "setupThing", QString("Unhandled thingClassId: %1").arg(thing->thingClassId().toString()).toUtf8());
}
if (m_energyMeters.contains(thing)) { if (m_energyMeters.contains(thing)) {
qCDebug(dcEnergyMeters()) << "Setup after rediscovery, cleaning up ..."; qCDebug(dcEnergyMeters()) << "Setup after rediscovery, cleaning up ...";
m_energyMeters.take(thing)->deleteLater(); m_energyMeters.take(thing)->deleteLater();
} }
int address = thing->paramValue(m_slaveIdParamTypeIds.value(thing->thingClassId())).toInt(); uint address = thing->paramValue(m_slaveIdParamTypeIds.value(thing->thingClassId())).toUInt();
if (address > 254 || address == 0) { if (address > 254 || address == 0) {
qCWarning(dcEnergyMeters()) << "Setup failed, slave address is not valid" << address; qCWarning(dcEnergyMeters()) << "Setup failed, slave address is not valid" << address;
info->finish(Thing::ThingErrorSetupFailed, tr("Slave address not valid, must be between 1 and 254")); info->finish(Thing::ThingErrorSetupFailed, tr("Slave address not valid, must be between 1 and 254"));
return; return;
} }
QUuid uuid = thing->paramValue(m_modbusUuidParamTypeIds.value(thing->thingClassId())).toString(); QUuid uuid = thing->paramValue(m_modbusUuidParamTypeIds.value(thing->thingClassId())).toUuid();
if (!hardwareManager()->modbusRtuResource()->hasModbusRtuMaster(uuid)) { if (!hardwareManager()->modbusRtuResource()->hasModbusRtuMaster(uuid)) {
qCWarning(dcEnergyMeters()) << "Setup failed, hardware manager not available"; qCWarning(dcEnergyMeters()) << "Setup failed, hardware manager not available";
info->finish(Thing::ThingErrorSetupFailed, tr("Modbus RTU resource not available.")); info->finish(Thing::ThingErrorSetupFailed, tr("Modbus RTU resource not available."));
@ -190,9 +193,6 @@ void IntegrationPluginEnergyMeters::setupThing(ThingSetupInfo *info)
}); });
meter->getEnergyConsumed(); meter->getEnergyConsumed();
return; return;
} else {
Q_ASSERT_X(false, "setupThing", QString("Unhandled thingClassId: %1").arg(thing->thingClassId().toString()).toUtf8());
}
} }
void IntegrationPluginEnergyMeters::postSetupThing(Thing *thing) void IntegrationPluginEnergyMeters::postSetupThing(Thing *thing)
@ -277,7 +277,7 @@ void IntegrationPluginEnergyMeters::onConnectionStateChanged(bool status)
void IntegrationPluginEnergyMeters::onVoltageL1Received(double voltage) void IntegrationPluginEnergyMeters::onVoltageL1Received(double voltage)
{ {
EnergyMeter *meter = static_cast<EnergyMeter *>(sender()); EnergyMeter *meter = qobject_cast<EnergyMeter *>(sender());
Thing *thing = m_energyMeters.key(meter); Thing *thing = m_energyMeters.key(meter);
if (!thing) if (!thing)
return; return;
@ -288,7 +288,7 @@ void IntegrationPluginEnergyMeters::onVoltageL1Received(double voltage)
void IntegrationPluginEnergyMeters::onVoltageL2Received(double voltage) void IntegrationPluginEnergyMeters::onVoltageL2Received(double voltage)
{ {
EnergyMeter *meter = static_cast<EnergyMeter *>(sender()); EnergyMeter *meter = qobject_cast<EnergyMeter *>(sender());
Thing *thing = m_energyMeters.key(meter); Thing *thing = m_energyMeters.key(meter);
if (!thing) if (!thing)
return; return;
@ -299,7 +299,7 @@ void IntegrationPluginEnergyMeters::onVoltageL2Received(double voltage)
void IntegrationPluginEnergyMeters::onVoltageL3Received(double voltage) void IntegrationPluginEnergyMeters::onVoltageL3Received(double voltage)
{ {
EnergyMeter *meter = static_cast<EnergyMeter *>(sender()); EnergyMeter *meter = qobject_cast<EnergyMeter *>(sender());
Thing *thing = m_energyMeters.key(meter); Thing *thing = m_energyMeters.key(meter);
if (!thing) if (!thing)
return; return;
@ -310,7 +310,7 @@ void IntegrationPluginEnergyMeters::onVoltageL3Received(double voltage)
void IntegrationPluginEnergyMeters::onCurrentL1Received(double current) void IntegrationPluginEnergyMeters::onCurrentL1Received(double current)
{ {
EnergyMeter *meter = static_cast<EnergyMeter *>(sender()); EnergyMeter *meter = qobject_cast<EnergyMeter *>(sender());
Thing *thing = m_energyMeters.key(meter); Thing *thing = m_energyMeters.key(meter);
if (!thing) if (!thing)
return; return;
@ -321,7 +321,7 @@ void IntegrationPluginEnergyMeters::onCurrentL1Received(double current)
void IntegrationPluginEnergyMeters::onCurrentL2Received(double current) void IntegrationPluginEnergyMeters::onCurrentL2Received(double current)
{ {
EnergyMeter *meter = static_cast<EnergyMeter *>(sender()); EnergyMeter *meter = qobject_cast<EnergyMeter *>(sender());
Thing *thing = m_energyMeters.key(meter); Thing *thing = m_energyMeters.key(meter);
if (!thing) if (!thing)
return; return;
@ -332,7 +332,7 @@ void IntegrationPluginEnergyMeters::onCurrentL2Received(double current)
void IntegrationPluginEnergyMeters::onCurrentL3Received(double current) void IntegrationPluginEnergyMeters::onCurrentL3Received(double current)
{ {
EnergyMeter *meter = static_cast<EnergyMeter *>(sender()); EnergyMeter *meter = qobject_cast<EnergyMeter *>(sender());
Thing *thing = m_energyMeters.key(meter); Thing *thing = m_energyMeters.key(meter);
if (!thing) if (!thing)
return; return;
@ -343,7 +343,7 @@ void IntegrationPluginEnergyMeters::onCurrentL3Received(double current)
void IntegrationPluginEnergyMeters::onActivePowerReceived(double power) void IntegrationPluginEnergyMeters::onActivePowerReceived(double power)
{ {
EnergyMeter *meter = static_cast<EnergyMeter *>(sender()); EnergyMeter *meter = qobject_cast<EnergyMeter *>(sender());
Thing *thing = m_energyMeters.key(meter); Thing *thing = m_energyMeters.key(meter);
if (!thing) if (!thing)
return; return;
@ -354,7 +354,7 @@ void IntegrationPluginEnergyMeters::onActivePowerReceived(double power)
void IntegrationPluginEnergyMeters::onFrequencyReceived(double frequency) void IntegrationPluginEnergyMeters::onFrequencyReceived(double frequency)
{ {
EnergyMeter *meter = static_cast<EnergyMeter *>(sender()); EnergyMeter *meter = qobject_cast<EnergyMeter *>(sender());
Thing *thing = m_energyMeters.key(meter); Thing *thing = m_energyMeters.key(meter);
if (!thing) if (!thing)
return; return;
@ -365,7 +365,7 @@ void IntegrationPluginEnergyMeters::onFrequencyReceived(double frequency)
void IntegrationPluginEnergyMeters::onPowerFactorReceived(double powerFactor) void IntegrationPluginEnergyMeters::onPowerFactorReceived(double powerFactor)
{ {
EnergyMeter *meter = static_cast<EnergyMeter *>(sender()); EnergyMeter *meter = qobject_cast<EnergyMeter *>(sender());
Thing *thing = m_energyMeters.key(meter); Thing *thing = m_energyMeters.key(meter);
if (!thing) if (!thing)
return; return;
@ -376,7 +376,7 @@ void IntegrationPluginEnergyMeters::onPowerFactorReceived(double powerFactor)
void IntegrationPluginEnergyMeters::onProducedEnergyReceived(double energy) void IntegrationPluginEnergyMeters::onProducedEnergyReceived(double energy)
{ {
EnergyMeter *meter = static_cast<EnergyMeter *>(sender()); EnergyMeter *meter = qobject_cast<EnergyMeter *>(sender());
Thing *thing = m_energyMeters.key(meter); Thing *thing = m_energyMeters.key(meter);
if (!thing) if (!thing)
return; return;
@ -387,7 +387,7 @@ void IntegrationPluginEnergyMeters::onProducedEnergyReceived(double energy)
void IntegrationPluginEnergyMeters::onConsumedEnergyReceived(double energy) void IntegrationPluginEnergyMeters::onConsumedEnergyReceived(double energy)
{ {
EnergyMeter *meter = static_cast<EnergyMeter *>(sender()); EnergyMeter *meter = qobject_cast<EnergyMeter *>(sender());
Thing *thing = m_energyMeters.key(meter); Thing *thing = m_energyMeters.key(meter);
if (!thing) if (!thing)
return; return;

2
energymeters/integrationpluginenergymeters.h
View File

@ -1,6 +1,6 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* Copyright 2013 - 2020, nymea GmbH * Copyright 2013 - 2021, nymea GmbH
* Contact: contact@nymea.io * Contact: contact@nymea.io
* *
* This file is part of nymea. * This file is part of nymea.

4
energymeters/integrationpluginenergymeters.json
View File

@ -39,7 +39,7 @@
"id": "c75b2c31-6ec3-49ab-8c8f-5231d0a7e941", "id": "c75b2c31-6ec3-49ab-8c8f-5231d0a7e941",
"name": "slaveAddress", "name": "slaveAddress",
"displayName": "Modbus slave address", "displayName": "Modbus slave address",
"type": "int", "type": "uint",
"defaultValue": 1 "defaultValue": 1
}, },
{ {
@ -188,7 +188,7 @@
"id": "ac77ea98-b006-486e-a3e8-b30a483f26c1", "id": "ac77ea98-b006-486e-a3e8-b30a483f26c1",
"name": "slaveAddress", "name": "slaveAddress",
"displayName": "Modbus slave address", "displayName": "Modbus slave address",
"type": "int", "type": "uint",
"defaultValue": 1 "defaultValue": 1
}, },
{ {

2
energymeters/registerdescriptor.h
View File

@ -1,6 +1,6 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* Copyright 2013 - 2020, nymea GmbH * Copyright 2013 - 2021, nymea GmbH
* Contact: contact@nymea.io * Contact: contact@nymea.io
* *
* This file is part of nymea. * This file is part of nymea.