355 lines
No EOL
20 KiB
HTML
355 lines
No EOL
20 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 Template Light - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions for how to setup MQTT Template lights within Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/light.mqtt_template/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="MQTT Template Light">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/light.mqtt_template/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions for how to setup MQTT Template 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 Template Light">
|
||
<meta name="twitter:description" content="Instructions for how to setup MQTT Template 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 Template Light
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>The <code class="highlighter-rouge">mqtt_template</code> light platform lets you control a MQTT-enabled light that receive commands on a command topic and optionally sends status update on a state topic.
|
||
It is format-agnostic so you can use any data format you want (i.e. string, JSON), just configure it with templating.</p>
|
||
|
||
<p>This platform supports on/off, brightness, RGB colors, transitions, short/long flashing and effects.</p>
|
||
|
||
<p>In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with the RETAIN flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the light will be 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 the device (message from <code class="highlighter-rouge">state_topic</code>).</p>
|
||
|
||
<p>Optimistic mode can be forced, even if state topic is available. Try enabling it if the light is operating incorrectly.</p>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml 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_template</span>
|
||
<span class="s">command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home/rgb1/set"</span>
|
||
<span class="s">command_on_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">on"</span>
|
||
<span class="s">command_off_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">off"</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>name</strong> (<em>Optional</em>): The name of the light. Default is “MQTT Template Light.”</li>
|
||
<li><strong>effect_list</strong> (<em>Optional</em>): List of possible effects.</li>
|
||
<li><strong>command_topic</strong> (<em>Required</em>): The MQTT topic to publish commands to change the light’s state.</li>
|
||
<li><strong>state_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive state updates.</li>
|
||
<li><strong>command_on_template</strong> (<em>Required</em>): The template for <em>on</em> state changes. Available variables: <code class="highlighter-rouge">state</code>, <code class="highlighter-rouge">brightness</code>, <code class="highlighter-rouge">red</code>, <code class="highlighter-rouge">green</code>, <code class="highlighter-rouge">blue</code>, <code class="highlighter-rouge">flash</code>, <code class="highlighter-rouge">transition</code> and <code class="highlighter-rouge">effect</code>.</li>
|
||
<li><strong>command_off_template</strong> (<em>Required</em>): The template for <em>off</em> state changes. Available variables: <code class="highlighter-rouge">state</code> and <code class="highlighter-rouge">transition</code>.</li>
|
||
<li><strong>state_template</strong> (<em>Optional</em>): Template to extract state from the state payload value.</li>
|
||
<li><strong>brightness_template</strong> (<em>Optional</em>): Template to extract brightness from the state payload value.</li>
|
||
<li><strong>red_template</strong> (<em>Optional</em>): Template to extract red color from the state payload value.</li>
|
||
<li><strong>green_template</strong> (<em>Optional</em>): Template to extract green color from the state payload value.</li>
|
||
<li><strong>blue_template</strong> (<em>Optional</em>): Template to extract blue color from the state payload value.</li>
|
||
<li><strong>effect_template</strong> (<em>Optional</em>): Template to extract effect from the state payload value.</li>
|
||
<li><strong>optimistic</strong> (<em>Optional</em>): Flag that defines if the light works in optimistic mode. Default is true if no state topic or state template is defined, else false.</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>
|
||
</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 light.</p>
|
||
|
||
<h3><a class="title-link" name="simple-string-payload" href="#simple-string-payload"></a> Simple string payload</h3>
|
||
|
||
<p>For a simple string payload with the format <code class="highlighter-rouge">state,brightness,r-g-b</code> (e.g. <code class="highlighter-rouge">on,255,255-255-255</code>), 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.yaml 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_template</span>
|
||
<span class="s">command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home/rgb1/set"</span>
|
||
<span class="s">state_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home/rgb1/status"</span>
|
||
<span class="s">command_on_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">on,{{</span><span class="nv"> </span><span class="s">brightness|d</span><span class="nv"> </span><span class="s">}},{{</span><span class="nv"> </span><span class="s">red|d</span><span class="nv"> </span><span class="s">}}-{{</span><span class="nv"> </span><span class="s">green|d</span><span class="nv"> </span><span class="s">}}-{{</span><span class="nv"> </span><span class="s">blue|d</span><span class="nv"> </span><span class="s">}}"</span>
|
||
<span class="s">command_off_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">off"</span>
|
||
<span class="s">state_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">value.split(',')[0]</span><span class="nv"> </span><span class="s">}}"</span> <span class="c1"># must return `on` or `off`</span>
|
||
<span class="s">brightness_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">value.split(',')[1]</span><span class="nv"> </span><span class="s">}}"</span>
|
||
<span class="s">red_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">value.split(',')[2].split('-')[0]</span><span class="nv"> </span><span class="s">}}"</span>
|
||
<span class="s">green_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">value.split(',')[2].split('-')[1]</span><span class="nv"> </span><span class="s">}}"</span>
|
||
<span class="s">blue_template</span><span class="pi">:</span> <span class="s2">"</span><span class="s">{{</span><span class="nv"> </span><span class="s">value.split(',')[2].split('-')[2]</span><span class="nv"> </span><span class="s">}}"</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<h3><a class="title-link" name="json-payload" href="#json-payload"></a> JSON payload</h3>
|
||
|
||
<p>For a JSON payload with the format <code class="highlighter-rouge"><span class="p">{</span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="s2">"on"</span><span class="p">,</span><span class="w"> </span><span class="nt">"brightness"</span><span class="p">:</span><span class="w"> </span><span class="mi">255</span><span class="p">,</span><span class="w"> </span><span class="nt">"color"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="mi">255</span><span class="p">,</span><span class="w"> </span><span class="mi">255</span><span class="p">,</span><span class="w"> </span><span class="mi">255</span><span class="p">],</span><span class="w"> </span><span class="nt">"effect"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rainbow"</span><span class="p">}</span></code>, 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.yaml 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_template</span>
|
||
<span class="s">effect_list</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">rainbow</span>
|
||
<span class="pi">-</span> <span class="s">colorloop</span>
|
||
<span class="s">command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home/rgb1/set"</span>
|
||
<span class="s">state_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home/rgb1/status"</span>
|
||
<span class="s">command_on_template</span><span class="pi">:</span> <span class="pi">></span>
|
||
<span class="no">{"state": "on"</span>
|
||
<span class="no">{%- if brightness is defined -%}</span>
|
||
<span class="no">, "brightness": {{ brightness }}</span>
|
||
<span class="no">{%- endif -%}</span>
|
||
<span class="no">{%- if red is defined and green is defined and blue is defined -%}</span>
|
||
<span class="no">, "color": [{{ red }}, {{ green }}, {{ blue }}]</span>
|
||
<span class="no">{%- endif -%}</span>
|
||
<span class="no">{%- if effect is defined -%}</span>
|
||
<span class="no">, "effect": "{{ effect }}"</span>
|
||
<span class="no">{%- endif -%}</span>
|
||
<span class="no">}</span>
|
||
<span class="s">command_off_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{"state":</span><span class="nv"> </span><span class="s">"off"}'</span>
|
||
<span class="s">state_template</span><span class="pi">:</span> <span class="s1">'</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_template</span><span class="pi">:</span> <span class="s1">'</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">red_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">value_json.color[0]</span><span class="nv"> </span><span class="s">}}'</span>
|
||
<span class="s">green_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">value_json.color[1]</span><span class="nv"> </span><span class="s">}}'</span>
|
||
<span class="s">blue_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">value_json.color[2]</span><span class="nv"> </span><span class="s">}}'</span>
|
||
<span class="s">effect_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">value_json.effect</span><span class="nv"> </span><span class="s">}}'</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<h3><a class="title-link" name="no-brightness-or-color-support" href="#no-brightness-or-color-support"></a> No brightness or color support</h3>
|
||
|
||
<p>If you don’t want brightness, color or effect support, just omit the corresponding configuration sections.</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_template.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'>
|
||
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Push
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.33
|
||
</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">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>
|
||
<a href='/components/light.mqtt/'>MQTT Light</a>
|
||
</li>
|
||
<li>
|
||
MQTT Template Light
|
||
</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> |