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

   1 /**
   2  * Copyright (c) 2010-2024 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.miele.internal.handler;
  14
  15 import static java.util.Map.entry;
  16 import static org.openhab.binding.miele.internal.MieleBindingConstants.*;
  17
  18 import java.lang.reflect.Method;
  19 import java.util.Map;
  20
  21 import org.eclipse.jdt.annotation.NonNullByDefault;
  22 import org.eclipse.jdt.annotation.Nullable;
  23 import org.openhab.binding.miele.internal.DeviceUtil;
  24 import org.openhab.binding.miele.internal.MieleTranslationProvider;
  25 import org.openhab.binding.miele.internal.api.dto.DeviceMetaData;
  26 import org.openhab.core.library.types.DateTimeType;
  27 import org.openhab.core.library.types.DecimalType;
  28 import org.openhab.core.library.types.OnOffType;
  29 import org.openhab.core.library.types.OpenClosedType;
  30 import org.openhab.core.library.types.QuantityType;
  31 import org.openhab.core.library.types.StringType;
  32 import org.openhab.core.library.unit.Units;
  33 import org.openhab.core.types.State;
  34 import org.openhab.core.types.Type;
  35 import org.openhab.core.types.UnDefType;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * The {@link ApplianceChannelSelector} for dishwashers
  41  *
  42  * @author Karel Goderis - Initial contribution
  43  * @author Kai Kreuzer - Changed START_TIME to DateTimeType
  44  * @author Jacob Laursen - Added power/water consumption channels, raw channels
  45  */
  46 @NonNullByDefault
  47 public enum DishwasherChannelSelector implements ApplianceChannelSelector {
  48
  49     PRODUCT_TYPE("productTypeId", "productType", StringType.class, true, false),
  50     DEVICE_TYPE("mieleDeviceType", "deviceType", StringType.class, true, false),
  51     STATE_TEXT(STATE_PROPERTY_NAME, STATE_TEXT_CHANNEL_ID, StringType.class, false, false) {
  52         @Override
  53         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
  54             return DeviceUtil.getStateTextState(s, dmd, translationProvider);
  55         }
  56     },
  57     STATE("", STATE_CHANNEL_ID, DecimalType.class, false, false),
  58     PROGRAM_TEXT(PROGRAM_ID_PROPERTY_NAME, PROGRAM_TEXT_CHANNEL_ID, StringType.class, false, false) {
  59         @Override
  60         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
  61             return DeviceUtil.getTextState(s, dmd, translationProvider, PROGRAMS, MISSING_PROGRAM_TEXT_PREFIX,
  62                     MIELE_DISHWASHER_TEXT_PREFIX);
  63         }
  64     },
  65     PROGRAM("", PROGRAM_CHANNEL_ID, DecimalType.class, false, false),
  66     PROGRAM_PHASE_TEXT(PHASE_PROPERTY_NAME, PHASE_TEXT_CHANNEL_ID, StringType.class, false, false) {
  67         @Override
  68         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
  69             return DeviceUtil.getTextState(s, dmd, translationProvider, PHASES, MISSING_PHASE_TEXT_PREFIX,
  70                     MIELE_DISHWASHER_TEXT_PREFIX);
  71         }
  72     },
  73     PROGRAM_PHASE(RAW_PHASE_PROPERTY_NAME, PHASE_CHANNEL_ID, DecimalType.class, false, false),
  74     START_TIME("", START_CHANNEL_ID, DateTimeType.class, false, false),
  75     END_TIME("", END_CHANNEL_ID, DateTimeType.class, false, false),
  76     DURATION("duration", "duration", QuantityType.class, false, false) {
  77         @Override
  78         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
  79             try {
  80                 return new QuantityType<>(Long.valueOf(s), Units.MINUTE);
  81             } catch (NumberFormatException e) {
  82                 return UnDefType.UNDEF;
  83             }
  84         }
  85     },
  86     ELAPSED_TIME("elapsedTime", "elapsed", QuantityType.class, false, false) {
  87         @Override
  88         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
  89             try {
  90                 return new QuantityType<>(Long.valueOf(s), Units.MINUTE);
  91             } catch (NumberFormatException e) {
  92                 return UnDefType.UNDEF;
  93             }
  94         }
  95     },
  96     FINISH_TIME("", FINISH_CHANNEL_ID, QuantityType.class, false, false),
  97     DOOR("signalDoor", "door", OpenClosedType.class, false, false) {
  98         @Override
  99         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
 100             if ("true".equals(s)) {
 101                 return getState("OPEN");
 102             }
 103
 104             if ("false".equals(s)) {
 105                 return getState("CLOSED");
 106             }
 107
 108             return UnDefType.UNDEF;
 109         }
 110     },
 111     SWITCH("", "switch", OnOffType.class, false, false),
 112     ENERGY_CONSUMPTION(EXTENDED_DEVICE_STATE_PROPERTY_NAME, ENERGY_CONSUMPTION_CHANNEL_ID, QuantityType.class, false,
 113             true),
 114     WATER_CONSUMPTION(EXTENDED_DEVICE_STATE_PROPERTY_NAME, WATER_CONSUMPTION_CHANNEL_ID, QuantityType.class, false,
 115             true);
 116
 117     private final Logger logger = LoggerFactory.getLogger(DishwasherChannelSelector.class);
 118
 119     private static final Map<String, String> PROGRAMS = Map.ofEntries(entry("26", "intensive"),
 120             entry("27", "maintenance-programme"), entry("28", "eco"), entry("30", "normal"), entry("32", "automatic"),
 121             entry("34", "solarsave"), entry("35", "gentle"), entry("36", "extra-quiet"), entry("37", "hygiene"),
 122             entry("38", "quickpowerwash"), entry("42", "tall-items"));
 123
 124     private static final Map<String, String> PHASES = Map.ofEntries(entry("2", "pre-wash"), entry("3", "main-wash"),
 125             entry("4", "rinses"), entry("6", "final-rinse"), entry("7", "drying"), entry("8", "finished"));
 126
 127     private final String mieleID;
 128     private final String channelID;
 129     private final Class<? extends Type> typeClass;
 130     private final boolean isProperty;
 131     private final boolean isExtendedState;
 132
 133     DishwasherChannelSelector(String propertyID, String channelID, Class<? extends Type> typeClass, boolean isProperty,
 134             boolean isExtendedState) {
 135         this.mieleID = propertyID;
 136         this.channelID = channelID;
 137         this.typeClass = typeClass;
 138         this.isProperty = isProperty;
 139         this.isExtendedState = isExtendedState;
 140     }
 141
 142     @Override
 143     public String toString() {
 144         return mieleID;
 145     }
 146
 147     @Override
 148     public String getMieleID() {
 149         return mieleID;
 150     }
 151
 152     @Override
 153     public String getChannelID() {
 154         return channelID;
 155     }
 156
 157     @Override
 158     public boolean isProperty() {
 159         return isProperty;
 160     }
 161
 162     @Override
 163     public boolean isExtendedState() {
 164         return isExtendedState;
 165     }
 166
 167     @Override
 168     public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
 169         return this.getState(s, dmd);
 170     }
 171
 172     @Override
 173     public State getState(String s, @Nullable DeviceMetaData dmd) {
 174         if (dmd != null) {
 175             String localizedValue = dmd.getMieleEnum(s);
 176             if (localizedValue == null) {
 177                 localizedValue = dmd.LocalizedValue;
 178             }
 179             if (localizedValue == null) {
 180                 localizedValue = s;
 181             }
 182
 183             return getState(localizedValue);
 184         } else {
 185             return getState(s);
 186         }
 187     }
 188
 189     @Override
 190     public State getState(String s) {
 191         try {
 192             Method valueOf = typeClass.getMethod("valueOf", String.class);
 193             State state = (State) valueOf.invoke(typeClass, s);
 194             if (state != null) {
 195                 return state;
 196             }
 197         } catch (Exception e) {
 198             logger.warn("An exception occurred while converting '{}' into a State", s);
 199         }
 200
 201         return UnDefType.UNDEF;
 202     }
 203 }