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.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 ovens
  41  *
  42  * @author Karel Goderis - Initial contribution
  43  * @author Kai Kreuzer - Changed START_TIME to DateTimeType
  44  * @author Jacob Laursen - Added UoM for temperatures, raw channels
  45  */
  46 @NonNullByDefault
  47 public enum OvenChannelSelector implements ApplianceChannelSelector {
  48
  49     PRODUCT_TYPE("productTypeId", "productType", StringType.class, true),
  50     DEVICE_TYPE("mieleDeviceType", "deviceType", StringType.class, true),
  51     STATE_TEXT(STATE_PROPERTY_NAME, STATE_TEXT_CHANNEL_ID, StringType.class, 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),
  58     PROGRAM_TEXT(PROGRAM_ID_PROPERTY_NAME, PROGRAM_TEXT_CHANNEL_ID, StringType.class, false),
  59     PROGRAM("", PROGRAM_CHANNEL_ID, DecimalType.class, false),
  60     PROGRAMTYPE("programType", "type", StringType.class, false),
  61     PROGRAM_PHASE_TEXT(PHASE_PROPERTY_NAME, PHASE_TEXT_CHANNEL_ID, StringType.class, false) {
  62         @Override
  63         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
  64             return DeviceUtil.getTextState(s, dmd, translationProvider, PHASES, MISSING_PHASE_TEXT_PREFIX,
  65                     MIELE_OVEN_TEXT_PREFIX);
  66         }
  67     },
  68     PROGRAM_PHASE(RAW_PHASE_PROPERTY_NAME, PHASE_CHANNEL_ID, DecimalType.class, false),
  69     START_TIME("", START_CHANNEL_ID, DateTimeType.class, false),
  70     END_TIME("", END_CHANNEL_ID, DateTimeType.class, false),
  71     DURATION("duration", "duration", QuantityType.class, false) {
  72         @Override
  73         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
  74             try {
  75                 return new QuantityType<>(Long.valueOf(s), Units.MINUTE);
  76             } catch (NumberFormatException e) {
  77                 return UnDefType.UNDEF;
  78             }
  79         }
  80     },
  81     ELAPSED_TIME("elapsedTime", "elapsed", QuantityType.class, false) {
  82         @Override
  83         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
  84             try {
  85                 return new QuantityType<>(Long.valueOf(s), Units.MINUTE);
  86             } catch (NumberFormatException e) {
  87                 return UnDefType.UNDEF;
  88             }
  89         }
  90     },
  91     FINISH_TIME("", FINISH_CHANNEL_ID, QuantityType.class, false),
  92     TARGET_TEMP("targetTemperature", "target", QuantityType.class, false) {
  93         @Override
  94         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
  95             return getTemperatureState(s);
  96         }
  97     },
  98     MEASURED_TEMP("measuredTemperature", "measured", QuantityType.class, false) {
  99         @Override
 100         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
 101             return getTemperatureState(s);
 102         }
 103     },
 104     DEVICE_TEMP_ONE("deviceTemperature1", "temp1", QuantityType.class, false) {
 105         @Override
 106         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
 107             return getTemperatureState(s);
 108         }
 109     },
 110     DEVICE_TEMP_TWO("deviceTemperature2", "temp2", QuantityType.class, false) {
 111         @Override
 112         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
 113             return getTemperatureState(s);
 114         }
 115     },
 116     DOOR("signalDoor", "door", OpenClosedType.class, false) {
 117         @Override
 118         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
 119             if ("true".equals(s)) {
 120                 return getState("OPEN");
 121             }
 122
 123             if ("false".equals(s)) {
 124                 return getState("CLOSED");
 125             }
 126
 127             return UnDefType.UNDEF;
 128         }
 129     },
 130     STOP("", "stop", OnOffType.class, false),
 131     SWITCH("", "switch", OnOffType.class, false);
 132
 133     private final Logger logger = LoggerFactory.getLogger(OvenChannelSelector.class);
 134
 135     private static final Map<String, String> PHASES = Map.ofEntries(entry("1", "heating"), entry("2", "temp-hold"),
 136             entry("3", "door-open"), entry("4", "pyrolysis"), entry("7", "lighting"), entry("8", "searing-phase"),
 137             entry("10", "defrost"), entry("11", "cooling-down"), entry("12", "energy-save-phase"));
 138
 139     private final String mieleID;
 140     private final String channelID;
 141     private final Class<? extends Type> typeClass;
 142     private final boolean isProperty;
 143
 144     OvenChannelSelector(String propertyID, String channelID, Class<? extends Type> typeClass, boolean isProperty) {
 145         this.mieleID = propertyID;
 146         this.channelID = channelID;
 147         this.typeClass = typeClass;
 148         this.isProperty = isProperty;
 149     }
 150
 151     @Override
 152     public String toString() {
 153         return mieleID;
 154     }
 155
 156     @Override
 157     public String getMieleID() {
 158         return mieleID;
 159     }
 160
 161     @Override
 162     public String getChannelID() {
 163         return channelID;
 164     }
 165
 166     @Override
 167     public boolean isProperty() {
 168         return isProperty;
 169     }
 170
 171     @Override
 172     public boolean isExtendedState() {
 173         return false;
 174     }
 175
 176     @Override
 177     public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
 178         return this.getState(s, dmd);
 179     }
 180
 181     @Override
 182     public State getState(String s, @Nullable DeviceMetaData dmd) {
 183         if (dmd != null) {
 184             String localizedValue = dmd.getMieleEnum(s);
 185             if (localizedValue == null) {
 186                 localizedValue = dmd.LocalizedValue;
 187             }
 188             if (localizedValue == null) {
 189                 localizedValue = s;
 190             }
 191
 192             return getState(localizedValue);
 193         } else {
 194             return getState(s);
 195         }
 196     }
 197
 198     @Override
 199     public State getState(String s) {
 200         try {
 201             Method valueOf = typeClass.getMethod("valueOf", String.class);
 202             State state = (State) valueOf.invoke(typeClass, s);
 203             if (state != null) {
 204                 return state;
 205             }
 206         } catch (Exception e) {
 207             logger.warn("An exception occurred while converting '{}' into a State", s);
 208         }
 209
 210         return UnDefType.UNDEF;
 211     }
 212
 213     public State getTemperatureState(String s) {
 214         try {
 215             return DeviceUtil.getTemperatureState(s);
 216         } catch (NumberFormatException e) {
 217             logger.warn("An exception occurred while converting '{}' into a State", s);
 218             return UnDefType.UNDEF;
 219         }
 220     }
 221 }