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 static org.openhab.binding.netatmo.internal.NetatmoBindingConstants.*;
  16
  17 import java.util.ArrayList;
  18 import java.util.HashSet;
  19 import java.util.List;
  20 import java.util.Set;
  21 import java.util.stream.Collectors;
  22
  23 import org.eclipse.jdt.annotation.NonNullByDefault;
  24 import org.eclipse.jdt.annotation.Nullable;
  25 import org.openhab.binding.netatmo.internal.api.HomeApi;
  26 import org.openhab.binding.netatmo.internal.api.NetatmoException;
  27 import org.openhab.binding.netatmo.internal.api.data.NetatmoConstants.FeatureArea;
  28 import org.openhab.binding.netatmo.internal.api.dto.HomeData;
  29 import org.openhab.binding.netatmo.internal.api.dto.Location;
  30 import org.openhab.binding.netatmo.internal.api.dto.NAError;
  31 import org.openhab.binding.netatmo.internal.api.dto.NAObject;
  32 import org.openhab.binding.netatmo.internal.config.HomeConfiguration;
  33 import org.openhab.binding.netatmo.internal.handler.CommonInterface;
  34 import org.openhab.binding.netatmo.internal.providers.NetatmoDescriptionProvider;
  35 import org.openhab.core.thing.Bridge;
  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
  48     private final Logger logger = LoggerFactory.getLogger(HomeCapability.class);
  49     private final Set<FeatureArea> featureAreas = new HashSet<>();
  50     private final NetatmoDescriptionProvider descriptionProvider;
  51     private final Set<String> homeIds = new HashSet<>(3);
  52
  53     public HomeCapability(CommonInterface handler, NetatmoDescriptionProvider descriptionProvider) {
  54         super(handler, HomeApi.class);
  55         this.descriptionProvider = descriptionProvider;
  56     }
  57
  58     @Override
  59     public void initialize() {
  60         super.initialize();
  61         HomeConfiguration config = handler.getThingConfigAs(HomeConfiguration.class);
  62         homeIds.add(config.getId());
  63         if (!config.energyId.isBlank()) {
  64             homeIds.add(config.energyId);
  65         }
  66         if (!config.securityId.isBlank()) {
  67             homeIds.add(config.securityId);
  68         }
  69         if (hasArea(FeatureArea.SECURITY) && !handler.getCapabilities().containsKey(SecurityCapability.class)) {
  70             handler.getCapabilities().put(new SecurityCapability(handler));
  71         }
  72         if (hasArea(FeatureArea.ENERGY) && !handler.getCapabilities().containsKey(EnergyCapability.class)) {
  73             handler.getCapabilities().put(new EnergyCapability(handler, descriptionProvider));
  74         }
  75     }
  76
  77     @Override
  78     public void dispose() {
  79         homeIds.clear();
  80         super.dispose();
  81     }
  82
  83     @Override
  84     protected void updateHomeData(HomeData home) {
  85         if (firstLaunch) {
  86             home.getCountry().map(country -> properties.put(PROPERTY_COUNTRY, country));
  87             home.getTimezone().map(tz -> properties.put(PROPERTY_TIMEZONE, tz));
  88             properties.put(GROUP_LOCATION, ((Location) home).getLocation().toString());
  89             properties.put(PROPERTY_FEATURE,
  90                     featureAreas.stream().map(FeatureArea::name).collect(Collectors.joining(",")));
  91         }
  92     }
  93
  94     @Override
  95     protected void afterNewData(@Nullable NAObject newData) {
  96         if (firstLaunch && !hasArea(FeatureArea.SECURITY)) {
  97             handler.removeChannels(thing.getChannelsOfGroup(GROUP_SECURITY));
  98         }
  99         if (firstLaunch && !hasArea(FeatureArea.ENERGY)) {
 100             handler.removeChannels(thing.getChannelsOfGroup(GROUP_ENERGY));
 101         }
 102         super.afterNewData(newData);
 103     }
 104
 105     private boolean hasArea(FeatureArea searched) {
 106         return featureAreas.contains(searched);
 107     }
 108
 109     /**
 110      * Errored equipments are reported at home level - so we need to explore all the tree to identify modules
 111      * depending from a child device.
 112      */
 113     @Override
 114     protected void updateErrors(NAError error) {
 115         handler.getAllActiveChildren((Bridge) thing).stream().filter(handler -> handler.getId().equals(error.getId()))
 116                 .findFirst().ifPresent(handler -> handler.setNewData(error));
 117     }
 118
 119     @Override
 120     protected List<NAObject> updateReadings(HomeApi api) {
 121         List<NAObject> result = new ArrayList<>();
 122         homeIds.stream().filter(id -> !id.isEmpty()).forEach(id -> {
 123             try {
 124                 HomeData homeData = api.getHomeData(id);
 125                 if (homeData != null) {
 126                     result.add(homeData);
 127                     featureAreas.addAll(homeData.getFeatures());
 128                 }
 129
 130                 api.getHomeStatus(id).ifPresent(body -> {
 131                     body.getHomeStatus().ifPresent(result::add);
 132                     result.addAll(body.getErrors());
 133                 });
 134             } catch (NetatmoException e) {
 135                 logger.warn("Error getting Home informations: {}", e.getMessage());
 136             }
 137         });
 138         return result;
 139     }
 140 }