Skip to content

Version 2.1.0 - Optional Enhanced Latency Metrics & Result URL

Choose a tag to compare

View all tags
@soulripper13 soulripper13 released this 14 Jan 15:22
v2.1.0
a21551d
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Release Notes

Version 2.1.0 - Enhanced Latency Metrics & Result URL

New Features

1. Speedtest Result URL Sensor

Added a new sensor that displays the direct link to your speedtest results on Ookla's website.

What's New:

  • New sensor entity: sensor.ookla_speedtest_result_url
  • Displays the full URL to view detailed speedtest results on speedtest.net
  • Uses a link icon (mdi:link) for easy identification
  • Enabled by default

Benefits:

  • Quick access to detailed speedtest results with graphs and additional metrics
  • Share your speedtest results easily by copying the URL
  • View historical speedtest data on Ookla's platform
  • Access additional information not available in Home Assistant sensors

2. Advanced Latency Sensors

Added detailed latency metrics for comprehensive network performance monitoring.

New Ping Sensors:

  • sensor.ookla_speedtest_ping_min - Minimum ping latency
  • sensor.ookla_speedtest_ping_max - Maximum ping latency

New Download Latency Sensors:

  • sensor.ookla_speedtest_download_ping - Average ping during download (IQM)
  • sensor.ookla_speedtest_download_ping_min - Minimum ping during download
  • sensor.ookla_speedtest_download_ping_max - Maximum ping during download
  • sensor.ookla_speedtest_download_jitter - Jitter during download

New Upload Latency Sensors:

  • sensor.ookla_speedtest_upload_ping - Average ping during upload (IQM)
  • sensor.ookla_speedtest_upload_ping_min - Minimum ping during upload
  • sensor.ookla_speedtest_upload_ping_max - Maximum ping during upload
  • sensor.ookla_speedtest_upload_jitter - Jitter during upload

Note: All advanced latency sensors are disabled by default. Enable them individually in Home Assistant if you need detailed latency analysis.

Benefits:

  • Monitor latency variations during speed tests
  • Identify network stability issues
  • Track jitter for VoIP and gaming performance
  • Analyze how latency changes during upload/download operations

How to Use:

  1. Restart Home Assistant or reload the Ookla Speedtest integration
  2. The new "Result URL" sensor will appear automatically (enabled by default)
  3. Advanced latency sensors will be available but disabled - enable them in Settings > Devices & Services > Ookla Speedtest > Entities
  4. After each speedtest run, all sensors will update with the latest data
  5. Click the Result URL to view detailed results on speedtest.net

Enabling Advanced Latency Sensors:

  1. Go to Settings > Devices & Services
  2. Find "Ookla Speedtest" and click on it
  3. Click on the "X entities" link
  4. Find the disabled sensors (they'll have a "Disabled" badge)
  5. Click on each sensor you want to enable
  6. Click "Enable entity"

Example Result URL Format:

https://www.speedtest.net/result/c/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Data Source:
All metrics are extracted from the Ookla Speedtest CLI JSON output:

  • Result URL: result.url
  • Ping metrics: ping.low, ping.high
  • Download latency: download.latency.iqm, download.latency.low, download.latency.high, download.latency.jitter
  • Upload latency: upload.latency.iqm, upload.latency.low, upload.latency.high, upload.latency.jitter

Contributors

Special thanks to @ndrwrbgs for contributing the advanced latency sensors feature!

Notes

  • The Result URL sensor will show an empty value if the speedtest fails or if the URL is not available in the response
  • The URL is generated by Ookla and provides access to detailed test results including:
    • Interactive speed graphs
    • Packet loss information
    • Server details and map
    • Share functionality

Full Changelog: See commit history for detailed changes

Assets 2
Loading