Dev models: tuyaEF00/fromDevice => private/EF00

KiwiHC16 · Mar 19, 2024 · a4a03e8 · a4a03e8
1 parent 3e45296
commit a4a03e8
Show file tree

Hide file tree

Showing 20 changed files with 106 additions and 56 deletions.
diff --git a/core/ajax/Abeille.ajax.php b/core/ajax/Abeille.ajax.php
@@ -755,7 +755,7 @@ function sendToCmd($topic, $payload = '') {
                 $curArr = $eqLogic->getConfiguration($eqConfKey, []);
                 foreach ($newArr as $setKey => $setVal) {
                     $curArr[$setKey] = $setVal;
-                    logDebug("  ${eqConfKey}[${setKey}]=${setVal}");
+                    logDebug("  ${eqConfKey}[${setKey}]=".json_encode($setVal, JSON_UNESCAPED_SLASHES));
                 }
                 $eqLogic->setConfiguration($eqConfKey, $curArr);
                 $eqLogic->save();

diff --git a/core/class/Abeille.class.php b/core/class/Abeille.class.php
@@ -3066,11 +3066,11 @@ public static function createDevice($action, $dev) {
         else
             $eqLogic->setConfiguration('poll', null);
 
-        // Tuya specific infos: OBSOLETE soon. Replaced by 'fromDevice'
-        if (isset($model['tuyaEF00']))
-            $eqLogic->setConfiguration('ab::tuyaEF00', $model['tuyaEF00']);
-        else
-            $eqLogic->setConfiguration('ab::tuyaEF00', null);
+        // Tuya specific infos: OBSOLETE ! Replaced by 'private' + 'EF00' + 'type=tuya'
+        // if (isset($model['tuyaEF00']))
+        //     $eqLogic->setConfiguration('ab::tuyaEF00', $model['tuyaEF00']);
+        // else
+        //     $eqLogic->setConfiguration('ab::tuyaEF00', null);
 
         // Xiaomi specific infos: OBSOLETE soon. Replaced by 'fromDevice'
         // if (isset($model['xiaomi']))
@@ -3103,7 +3103,7 @@ public static function createDevice($action, $dev) {
         }
         $eqLogic->setConfiguration('ab::zigbee', $zigbee);
 
-        // JSON model infos
+        // JSON model infos => 'ab::eqModel'
         $eqModelInfos = array(
             // Model infos
             'modelSource' => $modelSource, // Equipment model file location
@@ -3117,8 +3117,10 @@ public static function createDevice($action, $dev) {
             'manuf' => isset($model['manufacturer']) ? $model['manufacturer'] : '',
             'model' => isset($model['model']) ? $model['model'] : '',
             'type' => $model['type'],
+
             // 'lastUpdate' => time(), // Store last update from model. // Tcharp38: created for Abeille but not used
             // 'variables' // Optional
+            // 'private' // Optional
         );
         if ($modelPath != "${modelName}/${modelName}.json")
             $eqModelInfos['modelPath'] = $modelPath;

diff --git a/core/class/AbeilleParser.class.php b/core/class/AbeilleParser.class.php
@@ -836,10 +836,15 @@ function deviceConfigure($net, $addr) {
                 }
             } else
                 $eq['customization'] = null;
-            if (isset($eqModel['tuyaEF00']))
-                $eq['tuyaEF00'] = $eqModel['tuyaEF00'];
+            // if (isset($eqModel['tuyaEF00']))
+            //     $eq['tuyaEF00'] = $eqModel['tuyaEF00'];
+            // else
+            //     $eq['tuyaEF00'] = null;
+            // Really required here ?
+            if (isset($eqModel['private']))
+                $eq['private'] = $eqModel['private'];
             else
-                $eq['tuyaEF00'] = null;
+                $eq['private'] = null;
 
             /* Config ongoing. Informing Abeille for EQ creation/update */
             $msg = array(

diff --git a/core/config/Abeille.config.php b/core/config/Abeille.config.php
@@ -3,7 +3,7 @@
      * Abeille's static config file
      */
 
-    define('lastDbVersion', 20240312);
+    define('lastDbVersion', 20240319);
     $in = "/tmp/AbeilleDeamonInput";
     $resourcePath = realpath(__DIR__.'/../../resources');
     define('wifiLink', '/tmp/zigateWifi'); // For WIFI: Socat output

diff --git a/core/config/devices/TS0101__TZ3210_eymunffl/TS0101__TZ3210_eymunffl.json b/core/config/devices/TS0101__TZ3210_eymunffl/TS0101__TZ3210_eymunffl.json
@@ -42,8 +42,9 @@
                 "params": "clustId=0006&attrId=0000"
             }
         },
-        "tuyaEF00": {
-            "fromDevice": {
+        "private": {
+            "EF00": {
+                "type": "tuya",
                 "65": {
                     "function": "rcvValue",
                     "info": "0001-01-0021"

diff --git a/core/config/devices/TS0601__TZE200_81isopgh/TS0601__TZE200_81isopgh.json b/core/config/devices/TS0601__TZE200_81isopgh/TS0601__TZE200_81isopgh.json
@@ -50,8 +50,9 @@
                 "isHistorized": 1
             }
         },
-        "tuyaEF00": {
-            "fromDevice": {
+        "private": {
+            "EF00": {
+                "type": "tuya",
                 "05": {
                     "function": "rcvValue",
                     "info": "01-measuredValue"

diff --git a/core/config/devices/TS0601__TZE200_aoclfnxz/TS0601__TZE200_aoclfnxz.json b/core/config/devices/TS0601__TZE200_aoclfnxz/TS0601__TZE200_aoclfnxz.json
@@ -28,8 +28,9 @@
                 "nextLine": "after"
             }
         },
-        "tuyaEF00": {
-            "fromDevice": {
+        "private": {
+            "EF00": {
+                "type": "tuya",
                 "10": {
                     "function": "rcvValue",
                     "info": "01-setpoint"

diff --git a/core/config/devices/TS0601__TZE200_b6wax7g0/TS0601__TZE200_b6wax7g0.json b/core/config/devices/TS0601__TZE200_b6wax7g0/TS0601__TZE200_b6wax7g0.json
@@ -74,8 +74,9 @@
                 "isVisible": "1"
             }
         },
-        "tuyaEF00": {
-            "fromDevice": {
+        "private": {
+            "EF00": {
+                "type": "tuya",
                 "02": {
                     "function": "rcvValue",
                     "info": "01-setpoint"

diff --git a/core/config/devices/TS0601__TZE200_e3oitdyu/TS0601__TZE200_e3oitdyu.json b/core/config/devices/TS0601__TZE200_e3oitdyu/TS0601__TZE200_e3oitdyu.json
@@ -89,8 +89,9 @@
                 "nextLine": "after"
             }
         },
-        "tuyaEF00": {
-            "fromDevice": {
+        "private": {
+            "EF00": {
+                "type": "tuya",
                 "01": {
                     "function": "rcvValue",
                     "info": "status1"

diff --git a/core/config/devices/TS0601__TZE200_f1pvdgoh/TS0601__TZE200_f1pvdgoh.json b/core/config/devices/TS0601__TZE200_f1pvdgoh/TS0601__TZE200_f1pvdgoh.json
@@ -25,8 +25,9 @@
                 "isVisible": 1
             }
         },
-        "tuyaEF00": {
-            "fromDevice": {
+        "private": {
+            "EF00": {
+                "type": "tuya",
                 "01": {
                     "function": "rcvValue0Is1",
                     "info": "01-presence"

diff --git a/core/config/devices/TS0601__TZE200_hue3yfsn/TS0601__TZE200_hue3yfsn.json b/core/config/devices/TS0601__TZE200_hue3yfsn/TS0601__TZE200_hue3yfsn.json
@@ -83,8 +83,9 @@
                 "isVisible": 0
             }
         },
-        "tuyaEF00": {
-            "fromDevice": {
+        "private": {
+            "EF00": {
+                "type": "tuya",
                 "02": {
                     "function": "rcvThermostat-Mode"
                 },

diff --git a/core/config/devices/TS0601__TZE200_la2c2uo9/TS0601__TZE200_la2c2uo9.json b/core/config/devices/TS0601__TZE200_la2c2uo9/TS0601__TZE200_la2c2uo9.json
@@ -37,8 +37,9 @@
                 "isVisible": 1
             }
         },
-        "tuyaEF00": {
-            "fromDevice": {
+        "private": {
+            "EF00": {
+                "type": "tuya",
                 "01": {
                     "function": "rcvValue",
                     "info": "0006-01-0000"

diff --git a/core/config/devices/TS0601__TZE200_nklqjk62/TS0601__TZE200_nklqjk62.json b/core/config/devices/TS0601__TZE200_nklqjk62/TS0601__TZE200_nklqjk62.json
@@ -40,8 +40,9 @@
                 "isVisible": 1
             }
         },
-        "tuyaEF00": {
-            "fromDevice": {
+        "private": {
+            "EF00": {
+                "type": "tuya",
                 "01": {
                     "function": "rcvValue",
                     "info": "01-doorTrigger",
@@ -55,4 +56,4 @@
             }
         }
     }
-}
+}
diff --git a/core/config/devices/TS0601__TZE200_ntcy3xu1/TS0601__TZE200_ntcy3xu1.json b/core/config/devices/TS0601__TZE200_ntcy3xu1/TS0601__TZE200_ntcy3xu1.json
@@ -28,8 +28,9 @@
                 "isVisible": 1
             }
         },
-        "tuyaEF00": {
-            "fromDevice": {
+        "private": {
+            "EF00": {
+                "type": "tuya",
                 "01": {
                     "function": "rcvValue0Is1",
                     "info": "01-smokeAlarm"

diff --git a/core/config/devices/TS0601__TZE200_p3dbf6qs/TS0601__TZE200_p3dbf6qs.json b/core/config/devices/TS0601__TZE200_p3dbf6qs/TS0601__TZE200_p3dbf6qs.json
@@ -92,8 +92,9 @@
                 "nextLine": "after"
             }
         },
-        "tuyaEF00": {
-            "fromDevice": {
+        "private": {
+            "EF00": {
+                "type": "tuya",
                 "02": {
                     "function": "rcvThermostat-Mode",
                     "info": "01-mode",

diff --git a/core/config/devices/TS0601__TZE200_yvx5lh6k/TS0601__TZE200_yvx5lh6k.json b/core/config/devices/TS0601__TZE200_yvx5lh6k/TS0601__TZE200_yvx5lh6k.json
@@ -50,8 +50,9 @@
                 "isVisible": 1
             }
         },
-        "tuyaEF00": {
-            "fromDevice": {
+        "private": {
+            "EF00": {
+                "type": "tuya",
                 "02": {
                     "function": "rcvValue",
                     "info": "01-CO2_ppm"

diff --git a/core/php/AbeilleParser-Tuya.php b/core/php/AbeilleParser-Tuya.php
@@ -77,7 +77,7 @@ function tuyaGetDp($msg) {
     // bitmap	0x05	1/2/4	        Large end representation for lengths greater than 1 byte
 
     // Receive a datapoint, map it to a specific function an decode it.
-    // Mapping is defined "per device" directly in its model (tuyaEF00/fromDevice).
+    // Mapping is defined "per device" directly in its model (private + type="tuya").
     function tuyaDecodeDp($addr, $ep, $dp, $mapping) {
         $dpId = $dp['id'];
         if (!isset($mapping[$dpId])) {
@@ -86,8 +86,9 @@ function tuyaDecodeDp($addr, $ep, $dp, $mapping) {
         }
 
         /* New syntax
-            "tuyaEF00": {
-                "fromDevice": {
+            "private": {
+                "EF00": {
+                    "type": "tuya",
                     "01": { "function": "rcvValueDiv", "info": "0006-01-0000", "div": 1 },
                     "02": { "function": "rcvValue", "info": "0008-01-0000" },
                 }
@@ -273,11 +274,14 @@ function tuyaDecodeEF00Cmd($net, $addr, $ep, $cmdId, $msg) {
 
         if (($cmdId == "01") || ($cmdId == "02")) {
             // parserLog('debug', 'eq='.json_encode($eq));
-            if (!isset($eq['tuyaEF00']) || !isset($eq['tuyaEF00']['fromDevice'])) {
+            // if (!isset($eq['tuyaEF00']) || !isset($eq['tuyaEF00']['fromDevice'])) {
+            // TODO: EF00 might not be always the cluster in Tuya DP mode
+            if (!isset($eq['private']) || !isset($eq['private']['EF00'])) {
                 parserLog2('debug', $addr, "  No defined Tuya mapping => ignoring (msg=".$msg.")");
                 return [];
             }
-            $mapping = $eq['tuyaEF00']['fromDevice'];
+            // $mapping = $eq['tuyaEF00']['fromDevice'];
+            $mapping = $eq['private']['EF00'];
             // parserLog('debug', '  Tuya mapping='.json_encode($mapping));
 
             $tSqn = substr($msg, 0, 4); // uint16
@@ -290,8 +294,10 @@ function tuyaDecodeEF00Cmd($net, $addr, $ep, $cmdId, $msg) {
                 if ($a !== false)
                     $attributesN[] = $a;
                 else { // Unknown DP
-                    if (!isset($eq['tuyaEF00']['unknown']) || !isset($eq['tuyaEF00'][$dp['id']]))
-                        $eq['tuyaEF00']['unknown'][$dp['id']] = $dp;
+                    // if (!isset($eq['tuyaEF00']['unknown']) || !isset($eq['tuyaEF00'][$dp['id']]))
+                    //     $eq['tuyaEF00']['unknown'][$dp['id']] = $dp;
+                    // TODO: Is that the right converstion to 'private' section ?
+                    $eq['private']['EF00']['unknown'][$dp['id']] = $dp;
                 }
 
                 // Move to next DP
@@ -303,7 +309,8 @@ function tuyaDecodeEF00Cmd($net, $addr, $ep, $cmdId, $msg) {
             $tSeq = substr($msg, 0, 4);
             $msg = substr($msg, 4); // Skip tSqn
             $dp = tuyaGetDp($msg);
-            $mapping = $eq['tuyaEF00']['fromDevice'];
+            // $mapping = $eq['tuyaEF00']['fromDevice'];
+            $mapping = $eq['private']['EF00'];
             $a = tuyaDecodeDp($addr, $ep, $dp, $mapping);
             if ($a !== false)
                 $attributesN[] = $a;

diff --git a/core/php/AbeilleParser.php b/core/php/AbeilleParser.php
@@ -390,21 +390,20 @@ function updateDeviceFromDB($eqId) {
         $eq['modelForced'] = isset($eqModel['modelForced']) ? $eqModel['modelForced'] : false;
         if (isset($eqModel['modelPath'])) // Forced model variant case
             $eq['modelPath'] = $eqModel['modelPath'];
-
-        $private = $eqLogic->getConfiguration('ab::private', null);
-        if ($private !== null) {
-            $eq['private'] = $private;
+        if (isset($eqModel['private'])) {
+            $eq['private'] = $eqModel['private'];
             parserLog('debug', "  'private' updated to ".json_encode($eq['private'], JSON_UNESCAPED_SLASHES));
-        } else if (isset($eq['private']))
+        } else if ($GLOBALS['eqList'][$net][$addr]['private'])
             unset($GLOBALS['eqList'][$net][$addr]['private']);
+
         $fromDevice = $eqLogic->getConfiguration('ab::fromDevice', null); // OBSOLETE soon. Replaced by 'private'
         if ($fromDevice !== null) { // OBSOLETE soon. Replaced by 'private'
             $eq['fromDevice'] = $fromDevice;
             parserLog('debug', "  'fromDevice' updated to ".json_encode($eq['fromDevice']));
         } else if (isset($eq['fromDevice']))
             unset($GLOBALS['eqList'][$net][$addr]['fromDevice']);
-        $eq['tuyaEF00'] = $eqLogic->getConfiguration('ab::tuyaEF00', null); // OBSOLETE soon. Replaced by 'private'
-        parserLog('debug', "  'tuyaEF00' updated to ".json_encode($eq['tuyaEF00'])); // OBSOLETE soon. Replaced by 'private'
+        // $eq['tuyaEF00'] = $eqLogic->getConfiguration('ab::tuyaEF00', null); // OBSOLETE soon. Replaced by 'private'
+        // parserLog('debug', "  'tuyaEF00' updated to ".json_encode($eq['tuyaEF00'])); // OBSOLETE soon. Replaced by 'private'
         // $eq['xiaomi'] = $eqLogic->getConfiguration('ab::xiaomi', null); // OBSOLETE soon. Replaced by 'private'
         // parserLog('debug', "  'xiaomi' updated to ".json_encode($eq['xiaomi'])); // OBSOLETE soon. Replaced by 'private'
 
@@ -535,9 +534,9 @@ function signalHandler($signal) {
                 'modelSource' => '',
                 'modelForced' => isset($eqModel['modelForced']) ? $eqModel['modelForced'] : false,
                 'customization' => $eqLogic->getConfiguration('ab::customization', null),
-                //'private' => // Set if exists in model
+                //'private' => // Optional: Set if 'private' section exists in model
                 //'fromDevice' => // Set if exists in model // OBSOLETE soon
-                'tuyaEF00' => $eqLogic->getConfiguration('ab::tuyaEF00', null), // OBSOLETE soon => replaced by 'private'
+                // 'tuyaEF00' => $eqLogic->getConfiguration('ab::tuyaEF00', null), // OBSOLETE soon => replaced by 'private'
                 // 'xiaomi' => $eqLogic->getConfiguration('ab::xiaomi', null), // OBSOLETE soon => replaced by 'private'
                 // Optional 'notStandard-0400-0000'
             );

diff --git a/docs/fr_FR/Changelog.rst b/docs/fr_FR/Changelog.rst
@@ -14,6 +14,7 @@ ChangeLog
 - Réseau: Affichage table des liens Zigate 1 à l'ouverture.
 - SonOff ZbminiL2: Correction 'mac capa' incorrect => 'RxOnWhenIdle'.
 - Interne: Mises-à-jour 'check_json' + 'update_json' pour changement 'tuyaEF00/fromDevice' => 'private/EF00'.
+- Modèles d'équipement: Suppression 'tuyaEF00/fromDevice' => remplacé par 'private/EF00'.
 
 240308-BETA-1
 -------------

diff --git a/plugin_info/install.php b/plugin_info/install.php
@@ -886,7 +886,7 @@ function updateConfigDB() {
          * - Cmds DB: 'onGroupBroadcast'/'offGroupBroadcast' replaced by 'cmd-0006'
          * - Cmds DB: 'ab::trigOut' syntax updated to associative array
          */
-        if (intval($dbVersion) < 20240312) {
+        if (intval($dbVersion) < 20240319) {
             // 'eqLogic' + 'cmd' DB updates
             $eqLogics = eqLogic::byType('Abeille');
             foreach ($eqLogics as $eqLogic) {
@@ -953,23 +953,47 @@ function updateConfigDB() {
                 // ab::xiaomi replaced by ab::eqModel['private'] + type=xiaomi
                 $xiaomi = $eqLogic->getConfiguration('ab::xiaomi', null);
                 if ($xiaomi !== null) {
-                    $eqMode['private'] = [];
+                    $eqModel['private'] = [];
                     foreach ($xiaomi['fromDevice'] as $pKey => $pVal) {
                         $pVal['type'] = "xiaomi";
                         $eqModel['private'][$pKey] = $pVal;
                     }
+                    $saveEqModel = true;
                     $eqLogic->setConfiguration('ab::xiaomi', null);
                     log::add('Abeille', 'debug', '  '.$eqHName.": 'ab::xiaomi' replaced by 'private' entries");
+                }
+                // eqLogic DB: 'ab::tuyaEF00' => 'ab::eqModel['private']['EF00']'
+                /* Reminder
+                   Old syntax
+                    "tuyaEF00": {
+                        "fromDevice": {
+                            "01": { "function": "rcvValueDiv", "info": "0006-01-0000", "div": 1 }
+                        }
+                    }
+                   New syntax
+                    "private": {
+                        "EF00": {
+                            "type": "tuya",
+                            "01": { "function": "rcvValueDiv", "info": "0006-01-0000", "div": 1 }
+                        }
+                    }
+                 */
+                $tuyaEF00 = $eqLogic->getConfiguration('ab::tuyaEF00', 'nada');
+                if ($tuyaEF00 != 'nada') {
+                    $eqModel['private']['EF00'] = $tuyaEF00['fromDevice'];
+                    $eqModel['private']['EF00']['type'] = "tuya";
                     $saveEqModel = true;
+                    $eqLogic->setConfiguration('ab::tuyaEF00', null);
+                    log::add('Abeille', 'debug', '  '.$eqHName.": 'ab::tuyaEF00' moved to 'ab::eqModel['private']['EF00']");
                 }
                 // ab::signature content moved into 'ab::zigbee'
                 $sig = $eqLogic->getConfiguration('ab::signature', null);
                 if ($sig !== null) {
                     $zigbee['modelId'] = isset($sig['modelId']) ? $sig['modelId'] : '';
                     $zigbee['manufId'] = isset($sig['manufId']) ? $sig['manufId'] : '';
+                    $saveEqZigbee = true;
                     $eqLogic->setConfiguration('ab::signature', null);
                     log::add('Abeille', 'debug', '  '.$eqHName.": 'ab::signature' content moved in 'ab::zigbee'");
-                    $saveEqZigbee = true;
                 }
                 // eqLogic DB: 'groupEPx' => 'ab::eqModel['variables']'
                 for ($g = 1; $g <= 8; $g++) {