Skip to content

🚀 Release v2.0.0 - Major Configuration Improvements

Choose a tag to compare

View all tags
@soulripper13 soulripper13 released this 02 Dec 07:16
v2.0.0
8a0ce1e
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

🚀 Release v2.0.0 - Major Configuration Improvements

🎉 What's New

This major release brings significant improvements to the configuration experience and fixes critical issues with the config flow UI.

✨ Highlights

  • 🔧 Fixed Configuration UI: Resolved the "500 Internal Server Error" that prevented users from accessing the Configure button
  • 📝 User-Friendly Descriptions: Added helpful, detailed descriptions for every configuration option
  • 🔄 Live Reconfiguration: Change your settings anytime through the Home Assistant UI without removing the integration
  • ⚡ Auto-Reload: Integration automatically reloads when you change settings - no manual restart needed

🐛 Bug Fixes

  • Fixed: 500 Internal Server Error when clicking the Configure button
  • Fixed: Config flow handler registration issues that caused "Invalid handler specified" errors
  • Fixed: Options flow now properly reads from entry.options with fallback to entry.data
  • Fixed: Removed invalid ConfigFlowError exception that caused import failures

🎨 New Features

Interactive Configuration

  • User-Friendly Setup: Step-by-step guidance with clear descriptions for each option
  • Reconfigure Anytime: Access Settings > Devices & Services > Ookla Speedtest > Configure
  • Smart Defaults: Options flow remembers your previous settings

Enhanced User Experience

  • Server Selection:

    • Clear explanation: "Choose which server to test against. 'Closest Server' automatically selects the nearest server."
    • Shows 10 nearest servers sorted by distance
    • Manual server ID option with helpful hints

  • Manual Mode:

    • Clear explanation: "When enabled, speed tests only run when manually triggered via the service."
    • Understand exactly when tests will run

  • Scan Interval:

    • Clear explanation: "How often to automatically run speed tests (in minutes)."
    • Bandwidth usage warning for frequent scans

Translation Support

  • Added strings.json with comprehensive field descriptions
  • Added translations/en.json for full English localization
  • Foundation for future multi-language support

🔧 Improvements

  • Automatic Reload: Integration reloads automatically when configuration changes
  • Better Error Handling: Improved error messages and validation during setup
  • Backwards Compatibility: Options flow gracefully handles both old and new configuration formats
  • Code Quality: Cleaner, more maintainable config flow implementation

📋 Breaking Changes

⚠️ Important: While this is a major version bump, there are no breaking changes for existing users. Your current configuration will continue to work seamlessly.

We bumped to v2.0.0 to reflect the significant improvements to the configuration system.

🔄 Upgrade Instructions

For HACS Users (Recommended)

  1. Go to HACS > Integrations
  2. Find Ookla Speedtest and click Update
  3. Restart Home Assistant: Settings > System > Restart
  4. Test the new Configure feature: Settings > Devices & Services > Ookla Speedtest > Configure

Manual Installation

  1. Download the latest release
  2. Extract to /config/custom_components/ookla_speedtest/
  3. Clear Python cache: 
    find /config/custom_components/ookla_speedtest -type d -name "__pycache__" -exec rm -rf {} +
find /config/custom_components/ookla_speedtest -name "*.pyc" -delete
  4. Restart Home Assistant
  5. Enjoy the improved configuration experience!

📸 Screenshots

The new configuration UI includes:

  • ✅ Helpful descriptions below each field
  • ✅ Server selection with distance information
  • ✅ Manual mode toggle with clear explanation
  • ✅ Scan interval with bandwidth warning
  • ✅ Manual server ID option with hints

🙏 Acknowledgments

Thank you to all users who reported the configuration issues and helped test the fixes!

📝 Full Changelog

Added

  • User-friendly descriptions for all configuration options
  • Complete UI-based reconfiguration support
  • Automatic integration reload on configuration changes
  • Translation files (strings.json, translations/en.json)
  • Options flow __init__ method for proper initialization
  • Explicit config flow handler registration

Fixed

  • 500 Internal Server Error on Configure button
  • Config flow handler registration issues
  • Invalid handler specified errors
  • Options flow data handling
  • Import errors from invalid exception usage

Changed

  • Bumped version to 2.0.0
  • Improved error handling in setup script
  • Enhanced code quality and maintainability

Improved

  • Configuration user experience
  • Error messages and validation
  • Documentation in README.md
  • Backwards compatibility

🔗 Links

Enjoy the improved Ookla Speedtest integration! 🎊

If you encounter any issues, please report them on our GitHub Issues page.

Assets 2
Loading