net: mqtt-sn: Update MQTT-SN Publisher Sample with Gateway Discovery

Fixes: #78010
This commit adds the "Gateway Advertisement and Discovery" process
to the MQTT-SN Publisher Sample application.

Signed-off-by: Kenneth Witham <[email protected]>

Author: SpontaneousDuck

samples/net/mqtt_sn_publisher/Kconfig

@@ -5,12 +5,22 @@
 
 mainmenu "MQTT-SN sample application"
 
+config NET_SAMPLE_MQTT_SN_STATIC_GATEWAY
+	bool "Whether to statically define the Gateway. Will use Search procedure if False."
+
 config NET_SAMPLE_MQTT_SN_GATEWAY_IP
-	string "IP of the MQTT-SN gateway"
+	string "IP of the MQTT-SN gateway. Only used if NET_SAMPLE_MQTT_SN_STATIC_GATEWAY=n."
+	depends on NET_SAMPLE_MQTT_SN_STATIC_GATEWAY
 
 config NET_SAMPLE_MQTT_SN_GATEWAY_PORT
 	int "Port of the MQTT-SN gateway"
 
+config NET_SAMPLE_MQTT_SN_BROADCAST_IP
+	string "IP of the Broadcast address"
+
+config NET_SAMPLE_MQTT_SN_BROADCAST_PORT
+	int "Port of the MQTT-SN broadcast"
+
 config NET_SAMPLE_MQTT_SN_BUFFER_SIZE
 	int "Size of the TX and RX buffers"
 	default 255

samples/net/mqtt_sn_publisher/README.rst

@@ -40,13 +40,30 @@ Requirements
 Build and Running
 *****************
 
-Currently, this sample application only supports static IP addresses.
-Open the :file:`prj.conf` file and set the IP addresses according
-to the LAN environment.
+This sample application supports both static IP addresses and the Gateway Discovery process.
+Open the :zephyr_file:`samples/net/mqtt_sn_publisher/prj.conf` file and set the IP addresses according
+to the LAN environment. CONFIG_NET_SAMPLE_MQTT_SN_STATIC_GATEWAY can be used to select the
+static IP or Gateway discovery process.
 
-You will also need to start an MQTT-SN gateway. With Paho, you can either
-build it from source - see `PAHO MQTT-SN Gateway`_ - or run an unofficial
-docker image, like `kyberpunk/paho`_.
+You will also need to start an MQTT-SN gateway. A convenience Docker Compose specification file
+is provided in :zephyr_file:`samples/net/mqtt_sn_publisher/compose/compose.yaml`.
+First, Start the net-tools configuration from[here](https://github.com/zephyrproject-rtos/net-tools)
+with:
+
+.. code-block:: console
+
+	$ ./net-setup.sh --config docker.conf
+
+Then bring up the Docker environment in a separate terminal window with:
+
+.. code-block:: console
+
+	$ cd ./compose
+	$ docker compose up
+
+You can also set up this environment manually.With Paho, you can either build it
+from source - see `PAHO MQTT-SN Gateway`_ - or run an unofficial docker image, l
+ike `kyberpunk/paho`_.
 
 .. _PAHO MQTT-SN Gateway: https://www.eclipse.org/paho/index.php?page=components/mqtt-sn-transparent-gateway/index.php
 .. _kyberpunk/paho: https://hub.docker.com/r/kyberpunk/paho

samples/net/mqtt_sn_publisher/compose/compose.yaml

@@ -0,0 +1,21 @@
+services:
+  mosquitto:
+    image: eclipse-mosquitto:latest
+    volumes:
+      - ./mosquitto.conf:/mosquitto/config/mosquitto.conf:ro
+    restart: unless-stopped
+    networks:
+      net-tools:
+        ipv4_address: 192.0.2.3
+  mqttsn-gateway:
+    image: kyberpunk/paho
+    volumes:
+      - ./gateway.conf:/etc/paho/gateway.conf:ro
+    restart: unless-stopped
+    networks:
+      net-tools:
+        ipv4_address: 192.0.2.2
+networks:
+  net-tools:
+    name: net-tools0
+    external: true

samples/net/mqtt_sn_publisher/compose/gateway.conf

@@ -0,0 +1,107 @@
+#**************************************************************************
+# Copyright (c) 2016-2021, Tomoaki Yamaguchi
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v1.0
+# and Eclipse Distribution License v1.0 which accompany this distribution.
+#
+# The Eclipse Public License is available at
+#    http://www.eclipse.org/legal/epl-v10.html
+# and the Eclipse Distribution License is available at
+#   http://www.eclipse.org/org/documents/edl-v10.php.
+#***************************************************************************
+#
+# config file of MQTT-SN Gateway
+#
+
+GatewayID=1
+GatewayName=PahoGateway-01
+MaxNumberOfClients=30
+KeepAlive=60
+#LoginID=your_ID
+#Password=your_Password
+
+BrokerName=mosquitto
+BrokerPortNo=1883
+BrokerSecurePortNo=8883
+
+#
+# CertsKey for TLS connections to a broker
+#
+
+#RootCAfile=/etc/ssl/certs/ca-certificates.crt
+#RootCApath=/etc/ssl/certs/
+#CertKey=/path/to/certKey.pem
+#PrivateKey=/path/to/privateKey.pem
+
+#
+# When AggregatingGateway=YES or ClientAuthentication=YES,
+# All clients must be specified by the ClientList File
+#
+
+AggregatingGateway=NO
+QoS-1=NO
+Forwarder=NO
+PredefinedTopic=NO
+ClientAuthentication=NO
+
+ClientsList=/path/to/your_clients.conf
+PredefinedTopicList=/path/to/your_predefinedTopic.conf
+
+
+#==============================
+#  SensorNetworks parameters
+#==============================
+#
+# UDP | DTLS
+#
+
+GatewayPortNo=10000
+MulticastPortNo=1883
+MulticastIP=225.1.1.1
+MulticastTTL=1
+
+#
+# UDP6 | DTLS6
+#
+
+GatewayIPv6PortNo=10000
+MulticastIPv6PortNo=1883
+MulticastIPv6=ff1e:feed:caca:dead::1
+MulticastIPv6If=wlp4s0
+MulticastHops=1
+
+#
+# DTLS | DTLS6
+#
+
+DtlsCertsKey=/etc/ssl/certs/gateway.pem
+DtlsPrivKey=/etc/ssl/private/privkey.pem
+
+#
+# XBee
+#
+
+Baudrate=38400
+SerialDevice=/dev/ttyUSB0
+ApiMode=2
+
+#
+# LoRaLink
+#
+
+BaudrateLoRaLink=115200
+DeviceRxLoRaLink=/dev/loralinkRx
+DeviceTxLoRaLink=/dev/loralinkTx
+
+#
+# Bluetooth RFCOMM
+#
+
+RFCOMMAddress=60:57:18:06:8B:72.*
+
+#
+# LOG
+#
+
+ShearedMemory=NO