ETM-Schurig/etm-powersync-plugins
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

go-e: Add zeroconf discovery support

Browse Source
This commit is contained in:
Simon Stürz 2024-03-27 16:25:54 +01:00
parent d4d9ad698d
commit 3e6f26a03b
4 changed files with 239 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
goecharger/goediscovery.cpp
View File

@ -1,6 +1,6 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* Copyright 2013 - 2022, nymea GmbH * Copyright 2013 - 2024, nymea GmbH
* Contact: contact@nymea.io * Contact: contact@nymea.io
* *
* This file is part of nymea. * This file is part of nymea.
@ -34,10 +34,11 @@
#include <QJsonDocument> #include <QJsonDocument>
#include <QJsonParseError> #include <QJsonParseError>
GoeDiscovery::GoeDiscovery(NetworkAccessManager *networkAccessManager, NetworkDeviceDiscovery *networkDeviceDiscovery, QObject *parent) : GoeDiscovery::GoeDiscovery(NetworkAccessManager *networkAccessManager, NetworkDeviceDiscovery *networkDeviceDiscovery, ZeroConfServiceBrowser *serviceBrowser, QObject *parent) :
QObject(parent), QObject{parent},
m_networkAccessManager(networkAccessManager), m_networkAccessManager{networkAccessManager},
m_networkDeviceDiscovery(networkDeviceDiscovery) m_networkDeviceDiscovery{networkDeviceDiscovery},
m_serviceBrowser{serviceBrowser}
{ {
} }
@ -57,6 +58,14 @@ void GoeDiscovery::startDiscovery()
m_startDateTime = QDateTime::currentDateTime(); m_startDateTime = QDateTime::currentDateTime();
qCInfo(dcGoECharger()) << "Discovery: Start discovering the network..."; qCInfo(dcGoECharger()) << "Discovery: Start discovering the network...";
// ZeroConf
connect(m_serviceBrowser, &ZeroConfServiceBrowser::serviceEntryAdded, this, &GoeDiscovery::onServiceEntryAdded);
foreach (const ZeroConfServiceEntry &serviceEntry, m_serviceBrowser->serviceEntries()) {
onServiceEntryAdded(serviceEntry);
}
// Network discovery
m_discoveryReply = m_networkDeviceDiscovery->discover(); m_discoveryReply = m_networkDeviceDiscovery->discover();
// Test any network device beeing discovered // Test any network device beeing discovered
@ -112,6 +121,11 @@ QNetworkRequest GoeDiscovery::buildRequestV2(const QHostAddress &address)
return QNetworkRequest(requestUrl); return QNetworkRequest(requestUrl);
} }
bool GoeDiscovery::isGoeCharger(const ZeroConfServiceEntry &serviceEntry)
{
return serviceEntry.name().toLower().contains("go-echarger");
}
void GoeDiscovery::checkNetworkDevice(const NetworkDeviceInfo &networkDeviceInfo) void GoeDiscovery::checkNetworkDevice(const NetworkDeviceInfo &networkDeviceInfo)
{ {
// Make sure we have not checked this host yet // Make sure we have not checked this host yet
@ -154,6 +168,12 @@ void GoeDiscovery::checkNetworkDeviceApiV1(const NetworkDeviceInfo &networkDevic
// Looks like we have found a go-e V1 api endpoint, nice // Looks like we have found a go-e V1 api endpoint, nice
qCDebug(dcGoECharger()) << "Discovery: --> Found API V1 on" << networkDeviceInfo.address().toString(); qCDebug(dcGoECharger()) << "Discovery: --> Found API V1 on" << networkDeviceInfo.address().toString();
if (m_discoveryResults.contains(networkDeviceInfo.address()) && m_discoveryResults.value(networkDeviceInfo.address()).discoveryMethod == DiscoveryMethodZeroConf) {
qCDebug(dcGoECharger()) << "Discovery: Network discovery found API V1 go-eCharger on" << networkDeviceInfo.address().toString()
<< "but this host has already been discovered using ZeroConf. Prefering ZeroConf over MAC address due to Repeater missbehaviours.";
return;
}
if (m_discoveryResults.contains(networkDeviceInfo.address())) { if (m_discoveryResults.contains(networkDeviceInfo.address())) {
// We use the information from API V2 since there are more information available // We use the information from API V2 since there are more information available
m_discoveryResults[networkDeviceInfo.address()].apiAvailableV1 = true; m_discoveryResults[networkDeviceInfo.address()].apiAvailableV1 = true;
@ -209,11 +229,19 @@ void GoeDiscovery::checkNetworkDeviceApiV2(const NetworkDeviceInfo &networkDevic
result.product = responseMap.value("typ").toString(); result.product = responseMap.value("typ").toString();
result.friendlyName = responseMap.value("fna").toString(); result.friendlyName = responseMap.value("fna").toString();
result.networkDeviceInfo = networkDeviceInfo; result.networkDeviceInfo = networkDeviceInfo;
result.discoveryMethod = DiscoveryMethodNetwork;
result.apiAvailableV2 = true; result.apiAvailableV2 = true;
if (m_discoveryResults.contains(networkDeviceInfo.address()) && m_discoveryResults.value(networkDeviceInfo.address()).discoveryMethod == DiscoveryMethodZeroConf) {
qCDebug(dcGoECharger()) << "Discovery: Network discovery found API V2 go-eCharger on" << networkDeviceInfo.address().toString()
<< "but this host has already been discovered using ZeroConf. Prefering ZeroConf over MAC address due to Repeater missbehaviours.";
return;
}
if (m_discoveryResults.contains(networkDeviceInfo.address())) { if (m_discoveryResults.contains(networkDeviceInfo.address())) {
result.apiAvailableV1 = m_discoveryResults.value(networkDeviceInfo.address()).apiAvailableV1; result.apiAvailableV1 = m_discoveryResults.value(networkDeviceInfo.address()).apiAvailableV1;
} }
// Overwrite result from V1 since V2 contains more information // Overwrite result from V1 since V2 contains more information
m_discoveryResults[networkDeviceInfo.address()] = result; m_discoveryResults[networkDeviceInfo.address()] = result;
} else { } else {
@ -222,6 +250,33 @@ void GoeDiscovery::checkNetworkDeviceApiV2(const NetworkDeviceInfo &networkDevic
}); });
} }
void GoeDiscovery::onServiceEntryAdded(const ZeroConfServiceEntry &serviceEntry)
{
// Note: we always prefere the zeroconf discovery over the network discovery. Some networks use wifi repeaters,
// which spoof the mac address and multipe IP have the same mac address. Using zeroconf and have IP based discovery
// solves this issue
if (isGoeCharger(serviceEntry)) {
qCDebug(dcGoECharger()) << "Discovery: Found ZeroConf go-eCharger" << serviceEntry;
GoeDiscovery::Result result;
result.serialNumber = serviceEntry.txt("serial");
result.firmwareVersion = serviceEntry.txt("version");
result.manufacturer = serviceEntry.txt("manufacturer");
result.product = serviceEntry.txt("devicetype");
result.friendlyName = serviceEntry.txt("friendly_name");
result.discoveryMethod = DiscoveryMethodZeroConf;
result.apiAvailableV1 = serviceEntry.txt("protocol").toUInt() == 1;
result.apiAvailableV2 = serviceEntry.txt("protocol").toUInt() == 2;
result.address = serviceEntry.hostAddress();
qCDebug(dcGoECharger()) << "Discovery:" << result;
// Overwrite any already discovered result for this host, we always prefere ZeroConf over Networkdiscovery...
m_discoveryResults[result.address] = result;
}
}
void GoeDiscovery::cleanupPendingReplies() void GoeDiscovery::cleanupPendingReplies()
{ {
foreach (QNetworkReply *reply, m_pendingReplies) { foreach (QNetworkReply *reply, m_pendingReplies) {
@ -232,6 +287,9 @@ void GoeDiscovery::cleanupPendingReplies()
void GoeDiscovery::finishDiscovery() void GoeDiscovery::finishDiscovery()
{ {
disconnect(m_serviceBrowser, &ZeroConfServiceBrowser::serviceEntryAdded, this, &GoeDiscovery::onServiceEntryAdded);
qint64 durationMilliSeconds = QDateTime::currentMSecsSinceEpoch() - m_startDateTime.toMSecsSinceEpoch(); qint64 durationMilliSeconds = QDateTime::currentMSecsSinceEpoch() - m_startDateTime.toMSecsSinceEpoch();
qCInfo(dcGoECharger()) << "Discovery: Finished the discovery process. Found" << m_discoveryResults.count() << "go-eChargers in" << QTime::fromMSecsSinceStartOfDay(durationMilliSeconds).toString("mm:ss.zzz"); qCInfo(dcGoECharger()) << "Discovery: Finished the discovery process. Found" << m_discoveryResults.count() << "go-eChargers in" << QTime::fromMSecsSinceStartOfDay(durationMilliSeconds).toString("mm:ss.zzz");
cleanupPendingReplies(); cleanupPendingReplies();
@ -246,8 +304,13 @@ QDebug operator<<(QDebug dbg, const GoeDiscovery::Result &result)
dbg.nospace() << ", SN: " << result.serialNumber; dbg.nospace() << ", SN: " << result.serialNumber;
dbg.nospace() << ", V1: " << result.apiAvailableV1; dbg.nospace() << ", V1: " << result.apiAvailableV1;
dbg.nospace() << ", V2: " << result.apiAvailableV2; dbg.nospace() << ", V2: " << result.apiAvailableV2;
dbg.nospace() << ", " << result.networkDeviceInfo.address().toString(); if (result.discoveryMethod == GoeDiscovery::DiscoveryMethodZeroConf) {
dbg.nospace() << ", " << result.networkDeviceInfo.macAddress(); dbg.nospace() << ", " << result.discoveryMethod;
dbg.nospace() << ", " << result.address.toString();
} else {
dbg.nospace() << ", " << result.networkDeviceInfo.address().toString();
dbg.nospace() << ", " << result.networkDeviceInfo.macAddress();
}
dbg.nospace() << ") "; dbg.nospace() << ") ";
return dbg.maybeSpace(); return dbg.maybeSpace();
} }

24
goecharger/goediscovery.h
View File

@ -1,6 +1,6 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* Copyright 2013 - 2022, nymea GmbH * Copyright 2013 - 2024, nymea GmbH
* Contact: contact@nymea.io * Contact: contact@nymea.io
* *
* This file is part of nymea. * This file is part of nymea.
@ -36,23 +36,34 @@
#include <network/networkaccessmanager.h> #include <network/networkaccessmanager.h>
#include <network/networkdevicediscovery.h> #include <network/networkdevicediscovery.h>
#include <network/networkdevicediscovery.h>
#include <platform/platformzeroconfcontroller.h>
#include <network/zeroconf/zeroconfservicebrowser.h>
class GoeDiscovery : public QObject class GoeDiscovery : public QObject
{ {
Q_OBJECT Q_OBJECT
public: public:
enum DiscoveryMethod {
DiscoveryMethodNetwork,
DiscoveryMethodZeroConf,
};
Q_ENUM(DiscoveryMethod)
typedef struct Result { typedef struct Result {
QString product = "go-eCharger"; QString product = "go-eCharger";
QString manufacturer = "go-e"; QString manufacturer = "go-e";
QString friendlyName; QString friendlyName;
QString serialNumber; QString serialNumber;
QString firmwareVersion; QString firmwareVersion;
NetworkDeviceInfo networkDeviceInfo; DiscoveryMethod discoveryMethod;
NetworkDeviceInfo networkDeviceInfo; // Network discovery
QHostAddress address; // ZeroConf
bool apiAvailableV1 = false; bool apiAvailableV1 = false;
bool apiAvailableV2 = false; bool apiAvailableV2 = false;
} Result; } Result;
explicit GoeDiscovery(NetworkAccessManager *networkAccessManager, NetworkDeviceDiscovery *networkDeviceDiscovery, QObject *parent = nullptr); explicit GoeDiscovery(NetworkAccessManager *networkAccessManager, NetworkDeviceDiscovery *networkDeviceDiscovery, ZeroConfServiceBrowser *serviceBrowser, QObject *parent = nullptr);
~GoeDiscovery(); ~GoeDiscovery();
void startDiscovery(); void startDiscovery();
@ -62,6 +73,9 @@ public:
static QNetworkRequest buildRequestV1(const QHostAddress &address); static QNetworkRequest buildRequestV1(const QHostAddress &address);
static QNetworkRequest buildRequestV2(const QHostAddress &address); static QNetworkRequest buildRequestV2(const QHostAddress &address);
// Zeroconf service helpers
static bool isGoeCharger(const ZeroConfServiceEntry &serviceEntry);
signals: signals:
void discoveryFinished(); void discoveryFinished();
@ -70,10 +84,12 @@ private:
NetworkAccessManager *m_networkAccessManager = nullptr; NetworkAccessManager *m_networkAccessManager = nullptr;
NetworkDeviceDiscovery *m_networkDeviceDiscovery = nullptr; NetworkDeviceDiscovery *m_networkDeviceDiscovery = nullptr;
NetworkDeviceDiscoveryReply *m_discoveryReply = nullptr; NetworkDeviceDiscoveryReply *m_discoveryReply = nullptr;
ZeroConfServiceBrowser *m_serviceBrowser = nullptr;
QHash<QHostAddress, GoeDiscovery::Result> m_discoveryResults; QHash<QHostAddress, GoeDiscovery::Result> m_discoveryResults;
NetworkDeviceInfos m_discoveredNetworkDeviceInfos; NetworkDeviceInfos m_discoveredNetworkDeviceInfos;
NetworkDeviceInfos m_verifiedNetworkDeviceInfos; NetworkDeviceInfos m_verifiedNetworkDeviceInfos;
QList<QNetworkReply *> m_pendingReplies; QList<QNetworkReply *> m_pendingReplies;
private slots: private slots:
@ -81,6 +97,8 @@ private slots:
void checkNetworkDeviceApiV1(const NetworkDeviceInfo &networkDeviceInfo); void checkNetworkDeviceApiV1(const NetworkDeviceInfo &networkDeviceInfo);
void checkNetworkDeviceApiV2(const NetworkDeviceInfo &networkDeviceInfo); void checkNetworkDeviceApiV2(const NetworkDeviceInfo &networkDeviceInfo);
void onServiceEntryAdded(const ZeroConfServiceEntry &serviceEntry);
void cleanupPendingReplies(); void cleanupPendingReplies();
void finishDiscovery(); void finishDiscovery();

238
goecharger/integrationplugingoecharger.cpp
View File

@ -1,6 +1,6 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* Copyright 2013 - 2022, nymea GmbH * Copyright 2013 - 2024, nymea GmbH
* Contact: contact@nymea.io * Contact: contact@nymea.io
* *
* This file is part of nymea. * This file is part of nymea.
@ -28,9 +28,10 @@
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#include "plugininfo.h"
#include "integrationplugingoecharger.h" #include "integrationplugingoecharger.h"
#include "network/networkdevicediscovery.h" #include "plugininfo.h"
#include "goediscovery.h"
#include <QUrlQuery> #include <QUrlQuery>
#include <QHostAddress> #include <QHostAddress>
@ -38,8 +39,6 @@
#include <QJsonDocument> #include <QJsonDocument>
#include <QJsonParseError> #include <QJsonParseError>
#include "goediscovery.h"
// API documentation: // API documentation:
// V1: https://github.com/goecharger/go-eCharger-API-v1 // V1: https://github.com/goecharger/go-eCharger-API-v1
// V2: https://github.com/goecharger/go-eCharger-API-v2 // V2: https://github.com/goecharger/go-eCharger-API-v2
@ -52,6 +51,12 @@ IntegrationPluginGoECharger::IntegrationPluginGoECharger()
void IntegrationPluginGoECharger::init() void IntegrationPluginGoECharger::init()
{ {
connect(this, &IntegrationPlugin::configValueChanged, this, &IntegrationPluginGoECharger::onConfigValueChanged); connect(this, &IntegrationPlugin::configValueChanged, this, &IntegrationPluginGoECharger::onConfigValueChanged);
if (!m_serviceBrowser) {
m_serviceBrowser = hardwareManager()->zeroConfController()->createServiceBrowser();
connect(m_serviceBrowser, &ZeroConfServiceBrowser::serviceEntryAdded, this, &IntegrationPluginGoECharger::onServiceEntryAdded);
}
} }
void IntegrationPluginGoECharger::discoverThings(ThingDiscoveryInfo *info) void IntegrationPluginGoECharger::discoverThings(ThingDiscoveryInfo *info)
@ -62,7 +67,8 @@ void IntegrationPluginGoECharger::discoverThings(ThingDiscoveryInfo *info)
return; return;
} }
GoeDiscovery *discovery = new GoeDiscovery(hardwareManager()->networkManager(), hardwareManager()->networkDeviceDiscovery(), this); GoeDiscovery *discovery = new GoeDiscovery(hardwareManager()->networkManager(), hardwareManager()->networkDeviceDiscovery(), m_serviceBrowser, this);
connect(discovery, &GoeDiscovery::discoveryFinished, discovery, &GoeDiscovery::deleteLater); connect(discovery, &GoeDiscovery::discoveryFinished, discovery, &GoeDiscovery::deleteLater);
connect(discovery, &GoeDiscovery::discoveryFinished, info, [=](){ connect(discovery, &GoeDiscovery::discoveryFinished, info, [=](){
foreach (const GoeDiscovery::Result &result, discovery->discoveryResults()) { foreach (const GoeDiscovery::Result &result, discovery->discoveryResults()) {
@ -79,7 +85,13 @@ void IntegrationPluginGoECharger::discoverThings(ThingDiscoveryInfo *info)
title += " (" + result.manufacturer + ")"; title += " (" + result.manufacturer + ")";
} }
QString description = "Serial: " + result.serialNumber + ", V: " + result.firmwareVersion + " - " + result.networkDeviceInfo.address().toString(); QString description = "Serial: " + result.serialNumber + ", V: " + result.firmwareVersion;
if (result.discoveryMethod == GoeDiscovery::DiscoveryMethodNetwork) {
description.append(" - " + result.networkDeviceInfo.address().toString());
} else {
description.append(" - " + result.address.toString());
}
qCDebug(dcGoECharger()) << "-->" << title << description; qCDebug(dcGoECharger()) << "-->" << title << description;
ThingDescriptor descriptor(goeHomeThingClassId, title, description); ThingDescriptor descriptor(goeHomeThingClassId, title, description);
ParamList params; ParamList params;
@ -89,7 +101,7 @@ void IntegrationPluginGoECharger::discoverThings(ThingDiscoveryInfo *info)
descriptor.setParams(params); descriptor.setParams(params);
// Check if we already have set up this device // Check if we already have set up this device
Things existingThings = myThings().filterByParam(goeHomeThingMacAddressParamTypeId, result.networkDeviceInfo.macAddress()); Things existingThings = myThings().filterByParam(goeHomeThingSerialNumberParamTypeId, result.serialNumber);
if (existingThings.count() == 1) { if (existingThings.count() == 1) {
qCDebug(dcGoECharger()) << "This wallbox already exists in the system!" << result.networkDeviceInfo; qCDebug(dcGoECharger()) << "This wallbox already exists in the system!" << result.networkDeviceInfo;
descriptor.setThingId(existingThings.first()->id()); descriptor.setThingId(existingThings.first()->id());
@ -112,103 +124,110 @@ void IntegrationPluginGoECharger::setupThing(ThingSetupInfo *info)
MacAddress macAddress = MacAddress(thing->paramValue(goeHomeThingMacAddressParamTypeId).toString()); MacAddress macAddress = MacAddress(thing->paramValue(goeHomeThingMacAddressParamTypeId).toString());
if (!macAddress.isValid()) { if (!macAddress.isValid()) {
qCWarning(dcGoECharger()) << "The configured mac address is not valid" << thing->params(); // ZeroConf
info->finish(Thing::ThingErrorInvalidParameter, QT_TR_NOOP("The MAC address is not known. Please reconfigure the thing.")); QHostAddress address = getHostAddress(thing);
return; if (address.isNull()) {
} qCWarning(dcGoECharger()) << "Cannot set up go-eCharger. The host address is not known yet. Maybe it will be available in the next run...";
// Handle reconfigure
if (m_monitors.contains(thing))
hardwareManager()->networkDeviceDiscovery()->unregisterMonitor(m_monitors.take(thing));
// Create the monitor
NetworkDeviceMonitor *monitor = hardwareManager()->networkDeviceDiscovery()->registerMonitor(macAddress);
m_monitors.insert(thing, monitor);
QHostAddress address = getHostAddress(thing);
if (address.isNull()) {
qCWarning(dcGoECharger()) << "Cannot set up go-eCharger. The host address is not known yet. Maybe it will be available in the next run...";
hardwareManager()->networkDeviceDiscovery()->unregisterMonitor(m_monitors.take(thing));
info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The host address is not known yet. Trying later again."));
return;
}
// Clean up in case the setup gets aborted
connect(info, &ThingSetupInfo::aborted, monitor, [=](){
if (m_monitors.contains(thing)) {
qCDebug(dcGoECharger()) << "Unregister monitor because setup has been aborted.";
hardwareManager()->networkDeviceDiscovery()->unregisterMonitor(m_monitors.take(thing)); hardwareManager()->networkDeviceDiscovery()->unregisterMonitor(m_monitors.take(thing));
info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The host address is not known yet. Trying later again."));
return;
} }
});
connect(monitor, &NetworkDeviceMonitor::reachableChanged, thing, [=](bool reachable){ setupGoeHome(info);
qCDebug(dcGoECharger()) << "Network device monitor reachable changed for" << thing->name() << reachable; return;
if (reachable && thing->setupComplete() && !thing->stateValue("connected").toBool()) { } else {
// The device is reachable again and we have already set it up. // Handle reconfigure
// Update data and optionally reconfigure the mqtt channel if (m_monitors.contains(thing))
hardwareManager()->networkDeviceDiscovery()->unregisterMonitor(m_monitors.take(thing));
QNetworkReply *reply = hardwareManager()->networkManager()->get(buildStatusRequest(thing, true)); // Create the monitor
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater); NetworkDeviceMonitor *monitor = hardwareManager()->networkDeviceDiscovery()->registerMonitor(macAddress);
connect(reply, &QNetworkReply::finished, thing, [=](){ m_monitors.insert(thing, monitor);
if (reply->error() != QNetworkReply::NoError) { QHostAddress address = getHostAddress(thing);
qCWarning(dcGoECharger()) << "HTTP status reply returned error:" << reply->errorString() << reply->readAll(); if (address.isNull()) {
return; qCWarning(dcGoECharger()) << "Cannot set up go-eCharger. The host address is not known yet. Maybe it will be available in the next run...";
} hardwareManager()->networkDeviceDiscovery()->unregisterMonitor(m_monitors.take(thing));
info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The host address is not known yet. Trying later again."));
return;
}
QByteArray data = reply->readAll(); // Clean up in case the setup gets aborted
QJsonParseError error; connect(info, &ThingSetupInfo::aborted, monitor, [=](){
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error); if (m_monitors.contains(thing)) {
if (error.error != QJsonParseError::NoError) { qCDebug(dcGoECharger()) << "Unregister monitor because setup has been aborted.";
qCWarning(dcGoECharger()) << "Failed to parse status data for thing " << thing->name() << qUtf8Printable(data) << error.errorString(); hardwareManager()->networkDeviceDiscovery()->unregisterMonitor(m_monitors.take(thing));
return; }
} });
qCDebug(dcGoECharger()) << "Initial status map" << qUtf8Printable(jsonDoc.toJson(QJsonDocument::Compact)); connect(monitor, &NetworkDeviceMonitor::reachableChanged, thing, [=](bool reachable){
QVariantMap statusMap = jsonDoc.toVariant().toMap(); qCDebug(dcGoECharger()) << "Network device monitor reachable changed for" << thing->name() << reachable;
if (reachable && thing->setupComplete() && !thing->stateValue("connected").toBool()) {
ApiVersion apiVersion = getApiVersion(thing); // The device is reachable again and we have already set it up.
switch (apiVersion) { // Update data and optionally reconfigure the mqtt channel
case ApiVersion1:
if (thing->paramValue(goeHomeThingUseMqttParamTypeId).toBool()) { QNetworkReply *reply = hardwareManager()->networkManager()->get(buildStatusRequest(thing, true));
// Verify mqtt client and set it up connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
qCDebug(dcGoECharger()) << "Setup using MQTT connection for" << thing; connect(reply, &QNetworkReply::finished, thing, [=](){
reconfigureMqttChannelV1(thing, statusMap); if (reply->error() != QNetworkReply::NoError) {
} else { qCWarning(dcGoECharger()) << "HTTP status reply returned error:" << reply->errorString() << reply->readAll();
// Since we are not using mqtt, we are done with the setup, the refresh timer will be configured in post setup return;
qCDebug(dcGoECharger()) << "Setup using HTTP finished successfully";
updateV1(thing, statusMap);
} }
break;
case ApiVersion2: QByteArray data = reply->readAll();
if (thing->paramValue(goeHomeThingUseMqttParamTypeId).toBool()) { QJsonParseError error;
// Verify mqtt client and set it up QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
qCDebug(dcGoECharger()) << "Setup using MQTT connection for" << thing; if (error.error != QJsonParseError::NoError) {
reconfigureMqttChannelV2(thing); qCWarning(dcGoECharger()) << "Failed to parse status data for thing " << thing->name() << qUtf8Printable(data) << error.errorString();
} else { return;
// Since we are not using mqtt, we are done with the setup, the refresh timer will be configured in post setup
qCDebug(dcGoECharger()) << "Setup using HTTP finished successfully";
updateV2(thing, statusMap);
} }
break;
qCDebug(dcGoECharger()) << "Initial status map" << qUtf8Printable(jsonDoc.toJson(QJsonDocument::Compact));
QVariantMap statusMap = jsonDoc.toVariant().toMap();
ApiVersion apiVersion = getApiVersion(thing);
switch (apiVersion) {
case ApiVersion1:
if (thing->paramValue(goeHomeThingUseMqttParamTypeId).toBool()) {
// Verify mqtt client and set it up
qCDebug(dcGoECharger()) << "Setup using MQTT connection for" << thing;
reconfigureMqttChannelV1(thing, statusMap);
} else {
// Since we are not using mqtt, we are done with the setup, the refresh timer will be configured in post setup
qCDebug(dcGoECharger()) << "Setup using HTTP finished successfully";
updateV1(thing, statusMap);
}
break;
case ApiVersion2:
if (thing->paramValue(goeHomeThingUseMqttParamTypeId).toBool()) {
// Verify mqtt client and set it up
qCDebug(dcGoECharger()) << "Setup using MQTT connection for" << thing;
reconfigureMqttChannelV2(thing);
} else {
// Since we are not using mqtt, we are done with the setup, the refresh timer will be configured in post setup
qCDebug(dcGoECharger()) << "Setup using HTTP finished successfully";
updateV2(thing, statusMap);
}
break;
}
});
}
});
// Wait for the monitor to be ready
if (monitor->reachable()) {
// Thing already reachable...let's finish the setup
setupGoeHome(info);
} else {
qCDebug(dcGoECharger()) << "Wait for the network monitor to get reachable";
connect(monitor, &NetworkDeviceMonitor::reachableChanged, info, [=](bool reachable){
if (reachable) {
setupGoeHome(info);
} }
}); });
} }
});
// Wait for the monitor to be ready
if (monitor->reachable()) {
// Thing already reachable...let's finish the setup
setupGoeHome(info);
} else {
qCDebug(dcGoECharger()) << "Wait for the network monitor to get reachable";
connect(monitor, &NetworkDeviceMonitor::reachableChanged, info, [=](bool reachable){
if (reachable) {
setupGoeHome(info);
}
});
} }
Q_ASSERT_X(false, "setupThing", QString("Unhandled thingClassId: %1").arg(thing->thingClassId().toString()).toUtf8());
} }
void IntegrationPluginGoECharger::postSetupThing(Thing *thing) void IntegrationPluginGoECharger::postSetupThing(Thing *thing)
@ -288,7 +307,7 @@ void IntegrationPluginGoECharger::executeAction(ThingActionInfo *info)
return; return;
} }
if (!thing->stateValue("connected").toBool()) { if (!thing->stateValue("connected").toBool() || address.isNull()) {
qCWarning(dcGoECharger()) << thing << "failed to execute action. The device seems not to be connected."; qCWarning(dcGoECharger()) << thing << "failed to execute action. The device seems not to be connected.";
info->finish(Thing::ThingErrorHardwareNotAvailable); info->finish(Thing::ThingErrorHardwareNotAvailable);
return; return;
@ -330,7 +349,8 @@ void IntegrationPluginGoECharger::executeAction(ThingActionInfo *info)
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater); connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
connect(reply, &QNetworkReply::finished, info, [=](){ connect(reply, &QNetworkReply::finished, info, [=](){
if (reply->error() != QNetworkReply::NoError) { if (reply->error() != QNetworkReply::NoError) {
qCWarning(dcGoECharger()) << "Execute action failed for" << thing->name() << "HTTP error:" << reply->errorString() << reply->readAll() << "Request was:" << request.url().toString(); qCWarning(dcGoECharger()) << "Execute action failed for" << thing->name() << "HTTP error:" << reply->errorString() << reply->readAll()
<< "Request was:" << request.url().toString();
info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("The wallbox does not seem to be reachable.")); info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("The wallbox does not seem to be reachable."));
return; return;
} }
@ -339,7 +359,8 @@ void IntegrationPluginGoECharger::executeAction(ThingActionInfo *info)
QJsonParseError error; QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error); QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) { if (error.error != QJsonParseError::NoError) {
qCWarning(dcGoECharger()) << "Execute action failed for" << thing->name() << "Parsing data failed:" << qUtf8Printable(data) << error.errorString() << "Request was:" << request.url().toString(); qCWarning(dcGoECharger()) << "Execute action failed for" << thing->name() << "Parsing data failed:" << qUtf8Printable(data) << error.errorString()
<< "Request was:" << request.url().toString();
info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The wallbox returned invalid data.")); info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The wallbox returned invalid data."));
return; return;
} }
@ -369,7 +390,8 @@ void IntegrationPluginGoECharger::executeAction(ThingActionInfo *info)
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater); connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
connect(reply, &QNetworkReply::finished, info, [=](){ connect(reply, &QNetworkReply::finished, info, [=](){
if (reply->error() != QNetworkReply::NoError) { if (reply->error() != QNetworkReply::NoError) {
qCWarning(dcGoECharger()) << "Execute action failed for" << thing->name() << "HTTP error:" << reply->errorString() << reply->readAll() << "Request was:" << request.url().toString(); qCWarning(dcGoECharger()) << "Execute action failed for" << thing->name() << "HTTP error:" << reply->errorString() << reply->readAll()
<< "Request was:" << request.url().toString();
info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("The wallbox does not seem to be reachable.")); info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("The wallbox does not seem to be reachable."));
return; return;
} }
@ -378,7 +400,8 @@ void IntegrationPluginGoECharger::executeAction(ThingActionInfo *info)
QJsonParseError error; QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error); QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) { if (error.error != QJsonParseError::NoError) {
qCWarning(dcGoECharger()) << "Execute action failed for" << thing->name() << "Failed to parse data" << qUtf8Printable(data) << error.errorString() << "Request was:" << request.url().toString(); qCWarning(dcGoECharger()) << "Execute action failed for" << thing->name() << "Failed to parse data" << qUtf8Printable(data) << error.errorString()
<< "Request was:" << request.url().toString();
info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The wallbox returned invalid data.")); info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The wallbox returned invalid data."));
return; return;
} }
@ -408,7 +431,8 @@ void IntegrationPluginGoECharger::executeAction(ThingActionInfo *info)
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater); connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
connect(reply, &QNetworkReply::finished, info, [=](){ connect(reply, &QNetworkReply::finished, info, [=](){
if (reply->error() != QNetworkReply::NoError) { if (reply->error() != QNetworkReply::NoError) {
qCWarning(dcGoECharger()) << "Execute action failed for" << thing->name() << "HTTP error:" << reply->errorString() << reply->readAll() << "Request was:" << request.url().toString(); qCWarning(dcGoECharger()) << "Execute action failed for" << thing->name() << "HTTP error:" << reply->errorString() << reply->readAll()
<< "Request was:" << request.url().toString();
info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("The wallbox does not seem to be reachable.")); info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("The wallbox does not seem to be reachable."));
return; return;
} }
@ -417,7 +441,8 @@ void IntegrationPluginGoECharger::executeAction(ThingActionInfo *info)
QJsonParseError error; QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error); QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) { if (error.error != QJsonParseError::NoError) {
qCWarning(dcGoECharger()) << "Execute action failed for" << thing->name() << "Failed to parse data" << qUtf8Printable(data) << error.errorString() << "Request was:" << request.url().toString(); qCWarning(dcGoECharger()) << "Execute action failed for" << thing->name() << "Failed to parse data" << qUtf8Printable(data) << error.errorString()
<< "Request was:" << request.url().toString();
info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The wallbox returned invalid data.")); info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The wallbox returned invalid data."));
return; return;
} }
@ -551,6 +576,15 @@ QHostAddress IntegrationPluginGoECharger::getHostAddress(Thing *thing)
if (m_monitors.contains(thing)) if (m_monitors.contains(thing))
return m_monitors.value(thing)->networkDeviceInfo().address(); return m_monitors.value(thing)->networkDeviceInfo().address();
foreach (const ZeroConfServiceEntry &serviceEntry, m_serviceBrowser->serviceEntries()) {
if (GoeDiscovery::isGoeCharger(serviceEntry)) {
QString serial = serviceEntry.txt("serial");
if (thing->paramValue(goeHomeThingSerialNumberParamTypeId).toString() == serial) {
return serviceEntry.hostAddress();
}
}
}
return QHostAddress(); return QHostAddress();
} }
@ -1551,6 +1585,14 @@ void IntegrationPluginGoECharger::onConfigValueChanged(const ParamTypeId &paramT
} }
} }
void IntegrationPluginGoECharger::onServiceEntryAdded(const ZeroConfServiceEntry &serviceEntry)
{
if (GoeDiscovery::isGoeCharger(serviceEntry)) {
qCDebug(dcGoECharger()) << "Found ZeroConf go-eCharger:" << serviceEntry;
}
}
void IntegrationPluginGoECharger::onMqttClientV1Connected(MqttChannel *channel) void IntegrationPluginGoECharger::onMqttClientV1Connected(MqttChannel *channel)
{ {

9
goecharger/integrationplugingoecharger.h
View File

@ -1,6 +1,6 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* Copyright 2013 - 2022, nymea GmbH * Copyright 2013 - 2024, nymea GmbH
* Contact: contact@nymea.io * Contact: contact@nymea.io
* *
* This file is part of nymea. * This file is part of nymea.
@ -40,6 +40,8 @@
#include <network/networkdevicemonitor.h> #include <network/networkdevicemonitor.h>
#include <integrations/integrationplugin.h> #include <integrations/integrationplugin.h>
#include <network/zeroconf/zeroconfservicebrowser.h>
#include "extern-plugininfo.h" #include "extern-plugininfo.h"
class IntegrationPluginGoECharger: public IntegrationPlugin class IntegrationPluginGoECharger: public IntegrationPlugin
@ -112,6 +114,8 @@ private:
QHash<Thing *, QNetworkReply *> m_pendingReplies; QHash<Thing *, QNetworkReply *> m_pendingReplies;
QHash<Thing *, NetworkDeviceMonitor *> m_monitors; QHash<Thing *, NetworkDeviceMonitor *> m_monitors;
ZeroConfServiceBrowser *m_serviceBrowser = nullptr;
// General methods // General methods
void setupGoeHome(ThingSetupInfo *info); void setupGoeHome(ThingSetupInfo *info);
QNetworkRequest buildStatusRequest(Thing *thing, bool fullStatus = false); QNetworkRequest buildStatusRequest(Thing *thing, bool fullStatus = false);
@ -136,6 +140,9 @@ private slots:
void onConfigValueChanged(const ParamTypeId &paramTypeId, const QVariant &value); void onConfigValueChanged(const ParamTypeId &paramTypeId, const QVariant &value);
// ZeroConf
void onServiceEntryAdded(const ZeroConfServiceEntry &serviceEntry);
// API V1 // API V1
void onMqttClientV1Connected(MqttChannel* channel); void onMqttClientV1Connected(MqttChannel* channel);
void onMqttClientV1Disconnected(MqttChannel* channel); void onMqttClientV1Disconnected(MqttChannel* channel);