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.Collection;
16 import java.util.List;
18 import org.eclipse.jdt.annotation.NonNullByDefault;
19 import org.eclipse.jdt.annotation.Nullable;
20 import org.openhab.binding.netatmo.internal.api.NetatmoException;
21 import org.openhab.binding.netatmo.internal.api.SecurityApi;
22 import org.openhab.binding.netatmo.internal.api.data.NetatmoConstants.FloodLightMode;
23 import org.openhab.binding.netatmo.internal.api.dto.HomeData;
24 import org.openhab.binding.netatmo.internal.api.dto.HomeDataModule;
25 import org.openhab.binding.netatmo.internal.api.dto.HomeDataPerson;
26 import org.openhab.binding.netatmo.internal.api.dto.HomeEvent;
27 import org.openhab.binding.netatmo.internal.api.dto.HomeStatusModule;
28 import org.openhab.binding.netatmo.internal.api.dto.HomeStatusPerson;
29 import org.openhab.binding.netatmo.internal.api.dto.NAHomeStatus.HomeStatus;
30 import org.openhab.binding.netatmo.internal.deserialization.NAObjectMap;
31 import org.openhab.binding.netatmo.internal.handler.CommonInterface;
32 import org.slf4j.Logger;
33 import org.slf4j.LoggerFactory;
36 * The {@link SecurityCapability} is the base class for handler able to handle security features
38 * @author Gaƫl L'hopital - Initial contribution
42 class SecurityCapability extends RestCapability<SecurityApi> {
43 private final Logger logger = LoggerFactory.getLogger(SecurityCapability.class);
45 SecurityCapability(CommonInterface handler) {
46 super(handler, SecurityApi.class);
50 protected void updateHomeData(HomeData homeData) {
51 NAObjectMap<HomeDataPerson> persons = homeData.getPersons();
52 NAObjectMap<HomeDataModule> modules = homeData.getModules();
53 handler.getActiveChildren().forEach(childHandler -> {
54 String childId = childHandler.getId();
55 persons.getOpt(childId).ifPresentOrElse(person -> {
56 person.setIgnoredForThingUpdate(true);
57 childHandler.setNewData(person);
59 modules.getOpt(childId).ifPresent(module -> {
60 module.setIgnoredForThingUpdate(true);
61 childHandler.setNewData(module);
68 protected void updateHomeStatus(HomeStatus homeStatus) {
69 NAObjectMap<HomeStatusPerson> persons = homeStatus.getPersons();
70 NAObjectMap<HomeStatusModule> modules = homeStatus.getModules();
71 handler.getActiveChildren().forEach(childHandler -> {
72 String childId = childHandler.getId();
73 persons.getOpt(childId).ifPresentOrElse(person -> childHandler.setNewData(person), () -> {
74 modules.getOpt(childId).ifPresentOrElse(module -> childHandler.setNewData(module), () -> {
75 // This module is not present in the homestatus data, so it is considered as unreachable
76 HomeStatusModule module = new HomeStatusModule();
77 module.setReachable(false);
78 childHandler.setNewData(module);
85 protected void updateHomeEvent(HomeEvent homeEvent) {
86 String personId = homeEvent.getPersonId();
87 if (personId != null) {
88 handler.getActiveChildren().stream().filter(handler -> personId.equals(handler.getId())).findFirst()
89 .ifPresent(handler -> {
90 homeEvent.setIgnoredForThingUpdate(true);
91 handler.setNewData(homeEvent);
94 String cameraId = homeEvent.getCameraId();
95 handler.getActiveChildren().stream().filter(handler -> cameraId.equals(handler.getId())).findFirst()
96 .ifPresent(handler -> {
97 homeEvent.setIgnoredForThingUpdate(true);
98 handler.setNewData(homeEvent);
102 public Collection<HomeEvent> getCameraEvents(String cameraId, String deviceType) {
103 return getApi().map(api -> {
105 return api.getCameraEvents(handler.getId(), cameraId, deviceType);
106 } catch (NetatmoException e) {
107 logger.warn("Error retrieving last events of camera '{}' : {}", cameraId, e.getMessage());
110 }).orElse(List.of());
113 public Collection<HomeEvent> getPersonEvents(String personId) {
114 return getApi().map(api -> {
116 return api.getPersonEvents(handler.getId(), personId);
117 } catch (NetatmoException e) {
118 logger.warn("Error retrieving last events of person '{}' : {}", personId, e.getMessage());
121 }).orElse(List.of());
124 public void setPersonAway(String personId, boolean away) {
125 getApi().ifPresent(api -> {
127 api.setPersonAwayStatus(handler.getId(), personId, away);
128 handler.expireData();
129 } catch (NetatmoException e) {
130 logger.warn("Error setting person away/at home '{}' : {}", personId, e.getMessage());
135 public @Nullable String ping(String vpnUrl) {
136 return getApi().map(api -> {
138 return api.ping(vpnUrl);
139 } catch (NetatmoException e) {
140 logger.warn("Error pinging camera '{}' : {}", vpnUrl, e.getMessage());
146 public void changeStatus(@Nullable String localURL, boolean status) {
147 if (localURL == null) {
148 logger.info("Monitoring changes can only be done on local camera.");
151 getApi().ifPresent(api -> {
153 api.changeStatus(localURL, status);
154 handler.expireData();
155 } catch (NetatmoException e) {
156 logger.warn("Error changing camera monitoring status '{}' : {}", status, e.getMessage());
161 public void changeFloodlightMode(String cameraId, FloodLightMode mode) {
162 getApi().ifPresent(api -> {
164 api.changeFloodLightMode(handler.getId(), cameraId, mode);
165 handler.expireData();
166 } catch (NetatmoException e) {
167 logger.warn("Error changing Presence floodlight mode '{}' : {}", mode, e.getMessage());