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

   1 /**
   2  * Copyright (c) 2010-2020 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.deconz.internal.handler;
  14
  15 import static org.openhab.binding.deconz.internal.BindingConstants.*;
  16
  17 import java.util.List;
  18 import java.util.Map;
  19 import java.util.Objects;
  20 import java.util.concurrent.ScheduledFuture;
  21 import java.util.concurrent.TimeUnit;
  22
  23 import javax.measure.Unit;
  24
  25 import org.eclipse.jdt.annotation.NonNullByDefault;
  26 import org.eclipse.jdt.annotation.Nullable;
  27 import org.openhab.binding.deconz.internal.Util;
  28 import org.openhab.binding.deconz.internal.dto.DeconzBaseMessage;
  29 import org.openhab.binding.deconz.internal.dto.SensorConfig;
  30 import org.openhab.binding.deconz.internal.dto.SensorMessage;
  31 import org.openhab.binding.deconz.internal.dto.SensorState;
  32 import org.openhab.binding.deconz.internal.types.ResourceType;
  33 import org.openhab.core.library.types.DecimalType;
  34 import org.openhab.core.library.types.OnOffType;
  35 import org.openhab.core.library.types.QuantityType;
  36 import org.openhab.core.thing.Channel;
  37 import org.openhab.core.thing.ChannelUID;
  38 import org.openhab.core.thing.Thing;
  39 import org.openhab.core.thing.ThingStatus;
  40 import org.openhab.core.thing.ThingStatusDetail;
  41 import org.openhab.core.thing.binding.ThingHandlerCallback;
  42 import org.openhab.core.thing.type.ChannelKind;
  43 import org.openhab.core.thing.type.ChannelTypeUID;
  44 import org.openhab.core.types.Command;
  45 import org.slf4j.Logger;
  46 import org.slf4j.LoggerFactory;
  47
  48 import com.google.gson.Gson;
  49
  50 /**
  51  * This sensor Thing doesn't establish any connections, that is done by the bridge Thing.
  52  *
  53  * It waits for the bridge to come online, grab the websocket connection and bridge configuration
  54  * and registers to the websocket connection as a listener.
  55  *
  56  * A REST API call is made to get the initial sensor state.
  57  *
  58  * Every sensor and switch is supported by this Thing, because a unified state is kept
  59  * in {@link #sensorState}. Every field that got received by the REST API for this specific
  60  * sensor is published to the framework.
  61  *
  62  * @author David Graeff - Initial contribution
  63  * @author Lukas Agethen - Refactored to provide better extensibility
  64  */
  65 @NonNullByDefault
  66 public abstract class SensorBaseThingHandler extends DeconzBaseThingHandler {
  67     private final Logger logger = LoggerFactory.getLogger(SensorBaseThingHandler.class);
  68     /**
  69      * The sensor state. Contains all possible fields for all supported sensors and switches
  70      */
  71     protected SensorConfig sensorConfig = new SensorConfig();
  72     protected SensorState sensorState = new SensorState();
  73     /**
  74      * Prevent a dispose/init cycle while this flag is set. Use for property updates
  75      */
  76     private boolean ignoreConfigurationUpdate;
  77     private @Nullable ScheduledFuture<?> lastSeenPollingJob;
  78
  79     public SensorBaseThingHandler(Thing thing, Gson gson) {
  80         super(thing, gson, ResourceType.SENSORS);
  81     }
  82
  83     @Override
  84     public void dispose() {
  85         ScheduledFuture<?> lastSeenPollingJob = this.lastSeenPollingJob;
  86         if (lastSeenPollingJob != null) {
  87             lastSeenPollingJob.cancel(true);
  88             this.lastSeenPollingJob = null;
  89         }
  90
  91         super.dispose();
  92     }
  93
  94     @Override
  95     public abstract void handleCommand(ChannelUID channelUID, Command command);
  96
  97     protected abstract void createTypeSpecificChannels(SensorConfig sensorState, SensorState sensorConfig);
  98
  99     protected abstract List<String> getConfigChannels();
 100
 101     @Override
 102     public void handleConfigurationUpdate(Map<String, Object> configurationParameters) {
 103         if (!ignoreConfigurationUpdate) {
 104             super.handleConfigurationUpdate(configurationParameters);
 105         }
 106     }
 107
 108     @Override
 109     protected void processStateResponse(DeconzBaseMessage stateResponse) {
 110         if (!(stateResponse instanceof SensorMessage)) {
 111             return;
 112         }
 113
 114         SensorMessage sensorMessage = (SensorMessage) stateResponse;
 115         sensorConfig = Objects.requireNonNullElse(sensorMessage.config, new SensorConfig());
 116         sensorState = Objects.requireNonNullElse(sensorMessage.state, new SensorState());
 117
 118         // Add some information about the sensor
 119         if (!sensorConfig.reachable) {
 120             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.GONE, "Not reachable");
 121             return;
 122         }
 123
 124         if (!sensorConfig.on) {
 125             updateStatus(ThingStatus.OFFLINE);
 126             return;
 127         }
 128
 129         Map<String, String> editProperties = editProperties();
 130         editProperties.put(Thing.PROPERTY_FIRMWARE_VERSION, sensorMessage.swversion);
 131         editProperties.put(Thing.PROPERTY_MODEL_ID, sensorMessage.modelid);
 132         editProperties.put(UNIQUE_ID, sensorMessage.uniqueid);
 133         ignoreConfigurationUpdate = true;
 134         updateProperties(editProperties);
 135
 136         // Some sensors support optional channels
 137         // (see https://github.com/dresden-elektronik/deconz-rest-plugin/wiki/Supported-Devices#sensors)
 138         // any battery-powered sensor
 139         if (sensorConfig.battery != null) {
 140             createChannel(CHANNEL_BATTERY_LEVEL, ChannelKind.STATE);
 141             createChannel(CHANNEL_BATTERY_LOW, ChannelKind.STATE);
 142         }
 143
 144         createTypeSpecificChannels(sensorConfig, sensorState);
 145
 146         ignoreConfigurationUpdate = false;
 147
 148         // "Last seen" is the last "ping" from the device, whereas "last update" is the last status changed.
 149         // For example, for a fire sensor, the device pings regularly, without necessarily updating channels.
 150         // So to monitor a sensor is still alive, the "last seen" is necessary.
 151         // Because "last seen" is never updated by the WebSocket API - if this is supported, then we have to
 152         // manually poll it after the defined time
 153         String lastSeen = sensorMessage.lastseen;
 154         if (lastSeen != null && config.lastSeenPolling > 0) {
 155             createChannel(CHANNEL_LAST_SEEN, ChannelKind.STATE);
 156             updateState(CHANNEL_LAST_SEEN, Util.convertTimestampToDateTime(lastSeen));
 157             lastSeenPollingJob = scheduler.schedule(() -> requestState(this::processLastSeen), config.lastSeenPolling,
 158                     TimeUnit.MINUTES);
 159             logger.trace("lastSeen polling enabled for thing {} with interval of {} minutes", thing.getUID(),
 160                     config.lastSeenPolling);
 161         }
 162
 163         // Initial data
 164         updateChannels(sensorConfig);
 165         updateChannels(sensorState, true);
 166
 167         updateStatus(ThingStatus.ONLINE);
 168     }
 169
 170     private void processLastSeen(DeconzBaseMessage stateResponse) {
 171         String lastSeen = stateResponse.lastseen;
 172         if (lastSeen != null) {
 173             updateState(CHANNEL_LAST_SEEN, Util.convertTimestampToDateTime(lastSeen));
 174         }
 175     }
 176
 177     protected void createChannel(String channelId, ChannelKind kind) {
 178         if (thing.getChannel(channelId) != null) {
 179             // channel already exists, no update necessary
 180             return;
 181         }
 182
 183         ThingHandlerCallback callback = getCallback();
 184         if (callback != null) {
 185             ChannelUID channelUID = new ChannelUID(thing.getUID(), channelId);
 186             ChannelTypeUID channelTypeUID;
 187             switch (channelId) {
 188                 case CHANNEL_BATTERY_LEVEL:
 189                     channelTypeUID = new ChannelTypeUID("system:battery-level");
 190                     break;
 191                 case CHANNEL_BATTERY_LOW:
 192                     channelTypeUID = new ChannelTypeUID("system:low-battery");
 193                     break;
 194                 default:
 195                     channelTypeUID = new ChannelTypeUID(BINDING_ID, channelId);
 196                     break;
 197             }
 198             Channel channel = callback.createChannelBuilder(channelUID, channelTypeUID).withKind(kind).build();
 199             updateThing(editThing().withChannel(channel).build());
 200         }
 201     }
 202
 203     /**
 204      * Update channel value from {@link SensorConfig} object - override to include further channels
 205      *
 206      * @param channelUID
 207      * @param newConfig
 208      */
 209     protected void valueUpdated(ChannelUID channelUID, SensorConfig newConfig) {
 210         Integer batteryLevel = newConfig.battery;
 211         switch (channelUID.getId()) {
 212             case CHANNEL_BATTERY_LEVEL:
 213                 if (batteryLevel != null) {
 214                     updateState(channelUID, new DecimalType(batteryLevel.longValue()));
 215                 }
 216                 break;
 217             case CHANNEL_BATTERY_LOW:
 218                 if (batteryLevel != null) {
 219                     updateState(channelUID, OnOffType.from(batteryLevel <= 10));
 220                 }
 221                 break;
 222             default:
 223                 // other cases covered by sub-class
 224         }
 225     }
 226
 227     /**
 228      * Update channel value from {@link SensorState} object - override to include further channels
 229      *
 230      * @param channelID
 231      * @param newState
 232      * @param initializing
 233      */
 234     protected void valueUpdated(String channelID, SensorState newState, boolean initializing) {
 235         switch (channelID) {
 236             case CHANNEL_LAST_UPDATED:
 237                 String lastUpdated = newState.lastupdated;
 238                 if (lastUpdated != null && !"none".equals(lastUpdated)) {
 239                     updateState(channelID, Util.convertTimestampToDateTime(lastUpdated));
 240                 }
 241                 break;
 242             default:
 243                 // other cases covered by sub-class
 244         }
 245     }
 246
 247     @Override
 248     public void messageReceived(String sensorID, DeconzBaseMessage message) {
 249         logger.trace("{} received {}", thing.getUID(), message);
 250         if (message instanceof SensorMessage) {
 251             SensorMessage sensorMessage = (SensorMessage) message;
 252             SensorConfig sensorConfig = sensorMessage.config;
 253             if (sensorConfig != null) {
 254                 this.sensorConfig = sensorConfig;
 255                 updateChannels(sensorConfig);
 256             }
 257             SensorState sensorState = sensorMessage.state;
 258             if (sensorState != null) {
 259                 updateChannels(sensorState, false);
 260             }
 261         }
 262     }
 263
 264     private void updateChannels(SensorConfig newConfig) {
 265         List<String> configChannels = getConfigChannels();
 266         thing.getChannels().stream().map(Channel::getUID)
 267                 .filter(channelUID -> configChannels.contains(channelUID.getId()))
 268                 .forEach((channelUID) -> valueUpdated(channelUID, newConfig));
 269     }
 270
 271     protected void updateChannels(SensorState newState, boolean initializing) {
 272         sensorState = newState;
 273         thing.getChannels().forEach(channel -> valueUpdated(channel.getUID().getId(), newState, initializing));
 274     }
 275
 276     protected void updateSwitchChannel(String channelID, @Nullable Boolean value) {
 277         if (value == null) {
 278             return;
 279         }
 280         updateState(channelID, OnOffType.from(value));
 281     }
 282
 283     protected void updateDecimalTypeChannel(String channelID, @Nullable Number value) {
 284         if (value == null) {
 285             return;
 286         }
 287         updateState(channelID, new DecimalType(value.longValue()));
 288     }
 289
 290     protected void updateQuantityTypeChannel(String channelID, @Nullable Number value, Unit<?> unit) {
 291         updateQuantityTypeChannel(channelID, value, unit, 1.0);
 292     }
 293
 294     protected void updateQuantityTypeChannel(String channelID, @Nullable Number value, Unit<?> unit, double scaling) {
 295         if (value == null) {
 296             return;
 297         }
 298         updateState(channelID, new QuantityType<>(value.doubleValue() * scaling, unit));
 299     }
 300 }