Skip to content

Update Speedtest #1628

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions source/_components/sensor.speedtest.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
```