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.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 HomeConnectWasherHandler} is responsible for handling commands, which are
  37  * sent to one of the channels of a washing machine.
  38  *
  39  * @author Jonas Brüstel - Initial contribution
  40  */
  41 @NonNullByDefault
  42 public class HomeConnectWasherHandler 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(HomeConnectWasherHandler.class);
  47
  48     public HomeConnectWasherHandler(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_IDOS1,
  71                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  72         handlers.put(CHANNEL_WASHER_IDOS2,
  73                 getAndUpdateProgramOptionsStateDescriptionsAndSelectedProgramStateUpdateHandler());
  74     }
  75
  76     @Override
  77     protected void configureEventHandlers(Map<String, EventHandler> handlers) {
  78         // register default event handlers
  79         handlers.put(EVENT_DOOR_STATE, defaultDoorStateEventHandler());
  80         handlers.put(EVENT_REMOTE_CONTROL_ACTIVE, updateRemoteControlActiveAndProgramOptionsStateEventHandler());
  81         handlers.put(EVENT_REMOTE_CONTROL_START_ALLOWED,
  82                 defaultBooleanEventHandler(CHANNEL_REMOTE_START_ALLOWANCE_STATE));
  83         handlers.put(EVENT_FINISH_IN_RELATIVE, defaultRemainingProgramTimeEventHandler());
  84         handlers.put(EVENT_REMAINING_PROGRAM_TIME, defaultRemainingProgramTimeEventHandler());
  85         handlers.put(EVENT_PROGRAM_PROGRESS, defaultPercentQuantityTypeEventHandler(CHANNEL_PROGRAM_PROGRESS_STATE));
  86         handlers.put(EVENT_LOCAL_CONTROL_ACTIVE, defaultBooleanEventHandler(CHANNEL_LOCAL_CONTROL_ACTIVE_STATE));
  87         handlers.put(EVENT_ACTIVE_PROGRAM, defaultActiveProgramEventHandler());
  88         handlers.put(EVENT_OPERATION_STATE, defaultOperationStateEventHandler());
  89         handlers.put(EVENT_SELECTED_PROGRAM, updateProgramOptionsAndSelectedProgramStateEventHandler());
  90
  91         // register washer specific event handlers
  92         handlers.put(EVENT_WASHER_TEMPERATURE,
  93                 event -> getThingChannel(CHANNEL_WASHER_TEMPERATURE).ifPresent(channel -> updateState(channel.getUID(),
  94                         event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
  95         handlers.put(EVENT_WASHER_SPIN_SPEED,
  96                 event -> getThingChannel(CHANNEL_WASHER_SPIN_SPEED).ifPresent(channel -> updateState(channel.getUID(),
  97                         event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
  98         handlers.put(EVENT_WASHER_IDOS_1_DOSING_LEVEL,
  99                 event -> getThingChannel(CHANNEL_WASHER_IDOS1).ifPresent(channel -> updateState(channel.getUID(),
 100                         event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
 101         handlers.put(EVENT_WASHER_IDOS_2_DOSING_LEVEL,
 102                 event -> getThingChannel(CHANNEL_WASHER_IDOS2).ifPresent(channel -> updateState(channel.getUID(),
 103                         event.getValue() == null ? UnDefType.UNDEF : new StringType(event.getValue()))));
 104     }
 105
 106     @Override
 107     protected void handleCommand(final ChannelUID channelUID, final Command command,
 108             final HomeConnectApiClient apiClient)
 109             throws CommunicationException, AuthorizationException, ApplianceOfflineException {
 110         super.handleCommand(channelUID, command, apiClient);
 111         String operationState = getOperationState();
 112
 113         // only handle these commands if operation state allows it
 114         if (operationState != null && INACTIVE_STATE.contains(operationState) && command instanceof StringType) {
 115             switch (channelUID.getId()) {
 116                 case CHANNEL_WASHER_TEMPERATURE:
 117                     apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_TEMPERATURE, command.toFullString(), null,
 118                             false, false);
 119                     break;
 120                 case CHANNEL_WASHER_SPIN_SPEED:
 121                     apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_SPIN_SPEED, command.toFullString(), null,
 122                             false, false);
 123                     break;
 124                 case CHANNEL_WASHER_IDOS1:
 125                     apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_IDOS_1_DOSING_LEVEL,
 126                             command.toFullString(), null, false, false);
 127                     break;
 128                 case CHANNEL_WASHER_IDOS2:
 129                     apiClient.setProgramOptions(getThingHaId(), OPTION_WASHER_IDOS_2_DOSING_LEVEL,
 130                             command.toFullString(), null, false, false);
 131                     break;
 132             }
 133         } else {
 134             logger.debug("Device can not handle command {} in current operation state ({}). haId={}", command,
 135                     operationState, getThingHaId());
 136         }
 137     }
 138
 139     @Override
 140     public String toString() {
 141         return "HomeConnectWasherHandler [haId: " + getThingHaId() + "]";
 142     }
 143
 144     @Override
 145     protected void resetProgramStateChannels(boolean offline) {
 146         super.resetProgramStateChannels(offline);
 147         getThingChannel(CHANNEL_REMAINING_PROGRAM_TIME_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 148         getThingChannel(CHANNEL_PROGRAM_PROGRESS_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 149         getThingChannel(CHANNEL_ACTIVE_PROGRAM_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 150         if (offline) {
 151             getThingChannel(CHANNEL_WASHER_TEMPERATURE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 152             getThingChannel(CHANNEL_WASHER_SPIN_SPEED).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 153             getThingChannel(CHANNEL_WASHER_IDOS1).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 154             getThingChannel(CHANNEL_WASHER_IDOS2).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
 155         }
 156     }
 157 }