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
  17 import java.util.ArrayList;
  18 import java.util.List;
  19 import java.util.Set;
  20 import java.util.stream.Collectors;
  21
  22 import org.eclipse.jdt.annotation.NonNullByDefault;
  23 import org.eclipse.jdt.annotation.Nullable;
  24 import org.openhab.binding.netatmo.internal.api.HomeApi;
  25 import org.openhab.binding.netatmo.internal.api.NetatmoException;
  26 import org.openhab.binding.netatmo.internal.api.data.NetatmoConstants.FeatureArea;
  27 import org.openhab.binding.netatmo.internal.api.dto.HomeData;
  28 import org.openhab.binding.netatmo.internal.api.dto.HomeDataModule;
  29 import org.openhab.binding.netatmo.internal.api.dto.HomeDataPerson;
  30 import org.openhab.binding.netatmo.internal.api.dto.Location;
  31 import org.openhab.binding.netatmo.internal.api.dto.NAHomeStatus.HomeStatus;
  32 import org.openhab.binding.netatmo.internal.api.dto.NAObject;
  33 import org.openhab.binding.netatmo.internal.deserialization.NAObjectMap;
  34 import org.openhab.binding.netatmo.internal.handler.CommonInterface;
  35 import org.openhab.binding.netatmo.internal.providers.NetatmoDescriptionProvider;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 /**
  40  * The {@link HomeCapability} is the base class for handler able to manage persons and modules
  41  *
  42  * @author Gaël L'hopital - Initial contribution
  43  *
  44  */
  45 @NonNullByDefault
  46 public class HomeCapability extends RestCapability<HomeApi> {
  47     private final Logger logger = LoggerFactory.getLogger(HomeCapability.class);
  48
  49     private final NetatmoDescriptionProvider descriptionProvider;
  50
  51     private NAObjectMap<HomeDataPerson> persons = new NAObjectMap<>();
  52     private NAObjectMap<HomeDataModule> modules = new NAObjectMap<>();
  53
  54     private Set<FeatureArea> featuresArea = Set.of();
  55
  56     public HomeCapability(CommonInterface handler, NetatmoDescriptionProvider descriptionProvider) {
  57         super(handler, HomeApi.class);
  58         this.descriptionProvider = descriptionProvider;
  59     }
  60
  61     @Override
  62     protected void updateHomeData(HomeData home) {
  63         featuresArea = home.getFeatures();
  64         if (hasFeature(FeatureArea.SECURITY) && !handler.getCapabilities().containsKey(SecurityCapability.class)) {
  65             handler.getCapabilities().put(new SecurityCapability(handler));
  66         }
  67         if (hasFeature(FeatureArea.ENERGY) && !handler.getCapabilities().containsKey(EnergyCapability.class)) {
  68             handler.getCapabilities().put(new EnergyCapability(handler, descriptionProvider));
  69         }
  70         if (firstLaunch) {
  71             home.getCountry().map(country -> properties.put(PROPERTY_COUNTRY, country));
  72             home.getTimezone().map(tz -> properties.put(PROPERTY_TIMEZONE, tz));
  73             properties.put(GROUP_LOCATION, ((Location) home).getLocation().toString());
  74             properties.put(PROPERTY_FEATURE, featuresArea.stream().map(f -> f.name()).collect(Collectors.joining(",")));
  75         }
  76     }
  77
  78     @Override
  79     protected void afterNewData(@Nullable NAObject newData) {
  80         super.afterNewData(newData);
  81         if (firstLaunch && !hasFeature(FeatureArea.SECURITY)) {
  82             handler.removeChannels(thing.getChannelsOfGroup(GROUP_SECURITY));
  83         }
  84         if (firstLaunch && !hasFeature(FeatureArea.ENERGY)) {
  85             handler.removeChannels(thing.getChannelsOfGroup(GROUP_ENERGY));
  86         }
  87     }
  88
  89     private boolean hasFeature(FeatureArea seeked) {
  90         return featuresArea.contains(seeked);
  91     }
  92
  93     public NAObjectMap<HomeDataPerson> getPersons() {
  94         return persons;
  95     }
  96
  97     public NAObjectMap<HomeDataModule> getModules() {
  98         return modules;
  99     }
 100
 101     @Override
 102     protected List<NAObject> updateReadings(HomeApi api) {
 103         List<NAObject> result = new ArrayList<>();
 104         try {
 105             HomeData homeData = api.getHomeData(handler.getId());
 106             if (homeData != null) {
 107                 result.add(homeData);
 108                 persons = homeData.getPersons();
 109                 modules = homeData.getModules();
 110             }
 111             HomeStatus homeStatus = api.getHomeStatus(handler.getId());
 112             if (homeStatus != null) {
 113                 result.add(homeStatus);
 114             }
 115         } catch (NetatmoException e) {
 116             logger.warn("Error getting Home informations : {}", e.getMessage());
 117         }
 118         return result;
 119     }
 120 }