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.enocean.internal.handler;
  14
  15 import static org.openhab.binding.enocean.internal.EnOceanBindingConstants.*;
  16
  17 import java.util.Collection;
  18 import java.util.Collections;
  19 import java.util.Comparator;
  20 import java.util.Hashtable;
  21 import java.util.Set;
  22 import java.util.concurrent.ScheduledFuture;
  23 import java.util.concurrent.TimeUnit;
  24 import java.util.function.Predicate;
  25
  26 import org.openhab.binding.enocean.internal.config.EnOceanBaseConfig;
  27 import org.openhab.binding.enocean.internal.eep.EEP;
  28 import org.openhab.binding.enocean.internal.eep.EEPFactory;
  29 import org.openhab.binding.enocean.internal.eep.EEPType;
  30 import org.openhab.binding.enocean.internal.messages.BasePacket;
  31 import org.openhab.binding.enocean.internal.messages.ERP1Message;
  32 import org.openhab.binding.enocean.internal.messages.ERP1Message.RORG;
  33 import org.openhab.binding.enocean.internal.transceiver.PacketListener;
  34 import org.openhab.core.config.core.Configuration;
  35 import org.openhab.core.thing.Channel;
  36 import org.openhab.core.thing.ChannelUID;
  37 import org.openhab.core.thing.Thing;
  38 import org.openhab.core.thing.ThingTypeUID;
  39 import org.openhab.core.thing.link.ItemChannelLinkRegistry;
  40 import org.openhab.core.thing.type.ChannelKind;
  41 import org.openhab.core.thing.type.ChannelTypeUID;
  42 import org.openhab.core.types.Command;
  43 import org.openhab.core.types.State;
  44 import org.openhab.core.types.UnDefType;
  45 import org.openhab.core.util.HexUtils;
  46
  47 /**
  48  * @author Daniel Weber - Initial contribution
  49  *         This class defines base functionality for receiving eep messages.
  50  */
  51 public class EnOceanBaseSensorHandler extends EnOceanBaseThingHandler implements PacketListener {
  52
  53     // List of all thing types which support receiving of eep messages
  54     public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES = Set.of(THING_TYPE_ROOMOPERATINGPANEL,
  55             THING_TYPE_MECHANICALHANDLE, THING_TYPE_CONTACT, THING_TYPE_TEMPERATURESENSOR,
  56             THING_TYPE_TEMPERATUREHUMIDITYSENSOR, THING_TYPE_ROCKERSWITCH, THING_TYPE_OCCUPANCYSENSOR,
  57             THING_TYPE_LIGHTTEMPERATUREOCCUPANCYSENSOR, THING_TYPE_LIGHTSENSOR, THING_TYPE_PUSHBUTTON,
  58             THING_TYPE_AUTOMATEDMETERSENSOR, THING_TYPE_ENVIRONMENTALSENSOR, THING_TYPE_MULTFUNCTIONSMOKEDETECTOR,
  59             THING_TYPE_WINDOWSASHHANDLESENSOR);
  60
  61     protected final Hashtable<RORG, EEPType> receivingEEPTypes = new Hashtable<>();
  62
  63     protected ScheduledFuture<?> responseFuture = null;
  64
  65     public EnOceanBaseSensorHandler(Thing thing, ItemChannelLinkRegistry itemChannelLinkRegistry) {
  66         super(thing, itemChannelLinkRegistry);
  67     }
  68
  69     @Override
  70     void initializeConfig() {
  71         config = getConfigAs(EnOceanBaseConfig.class);
  72     }
  73
  74     @Override
  75     Collection<EEPType> getEEPTypes() {
  76         return Collections.unmodifiableCollection(receivingEEPTypes.values());
  77     }
  78
  79     @Override
  80     boolean validateConfig() {
  81         receivingEEPTypes.clear();
  82         try {
  83             config.receivingEEPId.forEach(receivingEEP -> {
  84                 EEPType receivingEEPType = EEPType.getType(receivingEEP);
  85                 if (receivingEEPTypes.putIfAbsent(receivingEEPType.getRORG(), receivingEEPType) != null) {
  86                     throw new IllegalArgumentException("Receiving more than one EEP of the same RORG is not supported");
  87                 }
  88             });
  89             if (config.receivingSIGEEP) {
  90                 receivingEEPTypes.put(EEPType.SigBatteryStatus.getRORG(), EEPType.SigBatteryStatus);
  91             }
  92         } catch (IllegalArgumentException e) {
  93             configurationErrorDescription = e.getMessage();
  94             return false;
  95         }
  96
  97         updateChannels();
  98
  99         if (!validateEnoceanId(config.enoceanId)) {
 100             configurationErrorDescription = "EnOceanId is not a valid EnOceanId";
 101             return false;
 102         }
 103
 104         if (!config.enoceanId.equals(EMPTYENOCEANID)) {
 105             getBridgeHandler().addPacketListener(this);
 106         }
 107
 108         return true;
 109     }
 110
 111     @Override
 112     public long getEnOceanIdToListenTo() {
 113         return Long.parseLong(config.enoceanId, 16);
 114     }
 115
 116     @Override
 117     public void handleRemoval() {
 118         if (getBridgeHandler() != null) {
 119             getBridgeHandler().removePacketListener(this);
 120         }
 121         super.handleRemoval();
 122     }
 123
 124     @Override
 125     public void handleCommand(ChannelUID channelUID, Command command) {
 126         // sensor things cannot send any messages, hence they are not allowed to handle any command
 127         // The only possible command would be "Refresh"
 128     }
 129
 130     protected Predicate<Channel> channelFilter(EEPType eepType, byte[] senderId) {
 131         return c -> {
 132
 133             boolean result = eepType.isChannelSupported(c);
 134             return (isLinked(c.getUID()) || c.getKind() == ChannelKind.TRIGGER) && result;
 135         };
 136     }
 137
 138     protected void sendRequestResponse() {
 139         throw new UnsupportedOperationException("Sensor cannot send responses");
 140     }
 141
 142     @Override
 143     public void packetReceived(BasePacket packet) {
 144         ERP1Message msg = (ERP1Message) packet;
 145         EEPType receivingEEPType = receivingEEPTypes.get(msg.getRORG());
 146         if (receivingEEPType == null) {
 147             return;
 148         }
 149
 150         EEP eep = EEPFactory.buildEEP(receivingEEPType, (ERP1Message) packet);
 151         logger.debug("ESP Packet payload {} for {} received", HexUtils.bytesToHex(packet.getPayload()),
 152                 HexUtils.bytesToHex(msg.getSenderId()));
 153
 154         if (eep.isValid()) {
 155             byte[] senderId = msg.getSenderId();
 156
 157             // try to interpret received message for all linked or trigger channels
 158             getThing().getChannels().stream().filter(channelFilter(receivingEEPType, senderId))
 159                     .sorted(Comparator.comparing(Channel::getKind)) // handle state channels first
 160                     .forEachOrdered(channel -> {
 161
 162                         ChannelTypeUID channelTypeUID = channel.getChannelTypeUID();
 163                         String channelTypeId = (channelTypeUID != null) ? channelTypeUID.getId() : "";
 164
 165                         String channelId = channel.getUID().getId();
 166                         Configuration channelConfig = channel.getConfiguration();
 167
 168                         switch (channel.getKind()) {
 169                             case STATE:
 170                                 State result = eep.convertToState(channelId, channelTypeId, channelConfig,
 171                                         this::getCurrentState);
 172
 173                                 // if message can be interpreted (result != UnDefType.UNDEF) => update item state
 174                                 if (result != null && result != UnDefType.UNDEF) {
 175                                     updateState(channelId, result);
 176                                 }
 177                                 break;
 178                             case TRIGGER:
 179                                 String lastEvent = lastEvents.get(channelId);
 180                                 String event = eep.convertToEvent(channelId, channelTypeId, lastEvent, channelConfig);
 181                                 if (event != null) {
 182                                     triggerChannel(channel.getUID(), event);
 183                                     lastEvents.put(channelId, event);
 184                                 }
 185                                 break;
 186                         }
 187                     });
 188
 189             if (receivingEEPType.getRequstesResponse()) {
 190                 // fire trigger for receive
 191                 triggerChannel(prepareAnswer, "requestAnswer");
 192                 // Send response after 100ms
 193                 if (responseFuture == null || responseFuture.isDone()) {
 194                     responseFuture = scheduler.schedule(this::sendRequestResponse, 100, TimeUnit.MILLISECONDS);
 195                 }
 196             }
 197         }
 198     }
 199 }