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
|
/****************************************************************************
**
** Copyright (C) 2017 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtIvi module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite 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 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.LGPL3 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-3.0.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 (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: LGPL-3.0
**
****************************************************************************/
#include "qivizonedfeatureinterface.h"
/*!
\class QIviZonedFeatureInterface
\inmodule QtIviCore
\ingroup backends
\brief QIviZonedFeatureInterface defines the base interface for the
feature backend classes.
Vehicle feature can be zoned or be just generic depending of the vehicle.
For example some vehicles can contain only one climate fan and some other
may have one fan for the front seats and one for the back seat. To fill both
requirements, a backend developer can specify each feature attribute to be
generic or zone specific. If the backend doesn't specify a zone for an
attribute, then the attribute is generic. There can be multiple zone
attributes, but only a single generic one. The zone value for a generic
attribute is an empty string, and it can be omitted from the signals. The
code snippets below describes how to implement zone specific fanSpeedlevel
and generic steeringWheelHeater support in the backend.
\section2 Providing Available Zones
Before making any further calls to the backend, VehicleFunctions will query
the list of available zones. Zones are string keys and can be anything
defined by the backend developer. In this case we have two zones: "Front"
and "Rear".
The backend must return all available zones via
\l {QIviZonedFeatureInterface::}{availableZones}:
\code
QStringList backend::availableZones() const {
QStringList zones;
zones << "Front";
zones << "Rear";
return zones;
}
\endcode
\section2 Initializing Attributes
VehicleFunctions calls the backend to initialize all attributes. Backend
implementation has to emit all supported attribute signals, passing the
zone as a parameter. Zone is not needed if attribute is generic.
Initialization signals are emitted in the
\l {QIviZonedFeatureInterface::}{initializeAttributes}:
\code
void backend::initializeAttributes() {
emit fanSpeedLevelChanged(2, "Front");
emit fanSpeedLevelChanged(2, "Rear");
emit steeringWheelHeaterChanged(0); // Generic, no zone specified
}
\endcode
\section2 Implementing Feature-specific Attributes
Fan speed is zoned, validating requested zones is the responsibility
of the backend. If zone is valid, the vehicle's actual fan speed level
can be adjusted. The backend has to emit a signal for the changed zone.
\code
void backend::setFanSpeedLevel(int value, const QString &zone) {
if (!m_fanSpeedZones.contains(zone)) {
emit errorChanged(QIviAbstractFeature::InvalidZone);
} else {
// Set specified zone fan to value
...
emit fanSpeedLevelChanged(value, zone);
}
}
int backend::fanSpeedLevel(const QString &zone) {
if (!m_fanSpeedZones.contains(zone)) {
emit errorChanged(QIviAbstractFeature::InvalidZone);
return -1;
} else {
int value = ... // Get vehicle's zone fan Speed
return value;
}
}
\endcode
Steering wheel heater is not zone specific, so zone attribute should be
empty. If zone is empty, the vehicle's actual steering wheel heater can
be controlled. The backend has to emit a signal for the changed value.
Because the attribute is generic, zone is omitted from the signal.
\code
void backend::setSteeringWheelHeater(int value, const QString &zone) {
if (!zone.isEmpty()) { // zone must be empty for a generic attribute
emit errorChanged(QIviAbstractFeature::InvalidZone);
return;
} else {
// Set vehicle's steering wheel heater value
...
emit steeringWheelHeaterChanged(value);
}
}
int backend::steeringWheelHeater(const QString &zone) {
if (!zone.isEmpty()) { // zone must be empty for a generic attribute
emit errorChanged(QIviAbstractFeature::InvalidZone);
return -1;
} else {
int value = ... // Get vehicle's steering wheel heater value
return value;
}
}
\endcode
To implement a backend plugin you need also to implement QIviServiceInterface from the QtIviCore module.
See the full example backend implementation from \c {src/plugins/ivivehiclefunctions/climate_simulator}.
\sa QIviAbstractZonedFeature, QIviServiceInterface
*/
/*!
* \fn QIviZonedFeatureInterface::QIviZonedFeatureInterface(QObject *parent=0)
*
* Constructs a backend base interface.
*
* The \a parent is sent to the QObject constructor.
*/
QIviZonedFeatureInterface::QIviZonedFeatureInterface(QObject *parent)
: QObject(parent)
{
}
/*!
* \fn QStringList QIviZonedFeatureInterface::availableZones() const
*
* Returns a list of supported zone names. This is called from the client
* after having connected.
*
* The returned names must be valid QML property names, i.e. \c {[a-z_][A-Za-z0-9_]*}.
*
* \sa {Providing Available Zones}
*/
/*!
* \fn void QIviZonedFeatureInterface::initializeAttributes()
*
* Called from the client to initialize attributes. This is called after
* client is connected and available zones are fetched.
*
* In this function all supported attributes for each zone need to be emitted with
* the initialized value.
*
* \sa {Initializing Attributes}
*/
/*!
* \fn void errorChanged(QIviAbstractFeature::Error error, const QString &message = QString())
*
* The signal is emitted when \a error occurs in the backend.
* Error \a message is optional.
*/
|
