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.lcn.internal.subhandler;
  14
  15 import java.util.Arrays;
  16 import java.util.Collection;
  17 import java.util.regex.Matcher;
  18 import java.util.regex.Pattern;
  19
  20 import org.eclipse.jdt.annotation.NonNullByDefault;
  21 import org.openhab.binding.lcn.internal.LcnBindingConstants;
  22 import org.openhab.binding.lcn.internal.LcnModuleHandler;
  23 import org.openhab.binding.lcn.internal.common.DimmerOutputCommand;
  24 import org.openhab.binding.lcn.internal.common.LcnChannelGroup;
  25 import org.openhab.binding.lcn.internal.common.LcnDefs;
  26 import org.openhab.binding.lcn.internal.common.LcnException;
  27 import org.openhab.binding.lcn.internal.common.PckGenerator;
  28 import org.openhab.binding.lcn.internal.connection.ModInfo;
  29 import org.openhab.core.library.types.HSBType;
  30 import org.openhab.core.library.types.OnOffType;
  31 import org.openhab.core.library.types.PercentType;
  32 import org.openhab.core.library.types.StringType;
  33 import org.openhab.core.library.types.UpDownType;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 /**
  38  * Handles Commands and State changes of dimmer outputs of an LCN module.
  39  *
  40  * @author Fabian Wolter - Initial contribution
  41  */
  42 @NonNullByDefault
  43 public class LcnModuleOutputSubHandler extends AbstractLcnModuleSubHandler {
  44     private final Logger logger = LoggerFactory.getLogger(LcnModuleOutputSubHandler.class);
  45     private static final int COLOR_RAMP_MS = 1000;
  46     private static final String OUTPUT_COLOR = "color";
  47     private static final Pattern PERCENT_PATTERN;
  48     private static final Pattern NATIVE_PATTERN;
  49     private volatile HSBType currentColor = new HSBType();
  50     private volatile PercentType output4 = new PercentType();
  51
  52     public LcnModuleOutputSubHandler(LcnModuleHandler handler, ModInfo info) {
  53         super(handler, info);
  54     }
  55
  56     static {
  57         PERCENT_PATTERN = Pattern.compile(LcnBindingConstants.ADDRESS_REGEX + "A(?<outputId>\\d)(?<percent>\\d{3})");
  58         NATIVE_PATTERN = Pattern.compile(LcnBindingConstants.ADDRESS_REGEX + "O(?<outputId>\\d)(?<value>\\d{3})");
  59     }
  60
  61     @Override
  62     public Collection<Pattern> getPckStatusMessagePatterns() {
  63         return Arrays.asList(NATIVE_PATTERN, PERCENT_PATTERN);
  64     }
  65
  66     @Override
  67     public void handleRefresh(LcnChannelGroup channelGroup, int number) {
  68         info.refreshOutput(number);
  69     }
  70
  71     @Override
  72     public void handleRefresh(String groupId) {
  73         if (OUTPUT_COLOR.equals(groupId)) {
  74             info.refreshAllOutputs();
  75         }
  76     }
  77
  78     @Override
  79     public void handleCommandOnOff(OnOffType command, LcnChannelGroup channelGroup, int number) throws LcnException {
  80         // don't use OnOffType.as() here, because it returns @Nullable
  81         handler.sendPck(PckGenerator.dimOutput(number, command == OnOffType.ON ? 100 : 0, 0));
  82     }
  83
  84     @Override
  85     public void handleCommandPercent(PercentType command, LcnChannelGroup channelGroup, int number)
  86             throws LcnException {
  87         handler.sendPck(PckGenerator.dimOutput(number, command.doubleValue(), 0));
  88     }
  89
  90     @Override
  91     public void handleCommandPercent(PercentType command, LcnChannelGroup channelGroup, String idWithoutGroup)
  92             throws LcnException {
  93         if (!OUTPUT_COLOR.equals(idWithoutGroup)) {
  94             throw new LcnException("Unknown group ID: " + idWithoutGroup);
  95         }
  96         updateAndSendColor(new HSBType(currentColor.getHue(), currentColor.getSaturation(), command));
  97     }
  98
  99     @Override
 100     public void handleCommandHsb(HSBType command, String groupId) throws LcnException {
 101         if (!OUTPUT_COLOR.equals(groupId)) {
 102             throw new LcnException("Unknown group ID: " + groupId);
 103         }
 104         updateAndSendColor(command);
 105     }
 106
 107     private synchronized void updateAndSendColor(HSBType hsbType) throws LcnException {
 108         currentColor = hsbType;
 109         handler.updateChannel(LcnChannelGroup.OUTPUT, OUTPUT_COLOR, currentColor);
 110
 111         if (info.getFirmwareVersion().map(v -> v >= LcnBindingConstants.FIRMWARE_2014).orElse(true)) {
 112             handler.sendPck(PckGenerator.dimAllOutputs(currentColor.getRed().doubleValue(),
 113                     currentColor.getGreen().doubleValue(), currentColor.getBlue().doubleValue(), output4.doubleValue(),
 114                     COLOR_RAMP_MS));
 115         } else {
 116             handler.sendPck(PckGenerator.dimOutput(0, currentColor.getRed().doubleValue(), COLOR_RAMP_MS));
 117             handler.sendPck(PckGenerator.dimOutput(1, currentColor.getGreen().doubleValue(), COLOR_RAMP_MS));
 118             handler.sendPck(PckGenerator.dimOutput(2, currentColor.getBlue().doubleValue(), COLOR_RAMP_MS));
 119         }
 120     }
 121
 122     @Override
 123     public void handleCommandDimmerOutput(DimmerOutputCommand command, int number) throws LcnException {
 124         int rampMs = command.getRampMs();
 125         if (command.isControlAllOutputs()) { // control all dimmer outputs
 126             if (rampMs == LcnDefs.FIXED_RAMP_MS) {
 127                 // compatibility command
 128                 handler.sendPck(PckGenerator.controlAllOutputs(command.intValue()));
 129             } else {
 130                 // command since firmware 180501
 131                 handler.sendPck(PckGenerator.dimAllOutputs(command.doubleValue(), command.doubleValue(),
 132                         command.doubleValue(), command.doubleValue(), rampMs));
 133             }
 134         } else if (command.isControlOutputs12()) { // control dimmer outputs 1+2
 135             if (command.intValue() == 0 || command.intValue() == 100) {
 136                 handler.sendPck(PckGenerator.controlOutputs12(command.intValue() > 0, rampMs >= LcnDefs.FIXED_RAMP_MS));
 137             } else {
 138                 // ignore ramp when dimming
 139                 handler.sendPck(PckGenerator.dimOutputs12(command.doubleValue()));
 140             }
 141         } else {
 142             handler.sendPck(PckGenerator.dimOutput(number, command.doubleValue(), rampMs));
 143         }
 144     }
 145
 146     @Override
 147     public void handleCommandString(StringType command, int number) throws LcnException {
 148         int mode = 0;
 149
 150         switch (command.toString()) {
 151             case "DISABLE":
 152                 mode = 0;
 153                 break;
 154             case "OUTPUT1":
 155                 mode = 1;
 156                 break;
 157             case "BOTH":
 158                 mode = 2;
 159                 break;
 160         }
 161
 162         handler.sendPck(PckGenerator.setTunableWhiteMode(mode));
 163     }
 164
 165     @Override
 166     public void handleStatusMessage(Matcher matcher) {
 167         int outputId = Integer.parseInt(matcher.group("outputId")) - 1;
 168
 169         if (!LcnChannelGroup.OUTPUT.isValidId(outputId)) {
 170             logger.warn("outputId out of range: {}", outputId);
 171             return;
 172         }
 173         double percent;
 174         if (matcher.pattern() == PERCENT_PATTERN) {
 175             percent = Integer.parseInt(matcher.group("percent"));
 176         } else if (matcher.pattern() == NATIVE_PATTERN) {
 177             percent = (double) Integer.parseInt(matcher.group("value")) / 2;
 178         } else {
 179             logger.warn("Unexpected pattern: {}", matcher.pattern());
 180             return;
 181         }
 182
 183         info.onOutputResponseReceived(outputId);
 184
 185         percent = Math.min(100, Math.max(0, percent));
 186
 187         PercentType percentType = new PercentType((int) Math.round(percent));
 188         fireUpdate(LcnChannelGroup.OUTPUT, outputId, percentType);
 189
 190         if (outputId == 3) {
 191             output4 = percentType;
 192         }
 193
 194         if (percent > 0) {
 195             if (outputId == 0) {
 196                 fireUpdate(LcnChannelGroup.ROLLERSHUTTEROUTPUT, 0, UpDownType.UP);
 197             } else if (outputId == 1) {
 198                 fireUpdate(LcnChannelGroup.ROLLERSHUTTEROUTPUT, 0, UpDownType.DOWN);
 199             }
 200         }
 201     }
 202 }