372 lines
No EOL
18 KiB
HTML
372 lines
No EOL
18 KiB
HTML
<!doctype html>
|
||
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
||
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
||
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
||
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
<title>MQTT Light - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to setup MQTT lights within Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/light.mqtt/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="MQTT Light">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/light.mqtt/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to setup MQTT lights within Home Assistant.">
|
||
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
||
|
||
<meta name="twitter:card" content="summary_large_image">
|
||
<meta name="twitter:site" content="@home_assistant">
|
||
|
||
<meta name="twitter:title" content="MQTT Light">
|
||
<meta name="twitter:description" content="Instructions how to setup MQTT lights within Home Assistant.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
|
||
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
|
||
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
||
<link rel='shortcut icon' href='/images/favicon.ico' />
|
||
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
||
</head>
|
||
|
||
<body >
|
||
|
||
<header>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
|
||
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
||
<a href="/" class="site-title">
|
||
<img width='40' src='/demo/favicon-192x192.png'>
|
||
<span>Home Assistant</span>
|
||
</a>
|
||
</div>
|
||
|
||
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
||
<nav>
|
||
<input type="checkbox" id="toggle">
|
||
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
||
<ul class="menu pull-right">
|
||
|
||
<li><a href="/getting-started/">Getting started</a></li>
|
||
<li><a href="/components/">Components</a></li>
|
||
<li><a href="/ecosystem/">Ecosystem</a></li>
|
||
<li><a href="/cookbook/">Examples</a></li>
|
||
<li><a href="/developers/">Developers</a></li>
|
||
<li><a href="/blog/">Blog</a></li>
|
||
<li><a href="/help/">Need help?</a></li>
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</header>
|
||
|
||
|
||
|
||
<div class="grid-wrapper">
|
||
<div class="grid grid-center">
|
||
|
||
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
||
|
||
|
||
<article class="page">
|
||
|
||
|
||
|
||
|
||
<header>
|
||
<h1 class="title indent">
|
||
MQTT Light
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>The <code class="highlighter-rouge">mqtt</code> light platform let you control your MQTT enabled light.</p>
|
||
|
||
<p>In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with RETAIN flag, the MQTT switch will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state of the switch will be false/off.</p>
|
||
|
||
<p>When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from device (message from <code class="highlighter-rouge">state_topic</code>).</p>
|
||
|
||
<p>Optimistic mode can be forced, even if state topic is available. Try to enable it, if experiencing incorrect light operation.</p>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yml entry</span>
|
||
<span class="s">light</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">mqtt</span>
|
||
<span class="s">command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">office/rgb1/light/switch"</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>command_topic</strong> (<em>Required</em>): The MQTT topic to publish commands to change the switch state.</li>
|
||
<li><strong>name</strong> (<em>Optional</em>): The name of the switch. Default is ‘MQTT Switch’.</li>
|
||
<li><strong>state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive state updates.</li>
|
||
<li><strong>brightness_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive brightness state updates.</li>
|
||
<li><strong>brightness_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the light’s brightness.</li>
|
||
<li><strong>rgb_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive RGB state updates.</li>
|
||
<li><strong>rgb_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the light’s RGB state.</li>
|
||
<li><strong>color_temp_state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive color temperature state updates.</li>
|
||
<li><strong>color_temp_command_topic</strong> (<em>Optional</em>): The MQTT topic to publish commands to change the light’s color temperature state.</li>
|
||
<li><strong>state_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the state value.</li>
|
||
<li><strong>brightness_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the brightness value.</li>
|
||
<li><strong>rgb_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the RGB value.</li>
|
||
<li><strong>color_temp_value_template</strong> (<em>Optional</em>): Defines a <a href="/topics/templating/">template</a> to extract the color temperature value.</li>
|
||
<li><strong>brightness_scale</strong> (<em>Optional</em>): Defines the maximum brightness value (i.e. 100%) of the MQTT device (defaults to 255).</li>
|
||
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.</li>
|
||
<li><strong>payload_on</strong> (<em>Optional</em>): The payload that represents enabled state. Default is “ON”.</li>
|
||
<li><strong>payload_off</strong> (<em>Optional</em>): The payload that represents disabled state. Default is “OFF”.</li>
|
||
<li><strong>optimistic</strong> (<em>Optional</em>): Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false.</li>
|
||
</ul>
|
||
|
||
<p class="note warning">
|
||
Make sure that your topics match exact. <code class="highlighter-rouge">some-topic/</code> and <code class="highlighter-rouge">some-topic</code> are different topics.
|
||
</p>
|
||
|
||
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
|
||
|
||
<p>In this section you find some real life examples of how to use this sensor.</p>
|
||
|
||
<h3><a class="title-link" name="brightness-and-rgb-support" href="#brightness-and-rgb-support"></a> Brightness and RGB support</h3>
|
||
|
||
<p>To enable a light with brightness and RGB support in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yml entry</span>
|
||
<span class="s">light</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">mqtt</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Office</span><span class="nv"> </span><span class="s">Light</span><span class="nv"> </span><span class="s">RGB"</span>
|
||
<span class="s">state_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">office/rgb1/light/status"</span>
|
||
<span class="s">command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">office/rgb1/light/switch"</span>
|
||
<span class="s">brightness_state_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">office/rgb1/brightness/status"</span>
|
||
<span class="s">brightness_command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">office/rgb1/brightness/set"</span>
|
||
<span class="s">rgb_state_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">office/rgb1/rgb/status"</span>
|
||
<span class="s">rgb_command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">office/rgb1/rgb/set"</span>
|
||
<span class="s">state_value_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">value_json.state</span><span class="nv"> </span><span class="s">}}"</span>
|
||
<span class="s">brightness_value_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">value_json.brightness</span><span class="nv"> </span><span class="s">}}"</span>
|
||
<span class="s">rgb_value_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">value_json.rgb</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">join(',')</span><span class="nv"> </span><span class="s">}}"</span>
|
||
<span class="s">qos</span><span class="pi">:</span> <span class="s">0</span>
|
||
<span class="s">payload_on</span><span class="pi">:</span> <span class="s2">"</span><span class="s">ON"</span>
|
||
<span class="s">payload_off</span><span class="pi">:</span> <span class="s2">"</span><span class="s">OFF"</span>
|
||
<span class="s">optimistic</span><span class="pi">:</span> <span class="s">false</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<h3><a class="title-link" name="brightness-and-no-rgb-support" href="#brightness-and-no-rgb-support"></a> Brightness and no RGB support</h3>
|
||
|
||
<p>To enable a light with brightness (no RGB version) in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yml entry</span>
|
||
<span class="s">light</span><span class="pi">:</span>
|
||
<span class="s">platform</span><span class="pi">:</span> <span class="s">mqtt</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Office</span><span class="nv"> </span><span class="s">light"</span>
|
||
<span class="s">state_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">office/rgb1/light/status"</span>
|
||
<span class="s">command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">office/rgb1/light/switch"</span>
|
||
<span class="s">brightness_state_topic</span><span class="pi">:</span> <span class="s1">'</span><span class="s">office/rgb1/light/brightness'</span>
|
||
<span class="s">brightness_command_topic</span><span class="pi">:</span> <span class="s1">'</span><span class="s">office/rgb1/light/brightness/set'</span>
|
||
<span class="s">qos</span><span class="pi">:</span> <span class="s">0</span>
|
||
<span class="s">payload_on</span><span class="pi">:</span> <span class="s2">"</span><span class="s">ON"</span>
|
||
<span class="s">payload_off</span><span class="pi">:</span> <span class="s2">"</span><span class="s">OFF"</span>
|
||
<span class="s">optimistic</span><span class="pi">:</span> <span class="s">false</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<h3><a class="title-link" name="implementations" href="#implementations"></a> Implementations</h3>
|
||
|
||
<p>A basic example using a nodeMCU board (ESP8266) to control its built-in led (on/off) can be found <a href="https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_light">here</a>. <a href="https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_rgb_light">Here</a> is another example to control a RGB led (on/off, brightness and colors).</p>
|
||
|
||
|
||
</article>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
||
<div class="grid">
|
||
|
||
|
||
<section class="aside-module grid__item one-whole lap-one-half">
|
||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/light.mqtt.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/mqtt.png' />
|
||
</div>
|
||
<div class='section'>
|
||
This is a platform for
|
||
<a href='/components/light/'>the Lights component</a>.
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class='title delta'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/mqtt/'>
|
||
MQTT
|
||
</a></li>
|
||
<li><a href='/components/alarm_control_panel.mqtt/'>
|
||
MQTT Alarm Control Panel
|
||
</a></li>
|
||
<li><a href='/components/binary_sensor.mqtt/'>
|
||
MQTT Binary Sensor
|
||
</a></li>
|
||
<li><a href='/components/cover.mqtt/'>
|
||
MQTT Cover
|
||
</a></li>
|
||
<li><a href='/components/device_tracker.mqtt/'>
|
||
MQTT Device Tracker
|
||
</a></li>
|
||
<li><a href='/components/fan.mqtt/'>
|
||
MQTT Fan
|
||
</a></li>
|
||
<li><a href='/components/lock.mqtt/'>
|
||
MQTT Lock
|
||
</a></li>
|
||
<li><a href='/components/notify.mqtt/'>
|
||
MQTT Notifications
|
||
</a></li>
|
||
<li><a href='/components/sensor.mqtt/'>
|
||
MQTT Sensor
|
||
</a></li>
|
||
<li><a href='/components/switch.mqtt/'>
|
||
MQTT Switch
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Light</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/light.wemo/'>Belkin WeMo Lights</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.blinksticklight/'>Blinkstick</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.enocean/'>EnOcean Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.flux_led/'>Flux Led/MagicLight</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.homematic/'>Homematic Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.hyperion/'>Hyperion</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.isy994/'>ISY994 Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.insteon_local/'>Insteon (Local) Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.insteon_hub/'>Insteon Hub Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.lifx/'>LIFX</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.limitlessled/'>LimitlessLED</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.litejet/'>LiteJet Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.mqtt_json/'>MQTT JSON Light</a>
|
||
</li>
|
||
<li>
|
||
MQTT Light
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.mqtt_template/'>MQTT Template Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.mysensors/'>MySensors Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.osramlightify/'>Osram Lightify</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.hue/'>Philips Hue</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.qwikswitch/'>QwikSwitch Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.rfxtrx/'>RFXtrx Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.scsgate/'>SCSGate Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.tellstick/'>TellStick Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.tikteck/'>Tikteck</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.vera/'>Vera Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.wink/'>Wink Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.x10/'>X10</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.yeelight/'>Yeelight Wifi Bulb</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.zwave/'>Z-Wave Light</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.zengge/'>Zengge</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/light.zigbee/'>ZigBee Light</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
|
||
</div>
|
||
</aside>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<footer>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item">
|
||
<div class="copyright">
|
||
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
||
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
||
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
||
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
||
|
||
<div class="credit">
|
||
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
|
||
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
||
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
|
||
<script>
|
||
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
||
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
||
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
||
s.parentNode.insertBefore(g,s)}(document,'script'));
|
||
</script>
|
||
</body>
|
||
</html> |