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.mqtt.homeassistant.internal.component;
  14
  15 import java.math.BigDecimal;
  16 import java.util.Objects;
  17
  18 import org.eclipse.jdt.annotation.NonNullByDefault;
  19 import org.eclipse.jdt.annotation.Nullable;
  20 import org.openhab.binding.mqtt.generic.ChannelStateUpdateListener;
  21 import org.openhab.binding.mqtt.generic.mapping.ColorMode;
  22 import org.openhab.binding.mqtt.generic.values.ColorValue;
  23 import org.openhab.binding.mqtt.generic.values.TextValue;
  24 import org.openhab.binding.mqtt.homeassistant.internal.ComponentChannel;
  25 import org.openhab.core.library.types.DecimalType;
  26 import org.openhab.core.library.types.HSBType;
  27 import org.openhab.core.library.types.OnOffType;
  28 import org.openhab.core.library.types.PercentType;
  29 import org.openhab.core.library.types.StringType;
  30 import org.openhab.core.thing.ChannelUID;
  31 import org.openhab.core.types.Command;
  32 import org.openhab.core.types.State;
  33 import org.openhab.core.types.UnDefType;
  34
  35 /**
  36  * A MQTT light, following the https://www.home-assistant.io/components/light.mqtt/ specification.
  37  *
  38  * Specifically, the default schema. This class will present a single channel for color, brightness,
  39  * or on/off as appropriate. Additional attributes are still exposed as dedicated channels.
  40  *
  41  * @author Cody Cutrer - Initial contribution
  42  */
  43 @NonNullByDefault
  44 public class DefaultSchemaLight extends Light {
  45     protected static final String HS_CHANNEL_ID = "hs";
  46     protected static final String RGB_CHANNEL_ID = "rgb";
  47     protected static final String RGBW_CHANNEL_ID = "rgbw";
  48     protected static final String RGBWW_CHANNEL_ID = "rgbww";
  49     protected static final String XY_CHANNEL_ID = "xy";
  50     protected static final String WHITE_CHANNEL_ID = "white";
  51
  52     protected @Nullable ComponentChannel hsChannel;
  53     protected @Nullable ComponentChannel rgbChannel;
  54     protected @Nullable ComponentChannel xyChannel;
  55
  56     public DefaultSchemaLight(ComponentFactory.ComponentConfiguration builder) {
  57         super(builder);
  58     }
  59
  60     @Override
  61     protected void buildChannels() {
  62         ComponentChannel localOnOffChannel;
  63         localOnOffChannel = onOffChannel = buildChannel(ON_OFF_CHANNEL_ID, onOffValue, "On/Off State", this)
  64                 .stateTopic(channelConfiguration.stateTopic, channelConfiguration.stateValueTemplate)
  65                 .commandTopic(channelConfiguration.commandTopic, channelConfiguration.isRetain(),
  66                         channelConfiguration.getQos())
  67                 .commandFilter(this::handleRawOnOffCommand).build(false);
  68
  69         @Nullable
  70         ComponentChannel localBrightnessChannel = null;
  71         if (channelConfiguration.brightnessStateTopic != null || channelConfiguration.brightnessCommandTopic != null) {
  72             localBrightnessChannel = brightnessChannel = buildChannel(BRIGHTNESS_CHANNEL_ID, brightnessValue,
  73                     "Brightness", this)
  74                     .stateTopic(channelConfiguration.brightnessStateTopic, channelConfiguration.brightnessValueTemplate)
  75                     .commandTopic(channelConfiguration.brightnessCommandTopic, channelConfiguration.isRetain(),
  76                             channelConfiguration.getQos())
  77                     .withFormat("%.0f").commandFilter(this::handleBrightnessCommand).build(false);
  78         }
  79
  80         if (channelConfiguration.whiteCommandTopic != null) {
  81             buildChannel(WHITE_CHANNEL_ID, brightnessValue, "Go directly to white of a specific brightness", this)
  82                     .commandTopic(channelConfiguration.whiteCommandTopic, channelConfiguration.isRetain(),
  83                             channelConfiguration.getQos())
  84                     .isAdvanced(true).build();
  85         }
  86
  87         if (channelConfiguration.colorModeStateTopic != null) {
  88             buildChannel(COLOR_MODE_CHANNEL_ID, new TextValue(), "Current color mode", this)
  89                     .stateTopic(channelConfiguration.colorModeStateTopic, channelConfiguration.colorModeValueTemplate)
  90                     .build();
  91         }
  92
  93         if (channelConfiguration.colorTempStateTopic != null || channelConfiguration.colorTempCommandTopic != null) {
  94             buildChannel(COLOR_TEMP_CHANNEL_ID, colorTempValue, "Color Temperature", this)
  95                     .stateTopic(channelConfiguration.colorTempStateTopic, channelConfiguration.colorTempValueTemplate)
  96                     .commandTopic(channelConfiguration.colorTempCommandTopic, channelConfiguration.isRetain(),
  97                             channelConfiguration.getQos())
  98                     .build();
  99         }
 100
 101         if (channelConfiguration.effectStateTopic != null || channelConfiguration.effectCommandTopic != null) {
 102             buildChannel(EFFECT_CHANNEL_ID, effectValue, "Lighting effect", this)
 103                     .stateTopic(channelConfiguration.effectStateTopic, channelConfiguration.effectValueTemplate)
 104                     .commandTopic(channelConfiguration.effectCommandTopic, channelConfiguration.isRetain(),
 105                             channelConfiguration.getQos())
 106                     .build();
 107         }
 108
 109         if (channelConfiguration.rgbStateTopic != null || channelConfiguration.rgbCommandTopic != null) {
 110             hasColorChannel = true;
 111             hiddenChannels.add(rgbChannel = buildChannel(RGB_CHANNEL_ID, new ColorValue(ColorMode.RGB, null, null, 100),
 112                     "RGB state", this)
 113                     .stateTopic(channelConfiguration.rgbStateTopic, channelConfiguration.rgbValueTemplate)
 114                     .commandTopic(channelConfiguration.rgbCommandTopic, channelConfiguration.isRetain(),
 115                             channelConfiguration.getQos())
 116                     .build(false));
 117         }
 118
 119         if (channelConfiguration.rgbwStateTopic != null || channelConfiguration.rgbwCommandTopic != null) {
 120             hasColorChannel = true;
 121             hiddenChannels.add(buildChannel(RGBW_CHANNEL_ID, new TextValue(), "RGBW state", this)
 122                     .stateTopic(channelConfiguration.rgbwStateTopic, channelConfiguration.rgbwValueTemplate)
 123                     .commandTopic(channelConfiguration.rgbwCommandTopic, channelConfiguration.isRetain(),
 124                             channelConfiguration.getQos())
 125                     .build(false));
 126         }
 127
 128         if (channelConfiguration.rgbwwStateTopic != null || channelConfiguration.rgbwwCommandTopic != null) {
 129             hasColorChannel = true;
 130             hiddenChannels.add(buildChannel(RGBWW_CHANNEL_ID, new TextValue(), "RGBWW state", this)
 131                     .stateTopic(channelConfiguration.rgbwwStateTopic, channelConfiguration.rgbwwValueTemplate)
 132                     .commandTopic(channelConfiguration.rgbwwCommandTopic, channelConfiguration.isRetain(),
 133                             channelConfiguration.getQos())
 134                     .build(false));
 135         }
 136
 137         if (channelConfiguration.xyStateTopic != null || channelConfiguration.xyCommandTopic != null) {
 138             hasColorChannel = true;
 139             hiddenChannels.add(
 140                     xyChannel = buildChannel(XY_CHANNEL_ID, new ColorValue(ColorMode.XYY, null, null, 100), "XY State",
 141                             this).stateTopic(channelConfiguration.xyStateTopic, channelConfiguration.xyValueTemplate)
 142                             .commandTopic(channelConfiguration.xyCommandTopic, channelConfiguration.isRetain(),
 143                                     channelConfiguration.getQos())
 144                             .build(false));
 145         }
 146
 147         if (channelConfiguration.hsStateTopic != null || channelConfiguration.hsCommandTopic != null) {
 148             hasColorChannel = true;
 149             hiddenChannels.add(this.hsChannel = buildChannel(HS_CHANNEL_ID, new TextValue(), "Hue and Saturation", this)
 150                     .stateTopic(channelConfiguration.hsStateTopic, channelConfiguration.hsValueTemplate)
 151                     .commandTopic(channelConfiguration.hsCommandTopic, channelConfiguration.isRetain(),
 152                             channelConfiguration.getQos())
 153                     .build(false));
 154         }
 155
 156         if (hasColorChannel) {
 157             hiddenChannels.add(localOnOffChannel);
 158             if (localBrightnessChannel != null) {
 159                 hiddenChannels.add(localBrightnessChannel);
 160             }
 161             buildChannel(COLOR_CHANNEL_ID, colorValue, "Color", this)
 162                     .commandTopic(DUMMY_TOPIC, channelConfiguration.isRetain(), channelConfiguration.getQos())
 163                     .commandFilter(this::handleColorCommand).build();
 164         } else if (localBrightnessChannel != null) {
 165             hiddenChannels.add(localOnOffChannel);
 166             channels.put(BRIGHTNESS_CHANNEL_ID, localBrightnessChannel);
 167         } else {
 168             channels.put(ON_OFF_CHANNEL_ID, localOnOffChannel);
 169         }
 170     }
 171
 172     // all handle*Command methods return false if they've been handled,
 173     // or true if default handling should continue
 174
 175     // The commandFilter for onOffChannel
 176     private boolean handleRawOnOffCommand(Command command) {
 177         // on_command_type of brightness is not allowed to send an actual on command
 178         if (command.equals(OnOffType.ON) && channelConfiguration.onCommandType.equals(ON_COMMAND_TYPE_BRIGHTNESS)) {
 179             // No prior state (or explicit off); set to 100%
 180             if (brightnessValue.getChannelState() instanceof UnDefType
 181                     || brightnessValue.getChannelState().equals(PercentType.ZERO)) {
 182                 brightnessChannel.getState().publishValue(PercentType.HUNDRED);
 183             } else {
 184                 brightnessChannel.getState().publishValue((Command) brightnessValue.getChannelState());
 185             }
 186             return false;
 187         }
 188
 189         return true;
 190     }
 191
 192     // The helper method the other commandFilters call
 193     private boolean handleOnOffCommand(Command command) {
 194         if (!handleRawOnOffCommand(command)) {
 195             return false;
 196         }
 197
 198         // OnOffType commands to go the regular command topic
 199         if (command instanceof OnOffType) {
 200             onOffChannel.getState().publishValue(command);
 201             return false;
 202         }
 203
 204         boolean needsOn = !onOffValue.getChannelState().equals(OnOffType.ON);
 205         if (command.equals(PercentType.ZERO) || command.equals(HSBType.BLACK)) {
 206             needsOn = false;
 207         }
 208         if (needsOn) {
 209             if (channelConfiguration.onCommandType.equals(ON_COMMAND_TYPE_FIRST)) {
 210                 onOffChannel.getState().publishValue(OnOffType.ON);
 211             } else if (channelConfiguration.onCommandType.equals(ON_COMMAND_TYPE_LAST)) {
 212                 // TODO: schedule the ON publish for after this is sent
 213             }
 214         }
 215         return true;
 216     }
 217
 218     private boolean handleBrightnessCommand(Command command) {
 219         // if it's OnOffType, it'll get handled by this; otherwise it'll return
 220         // true and PercentType will be handled as normal
 221         return handleOnOffCommand(command);
 222     }
 223
 224     private boolean handleColorCommand(Command command) {
 225         if (!handleOnOffCommand(command)) {
 226             return false;
 227         } else if (command instanceof HSBType color) {
 228             if (channelConfiguration.hsCommandTopic != null) {
 229                 // If we don't have a brightness channel, something is probably busted
 230                 // but don't choke
 231                 if (channelConfiguration.brightnessCommandTopic != null) {
 232                     brightnessChannel.getState().publishValue(color.getBrightness());
 233                 }
 234                 String hs = String.format("%d,%d", color.getHue().intValue(), color.getSaturation().intValue());
 235                 hsChannel.getState().publishValue(new StringType(hs));
 236             } else if (channelConfiguration.rgbCommandTopic != null) {
 237                 rgbChannel.getState().publishValue(command);
 238                 // } else if (channelConfiguration.rgbwCommandTopic != null) {
 239                 // TODO
 240                 // } else if (channelConfiguration.rgbwwCommandTopic != null) {
 241                 // TODO
 242             } else if (channelConfiguration.xyCommandTopic != null) {
 243                 PercentType[] xy = color.toXY();
 244                 // If we don't have a brightness channel, something is probably busted
 245                 // but don't choke
 246                 if (channelConfiguration.brightnessCommandTopic != null) {
 247                     brightnessChannel.getState().publishValue(color.getBrightness());
 248                 }
 249                 String xyString = String.format("%f,%f", xy[0].doubleValue(), xy[1].doubleValue());
 250                 xyChannel.getState().publishValue(new StringType(xyString));
 251             }
 252         } else if (command instanceof PercentType brightness) {
 253             if (channelConfiguration.brightnessCommandTopic != null) {
 254                 brightnessChannel.getState().publishValue(command);
 255             } else {
 256                 // No brightness command topic?! must be RGB only
 257                 // so re-calculatate
 258                 State color = colorValue.getChannelState();
 259                 if (color instanceof UnDefType) {
 260                     color = HSBType.WHITE;
 261                 }
 262                 HSBType existingColor = (HSBType) color;
 263                 HSBType newCommand = new HSBType(existingColor.getHue(), existingColor.getSaturation(), brightness);
 264                 // re-process
 265                 handleColorCommand(newCommand);
 266             }
 267         }
 268         return false;
 269     }
 270
 271     @Override
 272     public void updateChannelState(ChannelUID channel, State state) {
 273         ChannelStateUpdateListener listener = this.channelStateUpdateListener;
 274         switch (channel.getIdWithoutGroup()) {
 275             case ON_OFF_CHANNEL_ID:
 276                 if (hasColorChannel) {
 277                     HSBType newOnState = colorValue.getChannelState() instanceof HSBType
 278                             ? (HSBType) colorValue.getChannelState()
 279                             : HSBType.WHITE;
 280                     if (state.equals(OnOffType.ON)) {
 281                         colorValue.update(newOnState);
 282                     }
 283
 284                     listener.updateChannelState(new ChannelUID(getGroupUID(), COLOR_CHANNEL_ID),
 285                             state.equals(OnOffType.ON) ? newOnState : HSBType.BLACK);
 286                 } else if (brightnessChannel != null) {
 287                     listener.updateChannelState(new ChannelUID(channel.getThingUID(), BRIGHTNESS_CHANNEL_ID),
 288                             state.equals(OnOffType.ON) ? brightnessValue.getChannelState() : PercentType.ZERO);
 289                 } else {
 290                     listener.updateChannelState(channel, state);
 291                 }
 292                 return;
 293             case BRIGHTNESS_CHANNEL_ID:
 294                 onOffValue.update(Objects.requireNonNull(state.as(OnOffType.class)));
 295                 if (hasColorChannel) {
 296                     if (colorValue.getChannelState() instanceof HSBType) {
 297                         HSBType hsb = (HSBType) (colorValue.getChannelState());
 298                         colorValue.update(new HSBType(hsb.getHue(), hsb.getSaturation(),
 299                                 (PercentType) brightnessValue.getChannelState()));
 300                     } else {
 301                         colorValue.update(new HSBType(DecimalType.ZERO, PercentType.ZERO,
 302                                 (PercentType) brightnessValue.getChannelState()));
 303                     }
 304                     listener.updateChannelState(new ChannelUID(getGroupUID(), COLOR_CHANNEL_ID),
 305                             colorValue.getChannelState());
 306                 } else {
 307                     listener.updateChannelState(channel, state);
 308                 }
 309                 return;
 310             case COLOR_TEMP_CHANNEL_ID:
 311             case EFFECT_CHANNEL_ID:
 312                 // Real channels; pass through
 313                 listener.updateChannelState(channel, state);
 314                 return;
 315             case HS_CHANNEL_ID:
 316             case XY_CHANNEL_ID:
 317                 if (brightnessValue.getChannelState() instanceof UnDefType) {
 318                     brightnessValue.update(PercentType.HUNDRED);
 319                 }
 320                 String[] split = state.toString().split(",");
 321                 if (split.length != 2) {
 322                     throw new IllegalArgumentException(state.toString() + " is not a valid string syntax");
 323                 }
 324                 float x = Float.parseFloat(split[0]);
 325                 float y = Float.parseFloat(split[1]);
 326                 PercentType brightness = (PercentType) brightnessValue.getChannelState();
 327                 if (channel.getIdWithoutGroup().equals(HS_CHANNEL_ID)) {
 328                     colorValue.update(new HSBType(new DecimalType(x), new PercentType(new BigDecimal(y)), brightness));
 329                 } else {
 330                     HSBType xyColor = HSBType.fromXY(x, y);
 331                     colorValue.update(new HSBType(xyColor.getHue(), xyColor.getSaturation(), brightness));
 332                 }
 333                 listener.updateChannelState(new ChannelUID(getGroupUID(), COLOR_CHANNEL_ID),
 334                         colorValue.getChannelState());
 335                 return;
 336             case RGB_CHANNEL_ID:
 337                 colorValue.update((HSBType) state);
 338                 listener.updateChannelState(new ChannelUID(getGroupUID(), COLOR_CHANNEL_ID),
 339                         colorValue.getChannelState());
 340                 break;
 341             case RGBW_CHANNEL_ID:
 342             case RGBWW_CHANNEL_ID:
 343                 // TODO: update color value
 344                 break;
 345         }
 346     }
 347 }