home-assistant.github.io/components/switch.netio/index.html
2018-03-09 18:51:31 +00:00

436 lines
20 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Netio Switch - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate Netio switches into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/switch.netio/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Netio Switch">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/switch.netio/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Netio 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="Netio Switch">
<meta name="twitter:description" content="Instructions how to integrate Netio 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, print" 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">
Netio Switch
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">netio</code> switch platform allows you to control your <a href="http://www.netio-products.com/en/overview/">Netio</a> Netio4, Netio4 All, and Netio 230B. These are smart outlets controllable through Ethernet and/or WiFi that reports consumptions (Netio4all).</p>
<p>To use Netio devices 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.yaml 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">netio</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.43</span>
<span class="s">username</span><span class="pi">:</span> <span class="s">YOUR_USERNAME</span>
<span class="s">password</span><span class="pi">:</span> <span class="s">YOUR_PASSWORD</span>
<span class="s">outlets</span><span class="pi">:</span>
<span class="s">1</span><span class="pi">:</span> <span class="s">Free</span>
<span class="s">2</span><span class="pi">:</span> <span class="s">TV</span>
<span class="s">4</span><span class="pi">:</span> <span class="s">Lamp</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP address of your Netio plug, eg. <code class="highlighter-rouge">http://192.168.1.32</code>.</li>
<li><strong>port</strong> (<em>Optional</em>): The port to communicate with the switch. Defaults to <code class="highlighter-rouge">1234</code>.</li>
<li><strong>username</strong> (<em>Required</em>): The username for your plug.</li>
<li><strong>password</strong> (<em>Required</em>): The password for your plug.</li>
<li><strong>outlets</strong> (<em>Required</em>) array: List of all outlets.
<ul>
<li><strong>[No.]: [Name]</strong> (<em>Required</em>): Identification of an outlet.</li>
</ul>
</li>
</ul>
<p>To get pushed updates from the Netio devices, one can add this Lua code in the device interface as an action triggered on “Netio” “System variables updated” with an Always schedule:</p>
<div class="language-lua highlighter-rouge"><pre class="highlight"><code><span class="c1">-- this will send socket and consumption status updates via CGI</span>
<span class="c1">-- to given address. Associate with 'System variables update' event</span>
<span class="c1">-- to get consumption updates when they show up</span>
<span class="kd">local</span> <span class="n">address</span><span class="o">=</span><span class="s1">'ha:8123'</span>
<span class="kd">local</span> <span class="n">path</span> <span class="o">=</span> <span class="s1">'/api/netio/&lt;host&gt;'</span>
<span class="kd">local</span> <span class="n">output</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">4</span> <span class="k">do</span> <span class="k">for</span> <span class="n">_</span><span class="p">,</span> <span class="n">what</span> <span class="k">in</span> <span class="nb">pairs</span><span class="p">({</span><span class="s1">'state'</span><span class="p">,</span> <span class="s1">'consumption'</span><span class="p">,</span>
<span class="s1">'cumulatedConsumption'</span><span class="p">,</span> <span class="s1">'consumptionStart'</span><span class="p">})</span> <span class="k">do</span>
<span class="kd">local</span> <span class="n">varname</span> <span class="o">=</span> <span class="nb">string.format</span><span class="p">(</span><span class="s1">'output%d_%s'</span><span class="p">,</span> <span class="n">i</span><span class="p">,</span> <span class="n">what</span><span class="p">)</span>
<span class="nb">table.insert</span><span class="p">(</span><span class="n">output</span><span class="p">,</span>
<span class="n">varname</span><span class="o">..</span><span class="s1">'='</span><span class="o">..</span><span class="nb">tostring</span><span class="p">(</span><span class="n">devices</span><span class="p">.</span><span class="n">system</span><span class="p">[</span><span class="n">varname</span><span class="p">]):</span><span class="n">gsub</span><span class="p">(</span><span class="s2">" "</span><span class="p">,</span><span class="s2">"|"</span><span class="p">))</span>
<span class="k">end</span> <span class="k">end</span>
<span class="kd">local</span> <span class="n">qs</span> <span class="o">=</span> <span class="nb">table.concat</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="s1">'&amp;'</span><span class="p">)</span>
<span class="kd">local</span> <span class="n">url</span> <span class="o">=</span> <span class="nb">string.format</span><span class="p">(</span><span class="s1">'http://%s%s?%s'</span><span class="p">,</span> <span class="n">address</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">qs</span><span class="p">)</span>
<span class="n">devices</span><span class="p">.</span><span class="n">system</span><span class="p">.</span><span class="n">CustomCGI</span><span class="p">{</span><span class="n">url</span><span class="o">=</span><span class="n">url</span><span class="p">}</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.netio.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/netio.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 Polling
</div>
<div class='section'>
Introduced in release: 0.24
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/switch/netio.py'>switch/netio.py</a>
</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">Category Switch</h1>
<ul class='divided'>
<li>
<a href='/components/switch.ads/'>ADS Switch</a>
</li>
<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.doorbird/'>DoorBird 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.hikvisioncam/'>Hikvision Camera Switch</a>
</li>
<li>
<a href='/components/switch.hive/'>Hive 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.ihc/'>IHC 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>
<a href='/components/switch.mqtt/'>MQTT Switch</a>
</li>
<li>
<a href='/components/switch.raincloud/'>Melnor Raincloud Switch</a>
</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>
Netio Switch
</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.snmp/'>SNMP Switch</a>
</li>
<li>
<a href='/components/switch.skybell/'>Skybell Switch</a>
</li>
<li>
<a href='/components/switch.smappee/'>Smappee Switch</a>
</li>
<li>
<a href='/components/switch.tplink/'>TP-Link 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.telnet/'>Telnet Switch</a>
</li>
<li>
<a href='/components/switch.template/'>Template Switch</a>
</li>
<li>
<a href='/components/switch.tesla/'>Tesla Switch</a>
</li>
<li>
<a href='/components/switch.thinkingcleaner/'>Thinking Cleaner Switch</a>
</li>
<li>
<a href='/components/switch.toon/'>Toon Smart Plugs</a>
</li>
<li>
<a href='/components/switch.upcloud/'>UpCloud 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.vultr/'>Vultr Switch</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_miio/'>Xiaomi Smart WiFi Socket and Smart Power Strip</a>
</li>
<li>
<a href='/components/switch.xiaomi_aqara/'>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.gc100/'>gc100 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>