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
|
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** 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 Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\page qtserialbus-peakcan-overview.html
\title Using PeakCAN Plugin
\brief Overview of how to use the PeakCAN plugin.
The PeakCAN plugin encapsulates the low-level API to work with the
\l{http://www.peak-system.com/}{PEAK-System} CAN adapters.
This plugin requires the PCAN device drivers and the PCAN-Basic library
version 4.0.0 or higher on Windows (pcanbasic.dll) and Linux (libpcanbasic.so).
On macOS the plugin requires the PCBUSB library from
\l{http://www.mac-can.com}{UV Software}.
\section1 Creating CAN Bus Devices
At first it is necessary to check that QCanBus provides the desired plugin:
\code
if (QCanBus::instance()->plugins().contains(QStringLiteral("peakcan"))) {
// plugin available
}
\endcode
Where \e peakcan is the plugin name.
Next, a connection to a specific interface can be established:
\code
QString errorString;
QCanBusDevice *device = QCanBus::instance()->createDevice(
QStringLiteral("peakcan"), QStringLiteral("usb0"), &errorString);
if (!device) {
// Error handling goes here
qDebug << errorString;
} else {
device->connectDevice();
}
\endcode
Where \e usb0 is the active CAN interface name. The PeakCAN plugin supports
16 USB interfaces from \e usb0 to \e usb15 and 16 PCI interfaces from
\e pci0 to \e pci15. The \l {QCanBus::}{availableDevices()} method returns a
list of currently available devices.
\note Only the USB and PCI adapters are currently supported by this plugin.
\note On macOS, only USB adapters are currently supported by this plugin.
The device is now open for writing and reading CAN frames:
\code
QCanBusFrame frame;
frame.setFrameId(8);
QByteArray payload("A36E");
frame.setPayload(payload);
device->writeFrame(frame);
\endcode
The reading can be done using the \l {QCanBusDevice::}{readFrame()} method. The
\l {QCanBusDevice::}{framesReceived()} signal is emitted when at least one new frame
is available for reading:
\code
QCanBusFrame frame = device->readFrame();
\endcode
PeakCAN supports the following configurations that can be controlled through
\l {QCanBusDevice::}{setConfigurationParameter()}:
\table
\header
\li Configuration parameter key
\li Description
\row
\li QCanBusDevice::CanFdKey
\li This configuration option determines whether CAN FD frames may be sent or
received. By default, this option is disabled. CAN FD compatible hardware
is needed to enable this option.
\row
\li QCanBusDevice::BitRateKey
\li Determines the bit rate of the CAN bus connection. The following bit rates
are supported: 5000, 10000, 20000, 33000, 47000, 50000, 83000, 95000,
100000, 125000, 250000, 500000, 800000, 1000000.
If the QCanBusDevice::CanFdKey option is enabled, the bit rates are limited
to 125000, 250000, 500000, or 1000000.
Note that this configuration parameter can only be adjusted while the
QCanBusDevice is not connected.
\row
\li QCanBusDevice::DataBitRateKey
\li Determines the data bit rate of the CAN FD bus connection. The
QCanBusDevice::CanFdKey option must be enabled to allow setting this option.
Possible data bitrates are 2000000, 4000000, 8000000, or 10000000. Note that
this configuration parameter can only be adjusted while the QCanBusDevice is
not connected.
\endtable
PeakCAN supports the following additional functions:
\list
\li QCanBusDevice::resetController()
\li QCanBusDevice::busStatus()
\endlist
*/
|
