nymea-plugins-modbus/libnymea-modbus/modbusdatautils.h

109 lines
4.1 KiB
C++

// SPDX-License-Identifier: LGPL-3.0-or-later
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright (C) 2013 - 2024, nymea GmbH
* Copyright (C) 2024 - 2025, chargebyte austria GmbH
*
* This file is part of libnymea-modbus.
*
* libnymea-modbus is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation, either version 3
* of the License, or (at your option) any later version.
*
* libnymea-modbus 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 libnymea-modbus. If not, see <https://www.gnu.org/licenses/>.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#ifndef MODBUSDATAUTILS_H
#define MODBUSDATAUTILS_H
#include <QVector>
#include <QObject>
#include <QModbusPdu>
#include <QMetaObject>
#include <QModbusDataUnit>
class ModbusDataUtils
{
Q_GADGET
public:
enum Access {
AccessReadOnly,
AccessWriteOnly,
AccessReadWrite
};
Q_ENUM(Access)
enum ByteOrder {
ByteOrderLittleEndian,
ByteOrderBigEndian
};
Q_ENUM(ByteOrder)
enum DataType {
UInt8,
UInt16,
Uint32,
Uint64,
Int8,
Int16,
Int32,
Int64,
Float,
Float64,
String,
Bool
};
Q_ENUM(DataType)
typedef struct ModbusRegister {
quint16 address;
quint16 size;
DataType dataType;
Access access;
QString description;
QString unit;
QVector<quint16> rawData;
} ModbusRegister;
typedef QVector<ModbusRegister> ModbusRegisters;
explicit ModbusDataUtils();
// Convert to
static quint16 convertToUInt16(const QVector<quint16> &registers);
static qint16 convertToInt16(const QVector<quint16> &registers);
static quint32 convertToUInt32(const QVector<quint16> &registers, ByteOrder byteOrder = ByteOrderLittleEndian);
static qint32 convertToInt32(const QVector<quint16> &registers, ByteOrder byteOrder = ByteOrderLittleEndian);
static quint64 convertToUInt64(const QVector<quint16> &registers, ByteOrder byteOrder = ByteOrderLittleEndian);
static qint64 convertToInt64(const QVector<quint16> &registers, ByteOrder byteOrder = ByteOrderLittleEndian);
static QString convertToString(const QVector<quint16> &registers, ByteOrder characterByteOrder = ByteOrderLittleEndian);
static QByteArray convertToByteArray(const QVector<quint16> &registers);
static float convertToFloat32(const QVector<quint16> &registers, ByteOrder byteOrder = ByteOrderLittleEndian);
static double convertToFloat64(const QVector<quint16> &registers, ByteOrder byteOrder = ByteOrderLittleEndian);
// Convert from
static QVector<quint16> convertFromUInt16(quint16 value);
static QVector<quint16> convertFromInt16(qint16 value);
static QVector<quint16> convertFromUInt32(quint32 value, ByteOrder byteOrder = ByteOrderLittleEndian);
static QVector<quint16> convertFromInt32(qint32 value, ByteOrder byteOrder = ByteOrderLittleEndian);
static QVector<quint16> convertFromUInt64(quint64 value, ByteOrder byteOrder = ByteOrderLittleEndian);
static QVector<quint16> convertFromInt64(qint64 value, ByteOrder byteOrder = ByteOrderLittleEndian);
static QVector<quint16> convertFromString(const QString &value, quint16 stringLength, ByteOrder characterByteOrder = ByteOrderLittleEndian);
static QVector<quint16> convertFromFloat32(float value, ByteOrder byteOrder = ByteOrderLittleEndian);
static QVector<quint16> convertFromFloat64(double value, ByteOrder byteOrder = ByteOrderLittleEndian);
static QString exceptionCodeToString(QModbusPdu::ExceptionCode exception);
static QString registerTypeToString(QModbusDataUnit::RegisterType registerType);
};
#endif // MODBUSDATAUTILS_H