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     INFO("signalInfo", "info", OnOffType.class, false, false) {
 131         @Override
 132         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
 133             return OnOffType.from("true".equals(s));
 134         }
 135     },
 136     FAILURE("signalFailure", "failure", OnOffType.class, false, false) {
 137         @Override
 138         public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
 139             return OnOffType.from("true".equals(s));
 140         }
 141     },
 142     SWITCH("", "switch", OnOffType.class, false, false),
 143     ENERGY_CONSUMPTION(EXTENDED_DEVICE_STATE_PROPERTY_NAME, ENERGY_CONSUMPTION_CHANNEL_ID, QuantityType.class, false,
 144             true),
 145     WATER_CONSUMPTION(EXTENDED_DEVICE_STATE_PROPERTY_NAME, WATER_CONSUMPTION_CHANNEL_ID, QuantityType.class, false,
 146             true);
 147
 148     private final Logger logger = LoggerFactory.getLogger(WashingMachineChannelSelector.class);
 149
 150     private static final Map<String, String> PROGRAMS = Map.ofEntries(entry("1", "cottons"), entry("3", "minimum-iron"),
 151             entry("4", "delicates"), entry("8", "woollens"), entry("9", "silks"), entry("17", "starch"),
 152             entry("18", "rinse"), entry("21", "drain-spin"), entry("22", "curtains"), entry("23", "shirts"),
 153             entry("24", "denim"), entry("27", "proofing"), entry("29", "sportswear"), entry("31", "automatic-plus"),
 154             entry("37", "outerwear"), entry("39", "pillows"), entry("50", "dark-garments"), entry("53", "first-wash"),
 155             entry("75", "steam-care"), entry("76", "freshen-up"), entry("91", "maintenance-wash"),
 156             entry("95", "down-duvets"), entry("122", "express-20"), entry("129", "down-filled-items"),
 157             entry("133", "cottons-eco"), entry("146", "quickpowerwash"), entry("65532", "mix"));
 158
 159     private static final Map<String, String> PHASES = Map.ofEntries(entry("1", "pre-wash"), entry("4", "washing"),
 160             entry("5", "rinses"), entry("7", "clean"), entry("9", "drain"), entry("10", "spin"),
 161             entry("11", "anti-crease"), entry("12", "finished"));
 162
 163     private final String mieleID;
 164     private final String channelID;
 165     private final Class<? extends Type> typeClass;
 166     private final boolean isProperty;
 167     private final boolean isExtendedState;
 168
 169     WashingMachineChannelSelector(String propertyID, String channelID, Class<? extends Type> typeClass,
 170             boolean isProperty, boolean isExtendedState) {
 171         this.mieleID = propertyID;
 172         this.channelID = channelID;
 173         this.typeClass = typeClass;
 174         this.isProperty = isProperty;
 175         this.isExtendedState = isExtendedState;
 176     }
 177
 178     @Override
 179     public String toString() {
 180         return mieleID;
 181     }
 182
 183     @Override
 184     public String getMieleID() {
 185         return mieleID;
 186     }
 187
 188     @Override
 189     public String getChannelID() {
 190         return channelID;
 191     }
 192
 193     @Override
 194     public boolean isProperty() {
 195         return isProperty;
 196     }
 197
 198     @Override
 199     public boolean isExtendedState() {
 200         return isExtendedState;
 201     }
 202
 203     @Override
 204     public State getState(String s, @Nullable DeviceMetaData dmd, MieleTranslationProvider translationProvider) {
 205         return this.getState(s, dmd);
 206     }
 207
 208     @Override
 209     public State getState(String s, @Nullable DeviceMetaData dmd) {
 210         if (dmd != null) {
 211             String localizedValue = dmd.getMieleEnum(s);
 212             if (localizedValue == null) {
 213                 localizedValue = dmd.LocalizedValue;
 214             }
 215             if (localizedValue == null) {
 216                 localizedValue = s;
 217             }
 218
 219             return getState(localizedValue);
 220         } else {
 221             return getState(s);
 222         }
 223     }
 224
 225     @Override
 226     public State getState(String s) {
 227         try {
 228             Method valueOf = typeClass.getMethod("valueOf", String.class);
 229             State state = (State) valueOf.invoke(typeClass, s);
 230             if (state != null) {
 231                 return state;
 232             }
 233         } catch (Exception e) {
 234             logger.warn("An exception occurred while converting '{}' into a State", s);
 235         }
 236
 237         return UnDefType.UNDEF;
 238     }
 239
 240     public State getTemperatureState(String s) {
 241         try {
 242             return DeviceUtil.getTemperatureState(s);
 243         } catch (NumberFormatException e) {
 244             logger.warn("An exception occurred while converting '{}' into a State", s);
 245             return UnDefType.UNDEF;
 246         }
 247     }
 248 }