nymea-plugins-modbus/energymeters/energymeter.cpp

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright 2013 - 2021, nymea GmbH
* Contact: contact@nymea.io
*
* This file is part of nymea.
* This project including source code and documentation is protected by
* copyright law, and remains the property of nymea GmbH. All rights, including
* reproduction, publication, editing and translation, are reserved. The use of
* this project is subject to the terms of a license agreement to be concluded
* with nymea GmbH in accordance with the terms of use of nymea GmbH, available
* under https://nymea.io/license
*
* GNU Lesser General Public License Usage
* Alternatively, this project may be redistributed and/or modified under the
* terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; version 3. This project 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this project. If not, see <https://www.gnu.org/licenses/>.
*
* For any further details and any questions please contact us under
* contact@nymea.io or see our FAQ/Licensing Information on
* https://nymea.io/license/faq
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#include "energymeter.h"
#include "hardware/modbus/modbusrtureply.h"

#include "extern-plugininfo.h"

EnergyMeter::EnergyMeter(ModbusRtuMaster *modbusMaster, int slaveAddress, const QHash<ModbusRegisterType, ModbusRegisterDescriptor> &modbusRegisters, QObject *parent) :
    QObject(parent),
    m_modbusRtuMaster(modbusMaster),
    m_slaveAddress(slaveAddress),
    m_modbusRegisters(modbusRegisters)
{

}

ModbusRtuMaster *EnergyMeter::modbusMaster()
{
    return m_modbusRtuMaster;
}

void EnergyMeter::setModbusMaster(ModbusRtuMaster *modbusMaster)
{
    m_modbusRtuMaster = modbusMaster;
}

bool EnergyMeter::connected() const
{
    return m_connected;
}

bool EnergyMeter::getVoltageL1()
{
    return getRegister(ModbusRegisterType::VoltageL1);
}

bool EnergyMeter::getVoltageL2()
{
    return getRegister(ModbusRegisterType::VoltageL2);
}

bool EnergyMeter::getVoltageL3()
{
    return getRegister(ModbusRegisterType::VoltageL3);
}

bool EnergyMeter::getCurrentL1()
{
    return getRegister(ModbusRegisterType::CurrentL1);
}

bool EnergyMeter::getCurrentL2()
{
    return getRegister(ModbusRegisterType::CurrentL2);
}

bool EnergyMeter::getCurrentL3()
{
    return getRegister(ModbusRegisterType::CurrentL3);
}

bool EnergyMeter::getFrequency()
{
    return getRegister(ModbusRegisterType::Frequency);
}

bool EnergyMeter::getPowerFactor()
{
    return getRegister(ModbusRegisterType::PowerFactor);
}

bool EnergyMeter::getActivePower()
{
    return getRegister(ModbusRegisterType::ActivePower);
}

bool EnergyMeter::getEnergyProduced()
{
    return getRegister(ModbusRegisterType::EnergyProduced);
}

bool EnergyMeter::getEnergyConsumed()
{
    return getRegister(ModbusRegisterType::EnergyConsumed);
}

bool EnergyMeter::getRegister(ModbusRegisterType type)
{
    if (!m_modbusRegisters.contains(type))
        return false;

    if (!m_modbusRtuMaster)
        return false;

    if (!m_modbusRtuMaster->connected())
        return false;

    ModbusRegisterDescriptor descriptor = m_modbusRegisters.value(type);

    ModbusRtuReply *reply = nullptr;
    if (descriptor.functionCode() == 3){
        reply = m_modbusRtuMaster->readHoldingRegister(m_slaveAddress, descriptor.address(), descriptor.length());
    } else if (descriptor.functionCode() == 4){
        reply = m_modbusRtuMaster->readInputRegister(m_slaveAddress, descriptor.address(), descriptor.length());
    }
    connect(reply, &ModbusRtuReply::finished, reply, &ModbusRtuReply::deleteLater);
    connect(reply, &ModbusRtuReply::finished, this, [reply, type, descriptor, this] {
        if (reply->error() != ModbusRtuReply::NoError) {
            if (m_connected) {
                m_connected = false;
                emit connectedChanged(m_connected);
            }
            return;
        } else {
            if (!m_connected) {
                m_connected = true;
                emit connectedChanged(m_connected);
            }
        }
        modbus_32_t value;
        value.u = 0;
        if (reply->result().length() == 1) {
            value.u = static_cast<float>(reply->result().at(0));
        } else if (reply->result().length() == 2) {
            if (descriptor.dataType() == "float") {
                value.u = static_cast<float>(static_cast<uint32_t>(reply->result().at(0)) << 16 | reply->result().at(1));
            } else {
                qCWarning(dcEnergyMeters()) << "Data type not supported" << descriptor.dataType();
            }
        } else {
            return;
        }

        if (type == ModbusRegisterType::VoltageL1) {
            if (descriptor.unit() == "mV")
                value.f /= 1000.00;

            emit voltageL1Received(value.f);
        } else if (type == ModbusRegisterType::VoltageL2) {
            if (descriptor.unit() == "mV")
                value.f /= 1000.00;

            emit voltageL2Received(value.f);
        } else if (type == ModbusRegisterType::VoltageL3) {
            if (descriptor.unit() == "mV")
                value.f /= 1000.00;

            emit voltageL3Received(value.f);
        } else if (type == ModbusRegisterType::CurrentL1) {
            if (descriptor.unit() == "mA")
                value.f /= 1000.00;

            emit currentL1Received(value.f);
        } else if (type == ModbusRegisterType::CurrentL2) {
            if (descriptor.unit() == "mA")
                value.f /= 1000.00;

            emit currentL2Received(value.f);
        } else if (type == ModbusRegisterType::CurrentL3) {
            if (descriptor.unit() == "mA")
                value.f /= 1000.00;

            emit currentL3Received(value.f);
        } else if (type == ModbusRegisterType::ActivePower) {
            if (descriptor.unit() == "kW") {
                value.f *= 1000;
            } else if (descriptor.unit() == "mW") {
                value.f /= 1000.00;
            }
            emit activePowerReceived(value.f);
        } else if (type == ModbusRegisterType::PowerFactor) {
            emit powerFactorReceived(value.f);
        } else if (type == ModbusRegisterType::Frequency) {
            emit frequencyReceived(value.f);
        } else if (type == ModbusRegisterType::EnergyConsumed) {
            if (descriptor.unit() == "Wh") {
                value.f /= 1000.00;
            }
            emit consumedEnergyReceived(value.f);
        } else if (type == ModbusRegisterType::EnergyProduced) {
            if (descriptor.unit() == "Wh") {
                value.f /= 1000.00;
            }
            emit producedEnergyReceived(value.f);
        } else {
            qCWarning(dcEnergyMeters()) << "EnergyMeter: Modbus register type not handled" << type;
        }
    });
    return true;
}