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.nikohomecontrol.internal.protocol;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16
  17 /**
  18  * The {@link NhcActionEvent} interface is used to pass action events received from the Niko Home Control controller to
  19  * the consuming client. It is designed to pass events to openHAB handlers that implement this interface. Because of
  20  * the design, the org.openhab.binding.nikohomecontrol.internal.protocol package can be extracted and used independent
  21  * of openHAB.
  22  *
  23  * @author Mark Herwege - Initial Contribution
  24  */
  25 @NonNullByDefault
  26 public interface NhcActionEvent {
  27
  28     /**
  29      * This method is called when an action event is received from the Niko Home Control controller.
  30      *
  31      * @param state
  32      */
  33     public void actionEvent(int state);
  34
  35     /**
  36      * Called to indicate the action has been initialized.
  37      *
  38      */
  39     public void actionInitialized();
  40
  41     /**
  42      * Called to indicate the action has been removed from the Niko Home Control controller.
  43      *
  44      */
  45     public void actionRemoved();
  46 }