feat: allow reconfiguring via options

custom_components/alexa_media/config_flow.py

@@ -31,6 +31,7 @@
 from homeassistant.core import callback
 from homeassistant.data_entry_flow import UnknownFlow
 from homeassistant.exceptions import Unauthorized
+from homeassistant.helpers import config_validation as cv
 from homeassistant.helpers.network import NoURLAvailableError, get_url
 from homeassistant.util import slugify
 import httpx
@@ -55,9 +56,11 @@
     CONF_SECURITYCODE,
     CONF_TOTP_REGISTER,
     DATA_ALEXAMEDIA,
-    DEFAULT_EXTENDED_ENTITY_DISCOVERY,
     DEFAULT_PUBLIC_URL,
     DEFAULT_QUEUE_DELAY,
+    DEFAULT_SCAN_DELAY,
+    DEFAULT_EXTENDED_ENTITY_DISCOVERY,
+    DEFAULT_DEBUG,
     DOMAIN,
     ISSUE_URL,
     STARTUP,
@@ -111,15 +114,18 @@ def __init__(self):
         self.proxy_schema = None
         self.data_schema = OrderedDict(
             [
+                (vol.Required(CONF_URL, default="amazon.com"), str),
+                (vol.Required(CONF_HASS_URL), str),
                 (vol.Required(CONF_EMAIL), str),
                 (vol.Required(CONF_PASSWORD), str),
-                (vol.Required(CONF_URL, default="amazon.com"), str),
-                (vol.Optional(CONF_SECURITYCODE), str),
                 (vol.Optional(CONF_OTPSECRET), str),
-                (vol.Optional(CONF_DEBUG, default=False), bool),
+                (vol.Optional(CONF_SECURITYCODE), str),
                 (vol.Optional(CONF_INCLUDE_DEVICES, default=""), str),
                 (vol.Optional(CONF_EXCLUDE_DEVICES, default=""), str),
                 (vol.Optional(CONF_SCAN_INTERVAL, default=60), int),
+                (vol.Optional(CONF_QUEUE_DELAY, default=1.5), float),
+                (vol.Optional(CONF_EXTENDED_ENTITY_DISCOVERY, default=False), bool),
+                (vol.Optional(CONF_DEBUG, default=False), bool),
             ]
         )
         self.totp_register = OrderedDict(
@@ -143,40 +149,39 @@ async def async_step_user(self, user_input=None):
             hass_url = ""
         self.proxy_schema = OrderedDict(
             [
-                (
-                    vol.Required(CONF_EMAIL, default=self.config.get(CONF_EMAIL, "")),
-                    str,
-                ),
                 (
                     vol.Required(
-                        CONF_PASSWORD, default=self.config.get(CONF_PASSWORD, "")
+                        CONF_URL,
+                        default=self.config.get(CONF_URL, "amazon.com")
                     ),
                     str,
                 ),
                 (
                     vol.Required(
-                        CONF_URL, default=self.config.get(CONF_URL, "amazon.com")
-                    ),
+                        CONF_EMAIL,
+                        default=self.config.get(CONF_EMAIL, "")),
                     str,
                 ),
                 (
                     vol.Required(
-                        CONF_HASS_URL,
-                        default=self.config.get(CONF_HASS_URL, hass_url),
+                        CONF_PASSWORD,
+                        default=self.config.get(CONF_PASSWORD, "")
                     ),
                     str,
                 ),
                 (
                     vol.Optional(
-                        CONF_OTPSECRET, default=self.config.get(CONF_OTPSECRET, "")
+                        CONF_OTPSECRET,
+                        default=self.config.get(CONF_OTPSECRET, "")
                     ),
                     str,
                 ),
                 (
                     vol.Optional(
-                        CONF_DEBUG, default=self.config.get(CONF_DEBUG, False)
+                        CONF_HASS_URL,
+                        default=self.config.get(CONF_HASS_URL, ""),
                     ),
-                    bool,
+                    str,
                 ),
                 (
                     vol.Optional(
@@ -195,10 +200,31 @@ async def async_step_user(self, user_input=None):
                 (
                     vol.Optional(
                         CONF_SCAN_INTERVAL,
-                        default=self.config.get(CONF_SCAN_INTERVAL, 60),
+                        default=self.config.get(CONF_SCAN_INTERVAL, DEFAULT_SCAN_DELAY),
                     ),
                     int,
                 ),
+                (
+                    vol.Optional(
+                        CONF_QUEUE_DELAY,
+                        default=self.config.get(CONF_QUEUE_DELAY, DEFAULT_QUEUE_DELAY),
+                    ),
+                    float,
+                ),
+                (
+                    vol.Optional(
+                        CONF_EXTENDED_ENTITY_DISCOVERY,
+                        default=self.config.get(CONF_EXTENDED_ENTITY_DISCOVERY, DEFAULT_EXTENDED_ENTITY_DISCOVERY)
+                    ),
+                    bool,
+                ),
+                (
+                    vol.Optional(
+                        CONF_DEBUG,
+                        default=self.config.get(CONF_DEBUG, DEFAULT_DEBUG)
+                    ),
+                    bool,
+                ),
             ]
         )
         if not user_input:
@@ -570,8 +596,11 @@ async def _test_login(self):
                 self.config.pop("reauth")
             if self.config.get(CONF_SECURITYCODE):
                 self.config.pop(CONF_SECURITYCODE)
+
+#            ### Alan, why is this being done? ###
             if self.config.get("hass_url"):
                 self.config.pop("hass_url")
+
             self.config[CONF_OAUTH] = {
                 "access_token": login.access_token,
                 "refresh_token": login.refresh_token,
@@ -691,8 +720,8 @@ def _save_user_input_to_config(self, user_input=None) -> None:
         """
         if user_input is None:
             return
-        if CONF_HASS_URL in user_input:
-            self.config[CONF_HASS_URL] = user_input[CONF_HASS_URL]
+        if CONF_URL in user_input:
+            self.config[CONF_URL] = user_input[CONF_URL]
         self.securitycode = user_input.get(CONF_SECURITYCODE)
         if self.securitycode is not None:
             self.config[CONF_SECURITYCODE] = self.securitycode
@@ -709,16 +738,18 @@ def _save_user_input_to_config(self, user_input=None) -> None:
             self.config[CONF_EMAIL] = user_input[CONF_EMAIL]
         if CONF_PASSWORD in user_input:
             self.config[CONF_PASSWORD] = user_input[CONF_PASSWORD]
-        if CONF_URL in user_input:
-            self.config[CONF_URL] = user_input[CONF_URL]
-        if CONF_DEBUG in user_input:
-            self.config[CONF_DEBUG] = user_input[CONF_DEBUG]
+        if CONF_HASS_URL in user_input:
+            self.config[CONF_HASS_URL] = user_input[CONF_HASS_URL]
         if CONF_SCAN_INTERVAL in user_input:
             self.config[CONF_SCAN_INTERVAL] = (
                 user_input[CONF_SCAN_INTERVAL]
                 if not isinstance(user_input[CONF_SCAN_INTERVAL], timedelta)
                 else user_input[CONF_SCAN_INTERVAL].total_seconds()
             )
+        if CONF_QUEUE_DELAY in user_input:
+            self.config[CONF_QUEUE_DELAY] = (
+                user_input[CONF_QUEUE_DELAY]
+            )
         if CONF_INCLUDE_DEVICES in user_input:
             if isinstance(user_input[CONF_INCLUDE_DEVICES], list):
                 self.config[CONF_INCLUDE_DEVICES] = (
@@ -737,29 +768,38 @@ def _save_user_input_to_config(self, user_input=None) -> None:
                 )
             else:
                 self.config[CONF_EXCLUDE_DEVICES] = user_input[CONF_EXCLUDE_DEVICES]
+        if CONF_EXTENDED_ENTITY_DISCOVERY in user_input:
+            self.config[CONF_EXTENDED_ENTITY_DISCOVERY] = user_input[CONF_EXTENDED_ENTITY_DISCOVERY]
+        if CONF_DEBUG in user_input:
+            self.config[CONF_DEBUG] = user_input[CONF_DEBUG]
 
     def _update_schema_defaults(self) -> Any:
         new_schema = self._update_ord_dict(
             self.data_schema,
             {
-                vol.Required(CONF_EMAIL, default=self.config.get(CONF_EMAIL, "")): str,
                 vol.Required(
-                    CONF_PASSWORD, default=self.config.get(CONF_PASSWORD, "")
+                    CONF_URL,
+                    default=self.config.get(CONF_URL, "amazon.com")
                 ): str,
-                vol.Optional(
+                vol.Required(CONF_EMAIL,
+                default=self.config.get(CONF_EMAIL, "")
+                ): str,
+                vol.Required(
+                    CONF_PASSWORD,
+                    default=self.config.get(CONF_PASSWORD, "")
+                ): str,
+                vol.Required(
                     CONF_SECURITYCODE,
                     default=self.securitycode if self.securitycode else "",
                 ): str,
-                vol.Optional(
+                vol.Required(
                     CONF_OTPSECRET,
                     default=self.config.get(CONF_OTPSECRET, ""),
                 ): str,
-                vol.Required(
-                    CONF_URL, default=self.config.get(CONF_URL, "amazon.com")
-                ): str,
-                vol.Optional(
-                    CONF_DEBUG, default=bool(self.config.get(CONF_DEBUG, False))
-                ): bool,
+#                vol.Required(
+#                    CONF_HASS_URL,
+#                    default=self.config_entry.options.get(CONF_HASS_URL, ""),
+#                ): str,
                 vol.Optional(
                     CONF_INCLUDE_DEVICES,
                     default=self.config.get(CONF_INCLUDE_DEVICES, ""),
@@ -769,8 +809,24 @@ def _update_schema_defaults(self) -> Any:
                     default=self.config.get(CONF_EXCLUDE_DEVICES, ""),
                 ): str,
                 vol.Optional(
-                    CONF_SCAN_INTERVAL, default=self.config.get(CONF_SCAN_INTERVAL, 60)
+                    CONF_SCAN_INTERVAL,
+                    default=self.config.get(CONF_SCAN_INTERVAL, 60)
                 ): int,
+                vol.Optional(
+                    CONF_QUEUE_DELAY,
+                    default=self.config_entry.options.get(CONF_QUEUE_DELAY, 1.5
+                    ),
+                ):float,
+                vol.Optional(
+                    CONF_EXTENDED_ENTITY_DISCOVERY,
+                    default=self.config_entry.options.get(
+                        CONF_EXTENDED_ENTITY_DISCOVERY,
+                        DEFAULT_EXTENDED_ENTITY_DISCOVERY,
+                    ),
+                ): bool,
+                vol.Optional(
+                    CONF_DEBUG, default=bool(self.config.get(CONF_DEBUG, False))
+                ): bool,
             },
         )
         return new_schema
@@ -781,44 +837,68 @@ def async_get_options_flow(config_entry):
         """Get the options flow for this handler."""
         return OptionsFlowHandler(config_entry)
 
-
 class OptionsFlowHandler(config_entries.OptionsFlow):
     """Handle a option flow for Alexa Media."""
 
-    def __init__(self, config_entry: config_entries.ConfigEntry):
+    def __init__(self, config_entry: config_entries.ConfigEntry) -> None:
         """Initialize options flow."""
         self.config_entry = config_entry
 
     async def async_step_init(self, user_input=None):
         """Handle options flow."""
         if user_input is not None:
-            return self.async_create_entry(title="", data=user_input)
+            """Preserve these parameters"""
+            if CONF_URL in self.config_entry.data:
+                user_input[CONF_URL] = self.config_entry.data[CONF_URL]
+            if CONF_EMAIL in self.config_entry.data:
+                user_input[CONF_EMAIL] = self.config_entry.data[CONF_EMAIL]
+            if CONF_PASSWORD in self.config_entry.data:
+                user_input[CONF_PASSWORD] = self.config_entry.data[CONF_PASSWORD]
+            if CONF_SECURITYCODE in self.config_entry.data:
+                user_input[CONF_SECURITYCODE] = self.config_entry.data[CONF_SECURITYCODE]
+            if CONF_OTPSECRET in self.config_entry.data:
+                user_input[CONF_OTPSECRET] = self.config_entry.data[CONF_OTPSECRET]
+
+            self.hass.config_entries.async_update_entry(
+                self.config_entry, data=user_input, options=self.config_entry.options
+            )
+            return self.async_create_entry(title="", data={})
 
-        data_schema = vol.Schema(
-            {
-                vol.Optional(
-                    CONF_QUEUE_DELAY,
-                    default=self.config_entry.options.get(
-                        CONF_QUEUE_DELAY, DEFAULT_QUEUE_DELAY
-                    ),
-                ): vol.All(vol.Coerce(float), vol.Clamp(min=0)),
-                vol.Optional(
-                    CONF_PUBLIC_URL,
-                    default=self.config_entry.options.get(
-                        CONF_PUBLIC_URL, DEFAULT_PUBLIC_URL
-                    ),
-                ): str,
-                vol.Required(
-                    CONF_EXTENDED_ENTITY_DISCOVERY,
-                    default=self.config_entry.options.get(
+        return self.async_show_form(
+            step_id="init",
+            data_schema=vol.Schema(
+                {
+#                    vol.Optional(
+#                        CONF_HASS_URL,
+#                        default=self.config_entry.data[CONF_HASS_URL],
+#                    ): cv.string,
+                    vol.Optional(
+                        CONF_INCLUDE_DEVICES,
+                        default=self.config_entry.data[CONF_INCLUDE_DEVICES],
+                    ): cv.string,
+                    vol.Optional(
+                        CONF_EXCLUDE_DEVICES,
+                        default=self.config_entry.data[CONF_EXCLUDE_DEVICES],
+                    ): cv.string,
+                    vol.Optional(
+                        CONF_SCAN_INTERVAL,
+                        default=self.config_entry.data[CONF_SCAN_INTERVAL],
+                    ): vol.All(vol.Coerce(int), vol.Range(min=0, max=1800)),
+                    vol.Optional(
+                        CONF_QUEUE_DELAY,
+                        default=self.config_entry.data[CONF_QUEUE_DELAY],
+                    ): vol.All(vol.Coerce(float), vol.Range(min=0.5, max=5.0)),
+                    vol.Optional(
                         CONF_EXTENDED_ENTITY_DISCOVERY,
-                        DEFAULT_EXTENDED_ENTITY_DISCOVERY,
-                    ),
-                ): bool,
-            }
+                        default=self.config_entry.data[CONF_EXTENDED_ENTITY_DISCOVERY],
+                    ): cv.boolean,
+                    vol.Optional(
+                        CONF_DEBUG,
+                        default=self.config_entry.data[CONF_DEBUG],
+                    ): cv.boolean,
+                }
+            ),
         )
-        return self.async_show_form(step_id="init", data_schema=data_schema)
-
 
 class AlexaMediaAuthorizationCallbackView(HomeAssistantView):
     """Handle callback from external auth."""

custom_components/alexa_media/const.py

@@ -58,9 +58,11 @@
 
 EXCEPTION_TEMPLATE = "An exception of type {0} occurred. Arguments:\n{1!r}"
 
-DEFAULT_EXTENDED_ENTITY_DISCOVERY = False
+DEFAULT_SCAN_DELAY = 60
 DEFAULT_QUEUE_DELAY = 1.5
 DEFAULT_PUBLIC_URL = ""
+DEFAULT_EXTENDED_ENTITY_DISCOVERY = False
+DEFAULT_DEBUG = False
 SERVICE_CLEAR_HISTORY = "clear_history"
 SERVICE_UPDATE_LAST_CALLED = "update_last_called"
 SERVICE_FORCE_LOGOUT = "force_logout"

custom_components/alexa_media/services.yaml

@@ -11,23 +11,6 @@ update_last_called:
       # Example value that can be passed for this field
       example: "[email protected]"
 
-clear_history:
-  # Description of the service
-  description: Clear last entries from Alexa Voice history for each Alexa account.
-  # Different fields that your service accepts
-  fields:
-    # Key of the field
-    email:
-      # Description of the field
-      description: List of Alexa accounts to update. If empty, will delete from all known accounts.
-      # Example value that can be passed for this field
-      example: "[email protected]"
-    entries:
-      # Description of the field
-      description: Number of entries to clear from 1 to 50. If empty, clear 50.
-      # Example value that can be passed for this field
-      example: 50
-
 force_logout:
   # Description of the service
   description: Force logout of Alexa Login account and deletion of .pickle. Intended for debugging use.