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

   1 /**
   2  * Copyright (c) 2010-2020 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.homematic.internal.communicator.virtual;
  14
  15 import static org.openhab.binding.homematic.internal.misc.HomematicConstants.VIRTUAL_DATAPOINT_NAME_DELETE_DEVICE_MODE;
  16
  17 import java.io.IOException;
  18
  19 import org.apache.commons.lang.StringUtils;
  20 import org.openhab.binding.homematic.internal.misc.HomematicClientException;
  21 import org.openhab.binding.homematic.internal.model.HmDatapoint;
  22 import org.openhab.binding.homematic.internal.model.HmDatapointConfig;
  23 import org.openhab.binding.homematic.internal.model.HmDevice;
  24 import org.openhab.binding.homematic.internal.model.HmInterface;
  25 import org.openhab.binding.homematic.internal.model.HmValueType;
  26
  27 /**
  28  * A virtual enum datapoint which holds the delete flag for deleting a device with the DELETE_DEVICE virtual datapoint.
  29  * Falls back to LOCKED after 30 seconds to prevent accidental deletion.
  30  *
  31  * @author Gerhard Riegler - Initial contribution
  32  */
  33 public class DeleteDeviceModeVirtualDatapointHandler extends AbstractVirtualDatapointHandler {
  34     protected static final String MODE_LOCKED = "LOCKED";
  35     protected static final String MODE_RESET = "RESET";
  36     protected static final String MODE_FORCE = "FORCE";
  37     protected static final String MODE_DEFER = "DEFER";
  38     private static final int DELETE_MODE_DURATION = 30;
  39
  40     @Override
  41     public String getName() {
  42         return VIRTUAL_DATAPOINT_NAME_DELETE_DEVICE_MODE;
  43     }
  44
  45     @Override
  46     public void initialize(HmDevice device) {
  47         if (!device.isGatewayExtras() && !(device.getHmInterface() == HmInterface.CUXD)) {
  48             HmDatapoint dp = addDatapoint(device, 0, getName(), HmValueType.ENUM, 0, false);
  49             dp.setOptions(new String[] { MODE_LOCKED, MODE_RESET, MODE_FORCE, MODE_DEFER });
  50             dp.setMinValue(0);
  51             dp.setMaxValue(dp.getOptions().length - 1);
  52         }
  53     }
  54
  55     @Override
  56     public boolean canHandleCommand(HmDatapoint dp, Object value) {
  57         return getName().equals(dp.getName());
  58     }
  59
  60     @Override
  61     public void handleCommand(VirtualGateway gateway, HmDatapoint dp, HmDatapointConfig dpConfig, Object value)
  62             throws IOException, HomematicClientException {
  63         dp.setValue(value);
  64         if (!StringUtils.equals(dp.getOptionValue(), MODE_LOCKED)) {
  65             gateway.disableDatapoint(dp, DELETE_MODE_DURATION);
  66         }
  67     }
  68 }