428 lines
17 KiB
C++
428 lines
17 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 "sunspec.h"
|
|
#include "extern-plugininfo.h"
|
|
#include <QtEndian>
|
|
|
|
SunSpec::SunSpec(const QHostAddress &hostAddress, uint port, uint slaveId, QObject *parent) :
|
|
QObject(parent),
|
|
m_hostAddress(hostAddress),
|
|
m_port(port),
|
|
m_slaveId(slaveId)
|
|
{
|
|
qCDebug(dcSunSpec()) << "SunSpec: Creating SunSpec connection";
|
|
m_modbusTcpClient = new QModbusTcpClient(this);
|
|
m_modbusTcpClient->setConnectionParameter(QModbusDevice::NetworkPortParameter, m_port);
|
|
m_modbusTcpClient->setConnectionParameter(QModbusDevice::NetworkAddressParameter, m_hostAddress.toString());
|
|
m_modbusTcpClient->setTimeout(2000);
|
|
m_modbusTcpClient->setNumberOfRetries(3);
|
|
|
|
connect(m_modbusTcpClient, &QModbusTcpClient::stateChanged, this, &SunSpec::onModbusStateChanged);
|
|
}
|
|
|
|
SunSpec::~SunSpec()
|
|
{
|
|
qCDebug(dcSunSpec()) << "SunSpec: Deleting SunSpec connection";
|
|
}
|
|
|
|
bool SunSpec::connectModbus()
|
|
{
|
|
qCDebug(dcSunSpec()) << "SunSpec: Connect modbus";
|
|
return m_modbusTcpClient->connectDevice();
|
|
}
|
|
|
|
void SunSpec::setHostAddress(const QHostAddress &hostAddress)
|
|
{
|
|
if (m_hostAddress != hostAddress) {
|
|
qCDebug(dcSunSpec()) << "SunSpec: Set host address" << hostAddress.toString();
|
|
m_hostAddress = hostAddress;
|
|
m_modbusTcpClient->setConnectionParameter(QModbusDevice::NetworkAddressParameter, m_hostAddress.toString());
|
|
}
|
|
}
|
|
|
|
void SunSpec::setPort(uint port)
|
|
{
|
|
if (port != m_port) {
|
|
qCDebug(dcSunSpec()) << "SunSpec: Set Port" << port;
|
|
m_port = port;
|
|
m_modbusTcpClient->setConnectionParameter(QModbusDevice::NetworkPortParameter, port);
|
|
}
|
|
}
|
|
|
|
void SunSpec::setSlaveId(uint slaveId)
|
|
{
|
|
qCDebug(dcSunSpec()) << "SunSpec: Set slave id" << slaveId;
|
|
m_slaveId = slaveId;
|
|
}
|
|
|
|
void SunSpec::setTimeout(uint milliSeconds)
|
|
{
|
|
qCDebug(dcSunSpec()) << "SunSpec: Set timeout" << milliSeconds << "[ms]";
|
|
m_modbusTcpClient->setTimeout(milliSeconds);
|
|
}
|
|
|
|
void SunSpec::setNumberOfRetries(uint retries)
|
|
{
|
|
qCDebug(dcSunSpec()) << "SunSpec: Set number of retries" << retries;
|
|
m_modbusTcpClient->setNumberOfRetries(retries);
|
|
}
|
|
|
|
QHostAddress SunSpec::hostAddress() const
|
|
{
|
|
return m_hostAddress;
|
|
}
|
|
|
|
uint SunSpec::port()
|
|
{
|
|
return m_port;
|
|
}
|
|
|
|
uint SunSpec::slaveId()
|
|
{
|
|
return m_slaveId;
|
|
}
|
|
|
|
QString SunSpec::manufacturer()
|
|
{
|
|
return m_manufacturer;
|
|
}
|
|
|
|
QString SunSpec::deviceModel()
|
|
{
|
|
return m_deviceModel;
|
|
}
|
|
|
|
QString SunSpec::serialNumber()
|
|
{
|
|
return m_serialNumber;
|
|
}
|
|
|
|
void SunSpec::findBaseRegister()
|
|
{
|
|
qCDebug(dcSunSpec()) << "SunSpec: Find base register";
|
|
QList<int> validBaseRegisters;
|
|
validBaseRegisters.append(0);
|
|
validBaseRegisters.append(40000);
|
|
validBaseRegisters.append(50000);
|
|
|
|
Q_FOREACH (int baseRegister, validBaseRegisters) {
|
|
qCDebug(dcSunSpec()) << " - Searching address" << baseRegister;
|
|
QModbusDataUnit request = QModbusDataUnit(QModbusDataUnit::RegisterType::HoldingRegisters, baseRegister, 2);
|
|
if (QModbusReply *reply = m_modbusTcpClient->sendReadRequest(request, m_slaveId)) {
|
|
if (!reply->isFinished()) {
|
|
connect(reply, &QModbusReply::finished, reply, &QModbusReply::deleteLater);
|
|
connect(reply, &QModbusReply::finished, this, [reply, baseRegister, this] {
|
|
|
|
if (reply->error() == QModbusDevice::NoError) {
|
|
const QModbusDataUnit unit = reply->result();
|
|
if ((unit.value(0) << 16 | unit.value(1)) == 0x53756e53) {
|
|
//Well-known value. Uniquely identifies this as a SunSpec Modbus model
|
|
qCDebug(dcSunSpec()) << "SunSpec: Found start of modbus model" << baseRegister;
|
|
m_baseRegister = baseRegister;
|
|
emit foundBaseRegister(baseRegister);
|
|
} else {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Got reply on base register" << baseRegister << ", but value didn't mach 0x53756e53";
|
|
}
|
|
} else {
|
|
qCDebug(dcSunSpec()) << "SunSpec: Find base register not found at:" << baseRegister;
|
|
}
|
|
});
|
|
} else {
|
|
delete reply; // broadcast replies return immediately
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void SunSpec::findSunSpecModels(const QList<ModelId> &ids, uint modbusAddressOffset)
|
|
{
|
|
qCDebug(dcSunSpec()) << "SunSpec: Find modbus model. Start register" << m_baseRegister+modbusAddressOffset;
|
|
QModbusDataUnit request = QModbusDataUnit(QModbusDataUnit::RegisterType::HoldingRegisters, m_baseRegister+modbusAddressOffset, 2);
|
|
|
|
if (QModbusReply *reply = m_modbusTcpClient->sendReadRequest(request, m_slaveId)) {
|
|
if (!reply->isFinished()) {
|
|
connect(reply, &QModbusReply::finished, reply, &QModbusReply::deleteLater);
|
|
connect(reply, &QModbusReply::finished, this, [ids, reply, this] {
|
|
|
|
if (reply->error() == QModbusDevice::NoError) {
|
|
const QModbusDataUnit unit = reply->result();
|
|
uint modbusAddress = unit.startAddress();
|
|
ModelId modelId = ModelId(unit.value(0));
|
|
int modelLength = unit.value(1);
|
|
if (modelId == ModelIdEnd) {
|
|
qCDebug(dcSunSpec()) << "SunSpec: Model Id End";
|
|
sunspecModelSearchFinished(m_modelList);
|
|
return;
|
|
}
|
|
|
|
if (ids.isEmpty() || ids.contains(modelId)) {
|
|
// If ids is empty then emit all models
|
|
qCDebug(dcSunSpec()) << "SunSpec: Found model" << ModelId(modelId) << "with length" << modelLength;
|
|
m_modelList.insert(ModelId(modelId), modbusAddress);
|
|
foundSunSpecModel(ModelId(modelId), modbusAddress);
|
|
}
|
|
findSunSpecModels(ids, modbusAddress+2+modelLength-m_baseRegister); //read next model
|
|
} else {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Find modbus model, read response error:" << reply->error();
|
|
}
|
|
});
|
|
} else {
|
|
delete reply; // broadcast replies return immediately
|
|
return;
|
|
}
|
|
} else {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Read error: " << m_modbusTcpClient->errorString();
|
|
return;
|
|
}
|
|
}
|
|
|
|
void SunSpec::readModelHeader(uint modbusAddress)
|
|
{
|
|
qCDebug(dcSunSpec()) << "SunSpec: Read model header, modbus address:" << modbusAddress << "Slave ID" << m_slaveId;
|
|
if (modbusAddress == 0 || modbusAddress == 40000 || modbusAddress == 50000)
|
|
modbusAddress += 2;
|
|
|
|
QModbusDataUnit request = QModbusDataUnit(QModbusDataUnit::RegisterType::HoldingRegisters, modbusAddress, 2);
|
|
|
|
if (QModbusReply *reply = m_modbusTcpClient->sendReadRequest(request, m_slaveId)) {
|
|
if (!reply->isFinished()) {
|
|
connect(reply, &QModbusReply::finished, reply, &QModbusReply::deleteLater);
|
|
connect(reply, &QModbusReply::finished, this, [reply, this] {
|
|
|
|
if (reply->error() == QModbusDevice::NoError) {
|
|
const QModbusDataUnit unit = reply->result();
|
|
uint modbusAddress = unit.startAddress();
|
|
ModelId modelId = ModelId(unit.value(0));
|
|
int length = unit.value(1);
|
|
qCDebug(dcSunSpec()) << "SunSpec: Received model header response. Model ID:" << modelId << "length" << length;
|
|
modelHeaderReceived(modbusAddress, modelId, length);
|
|
} else {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Read model header response error:" << reply->error();
|
|
}
|
|
});
|
|
connect(reply, &QModbusReply::errorOccurred, this, [reply] (QModbusDevice::Error error) {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Read model header, modbus reply error:" << error;
|
|
reply->finished(); // To make sure it will be deleted
|
|
});
|
|
} else {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Read model header error: " << m_modbusTcpClient->errorString();
|
|
delete reply; // broadcast replies return immediately
|
|
return;
|
|
}
|
|
} else {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Read model header error: " << m_modbusTcpClient->errorString();
|
|
return;
|
|
}
|
|
}
|
|
|
|
void SunSpec::readModelDataBlock(uint modbusAddress, uint length)
|
|
{
|
|
qCDebug(dcSunSpec()) << "SunSpec: Read model, modbus address" << modbusAddress << "length" << length << ", Slave ID" << m_slaveId;
|
|
|
|
if (length > 125) { //Modbus register limit is 125
|
|
qCWarning(dcSunSpec()) << "SunSpec: Data block length is too long, max 125 register";
|
|
return;
|
|
}
|
|
|
|
QModbusDataUnit request = QModbusDataUnit(QModbusDataUnit::RegisterType::HoldingRegisters, modbusAddress, length+2);
|
|
|
|
if (QModbusReply *reply = m_modbusTcpClient->sendReadRequest(request, m_slaveId)) {
|
|
if (!reply->isFinished()) {
|
|
connect(reply, &QModbusReply::finished, reply, &QModbusReply::deleteLater);
|
|
connect(reply, &QModbusReply::finished, this, [reply, this] {
|
|
|
|
if (reply->error() == QModbusDevice::NoError) {
|
|
const QModbusDataUnit unit = reply->result();
|
|
uint modbusAddress = unit.startAddress();
|
|
ModelId modelId = ModelId(unit.value(0));
|
|
uint length = unit.value(1);
|
|
qCDebug(dcSunSpec()) << "SunSpec: Received model. Modbus address" << modbusAddress << "model ID" << modelId << "length" << length;
|
|
emit modelDataBlockReceived(modelId, length, unit.values().mid(2));
|
|
} else {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Read response error:" << reply->error();
|
|
}
|
|
});
|
|
connect(reply, &QModbusReply::errorOccurred, this, [reply] (QModbusDevice::Error error) {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Modbus reply error:" << error;
|
|
reply->finished(); // To make sure it will be deleted
|
|
});
|
|
} else {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Read error: " << m_modbusTcpClient->errorString();
|
|
delete reply; // broadcast replies return immediately
|
|
return;
|
|
}
|
|
} else {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Read error: " << m_modbusTcpClient->errorString();
|
|
return;
|
|
}
|
|
}
|
|
|
|
void SunSpec::readCommonModel()
|
|
{
|
|
qCDebug(dcSunSpec()) << "SunSpec: Read common model header. Modbus Address" << m_baseRegister+2 << ", Slave ID" << m_slaveId;
|
|
|
|
QModbusDataUnit request = QModbusDataUnit(QModbusDataUnit::RegisterType::HoldingRegisters, m_baseRegister+2, 66);
|
|
|
|
if (QModbusReply *reply = m_modbusTcpClient->sendReadRequest(request, m_slaveId)) {
|
|
if (!reply->isFinished()) {
|
|
connect(reply, &QModbusReply::finished, reply, &QModbusReply::deleteLater);
|
|
connect(reply, &QModbusReply::finished, this, [reply, this] {
|
|
|
|
if (reply->error() == QModbusDevice::NoError) {
|
|
const QModbusDataUnit unit = reply->result();
|
|
m_manufacturer = convertModbusRegisters(unit.values(), MandatoryRegistersModel1::Manufacturer, 16);
|
|
m_manufacturer.remove('\x00');
|
|
m_deviceModel = convertModbusRegisters(unit.values(), MandatoryRegistersModel1::Model, 16);
|
|
m_deviceModel.remove('\x00');
|
|
m_serialNumber = convertModbusRegisters(unit.values(), MandatoryRegistersModel1::SerialNumber, 16);
|
|
m_serialNumber.remove('\x00');
|
|
qCDebug(dcSunSpec()) << "SunSpec: Received common block response. Manufacturer" << m_manufacturer << "Model" << m_deviceModel << "Serial number" << m_serialNumber;
|
|
commonModelReceived(m_manufacturer, m_deviceModel, m_serialNumber);
|
|
} else {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Read common model, read response error:" << reply->error();
|
|
}
|
|
});
|
|
} else {
|
|
qCWarning(dcSunSpec()) << "Sunspec: Read common model read error: " << m_modbusTcpClient->errorString();
|
|
delete reply; // broadcast replies return immediately
|
|
return;
|
|
}
|
|
} else {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Read error: " << m_modbusTcpClient->errorString();
|
|
return;
|
|
}
|
|
}
|
|
|
|
QByteArray SunSpec::convertModbusRegister(const uint16_t &modbusData)
|
|
{
|
|
uint8_t data[2];
|
|
data[0] = modbusData >> 8;
|
|
data[1] = modbusData & 0xFF;
|
|
//qCDebug(dcSunSpec()) << (char)data[0] << (char)data[1];
|
|
return QByteArray().append((char)data[0]).append((char)data[1]);
|
|
}
|
|
|
|
QBitArray SunSpec::convertModbusRegisterBits(const uint16_t &modbusData)
|
|
{
|
|
QByteArray data = convertModbusRegister(modbusData);
|
|
QBitArray bits(data.count() * 8);
|
|
|
|
// Convert from QByteArray to QBitArray
|
|
for(int i = 0; i < data.count(); ++i) {
|
|
for(int b = 0; b < 8; b++) {
|
|
bits.setBit(i * 8 + b, data.at(i) & (1 << ( 7 - b)));
|
|
}
|
|
}
|
|
return bits;
|
|
}
|
|
|
|
QByteArray SunSpec::convertModbusRegisters(const QVector<quint16> &modbusData, int offset, int size)
|
|
{
|
|
QByteArray bytes;
|
|
for (int i = offset; i < offset + size; i++)
|
|
bytes.append(convertModbusRegister(modbusData[i]));
|
|
|
|
return bytes;
|
|
}
|
|
|
|
float SunSpec::convertToFloatWithSSF(quint32 rawValue, quint16 sunssf)
|
|
{
|
|
float value;
|
|
value = rawValue * pow(10, static_cast<qint16>(sunssf));
|
|
return value;
|
|
}
|
|
|
|
quint32 SunSpec::convertFromFloatWithSSF(float value, quint16 sunssf)
|
|
{
|
|
quint32 rawValue;
|
|
rawValue = value / pow(10, static_cast<qint16>(sunssf));
|
|
return rawValue;
|
|
}
|
|
|
|
float SunSpec::convertFloatValues(quint16 rawValue0, quint16 rawValue1)
|
|
{
|
|
suns_modbus_v32_t value;
|
|
value.u = (static_cast<uint32_t>(rawValue0) << 16) + rawValue1;
|
|
return value.f;
|
|
}
|
|
|
|
void SunSpec::onModbusStateChanged(QModbusDevice::State state)
|
|
{
|
|
bool connected = (state == QModbusDevice::ConnectedState);
|
|
if (!connected) {
|
|
//try to reconnect in 10 seconds
|
|
QTimer::singleShot(10000, m_modbusTcpClient, [this] {
|
|
if (m_modbusTcpClient->connectDevice()) {
|
|
qCDebug(dcSunSpec()) << "SunSpec: Could not reconnect";
|
|
}
|
|
});
|
|
}
|
|
emit connectionStateChanged(connected);
|
|
}
|
|
|
|
QUuid SunSpec::writeHoldingRegister(uint registerAddress, quint16 value)
|
|
{
|
|
return writeHoldingRegisters(registerAddress, QVector<quint16>() << value);
|
|
}
|
|
|
|
QUuid SunSpec::writeHoldingRegisters(uint registerAddress, const QVector<quint16> &values)
|
|
{
|
|
if (!m_modbusTcpClient) {
|
|
return "";
|
|
}
|
|
QUuid requestId = QUuid::createUuid();
|
|
QModbusDataUnit request = QModbusDataUnit(QModbusDataUnit::RegisterType::HoldingRegisters, registerAddress, values.length());
|
|
request.setValues(values);
|
|
|
|
if (QModbusReply *reply = m_modbusTcpClient->sendWriteRequest(request, m_slaveId)) {
|
|
if (!reply->isFinished()) {
|
|
connect(reply, &QModbusReply::finished, reply, &QModbusReply::deleteLater);
|
|
connect(reply, &QModbusReply::finished, this, [reply, requestId, this] {
|
|
|
|
if (reply->error() != QModbusDevice::NoError) {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Read response error:" << reply->error();
|
|
emit requestExecuted(requestId, false);
|
|
return;
|
|
}
|
|
emit requestExecuted(requestId, true);
|
|
});
|
|
} else {
|
|
delete reply; // broadcast replies return immediately
|
|
return "";
|
|
}
|
|
} else {
|
|
qCWarning(dcSunSpec()) << "SunSpec: Read error: " << m_modbusTcpClient->errorString();
|
|
return "";
|
|
}
|
|
return requestId;
|
|
}
|