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

   1 /**
   2  * Copyright (c) 2010-2021 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.lcn.internal;
  14
  15 import java.util.ArrayList;
  16 import java.util.Collection;
  17 import java.util.Collections;
  18 import java.util.HashMap;
  19 import java.util.List;
  20 import java.util.Map;
  21 import java.util.NoSuchElementException;
  22 import java.util.Optional;
  23
  24 import org.eclipse.jdt.annotation.NonNullByDefault;
  25 import org.eclipse.jdt.annotation.Nullable;
  26 import org.openhab.binding.lcn.internal.common.DimmerOutputCommand;
  27 import org.openhab.binding.lcn.internal.common.LcnAddr;
  28 import org.openhab.binding.lcn.internal.common.LcnAddrMod;
  29 import org.openhab.binding.lcn.internal.common.LcnChannelGroup;
  30 import org.openhab.binding.lcn.internal.common.LcnException;
  31 import org.openhab.binding.lcn.internal.connection.Connection;
  32 import org.openhab.binding.lcn.internal.connection.ModInfo;
  33 import org.openhab.binding.lcn.internal.converter.Converter;
  34 import org.openhab.binding.lcn.internal.converter.Converters;
  35 import org.openhab.binding.lcn.internal.converter.InversionConverter;
  36 import org.openhab.binding.lcn.internal.converter.S0Converter;
  37 import org.openhab.binding.lcn.internal.subhandler.AbstractLcnModuleSubHandler;
  38 import org.openhab.binding.lcn.internal.subhandler.LcnModuleMetaAckSubHandler;
  39 import org.openhab.binding.lcn.internal.subhandler.LcnModuleMetaFirmwareSubHandler;
  40 import org.openhab.core.library.types.DecimalType;
  41 import org.openhab.core.library.types.HSBType;
  42 import org.openhab.core.library.types.OnOffType;
  43 import org.openhab.core.library.types.PercentType;
  44 import org.openhab.core.library.types.QuantityType;
  45 import org.openhab.core.library.types.StopMoveType;
  46 import org.openhab.core.library.types.StringType;
  47 import org.openhab.core.library.types.UpDownType;
  48 import org.openhab.core.thing.Bridge;
  49 import org.openhab.core.thing.Channel;
  50 import org.openhab.core.thing.ChannelUID;
  51 import org.openhab.core.thing.Thing;
  52 import org.openhab.core.thing.ThingStatus;
  53 import org.openhab.core.thing.ThingStatusDetail;
  54 import org.openhab.core.thing.binding.BaseThingHandler;
  55 import org.openhab.core.thing.binding.ThingHandlerService;
  56 import org.openhab.core.types.Command;
  57 import org.openhab.core.types.RefreshType;
  58 import org.openhab.core.types.State;
  59 import org.slf4j.Logger;
  60 import org.slf4j.LoggerFactory;
  61
  62 /**
  63  * The {@link LcnModuleHandler} is responsible for handling commands, which are
  64  * sent to or received from one of the channels.
  65  *
  66  * @author Fabian Wolter - Initial contribution
  67  */
  68 @NonNullByDefault
  69 public class LcnModuleHandler extends BaseThingHandler {
  70     private final Logger logger = LoggerFactory.getLogger(LcnModuleHandler.class);
  71     private static final Map<String, Converter> VALUE_CONVERTERS = new HashMap<>();
  72     private static final InversionConverter INVERSION_CONVERTER = new InversionConverter();
  73     private @Nullable LcnAddrMod moduleAddress;
  74     private final Map<LcnChannelGroup, AbstractLcnModuleSubHandler> subHandlers = new HashMap<>();
  75     private final List<AbstractLcnModuleSubHandler> metadataSubHandlers = new ArrayList<>();
  76     private final Map<ChannelUID, Converter> converters = new HashMap<>();
  77
  78     static {
  79         VALUE_CONVERTERS.put("temperature", Converters.TEMPERATURE);
  80         VALUE_CONVERTERS.put("light", Converters.LIGHT);
  81         VALUE_CONVERTERS.put("co2", Converters.CO2);
  82         VALUE_CONVERTERS.put("current", Converters.CURRENT);
  83         VALUE_CONVERTERS.put("voltage", Converters.VOLTAGE);
  84         VALUE_CONVERTERS.put("angle", Converters.ANGLE);
  85         VALUE_CONVERTERS.put("windspeed", Converters.WINDSPEED);
  86     }
  87
  88     public LcnModuleHandler(Thing thing) {
  89         super(thing);
  90     }
  91
  92     @Override
  93     public void initialize() {
  94         LcnModuleConfiguration localConfig = getConfigAs(LcnModuleConfiguration.class);
  95         LcnAddrMod localModuleAddress = moduleAddress = new LcnAddrMod(localConfig.segmentId, localConfig.moduleId);
  96
  97         try {
  98             // Determine serial number of manually added modules
  99             requestFirmwareVersionAndSerialNumberIfNotSet();
 100
 101             // create sub handlers
 102             ModInfo info = getPckGatewayHandler().getModInfo(localModuleAddress);
 103             for (LcnChannelGroup type : LcnChannelGroup.values()) {
 104                 subHandlers.put(type, type.createSubHandler(this, info));
 105             }
 106
 107             // meta sub handlers, which are not assigned to a channel group
 108             metadataSubHandlers.add(new LcnModuleMetaAckSubHandler(this, info));
 109             metadataSubHandlers.add(new LcnModuleMetaFirmwareSubHandler(this, info));
 110
 111             // initialize converters
 112             for (Channel channel : thing.getChannels()) {
 113                 Object unitObject = channel.getConfiguration().get("unit");
 114                 Object parameterObject = channel.getConfiguration().get("parameter");
 115                 Object invertState = channel.getConfiguration().get("invertState");
 116                 Object invertUpDown = channel.getConfiguration().get("invertUpDown");
 117
 118                 // Initialize value converters
 119                 if (unitObject instanceof String) {
 120                     switch ((String) unitObject) {
 121                         case "power":
 122                         case "energy":
 123                             converters.put(channel.getUID(), new S0Converter(parameterObject));
 124                             break;
 125                         default:
 126                             Converter converter = VALUE_CONVERTERS.get(unitObject);
 127                             if (converter != null) {
 128                                 converters.put(channel.getUID(), converter);
 129                             }
 130                             break;
 131                     }
 132                 }
 133
 134                 // Initialize inversion converter
 135                 if (Boolean.TRUE.equals(invertState) || Boolean.TRUE.equals(invertUpDown)) {
 136                     converters.put(channel.getUID(), INVERSION_CONVERTER);
 137                 }
 138
 139             }
 140
 141             // module is assumed as online, when the corresponding Bridge (PckGatewayHandler) is online.
 142             updateStatus(ThingStatus.ONLINE);
 143
 144             // trigger REFRESH commands for all linked Channels to start polling
 145             getThing().getChannels().forEach(channel -> {
 146                 if (isLinked(channel.getUID())) {
 147                     channelLinked(channel.getUID());
 148                 }
 149             });
 150         } catch (LcnException e) {
 151             updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getMessage());
 152         }
 153     }
 154
 155     /**
 156      * Triggers requesting the firmware version of the LCN module. The message also contains the serial number.
 157      *
 158      * @throws LcnException when the handler is not initialized
 159      */
 160     protected void requestFirmwareVersionAndSerialNumberIfNotSet() throws LcnException {
 161         String serialNumber = getThing().getProperties().get(Thing.PROPERTY_SERIAL_NUMBER);
 162         if (serialNumber == null || serialNumber.isEmpty()) {
 163             LcnAddrMod localModuleAddress = moduleAddress;
 164             if (localModuleAddress != null) {
 165                 getPckGatewayHandler().getModInfo(localModuleAddress).requestFirmwareVersion();
 166             }
 167         }
 168     }
 169
 170     @Override
 171     public void handleCommand(ChannelUID channelUid, Command command) {
 172         try {
 173             String groupId = channelUid.getGroupId();
 174
 175             if (!channelUid.isInGroup()) {
 176                 return;
 177             }
 178
 179             if (groupId == null) {
 180                 throw new LcnException("Group ID is null");
 181             }
 182
 183             LcnChannelGroup channelGroup = LcnChannelGroup.valueOf(groupId.toUpperCase());
 184             AbstractLcnModuleSubHandler subHandler = subHandlers.get(channelGroup);
 185
 186             if (subHandler == null) {
 187                 throw new LcnException("Sub Handler not found for: " + channelGroup);
 188             }
 189
 190             Optional<Integer> number = channelUidToChannelNumber(channelUid, channelGroup);
 191
 192             if (command instanceof RefreshType) {
 193                 number.ifPresent(n -> subHandler.handleRefresh(channelGroup, n));
 194                 subHandler.handleRefresh(channelUid.getIdWithoutGroup());
 195             } else if (command instanceof OnOffType) {
 196                 subHandler.handleCommandOnOff((OnOffType) command, channelGroup, number.get());
 197             } else if (command instanceof DimmerOutputCommand) {
 198                 subHandler.handleCommandDimmerOutput((DimmerOutputCommand) command, number.get());
 199             } else if (command instanceof PercentType && number.isPresent()) {
 200                 subHandler.handleCommandPercent((PercentType) command, channelGroup, number.get());
 201             } else if (command instanceof HSBType) {
 202                 subHandler.handleCommandHsb((HSBType) command, channelUid.getIdWithoutGroup());
 203             } else if (command instanceof PercentType) {
 204                 subHandler.handleCommandPercent((PercentType) command, channelGroup, channelUid.getIdWithoutGroup());
 205             } else if (command instanceof StringType) {
 206                 subHandler.handleCommandString((StringType) command, number.get());
 207             } else if (command instanceof DecimalType) {
 208                 DecimalType decimalType = (DecimalType) command;
 209                 DecimalType nativeValue = getConverter(channelUid).onCommandFromItem(decimalType.doubleValue());
 210                 subHandler.handleCommandDecimal(nativeValue, channelGroup, number.get());
 211             } else if (command instanceof QuantityType) {
 212                 QuantityType<?> quantityType = (QuantityType<?>) command;
 213                 DecimalType nativeValue = getConverter(channelUid).onCommandFromItem(quantityType);
 214                 subHandler.handleCommandDecimal(nativeValue, channelGroup, number.get());
 215             } else if (command instanceof UpDownType) {
 216                 Channel channel = thing.getChannel(channelUid);
 217                 if (channel != null) {
 218                     Object invertConfig = channel.getConfiguration().get("invertUpDown");
 219                     boolean invertUpDown = invertConfig instanceof Boolean && (boolean) invertConfig;
 220                     subHandler.handleCommandUpDown((UpDownType) command, channelGroup, number.get(), invertUpDown);
 221                 }
 222             } else if (command instanceof StopMoveType) {
 223                 subHandler.handleCommandStopMove((StopMoveType) command, channelGroup, number.get());
 224             } else {
 225                 throw new LcnException("Unsupported command type");
 226             }
 227         } catch (IllegalArgumentException | NoSuchElementException | LcnException e) {
 228             logger.warn("{}: Failed to handle command {}: {}", channelUid, command.getClass().getSimpleName(),
 229                     e.getMessage());
 230         }
 231     }
 232
 233     @NonNullByDefault({}) // getOrDefault()
 234     private Converter getConverter(ChannelUID channelUid) {
 235         return converters.getOrDefault(channelUid, Converters.IDENTITY);
 236     }
 237
 238     /**
 239      * Invoked when a PCK messages arrives from the PCK gateway
 240      *
 241      * @param pck the message without line termination
 242      */
 243     public void handleStatusMessage(String pck) {
 244         for (AbstractLcnModuleSubHandler handler : subHandlers.values()) {
 245             if (handler.tryParse(pck)) {
 246                 break;
 247             }
 248         }
 249
 250         metadataSubHandlers.forEach(h -> h.tryParse(pck));
 251     }
 252
 253     private Optional<Integer> channelUidToChannelNumber(ChannelUID channelUid, LcnChannelGroup channelGroup)
 254             throws LcnException {
 255         try {
 256             int number = Integer.parseInt(channelUid.getIdWithoutGroup()) - 1;
 257
 258             if (!channelGroup.isValidId(number)) {
 259                 throw new LcnException("Out of range: " + number);
 260             }
 261             return Optional.of(number);
 262         } catch (NumberFormatException e) {
 263             return Optional.empty();
 264         }
 265     }
 266
 267     private PckGatewayHandler getPckGatewayHandler() throws LcnException {
 268         Bridge bridge = getBridge();
 269         if (bridge == null) {
 270             throw new LcnException("No LCN-PCK gateway configured for this module");
 271         }
 272
 273         PckGatewayHandler handler = (PckGatewayHandler) bridge.getHandler();
 274         if (handler == null) {
 275             throw new LcnException("Could not get PckGatewayHandler");
 276         }
 277         return handler;
 278     }
 279
 280     /**
 281      * Queues a PCK string for sending.
 282      *
 283      * @param command without the address part
 284      * @throws LcnException when the module address is unknown
 285      */
 286     public void sendPck(String command) throws LcnException {
 287         getPckGatewayHandler().queue(getCommandAddress(), true, command);
 288     }
 289
 290     /**
 291      * Queues a PCK byte buffer for sending.
 292      *
 293      * @param command without the address part
 294      * @throws LcnException when the module address is unknown
 295      */
 296     public void sendPck(byte[] command) throws LcnException {
 297         getPckGatewayHandler().queue(getCommandAddress(), true, command);
 298     }
 299
 300     /**
 301      * Gets the address, which shall be used when sending commands into the LCN bus. This can also be a group address.
 302      *
 303      * @return the address to send to
 304      * @throws LcnException when the address is unknown
 305      */
 306     protected LcnAddr getCommandAddress() throws LcnException, LcnException {
 307         LcnAddr localAddress = moduleAddress;
 308         if (localAddress == null) {
 309             throw new LcnException("Module address not set");
 310         }
 311         return localAddress;
 312     }
 313
 314     /**
 315      * Invoked when an update for this LCN module should be fired to openHAB.
 316      *
 317      * @param channelGroup the Channel to update
 318      * @param channelId the ID within the Channel to update
 319      * @param state the new state
 320      */
 321     public void updateChannel(LcnChannelGroup channelGroup, String channelId, State state) {
 322         ChannelUID channelUid = createChannelUid(channelGroup, channelId);
 323         Converter converter = converters.get(channelUid);
 324
 325         State convertedState = state;
 326         if (converter != null) {
 327             convertedState = converter.onStateUpdateFromHandler(state);
 328         }
 329
 330         updateState(channelUid, convertedState);
 331     }
 332
 333     /**
 334      * Updates the LCN module's serial number property.
 335      *
 336      * @param serialNumber the new serial number
 337      */
 338     public void updateSerialNumberProperty(String serialNumber) {
 339         updateProperty(Thing.PROPERTY_SERIAL_NUMBER, serialNumber);
 340     }
 341
 342     /**
 343      * Invoked when an trigger for this LCN module should be fired to openHAB.
 344      *
 345      * @param channelGroup the Channel to update
 346      * @param channelId the ID within the Channel to update
 347      * @param event the event used to trigger
 348      */
 349     public void triggerChannel(LcnChannelGroup channelGroup, String channelId, String event) {
 350         triggerChannel(createChannelUid(channelGroup, channelId), event);
 351     }
 352
 353     private ChannelUID createChannelUid(LcnChannelGroup channelGroup, String channelId) {
 354         return new ChannelUID(thing.getUID(), channelGroup.name().toLowerCase() + "#" + channelId);
 355     }
 356
 357     /**
 358      * Checks the LCN module address against the own.
 359      *
 360      * @param physicalSegmentId which is 0 if it is the local segment
 361      * @param moduleId
 362      * @return true, if the given address matches the own address
 363      */
 364     public boolean isMyAddress(String physicalSegmentId, String moduleId) {
 365         try {
 366             return new LcnAddrMod(getPckGatewayHandler().toLogicalSegmentId(Integer.parseInt(physicalSegmentId)),
 367                     Integer.parseInt(moduleId)).equals(getStatusMessageAddress());
 368         } catch (LcnException e) {
 369             return false;
 370         }
 371     }
 372
 373     @Override
 374     public Collection<Class<? extends ThingHandlerService>> getServices() {
 375         return Collections.singleton(LcnModuleActions.class);
 376     }
 377
 378     /**
 379      * Invoked when an Ack from this module has been received.
 380      */
 381     public void onAckRceived() {
 382         try {
 383             Connection connection = getPckGatewayHandler().getConnection();
 384             LcnAddrMod localModuleAddress = moduleAddress;
 385             if (connection != null && localModuleAddress != null) {
 386                 getPckGatewayHandler().getModInfo(localModuleAddress).onAck(LcnBindingConstants.CODE_ACK, connection,
 387                         getPckGatewayHandler().getTimeoutMs(), System.nanoTime());
 388             }
 389         } catch (LcnException e) {
 390             logger.warn("Connection or module address not set");
 391         }
 392     }
 393
 394     /**
 395      * Gets the address the handler shall react to, when a status message from this address is processed.
 396      *
 397      * @return the address for status messages
 398      */
 399     public LcnAddrMod getStatusMessageAddress() {
 400         LcnAddrMod localmoduleAddress = moduleAddress;
 401         if (localmoduleAddress != null) {
 402             return localmoduleAddress;
 403         } else {
 404             return new LcnAddrMod(0, 0);
 405         }
 406     }
 407
 408     @Override
 409     public void dispose() {
 410         metadataSubHandlers.clear();
 411         subHandlers.clear();
 412         converters.clear();
 413     }
 414 }