Split options flow into Basic and Advanced steps #1311
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Users have complained about the overwhelming number of options (28+) in the configuration UI. This change splits the options into two steps: **Basic Settings (9 options):** - lights, min/max brightness, min/max color temp - sleep brightness, sleep color temp, transition, interval **Advanced Settings (20+ options):** - All other options (sunrise/sunset times, offsets, brightness modes, take_over_control, detect_non_ha_changes, etc.) The flow now works as: 1. User configures basic options 2. Menu appears: "Configure advanced options" or "Save and finish" 3. If advanced chosen, show advanced options form 4. Save combined options Changes: - Add BASIC_OPTIONS constant to const.py - Refactor OptionsFlowHandler with async_step_init, async_step_advanced, async_step_finish methods - Update strings.json with menu_options and advanced step - Update all 34 translation files with translated menu/titles - Update tests for multi-step flow Note for Weblate: After merging, run "Rescan all translation files" to pick up the new structure. Existing translations are preserved.
The _build_options_schema method was calling _get_lights_schema internally, causing it to be called multiple times redundantly. This refactoring: - Renames _get_lights_schema to _prepare_lights_schema for clarity - Changes _build_options_schema to accept to_replace as a parameter - Updates all callers to prepare lights schema first and pass it - Fixes async_step_advanced which was broken due to missing parameter
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Users have complained about the overwhelming number of options (28+) in the configuration UI. This PR splits the options flow into two steps to improve usability.
Basic Settings (9 options)
lights- Light entities to controlmin_brightness/max_brightness- Brightness rangemin_color_temp/max_color_temp- Color temperature rangesleep_brightness/sleep_color_temp- Sleep mode settingstransition/interval- Timing settingsAdvanced Settings (20+ options)
All other options including sunrise/sunset times, offsets, brightness modes,
take_over_control,detect_non_ha_changes, etc.Flow
Changes
BASIC_OPTIONSconstant toconst.pyOptionsFlowHandlerwith multi-step flow:async_step_init- Basic options + menuasync_step_advanced- Advanced optionsasync_step_finish- Save without advancedstrings.jsonwithmenu_optionsandadvancedstepWeblate Note
After merging, run "Rescan all translation files in the Weblate repository" to pick up the new structure. Existing translations are preserved in the files - they've just been reorganized from
init.datatoadvanced.data.Test plan