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.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.Location;
  29 import org.openhab.binding.netatmo.internal.api.dto.NAError;
  30 import org.openhab.binding.netatmo.internal.api.dto.NAObject;
  31 import org.openhab.binding.netatmo.internal.config.HomeConfiguration;
  32 import org.openhab.binding.netatmo.internal.handler.CommonInterface;
  33 import org.openhab.binding.netatmo.internal.providers.NetatmoDescriptionProvider;
  34 import org.openhab.core.thing.Bridge;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 /**
  39  * The {@link HomeCapability} is the base class for handler able to manage persons and modules
  40  *
  41  * @author Gaël L'hopital - Initial contribution
  42  *
  43  */
  44 @NonNullByDefault
  45 public class HomeCapability extends RestCapability<HomeApi> {
  46
  47     private final Logger logger = LoggerFactory.getLogger(HomeCapability.class);
  48     private final Set<FeatureArea> featureAreas = new HashSet<>();
  49     private final NetatmoDescriptionProvider descriptionProvider;
  50     private final Set<String> homeIds = new HashSet<>(3);
  51
  52     public HomeCapability(CommonInterface handler, NetatmoDescriptionProvider descriptionProvider) {
  53         super(handler, HomeApi.class);
  54         this.descriptionProvider = descriptionProvider;
  55     }
  56
  57     @Override
  58     public void initialize() {
  59         super.initialize();
  60         HomeConfiguration config = handler.getThingConfigAs(HomeConfiguration.class);
  61         homeIds.add(config.getId());
  62         if (!config.energyId.isBlank()) {
  63             homeIds.add(config.energyId);
  64         }
  65         if (!config.securityId.isBlank()) {
  66             homeIds.add(config.securityId);
  67         }
  68     }
  69
  70     @Override
  71     public void dispose() {
  72         homeIds.clear();
  73         super.dispose();
  74     }
  75
  76     @Override
  77     protected void updateHomeData(HomeData home) {
  78         if (firstLaunch) {
  79             if (featureAreas.contains(FeatureArea.SECURITY)) {
  80                 handler.getCapabilities().put(new SecurityCapability(handler));
  81             } else {
  82                 handler.removeChannels(thing.getChannelsOfGroup(GROUP_SECURITY));
  83             }
  84             if (featureAreas.contains(FeatureArea.ENERGY)) {
  85                 handler.getCapabilities().put(new EnergyCapability(handler, descriptionProvider));
  86             } else {
  87                 handler.removeChannels(thing.getChannelsOfGroup(GROUP_ENERGY));
  88             }
  89             home.getCountry().map(country -> properties.put(PROPERTY_COUNTRY, country));
  90             home.getTimezone().map(tz -> properties.put(PROPERTY_TIMEZONE, tz));
  91             properties.put(GROUP_LOCATION, ((Location) home).getLocation().toString());
  92             properties.put(PROPERTY_FEATURE,
  93                     featureAreas.stream().map(FeatureArea::name).collect(Collectors.joining(",")));
  94         }
  95     }
  96
  97     /**
  98      * Errored equipments are reported at home level - so we need to explore all the tree to identify modules
  99      * depending from a child device.
 100      */
 101     @Override
 102     protected void updateErrors(NAError error) {
 103         handler.getAllActiveChildren((Bridge) thing).stream().filter(handler -> handler.getId().equals(error.getId()))
 104                 .findFirst().ifPresent(handler -> handler.setNewData(error));
 105     }
 106
 107     @Override
 108     protected List<NAObject> updateReadings(HomeApi api) {
 109         List<NAObject> result = new ArrayList<>();
 110         homeIds.stream().filter(id -> !id.isEmpty()).forEach(id -> {
 111             try {
 112                 HomeData homeData = api.getHomeData(id);
 113                 if (homeData != null) {
 114                     result.add(homeData);
 115                     featureAreas.addAll(homeData.getFeatures());
 116                 }
 117
 118                 api.getHomeStatus(id).ifPresent(body -> {
 119                     body.getHomeStatus().ifPresent(result::add);
 120                     result.addAll(body.getErrors());
 121                 });
 122             } catch (NetatmoException e) {
 123                 logger.warn("Error getting Home informations: {}", e.getMessage());
 124             }
 125         });
 126         return result;
 127     }
 128 }