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.factory;
  14
  15 import static org.openhab.binding.knx.internal.KNXBindingConstants.*;
  16
  17 import java.util.Arrays;
  18 import java.util.Collection;
  19
  20 import org.eclipse.jdt.annotation.NonNullByDefault;
  21 import org.eclipse.jdt.annotation.Nullable;
  22 import org.openhab.binding.knx.internal.client.SerialTransportAdapter;
  23 import org.openhab.binding.knx.internal.handler.DeviceThingHandler;
  24 import org.openhab.binding.knx.internal.handler.IPBridgeThingHandler;
  25 import org.openhab.binding.knx.internal.handler.SerialBridgeThingHandler;
  26 import org.openhab.binding.knx.internal.i18n.KNXTranslationProvider;
  27 import org.openhab.core.config.core.Configuration;
  28 import org.openhab.core.i18n.LocaleProvider;
  29 import org.openhab.core.i18n.TranslationProvider;
  30 import org.openhab.core.io.transport.serial.SerialPortManager;
  31 import org.openhab.core.net.NetworkAddressService;
  32 import org.openhab.core.thing.Bridge;
  33 import org.openhab.core.thing.Thing;
  34 import org.openhab.core.thing.ThingTypeUID;
  35 import org.openhab.core.thing.ThingUID;
  36 import org.openhab.core.thing.binding.BaseThingHandlerFactory;
  37 import org.openhab.core.thing.binding.ThingHandler;
  38 import org.openhab.core.thing.binding.ThingHandlerFactory;
  39 import org.osgi.service.component.annotations.Activate;
  40 import org.osgi.service.component.annotations.Component;
  41 import org.osgi.service.component.annotations.Reference;
  42
  43 /**
  44  * The {@link KNXHandlerFactory} is responsible for creating things and thing
  45  * handlers.
  46  *
  47  * @author Simon Kaufmann - Initial contribution and API
  48  */
  49 @NonNullByDefault
  50 @Component(service = ThingHandlerFactory.class, configurationPid = "binding.knx")
  51 public class KNXHandlerFactory extends BaseThingHandlerFactory {
  52
  53     public static final Collection<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Arrays.asList(THING_TYPE_DEVICE,
  54             THING_TYPE_IP_BRIDGE, THING_TYPE_SERIAL_BRIDGE);
  55
  56     @Nullable
  57     private NetworkAddressService networkAddressService;
  58     private final SerialPortManager serialPortManager;
  59
  60     @Activate
  61     public KNXHandlerFactory(final @Reference TranslationProvider translationProvider,
  62             final @Reference LocaleProvider localeProvider, final @Reference SerialPortManager serialPortManager) {
  63         KNXTranslationProvider.I18N.setProvider(localeProvider, translationProvider);
  64         this.serialPortManager = serialPortManager;
  65         SerialTransportAdapter.setSerialPortManager(serialPortManager);
  66     }
  67
  68     @Override
  69     public boolean supportsThingType(ThingTypeUID thingTypeUID) {
  70         return SUPPORTED_THING_TYPES_UIDS.contains(thingTypeUID);
  71     }
  72
  73     @Override
  74     public @Nullable Thing createThing(ThingTypeUID thingTypeUID, Configuration configuration,
  75             @Nullable ThingUID thingUID, @Nullable ThingUID bridgeUID) {
  76         if (THING_TYPE_IP_BRIDGE.equals(thingTypeUID)) {
  77             ThingUID ipBridgeUID = getIPBridgeThingUID(thingTypeUID, thingUID, configuration);
  78             return super.createThing(thingTypeUID, configuration, ipBridgeUID, null);
  79         }
  80         if (THING_TYPE_SERIAL_BRIDGE.equals(thingTypeUID)) {
  81             ThingUID serialBridgeUID = getSerialBridgeThingUID(thingTypeUID, thingUID, configuration);
  82             return super.createThing(thingTypeUID, configuration, serialBridgeUID, null);
  83         }
  84         if (THING_TYPE_DEVICE.equals(thingTypeUID)) {
  85             return super.createThing(thingTypeUID, configuration, thingUID, bridgeUID);
  86         }
  87         throw new IllegalArgumentException("The thing type " + thingTypeUID + " is not supported by the KNX binding.");
  88     }
  89
  90     @Override
  91     protected @Nullable ThingHandler createHandler(Thing thing) {
  92         if (thing.getThingTypeUID().equals(THING_TYPE_IP_BRIDGE)) {
  93             return new IPBridgeThingHandler((Bridge) thing, networkAddressService);
  94         } else if (thing.getThingTypeUID().equals(THING_TYPE_SERIAL_BRIDGE)) {
  95             return new SerialBridgeThingHandler((Bridge) thing, serialPortManager);
  96         } else if (thing.getThingTypeUID().equals(THING_TYPE_DEVICE)) {
  97             return new DeviceThingHandler(thing);
  98         }
  99         return null;
 100     }
 101
 102     private ThingUID getIPBridgeThingUID(ThingTypeUID thingTypeUID, @Nullable ThingUID thingUID,
 103             Configuration configuration) {
 104         if (thingUID != null) {
 105             return thingUID;
 106         }
 107         String ipAddress = (String) configuration.get(IP_ADDRESS);
 108         return new ThingUID(thingTypeUID, ipAddress);
 109     }
 110
 111     private ThingUID getSerialBridgeThingUID(ThingTypeUID thingTypeUID, @Nullable ThingUID thingUID,
 112             Configuration configuration) {
 113         if (thingUID != null) {
 114             return thingUID;
 115         }
 116         String serialPort = (String) configuration.get(SERIAL_PORT);
 117         return new ThingUID(thingTypeUID, serialPort);
 118     }
 119
 120     @Reference
 121     protected void setNetworkAddressService(NetworkAddressService networkAddressService) {
 122         this.networkAddressService = networkAddressService;
 123     }
 124
 125     protected void unsetNetworkAddressService(NetworkAddressService networkAddressService) {
 126         this.networkAddressService = null;
 127     }
 128 }