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