/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright 2013 - 2025, nymea GmbH
* Contact: contact@nymea.io
*
* This fileDescriptor 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 .
*
* 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 "sunspecflowbatterymodel.h"
#include "sunspecconnection.h"
SunSpecFlowBatteryModelRepeatingBlock::SunSpecFlowBatteryModelRepeatingBlock(quint16 blockIndex, quint16 blockSize, quint16 modbusStartRegister, SunSpecFlowBatteryModel *parent) :
SunSpecModelRepeatingBlock(blockIndex, blockSize, modbusStartRegister, parent)
{
m_parentModel = parent;
m_byteOrder = parent->byteOrder();
initDataPoints();
}
QString SunSpecFlowBatteryModelRepeatingBlock::name() const
{
return "battery_string";
}
SunSpecFlowBatteryModel *SunSpecFlowBatteryModelRepeatingBlock::parentModel() const
{
return m_parentModel;
}
quint16 SunSpecFlowBatteryModelRepeatingBlock::batteryStringPointsToBeDetermined() const
{
return m_batteryStringPointsToBeDetermined;
}
void SunSpecFlowBatteryModelRepeatingBlock::initDataPoints()
{
SunSpecDataPoint batteryStringPointsToBeDeterminedDataPoint;
batteryStringPointsToBeDeterminedDataPoint.setName("BatStTBD");
batteryStringPointsToBeDeterminedDataPoint.setLabel("Battery String Points To Be Determined");
batteryStringPointsToBeDeterminedDataPoint.setMandatory(true);
batteryStringPointsToBeDeterminedDataPoint.setSize(1);
batteryStringPointsToBeDeterminedDataPoint.setAddressOffset(0);
batteryStringPointsToBeDeterminedDataPoint.setSunSpecDataType("uint16");
batteryStringPointsToBeDeterminedDataPoint.setByteOrder(m_byteOrder);
m_dataPoints.insert(batteryStringPointsToBeDeterminedDataPoint.name(), batteryStringPointsToBeDeterminedDataPoint);
}
void SunSpecFlowBatteryModelRepeatingBlock::processBlockData()
{
// Update properties according to the data point type
if (m_dataPoints.value("BatStTBD").isValid())
m_batteryStringPointsToBeDetermined = m_dataPoints.value("BatStTBD").toUInt16();
qCDebug(dcSunSpecModelData()) << this;
}
SunSpecFlowBatteryModel::SunSpecFlowBatteryModel(SunSpecConnection *connection, quint16 modbusStartRegister, quint16 modelLength, SunSpecDataPoint::ByteOrder byteOrder, QObject *parent) :
SunSpecModel(connection, modbusStartRegister, 806, modelLength, byteOrder, parent)
{
m_modelBlockType = SunSpecModel::ModelBlockTypeFixedAndRepeating;
initDataPoints();
connect(this, &SunSpecModel::initFinished, this, &SunSpecFlowBatteryModel::setupRepeatingBlocks);
}
SunSpecFlowBatteryModel::~SunSpecFlowBatteryModel()
{
}
QString SunSpecFlowBatteryModel::name() const
{
return "flow_battery";
}
QString SunSpecFlowBatteryModel::description() const
{
return QString();
}
QString SunSpecFlowBatteryModel::label() const
{
return "Flow Battery Model";
}
quint16 SunSpecFlowBatteryModel::batteryPointsToBeDetermined() const
{
return m_batteryPointsToBeDetermined;
}
void SunSpecFlowBatteryModel::initDataPoints()
{
SunSpecDataPoint modelIdDataPoint;
modelIdDataPoint.setName("ID");
modelIdDataPoint.setLabel("Model ID");
modelIdDataPoint.setDescription("Model identifier");
modelIdDataPoint.setMandatory(true);
modelIdDataPoint.setSize(1);
modelIdDataPoint.setAddressOffset(0);
modelIdDataPoint.setSunSpecDataType("uint16");
modelIdDataPoint.setByteOrder(m_byteOrder);
m_dataPoints.insert(modelIdDataPoint.name(), modelIdDataPoint);
SunSpecDataPoint modelLengthDataPoint;
modelLengthDataPoint.setName("L");
modelLengthDataPoint.setLabel("Model Length");
modelLengthDataPoint.setDescription("Model length");
modelLengthDataPoint.setMandatory(true);
modelLengthDataPoint.setSize(1);
modelLengthDataPoint.setAddressOffset(1);
modelLengthDataPoint.setSunSpecDataType("uint16");
modelLengthDataPoint.setByteOrder(m_byteOrder);
m_dataPoints.insert(modelLengthDataPoint.name(), modelLengthDataPoint);
SunSpecDataPoint batteryPointsToBeDeterminedDataPoint;
batteryPointsToBeDeterminedDataPoint.setName("BatTBD");
batteryPointsToBeDeterminedDataPoint.setLabel("Battery Points To Be Determined");
batteryPointsToBeDeterminedDataPoint.setMandatory(true);
batteryPointsToBeDeterminedDataPoint.setSize(1);
batteryPointsToBeDeterminedDataPoint.setAddressOffset(2);
batteryPointsToBeDeterminedDataPoint.setBlockOffset(0);
batteryPointsToBeDeterminedDataPoint.setSunSpecDataType("uint16");
batteryPointsToBeDeterminedDataPoint.setByteOrder(m_byteOrder);
m_dataPoints.insert(batteryPointsToBeDeterminedDataPoint.name(), batteryPointsToBeDeterminedDataPoint);
}
void SunSpecFlowBatteryModel::processBlockData()
{
// Update properties according to the data point type
if (m_dataPoints.value("BatTBD").isValid())
m_batteryPointsToBeDetermined = m_dataPoints.value("BatTBD").toUInt16();
qCDebug(dcSunSpecModelData()) << this;
}
void SunSpecFlowBatteryModel::setupRepeatingBlocks()
{
if (!m_repeatingBlocks.isEmpty()) {
foreach (SunSpecModelRepeatingBlock *block, m_repeatingBlocks) {
block->deleteLater();
}
m_repeatingBlocks.clear();
}
const auto headerLength = 2;
const auto repeatingBlocksDataSize = m_blockData.size() - headerLength - m_fixedBlockLength;
if (repeatingBlocksDataSize % m_repeatingBlockLength != 0) {
qCWarning(dcSunSpecModelData()) << "Unexpected repeating block data size:"
<< repeatingBlocksDataSize
<< "(repeating block size:"
<< m_repeatingBlockLength
<< ", extra bytes:"
<< repeatingBlocksDataSize % m_repeatingBlockLength
<< "). Repeating blocks will not be handled!";
return;
}
const auto numberOfBlocks = repeatingBlocksDataSize / m_repeatingBlockLength;
const auto repeatingBlocksOffset = m_fixedBlockLength + headerLength;
for (int i = 0; i < numberOfBlocks; ++i) {
const auto blockStartRegister = static_cast(modbusStartRegister() + repeatingBlocksOffset + m_repeatingBlockLength * i);
const auto block = new SunSpecFlowBatteryModelRepeatingBlock(i, m_repeatingBlockLength, blockStartRegister, this);
m_repeatingBlocks.append(block);
}
}
QDebug operator<<(QDebug debug, SunSpecFlowBatteryModel *model)
{
debug.nospace().noquote() << "SunSpecFlowBatteryModel(Model: " << model->modelId() << ", Register: " << model->modbusStartRegister() << ", Length: " << model->modelLength() << ")\n";
debug.nospace().noquote() << " - " << model->dataPoints().value("BatTBD") << "-->";
if (model->dataPoints().value("BatTBD").isValid()) {
debug.nospace().noquote() << model->batteryPointsToBeDetermined() << "\n";
} else {
debug.nospace().noquote() << "NaN\n";
}
return debug.space().quote();
}