git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 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 import static org.openhab.binding.netatmo.internal.utils.ChannelTypeUtils.*;
  17
  18 import java.util.ArrayList;
  19 import java.util.List;
  20
  21 import org.eclipse.jdt.annotation.NonNullByDefault;
  22 import org.eclipse.jdt.annotation.Nullable;
  23 import org.openhab.binding.netatmo.internal.api.data.NetatmoConstants.AlimentationStatus;
  24 import org.openhab.binding.netatmo.internal.api.data.NetatmoConstants.SdCardStatus;
  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.NAObject;
  29 import org.openhab.binding.netatmo.internal.api.dto.WebhookEvent;
  30 import org.openhab.binding.netatmo.internal.deserialization.NAObjectMap;
  31 import org.openhab.binding.netatmo.internal.handler.CommonInterface;
  32 import org.openhab.binding.netatmo.internal.handler.channelhelper.CameraChannelHelper;
  33 import org.openhab.binding.netatmo.internal.handler.channelhelper.ChannelHelper;
  34 import org.openhab.binding.netatmo.internal.providers.NetatmoDescriptionProvider;
  35 import org.openhab.core.library.types.OnOffType;
  36 import org.openhab.core.thing.ChannelUID;
  37 import org.openhab.core.thing.Thing;
  38 import org.openhab.core.thing.ThingUID;
  39 import org.openhab.core.types.Command;
  40 import org.openhab.core.types.State;
  41 import org.openhab.core.types.StateOption;
  42 import org.openhab.core.types.UnDefType;
  43
  44 /**
  45  * {@link CameraCapability} give to handle Welcome Camera specifics
  46  *
  47  * @author Gaël L'hopital - Initial contribution
  48  *
  49  */
  50 @NonNullByDefault
  51 public class CameraCapability extends HomeSecurityThingCapability {
  52     private final CameraChannelHelper cameraHelper;
  53     private final ChannelUID personChannelUID;
  54
  55     protected @Nullable String localUrl;
  56     protected @Nullable String vpnUrl;
  57     private boolean hasSubEventGroup;
  58     private boolean hasLastEventGroup;
  59
  60     public CameraCapability(CommonInterface handler, NetatmoDescriptionProvider descriptionProvider,
  61             List<ChannelHelper> channelHelpers) {
  62         super(handler, descriptionProvider, channelHelpers);
  63         this.personChannelUID = new ChannelUID(thing.getUID(), GROUP_LAST_EVENT, CHANNEL_EVENT_PERSON_ID);
  64         this.cameraHelper = (CameraChannelHelper) channelHelpers.stream().filter(c -> c instanceof CameraChannelHelper)
  65                 .findFirst().orElseThrow(() -> new IllegalArgumentException(
  66                         "CameraCapability must find a CameraChannelHelper, please file a bug report."));
  67     }
  68
  69     @Override
  70     public void initialize() {
  71         Thing thing = handler.getThing();
  72         hasSubEventGroup = !thing.getChannelsOfGroup(GROUP_SUB_EVENT).isEmpty();
  73         hasLastEventGroup = !thing.getChannelsOfGroup(GROUP_LAST_EVENT).isEmpty();
  74     }
  75
  76     @Override
  77     public void updateHomeStatusModule(HomeStatusModule newData) {
  78         super.updateHomeStatusModule(newData);
  79         // Per documentation vpn_url expires every 3 hours and on camera reboot. So useless to reping it if not changed
  80         String newVpnUrl = newData.getVpnUrl();
  81         if (newVpnUrl != null && !newVpnUrl.equals(vpnUrl)) {
  82             // This will also decrease the number of requests emitted toward Netatmo API.
  83             localUrl = newData.isLocal() ? getSecurityCapability().map(cap -> cap.ping(newVpnUrl)).orElse(null) : null;
  84             cameraHelper.setUrls(newVpnUrl, localUrl);
  85             eventHelper.setUrls(newVpnUrl, localUrl);
  86         }
  87         vpnUrl = newVpnUrl;
  88         if (!SdCardStatus.SD_CARD_WORKING.equals(newData.getSdStatus())
  89                 || !AlimentationStatus.ALIM_CORRECT_POWER.equals(newData.getAlimStatus())) {
  90             statusReason = String.format("%s, %s", newData.getSdStatus(), newData.getAlimStatus());
  91         }
  92     }
  93
  94     @Override
  95     protected void updateWebhookEvent(WebhookEvent event) {
  96         super.updateWebhookEvent(event);
  97
  98         if (hasSubEventGroup) {
  99             updateSubGroup(event, thing.getUID(), GROUP_SUB_EVENT);
 100         }
 101
 102         if (hasLastEventGroup) {
 103             updateSubGroup(event, thing.getUID(), GROUP_LAST_EVENT);
 104         }
 105
 106         // The channel should get triggered at last (after super and sub methods), because this allows rules to access
 107         // the new updated data from the other channels.
 108         final String eventType = event.getEventType().name();
 109         handler.recurseUpToHomeHandler(handler)
 110                 .ifPresent(homeHandler -> homeHandler.triggerChannel(CHANNEL_HOME_EVENT, eventType));
 111         handler.triggerChannel(CHANNEL_HOME_EVENT, eventType);
 112     }
 113
 114     private void updateSubGroup(WebhookEvent event, ThingUID thingUid, String group) {
 115         handler.updateState(new ChannelUID(thingUid, group, CHANNEL_EVENT_TYPE), toStringType(event.getEventType()));
 116         handler.updateState(new ChannelUID(thingUid, group, CHANNEL_EVENT_TIME), toDateTimeType(event.getTime()));
 117         handler.updateState(new ChannelUID(thingUid, group, CHANNEL_EVENT_SNAPSHOT), toRawType(event.getSnapshotUrl()));
 118         handler.updateState(new ChannelUID(thingUid, group, CHANNEL_EVENT_SNAPSHOT_URL),
 119                 toStringType(event.getSnapshotUrl()));
 120         handler.updateState(new ChannelUID(thingUid, group, CHANNEL_EVENT_VIGNETTE), toRawType(event.getVignetteUrl()));
 121         handler.updateState(new ChannelUID(thingUid, group, CHANNEL_EVENT_VIGNETTE_URL),
 122                 toStringType(event.getVignetteUrl()));
 123         handler.updateState(new ChannelUID(thingUid, group, CHANNEL_EVENT_SUBTYPE),
 124                 event.getSubTypeDescription().map(d -> toStringType(d)).orElse(UnDefType.NULL));
 125         final String message = event.getName();
 126         handler.updateState(new ChannelUID(thingUid, group, CHANNEL_EVENT_MESSAGE),
 127                 message == null || message.isBlank() ? UnDefType.NULL : toStringType(message));
 128         State personId = event.getPersons().isEmpty() ? UnDefType.NULL
 129                 : toStringType(event.getPersons().values().iterator().next().getId());
 130         handler.updateState(personChannelUID, personId);
 131     }
 132
 133     @Override
 134     public void handleCommand(String channelName, Command command) {
 135         if (command instanceof OnOffType && CHANNEL_MONITORING.equals(channelName)) {
 136             getSecurityCapability().ifPresent(cap -> cap.changeStatus(localUrl, OnOffType.ON.equals(command)));
 137         } else {
 138             super.handleCommand(channelName, command);
 139         }
 140     }
 141
 142     @Override
 143     protected void beforeNewData() {
 144         super.beforeNewData();
 145         getSecurityCapability().ifPresent(cap -> {
 146             NAObjectMap<HomeDataPerson> persons = cap.getPersons();
 147             descriptionProvider.setStateOptions(personChannelUID,
 148                     persons.values().stream().map(p -> new StateOption(p.getId(), p.getName())).toList());
 149         });
 150     }
 151
 152     @Override
 153     public List<NAObject> updateReadings() {
 154         List<NAObject> result = new ArrayList<>();
 155         getSecurityCapability().ifPresent(cap -> {
 156             HomeEvent event = cap.getDeviceLastEvent(handler.getId(), moduleType.apiName);
 157             if (event != null) {
 158                 result.add(event);
 159                 result.addAll(event.getSubevents());
 160             }
 161         });
 162         return result;
 163     }
 164 }