Site updated at 2015-12-16 15:13:55 UTC
This commit is contained in:
parent
d484b0f113
commit
2d2a6e49e4
98 changed files with 462 additions and 132 deletions
|
@ -117,6 +117,7 @@
|
|||
<span class="key">qos</span>: <span class="string"><span class="content">0</span></span>
|
||||
<span class="key">payload_on</span>: <span class="string"><span class="delimiter">"</span><span class="content">ON</span><span class="delimiter">"</span></span>
|
||||
<span class="key">payload_of</span>: <span class="string"><span class="delimiter">"</span><span class="content">OFF</span><span class="delimiter">"</span></span>
|
||||
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ template }}'</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -129,6 +130,7 @@
|
|||
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0.</li>
|
||||
<li><strong>payload_on</strong> (<em>Optional</em>): The payload that represents on state. Default is “ON”.</li>
|
||||
<li><strong>payload_off</strong> (<em>Optional</em>): The payload that represents state. Default is “OFF”.</li>
|
||||
<li><strong>value_template</strong> (<em>Optional</em>): Defines a <a href="/getting-started/templating/">template</a> to extract a value from the payload.</li>
|
||||
</ul>
|
||||
|
||||
<p>For a quick check you can use the commandline tools shipped with <code>mosquitto</code> to send MQTT messages. Set the state of your sensor manually:</p>
|
||||
|
|
|
@ -209,6 +209,9 @@ This device tracker needs telnet to be enabled on the router.
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -209,6 +209,9 @@ This device tracker needs telnet to be enabled on the router.
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -202,6 +202,9 @@ This device tracker needs telnet to be enabled on the router.
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -198,6 +198,9 @@
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -207,6 +207,9 @@ It seems that it is not necessary to use it in current generation Fritz!Box rout
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -185,6 +185,9 @@
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
245
components/device_tracker.icloud/index.html
Normal file
245
components/device_tracker.icloud/index.html
Normal file
|
@ -0,0 +1,245 @@
|
|||
<!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>iCloud - Home Assistant</title>
|
||||
<meta name="author" content="Paulus Schoutsen">
|
||||
<meta name="description" content="Instructions how to use iCloud to track devices in Home Assistant.">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/components/device_tracker.icloud/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="iCloud">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/components/device_tracker.icloud/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Instructions how to use iCloud to track devices in Home Assistant.">
|
||||
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
|
||||
|
||||
<meta name="twitter:card" content="summary">
|
||||
<meta name="twitter:site" content="@balloob">
|
||||
<meta name="twitter:title" content="iCloud">
|
||||
<meta name="twitter:description" content="Instructions how to use iCloud to track devices in Home Assistant.">
|
||||
<meta name="twitter:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.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='/images/favicon-192x192.png'> Home Assistant
|
||||
</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>
|
||||
<ul>
|
||||
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
|
||||
<li><a href='/getting-started/configuration/'>Configuration basics</a></li>
|
||||
<li><a href='/getting-started/devices/'>Adding devices</a></li>
|
||||
<li><a href='/getting-started/presence-detection/'>Presence detection</a></li>
|
||||
<li><a href='/getting-started/automation/'>Automation</a></li>
|
||||
<li><a href='/cookbook'>Configuration cookbook</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href='/components/'>Components</a></li>
|
||||
<li>
|
||||
<a href="/developers/">Developers</a>
|
||||
<ul>
|
||||
<li><a href="/developers/architecture/">Architecture</a></li>
|
||||
<li><a href="/developers/frontend/">Frontend development</a></li>
|
||||
<li><a href="/developers/creating_components/">
|
||||
Creating components
|
||||
</a></li>
|
||||
<li><a href="/developers/add_new_platform/">
|
||||
Adding platform support
|
||||
</a></li>
|
||||
<li><a href="/developers/api/">API</a></li>
|
||||
<li><a href="/developers/credits/">Credits</a></li>
|
||||
</ul>
|
||||
</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">
|
||||
iCloud
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
<p>The <code>icloud</code> platform allows you to detect presence using the <a href="https://www.icloud.com/">iCloud</a> service. iCloud allows users to track their location on iOS devices.</p>
|
||||
|
||||
<p>It does require that your device has beend registered with “Find My iPhone”.</p>
|
||||
|
||||
<p>To integrate iCloud in Home Assistant, add the following section to your <code>configuration.yaml</code> file:</p>
|
||||
|
||||
<div class="highlighter-coderay"><div class="CodeRay">
|
||||
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
||||
<span class="key">device_tracker</span>:
|
||||
<span class="key">platform</span>: <span class="string"><span class="content">icloud</span></span>
|
||||
<span class="key">username</span>: <span class="string"><span class="content">USERNAME</span></span>
|
||||
<span class="key">password</span>: <span class="string"><span class="content">PASSWORD</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p>Configuration variables:</p>
|
||||
|
||||
<ul>
|
||||
<li><strong>username</strong> (<em>Required</em>): The username for the iCloud account.</li>
|
||||
<li><strong>password</strong> (<em>Required</em>): The password for your given username.</li>
|
||||
</ul>
|
||||
|
||||
<p class="note warning">
|
||||
This may cause battery drainage as it wakes up your device to get the current location.
|
||||
</p>
|
||||
|
||||
<p class="note warning">
|
||||
You may receive an email from Apple stating that someone has logged into your account.
|
||||
</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='brand-logo-container section'>
|
||||
<img src='/images/supported_brands/icloud.png' />
|
||||
</div>
|
||||
<div class='section'>
|
||||
This is a platform for
|
||||
<a href='/components/device_tracker/'>the Device Tracker component</a>.
|
||||
</div>
|
||||
<div class='section'>
|
||||
<h1 class="title delta">Category Presence Detection</h1>
|
||||
<ul class='divided'>
|
||||
<li>
|
||||
<a href='/components/device_tracker.asuswrt/'>ASUSWRT</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.actiontec/'>Actiontec</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.aruba/'>Aruba</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.ddwrt/'>DD-WRT</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.fritz/'>FRITZ!Box</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.geofancy/'>Geofancy</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.mqtt/'>MQTT device tracker</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.netgear/'>Netgear</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.nmap_scanner/'>Nmap</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.luci/'>OpenWRT (luci)</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.ubus/'>OpenWRT (ubus)</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.owntracks/'>Owntracks</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.snmp/'>SNMP</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.tplink/'>TP-Link</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.thomson/'>Thomson</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
iCloud
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<div class="grid-wrapper">
|
||||
<div class="grid">
|
||||
<div class="grid__item">
|
||||
<p class="copyright">
|
||||
<span class="credit">Powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>. Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.</span>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<!--[if lt IE 7]>
|
||||
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
|
||||
<![endif]-->
|
||||
|
||||
<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>
|
|
@ -139,6 +139,8 @@
|
|||
|
||||
<p>See the <a href="/components/device_tracker/">device tracker component page</a> for instructions how to configure the people to be tracked.</p>
|
||||
|
||||
<p>Note for luci users; some installations have <a href="https://github.com/openwrt/luci/issues/576">a small bug</a> in them, where the timeout for luci RPC calls is not set and makes the call fail.</p>
|
||||
|
||||
</article>
|
||||
|
||||
|
||||
|
@ -208,6 +210,9 @@
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -223,6 +223,9 @@
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -198,6 +198,9 @@
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -193,6 +193,9 @@
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -191,6 +191,9 @@
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -112,7 +112,8 @@ This device tracker needs SNMP to be enabled on the router.
|
|||
|
||||
<p>OID examples:<br />
|
||||
- Microtik: 1.3.6.1.4.1.14988.1.1.1.2.1.1 (confirmed)<br />
|
||||
- Aruba: 1.3.6.1.4.1.14823.2.3.3.1.2.4.1.2 (untested)</p>
|
||||
- Aruba: 1.3.6.1.4.1.14823.2.3.3.1.2.4.1.2 (untested)<br />
|
||||
- BiPAC 7800DXL: 1.3.6.1.2.1.17.7.1.2.2.1.1 (confirmed on firmware 2.32e)</p>
|
||||
|
||||
<p>To use the snmp platform in your installation, add the following to your <code>configuration.yaml</code> file:</p>
|
||||
|
||||
|
@ -120,7 +121,7 @@ This device tracker needs SNMP to be enabled on the router.
|
|||
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
||||
<span class="key">device_tracker</span>:
|
||||
<span class="key">platform</span>: <span class="string"><span class="content">snmp</span></span>
|
||||
<span class="key">hosts</span>: <span class="string"><span class="content">192.168.1.1</span></span>
|
||||
<span class="key">host</span>: <span class="string"><span class="content">192.168.1.1</span></span>
|
||||
<span class="key">community</span>: <span class="string"><span class="content">public</span></span>
|
||||
<span class="key">baseoid</span>: <span class="string"><span class="content">1.3.6.1.4.1.14988.1.1.1.2.1.1</span></span>
|
||||
</pre></div>
|
||||
|
@ -207,6 +208,9 @@ This device tracker needs SNMP to be enabled on the router.
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -200,6 +200,9 @@
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -199,6 +199,9 @@
|
|||
<li>
|
||||
Tomato
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -207,6 +207,9 @@
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -244,6 +244,9 @@ file
|
|||
<li>
|
||||
<a href='/components/device_tracker.tomato/'>Tomato</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/components/device_tracker.icloud/'>iCloud</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
@ -198,6 +198,9 @@
|
|||
<li><a href='/components/device_tracker.tomato/'>
|
||||
Tomato
|
||||
</a></li>
|
||||
<li><a href='/components/device_tracker.icloud/'>
|
||||
iCloud
|
||||
</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
|
|
|
@ -1864,6 +1864,18 @@ Support for these components is provided by the Home Assistant community.
|
|||
|
||||
|
||||
|
||||
<a href='/components/device_tracker.icloud/' class='presence-detection'>
|
||||
<div class='img-container'>
|
||||
|
||||
<img src='/images/supported_brands/icloud.png'>
|
||||
|
||||
</div>
|
||||
<div class='title'>iCloud</div>
|
||||
<div class='category'>Presence Detection</div>
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<a href='/components/media_player.itunes/' class='media-player'>
|
||||
<div class='img-container'>
|
||||
|
||||
|
|
|
@ -115,8 +115,7 @@
|
|||
<span class="key">command</span>: <span class="string"><span class="content">SENSOR_COMMAND</span></span>
|
||||
<span class="key">name</span>: <span class="string"><span class="content">Command sensor</span></span>
|
||||
<span class="key">unit_of_measurement</span>: <span class="string"><span class="delimiter">"</span><span class="content">°C</span><span class="delimiter">"</span></span>
|
||||
<span class="key">correction_factor</span>: <span class="string"><span class="content">0.4921</span></span>
|
||||
<span class="key">decimal_places</span>: <span class="string"><span class="content">0</span></span>
|
||||
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ template }}'</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -127,8 +126,7 @@
|
|||
<li><strong>command</strong> (<em>Required</em>): The action to take to get the value.</li>
|
||||
<li><strong>name</strong> (<em>Optional</em>): Name of the command sensor.</li>
|
||||
<li><strong>unit_of_measurement</strong> (<em>Optional</em>): Defines the unit of measurement of the sensor, if any.</li>
|
||||
<li><strong>correction_factor</strong> (<em>Optional</em>): A float value to do some basic calculations.</li>
|
||||
<li><strong>decimal_places</strong> (<em>Optional</em>): Number of decimal places of the value.</li>
|
||||
<li><strong>value_template</strong> (<em>Optional</em>): Defines a <a href="/getting-started/templating/">template</a> to extract a value from the payload.</li>
|
||||
</ul>
|
||||
|
||||
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
|
||||
|
@ -168,7 +166,7 @@
|
|||
<span class="key">name</span>: <span class="string"><span class="content">CPU Temperature</span></span>
|
||||
<span class="key">command</span>: <span class="string"><span class="delimiter">"</span><span class="content">cat /sys/class/thermal/thermal_zone0/temp</span><span class="delimiter">"</span></span>
|
||||
<span class="key">unit_of_measurement</span>: <span class="string"><span class="delimiter">"</span><span class="content">°C</span><span class="delimiter">"</span></span>
|
||||
<span class="key">correction_factor</span>: <span class="string"><span class="content">0.001</span></span>
|
||||
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ value | multiply(0.001) }}'</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
@ -116,7 +116,7 @@
|
|||
<span class="key">name</span>: <span class="string"><span class="delimiter">"</span><span class="content">MQTT Sensor</span><span class="delimiter">"</span></span>
|
||||
<span class="key">qos</span>: <span class="string"><span class="content">0</span></span>
|
||||
<span class="key">unit_of_measurement</span>: <span class="string"><span class="delimiter">"</span><span class="content">°C</span><span class="delimiter">"</span></span>
|
||||
<span class="key">value_template</span>: <span class="string"><span class="content">''</span></span>
|
||||
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ template }}'</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -128,7 +128,7 @@
|
|||
<li><strong>name</strong> (<em>Optional</em>): The name of the sensor. Default is ‘MQTT Sensor’.</li>
|
||||
<li><strong>qos</strong> (<em>Optional</em>): The maximum QoS level of the state topic. Default is 0.</li>
|
||||
<li><strong>unit_of_measurement</strong> (<em>Optional</em>): Defines the units of measurement of the sensor, if any.</li>
|
||||
<li><strong>value_template</strong> (<em>Optional</em>): Defines a template to extract a value from the payload.</li>
|
||||
<li><strong>value_template</strong> (<em>Optional</em>): Defines a <a href="/getting-started/templating/">template</a> to extract a value from the payload.</li>
|
||||
</ul>
|
||||
|
||||
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
|
||||
|
|
|
@ -115,10 +115,8 @@
|
|||
<span class="key">resource</span>: <span class="string"><span class="content">http://IP_ADDRESS/ENDPOINT</span></span>
|
||||
<span class="key">method</span>: <span class="string"><span class="content">GET</span></span>
|
||||
<span class="key">name</span>: <span class="string"><span class="content">REST GET sensor</span></span>
|
||||
<span class="key">variable</span>: <span class="string"><span class="content">'return_value'</span></span>
|
||||
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ template }}'</span></span>
|
||||
<span class="key">unit_of_measurement</span>: <span class="string"><span class="delimiter">"</span><span class="content">°C</span><span class="delimiter">"</span></span>
|
||||
<span class="key">correction_factor</span>: <span class="string"><span class="content">0.01</span></span>
|
||||
<span class="key">decimal_places</span>: <span class="string"><span class="content">0</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -131,12 +129,10 @@
|
|||
<span class="key">platform</span>: <span class="string"><span class="content">rest</span></span>
|
||||
<span class="key">resource</span>: <span class="string"><span class="content">http://IP_ADDRESS/ENDPOINT</span></span>
|
||||
<span class="key">method</span>: <span class="string"><span class="content">POST</span></span>
|
||||
<span class="key">variable</span>: <span class="string"><span class="content">'temperature' or ['Temperatures', 0, 'CurrentReading']</span></span>
|
||||
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ template }}'</span></span>
|
||||
<span class="key">payload</span>: <span class="string"><span class="content">'{ "device" : "heater" }'</span></span>
|
||||
<span class="key">name</span>: <span class="string"><span class="content">REST POST sensor</span></span>
|
||||
<span class="key">unit_of_measurement</span>: <span class="string"><span class="delimiter">"</span><span class="content">°C</span><span class="delimiter">"</span></span>
|
||||
<span class="key">correction_factor</span>: <span class="string"><span class="content">0.0001</span></span>
|
||||
<span class="key">decimal_places</span>: <span class="string"><span class="content">0</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -146,12 +142,10 @@
|
|||
<ul>
|
||||
<li><strong>resource</strong> (<em>Required</em>): The resource or endpoint that contains the value.</li>
|
||||
<li><strong>method</strong> (<em>Optional</em>): The method of the request. Default is GET.</li>
|
||||
<li><strong>variable</strong> (<em>Optional</em>): Defines the variable or a list of element for complex responses to extract, if any.</li>
|
||||
<li><strong>value_template</strong> (<em>Required</em>): Defines a <a href="/getting-started/templating/">template</a> to extract the value.</li>
|
||||
<li><strong>payload</strong> (<em>Optional</em>): The payload to send with a POST request. Usualy formed as a dictionary-</li>
|
||||
<li><strong>name</strong> (<em>Optional</em>): Name of the REST sensor.</li>
|
||||
<li><strong>unit_of_measurement</strong> (<em>Optional</em>): Defines the unit of measurement of the sensor, if any.</li>
|
||||
<li><strong>correction_factor</strong> (<em>Optional</em>): A float value to do some basic calculations.</li>
|
||||
<li><strong>decimal_places</strong> (<em>Optional</em>): Number of decimal places of the value.</li>
|
||||
</ul>
|
||||
|
||||
<p class="note warning">
|
||||
|
@ -182,7 +176,7 @@ Make sure that the URL matches exactly your endpoint or resource.
|
|||
- <span class="string"><span class="content">platform: rest</span></span>
|
||||
<span class="key">resource</span>: <span class="string"><span class="content">http://ip.jsontest.com</span></span>
|
||||
<span class="key">name</span>: <span class="string"><span class="content">External IP</span></span>
|
||||
<span class="key">variable</span>: <span class="string"><span class="content">'ip'</span></span>
|
||||
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ value_json.ip }}'</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -198,10 +192,8 @@ Make sure that the URL matches exactly your endpoint or resource.
|
|||
- <span class="string"><span class="content">platform: rest</span></span>
|
||||
<span class="key">resource</span>: <span class="string"><span class="content">http://IP_ADRRESS:61208/api/2/mem/used</span></span>
|
||||
<span class="key">name</span>: <span class="string"><span class="content">Used mem</span></span>
|
||||
<span class="key">variable</span>: <span class="string"><span class="content">'used'</span></span>
|
||||
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ value_json.used| multiply(0.000000954) | round(0) }}'</span></span>
|
||||
<span class="key">unit_of_measurement</span>: <span class="string"><span class="content">MB</span></span>
|
||||
<span class="key">correction_factor</span>: <span class="string"><span class="content">0.000000954</span></span>
|
||||
<span class="key">decimal_places</span>: <span class="string"><span class="content">0</span></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue