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.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 "button":
  61                 return new Button(componentConfiguration);
  62             case "camera":
  63                 return new Camera(componentConfiguration);
  64             case "cover":
  65                 return new Cover(componentConfiguration);
  66             case "fan":
  67                 return new Fan(componentConfiguration);
  68             case "climate":
  69                 return new Climate(componentConfiguration);
  70             case "device_automation":
  71                 return new DeviceTrigger(componentConfiguration);
  72             case "light":
  73                 return Light.create(componentConfiguration);
  74             case "lock":
  75                 return new Lock(componentConfiguration);
  76             case "number":
  77                 return new Number(componentConfiguration);
  78             case "scene":
  79                 return new Scene(componentConfiguration);
  80             case "select":
  81                 return new Select(componentConfiguration);
  82             case "sensor":
  83                 return new Sensor(componentConfiguration);
  84             case "switch":
  85                 return new Switch(componentConfiguration);
  86             case "update":
  87                 return new Update(componentConfiguration);
  88             case "vacuum":
  89                 return new Vacuum(componentConfiguration);
  90             default:
  91                 throw new UnsupportedComponentException("Component '" + haID + "' is unsupported!");
  92         }
  93     }
  94
  95     protected static class ComponentConfiguration {
  96         private final ThingUID thingUID;
  97         private final HaID haID;
  98         private final String configJSON;
  99         private final ChannelStateUpdateListener updateListener;
 100         private final AvailabilityTracker tracker;
 101         private final Gson gson;
 102         private final ScheduledExecutorService scheduler;
 103         private @Nullable TransformationServiceProvider transformationServiceProvider;
 104
 105         /**
 106          * Provide a thingUID and HomeAssistant topic ID to determine the channel group UID and type.
 107          *
 108          * @param thingUID A ThingUID
 109          * @param haID A HomeAssistant topic ID
 110          * @param configJSON The configuration string
 111          * @param gson A Gson instance
 112          */
 113         protected ComponentConfiguration(ThingUID thingUID, HaID haID, String configJSON, Gson gson,
 114                 ChannelStateUpdateListener updateListener, AvailabilityTracker tracker,
 115                 ScheduledExecutorService scheduler) {
 116             this.thingUID = thingUID;
 117             this.haID = haID;
 118             this.configJSON = configJSON;
 119             this.gson = gson;
 120             this.updateListener = updateListener;
 121             this.tracker = tracker;
 122             this.scheduler = scheduler;
 123         }
 124
 125         public ComponentConfiguration transformationProvider(
 126                 TransformationServiceProvider transformationServiceProvider) {
 127             this.transformationServiceProvider = transformationServiceProvider;
 128             return this;
 129         }
 130
 131         public ThingUID getThingUID() {
 132             return thingUID;
 133         }
 134
 135         public HaID getHaID() {
 136             return haID;
 137         }
 138
 139         public String getConfigJSON() {
 140             return configJSON;
 141         }
 142
 143         public ChannelStateUpdateListener getUpdateListener() {
 144             return updateListener;
 145         }
 146
 147         @Nullable
 148         public TransformationServiceProvider getTransformationServiceProvider() {
 149             return transformationServiceProvider;
 150         }
 151
 152         public Gson getGson() {
 153             return gson;
 154         }
 155
 156         public AvailabilityTracker getTracker() {
 157             return tracker;
 158         }
 159
 160         public ScheduledExecutorService getScheduler() {
 161             return scheduler;
 162         }
 163
 164         public <C extends AbstractChannelConfiguration> C getConfig(Class<C> clazz) {
 165             return AbstractChannelConfiguration.fromString(configJSON, gson, clazz);
 166         }
 167     }
 168 }