229 lines
No EOL
12 KiB
HTML
229 lines
No EOL
12 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>PVOutput Sensor - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to use PVOutput within Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/sensor.pvoutput/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="PVOutput Sensor">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/sensor.pvoutput/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to use PVOutput 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="PVOutput Sensor">
|
||
<meta name="twitter:description" content="Instructions how to use PVOutput 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="/ecosystem/">Ecosystem</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">
|
||
PVOutput Sensor
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>The <code class="highlighter-rouge">pvoutput</code> sensor platform consumes informations from <a href="http://pvoutput.org/">PVOutput</a> which were uploaded by your solar photovoltaic (PV) system.</p>
|
||
|
||
<p>To add PVOutput details to 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="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">pvoutput</span>
|
||
<span class="s">system_id</span><span class="pi">:</span> <span class="s">YOUR_SYSTEM_ID</span>
|
||
<span class="s">api_key</span><span class="pi">:</span> <span class="s">YOUR_API_KEY</span>
|
||
<span class="s">scan_interval</span><span class="pi">:</span> <span class="s">120</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>api_key</strong> (<em>Required</em>): Your API key. A read-only key is fine.</li>
|
||
<li><strong>system_id</strong> (<em>Required</em>): The ID of your station.</li>
|
||
</ul>
|
||
|
||
<p class="note warning">
|
||
It’s recommended to set <code class="highlighter-rouge">scan_interval:</code> according to a value greater than 60 seconds. The service only allows 60 requests per hour but the sensor’s default is 30 seconds.
|
||
</p>
|
||
|
||
<p>To format the PVoutput sensor it’s recommended to use the <a href="/topics/templating/">template component</a>. For example:</p>
|
||
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><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">pvoutput</span>
|
||
<span class="s">system_id</span><span class="pi">:</span> <span class="s">YOUR_SYSTEM_ID</span>
|
||
<span class="s">api_key</span><span class="pi">:</span> <span class="s">YOUR_API_KEY</span>
|
||
<span class="s">scan_interval</span><span class="pi">:</span> <span class="s">150</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">template</span>
|
||
<span class="s">sensors</span><span class="pi">:</span>
|
||
<span class="s">power_consumption</span><span class="pi">:</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">if</span><span class="nv"> </span><span class="s">is_state_attr("sensor.pvoutput",</span><span class="nv"> </span><span class="s">"power_consumption",</span><span class="nv"> </span><span class="s">"NaN")</span><span class="nv"> </span><span class="s">%}0{%</span><span class="nv"> </span><span class="s">else</span><span class="nv"> </span><span class="s">%}{{</span><span class="nv"> </span><span class="s">states.sensor.pvoutput.attributes.power_consumption</span><span class="nv"> </span><span class="s">}}{%</span><span class="nv"> </span><span class="s">endif</span><span class="nv"> </span><span class="s">%}'</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Using'</span>
|
||
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Watt'</span>
|
||
<span class="s">energy_consumption</span><span class="pi">:</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">"%0.1f"|format(states.sensor.pvoutput.attributes.energy_consumption|float/1000)</span><span class="nv"> </span><span class="s">}}'</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Used'</span>
|
||
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s1">'</span><span class="s">kWh'</span>
|
||
<span class="s">power_generation</span><span class="pi">:</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">if</span><span class="nv"> </span><span class="s">is_state_attr("sensor.pvoutput",</span><span class="nv"> </span><span class="s">"power_generation",</span><span class="nv"> </span><span class="s">"NaN")</span><span class="nv"> </span><span class="s">%}0{%</span><span class="nv"> </span><span class="s">else</span><span class="nv"> </span><span class="s">%}{{</span><span class="nv"> </span><span class="s">states.sensor.pvoutput.attributes.power_generation</span><span class="nv"> </span><span class="s">}}{%</span><span class="nv"> </span><span class="s">endif</span><span class="nv"> </span><span class="s">%}'</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Generating'</span>
|
||
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Watt'</span>
|
||
<span class="s">energy_generation</span><span class="pi">:</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">if</span><span class="nv"> </span><span class="s">is_state_attr("sensor.pvoutput",</span><span class="nv"> </span><span class="s">"energy_generation",</span><span class="nv"> </span><span class="s">"NaN")</span><span class="nv"> </span><span class="s">%}0{%</span><span class="nv"> </span><span class="s">else</span><span class="nv"> </span><span class="s">%}{{</span><span class="nv"> </span><span class="s">"%0.2f"|format(states.sensor.pvoutput.attributes.energy_generation|float/1000)</span><span class="nv"> </span><span class="s">}}{%</span><span class="nv"> </span><span class="s">endif</span><span class="nv"> </span><span class="s">%}'</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Generated'</span>
|
||
<span class="s">unit_of_measurement</span><span class="pi">:</span> <span class="s1">'</span><span class="s">kWh'</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.pvoutput.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/pvoutput.png' />
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.33
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Energy</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/sensor.dsmr/'>DSMR/Slimme meter</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.dte_energy_bridge/'>DTE Energy Bridge</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.loop_energy/'>Loop Energy</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.neurio_energy/'>Neurio</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.ohmconnect/'>OhmConnect</a>
|
||
</li>
|
||
<li>
|
||
PVOutput Sensor
|
||
</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> |