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

   1 /**
   2  * Copyright (c) 2010-2022 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.shelly.internal.api;
  14
  15 import static org.openhab.binding.shelly.internal.ShellyBindingConstants.*;
  16 import static org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.*;
  17 import static org.openhab.binding.shelly.internal.discovery.ShellyThingCreator.*;
  18 import static org.openhab.binding.shelly.internal.util.ShellyUtils.*;
  19
  20 import java.util.HashMap;
  21 import java.util.Map;
  22 import java.util.regex.Matcher;
  23 import java.util.regex.Pattern;
  24
  25 import org.eclipse.jdt.annotation.NonNullByDefault;
  26 import org.eclipse.jdt.annotation.Nullable;
  27 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsDimmer;
  28 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsGlobal;
  29 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsInput;
  30 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsRelay;
  31 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsRgbwLight;
  32 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsStatus;
  33 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyThermnostat;
  34 import org.openhab.binding.shelly.internal.util.ShellyVersionDTO;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 import com.google.gson.Gson;
  39
  40 /**
  41  * The {@link ShellyDeviceProfile} creates a device profile based on the settings returned from the API's /settings
  42  * call. This is used to be more dynamic in controlling the device, but also to overcome some issues in the API (e.g.
  43  * RGBW2 returns "no meter" even it has one)
  44  *
  45  * @author Markus Michels - Initial contribution
  46  */
  47 @NonNullByDefault
  48 public class ShellyDeviceProfile {
  49     private final Logger logger = LoggerFactory.getLogger(ShellyDeviceProfile.class);
  50     private static final Pattern VERSION_PATTERN = Pattern.compile("v\\d+\\.\\d+\\.\\d+(-[a-z0-9]*)?");
  51
  52     public boolean initialized = false; // true when initialized
  53
  54     public String thingName = "";
  55     public String deviceType = "";
  56     public boolean extFeatures = false;
  57
  58     public String settingsJson = "";
  59     public ShellySettingsGlobal settings = new ShellySettingsGlobal();
  60     public ShellySettingsStatus status = new ShellySettingsStatus();
  61
  62     public String hostname = "";
  63     public String name = "";
  64     public String model = "";
  65     public String mode = "";
  66     public boolean discoverable = true;
  67     public boolean auth = false;
  68     public boolean alwaysOn = true;
  69     public boolean isGen2 = false;
  70
  71     public String hwRev = "";
  72     public String hwBatchId = "";
  73     public String mac = "";
  74     public String fwVersion = "";
  75     public String fwDate = "";
  76
  77     public boolean hasRelays = false; // true if it has at least 1 power meter
  78     public int numRelays = 0; // number of relays/outputs
  79     public int numRollers = 0; // number of Rollers, usually 1
  80     public boolean isRoller = false; // true for Shelly2 in roller mode
  81     public boolean isDimmer = false; // true for a Shelly Dimmer (SHDM-1)
  82     public int numInputs = 0; // number of inputs
  83
  84     public int numMeters = 0;
  85     public boolean isEMeter = false; // true for ShellyEM/3EM
  86
  87     public boolean isLight = false; // true if it is a Shelly Bulb/RGBW2
  88     public boolean isBulb = false; // true only if it is a Bulb
  89     public boolean isDuo = false; // true only if it is a Duo
  90     public boolean isRGBW2 = false; // true only if it a a RGBW2
  91     public boolean inColor = false; // true if bulb/rgbw2 is in color mode
  92
  93     public boolean isSensor = false; // true for HT & Smoke
  94     public boolean hasBattery = false; // true if battery device
  95     public boolean isSense = false; // true if thing is a Shelly Sense
  96     public boolean isMotion = false; // true if thing is a Shelly Sense
  97     public boolean isHT = false; // true for H&T
  98     public boolean isDW = false; // true for Door Window sensor
  99     public boolean isButton = false; // true for a Shelly Button 1
 100     public boolean isIX = false; // true for a Shelly IX
 101     public boolean isTRV = false; // true for a Shelly TRV
 102
 103     public int minTemp = 0; // Bulb/Duo: Min Light Temp
 104     public int maxTemp = 0; // Bulb/Duo: Max Light Temp
 105
 106     public int updatePeriod = 2 * UPDATE_SETTINGS_INTERVAL_SECONDS + 10;
 107
 108     public String coiotEndpoint = "";
 109
 110     public Map<String, String> irCodes = new HashMap<>(); // Sense: list of stored IR codes
 111
 112     public ShellyDeviceProfile() {
 113     }
 114
 115     public ShellyDeviceProfile initialize(String thingType, String json) throws ShellyApiException {
 116         Gson gson = new Gson();
 117
 118         initialized = false;
 119
 120         initFromThingType(thingType);
 121         settingsJson = json;
 122         ShellySettingsGlobal gs = fromJson(gson, json, ShellySettingsGlobal.class);
 123         settings = gs; // only update when no exception
 124
 125         // General settings
 126         name = getString(settings.name);
 127         deviceType = getString(settings.device.type);
 128         mac = getString(settings.device.mac);
 129         hostname = settings.device.hostname != null && !settings.device.hostname.isEmpty()
 130                 ? settings.device.hostname.toLowerCase()
 131                 : "shelly-" + mac.toUpperCase().substring(6, 11);
 132         mode = getString(settings.mode).toLowerCase();
 133         hwRev = settings.hwinfo != null ? getString(settings.hwinfo.hwRevision) : "";
 134         hwBatchId = settings.hwinfo != null ? getString(settings.hwinfo.batchId.toString()) : "";
 135         fwDate = substringBefore(settings.fw, "/");
 136         fwVersion = extractFwVersion(settings.fw);
 137         ShellyVersionDTO version = new ShellyVersionDTO();
 138         extFeatures = version.compare(fwVersion, SHELLY_API_FW_110) >= 0;
 139         discoverable = (settings.discoverable == null) || settings.discoverable;
 140
 141         isRoller = mode.equalsIgnoreCase(SHELLY_MODE_ROLLER);
 142         inColor = isLight && mode.equalsIgnoreCase(SHELLY_MODE_COLOR);
 143
 144         numRelays = !isLight ? getInteger(settings.device.numOutputs) : 0;
 145         if ((numRelays > 0) && (settings.relays == null)) {
 146             numRelays = 0;
 147         }
 148         hasRelays = (numRelays > 0) || isDimmer;
 149         numRollers = getInteger(settings.device.numRollers);
 150         numInputs = settings.inputs != null ? settings.inputs.size() : hasRelays ? isRoller ? 2 : 1 : 0;
 151
 152         isEMeter = settings.emeters != null;
 153         numMeters = !isEMeter ? getInteger(settings.device.numMeters) : getInteger(settings.device.numEMeters);
 154         if ((numMeters == 0) && isLight) {
 155             // RGBW2 doesn't report, but has one
 156             numMeters = inColor ? 1 : getInteger(settings.device.numOutputs);
 157         }
 158
 159         initialized = true;
 160         return this;
 161     }
 162
 163     public boolean containsEventUrl(String eventType) {
 164         return containsEventUrl(settingsJson, eventType);
 165     }
 166
 167     public boolean containsEventUrl(String json, String eventType) {
 168         String settings = json.toLowerCase();
 169         return settings.contains((eventType + SHELLY_EVENTURL_SUFFIX).toLowerCase());
 170     }
 171
 172     public boolean isInitialized() {
 173         return initialized;
 174     }
 175
 176     public void initFromThingType(String name) {
 177         String thingType = (name.contains("-") ? substringBefore(name, "-") : name).toLowerCase().trim();
 178         if (thingType.isEmpty()) {
 179             return;
 180         }
 181
 182         isDimmer = deviceType.equalsIgnoreCase(SHELLYDT_DIMMER) || deviceType.equalsIgnoreCase(SHELLYDT_DIMMER2);
 183         isBulb = thingType.equals(THING_TYPE_SHELLYBULB_STR);
 184         isDuo = thingType.equals(THING_TYPE_SHELLYDUO_STR) || thingType.equals(THING_TYPE_SHELLYVINTAGE_STR)
 185                 || thingType.equals(THING_TYPE_SHELLYDUORGBW_STR);
 186         isRGBW2 = thingType.startsWith(THING_TYPE_SHELLYRGBW2_PREFIX);
 187         isLight = isBulb || isDuo || isRGBW2;
 188         if (isLight) {
 189             minTemp = isBulb ? MIN_COLOR_TEMP_BULB : MIN_COLOR_TEMP_DUO;
 190             maxTemp = isBulb ? MAX_COLOR_TEMP_BULB : MAX_COLOR_TEMP_DUO;
 191         }
 192
 193         boolean isFlood = thingType.equals(THING_TYPE_SHELLYFLOOD_STR);
 194         boolean isSmoke = thingType.equals(THING_TYPE_SHELLYSMOKE_STR);
 195         boolean isGas = thingType.equals(THING_TYPE_SHELLYGAS_STR);
 196         boolean isUNI = thingType.equals(THING_TYPE_SHELLYUNI_STR);
 197         isHT = thingType.equals(THING_TYPE_SHELLYHT_STR) || thingType.equals(THING_TYPE_SHELLYPLUSHT_STR);
 198         isDW = thingType.equals(THING_TYPE_SHELLYDOORWIN_STR) || thingType.equals(THING_TYPE_SHELLYDOORWIN2_STR);
 199         isMotion = thingType.startsWith(THING_TYPE_SHELLYMOTION_STR);
 200         isSense = thingType.equals(THING_TYPE_SHELLYSENSE_STR);
 201         isIX = thingType.equals(THING_TYPE_SHELLYIX3_STR) || thingType.equals(THING_TYPE_SHELLYPLUSI4_STR)
 202                 || thingType.equals(THING_TYPE_SHELLYPLUSI4DC_STR);
 203         isButton = thingType.equals(THING_TYPE_SHELLYBUTTON1_STR) || thingType.equals(THING_TYPE_SHELLYBUTTON2_STR);
 204         isSensor = isHT || isFlood || isDW || isSmoke || isGas || isButton || isUNI || isMotion || isSense || isTRV;
 205         hasBattery = isHT || isFlood || isDW || isSmoke || isButton || isMotion || isTRV;
 206         isTRV = thingType.equals(THING_TYPE_SHELLYTRV_STR);
 207
 208         alwaysOn = !hasBattery || isMotion || isSense; // true means: device is reachable all the time (no sleep mode)
 209     }
 210
 211     public void updateFromStatus(ShellySettingsStatus status) {
 212         if (hasRelays) {
 213             // Dimmer-2 doesn't report inputs under /settings, only on /status, we need to update that info after init
 214             if (status.inputs != null) {
 215                 numInputs = status.inputs.size();
 216             }
 217         } else if (status.input != null) {
 218             // RGBW2
 219             numInputs = 1;
 220         }
 221     }
 222
 223     public String getControlGroup(int i) {
 224         if (i < 0) {
 225             logger.debug("{}: Invalid index {} for getControlGroup()", thingName, i);
 226             return "";
 227         }
 228         int idx = i + 1;
 229         if (isDimmer) {
 230             return CHANNEL_GROUP_DIMMER_CONTROL;
 231         } else if (isRoller) {
 232             return numRollers <= 1 ? CHANNEL_GROUP_ROL_CONTROL : CHANNEL_GROUP_ROL_CONTROL + idx;
 233         } else if (isDimmer) {
 234             return CHANNEL_GROUP_RELAY_CONTROL;
 235         } else if (hasRelays) {
 236             return numRelays <= 1 ? CHANNEL_GROUP_RELAY_CONTROL : CHANNEL_GROUP_RELAY_CONTROL + idx;
 237         } else if (isRGBW2) {
 238             return settings.lights == null || settings.lights.size() <= 1 ? CHANNEL_GROUP_LIGHT_CONTROL
 239                     : CHANNEL_GROUP_LIGHT_CHANNEL + idx;
 240         } else if (isLight) {
 241             return CHANNEL_GROUP_LIGHT_CONTROL;
 242         } else if (isButton) {
 243             return CHANNEL_GROUP_STATUS;
 244         } else if (isSensor) {
 245             return CHANNEL_GROUP_SENSOR;
 246         }
 247
 248         // e.g. ix3
 249         return numRelays == 1 ? CHANNEL_GROUP_STATUS : CHANNEL_GROUP_STATUS + idx;
 250     }
 251
 252     public String getMeterGroup(int idx) {
 253         return numMeters > 1 ? CHANNEL_GROUP_METER + (idx + 1) : CHANNEL_GROUP_METER;
 254     }
 255
 256     public String getInputGroup(int i) {
 257         int idx = i + 1; // group names are 1-based
 258         if (isRGBW2) {
 259             return CHANNEL_GROUP_LIGHT_CONTROL;
 260         } else if (isIX) {
 261             return CHANNEL_GROUP_STATUS + idx;
 262         } else if (isButton) {
 263             return CHANNEL_GROUP_STATUS;
 264         } else if (isRoller) {
 265             return numRelays <= 2 ? CHANNEL_GROUP_ROL_CONTROL : CHANNEL_GROUP_ROL_CONTROL + idx;
 266         } else {
 267             // Device has 1 input per relay: 0=off, 1+2 depend on switch mode
 268             return numRelays <= 1 ? CHANNEL_GROUP_RELAY_CONTROL : CHANNEL_GROUP_RELAY_CONTROL + idx;
 269         }
 270     }
 271
 272     public String getInputSuffix(int i) {
 273         int idx = i + 1; // channel names are 1-based
 274         if (isRGBW2 || isIX) {
 275             return ""; // RGBW2 has only 1 channel
 276         } else if (isRoller || isDimmer) {
 277             // Roller has 2 relays, but it will be mapped to 1 roller with 2 inputs
 278             return String.valueOf(idx);
 279         } else if (hasRelays) {
 280             return numRelays == 1 && numInputs >= 2 ? String.valueOf(idx) : "";
 281         }
 282         return "";
 283     }
 284
 285     public boolean inButtonMode(int idx) {
 286         if (idx < 0) {
 287             logger.debug("{}: Invalid index {} for inButtonMode()", thingName, idx);
 288             return false;
 289         }
 290         String btnType = "";
 291         if (isButton) {
 292             return true;
 293         } else if (isIX && settings.inputs != null && idx < settings.inputs.size()) {
 294             ShellySettingsInput input = settings.inputs.get(idx);
 295             btnType = getString(input.btnType);
 296         } else if (isDimmer) {
 297             if (settings.dimmers != null) {
 298                 ShellySettingsDimmer dimmer = settings.dimmers.get(0);
 299                 btnType = dimmer.btnType;
 300             }
 301         } else if (settings.relays != null) {
 302             if (numRelays == 1) {
 303                 ShellySettingsRelay relay = settings.relays.get(0);
 304                 if (relay.btnType != null) {
 305                     btnType = getString(relay.btnType);
 306                 } else {
 307                     // Shelly 1L has 2 inputs
 308                     btnType = idx == 0 ? getString(relay.btnType1) : getString(relay.btnType2);
 309                 }
 310             } else if (idx < settings.relays.size()) {
 311                 // only one input channel
 312                 ShellySettingsRelay relay = settings.relays.get(idx);
 313                 btnType = getString(relay.btnType);
 314             }
 315         } else if (isRGBW2 && (settings.lights != null) && (idx < settings.lights.size())) {
 316             ShellySettingsRgbwLight light = settings.lights.get(idx);
 317             btnType = light.btnType;
 318         }
 319
 320         return btnType.equalsIgnoreCase(SHELLY_BTNT_MOMENTARY) || btnType.equalsIgnoreCase(SHELLY_BTNT_MOM_ON_RELEASE)
 321                 || btnType.equalsIgnoreCase(SHELLY_BTNT_ONE_BUTTON) || btnType.equalsIgnoreCase(SHELLY_BTNT_TWO_BUTTON)
 322                 || btnType.equalsIgnoreCase(SHELLY_BTNT_DETACHED);
 323     }
 324
 325     public int getRollerFav(int id) {
 326         if ((id >= 0) && getBool(settings.favoritesEnabled) && (settings.favorites != null)
 327                 && (id < settings.favorites.size())) {
 328             return settings.favorites.get(id).pos;
 329         }
 330         return -1;
 331     }
 332
 333     public String[] getValveProfileList(int valveId) {
 334         if (isTRV && settings.thermostats != null && valveId <= settings.thermostats.size()) {
 335             ShellyThermnostat t = settings.thermostats.get(valveId);
 336             return t.profileNames;
 337         }
 338         return new String[0];
 339     }
 340
 341     public String getValueProfile(int valveId, int profileId) {
 342         int id = profileId;
 343         if (id <= 0 && settings.thermostats != null) {
 344             id = settings.thermostats.get(0).profile;
 345         }
 346         return "" + id;
 347     }
 348
 349     public static String extractFwVersion(@Nullable String version) {
 350         if (version != null) {
 351             // fix version e.g. 20210319-122304/v.1.10-Dimmer1-gfd4cc10 (with v.1. instead of v1.)
 352             String vers = version.replace("/v.1.10-", "/v1.10.0-");
 353
 354             // Extract version from string, e.g. 20210226-091047/v1.10.0-rc2-89-g623b41ec0-master
 355             Matcher matcher = VERSION_PATTERN.matcher(vers);
 356             if (matcher.find()) {
 357                 return matcher.group(0);
 358             }
 359         }
 360         return "";
 361     }
 362
 363     public boolean coiotEnabled() {
 364         if ((settings.coiot != null) && (settings.coiot.enabled != null)) {
 365             return settings.coiot.enabled;
 366         }
 367
 368         // If device is not yet intialized or the enabled property is missing we assume that CoIoT is enabled
 369         return true;
 370     }
 371 }