git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2024 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.knx.internal.console;
  14
  15 import java.util.List;
  16 import java.util.Map.Entry;
  17
  18 import org.eclipse.jdt.annotation.NonNullByDefault;
  19 import org.eclipse.jdt.annotation.Nullable;
  20 import org.openhab.binding.knx.internal.KNXBindingConstants;
  21 import org.openhab.binding.knx.internal.factory.KNXHandlerFactory;
  22 import org.openhab.binding.knx.internal.handler.KNXBridgeBaseThingHandler;
  23 import org.openhab.core.io.console.Console;
  24 import org.openhab.core.io.console.ConsoleCommandCompleter;
  25 import org.openhab.core.io.console.StringsCompleter;
  26 import org.openhab.core.io.console.extensions.AbstractConsoleCommandExtension;
  27 import org.openhab.core.io.console.extensions.ConsoleCommandExtension;
  28 import org.osgi.service.component.annotations.Activate;
  29 import org.osgi.service.component.annotations.Component;
  30 import org.osgi.service.component.annotations.Reference;
  31
  32 /**
  33  * The {@link KNXCommandExtension} is responsible for handling console commands
  34  *
  35  * @author Holger Friedrich - Initial contribution
  36  */
  37 @NonNullByDefault
  38 @Component(service = ConsoleCommandExtension.class)
  39 public class KNXCommandExtension extends AbstractConsoleCommandExtension implements ConsoleCommandCompleter {
  40
  41     private static final String CMD_LIST_UNKNOWN_GA = "list-unknown-ga";
  42     private static final StringsCompleter CMD_COMPLETER = new StringsCompleter(List.of(CMD_LIST_UNKNOWN_GA), false);
  43
  44     private final KNXHandlerFactory knxHandlerFactory;
  45
  46     @Activate
  47     public KNXCommandExtension(final @Reference KNXHandlerFactory knxHandlerFactory) {
  48         super(KNXBindingConstants.BINDING_ID, "Interact with KNX devices.");
  49         this.knxHandlerFactory = knxHandlerFactory;
  50     }
  51
  52     @Override
  53     public void execute(String[] args, Console console) {
  54         if (args.length == 1 && CMD_LIST_UNKNOWN_GA.equalsIgnoreCase(args[0])) {
  55             for (KNXBridgeBaseThingHandler bridgeHandler : knxHandlerFactory.getBridges()) {
  56                 console.println("KNX bridge \"" + bridgeHandler.getThing().getLabel()
  57                         + "\": group address, type, number of bytes, and number of occurence since last reload of binding:");
  58                 for (Entry<String, Long> entry : bridgeHandler.getCommandExtensionData().unknownGA().entrySet()) {
  59                     console.println(entry.getKey() + " " + entry.getValue());
  60                 }
  61             }
  62             return;
  63         }
  64         printUsage(console);
  65     }
  66
  67     @Override
  68     public List<String> getUsages() {
  69         return List
  70                 .of(buildCommandUsage(CMD_LIST_UNKNOWN_GA, "list group addresses which are not configured in openHAB"));
  71     }
  72
  73     @Override
  74     public @Nullable ConsoleCommandCompleter getCompleter() {
  75         return this;
  76     }
  77
  78     @Override
  79     public boolean complete(String[] args, int cursorArgumentIndex, int cursorPosition, List<String> candidates) {
  80         if (cursorArgumentIndex <= 0) {
  81             return CMD_COMPLETER.complete(args, cursorArgumentIndex, cursorPosition, candidates);
  82         }
  83         return false;
  84     }
  85 }