1/****************************************************************************
2**
3** Copyright (C) 2017 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtSerialBus module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:BSD$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** BSD License Usage
18** Alternatively, you may use this file under the terms of the BSD license
19** as follows:
20**
21** "Redistribution and use in source and binary forms, with or without
22** modification, are permitted provided that the following conditions are
23** met:
24** * Redistributions of source code must retain the above copyright
25** notice, this list of conditions and the following disclaimer.
26** * Redistributions in binary form must reproduce the above copyright
27** notice, this list of conditions and the following disclaimer in
28** the documentation and/or other materials provided with the
29** distribution.
30** * Neither the name of The Qt Company Ltd nor the names of its
31** contributors may be used to endorse or promote products derived
32** from this software without specific prior written permission.
33**
34**
35** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
36** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
37** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
38** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
39** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
42** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
43** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
44** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
45** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
46**
47** $QT_END_LICENSE$
48**
49****************************************************************************/
50
51#include <QVariant>
52#include <QCanBusDevice>
53
54int main(int /*argc*/, char ** /*argv*/)
55{
56 QCanBusDevice *device = nullptr;
57
58 //! [Filter Examples]
59 QCanBusDevice::Filter filter;
60 QList<QCanBusDevice::Filter> filterList;
61
62 // filter all CAN bus packages with id 0x444 (base) or 0xXXXXX444 (extended)
63 filter.frameId = 0x444u;
64 filter.frameIdMask = 0x7FFu;
65 filter.format = QCanBusDevice::Filter::MatchBaseAndExtendedFormat;
66 filter.type = QCanBusFrame::InvalidFrame;
67 filterList.append(t: filter);
68
69 // filter all DataFrames with extended CAN bus package format
70 filter.frameId = 0x0;
71 filter.frameIdMask = 0x0;
72 filter.format = QCanBusDevice::Filter::MatchExtendedFormat;
73 filter.type = QCanBusFrame::DataFrame;
74 filterList.append(t: filter);
75
76 // apply filter
77 device->setConfigurationParameter(key: QCanBusDevice::RawFilterKey, value: QVariant::fromValue(value: filterList));
78 //! [Filter Examples]
79
80 //! [SocketCan Filter Example]
81 QList<QCanBusDevice::Filter> list;
82 QCanBusDevice::Filter f;
83
84 // only accept odd numbered frame id of type remote request
85 // frame can utilize extended or base format
86 f.frameId = 0x1;
87 f.frameIdMask = 0x1;
88 f.format = QCanBusDevice::Filter::MatchBaseAndExtendedFormat;
89 f.type = QCanBusFrame::RemoteRequestFrame;
90 list.append(t: f);
91
92 device->setConfigurationParameter(key: QCanBusDevice::RawFilterKey, value: QVariant::fromValue(value: list));
93 device->setConfigurationParameter(key: QCanBusDevice::ErrorFilterKey,
94 value: QVariant::fromValue(value: QCanBusFrame::FrameErrors(QCanBusFrame::AnyError)));
95 //! [SocketCan Filter Example]
96
97 Q_UNUSED(filter);
98 return 0;
99}
100
101

source code of qtserialbus/src/serialbus/doc/snippets/snippetmain.cpp