jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2017-11-16 20:15:43 UTC

Browse source
This commit is contained in:
Travis CI 2017-11-16 20:15:43 +00:00
parent b56b1fd97c
commit b18af64131
34 changed files with 295 additions and 136 deletions
Download patch file Download diff file Expand all files Collapse all files

131
components/sensor.bitcoin/index.html
View file

@ -84,35 +84,108 @@
<span class="pi">-</span> <span class="s">trade_volume_btc</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>currency</strong> (<em>Optional</em>): The currency to exchange to, eg. CHF, USD, EUR, etc. Default is USD.</li>
<li><strong>display_options</strong> array (<em>Required</em>): Options to display in the frontend.
<ul>
<li><strong>exchangerate</strong>: Exchange rate of 1 BTC</li>
<li><strong>trade_volume_btc</strong>: Trade volume</li>
<li><strong>miners_revenue_usd</strong>: Miners revenue</li>
<li><strong>btc_mined</strong>: BTC mined</li>
<li><strong>trade_volume_usd</strong>: Trade volume in USD</li>
<li><strong>difficulty</strong>: Difficulty</li>
<li><strong>minutes_between_blocks</strong>: Time between blocks in minutes</li>
<li><strong>number_of_transactions</strong>: Number of transactions</li>
<li><strong>hash_rate</strong>: Hash rate in PH/s</li>
<li><strong>timestamp</strong>: Timestamp</li>
<li><strong>mined_blocks</strong>: Minded Blocks</li>
<li><strong>blocks_size</strong>: Block size</li>
<li><strong>total_fees_btc</strong>: Total fees in BTC</li>
<li><strong>total_btc_sent</strong>: Total sent in BTC</li>
<li><strong>estimated_btc_sent</strong>: Estimated sent in BTC</li>
<li><strong>total_btc</strong>: Total of BTC</li>
<li><strong>total_blocks</strong>: Total Blocks</li>
<li><strong>next_retarget</strong>: Next retarget</li>
<li><strong>estimated_transaction_volume_usd</strong>: Estimated transaction volume in BTC</li>
<li><strong>miners_revenue_btc</strong>: Miners revenue in BTC</li>
<li><strong>market_price_usd</strong>: Market price in USD</li>
</ul>
</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="currency" href="#currency"></a> currency</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The currency to exchange to, eg. CHF, USD, EUR, etc.</span></p>
<p class="default">Default value: USD</p>
</dd>
<dt><a class="title-link" name="display_options" href="#display_options"></a> display_options</dt>
<dd>
<p class="desc"><span class="type">(<span class="map">map</span>)</span><span class="required">(Required)</span><span class="description">Options to display in the frontend.</span></p>
</dd>
<dd>
<dl class="nested">
<dt><a class="title-link" name="exchangerate" href="#exchangerate"></a> exchangerate</dt>
<dd>
<p class="desc"><span class="description">Exchange rate of 1 BTC</span></p>
</dd>
<dt><a class="title-link" name="trade_volume_btc" href="#trade_volume_btc"></a> trade_volume_btc</dt>
<dd>
<p class="desc"><span class="description">Trade volume</span></p>
</dd>
<dt><a class="title-link" name="miners_revenue_usd" href="#miners_revenue_usd"></a> miners_revenue_usd</dt>
<dd>
<p class="desc"><span class="description">Miners revenue</span></p>
</dd>
<dt><a class="title-link" name="btc_mined" href="#btc_mined"></a> btc_mined</dt>
<dd>
<p class="desc"><span class="description">BTC mined</span></p>
</dd>
<dt><a class="title-link" name="trade_volume_usd" href="#trade_volume_usd"></a> trade_volume_usd</dt>
<dd>
<p class="desc"><span class="description">Trade volume in USD</span></p>
</dd>
<dt><a class="title-link" name="difficulty" href="#difficulty"></a> difficulty</dt>
<dd>
<p class="desc"><span class="description">Difficulty</span></p>
</dd>
<dt><a class="title-link" name="minutes_between_blocks" href="#minutes_between_blocks"></a> minutes_between_blocks</dt>
<dd>
<p class="desc"><span class="description">Time between blocks in minutes</span></p>
</dd>
<dt><a class="title-link" name="number_of_transactions" href="#number_of_transactions"></a> number_of_transactions</dt>
<dd>
<p class="desc"><span class="description">Number of transactions</span></p>
</dd>
<dt><a class="title-link" name="hash_rate" href="#hash_rate"></a> hash_rate</dt>
<dd>
<p class="desc"><span class="description">Hash rate in PH/s</span></p>
</dd>
<dt><a class="title-link" name="timestamp" href="#timestamp"></a> timestamp</dt>
<dd>
<p class="desc"><span class="description">Timestamp</span></p>
</dd>
<dt><a class="title-link" name="mined_blocks" href="#mined_blocks"></a> mined_blocks</dt>
<dd>
<p class="desc"><span class="description">Minded Blocks</span></p>
</dd>
<dt><a class="title-link" name="blocks_size" href="#blocks_size"></a> blocks_size</dt>
<dd>
<p class="desc"><span class="description">Block size</span></p>
</dd>
<dt><a class="title-link" name="total_fees_btc" href="#total_fees_btc"></a> total_fees_btc</dt>
<dd>
<p class="desc"><span class="description">Total fees in BTC</span></p>
</dd>
<dt><a class="title-link" name="total_btc_sent" href="#total_btc_sent"></a> total_btc_sent</dt>
<dd>
<p class="desc"><span class="description">Total sent in BTC</span></p>
</dd>
<dt><a class="title-link" name="estimated_btc_sent" href="#estimated_btc_sent"></a> estimated_btc_sent</dt>
<dd>
<p class="desc"><span class="description">Estimated sent in BTC</span></p>
</dd>
<dt><a class="title-link" name="total_btc" href="#total_btc"></a> total_btc</dt>
<dd>
<p class="desc"><span class="description">Total of BTC</span></p>
</dd>
<dt><a class="title-link" name="total_blocks" href="#total_blocks"></a> total_blocks</dt>
<dd>
<p class="desc"><span class="description">Total Blocks</span></p>
</dd>
<dt><a class="title-link" name="next_retarget" href="#next_retarget"></a> next_retarget</dt>
<dd>
<p class="desc"><span class="description">Next retarget</span></p>
</dd>
<dt><a class="title-link" name="estimated_transaction_volume_usd" href="#estimated_transaction_volume_usd"></a> estimated_transaction_volume_usd</dt>
<dd>
<p class="desc"><span class="description">Estimated transaction volume in BTC</span></p>
</dd>
<dt><a class="title-link" name="miners_revenue_btc" href="#miners_revenue_btc"></a> miners_revenue_btc</dt>
<dd>
<p class="desc"><span class="description">Miners revenue in BTC</span></p>
</dd>
<dt><a class="title-link" name="market_price_usd" href="#market_price_usd"></a> market_price_usd</dt>
<dd>
<p class="desc"><span class="description">Market price in USD</span></p>
</dd>
</dl>
</dd>
</dl>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

