df0b7e9c63
This patch separates the transactionSequenceNumber used for sending from the one received. According to the specification, the transactionSequenceNumber is not meant to equally increase on both ends, but instead really just be a "random" number which allows to match a reply to a request. Syncing them on both ends has the outcome to increase the likelyhood of collisions if a device sends a notification at the same time we send a request and thus even may wrongly interpret that incoming command as a reply to the request. In fact, ideally TSNs for outgoing messages would stay away as far as possible from incoming ones. The old code additionally had the problem that it would re-use the last received TSN for outgoing requests, given it used a post-increment when reading m_transactionSequenceNumber after setting it to the last received TSN. The new code will use a single static upcounting TSN for all outgoing requests but will still allow overriding it with a custom TSN of for some reason a certain device requires a specific TSN (apparently those exist). It will not do anything with incoming TSNs but forward them now to the application layer which may decide to use it match its own transactions or to deduplicate packets. This allows fixing the issue in nymea that remote controls sometimes produce duplicate pressed events (seen most often with the Tradfri Symfonisk) by discarding commands that didn't increase the TSN.
144 lines
5.4 KiB
C++
144 lines
5.4 KiB
C++
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
*
|
|
* Copyright 2013 - 2020, nymea GmbH
|
|
* Contact: contact@nymea.io
|
|
*
|
|
* This file is part of nymea-zigbee.
|
|
* This project including source code and documentation is protected by copyright law, and
|
|
* remains the property of nymea GmbH. All rights, including reproduction, publication,
|
|
* editing and translation, are reserved. The use of this project is subject to the terms of a
|
|
* license agreement to be concluded with nymea GmbH in accordance with the terms
|
|
* of use of nymea GmbH, available under https://nymea.io/license
|
|
*
|
|
* GNU Lesser General Public License Usage
|
|
* Alternatively, this project may be redistributed and/or modified under the terms of the GNU
|
|
* Lesser General Public License as published by the Free Software Foundation; version 3.
|
|
* this project is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
|
|
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
* See the GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License along with this project.
|
|
* If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
* For any further details and any questions please contact us under contact@nymea.io
|
|
* or see our FAQ/Licensing Information on https://nymea.io/license/faq
|
|
*
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
#ifndef ZIGBEECLUSTER_H
|
|
#define ZIGBEECLUSTER_H
|
|
|
|
#include <QObject>
|
|
|
|
#include "zigbee.h"
|
|
#include "zigbeeclusterreply.h"
|
|
#include "zigbeeclusterlibrary.h"
|
|
#include "zigbeeclusterattribute.h"
|
|
|
|
struct ZigbeeClusterReportConfigurationRecord {
|
|
quint8 direction;
|
|
Zigbee::DataType dataType;
|
|
quint16 attributeId;
|
|
quint16 minInterval;
|
|
quint16 maxInterval;
|
|
quint16 timeout;
|
|
quint8 change;
|
|
};
|
|
|
|
typedef struct ZigbeeClusterAttributeReport {
|
|
quint16 sourceAddress;
|
|
quint8 endpointId;
|
|
ZigbeeClusterLibrary::ClusterId clusterId;
|
|
quint16 attributeId;
|
|
ZigbeeClusterLibrary::Status attributeStatus;
|
|
Zigbee::DataType dataType;
|
|
QByteArray data;
|
|
} ZigbeeClusterAttributeReport;
|
|
|
|
class ZigbeeNode;
|
|
class ZigbeeNetwork;
|
|
class ZigbeeNodeEndpoint;
|
|
class ZigbeeNetworkReply;
|
|
|
|
class ZigbeeCluster : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
friend class ZigbeeNode;
|
|
friend class ZigbeeNetwork;
|
|
friend class ZigbeeNetworkDatabase;
|
|
|
|
public:
|
|
enum Direction {
|
|
Server,
|
|
Client
|
|
};
|
|
Q_ENUM(Direction)
|
|
|
|
explicit ZigbeeCluster(ZigbeeNetwork *network, ZigbeeNode *node, ZigbeeNodeEndpoint *endpoint, ZigbeeClusterLibrary::ClusterId clusterId, Direction direction, QObject *parent = nullptr);
|
|
|
|
ZigbeeNode *node() const;
|
|
ZigbeeNodeEndpoint *endpoint() const;
|
|
|
|
Direction direction() const;
|
|
|
|
ZigbeeClusterLibrary::ClusterId clusterId() const;
|
|
QString clusterName() const;
|
|
|
|
QList<ZigbeeClusterAttribute> attributes() const;
|
|
bool hasAttribute(quint16 attributeId) const;
|
|
ZigbeeClusterAttribute attribute(quint16 attributeId);
|
|
|
|
// ZCL global commands
|
|
ZigbeeClusterReply *readAttributes(QList<quint16> attributes, quint16 manufacturerCode = 0x0000);
|
|
ZigbeeClusterReply *writeAttributes(QList<ZigbeeClusterLibrary::WriteAttributeRecord> writeAttributeRecords, quint16 manufacturerCode = 0x0000);
|
|
ZigbeeClusterReply *configureReporting(QList<ZigbeeClusterLibrary::AttributeReportingConfiguration> reportingConfigurations, quint16 manufacturerCode = 0x0000);
|
|
|
|
protected:
|
|
ZigbeeNetwork *m_network = nullptr;
|
|
ZigbeeNode *m_node = nullptr;
|
|
ZigbeeNodeEndpoint *m_endpoint= nullptr;
|
|
|
|
ZigbeeClusterLibrary::ClusterId m_clusterId = ZigbeeClusterLibrary::ClusterIdUnknown;
|
|
Direction m_direction = Server;
|
|
QHash<quint16, ZigbeeClusterAttribute> m_attributes;
|
|
|
|
// Helper methods for sending cluster specific commands
|
|
ZigbeeNetworkRequest createGeneralRequest();
|
|
QHash<quint8, ZigbeeClusterReply *> m_pendingReplies;
|
|
|
|
// Global commands
|
|
ZigbeeClusterReply *executeGlobalCommand(quint8 command, const QByteArray &payload = QByteArray(), quint16 manufacturerCode = 0x0000, quint8 transactionSequenceNumber = newTransactionSequenceNumber());
|
|
|
|
// Cluster specific
|
|
ZigbeeClusterReply *createClusterReply(const ZigbeeNetworkRequest &request, ZigbeeClusterLibrary::Frame frame);
|
|
ZigbeeClusterReply *executeClusterCommand(quint8 command, const QByteArray &payload = QByteArray());
|
|
|
|
ZigbeeClusterReply *sendClusterServerResponse(quint8 command, quint8 transactionSequenceNumber, const QByteArray &payload = QByteArray());
|
|
ZigbeeClusterReply *sendDefaultResponse(quint8 transactionSequenceNumber, quint8 command, quint8 status);
|
|
|
|
bool verifyNetworkError(ZigbeeClusterReply *zclReply, ZigbeeNetworkReply *networkReply);
|
|
void finishZclReply(ZigbeeClusterReply *zclReply);
|
|
|
|
virtual void processDataIndication(ZigbeeClusterLibrary::Frame frame);
|
|
|
|
void updateOrAddAttribute(const ZigbeeClusterAttribute &attribute);
|
|
|
|
static quint8 newTransactionSequenceNumber();
|
|
|
|
private:
|
|
virtual void setAttribute(const ZigbeeClusterAttribute &attribute);
|
|
|
|
signals:
|
|
void attributeChanged(const ZigbeeClusterAttribute &attribute);
|
|
|
|
public slots:
|
|
void processApsDataIndication(const QByteArray &asdu, const ZigbeeClusterLibrary::Frame &frame);
|
|
|
|
};
|
|
|
|
QDebug operator<<(QDebug debug, ZigbeeCluster *cluster);
|
|
QDebug operator<<(QDebug debug, const ZigbeeClusterAttributeReport &attributeReport);
|
|
|
|
#endif // ZIGBEECLUSTER_H
|