Make BT support detection dynamic for Shelly RPC devices (#137323)

homeassistant/components/shelly/__init__.py

@@ -293,9 +293,11 @@ async def _async_setup_rpc_entry(hass: HomeAssistant, entry: ShellyConfigEntry)
                     translation_key="firmware_unsupported",
                     translation_placeholders={"device": entry.title},
                 )
-            runtime_data.rpc_script_events = await get_rpc_scripts_event_types(
-                device, ignore_scripts=[BLE_SCRIPT_NAME]
-            )
+            runtime_data.rpc_supports_scripts = await device.supports_scripts()
+            if runtime_data.rpc_supports_scripts:
+                runtime_data.rpc_script_events = await get_rpc_scripts_event_types(
+                    device, ignore_scripts=[BLE_SCRIPT_NAME]
+                )
         except (DeviceConnectionError, MacAddressMismatchError, RpcCallError) as err:
             await device.shutdown()
             raise ConfigEntryNotReady(

homeassistant/components/shelly/config_flow.py

@@ -7,12 +7,7 @@ from typing import Any, Final
 
 from aioshelly.block_device import BlockDevice
 from aioshelly.common import ConnectionOptions, get_info
-from aioshelly.const import (
-    BLOCK_GENERATIONS,
-    DEFAULT_HTTP_PORT,
-    MODEL_WALL_DISPLAY,
-    RPC_GENERATIONS,
-)
+from aioshelly.const import BLOCK_GENERATIONS, DEFAULT_HTTP_PORT, RPC_GENERATIONS
 from aioshelly.exceptions import (
     CustomPortNotSupported,
     DeviceConnectionError,
@@ -461,11 +456,9 @@ class ShellyConfigFlow(ConfigFlow, domain=DOMAIN):
     @callback
     def async_supports_options_flow(cls, config_entry: ShellyConfigEntry) -> bool:
         """Return options flow support for this handler."""
-        return (
-            get_device_entry_gen(config_entry) in RPC_GENERATIONS
-            and not config_entry.data.get(CONF_SLEEP_PERIOD)
-            and config_entry.data.get(CONF_MODEL) != MODEL_WALL_DISPLAY
-        )
+        return get_device_entry_gen(
+            config_entry
+        ) in RPC_GENERATIONS and not config_entry.data.get(CONF_SLEEP_PERIOD)
 
 
 class OptionsFlowHandler(OptionsFlow):
@@ -475,6 +468,13 @@ class OptionsFlowHandler(OptionsFlow):
         self, user_input: dict[str, Any] | None = None
     ) -> ConfigFlowResult:
         """Handle options flow."""
+        if (
+            supports_scripts := self.config_entry.runtime_data.rpc_supports_scripts
+        ) is None:
+            return self.async_abort(reason="cannot_connect")
+        if not supports_scripts:
+            return self.async_abort(reason="no_scripts_support")
+
         if user_input is not None:
             return self.async_create_entry(title="", data=user_input)
 

homeassistant/components/shelly/coordinator.py

@@ -89,6 +89,7 @@ class ShellyEntryData:
     rpc: ShellyRpcCoordinator | None = None
     rpc_poll: ShellyRpcPollingCoordinator | None = None
     rpc_script_events: dict[int, list[str]] | None = None
+    rpc_supports_scripts: bool | None = None
 
 
 type ShellyConfigEntry = ConfigEntry[ShellyEntryData]
@@ -716,7 +717,8 @@ class ShellyRpcCoordinator(ShellyCoordinatorBase[RpcDevice]):
         is updated.
         """
         if not self.sleep_period:
-            await self._async_connect_ble_scanner()
+            if self.config_entry.runtime_data.rpc_supports_scripts:
+                await self._async_connect_ble_scanner()
         else:
             await self._async_setup_outbound_websocket()
 

homeassistant/components/shelly/strings.json

@@ -100,6 +100,10 @@
           "ble_scanner_mode": "The scanner mode to use for Bluetooth scanning."
         }
       }
+    },
+    "abort": {
+      "cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
+      "no_scripts_support": "Device does not support scripts and cannot be used as a Bluetooth scanner."
     }
   },
   "selector": {

tests/components/shelly/test_config_flow.py

@@ -24,6 +24,7 @@ from homeassistant.components.shelly.const import (
     BLEScannerMode,
 )
 from homeassistant.components.shelly.coordinator import ENTRY_RELOAD_COOLDOWN
+from homeassistant.config_entries import ConfigEntryState
 from homeassistant.const import (
     CONF_HOST,
     CONF_MODEL,
@@ -744,6 +745,38 @@ async def test_zeroconf_sleeping_device_error(hass: HomeAssistant) -> None:
         assert result["reason"] == "cannot_connect"
 
 
+async def test_options_flow_abort_setup_retry(
+    hass: HomeAssistant, mock_rpc_device: Mock, monkeypatch: pytest.MonkeyPatch
+) -> None:
+    """Test ble options abort if device is in setup retry."""
+    monkeypatch.setattr(
+        mock_rpc_device, "initialize", AsyncMock(side_effect=DeviceConnectionError)
+    )
+    entry = await init_integration(hass, 2)
+
+    assert entry.state is ConfigEntryState.SETUP_RETRY
+
+    result = await hass.config_entries.options.async_init(entry.entry_id)
+
+    assert result["type"] is FlowResultType.ABORT
+    assert result["reason"] == "cannot_connect"
+
+
+async def test_options_flow_abort_no_scripts_support(
+    hass: HomeAssistant, mock_rpc_device: Mock, monkeypatch: pytest.MonkeyPatch
+) -> None:
+    """Test ble options abort if device does not support scripts."""
+    monkeypatch.setattr(
+        mock_rpc_device, "supports_scripts", AsyncMock(return_value=False)
+    )
+    entry = await init_integration(hass, 2)
+
+    result = await hass.config_entries.options.async_init(entry.entry_id)
+
+    assert result["type"] is FlowResultType.ABORT
+    assert result["reason"] == "no_scripts_support"
+
+
 async def test_zeroconf_already_configured(hass: HomeAssistant) -> None:
     """Test we get the form."""
 

tests/components/shelly/test_coordinator.py

@@ -853,12 +853,17 @@ async def test_rpc_update_entry_fw_ver(
     assert device.sw_version == "99.0.0"
 
 
+@pytest.mark.parametrize(("supports_scripts"), [True, False])
 async def test_rpc_runs_connected_events_when_initialized(
     hass: HomeAssistant,
     mock_rpc_device: Mock,
     monkeypatch: pytest.MonkeyPatch,
+    supports_scripts: bool,
 ) -> None:
     """Test RPC runs connected events when initialized."""
+    monkeypatch.setattr(
+        mock_rpc_device, "supports_scripts", AsyncMock(return_value=supports_scripts)
+    )
     monkeypatch.setattr(mock_rpc_device, "initialized", False)
     await init_integration(hass, 2)
 
@@ -869,8 +874,9 @@ async def test_rpc_runs_connected_events_when_initialized(
     mock_rpc_device.mock_initialized()
     await hass.async_block_till_done()
 
-    # BLE script list is called during connected events
-    assert call.script_list() in mock_rpc_device.mock_calls
+    assert call.supports_scripts() in mock_rpc_device.mock_calls
+    # BLE script list is called during connected events if device supports scripts
+    assert bool(call.script_list() in mock_rpc_device.mock_calls) == supports_scripts
 
 
 async def test_rpc_sleeping_device_unload_ignore_ble_scanner(