13
components/sensor.blockchain/index.html
View file

@ -84,10 +84,15 @@
<span class="pi">-</span> <span class="s1">'</span><span class="s">183J5pXWqYYsxZ7inTVw9tEpejDXyMFroe'</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>addresses</strong> (<em>Required</em>): List of bitcoin wallet addresses to watch.</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="addresses" href="#addresses"></a> addresses</dt>
<dd>
<p class="desc"><span class="type">(<span class="string, list">string | list</span>)</span><span class="required">(Required)</span><span class="description">List of bitcoin wallet addresses to watch.</span></p>
</dd>
</dl>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

21
components/sensor.coinmarketcap/index.html
View file

@ -81,11 +81,22 @@
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">coinmarketcap</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>currency</strong> (<em>Optional</em>): The cryptocurrency to use, eg. <code class="highlighter-rouge">bitcoin</code>, <code class="highlighter-rouge">litecoin</code>, <code class="highlighter-rouge">steem</code>, etc. Default is <code class="highlighter-rouge">bitcoin</code>.</li>
<li><strong>display_currency</strong> (<em>Optional</em>): The currency to display, eg. <code class="highlighter-rouge">USD</code>, <code class="highlighter-rouge">EUR</code>, <code class="highlighter-rouge">GBP</code>, etc. Default is <code class="highlighter-rouge">USD</code>. All supported currencies can be found <a href="https://coinmarketcap.com/api/">here</a>.</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="currency" href="#currency"></a> currency</dt>
<dd>
<p class="desc"><span class="type">(<span class="string, list">string | list</span>)</span><span class="required">(Optional)</span><span class="description">The cryptocurrency to use.</span></p>
<p class="default">Default value: Bitcoin</p>
</dd>
<dt><a class="title-link" name="display_currency" href="#display_currency"></a> display_currency</dt>
<dd>
<p class="desc"><span class="type">(<span class="string, list">string | list</span>)</span><span class="required">(Optional)</span><span class="description">The currency to display.</span></p>
<p class="default">Default value: USD</p>
</dd>
</dl>
</div>
<p>All supported currencies can be found <a href="https://coinmarketcap.com/api/">here</a>.</p>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

25
components/sensor.currencylayer/index.html
View file

