Allow port and SNMP community configuration for Brother printer (home-assistant#151506)

bieniu · web-flow · commit 63303bdcde80 · 2025-09-12T00:21:05.000+02:00
diff --git a/homeassistant/components/brother/__init__.py b/homeassistant/components/brother/__init__.py
@@ -2,28 +2,40 @@
 
 from __future__ import annotations
 
+import logging
+
 from brother import Brother, SnmpError
 
 from homeassistant.components.snmp import async_get_snmp_engine
-from homeassistant.const import CONF_HOST, CONF_TYPE, Platform
+from homeassistant.const import CONF_HOST, CONF_PORT, CONF_TYPE, Platform
 from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import ConfigEntryNotReady
 
-from .const import DOMAIN
+from .const import (
+    CONF_COMMUNITY,
+    DEFAULT_COMMUNITY,
+    DEFAULT_PORT,
+    DOMAIN,
+    SECTION_ADVANCED_SETTINGS,
+)
 from .coordinator import BrotherConfigEntry, BrotherDataUpdateCoordinator
 
+_LOGGER = logging.getLogger(__name__)
+
 PLATFORMS = [Platform.SENSOR]
 
 
 async def async_setup_entry(hass: HomeAssistant, entry: BrotherConfigEntry) -> bool:
     """Set up Brother from a config entry."""
     host = entry.data[CONF_HOST]
+    port = entry.data[SECTION_ADVANCED_SETTINGS][CONF_PORT]
+    community = entry.data[SECTION_ADVANCED_SETTINGS][CONF_COMMUNITY]
     printer_type = entry.data[CONF_TYPE]
 
     snmp_engine = await async_get_snmp_engine(hass)
     try:
         brother = await Brother.create(
-            host, printer_type=printer_type, snmp_engine=snmp_engine
+            host, port, community, printer_type=printer_type, snmp_engine=snmp_engine
         )
     except (ConnectionError, SnmpError, TimeoutError) as error:
         raise ConfigEntryNotReady(
@@ -48,3 +60,22 @@ async def async_setup_entry(hass: HomeAssistant, entry: BrotherConfigEntry) -> b
 async def async_unload_entry(hass: HomeAssistant, entry: BrotherConfigEntry) -> bool:
     """Unload a config entry."""
     return await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
+
+
+async def async_migrate_entry(hass: HomeAssistant, entry: BrotherConfigEntry) -> bool:
+    """Migrate an old entry."""
+    if entry.version == 1 and entry.minor_version < 2:
+        new_data = entry.data.copy()
+        new_data[SECTION_ADVANCED_SETTINGS] = {
+            CONF_PORT: DEFAULT_PORT,
+            CONF_COMMUNITY: DEFAULT_COMMUNITY,
+        }
+        hass.config_entries.async_update_entry(entry, data=new_data, minor_version=2)
+
+    _LOGGER.info(
+        "Migration to configuration version %s.%s successful",
+        entry.version,
+        entry.minor_version,
+    )
+
+    return True
diff --git a/homeassistant/components/brother/config_flow.py b/homeassistant/components/brother/config_flow.py
@@ -9,21 +9,65 @@
 
 from homeassistant.components.snmp import async_get_snmp_engine
 from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
-from homeassistant.const import CONF_HOST, CONF_TYPE
+from homeassistant.const import CONF_HOST, CONF_PORT, CONF_TYPE
 from homeassistant.core import HomeAssistant
+from homeassistant.data_entry_flow import section
 from homeassistant.exceptions import HomeAssistantError
 from homeassistant.helpers.service_info.zeroconf import ZeroconfServiceInfo
 from homeassistant.util.network import is_host_valid
 
-from .const import DOMAIN, PRINTER_TYPES
+from .const import (
+    CONF_COMMUNITY,
+    DEFAULT_COMMUNITY,
+    DEFAULT_PORT,
+    DOMAIN,
+    PRINTER_TYPES,
+    SECTION_ADVANCED_SETTINGS,
+)
 
 DATA_SCHEMA = vol.Schema(
     {
         vol.Required(CONF_HOST): str,
         vol.Optional(CONF_TYPE, default="laser"): vol.In(PRINTER_TYPES),
+        vol.Required(SECTION_ADVANCED_SETTINGS): section(
+            vol.Schema(
+                {
+                    vol.Required(CONF_PORT, default=DEFAULT_PORT): int,
+                    vol.Required(CONF_COMMUNITY, default=DEFAULT_COMMUNITY): str,
+                },
+            ),
+            {"collapsed": True},
+        ),
+    }
+)
+ZEROCONF_SCHEMA = vol.Schema(
+    {
+        vol.Optional(CONF_TYPE, default="laser"): vol.In(PRINTER_TYPES),
+        vol.Required(SECTION_ADVANCED_SETTINGS): section(
+            vol.Schema(
+                {
+                    vol.Required(CONF_PORT, default=DEFAULT_PORT): int,
+                    vol.Required(CONF_COMMUNITY, default=DEFAULT_COMMUNITY): str,
+                },
+            ),
+            {"collapsed": True},
+        ),
+    }
+)
+RECONFIGURE_SCHEMA = vol.Schema(
+    {
+        vol.Required(CONF_HOST): str,
+        vol.Required(SECTION_ADVANCED_SETTINGS): section(
+            vol.Schema(
+                {
+                    vol.Required(CONF_PORT, default=DEFAULT_PORT): int,
+                    vol.Required(CONF_COMMUNITY, default=DEFAULT_COMMUNITY): str,
+                },
+            ),
+            {"collapsed": True},
+        ),
     }
 )
-RECONFIGURE_SCHEMA = vol.Schema({vol.Required(CONF_HOST): str})
 
 
 async def validate_input(
@@ -35,7 +79,12 @@ async def validate_input(
 
     snmp_engine = await async_get_snmp_engine(hass)
 
-    brother = await Brother.create(user_input[CONF_HOST], snmp_engine=snmp_engine)
+    brother = await Brother.create(
+        user_input[CONF_HOST],
+        user_input[SECTION_ADVANCED_SETTINGS][CONF_PORT],
+        user_input[SECTION_ADVANCED_SETTINGS][CONF_COMMUNITY],
+        snmp_engine=snmp_engine,
+    )
     await brother.async_update()
 
     if expected_mac is not None and brother.serial.lower() != expected_mac:
@@ -48,6 +97,7 @@ class BrotherConfigFlow(ConfigFlow, domain=DOMAIN):
     """Handle a config flow for Brother Printer."""
 
     VERSION = 1
+    MINOR_VERSION = 2
 
     def __init__(self) -> None:
         """Initialize."""
@@ -126,13 +176,11 @@ async def async_step_zeroconf_confirm(
             title = f"{self.brother.model} {self.brother.serial}"
             return self.async_create_entry(
                 title=title,
-                data={CONF_HOST: self.host, CONF_TYPE: user_input[CONF_TYPE]},
+                data={CONF_HOST: self.host, **user_input},
             )
         return self.async_show_form(
             step_id="zeroconf_confirm",
-            data_schema=vol.Schema(
-                {vol.Optional(CONF_TYPE, default="laser"): vol.In(PRINTER_TYPES)}
-            ),
+            data_schema=ZEROCONF_SCHEMA,
             description_placeholders={
                 "serial_number": self.brother.serial,
                 "model": self.brother.model,
@@ -160,7 +208,7 @@ async def async_step_reconfigure(
             else:
                 return self.async_update_reload_and_abort(
                     entry,
-                    data_updates={CONF_HOST: user_input[CONF_HOST]},
+                    data_updates=user_input,
                 )
 
         return self.async_show_form(
diff --git a/homeassistant/components/brother/const.py b/homeassistant/components/brother/const.py
@@ -10,3 +10,10 @@
 PRINTER_TYPES: Final = ["laser", "ink"]
 
 UPDATE_INTERVAL = timedelta(seconds=30)
+
+SECTION_ADVANCED_SETTINGS = "advanced_settings"
+
+CONF_COMMUNITY = "community"
+
+DEFAULT_COMMUNITY = "public"
+DEFAULT_PORT = 161
diff --git a/homeassistant/components/brother/strings.json b/homeassistant/components/brother/strings.json
@@ -8,14 +8,44 @@
           "type": "Type of the printer"
         },
         "data_description": {
-          "host": "The hostname or IP address of the Brother printer to control."
+          "host": "The hostname or IP address of the Brother printer to control.",
+          "type": "Brother printer type: ink or laser."
+        },
+        "sections": {
+          "advanced_settings": {
+            "name": "Advanced settings",
+            "data": {
+              "port": "[%key:common::config_flow::data::port%]",
+              "community": "SNMP Community"
+            },
+            "data_description": {
+              "port": "The SNMP port of the Brother printer.",
+              "community": "A simple password for devices to communicate to each other."
+            }
+          }
         }
       },
       "zeroconf_confirm": {
         "description": "Do you want to add the printer {model} with serial number `{serial_number}` to Home Assistant?",
         "title": "Discovered Brother Printer",
         "data": {
           "type": "[%key:component::brother::config::step::user::data::type%]"
+        },
+        "data_description": {
+          "type": "[%key:component::brother::config::step::user::data_description::type%]"
+        },
+        "sections": {
+          "advanced_settings": {
+            "name": "Advanced settings",
+            "data": {
+              "port": "[%key:common::config_flow::data::port%]",
+              "community": "SNMP Community"
+            },
+            "data_description": {
+              "port": "The SNMP port of the Brother printer.",
+              "community": "A simple password for devices to communicate to each other."
+            }
+          }
         }
       },
       "reconfigure": {
@@ -25,6 +55,19 @@
         },
         "data_description": {
           "host": "[%key:component::brother::config::step::user::data_description::host%]"
+        },
+        "sections": {
+          "advanced_settings": {
+            "name": "Advanced settings",
+            "data": {
+              "port": "[%key:common::config_flow::data::port%]",
+              "community": "SNMP Community"
+            },
+            "data_description": {
+              "port": "The SNMP port of the Brother printer.",
+              "community": "A simple password for devices to communicate to each other."
+            }
+          }
         }
       }
     },
diff --git a/tests/components/brother/conftest.py b/tests/components/brother/conftest.py
@@ -7,8 +7,12 @@
 from brother import BrotherSensors
 import pytest
 
-from homeassistant.components.brother.const import DOMAIN
-from homeassistant.const import CONF_HOST, CONF_TYPE
+from homeassistant.components.brother.const import (
+    CONF_COMMUNITY,
+    DOMAIN,
+    SECTION_ADVANCED_SETTINGS,
+)
+from homeassistant.const import CONF_HOST, CONF_PORT, CONF_TYPE
 
 from tests.common import MockConfigEntry
 
@@ -122,5 +126,10 @@ def mock_config_entry() -> MockConfigEntry:
         domain=DOMAIN,
         title="HL-L2340DW 0123456789",
         unique_id="0123456789",
-        data={CONF_HOST: "localhost", CONF_TYPE: "laser"},
+        data={
+            CONF_HOST: "localhost",
+            CONF_TYPE: "laser",
+            SECTION_ADVANCED_SETTINGS: {CONF_PORT: 161, CONF_COMMUNITY: "public"},
+        },
+        minor_version=2,
     )
diff --git a/tests/components/brother/snapshots/test_diagnostics.ambr b/tests/components/brother/snapshots/test_diagnostics.ambr
@@ -66,6 +66,10 @@
     }),
     'firmware': '1.2.3',
     'info': dict({
+      'advanced_settings': dict({
+        'community': 'public',
+        'port': 161,
+      }),
       'host': 'localhost',
       'type': 'laser',
     }),
diff --git a/tests/components/brother/test_config_flow.py b/tests/components/brother/test_config_flow.py
diff --git a/tests/components/brother/test_init.py b/tests/components/brother/test_init.py
