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.mqtt.homeassistant.internal;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.eclipse.jdt.annotation.Nullable;
  17 import org.openhab.binding.mqtt.generic.values.OnOffValue;
  18
  19 /**
  20  * A MQTT Fan component, following the https://www.home-assistant.io/components/fan.mqtt/ specification.
  21  *
  22  * Only ON/OFF is supported so far.
  23  *
  24  * @author David Graeff - Initial contribution
  25  */
  26 @NonNullByDefault
  27 public class ComponentFan extends AbstractComponent<ComponentFan.ChannelConfiguration> {
  28     public static final String switchChannelID = "fan"; // Randomly chosen channel "ID"
  29
  30     /**
  31      * Configuration class for MQTT component
  32      */
  33     static class ChannelConfiguration extends BaseChannelConfiguration {
  34         ChannelConfiguration() {
  35             super("MQTT Fan");
  36         }
  37
  38         protected @Nullable String state_topic;
  39         protected String command_topic = "";
  40         protected String payload_on = "ON";
  41         protected String payload_off = "OFF";
  42     }
  43
  44     public ComponentFan(CFactory.ComponentConfiguration componentConfiguration) {
  45         super(componentConfiguration, ChannelConfiguration.class);
  46
  47         OnOffValue value = new OnOffValue(channelConfiguration.payload_on, channelConfiguration.payload_off);
  48         buildChannel(switchChannelID, value, channelConfiguration.name, componentConfiguration.getUpdateListener())
  49                 .stateTopic(channelConfiguration.state_topic, channelConfiguration.value_template)
  50                 .commandTopic(channelConfiguration.command_topic, channelConfiguration.retain).build();
  51     }
  52 }