2 * Copyright (c) 2010-2022 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 java.util.ArrayList;
16 import java.util.Collection;
17 import java.util.HashMap;
18 import java.util.List;
21 import org.eclipse.jdt.annotation.NonNullByDefault;
22 import org.eclipse.jdt.annotation.Nullable;
23 import org.openhab.binding.netatmo.internal.api.NetatmoException;
24 import org.openhab.binding.netatmo.internal.api.SecurityApi;
25 import org.openhab.binding.netatmo.internal.api.data.NetatmoConstants.FloodLightMode;
26 import org.openhab.binding.netatmo.internal.api.dto.HomeData;
27 import org.openhab.binding.netatmo.internal.api.dto.HomeDataModule;
28 import org.openhab.binding.netatmo.internal.api.dto.HomeDataPerson;
29 import org.openhab.binding.netatmo.internal.api.dto.HomeEvent;
30 import org.openhab.binding.netatmo.internal.api.dto.HomeStatusModule;
31 import org.openhab.binding.netatmo.internal.api.dto.HomeStatusPerson;
32 import org.openhab.binding.netatmo.internal.api.dto.NAHomeStatus.HomeStatus;
33 import org.openhab.binding.netatmo.internal.api.dto.NAObject;
34 import org.openhab.binding.netatmo.internal.deserialization.NAObjectMap;
35 import org.openhab.binding.netatmo.internal.handler.CommonInterface;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
40 * The {@link SecurityCapability} is the base class for handler able to handle security features
42 * @author Gaƫl L'hopital - Initial contribution
46 class SecurityCapability extends RestCapability<SecurityApi> {
47 private final Logger logger = LoggerFactory.getLogger(SecurityCapability.class);
49 private static final Map<String, HomeEvent> eventBuffer = new HashMap<>();
51 SecurityCapability(CommonInterface handler) {
52 super(handler, SecurityApi.class);
56 protected void updateHomeData(HomeData homeData) {
57 NAObjectMap<HomeDataPerson> persons = homeData.getPersons();
58 NAObjectMap<HomeDataModule> modules = homeData.getModules();
59 handler.getActiveChildren().forEach(childHandler -> {
60 String childId = childHandler.getId();
61 persons.getOpt(childId).ifPresentOrElse(personData -> {
62 personData.setIgnoredForThingUpdate(true);
63 childHandler.setNewData(personData);
65 modules.getOpt(childId).ifPresent(childData -> {
66 childData.setIgnoredForThingUpdate(true);
67 childHandler.setNewData(childData);
69 modules.values().stream().filter(module -> childId.equals(module.getBridge()))
70 .forEach(bridgedModule -> {
71 childHandler.setNewData(bridgedModule);
78 protected void updateHomeStatus(HomeStatus homeStatus) {
79 NAObjectMap<HomeStatusPerson> persons = homeStatus.getPersons();
80 NAObjectMap<HomeStatusModule> modules = homeStatus.getModules();
81 handler.getActiveChildren().forEach(childHandler -> {
82 String childId = childHandler.getId();
83 persons.getOpt(childId).ifPresentOrElse(personData -> childHandler.setNewData(personData), () -> {
84 modules.getOpt(childId).ifPresentOrElse(childData -> {
85 childHandler.setNewData(childData);
86 modules.values().stream().filter(module -> childId.equals(module.getBridge()))
87 .forEach(bridgedModule -> {
88 childHandler.setNewData(bridgedModule);
92 // This module is not present in the homestatus data, so it is considered as unreachable
93 HomeStatusModule module = new HomeStatusModule();
94 module.setReachable(false);
95 childHandler.setNewData(module);
102 protected void updateHomeEvent(HomeEvent homeEvent) {
103 String personId = homeEvent.getPersonId();
104 if (personId != null) {
105 handler.getActiveChildren().stream().filter(handler -> personId.equals(handler.getId())).findFirst()
106 .ifPresent(handler -> {
107 homeEvent.setIgnoredForThingUpdate(true);
108 handler.setNewData(homeEvent);
111 String cameraId = homeEvent.getCameraId();
112 handler.getActiveChildren().stream().filter(handler -> cameraId.equals(handler.getId())).findFirst()
113 .ifPresent(handler -> {
114 homeEvent.setIgnoredForThingUpdate(true);
115 handler.setNewData(homeEvent);
120 protected List<NAObject> updateReadings(SecurityApi api) {
121 List<NAObject> result = new ArrayList<>();
123 Collection<HomeEvent> lastEvents = api.getHomeEvents(handler.getId());
124 lastEvents.stream().forEach(event -> {
125 HomeEvent previousEvent = eventBuffer.get(event.getCameraId());
126 if (previousEvent == null || previousEvent.getTime().isBefore(event.getTime())) {
127 eventBuffer.put(event.getCameraId(), event);
129 String personId = event.getPersonId();
130 if (personId != null) {
131 previousEvent = eventBuffer.get(personId);
132 if (previousEvent == null || previousEvent.getTime().isBefore(event.getTime())) {
133 eventBuffer.put(personId, event);
137 } catch (NetatmoException e) {
138 logger.warn("Error retrieving last events for home '{}' : {}", handler.getId(), e.getMessage());
143 public @Nullable HomeEvent getLastPersonEvent(String personId) {
144 HomeEvent event = eventBuffer.get(personId);
146 Collection<HomeEvent> events = requestPersonEvents(personId);
147 if (!events.isEmpty()) {
148 event = events.iterator().next();
149 eventBuffer.put(personId, event);
155 public @Nullable HomeEvent getLastDeviceEvent(String cameraId, String deviceType) {
156 HomeEvent event = eventBuffer.get(cameraId);
158 Collection<HomeEvent> events = requestDeviceEvents(cameraId, deviceType);
159 if (!events.isEmpty()) {
160 event = events.iterator().next();
161 eventBuffer.put(cameraId, event);
167 private Collection<HomeEvent> requestDeviceEvents(String cameraId, String deviceType) {
168 return getApi().map(api -> {
170 return api.getDeviceEvents(handler.getId(), cameraId, deviceType);
171 } catch (NetatmoException e) {
172 logger.warn("Error retrieving last events of camera '{}' : {}", cameraId, e.getMessage());
175 }).orElse(List.of());
178 private Collection<HomeEvent> requestPersonEvents(String personId) {
179 return getApi().map(api -> {
181 return api.getPersonEvents(handler.getId(), personId);
182 } catch (NetatmoException e) {
183 logger.warn("Error retrieving last events of person '{}' : {}", personId, e.getMessage());
186 }).orElse(List.of());
189 public void setPersonAway(String personId, boolean away) {
190 getApi().ifPresent(api -> {
192 api.setPersonAwayStatus(handler.getId(), personId, away);
193 handler.expireData();
194 } catch (NetatmoException e) {
195 logger.warn("Error setting person away/at home '{}' : {}", personId, e.getMessage());
200 public @Nullable String ping(String vpnUrl) {
201 return getApi().map(api -> {
202 return api.ping(vpnUrl);
206 public void changeStatus(@Nullable String localURL, boolean status) {
207 if (localURL == null) {
208 logger.info("Monitoring changes can only be done on local camera.");
211 getApi().ifPresent(api -> {
213 api.changeStatus(localURL, status);
214 handler.expireData();
215 } catch (NetatmoException e) {
216 logger.warn("Error changing camera monitoring status '{}' : {}", status, e.getMessage());
221 public void changeFloodlightMode(String cameraId, FloodLightMode mode) {
222 getApi().ifPresent(api -> {
224 api.changeFloodLightMode(handler.getId(), cameraId, mode);
225 handler.expireData();
226 } catch (NetatmoException e) {
227 logger.warn("Error changing Presence floodlight mode '{}' : {}", mode, e.getMessage());