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.mqtt.homeassistant.internal.component;
  14
  15 import java.util.concurrent.ScheduledExecutorService;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.eclipse.jdt.annotation.Nullable;
  19 import org.openhab.binding.mqtt.generic.AvailabilityTracker;
  20 import org.openhab.binding.mqtt.generic.ChannelStateUpdateListener;
  21 import org.openhab.binding.mqtt.generic.TransformationServiceProvider;
  22 import org.openhab.binding.mqtt.homeassistant.internal.HaID;
  23 import org.openhab.binding.mqtt.homeassistant.internal.config.dto.AbstractChannelConfiguration;
  24 import org.openhab.binding.mqtt.homeassistant.internal.exception.ConfigurationException;
  25 import org.openhab.binding.mqtt.homeassistant.internal.exception.UnsupportedComponentException;
  26 import org.openhab.core.thing.ThingUID;
  27
  28 import com.google.gson.Gson;
  29
  30 /**
  31  * A factory to create HomeAssistant MQTT components. Those components are specified at:
  32  * https://www.home-assistant.io/docs/mqtt/discovery/
  33  *
  34  * @author David Graeff - Initial contribution
  35  */
  36 @NonNullByDefault
  37 public class ComponentFactory {
  38     /**
  39      * Create a HA MQTT component. The configuration JSon string is required.
  40      *
  41      * @param thingUID The Thing UID that this component will belong to.
  42      * @param haID The location of this component. The HomeAssistant ID contains the object-id, node-id and
  43      *            component-id.
  44      * @param channelConfigurationJSON Most components expect a "name", a "state_topic" and "command_topic" like with
  45      *            "{name:'Name',state_topic:'homeassistant/switch/0/object/state',command_topic:'homeassistant/switch/0/object/set'".
  46      * @param updateListener A channel state update listener
  47      * @return A HA MQTT Component
  48      */
  49     public static AbstractComponent<?> createComponent(ThingUID thingUID, HaID haID, String channelConfigurationJSON,
  50             ChannelStateUpdateListener updateListener, AvailabilityTracker tracker, ScheduledExecutorService scheduler,
  51             Gson gson, TransformationServiceProvider transformationServiceProvider) throws ConfigurationException {
  52         ComponentConfiguration componentConfiguration = new ComponentConfiguration(thingUID, haID,
  53                 channelConfigurationJSON, gson, updateListener, tracker, scheduler)
  54                 .transformationProvider(transformationServiceProvider);
  55         switch (haID.component) {
  56             case "alarm_control_panel":
  57                 return new AlarmControlPanel(componentConfiguration);
  58             case "binary_sensor":
  59                 return new BinarySensor(componentConfiguration);
  60             case "camera":
  61                 return new Camera(componentConfiguration);
  62             case "cover":
  63                 return new Cover(componentConfiguration);
  64             case "fan":
  65                 return new Fan(componentConfiguration);
  66             case "climate":
  67                 return new Climate(componentConfiguration);
  68             case "device_automation":
  69                 return new DeviceTrigger(componentConfiguration);
  70             case "light":
  71                 return Light.create(componentConfiguration);
  72             case "lock":
  73                 return new Lock(componentConfiguration);
  74             case "number":
  75                 return new Number(componentConfiguration);
  76             case "select":
  77                 return new Select(componentConfiguration);
  78             case "sensor":
  79                 return new Sensor(componentConfiguration);
  80             case "switch":
  81                 return new Switch(componentConfiguration);
  82             case "vacuum":
  83                 return new Vacuum(componentConfiguration);
  84             default:
  85                 throw new UnsupportedComponentException("Component '" + haID + "' is unsupported!");
  86         }
  87     }
  88
  89     protected static class ComponentConfiguration {
  90         private final ThingUID thingUID;
  91         private final HaID haID;
  92         private final String configJSON;
  93         private final ChannelStateUpdateListener updateListener;
  94         private final AvailabilityTracker tracker;
  95         private final Gson gson;
  96         private final ScheduledExecutorService scheduler;
  97         private @Nullable TransformationServiceProvider transformationServiceProvider;
  98
  99         /**
 100          * Provide a thingUID and HomeAssistant topic ID to determine the channel group UID and type.
 101          *
 102          * @param thingUID A ThingUID
 103          * @param haID A HomeAssistant topic ID
 104          * @param configJSON The configuration string
 105          * @param gson A Gson instance
 106          */
 107         protected ComponentConfiguration(ThingUID thingUID, HaID haID, String configJSON, Gson gson,
 108                 ChannelStateUpdateListener updateListener, AvailabilityTracker tracker,
 109                 ScheduledExecutorService scheduler) {
 110             this.thingUID = thingUID;
 111             this.haID = haID;
 112             this.configJSON = configJSON;
 113             this.gson = gson;
 114             this.updateListener = updateListener;
 115             this.tracker = tracker;
 116             this.scheduler = scheduler;
 117         }
 118
 119         public ComponentConfiguration transformationProvider(
 120                 TransformationServiceProvider transformationServiceProvider) {
 121             this.transformationServiceProvider = transformationServiceProvider;
 122             return this;
 123         }
 124
 125         public ThingUID getThingUID() {
 126             return thingUID;
 127         }
 128
 129         public HaID getHaID() {
 130             return haID;
 131         }
 132
 133         public String getConfigJSON() {
 134             return configJSON;
 135         }
 136
 137         public ChannelStateUpdateListener getUpdateListener() {
 138             return updateListener;
 139         }
 140
 141         @Nullable
 142         public TransformationServiceProvider getTransformationServiceProvider() {
 143             return transformationServiceProvider;
 144         }
 145
 146         public Gson getGson() {
 147             return gson;
 148         }
 149
 150         public AvailabilityTracker getTracker() {
 151             return tracker;
 152         }
 153
 154         public ScheduledExecutorService getScheduler() {
 155             return scheduler;
 156         }
 157
 158         public <C extends AbstractChannelConfiguration> C getConfig(Class<C> clazz) {
 159             return AbstractChannelConfiguration.fromString(configJSON, gson, clazz);
 160         }
 161     }
 162 }