Support connecting to MQTT brokers on non-standard ports

This patch makes the broker port configurable by adding a 'port' field to Settings.MQTT.
It incorporates parts of 2f2d5c9.

Signed-off-by: Timo Beckers <timo@incline.eu>

ha_mqtt_discoverable/__init__.py

@@ -544,6 +544,7 @@ class MQTT(BaseModel):
         """Connection settings for the MQTT broker"""
 
         host: str
+        port: Optional[int] = 1883
         username: Optional[str] = None
         password: Optional[str] = None
         client_name: Optional[str] = None
@@ -668,11 +669,13 @@ def _setup_client(self, on_connect: Optional[Callable] = None) -> None:
         mqtt_settings = self._settings.mqtt
         logger.debug(
             f"Creating mqtt client({mqtt_settings.client_name}) for "
-            "{mqtt_settings.host}"
+            "{mqtt_settings.host}:{mqtt_settings.port}"
         )
         self.mqtt_client = mqtt.Client(mqtt_settings.client_name)
         if mqtt_settings.tls_key:
-            logger.info(f"Connecting to {mqtt_settings.host} with SSL")
+            logger.info(
+                f"Connecting to {mqtt_settings.host}:{mqtt_settings.port} with SSL"
+            )
             logger.debug(f"ca_certs={mqtt_settings.tls_ca_cert}")
             logger.debug(f"certfile={mqtt_settings.tls_certfile}")
             logger.debug(f"keyfile={mqtt_settings.tls_key}")
@@ -684,7 +687,9 @@ def _setup_client(self, on_connect: Optional[Callable] = None) -> None:
                 tls_version=ssl.PROTOCOL_TLS,
             )
         else:
-            logger.debug(f"Connecting to {mqtt_settings.host} without SSL")
+            logger.debug(
+                f"Connecting to {mqtt_settings.host}:{mqtt_settings.port} without SSL"
+            )
             if mqtt_settings.username:
                 self.mqtt_client.username_pw_set(
                     mqtt_settings.username, password=mqtt_settings.password
@@ -699,7 +704,9 @@ def _setup_client(self, on_connect: Optional[Callable] = None) -> None:
     def _connect_client(self) -> None:
         """Connect the client to the MQTT broker, start its onw internal loop in
         a separate thread"""
-        result = self.mqtt_client.connect(self._settings.mqtt.host)
+        result = self.mqtt_client.connect(
+            self._settings.mqtt.host, self._settings.mqtt.port
+        )
         # Check if we have established a connection
         if result != mqtt.MQTT_ERR_SUCCESS:
             raise RuntimeError("Error while connecting to MQTT broker")
@@ -749,7 +756,7 @@ def delete(self) -> None:
         config_message = ""
         logger.info(
             f"Writing '{config_message}' to topic {self.config_topic} on "
-            "{self._settings.mqtt.host}"
+            "{self._settings.mqtt.host}:{self._settings.mqtt.port}"
         )
         self.mqtt_client.publish(self.config_topic, config_message, retain=True)
 
@@ -783,7 +790,7 @@ def write_config(self):
 
         logger.debug(
             f"Writing '{config_message}' to topic {self.config_topic} on "
-            "{self._settings.mqtt.host}"
+            "{self._settings.mqtt.host}:{self._settings.mqtt.port}"
         )
         self.wrote_configuration = True
         self.config_message = config_message

ha_mqtt_discoverable/cli/__init__.py

@@ -52,6 +52,7 @@ def create_base_parser(description: str = "Base parser"):
     parser.add_argument("--mqtt-user", type=str, help="MQTT user.")
     parser.add_argument("--mqtt-password", type=str, help="MQTT password.")
     parser.add_argument("--mqtt-server", type=str, help="MQTT server.")
+    parser.add_argument("--mqtt-port", type=str, help="MQTT port.", default=1883)
     parser.add_argument("--settings-file", type=str, help="Settings file.")
 
     parser.add_argument("--use-tls", "--use-ssl", action="store_true", help="Use TLS.")

ha_mqtt_discoverable/settings.py

@@ -17,7 +17,6 @@
 
 from ha_mqtt_discoverable.utils import read_yaml_file
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -43,6 +42,7 @@ def load_mqtt_settings(path: str = None, cli=None) -> dict:
     settings["mqtt_password"] = cli.mqtt_password
     settings["mqtt_prefix"] = cli.mqtt_prefix
     settings["mqtt_server"] = cli.mqtt_server
+    settings["mqtt_port"] = cli.mqtt_port
     settings["mqtt_user"] = cli.mqtt_user
 
     # Optional settings - make sure we don't raise an exception if they're unset
@@ -73,6 +73,8 @@ def load_mqtt_settings(path: str = None, cli=None) -> dict:
         raise RuntimeError("No device_name was specified")
     if "mqtt_prefix" not in settings:
         raise RuntimeError("You need to specify an mqtt prefix")
+    if "mqtt_port" not in settings:
+        raise RuntimeError("You need to specify an mqtt port")
     if "mqtt_user" not in settings:
         raise RuntimeError("No mqtt_user was specified")
     if "mqtt_password" not in settings:
@@ -105,6 +107,8 @@ def sensor_delete_settings(path: str = None, cli=None) -> dict:
         settings["mqtt_prefix"] = cli.mqtt_prefix
     if cli.mqtt_server:
         settings["mqtt_server"] = cli.mqtt_server
+    if cli.mqtt_port:
+        settings["mqtt_port"] = cli.mqtt_port
     if cli.mqtt_user:
         settings["mqtt_user"] = cli.mqtt_user
 
@@ -117,6 +121,8 @@ def sensor_delete_settings(path: str = None, cli=None) -> dict:
         raise RuntimeError("No device_name was specified")
     if "mqtt_prefix" not in settings:
         raise RuntimeError("You need to specify an mqtt prefix")
+    if "mqtt_port" not in settings:
+        raise RuntimeError("You need to specify an mqtt port")
     if "mqtt_user" not in settings:
         raise RuntimeError("No mqtt_user was specified")
     if "mqtt_password" not in settings: