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.shelly.internal.handler;
  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.handler.ShellyComponents.*;
  19 import static org.openhab.binding.shelly.internal.util.ShellyUtils.*;
  20 import static org.openhab.core.thing.Thing.*;
  21
  22 import java.net.InetAddress;
  23 import java.net.UnknownHostException;
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.TreeMap;
  27 import java.util.concurrent.ScheduledFuture;
  28 import java.util.concurrent.TimeUnit;
  29
  30 import org.eclipse.jdt.annotation.NonNullByDefault;
  31 import org.eclipse.jdt.annotation.Nullable;
  32 import org.eclipse.jetty.client.HttpClient;
  33 import org.openhab.binding.shelly.internal.api.ShellyApiException;
  34 import org.openhab.binding.shelly.internal.api.ShellyApiInterface;
  35 import org.openhab.binding.shelly.internal.api.ShellyApiResult;
  36 import org.openhab.binding.shelly.internal.api.ShellyDeviceProfile;
  37 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO;
  38 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyFavPos;
  39 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyInputState;
  40 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyOtaCheckResult;
  41 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsDevice;
  42 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellySettingsStatus;
  43 import org.openhab.binding.shelly.internal.api1.Shelly1ApiJsonDTO.ShellyThermnostat;
  44 import org.openhab.binding.shelly.internal.api1.Shelly1CoapHandler;
  45 import org.openhab.binding.shelly.internal.api1.Shelly1CoapJSonDTO;
  46 import org.openhab.binding.shelly.internal.api1.Shelly1CoapServer;
  47 import org.openhab.binding.shelly.internal.api1.Shelly1HttpApi;
  48 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO;
  49 import org.openhab.binding.shelly.internal.api2.Shelly2ApiJsonDTO.Shelly2APClientList.Shelly2APClient;
  50 import org.openhab.binding.shelly.internal.api2.Shelly2ApiRpc;
  51 import org.openhab.binding.shelly.internal.api2.ShellyBluApi;
  52 import org.openhab.binding.shelly.internal.config.ShellyBindingConfiguration;
  53 import org.openhab.binding.shelly.internal.config.ShellyThingConfiguration;
  54 import org.openhab.binding.shelly.internal.discovery.ShellyBasicDiscoveryService;
  55 import org.openhab.binding.shelly.internal.discovery.ShellyThingCreator;
  56 import org.openhab.binding.shelly.internal.provider.ShellyChannelDefinitions;
  57 import org.openhab.binding.shelly.internal.provider.ShellyTranslationProvider;
  58 import org.openhab.binding.shelly.internal.util.ShellyChannelCache;
  59 import org.openhab.binding.shelly.internal.util.ShellyVersionDTO;
  60 import org.openhab.core.config.discovery.DiscoveryResult;
  61 import org.openhab.core.library.types.DecimalType;
  62 import org.openhab.core.library.types.OnOffType;
  63 import org.openhab.core.library.types.OpenClosedType;
  64 import org.openhab.core.library.types.QuantityType;
  65 import org.openhab.core.thing.Channel;
  66 import org.openhab.core.thing.ChannelUID;
  67 import org.openhab.core.thing.Thing;
  68 import org.openhab.core.thing.ThingStatus;
  69 import org.openhab.core.thing.ThingStatusDetail;
  70 import org.openhab.core.thing.ThingTypeUID;
  71 import org.openhab.core.thing.binding.BaseThingHandler;
  72 import org.openhab.core.thing.binding.builder.ThingBuilder;
  73 import org.openhab.core.thing.type.ChannelTypeUID;
  74 import org.openhab.core.types.Command;
  75 import org.openhab.core.types.RefreshType;
  76 import org.openhab.core.types.State;
  77 import org.openhab.core.types.StateOption;
  78 import org.openhab.core.types.UnDefType;
  79 import org.slf4j.Logger;
  80 import org.slf4j.LoggerFactory;
  81
  82 /**
  83  * The {@link ShellyBaseHandler} is responsible for handling commands, which are
  84  * sent to one of the channels.
  85  *
  86  * @author Markus Michels - Initial contribution
  87  */
  88 @NonNullByDefault
  89 public abstract class ShellyBaseHandler extends BaseThingHandler
  90         implements ShellyThingInterface, ShellyDeviceListener, ShellyManagerInterface {
  91
  92     protected final Logger logger = LoggerFactory.getLogger(ShellyBaseHandler.class);
  93     protected final ShellyChannelDefinitions channelDefinitions;
  94
  95     public String thingName = "";
  96     public String thingType = "";
  97
  98     protected final ShellyApiInterface api;
  99     private final HttpClient httpClient;
 100     private final ShellyThingTable thingTable;
 101
 102     private ShellyBindingConfiguration bindingConfig;
 103     protected ShellyThingConfiguration config = new ShellyThingConfiguration();
 104     protected ShellyDeviceProfile profile = new ShellyDeviceProfile(); // init empty profile to avoid NPE
 105     private ShellyDeviceStats stats = new ShellyDeviceStats();
 106     private @Nullable Shelly1CoapHandler coap;
 107
 108     private final ShellyTranslationProvider messages;
 109     private final ShellyChannelCache cache;
 110     private final int cacheCount = UPDATE_SETTINGS_INTERVAL_SECONDS / UPDATE_STATUS_INTERVAL_SECONDS;
 111
 112     private boolean gen2 = false;
 113     private final boolean blu;
 114     protected boolean autoCoIoT = false;
 115
 116     // Thing status
 117     private boolean channelsCreated = false;
 118     private boolean stopping = false;
 119     private int vibrationFilter = 0;
 120     private String lastWakeupReason = "";
 121
 122     // Scheduler
 123     private long watchdog = now();
 124     protected int scheduledUpdates = 0;
 125     private int skipCount = UPDATE_SKIP_COUNT;
 126     private int skipUpdate = 0;
 127     private boolean refreshSettings = false;
 128     private @Nullable ScheduledFuture<?> statusJob;
 129     private @Nullable ScheduledFuture<?> initJob;
 130
 131     /**
 132      * Constructor
 133      *
 134      * @param thing The Thing object
 135      * @param translationProvider
 136      * @param bindingConfig The binding configuration (beside thing
 137      *            configuration)
 138      * @param thingTable
 139      * @param coapServer coap server instance
 140      * @param httpClient from httpService
 141      */
 142     public ShellyBaseHandler(final Thing thing, final ShellyTranslationProvider translationProvider,
 143             final ShellyBindingConfiguration bindingConfig, ShellyThingTable thingTable,
 144             final Shelly1CoapServer coapServer, final HttpClient httpClient) {
 145         super(thing);
 146
 147         this.thingTable = thingTable;
 148         this.thingName = getString(thing.getLabel());
 149         this.messages = translationProvider;
 150         this.cache = new ShellyChannelCache(this);
 151         this.channelDefinitions = new ShellyChannelDefinitions(messages);
 152         this.bindingConfig = bindingConfig;
 153         this.config = getConfigAs(ShellyThingConfiguration.class);
 154         this.httpClient = httpClient;
 155
 156         // Create thing handler depending on device generation
 157         String thingType = getThingType();
 158         blu = ShellyDeviceProfile.isBluSeries(thingType);
 159         gen2 = ShellyDeviceProfile.isGeneration2(thingType);
 160         if (blu) {
 161             this.api = new ShellyBluApi(thingName, thingTable, this);
 162         } else if (gen2) {
 163             this.api = new Shelly2ApiRpc(thingName, thingTable, this);
 164         } else {
 165             this.api = new Shelly1HttpApi(thingName, this);
 166         }
 167         if (gen2) {
 168             config.eventsCoIoT = false;
 169         }
 170         if (config.eventsCoIoT) {
 171             this.coap = new Shelly1CoapHandler(this, coapServer);
 172         }
 173     }
 174
 175     @Override
 176     public boolean checkRepresentation(String key) {
 177         return key.equalsIgnoreCase(getUID()) || key.equalsIgnoreCase(config.deviceAddress)
 178                 || key.equalsIgnoreCase(config.serviceName) || key.equalsIgnoreCase(getThingName());
 179     }
 180
 181     /**
 182      * Schedule asynchronous Thing initialization, register thing to event dispatcher
 183      */
 184     @Override
 185     public void initialize() {
 186         // start background initialization:
 187         initJob = scheduler.schedule(() -> {
 188             boolean start = true;
 189             try {
 190                 if (initializeThingConfig()) {
 191                     logger.debug("{}: Config: {}", thingName, config);
 192                     start = initializeThing();
 193                 }
 194             } catch (ShellyApiException e) {
 195                 start = handleApiException(e);
 196             } catch (IllegalArgumentException e) {
 197                 logger.debug("{}: Unable to initialize, retrying later", thingName, e);
 198             } finally {
 199                 // even this initialization failed we start the status update
 200                 // the updateJob will then try to auto-initialize the thing
 201                 // in this case the thing stays in status INITIALIZING
 202                 if (start) {
 203                     startUpdateJob();
 204                 }
 205             }
 206         }, 2, TimeUnit.SECONDS);
 207     }
 208
 209     private boolean handleApiException(ShellyApiException e) {
 210         ShellyApiResult res = e.getApiResult();
 211         ThingStatusDetail errorCode = ThingStatusDetail.COMMUNICATION_ERROR;
 212         String status = "";
 213         boolean retry = true;
 214         if (e.isJsonError()) { // invalid JSON format
 215             logger.debug("{}: Unable to parse API response: {}; json={}", thingName, res.getUrl(), res.response, e);
 216             status = "offline.status-error-unexpected-error";
 217             errorCode = ThingStatusDetail.CONFIGURATION_ERROR;
 218             retry = false;
 219         } else if (res.isHttpAccessUnauthorized()) {
 220             status = "offline.conf-error-access-denied";
 221             errorCode = ThingStatusDetail.CONFIGURATION_ERROR;
 222             retry = false;
 223         } else if (isWatchdogExpired()) {
 224             status = "offline.status-error-watchdog";
 225         } else if (res.httpCode >= 400) {
 226             logger.debug("{}: Unexpected API result: {}/{}", thingName, res.httpCode, res.httpReason, e);
 227             status = "offline.status-error-unexpected-api-result";
 228             retry = false;
 229         } else if (profile.alwaysOn && (e.isConnectionError() || res.isHttpTimeout())) {
 230             status = "offline.status-error-connect";
 231         }
 232
 233         if (!status.isEmpty()) {
 234             setThingOfflineAndDisconnect(errorCode, status, e.toString());
 235         } else {
 236             logger.debug("{}: Unable to initialize: {}, retrying later", thingName, e.toString());
 237         }
 238
 239         if (!retry) {
 240             api.close();
 241         }
 242
 243         return retry;
 244     }
 245
 246     @Override
 247     public ShellyThingConfiguration getThingConfig() {
 248         return config;
 249     }
 250
 251     @Override
 252     public HttpClient getHttpClient() {
 253         return httpClient;
 254     }
 255
 256     @Override
 257     public void startScan() {
 258         if (api.isInitialized()) {
 259             api.startScan();
 260         }
 261
 262         checkRangeExtender(profile);
 263     }
 264
 265     /**
 266      * This routine is called every time the Thing configuration has been changed
 267      */
 268     @Override
 269     public void handleConfigurationUpdate(Map<String, Object> configurationParameters) {
 270         super.handleConfigurationUpdate(configurationParameters);
 271         logger.debug("{}: Thing config updated, re-initialize", thingName);
 272         if (coap != null) {
 273             coap.stop();
 274         }
 275         stopping = false;
 276         reinitializeThing();// force re-initialization
 277     }
 278
 279     /**
 280      * Initialize Thing: Initialize API access, get settings and initialize Device Profile
 281      * If the device is password protected and the credentials are missing or don't match the API access will throw an
 282      * Exception. In this case the thing type will be changed to shelly-unknown. The user has the option to edit the
 283      * thing config and set the correct credentials. The thing type will be changed to the requested one if the
 284      * credentials are correct and the API access is initialized successful.
 285      *
 286      * @throws ShellyApiException e.g. http returned non-ok response, check e.getMessage() for details.
 287      */
 288     public boolean initializeThing() throws ShellyApiException {
 289         // Init from thing type to have a basic profile, gets updated when device info is received from API
 290         refreshSettings = false;
 291         lastWakeupReason = "";
 292         cache.setThingName(thingName);
 293         cache.clear();
 294         resetStats();
 295
 296         profile.initFromThingType(thingType);
 297         logger.debug(
 298                 "{}: Start initializing for thing {}, type {}, Device address {}, Gen2: {}, isBlu: {}, alwaysOn: {}, hasBattery: {}, CoIoT: {}",
 299                 thingName, getThing().getLabel(), thingType, config.deviceAddress.toUpperCase(), gen2, profile.isBlu,
 300                 profile.alwaysOn, profile.hasBattery, config.eventsCoIoT);
 301         if (config.deviceAddress.isEmpty()) {
 302             setThingOfflineAndDisconnect(ThingStatusDetail.CONFIGURATION_ERROR,
 303                     "config-status.error.missing-device-address");
 304             return false;
 305         }
 306
 307         if (profile.alwaysOn || !profile.isInitialized()) {
 308             ThingStatusDetail detail = getThingStatusDetail();
 309             if (detail != ThingStatusDetail.DUTY_CYCLE) {
 310                 updateStatus(ThingStatus.ONLINE, ThingStatusDetail.CONFIGURATION_PENDING,
 311                         messages.get("status.config_pending"));
 312             }
 313         }
 314
 315         // Gen 1 only: Setup CoAP listener to we get the CoAP message, which triggers initialization even the thing
 316         // could not be fully initialized here. In this case the CoAP messages triggers auto-initialization (like the
 317         // Action URL does when enabled)
 318         if (coap != null && config.eventsCoIoT && !profile.alwaysOn) {
 319             coap.start(thingName, config);
 320         }
 321
 322         // Initialize API access, exceptions will be catched by initialize()
 323         api.initialize();
 324         ShellySettingsDevice device = profile.device = api.getDeviceInfo();
 325         if (getBool(device.auth) && config.password.isEmpty()) {
 326             setThingOfflineAndDisconnect(ThingStatusDetail.CONFIGURATION_ERROR, "offline.conf-error-no-credentials");
 327             return false;
 328         }
 329         if (config.serviceName.isEmpty()) {
 330             config.serviceName = getString(device.hostname).toLowerCase();
 331         }
 332
 333         api.setConfig(thingName, config);
 334         ShellyDeviceProfile tmpPrf = api.getDeviceProfile(thingType, profile.device);
 335         String mode = getString(tmpPrf.device.mode);
 336         if (this.getThing().getThingTypeUID().equals(THING_TYPE_SHELLYPROTECTED)) {
 337             changeThingType(thingName, mode);
 338             return false; // force re-initialization
 339         }
 340         // Validate device mode
 341         String reqMode = thingType.contains("-") ? substringAfter(thingType, "-") : "";
 342         if (!reqMode.isEmpty() && !mode.equals(reqMode)) {
 343             setThingOfflineAndDisconnect(ThingStatusDetail.CONFIGURATION_ERROR, "offline.conf-error-wrong-mode", mode,
 344                     reqMode);
 345             return false;
 346         }
 347         if (!getString(tmpPrf.device.coiot).isEmpty()) {
 348             // New Shelly devices might use a different endpoint for the CoAP listener
 349             tmpPrf.coiotEndpoint = tmpPrf.device.coiot;
 350         }
 351         if (tmpPrf.settings.sleepMode != null && !tmpPrf.isTRV) {
 352             // Sensor, usually 12h, H&T in USB mode 10min
 353             tmpPrf.updatePeriod = "m".equalsIgnoreCase(getString(tmpPrf.settings.sleepMode.unit))
 354                     ? tmpPrf.settings.sleepMode.period * 60 // minutes
 355                     : tmpPrf.settings.sleepMode.period * 3600; // hours
 356             tmpPrf.updatePeriod += 60; // give 1min extra
 357         } else if (tmpPrf.settings.coiot != null && tmpPrf.settings.coiot.updatePeriod != null) {
 358             // Derive from CoAP update interval, usually 2*15+10s=40sec -> 70sec
 359             tmpPrf.updatePeriod = Math.max(UPDATE_SETTINGS_INTERVAL_SECONDS,
 360                     2 * getInteger(tmpPrf.settings.coiot.updatePeriod)) + 10;
 361         } else {
 362             tmpPrf.updatePeriod = UPDATE_SETTINGS_INTERVAL_SECONDS + 10;
 363         }
 364
 365         tmpPrf.status = api.getStatus(); // update thing properties
 366         tmpPrf.updateFromStatus(tmpPrf.status);
 367         addStateOptions(tmpPrf);
 368
 369         // update thing properties
 370         updateProperties(tmpPrf, tmpPrf.status);
 371         checkVersion(tmpPrf, tmpPrf.status);
 372
 373         // Check for Range Extender mode, add secondary device to Inbox
 374         checkRangeExtender(tmpPrf);
 375
 376         startCoap(config, tmpPrf);
 377         if (!gen2 && !blu) {
 378             api.setActionURLs(); // register event urls
 379         }
 380
 381         // All initialization done, so keep the profile and set Thing to ONLINE
 382         fillDeviceStatus(tmpPrf.status, false);
 383         postEvent(ALARM_TYPE_NONE, false);
 384
 385         profile = tmpPrf;
 386         showThingConfig(profile);
 387
 388         logger.debug("{}: Thing successfully initialized.", thingName);
 389         updateProperties(profile, profile.status);
 390         setThingOnline(); // if API call was successful the thing must be online
 391         return true; // success
 392     }
 393
 394     /**
 395      * Handle Channel Commands
 396      */
 397     @Override
 398     public void handleCommand(ChannelUID channelUID, Command command) {
 399         try {
 400             if (command instanceof RefreshType) {
 401                 String channelId = channelUID.getId();
 402                 State value = cache.getValue(channelId);
 403                 if (value != UnDefType.NULL) {
 404                     updateState(channelId, value);
 405                 }
 406                 return;
 407             }
 408
 409             if (!profile.isInitialized()) {
 410                 logger.debug("{}: {}", thingName, messages.get("command.init", command));
 411                 initializeThing();
 412             } else {
 413                 profile = getProfile(false);
 414             }
 415
 416             boolean update = false;
 417             switch (channelUID.getIdWithoutGroup()) {
 418                 case CHANNEL_SENSE_KEY: // Shelly Sense: Send Key
 419                     logger.debug("{}: Send key {}", thingName, command);
 420                     api.sendIRKey(command.toString());
 421                     update = true;
 422                     break;
 423
 424                 case CHANNEL_LED_STATUS_DISABLE:
 425                     logger.debug("{}: Set STATUS LED disabled to {}", thingName, command);
 426                     api.setLedStatus(SHELLY_LED_STATUS_DISABLE, command == OnOffType.ON);
 427                     break;
 428                 case CHANNEL_LED_POWER_DISABLE:
 429                     logger.debug("{}: Set POWER LED disabled to {}", thingName, command);
 430                     api.setLedStatus(SHELLY_LED_POWER_DISABLE, command == OnOffType.ON);
 431                     break;
 432
 433                 case CHANNEL_SENSOR_SLEEPTIME:
 434                     logger.debug("{}: Set sensor sleep time to {}", thingName, command);
 435                     int value = getNumber(command).intValue();
 436                     value = value > 0 ? Math.max(SHELLY_MOTION_SLEEPTIME_OFFSET, value - SHELLY_MOTION_SLEEPTIME_OFFSET)
 437                             : 0;
 438                     api.setSleepTime(value);
 439                     break;
 440                 case CHANNEL_CONTROL_SCHEDULE:
 441                     if (profile.isTRV) {
 442                         logger.debug("{}: {} Valve schedule/profile", thingName,
 443                                 command == OnOffType.ON ? "Enable" : "Disable");
 444                         api.setValveProfile(0,
 445                                 command == OnOffType.OFF ? 0 : profile.status.thermostats.get(0).profile);
 446                     }
 447                     break;
 448                 case CHANNEL_CONTROL_PROFILE:
 449                     logger.debug("{}: Select profile {}", thingName, command);
 450                     int id = -1;
 451                     if (command instanceof Number) {
 452                         id = getNumber(command).intValue();
 453                     } else {
 454                         String cmd = command.toString();
 455                         if (isDigit(cmd.charAt(0))) {
 456                             id = Integer.parseInt(cmd);
 457                         } else if (profile.settings.thermostats != null) {
 458                             ShellyThermnostat t = profile.settings.thermostats.get(0);
 459                             for (int i = 0; i < t.profileNames.length; i++) {
 460                                 if (t.profileNames[i].equalsIgnoreCase(cmd)) {
 461                                     id = i + 1;
 462                                 }
 463                             }
 464                         }
 465                     }
 466                     if (id < 0 || id > 5) {
 467                         logger.warn("{}: Invalid profile Id {} requested", thingName, profile);
 468                         break;
 469                     }
 470                     api.setValveProfile(0, id);
 471                     break;
 472                 case CHANNEL_CONTROL_MODE:
 473                     logger.debug("{}: Set mode to {}", thingName, command);
 474                     api.setValveMode(0, CHANNEL_CONTROL_MODE.equalsIgnoreCase(command.toString()));
 475                     break;
 476                 case CHANNEL_CONTROL_SETTEMP:
 477                     logger.debug("{}: Set temperature to {}", thingName, command);
 478                     api.setValveTemperature(0, getNumber(command).doubleValue());
 479                     break;
 480                 case CHANNEL_CONTROL_POSITION:
 481                     logger.debug("{}: Set position to {}", thingName, command);
 482                     api.setValvePosition(0, getNumber(command));
 483                     break;
 484                 case CHANNEL_CONTROL_BCONTROL:
 485                     logger.debug("{}: Set boost mode to {}", thingName, command);
 486                     api.startValveBoost(0, command == OnOffType.ON ? -1 : 0);
 487                     break;
 488                 case CHANNEL_CONTROL_BTIMER:
 489                     logger.debug("{}: Set boost timer to {}", thingName, command);
 490                     api.setValveBoostTime(0, getNumber(command).intValue());
 491                     break;
 492                 case CHANNEL_SENSOR_MUTE:
 493                     if (profile.isSmoke && ((OnOffType) command) == OnOffType.ON) {
 494                         logger.debug("{}: Mute Smoke Alarm", thingName);
 495                         api.muteSmokeAlarm(0);
 496                         updateChannel(getString(channelUID.getGroupId()), CHANNEL_SENSOR_MUTE, OnOffType.OFF);
 497                     }
 498                     break;
 499                 default:
 500                     update = handleDeviceCommand(channelUID, command);
 501                     break;
 502             }
 503
 504             restartWatchdog();
 505             if (update && !autoCoIoT && !isUpdateScheduled()) {
 506                 requestUpdates(1, false);
 507             }
 508         } catch (ShellyApiException e) {
 509             if (!handleApiException(e)) {
 510                 return;
 511             }
 512
 513             ShellyApiResult res = e.getApiResult();
 514             if (res.isNotCalibrtated()) {
 515                 logger.warn("{}: {}", thingName, messages.get("roller.calibrating"));
 516             } else {
 517                 logger.warn("{}: {} - {}", thingName, messages.get("command.failed", command, channelUID),
 518                         e.toString());
 519             }
 520
 521             String group = getString(channelUID.getGroupId());
 522             String channel = getString(channelUID.getIdWithoutGroup());
 523             State oldValue = getChannelValue(group, channel);
 524             if (oldValue != UnDefType.NULL) {
 525                 logger.info("{}: Restore channel value to {}", thingName, oldValue);
 526                 updateChannel(group, channel, oldValue);
 527             }
 528
 529         } catch (IllegalArgumentException e) {
 530             logger.debug("{}: {}", thingName, messages.get("command.failed", command, channelUID));
 531         }
 532     }
 533
 534     /**
 535      * Update device status and channels
 536      */
 537     protected void refreshStatus() {
 538         try {
 539             boolean updated = false;
 540
 541             if (vibrationFilter > 0) {
 542                 vibrationFilter--;
 543                 logger.debug("{}: Vibration events are absorbed for {} more seconds", thingName,
 544                         vibrationFilter * UPDATE_STATUS_INTERVAL_SECONDS);
 545             }
 546
 547             skipUpdate++;
 548             ThingStatus thingStatus = getThing().getStatus();
 549             if (refreshSettings || (scheduledUpdates > 0) || (skipUpdate % skipCount == 0)) {
 550                 if (!profile.isInitialized() || ((thingStatus == ThingStatus.OFFLINE))
 551                         || (getThingStatusDetail() == ThingStatusDetail.CONFIGURATION_PENDING)) {
 552                     logger.debug("{}: Status update triggered thing initialization", thingName);
 553                     initializeThing(); // may fire an exception if initialization failed
 554                 }
 555                 ShellySettingsStatus status = api.getStatus();
 556                 boolean restarted = checkRestarted(status);
 557                 profile = getProfile(refreshSettings || restarted);
 558                 profile.status = status;
 559                 profile.updateFromStatus(status);
 560                 if (restarted) {
 561                     logger.debug("{}: Device restart #{} detected", thingName, stats.restarts);
 562                     stats.restarts++;
 563                     postEvent(ALARM_TYPE_RESTARTED, true);
 564                 }
 565
 566                 // If status update was successful the thing must be online,
 567                 // but not while firmware update is in progress
 568                 if (getThingStatusDetail() != ThingStatusDetail.FIRMWARE_UPDATING) {
 569                     setThingOnline();
 570                 }
 571
 572                 // map status to channels
 573                 updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_NAME, getStringType(profile.settings.name));
 574                 updated |= this.updateDeviceStatus(status);
 575                 updated |= ShellyComponents.updateDeviceStatus(this, status);
 576                 fillDeviceStatus(status, updated);
 577                 updated |= updateInputs(status);
 578                 updated |= updateMeters(this, status);
 579                 updated |= updateSensors(this, status);
 580
 581                 // All channels must be created after the first cycle
 582                 channelsCreated = true;
 583             }
 584         } catch (ShellyApiException e) {
 585             // http call failed: go offline except for battery devices, which might be in
 586             // sleep mode. Once the next update is successful the device goes back online
 587             handleApiException(e);
 588         } catch (NullPointerException | IllegalArgumentException e) {
 589             logger.debug("{}: Unable to refresh status: {}", thingName, messages.get("statusupdate.failed"), e);
 590         } finally {
 591             if (scheduledUpdates > 0) {
 592                 --scheduledUpdates;
 593                 logger.trace("{}: {} more updates requested", thingName, scheduledUpdates);
 594             } else if ((skipUpdate >= cacheCount) && !cache.isEnabled()) {
 595                 logger.debug("{}: Enabling channel cache ({} updates / {}s)", thingName, skipUpdate,
 596                         cacheCount * UPDATE_STATUS_INTERVAL_SECONDS);
 597                 cache.enable();
 598             }
 599         }
 600     }
 601
 602     private void checkRangeExtender(ShellyDeviceProfile prf) {
 603         if (getBool(prf.settings.rangeExtender) && config.enableRangeExtender && prf.status.rangeExtender != null
 604                 && prf.status.rangeExtender.apClients != null) {
 605             for (Shelly2APClient client : profile.status.rangeExtender.apClients) {
 606                 String secondaryIp = config.deviceIp + ":" + client.mport.toString();
 607                 String name = "shellyplusrange-" + client.mac.replaceAll(":", "");
 608                 DiscoveryResult result = ShellyBasicDiscoveryService.createResult(true, name, secondaryIp,
 609                         bindingConfig, httpClient, messages);
 610                 if (result != null) {
 611                     thingTable.discoveredResult(result);
 612                 }
 613             }
 614         }
 615     }
 616
 617     private void showThingConfig(ShellyDeviceProfile profile) {
 618         logger.debug("{}: Initializing device {}, type {}, Hardware: Rev: {}, batch {}; Firmware: {} / {}", thingName,
 619                 profile.device.hostname, profile.device.type, profile.hwRev, profile.hwBatchId, profile.fwVersion,
 620                 profile.fwDate);
 621         logger.debug("{}: Shelly settings info for {}: {}", thingName, profile.device.hostname, profile.settingsJson);
 622         logger.debug("{}: Device "
 623                 + "hasRelays:{} (numRelays={}),isRoller:{} (numRoller={}),isDimmer:{},numMeter={},isEMeter:{}), ext. Switch Add-On: {}"
 624                 + ",isSensor:{},isDS:{},hasBattery:{}{},isSense:{},isMotion:{},isLight:{},isBulb:{},isDuo:{},isRGBW2:{},inColor:{}, BLU Gateway support: {}"
 625                 + ",alwaysOn:{}, updatePeriod:{}sec", thingName, profile.hasRelays, profile.numRelays, profile.isRoller,
 626                 profile.numRollers, profile.isDimmer, profile.numMeters, profile.isEMeter,
 627                 profile.settings.extSwitch != null ? "installed" : "n/a", profile.isSensor, profile.isDW,
 628                 profile.hasBattery, profile.hasBattery ? " (low battery threshold=" + config.lowBattery + "%)" : "",
 629                 profile.isSense, profile.isMotion, profile.isLight, profile.isBulb, profile.isDuo, profile.isRGBW2,
 630                 profile.inColor, profile.alwaysOn, profile.updatePeriod, config.enableBluGateway);
 631         if (profile.status.extTemperature != null || profile.status.extHumidity != null
 632                 || profile.status.extVoltage != null || profile.status.extAnalogInput != null) {
 633             logger.debug("{}: Shelly Add-On detected with at least 1 external sensor", thingName);
 634         }
 635     }
 636
 637     private void addStateOptions(ShellyDeviceProfile prf) {
 638         if (prf.isTRV) {
 639             String[] profileNames = prf.getValveProfileList(0);
 640             String channelId = mkChannelId(CHANNEL_GROUP_CONTROL, CHANNEL_CONTROL_PROFILE);
 641             logger.debug("{}: Adding TRV profile names to channel description: {}", thingName, profileNames);
 642             channelDefinitions.clearStateOptions(channelId);
 643             int fid = 1;
 644             for (String name : profileNames) {
 645                 channelDefinitions.addStateOption(channelId, "" + fid, fid + ": " + name);
 646                 fid++;
 647             }
 648         }
 649         if (prf.isRoller && prf.settings.favorites != null) {
 650             String channelId = mkChannelId(CHANNEL_GROUP_ROL_CONTROL, CHANNEL_ROL_CONTROL_FAV);
 651             logger.debug("{}: Adding {} roler favorite(s) to channel description", thingName,
 652                     prf.settings.favorites.size());
 653             channelDefinitions.clearStateOptions(channelId);
 654             int fid = 1;
 655             for (ShellyFavPos fav : prf.settings.favorites) {
 656                 channelDefinitions.addStateOption(channelId, "" + fid, fid + ": " + fav.name);
 657                 fid++;
 658             }
 659         }
 660     }
 661
 662     @Override
 663     public String getThingType() {
 664         return thing.getThingTypeUID().getId();
 665     }
 666
 667     @Override
 668     public ThingStatus getThingStatus() {
 669         return thing.getStatus();
 670     }
 671
 672     @Override
 673     public ThingStatusDetail getThingStatusDetail() {
 674         return thing.getStatusInfo().getStatusDetail();
 675     }
 676
 677     @Override
 678     public boolean isThingOnline() {
 679         return getThingStatus() == ThingStatus.ONLINE
 680                 && getThingStatusDetail() != ThingStatusDetail.CONFIGURATION_PENDING;
 681     }
 682
 683     public boolean isThingOffline() {
 684         return getThingStatus() == ThingStatus.OFFLINE;
 685     }
 686
 687     @Override
 688     public void setThingOnline() {
 689         if (!isThingOnline()) {
 690             updateStatus(ThingStatus.ONLINE);
 691
 692             // request 3 updates in a row (during the first 2+3*3 sec)
 693             requestUpdates(profile.alwaysOn ? 3 : 1, !channelsCreated);
 694         }
 695
 696         // Restart watchdog when status update was successful (no exception)
 697         restartWatchdog();
 698     }
 699
 700     @Override
 701     public void setThingOfflineAndDisconnect(ThingStatusDetail detail, String messageKey, Object... arguments) {
 702         if (!isThingOffline()) {
 703             updateStatus(ThingStatus.OFFLINE, detail, messages.get(messageKey, arguments));
 704         }
 705         api.close(); // Gen2: disconnect WS/close http sessions
 706         watchdog = 0;
 707         channelsCreated = false; // check for new channels after devices gets re-initialized (e.g. new
 708     }
 709
 710     @Override
 711     public void setThingStatus(ThingStatus status, ThingStatusDetail detail, String messageKey, Object... arguments) {
 712         updateStatus(status, detail, messages.get(messageKey, arguments));
 713     }
 714
 715     @Override
 716     public void restartWatchdog() {
 717         watchdog = now();
 718         updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_HEARTBEAT, getTimestamp());
 719         logger.trace("{}: Watchdog restarted (expires in {} sec)", thingName, profile.updatePeriod);
 720     }
 721
 722     private boolean isWatchdogExpired() {
 723         long delta = now() - watchdog;
 724         if ((watchdog > 0) && (delta > profile.updatePeriod)) {
 725             stats.remainingWatchdog = delta;
 726             return true;
 727         }
 728         return false;
 729     }
 730
 731     @Override
 732     public void reinitializeThing() {
 733         logger.debug("{}: Re-Initialize Thing", thingName);
 734         if (isStopping()) {
 735             logger.debug("{}: Handler is shutting down, ignore", thingName);
 736             return;
 737         }
 738         updateStatus(ThingStatus.ONLINE, ThingStatusDetail.CONFIGURATION_PENDING,
 739                 messages.get("offline.status-error-restarted"));
 740         requestUpdates(0, true);
 741     }
 742
 743     @Override
 744     public boolean isStopping() {
 745         return stopping;
 746     }
 747
 748     @Override
 749     public void fillDeviceStatus(ShellySettingsStatus status, boolean updated) {
 750         String alarm = "";
 751
 752         // Update uptime and WiFi, internal temp
 753         ShellyComponents.updateDeviceStatus(this, status);
 754         stats.wifiRssi = getInteger(status.wifiSta.rssi);
 755
 756         if (api.isInitialized()) {
 757             stats.timeoutErrors = api.getTimeoutErrors();
 758             stats.timeoutsRecorvered = api.getTimeoutsRecovered();
 759         }
 760         stats.remainingWatchdog = watchdog > 0 ? now() - watchdog : 0;
 761
 762         // Check various device indicators like overheating
 763         if (checkRestarted(status)) {
 764             // Force re-initialization on next status update
 765             reinitializeThing();
 766         } else if (getBool(status.overtemperature)) {
 767             alarm = ALARM_TYPE_OVERTEMP;
 768         } else if (getBool(status.overload)) {
 769             alarm = ALARM_TYPE_OVERLOAD;
 770         } else if (getBool(status.loaderror)) {
 771             alarm = ALARM_TYPE_LOADERR;
 772         }
 773         State internalTemp = getChannelValue(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_ITEMP);
 774         if (internalTemp != UnDefType.NULL) {
 775             int temp = ((Number) internalTemp).intValue();
 776             if (temp > stats.maxInternalTemp) {
 777                 stats.maxInternalTemp = temp;
 778             }
 779         }
 780
 781         if (status.uptime != null) {
 782             stats.lastUptime = getLong(status.uptime);
 783         }
 784
 785         if (!alarm.isEmpty()) {
 786             postEvent(alarm, false);
 787         }
 788     }
 789
 790     @Override
 791     public void incProtMessages() {
 792         stats.protocolMessages++;
 793     }
 794
 795     @Override
 796     public void incProtErrors() {
 797         stats.protocolErrors++;
 798     }
 799
 800     /**
 801      * Check if device has restarted and needs a new Thing initialization
 802      *
 803      * @return true: restart detected
 804      */
 805
 806     private boolean checkRestarted(ShellySettingsStatus status) {
 807         if (profile.isInitialized() && profile.alwaysOn /* exclude battery powered devices */
 808                 && (status.uptime != null && status.uptime < stats.lastUptime
 809                         || (profile.status.update != null && !getString(profile.status.update.oldVersion).isEmpty()
 810                                 && !status.update.oldVersion.equals(profile.status.update.oldVersion)))) {
 811             logger.debug("{}: Device has been restarted, uptime={}/{}, firmware={}/{}", thingName, stats.lastUptime,
 812                     getLong(status.uptime), profile.status.update.oldVersion, status.update.oldVersion);
 813             updateProperties(profile, status);
 814             return true;
 815         }
 816         return false;
 817     }
 818
 819     /**
 820      * Save alarm to the lastAlarm channel
 821      *
 822      * @param event Alarm Message
 823      * @param force
 824      */
 825     @Override
 826     public void postEvent(String event, boolean force) {
 827         String channelId = mkChannelId(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_ALARM);
 828         State value = cache.getValue(channelId);
 829         String lastAlarm = value != UnDefType.NULL ? value.toString() : "";
 830
 831         if (force || !lastAlarm.equals(event)
 832                 || (lastAlarm.equals(event) && now() > stats.lastAlarmTs + HEALTH_CHECK_INTERVAL_SEC)) {
 833             switch (event.toUpperCase()) {
 834                 case "":
 835                 case "0": // DW2 1.8
 836                 case SHELLY_WAKEUPT_SENSOR:
 837                 case SHELLY_WAKEUPT_PERIODIC:
 838                 case SHELLY_WAKEUPT_BUTTON:
 839                 case SHELLY_WAKEUPT_POWERON:
 840                 case SHELLY_WAKEUPT_EXT_POWER:
 841                 case SHELLY_WAKEUPT_UNKNOWN:
 842                 case Shelly2ApiJsonDTO.SHELLY2_EVENT_OTASTART:
 843                 case Shelly2ApiJsonDTO.SHELLY2_EVENT_OTAPROGRESS:
 844                 case Shelly2ApiJsonDTO.SHELLY2_EVENT_OTADONE:
 845                 case SHELLY_EVENT_ROLLER_CALIB:
 846                     logger.debug("{}: {}", thingName, messages.get("event.filtered", event));
 847                 case ALARM_TYPE_NONE:
 848                     break;
 849                 default:
 850                     logger.debug("{}: {}", thingName, messages.get("event.triggered", event));
 851                     triggerChannel(channelId, event);
 852                     cache.updateChannel(channelId, getStringType(event.toUpperCase()));
 853                     stats.lastAlarm = event;
 854                     stats.lastAlarmTs = now();
 855                     stats.alarms++;
 856             }
 857         }
 858     }
 859
 860     public boolean isUpdateScheduled() {
 861         return scheduledUpdates > 0;
 862     }
 863
 864     /**
 865      * Callback for device events
 866      *
 867      * @param address
 868      * @param deviceName device receiving the event
 869      * @param deviceIndex
 870      * @param type the HTML input data
 871      * @param parameters parameters from the event URL
 872      * @return true if event was processed
 873      */
 874     @Override
 875     public boolean onEvent(String address, String deviceName, String deviceIndex, String type,
 876             Map<String, String> parameters) {
 877         if (thingName.equalsIgnoreCase(deviceName) || config.deviceAddress.equals(address)
 878                 || config.serviceName.equals(deviceName)) {
 879             logger.debug("{}: Event received: class={}, index={}, parameters={}", deviceName, type, deviceIndex,
 880                     parameters);
 881             int idx = !deviceIndex.isEmpty() ? Integer.parseInt(deviceIndex) : 1;
 882             if (!profile.isInitialized()) {
 883                 logger.debug("{}: Device is not yet initialized, event triggers initialization", deviceName);
 884                 requestUpdates(1, true);
 885             } else {
 886                 String group = profile.getControlGroup(idx);
 887                 if (group.isEmpty()) {
 888                     logger.debug("{}: Unsupported event class: {}", thingName, type);
 889                     return false;
 890                 }
 891
 892                 // map some of the events to system defined button triggers
 893                 String channel = "";
 894                 String onoff = "";
 895                 String payload = "";
 896                 String parmType = getString(parameters.get("type"));
 897                 String event = !parmType.isEmpty() ? parmType : type;
 898                 boolean isButton = profile.inButtonMode(idx - 1) || "button".equals(type);
 899                 switch (event) {
 900                     case SHELLY_EVENT_SHORTPUSH:
 901                     case SHELLY_EVENT_DOUBLE_SHORTPUSH:
 902                     case SHELLY_EVENT_TRIPLE_SHORTPUSH:
 903                     case SHELLY_EVENT_LONGPUSH:
 904                         if (isButton) {
 905                             triggerButton(group, idx, mapButtonEvent(event));
 906                             channel = CHANNEL_BUTTON_TRIGGER + profile.getInputSuffix(idx);
 907                             payload = Shelly1ApiJsonDTO.mapButtonEvent(event);
 908                         } else {
 909                             logger.debug("{}: Relay button is not in memontary or detached mode, ignore SHORT/LONGPUSH",
 910                                     thingName);
 911                         }
 912                         break;
 913                     case SHELLY_EVENT_BTN_ON:
 914                     case SHELLY_EVENT_BTN_OFF:
 915                         if (profile.isRGBW2) {
 916                             // RGBW2 has only one input, so not per channel
 917                             group = CHANNEL_GROUP_LIGHT_CONTROL;
 918                         }
 919                         onoff = CHANNEL_INPUT;
 920                         break;
 921                     case SHELLY_EVENT_BTN1_ON:
 922                     case SHELLY_EVENT_BTN1_OFF:
 923                         onoff = CHANNEL_INPUT1;
 924                         break;
 925                     case SHELLY_EVENT_BTN2_ON:
 926                     case SHELLY_EVENT_BTN2_OFF:
 927                         onoff = CHANNEL_INPUT2;
 928                         break;
 929                     case SHELLY_EVENT_OUT_ON:
 930                     case SHELLY_EVENT_OUT_OFF:
 931                         onoff = CHANNEL_OUTPUT;
 932                         break;
 933                     case SHELLY_EVENT_ROLLER_OPEN:
 934                     case SHELLY_EVENT_ROLLER_CLOSE:
 935                     case SHELLY_EVENT_ROLLER_STOP:
 936                         channel = CHANNEL_EVENT_TRIGGER;
 937                         payload = event;
 938                         break;
 939                     case SHELLY_EVENT_SENSORREPORT:
 940                         // process sensor with next refresh
 941                         break;
 942                     case SHELLY_EVENT_TEMP_OVER: // DW2
 943                     case SHELLY_EVENT_TEMP_UNDER:
 944                         channel = CHANNEL_EVENT_TRIGGER;
 945                         payload = event;
 946                         break;
 947                     case SHELLY_EVENT_FLOOD_DETECTED:
 948                     case SHELLY_EVENT_FLOOD_GONE:
 949                         updateChannel(group, CHANNEL_SENSOR_FLOOD,
 950                                 OnOffType.from(event.equalsIgnoreCase(SHELLY_EVENT_FLOOD_DETECTED)));
 951                         break;
 952
 953                     case SHELLY_EVENT_CLOSE: // DW 1.7
 954                     case SHELLY_EVENT_OPEN: // DW 1.7
 955                         updateChannel(group, CHANNEL_SENSOR_STATE,
 956                                 event.equalsIgnoreCase(SHELLY_API_DWSTATE_OPEN) ? OpenClosedType.OPEN
 957                                         : OpenClosedType.CLOSED);
 958                         break;
 959
 960                     case SHELLY_EVENT_DARK: // DW 1.7
 961                     case SHELLY_EVENT_TWILIGHT: // DW 1.7
 962                     case SHELLY_EVENT_BRIGHT: // DW 1.7
 963                         updateChannel(group, CHANNEL_SENSOR_ILLUM, getStringType(event));
 964                         break;
 965
 966                     case SHELLY_EVENT_ALARM_MILD: // Shelly Gas
 967                     case SHELLY_EVENT_ALARM_HEAVY:
 968                     case SHELLY_EVENT_ALARM_OFF:
 969                     case SHELLY_EVENT_VIBRATION: // DW2
 970                         channel = CHANNEL_SENSOR_ALARM_STATE;
 971                         payload = event.toUpperCase();
 972                         break;
 973
 974                     default:
 975                         // trigger will be provided by input/output channel or sensor channels
 976                 }
 977
 978                 if (!onoff.isEmpty()) {
 979                     updateChannel(group, onoff, OnOffType.from(event.toLowerCase().contains("_on")));
 980                 }
 981                 if (!payload.isEmpty()) {
 982                     // Pass event to trigger channel
 983                     payload = payload.toUpperCase();
 984                     logger.debug("{}: Post event {}", thingName, payload);
 985                     triggerChannel(mkChannelId(group, channel), payload);
 986                 }
 987             }
 988
 989             // request update on next interval (2x for non-battery devices)
 990             restartWatchdog();
 991             requestUpdates(scheduledUpdates >= 2 ? 0 : !profile.hasBattery ? 2 : 1, true);
 992             return true;
 993         }
 994         return false;
 995     }
 996
 997     /**
 998      * Initialize the binding's thing configuration, calc update counts
 999      */
