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.

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

[velux] Vane position channel is visible when required #13271

Merged
merged 14 commits into from
Sep 11, 2022
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
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
3 changes: 2 additions & 1 deletion bundles/org.openhab.binding.velux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,11 +176,12 @@ The supported Channels and their associated channel types are shown below.
| position | Rollershutter | Actual position of the window or device. |
| limitMinimum | Rollershutter | Minimum limit position of the window or device. |
| limitMaximum | Rollershutter | Maximum limit position of the window or device. |
| vanePosition | Dimmer | Vane position of a Venetian blind. |
| vanePosition | Dimmer | Vane position of a Venetian blind. (optional) |

The `position`, `limitMinimum`, and `limitMaximum` are the same as described above for "window" Things.

The `vanePosition` Channel only applies to Venetian blinds that have tiltable slats.
The binding detects whether the device supports a vane position, and if so, it adds the `vanePosition` Channel automatically.

### Channels for "actuator" Things

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
import org.openhab.core.thing.ThingStatus;
import org.openhab.core.thing.ThingStatusDetail;
import org.openhab.core.thing.ThingTypeUID;
import org.openhab.core.thing.binding.ThingHandler;
import org.openhab.core.thing.binding.ThingHandlerService;
import org.openhab.core.types.Command;
import org.openhab.core.types.RefreshType;
Expand Down Expand Up @@ -465,6 +466,8 @@ private void bridgeParamsUpdated() {
}
}

updateDynamicChannels();

veluxBridgeConfiguration.hasChanged = false;
logger.debug("Velux veluxBridge is online, now.");
updateStatus(ThingStatus.ONLINE);
Expand Down Expand Up @@ -957,4 +960,16 @@ public ProductBridgeIndex getProductBridgeIndex(String thingName) {
}
return ProductBridgeIndex.UNKNOWN;
}

/**
* Ask all things in the hub to initialise their dynamic vane position channel if they support it.
*/
private void updateDynamicChannels() {
getThing().getThings().stream().forEach(thing -> {
ThingHandler thingHandler = thing.getHandler();
if (thingHandler instanceof VeluxHandler) {
((VeluxHandler) thingHandler).updateDynamicChannels(this);
}
});
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,15 @@
import java.util.Map.Entry;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.openhab.binding.velux.internal.VeluxBindingConstants;
import org.openhab.binding.velux.internal.config.VeluxThingConfiguration;
import org.openhab.binding.velux.internal.handler.utils.ExtendedBaseThingHandler;
import org.openhab.binding.velux.internal.handler.utils.Thing2VeluxActuator;
import org.openhab.binding.velux.internal.things.VeluxProduct;
import org.openhab.binding.velux.internal.utils.Localization;
import org.openhab.core.config.core.Configuration;
import org.openhab.core.thing.Bridge;
import org.openhab.core.thing.Channel;
import org.openhab.core.thing.ChannelUID;
import org.openhab.core.thing.Thing;
import org.openhab.core.thing.ThingStatus;
Expand All @@ -41,7 +45,7 @@
public class VeluxHandler extends ExtendedBaseThingHandler {
private final Logger logger = LoggerFactory.getLogger(VeluxHandler.class);

VeluxThingConfiguration configuration = new VeluxThingConfiguration();
private VeluxThingConfiguration configuration = new VeluxThingConfiguration();

public VeluxHandler(Thing thing, Localization localization) {
super(thing);
Expand Down Expand Up @@ -125,4 +129,37 @@ public void handleConfigurationUpdate(Map<String, Object> configurationParameter
super.handleConfigurationUpdate(configurationParameters);
}
}

/**
* Remove previously statically created vane channel if the device does not support it. Or log a warning if it does
* support a vane and the respective channel is missing.
*
* @param bridgeHandler the calling bridge handler.
* @throws IllegalStateException if something went wrong.
*/
public void updateDynamicChannels(VeluxBridgeHandler bridgeHandler) throws IllegalStateException {
// roller shutters are the only things with a previously statically created vane channel
if (!VeluxBindingConstants.THING_TYPE_VELUX_ROLLERSHUTTER.equals(thing.getThingTypeUID())) {
return;
}

String id = VeluxBindingConstants.CHANNEL_VANE_POSITION;
ChannelUID uid = new ChannelUID(thing.getUID(), id);
Thing2VeluxActuator actuator = new Thing2VeluxActuator(bridgeHandler, uid);
VeluxProduct product = bridgeHandler.existingProducts().get(actuator.getProductBridgeIndex());

if (product.equals(VeluxProduct.UNKNOWN)) {
throw new IllegalStateException("initializeVanePositionChannel(): Product unknown in the bridge");
andrewfg marked this conversation as resolved.
Show resolved Hide resolved
}

Channel channel = thing.getChannel(id);
boolean required = product.supportsVanePosition();

if (!required && channel != null) {
logger.debug("Removing unsupported channel for {}: {}", thing.getUID(), id);
scheduler.submit(() -> updateThing(editThing().withoutChannels(channel).build()));
andrewfg marked this conversation as resolved.
Show resolved Hide resolved
} else if (required && channel == null) {
logger.warn("Thing {} does not have a '{}' channel => please reinitialize it", thing.getUID(), id);
andrewfg marked this conversation as resolved.
Show resolved Hide resolved
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ channel-type.velux.scenes.description = Scenes which are configured on the Bridg
channel-type.velux.check.label = Check of configuration
channel-type.velux.check.description = Result of the check of current item configuration.
#
channel-type.velux.windowPosition.label = Position
andrewfg marked this conversation as resolved.
Show resolved Hide resolved
channel-type.velux.windowPosition.description = Device control (UP, DOWN, STOP, closure 0-100%).
channel-type.velux.position.label = Position
channel-type.velux.position.description = Device control (UP, DOWN, STOP, closure 0-100%).
channel-type.velux.vanePosition.label = Vane Position
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,13 @@

<!-- Channel Type - Generic Things -->

<channel-type id="windowPosition">
<item-type>Rollershutter</item-type>
<label>@text/channel-type.velux.windowPosition.label</label>
<description>@text/channel-type.velux.windowPosition.description</description>
<category>Window</category>
</channel-type>
andrewfg marked this conversation as resolved.
Show resolved Hide resolved

<channel-type id="position">
<item-type>Rollershutter</item-type>
<label>@text/channel-type.velux.position.label</label>
Expand All @@ -143,7 +150,6 @@
<item-type>Dimmer</item-type>
<label>@text/channel-type.velux.vanePosition.label</label>
<description>@text/channel-type.velux.vanePosition.description</description>
<category>Blinds</category>
<state min="0" max="100"/>
</channel-type>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
<category>Blinds</category>
<channels>
<channel id="position" typeId="position"/>
<channel id="vanePosition" typeId="vanePosition"/>
<channel id="limitMinimum" typeId="limitMinimum"/>
<channel id="limitMaximum" typeId="limitMaximum"/>
<channel id="vanePosition" typeId="vanePosition"/>
</channels>
<representation-property>serial</representation-property>
<config-description-ref uri="thing-type:velux:rollershutter"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<description>@text/thing-type.velux.window.description</description>
<category>Window</category>
<channels>
<channel id="position" typeId="position"></channel>
<channel id="position" typeId="windowPosition"></channel>
andrewfg marked this conversation as resolved.
Show resolved Hide resolved
<channel id="limitMinimum" typeId="limitMinimum"/>
<channel id="limitMaximum" typeId="limitMaximum"/>
</channels>
Expand Down