summaryrefslogtreecommitdiffstats
path: root/src/serialbus/qmodbustcpclient.cpp
blob: 30a65e308e0ec215a27de31210a549ca9304be0a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtSerialBus module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qmodbustcpclient.h"
#include "qmodbustcpclient_p.h"

QT_BEGIN_NAMESPACE

/*!
    \class QModbusTcpClient
    \inmodule QtSerialBus
    \since 5.6

    \brief The QModbusTcpClient class is the interface class for Modbus TCP client device.

    QModbusTcpClient communicates with the Modbus backend providing users with a convenient API.
*/

/*!
    Constructs a QModbusTcpClient with the specified \a parent.
 */
QModbusTcpClient::QModbusTcpClient(QObject *parent)
    : QModbusClient(*new QModbusTcpClientPrivate, parent)
{
}

/*!
    Destroys the QModbusTcpClient instance.
*/
QModbusTcpClient::~QModbusTcpClient()
{
}

/*!
    \internal
*/
QModbusTcpClient::QModbusTcpClient(QModbusTcpClientPrivate &dd, QObject *parent)
    : QModbusClient(dd, parent)
{
}

/*!
    \fn void QModbusTcpClient::connectDevice(const QString &hostName, quint16 port = 502)

    Attempts to make a connection to \a hostName on the given \a port. If a connection is
    established, it emits stateChanged() with ModbusDeviceState::ConnectedState.

    At any point, the class can emit stateChanged() to signal the current device state or emit
    errorOccurred() to signal that an error occurred.

    \note \a hostName may be an IP address in string form (e.g., "43.195.83.32"), or it may be a
    host name (e.g., "example.com"). \a port is in native byte order and defaults to number 502.
*/

/*!
    \fn void QModbusTcpClient::connectDevice(const QHostAddress &address, quint16 port = 502)

    \overload

    Attempts to make a connection to \a address on port \a port.
*/

/*
    TODO: implement
*/
QModbusReplyEx *QModbusTcpClient::sendReadRequest(const QModbusDataUnit &read, int slaveAddress)
{
    Q_UNUSED(read)
    Q_UNUSED(slaveAddress)
    return Q_NULLPTR;
}

QModbusReplyEx *QModbusTcpClient::sendWriteRequest(const QModbusDataUnit &write, int slaveAddress)
{
    Q_UNUSED(write)
    Q_UNUSED(slaveAddress)
    return Q_NULLPTR;
}

QModbusReplyEx *QModbusTcpClient::sendReadWriteRequest(const QModbusDataUnit &read,
                                                       const QModbusDataUnit &write, int slaveAddress)
{
    Q_UNUSED(read)
    Q_UNUSED(write)
    Q_UNUSED(slaveAddress)
    return Q_NULLPTR;
}

QT_END_NAMESPACE