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.netatmo.internal.handler;
  14
  15 import java.util.ArrayList;
  16 import java.util.List;
  17 import java.util.Objects;
  18 import java.util.Optional;
  19 import java.util.concurrent.ScheduledExecutorService;
  20 import java.util.concurrent.TimeUnit;
  21 import java.util.stream.Stream;
  22
  23 import org.eclipse.jdt.annotation.NonNullByDefault;
  24 import org.eclipse.jdt.annotation.Nullable;
  25 import org.openhab.binding.netatmo.internal.api.data.ModuleType;
  26 import org.openhab.binding.netatmo.internal.api.data.NetatmoConstants.FeatureArea;
  27 import org.openhab.binding.netatmo.internal.api.dto.NAObject;
  28 import org.openhab.binding.netatmo.internal.api.dto.NAThing;
  29 import org.openhab.binding.netatmo.internal.config.NAThingConfiguration;
  30 import org.openhab.binding.netatmo.internal.handler.capability.Capability;
  31 import org.openhab.binding.netatmo.internal.handler.capability.CapabilityMap;
  32 import org.openhab.binding.netatmo.internal.handler.capability.HomeCapability;
  33 import org.openhab.binding.netatmo.internal.handler.capability.RefreshCapability;
  34 import org.openhab.binding.netatmo.internal.handler.capability.RestCapability;
  35 import org.openhab.core.config.core.Configuration;
  36 import org.openhab.core.thing.Bridge;
  37 import org.openhab.core.thing.Channel;
  38 import org.openhab.core.thing.ChannelUID;
  39 import org.openhab.core.thing.Thing;
  40 import org.openhab.core.thing.ThingStatus;
  41 import org.openhab.core.thing.ThingStatusDetail;
  42 import org.openhab.core.thing.binding.BridgeHandler;
  43 import org.openhab.core.thing.binding.builder.ThingBuilder;
  44 import org.openhab.core.thing.type.ChannelKind;
  45 import org.openhab.core.types.Command;
  46 import org.openhab.core.types.RefreshType;
  47 import org.openhab.core.types.State;
  48 import org.slf4j.Logger;
  49
  50 /**
  51  * {@link CommonInterface} defines common methods of AccountHandler and NAThingHandlers used by Capabilities
  52  *
  53  * @author Gaël L'hopital - Initial contribution
  54  *
  55  */
  56 @NonNullByDefault
  57 public interface CommonInterface {
  58     Thing getThing();
  59
  60     ThingBuilder editThing();
  61
  62     CapabilityMap getCapabilities();
  63
  64     Logger getLogger();
  65
  66     ScheduledExecutorService getScheduler();
  67
  68     boolean isLinked(ChannelUID channelUID);
  69
  70     void updateState(ChannelUID channelUID, State state);
  71
  72     void setThingStatus(ThingStatus thingStatus, ThingStatusDetail thingStatusDetail,
  73             @Nullable String thingStatusReason);
  74
  75     void triggerChannel(String channelID, String event);
  76
  77     void updateThing(Thing thing);
  78
  79     @Nullable
  80     Bridge getBridge();
  81
  82     default @Nullable CommonInterface getBridgeHandler() {
  83         Bridge bridge = getBridge();
  84         return bridge != null && bridge.getHandler() instanceof DeviceHandler ? (DeviceHandler) bridge.getHandler()
  85                 : null;
  86     }
  87
  88     default @Nullable ApiBridgeHandler getAccountHandler() {
  89         Bridge bridge = getBridge();
  90         BridgeHandler bridgeHandler = null;
  91         if (bridge != null) {
  92             bridgeHandler = bridge.getHandler();
  93             while (bridgeHandler != null && !(bridgeHandler instanceof ApiBridgeHandler)) {
  94                 bridge = ((CommonInterface) bridgeHandler).getBridge();
  95                 bridgeHandler = bridge != null ? bridge.getHandler() : null;
  96             }
  97         }
  98         return (ApiBridgeHandler) bridgeHandler;
  99     }
 100
 101     default @Nullable String getBridgeId() {
 102         CommonInterface bridge = getBridgeHandler();
 103         return bridge != null ? bridge.getId() : null;
 104     }
 105
 106     default void expireData() {
 107         getCapabilities().values().forEach(cap -> cap.expireData());
 108     }
 109
 110     default String getId() {
 111         return getConfiguration().as(NAThingConfiguration.class).getId();
 112     }
 113
 114     default Configuration getConfiguration() {
 115         return getThing().getConfiguration();
 116     }
 117
 118     default Stream<Channel> getActiveChannels() {
 119         return getThing().getChannels().stream()
 120                 .filter(channel -> ChannelKind.STATE.equals(channel.getKind()) && isLinked(channel.getUID()));
 121     }
 122
 123     default Optional<CommonInterface> recurseUpToHomeHandler(@Nullable CommonInterface handler) {
 124         if (handler == null) {
 125             return Optional.empty();
 126         }
 127         return handler.getCapabilities().get(HomeCapability.class).isPresent() ? Optional.of(handler)
 128                 : recurseUpToHomeHandler(handler.getBridgeHandler());
 129     }
 130
 131     default List<CommonInterface> getActiveChildren() {
 132         Thing thing = getThing();
 133         if (thing instanceof Bridge bridge) {
 134             return bridge.getThings().stream().filter(Thing::isEnabled)
 135                     .filter(th -> th.getStatusInfo().getStatusDetail() != ThingStatusDetail.BRIDGE_OFFLINE)
 136                     .map(Thing::getHandler).filter(Objects::nonNull).map(CommonInterface.class::cast).toList();
 137         }
 138         return List.of();
 139     }
 140
 141     default Stream<CommonInterface> getActiveChildren(FeatureArea area) {
 142         return getActiveChildren().stream().filter(child -> child.getModuleType().feature == area);
 143     }
 144
 145     default <T extends RestCapability<?>> Optional<T> getHomeCapability(Class<T> clazz) {
 146         return recurseUpToHomeHandler(this).map(handler -> handler.getCapabilities().get(clazz))
 147                 .orElse(Optional.empty());
 148     }
 149
 150     default void setNewData(NAObject newData) {
 151         if (newData instanceof NAThing thingData) {
 152             if (getId().equals(thingData.getBridge())) {
 153                 getActiveChildren().stream().filter(child -> child.getId().equals(thingData.getId())).findFirst()
 154                         .ifPresent(child -> child.setNewData(thingData));
 155                 return;
 156             }
 157         }
 158         String finalReason = null;
 159         for (Capability cap : getCapabilities().values()) {
 160             String thingStatusReason = cap.setNewData(newData);
 161             if (thingStatusReason != null) {
 162                 finalReason = thingStatusReason;
 163             }
 164         }
 165         // Prevent turning ONLINE myself if in the meantime something turned account OFFLINE
 166         ApiBridgeHandler accountHandler = getAccountHandler();
 167         if (accountHandler != null && accountHandler.isConnected() && !newData.isIgnoredForThingUpdate()) {
 168             setThingStatus(finalReason == null ? ThingStatus.ONLINE : ThingStatus.OFFLINE, ThingStatusDetail.NONE,
 169                     finalReason);
 170         }
 171     }
 172
 173     default void commonHandleCommand(ChannelUID channelUID, Command command) {
 174         if (ThingStatus.ONLINE.equals(getThing().getStatus())) {
 175             if (command == RefreshType.REFRESH) {
 176                 expireData();
 177                 return;
 178             }
 179             String channelName = channelUID.getIdWithoutGroup();
 180             getCapabilities().values().forEach(cap -> cap.handleCommand(channelName, command));
 181         } else {
 182             getLogger().debug("Command {} on channel {} dropped - thing is not ONLINE", command, channelUID);
 183         }
 184     }
 185
 186     default void proceedWithUpdate() {
 187         updateReadings().forEach(dataSet -> setNewData(dataSet));
 188     }
 189
 190     default List<NAObject> updateReadings() {
 191         List<NAObject> result = new ArrayList<>();
 192         getCapabilities().values().forEach(cap -> result.addAll(cap.updateReadings()));
 193         getActiveChildren().forEach(child -> result.addAll(child.updateReadings()));
 194         return result;
 195     }
 196
 197     default void commonInitialize() {
 198         Bridge bridge = getBridge();
 199         if (bridge == null || bridge.getHandler() == null) {
 200             setThingStatus(ThingStatus.OFFLINE, ThingStatusDetail.BRIDGE_UNINITIALIZED, null);
 201         } else if (!ThingStatus.ONLINE.equals(bridge.getStatus())) {
 202             setThingStatus(ThingStatus.OFFLINE, ThingStatusDetail.BRIDGE_OFFLINE, null);
 203             removeRefreshCapability();
 204         } else {
 205             setThingStatus(ThingStatus.UNKNOWN, ThingStatusDetail.NONE, null);
 206             setRefreshCapability();
 207             getScheduler().schedule(() -> {
 208                 CommonInterface bridgeHandler = getBridgeHandler();
 209                 if (bridgeHandler != null) {
 210                     bridgeHandler.expireData();
 211                 }
 212             }, 1, TimeUnit.SECONDS);
 213         }
 214     }
 215
 216     default ModuleType getModuleType() {
 217         return ModuleType.from(getThing().getThingTypeUID());
 218     }
 219
 220     default void setRefreshCapability() {
 221         if (ModuleType.ACCOUNT.equals(getModuleType().getBridge())) {
 222             NAThingConfiguration config = getThing().getConfiguration().as(NAThingConfiguration.class);
 223             getCapabilities().put(new RefreshCapability(this, getScheduler(), config.refreshInterval));
 224         }
 225     }
 226
 227     default void removeRefreshCapability() {
 228         Capability refreshCap = getCapabilities().remove(RefreshCapability.class);
 229         if (refreshCap != null) {
 230             refreshCap.dispose();
 231         }
 232     }
 233
 234     default void commonDispose() {
 235         getCapabilities().values().forEach(Capability::dispose);
 236     }
 237
 238     default void removeChannels(List<Channel> channels) {
 239         ThingBuilder builder = editThing().withoutChannels(channels);
 240         updateThing(builder.build());
 241     }
 242 }