Add Iperf3 sensor (#5282)

This commit is contained in:
Marcelo Moreira de Mello 2018-05-24 03:26:22 -04:00 committed by Sebastian Muszynski
parent 33e8355a77
commit 4da6af168e
2 changed files with 78 additions and 0 deletions

View File

@ -0,0 +1,78 @@
---
layout: page
title: "Iperf3 Sensor"
description: "How to use Iperf3 within Home Assistant to measure your network bandwith."
date: 2018-05-01 02:00
sidebar: true
comments: false
sharing: true
footer: true
logo: iperf3.png
ha_category: System Monitor
featured: false
ha_release: 0.71
ha_iot_class: "Local Polling"
---
The `iperf3` sensor component allows you to measure network bandwidth performance against a private or public Iperf3 server.
## {% linkable_title Configuration %}
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 iperf3 test to run.
To add the `iperf3` sensor to your installation, add the following to your `configuration.yaml` file:
Once per hour, on the hour (default):
```yaml
# Example configuration.yaml entry
sensor:
- platform: iperf3
host: iperf.he.net
monitored_conditions:
- download
- upload
```
{% configuration %}
monitored_conditions:
description: Sensors to display in the frontend.
required: true
type: list
keys:
download:
description: Download speed (Mbit/s)
upload:
description: Upload speed (Mbit/s)
host:
description: Specify the Iperf3 test to perform the test against.
required: true
type: string
duration:
description: Specify the test duration in seconds. Default is 10 and valid range is from 5 to 10.
required: false
default: 3
type: int
scan_interval:
description: Specify the frequency in seconds which the test will be perfomed. Default value is 30 minutes.
required: false
default: 1800
type: int
{% endconfiguration %}
You can find a list of public Iperf3 servers [here](https://iperf.fr/iperf-servers.php). You can also start your own Iperf3 server using the [mlabbe/iperf3's](https://hub.docker.com/r/mlabbe/iperf3/) docker image or just refer to your `iperf3` command's man page.
The frequency when the test will be automatically triggered can be adjusted by setting the value `scan_interval` in seconds.
You can use the service `sensor.iperf3_update` to trigger a manual speed test for all sensors. Iperf3 has its own service call that allow to perform a speed test on a particular entity.
### {% linkable_title Service `sensor.iperf3_update` %}
| Service data attribute | Description |
| `entity_id` | String that point at `entity_id`s of the Iperf3 sensor. Else targets all.
## {% linkable_title Notes %}
- When running on Raspberry Pi, just note that the maximum speed is limited by its 100 Mbit/s LAN adapter.
- This component requires the `iperf3` command to be installed on your OS. Please, refer to the [official Iperf3 documentation](http://software.es.net/iperf/obtaining.html) for installation instructions.

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB