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

Add goe discovery and prepare V2 integration

Browse Source
This commit is contained in:
Simon Stürz 2022-07-21 10:08:32 +02:00
parent 860fbac0e8
commit 094f2e14ef
6 changed files with 1093 additions and 420 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
goecharger/goecharger.pro
View File

@ -5,7 +5,9 @@ QT += network
PKGCONFIG += nymea-mqtt
SOURCES += \
goediscovery.cpp \
integrationplugingoecharger.cpp \
HEADERS += \
goediscovery.h \
integrationplugingoecharger.h \

273
goecharger/goediscovery.cpp Normal file
View File

@ -0,0 +1,273 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright 2013 - 2022, 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 <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
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#include "goediscovery.h"
#include "extern-plugininfo.h"
#include <QJsonDocument>
#include <QJsonParseError>
GoeDiscovery::GoeDiscovery(NetworkAccessManager *networkAccessManager, NetworkDeviceDiscovery *networkDeviceDiscovery, QObject *parent) :
QObject(parent),
m_networkAccessManager(networkAccessManager),
m_networkDeviceDiscovery(networkDeviceDiscovery)
{
m_gracePeriodTimer.setSingleShot(true);
m_gracePeriodTimer.setInterval(3000);
connect(&m_gracePeriodTimer, &QTimer::timeout, this, [this](){
qCDebug(dcGoECharger()) << "Discovery: Grace period timer triggered.";
finishDiscovery();
});
}
GoeDiscovery::~GoeDiscovery()
{
qCDebug(dcGoECharger()) << "Discovery: destroy discovery object";
cleanupPendingReplies();
}
void GoeDiscovery::startDiscovery()
{
// Clean up
m_discoveryResults.clear();
m_verifiedNetworkDeviceInfos.clear();
m_gracePeriodTimer.stop();
m_startDateTime = QDateTime::currentDateTime();
qCInfo(dcGoECharger()) << "Discovery: Start discovering the network...";
m_discoveryReply = m_networkDeviceDiscovery->discover();
// Check if all network device infos which might already be discovered here to save time...
foreach (const NetworkDeviceInfo &networkDeviceInfo, m_discoveryReply->networkDeviceInfos()) {
checkNetworkDevice(networkDeviceInfo);
}
// Test any network device beeing discovered
connect(m_discoveryReply, &NetworkDeviceDiscoveryReply::networkDeviceInfoAdded, this, &GoeDiscovery::checkNetworkDevice);
// When the network discovery has finished, we process the rest and give some time to finish the pending replies
connect(m_discoveryReply, &NetworkDeviceDiscoveryReply::finished, this, [=](){
// The network device discovery is done
m_discoveredNetworkDeviceInfos = m_discoveryReply->networkDeviceInfos();
m_discoveryReply = nullptr;
// Check if all network device infos have been verified
foreach (const NetworkDeviceInfo &networkDeviceInfo, m_discoveredNetworkDeviceInfos) {
if (m_verifiedNetworkDeviceInfos.contains(networkDeviceInfo))
continue;
checkNetworkDevice(networkDeviceInfo);
}
// If there might be some response after the grace period time,
// we don't care any more since there might just waiting for some timeouts...
// If there would be a device, it would have responded.
m_gracePeriodTimer.start();
});
}
QList<GoeDiscovery::Result> GoeDiscovery::discoveryResults() const
{
return m_discoveryResults.values();
}
QNetworkRequest GoeDiscovery::buildRequestV1(const QHostAddress &address)
{
QUrl requestUrl;
requestUrl.setScheme("http");
requestUrl.setHost(address.toString());
requestUrl.setPath("/status");
return QNetworkRequest(requestUrl);
}
QNetworkRequest GoeDiscovery::buildRequestV2(const QHostAddress &address)
{
QUrl requestUrl;
requestUrl.setScheme("http");
requestUrl.setHost(address.toString());
requestUrl.setPath("/api/status");
return QNetworkRequest(requestUrl);
}
void GoeDiscovery::checkNetworkDevice(const NetworkDeviceInfo &networkDeviceInfo)
{
// Make sure we have not checked this host yet
if (m_verifiedNetworkDeviceInfos.contains(networkDeviceInfo))
return;
qCDebug(dcGoECharger()) << "Discovery: Start inspecting" << networkDeviceInfo.address().toString();
checkNetworkDeviceApiV2(networkDeviceInfo);
checkNetworkDeviceApiV1(networkDeviceInfo);
m_verifiedNetworkDeviceInfos.append(networkDeviceInfo);
}
void GoeDiscovery::checkNetworkDeviceApiV1(const NetworkDeviceInfo &networkDeviceInfo)
{
// First check if API V1 is available: http://<host>/status
QNetworkReply *reply = m_networkAccessManager->get(buildRequestV1(networkDeviceInfo.address()));
m_pendingReplies.append(reply);
connect(reply, &QNetworkReply::finished, this, [=](){
m_pendingReplies.removeAll(reply);
reply->deleteLater();
if (reply->error() != QNetworkReply::NoError) {
qCDebug(dcGoECharger()) << "Discovery:" << networkDeviceInfo.address().toString() << "API V1 verification HTTP error" << reply->errorString() << "Continue...";
return;
}
QByteArray data = reply->readAll();
QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) {
qCDebug(dcGoECharger()) << "Discovery:" << networkDeviceInfo.address().toString() << "API V1 verification invalid JSON data. Continue...";
return;
}
// Verify if we have the required values in the response map
// https://github.com/goecharger/go-eCharger-API-v1/blob/master/go-eCharger%20API%20v1%20EN.md
QVariantMap responseMap = jsonDoc.toVariant().toMap();
if (responseMap.contains("fwv") && responseMap.contains("sse") && responseMap.contains("nrg") && responseMap.contains("amp")) {
// Looks like we have found a go-e V1 api endpoint, nice
qCDebug(dcGoECharger()) << "Discovery: --> Found API V1 on" << networkDeviceInfo.address().toString();
if (m_discoveryResults.contains(networkDeviceInfo.address())) {
// We use the information from API V2 since there are more information available
m_discoveryResults[networkDeviceInfo.address()].apiAvailableV1 = true;
} else {
GoeDiscovery::Result result;
result.serialNumber = responseMap.value("sse").toString();
result.firmwareVersion = responseMap.value("fwv").toString();
result.networkDeviceInfo = networkDeviceInfo;
result.apiAvailableV1 = true;
m_discoveryResults[networkDeviceInfo.address()] = result;
}
} else {
qCDebug(dcGoECharger()) << "Discovery:" << networkDeviceInfo.address().toString() << "API V1 verification returned JSON data but not the right one. Continue...";
}
// Check if we are done with all checks
verifyDiscoveryFinished();
});
}
void GoeDiscovery::checkNetworkDeviceApiV2(const NetworkDeviceInfo &networkDeviceInfo)
{
// Check if API V2 is available: http://<host>/api/status
qCDebug(dcGoECharger()) << "Discovery: verify API V2 on" << networkDeviceInfo.address().toString();
QNetworkReply *reply = m_networkAccessManager->get(buildRequestV2(networkDeviceInfo.address()));
m_pendingReplies.append(reply);
connect(reply, &QNetworkReply::finished, this, [=](){
m_pendingReplies.removeAll(reply);
reply->deleteLater();
if (reply->error() != QNetworkReply::NoError) {
qCDebug(dcGoECharger()) << "Discovery:" << networkDeviceInfo.address().toString() << "API V2 verification HTTP error" << reply->errorString() << "Continue...";
return;
}
QByteArray data = reply->readAll();
QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) {
qCDebug(dcGoECharger()) << "Discovery:" << networkDeviceInfo.address().toString() << "API V2 verification invalid JSON data. Continue...";
return;
}
// Verify if we have the required values in the response map
// https://github.com/goecharger/go-eCharger-API-v2/blob/main/http-en.md
QVariantMap responseMap = jsonDoc.toVariant().toMap();
if (responseMap.contains("fwv") && responseMap.contains("sse") && responseMap.contains("typ") && responseMap.contains("fna")) {
// Looks like we have found a go-e V2 api endpoint, nice
qCDebug(dcGoECharger()) << "Discovery: --> Found API V2 on" << networkDeviceInfo.address().toString();
GoeDiscovery::Result result;
result.serialNumber = responseMap.value("sse").toString();
result.firmwareVersion = responseMap.value("fwv").toString();
result.manufacturer = responseMap.value("oem").toString();
result.product = responseMap.value("typ").toString();
result.friendlyName = responseMap.value("fna").toString();
result.networkDeviceInfo = networkDeviceInfo;
result.apiAvailableV2 = true;
if (m_discoveryResults.contains(networkDeviceInfo.address())) {
result.apiAvailableV1 = m_discoveryResults.value(networkDeviceInfo.address()).apiAvailableV1;
}
// Overwrite result from V1 since V2 contains more information
m_discoveryResults[networkDeviceInfo.address()] = result;
} else {
qCDebug(dcGoECharger()) << "Discovery:" << networkDeviceInfo.address().toString() << "API V2 verification returned JSON data but not the right one. Continue...";
}
// Check if we are done with all checks
verifyDiscoveryFinished();
});
}
void GoeDiscovery::verifyDiscoveryFinished()
{
if (!m_discoveryReply && m_verifiedNetworkDeviceInfos.count() == m_discoveredNetworkDeviceInfos.count()) {
finishDiscovery();
}
}
void GoeDiscovery::cleanupPendingReplies()
{
foreach (QNetworkReply *reply, m_pendingReplies) {
m_pendingReplies.removeAll(reply);
reply->abort();
}
}
void GoeDiscovery::finishDiscovery()
{
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");
m_gracePeriodTimer.stop();
cleanupPendingReplies();
emit discoveryFinished();
}
QDebug operator<<(QDebug dbg, const GoeDiscovery::Result &result)
{
dbg.nospace() << "GoeDiscovery:Result(" << result.product;
dbg.nospace() << ", " << result.manufacturer;
dbg.nospace() << ", Version: " << result.firmwareVersion;
dbg.nospace() << ", SN: " << result.serialNumber;
dbg.nospace() << ", V1: " << result.apiAvailableV1;
dbg.nospace() << ", V2: " << result.apiAvailableV2;
dbg.nospace() << ", " << result.networkDeviceInfo.address().toString();
dbg.nospace() << ", " << result.networkDeviceInfo.macAddress();
dbg.nospace() << ") ";
return dbg.maybeSpace();
}

