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

/**
 * 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.List;

import com.zsmartsystems.zigbee.CommandResult;
import com.zsmartsystems.zigbee.ZigBeeEndpoint;
import com.zsmartsystems.zigbee.ZigBeeNetworkManager;
import com.zsmartsystems.zigbee.ZigBeeNode;
import com.zsmartsystems.zigbee.zcl.clusters.ZclIdentifyCluster;
import com.zsmartsystems.zigbee.zcl.clusters.identify.IdentifyCommand;

/**
 * Sends the identify command to an endpoint, or all endpoints on a device supporting the {@link ZclIdentifyCluster}.
 *
 * @author Chris Jackson
 *
 */
public class ZigBeeConsoleIdentifyCommand extends ZigBeeConsoleAbstractCommand {
    @Override
    public String getCommand() {
        return "identify";
    }

    @Override
    public String getDescription() {
        return "Identifies a device";
    }

    @Override
    public String getSyntax() {
        return "ENDPOINT | NODE [TIME]";
    }

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

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

        int period = 15;
        if (args.length == 3) {
            period = parseInteger(args[2]);
        }

        List clusters = new ArrayList<>();
        if (args[1].contains("/")) {
            ZigBeeEndpoint endpoint = getEndpoint(networkManager, args[1]);
            clusters.add((ZclIdentifyCluster) endpoint.getInputCluster(ZclIdentifyCluster.CLUSTER_ID));
        } else {
            ZigBeeNode node = getNode(networkManager, args[1]);
            for (ZigBeeEndpoint endpoint : node.getEndpoints()) {
                ZclIdentifyCluster cluster = (ZclIdentifyCluster) endpoint
                        .getInputCluster(ZclIdentifyCluster.CLUSTER_ID);
                if (cluster != null) {
                    clusters.add(cluster);
                }
            }
        }

        for (ZclIdentifyCluster cluster : clusters) {
            out.println("Sending identify command to " + cluster.getZigBeeAddress());
            CommandResult result;
            IdentifyCommand command = new IdentifyCommand(period);
            try {
                result = cluster.sendCommand(command).get();
                if (result.isError()) {
                    out.println(
                            "[Endpoint: " + cluster.getZigBeeAddress() + "] Failed to send command]");
                }
            } catch (Exception e) {
                out.println(
                        "[Endpoint: " + cluster.getZigBeeAddress() + "] Failed to send command [" + e.getMessage()
                                + "]");
            }
        }
    }
}