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.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     public boolean isBlu = false;
  71     public String gateway = "";
  72
  73     public String hwRev = "";
  74     public String hwBatchId = "";
  75     public String mac = "";
  76     public String fwVersion = "";
  77     public String fwDate = "";
  78
  79     public boolean hasRelays = false; // true if it has at least 1 power meter
  80     public int numRelays = 0; // number of relays/outputs
  81     public int numRollers = 0; // number of Rollers, usually 1
  82     public boolean isRoller = false; // true for Shelly2 in roller mode
  83     public boolean isDimmer = false; // true for a Shelly Dimmer (SHDM-1)
  84     public int numInputs = 0; // number of inputs
  85
  86     public int numMeters = 0;
  87     public boolean isEMeter = false; // true for ShellyEM/3EM
  88
  89     public boolean isLight = false; // true if it is a Shelly Bulb/RGBW2
  90     public boolean isBulb = false; // true only if it is a Bulb
  91     public boolean isDuo = false; // true only if it is a Duo
  92     public boolean isRGBW2 = false; // true only if it a RGBW2
  93     public boolean inColor = false; // true if bulb/rgbw2 is in color mode
  94
  95     public boolean isSensor = false; // true for HT & Smoke
  96     public boolean hasBattery = false; // true if battery device
  97     public boolean isSense = false; // true if thing is a Shelly Sense
  98     public boolean isMotion = false; // true if thing is a Shelly Sense
  99     public boolean isHT = false; // true for H&T
 100     public boolean isDW = false; // true for Door Window sensor
 101     public boolean isButton = false; // true for a Shelly Button 1
 102     public boolean isIX = false; // true for a Shelly IX
 103     public boolean isTRV = false; // true for a Shelly TRV
 104     public boolean isSmoke = false; // true for Shelly Smoke
 105     public boolean isWall = false; // true: Shelly Wall Display
 106     public boolean is3EM = false; // true for Shelly 3EM and Pro 3EM
 107
 108     public int minTemp = 0; // Bulb/Duo: Min Light Temp
 109     public int maxTemp = 0; // Bulb/Duo: Max Light Temp
 110
 111     public int updatePeriod = 2 * UPDATE_SETTINGS_INTERVAL_SECONDS + 10;
 112
 113     public String coiotEndpoint = "";
 114
 115     public Map<String, String> irCodes = new HashMap<>(); // Sense: list of stored IR codes
 116
 117     public ShellyDeviceProfile() {
 118     }
 119
 120     public ShellyDeviceProfile initialize(String thingType, String jsonIn) throws ShellyApiException {
 121         Gson gson = new Gson();
 122
 123         initialized = false;
 124
 125         initFromThingType(thingType);
 126
 127         String json = jsonIn;
 128         if (json.contains("\"ext_temperature\":{\"0\":[{")) {
 129             // Shelly UNI uses ext_temperature array, reformat to avoid GSON exception
 130             json = json.replace("ext_temperature", "ext_temperature_array");
 131         }
 132         if (json.contains("\"ext_humidity\":{\"0\":[{")) {
 133             // Shelly UNI uses ext_humidity array, reformat to avoid GSON exception
 134             json = json.replace("ext_humidity", "ext_humidity_array");
 135         }
 136         settingsJson = json;
 137         settings = fromJson(gson, json, ShellySettingsGlobal.class);
 138
 139         // General settings
 140         name = getString(settings.name);
 141         deviceType = getString(settings.device.type);
 142         mac = getString(settings.device.mac);
 143         hostname = !getString(settings.device.hostname).isEmpty() ? settings.device.hostname.toLowerCase()
 144                 : mac.length() >= 12 ? "shelly-" + mac.toUpperCase().substring(6, 11) : "unknown";
 145         mode = getString(settings.mode).toLowerCase();
 146         hwRev = settings.hwinfo != null ? getString(settings.hwinfo.hwRevision) : "";
 147         hwBatchId = settings.hwinfo != null ? getString(settings.hwinfo.batchId.toString()) : "";
 148         fwDate = substringBefore(settings.fw, "/");
 149         fwVersion = extractFwVersion(settings.fw);
 150         ShellyVersionDTO version = new ShellyVersionDTO();
 151         extFeatures = version.compare(fwVersion, SHELLY_API_FW_110) >= 0;
 152         discoverable = (settings.discoverable == null) || settings.discoverable;
 153
 154         isRoller = mode.equalsIgnoreCase(SHELLY_MODE_ROLLER);
 155         inColor = isLight && mode.equalsIgnoreCase(SHELLY_MODE_COLOR);
 156
 157         numRelays = !isLight ? getInteger(settings.device.numOutputs) : 0;
 158         if ((numRelays > 0) && (settings.relays == null)) {
 159             numRelays = 0;
 160         }
 161         hasRelays = (numRelays > 0) || isDimmer;
 162         numRollers = getInteger(settings.device.numRollers);
 163         numInputs = settings.inputs != null ? settings.inputs.size() : hasRelays ? isRoller ? 2 : 1 : 0;
 164
 165         isEMeter = settings.emeters != null;
 166         numMeters = !isEMeter ? getInteger(settings.device.numMeters) : getInteger(settings.device.numEMeters);
 167         if ((numMeters == 0) && isLight) {
 168             // RGBW2 doesn't report, but has one
 169             numMeters = inColor ? 1 : getInteger(settings.device.numOutputs);
 170         }
 171
 172         initialized = true;
 173         return this;
 174     }
 175
 176     public boolean containsEventUrl(String eventType) {
 177         return containsEventUrl(settingsJson, eventType);
 178     }
 179
 180     public boolean containsEventUrl(String json, String eventType) {
 181         String settings = json.toLowerCase();
 182         return settings.contains((eventType + SHELLY_EVENTURL_SUFFIX).toLowerCase());
 183     }
 184
 185     public boolean isInitialized() {
 186         return initialized;
 187     }
 188
 189     public void initFromThingType(String name) {
 190         String thingType = (name.contains("-") ? substringBefore(name, "-") : name).toLowerCase().trim();
 191         if (thingType.isEmpty()) {
 192             return;
 193         }
 194
 195         isBlu = thingType.startsWith("shellyblu"); // e.g. SBBT for BU Button
 196
 197         isDimmer = deviceType.equalsIgnoreCase(SHELLYDT_DIMMER) || deviceType.equalsIgnoreCase(SHELLYDT_DIMMER2)
 198                 || deviceType.equalsIgnoreCase(SHELLYDT_PLUSDIMMERUS)
 199                 || thingType.equalsIgnoreCase(THING_TYPE_SHELLYPLUSDIMMERUS_STR);
 200         isBulb = thingType.equals(THING_TYPE_SHELLYBULB_STR);
 201         isDuo = thingType.equals(THING_TYPE_SHELLYDUO_STR) || thingType.equals(THING_TYPE_SHELLYVINTAGE_STR)
 202                 || thingType.equals(THING_TYPE_SHELLYDUORGBW_STR);
 203         isRGBW2 = thingType.startsWith(THING_TYPE_SHELLYRGBW2_PREFIX);
 204         isLight = isBulb || isDuo || isRGBW2;
 205         if (isLight) {
 206             minTemp = isBulb ? MIN_COLOR_TEMP_BULB : MIN_COLOR_TEMP_DUO;
 207             maxTemp = isBulb ? MAX_COLOR_TEMP_BULB : MAX_COLOR_TEMP_DUO;
 208         }
 209
 210         boolean isFlood = thingType.equals(THING_TYPE_SHELLYFLOOD_STR);
 211         isSmoke = thingType.equals(THING_TYPE_SHELLYSMOKE_STR) || thingType.equals(THING_TYPE_SHELLYPLUSSMOKE_STR);
 212         boolean isGas = thingType.equals(THING_TYPE_SHELLYGAS_STR);
 213         boolean isUNI = thingType.equals(THING_TYPE_SHELLYUNI_STR);
 214         isHT = thingType.equals(THING_TYPE_SHELLYHT_STR) || thingType.equals(THING_TYPE_SHELLYPLUSHT_STR);
 215         isDW = thingType.equals(THING_TYPE_SHELLYDOORWIN_STR) || thingType.equals(THING_TYPE_SHELLYDOORWIN2_STR)
 216                 || thingType.equals(THING_TYPE_SHELLYBLUDW_STR);
 217         isMotion = thingType.startsWith(THING_TYPE_SHELLYMOTION_STR);
 218         isSense = thingType.equals(THING_TYPE_SHELLYSENSE_STR);
 219         isIX = thingType.equals(THING_TYPE_SHELLYIX3_STR) || thingType.equals(THING_TYPE_SHELLYPLUSI4_STR)
 220                 || thingType.equals(THING_TYPE_SHELLYPLUSI4DC_STR);
 221         isButton = thingType.equals(THING_TYPE_SHELLYBUTTON1_STR) || thingType.equals(THING_TYPE_SHELLYBUTTON2_STR)
 222                 || thingType.equals(THING_TYPE_SHELLYBLUBUTTON_STR);
 223         isTRV = thingType.equals(THING_TYPE_SHELLYTRV_STR);
 224         isWall = thingType.equals(THING_TYPE_SHELLYPLUSWALLDISPLAY_STR);
 225         is3EM = thingType.equals(THING_TYPE_SHELLY3EM_STR) || thingType.equals(THING_TYPE_SHELLYPRO3EM_STR);
 226
 227         isSensor = isHT || isFlood || isDW || isSmoke || isGas || isButton || isUNI || isMotion || isSense || isTRV
 228                 || isWall;
 229         hasBattery = isHT || isFlood || isDW || isSmoke || isButton || isMotion || isTRV;
 230         alwaysOn = !hasBattery || isMotion || isSense; // true means: device is reachable all the time (no sleep mode)
 231     }
 232
 233     public void updateFromStatus(ShellySettingsStatus status) {
 234         if (hasRelays) {
 235             // Dimmer-2 doesn't report inputs under /settings, only on /status, we need to update that info after init
 236             if (status.inputs != null) {
 237                 numInputs = status.inputs.size();
 238             }
 239         } else if (status.input != null) {
 240             // RGBW2
 241             numInputs = 1;
 242         }
 243     }
 244
 245     public String getControlGroup(int i) {
 246         if (i < 0) {
 247             logger.debug("{}: Invalid index {} for getControlGroup()", thingName, i);
 248             return "";
 249         }
 250         int idx = i + 1;
 251         if (isDimmer) {
 252             return CHANNEL_GROUP_DIMMER_CONTROL;
 253         } else if (isRoller) {
 254             return numRollers <= 1 ? CHANNEL_GROUP_ROL_CONTROL : CHANNEL_GROUP_ROL_CONTROL + idx;
 255         } else if (isDimmer) {
 256             return CHANNEL_GROUP_RELAY_CONTROL;
 257         } else if (hasRelays) {
 258             return numRelays <= 1 ? CHANNEL_GROUP_RELAY_CONTROL : CHANNEL_GROUP_RELAY_CONTROL + idx;
 259         } else if (isRGBW2) {
 260             return settings.lights == null || settings.lights != null && settings.lights.size() <= 1
 261                     ? CHANNEL_GROUP_LIGHT_CONTROL
 262                     : CHANNEL_GROUP_LIGHT_CHANNEL + idx;
 263         } else if (isLight) {
 264             return CHANNEL_GROUP_LIGHT_CONTROL;
 265         } else if (isButton) {
 266             return CHANNEL_GROUP_STATUS;
 267         } else if (isSensor) {
 268             return CHANNEL_GROUP_SENSOR;
 269         }
 270
 271         // e.g. ix3
 272         return numRelays == 1 ? CHANNEL_GROUP_STATUS : CHANNEL_GROUP_STATUS + idx;
 273     }
 274
 275     public String getMeterGroup(int idx) {
 276         return numMeters > 1 ? CHANNEL_GROUP_METER + (idx + 1) : CHANNEL_GROUP_METER;
 277     }
 278
 279     public String getInputGroup(int i) {
 280         int idx = i + 1; // group names are 1-based
 281         if (isRGBW2) {
 282             return CHANNEL_GROUP_LIGHT_CONTROL;
 283         } else if (isIX) {
 284             return CHANNEL_GROUP_STATUS + idx;
 285         } else if (isButton) {
 286             return CHANNEL_GROUP_STATUS;
 287         } else if (isRoller) {
 288             return numRelays <= 2 ? CHANNEL_GROUP_ROL_CONTROL : CHANNEL_GROUP_ROL_CONTROL + idx;
 289         } else {
 290             // Device has 1 input per relay: 0=off, 1+2 depend on switch mode
 291             return numRelays <= 1 ? CHANNEL_GROUP_RELAY_CONTROL : CHANNEL_GROUP_RELAY_CONTROL + idx;
 292         }
 293     }
 294
 295     public String getInputSuffix(int i) {
 296         int idx = i + 1; // channel names are 1-based
 297         if (isRGBW2 || isIX) {
 298             return ""; // RGBW2 has only 1 channel
 299         } else if (isRoller || isDimmer) {
 300             // Roller has 2 relays, but it will be mapped to 1 roller with 2 inputs
 301             return String.valueOf(idx);
 302         } else if (hasRelays) {
 303             return numRelays == 1 && numInputs >= 2 ? String.valueOf(idx) : "";
 304         }
 305         return "";
 306     }
 307
 308     @SuppressWarnings("null")
 309     public boolean inButtonMode(int idx) {
 310         if (idx < 0) {
 311             logger.debug("{}: Invalid index {} for inButtonMode()", thingName, idx);
 312             return false;
 313         }
 314         String btnType = "";
 315         if (isButton) {
 316             return true;
 317         } else if (isIX && settings.inputs != null && idx < settings.inputs.size()) {
 318             ShellySettingsInput input = settings.inputs.get(idx);
 319             btnType = getString(input.btnType);
 320         } else if (isDimmer) {
 321             if (settings.dimmers != null) {
 322                 ShellySettingsDimmer dimmer = settings.dimmers.get(0);
 323                 btnType = dimmer.btnType;
 324             }
 325         } else if (settings.relays != null) {
 326             if (numRelays == 1) {
 327                 ShellySettingsRelay relay = settings.relays.get(0);
 328                 if (relay.btnType != null) {
 329                     btnType = getString(relay.btnType);
 330                 } else {
 331                     // Shelly 1L has 2 inputs
 332                     btnType = idx == 0 ? getString(relay.btnType1) : getString(relay.btnType2);
 333                 }
 334             } else if (idx < settings.relays.size()) {
 335                 // only one input channel
 336                 ShellySettingsRelay relay = settings.relays.get(idx);
 337                 btnType = getString(relay.btnType);
 338             }
 339         } else if (isRGBW2 && (settings.lights != null) && (idx < settings.lights.size())) {
 340             ShellySettingsRgbwLight light = settings.lights.get(idx);
 341             btnType = light.btnType;
 342         }
 343
 344         return btnType.equalsIgnoreCase(SHELLY_BTNT_MOMENTARY) || btnType.equalsIgnoreCase(SHELLY_BTNT_MOM_ON_RELEASE)
 345                 || btnType.equalsIgnoreCase(SHELLY_BTNT_ONE_BUTTON) || btnType.equalsIgnoreCase(SHELLY_BTNT_TWO_BUTTON)
 346                 || btnType.equalsIgnoreCase(SHELLY_BTNT_DETACHED);
 347     }
 348
 349     public int getRollerFav(int id) {
 350         if (id >= 0 && getBool(settings.favoritesEnabled) && settings.favorites != null
 351                 && id < settings.favorites.size()) {
 352             return settings.favorites.get(id).pos;
 353         }
 354         return -1;
 355     }
 356
 357     public String[] getValveProfileList(int valveId) {
 358         if (isTRV && settings.thermostats != null) {
 359             int sz = settings.thermostats.size();
 360             if (valveId <= sz) {
 361                 if (settings.thermostats != null) {
 362                     ShellyThermnostat t = settings.thermostats.get(valveId);
 363                     return t.profileNames;
 364                 }
 365             }
 366         }
 367         return new String[0];
 368     }
 369
 370     public String getValueProfile(int valveId, int profileId) {
 371         int id = profileId;
 372         if (id <= 0 && settings.thermostats != null) {
 373             id = settings.thermostats.get(0).profile;
 374         }
 375         return "" + id;
 376     }
 377
 378     public static String extractFwVersion(@Nullable String version) {
 379         if (version != null) {
 380             // fix version e.g.
 381             // 20210319-122304/v.1.10-Dimmer1-gfd4cc10 (with v.1. instead of v1.)
 382             // 20220809-125346/v1.12-g99f7e0b (.0 in 1.12.0 missing)
 383             String vers = version.replace("/v.1.10-", "/v1.10.0-") //
 384                     .replace("/v1.12-", "/v1.12.0");
 385
 386             // Extract version from string, e.g. 20210226-091047/v1.10.0-rc2-89-g623b41ec0-master
 387             Matcher matcher = VERSION_PATTERN.matcher(vers);
 388             if (matcher.find()) {
 389                 return matcher.group(0);
 390             }
 391         }
 392         return "";
 393     }
 394
 395     public boolean coiotEnabled() {
 396         if ((settings.coiot != null) && (settings.coiot.enabled != null)) {
 397             return settings.coiot.enabled;
 398         }
 399
 400         // If device is not yet intialized or the enabled property is missing we assume that CoIoT is enabled
 401         return true;
 402     }
 403 }