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.netatmo.internal.handler.capability;
  14
  15 import java.util.Collection;
  16 import java.util.HashMap;
  17 import java.util.List;
  18 import java.util.Map;
  19
  20 import org.eclipse.jdt.annotation.NonNullByDefault;
  21 import org.eclipse.jdt.annotation.Nullable;
  22 import org.openhab.binding.netatmo.internal.api.data.ModuleType;
  23 import org.openhab.binding.netatmo.internal.api.dto.Device;
  24 import org.openhab.binding.netatmo.internal.api.dto.Event;
  25 import org.openhab.binding.netatmo.internal.api.dto.HomeData;
  26 import org.openhab.binding.netatmo.internal.api.dto.HomeEvent;
  27 import org.openhab.binding.netatmo.internal.api.dto.HomeStatusModule;
  28 import org.openhab.binding.netatmo.internal.api.dto.NAError;
  29 import org.openhab.binding.netatmo.internal.api.dto.NAHomeStatus.HomeStatus;
  30 import org.openhab.binding.netatmo.internal.api.dto.NAMain;
  31 import org.openhab.binding.netatmo.internal.api.dto.NAObject;
  32 import org.openhab.binding.netatmo.internal.api.dto.NAThing;
  33 import org.openhab.binding.netatmo.internal.api.dto.WebhookEvent;
  34 import org.openhab.binding.netatmo.internal.handler.CommonInterface;
  35 import org.openhab.core.thing.Thing;
  36 import org.openhab.core.thing.ThingUID;
  37 import org.openhab.core.thing.binding.ThingHandlerService;
  38 import org.openhab.core.types.Command;
  39
  40 /**
  41  * The {@link Capability} is the base class for all inherited capabilities
  42  *
  43  * @author Gaël L'hopital - Initial contribution
  44  *
  45  */
  46 @NonNullByDefault
  47 public class Capability {
  48     protected final Thing thing;
  49     protected final CommonInterface handler;
  50     protected final ModuleType moduleType;
  51     protected final ThingUID thingUID;
  52
  53     protected boolean firstLaunch = true;
  54     protected Map<String, String> properties = Map.of();
  55     protected @Nullable String statusReason;
  56
  57     Capability(CommonInterface handler) {
  58         this.handler = handler;
  59         this.thing = handler.getThing();
  60         this.thingUID = thing.getUID();
  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         statusReason = null;
 105     }
 106
 107     protected void afterNewData(@Nullable NAObject newData) {
 108         if (!properties.equals(thing.getProperties())) {
 109             thing.setProperties(properties);
 110         }
 111         firstLaunch = false;
 112     }
 113
 114     protected void updateNAThing(NAThing newData) {
 115         // do nothing by default, can be overridden by subclasses
 116     }
 117
 118     protected void updateNAMain(NAMain newData) {
 119         // do nothing by default, can be overridden by subclasses
 120     }
 121
 122     protected void updateHomeEvent(HomeEvent newData) {
 123         // do nothing by default, can be overridden by subclasses
 124     }
 125
 126     protected void updateHomeStatus(HomeStatus newData) {
 127         // do nothing by default, can be overridden by subclasses
 128     }
 129
 130     protected void updateHomeData(HomeData newData) {
 131         // do nothing by default, can be overridden by subclasses
 132     }
 133
 134     protected void updateEvent(Event newData) {
 135         // do nothing by default, can be overridden by subclasses
 136     }
 137
 138     protected void updateWebhookEvent(WebhookEvent newData) {
 139         // do nothing by default, can be overridden by subclasses
 140     }
 141
 142     protected void updateNADevice(Device newData) {
 143         // do nothing by default, can be overridden by subclasses
 144     }
 145
 146     protected void updateErrors(NAError error) {
 147         // do nothing by default, can be overridden by subclasses
 148     }
 149
 150     public void initialize() {
 151         // do nothing by default, can be overridden by subclasses
 152     }
 153
 154     public void expireData() {
 155         CommonInterface bridgeHandler = handler.getBridgeHandler();
 156         if (bridgeHandler != null && !handler.getCapabilities().containsKey(RefreshCapability.class)) {
 157             bridgeHandler.expireData();
 158         }
 159     }
 160
 161     public void dispose() {
 162         // do nothing by default, can be overridden by subclasses
 163     }
 164
 165     public void updateHomeStatusModule(HomeStatusModule newData) {
 166         // do nothing by default, can be overridden by subclasses
 167     }
 168
 169     public void handleCommand(String channelName, Command command) {
 170         // do nothing by default, can be overridden by subclasses
 171     }
 172
 173     public Collection<Class<? extends ThingHandlerService>> getServices() {
 174         return List.of();
 175     }
 176
 177     public List<NAObject> updateReadings() {
 178         return List.of();
 179     }
 180 }