From adb30e1ec1e09dcc7fa47e80b3e4668def94f66a Mon Sep 17 00:00:00 2001 From: TheJulianJES Date: Fri, 13 Mar 2026 16:56:12 +0100 Subject: [PATCH] Hide ZWA-2 adapter in Zigbee serial port selector (#155526) --- homeassistant/components/zha/config_flow.py | 13 +++- tests/components/zha/test_config_flow.py | 86 +++++++++++++++++++++ 2 files changed, 98 insertions(+), 1 deletion(-) diff --git a/homeassistant/components/zha/config_flow.py b/homeassistant/components/zha/config_flow.py index d20b0e5bdb8..54034fc6b13 100644 --- a/homeassistant/components/zha/config_flow.py +++ b/homeassistant/components/zha/config_flow.py @@ -103,6 +103,12 @@ ZEROCONF_PROPERTIES_SCHEMA = vol.Schema( extra=vol.ALLOW_EXTRA, ) +# USB devices to ignore in serial port selection (non-Zigbee devices) +# Format: (manufacturer, description) +IGNORED_USB_DEVICES = { + ("Nabu Casa", "ZWA-2"), +} + class OptionsMigrationIntent(StrEnum): """Zigbee options flow intents.""" @@ -176,7 +182,12 @@ async def list_serial_ports(hass: HomeAssistant) -> list[USBDevice]: ports.append(addon_port) - return ports + # Filter out ignored USB devices + return [ + port + for port in ports + if (port.manufacturer, port.description) not in IGNORED_USB_DEVICES + ] class BaseZhaFlow(ConfigEntryBaseFlow): diff --git a/tests/components/zha/test_config_flow.py b/tests/components/zha/test_config_flow.py index 8d4d96060dc..3fce8b9ebf3 100644 --- a/tests/components/zha/test_config_flow.py +++ b/tests/components/zha/test_config_flow.py @@ -2918,6 +2918,92 @@ async def test_config_flow_port_no_multiprotocol(hass: HomeAssistant) -> None: assert ports == [] +async def test_list_serial_ports_ignored_devices(hass: HomeAssistant) -> None: + """Test that list_serial_ports filters out ignored non-Zigbee devices.""" + mock_ports = [ + USBDevice( + device="/dev/ttyUSB0", + vid="303A", + pid="4001", + serial_number="1234", + manufacturer="Nabu Casa", + description="ZWA-2", + ), + USBDevice( + device="/dev/ttyUSB1", + vid="303A", + pid="4001", + serial_number="1235", + manufacturer="Nabu Casa", + description="ZBT-2", + ), + USBDevice( + device="/dev/ttyUSB2", + vid="10C4", + pid="EA60", + serial_number="1236", + manufacturer="Nabu Casa", + description="Home Assistant Connect ZBT-1", + ), + USBDevice( + device="/dev/ttyUSB3", + vid="10C4", + pid="EA60", + serial_number="1237", + manufacturer="Nabu Casa", + description="SkyConnect v1.0", + ), + USBDevice( + device="/dev/ttyUSB4", + vid="1234", + pid="5678", + serial_number="1238", + manufacturer="Another Manufacturer", + description="Zigbee USB Adapter", + ), + USBDevice( + device="/dev/ttyUSB5", + vid="1234", + pid="5678", + serial_number=None, + manufacturer=None, + description=None, + ), + ] + + with ( + patch("homeassistant.components.zha.config_flow.is_hassio", return_value=False), + patch( + "homeassistant.components.zha.config_flow.scan_serial_ports", + return_value=mock_ports, + ), + ): + ports = await config_flow.list_serial_ports(hass) + + # ZWA-2 should be filtered out, others should remain + assert len(ports) == 5 + + assert ports[0].device == "/dev/ttyUSB1" + assert ports[0].manufacturer == "Nabu Casa" + assert ports[0].description == "ZBT-2" + + assert ports[1].device == "/dev/ttyUSB2" + assert ports[1].manufacturer == "Nabu Casa" + assert ports[1].description == "Home Assistant Connect ZBT-1" + + assert ports[2].device == "/dev/ttyUSB3" + assert ports[2].manufacturer == "Nabu Casa" + assert ports[2].description == "SkyConnect v1.0" + + assert ports[3].device == "/dev/ttyUSB4" + assert ports[3].manufacturer == "Another Manufacturer" + assert ports[3].description == "Zigbee USB Adapter" + + assert ports[4].device == "/dev/ttyUSB5" + assert ports[4].manufacturer is None + assert ports[4].description is None + + @patch( "homeassistant.components.zha.config_flow.list_serial_ports", AsyncMock(return_value=[usb_port()]),