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

   1 /**
   2  * Copyright (c) 2010-2023 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.Arrays;
  16 import java.util.List;
  17 import java.util.Map.Entry;
  18
  19 import org.eclipse.jdt.annotation.NonNullByDefault;
  20 import org.eclipse.jdt.annotation.Nullable;
  21 import org.openhab.binding.knx.internal.KNXBindingConstants;
  22 import org.openhab.binding.knx.internal.factory.KNXHandlerFactory;
  23 import org.openhab.binding.knx.internal.handler.KNXBridgeBaseThingHandler;
  24 import org.openhab.core.io.console.Console;
  25 import org.openhab.core.io.console.ConsoleCommandCompleter;
  26 import org.openhab.core.io.console.StringsCompleter;
  27 import org.openhab.core.io.console.extensions.AbstractConsoleCommandExtension;
  28 import org.openhab.core.io.console.extensions.ConsoleCommandExtension;
  29 import org.osgi.service.component.annotations.Activate;
  30 import org.osgi.service.component.annotations.Component;
  31 import org.osgi.service.component.annotations.Reference;
  32
  33 /**
  34  * The {@link KNXCommandExtension} is responsible for handling console commands
  35  *
  36  * @author Holger Friedrich - Initial contribution
  37  */
  38 @NonNullByDefault
  39 @Component(service = ConsoleCommandExtension.class)
  40 public class KNXCommandExtension extends AbstractConsoleCommandExtension implements ConsoleCommandCompleter {
  41
  42     private static final String CMD_LIST_UNKNOWN_GA = "list-unknown-ga";
  43     private static final StringsCompleter CMD_COMPLETER = new StringsCompleter(List.of(CMD_LIST_UNKNOWN_GA), false);
  44
  45     private final KNXHandlerFactory knxHandlerFactory;
  46
  47     @Activate
  48     public KNXCommandExtension(final @Reference KNXHandlerFactory knxHandlerFactory) {
  49         super(KNXBindingConstants.BINDING_ID, "Interact with KNX devices.");
  50         this.knxHandlerFactory = knxHandlerFactory;
  51     }
  52
  53     @Override
  54     public void execute(String[] args, Console console) {
  55         if (args.length == 1 && CMD_LIST_UNKNOWN_GA.equalsIgnoreCase(args[0])) {
  56             for (KNXBridgeBaseThingHandler bridgeHandler : knxHandlerFactory.getBridges()) {
  57                 console.println("KNX bridge \"" + bridgeHandler.getThing().getLabel()
  58                         + "\": group address, type, number of bytes, and number of occurence since last reload of binding:");
  59                 // console.println(handler.getCommandExtensionData().unknownGA().toString());
  60                 for (Entry<String, Long> entry : bridgeHandler.getCommandExtensionData().unknownGA().entrySet()) {
  61                     console.println(entry.getKey() + " " + entry.getValue());
  62                 }
  63             }
  64             return;
  65         }
  66         printUsage(console);
  67     }
  68
  69     @Override
  70     public List<String> getUsages() {
  71         return Arrays.asList(
  72                 buildCommandUsage(CMD_LIST_UNKNOWN_GA, "list group addresses which are not configured in openHAB"));
  73     }
  74
  75     @Override
  76     public @Nullable ConsoleCommandCompleter getCompleter() {
  77         return this;
  78     }
  79
  80     @Override
  81     public boolean complete(String[] args, int cursorArgumentIndex, int cursorPosition, List<String> candidates) {
  82         if (cursorArgumentIndex <= 0) {
  83             return CMD_COMPLETER.complete(args, cursorArgumentIndex, cursorPosition, candidates);
  84         }
  85         return false;
  86     }
  87 }