From 4e5a4c514248787f7c208a5ea7092a5c2c5b2ecc Mon Sep 17 00:00:00 2001 From: Michael Zanetti Date: Sun, 26 Jun 2022 00:11:11 +0200 Subject: [PATCH] Tasmota: Add support for energy metering --- tasmota/integrationplugintasmota.cpp | 88 +++++++++++++-------------- tasmota/integrationplugintasmota.h | 7 --- tasmota/integrationplugintasmota.json | 58 ++++++++++++++++++ 3 files changed, 102 insertions(+), 51 deletions(-) diff --git a/tasmota/integrationplugintasmota.cpp b/tasmota/integrationplugintasmota.cpp index 1eb499b4..d21c622f 100644 --- a/tasmota/integrationplugintasmota.cpp +++ b/tasmota/integrationplugintasmota.cpp @@ -42,9 +42,11 @@ #include "network/mqtt/mqttchannel.h" static QHash sonoff_basicPowerStateTypeIds = { + {"POWER", sonoff_basicPowerStateTypeId}, // On single channel devices, sometimes there's no index {"POWER1", sonoff_basicPowerStateTypeId}, }; static QHash sonoff_dimmerPowerStateTypeIds = { + {"POWER", sonoff_dimmerPowerStateTypeId}, // On single channel devices, sometimes there's no index {"POWER1", sonoff_dimmerPowerStateTypeId}, }; static QHash sonoff_dualPowerStateTypeIds = { @@ -92,9 +94,6 @@ IntegrationPluginTasmota::IntegrationPluginTasmota() m_openingChannelParamTypeMap[tasmotaBlindsThingClassId] = tasmotaBlindsThingOpeningChannelParamTypeId; m_closingChannelParamTypeMap[tasmotaBlindsThingClassId] = tasmotaBlindsThingClosingChannelParamTypeId; - m_powerStateTypeMap[tasmotaSwitchThingClassId] = tasmotaSwitchPowerStateTypeId; - m_powerStateTypeMap[tasmotaLightThingClassId] = tasmotaLightPowerStateTypeId; - m_closableOpenActionTypeMap[tasmotaShutterThingClassId] = tasmotaShutterOpenActionTypeId; m_closableCloseActionTypeMap[tasmotaShutterThingClassId] = tasmotaShutterCloseActionTypeId; m_closableStopActionTypeMap[tasmotaShutterThingClassId] = tasmotaShutterStopActionTypeId; @@ -102,29 +101,6 @@ IntegrationPluginTasmota::IntegrationPluginTasmota() m_closableOpenActionTypeMap[tasmotaBlindsThingClassId] = tasmotaBlindsOpenActionTypeId; m_closableCloseActionTypeMap[tasmotaBlindsThingClassId] = tasmotaBlindsCloseActionTypeId; m_closableStopActionTypeMap[tasmotaBlindsThingClassId] = tasmotaBlindsStopActionTypeId; - - // Helper maps for all devices - m_connectedStateTypeMap[sonoff_basicThingClassId] = sonoff_basicConnectedStateTypeId; - m_connectedStateTypeMap[sonoff_dualThingClassId] = sonoff_dualConnectedStateTypeId; - m_connectedStateTypeMap[sonoff_triThingClassId] = sonoff_triConnectedStateTypeId; - m_connectedStateTypeMap[sonoff_quadThingClassId] = sonoff_quadConnectedStateTypeId; - m_connectedStateTypeMap[sonoff_dimmerThingClassId] = sonoff_dimmerConnectedStateTypeId; - m_connectedStateTypeMap[tasmotaSwitchThingClassId] = tasmotaSwitchConnectedStateTypeId; - m_connectedStateTypeMap[tasmotaLightThingClassId] = tasmotaLightConnectedStateTypeId; - m_connectedStateTypeMap[tasmotaShutterThingClassId] = tasmotaShutterConnectedStateTypeId; - m_connectedStateTypeMap[tasmotaBlindsThingClassId] = tasmotaBlindsConnectedStateTypeId; - - m_signalStrengthStateTypeMap[sonoff_basicThingClassId] = sonoff_basicSignalStrengthStateTypeId; - m_signalStrengthStateTypeMap[sonoff_dualThingClassId] = sonoff_dualSignalStrengthStateTypeId; - m_signalStrengthStateTypeMap[sonoff_triThingClassId] = sonoff_triSignalStrengthStateTypeId; - m_signalStrengthStateTypeMap[sonoff_quadThingClassId] = sonoff_quadSignalStrengthStateTypeId; - m_signalStrengthStateTypeMap[sonoff_dimmerThingClassId] = sonoff_dimmerSignalStrengthStateTypeId; - m_signalStrengthStateTypeMap[tasmotaSwitchThingClassId] = tasmotaSwitchSignalStrengthStateTypeId; - m_signalStrengthStateTypeMap[tasmotaLightThingClassId] = tasmotaLightSignalStrengthStateTypeId; - m_signalStrengthStateTypeMap[tasmotaShutterThingClassId] = tasmotaShutterSignalStrengthStateTypeId; - m_signalStrengthStateTypeMap[tasmotaBlindsThingClassId] = tasmotaBlindsSignalStrengthStateTypeId; - - m_brightnessStateTypeMap[sonoff_dimmerThingClassId] = sonoff_dimmerBrightnessStateTypeId; } IntegrationPluginTasmota::~IntegrationPluginTasmota() @@ -266,10 +242,9 @@ void IntegrationPluginTasmota::setupThing(ThingSetupInfo *info) return; } - if (m_connectedStateTypeMap.contains(thing->thingClassId())) { + if (thing->hasState("connected")) { Thing* parentDevice = myThings().findById(thing->parentId()); - StateTypeId connectedStateTypeId = m_connectedStateTypeMap.value(thing->thingClassId()); - thing->setStateValue(m_connectedStateTypeMap.value(thing->thingClassId()), parentDevice->stateValue(connectedStateTypeId)); + thing->setStateValue("connected", parentDevice->stateValue("connected")); return info->finish(Thing::ThingErrorNoError); } @@ -327,7 +302,7 @@ void IntegrationPluginTasmota::executeAction(ThingActionInfo *info) } // Legacy (deprecated) connected devices - if (m_powerStateTypeMap.contains(thing->thingClassId())) { + if (thing->hasState("power")) { Thing *parentDev = myThings().findById(thing->parentId()); MqttChannel *channel = m_mqttChannels.value(parentDev); if (!channel) { @@ -335,10 +310,10 @@ void IntegrationPluginTasmota::executeAction(ThingActionInfo *info) return info->finish(Thing::ThingErrorHardwareNotAvailable); } ParamTypeId channelParamTypeId = m_channelParamTypeMap.value(thing->thingClassId()); - ParamTypeId powerActionParamTypeId = ParamTypeId(m_powerStateTypeMap.value(thing->thingClassId()).toString()); + ParamTypeId powerActionParamTypeId = thing->thingClass().actionTypes().findByName("power").paramTypes().findByName("power").id(); qCDebug(dcTasmota) << "Publishing:" << channel->topicPrefixList().first() + "/sonoff/cmnd/" + thing->paramValue(channelParamTypeId).toString() << (action.param(powerActionParamTypeId).value().toBool() ? "ON" : "OFF"); channel->publish(channel->topicPrefixList().first() + "/sonoff/cmnd/" + thing->paramValue(channelParamTypeId).toString().toLower(), action.param(powerActionParamTypeId).value().toBool() ? "ON" : "OFF"); - thing->setStateValue(m_powerStateTypeMap.value(thing->thingClassId()), action.param(powerActionParamTypeId).value().toBool()); + thing->setStateValue("power", action.param(powerActionParamTypeId).value().toBool()); return info->finish(Thing::ThingErrorNoError); } if (m_closableStopActionTypeMap.contains(thing->thingClassId())) { @@ -375,11 +350,11 @@ void IntegrationPluginTasmota::onClientConnected(MqttChannel *channel) { qCDebug(dcTasmota) << "Sonoff thing connected!"; Thing *dev = m_mqttChannels.key(channel); - dev->setStateValue(m_connectedStateTypeMap.value(dev->thingClassId()), true); + dev->setStateValue("connected", true); foreach (Thing *child, myThings()) { if (child->parentId() == dev->id()) { - child->setStateValue(m_connectedStateTypeMap.value(child->thingClassId()), true); + child->setStateValue("connected", true); } } } @@ -388,11 +363,11 @@ void IntegrationPluginTasmota::onClientDisconnected(MqttChannel *channel) { qCDebug(dcTasmota) << "Sonoff thing disconnected!"; Thing *dev = m_mqttChannels.key(channel); - dev->setStateValue(m_connectedStateTypeMap.value(dev->thingClassId()), false); + dev->setStateValue("connected", false); foreach (Thing *child, myThings()) { if (child->parentId() == dev->id()) { - child->setStateValue(m_connectedStateTypeMap.value(child->thingClassId()), false); + child->setStateValue("connected", false); } } } @@ -411,8 +386,8 @@ void IntegrationPluginTasmota::onPublishReceived(MqttChannel *channel, const QSt if (child->paramValue(m_channelParamTypeMap.value(child->thingClassId())).toString() != channelName) { continue; } - if (m_powerStateTypeMap.contains(child->thingClassId())) { - child->setStateValue(m_powerStateTypeMap.value(child->thingClassId()), payload == "ON"); + if (child->hasState("power")) { + child->setStateValue("power", payload == "ON"); } if (child->thingClassId() == tasmotaSwitchThingClassId) { Event event(tasmotaSwitchPressedEventTypeId, child->id()); @@ -428,20 +403,45 @@ void IntegrationPluginTasmota::onPublishReceived(MqttChannel *channel, const QSt return; } QVariantMap dataMap = jsonDoc.toVariant().toMap(); - thing->setStateValue(m_signalStrengthStateTypeMap.value(thing->thingClassId()), dataMap.value("Wifi").toMap().value("RSSI").toInt()); + thing->setStateValue("signalStrength", dataMap.value("Wifi").toMap().value("RSSI").toInt()); - if (m_brightnessStateTypeMap.contains(thing->thingClassId())) { - thing->setStateValue(m_brightnessStateTypeMap.value(thing->thingClassId()), dataMap.value("Dimmer").toInt()); + if (thing->hasState("brightness")) { + thing->setStateValue("brightness", dataMap.value("Dimmer").toInt()); } // Legacy (deprecated) connected things by params foreach (Thing *child, myThings().filterByParentId(thing->id())) { - if (m_powerStateTypeMap.contains(child->thingClassId())) { + if (child->hasState("power")) { QString childChannel = child->paramValue(m_channelParamTypeMap.value(child->thingClassId())).toString(); QString valueString = jsonDoc.toVariant().toMap().value(childChannel).toString(); - child->setStateValue(m_powerStateTypeMap.value(child->thingClassId()), valueString == "ON"); + child->setStateValue("power", valueString == "ON"); } - child->setStateValue(m_signalStrengthStateTypeMap.value(child->thingClassId()), dataMap.value("Wifi").toMap().value("RSSI").toInt()); + child->setStateValue("signalStrength", dataMap.value("Wifi").toMap().value("RSSI").toInt()); + } + } + if (topic.startsWith(channel->topicPrefixList().first() + "/sonoff/SENSOR")) { + QJsonParseError error; + QJsonDocument jsonDoc = QJsonDocument::fromJson(payload, &error); + if (error.error != QJsonParseError::NoError) { + qCWarning(dcTasmota) << "Cannot parse JSON from Tasmota device" << error.errorString(); + return; + } + QVariantMap dataMap = jsonDoc.toVariant().toMap(); + + if (dataMap.contains("ENERGY")) { + QVariantMap energyMap = dataMap.value("ENERGY").toMap(); + QString channelName = topic.split("/").last(); + + // If we received energy meter values but don't have a power meter child yet, create one + Thing *meter = myThings().filterByParentId(thing->id()).filterByInterface("smartmeterconsumer").findByParams({Param(powerMeterChannelThingChannelNameParamTypeId, channelName)}); + if (!meter) { + ThingDescriptor descriptor(powerMeterChannelThingClassId, thing->name(), QString(), thing->id()); + descriptor.setParams({Param(powerMeterChannelThingChannelNameParamTypeId, channelName)}); + emit autoThingsAppeared({descriptor}); + return; + } + meter->setStateValue("currentPower", energyMap.value("Power").toDouble()); + meter->setStateValue("totalEnergyConsumed", energyMap.value("Total").toDouble()); } } } diff --git a/tasmota/integrationplugintasmota.h b/tasmota/integrationplugintasmota.h index a499234d..2d6a4248 100644 --- a/tasmota/integrationplugintasmota.h +++ b/tasmota/integrationplugintasmota.h @@ -68,17 +68,10 @@ private: QHash m_channelParamTypeMap; QHash m_openingChannelParamTypeMap; QHash m_closingChannelParamTypeMap; - QHash m_powerStateTypeMap; QHash m_closableOpenActionTypeMap; QHash m_closableCloseActionTypeMap; QHash m_closableStopActionTypeMap; - - // Helpers for both devices - QHash m_connectedStateTypeMap; - QHash m_signalStrengthStateTypeMap; - - QHash m_brightnessStateTypeMap; }; #endif // INTEGRATIONPLUGINTASMOTA_H diff --git a/tasmota/integrationplugintasmota.json b/tasmota/integrationplugintasmota.json index 59b0833e..623d5c21 100644 --- a/tasmota/integrationplugintasmota.json +++ b/tasmota/integrationplugintasmota.json @@ -623,6 +623,64 @@ "displayName": "Stop" } ] + }, + { + "id": "805487dd-768b-47d5-a0a9-c7021bbec6ff", + "name": "powerMeterChannel", + "displayName": "Power meter", + "createMethods": ["auto"], + "interfaces": ["smartmeterconsumer", "wirelessconnectable"], + "paramTypes": [ + { + "id": "72bafebf-e541-4ede-aed5-a17241a57743", + "name": "channelName", + "displayName": "Channel name", + "type": "QString" + } + ], + "stateTypes": [ + { + "id": "f268fa63-e17f-41ab-9536-ec2e21a9164c", + "name": "connected", + "displayName": "Connected", + "displayNameEvent": "Connected changed", + "type": "bool", + "defaultValue": false, + "cached": false + }, + { + "id": "5ef7fb87-901f-4f1f-8db0-1aa0e0ee633e", + "name": "signalStrength", + "displayName": "Signal strength", + "displayNameEvent": "Signal strength changed", + "type": "uint", + "unit": "Percentage", + "minValue": 0, + "maxValue": 100, + "defaultValue": 0, + "cached": false + }, + { + "id": "bcd91dba-d063-445a-9680-32d64da29fc0", + "name": "currentPower", + "displayName": "Current power consumption", + "displayNameEvent": "Current power consumption changed", + "type": "double", + "unit": "Watt", + "defaultValue": 0, + "cached": false + }, + { + "id": "ebd82e2f-4d23-451a-a26d-9c95fd3c00be", + "name": "totalEnergyConsumed", + "displayName": "Total consumed energy", + "displayNameEvent": "Total consumption changed", + "type": "double", + "unit": "KiloWattHour", + "defaultValue": 0 + } + ] + } ] }