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
|
/****************************************************************************
**
** 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$
**
****************************************************************************/
#ifndef QCANBUSDEVICE_H
#define QCANBUSDEVICE_H
#include <QtCore/qobject.h>
#include <QtSerialBus/qcanbusframe.h>
#include <QtSerialBus/qcanbusdeviceinfo.h>
QT_BEGIN_NAMESPACE
class QCanBusDevicePrivate;
class Q_SERIALBUS_EXPORT QCanBusDevice : public QObject
{
Q_OBJECT
Q_DECLARE_PRIVATE(QCanBusDevice)
Q_DISABLE_COPY(QCanBusDevice)
public:
enum CanBusError {
NoError,
ReadError,
WriteError,
ConnectionError,
ConfigurationError,
UnknownError
};
Q_ENUM(CanBusError)
enum CanBusDeviceState {
UnconnectedState,
ConnectingState,
ConnectedState,
ClosingState
};
Q_ENUM(CanBusDeviceState)
enum ConfigurationKey {
RawFilterKey = 0,
ErrorFilterKey,
LoopbackKey,
ReceiveOwnKey,
BitRateKey,
CanFdKey,
DataBitRateKey,
UserKey = 30
};
Q_ENUM(ConfigurationKey)
struct Filter
{
enum FormatFilter {
MatchBaseFormat = 0x0001,
MatchExtendedFormat = 0x0002,
MatchBaseAndExtendedFormat = 0x0003,
};
Q_DECLARE_FLAGS(FormatFilters, FormatFilter)
quint32 frameId = 0;
quint32 frameIdMask = 0;
QCanBusFrame::FrameType type = QCanBusFrame::InvalidFrame;
FormatFilter format = MatchBaseAndExtendedFormat;
};
explicit QCanBusDevice(QObject *parent = nullptr);
virtual void setConfigurationParameter(int key, const QVariant &value);
QVariant configurationParameter(int key) const;
QVector<int> configurationKeys() const;
virtual bool writeFrame(const QCanBusFrame &frame) = 0;
QCanBusFrame readFrame();
qint64 framesAvailable() const;
qint64 framesToWrite() const;
virtual bool waitForFramesWritten(int msecs);
virtual bool waitForFramesReceived(int msecs);
// TODO rename these once QIODevice dependency has been removed
bool connectDevice();
void disconnectDevice();
CanBusDeviceState state() const;
CanBusError error() const;
QString errorString() const;
virtual QString interpretErrorFrame(const QCanBusFrame &errorFrame) = 0;
Q_SIGNALS:
void errorOccurred(QCanBusDevice::CanBusError);
void framesReceived();
void framesWritten(qint64 framesCount);
void stateChanged(QCanBusDevice::CanBusDeviceState state);
protected:
void setState(QCanBusDevice::CanBusDeviceState newState);
void setError(const QString &errorText, QCanBusDevice::CanBusError);
void enqueueReceivedFrames(const QVector<QCanBusFrame> &newFrames);
void enqueueOutgoingFrame(const QCanBusFrame &newFrame);
QCanBusFrame dequeueOutgoingFrame();
bool hasOutgoingFrames() const;
// TODO Remove once official plugin system is gone
// Can be folded into one call to connectDevice() & disconnectDevice()
virtual bool open() = 0;
virtual void close() = 0;
static QCanBusDeviceInfo createDeviceInfo(const QString &name,
bool isVirtual = false,
bool isFlexibleDataRateCapable = false);
};
Q_DECLARE_TYPEINFO(QCanBusDevice::CanBusError, Q_PRIMITIVE_TYPE);
Q_DECLARE_TYPEINFO(QCanBusDevice::CanBusDeviceState, Q_PRIMITIVE_TYPE);
Q_DECLARE_TYPEINFO(QCanBusDevice::ConfigurationKey, Q_PRIMITIVE_TYPE);
Q_DECLARE_TYPEINFO(QCanBusDevice::Filter, Q_PRIMITIVE_TYPE);
Q_DECLARE_TYPEINFO(QCanBusDevice::Filter::FormatFilter, Q_PRIMITIVE_TYPE);
Q_DECLARE_OPERATORS_FOR_FLAGS(QCanBusDevice::Filter::FormatFilters)
QT_END_NAMESPACE
Q_DECLARE_METATYPE(QCanBusDevice::Filter::FormatFilter)
Q_DECLARE_METATYPE(QList<QCanBusDevice::Filter>)
#endif // QCANBUSDEVICE_H
|
