summaryrefslogtreecommitdiffstats
path: root/src/serialbus/qmodbusrtuserialmaster.cpp
blob: 51b9f2397ee7136e79a050d2e19b1d14cd9ed495 (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
/****************************************************************************
**
** 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 "qmodbusrtuserialmaster.h"
#include "qmodbusrtuserialmaster_p.h"

#include <QtSerialBus/qmodbus.h>

QT_BEGIN_NAMESPACE

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

    \brief The QModbusRtuSerialMaster 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 server implementation via a serial port.
*/

/*!
    Constructs a serial Modbus master with the specified \a parent.
 */
QModbusRtuSerialMaster::QModbusRtuSerialMaster(QObject *parent)
    : QModbusClient(*new QModbusRtuSerialMasterPrivate, parent)
{
    Q_D(QModbusRtuSerialMaster);
    d->setupMaster();
}

/*!
    \internal
 */
QModbusRtuSerialMaster::~QModbusRtuSerialMaster()
{
}

/*!
    Connects the Modbus master to a serial port. \a deviceName
    represents the serial port to which the Modbus servers are connected.

    The function returns \c true on success; otherwise \c false.

    \sa disconnectDevice()
 */
bool QModbusRtuSerialMaster::connectDevice(const QString &deviceName)
{
    Q_D(QModbusRtuSerialMaster);

    if (!d->pluginMaster)
        return false;

    // TODO remove setPortName() usage
    d->pluginMaster->setPortName(deviceName);

    // TODO Implement QModbusRtuSerialMaster::connectDevice(QString)

    return d->pluginMaster->connectDevice();
}

/*!
    \internal
*/
QModbusRtuSerialMaster::QModbusRtuSerialMaster(QModbusRtuSerialMasterPrivate &dd, QObject *parent)
    : QModbusClient(dd, parent)
{
    Q_D(QModbusRtuSerialMaster);
    d->setupMaster();
}

/*!
    \reimp
 */
bool QModbusRtuSerialMaster::open()
{
    // TODO remove later on
    // The function is not needed anymore as connectDevice(QString)
    // does not rely on it anymore.
    return false;
}

/*!
    \reimp
 */
void QModbusRtuSerialMaster::close()
{
    Q_D(QModbusRtuSerialMaster);

    if (!d->pluginMaster)
        return;

    d->pluginMaster->disconnectDevice();
}

// forward the state changes
void QModbusRtuSerialMasterPrivate::handleStateChanged(QModbusDevice::ModbusDeviceState state)
{
    Q_Q(QModbusRtuSerialMaster);
    q->setState(state);
}

// forward the error changes
void QModbusRtuSerialMasterPrivate::handleErrorOccurred(QModbusDevice::ModbusError error)
{
    Q_Q(QModbusRtuSerialMaster);
    q->setError(pluginMaster ? pluginMaster->errorString() : QString(), error);
}

/*!
    \reimp
 */
QModbusReply *QModbusRtuSerialMaster::write(const QModbusDataUnit &request, int slaveId)
{
    Q_D(QModbusRtuSerialMaster);

    if (!d->pluginMaster)
        return 0;

    return d->pluginMaster->write(request, slaveId);
}

/*!
    \reimp
 */
QModbusReply *QModbusRtuSerialMaster::read(const QModbusDataUnit &request, int slaveId)
{
    Q_D(QModbusRtuSerialMaster);

    if (!d->pluginMaster)
        return 0;

    return d->pluginMaster->read(request, slaveId);

}

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

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

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

#include "moc_qmodbusrtuserialmaster.cpp"

QT_END_NAMESPACE