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.handler;
  14
  15 import java.net.URI;
  16 import java.util.Comparator;
  17 import java.util.HashMap;
  18 import java.util.HashSet;
  19 import java.util.List;
  20 import java.util.Map;
  21 import java.util.Objects;
  22 import java.util.Optional;
  23 import java.util.Set;
  24 import java.util.concurrent.CompletableFuture;
  25 import java.util.function.Consumer;
  26
  27 import org.eclipse.jdt.annotation.NonNullByDefault;
  28 import org.eclipse.jdt.annotation.Nullable;
  29 import org.openhab.binding.mqtt.generic.AbstractMQTTThingHandler;
  30 import org.openhab.binding.mqtt.generic.ChannelState;
  31 import org.openhab.binding.mqtt.generic.MqttChannelStateDescriptionProvider;
  32 import org.openhab.binding.mqtt.generic.MqttChannelTypeProvider;
  33 import org.openhab.binding.mqtt.generic.tools.DelayedBatchProcessing;
  34 import org.openhab.binding.mqtt.generic.utils.FutureCollector;
  35 import org.openhab.binding.mqtt.homeassistant.generic.internal.MqttBindingConstants;
  36 import org.openhab.binding.mqtt.homeassistant.internal.ComponentChannel;
  37 import org.openhab.binding.mqtt.homeassistant.internal.DiscoverComponents;
  38 import org.openhab.binding.mqtt.homeassistant.internal.DiscoverComponents.ComponentDiscovered;
  39 import org.openhab.binding.mqtt.homeassistant.internal.HaID;
  40 import org.openhab.binding.mqtt.homeassistant.internal.HandlerConfiguration;
  41 import org.openhab.binding.mqtt.homeassistant.internal.component.AbstractComponent;
  42 import org.openhab.binding.mqtt.homeassistant.internal.component.ComponentFactory;
  43 import org.openhab.binding.mqtt.homeassistant.internal.component.Update;
  44 import org.openhab.binding.mqtt.homeassistant.internal.config.ChannelConfigurationTypeAdapterFactory;
  45 import org.openhab.binding.mqtt.homeassistant.internal.exception.ConfigurationException;
  46 import org.openhab.core.config.core.validation.ConfigValidationException;
  47 import org.openhab.core.io.transport.mqtt.MqttBrokerConnection;
  48 import org.openhab.core.thing.Channel;
  49 import org.openhab.core.thing.ChannelUID;
  50 import org.openhab.core.thing.Thing;
  51 import org.openhab.core.thing.ThingStatus;
  52 import org.openhab.core.thing.ThingStatusDetail;
  53 import org.openhab.core.thing.ThingTypeUID;
  54 import org.openhab.core.thing.ThingUID;
  55 import org.openhab.core.thing.binding.builder.ThingBuilder;
  56 import org.openhab.core.thing.type.ChannelTypeRegistry;
  57 import org.slf4j.Logger;
  58 import org.slf4j.LoggerFactory;
  59
  60 import com.google.gson.Gson;
  61 import com.google.gson.GsonBuilder;
  62 import com.hubspot.jinjava.Jinjava;
  63
  64 /**
  65  * Handles HomeAssistant MQTT object things. Such an HA Object can have multiple HA Components with different instances
  66  * of those Components. This handler auto-discovers all available Components and Component Instances and
  67  * adds any new appearing components over time.<br>
  68  * <br>
  69  *
  70  * The specification does not cover the case of disappearing Components. This handler doesn't as well therefore.<br>
  71  * <br>
  72  *
  73  * A Component Instance equals a Channel Group and the Component parts equal Channels.<br>
  74  * <br>
  75  *
  76  * If a Components configuration changes, the known ChannelGroupType and ChannelTypes are replaced with the new ones.
  77  *
  78  * @author David Graeff - Initial contribution
  79  */
  80 @NonNullByDefault
  81 public class HomeAssistantThingHandler extends AbstractMQTTThingHandler
  82         implements ComponentDiscovered, Consumer<List<AbstractComponent<?>>> {
  83     public static final String AVAILABILITY_CHANNEL = "availability";
  84     private static final Comparator<AbstractComponent<?>> COMPONENT_COMPARATOR = Comparator
  85             .comparing((AbstractComponent<?> component) -> component.hasGroup())
  86             .thenComparing(AbstractComponent::getName);
  87     private static final URI UPDATABLE_CONFIG_DESCRIPTION_URI = URI.create("thing-type:mqtt:homeassistant-updatable");
  88
  89     private final Logger logger = LoggerFactory.getLogger(HomeAssistantThingHandler.class);
  90
  91     protected final MqttChannelTypeProvider channelTypeProvider;
  92     protected final MqttChannelStateDescriptionProvider stateDescriptionProvider;
  93     protected final ChannelTypeRegistry channelTypeRegistry;
  94     protected final Jinjava jinjava;
  95     public final int attributeReceiveTimeout;
  96     protected final DelayedBatchProcessing<AbstractComponent<?>> delayedProcessing;
  97     protected final DiscoverComponents discoverComponents;
  98
  99     private final Gson gson;
 100     protected final Map<@Nullable String, AbstractComponent<?>> haComponents = new HashMap<>();
 101
 102     protected HandlerConfiguration config = new HandlerConfiguration();
 103     private Set<HaID> discoveryHomeAssistantIDs = new HashSet<>();
 104
 105     private boolean started;
 106     private boolean newStyleChannels;
 107     private @Nullable Update updateComponent;
 108
 109     /**
 110      * Create a new thing handler for HomeAssistant MQTT components.
 111      * A channel type provider and a topic value receive timeout must be provided.
 112      *
 113      * @param thing The thing of this handler
 114      * @param channelTypeProvider A channel type provider
 115      * @param subscribeTimeout Timeout for the entire tree parsing and subscription. In milliseconds.
 116      * @param attributeReceiveTimeout The timeout per attribute field subscription. In milliseconds.
 117      */
 118     public HomeAssistantThingHandler(Thing thing, MqttChannelTypeProvider channelTypeProvider,
 119             MqttChannelStateDescriptionProvider stateDescriptionProvider, ChannelTypeRegistry channelTypeRegistry,
 120             Jinjava jinjava, int subscribeTimeout, int attributeReceiveTimeout) {
 121         super(thing, subscribeTimeout);
 122         this.gson = new GsonBuilder().registerTypeAdapterFactory(new ChannelConfigurationTypeAdapterFactory()).create();
 123         this.channelTypeProvider = channelTypeProvider;
 124         this.stateDescriptionProvider = stateDescriptionProvider;
 125         this.channelTypeRegistry = channelTypeRegistry;
 126         this.jinjava = jinjava;
 127         this.attributeReceiveTimeout = attributeReceiveTimeout;
 128         this.delayedProcessing = new DelayedBatchProcessing<>(attributeReceiveTimeout, this, scheduler);
 129
 130         newStyleChannels = "true".equals(thing.getProperties().get("newStyleChannels"));
 131
 132         this.discoverComponents = new DiscoverComponents(thing.getUID(), scheduler, this, this, gson, jinjava,
 133                 newStyleChannels);
 134     }
 135
 136     @Override
 137     public void initialize() {
 138         started = false;
 139
 140         config = getConfigAs(HandlerConfiguration.class);
 141         if (config.topics.isEmpty()) {
 142             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, "Device topics unknown");
 143             return;
 144         }
 145         discoveryHomeAssistantIDs.addAll(HaID.fromConfig(config));
 146
 147         ThingTypeUID typeID = getThing().getThingTypeUID();
 148         for (Channel channel : thing.getChannels()) {
 149             final String groupID = channel.getUID().getGroupId();
 150             // Already restored component?
 151             @Nullable
 152             AbstractComponent<?> component = haComponents.get(groupID);
 153
 154             HaID haID = HaID.fromConfig(config.basetopic, channel.getConfiguration());
 155             discoveryHomeAssistantIDs.add(haID);
 156             ThingUID thingUID = channel.getUID().getThingUID();
 157             String channelConfigurationJSON = (String) channel.getConfiguration().get("config");
 158             if (channelConfigurationJSON == null) {
 159                 logger.warn("Provided channel does not have a 'config' configuration key!");
 160             } else {
 161                 try {
 162                     component = ComponentFactory.createComponent(thingUID, haID, channelConfigurationJSON, this, this,
 163                             scheduler, gson, jinjava, newStyleChannels);
 164                     if (typeID.equals(MqttBindingConstants.HOMEASSISTANT_MQTT_THING)) {
 165                         typeID = calculateThingTypeUID(component);
 166                     }
 167
 168                     haComponents.put(component.getGroupId(), component);
 169                 } catch (ConfigurationException e) {
 170                     logger.error("Cannot restore component {}: {}", thing, e.getMessage());
 171                 }
 172             }
 173         }
 174         if (updateThingType(typeID)) {
 175             super.initialize();
 176         }
 177     }
 178
 179     @Override
 180     public void dispose() {
 181         removeStateDescriptions();
 182         // super.dispose() calls stop()
 183         super.dispose();
 184     }
 185
 186     @Override
 187     public CompletableFuture<Void> unsubscribeAll() {
 188         // already unsubscribed everything by calling stop()
 189         return CompletableFuture.allOf();
 190     }
 191
 192     /**
 193      * Start a background discovery for the configured HA MQTT object-id.
 194      */
 195     @Override
 196     protected CompletableFuture<@Nullable Void> start(MqttBrokerConnection connection) {
 197         started = true;
 198
 199         connection.setQos(1);
 200         updateStatus(ThingStatus.UNKNOWN);
 201
 202         // Start all known components and channels within the components and put the Thing offline
 203         // if any subscribing failed ( == broker connection lost)
 204         CompletableFuture<@Nullable Void> future = CompletableFuture.allOf(super.start(connection),
 205                 haComponents.values().stream().map(e -> e.start(connection, scheduler, attributeReceiveTimeout))
 206                         .reduce(CompletableFuture.completedFuture(null), (a, v) -> a.thenCompose(b -> v)) // reduce to
 207                                                                                                           // one
 208                         .exceptionally(e -> {
 209                             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getMessage());
 210                             return null;
 211                         }));
 212
 213         return future
 214                 .thenCompose(b -> discoverComponents.startDiscovery(connection, 0, discoveryHomeAssistantIDs, this));
 215     }
 216
 217     @Override
 218     protected void stop() {
 219         if (started) {
 220             discoverComponents.stopDiscovery();
 221             delayedProcessing.join();
 222             // haComponents does not need to be synchronised -> the discovery thread is disabled
 223             haComponents.values().stream().map(AbstractComponent::stop) //
 224                     // we need to join all the stops, otherwise they might not be done when start is called
 225                     .collect(FutureCollector.allOf()).join();
 226
 227             started = false;
 228         }
 229         super.stop();
 230     }
 231
 232     @Override
 233     public @Nullable ChannelState getChannelState(ChannelUID channelUID) {
 234         String componentId;
 235         if (channelUID.isInGroup()) {
 236             componentId = channelUID.getGroupId();
 237         } else {
 238             componentId = channelUID.getId();
 239         }
 240         AbstractComponent<?> component;
 241         synchronized (haComponents) { // sync whenever discoverComponents is started
 242             component = haComponents.get(componentId);
 243         }
 244         if (component == null) {
 245             component = haComponents.get("");
 246             if (component == null) {
 247                 return null;
 248             }
 249         }
 250         ComponentChannel componentChannel = component.getChannel(channelUID.getIdWithoutGroup());
 251         if (componentChannel == null) {
 252             return null;
 253         }
 254         return componentChannel.getState();
 255     }
 256
 257     /**
 258      * Callback of {@link DiscoverComponents}. Add to a delayed batch processor.
 259      */
 260     @Override
 261     public void componentDiscovered(HaID homeAssistantTopicID, AbstractComponent<?> component) {
 262         delayedProcessing.accept(component);
 263     }
 264
 265     /**
 266      * Callback of {@link DelayedBatchProcessing}.
 267      * Add all newly discovered components to the Thing and start the components.
 268      */
 269     @Override
 270     public void accept(List<AbstractComponent<?>> discoveredComponentsList) {
 271         MqttBrokerConnection connection = this.connection;
 272         if (connection == null) {
 273             return;
 274         }
 275
 276         synchronized (haComponents) { // sync whenever discoverComponents is started
 277             ThingTypeUID typeID = getThing().getThingTypeUID();
 278             for (AbstractComponent<?> discovered : discoveredComponentsList) {
 279                 if (typeID.equals(MqttBindingConstants.HOMEASSISTANT_MQTT_THING)) {
 280                     typeID = calculateThingTypeUID(discovered);
 281                 }
 282                 String id = discovered.getGroupId();
 283                 AbstractComponent<?> known = haComponents.get(id);
 284                 // Is component already known?
 285                 if (known != null) {
 286                     if (discovered.getConfigHash() != known.getConfigHash()) {
 287                         // Don't wait for the future to complete. We are also not interested in failures.
 288                         // The component will be replaced in a moment.
 289                         known.stop();
 290                     } else {
 291                         known.setConfigSeen();
 292                         continue;
 293                     }
 294                 }
 295
 296                 // Add component to the component map
 297                 haComponents.put(id, discovered);
 298                 // Start component / Subscribe to channel topics
 299                 discovered.start(connection, scheduler, 0).exceptionally(e -> {
 300                     logger.warn("Failed to start component {}", discovered.getHaID(), e);
 301                     return null;
 302                 });
 303
 304                 if (discovered instanceof Update) {
 305                     updateComponent = (Update) discovered;
 306                     updateComponent.setReleaseStateUpdateListener(this::releaseStateUpdated);
 307                 }
 308             }
 309             updateThingType(typeID);
 310         }
 311     }
 312
 313     @Override
 314     protected void updateThingStatus(boolean messageReceived, Optional<Boolean> availabilityTopicsSeen) {
 315         if (availabilityTopicsSeen.orElse(messageReceived)) {
 316             updateStatus(ThingStatus.ONLINE, ThingStatusDetail.NONE);
 317         } else {
 318             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.NONE);
 319         }
 320     }
 321
 322     @Override
 323     public void handleConfigurationUpdate(Map<String, Object> configurationParameters)
 324             throws ConfigValidationException {
 325         if (configurationParameters.containsKey("doUpdate")) {
 326             configurationParameters = new HashMap<>(configurationParameters);
 327             Object value = configurationParameters.remove("doUpdate");
 328             if (value instanceof Boolean doUpdate && doUpdate) {
 329                 Update updateComponent = this.updateComponent;
 330                 if (updateComponent == null) {
 331                     logger.warn(
 332                             "Received update command for Home Assistant device {}, but it does not have an update component.",
 333                             getThing().getUID());
 334                 } else {
 335                     updateComponent.doUpdate();
 336                 }
 337             }
 338         }
 339         super.handleConfigurationUpdate(configurationParameters);
 340     }
 341
 342     private boolean updateThingType(ThingTypeUID typeID) {
 343         // if this is a dynamic type, then we update the type
 344         if (!MqttBindingConstants.HOMEASSISTANT_MQTT_THING.equals(typeID)) {
 345             var thingTypeBuilder = channelTypeProvider.derive(typeID, MqttBindingConstants.HOMEASSISTANT_MQTT_THING);
 346
 347             if (getThing().getThingTypeUID().equals(MqttBindingConstants.HOMEASSISTANT_MQTT_THING)) {
 348                 logger.debug("Migrating Home Assistant thing {} from generic type to dynamic type {}",
 349                         getThing().getUID(), typeID);
 350
 351                 // just create an empty thing type for now; channel configurations won't follow over
 352                 // to the re-created Thing, so we need to re-discover them all anyway
 353                 channelTypeProvider.putThingType(thingTypeBuilder.build());
 354                 changeThingType(typeID, getConfig());
 355                 return false;
 356             }
 357
 358             synchronized (haComponents) { // sync whenever discoverComponents is started
 359                 var sortedComponents = haComponents.values().stream().sorted(COMPONENT_COMPARATOR).toList();
 360
 361                 var channelGroupTypes = sortedComponents.stream().map(c -> c.getChannelGroupType(typeID.getId()))
 362                         .filter(Objects::nonNull).map(Objects::requireNonNull).toList();
 363                 channelTypeProvider.updateChannelGroupTypesForPrefix(typeID.getId(), channelGroupTypes);
 364
 365                 var groupDefs = sortedComponents.stream().map(c -> c.getGroupDefinition(typeID.getId()))
 366                         .filter(Objects::nonNull).map(Objects::requireNonNull).toList();
 367                 var channelDefs = sortedComponents.stream().map(AbstractComponent::getChannelDefinitions)
 368                         .flatMap(List::stream).toList();
 369                 thingTypeBuilder.withChannelDefinitions(channelDefs).withChannelGroupDefinitions(groupDefs);
 370                 Update updateComponent = this.updateComponent;
 371                 if (updateComponent != null && updateComponent.isUpdatable()) {
 372                     thingTypeBuilder.withConfigDescriptionURI(UPDATABLE_CONFIG_DESCRIPTION_URI);
 373                 }
 374
 375                 channelTypeProvider.putThingType(thingTypeBuilder.build());
 376
 377                 removeStateDescriptions();
 378                 sortedComponents.stream().forEach(c -> c.addStateDescriptions(stateDescriptionProvider));
 379
 380                 ThingBuilder thingBuilder = editThing().withChannels();
 381
 382                 sortedComponents.stream().map(AbstractComponent::getChannels).flatMap(List::stream)
 383                         .forEach(c -> thingBuilder.withChannel(c));
 384
 385                 updateThing(thingBuilder.build());
 386             }
 387         }
 388         return true;
 389     }
 390
 391     private ThingTypeUID calculateThingTypeUID(AbstractComponent component) {
 392         return new ThingTypeUID(MqttBindingConstants.BINDING_ID, MqttBindingConstants.HOMEASSISTANT_MQTT_THING.getId()
 393                 + "_" + component.getChannelConfiguration().getThingId(component.getHaID().objectID));
 394     }
 395
 396     @Override
 397     public void handleRemoval() {
 398         synchronized (haComponents) {
 399             channelTypeProvider.removeThingType(thing.getThingTypeUID());
 400             channelTypeProvider.removeChannelGroupTypesForPrefix(thing.getThingTypeUID().getId());
 401             removeStateDescriptions();
 402         }
 403         super.handleRemoval();
 404     }
 405
 406     private void removeStateDescriptions() {
 407         thing.getChannels().stream().forEach(c -> stateDescriptionProvider.remove(c.getUID()));
 408     }
 409
 410     private void releaseStateUpdated(Update.ReleaseState state) {
 411         Map<String, String> properties = editProperties();
 412         properties = state.appendToProperties(properties);
 413         updateProperties(properties);
 414     }
 415 }