You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/sensor.speedtest.markdown
+3-7Lines changed: 3 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -16,13 +16,14 @@ ha_iot_class: "Cloud Polling"
16
16
17
17
The `speedtest` sensor component uses the [Speedtest.net](https://speedtest.net/) web service to measure network bandwidth performance.
18
18
19
+
## {% linkable_title Configuration %}
20
+
19
21
By default, it will run every hour. The user can change the update frequency in the configuration by defining the minute, hour, and day for a speed test to run. For the `server_id` check the list of [available servers](https://www.speedtest.net/speedtest-servers.php).
20
22
21
23
To add a Speedtest.net sensor to your installation, add the following to your `configuration.yaml` file:
22
24
23
25
Once per hour, on the hour (default):
24
26
25
-
{% raw %}
26
27
```yaml
27
28
# Example configuration.yaml entry
28
29
sensor:
@@ -32,7 +33,6 @@ sensor:
32
33
- download
33
34
- upload
34
35
```
35
-
{% endraw %}
36
36
37
37
{% configuration %}
38
38
monitored_conditions:
@@ -79,7 +79,6 @@ This component uses [speedtest-cli](https://github.com/sivel/speedtest-cli) to g
79
79
80
80
When Home Assistant first starts up, the values of the speed test will show as `Unknown`. You can use the service `sensor.update_speedtest` to run a manual speed test and populate the data or just wait for the next regularly scheduled test. You can turn on manual mode to disable the scheduled speed tests.
81
81
82
-
83
82
## {% linkable_title Examples %}
84
83
85
84
In this section, you find some real-life examples of how to use this sensor.
@@ -88,7 +87,6 @@ In this section, you find some real-life examples of how to use this sensor.
88
87
89
88
Every half hour of every day:
90
89
91
-
{% raw %}
92
90
```yaml
93
91
# Example configuration.yaml entry
94
92
sensor:
@@ -101,13 +99,11 @@ sensor:
101
99
- download
102
100
- upload
103
101
```
104
-
{% endraw %}
105
102
106
103
### {% linkable_title Run at a specific time %}
107
104
108
105
Everyday at 12:30AM, 6:30AM, 12:30PM, 6:30PM:
109
106
110
-
{% raw %}
111
107
```yaml
112
108
# Example configuration.yaml entry
113
109
sensor:
@@ -123,7 +119,6 @@ sensor:
123
119
- download
124
120
- upload
125
121
```
126
-
{% endraw %}
127
122
128
123
### {% linkable_title Using as a trigger in an automation %}
129
124
@@ -150,6 +145,7 @@ automation:
150
145
## {% linkable_title Notes %}
151
146
152
147
- When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter.
148
+
- Running this platform can have negative effects on the system's performance as it requires a fair amount of memory.
153
149
- Entries under `monitored_conditions` only control what entities are available in Home Assistant, it does not disable the condition from running.
154
150
- If ran frequently, this component has the ability to use a considerable amount of data. Frequent updates should be avoided on bandwidth-capped connections.
155
151
- While running, your network capacity is fully utilized. This may have a negative effect on other devices in use the network such as gaming consoles or streaming boxes.
0 commit comments