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.plugwise.internal.handler;
  14
  15 import static org.openhab.binding.plugwise.internal.PlugwiseBindingConstants.CHANNEL_TRIGGERED;
  16 import static org.openhab.core.thing.ThingStatus.*;
  17
  18 import java.time.Duration;
  19
  20 import org.eclipse.jdt.annotation.NonNullByDefault;
  21 import org.openhab.binding.plugwise.internal.protocol.AcknowledgementMessage;
  22 import org.openhab.binding.plugwise.internal.protocol.AnnounceAwakeRequestMessage;
  23 import org.openhab.binding.plugwise.internal.protocol.AnnounceAwakeRequestMessage.AwakeReason;
  24 import org.openhab.binding.plugwise.internal.protocol.BroadcastGroupSwitchResponseMessage;
  25 import org.openhab.binding.plugwise.internal.protocol.InformationResponseMessage;
  26 import org.openhab.binding.plugwise.internal.protocol.Message;
  27 import org.openhab.core.library.types.OnOffType;
  28 import org.openhab.core.thing.Thing;
  29 import org.slf4j.Logger;
  30 import org.slf4j.LoggerFactory;
  31
  32 /**
  33  * The {@link AbstractPlugwiseThingHandler} handles common Plugwise sleeping end device (SED) channel updates and
  34  * commands.
  35  *
  36  * @author Wouter Born - Initial contribution
  37  */
  38 @NonNullByDefault
  39 public abstract class AbstractSleepingEndDeviceHandler extends AbstractPlugwiseThingHandler {
  40
  41     private static final int SED_PROPERTIES_COUNT = 3;
  42
  43     private final Logger logger = LoggerFactory.getLogger(AbstractSleepingEndDeviceHandler.class);
  44
  45     protected AbstractSleepingEndDeviceHandler(Thing thing) {
  46         super(thing);
  47     }
  48
  49     protected abstract Duration getWakeupDuration();
  50
  51     protected void handleAcknowledgement(AcknowledgementMessage message) {
  52         updateStatusOnDetailChange();
  53     }
  54
  55     protected void handleAnnounceAwakeRequest(AnnounceAwakeRequestMessage message) {
  56         AwakeReason awakeReason = message.getAwakeReason();
  57         if (awakeReason == AwakeReason.MAINTENANCE || awakeReason == AwakeReason.WAKEUP_BUTTON
  58                 || editProperties().size() < SED_PROPERTIES_COUNT) {
  59             updateInformation();
  60             if (isConfigurationPending() && !recentlySendConfigurationUpdate()) {
  61                 sendConfigurationUpdateCommands();
  62             }
  63         }
  64     }
  65
  66     protected void handleBroadcastGroupSwitchResponseMessage(BroadcastGroupSwitchResponseMessage message) {
  67         updateState(CHANNEL_TRIGGERED, message.getPowerState() ? OnOffType.ON : OnOffType.OFF);
  68     }
  69
  70     protected void handleInformationResponse(InformationResponseMessage message) {
  71         updateProperties(message);
  72     }
  73
  74     @Override
  75     public void handleResponseMessage(Message message) {
  76         updateLastSeen();
  77
  78         switch (message.getType()) {
  79             case ACKNOWLEDGEMENT_V1, ACKNOWLEDGEMENT_V2:
  80                 handleAcknowledgement((AcknowledgementMessage) message);
  81                 break;
  82             case ANNOUNCE_AWAKE_REQUEST:
  83                 handleAnnounceAwakeRequest((AnnounceAwakeRequestMessage) message);
  84                 break;
  85             case BROADCAST_GROUP_SWITCH_RESPONSE:
  86                 handleBroadcastGroupSwitchResponseMessage((BroadcastGroupSwitchResponseMessage) message);
  87                 break;
  88             case DEVICE_INFORMATION_RESPONSE:
  89                 handleInformationResponse((InformationResponseMessage) message);
  90                 break;
  91             default:
  92                 logger.trace("Received unhandled {} message from {} ({})", message.getType(), getDeviceType(),
  93                         getMACAddress());
  94                 break;
  95         }
  96     }
  97
  98     @Override
  99     protected boolean shouldOnlineTaskBeScheduled() {
 100         return thing.getStatus() == ONLINE;
 101     }
 102
 103     @Override
 104     protected void updateOnlineState() {
 105         if (thing.getStatus() == ONLINE && getWakeupDuration().minus(durationSinceLastSeen()).isNegative()) {
 106             updateStatus(OFFLINE, getThingStatusDetail());
 107         }
 108     }
 109 }