93
goecharger/goediscovery.h Normal file
View File

@ -0,0 +1,93 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright 2013 - 2022, 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 <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 GOEDISCOVERY_H
#define GOEDISCOVERY_H
#include <QObject>
#include <QDebug>
#include <network/networkaccessmanager.h>
#include <network/networkdevicediscovery.h>
class GoeDiscovery : public QObject
{
Q_OBJECT
public:
typedef struct Result {
QString product = "go-eCharger";
QString manufacturer = "go-e";
QString friendlyName;
QString serialNumber;
QString firmwareVersion;
NetworkDeviceInfo networkDeviceInfo;
bool apiAvailableV1 = false;
bool apiAvailableV2 = false;
} Result;
explicit GoeDiscovery(NetworkAccessManager *networkAccessManager, NetworkDeviceDiscovery *networkDeviceDiscovery, QObject *parent = nullptr);
~GoeDiscovery();
void startDiscovery();
QList<GoeDiscovery::Result> discoveryResults() const;
static QNetworkRequest buildRequestV1(const QHostAddress &address);
static QNetworkRequest buildRequestV2(const QHostAddress &address);
signals:
void discoveryFinished();
private:
QDateTime m_startDateTime;
QTimer m_gracePeriodTimer;
NetworkAccessManager *m_networkAccessManager = nullptr;
NetworkDeviceDiscovery *m_networkDeviceDiscovery = nullptr;
NetworkDeviceDiscoveryReply *m_discoveryReply = nullptr;
QHash<QHostAddress, GoeDiscovery::Result> m_discoveryResults;
NetworkDeviceInfos m_discoveredNetworkDeviceInfos;
NetworkDeviceInfos m_verifiedNetworkDeviceInfos;
QList<QNetworkReply *> m_pendingReplies;
private slots:
void checkNetworkDevice(const NetworkDeviceInfo &networkDeviceInfo);
void checkNetworkDeviceApiV1(const NetworkDeviceInfo &networkDeviceInfo);
void checkNetworkDeviceApiV2(const NetworkDeviceInfo &networkDeviceInfo);
void verifyDiscoveryFinished();
void cleanupPendingReplies();
void finishDiscovery();
};
QDebug operator<<(QDebug debug, const GoeDiscovery::Result &result);
#endif // GOEDISCOVERY_H

602
goecharger/integrationplugingoecharger.cpp
View File

