Add machine readable console argument definition

Signed-off-by: Chris Jackson <chris@cd-jackson.com>
zsmartsystems · Feb 5, 2019 · 3ab2f8f · 3ab2f8f
1 parent 62de467
commit 3ab2f8f
Show file tree

Hide file tree

Showing 42 changed files with 542 additions and 22 deletions.
diff --git a/...ber/src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleAbstractCommand.java b/...ber/src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleAbstractCommand.java
@@ -8,7 +8,7 @@
 package com.zsmartsystems.zigbee.console.ember;
 
 import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
-import com.zsmartsystems.zigbee.console.ZigBeeConsoleCommand;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleAbstractCommand;
 import com.zsmartsystems.zigbee.dongle.ember.EmberNcp;
 import com.zsmartsystems.zigbee.dongle.ember.ZigBeeDongleEzsp;
 
@@ -17,7 +17,7 @@
  * @author Chris Jackson - Initial Contribution
  *
  */
-public abstract class EmberConsoleAbstractCommand implements ZigBeeConsoleCommand {
+public abstract class EmberConsoleAbstractCommand extends ZigBeeConsoleAbstractCommand {
 
     protected EmberNcp getEmberNcp(ZigBeeNetworkManager networkManager)
             throws IllegalArgumentException, IllegalStateException {

diff --git a/...mber/src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleMmoHashCommand.java b/...mber/src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleMmoHashCommand.java
@@ -10,6 +10,7 @@
 import java.io.PrintStream;
 
 import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleArgument;
 import com.zsmartsystems.zigbee.dongle.ember.EmberNcp;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.structure.EmberAesMmoHashContext;
 
@@ -20,6 +21,11 @@
  *
  */
 public class EmberConsoleMmoHashCommand extends EmberConsoleAbstractCommand {
+    @Override
+    protected ZigBeeConsoleArgument initializeArguments() {
+        return null;
+    }
+
     @Override
     public String getCommand() {
         return "ncpmmohash";
@@ -30,11 +36,6 @@ public String getDescription() {
         return "Passes an install code to the NCP and receives the MMO hash key";
     }
 
-    @Override
-    public String getSyntax() {
-        return "INSTALLCODE";
-    }
-
     @Override
     public String getHelp() {
         return "";
@@ -76,4 +77,10 @@ private String arrayToString(int[] data) {
 
         return builder.toString();
     }
+
+    @Override
+    public ZigBeeConsoleArgument getArguments() {
+        // TODO Auto-generated method stub
+        return null;
+    }
 }
diff --git a/.../src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleNcpChildrenCommand.java b/.../src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleNcpChildrenCommand.java
@@ -10,6 +10,7 @@
 import java.io.PrintStream;
 
 import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleArgument;
 import com.zsmartsystems.zigbee.dongle.ember.EmberNcp;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.command.EzspGetChildDataResponse;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.command.EzspGetParentChildParametersResponse;
@@ -20,6 +21,11 @@
  *
  */
 public class EmberConsoleNcpChildrenCommand extends EmberConsoleAbstractCommand {
+    @Override
+    protected ZigBeeConsoleArgument initializeArguments() {
+        return null;
+    }
+
     @Override
     public String getCommand() {
         return "ncpchildren";

diff --git a/...main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleNcpConfigurationCommand.java b/...main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleNcpConfigurationCommand.java
@@ -13,6 +13,7 @@
 import java.util.TreeMap;
 
 import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleArgument;
 import com.zsmartsystems.zigbee.dongle.ember.EmberNcp;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.structure.EzspConfigId;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.structure.EzspValueId;
@@ -24,6 +25,11 @@
  *
  */
 public class EmberConsoleNcpConfigurationCommand extends EmberConsoleAbstractCommand {
+    @Override
+    protected ZigBeeConsoleArgument initializeArguments() {
+        return null;
+    }
+
     @Override
     public String getCommand() {
         return "ncpconfig";

diff --git a/.../src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleNcpCountersCommand.java b/.../src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleNcpCountersCommand.java
@@ -10,6 +10,7 @@
 import java.io.PrintStream;
 
 import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleArgument;
 import com.zsmartsystems.zigbee.dongle.ember.EmberNcp;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.structure.EmberCounterType;
 
@@ -19,6 +20,11 @@
  *
  */
 public class EmberConsoleNcpCountersCommand extends EmberConsoleAbstractCommand {
+    @Override
+    protected ZigBeeConsoleArgument initializeArguments() {
+        return null;
+    }
+
     @Override
     public String getCommand() {
         return "ncpcounters";

diff --git a/...mber/src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleNcpScanCommand.java b/...mber/src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleNcpScanCommand.java
@@ -13,6 +13,7 @@
 import com.zsmartsystems.zigbee.ExtendedPanId;
 import com.zsmartsystems.zigbee.ZigBeeChannelMask;
 import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleArgument;
 import com.zsmartsystems.zigbee.dongle.ember.EmberNcp;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.command.EzspEnergyScanResultHandler;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.command.EzspNetworkFoundHandler;
@@ -25,6 +26,11 @@
  *
  */
 public class EmberConsoleNcpScanCommand extends EmberConsoleAbstractCommand {
+    @Override
+    protected ZigBeeConsoleArgument initializeArguments() {
+        return null;
+    }
+
     @Override
     public String getCommand() {
         return "ncpscan";
@@ -88,4 +94,5 @@ private void outputChannelEnergy(PrintStream out, List<EzspEnergyScanResultHandl
             out.println(String.format("%-2d  %d", channel.getChannel(), channel.getMaxRssiValue()));
         }
     }
+
 }
diff --git a/...ber/src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleNcpStateCommand.java b/...ber/src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleNcpStateCommand.java
@@ -11,6 +11,7 @@
 
 import com.zsmartsystems.zigbee.IeeeAddress;
 import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleArgument;
 import com.zsmartsystems.zigbee.dongle.ember.EmberNcp;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.command.EzspGetNetworkParametersResponse;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.command.EzspVersionResponse;
@@ -24,6 +25,11 @@
  *
  */
 public class EmberConsoleNcpStateCommand extends EmberConsoleAbstractCommand {
+    @Override
+    protected ZigBeeConsoleArgument initializeArguments() {
+        return null;
+    }
+
     @Override
     public String getCommand() {
         return "ncpstate";

diff --git a/...ber/src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleNcpValueCommand.java b/...ber/src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleNcpValueCommand.java
@@ -14,6 +14,7 @@
 import java.util.TreeMap;
 
 import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleArgument;
 import com.zsmartsystems.zigbee.dongle.ember.EmberNcp;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.structure.EzspStatus;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.structure.EzspValueId;
@@ -25,6 +26,11 @@
  *
  */
 public class EmberConsoleNcpValueCommand extends EmberConsoleAbstractCommand {
+    @Override
+    protected ZigBeeConsoleArgument initializeArguments() {
+        return null;
+    }
+
     @Override
     public String getCommand() {
         return "ncpvalue";

diff --git a/...r/src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleNcpVersionCommand.java b/...r/src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleNcpVersionCommand.java
@@ -10,6 +10,7 @@
 import java.io.PrintStream;
 
 import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleArgument;
 import com.zsmartsystems.zigbee.dongle.ember.EmberNcp;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.EzspFrame;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.command.EzspVersionResponse;
@@ -20,6 +21,11 @@
  *
  */
 public class EmberConsoleNcpVersionCommand extends EmberConsoleAbstractCommand {
+    @Override
+    protected ZigBeeConsoleArgument initializeArguments() {
+        return null;
+    }
+
     @Override
     public String getCommand() {
         return "ncpversion";

diff --git a/...rc/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleSecurityStateCommand.java b/...rc/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleSecurityStateCommand.java
@@ -12,6 +12,7 @@
 import java.util.List;
 
 import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleArgument;
 import com.zsmartsystems.zigbee.dongle.ember.EmberNcp;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.structure.EmberCertificate283k1Data;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.structure.EmberCertificateData;
@@ -34,6 +35,11 @@
  *
  */
 public class EmberConsoleSecurityStateCommand extends EmberConsoleAbstractCommand {
+    @Override
+    protected ZigBeeConsoleArgument initializeArguments() {
+        return null;
+    }
+
     @Override
     public String getCommand() {
         return "ncpsecuritystate";

diff --git a/...src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleTransientKeyCommand.java b/...src/main/java/com/zsmartsystems/zigbee/console/ember/EmberConsoleTransientKeyCommand.java
@@ -11,6 +11,7 @@
 
 import com.zsmartsystems.zigbee.IeeeAddress;
 import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleArgument;
 import com.zsmartsystems.zigbee.dongle.ember.EmberNcp;
 import com.zsmartsystems.zigbee.dongle.ember.ezsp.structure.EmberStatus;
 import com.zsmartsystems.zigbee.security.ZigBeeKey;
@@ -22,6 +23,11 @@
  *
  */
 public class EmberConsoleTransientKeyCommand extends EmberConsoleAbstractCommand {
+    @Override
+    protected ZigBeeConsoleArgument initializeArguments() {
+        return null;
+    }
+
     @Override
     public String getCommand() {
         return "ncptransientkey";

diff --git a/...main/java/com/zsmartsystems/zigbee/console/telegesis/TelegesisConsoleAbstractCommand.java b/...main/java/com/zsmartsystems/zigbee/console/telegesis/TelegesisConsoleAbstractCommand.java
@@ -8,7 +8,7 @@
 package com.zsmartsystems.zigbee.console.telegesis;
 
 import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
-import com.zsmartsystems.zigbee.console.ZigBeeConsoleCommand;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleAbstractCommand;
 import com.zsmartsystems.zigbee.dongle.telegesis.TelegesisNcp;
 import com.zsmartsystems.zigbee.dongle.telegesis.ZigBeeDongleTelegesis;
 
@@ -17,12 +17,12 @@
  * @author Chris Jackson - Initial Contribution
  *
  */
-public abstract class TelegesisConsoleAbstractCommand implements ZigBeeConsoleCommand {
+public abstract class TelegesisConsoleAbstractCommand extends ZigBeeConsoleAbstractCommand {
 
     protected TelegesisNcp getTelegesisNcp(ZigBeeNetworkManager networkManager)
             throws IllegalArgumentException, IllegalStateException {
         if (!(networkManager.getZigBeeTransport() instanceof ZigBeeDongleTelegesis)) {
-            throw new IllegalArgumentException("Dongle is not an Ember NCP.");
+            throw new IllegalArgumentException("Dongle is not an Telegesis NCP.");
         }
         ZigBeeDongleTelegesis dongle = (ZigBeeDongleTelegesis) networkManager.getZigBeeTransport();
         if (dongle == null) {

diff --git a/...java/com/zsmartsystems/zigbee/console/telegesis/TelegesisConsoleSecurityStateCommand.java b/...java/com/zsmartsystems/zigbee/console/telegesis/TelegesisConsoleSecurityStateCommand.java
@@ -10,6 +10,7 @@
 import java.io.PrintStream;
 
 import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
+import com.zsmartsystems.zigbee.console.ZigBeeConsoleArgument;
 import com.zsmartsystems.zigbee.dongle.telegesis.TelegesisNcp;
 
 /**
@@ -19,6 +20,10 @@
  *
  */
 public class TelegesisConsoleSecurityStateCommand extends TelegesisConsoleAbstractCommand {
+    protected ZigBeeConsoleArgument initializeArguments() {
+        return null;
+    }
+
     @Override
     public String getCommand() {
         return "ncpsecuritystate";

diff --git a/....console/src/main/java/com/zsmartsystems/zigbee/console/ZigBeeConsoleAbstractCommand.java b/....console/src/main/java/com/zsmartsystems/zigbee/console/ZigBeeConsoleAbstractCommand.java
@@ -24,6 +24,63 @@
  *
  */
 public abstract class ZigBeeConsoleAbstractCommand implements ZigBeeConsoleCommand {
+    protected ZigBeeConsoleArgument arguments = initializeArguments();
+
+    protected abstract ZigBeeConsoleArgument initializeArguments();
+
+    @Override
+    public ZigBeeConsoleArgument getArguments() {
+        return arguments;
+    }
+
+    /**
+     * Gets a human readable syntax for this command
+     *
+     * @return a {@link String} defining the possible options
+     */
+    @Override
+    public String getSyntax() {
+        if (arguments == null) {
+            return "";
+        }
+        return getSyntax("", arguments);
+    }
+
+    private String getSyntax(String indent, ZigBeeConsoleArgument argument) {
+        StringBuilder builder = new StringBuilder();
+        do {
+            if (argument.hasSuboptions()) {
+                int len = 0;
+                for (ZigBeeConsoleArgument suboption : argument.getSuboptions()) {
+                    if (suboption.getConstant().length() > len) {
+                        len = suboption.getConstant().length();
+                    }
+                }
+                for (ZigBeeConsoleArgument suboption : argument.getSuboptions()) {
+                    builder.append(getSyntax(indent, suboption));
+                }
+            } else {
+                if (argument.isOptional()) {
+                    builder.append('[');
+                }
+                if (argument.getConstant() != null) {
+                    builder.append(argument.getConstant());
+                } else {
+                    builder.append(argument.getType());
+                }
+
+                if (argument.isOptional()) {
+                    builder.append(']');
+                }
+            }
+            argument = argument.getNext();
+            if (argument != null) {
+                builder.append(' ');
+            }
+        } while (argument != null);
+        builder.append('\n');
+        return builder.toString();
+    }
 
     /**
      * Gets a {@link ZigBeeNode}