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 java.time.Instant;
  16 import java.time.ZoneId;
  17 import java.time.ZonedDateTime;
  18 import java.util.ArrayList;
  19 import java.util.Collection;
  20 import java.util.HashMap;
  21 import java.util.List;
  22 import java.util.Map;
  23 import java.util.Objects;
  24
  25 import org.eclipse.jdt.annotation.NonNullByDefault;
  26 import org.eclipse.jdt.annotation.Nullable;
  27 import org.openhab.binding.netatmo.internal.api.NetatmoException;
  28 import org.openhab.binding.netatmo.internal.api.SecurityApi;
  29 import org.openhab.binding.netatmo.internal.api.data.NetatmoConstants.FeatureArea;
  30 import org.openhab.binding.netatmo.internal.api.data.NetatmoConstants.FloodLightMode;
  31 import org.openhab.binding.netatmo.internal.api.dto.HomeData;
  32 import org.openhab.binding.netatmo.internal.api.dto.HomeDataModule;
  33 import org.openhab.binding.netatmo.internal.api.dto.HomeDataPerson;
  34 import org.openhab.binding.netatmo.internal.api.dto.HomeEvent;
  35 import org.openhab.binding.netatmo.internal.api.dto.HomeStatusModule;
  36 import org.openhab.binding.netatmo.internal.api.dto.HomeStatusPerson;
  37 import org.openhab.binding.netatmo.internal.api.dto.NAHomeStatus.HomeStatus;
  38 import org.openhab.binding.netatmo.internal.api.dto.NAObject;
  39 import org.openhab.binding.netatmo.internal.config.HomeConfiguration;
  40 import org.openhab.binding.netatmo.internal.deserialization.NAObjectMap;
  41 import org.openhab.binding.netatmo.internal.handler.CommonInterface;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45 /**
  46  * The {@link SecurityCapability} is the base class for handler able to handle security features
  47  *
  48  * @author Gaël L'hopital - Initial contribution
  49  *
  50  */
  51 @NonNullByDefault
  52 class SecurityCapability extends RestCapability<SecurityApi> {
  53     private final static ZonedDateTime ZDT_REFERENCE = ZonedDateTime.ofInstant(Instant.ofEpochMilli(0),
  54             ZoneId.systemDefault());
  55
  56     private final Logger logger = LoggerFactory.getLogger(SecurityCapability.class);
  57     private final Map<String, HomeEvent> eventBuffer = new HashMap<>();
  58
  59     private ZonedDateTime freshestEventTime = ZDT_REFERENCE;
  60     private NAObjectMap<HomeDataPerson> persons = new NAObjectMap<>();
  61     private NAObjectMap<HomeDataModule> modules = new NAObjectMap<>();
  62     private String securityId = "";
  63
  64     SecurityCapability(CommonInterface handler) {
  65         super(handler, SecurityApi.class);
  66     }
  67
  68     @Override
  69     public void initialize() {
  70         super.initialize();
  71         securityId = handler.getThingConfigAs(HomeConfiguration.class).getIdForArea(FeatureArea.SECURITY);
  72     }
  73
  74     @Override
  75     protected void updateHomeData(HomeData homeData) {
  76         if (homeData instanceof HomeData.Security securityData) {
  77             persons = securityData.getPersons();
  78             modules = homeData.getModules();
  79             handler.getActiveChildren(FeatureArea.SECURITY).forEach(childHandler -> {
  80                 String childId = childHandler.getId();
  81                 persons.getOpt(childId).ifPresentOrElse(
  82                         personData -> childHandler.setNewData(personData.ignoringForThingUpdate()), () -> {
  83                             modules.getOpt(childId).ifPresent(
  84                                     childData -> childHandler.setNewData(childData.ignoringForThingUpdate()));
  85                             modules.values().stream().filter(module -> childId.equals(module.getBridge()))
  86                                     .forEach(bridgedModule -> childHandler.setNewData(bridgedModule));
  87                         });
  88             });
  89         }
  90     }
  91
  92     @Override
  93     protected void updateHomeStatus(HomeStatus securityStatus) {
  94         NAObjectMap<HomeStatusPerson> persons = securityStatus.getPersons();
  95         NAObjectMap<HomeStatusModule> modules = securityStatus.getModules();
  96         handler.getActiveChildren(FeatureArea.SECURITY).forEach(childHandler -> {
  97             String childId = childHandler.getId();
  98             persons.getOpt(childId).ifPresentOrElse(personData -> childHandler.setNewData(personData), () -> {
  99                 modules.getOpt(childId).ifPresent(childData -> {
 100                     childHandler.setNewData(childData);
 101                     modules.values().stream().filter(module -> childId.equals(module.getBridge()))
 102                             .forEach(bridgedModule -> childHandler.setNewData(bridgedModule));
 103                 });
 104             });
 105         });
 106     }
 107
 108     @Override
 109     protected void updateHomeEvent(HomeEvent homeEvent) {
 110         addEventIfKnownObject(homeEvent, homeEvent.getPersonId());
 111         addEventIfKnownObject(homeEvent, homeEvent.getCameraId());
 112     }
 113
 114     private void addEventIfKnownObject(HomeEvent homeEvent, @Nullable String objectId) {
 115         if (objectId == null) {
 116             return;
 117         }
 118         handler.getActiveChildren(FeatureArea.SECURITY).filter(child -> child.getId().equals(objectId))
 119                 .forEach(child -> child.setNewData(homeEvent));
 120     }
 121
 122     @Override
 123     protected List<NAObject> updateReadings(SecurityApi api) {
 124         List<NAObject> result = new ArrayList<>();
 125         try {
 126             api.getHomeEvents(securityId, freshestEventTime).stream().forEach(event -> {
 127                 bufferIfNewer(event.getCameraId(), event);
 128                 if (event.getPersonId() instanceof String personId) {
 129                     bufferIfNewer(personId, event);
 130                 }
 131                 if (event.getTime().isAfter(freshestEventTime)) {
 132                     freshestEventTime = event.getTime();
 133                 }
 134             });
 135         } catch (NetatmoException e) {
 136             logger.warn("Error retrieving last events for home '{}' : {}", securityId, e.getMessage());
 137         }
 138         return result;
 139     }
 140
 141     private void bufferIfNewer(String id, HomeEvent event) {
 142         HomeEvent previousEvent = eventBuffer.get(id);
 143         if (previousEvent == null || previousEvent.getTime().isBefore(event.getTime())) {
 144             eventBuffer.put(id, event);
 145         }
 146     }
 147
 148     public NAObjectMap<HomeDataPerson> getPersons() {
 149         return persons;
 150     }
 151
 152     public NAObjectMap<HomeDataModule> getModules() {
 153         return modules;
 154     }
 155
 156     public @Nullable HomeEvent getLastPersonEvent(String personId) {
 157         HomeEvent event = eventBuffer.get(personId);
 158         if (event == null) {
 159             Collection<HomeEvent> events = requestPersonEvents(personId);
 160             if (!events.isEmpty()) {
 161                 event = events.iterator().next();
 162                 eventBuffer.put(personId, event);
 163             }
 164         }
 165         return event;
 166     }
 167
 168     public @Nullable HomeEvent getDeviceLastEvent(String moduleId, String deviceType) {
 169         HomeEvent event = eventBuffer.get(moduleId);
 170         if (event == null) {
 171             Collection<HomeEvent> events = requestDeviceEvents(moduleId, deviceType);
 172             if (!events.isEmpty()) {
 173                 event = events.iterator().next();
 174                 eventBuffer.put(moduleId, event);
 175             }
 176         }
 177         return event;
 178     }
 179
 180     private Collection<HomeEvent> requestDeviceEvents(String moduleId, String deviceType) {
 181         return Objects.requireNonNull(getApi().map(api -> {
 182             try {
 183                 return api.getDeviceEvents(securityId, moduleId, deviceType);
 184             } catch (NetatmoException e) {
 185                 logger.warn("Error retrieving last events of camera '{}' : {}", moduleId, e.getMessage());
 186                 return null;
 187             }
 188         }).orElse(List.of()));
 189     }
 190
 191     private Collection<HomeEvent> requestPersonEvents(String personId) {
 192         return Objects.requireNonNull(getApi().map(api -> {
 193             try {
 194                 return api.getPersonEvents(securityId, personId);
 195             } catch (NetatmoException e) {
 196                 logger.warn("Error retrieving last events of person '{}' : {}", personId, e.getMessage());
 197                 return null;
 198             }
 199         }).orElse(List.of()));
 200     }
 201
 202     public void setPersonAway(String personId, boolean away) {
 203         getApi().ifPresent(api -> {
 204             try {
 205                 api.setPersonAwayStatus(securityId, personId, away);
 206                 handler.expireData();
 207             } catch (NetatmoException e) {
 208                 logger.warn("Error setting person away/at home '{}' : {}", personId, e.getMessage());
 209             }
 210         });
 211     }
 212
 213     public @Nullable String ping(String vpnUrl) {
 214         return getApi().map(api -> api.ping(vpnUrl)).orElse(null);
 215     }
 216
 217     public void changeStatus(@Nullable String localURL, boolean status) {
 218         if (localURL == null) {
 219             logger.info("Monitoring changes can only be done on local camera.");
 220             return;
 221         }
 222         getApi().ifPresent(api -> {
 223             try {
 224                 api.changeStatus(localURL, status);
 225                 handler.expireData();
 226             } catch (NetatmoException e) {
 227                 logger.warn("Error changing camera monitoring status '{}' : {}", status, e.getMessage());
 228             }
 229         });
 230     }
 231
 232     public void changeFloodlightMode(String cameraId, FloodLightMode mode) {
 233         getApi().ifPresent(api -> {
 234             try {
 235                 api.changeFloodLightMode(securityId, cameraId, mode);
 236                 handler.expireData();
 237             } catch (NetatmoException e) {
 238                 logger.warn("Error changing Presence floodlight mode '{}' : {}", mode, e.getMessage());
 239             }
 240         });
 241     }
 242 }