2 * Copyright (c) 2010-2023 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.*;
19 import org.eclipse.jdt.annotation.NonNullByDefault;
20 import org.openhab.binding.homeconnect.internal.client.HomeConnectApiClient;
21 import org.openhab.binding.homeconnect.internal.client.exception.ApplianceOfflineException;
22 import org.openhab.binding.homeconnect.internal.client.exception.AuthorizationException;
23 import org.openhab.binding.homeconnect.internal.client.exception.CommunicationException;
24 import org.openhab.binding.homeconnect.internal.type.HomeConnectDynamicStateDescriptionProvider;
25 import org.openhab.core.thing.ChannelUID;
26 import org.openhab.core.thing.Thing;
27 import org.openhab.core.types.Command;
28 import org.openhab.core.types.UnDefType;
31 * The {@link HomeConnectDishwasherHandler} is responsible for handling commands, which are
32 * sent to one of the channels of a dishwasher.
34 * @author Jonas BrĂ¼stel - Initial contribution
37 public class HomeConnectDishwasherHandler extends AbstractHomeConnectThingHandler {
39 public HomeConnectDishwasherHandler(Thing thing,
40 HomeConnectDynamicStateDescriptionProvider dynamicStateDescriptionProvider) {
41 super(thing, dynamicStateDescriptionProvider);
45 protected void configureChannelUpdateHandlers(Map<String, ChannelUpdateHandler> handlers) {
46 // register default update handlers
47 handlers.put(CHANNEL_DOOR_STATE, defaultDoorStateChannelUpdateHandler());
48 handlers.put(CHANNEL_POWER_STATE, defaultPowerStateChannelUpdateHandler());
49 handlers.put(CHANNEL_OPERATION_STATE, defaultOperationStateChannelUpdateHandler());
50 handlers.put(CHANNEL_REMOTE_CONTROL_ACTIVE_STATE, defaultRemoteControlActiveStateChannelUpdateHandler());
51 handlers.put(CHANNEL_REMOTE_START_ALLOWANCE_STATE, defaultRemoteStartAllowanceChannelUpdateHandler());
52 handlers.put(CHANNEL_SELECTED_PROGRAM_STATE, defaultSelectedProgramStateUpdateHandler());
53 handlers.put(CHANNEL_ACTIVE_PROGRAM_STATE, defaultActiveProgramStateUpdateHandler());
54 handlers.put(CHANNEL_AMBIENT_LIGHT_STATE, defaultAmbientLightChannelUpdateHandler());
58 protected void configureEventHandlers(Map<String, EventHandler> handlers) {
59 // register default event handlers
60 handlers.put(EVENT_DOOR_STATE, defaultDoorStateEventHandler());
61 handlers.put(EVENT_REMOTE_CONTROL_ACTIVE, defaultBooleanEventHandler(CHANNEL_REMOTE_CONTROL_ACTIVE_STATE));
62 handlers.put(EVENT_REMOTE_CONTROL_START_ALLOWED,
63 defaultBooleanEventHandler(CHANNEL_REMOTE_START_ALLOWANCE_STATE));
64 handlers.put(EVENT_FINISH_IN_RELATIVE, defaultRemainingProgramTimeEventHandler());
65 handlers.put(EVENT_REMAINING_PROGRAM_TIME, defaultRemainingProgramTimeEventHandler());
66 handlers.put(EVENT_PROGRAM_PROGRESS, defaultPercentQuantityTypeEventHandler(CHANNEL_PROGRAM_PROGRESS_STATE));
67 handlers.put(EVENT_SELECTED_PROGRAM, defaultSelectedProgramStateEventHandler());
68 handlers.put(EVENT_ACTIVE_PROGRAM, defaultActiveProgramEventHandler());
69 handlers.put(EVENT_POWER_STATE, defaultPowerStateEventHandler());
70 handlers.put(EVENT_OPERATION_STATE, defaultOperationStateEventHandler());
71 handlers.put(EVENT_AMBIENT_LIGHT_STATE, defaultBooleanEventHandler(CHANNEL_AMBIENT_LIGHT_STATE));
72 handlers.put(EVENT_AMBIENT_LIGHT_BRIGHTNESS_STATE,
73 defaultPercentHandler(CHANNEL_AMBIENT_LIGHT_BRIGHTNESS_STATE));
74 handlers.put(EVENT_AMBIENT_LIGHT_COLOR_STATE, defaultAmbientLightColorStateEventHandler());
75 handlers.put(EVENT_AMBIENT_LIGHT_CUSTOM_COLOR_STATE, defaultAmbientLightCustomColorStateEventHandler());
79 protected void handleCommand(final ChannelUID channelUID, final Command command,
80 final HomeConnectApiClient apiClient)
81 throws CommunicationException, AuthorizationException, ApplianceOfflineException {
82 super.handleCommand(channelUID, command, apiClient);
84 handlePowerCommand(channelUID, command, apiClient, STATE_POWER_OFF);
86 handleLightCommands(channelUID, command, apiClient);
90 public String toString() {
91 return "HomeConnectDishwasherHandler [haId: " + getThingHaId() + "]";
95 protected void resetProgramStateChannels(boolean offline) {
96 super.resetProgramStateChannels(offline);
97 getLinkedChannel(CHANNEL_REMAINING_PROGRAM_TIME_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
98 getLinkedChannel(CHANNEL_PROGRAM_PROGRESS_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));
99 getLinkedChannel(CHANNEL_ACTIVE_PROGRAM_STATE).ifPresent(c -> updateState(c.getUID(), UnDefType.UNDEF));