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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
/***************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtBluetooth module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 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$
**
****************************************************************************/
#include "qlowenergyconnectionparameters.h"
QT_BEGIN_NAMESPACE
class QLowEnergyConnectionParametersPrivate : public QSharedData
{
public:
QLowEnergyConnectionParametersPrivate()
: minInterval(7.5)
, maxInterval(4000)
, latency(0)
, timeout(32000)
{
}
double minInterval;
double maxInterval;
int latency;
int timeout;
};
/*!
\since 5.7
\class QLowEnergyConnectionParameters
\brief The QLowEnergyConnectionParameters class is used when requesting or reporting
an update of the parameters of a Bluetooth LE connection.
The connection parameters influence how often a master and a slave device synchronize
with each other. In general, a lower connection interval and latency means faster communication,
but also higher power consumption. How these criteria should be weighed against each other
is highly dependent on the concrete use case.
Android only indirectly permits the adjustment of this parameter set.
The platform separates the connection parameters into three categories (hight, low & balanced
priority). Each category implies a predefined set of values for \l minimumInterval(),
\l maximumInterval() and \l latency(). Additionally, the value ranges of each category can vary
from one Android device to the next. Qt uses the \l minimumInterval() to determine the target
category as follows:
\table
\header
\li minimumInterval()
\li Android priority
\row
\li interval < 30
\li CONNECTION_PRIORITY_HIGH
\row
\li 30 <= interval <= 100
\li CONNECTION_PRIORITY_BALANCED
\row
\li interval > 100
\li CONNECTION_PRIORITY_LOW_POWER
\endtable
The \l supervisionTimeout() cannot be changed on Android and is therefore ignored.
\inmodule QtBluetooth
\ingroup shared
\sa QLowEnergyController::requestConnectionUpdate
\sa QLowEnergyController::connectionUpdated
*/
/*!
Constructs a new object of this class. All values are initialized to valid defaults.
*/
QLowEnergyConnectionParameters::QLowEnergyConnectionParameters()
: d(new QLowEnergyConnectionParametersPrivate)
{
}
/*! Constructs a new object of this class that is a copy of \a other. */
QLowEnergyConnectionParameters::QLowEnergyConnectionParameters(const QLowEnergyConnectionParameters &other)
: d(other.d)
{
}
/*! Destroys this object. */
QLowEnergyConnectionParameters::~QLowEnergyConnectionParameters()
{
}
/*! Makes this object a copy of \a other and returns the new value of this object. */
QLowEnergyConnectionParameters &QLowEnergyConnectionParameters::operator=(const QLowEnergyConnectionParameters &other)
{
d = other.d;
return *this;
}
/*!
Sets the range in which the connection interval should be. The actual value will be decided by
the controller. Both \a minimum and \a maximum are given in milliseconds.
If \a maximum is smaller than \a minimum, it will be set to the value of \a minimum.
The smallest possible connection interval is 7.5 milliseconds, the largest one is
4000 milliseconds.
\sa minimumInterval(), maximumInterval()
*/
void QLowEnergyConnectionParameters::setIntervalRange(double minimum, double maximum)
{
d->minInterval = minimum;
d->maxInterval = qMax(minimum, maximum);
}
/*!
Returns the minimum connection interval in milliseconds. The default is 7.5.
\note If this object was emitted via \l QLowEnergyController::connectionUpdated(), then
this value is the same as \l maximumInterval() and refers to the actual
connection interval.
\sa setIntervalRange()
*/
double QLowEnergyConnectionParameters::minimumInterval() const
{
return d->minInterval;
}
/*!
Returns the maximum connection interval in milliseconds. The default is 4000.
\note If this object was emitted via \l QLowEnergyController::connectionUpdated(), then
this value is the same as \l minimumInterval() and refers to the actual
connection interval.
\sa setIntervalRange()
*/
double QLowEnergyConnectionParameters::maximumInterval() const
{
return d->maxInterval;
}
/*!
Sets the slave latency of the connection (that is, the number of connection events that a slave
device is allowed to ignore) to \a latency. The minimum value is 0, the maximum is 499.
\sa latency()
*/
void QLowEnergyConnectionParameters::setLatency(int latency)
{
d->latency = latency;
}
/*!
Returns the slave latency of the connection.
\sa setLatency()
*/
int QLowEnergyConnectionParameters::latency() const
{
return d->latency;
}
/*!
Sets the link supervision timeout to \a timeout milliseconds.
There are several constraints on this value: It must be in the range [100,32000] and it must be
larger than (1 + \l latency()) * 2 * \l maximumInterval().
On Android, this timeout is not adjustable and therefore ignored.
\sa supervisionTimeout()
*/
void QLowEnergyConnectionParameters::setSupervisionTimeout(int timeout)
{
d->timeout = timeout;
}
/*!
Returns the link supervision timeout of the connection in milliseconds.
\sa setSupervisionTimeout()
*/
int QLowEnergyConnectionParameters::supervisionTimeout() const
{
return d->timeout;
}
/*!
\fn void QLowEnergyConnectionParameters::swap(QLowEnergyConnectionParameters &other)
Swaps this object with \a other.
*/
/*!
Returns \a true if \a p1 and \a p2 are equal with respect to their public state,
otherwise returns false.
*/
bool operator==(const QLowEnergyConnectionParameters &p1, const QLowEnergyConnectionParameters &p2)
{
if (p1.d == p2.d)
return true;
return p1.minimumInterval() == p2.minimumInterval()
&& p1.maximumInterval() == p2.maximumInterval()
&& p1.latency() == p2.latency()
&& p1.supervisionTimeout() == p2.supervisionTimeout();
}
/*!
\fn bool operator!=(const QLowEnergyConnectionParameters &p1,
const QLowEnergyConnectionParameters &p2)
Returns \a true if \a p1 and \a p2 are not equal with respect to their public state,
otherwise returns false.
*/
QT_END_NAMESPACE
|
