blob: 6c91fbf1a806b089145815992041911601db08f7 (
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
|
/****************************************************************************
**
** 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-index.html
\title Qt Serial Bus
\brief Provides an API to access various serial bus devices
\ingroup technology-apis
The Qt Serial Bus API provides classes and functions to access the various
industrial serial buses and protocols, such as CAN, ModBus, and others.
\section1 Getting Started
To include the definitions of the module's classes and functions, use the
following directive:
\code
#include <QtSerialBus>
\endcode
To link against the module, add this line to your qmake .pro file:
\code
QT += serialbus
\endcode
\section1 Supported Buses and Protocols
\list
\li \l {Qt CAN Bus}
\li \l {Qt Modbus}
\endlist
\section1 API Reference
These are links to the API reference materials.
\list
\li \l {Qt Serial Bus C++ Classes}{C++ Classes}
\endlist
\section1 Logging Categories
The \l QtSerialBus module exports the following \l {Configuring Categories}{logging categories}:
\table
\header
\li Logging Category
\li Description
\row
\li qt.modbus
\li Enables standard logging inside the Modbus classes
\row
\li qt.modbus.lowlevel
\li Enables low level logging including individual packet content inside
the Modbus classes
\endtable
\section1 Examples
\list
\li \l {CAN Bus Example}
\li \l {Modbus Master example}
\li \l {Modbus Slave example}
\endlist
*/
|
