From f581ad6ce285406f2d3ecead96f2057cc2ca3525 Mon Sep 17 00:00:00 2001
From: jimmykmi <jimmy@lzj.ac.cn>
Date: Thu, 19 Dec 2024 02:02:56 +0800
Subject: [PATCH] feat: Add advanced configuration step

- Added an "Advanced Configuration Options" step to the config flow.
- Moved `action_debug` and `hide_non_standard_entities` configurations to the new step.
- Introduced a checkbox "Show Advanced Configuration Options" in the devices filter form.
- Only show the advanced step if the user opts in via the checkbox.

This change enhances the configuration process by allowing users to access advanced settings only if needed, keeping the initial setup simple.
---
 custom_components/xiaomi_home/config_flow.py | 58 ++++++++++++++++----
 1 file changed, 48 insertions(+), 10 deletions(-)

diff --git a/custom_components/xiaomi_home/config_flow.py b/custom_components/xiaomi_home/config_flow.py
index ccc91f9..4881b68 100644
--- a/custom_components/xiaomi_home/config_flow.py
+++ b/custom_components/xiaomi_home/config_flow.py
@@ -481,14 +481,12 @@ class XiaomiMihomeConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
                     'no_family_selected')
             self._ctrl_mode = user_input.get('ctrl_mode')
             for home_id, home_info in self._home_info_buffer[
-                    'homes']['home_list'].items():
+                'homes']['home_list'].items():
                 if home_id in home_selected:
                     self._home_selected[home_id] = home_info
             self._area_name_rule = user_input.get('area_name_rule')
-            self._action_debug = user_input.get(
-                'action_debug', self._action_debug)
-            self._hide_non_standard_entities = user_input.get(
-                'hide_non_standard_entities', self._hide_non_standard_entities)
+            # Check if advanced options should be shown
+            show_advanced_options = user_input.get('show_advanced_options', False)
             # Storage device list
             devices_list: dict[str, dict] = {
                 did: dev_info
@@ -498,7 +496,7 @@ class XiaomiMihomeConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
                 return await self.display_device_filter_form('no_devices')
             devices_list_sort = dict(sorted(
                 devices_list.items(), key=lambda item:
-                    item[1].get('home_id', '')+item[1].get('room_id', '')))
+                item[1].get('home_id', '') + item[1].get('room_id', '')))
             if not await self._miot_storage.save_async(
                     domain='miot_devices',
                     name=f'{self._uid}_{self._cloud_server}',
@@ -513,6 +511,10 @@ class XiaomiMihomeConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
                         'auth_info': self._auth_info
                     })):
                 raise MIoTError('miot_storage.update_user_config_async error')
+            # If advanced options should be shown, go to the advanced step
+            if show_advanced_options:
+                return await self.async_step_advanced_options()
+            # If not, create the entry directly
             return self.async_create_entry(
                 title=(
                     f'{self._nick_name}: {self._uid} '
@@ -552,10 +554,7 @@ class XiaomiMihomeConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
                 vol.Required('home_infos'): cv.multi_select(self._home_list),
                 vol.Required('area_name_rule', default='room'): vol.In(
                     self._miot_i18n.translate(key='config.room_name_rule')),
-                vol.Required('action_debug', default=self._action_debug): bool,
-                vol.Required(
-                    'hide_non_standard_entities',
-                    default=self._hide_non_standard_entities): bool,
+                vol.Required('show_advanced_options', default=False): bool,
             }),
             errors={'base': reason},
             description_placeholders={
@@ -564,6 +563,45 @@ class XiaomiMihomeConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
             last_step=False,
         )
 
+    async def async_step_advanced_options(self, user_input=None):
+        if user_input is not None:
+            # Advanced options, the default values are specified alongside the definition of each variable
+            self._action_debug = user_input.get('action_debug', self._action_debug)
+            self._hide_non_standard_entities = user_input.get(
+                'hide_non_standard_entities', self._hide_non_standard_entities)
+            return self.async_create_entry(
+                title=(
+                    f'{self._nick_name}: {self._uid} '
+                    f'[{CLOUD_SERVERS[self._cloud_server]}]'),
+                data={
+                    'virtual_did': self._virtual_did,
+                    'uuid': self._uuid,
+                    'integration_language': self._integration_language,
+                    'storage_path': self._storage_path,
+                    'uid': self._uid,
+                    'nick_name': self._nick_name,
+                    'cloud_server': self._cloud_server,
+                    'oauth_redirect_url': self._oauth_redirect_url,
+                    'ctrl_mode': self._ctrl_mode,
+                    'home_selected': self._home_selected,
+                    'area_name_rule': self._area_name_rule,
+                    'action_debug': self._action_debug,
+                    'hide_non_standard_entities':
+                        self._hide_non_standard_entities,
+                }
+            )
+
+        return self.async_show_form(
+            step_id='advanced_options',
+            data_schema=vol.Schema({
+                vol.Required('action_debug', default=self._action_debug): bool,
+                vol.Required(
+                    'hide_non_standard_entities',
+                    default=self._hide_non_standard_entities): bool,
+            }),
+            last_step=True,
+        )
+
     @ staticmethod
     @ callback
     def async_get_options_flow(