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 washing machines
  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, UoM for temperatures, raw channels
  45  */
  46 @NonNullByDefault
  47 public enum WashingMachineChannelSelector 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_WASHING_MACHINE_TEXT_PREFIX);
  63         }
  64     },
  65     PROGRAM("", PROGRAM_CHANNEL_ID, DecimalType.class, false, false),
  66     PROGRAMTYPE("programType", "type", StringType.class, false, false),
  67     PROGRAM_PHASE_TEXT(PHASE_PROPERTY_NAME, PHASE_TEXT_CHANNEL_ID, StringType.class, false, false) {
  68         @Override
  69         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
  70             return DeviceUtil.getTextState(s, dmd, translationProvider, PHASES, MISSING_PHASE_TEXT_PREFIX,
  71                     MIELE_WASHING_MACHINE_TEXT_PREFIX);
  72         }
  73     },
  74     PROGRAM_PHASE(RAW_PHASE_PROPERTY_NAME, PHASE_CHANNEL_ID, DecimalType.class, false, false),
  75     START_TIME("", START_CHANNEL_ID, DateTimeType.class, false, false),
  76     END_TIME("", END_CHANNEL_ID, DateTimeType.class, false, false),
  77     DURATION("duration", "duration", QuantityType.class, false, false) {
  78         @Override
  79         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
  80             try {
  81                 return new QuantityType<>(Long.valueOf(s), Units.MINUTE);
  82             } catch (NumberFormatException e) {
  83                 return UnDefType.UNDEF;
  84             }
  85         }
  86     },
  87     ELAPSED_TIME("elapsedTime", "elapsed", QuantityType.class, false, false) {
  88         @Override
  89         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
  90             try {
  91                 return new QuantityType<>(Long.valueOf(s), Units.MINUTE);
  92             } catch (NumberFormatException e) {
  93                 return UnDefType.UNDEF;
  94             }
  95         }
  96     },
  97     FINISH_TIME("", FINISH_CHANNEL_ID, QuantityType.class, false, false),
  98     TARGET_TEMP("targetTemperature", "target", QuantityType.class, false, false) {
  99         @Override
 100         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
 101             return getTemperatureState(s);
 102         }
 103     },
 104     SPINNING_SPEED("spinningSpeed", "spinningspeed", StringType.class, false, false) {
 105         @Override
 106         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
 107             if ("0".equals(s)) {
 108                 return getState("Without spinning");
 109             }
 110             if ("256".equals(s)) {
 111                 return getState("Rinsing");
 112             }
 113             return getState(Integer.toString((Integer.valueOf(s))));
 114         }
 115     },
 116     DOOR("signalDoor", "door", OpenClosedType.class, false, 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     SWITCH("", "switch", OnOffType.class, false, false),
 131     ENERGY_CONSUMPTION(EXTENDED_DEVICE_STATE_PROPERTY_NAME, ENERGY_CONSUMPTION_CHANNEL_ID, QuantityType.class, false,
 132             true),
 133     WATER_CONSUMPTION(EXTENDED_DEVICE_STATE_PROPERTY_NAME, WATER_CONSUMPTION_CHANNEL_ID, QuantityType.class, false,
 134             true);
 135
 136     private final Logger logger = LoggerFactory.getLogger(WashingMachineChannelSelector.class);
 137
 138     private static final Map<String, String> PROGRAMS = Map.ofEntries(entry("1", "cottons"), entry("3", "minimum-iron"),
 139             entry("4", "delicates"), entry("8", "woollens"), entry("9", "silks"), entry("17", "starch"),
 140             entry("18", "rinse"), entry("21", "drain-spin"), entry("22", "curtains"), entry("23", "shirts"),
 141             entry("24", "denim"), entry("27", "proofing"), entry("29", "sportswear"), entry("31", "automatic-plus"),
 142             entry("37", "outerwear"), entry("39", "pillows"), entry("50", "dark-garments"), entry("53", "first-wash"),
 143             entry("75", "steam-care"), entry("76", "freshen-up"), entry("91", "maintenance-wash"),
 144             entry("95", "down-duvets"), entry("122", "express-20"), entry("129", "down-filled-items"),
 145             entry("133", "cottons-eco"), entry("146", "quickpowerwash"), entry("65532", "mix"));
 146
 147     private static final Map<String, String> PHASES = Map.ofEntries(entry("1", "pre-wash"), entry("4", "washing"),
 148             entry("5", "rinses"), entry("7", "clean"), entry("9", "drain"), entry("10", "spin"),
 149             entry("11", "anti-crease"), entry("12", "finished"));
 150
 151     private final String mieleID;
 152     private final String channelID;
 153     private final Class<? extends Type> typeClass;
 154     private final boolean isProperty;
 155     private final boolean isExtendedState;
 156
 157     WashingMachineChannelSelector(String propertyID, String channelID, Class<? extends Type> typeClass,
 158             boolean isProperty, boolean isExtendedState) {
 159         this.mieleID = propertyID;
 160         this.channelID = channelID;
 161         this.typeClass = typeClass;
 162         this.isProperty = isProperty;
 163         this.isExtendedState = isExtendedState;
 164     }
 165
 166     @Override
 167     public String toString() {
 168         return mieleID;
 169     }
 170
 171     @Override
 172     public String getMieleID() {
 173         return mieleID;
 174     }
 175
 176     @Override
 177     public String getChannelID() {
 178         return channelID;
 179     }
 180
 181     @Override
 182     public boolean isProperty() {
 183         return isProperty;
 184     }
 185
 186     @Override
 187     public boolean isExtendedState() {
 188         return isExtendedState;
 189     }
 190
 191     @Override
 192     public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
 193         return this.getState(s, dmd);
 194     }
 195
 196     @Override
 197     public State getState(String s, @Nullable DeviceMetaData dmd) {
 198         if (dmd != null) {
 199             String localizedValue = dmd.getMieleEnum(s);
 200             if (localizedValue == null) {
 201                 localizedValue = dmd.LocalizedValue;
 202             }
 203             if (localizedValue == null) {
 204                 localizedValue = s;
 205             }
 206
 207             return getState(localizedValue);
 208         } else {
 209             return getState(s);
 210         }
 211     }
 212
 213     @Override
 214     public State getState(String s) {
 215         try {
 216             Method valueOf = typeClass.getMethod("valueOf", String.class);
 217             State state = (State) valueOf.invoke(typeClass, s);
 218             if (state != null) {
 219                 return state;
 220             }
 221         } catch (Exception e) {
 222             logger.warn("An exception occurred while converting '{}' into a State", s);
 223         }
 224
 225         return UnDefType.UNDEF;
 226     }
 227
 228     public State getTemperatureState(String s) {
 229         try {
 230             return DeviceUtil.getTemperatureState(s);
 231         } catch (NumberFormatException e) {
 232             logger.warn("An exception occurred while converting '{}' into a State", s);
 233             return UnDefType.UNDEF;
 234         }
 235     }
 236 }