nymea-plugins-modbus/sunspec/solaredgebattery.cpp

271 lines
15 KiB
C++

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright 2013 - 2020, 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 "solaredgebattery.h"
#include "extern-plugininfo.h"
#include <sunspecdatapoint.h>
#include <sunspecconnection.h>
SolarEdgeBattery::SolarEdgeBattery(Thing *thing, SunSpecConnection *connection, int modbusStartRegister, QObject *parent) :
SunSpecThing(thing, nullptr, parent),
m_connection(connection),
m_modbusStartRegister(modbusStartRegister)
{
m_timer.setSingleShot(true);
m_timer.setInterval(10000);
connect(&m_timer, &QTimer::timeout, this, [this](){
if (!m_initFinishedSuccess) {
emit initFinished(false);
}
});
}
SunSpecConnection *SolarEdgeBattery::connection() const
{
return m_connection;
}
quint16 SolarEdgeBattery::modbusStartRegister() const
{
return m_modbusStartRegister;
}
SolarEdgeBattery::BatteryData SolarEdgeBattery::batteryData() const
{
return m_batteryData;
}
void SolarEdgeBattery::init()
{
qCDebug(dcSunSpec()) << "Initializing battery on" << m_modbusStartRegister;
m_initFinishedSuccess = false;
readBlockData();
m_timer.start();
}
void SolarEdgeBattery::readBlockData()
{
// Read the data in 2 block requests
qCDebug(dcSunSpec()) << "SolarEdgeBattery: Read block 1 from modbus address" << m_modbusStartRegister << "length" << 107<< ", Slave ID" << m_connection->slaveId();
// Total possible block size is 0xE19A - 0xE100 = 0x9A = 153 registers
// First block request 0x00 - 0x4C
QModbusDataUnit request = QModbusDataUnit(QModbusDataUnit::RegisterType::HoldingRegisters, m_modbusStartRegister, 0x4C);
if (QModbusReply *reply = m_connection->modbusTcpClient()->sendReadRequest(request, m_connection->slaveId())) {
if (!reply->isFinished()) {
connect(reply, &QModbusReply::finished, reply, &QModbusReply::deleteLater);
connect(reply, &QModbusReply::finished, this, [=]() {
if (reply->error() != QModbusDevice::NoError) {
qCWarning(dcSunSpec()) << "SolarEdgeBattery: Read response error:" << reply->error();
return;
}
const QModbusDataUnit unit = reply->result();
QVector<quint16> values = unit.values();
qCDebug(dcSunSpec()) << "SolarEdgeBattery: Received first block data" << m_modbusStartRegister << values.count();
qCDebug(dcSunSpec()) << SunSpecDataPoint::registersToString(values);
m_batteryData.manufacturerName = SunSpecDataPoint::convertToString(values.mid(ManufacturerName, 16));
m_batteryData.model = SunSpecDataPoint::convertToString(values.mid(Model, 16));
m_batteryData.firmwareVersion = SunSpecDataPoint::convertToString(values.mid(FirmwareVersion, 16));
m_batteryData.serialNumber = SunSpecDataPoint::convertToString(values.mid(SerialNumber, 16));
m_batteryData.batteryDeviceId = values[BatteryDeviceId];
// 8192 17945 536888857 536888857 1.08652e-19
// 0x2000 0x4619
qCDebug(dcSunSpec()) << "SolarEdgeBattery: " << m_batteryData.batteryDeviceId << m_batteryData.manufacturerName << m_batteryData.model << m_batteryData.firmwareVersion << m_batteryData.serialNumber;
m_batteryData.ratedEnergy = SunSpecDataPoint::convertToFloat32(values.mid(RatedEnergy, 2));
m_batteryData.maxChargeContinuesPower = SunSpecDataPoint::convertToFloat32(values.mid(MaxChargeContinuesPower, 2));
m_batteryData.maxDischargeContinuesPower = SunSpecDataPoint::convertToFloat32(values.mid(MaxDischargeContinuesPower, 2));
m_batteryData.maxChargePeakPower = SunSpecDataPoint::convertToFloat32(values.mid(MaxChargePeakPower, 2));
m_batteryData.maxDischargePeakPower = SunSpecDataPoint::convertToFloat32(values.mid(MaxDischargePeakPower, 2));
// Read from 0x6c to 0x86
int offset = 0x6c;
QModbusDataUnit request = QModbusDataUnit(QModbusDataUnit::RegisterType::HoldingRegisters, m_modbusStartRegister + offset, 28);
if (QModbusReply *reply = m_connection->modbusTcpClient()->sendReadRequest(request, m_connection->slaveId())) {
if (!reply->isFinished()) {
connect(reply, &QModbusReply::finished, reply, &QModbusReply::deleteLater);
connect(reply, &QModbusReply::finished, this, [=]() {
if (reply->error() != QModbusDevice::NoError) {
qCWarning(dcSunSpec()) << "SolarEdgeBattery: Read response error:" << reply->error();
return;
}
const QModbusDataUnit unit = reply->result();
QVector<quint16> values = unit.values();
qCDebug(dcSunSpec()) << "SolarEdgeBattery: Received second block data" << m_modbusStartRegister + offset << values.count();
qCDebug(dcSunSpec()) << SunSpecDataPoint::registersToString(values);
QVector<quint16> valueRegisters;
valueRegisters = values.mid(BatteryAverageTemperature - offset, 2);
m_batteryData.averageTemperature = SunSpecDataPoint::convertToFloat32(valueRegisters);
qCDebug(dcSunSpec()) << "SolarEdgeBattery: Average temperature:" << SunSpecDataPoint::registersToString(valueRegisters) << m_batteryData.averageTemperature;
m_batteryData.maxTemperature = SunSpecDataPoint::convertToFloat32(values.mid(BatteryMaxTemperature - offset, 2));
m_batteryData.instantaneousVoltage = SunSpecDataPoint::convertToFloat32(values.mid(InstantaneousVoltage - offset, 2));
m_batteryData.instantaneousCurrent = SunSpecDataPoint::convertToFloat32(values.mid(InstantaneousCurrent - offset, 2));
m_batteryData.instantaneousPower = SunSpecDataPoint::convertToFloat32(values.mid(InstantaneousPower - offset, 2));
m_batteryData.maxEnergy = SunSpecDataPoint::convertToFloat32(values.mid(MaxEnergy - offset, 2));
valueRegisters = values.mid(AvailableEnergy - offset, 2);
m_batteryData.availableEnergy = SunSpecDataPoint::convertToFloat32(valueRegisters);
qCDebug(dcSunSpec()) << "SolarEdgeBattery: Available energy:" << (AvailableEnergy - offset) << SunSpecDataPoint::registersToString(valueRegisters) << m_batteryData.availableEnergy;
m_batteryData.stateOfHealth = SunSpecDataPoint::convertToFloat32(values.mid(StateOfHealth - offset, 2));
m_batteryData.stateOfEnergy = SunSpecDataPoint::convertToFloat32(values.mid(StateOfEnergy - offset, 2));
m_batteryData.batteryStatus = static_cast<BatteryStatus>(SunSpecDataPoint::convertToUInt32(values.mid(Status - offset, 2)));
if (!m_initFinishedSuccess) {
m_timer.stop();
m_initFinishedSuccess = true;
emit initFinished(true);
}
onBlockDataUpdated();
});
connect(reply, &QModbusReply::errorOccurred, this, [reply] (QModbusDevice::Error error) {
qCWarning(dcSunSpec()) << "SolarEdgeBattery: Modbus reply error:" << error;
emit reply->finished(); // To make sure it will be deleted
});
} else {
qCWarning(dcSunSpec()) << "SolarEdgeBattery: Read error: " << m_connection->modbusTcpClient()->errorString();
delete reply; // broadcast replies return immediately
return;
}
} else {
qCWarning(dcSunSpec()) << "SolarEdgeBattery: Read error: " << m_connection->modbusTcpClient()->errorString();
return;
}
});
connect(reply, &QModbusReply::errorOccurred, this, [reply] (QModbusDevice::Error error) {
qCWarning(dcSunSpec()) << "SolarEdgeBattery: Modbus reply error:" << error;
emit reply->finished(); // To make sure it will be deleted
});
} else {
qCWarning(dcSunSpec()) << "SolarEdgeBattery: Read error: " << m_connection->modbusTcpClient()->errorString();
delete reply; // broadcast replies return immediately
return;
}
} else {
qCWarning(dcSunSpec()) << "SolarEdgeBattery: Read error: " << m_connection->modbusTcpClient()->errorString();
return;
}
}
void SolarEdgeBattery::onBlockDataUpdated()
{
qCDebug(dcSunSpec()) << "SolarEdgeBattery: block updated:" << m_batteryData;
if (!m_thing)
return;
QString chargingState = "idle";
switch (m_batteryData.batteryStatus) {
case SolarEdgeBattery::Off:
chargingState = "idle";
m_thing->setStateValue(solarEdgeBatteryBatteryStatusStateTypeId, "Off");
break;
case SolarEdgeBattery::Standby:
chargingState = "idle";
m_thing->setStateValue(solarEdgeBatteryBatteryStatusStateTypeId, "Standby");
break;
case SolarEdgeBattery::Init:
chargingState = "idle";
m_thing->setStateValue(solarEdgeBatteryBatteryStatusStateTypeId, "Init");
break;
case SolarEdgeBattery::Charge:
chargingState = "charging";
m_thing->setStateValue(solarEdgeBatteryBatteryStatusStateTypeId, "Charging");
break;
case SolarEdgeBattery::Discharge:
chargingState = "discharging";
m_thing->setStateValue(solarEdgeBatteryBatteryStatusStateTypeId, "Discharging");
break;
case SolarEdgeBattery::Fault:
chargingState = "idle";
m_thing->setStateValue(solarEdgeBatteryBatteryStatusStateTypeId, "Fault");
break;
case SolarEdgeBattery::Holding:
chargingState = "idle";
m_thing->setStateValue(solarEdgeBatteryBatteryStatusStateTypeId, "Holding");
break;
case SolarEdgeBattery::Idle:
chargingState = "idle";
m_thing->setStateValue(solarEdgeBatteryBatteryStatusStateTypeId, "Idle");
break;
}
m_thing->setStateValue(solarEdgeBatteryBatteryCriticalStateTypeId, (m_batteryData.stateOfEnergy < 5) && chargingState != "charging");
m_thing->setStateValue(solarEdgeBatteryBatteryLevelStateTypeId, m_batteryData.stateOfEnergy);
m_thing->setStateValue(solarEdgeBatteryChargingStateStateTypeId, chargingState);
m_thing->setStateValue(solarEdgeBatteryRatedEnergyStateTypeId, m_batteryData.ratedEnergy);
m_thing->setStateValue(solarEdgeBatteryAverageTemperatureStateTypeId, m_batteryData.averageTemperature);
m_thing->setStateValue(solarEdgeBatteryInstantaneousVoltageStateTypeId, m_batteryData.instantaneousVoltage);
m_thing->setStateValue(solarEdgeBatteryInstantaneousCurrentStateTypeId, m_batteryData.instantaneousCurrent);
m_thing->setStateValue(solarEdgeBatteryCurrentPowerStateTypeId, m_batteryData.instantaneousPower);
m_thing->setStateValue(solarEdgeBatteryMaxEnergyStateTypeId, m_batteryData.maxEnergy);
m_thing->setStateValue(solarEdgeBatteryCapacityStateTypeId, m_batteryData.availableEnergy);
m_thing->setStateValue(solarEdgeBatteryStateOfHealthStateTypeId, m_batteryData.stateOfHealth);
m_thing->setStateValue(solarEdgeBatteryVersionStateTypeId, m_batteryData.firmwareVersion);
}
QDebug operator<<(QDebug debug, const SolarEdgeBattery::BatteryData &batteryData)
{
debug << "SolarEdgeBatteryData(" << batteryData.manufacturerName << "-" << batteryData.model << ")" << endl;
debug << " - Battery Device ID" << batteryData.batteryDeviceId << endl;
debug << " - Firmware version" << batteryData.firmwareVersion << endl;
debug << " - Serial number" << batteryData.serialNumber << endl;
debug << " - Rated Energy" << batteryData.ratedEnergy << "W * H" << endl;
debug << " - Max charging continues power" << batteryData.maxChargeContinuesPower << "W" << endl;
debug << " - Max discharging continues power" << batteryData.maxDischargeContinuesPower << "W" << endl;
debug << " - Max charging peak power" << batteryData.maxChargePeakPower << "W" << endl;
debug << " - Max discharging peak power" << batteryData.maxDischargePeakPower << "W" << endl;
debug << " - Average temperature" << batteryData.averageTemperature << "°C" << endl;
debug << " - Max temperature" << batteryData.maxTemperature << "°C" << endl;
debug << " - Instantuouse Voltage" << batteryData.instantaneousVoltage << "V" << endl;
debug << " - Instantuouse Current" << batteryData.instantaneousCurrent << "A" << endl;
debug << " - Instantuouse Power" << batteryData.instantaneousPower << "W" << endl;
debug << " - Max energy" << batteryData.maxEnergy << "W" << endl;
debug << " - Available energy" << batteryData.availableEnergy << "W" << endl;
debug << " - State of health" << batteryData.stateOfHealth << "%" << endl;
debug << " - State of energy" << batteryData.stateOfEnergy << "%" << endl;
debug << " - Battery status" << batteryData.batteryStatus << endl;
return debug;
}