Update documentation for Speedtest Sensor (#4914)
* Update documentation for Speedtest Sensor
* Fixed configuration variables
* Fixed automation example
* Fixed example format
* Fix netlify errors for raw/endraw tags
* ✏️ Minor improvements
This commit is contained in:
Dale Higgs
GitHub
parent
a9a26f7590
commit
e5b56699af
1 changed files with 67 additions and 29 deletions
|
|
@ -16,12 +16,13 @@ ha_iot_class: "Cloud Polling"
|
||||||
|
|
||||||
The `speedtest` sensor component uses the [Speedtest.net](https://speedtest.net/) web service to measure network bandwidth performance.
|
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 configuration by defining the minute, hour, and day for a speedtest to run. For the `server_id` check the list of [available servers](https://www.speedtest.net/speedtest-servers.php).
|
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).
|
||||||
|
|
||||||
To add a Speedtest.net sensor to your installation, add the following to your `configuration.yaml` file:
|
To add a Speedtest.net sensor to your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
Once per hour, on the hour (default):
|
Once per hour, on the hour (default):
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
|
|
@ -31,32 +32,63 @@ sensor:
|
||||||
- download
|
- download
|
||||||
- upload
|
- upload
|
||||||
```
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
Configuration variables:
|
{% configuration %}
|
||||||
|
monitored_conditions:
|
||||||
- **monitored_conditions** array (*Required*): Sensors to display in the frontend.
|
description: 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).
|
required: true
|
||||||
- **download**: Download speed in Mbps.
|
type: list
|
||||||
- **upload**: Upload speed in Mbps.
|
keys:
|
||||||
- **server_id** (*Optional*): Specify the speedtest server to perform test against.
|
ping:
|
||||||
- **minute** (*Optional*): Specify the minute(s) of the hour to schedule the speedtest. Use a list for multiple entries. Default is 0.
|
description: Reaction time in ms of your connection (how fast you get a response after you've sent out a request).
|
||||||
- **hour** (*Optional*): Specify the hour(s) of the day to schedule the speedtest. Use a list for multiple entries. Default is None.
|
download:
|
||||||
- **day** (*Optional*): Specify the day(s) of the month to schedule the speedtest. Use a list for multiple entries. Default is None.
|
description: Download speed (Mbit/s)
|
||||||
- **manual** (*Optional*): True or False to turn manual mode on or off. Manual mode will disable scheduled speedtests.
|
upload:
|
||||||
|
description: Upload speed (Mbit/s)
|
||||||
|
server_id:
|
||||||
|
description: Specify the speed test server to perform the test against.
|
||||||
|
required: false
|
||||||
|
type: int
|
||||||
|
day:
|
||||||
|
description: Specify the day(s) of the month to schedule the speed test. Use a list for multiple entries.
|
||||||
|
required: false
|
||||||
|
type: [int, list]
|
||||||
|
hour:
|
||||||
|
description: Specify the hour(s) of the day to schedule the speed test. Use a list for multiple entries.
|
||||||
|
required: false
|
||||||
|
type: [int, list]
|
||||||
|
minute:
|
||||||
|
description: Specify the minute(s) of the hour to schedule the speed test. Use a list for multiple entries.
|
||||||
|
required: false
|
||||||
|
type: [int, list]
|
||||||
|
default: 0
|
||||||
|
second:
|
||||||
|
description: Specify the second(s) of the minute to schedule the speed test. Use a list for multiple entries.
|
||||||
|
required: false
|
||||||
|
type: [int, list]
|
||||||
|
default: 0
|
||||||
|
manual:
|
||||||
|
description: True or False to turn manual mode on or off. Manual mode will disable scheduled speed tests.
|
||||||
|
required: false
|
||||||
|
type: bool
|
||||||
|
default: false
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
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.
|
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. You can turn on manual mode to disable the scheduled speedtests.
|
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.
|
||||||
|
|
||||||
|
|
||||||
## {% linkable_title Examples %}
|
## {% linkable_title Examples %}
|
||||||
|
|
||||||
In this section you find some real life examples of how to use this sensor.
|
In this section, you find some real-life examples of how to use this sensor.
|
||||||
|
|
||||||
### {% linkable_title Run periodically %}
|
### {% linkable_title Run periodically %}
|
||||||
|
|
||||||
Every half hour of every day:
|
Every half hour of every day:
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
|
|
@ -69,11 +101,13 @@ sensor:
|
||||||
- download
|
- download
|
||||||
- upload
|
- upload
|
||||||
```
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
### {% linkable_title Run at a specific time %}
|
### {% linkable_title Run at a specific time %}
|
||||||
|
|
||||||
Everyday at 12:30AM, 6:30AM, 12:30PM, 6:30PM:
|
Everyday at 12:30AM, 6:30AM, 12:30PM, 6:30PM:
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
sensor:
|
sensor:
|
||||||
|
|
@ -89,29 +123,33 @@ sensor:
|
||||||
- download
|
- download
|
||||||
- upload
|
- upload
|
||||||
```
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
### {% linkable_title Using as a trigger in an automation %}
|
### {% linkable_title Using as a trigger in an automation %}
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
```yaml
|
```yaml
|
||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
automation:
|
automation:
|
||||||
- alias: 'Internet Speed Glow Connect Great'
|
- alias: "Internet Speed Glow Connect Great"
|
||||||
trigger:
|
trigger:
|
||||||
platform: template
|
- platform: template
|
||||||
value_template: '{% raw %}{{ states.sensor.speedtest_download.state|float > 10}}{% endraw %}'
|
value_template: "{{ states('sensor.speedtest_download')|float > 10 }}"
|
||||||
action:
|
action:
|
||||||
service: shell_command.green
|
- service: shell_command.green
|
||||||
- alias: 'Internet Speed Glow Connect Poor'
|
|
||||||
trigger:
|
- alias: "Internet Speed Glow Connect Poor"
|
||||||
platform: template
|
trigger:
|
||||||
value_template: '{% raw %}{{ states.sensor.speedtest_download.state| float < 10 }}{% endraw %}'
|
- platform: template
|
||||||
action:
|
value_template: "{{ states('sensor.speedtest_download')|float < 10 }}"
|
||||||
service: shell_command.red
|
action:
|
||||||
|
- service: shell_command.red
|
||||||
```
|
```
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
## {% linkable_title Notes %}
|
## {% linkable_title Notes %}
|
||||||
|
|
||||||
- When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter.
|
- When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter.
|
||||||
- Entries under `monitored_conditions` only control what entities are available under home-assistant, it does not disable the condition from running.
|
- Entries under `monitored_conditions` only control what entities are available in Home Assistant, it does not disable the condition from running.
|
||||||
- If ran frequently, this component has the capability of using a very large amount of data. Frequent updates should be avoided on bandwidth capped connections.
|
- If ran frequently, this component has the ability to use a considerable amount of data. Frequent updates should be avoided on bandwidth-capped connections.
|
||||||
- While running, network usage is fully utilized. This may have a negative affect on other devices in use the network such as gaming consoles or streaming boxes.
|
- 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.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue