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 static org.openhab.binding.netatmo.internal.NetatmoBindingConstants.*;
  16 import static org.openhab.binding.netatmo.internal.utils.ChannelTypeUtils.*;
  17
  18 import java.time.ZonedDateTime;
  19 import java.util.ArrayList;
  20 import java.util.List;
  21 import java.util.stream.Stream;
  22
  23 import org.eclipse.jdt.annotation.NonNullByDefault;
  24 import org.eclipse.jdt.annotation.Nullable;
  25 import org.openhab.binding.netatmo.internal.api.data.EventType;
  26 import org.openhab.binding.netatmo.internal.api.data.ModuleType;
  27 import org.openhab.binding.netatmo.internal.api.dto.Event;
  28 import org.openhab.binding.netatmo.internal.api.dto.HomeDataModule;
  29 import org.openhab.binding.netatmo.internal.api.dto.HomeEvent;
  30 import org.openhab.binding.netatmo.internal.api.dto.NAObject;
  31 import org.openhab.binding.netatmo.internal.api.dto.WebhookEvent;
  32 import org.openhab.binding.netatmo.internal.handler.CommonInterface;
  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.types.Command;
  38 import org.openhab.core.types.StateOption;
  39 import org.openhab.core.types.UnDefType;
  40
  41 /**
  42  * {@link PersonCapability} gives the ability to handle Person specifics
  43  *
  44  * @author Gaël L'hopital - Initial contribution
  45  *
  46  */
  47 @NonNullByDefault
  48 public class PersonCapability extends HomeSecurityThingCapability {
  49     private final ChannelUID cameraChannelUID;
  50     private @Nullable ZonedDateTime lastEventTime;
  51
  52     public PersonCapability(CommonInterface handler, NetatmoDescriptionProvider descriptionProvider,
  53             List<ChannelHelper> channelHelpers) {
  54         super(handler, descriptionProvider, channelHelpers);
  55         this.cameraChannelUID = new ChannelUID(thingUID, GROUP_PERSON_LAST_EVENT, CHANNEL_EVENT_CAMERA_ID);
  56     }
  57
  58     @Override
  59     protected void beforeNewData() {
  60         super.beforeNewData();
  61         getSecurityCapability().ifPresent(cap -> {
  62             Stream<HomeDataModule> cameras = cap.getModules().values().stream()
  63                     .filter(module -> module.getType() == ModuleType.WELCOME);
  64             descriptionProvider.setStateOptions(cameraChannelUID,
  65                     cameras.map(p -> new StateOption(p.getId(), p.getName())).toList());
  66         });
  67     }
  68
  69     @Override
  70     public void handleCommand(String channelName, Command command) {
  71         if ((command instanceof OnOffType) && CHANNEL_PERSON_AT_HOME.equals(channelName)) {
  72             getSecurityCapability().ifPresent(cap -> cap.setPersonAway(handler.getId(), OnOffType.OFF.equals(command)));
  73         }
  74     }
  75
  76     @Override
  77     protected void updateWebhookEvent(WebhookEvent event) {
  78         super.updateWebhookEvent(event);
  79
  80         handler.updateState(GROUP_LAST_EVENT, CHANNEL_EVENT_SUBTYPE,
  81                 event.getSubTypeDescription().map(d -> toStringType(d)).orElse(UnDefType.NULL));
  82
  83         final String message = event.getName();
  84         handler.updateState(GROUP_LAST_EVENT, CHANNEL_EVENT_MESSAGE,
  85                 message == null || message.isBlank() ? UnDefType.NULL : toStringType(message));
  86
  87         handler.updateState(GROUP_LAST_EVENT, CHANNEL_EVENT_TIME, toDateTimeType(event.getTime()));
  88         handler.updateState(GROUP_LAST_EVENT, CHANNEL_EVENT_SNAPSHOT, toRawType(event.getSnapshotUrl()));
  89         handler.updateState(cameraChannelUID, toStringType(event.getCameraId()));
  90     }
  91
  92     @Override
  93     public void updateEvent(Event event) {
  94         super.updateEvent(event);
  95         EventType eventType = event.getEventType();
  96         ZonedDateTime localLast = lastEventTime;
  97         ZonedDateTime eventTime = event.getTime();
  98         if ((localLast != null && !eventTime.isAfter(localLast)) || !eventType.validFor(ModuleType.PERSON)) {
  99             return; // ignore incoming events if they are deprecated
 100         }
 101         lastEventTime = eventTime;
 102         handler.triggerChannel(CHANNEL_HOME_EVENT,
 103                 event.getSubTypeDescription().map(st -> st.name()).orElse(event.getEventType().name()));
 104     }
 105
 106     @Override
 107     public List<NAObject> updateReadings() {
 108         List<NAObject> result = new ArrayList<>();
 109         getSecurityCapability().ifPresent(cap -> {
 110             HomeEvent event = cap.getLastPersonEvent(handler.getId());
 111             if (event != null) {
 112                 result.add(event);
 113             }
 114         });
 115         return result;
 116     }
 117 }