@ -87,12 +87,25 @@
<span class="pi">-</span> <span class="s">INR</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>api_key</strong> (<em>Required</em>): API Key from <a href="https://currencylayer.com/">Currencylayer</a>.</li>
<li><strong>base</strong> (<em>Optional</em>): The symbol of the base currency. Defaults to USD.</li>
<li><strong>quote</strong> (<em>Required</em>): The symbol(s) of the quote or target currencies.</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="api_key" href="#api_key"></a> api_key</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">The API Key from <a href="https://currencylayer.com/">Currencylayer</a>.</span></p>
</dd>
<dt><a class="title-link" name="quote" href="#quote"></a> quote</dt>
<dd>
<p class="desc"><span class="type">(<span class="string, list">string | list</span>)</span><span class="required">(Optional)</span><span class="description">The symbol(s) of the quote or target currencies.</span></p>
<p class="default">Default value: Exchange rate</p>
</dd>
<dt><a class="title-link" name="base" href="#base"></a> base</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The symbol of the base currency.</span></p>
<p class="default">Default value: USD</p>
</dd>
</dl>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

19
components/sensor.etherscan/index.html
View file

@ -82,11 +82,20 @@
<span class="s">address</span><span class="pi">:</span> <span class="s1">'</span><span class="s">0xfB6916095ca1df60bB79Ce92cE3Ea74c37c5d359'</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>address</strong> (<em>Required</em>): Ethereum wallet address to watch.</li>
<li><strong>name</strong> (<em>Optional</em>): The name of the sensor used in the frontend.</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="address" href="#address"></a> address</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">Ethereum wallet address to watch.</span></p>
</dd>
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The name of the sensor used in the frontend.</span></p>
<p class="default">Default value: Ethereum Balance</p>
</dd>
</dl>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

25
components/sensor.fixer/index.html
View file

@ -83,12 +83,25 @@
<span class="s">target</span><span class="pi">:</span> <span class="s">CHF</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>target</strong> (<em>Required</em>): The symbol of the target currency.</li>
<li><strong>name</strong> (<em>Optional</em>): Name to use in the frontend.</li>
<li><strong>base</strong> (<em>Optional</em>): The symbol of the base currency. Default to USD</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="target" href="#target"></a> target</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">The symbol of the target currency.</span></p>
</dd>
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Name to use in the frontend.</span></p>
<p class="default">Default value: Exchange rate</p>
</dd>
<dt><a class="title-link" name="base" href="#base"></a> base</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The symbol of the base currency.</span></p>
<p class="default">Default value: USD</p>
</dd>
</dl>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

30
components/sensor.openexchangerates/index.html
View file

@ -84,13 +84,29 @@
<span class="s">quote</span><span class="pi">:</span> <span class="s">EUR</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>api_key</strong> (<em>Required</em>): API Key for <a href="https://openexchangerates.org">Open Exchange Rates</a>.</li>
<li><strong>quote</strong> (<em>Required</em>): The symbol of the quote or target currency.</li>
<li><strong>name</strong> (<em>Optional</em>): Name to use in the frontend.</li>
<li><strong>base</strong> (<em>Optional</em>): The symbol of the base currency. Defaults to USD.</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The name of the sensor.</span></p>
<p class="default">Default value: Exchange Rate Sensor</p>
</dd>
<dt><a class="title-link" name="api_key" href="#api_key"></a> api_key</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">The API Key for <a href="https://openexchangerates.org">Open Exchange Rates</a>.</span></p>
</dd>
<dt><a class="title-link" name="quote" href="#quote"></a> quote</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">The symbol of the quote or target currency.</span></p>
</dd>
<dt><a class="title-link" name="base" href="#base"></a> base</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The symbol of the base currency.</span></p>
<p class="default">Default value: USD</p>
</dd>
</dl>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

19
components/sensor.ripple/index.html
View file

@ -82,11 +82,20 @@
<span class="s">address</span><span class="pi">:</span> <span class="s1">'</span><span class="s">r3kmLJN5D28dHuH8vZNUZpMC43pEHpaocV'</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>address</strong> (<em>Required</em>): Ripple wallet address to watch</li>
<li><strong>name</strong> (<em>Optional</em>): Name for the sensor to use in the frontend.</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="address" href="#address"></a> address</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">Ripple wallet address to watch.</span></p>
</dd>
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Name for the sensor to use in the frontend.</span></p>
<p class="default">Default value: Ripple Balance</p>
</dd>
</dl>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">

20
components/sensor.yahoo_finance/index.html
View file

@ -81,11 +81,21 @@
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">yahoo_finance</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>name</strong> (<em>Optional</em>): The name of the sensor. If not specified, it defaults to <em>Yahoo Stock</em>.</li>
<li><strong>symbols</strong> array (<em>Optional</em>): List of stock market symbols for given companies. If not specified, it defaults to <em>Yahoo (YHOO)</em>.</li>
</ul>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">The name of the sensor.</span></p>
<p class="default">Default value: Yahoo Stock</p>
</dd>
<dt><a class="title-link" name="symbols" href="#symbols"></a> symbols</dt>
<dd>
<p class="desc"><span class="type">(<span class="string, list">string | list</span>)</span><span class="required">(Optional)</span><span class="description">List of stock market symbols for given companies.</span></p>
<p class="default">Default value: YHOO</p>
</dd>
</dl>
</div>
<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="red-hat-and-google" href="#red-hat-and-google"></a> Red Hat and Google</h3>