Site updated at 2017-05-11 17:08:54 UTC

This commit is contained in:
Travis CI 2017-05-11 17:08:54 +00:00
parent d79557e7c5
commit 92f9d1f463
25 changed files with 53 additions and 44 deletions

View file

@ -70,20 +70,29 @@
<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>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">dweet</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>
</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>name</strong> (<em>Optional</em>): Let you overwrite the the name of the device in the frontend.</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="full-configuration-sample" href="#full-configuration-sample"></a> Full configuration sample</h3>
<p>A ful configuration entry could look like the sample below.</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="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">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>
<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