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.capability;
  14
  15 import static org.openhab.binding.netatmo.internal.NetatmoBindingConstants.*;
  16 import static org.openhab.core.thing.Thing.*;
  17
  18 import java.util.Collection;
  19 import java.util.HashMap;
  20 import java.util.List;
  21 import java.util.Map;
  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.dto.Device;
  27 import org.openhab.binding.netatmo.internal.api.dto.Event;
  28 import org.openhab.binding.netatmo.internal.api.dto.HomeData;
  29 import org.openhab.binding.netatmo.internal.api.dto.HomeEvent;
  30 import org.openhab.binding.netatmo.internal.api.dto.HomeStatusModule;
  31 import org.openhab.binding.netatmo.internal.api.dto.NAError;
  32 import org.openhab.binding.netatmo.internal.api.dto.NAHomeStatus.HomeStatus;
  33 import org.openhab.binding.netatmo.internal.api.dto.NAMain;
  34 import org.openhab.binding.netatmo.internal.api.dto.NAObject;
  35 import org.openhab.binding.netatmo.internal.api.dto.NAThing;
  36 import org.openhab.binding.netatmo.internal.api.dto.WebhookEvent;
  37 import org.openhab.binding.netatmo.internal.handler.CommonInterface;
  38 import org.openhab.core.thing.Thing;
  39 import org.openhab.core.thing.binding.ThingHandlerService;
  40 import org.openhab.core.types.Command;
  41
  42 /**
  43  * The {@link Capability} is the base class for all inherited capabilities
  44  *
  45  * @author Gaël L'hopital - Initial contribution
  46  *
  47  */
  48 @NonNullByDefault
  49 public class Capability {
  50
  51     protected final Thing thing;
  52     protected final CommonInterface handler;
  53     protected final ModuleType moduleType;
  54
  55     protected boolean firstLaunch;
  56     protected Map<String, String> properties = Map.of();
  57     protected @Nullable String statusReason;
  58
  59     Capability(CommonInterface handler) {
  60         this.handler = handler;
  61         this.thing = handler.getThing();
  62         this.moduleType = ModuleType.from(thing.getThingTypeUID());
  63     }
  64
  65     public final @Nullable String setNewData(NAObject newData) {
  66         beforeNewData();
  67         if (newData instanceof NAError error) {
  68             updateErrors(error);
  69         } else {
  70             if (newData instanceof HomeData homeData) {
  71                 updateHomeData(homeData);
  72             }
  73             if (newData instanceof HomeStatus homeStatus) {
  74                 updateHomeStatus(homeStatus);
  75             }
  76             if (newData instanceof HomeStatusModule homeStatusModule) {
  77                 updateHomeStatusModule(homeStatusModule);
  78             }
  79
  80             if (newData instanceof HomeEvent homeEvent) {
  81                 updateHomeEvent(homeEvent);
  82             } else if (newData instanceof WebhookEvent webhookEvent
  83                     && webhookEvent.getEventType().validFor(moduleType)) {
  84                 updateWebhookEvent(webhookEvent);
  85             } else if (newData instanceof Event event) {
  86                 updateEvent(event);
  87             }
  88
  89             if (newData instanceof NAThing naThing) {
  90                 updateNAThing(naThing);
  91             }
  92             if (newData instanceof NAMain naMain) {
  93                 updateNAMain(naMain);
  94             }
  95             if (newData instanceof Device device) {
  96                 updateNADevice(device);
  97             }
  98         }
  99         afterNewData(newData);
 100         return statusReason;
 101     }
 102
 103     protected void beforeNewData() {
 104         properties = new HashMap<>(thing.getProperties());
 105         firstLaunch = properties.isEmpty();
 106         if (firstLaunch) {
 107             properties.put(PROPERTY_THING_TYPE_VERSION, moduleType.thingTypeVersion);
 108             if (!moduleType.isLogical()) {
 109                 String name = moduleType.apiName.isBlank() ? moduleType.name() : moduleType.apiName;
 110                 properties.put(PROPERTY_MODEL_ID, name);
 111                 properties.put(PROPERTY_VENDOR, VENDOR);
 112             }
 113         }
 114         statusReason = null;
 115     }
 116
 117     protected void afterNewData(@Nullable NAObject newData) {
 118         if (!properties.equals(thing.getProperties())) {
 119             thing.setProperties(properties);
 120         }
 121     }
 122
 123     protected void updateNAThing(NAThing newData) {
 124         String firmware = newData.getFirmware();
 125         if (firmware != null && !firmware.isBlank()) {
 126             properties.put(PROPERTY_FIRMWARE_VERSION, firmware);
 127         }
 128         if (!newData.isReachable()) {
 129             statusReason = "@text/device-not-connected";
 130         }
 131     }
 132
 133     protected void updateNAMain(NAMain newData) {
 134         // do nothing by default, can be overridden by subclasses
 135     }
 136
 137     protected void updateHomeEvent(HomeEvent newData) {
 138         // do nothing by default, can be overridden by subclasses
 139     }
 140
 141     protected void updateHomeStatus(HomeStatus newData) {
 142         // do nothing by default, can be overridden by subclasses
 143     }
 144
 145     protected void updateHomeData(HomeData newData) {
 146         // do nothing by default, can be overridden by subclasses
 147     }
 148
 149     protected void updateEvent(Event newData) {
 150         // do nothing by default, can be overridden by subclasses
 151     }
 152
 153     protected void updateWebhookEvent(WebhookEvent newData) {
 154         // do nothing by default, can be overridden by subclasses
 155     }
 156
 157     protected void updateNADevice(Device newData) {
 158         // do nothing by default, can be overridden by subclasses
 159     }
 160
 161     protected void updateErrors(NAError error) {
 162         // do nothing by default, can be overridden by subclasses
 163     }
 164
 165     public void initialize() {
 166         // do nothing by default, can be overridden by subclasses
 167     }
 168
 169     public void expireData() {
 170         if (!handler.getCapabilities().containsKey(RefreshCapability.class)) {
 171             CommonInterface bridgeHandler = handler.getBridgeHandler();
 172             if (bridgeHandler != null) {
 173                 bridgeHandler.expireData();
 174             }
 175         }
 176     }
 177
 178     public void dispose() {
 179         // do nothing by default, can be overridden by subclasses
 180     }
 181
 182     public void updateHomeStatusModule(HomeStatusModule newData) {
 183         // do nothing by default, can be overridden by subclasses
 184     }
 185
 186     public void handleCommand(String channelName, Command command) {
 187         // do nothing by default, can be overridden by subclasses
 188     }
 189
 190     public Collection<Class<? extends ThingHandlerService>> getServices() {
 191         return List.of();
 192     }
 193
 194     public List<NAObject> updateReadings() {
 195         return List.of();
 196     }
 197 }