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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
|
/******************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtKnx module.
**
** $QT_BEGIN_LICENSE:GPL$
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) 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.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-3.0.html.
**
** $QT_END_LICENSE$
**
******************************************************************************/
#include "qknxadditionalinfo.h"
#include "qknxutils.h"
#include <array>
QT_BEGIN_NAMESPACE
/*!
\class QKnxAdditionalInfo
\inmodule QtKnx
\ingroup qtknx-general-classes
\brief The QKnxAdditionalInfo class represents the additional information
that can be placed inside a KNX cEMI frame.
A Common External Message Interface (cEMI) frame can be used for KNX
information transport, independent of the KNX medium: twisted pair (TP),
power line (PL), or radio frequency (RF). The \l Type enum holds the type
of additional information to be placed into the frame.
The KNX specification limits the size of the data stored in the additional
info object to a maximum of 252 bytes. The class implementation acknowledges
this and silently truncates the data, when necessary.
*/
/*!
\enum QKnxAdditionalInfo::Type
This enum type holds the type of additional information to be placed into
a KNX cEMI frame.
\omitvalue Reserved
\value PlMediumInformation
Domain address used by the power line (PL) medium.
\value RfMediumInformation
RF-Info byte (formerly named RF-Ctrl), KNX Serial Number/DoA, and
Data Link Layer Frame Number (LFN) used by the radio frequency
(RF) medium.
\value BusmonitorStatusInfo
Bus monitor error flags.
\value TimestampRelative
Relative timestamp. For example, for \c L_Raw.ind.
\value TimeDelayUntilSending
Time delay. For example, for \c L_Raw.req.
\value ExtendedRelativeTimestamp
Device independent time stamp. For example, for \c L_Raw.ind or
\c L_Busmon.ind.
\value BiBatInformation Contains b7-b4 of the RF KNX-Ctrl
field and BiBat Block-number.
\value RfMultiInformation
RF multifrequency, call channel, and Fast Ack number.
\value PreambleAndPostamble Preamble and postamble length.
\value RfFastAckInformation
Status and information of each expected number of Fast Ack (N).
\value ManufacturerSpecificData
Manufacturer-specific data, including manufacturer ID (2-byte) and
Subfunction ID (1-byte).
\omitvalue EscCode
*/
/*!
\fn QKnxAdditionalInfo::QKnxAdditionalInfo()
Constructs a new, empty, invalid additional info object.
*/
/*!
\fn QKnxAdditionalInfo::~QKnxAdditionalInfo()
Destroys the additional info object and releases all allocated resources.
*/
/*!
Constructs a new additional info object and sets its \l Type to \a type
and data to \a data.
\sa isNull(), isValid()
*/
QKnxAdditionalInfo::QKnxAdditionalInfo(QKnxAdditionalInfo::Type type, const QKnxByteArray &data)
{
m_bytes.set(0, quint8(type));
m_bytes.set(1, quint8(qMin(data.size(), 252)));
m_bytes += data.mid(0, m_bytes.at(1));
}
/*!
If this is an additional info object that is constructed by default,
returns \c true; otherwise returns \c false. An additional info object
is considered null if it contains no initialized type value.
\sa isValid()
*/
bool QKnxAdditionalInfo::isNull() const
{
return (m_bytes.at(0) == 0x00);
}
/*!
Returns \c true if this is a valid additional info object; \c false
otherwise.
*/
bool QKnxAdditionalInfo::isValid() const
{
if (isNull())
return false;
if ((size() != m_bytes.size()) || (size() > 254))
return false;
const auto type = QKnxAdditionalInfo::Type(m_bytes.at(0));
const auto expectedSize = expectedDataSize(type);
if (expectedSize < 0)
return false;
switch (type) {
case QKnxAdditionalInfo::Type::PlMediumInformation:
case QKnxAdditionalInfo::Type::RfMediumInformation:
case QKnxAdditionalInfo::Type::BusmonitorStatusInfo:
case QKnxAdditionalInfo::Type::TimestampRelative:
case QKnxAdditionalInfo::Type::TimeDelayUntilSending:
case QKnxAdditionalInfo::Type::ExtendedRelativeTimestamp:
case QKnxAdditionalInfo::Type::BiBatInformation:
case QKnxAdditionalInfo::Type::RfMultiInformation:
case QKnxAdditionalInfo::Type::PreambleAndPostamble:
return dataSize() == quint8(expectedSize);
case QKnxAdditionalInfo::Type::RfFastAckInformation:
return (dataSize() >= quint8(expectedSize)) && ((dataSize() % 2) == 0);
case QKnxAdditionalInfo::Type::ManufacturerSpecificData:
return dataSize() >= quint8(expectedSize);
case QKnxAdditionalInfo::Type::Reserved:
case QKnxAdditionalInfo::Type::EscCode:
break;
}
return false;
}
/*!
Returns the number of bytes representing the additional info, including the
byte for the \l Type id and the byte for length information.
*/
quint8 QKnxAdditionalInfo::size() const
{
if (isNull())
return 0;
return m_bytes.at(1) + 2; // 2 -> type and length byte
}
/*!
Returns the type of the information stored in the additional info object.
*/
QKnxAdditionalInfo::Type QKnxAdditionalInfo::type() const
{
return QKnxAdditionalInfo::Type(m_bytes.at(0));
}
/*!
Sets the additional info type to \a type.
*/
void QKnxAdditionalInfo::setType(QKnxAdditionalInfo::Type type)
{
m_bytes.set(0, quint8(type));
}
/*!
Returns the data stored in the additional info object.
*/
QKnxByteArray QKnxAdditionalInfo::data() const
{
return m_bytes.mid(2);
}
/*!
Sets the data stored in the additional info object to \a data.
*/
void QKnxAdditionalInfo::setData(const QKnxByteArray &data)
{
m_bytes.set(1, quint8(qMin(data.size(), 252)));
m_bytes.resize(2);
m_bytes += data.mid(0, m_bytes.at(1));
}
/*!
Returns the number of bytes representing the data stored in the additional
info object.
*/
quint8 QKnxAdditionalInfo::dataSize() const
{
return m_bytes.at(1);
}
/*!
Returns the number of expected bytes for the \l Type id \a type. The
additional boolean parameter \a isFixedSize is set to \c true if the type
expects a fixed size of bytes; otherwise it is to \c false. If the type is
unknown, the function returns a negative value.
Known types of variable size are:
\list
\li \l QKnxAdditionalInfo::RfFastAckInformation - a multiple of two
bytes, two bytes minimum.
\li \l QKnxAdditionalInfo::ManufacturerSpecificData - three bytes minimum.
\endlist
*/
qint32 QKnxAdditionalInfo::expectedDataSize(QKnxAdditionalInfo::Type type, bool *isFixedSize)
{
static const std::array<int, 0x100> table = []() {
std::array<int, 0x100> table; table.fill(-1);
table[int(QKnxAdditionalInfo::Type::PlMediumInformation)] = 2;
table[int(QKnxAdditionalInfo::Type::RfMediumInformation)] = 8;
table[int(QKnxAdditionalInfo::Type::BusmonitorStatusInfo)] = 1;
table[int(QKnxAdditionalInfo::Type::TimestampRelative)] = 2;
table[int(QKnxAdditionalInfo::Type::TimeDelayUntilSending)] = 4;
table[int(QKnxAdditionalInfo::Type::ExtendedRelativeTimestamp)] = 4;
table[int(QKnxAdditionalInfo::Type::BiBatInformation)] = 2;
table[int(QKnxAdditionalInfo::Type::RfMultiInformation)] = 4;
table[int(QKnxAdditionalInfo::Type::PreambleAndPostamble)] = 3;
table[int(QKnxAdditionalInfo::Type::RfFastAckInformation)] = 2;
table[int(QKnxAdditionalInfo::Type::ManufacturerSpecificData)] = 3;
return table;
}();
if (isFixedSize)
*isFixedSize = (type < QKnxAdditionalInfo::Type::RfFastAckInformation);
return table[int(type)];
}
/*!
Returns \c true if this object and the given \a other are equal; otherwise
returns \c false.
*/
bool QKnxAdditionalInfo::operator==(const QKnxAdditionalInfo &other) const
{
return m_bytes == other.m_bytes;
}
/*!
Returns \c true if this object and the given \a other are not equal;
otherwise returns \c false.
*/
bool QKnxAdditionalInfo::operator!=(const QKnxAdditionalInfo &other) const
{
return !operator==(other);
}
/*!
Returns the byte at the position \a index in the additional info object.
*/
quint8 QKnxAdditionalInfo::byte(quint8 index) const
{
Q_ASSERT_X(index < size(), "QKnxAdditionalInfo::byte", "index out of range");
return m_bytes.at(index);
}
/*!
Returns an array of bytes that represent the additional info object.
*/
QKnxByteArray QKnxAdditionalInfo::bytes() const
{
if (!isValid())
return {};
return m_bytes;
}
/*!
Constructs the additional info object from the byte array \a bytes starting
at position \a index inside the array.
\sa isNull(), isValid()
*/
QKnxAdditionalInfo QKnxAdditionalInfo::fromBytes(const QKnxByteArray &bytes, quint16 index)
{
const qint32 availableSize = bytes.size() - index;
if (availableSize < 2)
return {}; // size missing
quint16 size = QKnxUtils::QUint8::fromBytes(bytes, index + 1) + 2; // type + size => 2
if (availableSize < size)
return {};
return { QKnxAdditionalInfo::Type(bytes.at(index)), bytes.mid(index + 2, bytes.at(index + 1)) };
}
/*!
\relates QKnxAdditionalInfo
Writes the KNX cEMI frame's additional info \a info to the \a debug stream.
*/
QDebug operator<<(QDebug debug, const QKnxAdditionalInfo &info)
{
QDebugStateSaver _(debug);
if (info.isValid()) {
QDebug &dbg = debug.nospace().noquote() << "0x" << Qt::hex << qSetFieldWidth(2)
<< qSetPadChar(QLatin1Char('0'));
const auto rawData = info.bytes();
for (quint8 byte : qAsConst(rawData))
dbg << byte;
} else {
debug.nospace().noquote() << "0x1nv4l1d";
}
return debug;
}
QT_END_NAMESPACE
|