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

Fronius: Make use of network device discovery if possible

master
Simon Stürz 2023-08-01 12:40:44 +02:00
parent 060ebeef98
commit 9b2afdb7bc
6 changed files with 142 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
fronius/froniusdiscovery.cpp
View File

@ -51,11 +51,11 @@ FroniusDiscovery::FroniusDiscovery(NetworkAccessManager *networkManager, Network
void FroniusDiscovery::startDiscovery()
{
qCInfo(dcFronius()) << "Discovery: Searching for Fronius solar devices in the network...";
qCDebug(dcFronius()) << "Discovery: Searching for Fronius solar devices in the network...";
m_startDateTime = QDateTime::currentDateTime();
NetworkDeviceDiscoveryReply *discoveryReply = m_networkDeviceDiscovery->discover();
connect(discoveryReply, &NetworkDeviceDiscoveryReply::networkDeviceInfoAdded, this, &FroniusDiscovery::checkNetworkDevice);
connect(discoveryReply, &NetworkDeviceDiscoveryReply::finished, this, [=](){
qCDebug(dcFronius()) << "Discovery: Network discovery finished. Found" << discoveryReply->networkDeviceInfos().count() << "network devices";
m_gracePeriodTimer.start();
@ -70,7 +70,7 @@ QList<NetworkDeviceInfo> FroniusDiscovery::discoveryResults() const
void FroniusDiscovery::checkNetworkDevice(const NetworkDeviceInfo &networkDeviceInfo)
{
qCDebug(dcFronius()) << "Checking network device:" << networkDeviceInfo;
qCDebug(dcFronius()) << "Discovery: Checking network device:" << networkDeviceInfo;
FroniusSolarConnection *connection = new FroniusSolarConnection(m_networkManager, networkDeviceInfo.address(), this);
m_connections.append(connection);
@ -80,9 +80,9 @@ void FroniusDiscovery::checkNetworkDevice(const NetworkDeviceInfo &networkDevice
QByteArray data = reply->networkReply()->readAll();
if (reply->networkReply()->error() != QNetworkReply::NoError) {
if (reply->networkReply()->error() == QNetworkReply::ContentNotFoundError) {
qCInfo(dcFronius()) << "The device does not reply to our requests. Please verify that the Fronius Solar API is enabled on the device.";
qCInfo(dcFronius()) << "Discovery: The device on" << networkDeviceInfo.address().toString() << "does not reply to our requests. Please verify that the Fronius Solar API is enabled on the device.";
} else {
qCDebug(dcFronius()) << "device" << networkDeviceInfo.address() << "is not reachable.";
qCDebug(dcFronius()) << "Discovery: Reply finished with error on" << networkDeviceInfo.address().toString() << reply->networkReply()->errorString();
}
cleanupConnection(connection);
return;
@ -91,22 +91,22 @@ void FroniusDiscovery::checkNetworkDevice(const NetworkDeviceInfo &networkDevice
QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) {
qCWarning(dcFronius()) << "Failed to parse JSON data" << data << ":" << error.errorString() << data;
qCDebug(dcFronius()) << "Discovery: Failed to parse JSON data from" << networkDeviceInfo.address().toString() << ":" << error.errorString() << data;
cleanupConnection(connection);
return;
}
QVariantMap versionResponseMap = jsonDoc.toVariant().toMap();
if (!versionResponseMap.contains("CompatibilityRange")) {
qCInfo(dcFronius()) << "Unexpected JSON reply. PRobably not a Fronius device.";
qCDebug(dcFronius()) << "Discovery: Unexpected JSON reply from" << networkDeviceInfo.address().toString() << "Probably not a Fronius device.";
cleanupConnection(connection);
return;
}
qCDebug(dcFronius()) << "Compatibility version" << versionResponseMap.value("CompatibilityRange").toString();
qCDebug(dcFronius()) << "Discovery: Compatibility version" << versionResponseMap.value("CompatibilityRange").toString();
// Knwon version with broken JSON API. Still allowing to discover so the user will get a proper error message during setup
if (versionResponseMap.value("CompatibilityRange").toString() == "1.6-2") {
qCWarning(dcFronius()) << "The Fronius data logger has a version which is known to have a broken JSON API firmware.";
qCWarning(dcFronius()) << "Discovery: The Fronius data logger has a version which is known to have a broken JSON API firmware.";
}
m_discoveryResults.append(networkDeviceInfo);
@ -128,7 +128,7 @@ void FroniusDiscovery::finishDiscovery()
cleanupConnection(connection);
}
qCInfo(dcFronius()) << "Discovery: Finished the discovery process. Found" << m_discoveryResults.count()
qCDebug(dcFronius()) << "Discovery: Finished the discovery process. Found" << m_discoveryResults.count()
<< "Fronius devices in" << QTime::fromMSecsSinceStartOfDay(durationMilliSeconds).toString("mm:ss.zzz");
m_gracePeriodTimer.stop();

24
fronius/froniussolarconnection.cpp
View File

@ -46,6 +46,30 @@ QHostAddress FroniusSolarConnection::address() const
return m_address;
}
void FroniusSolarConnection::setAddress(const QHostAddress &address)
{
if (m_address == address)
return;
m_address = address;
// The address has changed, let's clean up any queue and refresh
// Note: the destructor will take care about the cleanup of any pending replies
qDeleteAll(m_requestQueue);
m_requestQueue.clear();
if (m_currentReply) {
m_currentReply->deleteLater();
m_currentReply = nullptr;
}
if (m_address.isNull()) {
m_available = false;
emit availableChanged(m_available);
}
}
bool FroniusSolarConnection::available() const
{
return m_available;

2
fronius/froniussolarconnection.h
View File

@ -32,7 +32,6 @@
#define FRONIUSSOLARCONNECTION_H
#include <QObject>
#include <QQueue>
#include <QHostAddress>
@ -47,6 +46,7 @@ public:
explicit FroniusSolarConnection(NetworkAccessManager *networkManager, const QHostAddress &address, QObject *parent = nullptr);
QHostAddress address() const;
void setAddress(const QHostAddress &address);
bool available() const;

152
fronius/integrationpluginfronius.cpp
View File

@ -28,12 +28,11 @@
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#include "plugininfo.h"
#include "plugintimer.h"
#include "integrationpluginfronius.h"
#include "froniusdiscovery.h"
#include "network/networkaccessmanager.h"
#include "network/networkdevicediscovery.h"
#include "plugininfo.h"
#include <plugintimer.h>
#include <QUrl>
#include <QDebug>
@ -60,9 +59,9 @@ void IntegrationPluginFronius::discoverThings(ThingDiscoveryInfo *info)
FroniusDiscovery *discovery = new FroniusDiscovery(hardwareManager()->networkManager(), hardwareManager()->networkDeviceDiscovery(), info);
connect(discovery, &FroniusDiscovery::discoveryFinished, info, [=](){
ThingDescriptors descriptors;
qCDebug(dcFronius()) << "Discovery finished. Found" << discovery->discoveryResults().count() << "devices";
qCInfo(dcFronius()) << "Discovery finished. Found" << discovery->discoveryResults().count() << "devices";
foreach (const NetworkDeviceInfo &networkDeviceInfo, discovery->discoveryResults()) {
qCDebug(dcFronius()) << networkDeviceInfo;
qCInfo(dcFronius()) << "Discovered Fronius on" << networkDeviceInfo;
if (networkDeviceInfo.macAddress().isNull())
continue;
@ -90,13 +89,14 @@ void IntegrationPluginFronius::discoverThings(ThingDiscoveryInfo *info)
}
ParamList params;
params << Param(connectionThingAddressParamTypeId, networkDeviceInfo.address().toString());
params << Param(connectionThingMacParamTypeId, networkDeviceInfo.macAddress());
descriptor.setParams(params);
info->addThingDescriptor(descriptor);
}
info->finish(Thing::ThingErrorNoError);
});
discovery->startDiscovery();
}
void IntegrationPluginFronius::setupThing(ThingSetupInfo *info)
@ -106,8 +106,6 @@ void IntegrationPluginFronius::setupThing(ThingSetupInfo *info)
if (thing->thingClassId() == connectionThingClassId) {
QHostAddress address(thing->paramValue(connectionThingAddressParamTypeId).toString());
// Handle reconfigure
if (m_froniusConnections.values().contains(thing)) {
FroniusSolarConnection *connection = m_froniusConnections.key(thing);
@ -115,49 +113,41 @@ void IntegrationPluginFronius::setupThing(ThingSetupInfo *info)
connection->deleteLater();
}
if (m_monitors.contains(thing)) {
hardwareManager()->networkDeviceDiscovery()->unregisterMonitor(m_monitors.take(thing));
}
// Set up depending on the available params, mac can only be filled in by discovery (ro param),
// the ip could be used as static manual config for VPN networks or WAN IP's
QHostAddress address(thing->paramValue(connectionThingAddressParamTypeId).toString());
MacAddress mac(thing->paramValue(connectionThingMacParamTypeId).toString());
// Create the connection
FroniusSolarConnection *connection = new FroniusSolarConnection(hardwareManager()->networkManager(), address, thing);
FroniusSolarConnection *connection = nullptr;
// Verify the version
FroniusNetworkReply *reply = connection->getVersion();
connect(reply, &FroniusNetworkReply::finished, info, [=] {
QByteArray data = reply->networkReply()->readAll();
if (reply->networkReply()->error() != QNetworkReply::NoError) {
qCWarning(dcFronius()) << "Network request error:" << reply->networkReply()->error() << reply->networkReply()->errorString() << reply->networkReply()->url();
if (reply->networkReply()->error() == QNetworkReply::ContentNotFoundError) {
info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("The device does not reply to our requests. Please verify that the Fronius Solar API is enabled on the device."));
if (mac.isValid() && !mac.isNull()) {
qCInfo(dcFronius()) << "Setting up network device monitor for Fronius connection using MAC address" << mac.toString();
NetworkDeviceMonitor *monitor = hardwareManager()->networkDeviceDiscovery()->registerMonitor(mac);
m_monitors.insert(thing, monitor);
connection = new FroniusSolarConnection(hardwareManager()->networkManager(), monitor->networkDeviceInfo().address(), thing);
connect(monitor, &NetworkDeviceMonitor::networkDeviceInfoChanged, this, [=](const NetworkDeviceInfo &networkDeviceInfo){
qCDebug(dcFronius()) << "Network device info changed for" << thing << networkDeviceInfo;
if (networkDeviceInfo.isValid()) {
connection->setAddress(networkDeviceInfo.address());
refreshConnection(connection);
} else {
info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("The device is not reachable."));
connection->setAddress(QHostAddress());
}
return;
}
// Convert the rawdata to a JSON document
QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) {
qCWarning(dcFronius()) << "Failed to parse JSON data" << data << ":" << error.errorString() << data;
info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The data received from the device could not be processed because the format is unknown."));
return;
}
QVariantMap versionResponseMap = jsonDoc.toVariant().toMap();
qCDebug(dcFronius()) << "Compatibility version" << versionResponseMap.value("CompatibilityRange").toString();
// Knwon version with broken JSON API
if (versionResponseMap.value("CompatibilityRange").toString() == "1.6-2") {
qCWarning(dcFronius()) << "The Fronius data logger has a version which is known to have a broken JSON API firmware.";
info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The firmware version 1.6-2 of this Fronius data logger contains errors preventing proper operation. Please update your Fronius device and try again."));
return;
}
m_froniusConnections.insert(connection, thing);
info->finish(Thing::ThingErrorNoError);
// Update the already known states
thing->setStateValue("connected", true);
thing->setStateValue(connectionVersionStateTypeId, versionResponseMap.value("CompatibilityRange").toString());
});
});
} else if (!address.isNull()) {
qCInfo(dcFronius()) << "Setting up Fronius connection based on IP address" << address.toString() << "without monitoring. Any IP changed will not be recognized and the device will be disconnected.";
connection = new FroniusSolarConnection(hardwareManager()->networkManager(), address, thing);
} else {
qCWarning(dcFronius()) << "Unable to set up thing" << thing << ", neither IP nor MAC is valid." << thing->params();
info->finish(Thing::ThingErrorInvalidParameter, QT_TR_NOOP("Please reconfigure the device."));
return;
}
connect(connection, &FroniusSolarConnection::availableChanged, this, [=](bool available){
qCDebug(dcFronius()) << thing << "Available changed" << available;
@ -178,6 +168,53 @@ void IntegrationPluginFronius::setupThing(ThingSetupInfo *info)
}
});
if (info->isInitialSetup()) {
// Verify the version
FroniusNetworkReply *reply = connection->getVersion();
connect(reply, &FroniusNetworkReply::finished, info, [=] {
QByteArray data = reply->networkReply()->readAll();
if (reply->networkReply()->error() != QNetworkReply::NoError) {
qCWarning(dcFronius()) << "Network request error:" << reply->networkReply()->error() << reply->networkReply()->errorString() << reply->networkReply()->url();
if (reply->networkReply()->error() == QNetworkReply::ContentNotFoundError) {
info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("The device does not reply to our requests. Please verify that the Fronius Solar API is enabled on the device."));
} else {
info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("The device is not reachable."));
}
return;
}
// Convert the rawdata to a JSON document
QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) {
qCWarning(dcFronius()) << "Failed to parse JSON data" << data << ":" << error.errorString() << data;
info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The data received from the device could not be processed because the format is unknown."));
return;
}
QVariantMap versionResponseMap = jsonDoc.toVariant().toMap();
qCDebug(dcFronius()) << "Compatibility version" << versionResponseMap.value("CompatibilityRange").toString();
// Knwon version with broken JSON API
if (versionResponseMap.value("CompatibilityRange").toString() == "1.6-2") {
qCWarning(dcFronius()) << "The Fronius data logger has a version which is known to have a broken JSON API firmware.";
info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The firmware version 1.6-2 of this Fronius data logger contains errors preventing proper operation. Please update your Fronius device and try again."));
return;
}
m_froniusConnections.insert(connection, thing);
info->finish(Thing::ThingErrorNoError);
// Update the already known states
thing->setStateValue("connected", true);
thing->setStateValue(connectionVersionStateTypeId, versionResponseMap.value("CompatibilityRange").toString());
});
} else {
// Let the available state handle the connected state, this already worked once...
m_froniusConnections.insert(connection, thing);
info->finish(Thing::ThingErrorNoError);
}
} else if ((thing->thingClassId() == inverterThingClassId ||
thing->thingClassId() == meterThingClassId ||
thing->thingClassId() == storageThingClassId)) {
@ -225,6 +262,7 @@ void IntegrationPluginFronius::postSetupThing(Thing *thing)
// Refresh now
FroniusSolarConnection *connection = m_froniusConnections.key(thing);
if (connection) {
thing->setStateValue("connected", connection->available());
refreshConnection(connection);
}
}
@ -233,9 +271,15 @@ void IntegrationPluginFronius::postSetupThing(Thing *thing)
void IntegrationPluginFronius::thingRemoved(Thing *thing)
{
if (thing->thingClassId() == connectionThingClassId) {
FroniusSolarConnection *connection = m_froniusConnections.key(thing);
m_froniusConnections.remove(connection);
connection->deleteLater();
if (m_froniusConnections.values().contains(thing)) {
FroniusSolarConnection *connection = m_froniusConnections.key(thing);
m_froniusConnections.remove(connection);
connection->deleteLater();
}
if (m_monitors.contains(thing)) {
hardwareManager()->networkDeviceDiscovery()->unregisterMonitor(m_monitors.take(thing));
}
}
if (myThings().filterByThingClassId(connectionThingClassId).isEmpty()) {
@ -244,7 +288,6 @@ void IntegrationPluginFronius::thingRemoved(Thing *thing)
}
}
void IntegrationPluginFronius::executeAction(ThingActionInfo *info)
{
Q_UNUSED(info)
@ -257,6 +300,11 @@ void IntegrationPluginFronius::refreshConnection(FroniusSolarConnection *connect
return;
}
if (connection->address().isNull()) {
qCDebug(dcFronius()) << "Connection has no IP configured yet. Skipping refresh cycle until known";
return;
}
// Note: this call will be used to monitor the available state of the connection internally
FroniusNetworkReply *reply = connection->getActiveDevices();
connect(reply, &FroniusNetworkReply::finished, this, [=]() {

11
fronius/integrationpluginfronius.h
View File

@ -31,13 +31,11 @@
#ifndef INTEGRATIONPLUGINFRONIUS_H
#define INTEGRATIONPLUGINFRONIUS_H
#include "integrations/integrationplugin.h"
#include "froniussolarconnection.h"
#include <integrations/integrationplugin.h>
#include <network/networkaccessmanager.h>
#include <network/networkdevicediscovery.h>
#include <QHash>
#include <QNetworkReply>
#include <QTimer>
#include <QUuid>
#include "froniussolarconnection.h"
class PluginTimer;
@ -60,6 +58,7 @@ private:
PluginTimer *m_connectionRefreshTimer = nullptr;
QHash<FroniusSolarConnection *, Thing *> m_froniusConnections;
QHash<Thing *, NetworkDeviceMonitor *> m_monitors;
void refreshConnection(FroniusSolarConnection *connection);

2
fronius/integrationpluginfronius.json
View File

@ -22,7 +22,7 @@
"displayName": "Host address",
"type": "QString",
"inputType": "IPv4Address",
"defaultValue": "88.117.152.99"
"defaultValue": ""
},
{
"id": "2237972e-385b-4458-b5d3-1d1fb4ae8756",