com.zsmartsystems.zigbee.console.ZigBeeConsoleCommandsSupportedCommand Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.zsmartsystems.zigbee.console Show documentation
The newest version!
/**
 * 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.Set;
import java.util.concurrent.ExecutionException;

import com.zsmartsystems.zigbee.ZigBeeEndpoint;
import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
import com.zsmartsystems.zigbee.zcl.ZclCluster;
import com.zsmartsystems.zigbee.zcl.ZclCommand;
import com.zsmartsystems.zigbee.zcl.ZclFrameType;

/**
 * Console command that prints the commands that are supported by a given cluster.
 *
 * @author Henning Sudbrock
 */
public class ZigBeeConsoleCommandsSupportedCommand extends ZigBeeConsoleAbstractCommand {

    @Override
    public String getCommand() {
        return "cmdsupported";
    }

    @Override
    public String getDescription() {
        return "Check what commands are supported within a cluster, optionally restricted to generated / received commands";
    }

    @Override
    public String getSyntax() {
        return "ENDPOINT CLUSTER [gen|rcv] [MANUFACTURER-CODE]";
    }

    @Override
    public String getHelp() {
        return "";
    }

    @Override
    public void process(ZigBeeNetworkManager networkManager, String[] args, PrintStream out)
            throws IllegalArgumentException, InterruptedException, ExecutionException {
        if (args.length < 3 || args.length > 5) {
            throw new IllegalArgumentException("Invalid number of arguments");
        }

        String endpointParam = args[1];
        String clusterSpecParam = args[2];

        String genRcvParam = null;
        Integer manufacturerCode = null;
        if (args.length == 4) {
            if (args[3].equals("gen") || args[3].equals("rcv")) {
                genRcvParam = args[3];
            } else {
                manufacturerCode = parseInteger(args[3]);
            }
        } else if (args.length == 5) {
            genRcvParam = args[3];
            manufacturerCode = parseInteger(args[4]);
        }

        final ZigBeeEndpoint endpoint = getEndpoint(networkManager, endpointParam);
        ZclCluster cluster = getCluster(endpoint, clusterSpecParam);

        if (showGenerated(genRcvParam)) {
            if (cluster.discoverCommandsGenerated(false, manufacturerCode).get()) {
                out.println("Supported generated commands for " + printCluster(cluster));
                printCommands(out, cluster, cluster.getSupportedCommandsGenerated());

            } else {
                out.println("Failed to retrieve supported generated commands");
            }
            out.println();
        }

        if (showReceived(genRcvParam)) {
            if (cluster.discoverCommandsReceived(false, manufacturerCode).get()) {
                out.println("Supported received commands for " + printCluster(cluster));
                printCommands(out, cluster, cluster.getSupportedCommandsReceived());
            } else {
                out.println("Failed to retrieve supported received commands");
            }
        }
    }

    private void printCommands(PrintStream out, ZclCluster cluster, Set commandIds) {
        out.println("CommandId  Command");
        for (Integer commandId : commandIds) {
            ZclCommand command = cluster.getCommandFromId(ZclFrameType.CLUSTER_SPECIFIC_COMMAND, commandId);
            String commandName = (command != null) ? command.getClass().getSimpleName() : "unknown";
            out.println(String.format("%8d  %s", commandId, commandName));
        }
    }

    private boolean showGenerated(String genRcvParam) {
        return genRcvParam == null || "gen".equals(genRcvParam);
    }

    private boolean showReceived(String genRcvParam) {
        return genRcvParam == null || "rcv".equals(genRcvParam);
    }
}