Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[mqtt.homeassistant] handle multiple availability topics #15977

Merged
merged 4 commits into from
Dec 7, 2023
Merged

[mqtt.homeassistant] handle multiple availability topics #15977

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ba1e97
[mqtt.homeassistant] handle multiple availability topics
ccutrer Nov 29, 2023
c2129ee
Remove unused latestAvaialability field
ccutrer Dec 4, 2023
e5be6b0
apply review suggestions
ccutrer Dec 5, 2023
9d19bf9
reformat comment slightly
ccutrer Dec 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 28 additions & 7 deletions ...mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/AbstractMQTTThingHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -261,15 +262,15 @@ public void dispose() {
@Override
public void updateChannelState(ChannelUID channelUID, State value) {
if (messageReceived.compareAndSet(false, true)) {
calculateThingStatus();
calculateThingStatus(true);
}
super.updateState(channelUID, value);
}

@Override
public void triggerChannel(ChannelUID channelUID, String event) {
if (messageReceived.compareAndSet(false, true)) {
calculateThingStatus();
calculateThingStatus(true);
}
super.triggerChannel(channelUID, event);
}
Expand All @@ -292,6 +293,11 @@ public void setConnection(MqttBrokerConnection connection) {
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) {
Expand All @@ -310,7 +316,8 @@ public void addAvailabilityTopic(String availability_topic, String payload_avail
channelUID, value, new ChannelStateUpdateListener() {
@Override
public void updateChannelState(ChannelUID channelUID, State value) {
calculateThingStatus();
boolean online = value.equals(OnOffType.ON);
calculateThingStatus(online);
}

@Override
Expand Down Expand Up @@ -352,18 +359,32 @@ public void clearAllAvailabilityTopics() {
@Override
public void resetMessageReceived() {
if (messageReceived.compareAndSet(true, false)) {
calculateThingStatus();
calculateThingStatus(false);
}
}

protected void calculateThingStatus() {
protected void calculateThingStatus(boolean lastValue) {
ccutrer marked this conversation as resolved.
Show resolved Hide resolved
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))));
switch (availabilityMode) {
ccutrer marked this conversation as resolved.
Show resolved Hide resolved
case ALL:
availabilityTopicsSeen = Optional.of(availabilityStates.values().stream().allMatch(
c -> c != null && OnOffType.ON.equals(c.getCache().getChannelState().as(OnOffType.class))));
break;
case ANY:
availabilityTopicsSeen = Optional.of(availabilityStates.values().stream().anyMatch(
c -> c != null && OnOffType.ON.equals(c.getCache().getChannelState().as(OnOffType.class))));
break;
case LATEST:
availabilityTopicsSeen = Optional.of(lastValue);
break;
default:
availabilityTopicsSeen = Optional.empty();
break;
}
}
updateThingStatus(messageReceived.get(), availabilityTopicsSeen);
}
Expand Down
30 changes: 30 additions & 0 deletions ...ding.mqtt.generic/src/main/java/org/openhab/binding/mqtt/generic/AvailabilityTracker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,39 @@
* 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
*/
public enum AvailabilityMode {
ccutrer marked this conversation as resolved.
Show resolved Hide resolved
/**
* 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
ccutrer marked this conversation as resolved.
Show resolved Hide resolved
*/
ANY,

/**
* the last payload_available or payload_not_available received on any configured availability topic controls
* the
* availability
ccutrer marked this conversation as resolved.
Show resolved Hide resolved
*/
LATEST
}

/**
* Sets how multiple availability topics are treated
*/
void setAvailabilityMode(AvailabilityMode mode);

/**
* Adds an availability topic to determine the availability of a device.
Expand Down
2 changes: 1 addition & 1 deletion .../main/java/org/openhab/binding/mqtt/generic/internal/handler/GenericMQTTThingHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ public GenericMQTTThingHandler(Thing thing, MqttChannelStateDescriptionProvider
clearAllAvailabilityTopics();
initializeAvailabilityTopicsFromConfig();
return channelStateByChannelUID.values().stream().map(c -> c.start(connection, scheduler, 0))
.collect(FutureCollector.allOf()).thenRun(this::calculateThingStatus);
.collect(FutureCollector.allOf()).thenRun(() -> calculateThingStatus(false));
}

@Override
Expand Down
46 changes: 38 additions & 8 deletions ...ain/java/org/openhab/binding/mqtt/homeassistant/internal/component/AbstractComponent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.mqtt.generic.AvailabilityTracker;
import org.openhab.binding.mqtt.generic.ChannelStateUpdateListener;
import org.openhab.binding.mqtt.generic.MqttChannelTypeProvider;
import org.openhab.binding.mqtt.generic.TransformationServiceProvider;
Expand All @@ -32,6 +33,8 @@
import org.openhab.binding.mqtt.homeassistant.internal.HaID;
import org.openhab.binding.mqtt.homeassistant.internal.component.ComponentFactory.ComponentConfiguration;
import org.openhab.binding.mqtt.homeassistant.internal.config.dto.AbstractChannelConfiguration;
import org.openhab.binding.mqtt.homeassistant.internal.config.dto.Availability;
import org.openhab.binding.mqtt.homeassistant.internal.config.dto.AvailabilityMode;
import org.openhab.binding.mqtt.homeassistant.internal.config.dto.Device;
import org.openhab.core.io.transport.mqtt.MqttBrokerConnection;
import org.openhab.core.thing.ChannelGroupUID;
Expand Down Expand Up @@ -99,15 +102,42 @@ public AbstractComponent(ComponentFactory.ComponentConfiguration componentConfig

this.configSeen = false;

String availabilityTopic = this.channelConfiguration.getAvailabilityTopic();
if (availabilityTopic != null) {
String availabilityTemplate = this.channelConfiguration.getAvailabilityTemplate();
if (availabilityTemplate != null) {
availabilityTemplate = JINJA_PREFIX + availabilityTemplate;
final List<Availability> availabilities = channelConfiguration.getAvailability();
if (availabilities != null) {
AvailabilityMode mode = channelConfiguration.getAvailabilityMode();
switch (mode) {
ccutrer marked this conversation as resolved.
Show resolved Hide resolved
case ALL:
componentConfiguration.getTracker().setAvailabilityMode(AvailabilityTracker.AvailabilityMode.ALL);
break;
case ANY:
componentConfiguration.getTracker().setAvailabilityMode(AvailabilityTracker.AvailabilityMode.ANY);
break;
case LATEST:
componentConfiguration.getTracker()
.setAvailabilityMode(AvailabilityTracker.AvailabilityMode.LATEST);
break;
}
for (Availability availability : availabilities) {
String availabilityTemplate = availability.getValueTemplate();
if (availabilityTemplate != null) {
availabilityTemplate = JINJA_PREFIX + availabilityTemplate;
}
componentConfiguration.getTracker().addAvailabilityTopic(availability.getTopic(),
availability.getPayloadAvailable(), availability.getPayloadNotAvailable(), availabilityTemplate,
componentConfiguration.getTransformationServiceProvider());
}
} else {
String availabilityTopic = this.channelConfiguration.getAvailabilityTopic();
if (availabilityTopic != null) {
String availabilityTemplate = this.channelConfiguration.getAvailabilityTemplate();
if (availabilityTemplate != null) {
availabilityTemplate = JINJA_PREFIX + availabilityTemplate;
}
componentConfiguration.getTracker().addAvailabilityTopic(availabilityTopic,
this.channelConfiguration.getPayloadAvailable(),
this.channelConfiguration.getPayloadNotAvailable(), availabilityTemplate,
componentConfiguration.getTransformationServiceProvider());
}
componentConfiguration.getTracker().addAvailabilityTopic(availabilityTopic,
this.channelConfiguration.getPayloadAvailable(), this.channelConfiguration.getPayloadNotAvailable(),
availabilityTemplate, componentConfiguration.getTransformationServiceProvider());
}
}

Expand Down