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