@ -1,6 +1,6 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright 2013 - 2021, nymea GmbH
* Copyright 2013 - 2022, nymea GmbH
* Contact: contact@nymea.io
*
* This file is part of nymea.
@ -38,7 +38,11 @@
#include <QJsonDocument>
#include <QJsonParseError>
// API documentation: https://github.com/goecharger/go-eCharger-API-v1
#include "goediscovery.h"
// API documentation:
// V1: https://github.com/goecharger/go-eCharger-API-v1
// V2: https://github.com/goecharger/go-eCharger-API-v2
IntegrationPluginGoECharger::IntegrationPluginGoECharger()
{
@ -53,44 +57,36 @@ void IntegrationPluginGoECharger::discoverThings(ThingDiscoveryInfo *info)
return;
}
// Perform a network device discovery and filter for "go-eCharger" hosts
NetworkDeviceDiscoveryReply *discoveryReply = hardwareManager()->networkDeviceDiscovery()->discover();
connect(discoveryReply, &NetworkDeviceDiscoveryReply::finished, this, [=](){
foreach (const NetworkDeviceInfo &networkDeviceInfo, discoveryReply->networkDeviceInfos()) {
qCDebug(dcGoECharger()) << "Checking discovered" << networkDeviceInfo;
// Filter by hostname
if (!networkDeviceInfo.hostName().toLower().contains("go-echarger"))
continue;
// We need also the mac address
if (networkDeviceInfo.macAddress().isEmpty())
continue;
GoeDiscovery *discovery = new GoeDiscovery(hardwareManager()->networkManager(), hardwareManager()->networkDeviceDiscovery(), this);
connect(discovery, &GoeDiscovery::discoveryFinished, discovery, &GoeDiscovery::deleteLater);
connect(discovery, &GoeDiscovery::discoveryFinished, info, [=](){
foreach (const GoeDiscovery::Result &result, discovery->discoveryResults()) {
QString title;
if (networkDeviceInfo.hostName().isEmpty()) {
title = networkDeviceInfo.address().toString();
if (!result.product.isEmpty() && !result.friendlyName.isEmpty() && result.friendlyName != result.product) {
// We use the friendly name for the title, since the user seems to have given a name
title = result.friendlyName;
} else {
title = "go-eCharger";
title = result.product;
}
QString description;
if (networkDeviceInfo.macAddressManufacturer().isEmpty()) {
description = networkDeviceInfo.address().toString();
} else {
description = networkDeviceInfo.address().toString() + " (" + networkDeviceInfo.macAddressManufacturer() + ")";
// There might be an other OEM than go-e, let's use this information since the user might not look for go-e (whitelabel)
if (!result.manufacturer.isEmpty()) {
title += " (" + result.manufacturer + ")";
}
QString description = "Serial: " + result.serialNumber + ", V: " + result.firmwareVersion + " - " + result.networkDeviceInfo.address().toString();
qCDebug(dcGoECharger()) << "-->" << title << description;
ThingDescriptor descriptor(goeHomeThingClassId, title, description);
ParamList params;
params << Param(goeHomeThingIpAddressParamTypeId, networkDeviceInfo.address().toString());
params << Param(goeHomeThingMacAddressParamTypeId, networkDeviceInfo.macAddress());
params << Param(goeHomeThingMacAddressParamTypeId, result.networkDeviceInfo.macAddress());
params << Param(goeHomeThingSerialNumberParamTypeId, result.serialNumber);
params << Param(goeHomeThingApiVersionParamTypeId, result.apiAvailableV2 ? 2 : 1); // always use v2 if available...
descriptor.setParams(params);
// Check if we already have set up this device
Things existingThings = myThings().filterByParam(goeHomeThingMacAddressParamTypeId, networkDeviceInfo.macAddress());
Things existingThings = myThings().filterByParam(goeHomeThingMacAddressParamTypeId, result.networkDeviceInfo.macAddress());
if (existingThings.count() == 1) {
qCDebug(dcGoECharger()) << "This go-eCharger already exists in the system" << networkDeviceInfo;
qCDebug(dcGoECharger()) << "This wallbox already exists in the system!" << result.networkDeviceInfo;
descriptor.setThingId(existingThings.first()->id());
}
@ -99,18 +95,54 @@ void IntegrationPluginGoECharger::discoverThings(ThingDiscoveryInfo *info)
info->finish(Thing::ThingErrorNoError);
});
// Start the discovery process
discovery->startDiscovery();
}
void IntegrationPluginGoECharger::setupThing(ThingSetupInfo *info)
{
Thing *thing = info->thing();
if (thing->thingClassId() == goeHomeThingClassId) {
qCDebug(dcGoECharger()) << "Set up" << thing << thing->params();
MacAddress macAddress = MacAddress(thing->paramValue(goeHomeThingMacAddressParamTypeId).toString());
if (!macAddress.isValid()) {
qCWarning(dcGoECharger()) << "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."));
return;
}
// 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));
}
});
connect(monitor, &NetworkDeviceMonitor::reachableChanged, thing, [=](bool reachable){
qCDebug(dcGoECharger()) << "Network device monitor reachable changed for" << thing->name() << reachable;
if (reachable && thing->setupComplete() && !thing->stateValue("connected").toBool()) {
// The device is reachable again and we have already set it up.
// Update data and optionally reconfigure the mqtt channel
QNetworkReply *reply = hardwareManager()->networkManager()->get(buildStatusRequest(thing));
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
connect(reply, &QNetworkReply::finished, info, [=](){
connect(reply, &QNetworkReply::finished, thing, [=](){
if (reply->error() != QNetworkReply::NoError) {
qCWarning(dcGoECharger()) << "HTTP status reply returned error:" << reply->errorString();
info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("The wallbox does not seem to be reachable."));
qCWarning(dcGoECharger()) << "HTTP status reply returned error:" << reply->errorString() << reply->readAll();
return;
}
@ -119,33 +151,44 @@ void IntegrationPluginGoECharger::setupThing(ThingSetupInfo *info)
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) {
qCWarning(dcGoECharger()) << "Failed to parse status data for thing " << thing->name() << qUtf8Printable(data) << error.errorString();
info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The wallbox returned invalid data."));
return;
}
qCDebug(dcGoECharger()) << "Received" << qUtf8Printable(jsonDoc.toJson());
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()) {
// Handle reconfigure
if (m_channels.contains(thing)) {
hardwareManager()->mqttProvider()->releaseChannel(m_channels.take(thing));
// Continue with normal setup
}
// Verify mqtt client and set it up
qCDebug(dcGoECharger()) << "Setup using MQTT connection for" << thing;
QHostAddress address = QHostAddress(thing->paramValue(goeHomeThingIpAddressParamTypeId).toString());
setupMqttChannel(info, address, statusMap);
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
info->finish(Thing::ThingErrorNoError);
qCDebug(dcGoECharger()) << "Setup using HTTP finished successfully";
update(thing, statusMap);
thing->setStateValue(goeHomeConnectedStateTypeId, true);
updateV1(thing, statusMap);
}
break;
case ApiVersion2:
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);
}
});
return;
}
Q_ASSERT_X(false, "setupThing", QString("Unhandled thingClassId: %1").arg(thing->thingClassId().toString()).toUtf8());
@ -167,8 +210,8 @@ void IntegrationPluginGoECharger::postSetupThing(Thing *thing)
void IntegrationPluginGoECharger::thingRemoved(Thing *thing)
{
// Cleanup mqtt channels if set up
if (m_channels.contains(thing)) {
hardwareManager()->mqttProvider()->releaseChannel(m_channels.take(thing));
if (m_mqttChannelsV1.contains(thing)) {
hardwareManager()->mqttProvider()->releaseChannel(m_mqttChannelsV1.take(thing));
}
// Cleanup possible pending replies
@ -187,30 +230,28 @@ void IntegrationPluginGoECharger::executeAction(ThingActionInfo *info)
{
Thing *thing = info->thing();
Action action = info->action();
QHostAddress address = getHostAddress(thing);
ApiVersion apiVersion = getApiVersion(thing);
if (thing->thingClassId() != goeHomeThingClassId) {
info->finish(Thing::ThingErrorThingClassNotFound);
return;
}
if (!thing->stateValue(goeHomeConnectedStateTypeId).toBool()) {
if (!thing->stateValue("connected").toBool()) {
qCWarning(dcGoECharger()) << thing << "failed to execute action. The device seems not to be connected.";
info->finish(Thing::ThingErrorHardwareNotAvailable);
return;
}
if (thing->stateValue(goeHomeSerialNumberStateTypeId).toString().isEmpty()) {
qCDebug(dcGoECharger()) << "Could not execute action because the serial number is missing.";
info->finish(Thing::ThingErrorHardwareFailure);
return;
}
switch (apiVersion) {
case ApiVersion1: {
if (action.actionTypeId() == goeHomePowerActionTypeId) {
bool power = action.paramValue(goeHomePowerActionPowerParamTypeId).toBool();
qCDebug(dcGoECharger()) << "Setting charging allowed to" << power;
// Set the allow value
QString configuration = QString("alw=%1").arg(power ? 1: 0);
sendActionRequest(thing, info, configuration);
sendActionRequestV1(thing, info, configuration);
return;
} else if (action.actionTypeId() == goeHomeMaxChargingCurrentActionTypeId) {
uint maxChargingCurrent = action.paramValue(goeHomeMaxChargingCurrentActionMaxChargingCurrentParamTypeId).toUInt();
@ -218,91 +259,122 @@ void IntegrationPluginGoECharger::executeAction(ThingActionInfo *info)
// FIXME: check if we can use amx since it is better for pv charging, not all version seen implement amx
// Maybe check if the user sets it or a automatism
QString configuration = QString("amp=%1").arg(maxChargingCurrent);
sendActionRequest(thing, info, configuration);
return;
} else if (action.actionTypeId() == goeHomeAbsoluteMaxAmpereActionTypeId) {
uint maxAmpere = action.paramValue(goeHomeAbsoluteMaxAmpereActionAbsoluteMaxAmpereParamTypeId).toUInt();
qCDebug(dcGoECharger()) << "Setting absolute maximal charging amperes to" << maxAmpere << "A";
QString configuration = QString("ama=%1").arg(maxAmpere);
sendActionRequest(thing, info, configuration);
return;
} else if (action.actionTypeId() == goeHomeCloudActionTypeId) {
bool enabled = action.paramValue(goeHomeCloudActionCloudParamTypeId).toBool();
qCDebug(dcGoECharger()) << "Set cloud" << (enabled ? "enabled" : "disabled");
QString configuration = QString("cdi=%1").arg(enabled ? 1: 0);
sendActionRequest(thing, info, configuration);
return;
} else if (action.actionTypeId() == goeHomeLedBrightnessActionTypeId) {
quint8 brightness = action.paramValue(goeHomeLedBrightnessActionLedBrightnessParamTypeId).toUInt();
qCDebug(dcGoECharger()) << "Set led brightnss to" << brightness << "/" << 255;
QString configuration = QString("lbr=%1").arg(brightness);
sendActionRequest(thing, info, configuration);
return;
} else if (action.actionTypeId() == goeHomeLedEnergySaveActionTypeId) {
bool enabled = action.paramValue(goeHomeLedEnergySaveActionLedEnergySaveParamTypeId).toBool();
qCDebug(dcGoECharger()) << "Set led energy saving" << (enabled ? "enabled" : "disabled");
QString configuration = QString("lse=%1").arg(enabled ? 1: 0);
sendActionRequest(thing, info, configuration);
sendActionRequestV1(thing, info, configuration);
return;
} else {
info->finish(Thing::ThingErrorActionTypeNotFound);
}
break;
}
case ApiVersion2:
// TODO
break;
}
}
void IntegrationPluginGoECharger::onClientConnected(MqttChannel *channel)
void IntegrationPluginGoECharger::setupGoeHome(ThingSetupInfo *info)
{
Thing *thing = m_channels.key(channel);
if (!thing) {
qCWarning(dcGoECharger()) << "Received a client connect for an unknown thing. Ignoring the event.";
Thing *thing = info->thing();
QNetworkReply *reply = hardwareManager()->networkManager()->get(buildStatusRequest(thing));
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
connect(reply, &QNetworkReply::finished, info, [=](){
if (reply->error() != QNetworkReply::NoError) {
qCWarning(dcGoECharger()) << "HTTP status reply returned error:" << reply->errorString() << reply->readAll();
info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("The wallbox does not seem to be reachable."));
hardwareManager()->networkDeviceDiscovery()->unregisterMonitor(m_monitors.take(thing));
return;
}
qCDebug(dcGoECharger()) << thing << "connected";
thing->setStateValue(goeHomeConnectedStateTypeId, true);
}
void IntegrationPluginGoECharger::onClientDisconnected(MqttChannel *channel)
{
Thing *thing = m_channels.key(channel);
if (!thing) {
qCWarning(dcGoECharger()) << "Received a client disconnect for an unknown thing. Ignoring the event.";
return;
}
qCDebug(dcGoECharger()) << thing << "connected";
thing->setStateValue(goeHomeConnectedStateTypeId, false);
}
void IntegrationPluginGoECharger::onPublishReceived(MqttChannel *channel, const QString &topic, const QByteArray &payload)
{
Thing *thing = m_channels.key(channel);
if (!thing) {
qCWarning(dcGoECharger()) << "Received a MQTT client publish from an unknown thing. Ignoring the event.";
return;
}
qCDebug(dcGoECharger()) << thing << "publish received" << topic;
QByteArray data = reply->readAll();
QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(payload, &error);
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) {
qCWarning(dcGoECharger()) << "Failed to parse status data for thing " << thing->name() << qUtf8Printable(payload) << error.errorString();
qCWarning(dcGoECharger()) << "Failed to parse status data for thing " << thing->name() << qUtf8Printable(data) << error.errorString();
info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("The wallbox returned invalid data."));
hardwareManager()->networkDeviceDiscovery()->unregisterMonitor(m_monitors.take(thing));
return;
}
QString serialNumber = thing->stateValue(goeHomeSerialNumberStateTypeId).toString();
if (topic == QString("go-eCharger/%1/status").arg(serialNumber)) {
update(thing, jsonDoc.toVariant().toMap());
QHostAddress address = getHostAddress(thing);
ApiVersion apiVersion = getApiVersion(thing);
switch (apiVersion) {
case ApiVersion1: {
// Handle reconfigure
if (m_mqttChannelsV1.contains(thing))
hardwareManager()->mqttProvider()->releaseChannel(m_mqttChannelsV1.take(thing));
if (m_pendingReplies.contains(thing))
m_pendingReplies.take(thing)->abort();
qCDebug(dcGoECharger()) << "Initial status map" << qUtf8Printable(jsonDoc.toJson(QJsonDocument::Compact));
QVariantMap statusMap = jsonDoc.toVariant().toMap();
if (thing->paramValue(goeHomeThingUseMqttParamTypeId).toBool()) {
// Verify mqtt client and set it up
qCDebug(dcGoECharger()) << "Setup using MQTT connection for" << thing;
setupMqttChannelV1(info, address, statusMap);
} else {
qCDebug(dcGoECharger()) << "Unhandled topic publish received:" << topic << qUtf8Printable(jsonDoc.toJson(QJsonDocument::Compact));
// Since we are not using mqtt, we are done with the setup, the refresh timer will be configured in post setup
info->finish(Thing::ThingErrorNoError);
qCDebug(dcGoECharger()) << "Setup using HTTP finished successfully";
updateV1(thing, statusMap);
thing->setStateValue(goeHomeConnectedStateTypeId, true);
}
break;
}
case ApiVersion2:
// TODO
break;
}
});
}
void IntegrationPluginGoECharger::update(Thing *thing, const QVariantMap &statusMap)
QNetworkRequest IntegrationPluginGoECharger::buildStatusRequest(Thing *thing)
{
QHostAddress address = getHostAddress(thing);
ApiVersion apiVersion = getApiVersion(thing);
QUrl requestUrl;
requestUrl.setScheme("http");
requestUrl.setHost(address.toString());
switch (apiVersion) {
case ApiVersion1:
requestUrl.setPath("/status");
break;
case ApiVersion2:
requestUrl.setPath("/api/status");
break;
}
return QNetworkRequest(requestUrl);
}
QHostAddress IntegrationPluginGoECharger::getHostAddress(Thing *thing)
{
if (m_monitors.contains(thing))
return m_monitors.value(thing)->networkDeviceInfo().address();
return QHostAddress();
}
IntegrationPluginGoECharger::ApiVersion IntegrationPluginGoECharger::getApiVersion(Thing *thing)
{
return static_cast<ApiVersion>(thing->paramValue(goeHomeThingApiVersionParamTypeId).toUInt());
}
void IntegrationPluginGoECharger::updateV1(Thing *thing, const QVariantMap &statusMap)
{
if (thing->thingClassId() == goeHomeThingClassId) {
// Parse status map and update states...
CarState carState = static_cast<CarState>(statusMap.value("car").toUInt());
switch (carState) {
case CarStateUnknown:
thing->setStateValue(goeHomeCarStatusStateTypeId, "Unknown");
thing->setStateValue(goeHomePluggedInStateTypeId, false);
break;
case CarStateReadyNoCar:
thing->setStateValue(goeHomeCarStatusStateTypeId, "Ready but no vehicle connected");
thing->setStateValue(goeHomePluggedInStateTypeId, false);
@ -353,13 +425,9 @@ void IntegrationPluginGoECharger::update(Thing *thing, const QVariantMap &status
thing->setStateValue(goeHomeSessionEnergyStateTypeId, statusMap.value("dws").toUInt() / 360000.0);
thing->setStateValue(goeHomePowerStateTypeId, (statusMap.value("alw").toUInt() == 0 ? false : true));
thing->setStateValue(goeHomeUpdateAvailableStateTypeId, (statusMap.value("upd").toUInt() == 0 ? false : true));
thing->setStateValue(goeHomeCloudStateTypeId, (statusMap.value("cdi").toUInt() == 0 ? false : true));
thing->setStateValue(goeHomeFirmwareVersionStateTypeId, statusMap.value("fwv").toString());
// FIXME: check if we can use amx since it is better for pv charging, not all version seen implement this
thing->setStateValue(goeHomeMaxChargingCurrentStateTypeId, statusMap.value("amp").toUInt());
thing->setStateValue(goeHomeLedBrightnessStateTypeId, statusMap.value("lbr").toUInt());
thing->setStateValue(goeHomeLedEnergySaveStateTypeId, statusMap.value("lse").toBool());
thing->setStateValue(goeHomeSerialNumberStateTypeId, statusMap.value("sse").toString());
thing->setStateValue(goeHomeAdapterConnectedStateTypeId, (statusMap.value("adi").toUInt() == 0 ? false : true));
uint amaLimit = statusMap.value("ama").toUInt();
@ -438,21 +506,10 @@ void IntegrationPluginGoECharger::update(Thing *thing, const QVariantMap &status
thing->setStateValue(goeHomePhaseCountStateTypeId, phaseCount);
}
}
}
QNetworkRequest IntegrationPluginGoECharger::buildStatusRequest(Thing *thing)
{
QHostAddress address = QHostAddress(thing->paramValue(goeHomeThingIpAddressParamTypeId).toString());
QUrl requestUrl;
requestUrl.setScheme("http");
requestUrl.setHost(address.toString());
requestUrl.setPath("/status");
return QNetworkRequest(requestUrl);
}
QNetworkRequest IntegrationPluginGoECharger::buildConfigurationRequest(const QHostAddress &address, const QString &configuration)
QNetworkRequest IntegrationPluginGoECharger::buildConfigurationRequestV1(const QHostAddress &address, const QString &configuration)
{
QUrl requestUrl;
requestUrl.setScheme("http");
@ -464,10 +521,13 @@ QNetworkRequest IntegrationPluginGoECharger::buildConfigurationRequest(const QHo
return QNetworkRequest(requestUrl);
}
void IntegrationPluginGoECharger::sendActionRequest(Thing *thing, ThingActionInfo *info, const QString &configuration)
void IntegrationPluginGoECharger::sendActionRequestV1(Thing *thing, ThingActionInfo *info, const QString &configuration)
{
// Lets use rest here since we get a reply on the rest request. For using MQTT publish to topic "go-eCharger/<serialnumber>/cmd/req"
QNetworkRequest request = buildConfigurationRequest(QHostAddress(thing->paramValue(goeHomeThingIpAddressParamTypeId).toString()), configuration);
// Lets use rest here since we get a reply on the rest request.
// For using MQTT publish to topic "go-eCharger/<serialnumber>/cmd/req"
QHostAddress address = getHostAddress(thing);
QNetworkRequest request = buildConfigurationRequestV1(address, configuration);
QNetworkReply *reply = hardwareManager()->networkManager()->sendCustomRequest(request, "SET");
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
connect(reply, &QNetworkReply::finished, info, [=](){
@ -487,13 +547,14 @@ void IntegrationPluginGoECharger::sendActionRequest(Thing *thing, ThingActionInf
}
info->finish(Thing::ThingErrorNoError);
update(thing, jsonDoc.toVariant().toMap());
updateV1(thing, jsonDoc.toVariant().toMap());
});
}
void IntegrationPluginGoECharger::setupMqttChannel(ThingSetupInfo *info, const QHostAddress &address, const QVariantMap &statusMap)
void IntegrationPluginGoECharger::setupMqttChannelV1(ThingSetupInfo *info, const QHostAddress &address, const QVariantMap &statusMap)
{
Thing *thing = info->thing();
QString serialNumber = statusMap.value("sse").toString();
QString clientId = QString("go-eCharger:%1:%2").arg(serialNumber).arg(statusMap.value("rbc").toInt());
QString statusTopic = QString("go-eCharger/%1/status").arg(serialNumber);
@ -507,13 +568,13 @@ void IntegrationPluginGoECharger::setupMqttChannel(ThingSetupInfo *info, const Q
return;
}
m_channels.insert(thing, channel);
connect(channel, &MqttChannel::clientConnected, this, &IntegrationPluginGoECharger::onClientConnected);
connect(channel, &MqttChannel::clientDisconnected, this, &IntegrationPluginGoECharger::onClientDisconnected);
connect(channel, &MqttChannel::publishReceived, this, &IntegrationPluginGoECharger::onPublishReceived);
m_mqttChannelsV1.insert(thing, channel);
connect(channel, &MqttChannel::clientConnected, this, &IntegrationPluginGoECharger::onMqttClientV1Connected);
connect(channel, &MqttChannel::clientDisconnected, this, &IntegrationPluginGoECharger::onMqttClientV1Disconnected);
connect(channel, &MqttChannel::publishReceived, this, &IntegrationPluginGoECharger::onMqttPublishV1Received);
// Configure the mqtt server on the go-e
QNetworkRequest request = buildConfigurationRequest(address, QString("mcs=%1").arg(channel->serverAddress().toString()));
QNetworkRequest request = buildConfigurationRequestV1(address, QString("mcs=%1").arg(channel->serverAddress().toString()));
qCDebug(dcGoECharger()) << "Configure nymea mqtt server address on" << thing << request.url().toString();
QNetworkReply *reply = hardwareManager()->networkManager()->sendCustomRequest(request, "SET");
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
@ -543,7 +604,7 @@ void IntegrationPluginGoECharger::setupMqttChannel(ThingSetupInfo *info, const Q
}
// Configure the port
QNetworkRequest request = buildConfigurationRequest(address, QString("mcp=%1").arg(channel->serverPort()));
QNetworkRequest request = buildConfigurationRequestV1(address, QString("mcp=%1").arg(channel->serverPort()));
qCDebug(dcGoECharger()) << "Configure nymea mqtt server port on" << thing << request.url().toString();
QNetworkReply *reply = hardwareManager()->networkManager()->sendCustomRequest(request, "SET");
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
@ -573,7 +634,7 @@ void IntegrationPluginGoECharger::setupMqttChannel(ThingSetupInfo *info, const Q
}
// Username
QNetworkRequest request = buildConfigurationRequest(address, QString("mcu=%1").arg(channel->username()));
QNetworkRequest request = buildConfigurationRequestV1(address, QString("mcu=%1").arg(channel->username()));
qCDebug(dcGoECharger()) << "Configure nymea mqtt server user name on" << thing << request.url().toString();
QNetworkReply *reply = hardwareManager()->networkManager()->sendCustomRequest(request, "SET");
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
@ -603,7 +664,7 @@ void IntegrationPluginGoECharger::setupMqttChannel(ThingSetupInfo *info, const Q
}
// Password
QNetworkRequest request = buildConfigurationRequest(address, QString("mck=%1").arg(channel->password()));
QNetworkRequest request = buildConfigurationRequestV1(address, QString("mck=%1").arg(channel->password()));
qCDebug(dcGoECharger()) << "Configure nymea mqtt server password on" << thing << request.url().toString();
QNetworkReply *reply = hardwareManager()->networkManager()->sendCustomRequest(request, "SET");
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
@ -633,7 +694,7 @@ void IntegrationPluginGoECharger::setupMqttChannel(ThingSetupInfo *info, const Q
}
// Enable MQTT
QNetworkRequest request = buildConfigurationRequest(address, QString("mce=1"));
QNetworkRequest request = buildConfigurationRequestV1(address, QString("mce=1"));
qCDebug(dcGoECharger()) << "Enable custom mqtt server on" << thing << request.url().toString();
QNetworkReply *reply = hardwareManager()->networkManager()->sendCustomRequest(request, "SET");
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
@ -666,7 +727,176 @@ void IntegrationPluginGoECharger::setupMqttChannel(ThingSetupInfo *info, const Q
info->finish(Thing::ThingErrorNoError);
qCDebug(dcGoECharger()) << "Configuration of MQTT for" << thing << "finished successfully";
// Update states...
update(thing, statusMap);
updateV1(thing, statusMap);
});
});
});
});
});
}
void IntegrationPluginGoECharger::reconfigureMqttChannelV1(Thing *thing, const QVariantMap &statusMap)
{
QString serialNumber = thing->paramValue(goeHomeThingSerialNumberParamTypeId).toString();
QHostAddress address = getHostAddress(thing);
qCDebug(dcGoECharger()) << "Reconfigure mqtt channel for" << thing;
// At least in version 30.1
QString clientId = QString("go-eCharger:%1:%2").arg(serialNumber).arg(statusMap.value("rbc").toInt());
QString statusTopic = QString("/go-eCharger/%1/status").arg(serialNumber);
QString commandTopic = QString("/go-eCharger/%1/cmd/req").arg(serialNumber);
qCDebug(dcGoECharger()) << "Setting up mqtt channel for" << thing << address.toString() << statusTopic << commandTopic;
MqttChannel *channel = hardwareManager()->mqttProvider()->createChannel(clientId, address, {statusTopic, commandTopic});
if (!channel) {
qCWarning(dcGoECharger()) << "Failed to create MQTT channel for" << thing;
return;
}
m_mqttChannelsV1.insert(thing, channel);
connect(channel, &MqttChannel::clientConnected, this, &IntegrationPluginGoECharger::onMqttClientV1Connected);
connect(channel, &MqttChannel::clientDisconnected, this, &IntegrationPluginGoECharger::onMqttClientV1Disconnected);
connect(channel, &MqttChannel::publishReceived, this, &IntegrationPluginGoECharger::onMqttPublishV1Received);
// Configure the mqtt server on the go-e
QNetworkRequest request = buildConfigurationRequestV1(address, QString("mcs=%1").arg(channel->serverAddress().toString()));
qCDebug(dcGoECharger()) << "Configure nymea mqtt server address on" << thing << request.url().toString();
QNetworkReply *reply = hardwareManager()->networkManager()->sendCustomRequest(request, "SET");
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
connect(reply, &QNetworkReply::finished, thing, [=](){
if (reply->error() != QNetworkReply::NoError) {
qCWarning(dcGoECharger()) << "HTTP status reply returned error:" << reply->errorString();
return;
}
QByteArray data = reply->readAll();
QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) {
qCWarning(dcGoECharger()) << "Failed to parse status data for thing " << thing->name() << qUtf8Printable(data) << error.errorString();
return;
}
// Verify response matches the requsted value
if (jsonDoc.toVariant().toMap().value("mcs").toString() != channel->serverAddress().toString()) {
qCWarning(dcGoECharger()) << "Configured MQTT server but the response does not match with requested server address" << channel->serverAddress().toString();
return;
} else {
qCDebug(dcGoECharger()) << "Configured successfully MQTT server" << thing << channel->serverAddress().toString();
}
// Configure the port
QNetworkRequest request = buildConfigurationRequestV1(address, QString("mcp=%1").arg(channel->serverPort()));
qCDebug(dcGoECharger()) << "Configure nymea mqtt server port on" << thing << request.url().toString();
QNetworkReply *reply = hardwareManager()->networkManager()->sendCustomRequest(request, "SET");
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
connect(reply, &QNetworkReply::finished, thing, [=](){
if (reply->error() != QNetworkReply::NoError) {
qCWarning(dcGoECharger()) << "HTTP status reply returned error:" << reply->errorString();
return;
}
QByteArray data = reply->readAll();
QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) {
qCWarning(dcGoECharger()) << "Failed to parse status data for thing " << thing->name() << qUtf8Printable(data) << error.errorString();
return;
}
// Verify response matches the requsted value
if (jsonDoc.toVariant().toMap().value("mcp").toUInt() != channel->serverPort()) {
qCWarning(dcGoECharger()) << "Configured MQTT server but the response does not match with requested server port" << channel->serverPort();
return;
} else {
qCDebug(dcGoECharger()) << "Configured successfully MQTT server" << thing << channel->serverPort();
}
// Username
QNetworkRequest request = buildConfigurationRequestV1(address, QString("mcu=%1").arg(channel->username()));
qCDebug(dcGoECharger()) << "Configure nymea mqtt server user name on" << thing << request.url().toString();
QNetworkReply *reply = hardwareManager()->networkManager()->sendCustomRequest(request, "SET");
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
connect(reply, &QNetworkReply::finished, thing, [=](){
if (reply->error() != QNetworkReply::NoError) {
qCWarning(dcGoECharger()) << "HTTP status reply returned error:" << reply->errorString();
return;
}
QByteArray data = reply->readAll();
QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) {
qCWarning(dcGoECharger()) << "Failed to parse status data for thing " << thing->name() << qUtf8Printable(data) << error.errorString();
return;
}
// Verify response matches the requsted value
if (jsonDoc.toVariant().toMap().value("mcu").toString() != channel->username()) {
qCWarning(dcGoECharger()) << "Configured MQTT server but the response does not match with requested server username" << channel->username();
return;
} else {
qCDebug(dcGoECharger()) << "Configured successfully MQTT server" << thing << channel->username();
}
// Password
QNetworkRequest request = buildConfigurationRequestV1(address, QString("mck=%1").arg(channel->password()));
qCDebug(dcGoECharger()) << "Configure nymea mqtt server password on" << thing << request.url().toString();
QNetworkReply *reply = hardwareManager()->networkManager()->sendCustomRequest(request, "SET");
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
connect(reply, &QNetworkReply::finished, thing, [=](){
if (reply->error() != QNetworkReply::NoError) {
qCWarning(dcGoECharger()) << "HTTP status reply returned error:" << reply->errorString();
return;
}
QByteArray data = reply->readAll();
QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) {
qCWarning(dcGoECharger()) << "Failed to parse status data for thing " << thing->name() << qUtf8Printable(data) << error.errorString();
return;
}
// Verify response matches the requsted value
if (jsonDoc.toVariant().toMap().value("mck").toString() != channel->password()) {
qCWarning(dcGoECharger()) << "Configured MQTT server but the response does not match with requested server password" << channel->password();
return;
} else {
qCDebug(dcGoECharger()) << "Configured successfully MQTT server" << thing << channel->password();
}
// Enable MQTT
QNetworkRequest request = buildConfigurationRequestV1(address, QString("mce=1"));
qCDebug(dcGoECharger()) << "Enable custom mqtt server on" << thing << request.url().toString();
QNetworkReply *reply = hardwareManager()->networkManager()->sendCustomRequest(request, "SET");
connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater);
connect(reply, &QNetworkReply::finished, thing, [=](){
if (reply->error() != QNetworkReply::NoError) {
qCWarning(dcGoECharger()) << "HTTP status reply returned error:" << reply->errorString();
return;
}
QByteArray data = reply->readAll();
QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) {
qCWarning(dcGoECharger()) << "Failed to parse status data for thing " << thing->name() << qUtf8Printable(data) << error.errorString();
return;
}
// Verify response matches the requsted value
QVariantMap statusMap = jsonDoc.toVariant().toMap();
if (statusMap.value("mce").toInt() != 1) {
qCWarning(dcGoECharger()) << "Configured MQTT server but the response does not match with requested value 1";
return;
} else {
qCDebug(dcGoECharger()) << "Configured successfully MQTT server enabled" << thing;
}
qCDebug(dcGoECharger()) << "Configuration of MQTT for" << thing << "finished successfully";
// Update states...
updateV1(thing, statusMap);
});
});
});
@ -682,7 +912,8 @@ void IntegrationPluginGoECharger::refreshHttp()
continue;
// Poll thing which if not using mqtt
if (!thing->paramValue(goeHomeThingUseMqttParamTypeId).toBool()) {
if (thing->paramValue(goeHomeThingUseMqttParamTypeId).toBool())
continue;
// Make sure there is not a request pending for this thing, otherwise wait for the next refresh
if (m_pendingReplies.contains(thing) && m_pendingReplies.value(thing))
@ -699,7 +930,7 @@ void IntegrationPluginGoECharger::refreshHttp()
if (reply->error() != QNetworkReply::NoError) {
qCWarning(dcGoECharger()) << "HTTP status reply returned error:" << reply->errorString();
thing->setStateValue(goeHomeConnectedStateTypeId, false);
thing->setStateValue("connected", false);
return;
}
@ -708,18 +939,75 @@ void IntegrationPluginGoECharger::refreshHttp()
QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error);
if (error.error != QJsonParseError::NoError) {
qCWarning(dcGoECharger()) << "Failed to parse status data for thing " << thing->name() << qUtf8Printable(data) << error.errorString();
thing->setStateValue(goeHomeConnectedStateTypeId, false);
thing->setStateValue("connected", false);
return;
}
ApiVersion apiVersion = getApiVersion(thing);
// Valid json data received, connected true
thing->setStateValue(goeHomeConnectedStateTypeId, true);
thing->setStateValue("connected", true);
qCDebug(dcGoECharger()) << "Received" << qUtf8Printable(jsonDoc.toJson());
QVariantMap statusMap = jsonDoc.toVariant().toMap();
update(thing, statusMap);
});
switch (apiVersion) {
case ApiVersion1:
updateV1(thing, statusMap);
break;
case ApiVersion2:
// TODO:
break;
}
});
}
}
void IntegrationPluginGoECharger::onMqttClientV1Connected(MqttChannel *channel)
{
Thing *thing = m_mqttChannelsV1.key(channel);
if (!thing) {
qCWarning(dcGoECharger()) << "Received a client connect for an unknown thing. Ignoring the event.";
return;
}
qCDebug(dcGoECharger()) << thing << "connected";
thing->setStateValue("connected", true);
}
void IntegrationPluginGoECharger::onMqttClientV1Disconnected(MqttChannel *channel)
{
Thing *thing = m_mqttChannelsV1.key(channel);
if (!thing) {
qCWarning(dcGoECharger()) << "Received a client disconnect for an unknown thing. Ignoring the event.";
return;
}
qCDebug(dcGoECharger()) << thing << "connected";
thing->setStateValue("connected", false);
}
void IntegrationPluginGoECharger::onMqttPublishV1Received(MqttChannel *channel, const QString &topic, const QByteArray &payload)
{
Thing *thing = m_mqttChannelsV1.key(channel);
if (!thing) {
qCWarning(dcGoECharger()) << "Received a MQTT client publish from an unknown thing. Ignoring the event.";
return;
}
qCDebug(dcGoECharger()) << thing << "publish received" << topic;
QJsonParseError error;
QJsonDocument jsonDoc = QJsonDocument::fromJson(payload, &error);
if (error.error != QJsonParseError::NoError) {
qCWarning(dcGoECharger()) << "Failed to parse status data for thing " << thing->name() << qUtf8Printable(payload) << error.errorString();
return;
}
QString serialNumber = thing->paramValue(goeHomeThingSerialNumberParamTypeId).toString();
if (topic == QString("go-eCharger/%1/status").arg(serialNumber)) {
updateV1(thing, jsonDoc.toVariant().toMap());
} else {
qCDebug(dcGoECharger()) << "Unhandled topic publish received:" << topic << qUtf8Printable(jsonDoc.toJson(QJsonDocument::Compact));
}
}

