271 lines
12 KiB
HTML
271 lines
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>Fast.com - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="How to integrate Fast.com within Home Assistant.">
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/sensor.fastdotcom/">
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Fast.com">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/sensor.fastdotcom/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="How to integrate Fast.com 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="Fast.com">
|
|
<meta name="twitter:description" content="How to integrate Fast.com within Home Assistant.">
|
|
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
|
<link href="/stylesheets/screen.css" media="screen, projection, print" 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 class='site-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="/docs/">Docs</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>
|
|
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
|
</ul>
|
|
</nav>
|
|
<div class='search-container' style='display: none'>
|
|
<div class='search'>
|
|
<i class="icon-search"></i>
|
|
<input id='search' placeholder='Search the docs…'>
|
|
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
|
</div>
|
|
</div>
|
|
</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">
|
|
Fast.com
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
<p>The <code class="highlighter-rouge">fastdotcom</code> sensor component uses the <a href="https://fast.com/">Fast.com</a> web service to measure network bandwidth performance.</p>
|
|
<p class="note">
|
|
Currently fast.com only supports measuring download bandwidth. If you want to measure bandwidth metrics other then download such as ping and upload, utilize the <a href="/components/sensor.speedtest">speedtest</a> component.
|
|
</p>
|
|
<p>By default, it will run every hour. The user can change the update frequency in the config by defining the minute, hour, and day for a speedtest to run.</p>
|
|
<p>To add a Fast.com 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="s">sensor</span><span class="pi">:</span>
|
|
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">fastdotcom</span>
|
|
</code></pre>
|
|
</div>
|
|
<p>More examples:</p>
|
|
<p>Every half hour of every day:</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">fastdotcom</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>
|
|
</code></pre>
|
|
</div>
|
|
<p>Configuration variables:</p>
|
|
<ul>
|
|
<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>There is also a service named <code class="highlighter-rouge">sensor.update_fastdotcom</code> that you can use to run a fast.com speedtest on demand. You can turn on manual mode to disable the scheduled speedtests.</p>
|
|
</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.fastdotcom.markdown'>Edit this page on GitHub</a></div>
|
|
<div class='brand-logo-container section'>
|
|
<img src='/images/supported_brands/fastdotcom.png' />
|
|
</div>
|
|
<div class='section'>
|
|
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Cloud Polling
|
|
</div>
|
|
<div class='section'>
|
|
Introduced in release: 0.26
|
|
</div>
|
|
<div class='section'>
|
|
Source:
|
|
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/sensor/fastdotcom.py'>sensor/fastdotcom.py</a>
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class="title delta">Category System Monitor</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
<a href='/components/binary_sensor.apcupsd/'>APCUPSd Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.apcupsd/'>APCUPSd Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.cpuspeed/'>CPU speed</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.cups/'>CUPS Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.cert_expiry/'>Certificate Expiry</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 Call Monitor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.fritzbox_netmonitor/'>FRITZ!Box Net Monitor</a>
|
|
</li>
|
|
<li>
|
|
Fast.com
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.glances/'>Glances</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.google_wifi/'>Google Wifi</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/binary_sensor.linode/'>Linode Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.linux_battery/'>Linux Battery</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.nut/'>NUT Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.netdata/'>Netdata</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.openhardwaremonitor/'>Open Hardware Monitor Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.pi_hole/'>Pi-Hole Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.snmp/'>SNMP</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.speedtest/'>Speedtest.net</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.supervisord/'>Supervisord</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.synologydsm/'>SynologyDSM Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.systemmonitor/'>System Monitor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.upcloud/'>UpCloud Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/binary_sensor.vultr/'>Vultr Binary Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.vultr/'>Vultr Sensor</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/zabbix/'>Zabbix</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/sensor.zabbix/'>Zabbix 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://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> (no support!).<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>
|
|
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
|
</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>
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
|
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
|
<script type="text/javascript">
|
|
docsearch({
|
|
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
|
indexName: 'home-assistant',
|
|
inputSelector: '#search',
|
|
debug: false // Set debug to true if you want to inspect the dropdown
|
|
});
|
|
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
|
ev.preventDefault();
|
|
document.querySelector('.search-container').style.display = 'none';
|
|
});
|
|
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
|
ev.preventDefault();
|
|
document.querySelector('.search-container').style.display = 'block';
|
|
document.getElementById('toggle').checked = false;
|
|
document.querySelector('.search-container input').focus();
|
|
});
|
|
</script>
|
|
</body>
|
|
</html>
|