428 lines
20 KiB
HTML
428 lines
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 Switch - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to integrate MQTT switches into Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/switch.mqtt/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="MQTT Switch">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/switch.mqtt/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to integrate MQTT switches into 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 Switch">
|
||
<meta name="twitter:description" content="Instructions how to integrate MQTT switches into 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 class='site-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="/docs/">Docs</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>
|
||
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
||
</ul>
|
||
</nav>
|
||
<div class='search-container' style='display: none'>
|
||
<div class='search'>
|
||
<i class="icon-search"></i>
|
||
<input id='search' placeholder='Search the docs…'>
|
||
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
||
</div>
|
||
</div>
|
||
</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 Switch
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">mqtt</code> switch platform let you control your MQTT enabled switch.</p>
|
||
<p>In an ideal scenario, the MQTT device will have a <code class="highlighter-rouge">state_topic</code> to publish state changes. If these messages are published with <code class="highlighter-rouge">RETAIN</code> 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 <code class="highlighter-rouge">state_topic</code> is not available, the switch will work in optimistic mode. In this mode, the switch will immediately change state after every command. Otherwise, the switch 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 switch operation.</p>
|
||
<p>To enable this switch 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">switch</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">home/bedroom/switch1/set"</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<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>command_topic</strong> (<em>Required</em>): The MQTT topic to publish commands to change the switch state.</li>
|
||
<li><strong>availability_topic</strong> (<em>Optional</em>): The MQTT topic subscribed to receive availability (online/offline) updates.</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>payload_available</strong> (<em>Optional</em>): The payload that represents the available state, e.g. ‘online’. Default is “ON”.</li>
|
||
<li><strong>payload_not_available</strong> (<em>Optional</em>): The payload that represents the unavailable state, e.g. ‘offline’. Default is “OFF”.</li>
|
||
<li><strong>optimistic</strong> (<em>Optional</em>): Flag that defines if switch works in optimistic mode. Default is <code class="highlighter-rouge">true</code> if no <code class="highlighter-rouge">state_topic</code> defined, else <code class="highlighter-rouge">false</code>.</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>retain</strong> (<em>Optional</em>): If the published message should have the retain flag on or not.</li>
|
||
<li><strong>value_template</strong> (<em>Optional</em>): Defines a <a href="/docs/configuration/templating/#processing-incoming-data">template</a> to extract a value from the payload.</li>
|
||
</ul>
|
||
<p class="note warning">
|
||
Make sure that your topic 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="full-configuration" href="#full-configuration"></a> Full configuration</h3>
|
||
<p>The example below shows a full configuration for a switch.</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yml entry</span>
|
||
<span class="s">switch</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">Bedroom</span><span class="nv"> </span><span class="s">Switch"</span>
|
||
<span class="s">state_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home/bedroom/switch1"</span>
|
||
<span class="s">command_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home/bedroom/switch1/set"</span>
|
||
<span class="s">availability_topic</span><span class="pi">:</span> <span class="s2">"</span><span class="s">home/bedroom/switch1/available"</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>
|
||
<span class="s">qos</span><span class="pi">:</span> <span class="s">0</span>
|
||
<span class="s">retain</span><span class="pi">:</span> <span class="s">true</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>For a check you can use the command line tools <code class="highlighter-rouge">mosquitto_pub</code> shipped with <code class="highlighter-rouge">mosquitto</code> to send MQTT messages. This allows you to operate your switch manually:</p>
|
||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>mosquitto_pub -h 127.0.0.1 -t home/bedroom/switch1 -m <span class="s2">"ON"</span>
|
||
</code></pre>
|
||
</div>
|
||
</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/switch.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'>
|
||
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: depends
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.7
|
||
</div>
|
||
<div class='section'>
|
||
This is a platform for
|
||
<a href='/components/switch/'>the Switches 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/camera.mqtt/'>
|
||
MQTT Camera
|
||
</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/light.mqtt/'>
|
||
MQTT Light
|
||
</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>
|
||
</ul>
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Switch</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/switch.anel_pwrctrl/'>ANEL PwrCtrl Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.fritzdect/'>AVM FRITZ!DECT Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.abode/'>Abode Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.acer_projector/'>Acer Projector Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.android_ip_webcam/'>Android IP Webcam Settings</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.bbb_gpio/'>BeagleBone Black GPIO Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.wemo/'>Belkin WeMo Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.broadlink/'>Broadlink RM Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.command_line/'>Command line Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.dlink/'>D-Link Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.digitalloggers/'>Digital Loggers Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.digital_ocean/'>Digital Ocean Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.edimax/'>Edimax Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.enocean/'>EnOcean Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.hikvision/'>Hikvision Camera Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.homematic/'>Homematic Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.hook/'>Hook Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.isy994/'>ISY994 Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.insteon_local/'>Insteon (Local) Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.insteon_plm/'>Insteon PLM Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.knx/'>KNX Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.kankun/'>Kankun SP3 Wifi Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.litejet/'>LiteJet Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.lutron_caseta/'>Lutron Caseta Switch</a>
|
||
</li>
|
||
<li>
|
||
MQTT Switch
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.mochad/'>Mochad Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.modbus/'>Modbus Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.mysensors/'>MySensors Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.neato/'>Neato Robotics Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.netio/'>Netio Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.orvibo/'>Orvibo Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rpi_pfio/'>PiFace Digital I/O Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.pilight/'>Pilight Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.pulseaudio_loopback/'>PulseAudio Loopback Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.qwikswitch/'>QwikSwitch Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rest/'>RESTful Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rflink/'>RFLink Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rfxtrx/'>RFXtrx Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rachio/'>Rachio Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rainmachine/'>RainMachine Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rpi_gpio/'>Raspberry PI GPIO Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.rpi_rf/'>Raspberry Pi RF Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.raspihats/'>Raspihats Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.scsgate/'>SCSGate Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.tplink/'>TPLink Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.tellstick/'>TellStick Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.tellduslive/'>Telldus Live Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.template/'>Template switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.thinkingcleaner/'>Thinking Cleaner Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.velbus/'>Velbus Switches</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.vera/'>Vera Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.verisure/'>Verisure SmartPlug</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.wake_on_lan/'>Wake on LAN Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.wink/'>Wink Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.xiaomi/'>Xiaomi Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.zwave/'>Z-Wave Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.zha/'>ZigBee Home Automation Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.zigbee/'>ZigBee Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.zoneminder/'>ZoneMinder Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.arest/'>aREST Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.mfi/'>mFi Switch</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/switch.mystrom/'>myStrom Switch</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> (no support!).<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>
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||
</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>
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
||
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
||
<script type="text/javascript">
|
||
docsearch({
|
||
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
||
indexName: 'home-assistant',
|
||
inputSelector: '#search',
|
||
debug: false // Set debug to true if you want to inspect the dropdown
|
||
});
|
||
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'none';
|
||
});
|
||
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'block';
|
||
document.getElementById('toggle').checked = false;
|
||
document.querySelector('.search-container input').focus();
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|