53
goecharger/integrationplugingoecharger.h
View File

@ -1,6 +1,6 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright 2013 - 2021, nymea GmbH
* Copyright 2013 - 2022, nymea GmbH
* Contact: contact@nymea.io
*
* This file is part of nymea.
@ -33,11 +33,12 @@
#include <QUuid>
#include <network/networkaccessmanager.h>
#include <plugintimer.h>
#include <network/mqtt/mqttchannel.h>
#include <network/mqtt/mqttprovider.h>
#include <network/networkaccessmanager.h>
#include <network/networkdevicemonitor.h>
#include <integrations/integrationplugin.h>
#include <plugintimer.h>
class IntegrationPluginGoECharger: public IntegrationPlugin
{
@ -47,7 +48,14 @@ class IntegrationPluginGoECharger: public IntegrationPlugin
Q_INTERFACES(IntegrationPlugin)
public:
enum ApiVersion {
ApiVersion1 = 1,
ApiVersion2 = 2
};
Q_ENUM(ApiVersion)
enum CarState {
CarStateUnknown = 0,
CarStateReadyNoCar = 1,
CarStateCharging = 2,
CarStateWaitForCar = 3,
@ -55,6 +63,13 @@ public:
};
Q_ENUM(CarState)
enum ForceState {
ForceStateNeutral = 0,
ForceStateOff = 1,
ForceStateOn = 2
};
Q_ENUM(ForceState)
enum Access {
AccessOpen = 0,
AccessRfid = 1,
@ -83,25 +98,39 @@ public:
void setupThing(ThingSetupInfo *info) override;
void postSetupThing(Thing *thing) override;
void thingRemoved(Thing *thing) override;
void executeAction(ThingActionInfo *info) override;
private:
PluginTimer *m_refreshTimer = nullptr;
QHash<Thing *, MqttChannel *> m_channels;
QHash<Thing *, QNetworkReply *> m_pendingReplies;
void update(Thing *thing, const QVariantMap &statusMap);
QHash<Thing *, MqttChannel *> m_mqttChannelsV1;
QHash<Thing *, MqttChannel *> m_mqttChannelsV2;
QHash<Thing *, QNetworkReply *> m_pendingReplies;
QHash<Thing *, NetworkDeviceMonitor *> m_monitors;
// General methods
void setupGoeHome(ThingSetupInfo *info);
QNetworkRequest buildStatusRequest(Thing *thing);
QNetworkRequest buildConfigurationRequest(const QHostAddress &address, const QString &configuration);
void sendActionRequest(Thing *thing, ThingActionInfo *info, const QString &configuration);
void setupMqttChannel(ThingSetupInfo *info, const QHostAddress &address, const QVariantMap &statusMap);
QHostAddress getHostAddress(Thing *thing);
ApiVersion getApiVersion(Thing *thing);
// API V1
void updateV1(Thing *thing, const QVariantMap &statusMap);
void sendActionRequestV1(Thing *thing, ThingActionInfo *info, const QString &configuration);
QNetworkRequest buildConfigurationRequestV1(const QHostAddress &address, const QString &configuration);
void setupMqttChannelV1(ThingSetupInfo *info, const QHostAddress &address, const QVariantMap &statusMap);
void reconfigureMqttChannelV1(Thing *thing, const QVariantMap &statusMap);
private slots:
void refreshHttp();
void onClientConnected(MqttChannel* channel);
void onClientDisconnected(MqttChannel* channel);
void onPublishReceived(MqttChannel* channel, const QString &topic, const QByteArray &payload);
// API V1
void onMqttClientV1Connected(MqttChannel* channel);
void onMqttClientV1Disconnected(MqttChannel* channel);
void onMqttPublishV1Received(MqttChannel* channel, const QString &topic, const QByteArray &payload);
};

98
goecharger/integrationplugingoecharger.json
View File

@ -15,24 +15,34 @@
"createMethods": ["Discovery", "User"],
"interfaces": ["evcharger", "smartmeterconsumer", "connectable"],
"paramTypes": [
{
"id": "4342b72c-99d0-41a5-abc6-ea6c1cc1352c",
"name":"ipAddress",
"displayName": "IP address",
"type": "QString"
},
{
"id": "0e30e30f-ad96-417e-b739-cac85f75de39",
"name":"macAddress",
"displayName": "MAC address",
"type": "QString"
},
{
"id": "74abaff3-39e6-40be-b3c3-f41911d17e02",
"name": "serialNumber",
"displayName": "Serial number",
"type": "QString",
"defaultValue": ""
},
{
"id": "848613a6-8a17-4082-ba77-3b4421170a4f",
"name":"useMqtt",
"displayName": "Use MQTT interface",
"type": "bool",
"defaultValue": false
"defaultValue": true
},
{
"id": "3ad014e2-c948-406e-99be-eba1d866ea20",
"name":"apiVersion",
"displayName": "API Version",
"type": "uint",
"minValue": 1,
"maxValue": 2,
"defaultValue": 1
}
],
"stateTypes":[
@ -52,6 +62,7 @@
"displayNameEvent": "Car status changed",
"type": "QString",
"possibleValues": [
"Unknown",
"Ready but no vehicle connected",
"Vehicle loads",
"Waiting for vehicle",
@ -122,24 +133,25 @@
"name": "absoluteMaxAmpere",
"displayName": "Maximal ampere",
"displayNameEvent": "Maximal ampere changed",
"displayNameAction": "Set maximal ampere",
"type": "uint",
"unit": "Ampere",
"minValue": 6,
"maxValue": 32,
"defaultValue": 20,
"writable": true,
"defaultValue": 32,
"suggestLogging": true
},
{
"id": "ac849296-3f70-4b1b-aa30-127d774667bb",
"name": "cloud",
"displayName": "Cloud enabled",
"displayNameAction": "Set cloud enabled",
"displayNameEvent": "Cloud enabled changed",
"type": "bool",
"defaultValue": true,
"writable": true
"id": "ede9251d-662e-4d4b-90e3-db3d33c823d3",
"name": "modelMaxAmpere",
"displayName": "Model maximal ampere",
"displayNameEvent": "Maximal ampere model changed",
"type": "uint",
"unit": "Ampere",
"minValue": 16,
"maxValue": 32,
"defaultValue": 16,
"suggestLogging": true,
"cached": true
},
{
"id": "08b107bc-1284-455d-9e5a-6a1c3adc389f",
@ -166,7 +178,8 @@
"displayNameEvent": "Cable ampere encoding changed",
"type": "uint",
"unit": "Ampere",
"defaultValue": 0
"defaultValue": 0,
"cached": true
},
{
"id": "d8f5abb6-5db3-4040-8829-553b1d881ce4",
@ -175,7 +188,8 @@
"displayNameEvent": "Total energy changed",
"type": "double",
"unit": "KiloWattHour",
"defaultValue": 0.0
"defaultValue": 0.0,
"cached": true
},
{
"id": "e8258831-ad89-4d27-b295-e8c10dd42b76",
@ -277,6 +291,15 @@
"unit": "Volt",
"defaultValue": 0.00
},
{
"id": "28f59f96-4b30-4606-9a04-80c82abc346b",
"name": "frequency",
"displayName": "Frequency",
"displayNameEvent": "Frequency changed",
"type": "double",
"unit": "Hertz",
"defaultValue": 50.0
},
{
"id": "b78d805a-f97c-4c9d-a647-5fc98f8d6dd1",
"name": "phaseCount",
@ -287,28 +310,6 @@
"maxValue": 3,
"defaultValue": 1
},
{
"id": "b06479d5-7a38-4fbd-867e-e55bdb54651b",
"name": "ledBrightness",
"displayName": "Led brightness",
"displayNameAction": "Set led brightness",
"displayNameEvent": "Led brightness changed",
"type": "int",
"minValue": 0,
"maxValue": 255,
"defaultValue": 255,
"writable": true
},
{
"id": "048a4c98-3ee4-4d02-ad48-6d70f31fce8c",
"name": "ledEnergySave",
"displayName": "Led energy saving enabled",
"displayNameAction": "Set led energy saving enabled",
"displayNameEvent": "Led energy saving enabled enabled changed",
"type": "bool",
"defaultValue": true,
"writable": true
},
{
"id": "2bf1ebf1-0d8c-4209-ad35-4114d9861832",
"name": "temperatureSensor1",
@ -353,15 +354,6 @@
"type": "QString",
"defaultValue": "",
"cached": true
},
{
"id": "8ecdf24b-daca-4b7a-98b5-3236f1e6ad85",
"name": "serialNumber",
"displayName": "Serial number",
"displayNameEvent": "Serial number changed",
"type": "QString",
"defaultValue": "",
"cached": true
}
]
}
@ -369,7 +361,3 @@
}
]
}