Add enhancements for better management of manufacturer specific clusters (#1423)

cdjackson · web-flow · commit 6f9c87d986a4 · 2024-05-08T07:46:53.000+12:00
Signed-off-by: Chris Jackson &lt;chris@cd-jackson.com&gt;
diff --git a/com.zsmartsystems.zigbee.console.main/src/main/java/com/zsmartsystems/zigbee/console/main/ZigBeeConsole.java b/com.zsmartsystems.zigbee.console.main/src/main/java/com/zsmartsystems/zigbee/console/main/ZigBeeConsole.java
@@ -37,13 +37,15 @@
 import com.zsmartsystems.zigbee.ZigBeeNetworkState;
 import com.zsmartsystems.zigbee.ZigBeeNetworkStateListener;
 import com.zsmartsystems.zigbee.ZigBeeNode;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleAttributeAddCommand;
 import com.zsmartsystems.zigbee.console.ZigBeeConsoleAttributeReadCommand;
 import com.zsmartsystems.zigbee.console.ZigBeeConsoleAttributeSupportedCommand;
 import com.zsmartsystems.zigbee.console.ZigBeeConsoleAttributeWriteCommand;
 import com.zsmartsystems.zigbee.console.ZigBeeConsoleBindCommand;
 import com.zsmartsystems.zigbee.console.ZigBeeConsoleBindingTableCommand;
 import com.zsmartsystems.zigbee.console.ZigBeeConsoleCbkeCommand;
 import com.zsmartsystems.zigbee.console.ZigBeeConsoleChannelCommand;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleClusterCommand;
 import com.zsmartsystems.zigbee.console.ZigBeeConsoleColorCommand;
 import com.zsmartsystems.zigbee.console.ZigBeeConsoleCommand;
 import com.zsmartsystems.zigbee.console.ZigBeeConsoleCommandsSupportedCommand;
@@ -225,6 +227,9 @@ public ZigBeeConsole(final ZigBeeNetworkManager networkManager, final ZigBeeTran
         newCommands.put("identify", new ZigBeeConsoleIdentifyCommand());
         newCommands.put("reset", new ZigBeeConsoleNodeResetCommand());
 
+        newCommands.put("cluster", new ZigBeeConsoleClusterCommand());
+        newCommands.put("attadd", new ZigBeeConsoleAttributeAddCommand());
+
         zigBeeApi = new ZigBeeApi(networkManager);
 
         networkManager.addNetworkStateListener(new ZigBeeNetworkStateListener() {
diff --git a/com.zsmartsystems.zigbee.console.main/src/main/java/com/zsmartsystems/zigbee/console/main/ZigBeeConsoleMain.java b/com.zsmartsystems.zigbee.console.main/src/main/java/com/zsmartsystems/zigbee/console/main/ZigBeeConsoleMain.java
@@ -129,7 +129,7 @@ public static void main(final String[] args) {
                         ZclMeteringCluster.CLUSTER_ID, ZclElectricalMeasurementCluster.CLUSTER_ID,
                         ZclDiagnosticsCluster.CLUSTER_ID, ZclPowerConfigurationCluster.CLUSTER_ID,
                         ZclBallastConfigurationCluster.CLUSTER_ID, ZclOtaUpgradeCluster.CLUSTER_ID,
-                        ZclBinaryInputBasicCluster.CLUSTER_ID, 1000)
+                        ZclBinaryInputBasicCluster.CLUSTER_ID, ZclBallastConfigurationCluster.CLUSTER_ID, 1000, 0xff17)
                 .collect(Collectors.toSet()));
 
         final Set<Integer> supportedServerClusters = new TreeSet<>();
@@ -142,7 +142,8 @@ public static void main(final String[] args) {
                         ZclElectricalMeasurementCluster.CLUSTER_ID,
                         ZclDiagnosticsCluster.CLUSTER_ID, ZclBallastConfigurationCluster.CLUSTER_ID,
                         ZclTemperatureMeasurementCluster.CLUSTER_ID, ZclIasZoneCluster.CLUSTER_ID,
-                        ZclWindowCoveringCluster.CLUSTER_ID, ZclBinaryInputBasicCluster.CLUSTER_ID, 1000)
+                        ZclWindowCoveringCluster.CLUSTER_ID, ZclBinaryInputBasicCluster.CLUSTER_ID,
+                        ZclBallastConfigurationCluster.CLUSTER_ID, 1000, 0xff17)
                 .collect(Collectors.toSet()));
 
         final TransportConfig transportOptions = new TransportConfig();
