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.client.model.AvailableProgramOption;
  27 import org.openhab.binding.homeconnect.internal.type.HomeConnectDynamicStateDescriptionProvider;
  28 import org.openhab.core.library.types.StringType;
  29 import org.openhab.core.thing.ChannelUID;
  30 import org.openhab.core.thing.Thing;
  31 import org.openhab.core.types.Command;
  32 import org.openhab.core.types.UnDefType;
  33 import org.slf4j.Logger;
  34 import org.slf4j.LoggerFactory;
  35
  36 /**
  37  * The {@link HomeConnectWasherHandler} is responsible for handling commands, which are
  38  * sent to one of the channels of a washing machine.
  39  *
  40  * @author Jonas Brüstel - Initial contribution
  41  */
  42 @NonNullByDefault
  43 public class HomeConnectWasherHandler extends AbstractHomeConnectThingHandler {
  44
  45     private static final List<String> INACTIVE_STATE = Arrays.asList(OPERATION_STATE_INACTIVE, OPERATION_STATE_READY);
  46
  47     private final Logger logger = LoggerFactory.getLogger(HomeConnectWasherHandler.class);
  48
  49     public HomeConnectWasherHandler(Thing thing,
  50             HomeConnectDynamicStateDescriptionProvider dynamicStateDescriptionProvider) {
  51         super(thing, dynamicStateDescriptionProvider);
  52     }
  53
  54     @Override
  55     protected void configureChannelUpdateHandlers(Map<String, ChannelUpdateHandler> handlers) {
  56         // register default update handlers
  57         handlers.put(CHANNEL_DOOR_STATE, defaultDoorStateChannelUpdateHandler());
  58         handlers.put(CHANNEL_OPERATION_STATE, defaultOperationStateChannelUpdateHandler());
  59         handlers.put(CHANNEL_REMOTE_CONTROL_ACTIVE_STATE, defaultRemoteControlActiveStateChannelUpdateHandler());
  60         handlers.put(CHANNEL_REMOTE_START_ALLOWANCE_STATE, defaultRemoteStartAllowanceChannelUpdateHandler());
  61         handlers.put(CHANNEL_LOCAL_CONTROL_ACTIVE_STATE, defaultLocalControlActiveStateChannelUpdateHandler());
  62         handlers.put(CHANNEL_ACTIVE_PROGRAM_STATE, defaultActiveProgramStateUpdateHandler());
  63         handlers.put(CHANNEL_SELECTED_PROGRAM_STATE,
  64                 updateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  65
  66         // register washer specific handlers
  67         handlers.put(CHANNEL_WASHER_SPIN_SPEED,
  68                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  69         handlers.put(CHANNEL_WASHER_TEMPERATURE,
  70                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  71         handlers.put(CHANNEL_WASHER_IDOS1_LEVEL,
  72                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  73         handlers.put(CHANNEL_WASHER_IDOS2_LEVEL,
  74                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  75         handlers.put(CHANNEL_WASHER_IDOS1,
  76                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  77         handlers.put(CHANNEL_WASHER_IDOS2,
  78                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  79         handlers.put(CHANNEL_WASHER_VARIO_PERFECT,
  80                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  81         handlers.put(CHANNEL_WASHER_LESS_IRONING,
  82                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  83         handlers.put(CHANNEL_WASHER_PRE_WASH,
  84                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  85         handlers.put(CHANNEL_WASHER_RINSE_PLUS,
  86                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  87         handlers.put(CHANNEL_WASHER_RINSE_HOLD,
  88                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  89         handlers.put(CHANNEL_WASHER_SOAK,
  90                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  91         handlers.put(CHANNEL_WASHER_LOAD_RECOMMENDATION,
  92                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  93         handlers.put(CHANNEL_PROGRAM_ENERGY,
  94                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  95         handlers.put(CHANNEL_PROGRAM_WATER,
  96                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  97     }
  98
  99     @Override
 100     protected void configureEventHandlers(Map<String, EventHandler> handlers) {
 101         // register default event handlers
 102         handlers.put(EVENT_DOOR_STATE, defaultDoorStateEventHandler());
 103         handlers.put(EVENT_REMOTE_CONTROL_ACTIVE, updateRemoteControlActiveAndProgramOptionsStateEventHandler());
 104         handlers.put(EVENT_REMOTE_CONTROL_START_ALLOWED,
 105                 defaultBooleanEventHandler(CHANNEL_REMOTE_START_ALLOWANCE_STATE));
 106         handlers.put(EVENT_FINISH_IN_RELATIVE, defaultRemainingProgramTimeEventHandler());
 107         handlers.put(EVENT_REMAINING_PROGRAM_TIME, defaultRemainingProgramTimeEventHandler());
 108         handlers.put(EVENT_PROGRAM_PROGRESS, defaultPercentQuantityTypeEventHandler(CHANNEL_PROGRAM_PROGRESS_STATE));
 109         handlers.put(EVENT_LOCAL_CONTROL_ACTIVE, defaultBooleanEventHandler(CHANNEL_LOCAL_CONTROL_ACTIVE_STATE));
 110         handlers.put(EVENT_ACTIVE_PROGRAM, updateProgramOptionsAndActiveProgramStateEventHandler());
 111         handlers.put(EVENT_OPERATION_STATE, defaultOperationStateEventHandler());
 112         handlers.put(EVENT_SELECTED_PROGRAM, updateProgramOptionsAndSelectedProgramStateEventHandler());
 113
 114         // register washer specific event handlers
 115         handlers.put(EVENT_WASHER_TEMPERATURE,
 116                 event -> getLinkedChannel(CHANNEL_WASHER_TEMPERATURE).ifPresent(channel -> updateState(channel.getUID(),
 117                         event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
 118         handlers.put(EVENT_WASHER_SPIN_SPEED,
 119                 event -> getLinkedChannel(CHANNEL_WASHER_SPIN_SPEED).ifPresent(channel -> updateState(channel.getUID(),
 120                         event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
 121         handlers.put(EVENT_WASHER_IDOS_1_DOSING_LEVEL,
 122                 event -> getLinkedChannel(CHANNEL_WASHER_IDOS1_LEVEL).ifPresent(channel -> updateState(channel.getUID(),
 123                         event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
 124         handlers.put(EVENT_WASHER_IDOS_2_DOSING_LEVEL,
 125                 event -> getLinkedChannel(CHANNEL_WASHER_IDOS2_LEVEL).ifPresent(channel -> updateState(channel.getUID(),
 126                         event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
 127     }
 128
 129     @Override
 130     protected void configureUnsupportedProgramOptions(Map<String, List<AvailableProgramOption>> programOptions) {
 131         programOptions.put("LaundryCare.Washer.Program.Cotton.Eco4060", List.of(
 132                 new AvailableProgramOption(OPTION_WASHER_TEMPERATURE, List.of(TEMPERATURE_AUTO)),
 133                 new AvailableProgramOption(OPTION_WASHER_SPIN_SPEED,
 134                         List.of(SPIN_SPEED_400, SPIN_SPEED_600, SPIN_SPEED_800, SPIN_SPEED_1200, SPIN_SPEED_1400))));
 135
 136         programOptions.put("LaundryCare.Washer.Program.Cotton.Colour", List.of(
 137                 new AvailableProgramOption(OPTION_WASHER_TEMPERATURE,
 138                         List.of(TEMPERATURE_COLD, TEMPERATURE_20, TEMPERATURE_30, TEMPERATURE_40, TEMPERATURE_60,
 139                                 TEMPERATURE_90)),
 140                 new AvailableProgramOption(OPTION_WASHER_SPIN_SPEED,
 141                         List.of(SPIN_SPEED_400, SPIN_SPEED_600, SPIN_SPEED_800, SPIN_SPEED_1200, SPIN_SPEED_1400))));
 142
 143         // Auto30 is a supported program provided by the API but the API returns empty options, so we defined predefined
 144         // values for this program
 145         programOptions.put("LaundryCare.Washer.Program.Auto30",
 146                 List.of(new AvailableProgramOption(OPTION_WASHER_TEMPERATURE, List.of(TEMPERATURE_AUTO)),
 147                         new AvailableProgramOption(OPTION_WASHER_SPIN_SPEED, List.of(SPIN_SPEED_AUTO))));
 148
 149         programOptions.put("LaundryCare.Washer.Program.Super153045.Super1530",
 150                 List.of(new AvailableProgramOption(OPTION_WASHER_TEMPERATURE,
 151                         List.of(TEMPERATURE_COLD, TEMPERATURE_20, TEMPERATURE_30, TEMPERATURE_40)),
 152                         new AvailableProgramOption(OPTION_WASHER_SPIN_SPEED,
 153                                 List.of(SPIN_SPEED_400, SPIN_SPEED_600, SPIN_SPEED_800, SPIN_SPEED_1200))));
 154
 155         programOptions.put("LaundryCare.Washer.Program.Rinse",
 156                 List.of(new AvailableProgramOption(OPTION_WASHER_TEMPERATURE, List.of()),
 157                         new AvailableProgramOption(OPTION_WASHER_SPIN_SPEED, List.of(SPIN_SPEED_OFF, SPIN_SPEED_400,
 158                                 SPIN_SPEED_600, SPIN_SPEED_800, SPIN_SPEED_1200, SPIN_SPEED_1400))));
 159
 160         programOptions.put("LaundryCare.Washer.Program.Spin.SpinDrain",
 161                 List.of(new AvailableProgramOption(OPTION_WASHER_TEMPERATURE, List.of()),
 162                         new AvailableProgramOption(OPTION_WASHER_SPIN_SPEED, List.of(SPIN_SPEED_OFF, SPIN_SPEED_400,
 163                                 SPIN_SPEED_600, SPIN_SPEED_800, SPIN_SPEED_1200, SPIN_SPEED_1400))));
 164
 165         programOptions.put("LaundryCare.Washer.Program.DrumClean",
 166                 List.of(new AvailableProgramOption(OPTION_WASHER_TEMPERATURE, List.of()),
 167                         new AvailableProgramOption(OPTION_WASHER_SPIN_SPEED, List.of(SPIN_SPEED_1200))));
 168     }
 169
 170     @Override
 171     protected boolean isChannelLinkedToProgramOptionNotFullySupportedByApi() {
 172         return getLinkedChannel(CHANNEL_WASHER_IDOS1).isPresent() || getLinkedChannel(CHANNEL_WASHER_IDOS2).isPresent()
 173                 || getLinkedChannel(CHANNEL_WASHER_VARIO_PERFECT).isPresent()
 174                 || getLinkedChannel(CHANNEL_WASHER_LESS_IRONING).isPresent()
 175                 || getLinkedChannel(CHANNEL_WASHER_PRE_WASH).isPresent()
 176                 || getLinkedChannel(CHANNEL_WASHER_RINSE_PLUS).isPresent()
 177                 || getLinkedChannel(CHANNEL_WASHER_RINSE_HOLD).isPresent()
 178                 || getLinkedChannel(CHANNEL_WASHER_SOAK).isPresent()
 179                 || getLinkedChannel(CHANNEL_WASHER_LOAD_RECOMMENDATION).isPresent()
 180                 || getLinkedChannel(CHANNEL_PROGRAM_ENERGY).isPresent()
 181                 || getLinkedChannel(CHANNEL_PROGRAM_WATER).isPresent();
 182     }
 183
 184     @Override
 185     protected void handleCommand(final ChannelUID channelUID, final Command command,
 186             final HomeConnectApiClient apiClient)
 187             throws CommunicationException, AuthorizationException, ApplianceOfflineException {
 188         super.handleCommand(channelUID, command, apiClient);
 189         String operationState = getOperationState();
 190
 191         // only handle these commands if operation state allows it
 192         if (operationState != null && INACTIVE_STATE.contains(operationState) && command instanceof StringType) {
 193             switch (channelUID.getId()) {
 194                 case CHANNEL_WASHER_TEMPERATURE:
 195                     apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_TEMPERATURE, command.toFullString(), null,
 196                             false, false);
 197                     break;
 198                 case CHANNEL_WASHER_SPIN_SPEED:
 199                     apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_SPIN_SPEED, command.toFullString(), null,
 200                             false, false);
 201                     break;
 202                 case CHANNEL_WASHER_IDOS1_LEVEL:
 203                     apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_IDOS_1_DOSING_LEVEL,
 204                             command.toFullString(), null, false, false);
 205                     break;
 206                 case CHANNEL_WASHER_IDOS2_LEVEL:
 207                     apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_IDOS_2_DOSING_LEVEL,
 208                             command.toFullString(), null, false, false);
 209                     break;
 210             }
 211         } else {
 212             logger.debug("Device can not handle command {} in current operation state ({}). haId={}", command,
 213                     operationState, getThingHaId());
 214         }
 215     }
 216
 217     @Override
 218     public String toString() {
 219         return "HomeConnectWasherHandler [haId: " + getThingHaId() + "]";
 220     }
 221
 222     @Override
 223     protected void resetProgramStateChannels(boolean offline) {
 224         super.resetProgramStateChannels(offline);
 225         getLinkedChannel(CHANNEL_REMAINING_PROGRAM_TIME_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 226         getLinkedChannel(CHANNEL_PROGRAM_PROGRESS_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 227         getLinkedChannel(CHANNEL_ACTIVE_PROGRAM_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 228         if (offline) {
 229             getLinkedChannel(CHANNEL_WASHER_TEMPERATURE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 230             getLinkedChannel(CHANNEL_WASHER_SPIN_SPEED).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 231             getLinkedChannel(CHANNEL_WASHER_IDOS1_LEVEL).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 232             getLinkedChannel(CHANNEL_WASHER_IDOS2_LEVEL).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 233             getLinkedChannel(CHANNEL_WASHER_IDOS1).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 234             getLinkedChannel(CHANNEL_WASHER_IDOS2).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 235             getLinkedChannel(CHANNEL_WASHER_VARIO_PERFECT).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 236             getLinkedChannel(CHANNEL_WASHER_LESS_IRONING).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 237             getLinkedChannel(CHANNEL_WASHER_PRE_WASH).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 238             getLinkedChannel(CHANNEL_WASHER_RINSE_PLUS).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 239             getLinkedChannel(CHANNEL_WASHER_RINSE_HOLD).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 240             getLinkedChannel(CHANNEL_WASHER_SOAK).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 241             getLinkedChannel(CHANNEL_WASHER_LOAD_RECOMMENDATION)
 242                     .ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 243             getLinkedChannel(CHANNEL_PROGRAM_ENERGY).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 244             getLinkedChannel(CHANNEL_PROGRAM_WATER).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 245         }
 246     }
 247 }