-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Split out fastdotcom into a sensor and component #8377
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
aa2550b
Split out fastdotcom into a sensor and component
rohankapoorcom 2b31fd8
Correct copy/paste error
rohankapoorcom c695025
Update ha_category
klaasnicolaas 3efa2f1
Consolidate the fastdotcom sensor page back into the component
rohankapoorcom 411de83
:pencil2: Tweaks
frenck File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| --- | ||
| layout: page | ||
| title: "Fast.com" | ||
| description: "How to integrate Fast.com within Home Assistant." | ||
| date: 2019-02-01 21:30 | ||
| sidebar: true | ||
| comments: false | ||
| sharing: true | ||
| footer: true | ||
| logo: fastdotcom.png | ||
| ha_category: | ||
| - System Monitor | ||
| - Sensor | ||
| featured: false | ||
| ha_release: 0.88 | ||
| ha_iot_class: "Cloud Polling" | ||
| redirect_form: | ||
| - /components/sensor.fastdotcom/ | ||
| --- | ||
|
|
||
| The `fastdotcom` component uses the [Fast.com](https://fast.com/) web service to measure network bandwidth performance. | ||
|
|
||
| <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 [speedtest](/components/sensor.speedtest) component. | ||
| </p> | ||
|
|
||
| Enabling this component 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 `update_interval` for a speed test to run. | ||
|
|
||
| ## {% linkable_title 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: | ||
| update_interval: | ||
| minutes: 30 | ||
| ``` | ||
|
|
||
| {% configuration %} | ||
| update_interval: | ||
| description: "Minimum time interval between updates. Supported formats: `update_interval: 'HH:MM:SS'`, `update_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 %} | ||
|
|
||
| #### {% linkable_title Time period dictionary example %} | ||
|
|
||
| ```yaml | ||
| update_interval: | ||
| # At least one of these must be specified: | ||
| days: 0 | ||
| hours: 0 | ||
| minutes: 3 | ||
| seconds: 30 | ||
| milliseconds: 0 | ||
| ``` | ||
|
|
||
| ### {% linkable_title Service %} | ||
|
|
||
| Once loaded, the `fastdotcom` component 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 | ||
| ``` | ||
|
|
||
| ## {% linkable_title 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. | ||
This file was deleted.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.