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

   1 /**
   2  * Copyright (c) 2010-2024 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 org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.eclipse.jdt.annotation.Nullable;
  17 import org.openhab.binding.mqtt.generic.values.TextValue;
  18 import org.openhab.binding.mqtt.homeassistant.internal.ComponentChannelType;
  19 import org.openhab.binding.mqtt.homeassistant.internal.config.dto.AbstractChannelConfiguration;
  20 import org.openhab.core.thing.type.AutoUpdatePolicy;
  21
  22 import com.google.gson.annotations.SerializedName;
  23
  24 /**
  25  * A MQTT scene, following the https://www.home-assistant.io/integrations/scene.mqtt/ specification.
  26  *
  27  * @author Cody Cutrer - Initial contribution
  28  */
  29 @NonNullByDefault
  30 public class Scene extends AbstractComponent<Scene.ChannelConfiguration> {
  31     public static final String SCENE_CHANNEL_ID = "scene";
  32
  33     /**
  34      * Configuration class for MQTT component
  35      */
  36     static class ChannelConfiguration extends AbstractChannelConfiguration {
  37         ChannelConfiguration() {
  38             super("MQTT Scene");
  39         }
  40
  41         @SerializedName("command_topic")
  42         protected @Nullable String commandTopic;
  43
  44         @SerializedName("payload_on")
  45         protected String payloadOn = "ON";
  46     }
  47
  48     public Scene(ComponentFactory.ComponentConfiguration componentConfiguration, boolean newStyleChannels) {
  49         super(componentConfiguration, ChannelConfiguration.class, newStyleChannels, true);
  50
  51         TextValue value = new TextValue(new String[] { channelConfiguration.payloadOn });
  52
  53         buildChannel(SCENE_CHANNEL_ID, ComponentChannelType.STRING, value, getName(),
  54                 componentConfiguration.getUpdateListener())
  55                 .commandTopic(channelConfiguration.commandTopic, channelConfiguration.isRetain(),
  56                         channelConfiguration.getQos())
  57                 .withAutoUpdatePolicy(AutoUpdatePolicy.VETO).build();
  58     }
  59 }