1000     protected boolean initializeThingConfig() {
1001         thingType = getThing().getThingTypeUID().getId();
1002         final Map<String, String> properties = getThing().getProperties();
1003         thingName = getString(properties.get(PROPERTY_SERVICE_NAME));
1004         if (thingName.isEmpty()) {
1005             thingName = getString(thingType + "-" + getString(getThing().getUID().getId())).toLowerCase();
1006         }
1007
1008         config = getConfigAs(ShellyThingConfiguration.class);
1009         if (config.deviceAddress.isEmpty()) {
1010             config.deviceAddress = config.deviceIp;
1011         }
1012         if (config.deviceAddress.isEmpty()) {
1013             logger.debug("{}: IP/MAC address for the device must not be empty", thingName); // may not set in .things
1014                                                                                             // file
1015             return false;
1016         }
1017
1018         config.deviceAddress = config.deviceAddress.toLowerCase().replace(":", ""); // remove : from MAC address and
1019                                                                                     // convert to lower case
1020         if (!config.deviceIp.isEmpty()) {
1021             try {
1022                 String ip = config.deviceIp.contains(":") ? substringBefore(config.deviceIp, ":") : config.deviceIp;
1023                 String port = config.deviceIp.contains(":") ? substringAfter(config.deviceIp, ":") : "";
1024                 InetAddress addr = InetAddress.getByName(ip);
1025                 String saddr = addr.getHostAddress();
1026                 if (!ip.equals(saddr)) {
1027                     logger.debug("{}: hostname {} resolved to IP address {}", thingName, config.deviceIp, saddr);
1028                     config.deviceIp = saddr + (port.isEmpty() ? "" : ":" + port);
1029                 }
1030             } catch (UnknownHostException e) {
1031                 logger.debug("{}: Unable to resolve hostname {}", thingName, config.deviceIp);
1032             }
1033         }
1034
1035         config.serviceName = getString(properties.get(PROPERTY_SERVICE_NAME));
1036         config.localIp = bindingConfig.localIP;
1037         config.localPort = String.valueOf(bindingConfig.httpPort);
1038         if (config.localIp.startsWith("169.254")) {
1039             setThingOfflineAndDisconnect(ThingStatusDetail.COMMUNICATION_ERROR, "config-status.error.network-config",
1040                     config.localIp);
1041             return false;
1042         }
1043
1044         if (!profile.isGen2 && config.userId.isEmpty() && !bindingConfig.defaultUserId.isEmpty()) {
1045             // Gen2 has hard coded user "admin"
1046             config.userId = bindingConfig.defaultUserId;
1047             logger.debug("{}: Using default userId {} from binding config", thingName, config.userId);
1048         }
1049         if (config.password.isEmpty() && !bindingConfig.defaultPassword.isEmpty()) {
1050             config.password = bindingConfig.defaultPassword;
1051             logger.debug("{}: Using default password from bindingConfig (userId={})", thingName, config.userId);
1052         }
1053
1054         if (config.updateInterval == 0) {
1055             config.updateInterval = UPDATE_STATUS_INTERVAL_SECONDS * UPDATE_SKIP_COUNT;
1056         }
1057         if (config.updateInterval < UPDATE_MIN_DELAY) {
1058             config.updateInterval = UPDATE_MIN_DELAY;
1059         }
1060
1061         // Try to get updatePeriod from properties
1062         // For battery devinities the REST call to get the settings will most likely fail, because the device is in
1063         // sleep mode. Therefore we use the last saved property value as default. Will be overwritten, when device is
1064         // initialized successfully by the REST call.
1065         String lastPeriod = getString(properties.get(PROPERTY_UPDATE_PERIOD));
1066         if (!lastPeriod.isEmpty()) {
1067             int period = Integer.parseInt(lastPeriod);
1068             if (period > 0) {
1069                 profile.updatePeriod = period;
1070             }
1071         }
1072
1073         skipCount = config.updateInterval / UPDATE_STATUS_INTERVAL_SECONDS;
1074         logger.trace("{}: updateInterval = {}s -> skipCount = {}", thingName, config.updateInterval, skipCount);
1075         return true;
1076     }
1077
1078     private void checkVersion(ShellyDeviceProfile prf, ShellySettingsStatus status) {
1079         try {
1080             if (prf.fwVersion.isEmpty()) {
1081                 // no fw version available (e.g. BLU device)
1082                 return;
1083             }
1084             ShellyVersionDTO version = new ShellyVersionDTO();
1085             if (version.checkBeta(getString(prf.fwVersion))) {
1086                 logger.info("{}: {}", prf.device.hostname,
1087                         messages.get("versioncheck.beta", prf.fwVersion, prf.fwDate));
1088             } else {
1089                 String minVersion = !gen2 ? SHELLY_API_MIN_FWVERSION : SHELLY2_API_MIN_FWVERSION;
1090                 if (version.compare(prf.fwVersion, minVersion) < 0) {
1091                     logger.warn("{}: {}", prf.device.hostname,
1092                             messages.get("versioncheck.tooold", prf.fwVersion, prf.fwDate, minVersion));
1093                 }
1094             }
1095             if (!gen2 && bindingConfig.autoCoIoT && ((version.compare(prf.fwVersion, SHELLY_API_MIN_FWCOIOT)) >= 0)
1096                     || ("production_test".equalsIgnoreCase(prf.fwVersion))) {
1097                 if (!config.eventsCoIoT) {
1098                     logger.info("{}: {}", thingName, messages.get("versioncheck.autocoiot"));
1099                 }
1100                 autoCoIoT = true;
1101             }
1102             if (status.update.hasUpdate && !version.checkBeta(getString(prf.fwVersion))) {
1103                 logger.info("{}: {}", thingName,
1104                         messages.get("versioncheck.update", status.update.oldVersion, status.update.newVersion));
1105             }
1106         } catch (NullPointerException e) { // could be inconsistant format of beta version
1107             logger.debug("{}: {}", thingName, messages.get("versioncheck.failed", prf.fwVersion));
1108         }
1109     }
1110
1111     public String checkForUpdate() {
1112         try {
1113             ShellyOtaCheckResult result = api.checkForUpdate();
1114             return result.status;
1115         } catch (ShellyApiException e) {
1116             return "";
1117         }
1118     }
1119
1120     public void startCoap(ShellyThingConfiguration config, ShellyDeviceProfile profile) throws ShellyApiException {
1121         if (coap == null || !config.eventsCoIoT) {
1122             return;
1123         }
1124         if (profile.settings.coiot != null && profile.settings.coiot.enabled != null) {
1125             String devpeer = getString(profile.settings.coiot.peer);
1126             String ourpeer = config.localIp + ":" + Shelly1CoapJSonDTO.COIOT_PORT;
1127             if (!profile.settings.coiot.enabled || (profile.isMotion && devpeer.isEmpty())) {
1128                 try {
1129                     api.setCoIoTPeer(ourpeer);
1130                     logger.info("{}: CoIoT peer updated to {}", thingName, ourpeer);
1131                 } catch (ShellyApiException e) {
1132                     logger.debug("{}: Unable to set CoIoT peer: {}", thingName, e.toString());
1133                 }
1134             } else if (!devpeer.isEmpty() && !devpeer.equals(ourpeer)) {
1135                 logger.warn("{}: CoIoT peer in device settings does not point this to this host", thingName);
1136             }
1137         }
1138         if (autoCoIoT) {
1139             logger.debug("{}: Auto-CoIoT is enabled, disabling action urls", thingName);
1140             config.eventsCoIoT = true;
1141             config.eventsSwitch = false;
1142             config.eventsButton = false;
1143             config.eventsPush = false;
1144             config.eventsRoller = false;
1145             config.eventsSensorReport = false;
1146             api.setConfig(thingName, config);
1147         }
1148
1149         logger.debug("{}: Starting CoIoT (autoCoIoT={}/{})", thingName, bindingConfig.autoCoIoT, autoCoIoT);
1150         if (coap != null) {
1151             coap.start(thingName, config);
1152         }
1153     }
1154
1155     /**
1156      * Change type of this thing.
1157      *
1158      * @param thingType thing type acc. to the xml definition
1159      * @param mode Device mode (e.g. relay, roller)
1160      */
1161     protected void changeThingType(String thingType, String mode) {
1162         String deviceType = substringBefore(thingType, "-");
1163         ThingTypeUID thingTypeUID = ShellyThingCreator.getThingTypeUID(thingType, deviceType, mode);
1164         if (!thingTypeUID.equals(THING_TYPE_SHELLYUNKNOWN)) {
1165             logger.debug("{}: Changing thing type to {}", getThing().getLabel(), thingTypeUID);
1166             Map<String, String> properties = editProperties();
1167             properties.replace(PROPERTY_DEV_TYPE, deviceType);
1168             properties.replace(PROPERTY_DEV_MODE, mode);
1169             updateProperties(properties);
1170             changeThingType(thingTypeUID, getConfig());
1171         } else {
1172             logger.debug("{}:  to {}", thingName, thingType);
1173             setThingOfflineAndDisconnect(ThingStatusDetail.CONFIGURATION_ERROR,
1174                     "Unable to change thing type to " + thingType);
1175         }
1176     }
1177
1178     @Override
1179     public void thingUpdated(Thing thing) {
1180         logger.debug("{}: Channel definitions updated.", thingName);
1181         super.thingUpdated(thing);
1182     }
1183
1184     /**
1185      * Start the background updates
1186      */
1187     protected void startUpdateJob() {
1188         ScheduledFuture<?> statusJob = this.statusJob;
1189         if ((statusJob == null) || statusJob.isCancelled()) {
1190             this.statusJob = scheduler.scheduleWithFixedDelay(this::refreshStatus, 2, UPDATE_STATUS_INTERVAL_SECONDS,
1191                     TimeUnit.SECONDS);
1192             logger.debug("{}: Update status job started, interval={}*{}={}sec.", thingName, skipCount,
1193                     UPDATE_STATUS_INTERVAL_SECONDS, skipCount * UPDATE_STATUS_INTERVAL_SECONDS);
1194         }
1195     }
1196
1197     /**
1198      * Flag the status job to do an exceptional update (something happened) rather
1199      * than waiting until the next regular poll
1200      *
1201      * @param requestCount number of polls to execute
1202      * @param refreshSettings true=force a /settings query
1203      * @return true=Update schedule, false=skipped (too many updates already
1204      *         scheduled)
1205      */
1206     @Override
1207     public boolean requestUpdates(int requestCount, boolean refreshSettings) {
1208         this.refreshSettings |= refreshSettings;
1209         if (refreshSettings) {
1210             if (requestCount == 0) {
1211                 logger.debug("{}: Request settings refresh", thingName);
1212             }
1213             scheduledUpdates = 1;
1214             return true;
1215         }
1216         if (scheduledUpdates < 10) { // < 30s
1217             scheduledUpdates += requestCount;
1218             return true;
1219         }
1220         return false;
1221     }
1222
1223     /**
1224      * Map input states to channels
1225      *
1226      * @param status Shelly device status
1227      * @return true: one or more inputs were updated
1228      */
1229     @Override
1230     public boolean updateInputs(ShellySettingsStatus status) {
1231         boolean updated = false;
1232
1233         if (status.inputs != null) {
1234             if (!areChannelsCreated()) {
1235                 updateChannelDefinitions(ShellyChannelDefinitions.createInputChannels(thing, profile, status));
1236             }
1237
1238             int idx = 0;
1239             boolean multiInput = !profile.isIX && status.inputs.size() >= 2; // device has multiple SW (inputs)
1240             for (ShellyInputState input : status.inputs) {
1241                 String group = profile.getInputGroup(idx);
1242                 String suffix = multiInput ? profile.getInputSuffix(idx) : "";
1243                 updated |= updateChannel(group, CHANNEL_INPUT + suffix, getOnOff(input.input));
1244                 if (input.event != null) {
1245                     updated |= updateChannel(group, CHANNEL_STATUS_EVENTTYPE + suffix, getStringType(input.event));
1246                     updated |= updateChannel(group, CHANNEL_STATUS_EVENTCOUNT + suffix, getDecimal(input.eventCount));
1247                 }
1248                 idx++;
1249             }
1250         } else {
1251             if (status.input != null) {
1252                 // RGBW2: a single int rather than an array
1253                 return updateChannel(profile.getControlGroup(0), CHANNEL_INPUT,
1254                         OnOffType.from(getInteger(status.input) != 0));
1255             }
1256         }
1257         return updated;
1258     }
1259
1260     @Override
1261     public boolean updateWakeupReason(@Nullable List<Object> valueArray) {
1262         boolean changed = false;
1263         if (valueArray != null && !valueArray.isEmpty()) {
1264             String reason = getString((String) valueArray.get(0));
1265             String newVal = valueArray.toString();
1266             changed = updateChannel(CHANNEL_GROUP_DEV_STATUS, CHANNEL_DEVST_WAKEUP, getStringType(reason));
1267             changed |= !lastWakeupReason.isEmpty() && !lastWakeupReason.equals(newVal);
1268             if (changed) {
1269                 postEvent(reason.toUpperCase(), true);
1270             }
1271             lastWakeupReason = newVal;
1272         }
1273         return changed;
1274     }
1275
1276     @Override
1277     public void triggerButton(String group, int idx, String value) {
1278         String trigger = mapButtonEvent(value);
1279         if (trigger.isEmpty()) {
1280             return;
1281         }
1282
1283         logger.debug("{}: Update button state with {}/{}", thingName, value, trigger);
1284         triggerChannel(group,
1285                 profile.isRoller ? CHANNEL_EVENT_TRIGGER : CHANNEL_BUTTON_TRIGGER + profile.getInputSuffix(idx),
1286                 trigger);
1287         updateChannel(group, CHANNEL_LAST_UPDATE, getTimestamp());
1288         if (profile.alwaysOn) {
1289             // refresh status of the input channel
1290             requestUpdates(1, false);
1291         }
1292     }
1293
1294     @Override
1295     public void publishState(String channelId, State value) {
1296         String id = channelId.contains("$") ? substringBefore(channelId, "$") : channelId;
1297         if (!stopping && isLinked(id)) {
1298             updateState(id, value);
1299             logger.debug("{}: Channel {} updated with {} (type {}).", thingName, channelId, value, value.getClass());
1300         }
1301     }
1302
1303     @Override
1304     public boolean updateChannel(String group, String channel, State value) {
1305         return updateChannel(mkChannelId(group, channel), value, false);
1306     }
1307
1308     @Override
1309     public boolean updateChannel(String channelId, State value, boolean force) {
1310         return !stopping && cache.updateChannel(channelId, value, force);
1311     }
1312
1313     @Override
1314     public State getChannelValue(String group, String channel) {
1315         return cache.getValue(group, channel);
1316     }
1317
1318     @Override
1319     public double getChannelDouble(String group, String channel) {
1320         State value = getChannelValue(group, channel);
1321         if (value != UnDefType.NULL) {
1322             if (value instanceof QuantityType<?> quantityCommand) {
1323                 return quantityCommand.toBigDecimal().doubleValue();
1324             }
1325             if (value instanceof DecimalType decimalCommand) {
1326                 return decimalCommand.doubleValue();
1327             }
1328         }
1329         return -1;
1330     }
1331
1332     /**
1333      * Update Thing's channels according to available status information from the API
1334      *
1335      * @param dynChannels
1336      */
1337     @Override
1338     public void updateChannelDefinitions(Map<String, Channel> dynChannels) {
1339         if (channelsCreated) {
1340             return; // already done
1341         }
1342
1343         try {
1344             // Get subset of those channels that currently do not exist
1345             List<Channel> existingChannels = getThing().getChannels();
1346             for (Channel channel : existingChannels) {
1347                 String id = channel.getUID().getId();
1348                 if (dynChannels.containsKey(id)) {
1349                     dynChannels.remove(id);
1350                 }
1351             }
1352
1353             if (!dynChannels.isEmpty()) {
1354                 logger.debug("{}: Updating channel definitions, {} channels", thingName, dynChannels.size());
1355                 ThingBuilder thingBuilder = editThing();
1356                 for (Map.Entry<String, Channel> channel : dynChannels.entrySet()) {
1357                     Channel c = channel.getValue();
1358                     logger.debug("{}: Adding channel {}", thingName, c.getUID().getId());
1359                     thingBuilder.withChannel(c);
1360                 }
1361                 updateThing(thingBuilder.build());
1362                 logger.debug("{}: Channel definitions updated", thingName);
1363             }
1364         } catch (IllegalArgumentException e) {
1365             logger.debug("{}: Unable to update channel definitions", thingName, e);
1366         }
1367     }
1368
1369     @Override
1370     public boolean areChannelsCreated() {
1371         return channelsCreated;
1372     }
1373
1374     /**
1375      * Update thing properties with dynamic values
1376      *
1377      * @param profile The device profile
1378      * @param status the /status result
1379      */
1380     public void updateProperties(ShellyDeviceProfile profile, ShellySettingsStatus status) {
1381         Map<String, Object> properties = fillDeviceProperties(profile);
1382         String deviceName = getString(profile.settings.name);
1383         properties.put(PROPERTY_SERVICE_NAME, config.serviceName);
1384         properties.put(PROPERTY_DEV_AUTH, getBool(profile.device.auth) ? "yes" : "no");
1385         if (!deviceName.isEmpty()) {
1386             properties.put(PROPERTY_DEV_NAME, deviceName);
1387         }
1388
1389         // add status properties
1390         if (status.wifiSta != null) {
1391             properties.put(PROPERTY_WIFI_NETW, getString(status.wifiSta.ssid));
1392         }
1393         if (status.update != null) {
1394             properties.put(PROPERTY_UPDATE_STATUS, getString(status.update.status));
1395             properties.put(PROPERTY_UPDATE_AVAILABLE, getBool(status.update.hasUpdate) ? "yes" : "no");
1396             properties.put(PROPERTY_UPDATE_CURR_VERS, getString(status.update.oldVersion));
1397             properties.put(PROPERTY_UPDATE_NEW_VERS, getString(status.update.newVersion));
1398         }
1399         properties.put(PROPERTY_COIOTAUTO, String.valueOf(autoCoIoT));
1400
1401         Map<String, String> thingProperties = new TreeMap<>();
1402         for (Map.Entry<String, Object> property : properties.entrySet()) {
1403             thingProperties.put(property.getKey(), (String) property.getValue());
1404         }
1405         flushProperties(thingProperties);
1406     }
1407
1408     /**
1409      * Add one property to the Thing Properties
1410      *
1411      * @param key Name of the property
1412      * @param value Value of the property
1413      */
1414     @Override
1415     public void updateProperties(String key, String value) {
1416         Map<String, String> thingProperties = editProperties();
1417         if (thingProperties.containsKey(key)) {
1418             thingProperties.replace(key, value);
1419         } else {
1420             thingProperties.put(key, value);
1421         }
1422         updateProperties(thingProperties);
1423         logger.trace("{}: Properties updated", thingName);
1424     }
1425
1426     public void flushProperties(Map<String, String> propertyUpdates) {
1427         Map<String, String> thingProperties = editProperties();
1428         for (Map.Entry<String, String> property : propertyUpdates.entrySet()) {
1429             if (thingProperties.containsKey(property.getKey())) {
1430                 thingProperties.replace(property.getKey(), property.getValue());
1431             } else {
1432                 thingProperties.put(property.getKey(), property.getValue());
1433             }
1434         }
1435         updateProperties(thingProperties);
1436     }
1437
1438     /**
1439      * Get one property from the Thing Properties
1440      *
1441      * @param key property name
1442      * @return property value or "" if property is not set
1443      */
1444     @Override
1445     public String getProperty(String key) {
1446         Map<String, String> thingProperties = getThing().getProperties();
1447         return getString(thingProperties.get(key));
1448     }
1449
1450     /**
1451      * Fill Thing Properties with device attributes
1452      *
1453      * @param profile Property Map to full
1454      * @return a full property map
1455      */
1456     public static Map<String, Object> fillDeviceProperties(ShellyDeviceProfile profile) {
1457         Map<String, Object> properties = new TreeMap<>();
1458         properties.put(PROPERTY_VENDOR, VENDOR);
1459         if (profile.isInitialized()) {
1460             properties.put(PROPERTY_MODEL_ID, getString(profile.device.type));
1461             properties.put(PROPERTY_MAC_ADDRESS, profile.device.mac);
1462             properties.put(PROPERTY_FIRMWARE_VERSION, profile.fwVersion + "/" + profile.fwDate);
1463             properties.put(PROPERTY_DEV_MODE, profile.device.mode);
1464             if (profile.hasRelays) {
1465                 properties.put(PROPERTY_NUM_RELAYS, String.valueOf(profile.numRelays));
1466                 properties.put(PROPERTY_NUM_ROLLERS, String.valueOf(profile.numRollers));
1467                 properties.put(PROPERTY_NUM_METER, String.valueOf(profile.numMeters));
1468             }
1469             properties.put(PROPERTY_UPDATE_PERIOD, String.valueOf(profile.updatePeriod));
1470             if (!profile.hwRev.isEmpty()) {
1471                 properties.put(PROPERTY_HWREV, profile.hwRev);
1472                 properties.put(PROPERTY_HWBATCH, profile.hwBatchId);
1473             }
1474         }
1475         return properties;
1476     }
1477
1478     /**
1479      * Return device profile.
1480      *
1481      * @param forceRefresh true=force refresh before returning, false=return without
1482      *            refresh
1483      * @return ShellyDeviceProfile instance
1484      * @throws ShellyApiException
1485      */
1486     @Override
1487     public ShellyDeviceProfile getProfile(boolean forceRefresh) throws ShellyApiException {
1488         try {
1489             refreshSettings |= forceRefresh;
1490             if (refreshSettings) {
1491                 profile = api.getDeviceProfile(thingType, null);
1492                 if (!isThingOnline()) {
1493                     logger.debug("{}: Device profile re-initialized (thingType={})", thingName, thingType);
1494                 }
1495             }
1496         } catch (ShellyApiException | RuntimeException e) {
1497             logger.debug("{}: Unable to initialize Device Profile", thingName, e);
1498         } finally {
1499             refreshSettings = false;
1500         }
1501         return profile;
1502     }
1503
1504     @Override
1505     public ShellyDeviceProfile getProfile() {
1506         return profile;
1507     }
1508
1509     @Override
1510     public @Nullable List<StateOption> getStateOptions(ChannelTypeUID uid) {
1511         List<StateOption> options = channelDefinitions.getStateOptions(uid);
1512         if (!options.isEmpty()) {
1513             logger.debug("{}: Return {} state options for channel uid {}", thingName, options.size(), uid.getId());
1514             return options;
1515         }
1516         return null;
1517     }
1518
1519     protected ShellyDeviceProfile getDeviceProfile() {
1520         return profile;
1521     }
1522
1523     @Override
1524     public void triggerChannel(String group, String channel, String payload) {
1525         String triggerCh = mkChannelId(group, channel);
1526         logger.debug("{}: Send event {} to channel {}", thingName, triggerCh, payload);
1527         if (EVENT_TYPE_VIBRATION.contentEquals(payload)) {
1528             if (vibrationFilter == 0) {
1529                 vibrationFilter = VIBRATION_FILTER_SEC / UPDATE_STATUS_INTERVAL_SECONDS + 1;
1530                 logger.debug("{}: Duplicate vibration events will be absorbed for the next {} sec", thingName,
1531                         vibrationFilter * UPDATE_STATUS_INTERVAL_SECONDS);
1532             } else {
1533                 logger.debug("{}: Vibration event absorbed, {} sec remaining", thingName,
1534                         vibrationFilter * UPDATE_STATUS_INTERVAL_SECONDS);
1535                 return;
1536             }
1537         }
1538
1539         triggerChannel(triggerCh, payload);
1540     }
1541
1542     public void stop() {
1543         logger.debug("{}: Shutting down", thingName);
1544         ScheduledFuture<?> job = this.initJob;
1545         if (job != null) {
1546             job.cancel(true);
1547             initJob = null;
1548         }
1549         job = this.statusJob;
1550         if (job != null) {
1551             job.cancel(true);
1552             statusJob = null;
1553             logger.debug("{}: Shelly statusJob stopped", thingName);
1554         }
1555         api.close();
1556         profile.initialized = false;
1557     }
1558
1559     /**
1560      * Shutdown thing, make sure background jobs are canceled
1561      */
1562     @Override
1563     public void dispose() {
1564         logger.debug("{}: Stopping Thing", thingName);
1565         stopping = true;
1566         stop();
1567         super.dispose();
1568     }
1569
1570     /**
1571      * Device specific command handlers are overriding this method to do additional stuff
1572      */
1573     public boolean handleDeviceCommand(ChannelUID channelUID, Command command) throws ShellyApiException {
1574         return false;
1575     }
1576
1577     public String getUID() {
1578         return getThing().getUID().getAsString();
1579     }
1580
1581     /**
1582      * Device specific handlers are overriding this method to do additional stuff
1583      */
1584     public boolean updateDeviceStatus(ShellySettingsStatus status) throws ShellyApiException {
1585         return false;
1586     }
1587
1588     @Override
1589     public String getThingName() {
1590         return thingName;
1591     }
1592
1593     @Override
1594     public void resetStats() {
1595         // reset statistics
1596         stats = new ShellyDeviceStats();
1597     }
1598
1599     @Override
1600     public ShellyDeviceStats getStats() {
1601         return stats;
1602     }
1603
1604     @Override
1605     public ShellyApiInterface getApi() {
1606         return api;
1607     }
1608
1609     @Override
1610     public long getScheduledUpdates() {
1611         return scheduledUpdates;
1612     }
1613
1614     public Map<String, String> getStatsProp() {
1615         return stats.asProperties();
1616     }
1617
1618     @Override
1619     public void triggerUpdateFromCoap() {
1620         if ((!autoCoIoT && (getScheduledUpdates() < 1)) || (autoCoIoT && !profile.isLight && !profile.hasBattery)) {
1621             requestUpdates(1, false);
1622         }
1623     }
1624 }