mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-03 00:36:50 +00:00

* 🔥 Removes octopress.js * 🔥 Removes use of root_url var * 🔥 Removes Octopress generator reference from feed * 🔥 Removes delicious support * 🔥 Removes support for Pinboard * 🔥 Removes support for Disqus * 🔥 Removes support for Google Plus * ↩️ Migrate custom after_footer to default template * ↩️ Migrate custom footer to default template * ↩️ Migrate custom header to default template * 🔥 Removes unused template files * 🚀 Places time to read directly in post template * 🚀 Removes unneeded capture from archive_post.html template * 🔥 🚀 Removes unused, but heaving sorting call in component page * 🚀 Merged javascripts into a single file * 🔥 Removes more uses of root_url * 🚀 Removal of unneeded captures from head * 🔥 🚀 Removal of expensive liquid HTML compressor * 🔥 Removes unneeded templates * 🚀 Replaces kramdown with GitHub's CommonMark 🚀 * 💄 Adds Prism code syntax highlighting * ✨ Adds support for redirect in Netlify * ↩️ 🔥 Let Netlify handle all developer doc redirects * ✏️ Fixes typo in redirects file: Netify -> Netlify * 🔥 Removes unused .themes folder * 🔥 Removes unused aside.html template * 🔥 Removes Disqus config leftover * 🔥 Removes rouge highlighter config * 🔥 Removes Octopress 🎉 * 💄 Adjust code block font size and adds soft wraps * 💄 Adds styling for inline code blocks * 💄 Improve styling of note/warning/info boxes + div support * 🔨 Rewrites all note/warning/info boxes
82 lines
2.2 KiB
Markdown
82 lines
2.2 KiB
Markdown
---
|
|
title: "Fast.com"
|
|
description: "How to integrate Fast.com within Home Assistant."
|
|
logo: fastdotcom.png
|
|
ha_category:
|
|
- System Monitor
|
|
- Sensor
|
|
ha_release: 0.88
|
|
ha_iot_class: Cloud Polling
|
|
redirect_from:
|
|
- /components/sensor.fastdotcom/
|
|
---
|
|
|
|
The `fastdotcom` integration uses the [Fast.com](https://fast.com/) web service to measure network bandwidth performance.
|
|
|
|
<div 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 [speedtest](/components/sensor.speedtest) component.
|
|
|
|
</div>
|
|
|
|
Enabling this integration will automatically create the Fast.com Sensor.
|
|
|
|
By default, a speed test will be run every hour. The user can change the update frequency in the configuration by defining the `scan_interval` for a speed test to run.
|
|
|
|
## Configuration
|
|
|
|
To add Fast.com to your installation, add the following to your `configuration.yaml` file:
|
|
|
|
Once per hour, on the hour (default):
|
|
|
|
```yaml
|
|
fastdotcom:
|
|
```
|
|
|
|
Every half hour of every day:
|
|
|
|
```yaml
|
|
fastdotcom:
|
|
scan_interval:
|
|
minutes: 30
|
|
```
|
|
|
|
{% configuration %}
|
|
scan_interval:
|
|
description: "Minimum time interval between updates. Supported formats: `scan_interval: 'HH:MM:SS'`, `scan_interval: 'HH:MM'` and Time period dictionary (see example below)."
|
|
required: false
|
|
default: 60 minutes
|
|
type: time
|
|
manual:
|
|
description: Turn manual mode on or off. Manual mode will disable scheduled speedtests.
|
|
required: false
|
|
default: false
|
|
type: boolean
|
|
{% endconfiguration %}
|
|
|
|
#### Time period dictionary example
|
|
|
|
```yaml
|
|
scan_interval:
|
|
# At least one of these must be specified:
|
|
days: 0
|
|
hours: 0
|
|
minutes: 3
|
|
seconds: 30
|
|
milliseconds: 0
|
|
```
|
|
|
|
### Service
|
|
|
|
Once loaded, the `fastdotcom` integration will expose a service (`fastdotcom.speedtest`) that can be called to run a Fast.com speed test on demand. This service takes no parameters. This can be useful if you have enabled manual mode.
|
|
|
|
```yaml
|
|
action:
|
|
service: fastdotcom.speedtest
|
|
```
|
|
|
|
## Notes
|
|
|
|
- When running on Raspberry Pi, the maximum speed is limited by its 100 Mbit/s LAN adapter.
|
|
- The sensor will return the maximum measured speed during a 15-second test.
|