Refactor button map data types

* Separate from Sensor class;
* Add button map related struct types in seperate files;
* Use std::vector instead QMap;
* Use lightweight index based references to button maps in Sensor;
* Don't copy "large" button maps around;
* Parse "buttons" meta information for introspection;

This is preparation for separate REST API introspection PR.

Fix shadow iterator variable in loadButtonMapJson()


Correct intendation in  BM_ButtonMapRefForHash

Author: manup

button_maps.cpp

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2021 dresden elektronik ingenieurtechnik gmbh.
+ * All rights reserved.
+ *
+ * The software in this package is published under the terms of the BSD
+ * style license a copy of which has been included with this distribution in
+ * the LICENSE.txt file.
+ *
+ */
+
+#include "button_maps.h"
+
+ButtonMapRef BM_ButtonMapRefForHash(uint32_t buttonMapNameHash, const std::vector<ButtonMap> &buttonMaps)
+{
+    const auto bm = std::find_if(buttonMaps.cbegin(), buttonMaps.cend(),
+                                 [buttonMapNameHash](const auto &bm) { return bm.buttonMapRef.hash == buttonMapNameHash; });
+    if (bm != buttonMaps.cend())
+    {
+        return bm->buttonMapRef;
+    }
+
+    return {};
+}
+
+const ButtonMap *BM_ButtonMapForRef(ButtonMapRef ref, const std::vector<ButtonMap> &buttonMaps)
+{
+    if (isValid(ref) && ref.index < buttonMaps.size())
+    {
+        const ButtonMap &bm = buttonMaps[ref.index];
+        if (bm.buttonMapRef.hash == ref.hash)
+        {
+            return &bm;
+        }
+    }
+
+    return nullptr;
+}
+
+const ButtonMap *BM_ButtonMapForProduct(ProductIdHash productHash, const std::vector<ButtonMap> &buttonMaps,
+                                                    const std::vector<ButtonProduct> &buttonProductMap)
+{
+    ButtonMapRef buttonMapHash{};
+    {
+        const auto mapping = std::find_if(buttonProductMap.cbegin(), buttonProductMap.cend(),
+                                      [productHash](const auto &i) { return i.productHash == productHash; });
+
+        if (mapping != buttonProductMap.cend())
+        {
+            buttonMapHash = mapping->buttonMapRef;
+        }
+    }
+
+    if (isValid(buttonMapHash))
+    {
+        return BM_ButtonMapForRef(buttonMapHash, buttonMaps);
+    }
+
+    return nullptr;
+}

button_maps.h

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2021 dresden elektronik ingenieurtechnik gmbh.
+ * All rights reserved.
+ *
+ * The software in this package is published under the terms of the BSD
+ * style license a copy of which has been included with this distribution in
+ * the LICENSE.txt file.
+ *
+ */
+
+#ifndef BUTTON_MAPS_H
+#define BUTTON_MAPS_H
+
+#include <QString>
+#include <vector>
+
+using ProductIdHash = std::size_t;
+
+/*! Reference to a button map for quick lookup and leightweight embedding. */
+struct ButtonMapRef
+{
+    uint32_t hash = 0; //! hash of button map name
+    uint32_t index = UINT32_MAX; //! index into ButtonMap vector
+};
+
+/*! Meta data about buttons, not used by the plugin but exposed via REST API. */
+struct ButtonMeta
+{
+    struct Button
+    {
+        QString name;
+        int button;
+    };
+
+    std::vector<ButtonMeta::Button> buttons;
+    ButtonMapRef buttonMapRef{};
+};
+
+/*! Mapping between a product and a buttom map.
+ */
+struct ButtonProduct
+{
+    ButtonMapRef buttonMapRef{};
+    ProductIdHash productHash = 0; //! hash of modelid or manufacturer name generated by \c productHash(Resource*)
+};
+
+struct ButtonMap
+{
+    struct Item
+    {
+        quint8 mode;
+        quint8 endpoint;
+        quint16 clusterId;
+        quint8 zclCommandId;
+        quint16 zclParam0;
+        int button;
+        QString name;
+    };
+    std::vector<ButtonMap::Item> buttons;
+    ButtonMapRef buttonMapRef{};
+};
+
+ButtonMapRef BM_ButtonMapRefForHash(uint32_t buttonMapNameHash, const std::vector<ButtonMap> &buttonMaps);
+const ButtonMap *BM_ButtonMapForRef(ButtonMapRef ref, const std::vector<ButtonMap> &buttonMaps);
+const ButtonMap *BM_ButtonMapForProduct(ProductIdHash productHash, const std::vector<ButtonMap> &buttonMaps, const std::vector<ButtonProduct> &buttonProductMap);
+
+inline bool isValid(ButtonMapRef a) { return a.hash != 0 && a.index != UINT32_MAX; }
+inline bool operator==(ButtonMapRef a, ButtonMapRef b) { return a.hash == b.hash && a.index == b.index; }
+inline bool operator!=(ButtonMapRef a, ButtonMapRef b) { return !(a == b); }
+
+#endif // BUTTON_MAPS_H

de_web.pro

@@ -99,6 +99,7 @@ DEFINES += GW_DEFAULT_NAME=\\\"Phoscon-GW\\\"
 
 HEADERS  = bindings.h \
            backup.h \
+           button_maps.h \
            connectivity.h \
            colorspace.h \
            daylight.h \
@@ -132,6 +133,7 @@ SOURCES  = air_quality.cpp \
            authorisation.cpp \
            backup.cpp \
            bindings.cpp \
+           button_maps.cpp \
            change_channel.cpp \
            connectivity.cpp \
            colorspace.cpp \

de_web_plugin.cpp

