diff --git a/source/_components/sensor.speedtest.markdown b/source/_components/sensor.speedtest.markdown index 4bba84884fa1..b8bcf1f12b87 100644 --- a/source/_components/sensor.speedtest.markdown +++ b/source/_components/sensor.speedtest.markdown @@ -41,6 +41,7 @@ Configuration variables: - **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. +- **manual** (*Optional*): When set to true the sensor will not update unless the service is called. Default is False. 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. @@ -86,3 +87,18 @@ sensor: - download - upload ``` + +### {% linkable_title Run manually %} + +Never updates the sensor unless service sensor.speed_test is called: + +```yaml +# Example configuration.yaml entry +sensor: + platform: speedtest + manual: true + monitored_conditions: + - ping + - download + - upload +```