git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 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.homeconnect.internal.handler;
  14
  15 import static org.openhab.binding.homeconnect.internal.HomeConnectBindingConstants.*;
  16
  17 import java.util.Arrays;
  18 import java.util.List;
  19 import java.util.Map;
  20
  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;
  34
  35 /**
  36  * The {@link HomeConnectWasherDryerHandler} is responsible for handling commands, which are
  37  * sent to one of the channels of a washer dryer combined machine.
  38  *
  39  * @author Jonas Brüstel - Initial contribution
  40  */
  41 @NonNullByDefault
  42 public class HomeConnectWasherDryerHandler extends AbstractHomeConnectThingHandler {
  43
  44     private static final List<String> INACTIVE_STATE = Arrays.asList(OPERATION_STATE_INACTIVE, OPERATION_STATE_READY);
  45
  46     private final Logger logger = LoggerFactory.getLogger(HomeConnectWasherDryerHandler.class);
  47
  48     public HomeConnectWasherDryerHandler(Thing thing,
  49             HomeConnectDynamicStateDescriptionProvider dynamicStateDescriptionProvider) {
  50         super(thing, dynamicStateDescriptionProvider);
  51     }
  52
  53     @Override
  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());
  64
  65         // register washer specific handlers
  66         handlers.put(CHANNEL_WASHER_SPIN_SPEED,
  67                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  68         handlers.put(CHANNEL_WASHER_TEMPERATURE,
  69                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  70         handlers.put(CHANNEL_WASHER_VARIO_PERFECT,
  71                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  72         handlers.put(CHANNEL_WASHER_LESS_IRONING,
  73                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  74         handlers.put(CHANNEL_WASHER_PRE_WASH,
  75                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  76         handlers.put(CHANNEL_WASHER_RINSE_PLUS,
  77                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  78         handlers.put(CHANNEL_WASHER_RINSE_HOLD,
  79                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  80         handlers.put(CHANNEL_WASHER_SOAK,
  81                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  82         handlers.put(CHANNEL_WASHER_LOAD_RECOMMENDATION,
  83                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  84         handlers.put(CHANNEL_PROGRAM_ENERGY,
  85                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  86         handlers.put(CHANNEL_PROGRAM_WATER,
  87                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  88         // register dryer specific handlers
  89         handlers.put(CHANNEL_DRYER_DRYING_TARGET,
  90                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  91     }
  92
  93     @Override
  94     protected void configureEventHandlers(Map<String, EventHandler> handlers) {
  95         // register default event handlers
  96         handlers.put(EVENT_DOOR_STATE, defaultDoorStateEventHandler());
  97         handlers.put(EVENT_REMOTE_CONTROL_ACTIVE, updateRemoteControlActiveAndProgramOptionsStateEventHandler());
  98         handlers.put(EVENT_REMOTE_CONTROL_START_ALLOWED,
  99                 defaultBooleanEventHandler(CHANNEL_REMOTE_START_ALLOWANCE_STATE));
 100         handlers.put(EVENT_FINISH_IN_RELATIVE, defaultRemainingProgramTimeEventHandler());
 101         handlers.put(EVENT_REMAINING_PROGRAM_TIME, defaultRemainingProgramTimeEventHandler());
 102         handlers.put(EVENT_PROGRAM_PROGRESS, defaultPercentQuantityTypeEventHandler(CHANNEL_PROGRAM_PROGRESS_STATE));
 103         handlers.put(EVENT_LOCAL_CONTROL_ACTIVE, defaultBooleanEventHandler(CHANNEL_LOCAL_CONTROL_ACTIVE_STATE));
 104         handlers.put(EVENT_ACTIVE_PROGRAM, updateProgramOptionsAndActiveProgramStateEventHandler());
 105         handlers.put(EVENT_OPERATION_STATE, defaultOperationStateEventHandler());
 106         handlers.put(EVENT_SELECTED_PROGRAM, updateProgramOptionsAndSelectedProgramStateEventHandler());
 107
 108         // register washer specific event handlers
 109         handlers.put(EVENT_WASHER_TEMPERATURE,
 110                 event -> getLinkedChannel(CHANNEL_WASHER_TEMPERATURE).ifPresent(channel -> updateState(channel.getUID(),
 111                         event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
 112         handlers.put(EVENT_WASHER_SPIN_SPEED,
 113                 event -> getLinkedChannel(CHANNEL_WASHER_SPIN_SPEED).ifPresent(channel -> updateState(channel.getUID(),
 114                         event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
 115         // register dryer specific event handlers
 116         handlers.put(EVENT_DRYER_DRYING_TARGET,
 117                 event -> getLinkedChannel(CHANNEL_DRYER_DRYING_TARGET)
 118                         .ifPresent(channel -> updateState(channel.getUID(),
 119                                 event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
 120     }
 121
 122     @Override
 123     protected boolean isChannelLinkedToProgramOptionNotFullySupportedByApi() {
 124         return getLinkedChannel(CHANNEL_WASHER_VARIO_PERFECT).isPresent()
 125                 || getLinkedChannel(CHANNEL_WASHER_LESS_IRONING).isPresent()
 126                 || getLinkedChannel(CHANNEL_WASHER_PRE_WASH).isPresent()
 127                 || getLinkedChannel(CHANNEL_WASHER_RINSE_PLUS).isPresent()
 128                 || getLinkedChannel(CHANNEL_WASHER_RINSE_HOLD).isPresent()
 129                 || getLinkedChannel(CHANNEL_WASHER_SOAK).isPresent()
 130                 || getLinkedChannel(CHANNEL_WASHER_LOAD_RECOMMENDATION).isPresent()
 131                 || getLinkedChannel(CHANNEL_PROGRAM_ENERGY).isPresent()
 132                 || getLinkedChannel(CHANNEL_PROGRAM_WATER).isPresent();
 133     }
 134
 135     @Override
 136     protected void handleCommand(final ChannelUID channelUID, final Command command,
 137             final HomeConnectApiClient apiClient)
 138             throws CommunicationException, AuthorizationException, ApplianceOfflineException {
 139         super.handleCommand(channelUID, command, apiClient);
 140         String operationState = getOperationState();
 141
 142         // only handle these commands if operation state allows it
 143         if (operationState != null && INACTIVE_STATE.contains(operationState) && command instanceof StringType) {
 144             switch (channelUID.getId()) {
 145                 case CHANNEL_WASHER_TEMPERATURE:
 146                     apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_TEMPERATURE, command.toFullString(), null,
 147                             false, false);
 148                     break;
 149                 case CHANNEL_WASHER_SPIN_SPEED:
 150                     apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_SPIN_SPEED, command.toFullString(), null,
 151                             false, false);
 152                     break;
 153                 case CHANNEL_DRYER_DRYING_TARGET:
 154                     apiClient.setProgramOptions(getThingHaId(), OPTION_DRYER_DRYING_TARGET, command.toFullString(),
 155                             null, false, false);
 156                     break;
 157             }
 158         } else {
 159             logger.debug("Device can not handle command {} in current operation state ({}). haId={}", command,
 160                     operationState, getThingHaId());
 161         }
 162     }
 163
 164     @Override
 165     public String toString() {
 166         return "HomeConnectWasherDryerHandler [haId: " + getThingHaId() + "]";
 167     }
 168
 169     @Override
 170     protected void resetProgramStateChannels(boolean offline) {
 171         super.resetProgramStateChannels(offline);
 172         getLinkedChannel(CHANNEL_REMAINING_PROGRAM_TIME_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 173         getLinkedChannel(CHANNEL_PROGRAM_PROGRESS_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 174         getLinkedChannel(CHANNEL_ACTIVE_PROGRAM_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 175         if (offline) {
 176             getLinkedChannel(CHANNEL_WASHER_TEMPERATURE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 177             getLinkedChannel(CHANNEL_WASHER_SPIN_SPEED).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 178             getLinkedChannel(CHANNEL_WASHER_VARIO_PERFECT).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 179             getLinkedChannel(CHANNEL_WASHER_LESS_IRONING).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 180             getLinkedChannel(CHANNEL_WASHER_PRE_WASH).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 181             getLinkedChannel(CHANNEL_WASHER_RINSE_PLUS).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 182             getLinkedChannel(CHANNEL_WASHER_RINSE_HOLD).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 183             getLinkedChannel(CHANNEL_WASHER_SOAK).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 184             getLinkedChannel(CHANNEL_WASHER_LOAD_RECOMMENDATION)
 185                     .ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 186             getLinkedChannel(CHANNEL_PROGRAM_ENERGY).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 187             getLinkedChannel(CHANNEL_PROGRAM_WATER).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 188             getLinkedChannel(CHANNEL_DRYER_DRYING_TARGET).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 189         }
 190     }
 191 }