317 lines
No EOL
13 KiB
HTML
317 lines
No EOL
13 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>Dweet.io - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Instructions how to integrate Dweet.io sensors within Home Assistant.">
|
|
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/sensor.dweet/">
|
|
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Dweet.io">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/sensor.dweet/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to integrate Dweet.io sensors 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="Dweet.io">
|
|
<meta name="twitter:description" content="Instructions how to integrate Dweet.io sensors 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='/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">
|
|
Dweet.io
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
|
|
|
|
<p>The <code class="highlighter-rouge">dweet</code> sensor platform allows you to get details from your devices which are publishing their values to <a href="https://dweet.io/">Dweet.io</a>.</p>
|
|
|
|
<p>To use Dweet.io 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">sensor</span><span class="pi">:</span>
|
|
<span class="s">platform</span><span class="pi">:</span> <span class="s">dweet</span>
|
|
<span class="s">name</span><span class="pi">:</span> <span class="s">Dweet.io Temperature</span>
|
|
<span class="s">device</span><span class="pi">:</span> <span class="s">THING_NAME</span>
|
|
<span class="s">value_template</span><span class="pi">:</span> <span class="s1">'</span><span class="s">{{</span><span class="nv"> </span><span class="s">value_json.VARIABLE</span><span class="nv"> </span><span class="s">}}'</span>
|
|
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s2">"</span><span class="s">°C"</span>
|
|
</code></pre>
|
|
</div>
|
|
|
|
<p>Configuration variables:</p>
|
|
|
|
<ul>
|
|
<li><strong>device</strong> (<em>Required</em>): Identification of the device (also known as <code class="highlighter-rouge">thing</code>).</li>
|
|
<li><strong>name</strong> (<em>Optional</em>): Let you overwrite the the name of the device in the frontend.</li>
|
|
<li><strong>value_template</strong> (<em>Required</em>): The variable to extract a value from the content.</li>
|
|
<li><strong>unit_of_measurement</strong> (<em>Optional</em>): Defines the unit of measurement of the sensor, if any.</li>
|
|
</ul>
|
|
|
|
<h3><a class="title-link" name="interacting-with-dweetio" href="#interacting-with-dweetio"></a> Interacting with Dweet.io</h3>
|
|
|
|
<p>You can easily send dweets from the commandline to test your sensor with <code class="highlighter-rouge">curl</code>.</p>
|
|
|
|
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>curl -H <span class="s1">'Content-Type: application/json'</span> -d <span class="s1">'{"temperature": 40, "humidity": 65}'</span> https://dweet.io/dweet/for/ha-sensor
|
|
</code></pre>
|
|
</div>
|
|
<p>will give you a response like the one below:</p>
|
|
|
|
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="nt">"this"</span><span class="p">:</span><span class="s2">"succeeded"</span><span class="p">,</span><span class="nt">"by"</span><span class="p">:</span><span class="s2">"dweeting"</span><span class="p">,</span><span class="nt">"the"</span><span class="p">:</span><span class="s2">"dweet"</span><span class="p">,</span><span class="nt">"with"</span><span class="p">:{</span><span class="nt">"thing"</span><span class="p">:</span><span class="s2">"ha-sensor"</span><span class="p">,</span><span class="nt">"created"</span><span class="p">:</span><span class="s2">"2015-12-10T09:43:31.133Z"</span><span class="p">,</span><span class="nt">"content"</span><span class="p">:{</span><span class="nt">"temperature"</span><span class="p">:</span><span class="mi">40</span><span class="p">,</span><span class="nt">"humidity"</span><span class="p">:</span><span class="mi">65</span><span class="p">}}}</span><span class="w">
|
|
</span></code></pre>
|
|
</div>
|
|
|
|
<p>The <a href="https://github.com/paddycarey/dweepy">dweepy</a> module gives you another option to work with <a href="https://dweet.io/">Dweet.io</a>.</p>
|
|
|
|
<p>Send a dweet.</p>
|
|
|
|
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>python3
|
|
<span class="gp">>>> </span>import dweepy
|
|
<span class="gp">>>> </span>dweepy.dweet_for<span class="o">(</span><span class="s1">'ha-sensor'</span>, <span class="o">{</span><span class="s1">'temperature'</span>: <span class="s1">'23'</span>, <span class="s1">'humiditiy'</span>:<span class="s1">'81'</span><span class="o">})</span>
|
|
<span class="o">{</span><span class="s1">'thing'</span>: <span class="s1">'ha-sensor'</span>, <span class="s1">'created'</span>: <span class="s1">'2015-12-10T09:46:08.559Z'</span>, <span class="s1">'content'</span>: <span class="o">{</span><span class="s1">'humiditiy'</span>: 81, <span class="s1">'temperature'</span>: 23<span class="o">}}</span>
|
|
</code></pre>
|
|
</div>
|
|
|
|
<p>Recieve the latest dweet.</p>
|
|
|
|
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">>>> </span>dweepy.get_latest_dweet_for<span class="o">(</span><span class="s1">'ha-sensor'</span><span class="o">)</span>
|
|
<span class="o">[{</span><span class="s1">'thing'</span>: <span class="s1">'ha-sensor'', '</span>created<span class="s1">': '</span>2015-12-10T09:43:31.133Z<span class="s1">', '</span>content<span class="s1">': {'</span>humidity<span class="s1">': 65, '</span>temperature<span class="s1">': 40}}]
|
|
</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/sensor.dweet.markdown'>Edit this page on GitHub</a></div>
|
|
<div class='brand-logo-container section'>
|
|
<img src='/images/supported_brands/dweet.png' />
|
|
</div>
|
|
<div class='section'>
|
|
Introduced in release: 0.10
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class='title delta'>Related components</h1>
|
|
<ul class='divided'>
|
|
<li><a href='/components/dweet/'>
|
|
Dweet.io
|
|
</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class="title delta">Category Sensor</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
<a href='/components/sensor.apcupsd/'>APCUPSd Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.bloomsky/'>BloomSky Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.command_line/'>Command line Sensor</a>
|
|
</li>
|
|
<li>
|
|
Dweet.io
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.ecobee/'>Ecobee Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.enocean/'>EnOcean Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.envisalink/'>Envisalink Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.gpsd/'>GPSD</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.http/'>HTTP Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.homematic/'>Homematic Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.imap/'>IMAP Unread E-mail</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.mqtt/'>MQTT Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.modbus/'>Modbus Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.moldindicator/'>Mold Indicator</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.mysensors/'>MySensors Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.nest/'>Nest Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.neurio_energy/'>Neurio</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.octoprint/'>OctoPrint Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.onewire/'>One wire Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.rest/'>RESTful Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.rfxtrx/'>RFXtrx Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.tcp/'>TCP Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.temper/'>TEMPer Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.tellstick/'>TellStick Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.tellduslive/'>Telldus Live sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.template/'>Template Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.thinkingcleaner/'>Thinking Cleaner sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.vera/'>Vera Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.verisure/'>Verisure Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.wink/'>Wink Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.zwave/'>Z-Wave Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.zigbee/'>ZigBee Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.arest/'>aREST Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.mfi/'>mFi Sensor</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> |