diff --git a/com.zsmartsystems.zigbee.console/src/main/java/com/zsmartsystems/zigbee/console/ZigBeeConsoleAttributeAddCommand.java b/com.zsmartsystems.zigbee.console/src/main/java/com/zsmartsystems/zigbee/console/ZigBeeConsoleAttributeAddCommand.java
@@ -0,0 +1,79 @@
+/**
+ * Copyright (c) 2016-2024 by the respective copyright holders.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package com.zsmartsystems.zigbee.console;
+
+import java.io.PrintStream;
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.concurrent.ExecutionException;
+import java.util.stream.Collectors;
+
+import com.zsmartsystems.zigbee.ZigBeeEndpoint;
+import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
+import com.zsmartsystems.zigbee.zcl.ZclAttribute;
+import com.zsmartsystems.zigbee.zcl.ZclCluster;
+import com.zsmartsystems.zigbee.zcl.protocol.ZclDataType;
+
+/**
+ *
+ * @author Chris Jackson
+ *
+ */
+public class ZigBeeConsoleAttributeAddCommand extends ZigBeeConsoleAbstractCommand {
+
+    @Override
+    public String getCommand() {
+        return "attadd";
+    }
+
+    @Override
+    public String getDescription() {
+        return "Add an attribute.";
+    }
+
+    @Override
+    public String getSyntax() {
+        return "ENDPOINT CLUSTER ATTRIBUTEID MANUFACTURER TYPE NAME";
+    }
+
+    @Override
+    public String getHelp() {
+        return null;
+    }
+
+    @Override
+    public void process(ZigBeeNetworkManager networkManager, String[] args, PrintStream out)
+            throws IllegalArgumentException, InterruptedException, ExecutionException {
+        if (args.length < 6) {
+            throw new IllegalArgumentException("Too few arguments");
+        }
+
+        final ZigBeeEndpoint endpoint = getEndpoint(networkManager, args[1]);
+        final ZclCluster cluster = getCluster(endpoint, args[2]);
+        final Integer attributeId = parseAttribute(args[3]);
+        final Integer manufacturerId = parseAttribute(args[4]);
+        final ZclDataType dataType = ZclDataType.valueOf(args[5]);
+
+        List<String> nameList = new ArrayList<>();
+        for (int cnt = 6; cnt < args.length; cnt++) {
+            nameList.add(args[cnt]);
+        }
+        String name = nameList.stream().collect(Collectors.joining(" "));
+
+        final ZclAttribute attribute = new ZclAttribute(cluster, attributeId, name, dataType, false, true, true, true,
+                manufacturerId);
+
+        Set<ZclAttribute> attributes = new HashSet<>();
+        attributes.add(attribute);
+
+        cluster.addAttributes(attributes);
+        out.println("Added attribute " + attribute);
+    }
+}
diff --git a/com.zsmartsystems.zigbee.console/src/main/java/com/zsmartsystems/zigbee/console/ZigBeeConsoleAttributeWriteCommand.java b/com.zsmartsystems.zigbee.console/src/main/java/com/zsmartsystems/zigbee/console/ZigBeeConsoleAttributeWriteCommand.java
@@ -41,7 +41,7 @@ public String getDescription() {
 
     @Override
     public String getSyntax() {
-        return "ENDPOINT CLUSTER ATTRIBUTEID (VALUE [TYPE] | {VALUE1 VALUE2 ... VALUEN} TYPE)";
+        return "ENDPOINT CLUSTER ATTRIBUTEID (VALUE [TYPE] | {VALUE1 VALUE2 ... VALUEn} TYPE)";
     }
 
     @Override
diff --git a/com.zsmartsystems.zigbee.console/src/main/java/com/zsmartsystems/zigbee/console/ZigBeeConsoleClusterCommand.java b/com.zsmartsystems.zigbee.console/src/main/java/com/zsmartsystems/zigbee/console/ZigBeeConsoleClusterCommand.java
@@ -0,0 +1,80 @@
+/**
+ * Copyright (c) 2016-2024 by the respective copyright holders.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package com.zsmartsystems.zigbee.console;
+
+import java.io.PrintStream;
+import java.util.concurrent.ExecutionException;
+
+import com.zsmartsystems.zigbee.ZigBeeEndpoint;
+import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
+import com.zsmartsystems.zigbee.zcl.ZclCluster;
+
+/**
+ *
+ * @author Chris Jackson
+ *
+ */
+public class ZigBeeConsoleClusterCommand extends ZigBeeConsoleAbstractCommand {
+
+    @Override
+    public String getCommand() {
+        return "cluster";
+    }
+
+    @Override
+    public String getDescription() {
+        return "Edit a cluster.";
+    }
+
+    @Override
+    public String getSyntax() {
+        return "ENDPOINT CLUSTER [MANUFACTURER=id]";
+    }
+
+    @Override
+    public String getHelp() {
+        return null;
+    }
+
+    @Override
+    public void process(ZigBeeNetworkManager networkManager, String[] args, PrintStream out)
+            throws IllegalArgumentException, InterruptedException, ExecutionException {
+        if (args.length < 3) {
+            throw new IllegalArgumentException("Too few arguments");
+        }
+
+        final ZigBeeEndpoint endpoint = getEndpoint(networkManager, args[1]);
+        final ZclCluster cluster = getCluster(endpoint, args[2]);
+
+        Integer manufacturer = null;
+
+        for (int i = 3; i < args.length; i++) {
+            String cmd[] = args[i].split("=");
+            if (cmd != null && cmd.length == 2) {
+                switch (cmd[0].toLowerCase()) {
+                    case "manufacturer":
+                        manufacturer = parseInteger(cmd[1]);
+                        break;
+                    default:
+                        break;
+                }
+                continue;
+            }
+        }
+
+        if (manufacturer != null) {
+            if (cluster.setManufacturerCode(manufacturer)) {
+                out.println("Manufacturer code set to " + manufacturer);
+            } else {
+                out.println("Error setting manufacturer code!");
+            }
+        }
+
+        out.println("Cluster updated: " + cluster.toString());
+    }
+}
diff --git a/com.zsmartsystems.zigbee.console/src/main/java/com/zsmartsystems/zigbee/console/ZigBeeConsoleDeviceFingerprintCommand.java b/com.zsmartsystems.zigbee.console/src/main/java/com/zsmartsystems/zigbee/console/ZigBeeConsoleDeviceFingerprintCommand.java
@@ -204,7 +204,11 @@ private void getClusterInfo(PrintStream out, ZigBeeNetworkManager networkManager
         out.println(
                 "| | | |>| Cluster " + String.format("%04X", cluster.getClusterId()) + " " + cluster.getClusterName());
         out.println("| | | | |> Type                 " + (cluster.isClient() ? "Client [Output]" : "Server [Input]"));
-        out.println("| | | | |> Manufacturer Spec.   " + (cluster.isManufacturerSpecific() ? "Yes" : "No"));
+        out.print("| | | | |> Manufacturer Spec.   " + (cluster.isManufacturerSpecific() ? "Yes" : "No"));
+        if (cluster.isManufacturerSpecific()) {
+            out.print(" [" + String.format("%04X", cluster.getManufacturerCode()) + "]");
+        }
+        out.println();
 
         if ((cluster.isClient() && !networkManager.isClientClusterSupported(cluster.getClusterId())) ||
                 (cluster.isServer() && !networkManager.isServerClusterSupported(cluster.getClusterId()))) {
diff --git a/com.zsmartsystems.zigbee/src/main/java/com/zsmartsystems/zigbee/zcl/ZclCluster.java b/com.zsmartsystems.zigbee/src/main/java/com/zsmartsystems/zigbee/zcl/ZclCluster.java
@@ -1921,14 +1921,34 @@ public Future<CommandResult> getReporting(final ZclAttribute attribute) {
     }
 
     /**
-     * Indicates whether this is a manufacturer-specific attribute. Default is not manufacturer-specific.
+     * Set the manufacturer code; must be non-null for manufacturer-specific clusters.
+     *
+     * @param manufacturerCode the new manufacturer code - must be non-null for a manufacturer specific cluster
+     * @return true if the manufacturer code was updated. If the cluster already has a manufacturer specific code set,
+     *         this will return false
+     */
+    public boolean setManufacturerCode(int manufacturerCode) {
+        if (this.manufacturerCode != null) {
+            return false;
+        }
+
+        this.manufacturerCode = manufacturerCode;
+        return true;
+    }
+
+    /**
+     * Indicates whether this is a manufacturer-specific cluster. Default is not manufacturer-specific.
+     *
+     * @return true if this is a manufacturer-specific cluster
      */
     public boolean isManufacturerSpecific() {
         return getManufacturerCode() != null;
     }
 
     /**
      * Returns the manufacturer code; must be non-null for manufacturer-specific clusters.
+     *
+     * @return the manufacturer code or null if this is not a manufacturer specific cluster
      */
     public Integer getManufacturerCode() {
         return manufacturerCode;

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public String getDescription() {`
`41`	`41`
`42`	`42`	`@Override`
`43`	`43`	`public String getSyntax() {`
`44`		`- return "ENDPOINT CLUSTER ATTRIBUTEID (VALUE [TYPE] \| {VALUE1 VALUE2 ... VALUEN} TYPE)";`
	`44`	`+ return "ENDPOINT CLUSTER ATTRIBUTEID (VALUE [TYPE] \| {VALUE1 VALUE2 ... VALUEn} TYPE)";`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`@Override`