mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-01 15:56:49 +00:00
81 lines
2.5 KiB
Markdown
81 lines
2.5 KiB
Markdown
---
|
|
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: System Monitor
|
|
featured: false
|
|
ha_release: 0.13
|
|
---
|
|
|
|
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. The user can change the update frequency in the config by defining the minute, hour, and day for a speedtest to run.
|
|
|
|
To add a Speedtest.net sensor to your installation, add the following to your `configuration.yaml` file:
|
|
|
|
Once per hour, on the hour (default):
|
|
|
|
```yaml
|
|
sensor:
|
|
platform: speedtest
|
|
server_id: 1234
|
|
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*): Sensors to display in the frontend.
|
|
- **ping**: Reaction time in ms of your connection, (how fast you get a response after you've sent out a request).
|
|
- **download**: Download speed in Mbps.
|
|
- **upload**: Upload speed in Mbps.
|
|
- **server_id (*Optional*): Specify the speedtest server to perform test against.
|
|
- **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 [speedtest-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.
|
|
|
|
When Home Assistant first starts up, the values of the speedtest will show as `Unknown`. You can use the service `sensor.update_speedtest` to run a manual speedtest and populate the data or just wait for the next regularly scheduled test.
|