281 lines
No EOL
12 KiB
HTML
281 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>Speedtest.net - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="How to integrate Speedtest.net within Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/sensor.speedtest/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Speedtest.net">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/sensor.speedtest/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="How to integrate Speedtest.net 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="Speedtest.net">
|
||
<meta name="twitter:description" content="How to integrate Speedtest.net 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">
|
||
Speedtest.net
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>The <code class="highlighter-rouge">speedtest</code> sensor component uses the <a href="https://speedtest.net/">Speedtest.net</a> web service to measure network bandwidth performance.</p>
|
||
|
||
<p>By default, it will run every hour. The user can change the update frequency in the configuration by defining the minute, hour, and day for a speedtest to run. For the <code class="highlighter-rouge">server_id</code> check the list of <a href="https://www.speedtest.net/speedtest-servers.php">available servers</a>.</p>
|
||
|
||
<p>To add a Speedtest.net sensor to your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||
|
||
<p>Once per hour, on the hour (default):</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">speedtest</span>
|
||
<span class="s">monitored_conditions</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">ping</span>
|
||
<span class="pi">-</span> <span class="s">download</span>
|
||
<span class="pi">-</span> <span class="s">upload</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>monitored_conditions</strong> array (<em>Required</em>): Sensors to display in the frontend.
|
||
<ul>
|
||
<li><strong>ping</strong>: Reaction time in ms of your connection (how fast you get a response after you’ve sent out a request).</li>
|
||
<li><strong>download</strong>: Download speed in Mbps.</li>
|
||
<li><strong>upload</strong>: Upload speed in Mbps.</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>server_id</strong> (<em>Optional</em>): Specify the speedtest server to perform test against.</li>
|
||
<li><strong>minute</strong> (<em>Optional</em>): Specify the minute(s) of the hour to schedule the speedtest. Use a list for multiple entries. Default is 0.</li>
|
||
<li><strong>hour</strong> (<em>Optional</em>): Specify the hour(s) of the day to schedule the speedtest. Use a list for multiple entries. Default is None.</li>
|
||
<li><strong>day</strong> (<em>Optional</em>): Specify the day(s) of the month to schedule the speedtest. Use a list for multiple entries. Default is None.</li>
|
||
<li><strong>manual</strong> (<em>Optional</em>): True or False to turn manual mode on or off. Manual mode will disable scheduled speedtests.</li>
|
||
</ul>
|
||
|
||
<p>This component uses <a href="https://github.com/sivel/speedtest-cli">speedtest-cli</a> to gather network performance data from Speedtest.net. Please be aware of the potential <a href="https://github.com/sivel/speedtest-cli#inconsistency">inconsistencies</a> that this component may display.</p>
|
||
|
||
<p>When Home Assistant first starts up, the values of the speedtest will show as <code class="highlighter-rouge">Unknown</code>. You can use the service <code class="highlighter-rouge">sensor.update_speedtest</code> to run a manual speedtest and populate the data or just wait for the next regularly scheduled test. You can turn on manual mode to disable the scheduled speedtests.</p>
|
||
|
||
<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="run-periodically" href="#run-periodically"></a> Run periodically</h3>
|
||
|
||
<p>Every half hour of every day:</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">speedtest</span>
|
||
<span class="s">minute</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">0</span>
|
||
<span class="pi">-</span> <span class="s">30</span>
|
||
<span class="s">monitored_conditions</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">ping</span>
|
||
<span class="pi">-</span> <span class="s">download</span>
|
||
<span class="pi">-</span> <span class="s">upload</span>
|
||
</code></pre>
|
||
</div>
|
||
|
||
<h3><a class="title-link" name="run-at-a-specific-time" href="#run-at-a-specific-time"></a> Run at a specific time</h3>
|
||
|
||
<p>Everyday at 12:30AM, 6:30AM, 12:30PM, 6:30PM:</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">speedtest</span>
|
||
<span class="s">minute</span><span class="pi">:</span> <span class="s">30</span>
|
||
<span class="s">hour</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">0</span>
|
||
<span class="pi">-</span> <span class="s">6</span>
|
||
<span class="pi">-</span> <span class="s">12</span>
|
||
<span class="pi">-</span> <span class="s">18</span>
|
||
<span class="s">monitored_conditions</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">ping</span>
|
||
<span class="pi">-</span> <span class="s">download</span>
|
||
<span class="pi">-</span> <span class="s">upload</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.speedtest.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/speedtest.png' />
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.13
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category System Monitor</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/sensor.cpuspeed/'>CPU speed</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.cups/'>CUPS Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/binary_sensor.digital_ocean/'>Digital Ocean Binary Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.dovado/'>Dovado</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.fritzbox_callmonitor/'>FRITZ!Box</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.fastdotcom/'>Fast.com</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.glances/'>Glances</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.hddtemp/'>HDDTemp</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.hp_ilo/'>HP ILO</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.netdata/'>Netdata</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.snmp/'>SNMP</a>
|
||
</li>
|
||
<li>
|
||
Speedtest.net
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.supervisord/'>Supervisord</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.systemmonitor/'>System Monitor</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> |