2 * Copyright (c) 2010-2021 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
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
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.binding.homeconnect.internal.handler;
15 import static org.openhab.binding.homeconnect.internal.HomeConnectBindingConstants.*;
17 import java.util.Arrays;
18 import java.util.List;
21 import org.eclipse.jdt.annotation.NonNullByDefault;
22 import org.openhab.binding.homeconnect.internal.client.HomeConnectApiClient;
23 import org.openhab.binding.homeconnect.internal.client.exception.ApplianceOfflineException;
24 import org.openhab.binding.homeconnect.internal.client.exception.AuthorizationException;
25 import org.openhab.binding.homeconnect.internal.client.exception.CommunicationException;
26 import org.openhab.binding.homeconnect.internal.type.HomeConnectDynamicStateDescriptionProvider;
27 import org.openhab.core.library.types.StringType;
28 import org.openhab.core.thing.ChannelUID;
29 import org.openhab.core.thing.Thing;
30 import org.openhab.core.types.Command;
31 import org.openhab.core.types.UnDefType;
32 import org.slf4j.Logger;
33 import org.slf4j.LoggerFactory;
36 * The {@link HomeConnectWasherDryerHandler} is responsible for handling commands, which are
37 * sent to one of the channels of a washer dryer combined machine.
39 * @author Jonas BrĂ¼stel - Initial contribution
42 public class HomeConnectWasherDryerHandler extends AbstractHomeConnectThingHandler {
44 private static final List<String> INACTIVE_STATE = Arrays.asList(OPERATION_STATE_INACTIVE, OPERATION_STATE_READY);
46 private final Logger logger = LoggerFactory.getLogger(HomeConnectWasherDryerHandler.class);
48 public HomeConnectWasherDryerHandler(Thing thing,
49 HomeConnectDynamicStateDescriptionProvider dynamicStateDescriptionProvider) {
50 super(thing, dynamicStateDescriptionProvider);
54 protected void configureChannelUpdateHandlers(Map<String, ChannelUpdateHandler> handlers) {
55 // register default update handlers
56 handlers.put(CHANNEL_DOOR_STATE, defaultDoorStateChannelUpdateHandler());
57 handlers.put(CHANNEL_OPERATION_STATE, defaultOperationStateChannelUpdateHandler());
58 handlers.put(CHANNEL_REMOTE_CONTROL_ACTIVE_STATE, defaultRemoteControlActiveStateChannelUpdateHandler());
59 handlers.put(CHANNEL_REMOTE_START_ALLOWANCE_STATE, defaultRemoteStartAllowanceChannelUpdateHandler());
60 handlers.put(CHANNEL_LOCAL_CONTROL_ACTIVE_STATE, defaultLocalControlActiveStateChannelUpdateHandler());
61 handlers.put(CHANNEL_ACTIVE_PROGRAM_STATE, defaultActiveProgramStateUpdateHandler());
62 handlers.put(CHANNEL_SELECTED_PROGRAM_STATE,
63 updateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
65 // register washer specific handlers
66 handlers.put(CHANNEL_WASHER_SPIN_SPEED,
67 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
68 handlers.put(CHANNEL_WASHER_TEMPERATURE,
69 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
70 // register dryer specific handlers
71 handlers.put(CHANNEL_DRYER_DRYING_TARGET,
72 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
76 protected void configureEventHandlers(Map<String, EventHandler> handlers) {
77 // register default event handlers
78 handlers.put(EVENT_DOOR_STATE, defaultDoorStateEventHandler());
79 handlers.put(EVENT_REMOTE_CONTROL_ACTIVE, updateRemoteControlActiveAndProgramOptionsStateEventHandler());
80 handlers.put(EVENT_REMOTE_CONTROL_START_ALLOWED,
81 defaultBooleanEventHandler(CHANNEL_REMOTE_START_ALLOWANCE_STATE));
82 handlers.put(EVENT_FINISH_IN_RELATIVE, defaultRemainingProgramTimeEventHandler());
83 handlers.put(EVENT_REMAINING_PROGRAM_TIME, defaultRemainingProgramTimeEventHandler());
84 handlers.put(EVENT_PROGRAM_PROGRESS, defaultPercentQuantityTypeEventHandler(CHANNEL_PROGRAM_PROGRESS_STATE));
85 handlers.put(EVENT_LOCAL_CONTROL_ACTIVE, defaultBooleanEventHandler(CHANNEL_LOCAL_CONTROL_ACTIVE_STATE));
86 handlers.put(EVENT_ACTIVE_PROGRAM, defaultActiveProgramEventHandler());
87 handlers.put(EVENT_OPERATION_STATE, defaultOperationStateEventHandler());
88 handlers.put(EVENT_SELECTED_PROGRAM, updateProgramOptionsAndSelectedProgramStateEventHandler());
90 // register washer specific event handlers
91 handlers.put(EVENT_WASHER_TEMPERATURE,
92 event -> getThingChannel(CHANNEL_WASHER_TEMPERATURE).ifPresent(channel -> updateState(channel.getUID(),
93 event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
94 handlers.put(EVENT_WASHER_SPIN_SPEED,
95 event -> getThingChannel(CHANNEL_WASHER_SPIN_SPEED).ifPresent(channel -> updateState(channel.getUID(),
96 event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
97 // register dryer specific event handlers
98 handlers.put(EVENT_DRYER_DRYING_TARGET,
99 event -> getThingChannel(CHANNEL_DRYER_DRYING_TARGET).ifPresent(channel -> updateState(channel.getUID(),
100 event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
104 protected void handleCommand(final ChannelUID channelUID, final Command command,
105 final HomeConnectApiClient apiClient)
106 throws CommunicationException, AuthorizationException, ApplianceOfflineException {
107 super.handleCommand(channelUID, command, apiClient);
108 String operationState = getOperationState();
110 // only handle these commands if operation state allows it
111 if (operationState != null && INACTIVE_STATE.contains(operationState) && command instanceof StringType) {
112 switch (channelUID.getId()) {
113 case CHANNEL_WASHER_TEMPERATURE:
114 apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_TEMPERATURE, command.toFullString(), null,
117 case CHANNEL_WASHER_SPIN_SPEED:
118 apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_SPIN_SPEED, command.toFullString(), null,
121 case CHANNEL_DRYER_DRYING_TARGET:
122 apiClient.setProgramOptions(getThingHaId(), OPTION_DRYER_DRYING_TARGET, command.toFullString(),
127 logger.debug("Device can not handle command {} in current operation state ({}). haId={}", command,
128 operationState, getThingHaId());
133 public String toString() {
134 return "HomeConnectWasherDryerHandler [haId: " + getThingHaId() + "]";
138 protected void resetProgramStateChannels(boolean offline) {
139 super.resetProgramStateChannels(offline);
140 getThingChannel(CHANNEL_REMAINING_PROGRAM_TIME_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
141 getThingChannel(CHANNEL_PROGRAM_PROGRESS_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
142 getThingChannel(CHANNEL_ACTIVE_PROGRAM_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
144 getThingChannel(CHANNEL_WASHER_TEMPERATURE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
145 getThingChannel(CHANNEL_WASHER_SPIN_SPEED).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
146 getThingChannel(CHANNEL_DRYER_DRYING_TARGET).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));