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.nibeuplink.internal.handler;
  14
  15 import java.util.Map;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.eclipse.jdt.annotation.Nullable;
  19 import org.openhab.binding.nibeuplink.internal.config.NibeUplinkConfiguration;
  20 import org.openhab.binding.nibeuplink.internal.connector.UplinkWebInterface;
  21 import org.openhab.core.thing.Channel;
  22 import org.openhab.core.thing.ThingStatus;
  23 import org.openhab.core.thing.ThingStatusDetail;
  24 import org.openhab.core.thing.binding.ThingHandler;
  25 import org.openhab.core.types.State;
  26
  27 /**
  28  * public interface of the {@link UplinkBaseHandler}
  29  *
  30  * @author Alexander Friese - initial contribution
  31  */
  32 @NonNullByDefault
  33 public interface NibeUplinkHandler extends ThingHandler, ChannelProvider {
  34     /**
  35      * Called from
  36      * {@link org.openhab.binding.nibeuplink.internal.connector.UplinkWebInterface.WebRequestExecutor#authenticate()}
  37      * to update the thing status because updateStatus is protected.
  38      *
  39      * @param status Bridge status
  40      * @param statusDetail Bridge status detail
  41      * @param description Bridge status description
  42      */
  43     void setStatusInfo(ThingStatus status, ThingStatusDetail statusDetail, @Nullable String description);
  44
  45     /**
  46      * Provides the web interface object.
  47      *
  48      * @return The web interface object
  49      */
  50     UplinkWebInterface getWebInterface();
  51
  52     void updateChannelStatus(Map<Channel, State> values);
  53
  54     NibeUplinkConfiguration getConfiguration();
  55 }