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.velux.internal.handler;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.eclipse.jdt.annotation.Nullable;
  17 import org.openhab.binding.velux.internal.VeluxBindingConstants;
  18 import org.openhab.binding.velux.internal.VeluxItemType;
  19 import org.openhab.binding.velux.internal.bridge.VeluxBridgeWLANConfig;
  20 import org.openhab.binding.velux.internal.handler.utils.StateUtils;
  21 import org.openhab.binding.velux.internal.handler.utils.ThingProperty;
  22 import org.openhab.core.library.types.StringType;
  23 import org.openhab.core.thing.ChannelUID;
  24 import org.openhab.core.types.State;
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27
  28 /**
  29  * <B>Channel-specific retrieval and modification.</B>
  30  * <P>
  31  * This class implements the Channels <B>WLANSSID</B> and <B>WLANPassword</B> of the Thing <B>klf200</B> :
  32  * <UL>
  33  * <LI><I>Velux</I> <B>bridge</B> &rarr; <B>OpenHAB</B>:
  34  * <P>
  35  * Information retrieval by method {@link #handleRefresh}.</LI>
  36  * </UL>
  37  *
  38  * @author Guenther Schreiner - Initial contribution.
  39  */
  40 @NonNullByDefault
  41 final class ChannelBridgeWLANconfig extends ChannelHandlerTemplate {
  42     private static final Logger LOGGER = LoggerFactory.getLogger(ChannelBridgeWLANconfig.class);
  43
  44     /*
  45      * ************************
  46      * ***** Constructors *****
  47      */
  48
  49     // Suppress default constructor for non-instantiability
  50
  51     private ChannelBridgeWLANconfig() {
  52         throw new AssertionError();
  53     }
  54
  55     /**
  56      * Communication method to retrieve information to update the channel value.
  57      *
  58      * @param channelUID The item passed as type {@link ChannelUID} for which a refresh is intended.
  59      * @param channelId The same item passed as type {@link String} for which a refresh is intended.
  60      * @param thisBridgeHandler The Velux bridge handler with a specific communication protocol which provides
  61      *            information for this channel.
  62      * @return newState The value retrieved for the passed channel, or <I>null</I> in case if there is no (new) value.
  63      */
  64     static @Nullable State handleRefresh(ChannelUID channelUID, String channelId,
  65             VeluxBridgeHandler thisBridgeHandler) {
  66         LOGGER.debug("handleRefresh({},{},{}) called.", channelUID, channelId, thisBridgeHandler);
  67         State newState = null;
  68         thisBridgeHandler.bridgeParameters.wlanConfig = new VeluxBridgeWLANConfig()
  69                 .retrieve(thisBridgeHandler.thisBridge);
  70         if (thisBridgeHandler.bridgeParameters.wlanConfig.isRetrieved) {
  71             VeluxItemType itemType = VeluxItemType.getByThingAndChannel(thisBridgeHandler.thingTypeUIDOf(channelUID),
  72                     channelUID.getId());
  73             String msg = thisBridgeHandler.localization.getText("config.velux.bridge.unAvailable");
  74             switch (itemType) {
  75                 case BRIDGE_WLANSSID:
  76                     newState = StateUtils.createState(new StringType(msg));
  77                     ThingProperty.setValue(thisBridgeHandler, VeluxBindingConstants.PROPERTY_BRIDGE_WLANSSID, msg);
  78                     break;
  79                 case BRIDGE_WLANPASSWORD:
  80                     newState = StateUtils.createState(new StringType(msg));
  81                     ThingProperty.setValue(thisBridgeHandler, VeluxBindingConstants.PROPERTY_BRIDGE_WLANPASSWORD, msg);
  82                     break;
  83                 default:
  84             }
  85         }
  86         LOGGER.trace("handleRefresh() returns {}.", newState);
  87         return newState;
  88     }
  89 }