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.homematic.internal.communicator.virtual;
  14
  15 import java.io.IOException;
  16
  17 import org.openhab.binding.homematic.internal.communicator.HomematicGateway;
  18 import org.openhab.binding.homematic.internal.communicator.HomematicGatewayAdapter;
  19 import org.openhab.binding.homematic.internal.communicator.client.RpcClient;
  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.HmInterface;
  24
  25 /**
  26  * Extends the HomematicGateway with a method called from a virtual datapoint.
  27  *
  28  * @author Gerhard Riegler - Initial contribution
  29  */
  30 public interface VirtualGateway extends HomematicGateway {
  31
  32     /**
  33      * Sends the datapoint from a virtual datapoint.
  34      */
  35     void sendDatapointIgnoreVirtual(HmDatapoint dp, HmDatapointConfig dpConfig, Object newValue)
  36             throws IOException, HomematicClientException;
  37
  38     /**
  39      * Returns the rpc client.
  40      */
  41     RpcClient<?> getRpcClient(HmInterface hmInterface) throws IOException;
  42
  43     /**
  44      * Disables a boolean datapoint by setting the value to false after a given delay.
  45      */
  46     void disableDatapoint(HmDatapoint dp, double delay);
  47
  48     /**
  49      * Returns the event listener.
  50      */
  51     HomematicGatewayAdapter getGatewayAdapter();
  52 }