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

   1 /**
   2  * Copyright (c) 2010-2021 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_SOAK,
  88                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  89         handlers.put(CHANNEL_PROGRAM_ENERGY,
  90                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  91         handlers.put(CHANNEL_PROGRAM_WATER,
  92                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  93     }
  94
  95     @Override
  96     protected void configureEventHandlers(Map<String, EventHandler> handlers) {
  97         // register default event handlers
  98         handlers.put(EVENT_DOOR_STATE, defaultDoorStateEventHandler());
  99         handlers.put(EVENT_REMOTE_CONTROL_ACTIVE, updateRemoteControlActiveAndProgramOptionsStateEventHandler());
 100         handlers.put(EVENT_REMOTE_CONTROL_START_ALLOWED,
 101                 defaultBooleanEventHandler(CHANNEL_REMOTE_START_ALLOWANCE_STATE));
 102         handlers.put(EVENT_FINISH_IN_RELATIVE, defaultRemainingProgramTimeEventHandler());
 103         handlers.put(EVENT_REMAINING_PROGRAM_TIME, defaultRemainingProgramTimeEventHandler());
 104         handlers.put(EVENT_PROGRAM_PROGRESS, defaultPercentQuantityTypeEventHandler(CHANNEL_PROGRAM_PROGRESS_STATE));
 105         handlers.put(EVENT_LOCAL_CONTROL_ACTIVE, defaultBooleanEventHandler(CHANNEL_LOCAL_CONTROL_ACTIVE_STATE));
 106         handlers.put(EVENT_ACTIVE_PROGRAM, updateProgramOptionsAndActiveProgramStateEventHandler());
 107         handlers.put(EVENT_OPERATION_STATE, defaultOperationStateEventHandler());
 108         handlers.put(EVENT_SELECTED_PROGRAM, updateProgramOptionsAndSelectedProgramStateEventHandler());
 109
 110         // register washer specific event handlers
 111         handlers.put(EVENT_WASHER_TEMPERATURE,
 112                 event -> getThingChannel(CHANNEL_WASHER_TEMPERATURE).ifPresent(channel -> updateState(channel.getUID(),
 113                         event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
 114         handlers.put(EVENT_WASHER_SPIN_SPEED,
 115                 event -> getThingChannel(CHANNEL_WASHER_SPIN_SPEED).ifPresent(channel -> updateState(channel.getUID(),
 116                         event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
 117         handlers.put(EVENT_WASHER_IDOS_1_DOSING_LEVEL,
 118                 event -> getThingChannel(CHANNEL_WASHER_IDOS1_LEVEL).ifPresent(channel -> updateState(channel.getUID(),
 119                         event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
 120         handlers.put(EVENT_WASHER_IDOS_2_DOSING_LEVEL,
 121                 event -> getThingChannel(CHANNEL_WASHER_IDOS2_LEVEL).ifPresent(channel -> updateState(channel.getUID(),
 122                         event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
 123     }
 124
 125     @Override
 126     protected void configureUnsupportedProgramOptions(Map<String, List<AvailableProgramOption>> programOptions) {
 127         programOptions.put("LaundryCare.Washer.Program.Cotton.Eco4060", List.of(
 128                 new AvailableProgramOption(OPTION_WASHER_TEMPERATURE, List.of(TEMPERATURE_AUTO)),
 129                 new AvailableProgramOption(OPTION_WASHER_SPIN_SPEED,
 130                         List.of(SPIN_SPEED_400, SPIN_SPEED_600, SPIN_SPEED_800, SPIN_SPEED_1200, SPIN_SPEED_1400))));
 131
 132         programOptions.put("LaundryCare.Washer.Program.Cotton.Colour", List.of(
 133                 new AvailableProgramOption(OPTION_WASHER_TEMPERATURE,
 134                         List.of(TEMPERATURE_COLD, TEMPERATURE_20, TEMPERATURE_30, TEMPERATURE_40, TEMPERATURE_60,
 135                                 TEMPERATURE_90)),
 136                 new AvailableProgramOption(OPTION_WASHER_SPIN_SPEED,
 137                         List.of(SPIN_SPEED_400, SPIN_SPEED_600, SPIN_SPEED_800, SPIN_SPEED_1200, SPIN_SPEED_1400))));
 138
 139         // Auto30 is a supported program provided by the API but the API returns empty options, so we defined predefined
 140         // values for this program
 141         programOptions.put("LaundryCare.Washer.Program.Auto30",
 142                 List.of(new AvailableProgramOption(OPTION_WASHER_TEMPERATURE, List.of(TEMPERATURE_AUTO)),
 143                         new AvailableProgramOption(OPTION_WASHER_SPIN_SPEED, List.of(SPIN_SPEED_AUTO))));
 144
 145         programOptions.put("LaundryCare.Washer.Program.Super153045.Super1530",
 146                 List.of(new AvailableProgramOption(OPTION_WASHER_TEMPERATURE,
 147                         List.of(TEMPERATURE_COLD, TEMPERATURE_20, TEMPERATURE_30, TEMPERATURE_40)),
 148                         new AvailableProgramOption(OPTION_WASHER_SPIN_SPEED,
 149                                 List.of(SPIN_SPEED_400, SPIN_SPEED_600, SPIN_SPEED_800, SPIN_SPEED_1200))));
 150
 151         programOptions.put("LaundryCare.Washer.Program.Rinse",
 152                 List.of(new AvailableProgramOption(OPTION_WASHER_TEMPERATURE, List.of()),
 153                         new AvailableProgramOption(OPTION_WASHER_SPIN_SPEED, List.of(SPIN_SPEED_OFF, SPIN_SPEED_400,
 154                                 SPIN_SPEED_600, SPIN_SPEED_800, SPIN_SPEED_1200, SPIN_SPEED_1400))));
 155
 156         programOptions.put("LaundryCare.Washer.Program.Spin.SpinDrain",
 157                 List.of(new AvailableProgramOption(OPTION_WASHER_TEMPERATURE, List.of()),
 158                         new AvailableProgramOption(OPTION_WASHER_SPIN_SPEED, List.of(SPIN_SPEED_OFF, SPIN_SPEED_400,
 159                                 SPIN_SPEED_600, SPIN_SPEED_800, SPIN_SPEED_1200, SPIN_SPEED_1400))));
 160
 161         programOptions.put("LaundryCare.Washer.Program.DrumClean",
 162                 List.of(new AvailableProgramOption(OPTION_WASHER_TEMPERATURE, List.of()),
 163                         new AvailableProgramOption(OPTION_WASHER_SPIN_SPEED, List.of(SPIN_SPEED_1200))));
 164     }
 165
 166     @Override
 167     protected boolean isChannelLinkedToProgramOptionNotFullySupportedByApi() {
 168         return (getThingChannel(CHANNEL_WASHER_IDOS1).isPresent() && isLinked(CHANNEL_WASHER_IDOS1))
 169                 || (getThingChannel(CHANNEL_WASHER_IDOS2).isPresent() && isLinked(CHANNEL_WASHER_IDOS2))
 170                 || (getThingChannel(CHANNEL_WASHER_VARIO_PERFECT).isPresent() && isLinked(CHANNEL_WASHER_VARIO_PERFECT))
 171                 || (getThingChannel(CHANNEL_WASHER_LESS_IRONING).isPresent() && isLinked(CHANNEL_WASHER_LESS_IRONING))
 172                 || (getThingChannel(CHANNEL_WASHER_PRE_WASH).isPresent() && isLinked(CHANNEL_WASHER_PRE_WASH))
 173                 || (getThingChannel(CHANNEL_WASHER_RINSE_PLUS).isPresent() && isLinked(CHANNEL_WASHER_RINSE_PLUS))
 174                 || (getThingChannel(CHANNEL_WASHER_SOAK).isPresent() && isLinked(CHANNEL_WASHER_SOAK))
 175                 || (getThingChannel(CHANNEL_PROGRAM_ENERGY).isPresent() && isLinked(CHANNEL_PROGRAM_ENERGY))
 176                 || (getThingChannel(CHANNEL_PROGRAM_WATER).isPresent() && isLinked(CHANNEL_PROGRAM_WATER));
 177     }
 178
 179     @Override
 180     protected void handleCommand(final ChannelUID channelUID, final Command command,
 181             final HomeConnectApiClient apiClient)
 182             throws CommunicationException, AuthorizationException, ApplianceOfflineException {
 183         super.handleCommand(channelUID, command, apiClient);
 184         String operationState = getOperationState();
 185
 186         // only handle these commands if operation state allows it
 187         if (operationState != null && INACTIVE_STATE.contains(operationState) && command instanceof StringType) {
 188             switch (channelUID.getId()) {
 189                 case CHANNEL_WASHER_TEMPERATURE:
 190                     apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_TEMPERATURE, command.toFullString(), null,
 191                             false, false);
 192                     break;
 193                 case CHANNEL_WASHER_SPIN_SPEED:
 194                     apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_SPIN_SPEED, command.toFullString(), null,
 195                             false, false);
 196                     break;
 197                 case CHANNEL_WASHER_IDOS1_LEVEL:
 198                     apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_IDOS_1_DOSING_LEVEL,
 199                             command.toFullString(), null, false, false);
 200                     break;
 201                 case CHANNEL_WASHER_IDOS2_LEVEL:
 202                     apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_IDOS_2_DOSING_LEVEL,
 203                             command.toFullString(), null, false, false);
 204                     break;
 205             }
 206         } else {
 207             logger.debug("Device can not handle command {} in current operation state ({}). haId={}", command,
 208                     operationState, getThingHaId());
 209         }
 210     }
 211
 212     @Override
 213     public String toString() {
 214         return "HomeConnectWasherHandler [haId: " + getThingHaId() + "]";
 215     }
 216
 217     @Override
 218     protected void resetProgramStateChannels(boolean offline) {
 219         super.resetProgramStateChannels(offline);
 220         getThingChannel(CHANNEL_REMAINING_PROGRAM_TIME_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 221         getThingChannel(CHANNEL_PROGRAM_PROGRESS_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 222         getThingChannel(CHANNEL_ACTIVE_PROGRAM_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 223         if (offline) {
 224             getThingChannel(CHANNEL_WASHER_TEMPERATURE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 225             getThingChannel(CHANNEL_WASHER_SPIN_SPEED).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 226             getThingChannel(CHANNEL_WASHER_IDOS1_LEVEL).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 227             getThingChannel(CHANNEL_WASHER_IDOS2_LEVEL).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 228             getThingChannel(CHANNEL_WASHER_IDOS1).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 229             getThingChannel(CHANNEL_WASHER_IDOS2).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 230             getThingChannel(CHANNEL_WASHER_VARIO_PERFECT).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 231             getThingChannel(CHANNEL_WASHER_LESS_IRONING).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 232             getThingChannel(CHANNEL_WASHER_PRE_WASH).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 233             getThingChannel(CHANNEL_WASHER_RINSE_PLUS).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 234             getThingChannel(CHANNEL_WASHER_SOAK).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 235             getThingChannel(CHANNEL_PROGRAM_ENERGY).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 236             getThingChannel(CHANNEL_PROGRAM_WATER).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 237         }
 238     }
 239 }