[mqtt.homeassistant] handle multiple availability topics (#15977)

* [mqtt.homeassistant] handle multiple availability topics

---------

Signed-off-by: Cody Cutrer <cody@cutrer.us>

bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/AbstractMQTTThingHandler.java

@@ -83,6 +83,7 @@ public abstract class AbstractMQTTThingHandler extends BaseThingHandler
 
     private AtomicBoolean messageReceived = new AtomicBoolean(false);
     private Map<String, @Nullable ChannelState> availabilityStates = new ConcurrentHashMap<>();
+    private AvailabilityMode availabilityMode = AvailabilityMode.ALL;
 
     public AbstractMQTTThingHandler(Thing thing, int subscribeTimeout) {
         super(thing);
@@ -261,7 +262,7 @@ public abstract class AbstractMQTTThingHandler extends BaseThingHandler
     @Override
     public void updateChannelState(ChannelUID channelUID, State value) {
         if (messageReceived.compareAndSet(false, true)) {
-            calculateThingStatus();
+            calculateAndUpdateThingStatus(true);
         }
         super.updateState(channelUID, value);
     }
@@ -269,7 +270,7 @@ public abstract class AbstractMQTTThingHandler extends BaseThingHandler
     @Override
     public void triggerChannel(ChannelUID channelUID, String event) {
         if (messageReceived.compareAndSet(false, true)) {
-            calculateThingStatus();
+            calculateAndUpdateThingStatus(true);
         }
         super.triggerChannel(channelUID, event);
     }
@@ -292,6 +293,11 @@ public abstract class AbstractMQTTThingHandler extends BaseThingHandler
         this.connection = connection;
     }
 
+    @Override
+    public void setAvailabilityMode(AvailabilityMode mode) {
+        this.availabilityMode = mode;
+    }
+
     @Override
     public void addAvailabilityTopic(String availability_topic, String payload_available,
             String payload_not_available) {
@@ -310,7 +316,8 @@ public abstract class AbstractMQTTThingHandler extends BaseThingHandler
                     channelUID, value, new ChannelStateUpdateListener() {
                         @Override
                         public void updateChannelState(ChannelUID channelUID, State value) {
-                            calculateThingStatus();
+                            boolean online = value.equals(OnOffType.ON);
+                            calculateAndUpdateThingStatus(online);
                         }
 
                         @Override
@@ -352,18 +359,23 @@ public abstract class AbstractMQTTThingHandler extends BaseThingHandler
     @Override
     public void resetMessageReceived() {
         if (messageReceived.compareAndSet(true, false)) {
-            calculateThingStatus();
+            calculateAndUpdateThingStatus(false);
         }
     }
 
-    protected void calculateThingStatus() {
+    protected void calculateAndUpdateThingStatus(boolean lastValue) {
         final Optional<Boolean> availabilityTopicsSeen;
 
         if (availabilityStates.isEmpty()) {
             availabilityTopicsSeen = Optional.empty();
         } else {
-            availabilityTopicsSeen = Optional.of(availabilityStates.values().stream().allMatch(
-                    c -> c != null && OnOffType.ON.equals(c.getCache().getChannelState().as(OnOffType.class))));
+            availabilityTopicsSeen = switch (availabilityMode) {
+                case ALL -> Optional.of(availabilityStates.values().stream().allMatch(
+                        c -> c != null && OnOffType.ON.equals(c.getCache().getChannelState().as(OnOffType.class))));
+                case ANY -> Optional.of(availabilityStates.values().stream().anyMatch(
+                        c -> c != null && OnOffType.ON.equals(c.getCache().getChannelState().as(OnOffType.class))));
+                case LATEST -> Optional.of(lastValue);
+            };
         }
         updateThingStatus(messageReceived.get(), availabilityTopicsSeen);
     }

bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/AvailabilityTracker.java

@@ -19,9 +19,37 @@ import org.eclipse.jdt.annotation.Nullable;
  * Interface to keep track of the availability of device using an availability topic or messages received
  *
  * @author Jochen Klein - Initial contribution
+ * @author Cody Cutrer - Support all/any/latest
  */
 @NonNullByDefault
 public interface AvailabilityTracker {
+    /**
+     * controls the conditions needed to set the entity to available
+     */
+    enum AvailabilityMode {
+        /**
+         * payload_available must be received on all configured availability topics before the entity is marked as
+         * online
+         */
+        ALL,
+
+        /**
+         * payload_available must be received on at least one configured availability topic before the entity is marked
+         * as online
+         */
+        ANY,
+
+        /**
+         * the last payload_available or payload_not_available received on any configured availability topic controls
+         * the availability
+         */
+        LATEST
+    }
+
+    /**
+     * Sets how multiple availability topics are treated
+     */
+    void setAvailabilityMode(AvailabilityMode mode);
 
     /**
      * Adds an availability topic to determine the availability of a device.

bundles/org.openhab.binding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/internal/handler/GenericMQTTThingHandler.java

@@ -93,7 +93,7 @@ public class GenericMQTTThingHandler extends AbstractMQTTThingHandler implements
         clearAllAvailabilityTopics();
         initializeAvailabilityTopicsFromConfig();
         return channelStateByChannelUID.values().stream().map(c -> c.start(connection, scheduler, 0))
-                .collect(FutureCollector.allOf()).thenRun(this::calculateThingStatus);
+                .collect(FutureCollector.allOf()).thenRun(() -> calculateAndUpdateThingStatus(false));
     }
 
     @Override