home-assistant.github.io/components/sensor.bitcoin/index.html
2016-01-16 19:31:32 +00:00

329 lines
No EOL
13 KiB
HTML
Raw 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>Bitcoin - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions how to integrate Bitcoin data within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.bitcoin/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Bitcoin">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.bitcoin/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Bitcoin data within 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="@home_assistant">
<meta name="twitter:title" content="Bitcoin">
<meta name="twitter:description" content="Instructions how to integrate Bitcoin data within 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'>
<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>
<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='/getting-started/templating/'>Templating</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">
Bitcoin
</h1>
</header>
<hr class="divider">
<p>The bitcoin platform displays various details about the <a href="https://bitcoin.org">Bitcoin</a> network.</p>
<p>If you have an online wallet from <a href="https://blockchain.info/">Blockchain.info</a> the sensor is capable to show your current balance.</p>
<p>You need to enable the API access for your online wallet to get the balance. To do that log in and move to Account Setting, choose IP Restrictions, and check Enable Api Access. You will get an email message from blockchain.info where you must authorize the API access.</p>
<p>To add the Bitcoin sensor to your installation, add a selection of the available display options 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">sensor</span>:
<span class="key">platform</span>: <span class="string"><span class="content">bitcoin</span></span>
<span class="key">wallet</span>: <span class="string"><span class="content">'YOUR WALLET_ID'</span></span>
<span class="key">password</span>: <span class="string"><span class="content">YOUR_ACCOUNT_PASSWORD</span></span>
<span class="key">currency</span>: <span class="string"><span class="content">YOUR CURRENCY</span></span>
<span class="key">display_options</span>:
- <span class="string"><span class="content">exchangerate</span></span>
- <span class="string"><span class="content">trade_volume_btc</span></span>
- <span class="string"><span class="content">miners_revenue_usd</span></span>
- <span class="string"><span class="content">btc_mined</span></span>
- <span class="string"><span class="content">trade_volume_usd</span></span>
- <span class="string"><span class="content">difficulty</span></span>
- <span class="string"><span class="content">minutes_between_blocks</span></span>
- <span class="string"><span class="content">number_of_transactions</span></span>
- <span class="string"><span class="content">hash_rate</span></span>
- <span class="string"><span class="content">timestamp</span></span>
- <span class="string"><span class="content">mined_blocks</span></span>
- <span class="string"><span class="content">blocks_size</span></span>
- <span class="string"><span class="content">total_fees_btc</span></span>
- <span class="string"><span class="content">total_btc_sent</span></span>
- <span class="string"><span class="content">estimated_btc_sent</span></span>
- <span class="string"><span class="content">total_btc</span></span>
- <span class="string"><span class="content">total_blocks</span></span>
- <span class="string"><span class="content">next_retarget</span></span>
- <span class="string"><span class="content">estimated_transaction_volume_usd</span></span>
- <span class="string"><span class="content">miners_revenue_btc</span></span>
- <span class="string"><span class="content">market_price_usd</span></span>
</pre></div>
</div>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>wallet</strong> (<em>Optional</em>): This is your wallet identifier from https://blockchain.info to access the online wallet.</li>
<li><strong>password</strong> (<em>Optional</em>): Password for your online wallet.</li>
<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>
</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/bitcoin.png' />
</div>
<div class='section'>
<h1 class="title delta">Category Sensor</h1>
<ul class='divided'>
<li>
Bitcoin
</li>
<li>
<a href='/components/sensor.cpuspeed/'>CPU speed</a>
</li>
<li>
<a href='/components/sensor.command_sensor/'>Command line sensor</a>
</li>
<li>
<a href='/components/sensor.dweet/'>Dweet.io</a>
</li>
<li>
<a href='/components/sensor.ecobee/'>Ecobee sensor</a>
</li>
<li>
<a href='/components/sensor.efergy/'>Efergy</a>
</li>
<li>
<a href='/components/sensor.eliqonline/'>Eliqonline</a>
</li>
<li>
<a href='/components/sensor.glances/'>Glances</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.mysensors/'>MySensors sensor</a>
</li>
<li>
<a href='/components/sensor.nest/'>Nest thermostat</a>
</li>
<li>
<a href='/components/sensor.netatmo/'>Netatmo</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.sabnzbd/'>SABnzbd</a>
</li>
<li>
<a href='/components/sensor.swiss_public_transport/'>Swiss Public Transport</a>
</li>
<li>
<a href='/components/sensor.systemmonitor/'>System Monitor</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.time_date/'>Time & Date</a>
</li>
<li>
<a href='/components/sensor.torque/'>Torque (OBD2)</a>
</li>
<li>
<a href='/components/sensor.transmission/'>Transmission sensor</a>
</li>
<li>
<a href='/components/sensor.twitch/'>Twitch</a>
</li>
<li>
<a href='/components/sensor.vera/'>Vera sensor</a>
</li>
<li>
<a href='/components/sensor.wink/'>Wink sensor</a>
</li>
<li>
<a href='/components/sensor.worldclock/'>Worldclock</a>
</li>
<li>
<a href='/components/sensor.zwave/'>Z-Wave sensor</a>
</li>
<li>
<a href='/components/sensor.arest/'>aREST 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://github.com/balloob/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
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>
<!--[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>