blob: d3845647a40e5c74105c8b336532110235e18812 (
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtSerialBus module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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.LGPL3 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-3.0.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 (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qmodbusrtuserialclient.h"
#include "qmodbusrtuserialclient_p.h"
#include <QtCore/qloggingcategory.h>
QT_BEGIN_NAMESPACE
Q_DECLARE_LOGGING_CATEGORY(QT_MODBUS)
Q_DECLARE_LOGGING_CATEGORY(QT_MODBUS_LOW)
/*!
\class QModbusRtuSerialClient
\inmodule QtSerialBus
\since 6.2
\brief The QModbusRtuSerialClient class represents a Modbus client
that uses a serial bus for its communication with the Modbus server.
Communication via Modbus requires the interaction between a single
Modbus client instance and multiple Modbus servers. This class
provides the client implementation via a serial port.
*/
/*!
Constructs a serial Modbus client with the specified \a parent.
*/
QModbusRtuSerialClient::QModbusRtuSerialClient(QObject *parent)
: QModbusClient(*new QModbusRtuSerialClientPrivate, parent)
{
Q_D(QModbusRtuSerialClient);
d->setupSerialPort();
}
/*!
\internal
*/
QModbusRtuSerialClient::~QModbusRtuSerialClient()
{
close();
}
/*!
Returns the amount of microseconds for the silent interval between two
consecutive Modbus messages.
\sa setInterFrameDelay()
*/
int QModbusRtuSerialClient::interFrameDelay() const
{
Q_D(const QModbusRtuSerialClient);
return d->m_interFrameDelayMilliseconds * 1000;
}
/*!
Sets the amount of \a microseconds for the silent interval between two
consecutive Modbus messages. By default, the class implementation will use
a pre-calculated value according to the Modbus specification. A active or
running connection is not affected by such delay changes.
\note If \a microseconds is set to -1 or \a microseconds is less than the
pre-calculated delay then this pre-calculated value is used as frame delay.
*/
void QModbusRtuSerialClient::setInterFrameDelay(int microseconds)
{
Q_D(QModbusRtuSerialClient);
d->m_interFrameDelayMilliseconds = qCeil(qreal(microseconds) / 1000.);
d->calculateInterFrameDelay();
}
/*!
\since 5.13
Returns the amount of milliseconds for the silent interval between a Modbus
broadcast and a consecutive Modbus messages. The default value is set to
\c 100 milliseconds.
*/
int QModbusRtuSerialClient::turnaroundDelay() const
{
Q_D(const QModbusRtuSerialClient);
return d->m_turnaroundDelay;
}
/*!
\since 5.13
Sets the amount of milliseconds for the silent interval between a Modbus
broadcast and a consecutive Modbus messages to \a turnaroundDelay.
Typically the turnaround delay is in the range of \c 100 to \c 200
milliseconds.
*/
void QModbusRtuSerialClient::setTurnaroundDelay(int turnaroundDelay)
{
Q_D(QModbusRtuSerialClient);
d->m_turnaroundDelay = turnaroundDelay;
}
/*!
\internal
*/
QModbusRtuSerialClient::QModbusRtuSerialClient(QModbusRtuSerialClientPrivate &dd, QObject *parent)
: QModbusClient(dd, parent)
{
Q_D(QModbusRtuSerialClient);
d->setupSerialPort();
}
/*!
\reimp
\note When calling this function, existing buffered data is removed from
the serial port.
*/
bool QModbusRtuSerialClient::open()
{
if (state() == QModbusDevice::ConnectedState)
return true;
Q_D(QModbusRtuSerialClient);
d->setupEnvironment(); // to be done before open
if (d->m_serialPort->open(QIODevice::ReadWrite)) {
setState(QModbusDevice::ConnectedState);
d->m_serialPort->clear(); // only possible after open
} else {
setError(d->m_serialPort->errorString(), QModbusDevice::ConnectionError);
}
return (state() == QModbusDevice::ConnectedState);
}
/*!
\reimp
*/
void QModbusRtuSerialClient::close()
{
if (state() == QModbusDevice::UnconnectedState)
return;
setState(QModbusDevice::ClosingState);
Q_D(QModbusRtuSerialClient);
if (d->m_serialPort->isOpen())
d->m_serialPort->close();
int numberOfAborts = 0;
while (!d->m_queue.isEmpty()) {
// Finish each open reply and forget them
QModbusRtuSerialClientPrivate::QueueElement elem = d->m_queue.dequeue();
if (!elem.reply.isNull()) {
elem.reply->setError(QModbusDevice::ReplyAbortedError,
QModbusClient::tr("Reply aborted due to connection closure."));
numberOfAborts++;
}
}
if (numberOfAborts > 0)
qCDebug(QT_MODBUS_LOW) << "(RTU client) Aborted replies:" << numberOfAborts;
setState(QModbusDevice::UnconnectedState);
}
QT_END_NAMESPACE
#include "moc_qmodbusrtuserialclient.cpp"
|