@@ -868,14 +868,15 @@ DeRestPluginPrivate::DeRestPluginPrivate(QObject *parent) :
         }
 
         QStringList requiredJsonObjects = {"buttons", "buttonActions", "clusters", "commands", "maps"};
-        QJsonDocument buttonMaps = readButtonMapJson(path);
+        QJsonDocument buttonMapsDoc = readButtonMapJson(path);
 
-        if (checkRootLevelObjectsJson(buttonMaps, requiredJsonObjects))
+        if (checkRootLevelObjectsJson(buttonMapsDoc, requiredJsonObjects))
         {
-            btnMapClusters = loadButtonMapClustersJson(buttonMaps);
-            btnMapClusterCommands = loadButtonMapCommadsJson(buttonMaps);
-            buttonMapForModelId = loadButtonMapModelIdsJson(buttonMaps);
-            buttonMapData = loadButtonMapsJson(buttonMaps, btnMapClusters, btnMapClusterCommands);
+            btnMapClusters = loadButtonMapClustersJson(buttonMapsDoc);
+            btnMapClusterCommands = loadButtonMapCommadsJson(buttonMapsDoc);
+            buttonMaps = loadButtonMapsJson(buttonMapsDoc, btnMapClusters, btnMapClusterCommands);
+            buttonMeta = loadButtonMetaJson(buttonMapsDoc, buttonMaps);
+            buttonProductMap = loadButtonMapModelIdsJson(buttonMapsDoc, buttonMaps);
             break; // only load once
         }
     }
@@ -4014,7 +4015,22 @@ void DeRestPluginPrivate::checkSensorButtonEvent(Sensor *sensor, const deCONZ::A
 
     bool checkReporting = false;
     bool checkClientCluster = false;
-    const std::vector<Sensor::ButtonMap> buttonMapVec = sensor->buttonMap(buttonMapData, buttonMapForModelId);
+
+    const ButtonMap *buttonMap = nullptr;
+
+    if (!isValid(sensor->buttonMapRef())) // TODO sensor.hasButtonMap()
+    {
+        buttonMap = BM_ButtonMapForProduct(productHash(sensor), buttonMaps, buttonProductMap);
+        if (buttonMap)
+        {
+            sensor->setButtonMapRef(buttonMap->buttonMapRef);
+        }
+    }
+    else
+    {
+        buttonMap = BM_ButtonMapForRef(sensor->buttonMapRef(), buttonMaps);
+    }
+
     QString cluster = "0x" + QString("%1").arg(ind.clusterId(), 4, 16, QLatin1Char('0')).toUpper();
     QString cmd = "0x" + QString("%1").arg(zclFrame.commandId(), 2, 16, QLatin1Char('0')).toUpper();
     QString addressMode;
@@ -4034,7 +4050,7 @@ void DeRestPluginPrivate::checkSensorButtonEvent(Sensor *sensor, const deCONZ::A
         if (!temp.empty() && !temp.key(zclFrame.commandId()).isEmpty()) { cmd = temp.key(zclFrame.commandId()) + " (" + cmd + ")"; }
     }
 
-    if (buttonMapVec.empty())
+    if (!buttonMap || buttonMap->buttons.empty())
     {
         DBG_Printf(DBG_INFO, "[INFO] - No button map for: %s%s, endpoint: 0x%02X, cluster: %s, command: %s, payload: %s, zclSeq: %u\n",
             qPrintable(sensor->modelId()), qPrintable(addressMode), ind.srcEndpoint(), qPrintable(cluster), qPrintable(cmd), qPrintable(zclPayload), zclFrame.sequenceNumber());
@@ -4435,7 +4451,7 @@ void DeRestPluginPrivate::checkSensorButtonEvent(Sensor *sensor, const deCONZ::A
     }
 
     bool ok = false;
-    for (const auto &buttonMap : buttonMapVec)
+    for (const auto &buttonMap : buttonMap->buttons)
     {
         if (buttonMap.mode != Sensor::ModeNone && !ok)
         {

de_web_plugin_private.h

@@ -1684,10 +1684,11 @@ public Q_SLOTS:
     QString emptyString;
 
     // JSON support
-    QMap<QString, std::vector<Sensor::ButtonMap>> buttonMapData;
+    std::vector<ButtonMeta> buttonMeta;
+    std::vector<ButtonMap> buttonMaps;
     QMap<QString, quint16> btnMapClusters;
     QMap<QString, QMap<QString, quint16>> btnMapClusterCommands;
-    QMap<QString, QString> buttonMapForModelId;
+    std::vector<ButtonProduct> buttonProductMap;
 
     // gateways
     std::vector<Gateway*> gateways;

product_match.cpp

@@ -243,3 +243,21 @@ bool isLidlDevice(const QString &zigbeeModelIdentifier, const QString &manufactu
     }
     return false;
 }
+
+uint productHash(const Resource *r)
+{
+    if (!r || !r->item(RAttrManufacturerName) || !r->item(RAttrModelId))
+    {
+        return 0;
+    }
+
+    if (isTuyaManufacturerName(r->item(RAttrManufacturerName)->toString()))
+    {
+        // for Tuya devices use manufacturer name as modelid
+        return qHash(r->item(RAttrManufacturerName)->toString());
+    }
+    else
+    {
+        return qHash(r->item(RAttrModelId)->toString());
+    }
+}

product_match.h

@@ -26,5 +26,6 @@ const QString R_GetProductId(Resource *resource);
 bool isTuyaManufacturerName(const QString &manufacturer);
 bool isLidlDevice(const QString &zigbeeModelIdentifier, const QString &manufacturername);
 const lidlDevice *getLidlDevice(const QString &zigbeeManufacturerName);
+uint productHash(const Resource *r);
 
 #endif // PRODUCT_MATCH_H