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.api2;
  14
  15 import static org.openhab.binding.shelly.internal.ShellyBindingConstants.CHANNEL_INPUT;
  16 import static org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.*;
  17 import static org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.*;
  18 import static org.openhab.binding.shelly.internal.util.ShellyUtils.*;
  19
  20 import java.util.ArrayList;
  21 import java.util.HashMap;
  22 import java.util.Map;
  23 import java.util.Random;
  24
  25 import org.eclipse.jdt.annotation.NonNullByDefault;
  26 import org.eclipse.jdt.annotation.Nullable;
  27 import org.eclipse.jetty.client.HttpClient;
  28 import org.openhab.binding.shelly.internal.api.ShellyApiException;
  29 import org.openhab.binding.shelly.internal.api.ShellyDeviceProfile;
  30 import org.openhab.binding.shelly.internal.api.ShellyHttpClient;
  31 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyFavPos;
  32 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyInputState;
  33 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyRollerStatus;
  34 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySensorTmp;
  35 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsEMeter;
  36 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsInput;
  37 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsMeter;
  38 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsRelay;
  39 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsRoller;
  40 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsStatus;
  41 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyShortStatusRelay;
  42 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusRelay;
  43 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusSensor;
  44 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusSensor.ShellyExtAnalogInput;
  45 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusSensor.ShellyExtDigitalInput;
  46 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusSensor.ShellyExtHumidity;
  47 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusSensor.ShellyExtTemperature;
  48 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusSensor.ShellyExtTemperature.ShellyShortTemp;
  49 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusSensor.ShellyExtVoltage;
  50 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusSensor.ShellySensorBat;
  51 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyStatusSensor.ShellySensorHum;
  52 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2AuthRequest;
  53 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2AuthResponse;
  54 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2DeviceConfig.Shelly2DevConfigCover;
  55 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2DeviceConfig.Shelly2DevConfigInput;
  56 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2DeviceConfig.Shelly2DevConfigSwitch;
  57 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2DeviceConfig.Shelly2GetConfigResult;
  58 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2DeviceStatus.Shelly2DeviceStatusResult;
  59 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2DeviceStatus.Shelly2DeviceStatusResult.Shelly2CoverStatus;
  60 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2DeviceStatus.Shelly2DeviceStatusResult.Shelly2DeviceStatusEm;
  61 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2DeviceStatus.Shelly2DeviceStatusResult.Shelly2DeviceStatusHumidity;
  62 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2DeviceStatus.Shelly2DeviceStatusResult.Shelly2DeviceStatusPower;
  63 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2DeviceStatus.Shelly2DeviceStatusResult.Shelly2DeviceStatusSmoke;
  64 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2DeviceStatus.Shelly2DeviceStatusResult.Shelly2DeviceStatusTempId;
  65 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2DeviceStatus.Shelly2InputStatus;
  66 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2RelayStatus;
  67 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2RpcBaseMessage;
  68 import org.openhab.binding.shelly.internal.config.ShellyThingConfiguration;
  69 import org.openhab.binding.shelly.internal.handler.ShellyBaseHandler;
  70 import org.openhab.binding.shelly.internal.handler.ShellyComponents;
  71 import org.openhab.binding.shelly.internal.handler.ShellyThingInterface;
  72 import org.openhab.core.types.State;
  73 import org.slf4j.Logger;
  74 import org.slf4j.LoggerFactory;
  75
  76 /**
  77  * {@link Shelly2ApiClient} Low level part of the RPC API
  78  *
  79  * @author Markus Michels - Initial contribution
  80  */
  81 @NonNullByDefault
  82 public class Shelly2ApiClient extends ShellyHttpClient {
  83     private final Logger logger = LoggerFactory.getLogger(Shelly2ApiClient.class);
  84     protected final Random random = new Random();
  85     protected final ShellyStatusRelay relayStatus = new ShellyStatusRelay();
  86     protected final ShellyStatusSensor sensorData = new ShellyStatusSensor();
  87     protected final ArrayList<ShellyRollerStatus> rollerStatus = new ArrayList<>();
  88     protected @Nullable ShellyThingInterface thing;
  89     protected @Nullable Shelly2AuthRequest authReq;
  90
  91     public Shelly2ApiClient(String thingName, ShellyThingInterface thing) {
  92         super(thingName, thing);
  93         this.thing = thing;
  94     }
  95
  96     public Shelly2ApiClient(String thingName, ShellyThingConfiguration config, HttpClient httpClient) {
  97         super(thingName, config, httpClient);
  98     }
  99
 100     protected static final Map<String, String> MAP_INMODE_BTNTYPE = new HashMap<>();
 101     static {
 102         MAP_INMODE_BTNTYPE.put(SHELLY2_BTNT_MOMENTARY, SHELLY_BTNT_MOMENTARY);
 103         MAP_INMODE_BTNTYPE.put(SHELLY2_BTNT_FLIP, SHELLY_BTNT_TOGGLE);
 104         MAP_INMODE_BTNTYPE.put(SHELLY2_BTNT_FOLLOW, SHELLY_BTNT_EDGE);
 105         MAP_INMODE_BTNTYPE.put(SHELLY2_BTNT_DETACHED, SHELLY_BTNT_MOMENTARY);
 106     }
 107
 108     protected static final Map<String, String> MAP_INPUT_EVENT_TYPE = new HashMap<>();
 109     static {
 110         MAP_INPUT_EVENT_TYPE.put(SHELLY2_EVENT_1PUSH, SHELLY_BTNEVENT_1SHORTPUSH);
 111         MAP_INPUT_EVENT_TYPE.put(SHELLY2_EVENT_2PUSH, SHELLY_BTNEVENT_2SHORTPUSH);
 112         MAP_INPUT_EVENT_TYPE.put(SHELLY2_EVENT_3PUSH, SHELLY_BTNEVENT_3SHORTPUSH);
 113         MAP_INPUT_EVENT_TYPE.put(SHELLY2_EVENT_LPUSH, SHELLY_BTNEVENT_LONGPUSH);
 114         MAP_INPUT_EVENT_TYPE.put(SHELLY2_EVENT_LSPUSH, SHELLY_BTNEVENT_LONGSHORTPUSH);
 115         MAP_INPUT_EVENT_TYPE.put(SHELLY2_EVENT_SLPUSH, SHELLY_BTNEVENT_SHORTLONGPUSH);
 116     }
 117
 118     protected static final Map<String, String> MAP_INPUT_EVENT_ID = new HashMap<>();
 119     static {
 120         MAP_INPUT_EVENT_ID.put(SHELLY2_EVENT_BTNUP, SHELLY_EVENT_BTN_OFF);
 121         MAP_INPUT_EVENT_ID.put(SHELLY2_EVENT_BTNDOWN, SHELLY_EVENT_BTN_ON);
 122         MAP_INPUT_EVENT_ID.put(SHELLY2_EVENT_1PUSH, SHELLY_EVENT_SHORTPUSH);
 123         MAP_INPUT_EVENT_ID.put(SHELLY2_EVENT_2PUSH, SHELLY_EVENT_DOUBLE_SHORTPUSH);
 124         MAP_INPUT_EVENT_ID.put(SHELLY2_EVENT_3PUSH, SHELLY_EVENT_TRIPLE_SHORTPUSH);
 125         MAP_INPUT_EVENT_ID.put(SHELLY2_EVENT_LPUSH, SHELLY_EVENT_LONGPUSH);
 126         MAP_INPUT_EVENT_ID.put(SHELLY2_EVENT_LSPUSH, SHELLY_EVENT_LONG_SHORTPUSH);
 127         MAP_INPUT_EVENT_ID.put(SHELLY2_EVENT_SLPUSH, SHELLY_EVENT_SHORT_LONGTPUSH);
 128     }
 129
 130     protected static final Map<String, String> MAP_INPUT_MODE = new HashMap<>();
 131     static {
 132         MAP_INPUT_MODE.put(SHELLY2_RMODE_SINGLE, SHELLY_INP_MODE_ONEBUTTON);
 133         MAP_INPUT_MODE.put(SHELLY2_RMODE_DUAL, SHELLY_INP_MODE_OPENCLOSE);
 134         MAP_INPUT_MODE.put(SHELLY2_RMODE_DETACHED, SHELLY_INP_MODE_ONEBUTTON);
 135     }
 136
 137     protected static final Map<String, String> MAP_ROLLER_STATE = new HashMap<>();
 138     static {
 139         MAP_ROLLER_STATE.put(SHELLY2_RSTATE_OPEN, SHELLY_RSTATE_OPEN);
 140         MAP_ROLLER_STATE.put(SHELLY2_RSTATE_CLOSED, SHELLY_RSTATE_CLOSE);
 141         MAP_ROLLER_STATE.put(SHELLY2_RSTATE_OPENING, SHELLY2_RSTATE_OPENING); // Gen2-only
 142         MAP_ROLLER_STATE.put(SHELLY2_RSTATE_CLOSING, SHELLY2_RSTATE_CLOSING); // Gen2-only
 143         MAP_ROLLER_STATE.put(SHELLY2_RSTATE_STOPPED, SHELLY_RSTATE_STOP);
 144         MAP_ROLLER_STATE.put(SHELLY2_RSTATE_CALIB, SHELLY2_RSTATE_CALIB); // Gen2-only
 145     }
 146
 147     protected @Nullable ArrayList<@Nullable ShellySettingsRelay> fillRelaySettings(ShellyDeviceProfile profile,
 148             Shelly2GetConfigResult dc) {
 149         if (dc.switch0 == null) {
 150             return null;
 151         }
 152         ArrayList<@Nullable ShellySettingsRelay> relays = new ArrayList<>();
 153         addRelaySettings(relays, dc.switch0);
 154         addRelaySettings(relays, dc.switch1);
 155         addRelaySettings(relays, dc.switch2);
 156         addRelaySettings(relays, dc.switch3);
 157         return relays;
 158     }
 159
 160     private void addRelaySettings(ArrayList<@Nullable ShellySettingsRelay> relays,
 161             @Nullable Shelly2DevConfigSwitch cs) {
 162         if (cs == null) {
 163             return;
 164         }
 165
 166         ShellySettingsRelay rsettings = new ShellySettingsRelay();
 167         rsettings.name = cs.name;
 168         rsettings.ison = false;
 169         rsettings.autoOn = getBool(cs.autoOn) ? cs.autoOnDelay : 0;
 170         rsettings.autoOff = getBool(cs.autoOff) ? cs.autoOffDelay : 0;
 171         rsettings.hasTimer = false;
 172         rsettings.btnType = mapValue(MAP_INMODE_BTNTYPE, getString(cs.mode).toLowerCase());
 173         relays.add(rsettings);
 174     }
 175
 176     protected boolean fillDeviceStatus(ShellySettingsStatus status, Shelly2DeviceStatusResult result,
 177             boolean channelUpdate) throws ShellyApiException {
 178         boolean updated = false;
 179
 180         if (result.temperature0 != null && !getProfile().isSensor) {
 181             status.temperature = status.tmp.tC = result.temperature0.tC;
 182         }
 183
 184         updated |= updateInputStatus(status, result, channelUpdate);
 185         updated |= updateRelayStatus(status, result.switch0, channelUpdate);
 186         updated |= updateRelayStatus(status, result.switch1, channelUpdate);
 187         updated |= updateRelayStatus(status, result.switch2, channelUpdate);
 188         updated |= updateRelayStatus(status, result.switch3, channelUpdate);
 189         updated |= updateEmStatus(status, result.em0, channelUpdate);
 190         updated |= updateRollerStatus(status, result.cover0, channelUpdate);
 191         if (channelUpdate) {
 192             updated |= ShellyComponents.updateMeters(getThing(), status);
 193         }
 194
 195         updateHumidityStatus(sensorData, result.humidity0);
 196         updateTemperatureStatus(sensorData, result.temperature0);
 197         updateSmokeStatus(sensorData, result.smoke0);
 198         updateBatteryStatus(sensorData, result.devicepower0);
 199         updateAddonStatus(status, result);
 200         updated |= ShellyComponents.updateSensors(getThing(), status);
 201         return updated;
 202     }
 203
 204     private boolean updateRelayStatus(ShellySettingsStatus status, @Nullable Shelly2RelayStatus rs,
 205             boolean channelUpdate) throws ShellyApiException {
 206         if (rs == null) {
 207             return false;
 208         }
 209         ShellyDeviceProfile profile = getProfile();
 210         if (rs.id >= profile.numRelays) {
 211             throw new IllegalArgumentException("Update for invalid relay index");
 212         }
 213
 214         ShellySettingsRelay rstatus = status.relays.get(rs.id);
 215         ShellyShortStatusRelay sr = relayStatus.relays.get(rs.id);
 216         sr.isValid = rstatus.isValid = true;
 217         sr.name = rstatus.name = status.name;
 218         if (rs.output != null) {
 219             sr.ison = rstatus.ison = getBool(rs.output);
 220         }
 221         if (getDouble(rs.timerStartetAt) > 0) {
 222             int duration = (int) (now() - rs.timerStartetAt);
 223             sr.timerRemaining = duration;
 224         }
 225         if (rs.temperature != null) {
 226             status.tmp.isValid = true;
 227             status.tmp.tC = rs.temperature.tC;
 228             status.tmp.tF = rs.temperature.tF;
 229             status.tmp.units = "C";
 230             sr.temperature = getDouble(rs.temperature.tC);
 231             if (status.temperature == null || getDouble(rs.temperature.tC) > status.temperature) {
 232                 status.temperature = sr.temperature;
 233             }
 234         } else {
 235             status.tmp.isValid = false;
 236         }
 237         if (rs.voltage != null) {
 238             if (status.voltage == null || rs.voltage > status.voltage) {
 239                 status.voltage = rs.voltage;
 240             }
 241         }
 242         if (rs.errors != null) {
 243             for (String error : rs.errors) {
 244                 sr.overpower = rstatus.overpower = SHELLY2_ERROR_OVERPOWER.equals(error);
 245                 status.overload = SHELLY2_ERROR_OVERVOLTAGE.equals(error);
 246                 status.overtemperature = SHELLY2_ERROR_OVERTEMP.equals(error);
 247             }
 248             sr.overtemperature = status.overtemperature;
 249         }
 250
 251         ShellySettingsMeter sm = new ShellySettingsMeter();
 252         ShellySettingsEMeter emeter = status.emeters.get(rs.id);
 253         sm.isValid = emeter.isValid = true;
 254         if (rs.apower != null) {
 255             sm.power = emeter.power = rs.apower;
 256         }
 257         if (rs.aenergy != null) {
 258             sm.total = emeter.total = rs.aenergy.total;
 259             sm.counters = rs.aenergy.byMinute;
 260             sm.timestamp = rs.aenergy.minuteTs;
 261         }
 262         if (rs.voltage != null) {
 263             emeter.voltage = rs.voltage;
 264         }
 265         if (rs.current != null) {
 266             emeter.current = rs.current;
 267         }
 268         if (rs.pf != null) {
 269             emeter.pf = rs.pf;
 270         }
 271
 272         // Update internal structures
 273         status.relays.set(rs.id, rstatus);
 274         relayStatus.relays.set(rs.id, sr);
 275         updateMeter(status, rs.id, sm, emeter, channelUpdate);
 276         return channelUpdate ? ShellyComponents.updateRelay((ShellyBaseHandler) getThing(), status, rs.id) : false;
 277     }
 278
 279     private void updateMeter(ShellySettingsStatus status, int id, ShellySettingsMeter sm, ShellySettingsEMeter emeter,
 280             boolean channelUpdate) throws ShellyApiException {
 281         status.meters.set(id, sm);
 282         status.emeters.set(id, emeter);
 283         relayStatus.meters.set(id, sm);
 284     }
 285
 286     private boolean updateEmStatus(ShellySettingsStatus status, @Nullable Shelly2DeviceStatusEm em,
 287             boolean channelUpdate) throws ShellyApiException {
 288         if (em == null) {
 289             return false;
 290         }
 291
 292         ShellySettingsMeter sm = new ShellySettingsMeter();
 293         ShellySettingsEMeter emeter = status.emeters.get(0);
 294         sm.isValid = emeter.isValid = true;
 295         if (em.aActPower != null) {
 296             sm.power = emeter.power = em.aActPower;
 297         }
 298         if (em.aAprtPower != null) {
 299             emeter.totalReturned = em.aAprtPower;
 300         }
 301         if (em.aVoltage != null) {
 302             emeter.voltage = em.aVoltage;
 303         }
 304         if (em.aCurrent != null) {
 305             emeter.current = em.aCurrent;
 306         }
 307         if (em.aPF != null) {
 308             emeter.pf = em.aPF;
 309         }
 310         // Update internal structures
 311         updateMeter(status, 0, sm, emeter, channelUpdate);
 312
 313         sm = new ShellySettingsMeter();
 314         emeter = status.emeters.get(1);
 315         sm.isValid = emeter.isValid = true;
 316         if (em.bActPower != null) {
 317             sm.power = emeter.power = em.bActPower;
 318         }
 319         if (em.bAprtPower != null) {
 320             emeter.totalReturned = em.bAprtPower;
 321         }
 322         if (em.bVoltage != null) {
 323             emeter.voltage = em.bVoltage;
 324         }
 325         if (em.bCurrent != null) {
 326             emeter.current = em.bCurrent;
 327         }
 328         if (em.bPF != null) {
 329             emeter.pf = em.bPF;
 330         }
 331         // Update internal structures
 332         updateMeter(status, 1, sm, emeter, channelUpdate);
 333
 334         sm = new ShellySettingsMeter();
 335         emeter = status.emeters.get(2);
 336         sm.isValid = emeter.isValid = true;
 337         if (em.cActPower != null) {
 338             sm.power = emeter.power = em.cActPower;
 339         }
 340         if (em.cAprtPower != null) {
 341             emeter.totalReturned = em.cAprtPower;
 342         }
 343         if (em.cVoltage != null) {
 344             emeter.voltage = em.cVoltage;
 345         }
 346         if (em.cCurrent != null) {
 347             emeter.current = em.cCurrent;
 348         }
 349         if (em.cPF != null) {
 350             emeter.pf = em.cPF;
 351         }
 352         // Update internal structures
 353         updateMeter(status, 2, sm, emeter, channelUpdate);
 354
 355         return channelUpdate ? ShellyComponents.updateMeters(getThing(), status) : false;
 356     }
 357
 358     protected @Nullable ArrayList<@Nullable ShellySettingsRoller> fillRollerSettings(ShellyDeviceProfile profile,
 359             Shelly2GetConfigResult dc) {
 360         if (dc.cover0 == null) {
 361             return null;
 362         }
 363
 364         ArrayList<@Nullable ShellySettingsRoller> rollers = new ArrayList<>();
 365
 366         addRollerSettings(rollers, dc.cover0);
 367         fillRollerFavorites(profile, dc);
 368         return rollers;
 369     }
 370
 371     private void addRollerSettings(ArrayList<@Nullable ShellySettingsRoller> rollers,
 372             @Nullable Shelly2DevConfigCover coverConfig) {
 373         if (coverConfig == null) {
 374             return;
 375         }
 376
 377         ShellySettingsRoller settings = new ShellySettingsRoller();
 378         settings.isValid = true;
 379         settings.defaultState = coverConfig.initialState;
 380         settings.inputMode = mapValue(MAP_INPUT_MODE, coverConfig.inMode);
 381         settings.btnReverse = getBool(coverConfig.invertDirections) ? 1 : 0;
 382         settings.swapInputs = coverConfig.swapInputs;
 383         settings.maxtime = 0.0; // n/a
 384         settings.maxtimeOpen = coverConfig.maxtimeOpen;
 385         settings.maxtimeClose = coverConfig.maxtimeClose;
 386         if (coverConfig.safetySwitch != null) {
 387             settings.safetySwitch = coverConfig.safetySwitch.enable;
 388             settings.safetyAction = coverConfig.safetySwitch.action;
 389         }
 390         if (coverConfig.obstructionDetection != null) {
 391             settings.obstacleAction = coverConfig.obstructionDetection.action;
 392             settings.obstacleDelay = coverConfig.obstructionDetection.holdoff.intValue();
 393             settings.obstaclePower = coverConfig.obstructionDetection.powerThr;
 394         }
 395         rollers.add(settings);
 396     }
 397
 398     private void fillRollerFavorites(ShellyDeviceProfile profile, Shelly2GetConfigResult dc) {
 399         if (dc.sys.uiData.cover != null) {
 400             String[] favorites = dc.sys.uiData.cover.split(",");
 401             profile.settings.favorites = new ArrayList<>();
 402             for (int i = 0; i < favorites.length; i++) {
 403                 ShellyFavPos fav = new ShellyFavPos();
 404                 fav.pos = Integer.parseInt(favorites[i]);
 405                 fav.name = fav.pos + "%";
 406                 profile.settings.favorites.add(fav);
 407             }
 408             profile.settings.favoritesEnabled = profile.settings.favorites.size() > 0;
 409             logger.debug("{}: Roller Favorites loaded: {}", thingName,
 410                     profile.settings.favoritesEnabled ? profile.settings.favorites.size() : "none");
 411         }
 412     }
 413
 414     private boolean updateRollerStatus(ShellySettingsStatus status, @Nullable Shelly2CoverStatus cs,
 415             boolean updateChannels) throws ShellyApiException {
 416         if (cs == null) {
 417             return false;
 418         }
 419
 420         ShellyRollerStatus rs = status.rollers.get(cs.id);
 421         ShellySettingsMeter sm = status.meters.get(cs.id);
 422         ShellySettingsEMeter emeter = status.emeters.get(cs.id);
 423         rs.isValid = sm.isValid = emeter.isValid = true;
 424         if (cs.state != null) {
 425             if (!getString(rs.state).equals(cs.state)) {
 426                 logger.debug("{}: Roller status changed from {} to {}, updateChannels={}", thingName, rs.state,
 427                         mapValue(MAP_ROLLER_STATE, cs.state), updateChannels);
 428             }
 429             rs.state = mapValue(MAP_ROLLER_STATE, cs.state);
 430             rs.calibrating = SHELLY2_RSTATE_CALIB.equals(cs.state);
 431         }
 432         if (cs.currentPos != null) {
 433             rs.currentPos = cs.currentPos;
 434         }
 435         if (cs.moveStartedAt != null) {
 436             rs.duration = (int) (now() - cs.moveStartedAt.longValue());
 437         }
 438         if (cs.temperature != null && cs.temperature.tC > getDouble(status.temperature)) {
 439             status.temperature = status.tmp.tC = getDouble(cs.temperature.tC);
 440         }
 441         if (cs.apower != null) {
 442             rs.power = sm.power = emeter.power = cs.apower;
 443         }
 444         if (cs.aenergy != null) {
 445             sm.total = emeter.total = cs.aenergy.total;
 446             sm.counters = cs.aenergy.byMinute;
 447             if (cs.aenergy.minuteTs != null) {
 448                 sm.timestamp = (long) cs.aenergy.minuteTs;
 449             }
 450         }
 451         if (cs.voltage != null) {
 452             emeter.voltage = cs.voltage;
 453         }
 454         if (cs.current != null) {
 455             emeter.current = cs.current;
 456         }
 457         if (cs.pf != null) {
 458             emeter.pf = cs.pf;
 459         }
 460
 461         rollerStatus.set(cs.id, rs);
 462         status.rollers.set(cs.id, rs);
 463         relayStatus.meters.set(cs.id, sm);
 464         status.meters.set(cs.id, sm);
 465         status.emeters.set(cs.id, emeter);
 466
 467         postAlarms(cs.errors);
 468         if (rs.calibrating != null && rs.calibrating) {
 469             getThing().postEvent(SHELLY_EVENT_ROLLER_CALIB, false);
 470         }
 471
 472         return updateChannels ? ShellyComponents.updateRoller((ShellyBaseHandler) getThing(), rs, cs.id) : false;
 473     }
 474
 475     // Addon
 476     private void updateAddonStatus(ShellySettingsStatus status, @Nullable Shelly2DeviceStatusResult ds)
 477             throws ShellyApiException {
 478         if (ds == null) {
 479             return;
 480         }
 481
 482         if (ds.temperature100 != null) {
 483             if (status.extTemperature == null) {
 484                 status.extTemperature = new ShellyExtTemperature();
 485             }
 486             status.extTemperature.sensor1 = updateExtTempSensor(ds.temperature100);
 487             status.extTemperature.sensor2 = updateExtTempSensor(ds.temperature101);
 488             status.extTemperature.sensor3 = updateExtTempSensor(ds.temperature102);
 489             status.extTemperature.sensor4 = updateExtTempSensor(ds.temperature103);
 490             status.extTemperature.sensor5 = updateExtTempSensor(ds.temperature104);
 491         }
 492         if (ds.humidity100 != null) {
 493             status.extHumidity = new ShellyExtHumidity(ds.humidity100.rh);
 494         }
 495         if (ds.voltmeter100 != null) {
 496             status.extVoltage = new ShellyExtVoltage(ds.voltmeter100.voltage);
 497         }
 498         if (ds.input100 != null) {
 499             status.extDigitalInput = new ShellyExtDigitalInput(getBool(ds.input100.state));
 500         }
 501     }
 502
 503     private @Nullable ShellyShortTemp updateExtTempSensor(@Nullable Shelly2DeviceStatusTempId value) {
 504         if (value != null) {
 505             ShellyShortTemp temp = new ShellyShortTemp();
 506             temp.hwID = value.id.toString();
 507             temp.tC = value.tC;
 508             temp.tF = value.tF;
 509             return temp;
 510         }
 511         return null;
 512     }
 513
 514     protected void updateHumidityStatus(ShellyStatusSensor sdata, @Nullable Shelly2DeviceStatusHumidity value) {
 515         if (value == null) {
 516             return;
 517         }
 518         if (sdata.hum == null) {
 519             sdata.hum = new ShellySensorHum();
 520         }
 521         sdata.hum.value = getDouble(value.rh);
 522     }
 523
 524     protected void updateTemperatureStatus(ShellyStatusSensor sdata, @Nullable Shelly2DeviceStatusTempId value) {
 525         if (value == null) {
 526             return;
 527         }
 528         if (sdata.tmp == null) {
 529             sdata.tmp = new ShellySensorTmp();
 530         }
 531         sdata.tmp.isValid = true;
 532         sdata.tmp.units = SHELLY_TEMP_CELSIUS;
 533         sdata.tmp.tC = value.tC;
 534         sdata.tmp.tF = value.tF;
 535     }
 536
 537     protected void updateSmokeStatus(ShellyStatusSensor sdata, @Nullable Shelly2DeviceStatusSmoke value) {
 538         if (value == null) {
 539             return;
 540         }
 541         sdata.smoke = getBool(value.alarm);
 542         sdata.mute = getBool(value.mute);
 543     }
 544
 545     protected void updateBatteryStatus(ShellyStatusSensor sdata, @Nullable Shelly2DeviceStatusPower value) {
 546         if (value == null) {
 547             return;
 548         }
 549         if (sdata.bat == null) {
 550             sdata.bat = new ShellySensorBat();
 551         }
 552
 553         if (value.battery != null) {
 554             sdata.bat.voltage = value.battery.volt;
 555             sdata.bat.value = value.battery.percent;
 556         }
 557         if (value.external != null) {
 558             sdata.charger = value.external.present;
 559         }
 560     }
 561
 562     private void postAlarms(@Nullable ArrayList<@Nullable String> errors) throws ShellyApiException {
 563         if (errors != null) {
 564             for (String e : errors) {
 565                 if (e != null) {
 566                     getThing().postEvent(e, false);
 567                 }
 568             }
 569         }
 570     }
 571
 572     protected @Nullable ArrayList<ShellySettingsInput> fillInputSettings(ShellyDeviceProfile profile,
 573             Shelly2GetConfigResult dc) {
 574         if (dc.input0 == null) {
 575             return null; // device has no input
 576         }
 577
 578         ArrayList<ShellySettingsInput> inputs = new ArrayList<>();
 579         addInputSettings(inputs, dc.input0);
 580         addInputSettings(inputs, dc.input1);
 581         addInputSettings(inputs, dc.input2);
 582         addInputSettings(inputs, dc.input3);
 583         return inputs;
 584     }
 585
 586     private void addInputSettings(ArrayList<ShellySettingsInput> inputs, @Nullable Shelly2DevConfigInput ic) {
 587         if (ic == null) {
 588             return;
 589         }
 590
 591         ShellySettingsInput settings = new ShellySettingsInput();
 592         settings.btnType = getString(ic.type).equalsIgnoreCase(SHELLY2_INPUTT_BUTTON) ? SHELLY_BTNT_MOMENTARY
 593                 : SHELLY_BTNT_EDGE;
 594         inputs.add(settings);
 595     }
 596
 597     protected boolean updateInputStatus(ShellySettingsStatus status, Shelly2DeviceStatusResult ds,
 598             boolean updateChannels) throws ShellyApiException {
 599         boolean updated = false;
 600         updated |= addInputStatus(status, ds.input0, updateChannels);
 601         updated |= addInputStatus(status, ds.input1, updateChannels);
 602         updated |= addInputStatus(status, ds.input2, updateChannels);
 603         updated |= addInputStatus(status, ds.input3, updateChannels);
 604         status.inputs = relayStatus.inputs;
 605         return updated;
 606     }
 607
 608     private boolean addInputStatus(ShellySettingsStatus status, @Nullable Shelly2InputStatus is, boolean updateChannels)
 609             throws ShellyApiException {
 610         if (is == null) {
 611             return false;
 612         }
 613         ShellyDeviceProfile profile = getProfile();
 614
 615         if (is.id == null || is.id > profile.numInputs) {
 616             logger.debug("{}: Invalid input id: {}", thingName, is.id);
 617             return false;
 618         }
 619
 620         String group = profile.getInputGroup(is.id);
 621         ShellyInputState input = relayStatus.inputs.size() > is.id ? relayStatus.inputs.get(is.id)
 622                 : new ShellyInputState();
 623         boolean updated = false;
 624         input.input = getBool(is.state) ? 1 : 0; // old format Integer, new one Boolean
 625         if (input.event == null && profile.inButtonMode(is.id)) {
 626             input.event = "";
 627             input.eventCount = 0;
 628         }
 629         if (is.percent != null) { // analogous input
 630             status.extAnalogInput = new ShellyExtAnalogInput(getDouble(is.percent));
 631         }
 632         relayStatus.inputs.set(is.id, input);
 633         if (updateChannels) {
 634             updated |= updateChannel(group, CHANNEL_INPUT + profile.getInputSuffix(is.id), getOnOff(getBool(is.state)));
 635         }
 636         return updated;
 637     }
 638
 639     protected Shelly2RpcBaseMessage buildRequest(String method, @Nullable Object params) throws ShellyApiException {
 640         Shelly2RpcBaseMessage request = new Shelly2RpcBaseMessage();
 641         request.id = Math.abs(random.nextInt());
 642         request.src = thingName;
 643         request.method = !method.contains(".") ? SHELLYRPC_METHOD_CLASS_SHELLY + "." + method : method;
 644         request.params = params;
 645         request.auth = authReq;
 646         return request;
 647     }
 648
 649     protected Shelly2AuthRequest buildAuthRequest(Shelly2AuthResponse authParm, String user, String realm,
 650             String password) throws ShellyApiException {
 651         Shelly2AuthRequest authReq = new Shelly2AuthRequest();
 652         authReq.username = "admin";
 653         authReq.realm = realm;
 654         authReq.nonce = authParm.nonce;
 655         authReq.cnonce = (long) Math.floor(Math.random() * 10e8);
 656         authReq.nc = authParm.nc != null ? authParm.nc : 1;
 657         authReq.authType = SHELLY2_AUTHTTYPE_DIGEST;
 658         authReq.algorithm = SHELLY2_AUTHALG_SHA256;
 659         String ha1 = sha256(authReq.username + ":" + authReq.realm + ":" + password);
 660         String ha2 = SHELLY2_AUTH_NOISE;
 661         authReq.response = sha256(
 662                 ha1 + ":" + authReq.nonce + ":" + authReq.nc + ":" + authReq.cnonce + ":" + "auth" + ":" + ha2);
 663         return authReq;
 664     }
 665
 666     protected String mapValue(Map<String, String> map, @Nullable String key) {
 667         String value;
 668         boolean known = key != null && !key.isEmpty() && map.containsKey(key);
 669         value = known ? getString(map.get(key)) : "";
 670         logger.trace("{}: API value {} was mapped to {}", thingName, key, known ? value : "UNKNOWN");
 671         return value;
 672     }
 673
 674     protected boolean updateChannel(String group, String channel, State value) throws ShellyApiException {
 675         return getThing().updateChannel(group, channel, value);
 676     }
 677
 678     protected ShellyThingInterface getThing() throws ShellyApiException {
 679         ShellyThingInterface t = thing;
 680         if (t != null) {
 681             return t;
 682         }
 683         throw new ShellyApiException("Thing/profile not initialized!");
 684     }
 685
 686     ShellyDeviceProfile getProfile() throws ShellyApiException {
 687         if (thing != null) {
 688             return thing.getProfile();
 689         }
 690         throw new ShellyApiException("Unable to get profile, thing not initialized!");
 691     }
 692 }