/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Copyright 2013 - 2020, nymea GmbH * Contact: contact@nymea.io * * This file is part of nymea. * This project including source code and documentation is protected by * copyright law, and remains the property of nymea GmbH. All rights, including * reproduction, publication, editing and translation, are reserved. The use of * this project is subject to the terms of a license agreement to be concluded * with nymea GmbH in accordance with the terms of use of nymea GmbH, available * under https://nymea.io/license * * GNU Lesser General Public License Usage * Alternatively, this project may be redistributed and/or modified under the * terms of the GNU Lesser General Public License as published by the Free * Software Foundation; version 3. This project is distributed in the hope that * it will be useful, but WITHOUT ANY WARRANTY; without even the implied * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this project. If not, see . * * For any further details and any questions please contact us under * contact@nymea.io or see our FAQ/Licensing Information on * https://nymea.io/license/faq * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ #include "integrationpluginshelly.h" #include "plugininfo.h" #include #include #include #include #include #include "hardwaremanager.h" #include "network/networkaccessmanager.h" #include "network/mqtt/mqttprovider.h" #include "network/mqtt/mqttchannel.h" #include "network/zeroconf/zeroconfservicebrowser.h" #include "platform/platformzeroconfcontroller.h" IntegrationPluginShelly::IntegrationPluginShelly() { // Device param types m_idParamTypeMap[shelly1ThingClassId] = shelly1ThingIdParamTypeId; m_idParamTypeMap[shelly1pmThingClassId] = shelly1pmThingIdParamTypeId; m_idParamTypeMap[shellyPlugThingClassId] = shellyPlugThingIdParamTypeId; m_idParamTypeMap[shellyRgbw2ThingClassId] = shellyRgbw2ThingIdParamTypeId; m_idParamTypeMap[shellyDimmerThingClassId] = shellyDimmerThingIdParamTypeId; m_idParamTypeMap[shelly25ThingClassId] = shelly25ThingIdParamTypeId; m_usernameParamTypeMap[shelly1ThingClassId] = shelly1ThingUsernameParamTypeId; m_usernameParamTypeMap[shelly1pmThingClassId] = shelly1pmThingUsernameParamTypeId; m_usernameParamTypeMap[shellyPlugThingClassId] = shellyPlugThingUsernameParamTypeId; m_usernameParamTypeMap[shellyRgbw2ThingClassId] = shellyRgbw2ThingUsernameParamTypeId; m_usernameParamTypeMap[shellyDimmerThingClassId] = shellyDimmerThingUsernameParamTypeId; m_usernameParamTypeMap[shelly25ThingClassId] = shelly25ThingUsernameParamTypeId; m_passwordParamTypeMap[shelly1ThingClassId] = shelly1ThingPasswordParamTypeId; m_passwordParamTypeMap[shelly1pmThingClassId] = shelly1pmThingPasswordParamTypeId; m_passwordParamTypeMap[shellyPlugThingClassId] = shellyPlugThingPasswordParamTypeId; m_passwordParamTypeMap[shellyRgbw2ThingClassId] = shellyRgbw2ThingPasswordParamTypeId; m_passwordParamTypeMap[shellyDimmerThingClassId] = shellyDimmerThingPasswordParamTypeId; m_passwordParamTypeMap[shelly25ThingClassId] = shelly25ThingPasswordParamTypeId; m_connectedDeviceParamTypeMap[shelly1ThingClassId] = shelly1ThingConnectedDeviceParamTypeId; m_connectedDeviceParamTypeMap[shelly1pmThingClassId] = shelly1pmThingConnectedDeviceParamTypeId; m_connectedDeviceParamTypeMap[shellyPlugThingClassId] = shellyPlugThingConnectedDeviceParamTypeId; m_connectedDeviceParamTypeMap[shelly25ThingClassId] = shelly25ThingConnectedDevice1ParamTypeId; m_connectedDevice2ParamTypeMap[shelly25ThingClassId] = shelly25ThingConnectedDevice2ParamTypeId; m_channelParamTypeMap[shellyGenericThingClassId] = shellyGenericThingChannelParamTypeId; m_channelParamTypeMap[shellyLightThingClassId] = shellyLightThingChannelParamTypeId; m_channelParamTypeMap[shellySocketThingClassId] = shellySocketThingChannelParamTypeId; m_channelParamTypeMap[shellyGenericPMThingClassId] = shellyGenericPMThingChannelParamTypeId; m_channelParamTypeMap[shellyLightPMThingClassId] = shellyLightPMThingChannelParamTypeId; m_channelParamTypeMap[shellySocketPMThingClassId] = shellySocketPMThingChannelParamTypeId; m_channelParamTypeMap[shellyRollerThingClassId] = shellyRollerThingChannelParamTypeId; // States m_connectedStateTypesMap[shelly1ThingClassId] = shelly1ConnectedStateTypeId; m_connectedStateTypesMap[shelly1pmThingClassId] = shelly1pmConnectedStateTypeId; m_connectedStateTypesMap[shelly25ThingClassId] = shelly25ConnectedStateTypeId; m_connectedStateTypesMap[shellyPlugThingClassId] = shellyPlugConnectedStateTypeId; m_connectedStateTypesMap[shellyRgbw2ThingClassId] = shellyRgbw2ConnectedStateTypeId; m_connectedStateTypesMap[shellyDimmerThingClassId] = shellyDimmerConnectedStateTypeId; m_connectedStateTypesMap[shellySwitchThingClassId] = shellySwitchConnectedStateTypeId; m_connectedStateTypesMap[shellyGenericThingClassId] = shellyGenericConnectedStateTypeId; m_connectedStateTypesMap[shellyLightThingClassId] = shellyLightConnectedStateTypeId; m_connectedStateTypesMap[shellySocketThingClassId] = shellySocketConnectedStateTypeId; m_connectedStateTypesMap[shellyGenericPMThingClassId] = shellyGenericPMConnectedStateTypeId; m_connectedStateTypesMap[shellyLightPMThingClassId] = shellyLightPMConnectedStateTypeId; m_connectedStateTypesMap[shellySocketPMThingClassId] = shellySocketPMConnectedStateTypeId; m_connectedStateTypesMap[shellyRollerThingClassId] = shellyRollerConnectedStateTypeId; m_powerStateTypeMap[shellyPlugThingClassId] = shellyPlugPowerStateTypeId; m_powerStateTypeMap[shellyRgbw2ThingClassId] = shellyRgbw2PowerStateTypeId; m_powerStateTypeMap[shellyDimmerThingClassId] = shellyDimmerPowerStateTypeId; m_powerStateTypeMap[shellyGenericThingClassId] = shellyGenericPowerStateTypeId; m_powerStateTypeMap[shellyLightThingClassId] = shellyLightPowerStateTypeId; m_powerStateTypeMap[shellySocketThingClassId] = shellySocketPowerStateTypeId; m_powerStateTypeMap[shellyGenericPMThingClassId] = shellyGenericPMPowerStateTypeId; m_powerStateTypeMap[shellyLightPMThingClassId] = shellyLightPMPowerStateTypeId; m_powerStateTypeMap[shellySocketPMThingClassId] = shellySocketPMPowerStateTypeId; m_currentPowerStateTypeMap[shellyPlugThingClassId] = shellyPlugCurrentPowerStateTypeId; m_currentPowerStateTypeMap[shellyRgbw2ThingClassId] = shellyRgbw2CurrentPowerStateTypeId; m_currentPowerStateTypeMap[shellyDimmerThingClassId] = shellyDimmerCurrentPowerStateTypeId; m_currentPowerStateTypeMap[shellyGenericPMThingClassId] = shellyGenericPMCurrentPowerStateTypeId; m_currentPowerStateTypeMap[shellyLightPMThingClassId] = shellyLightPMCurrentPowerStateTypeId; m_currentPowerStateTypeMap[shellySocketPMThingClassId] = shellySocketPMCurrentPowerStateTypeId; m_currentPowerStateTypeMap[shellyRollerThingClassId] = shellyRollerCurrentPowerStateTypeId; m_totalEnergyConsumedStateTypeMap[shellyPlugThingClassId] = shellyPlugTotalEnergyConsumedStateTypeId; m_totalEnergyConsumedStateTypeMap[shellyGenericPMThingClassId] = shellyGenericPMTotalEnergyConsumedStateTypeId; m_totalEnergyConsumedStateTypeMap[shellyLightPMThingClassId] = shellyLightPMTotalEnergyConsumedStateTypeId; m_totalEnergyConsumedStateTypeMap[shellySocketPMThingClassId] = shellySocketPMTotalEnergyConsumedStateTypeId; m_totalEnergyConsumedStateTypeMap[shellyRollerThingClassId] = shellyRollerTotalEnergyConsumedStateTypeId; m_colorStateTypeMap[shellyRgbw2ThingClassId] = shellyRgbw2ColorStateTypeId; m_colorTemperatureStateTypeMap[shellyRgbw2ThingClassId] = shellyRgbw2ColorTemperatureStateTypeId; m_brightnessStateTypeMap[shellyRgbw2ThingClassId] = shellyRgbw2BrightnessStateTypeId; m_brightnessStateTypeMap[shellyDimmerThingClassId] = shellyDimmerBrightnessStateTypeId; // Actions and their params m_rebootActionTypeMap[shelly1RebootActionTypeId] = shelly1ThingClassId; m_rebootActionTypeMap[shelly1pmRebootActionTypeId] = shelly1pmThingClassId; m_rebootActionTypeMap[shellyPlugRebootActionTypeId] = shellyPlugThingClassId; m_rebootActionTypeMap[shellyRgbw2RebootActionTypeId] = shellyRgbw2ThingClassId; m_rebootActionTypeMap[shellyDimmerRebootActionTypeId] = shellyDimmerThingClassId; m_rebootActionTypeMap[shelly25RebootActionTypeId] = shelly25ThingClassId; m_powerActionTypesMap[shellyPlugPowerActionTypeId] = shellyPlugThingClassId; m_powerActionTypesMap[shellyGenericPowerActionTypeId] = shellyGenericThingClassId; m_powerActionTypesMap[shellyLightPowerActionTypeId] = shellyLightThingClassId; m_powerActionTypesMap[shellySocketPowerActionTypeId] = shellySocketThingClassId; m_powerActionTypesMap[shellyGenericPMPowerActionTypeId] = shellyGenericPMThingClassId; m_powerActionTypesMap[shellyLightPMPowerActionTypeId] = shellyLightPMThingClassId; m_powerActionTypesMap[shellySocketPMPowerActionTypeId] = shellySocketPMThingClassId; m_powerActionParamTypesMap[shellyPlugPowerActionTypeId] = shellyPlugPowerActionPowerParamTypeId; m_powerActionParamTypesMap[shellyGenericPowerActionTypeId] = shellyGenericPowerActionPowerParamTypeId; m_powerActionParamTypesMap[shellyLightPowerActionTypeId] = shellyLightPowerActionPowerParamTypeId; m_powerActionParamTypesMap[shellySocketPowerActionTypeId] = shellySocketPowerActionPowerParamTypeId; m_powerActionParamTypesMap[shellyGenericPMPowerActionTypeId] = shellyGenericPMPowerActionPowerParamTypeId; m_powerActionParamTypesMap[shellyLightPMPowerActionTypeId] = shellyLightPMPowerActionPowerParamTypeId; m_powerActionParamTypesMap[shellySocketPMPowerActionTypeId] = shellySocketPMPowerActionPowerParamTypeId; m_colorPowerActionTypesMap[shellyRgbw2PowerActionTypeId] = shellyRgbw2ThingClassId; m_colorPowerActionParamTypesMap[shellyRgbw2PowerActionPowerParamTypeId] = shellyRgbw2PowerActionTypeId; m_colorActionTypesMap[shellyRgbw2ColorActionTypeId] = shellyRgbw2ThingClassId; m_colorActionParamTypesMap[shellyRgbw2ColorActionTypeId] = shellyRgbw2ColorActionTypeId; m_colorBrightnessActionTypesMap[shellyRgbw2BrightnessActionTypeId] = shellyRgbw2ThingClassId; m_colorBrightnessActionParamTypesMap[shellyRgbw2BrightnessActionBrightnessParamTypeId] = shellyRgbw2BrightnessActionTypeId; m_colorTemperatureActionTypesMap[shellyRgbw2ColorTemperatureActionTypeId] = shellyRgbw2ThingClassId; m_colorTemperatureActionParamTypesMap[shellyRgbw2ColorTemperatureActionTypeId] = shellyRgbw2ColorTemperatureActionColorTemperatureParamTypeId; m_dimmablePowerActionTypesMap[shellyDimmerPowerActionTypeId] = shellyDimmerThingClassId; m_dimmablePowerActionParamTypesMap[shellyDimmerPowerActionTypeId] = shellyDimmerPowerActionPowerParamTypeId; m_dimmableBrightnessActionTypesMap[shellyDimmerBrightnessActionTypeId] = shellyDimmerThingClassId; m_dimmableBrightnessActionParamTypesMap[shellyDimmerBrightnessActionTypeId] = shellyDimmerBrightnessActionBrightnessParamTypeId; m_rollerOpenActionTypeMap[shellyRollerOpenActionTypeId] = shellyRollerThingClassId; m_rollerCloseActionTypeMap[shellyRollerCloseActionTypeId] = shellyRollerThingClassId; m_rollerStopActionTypeMap[shellyRollerStopActionTypeId] = shellyRollerThingClassId; } IntegrationPluginShelly::~IntegrationPluginShelly() { } void IntegrationPluginShelly::init() { m_zeroconfBrowser = hardwareManager()->zeroConfController()->createServiceBrowser("_http._tcp"); } void IntegrationPluginShelly::discoverThings(ThingDiscoveryInfo *info) { foreach (const ZeroConfServiceEntry &entry, m_zeroconfBrowser->serviceEntries()) { // qCDebug(dcShelly()) << "Have entry" << entry; QRegExp namePattern; if (info->thingClassId() == shelly1ThingClassId) { namePattern = QRegExp("^shelly1-[0-9A-Z]+$"); } else if (info->thingClassId() == shelly1pmThingClassId) { namePattern = QRegExp("^shelly1pm-[0-9A-Z]+$"); } else if (info->thingClassId() == shellyPlugThingClassId) { namePattern = QRegExp("^shellyplug(-s)?-[0-9A-Z]+$"); } else if (info->thingClassId() == shellyRgbw2ThingClassId) { namePattern = QRegExp("^shellyrgbw2-[0-9A-Z]+$"); } else if (info->thingClassId() == shellyDimmerThingClassId) { namePattern = QRegExp("^shellydimmer-[0-9A-Z]+$"); } else if (info->thingClassId() == shelly25ThingClassId) { namePattern = QRegExp("^shellyswitch25-[0-9A-Z]+$"); } if (!entry.name().contains(namePattern)) { continue; } qCDebug(dcShelly()) << "Found shelly thing!" << entry; ThingDescriptor descriptor(info->thingClassId(), entry.name(), entry.hostAddress().toString()); ParamList params; params << Param(m_idParamTypeMap.value(info->thingClassId()), entry.name()); params << Param(m_usernameParamTypeMap.value(info->thingClassId()), ""); params << Param(m_passwordParamTypeMap.value(info->thingClassId()), ""); if (m_connectedDeviceParamTypeMap.contains(info->thingClassId())) { params << Param(m_connectedDeviceParamTypeMap.value(info->thingClassId()), "None"); } if (m_connectedDevice2ParamTypeMap.contains(info->thingClassId())) { params << Param(m_connectedDevice2ParamTypeMap.value(info->thingClassId()), "None"); } descriptor.setParams(params); Things existingThings = myThings().filterByParam(m_idParamTypeMap.value(info->thingClassId()), entry.name()); if (existingThings.count() == 1) { qCDebug(dcShelly()) << "This shelly already exists in the system!"; descriptor.setThingId(existingThings.first()->id()); } info->addThingDescriptor(descriptor); } info->finish(Thing::ThingErrorNoError); } void IntegrationPluginShelly::setupThing(ThingSetupInfo *info) { Thing *thing = info->thing(); if (thing->thingClassId() == shelly1ThingClassId || thing->thingClassId() == shelly1pmThingClassId || thing->thingClassId() == shellyPlugThingClassId || thing->thingClassId() == shellyRgbw2ThingClassId || thing->thingClassId() == shellyDimmerThingClassId || thing->thingClassId() == shelly25ThingClassId) { setupShellyGateway(info); return; } setupShellyChild(info); } void IntegrationPluginShelly::thingRemoved(Thing *thing) { if (m_mqttChannels.contains(thing)) { hardwareManager()->mqttProvider()->releaseChannel(m_mqttChannels.take(thing)); } qCDebug(dcShelly()) << "Device removed" << thing->name(); } void IntegrationPluginShelly::executeAction(ThingActionInfo *info) { Thing *thing = info->thing(); Action action = info->action(); if (m_rebootActionTypeMap.contains(action.actionTypeId())) { QUrl url; url.setScheme("http"); url.setHost(getIP(info->thing())); url.setPath("/reboot"); url.setUserName(thing->paramValue(m_usernameParamTypeMap.value(thing->thingClassId())).toString()); url.setPassword(thing->paramValue(m_passwordParamTypeMap.value(thing->thingClassId())).toString()); QNetworkReply *reply = hardwareManager()->networkManager()->get(QNetworkRequest(url)); connect(reply, &QNetworkReply::finished, &QNetworkReply::deleteLater); connect(reply, &QNetworkReply::finished, info, [info, reply](){ info->finish(reply->error() == QNetworkReply::NoError ? Thing::ThingErrorNoError : Thing::ThingErrorHardwareFailure); }); return; } if (m_powerActionTypesMap.contains(action.actionTypeId())) { // If the main shelly has a power action (e.g. Shelly Plug, there is no parentId) Thing *parentDevice = thing->parentId().isNull() ? thing : myThings().findById(thing->parentId()); MqttChannel *channel = m_mqttChannels.value(parentDevice); QString shellyId = parentDevice->paramValue(m_idParamTypeMap.value(parentDevice->thingClassId())).toString(); int relay = 1; if (m_channelParamTypeMap.contains(thing->thingClassId())) { relay = thing->paramValue(m_channelParamTypeMap.value(thing->thingClassId())).toInt(); } ParamTypeId powerParamTypeId = m_powerActionParamTypesMap.value(action.actionTypeId()); bool on = action.param(powerParamTypeId).value().toBool(); channel->publish(QString("shellies/%1/relay/%2/command").arg(shellyId).arg(relay - 1), on ? "on" : "off"); info->finish(Thing::ThingErrorNoError); return; } if (m_colorPowerActionTypesMap.contains(action.actionTypeId())) { MqttChannel *channel = m_mqttChannels.value(thing); QString shellyId = info->thing()->paramValue(m_idParamTypeMap.value(info->thing()->thingClassId())).toString(); ParamTypeId colorPowerParamTypeId = m_colorPowerActionParamTypesMap.value(action.actionTypeId()); bool on = action.param(colorPowerParamTypeId).value().toBool(); channel->publish("shellies/" + shellyId + "/color/0/command", on ? "on" : "off"); info->finish(Thing::ThingErrorNoError); return; } if (m_colorActionTypesMap.contains(action.actionTypeId())) { MqttChannel *channel = m_mqttChannels.value(thing); QString shellyId = info->thing()->paramValue(m_idParamTypeMap.value(info->thing()->thingClassId())).toString(); ParamTypeId colorParamTypeId = m_colorActionParamTypesMap.value(action.actionTypeId()); QColor color = action.param(colorParamTypeId).value().value(); QVariantMap data; data.insert("turn", "on"); // Should we really? data.insert("red", color.red()); data.insert("green", color.green()); data.insert("blue", color.blue()); data.insert("white", 0); QJsonDocument jsonDoc = QJsonDocument::fromVariant(data); channel->publish("shellies/" + shellyId + "/color/0/set", jsonDoc.toJson()); info->finish(Thing::ThingErrorNoError); return; } if (m_colorTemperatureStateTypeMap.contains(action.actionTypeId())) { MqttChannel *channel = m_mqttChannels.value(thing); QString shellyId = info->thing()->paramValue(m_idParamTypeMap.value(info->thing()->thingClassId())).toString(); ParamTypeId colorTemperatureParamTypeId = m_colorTemperatureActionParamTypesMap.value(action.actionTypeId()); int ct = action.param(colorTemperatureParamTypeId).value().toInt(); QVariantMap data; data.insert("turn", "on"); // Should we really? data.insert("red", qMin(255, ct * 255 / 50)); data.insert("green", 0); data.insert("blue", qMax(0, ct - 50) * 255 / 50); data.insert("white", 255); QJsonDocument jsonDoc = QJsonDocument::fromVariant(data); channel->publish("shellies/" + shellyId + "/color/0/set", jsonDoc.toJson()); info->finish(Thing::ThingErrorNoError); return; } if (m_colorBrightnessActionTypesMap.contains(action.actionTypeId())) { MqttChannel *channel = m_mqttChannels.value(thing); QString shellyId = info->thing()->paramValue(m_idParamTypeMap.value(info->thing()->thingClassId())).toString(); ParamTypeId brightnessParamTypeId = m_colorBrightnessActionParamTypesMap.value(action.actionTypeId()); int brightness = action.param(brightnessParamTypeId).value().toInt(); QVariantMap data; data.insert("turn", "on"); // Should we really? data.insert("gain", brightness); QJsonDocument jsonDoc = QJsonDocument::fromVariant(data); channel->publish("shellies/" + shellyId + "/color/0/set", jsonDoc.toJson()); info->finish(Thing::ThingErrorNoError); return; } qCDebug(dcShelly()) << "Power action"; if (m_dimmablePowerActionTypesMap.contains(action.actionTypeId())) { MqttChannel *channel = m_mqttChannels.value(thing); QString shellyId = info->thing()->paramValue(m_idParamTypeMap.value(info->thing()->thingClassId())).toString(); ParamTypeId powerParamTypeId = m_dimmablePowerActionParamTypesMap.value(action.actionTypeId()); bool on = action.param(powerParamTypeId).value().toBool(); channel->publish("shellies/" + shellyId + "/light/0/command", on ? "on" : "off"); info->finish(Thing::ThingErrorNoError); return; } if (m_dimmableBrightnessActionTypesMap.contains(action.actionTypeId())) { MqttChannel *channel = m_mqttChannels.value(thing); QString shellyId = info->thing()->paramValue(m_idParamTypeMap.value(info->thing()->thingClassId())).toString(); ParamTypeId brightnessParamTypeId = m_dimmableBrightnessActionParamTypesMap.value(action.actionTypeId()); int brightness = action.param(brightnessParamTypeId).value().toInt(); QVariantMap data; data.insert("turn", "on"); // Should we really? data.insert("brightness", brightness); QJsonDocument jsonDoc = QJsonDocument::fromVariant(data); channel->publish("shellies/" + shellyId + "/light/0/set", jsonDoc.toJson()); info->finish(Thing::ThingErrorNoError); return; } if (m_rollerOpenActionTypeMap.contains(action.actionTypeId())) { Thing *parentDevice = myThings().findById(thing->parentId()); MqttChannel *channel = m_mqttChannels.value(parentDevice); QString shellyId = parentDevice->paramValue(m_idParamTypeMap.value(parentDevice->thingClassId())).toString(); channel->publish("shellies/" + shellyId + "/roller/0/command", "open"); info->finish(Thing::ThingErrorNoError); return; } if (m_rollerCloseActionTypeMap.contains(action.actionTypeId())) { Thing *parentDevice = myThings().findById(thing->parentId()); MqttChannel *channel = m_mqttChannels.value(parentDevice); QString shellyId = parentDevice->paramValue(m_idParamTypeMap.value(parentDevice->thingClassId())).toString(); channel->publish("shellies/" + shellyId + "/roller/0/command", "close"); info->finish(Thing::ThingErrorNoError); return; } if (m_rollerStopActionTypeMap.contains(action.actionTypeId())) { Thing *parentDevice = myThings().findById(thing->parentId()); MqttChannel *channel = m_mqttChannels.value(parentDevice); QString shellyId = parentDevice->paramValue(m_idParamTypeMap.value(parentDevice->thingClassId())).toString(); channel->publish("shellies/" + shellyId + "/roller/0/command", "stop"); info->finish(Thing::ThingErrorNoError); return; } if (action.actionTypeId() == shellyRollerCalibrateActionTypeId) { Thing *parentDevice = myThings().findById(thing->parentId()); MqttChannel *channel = m_mqttChannels.value(parentDevice); QString shellyId = parentDevice->paramValue(m_idParamTypeMap.value(parentDevice->thingClassId())).toString(); channel->publish("shellies/" + shellyId + "/roller/0/command", "rc"); info->finish(Thing::ThingErrorNoError); return; } qCWarning(dcShelly()) << "Unhandled execute action call for device" << thing; } void IntegrationPluginShelly::onClientConnected(MqttChannel *channel) { Thing *thing = m_mqttChannels.key(channel); if (!thing) { qCWarning(dcShelly()) << "Received a client connect for a thing we don't know!"; return; } thing->setStateValue(m_connectedStateTypesMap.value(thing->thingClassId()), true); foreach (Thing *child, myThings().filterByParentId(thing->id())) { child->setStateValue(m_connectedStateTypesMap[child->thingClassId()], true); } } void IntegrationPluginShelly::onClientDisconnected(MqttChannel *channel) { Thing *thing = m_mqttChannels.key(channel); if (!thing) { qCWarning(dcShelly()) << "Received a client disconnect for a thing we don't know!"; return; } thing->setStateValue(m_connectedStateTypesMap.value(thing->thingClassId()), false); foreach (Thing *child, myThings().filterByParentId(thing->id())) { child->setStateValue(m_connectedStateTypesMap[child->thingClassId()], false); } } void IntegrationPluginShelly::onPublishReceived(MqttChannel *channel, const QString &topic, const QByteArray &payload) { Thing *thing = m_mqttChannels.key(channel); if (!thing) { qCWarning(dcShelly()) << "Received a publish message for a thing we don't know!"; return; } qCDebug(dcShelly()) << "Publish received from" << thing->name() << topic << payload; QString shellyId = thing->paramValue(m_idParamTypeMap.value(thing->thingClassId())).toString(); if (topic.startsWith("shellies/" + shellyId + "/input/")) { int channel = topic.split("/").last().toInt(); // "1" or "0" // Emit event button pressed bool on = payload == "1"; foreach (Thing *child, myThings().filterByParentId(thing->id())) { if (child->thingClassId() == shellySwitchThingClassId && child->paramValue(shellySwitchThingChannelParamTypeId).toInt() == channel + 1) { if (child->stateValue(shellySwitchPowerStateTypeId).toBool() != on) { child->setStateValue(shellySwitchPowerStateTypeId, on); emit emitEvent(Event(shellySwitchPressedEventTypeId, child->id())); } } } } QRegExp topicMatcher = QRegExp("shellies/" + shellyId + "/relay/[0-1]"); if (topicMatcher.exactMatch(topic)) { QStringList parts = topic.split("/"); int channel = parts.at(3).toInt(); bool on = payload == "on"; // If the shelly main thing has a power state (e.g. Shelly Plug) if (m_powerStateTypeMap.contains(thing->thingClassId())) { thing->setStateValue(m_powerStateTypeMap.value(thing->thingClassId()), on); } // And switch all childs of this shelly too foreach (Thing *child, myThings().filterByParentId(thing->id())) { if (m_powerStateTypeMap.contains(child->thingClassId())) { ParamTypeId channelParamTypeId = m_channelParamTypeMap.value(child->thingClassId()); if (child->paramValue(channelParamTypeId).toInt() == channel + 1) { child->setStateValue(m_powerStateTypeMap.value(child->thingClassId()), on); } } } } topicMatcher = QRegExp("shellies/" + shellyId + "/(relay|roller)/[0-1]/power"); if (topicMatcher.exactMatch(topic)) { QStringList parts = topic.split("/"); int channel = parts.at(3).toInt(); double power = payload.toDouble(); // If this gateway thing supports power measuring (e.g. Shelly Plug S) set it directly here if (m_currentPowerStateTypeMap.contains(thing->thingClassId())) { thing->setStateValue(m_currentPowerStateTypeMap.value(thing->thingClassId()), power); } // For multi-channel devices, power measurements are per-channel, so, find the child thing foreach (Thing *child, myThings().filterByParentId(thing->id()).filterByInterface("extendedsmartmeterconsumer")) { ParamTypeId channelParamTypeId = m_channelParamTypeMap.value(child->thingClassId()); if (child->paramValue(channelParamTypeId).toInt() == channel + 1) { child->setStateValue(m_currentPowerStateTypeMap.value(child->thingClassId()), power); } } } topicMatcher = QRegExp("shellies/" + shellyId + "/(relay|roller)/[0-1]/energy"); if (topicMatcher.exactMatch(topic)) { QStringList parts = topic.split("/"); int channel = parts.at(3).toInt(); // W/min => kW/h double energy = payload.toDouble() / 1000 / 60; // If this gateway thing supports energy measuring (e.g. Shelly Plug S) set it directly here if (m_totalEnergyConsumedStateTypeMap.contains(thing->thingClassId())) { thing->setStateValue(m_totalEnergyConsumedStateTypeMap.value(thing->thingClassId()), energy); } // For multi-channel devices, power measurements are per-channel, so, find the child thing foreach (Thing *child, myThings().filterByParentId(thing->id()).filterByInterface("extendedsmartmeterconsumer")) { ParamTypeId channelParamTypeId = m_channelParamTypeMap.value(child->thingClassId()); if (child->paramValue(channelParamTypeId).toInt() == channel + 1) { child->setStateValue(m_totalEnergyConsumedStateTypeMap.value(child->thingClassId()), energy); } } } if (topic == "shellies/" + shellyId + "/color/0") { bool on = payload == "on"; if (m_powerStateTypeMap.contains(thing->thingClassId())) { thing->setStateValue(m_powerStateTypeMap.value(thing->thingClassId()), on); } } if (topic == "shellies/" + shellyId + "/color/0/status") { QJsonParseError error; QJsonDocument jsonDoc = QJsonDocument::fromJson(payload, &error); if (error.error != QJsonParseError::NoError) { qCWarning(dcShelly()) << "Error parsing JSON from Shelly:" << error.error << error.errorString() << payload; return; } QVariantMap statusMap = jsonDoc.toVariant().toMap(); if (m_colorStateTypeMap.contains(thing->thingClassId())) { QColor color = QColor(statusMap.value("red").toInt(), statusMap.value("green").toInt(), statusMap.value("blue").toInt()); thing->setStateValue(m_colorStateTypeMap.value(thing->thingClassId()), color); } if (m_brightnessStateTypeMap.contains(thing->thingClassId())) { int brightness = statusMap.value("gain").toInt(); thing->setStateValue(m_brightnessStateTypeMap.value(thing->thingClassId()), brightness); } if (m_currentPowerStateTypeMap.contains(thing->thingClassId())) { double power = statusMap.value("power").toDouble(); thing->setStateValue(m_currentPowerStateTypeMap.value(thing->thingClassId()), power); } } if (topic == "shellies/" + shellyId + "/light/0") { bool on = payload == "on"; if (m_powerStateTypeMap.contains(thing->thingClassId())) { thing->setStateValue(m_powerStateTypeMap.value(thing->thingClassId()), on); } } if (topic == "shellies/" + shellyId + "/light/0/status") { QJsonParseError error; QJsonDocument jsonDoc = QJsonDocument::fromJson(payload, &error); if (error.error != QJsonParseError::NoError) { qCWarning(dcShelly()) << "Error parsing JSON from Shelly:" << error.error << error.errorString() << payload; return; } QVariantMap statusMap = jsonDoc.toVariant().toMap(); if (m_brightnessStateTypeMap.contains(thing->thingClassId())) { int brightness = statusMap.value("brightness").toInt(); thing->setStateValue(m_brightnessStateTypeMap.value(thing->thingClassId()), brightness); } } if (topic == "shellies/" + shellyId + "/light/0/power") { if (m_currentPowerStateTypeMap.contains(thing->thingClassId())) { double power = payload.toDouble(); thing->setStateValue(m_currentPowerStateTypeMap.value(thing->thingClassId()), power); } } if (topic == "shellies/" + shellyId + "/roller/0") { // Roller shutters are always child devices... foreach (Thing *child, myThings().filterByParentId(thing->id()).filterByInterface("extendedshutter")) { child->setStateValue(shellyRollerMovingStateTypeId, payload != "stop"); } } if (topic == "shellies/" + shellyId + "/roller/0/pos") { // Roller shutters are always child devices... int pos = payload.toInt(); foreach (Thing *child, myThings().filterByParentId(thing->id()).filterByInterface("extendedshutter")) { child->setStateValue(shellyRollerPercentageStateTypeId, 100 - pos); } } } void IntegrationPluginShelly::setupShellyGateway(ThingSetupInfo *info) { Thing *thing = info->thing(); QString shellyId = info->thing()->paramValue(m_idParamTypeMap.value(info->thing()->thingClassId())).toString(); ZeroConfServiceEntry zeroConfEntry; foreach (const ZeroConfServiceEntry &entry, m_zeroconfBrowser->serviceEntries()) { if (entry.name() == shellyId) { zeroConfEntry = entry; } } QHostAddress address; pluginStorage()->beginGroup(info->thing()->id().toString()); if (zeroConfEntry.isValid()) { address = zeroConfEntry.hostAddress().toString(); pluginStorage()->setValue("cachedAddress", address.toString()); } else { qCWarning(dcShelly()) << "Could not find Shelly thing on zeroconf. Trying cached address."; address = pluginStorage()->value("cachedAddress").toString(); } pluginStorage()->endGroup(); if (address.isNull()) { qCWarning(dcShelly()) << "Unable to determine Shelly's network address. Failed to set up device."; info->finish(Thing::ThingErrorHardwareNotAvailable, QT_TR_NOOP("Unable to find the thing in the network.")); return; } // Validate params bool rollerMode = false; if (info->thing()->thingClassId() == shelly25ThingClassId) { QString connectedDevice1 = info->thing()->paramValue(shelly25ThingConnectedDevice1ParamTypeId).toString(); QString connectedDevice2 = info->thing()->paramValue(shelly25ThingConnectedDevice2ParamTypeId).toString(); if (connectedDevice1.startsWith("Roller Shutter") && !connectedDevice2.startsWith("Roller Shutter")) { qCWarning(dcShelly()) << "Cannot mix roller and relay mode. This won't work.."; info->finish(Thing::ThingErrorInvalidParameter, QT_TR_NOOP("Roller shutter mode can't be mixed with relay mode. Please configure both connected devices to control a shutter or relays.")); return; } if (connectedDevice1 == "Roller Shutter Up" && connectedDevice2 != "Roller Shutter Down") { qCWarning(dcShelly()) << "Connected thing 1 is shutter up but connected thing 2 is not shutter down. This won't work.."; info->finish(Thing::ThingErrorInvalidParameter, QT_TR_NOOP("For using a roller shutter, one channel must be set to up, the other to down.")); return; } if (connectedDevice1 == "Roller Shutter Down" && connectedDevice2 != "Roller Shutter Up") { qCWarning(dcShelly()) << "Connected thing 1 is shutter down but connected thing 2 is not shutter up. This won't work.."; info->finish(Thing::ThingErrorInvalidParameter, QT_TR_NOOP("For using a roller shutter, one channel must be set to up, the other to down.")); return; } if (connectedDevice1.startsWith("Roller Shutter") && connectedDevice2.startsWith("Roller Shutter")) { rollerMode = true; } } MqttChannel *channel = hardwareManager()->mqttProvider()->createChannel(shellyId, QHostAddress(address), {"shellies"}); if (!channel) { qCWarning(dcShelly()) << "Failed to create MQTT channel."; return info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("Error creating MQTT channel. Please check MQTT server settings.")); } connect(channel, &MqttChannel::clientConnected, this, &IntegrationPluginShelly::onClientConnected); connect(channel, &MqttChannel::clientDisconnected, this, &IntegrationPluginShelly::onClientDisconnected); connect(channel, &MqttChannel::publishReceived, this, &IntegrationPluginShelly::onPublishReceived); QUrl url; url.setScheme("http"); url.setHost(address.toString()); url.setPort(80); url.setPath("/settings"); url.setUserName(info->thing()->paramValue(m_usernameParamTypeMap.value(info->thing()->thingClassId())).toString()); url.setPassword(info->thing()->paramValue(m_passwordParamTypeMap.value(info->thing()->thingClassId())).toString()); QUrlQuery query; query.addQueryItem("mqtt_server", channel->serverAddress().toString() + ":" + QString::number(channel->serverPort())); query.addQueryItem("mqtt_user", channel->username()); query.addQueryItem("mqtt_pass", channel->password()); query.addQueryItem("mqtt_enable", "true"); // Make sure the shelly 2.5 is in the mode we expect it to be (roller or relay) if (info->thing()->thingClassId() == shelly25ThingClassId) { query.addQueryItem("mode", rollerMode ? "roller" : "relay"); } url.setQuery(query); QNetworkRequest request(url); qCDebug(dcShelly()) << "Connecting to" << url.toString(); QNetworkReply *reply = hardwareManager()->networkManager()->get(request); connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater); connect(info, &ThingSetupInfo::aborted, channel, [this, channel](){ hardwareManager()->mqttProvider()->releaseChannel(channel); }); connect(reply, &QNetworkReply::finished, info, [this, info, reply, channel, address](){ if (reply->error() != QNetworkReply::NoError) { hardwareManager()->mqttProvider()->releaseChannel(channel); qCWarning(dcShelly()) << "Error fetching thing settings" << reply->error() << reply->errorString(); if (reply->error() == QNetworkReply::AuthenticationRequiredError) { info->finish(Thing::ThingErrorAuthenticationFailure, QT_TR_NOOP("Username and password not set correctly.")); } else { info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("Error connecting to Shelly device.")); } return; } QByteArray data = reply->readAll(); QJsonParseError error; QJsonDocument jsonDoc = QJsonDocument::fromJson(data, &error); if (error.error != QJsonParseError::NoError) { qCWarning(dcShelly()) << "Error parsing settings reply" << error.errorString() << "\n" << data; info->finish(Thing::ThingErrorHardwareFailure, QT_TR_NOOP("Unexpected data received from Shelly device.")); hardwareManager()->mqttProvider()->releaseChannel(channel); return; } qCDebug(dcShelly()) << "Settings data" << qUtf8Printable(jsonDoc.toJson(QJsonDocument::Indented)); m_mqttChannels.insert(info->thing(), channel); ThingDescriptors autoChilds; // Autogenerate some childs if this thing has no childs yet if (myThings().filterByParentId(info->thing()->id()).isEmpty()) { // Always create the switch thing if we don't have one yet for shellies with input (1, 1pm etc) if (info->thing()->thingClassId() == shelly1ThingClassId || info->thing()->thingClassId() == shelly1pmThingClassId) { ThingDescriptor switchChild(shellySwitchThingClassId, info->thing()->name() + " switch", QString(), info->thing()->id()); autoChilds.append(switchChild); } // Create 2 switches for shelly 2.5 if (info->thing()->thingClassId() == shelly25ThingClassId) { ThingDescriptor switchChild(shellySwitchThingClassId, info->thing()->name() + " switch 1", QString(), info->thing()->id()); switchChild.setParams(ParamList() << Param(shellySwitchThingChannelParamTypeId, 1)); autoChilds.append(switchChild); ThingDescriptor switch2Child(shellySwitchThingClassId, info->thing()->name() + " switch 2", QString(), info->thing()->id()); switch2Child.setParams(ParamList() << Param(shellySwitchThingChannelParamTypeId, 2)); autoChilds.append(switch2Child); } // Add connected devices as configured in params // No PM devices for shelly 1 if (info->thing()->thingClassId() == shelly1ThingClassId) { if (info->thing()->paramValue(m_connectedDeviceParamTypeMap.value(info->thing()->thingClassId())).toString() == "Generic") { ThingDescriptor genericChild(shellyGenericThingClassId, info->thing()->name() + " connected device", QString(), info->thing()->id()); genericChild.setParams(ParamList() << Param(shellyGenericThingChannelParamTypeId, 1)); autoChilds.append(genericChild); } if (info->thing()->paramValue(m_connectedDeviceParamTypeMap.value(info->thing()->thingClassId())).toString() == "Light") { ThingDescriptor lightChild(shellyLightThingClassId, info->thing()->name() + " connected light", QString(), info->thing()->id()); lightChild.setParams(ParamList() << Param(shellyLightThingChannelParamTypeId, 1)); autoChilds.append(lightChild); } if (info->thing()->paramValue(m_connectedDeviceParamTypeMap.value(info->thing()->thingClassId())).toString() == "Socket") { ThingDescriptor socketChild(shellySocketThingClassId, info->thing()->name() + " connected socket", QString(), info->thing()->id()); socketChild.setParams(ParamList() << Param(shellySocketThingChannelParamTypeId, 1)); autoChilds.append(socketChild); } // PM devices for shelly 1 pm and 2.5 } else if (info->thing()->thingClassId() == shelly1pmThingClassId || info->thing()->thingClassId() == shelly25ThingClassId) { if (info->thing()->paramValue(m_connectedDeviceParamTypeMap.value(info->thing()->thingClassId())).toString() == "Generic") { ThingDescriptor genericChild(shellyGenericPMThingClassId, info->thing()->name() + " connected device", QString(), info->thing()->id()); genericChild.setParams(ParamList() << Param(shellyGenericPMThingChannelParamTypeId, 1)); autoChilds.append(genericChild); } if (info->thing()->paramValue(m_connectedDeviceParamTypeMap.value(info->thing()->thingClassId())).toString() == "Light") { ThingDescriptor lightChild(shellyLightPMThingClassId, info->thing()->name() + " connected light", QString(), info->thing()->id()); lightChild.setParams(ParamList() << Param(shellyLightPMThingChannelParamTypeId, 1)); autoChilds.append(lightChild); } if (info->thing()->paramValue(m_connectedDeviceParamTypeMap.value(info->thing()->thingClassId())).toString() == "Socket") { ThingDescriptor socketChild(shellySocketPMThingClassId, info->thing()->name() + " connected socket", QString(), info->thing()->id()); socketChild.setParams(ParamList() << Param(shellySocketPMThingChannelParamTypeId, 1)); autoChilds.append(socketChild); } // Add more for 2.5 if (info->thing()->thingClassId() == shelly25ThingClassId) { if (info->thing()->paramValue(m_connectedDevice2ParamTypeMap.value(info->thing()->thingClassId())).toString() == "Generic") { ThingDescriptor genericChild(shellyGenericPMThingClassId, info->thing()->name() + " connected thing 2", QString(), info->thing()->id()); genericChild.setParams(ParamList() << Param(shellyGenericPMThingChannelParamTypeId, 2)); autoChilds.append(genericChild); } if (info->thing()->paramValue(m_connectedDevice2ParamTypeMap.value(info->thing()->thingClassId())).toString() == "Light") { ThingDescriptor lightChild(shellyLightPMThingClassId, info->thing()->name() + " connected light 2", QString(), info->thing()->id()); lightChild.setParams(ParamList() << Param(shellyLightPMThingChannelParamTypeId, 2)); autoChilds.append(lightChild); } if (info->thing()->paramValue(m_connectedDevice2ParamTypeMap.value(info->thing()->thingClassId())).toString() == "Socket") { ThingDescriptor socketChild(shellySocketPMThingClassId, info->thing()->name() + " connected socket 2", QString(), info->thing()->id()); socketChild.setParams(ParamList() << Param(shellySocketPMThingChannelParamTypeId, 2)); autoChilds.append(socketChild); } if (info->thing()->paramValue(m_connectedDeviceParamTypeMap.value(info->thing()->thingClassId())).toString() == "Roller Shutter Up" && info->thing()->paramValue(m_connectedDevice2ParamTypeMap.value(info->thing()->thingClassId())).toString() == "Roller Shutter Down") { ThingDescriptor rollerShutterChild(shellyRollerThingClassId, info->thing()->name() + " connected shutter", QString(), info->thing()->id()); rollerShutterChild.setParams(ParamList() << Param(shellyRollerThingChannelParamTypeId, 1)); autoChilds.append(rollerShutterChild); } } } } info->finish(Thing::ThingErrorNoError); emit autoThingsAppeared(autoChilds); // Make sure authentication is enalbed if the user wants it QString username = info->thing()->paramValue(m_usernameParamTypeMap.value(info->thing()->thingClassId())).toString(); QString password = info->thing()->paramValue(m_passwordParamTypeMap.value(info->thing()->thingClassId())).toString(); if (!username.isEmpty()) { QUrl url; url.setScheme("http"); url.setHost(address.toString()); url.setPort(80); url.setPath("/settings/login"); url.setUserName(username); url.setPassword(password); QUrlQuery query; query.addQueryItem("username", username); query.addQueryItem("password", password); query.addQueryItem("enabled", "true"); url.setQuery(query); QNetworkRequest request(url); qCDebug(dcShelly()) << "Enabling auth" << username << password; QNetworkReply *reply = hardwareManager()->networkManager()->get(request); connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater); } }); // Handle thing settings of gateway devices if (info->thing()->thingClassId() == shellyPlugThingClassId) { connect(info->thing(), &Thing::settingChanged, this, [this, thing, shellyId](const ParamTypeId ¶mTypeId, const QVariant &value) { pluginStorage()->beginGroup(thing->id().toString()); QString address = pluginStorage()->value("cachedAddress").toString(); pluginStorage()->endGroup(); QUrl url; url.setScheme("http"); url.setHost(address); url.setPort(80); url.setPath("/settings/relay/0"); url.setUserName(thing->paramValue(m_usernameParamTypeMap.value(thing->thingClassId())).toString()); url.setPassword(thing->paramValue(m_passwordParamTypeMap.value(thing->thingClassId())).toString()); QUrlQuery query; if (paramTypeId == shellyPlugSettingsDefaultStateParamTypeId) { query.addQueryItem("default_state", value.toString()); } url.setQuery(query); QNetworkReply *reply = hardwareManager()->networkManager()->get(QNetworkRequest(url)); connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater); }); } } void IntegrationPluginShelly::setupShellyChild(ThingSetupInfo *info) { Thing *thing = info->thing(); // Connect to settings changes to store them to the thing connect(info->thing(), &Thing::settingChanged, this, [this, thing](const ParamTypeId ¶mTypeId, const QVariant &value){ Thing *parentDevice = myThings().findById(thing->parentId()); pluginStorage()->beginGroup(parentDevice->id().toString()); QString address = pluginStorage()->value("cachedAddress").toString(); pluginStorage()->endGroup(); QUrl url; url.setScheme("http"); url.setHost(address); url.setPort(80); url.setPath("/settings/relay/0"); url.setUserName(parentDevice->paramValue(m_usernameParamTypeMap.value(parentDevice->thingClassId())).toString()); url.setPassword(parentDevice->paramValue(m_passwordParamTypeMap.value(parentDevice->thingClassId())).toString()); QUrlQuery query; if (paramTypeId == shellySwitchSettingsButtonTypeParamTypeId) { query.addQueryItem("btn_type", value.toString()); } if (paramTypeId == shellySwitchSettingsInvertButtonParamTypeId) { query.addQueryItem("btn_reverse", value.toBool() ? "1" : "0"); } if (paramTypeId == shellyGenericSettingsDefaultStateParamTypeId || paramTypeId == shellyLightSettingsDefaultStateParamTypeId) { query.addQueryItem("default_state", value.toString()); } url.setQuery(query); QNetworkReply *reply = hardwareManager()->networkManager()->get(QNetworkRequest(url)); connect(reply, &QNetworkReply::finished, reply, &QNetworkReply::deleteLater); }); info->finish(Thing::ThingErrorNoError); } QString IntegrationPluginShelly::getIP(Thing *thing) const { Thing *d = thing; if (!thing->parentId().isNull()) { d = myThings().findById(thing->parentId()); } pluginStorage()->beginGroup(d->id().toString()); QString ip = pluginStorage()->value("cachedAddress").toString(); pluginStorage()->endGroup(); return ip; }