From dbecb39e0bdfd48fed94e3906d43d611bd5159cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Mon, 26 Aug 2024 13:08:30 +0200 Subject: [PATCH] INRO: Introduce UDP discovery and update connection handling MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Simon Stürz Signed-off-by: Martin Lukas --- inro/crclookuptable.h | 42 +++++++++ inro/inro.pro | 7 +- inro/integrationplugininro.cpp | 67 ++++---------- inro/integrationplugininro.h | 2 + inro/pantaboxudpdiscovery.cpp | 163 +++++++++++++++++++++++++++++++++ inro/pantaboxudpdiscovery.h | 74 +++++++++++++++ 6 files changed, 303 insertions(+), 52 deletions(-) create mode 100644 inro/crclookuptable.h create mode 100644 inro/pantaboxudpdiscovery.cpp create mode 100644 inro/pantaboxudpdiscovery.h diff --git a/inro/crclookuptable.h b/inro/crclookuptable.h new file mode 100644 index 0000000..1fa34c3 --- /dev/null +++ b/inro/crclookuptable.h @@ -0,0 +1,42 @@ +#ifndef CRCLOOKUPTABLE_H +#define CRCLOOKUPTABLE_H +#include + +//CRC-8/NRSC-5 lookup table + +const QVector crc8LookupTable = { + 0x00, 0x31, 0x62, 0x53, 0xc4, 0xf5, 0xa6, 0x97, + 0xb9, 0x88, 0xdb, 0xea, 0x7d, 0x4c, 0x1f, 0x2e, + 0x43, 0x72, 0x21, 0x10, 0x87, 0xb6, 0xe5, 0xd4, + 0xfa, 0xcb, 0x98, 0xa9, 0x3e, 0x0f, 0x5c, 0x6d, + 0x86, 0xb7, 0xe4, 0xd5, 0x42, 0x73, 0x20, 0x11, + 0x3f, 0x0e, 0x5d, 0x6c, 0xfb, 0xca, 0x99, 0xa8, + 0xc5, 0xf4, 0xa7, 0x96, 0x01, 0x30, 0x63, 0x52, + 0x7c, 0x4d, 0x1e, 0x2f, 0xb8, 0x89, 0xda, 0xeb, + 0x3d, 0x0c, 0x5f, 0x6e, 0xf9, 0xc8, 0x9b, 0xaa, + 0x84, 0xb5, 0xe6, 0xd7, 0x40, 0x71, 0x22, 0x13, + 0x7e, 0x4f, 0x1c, 0x2d, 0xba, 0x8b, 0xd8, 0xe9, + 0xc7, 0xf6, 0xa5, 0x94, 0x03, 0x32, 0x61, 0x50, + 0xbb, 0x8a, 0xd9, 0xe8, 0x7f, 0x4e, 0x1d, 0x2c, + 0x02, 0x33, 0x60, 0x51, 0xc6, 0xf7, 0xa4, 0x95, + 0xf8, 0xc9, 0x9a, 0xab, 0x3c, 0x0d, 0x5e, 0x6f, + 0x41, 0x70, 0x23, 0x12, 0x85, 0xb4, 0xe7, 0xd6, + 0x7a, 0x4b, 0x18, 0x29, 0xbe, 0x8f, 0xdc, 0xed, + 0xc3, 0xf2, 0xa1, 0x90, 0x07, 0x36, 0x65, 0x54, + 0x39, 0x08, 0x5b, 0x6a, 0xfd, 0xcc, 0x9f, 0xae, + 0x80, 0xb1, 0xe2, 0xd3, 0x44, 0x75, 0x26, 0x17, + 0xfc, 0xcd, 0x9e, 0xaf, 0x38, 0x09, 0x5a, 0x6b, + 0x45, 0x74, 0x27, 0x16, 0x81, 0xb0, 0xe3, 0xd2, + 0xbf, 0x8e, 0xdd, 0xec, 0x7b, 0x4a, 0x19, 0x28, + 0x06, 0x37, 0x64, 0x55, 0xc2, 0xf3, 0xa0, 0x91, + 0x47, 0x76, 0x25, 0x14, 0x83, 0xb2, 0xe1, 0xd0, + 0xfe, 0xcf, 0x9c, 0xad, 0x3a, 0x0b, 0x58, 0x69, + 0x04, 0x35, 0x66, 0x57, 0xc0, 0xf1, 0xa2, 0x93, + 0xbd, 0x8c, 0xdf, 0xee, 0x79, 0x48, 0x1b, 0x2a, + 0xc1, 0xf0, 0xa3, 0x92, 0x05, 0x34, 0x67, 0x56, + 0x78, 0x49, 0x1a, 0x2b, 0xbc, 0x8d, 0xde, 0xef, + 0x82, 0xb3, 0xe0, 0xd1, 0x46, 0x77, 0x24, 0x15, + 0x3b, 0x0a, 0x59, 0x68, 0xff, 0xce, 0x9d, 0xac +}; + +#endif // CRCLOOKUPTABLE_H diff --git a/inro/inro.pro b/inro/inro.pro index 18de92a..2bc5f38 100644 --- a/inro/inro.pro +++ b/inro/inro.pro @@ -7,11 +7,14 @@ MODBUS_TOOLS_CONFIG += VERBOSE include(../modbus.pri) HEADERS += \ + crclookuptable.h \ integrationplugininro.h \ pantabox.h \ - pantaboxdiscovery.h + pantaboxdiscovery.h \ + pantaboxudpdiscovery.h SOURCES += \ integrationplugininro.cpp \ pantabox.cpp \ - pantaboxdiscovery.cpp + pantaboxdiscovery.cpp \ + pantaboxudpdiscovery.cpp diff --git a/inro/integrationplugininro.cpp b/inro/integrationplugininro.cpp index daa5c7d..44ac121 100644 --- a/inro/integrationplugininro.cpp +++ b/inro/integrationplugininro.cpp @@ -39,6 +39,7 @@ IntegrationPluginInro::IntegrationPluginInro() { + m_updDiscovery = new PantaboxUdpDiscovery(this); } @@ -93,41 +94,16 @@ void IntegrationPluginInro::setupThing(ThingSetupInfo *info) } } - MacAddress macAddress = MacAddress(thing->paramValue(pantaboxThingMacAddressParamTypeId).toString()); - if (!macAddress.isValid()) { - qCWarning(dcInro()) << "The configured mac address is not valid" << thing->params(); - info->finish(Thing::ThingErrorInvalidParameter, QT_TR_NOOP("The MAC address is not known. Please reconfigure the thing.")); + + QString serialNumber = thing->paramValue(pantaboxThingSerialNumberParamTypeId).toString(); + + if (serialNumber.isEmpty()) { + qCWarning(dcInro()) << "Could not set up PANTABOX because the configured serial number is empty" << thing->params(); + info->finish(Thing::ThingErrorInvalidParameter, QT_TR_NOOP("The serial number is not known. Please reconfigure the thing.")); return; } - NetworkDeviceMonitor *monitor = hardwareManager()->networkDeviceDiscovery()->registerMonitor(macAddress); - m_monitors.insert(thing, monitor); - - connect(info, &ThingSetupInfo::aborted, monitor, [=](){ - if (m_monitors.contains(thing)) { - qCDebug(dcInro()) << "Unregistering monitor because setup has been aborted."; - hardwareManager()->networkDeviceDiscovery()->unregisterMonitor(m_monitors.take(thing)); - } - }); - - // Only make sure the connection is working in the initial setup, otherwise we let the monitor do the work - if (info->isInitialSetup()) { - // Continue with setup only if we know that the network device is reachable - if (monitor->reachable()) { - setupConnection(info); - } else { - // otherwise wait until we reach the networkdevice before setting up the device - qCDebug(dcInro()) << "Network device" << thing->name() << "is not reachable yet. Continue with the setup once reachable."; - connect(monitor, &NetworkDeviceMonitor::reachableChanged, info, [=](bool reachable){ - if (reachable) { - qCDebug(dcInro()) << "Network device" << thing->name() << "is now reachable. Continue with the setup..."; - setupConnection(info); - } - }); - } - } else { - setupConnection(info); - } + setupConnection(info); } void IntegrationPluginInro::postSetupThing(Thing *thing) @@ -293,24 +269,21 @@ void IntegrationPluginInro::thingRemoved(Thing *thing) void IntegrationPluginInro::setupConnection(ThingSetupInfo *info) { Thing *thing = info->thing(); - NetworkDeviceMonitor *monitor = m_monitors.value(thing); + // NetworkDeviceMonitor *monitor = m_monitors.value(thing); - Pantabox *connection = new Pantabox(monitor->networkDeviceInfo().address(), 502, 1, this); + Pantabox *connection = new Pantabox(QHostAddress(), 502, 1, this); connect(info, &ThingSetupInfo::aborted, connection, &Pantabox::deleteLater); - // Monitor reachability - connect(monitor, &NetworkDeviceMonitor::reachableChanged, thing, [=](bool reachable){ - if (!thing->setupComplete()) + connect(m_updDiscovery, &PantaboxUdpDiscovery::pantaboxDiscovered, connection, [connection, thing](const PantaboxUdpDiscovery::PantaboxUdp &pantabox){ + QString serialNumber = thing->paramValue(pantaboxThingSerialNumberParamTypeId).toString(); + if (pantabox.serialNumber != serialNumber) return; - qCDebug(dcInro()) << "Network device monitor for" << thing->name() << (reachable ? "is now reachable" : "is not reachable any more" ); - if (reachable && !thing->stateValue("connected").toBool()) { - connection->modbusTcpMaster()->setHostAddress(monitor->networkDeviceInfo().address()); + connection->modbusTcpMaster()->setHostAddress(pantabox.ipAddress); + + if (!thing->stateValue("connected").toBool()) { + qCDebug(dcInro()) << "Received discovery paket for" << thing << "Start connecting to the PANTABOX on" << pantabox.ipAddress.toString(); connection->connectDevice(); - } else if (!reachable) { - // Note: We disable autoreconnect explicitly and we will - // connect the device once the monitor says it is reachable again - connection->disconnectDevice(); } }); @@ -397,10 +370,4 @@ void IntegrationPluginInro::setupConnection(ThingSetupInfo *info) m_connections.insert(thing, connection); info->finish(Thing::ThingErrorNoError); - - qCDebug(dcInro()) << "Setting up PANTABOX finished successfully" << monitor->networkDeviceInfo().address().toString(); - - // Connect reight the way if the monitor indicates reachable, otherwise the connect will handle the connect later - if (monitor->reachable()) - connection->connectDevice(); } diff --git a/inro/integrationplugininro.h b/inro/integrationplugininro.h index 17bb5a0..cc49ac0 100644 --- a/inro/integrationplugininro.h +++ b/inro/integrationplugininro.h @@ -37,6 +37,7 @@ #include "extern-plugininfo.h" #include "pantabox.h" +#include "pantaboxudpdiscovery.h" class IntegrationPluginInro: public IntegrationPlugin { @@ -60,6 +61,7 @@ private: QHash m_monitors; QHash m_initReadRequired; + PantaboxUdpDiscovery *m_updDiscovery = nullptr; void setupConnection(ThingSetupInfo *info); }; diff --git a/inro/pantaboxudpdiscovery.cpp b/inro/pantaboxudpdiscovery.cpp new file mode 100644 index 0000000..2ea9415 --- /dev/null +++ b/inro/pantaboxudpdiscovery.cpp @@ -0,0 +1,163 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +* +* Copyright 2013 - 2024, nymea GmbH +* Contact: contact@nymea.io +* +* This file is part of nymea. +* 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 . +* +* 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 +* +* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +#include "pantaboxudpdiscovery.h" +#include "extern-plugininfo.h" + +#include +#include +#include +#include "crclookuptable.h" + +#define PANTABOX_DISCOVERY_PORT 52001 + +PantaboxUdpDiscovery::PantaboxUdpDiscovery(QObject *parent) + : QObject{parent} +{ + m_socket = new QUdpSocket(this); + if (!m_socket->bind(QHostAddress::Broadcast, PANTABOX_DISCOVERY_PORT, QAbstractSocket::ShareAddress | QAbstractSocket::ReuseAddressHint)) { + qCWarning(dcInro()) << "UdpDiscovery: Failed to bind to UDP broadcast on" << PANTABOX_DISCOVERY_PORT << m_socket->errorString(); + return; + } + + connect(m_socket, &QUdpSocket::readyRead, this, &PantaboxUdpDiscovery::readPendingDatagrams); + + m_available = true; + +} + +QHash PantaboxUdpDiscovery::results() const +{ + return m_results; +} + +void PantaboxUdpDiscovery::readPendingDatagrams() +{ + while(m_socket->hasPendingDatagrams()) { + + QNetworkDatagram datagram = m_socket->receiveDatagram(); + + for (int i = 0; i < datagram.data().length(); i++) { + + quint8 dataByte = static_cast(datagram.data().at(i)); + + if (!m_prefixStartDiscovered[datagram.senderAddress()] && dataByte == 0xe5) { + m_prefixStartDiscovered[datagram.senderAddress()] = true; + continue; + } + + if (m_prefixStartDiscovered[datagram.senderAddress()] && dataByte == 0x00) { + m_prefixStartDiscovered[datagram.senderAddress()] = false; + + // Paket prefix discovered (0xe5 0x00), process current buffer and start collecting data + processDataBuffer(datagram.senderAddress()); + m_buffers[datagram.senderAddress()].clear(); + continue; + } else { + m_prefixStartDiscovered[datagram.senderAddress()] = false; + } + + // Adding data byte + m_buffers[datagram.senderAddress()].append(dataByte); + + if (m_buffers[datagram.senderAddress()].length() >= 0xffff) { + qCWarning(dcInro()) << "UdpDiscovery: Buffer overflow. Wipe data buffer..."; + m_buffers[datagram.senderAddress()].clear(); + } + } + } +} + +quint8 PantaboxUdpDiscovery::calculateCrc8(const QByteArray &data) +{ + // CRC-8/NRSC-5 initial value + quint8 crc = 0xFF; + + for (quint8 byte : data) { + crc = crc8LookupTable[crc ^ byte]; + } + + return crc; +} + +void PantaboxUdpDiscovery::processDataBuffer(const QHostAddress &address) +{ + if (m_buffers[address].length() < 3) + return; + + quint8 receivedCrc = static_cast(m_buffers[address].at(m_buffers[address].length() - 1)); + quint8 calculatedCrc = calculateCrc8(QByteArray::fromHex("e500").append(m_buffers[address].left(m_buffers[address].length() - 1))); + + if (calculatedCrc != receivedCrc) { + qCDebug(dcInro()) << "UdpDiscovery: Crc checksum not correct. Received crc "<< receivedCrc <<", calculated crc " << calculatedCrc ; + return; + } + + QJsonParseError jsonError; + QJsonDocument jsonDoc = QJsonDocument::fromJson(m_buffers[address].mid(2, m_buffers[address].length() - 3), &jsonError); + + if (jsonError.error != QJsonParseError::NoError) { + qCDebug(dcInro()) << "UdpDiscovery: Received invalud json data" << jsonError.errorString(); + return; + } + + //qCDebug(dcInro()) << "UdpDiscovery:" << qUtf8Printable(jsonDoc.toJson(QJsonDocument::Indented)); + /* + { + "deviceId": "e45749d4-8c05-44b2-9dbc-xxxxxxxxxxxx", + "encryptBLE": 1, + "env": "live", + "fwVersion": "V1.19.6", + "ipAddress": "10.10.10.111", + "macAddress": "8C:4B:14:88:05:00", + "name": "#1XXXXXXX", + "productKey": "inro-test-1", + "serialNumber": "#1XXXXXXX", + "useTLS": 1 + } + */ + + QVariantMap dataMap = jsonDoc.toVariant().toMap(); + if (dataMap.contains("serialNumber") && dataMap.contains("ipAddress") && dataMap.contains("macAddress")) { + PantaboxUdp pantabox; + pantabox.serialNumber = dataMap.value("serialNumber").toString().remove("#"); + pantabox.macAddress = MacAddress(dataMap.value("macAddress").toString()); + pantabox.ipAddress = QHostAddress(dataMap.value("ipAddress").toString()); + + if (address != pantabox.ipAddress) { + qCDebug(dcInro()) << "UdpDiscovery: Received UPD discovery paket from a different IP than communicated in the paket. Ignoring paket."; + return; + } + + qCDebug(dcInro()) << "UdpDiscovery: --> Received discovery paket from" << pantabox.serialNumber << pantabox.macAddress.toString() << pantabox.ipAddress.toString(); + m_results[pantabox.serialNumber] = pantabox; + emit pantaboxDiscovered(pantabox); + } +} diff --git a/inro/pantaboxudpdiscovery.h b/inro/pantaboxudpdiscovery.h new file mode 100644 index 0000000..fd61225 --- /dev/null +++ b/inro/pantaboxudpdiscovery.h @@ -0,0 +1,74 @@ +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * +* +* Copyright 2013 - 2024, nymea GmbH +* Contact: contact@nymea.io +* +* This file is part of nymea. +* 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 . +* +* 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 PANTABOXUDPDISCOVERY_H +#define PANTABOXUDPDISCOVERY_H + +#include +#include + +#include + +class PantaboxUdpDiscovery : public QObject +{ + Q_OBJECT +public: + explicit PantaboxUdpDiscovery(QObject *parent = nullptr); + + typedef struct PantaboxUdp { + QString serialNumber; + MacAddress macAddress; + QHostAddress ipAddress; + } PantaboxUdp; + + bool available() const; + + QHash results() const; + +signals: + void pantaboxDiscovered(const PantaboxUdp &pantabox); + +private slots: + void readPendingDatagrams(); + +private: + QUdpSocket *m_socket = nullptr; + bool m_available = false; + + QHash m_buffers; + QHash m_prefixStartDiscovered; + + quint8 calculateCrc8(const QByteArray &data); + void processDataBuffer(const QHostAddress &address); + + QHash m_results; +}; + +#endif // PANTABOXUDPDISCOVERY_H