2 * Copyright (c) 2010-2023 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
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
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.binding.netatmo.internal.handler.capability;
15 import static org.openhab.binding.netatmo.internal.NetatmoBindingConstants.*;
17 import java.util.ArrayList;
18 import java.util.HashSet;
19 import java.util.List;
21 import java.util.stream.Collectors;
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.NAHomeStatus.HomeStatus;
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.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
39 * The {@link HomeCapability} is the base class for handler able to manage persons and modules
41 * @author Gaƫl L'hopital - Initial contribution
45 public class HomeCapability extends RestCapability<HomeApi> {
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<>();
52 public HomeCapability(CommonInterface handler, NetatmoDescriptionProvider descriptionProvider) {
53 super(handler, HomeApi.class);
54 this.descriptionProvider = descriptionProvider;
58 public void initialize() {
60 HomeConfiguration config = handler.getConfiguration().as(HomeConfiguration.class);
61 homeIds.add(config.getId());
62 if (!config.energyId.isBlank()) {
63 homeIds.add(config.energyId);
65 if (!config.securityId.isBlank()) {
66 homeIds.add(config.securityId);
71 public void dispose() {
77 protected void updateHomeData(HomeData home) {
78 if (hasArea(FeatureArea.SECURITY) && !handler.getCapabilities().containsKey(SecurityCapability.class)) {
79 handler.getCapabilities().put(new SecurityCapability(handler));
81 if (hasArea(FeatureArea.ENERGY) && !handler.getCapabilities().containsKey(EnergyCapability.class)) {
82 handler.getCapabilities().put(new EnergyCapability(handler, descriptionProvider));
85 home.getCountry().map(country -> properties.put(PROPERTY_COUNTRY, country));
86 home.getTimezone().map(tz -> properties.put(PROPERTY_TIMEZONE, tz));
87 properties.put(GROUP_LOCATION, ((Location) home).getLocation().toString());
88 properties.put(PROPERTY_FEATURE,
89 featureAreas.stream().map(FeatureArea::name).collect(Collectors.joining(",")));
94 protected void afterNewData(@Nullable NAObject newData) {
95 super.afterNewData(newData);
96 if (firstLaunch && !hasArea(FeatureArea.SECURITY)) {
97 handler.removeChannels(thing.getChannelsOfGroup(GROUP_SECURITY));
99 if (firstLaunch && !hasArea(FeatureArea.ENERGY)) {
100 handler.removeChannels(thing.getChannelsOfGroup(GROUP_ENERGY));
104 private boolean hasArea(FeatureArea searched) {
105 return featureAreas.contains(searched);
109 protected List<NAObject> updateReadings(HomeApi api) {
110 List<NAObject> result = new ArrayList<>();
111 homeIds.stream().filter(id -> !id.isEmpty()).forEach(id -> {
113 HomeData homeData = api.getHomeData(id);
114 if (homeData != null) {
115 result.add(homeData);
116 featureAreas.addAll(homeData.getFeatures());
118 HomeStatus homeStatus = api.getHomeStatus(id);
119 if (homeStatus != null) {
120 result.add(homeStatus);
122 } catch (NetatmoException e) {
123 logger.warn("Error getting Home informations : {}", e.getMessage());