mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-21 00:06:51 +00:00
add docs for speedtest component
This commit is contained in:
parent
813ae55aff
commit
9fb0fa4809
73
source/_components/sensor.speedtest.markdown
Normal file
73
source/_components/sensor.speedtest.markdown
Normal file
@ -0,0 +1,73 @@
|
|||||||
|
---
|
||||||
|
layout: page
|
||||||
|
title: "Speedtest.net"
|
||||||
|
description: "How to integrate Speedtest.net within Home Assistant."
|
||||||
|
date: 2016-02-12 9:06
|
||||||
|
sidebar: true
|
||||||
|
comments: false
|
||||||
|
sharing: true
|
||||||
|
footer: true
|
||||||
|
logo: speedtest.png
|
||||||
|
ha_category: Sensor
|
||||||
|
featured: false
|
||||||
|
---
|
||||||
|
|
||||||
|
The `speedtest` sensor component uses the [Speedtest.net](https://speedtest.net/) web service to measure network bandwidth performance.
|
||||||
|
|
||||||
|
By default, it will run every hour on the hour. The user can change the update frequency in the config by defining the minute, hour, and day for speedtest to run.
|
||||||
|
|
||||||
|
To add speedtest.net sensors to your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
|
Once per hour, on the hour (default):
|
||||||
|
```yaml
|
||||||
|
sensor:
|
||||||
|
platform: speedtest
|
||||||
|
monitored_conditions:
|
||||||
|
- ping
|
||||||
|
- download
|
||||||
|
- upload
|
||||||
|
```
|
||||||
|
|
||||||
|
More examples:
|
||||||
|
|
||||||
|
Every half hour of every day:
|
||||||
|
```yaml
|
||||||
|
sensor:
|
||||||
|
platform: speedtest
|
||||||
|
minute:
|
||||||
|
- 0
|
||||||
|
- 30
|
||||||
|
monitored_conditions:
|
||||||
|
- ping
|
||||||
|
- download
|
||||||
|
- upload
|
||||||
|
```
|
||||||
|
|
||||||
|
Everyday at 12:30AM, 6:30AM, 12:30PM, 6:30PM:
|
||||||
|
```yaml
|
||||||
|
sensor:
|
||||||
|
platform: speedtest
|
||||||
|
minute: 30
|
||||||
|
hour:
|
||||||
|
- 0
|
||||||
|
- 6
|
||||||
|
- 12
|
||||||
|
- 18
|
||||||
|
monitored_conditions:
|
||||||
|
- ping
|
||||||
|
- download
|
||||||
|
- upload
|
||||||
|
```
|
||||||
|
|
||||||
|
Configuration variables:
|
||||||
|
|
||||||
|
- **monitored_conditions** array (*Required*): Conditions to display in the frontend.
|
||||||
|
- **ping**: A human-readable text summary.
|
||||||
|
- **download**: The type of precipitation occurring.
|
||||||
|
- **upload**: The average expected intensity of precipitation occurring.
|
||||||
|
- **ozone**: The columnar density of total atmospheric ozone in Dobson.
|
||||||
|
- **minute** (*Optional*): Specify the minute(s) of the hour to schedule the speedtest. Use a list for multiple entries. Default is 0.
|
||||||
|
- **hour** (*Optional*): Specify the hour(s) of the day to schedule the speedtest. Use a list for multiple entries. Default is None.
|
||||||
|
- **day** (*Optional*): Specify the day(s) of the month to schedule the speedtest. Use a list for multiple entries. Default is None.
|
||||||
|
|
||||||
|
This component uses [speetest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from speedtest.net. Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this component may display.
|
BIN
source/images/supported_brands/speedtest.png
Normal file
BIN
source/images/supported_brands/speedtest.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 76 KiB |
Loading…
x
Reference in New Issue
Block a user