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.velux.internal.bridge.common;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16
  17 /**
  18  * <B>Common bridge communication message scheme supported by the </B><I>Velux</I><B> bridge.</B>
  19  * <P>
  20  * Message semantic will be defined by the implementations according to the different comm paths.
  21  * <P>
  22  * In addition to the common methods defined by {@link BridgeCommunicationProtocol}
  23  * each protocol-specific implementation has to provide the following methods:
  24  * <UL>
  25  * <LI>{@link #setSceneId} for defining the intended scene.
  26  * </UL>
  27  *
  28  * @see BridgeCommunicationProtocol
  29  *
  30  * @author Guenther Schreiner - Initial contribution.
  31  */
  32 @NonNullByDefault
  33 public abstract class RunScene implements BridgeCommunicationProtocol {
  34
  35     /**
  36      * Sets the intended scene identifier to be executed
  37      *
  38      * @param id Gateway internal scene identifier
  39      * @return reference to the class instance.
  40      */
  41     public RunScene setSceneId(int id) {
  42         return this;
  43     }
  44
  45     /**
  46      * Sets the intended scene velocity for later execution
  47      *
  48      * @param velocity setting as String.
  49      * @return reference to the class instance.
  50      */
  51     public RunScene setVelocity(int velocity) {
  52         return this;
  53     }
  54 }