qmodbusdevice.h - mozsearch

Enable keyboard shortcuts

// Copyright (C) 2017 The Qt Company Ltd.

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

// Qt-Security score:significant reason:default

#ifndef QMODBUSDEVICE_H

#define QMODBUSDEVICE_H

#include <QtCore/qobject.h>

#include <QtCore/qiodevice.h>

#include <QtSerialBus/qtserialbusglobal.h>

QT_BEGIN_NAMESPACE

class QModbusDevicePrivate;

class Q_SERIALBUS_EXPORT QModbusDevice : public QObject

    Q_OBJECT

    Q_DECLARE_PRIVATE(QModbusDevice)

public:

    enum Error {

        NoError,

        ReadError,

        WriteError,

        ConnectionError,

        ConfigurationError,

        TimeoutError,

        ProtocolError,

        ReplyAbortedError,

        UnknownError,

        InvalidResponseError

};

    Q_ENUM(Error)

    enum State {

        UnconnectedState,

        ConnectingState,

        ConnectedState,

        ClosingState

};

    Q_ENUM(State)

    enum ConnectionParameter {

        SerialPortNameParameter,

        SerialParityParameter,

        SerialBaudRateParameter,

        SerialDataBitsParameter,

        SerialStopBitsParameter,

        NetworkPortParameter,

        NetworkAddressParameter

};

    Q_ENUM(ConnectionParameter)

    enum IntermediateError

        ResponseCrcError,

        ResponseRequestMismatch

};

    Q_ENUM(IntermediateError)

    explicit QModbusDevice(QObject *parent = nullptr);

    ~QModbusDevice();

    QVariant connectionParameter(ConnectionParameter parameter) const;

    void setConnectionParameter(ConnectionParameter parameter, const QVariant &value);

    bool connectDevice();

    void disconnectDevice();

    State state() const;

    Error error() const;

    QString errorString() const;

    QIODevice *device() const;

Q_SIGNALS:

    void errorOccurred(QModbusDevice::Error error);

    void stateChanged(QModbusDevice::State state);

protected:

    QModbusDevice(QModbusDevicePrivate &dd, QObject *parent = nullptr);

    void setState(QModbusDevice::State newState);

    void setError(const QString &errorText, QModbusDevice::Error error);

    virtual bool open() = 0;

    virtual void close() = 0;

};

Q_DECLARE_TYPEINFO(QModbusDevice::Error, Q_PRIMITIVE_TYPE);

Q_DECLARE_TYPEINFO(QModbusDevice::State, Q_PRIMITIVE_TYPE);

Q_DECLARE_TYPEINFO(QModbusDevice::ConnectionParameter, Q_PRIMITIVE_TYPE);

Q_DECLARE_TYPEINFO(QModbusDevice::IntermediateError, Q_PRIMITIVE_TYPE);

QT_END_NAMESPACE

#endif // QMODBUSDEVICE_H