nRF5 IoT SDK  v0.9.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
MQTT Client - Publisher

The MQTT publisher example is an MQTT client that connects to the broker identified by the broker address configured in the example at compile time. If the connection succeeds, it is ready to publish the LED state information under the topic "led/state".

The example allows you to disconnect the MQTT client from the broker and then reconnect.

An overview of how the examples could be used are shown in the scenarios below. Scenario 1 is a complex, but possibly a real-time scenario where there are one or more publishers and subscribers. In this scenario not all MQTT clients (publishers/subscribers) have to be BLE enabled IPv6 devices; they could be computer applications and/or embedded devices, wired or wireless, that use MQTT as application protocol over the IP stack. This scenario is seen as a super-set of possible scenarios.


MQTT_Overall.svg
Scenario 1: Setup of the lwIP based MQTT application on nRF52


Scenario 2 shows a possible use case where the nRF52 SoC MQTT publisher is used to send a message to subscribers that are not BLE MQTT clients, such as computer applications. This scenario is realized when the mosquitto subscriber application is used to test the publisher application on the nRF52 SoC.


MQTT_Client.svg
Scenario 2: Setup of the lwIP based MQTT client publisher application on nRF52


Scenario 3 shows a possible use case where all the MQTT clients are nRF52 devices running MQTT clients, either publisher or subscriber. This scenario is realized when the subscriber and the publisher applications included in the IoT SDK are used to connect to the MQTT broker.


MQTT_Client_Server.svg
Scenario 3: Setup of the lwIP based MQTT client publisher and subscriber on nRF52


Common Modules Dependency and Usage

This section summarizes the usage of the nRF52 SoC resources and common modules in the examples, apart from the IoT 6LoWPAN and lwIP stack library.

Module Inclusion/Usage Description
Timer 3 Timer for lwIP, leds and the button module.
Button 3 Buttons are used to control the application. See the Overview section.
LEDs 4 LEDs are used to indicate the application states. See LED assignments.
Adv Data Encoder Yes The device name used is 'MQTTPublisher', the IPSP Service UUID is included in the UUID list.
Scheduler No Scheduler is used for processing stack events.
UART Trace Yes Tracing used to help mointor state of application.
Note
The lwIP library used for this example is under BSD-style license; this is different from the Nordic SDK license. The license text can be found at <InstallFolder>external/lwip/license.txt

Setup

The name of this example is iot_lwip_mqtt_publisher. You can find the source code and project file of the example in the following folder: <InstallFolder>/examples/iot/mqtt/publisher

LED assignments

  • Connection state:
    LED 1 LED 2 Description
    Blinking Off Device advertising as BLE peripheral.
    Off Blinking BLE link established, IPv6 interface down.
    On Off BLE link established, IPv6 interface up.
    Off On MQTT connection is established.
    On On Assertion failure in the application.
  • MQTT message publication:
    LED 3 LED 4
    Flashes once, if publishing of the LED state failed. Shows the last successfully published LED state.
    Both LED 3 and LED 4 are turned on in case of an assertion failure in the application.

Button assignments

Button Mapped Action
1 MQTT Connection Request
2 MQTT Publish Topic
3 MQTT Disconnection
Note
If commissioning is enabled, additional LED and Button assignments are made.

The example by default requests a secure connection on MQTT Secure port 8883. In order to disable security for MQTT clients, please follow the following setps.

  1. Change the MQTT broker port from 8883 to 1883 (or the non secure port that MQTT broker is configured to listen on).
  2. Edit the connection parameters for the mqtt_connect request as below. Change from:
    m_app_mqtt_client.transport_type = MQTT_TRANSPORT_SECURE;
    m_app_mqtt_client.p_security_settings = &m_tls_keys;
    uint32_t err_code = mqtt_connect(&m_app_mqtt_client);
    APP_ERROR_CHECK(err_code);
    To:
    m_app_mqtt_client.transport_type = MQTT_TRANSPORT_NON_SECURE;
    m_app_mqtt_client.p_security_settings = NULL;
    uint32_t err_code = mqtt_connect(&m_app_mqtt_client);
    APP_ERROR_CHECK(err_code);

MQTT Broker Setup

Please refer to Setting up the Mosquitto MQTT broker for detailed description of setting up mostquitto in various configurations.

Since the example uses security by default, the broker shall be setup to use TLS.

MQTT Subscriber setup

This section describes how mosquitto can be used as a subscriber application to test this example.

# Installation of mosquitto.
sudo apt-get install mosquitto-clients
# Running it in verbosity mode in default port 1883.
mosquitto_sub -t "led/state"

Testing

See Connecting devices to the router for a list of relevant Linux commands.

  1. Ensure that the MQTT broker address is set correct in the application.
  2. Open a terminal program (for example PUTTY) to monitor the messages from the kit on the COM port.
  3. Compile and program the application. Observe that the device is advertising.
  4. Prepare the Linux router device by initializing the 6LoWPAN module.
  5. Discover the advertising device by using the hcitool lescan command.
  6. Connect to the discovered device from the Linux console by using the Bluetooth 6LoWPAN connect command.
  7. Check if the connected state is reflected by the LEDs.
  8. Prepare the IPv6 global prefix for the btX interface.
  9. Push Button 1. Observe that the mosquitto broker reports a new connection from the client "nrfPublisher".
    1. Observe that LED 2 is ON, which means that the connection is established. In case the LED 2 is not turned on within 30 seconds, the procedure might have failed. This can be verified by observing a notification of MQTT_EVT_CONNECT with a failure (non-zero result code). Retry MQTT connection by pushing Button 1. Pushing the button before the procedure is complete, either with success or failure, will result in application assertion.
  10. Push Button 2.
  11. Observe that LED 4 is lit. This step may take several seconds to complete.
  12. Observe the publish message and its acknowledgement logged on the mosquitto broker.
    Note
    If a mosquitto subscriber subscribes to "led/state", it receives publish messages from the broker.
    If the nRF52 SoC kit running as the MQTT subscriber is also connected to the broker, observe LED 4 of the subscriber synchronising with the LED 4 of the publisher each time the topic is published.
  13. Pushing Button 2 repeatedly will toggle the state of LED 4 and send publish messages to the broker.
  14. Disconnect the MQTT connection with the broker by pressing Button 3. LED 3 is turned off on disconnection.
  15. Disconnect from the device by using the Bluetooth 6LoWPAN disconnect command.
  16. Observe that only the advertising LED is lit.