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