Re-adding docs for Fast.com (#28654)

* Re-adding docs for Fast.com

* Update source/_integrations/fastdotcom.markdown

Co-authored-by: G Johansson <goran.johansson@shiftit.se>

* Tweak

---------

Co-authored-by: G Johansson <goran.johansson@shiftit.se>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Erwin Douna 2023-11-22 12:33:05 +01:00 committed by GitHub
parent ea78104444
commit cf4ff409f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -6,8 +6,10 @@ ha_category:
- System Monitor
ha_release: 0.88
ha_iot_class: Cloud Polling
ha_config_flow: true
ha_codeowners:
- '@rohankapoorcom'
- '@erwindouna'
ha_domain: fastdotcom
ha_platforms:
- sensor
@ -25,62 +27,12 @@ If you want to measure bandwidth metrics other then download such as ping and up
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.
By default, a speed test will be run every hour. The user can manually run a speed test via the `homeassistant.update_entity` service.
## 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
```
{% include integrations/config_flow.md %}
## Notes
- When running on Raspberry Pi 3 or older, 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.
- Speed tests consume data depending on your internet speed, make sure to consider this if your internet connection has limited bandwidth.
- Speed tests consume data depending on your internet speed. Make sure to consider this if your internet connection has limited bandwidth.