git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2022 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.VENDOR;
  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.NAHomeStatus.HomeStatus;
  32 import org.openhab.binding.netatmo.internal.api.dto.NAMain;
  33 import org.openhab.binding.netatmo.internal.api.dto.NAObject;
  34 import org.openhab.binding.netatmo.internal.api.dto.NAThing;
  35 import org.openhab.binding.netatmo.internal.handler.CommonInterface;
  36 import org.openhab.core.thing.Thing;
  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
  49     protected final Thing thing;
  50     protected final CommonInterface handler;
  51     protected final ModuleType moduleType;
  52
  53     protected boolean firstLaunch;
  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.moduleType = ModuleType.from(thing.getThingTypeUID());
  61     }
  62
  63     public final @Nullable String setNewData(NAObject newData) {
  64         beforeNewData();
  65         if (newData instanceof HomeData) {
  66             updateHomeData((HomeData) newData);
  67         }
  68         if (newData instanceof HomeStatus) {
  69             updateHomeStatus((HomeStatus) newData);
  70         }
  71         if (newData instanceof HomeStatusModule) {
  72             updateHomeStatusModule((HomeStatusModule) newData);
  73         }
  74         if (newData instanceof Event) {
  75             updateEvent((Event) newData);
  76         }
  77         if (newData instanceof HomeEvent) {
  78             updateHomeEvent((HomeEvent) newData);
  79         }
  80         if (newData instanceof NAThing) {
  81             updateNAThing((NAThing) newData);
  82         }
  83         if (newData instanceof NAMain) {
  84             updateNAMain((NAMain) newData);
  85         }
  86         if (newData instanceof Device) {
  87             updateNADevice((Device) newData);
  88         }
  89         afterNewData(newData);
  90         return statusReason;
  91     }
  92
  93     protected void beforeNewData() {
  94         properties = new HashMap<>(thing.getProperties());
  95         firstLaunch = properties.isEmpty();
  96         if (firstLaunch && !moduleType.isLogical()) {
  97             String name = moduleType.apiName.isBlank() ? moduleType.name() : moduleType.apiName;
  98             properties.put(PROPERTY_MODEL_ID, name);
  99             properties.put(PROPERTY_VENDOR, VENDOR);
 100         }
 101         statusReason = null;
 102     }
 103
 104     protected void afterNewData(@Nullable NAObject newData) {
 105         if (!properties.equals(thing.getProperties())) {
 106             thing.setProperties(properties);
 107         }
 108     }
 109
 110     protected void updateNAThing(NAThing newData) {
 111         String firmware = newData.getFirmware();
 112         if (firmware != null && !firmware.isBlank()) {
 113             properties.put(PROPERTY_FIRMWARE_VERSION, firmware);
 114         }
 115         if (!newData.isReachable()) {
 116             statusReason = "@text/device-not-connected";
 117         }
 118     }
 119
 120     protected void updateNAMain(NAMain newData) {
 121         // do nothing by default, can be overridden by subclasses
 122     }
 123
 124     protected void updateHomeEvent(HomeEvent newData) {
 125         // do nothing by default, can be overridden by subclasses
 126     }
 127
 128     protected void updateHomeStatus(HomeStatus newData) {
 129         // do nothing by default, can be overridden by subclasses
 130     }
 131
 132     protected void updateHomeData(HomeData newData) {
 133         // do nothing by default, can be overridden by subclasses
 134     }
 135
 136     protected void updateEvent(Event newData) {
 137         // do nothing by default, can be overridden by subclasses
 138     }
 139
 140     protected void updateNADevice(Device newData) {
 141         // do nothing by default, can be overridden by subclasses
 142     }
 143
 144     public void initialize() {
 145         // do nothing by default, can be overridden by subclasses
 146     }
 147
 148     public void expireData() {
 149         if (!handler.getCapabilities().containsKey(RefreshCapability.class)) {
 150             CommonInterface bridgeHandler = handler.getBridgeHandler();
 151             if (bridgeHandler != null) {
 152                 bridgeHandler.expireData();
 153             }
 154         }
 155     }
 156
 157     public void dispose() {
 158         // do nothing by default, can be overridden by subclasses
 159     }
 160
 161     public void updateHomeStatusModule(HomeStatusModule newData) {
 162         // do nothing by default, can be overridden by subclasses
 163     }
 164
 165     public void handleCommand(String channelName, Command command) {
 166         // do nothing by default, can be overridden by subclasses
 167     }
 168
 169     public Collection<Class<? extends ThingHandlerService>> getServices() {
 170         return List.of();
 171     }
 172
 173     public List<NAObject> updateReadings() {
 174         return List.of();
 175     }
 176 }