mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-16 05:46:52 +00:00
Added UDP and parallel streams support to Iperf3 (#5434)
This commit is contained in:
parent
313479464c
commit
9f9aacbbcd
@ -49,14 +49,23 @@ sensor:
|
||||
required: true
|
||||
type: string
|
||||
duration:
|
||||
description: Specify the test duration in seconds. Default is 10 and valid range is from 5 to 10.
|
||||
description: Specify the test duration in seconds. Default is 10 and the 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.
|
||||
parallel:
|
||||
description: Specify the number of concurrent streams to connect to the server. Default is 1 and the valid range is from 1 to 20.
|
||||
default: 1
|
||||
type: int
|
||||
protocol:
|
||||
description: Specify the protocol to be used on the test. Default is TCP and the valid values are TCP or UDP. If your Iperf3 server is located in the Internet, consider to use TCP instead of UDP. If the protocol is set to use UDP, the sensor may not get updated due to package retransmission issues due to its nature.
|
||||
required: false
|
||||
default: 1800
|
||||
default: tcp
|
||||
type: string
|
||||
scan_interval:
|
||||
description: Specify the frequency in seconds which the test will be perfomed. Default value is 1 hour.
|
||||
required: false
|
||||
default: 3600
|
||||
type: int
|
||||
{% endconfiguration %}
|
||||
|
||||
@ -64,6 +73,8 @@ You can find a list of public Iperf3 servers [here](https://iperf.fr/iperf-serve
|
||||
|
||||
The frequency when the test will be automatically triggered can be adjusted by setting the value `scan_interval` in seconds.
|
||||
|
||||
Parallel streams can help in some situations. As TCP attempts to be fair and conservative, you may consider increasing the `parallel` attribute. Use this value with careful and refer to Iperf3 man page for more information.
|
||||
|
||||
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` %}
|
||||
|
Loading…
x
Reference in New Issue
Block a user