MQTT client with Python (paho-mqtt) in IOT Protocols - Mini Project: Build & Apply

MQTT client with Python (paho-mqtt)

📖 Scenario: You want to create a simple program that connects to an MQTT broker and listens for messages on a specific topic. MQTT is a messaging protocol often used in IoT devices to send data efficiently.Imagine you have a smart home sensor that sends temperature updates. Your program will subscribe to these updates and print them out.

🎯 Goal: Build a Python MQTT client using the paho-mqtt library that connects to a broker, subscribes to a topic, and prints received messages.

📋 What You'll Learn

Use the paho.mqtt.client library

Connect to the broker at test.mosquitto.org on port 1883

Subscribe to the topic home/sensor/temperature

Print any message received on that topic

💡 Why This Matters

🌍 Real World

MQTT is widely used in IoT devices like sensors, smart home gadgets, and industrial equipment to send data efficiently over networks.

💼 Career

Understanding how to build MQTT clients is useful for roles in IoT development, DevOps for IoT infrastructure, and automation engineers working with device communication.

1

Setup MQTT client and connect to broker

Import the paho.mqtt.client module as mqtt. Create a client object called client using mqtt.Client(). Connect client to the broker at test.mosquitto.org on port 1883 using client.connect().

IOT Protocols

# Import paho.mqtt.client as mqtt
# Create client with mqtt.Client()
# Connect client to 'test.mosquitto.org' on port 1883
# Your code here

Hint

Use import paho.mqtt.client as mqtt to import the library. Then create the client with mqtt.Client(). Use client.connect() with the broker address and port.

2

Subscribe to the temperature topic

Use the client.subscribe() method to subscribe to the topic 'home/sensor/temperature'.

IOT Protocols

import paho.mqtt.client as mqtt

client = mqtt.Client()
client.connect('test.mosquitto.org', 1883)
# Subscribe to 'home/sensor/temperature' topic
# Your code here

Hint

Call client.subscribe() with the exact topic string 'home/sensor/temperature'.

3

Define a message callback to print received messages

Define a function called on_message that takes parameters client, userdata, and msg. Inside the function, print the topic and message payload decoded as UTF-8. Assign this function to client.on_message.

IOT Protocols

import paho.mqtt.client as mqtt

client = mqtt.Client()
client.connect('test.mosquitto.org', 1883)
client.subscribe('home/sensor/temperature')
# Define on_message callback function
# Assign it to client.on_message
# Your code here

Hint

The callback function on_message receives the message object msg. Use msg.topic and msg.payload.decode('utf-8') to get the topic and message text.

4

Start the MQTT client loop to listen for messages

Call client.loop_forever() to start the network loop and keep the client listening for messages indefinitely.

IOT Protocols

import paho.mqtt.client as mqtt

client = mqtt.Client()
client.connect('test.mosquitto.org', 1883)
client.subscribe('home/sensor/temperature')

def on_message(client, userdata, msg):
    print(f"Received message on topic {msg.topic}: {msg.payload.decode('utf-8')}")

client.on_message = on_message
# Start the MQTT client loop
# Your code here

Hint

Use client.loop_forever() to keep the client running and listening for messages.

Practice

1. What is the main purpose of the paho-mqtt library in Python?

easy

A. To manage databases in Python

B. To create web servers in Python

C. To connect and communicate with MQTT brokers using Python

D. To build graphical user interfaces in Python

Solution

1. Step 1: Understand the role of paho-mqtt

   The paho-mqtt library is designed to help Python programs connect to MQTT brokers and send or receive messages.

2. Step 2: Compare with other options

   Options B, C, and D describe unrelated tasks like web servers, databases, or GUIs, which paho-mqtt does not handle.

3. Final Answer:

   To connect and communicate with MQTT brokers using Python -> Option C

4. Quick Check:

   paho-mqtt = MQTT communication [OK]

Hint: paho-mqtt is for MQTT messaging in Python [OK]

Common Mistakes:

• Confusing paho-mqtt with web or database libraries
• Thinking it manages GUIs
• Assuming it is a general networking library

2. Which of the following is the correct way to import the MQTT client class from the paho-mqtt library in Python?

easy

A. import paho.mqtt.client as mqtt

B. from paho.mqtt import Client

C. from paho import mqtt_client

D. import mqtt from paho.client

Solution

1. Step 1: Recall the standard import syntax for paho-mqtt

   The common and correct way is to import the client module as an alias: import paho.mqtt.client as mqtt.

2. Step 2: Check other options for syntax errors

   from paho.mqtt import Client is incorrect because the Client class is inside the client module, not directly in paho.mqtt. from paho import mqtt_client and D have invalid import syntax.

3. Final Answer:

   import paho.mqtt.client as mqtt -> Option A

4. Quick Check:

   Correct import = import paho.mqtt.client as mqtt [OK]

Hint: Use 'import paho.mqtt.client as mqtt' to import client [OK]

Common Mistakes:

• Trying to import Client directly from paho.mqtt
• Using invalid Python import syntax
• Confusing module and class names

3. What will be the output of this Python code snippet using paho-mqtt?

import paho.mqtt.client as mqtt

def on_connect(client, userdata, flags, rc):
    print(f"Connected with result code {rc}")
    client.subscribe("test/topic")

def on_message(client, userdata, msg):
    print(f"Received message: {msg.payload.decode()}")

client = mqtt.Client()
client.on_connect = on_connect
client.on_message = on_message
client.connect("broker.hivemq.com", 1883, 60)
client.loop_start()
client.publish("test/topic", "Hello MQTT")
import time
time.sleep(2)
client.loop_stop()

medium

A. Connected with result code 0
No message received

B. Connected with result code 1
Received message: Hello MQTT

C. No output because callbacks are not set

D. Connected with result code 0
Received message: Hello MQTT

Solution

1. Step 1: Analyze connection and subscription

   The on_connect callback prints the connection result code (0 means success) and subscribes to "test/topic".

2. Step 2: Analyze message publishing and receiving

   The client publishes "Hello MQTT" to "test/topic". Since it subscribed to the same topic, on_message is triggered and prints the received message.

3. Final Answer:

   Connected with result code 0 Received message: Hello MQTT -> Option D

4. Quick Check:

   Successful connect and message received = Connected with result code 0 Received message: Hello MQTT [OK]

Hint: Subscribe before publish to receive your own message [OK]

Common Mistakes:

• Assuming result code 1 means success
• Forgetting to start the loop for callbacks
• Not decoding message payload

4. Identify the error in this MQTT client code snippet:

import paho.mqtt.client as mqtt

client = mqtt.Client()
client.connect("broker.hivemq.com", 1883)
client.publish("test/topic", "Hello")
client.loop_forever()

medium

A. Missing callback functions for connect and message

B. connect() missing the keepalive parameter

C. loop_forever() should be called before publish()

D. No error; code will run correctly

Solution

1. Step 1: Check for required callbacks

   The code does not set any callbacks like on_connect or on_message, so it won't handle connection confirmation or incoming messages properly.

2. Step 2: Validate connect and loop usage

   The connect call is valid with default keepalive, and loop_forever() is correctly placed after publish to keep the client running.

3. Final Answer:

   Missing callback functions for connect and message -> Option A

4. Quick Check:

   Callbacks missing = Missing callback functions for connect and message [OK]

Hint: Always set on_connect and on_message callbacks [OK]

Common Mistakes:

• Ignoring callbacks causes silent failures
• Assuming connect needs explicit keepalive
• Calling loop_forever before publish

5. You want to create an MQTT client in Python that connects to a broker, subscribes to multiple topics, and prints messages only from topics starting with "home/". Which approach correctly implements this filtering?

hard

A. Subscribe to all topics with client.subscribe("#") and in on_message, check if msg.topic.startswith("home/") before printing

B. Subscribe only to "home/#" and print all received messages in on_message

C. Subscribe to "home/" and print messages if msg.payload == "home"

D. Subscribe to "home/#" but ignore all messages in on_message

Solution

1. Step 1: Understand MQTT topic wildcards

   The subscription "home/#" subscribes to all topics starting with "home/", which is the correct way to filter topics at the broker level.

2. Step 2: Handle messages in on_message

   Since only relevant topics are subscribed, the on_message callback can print all messages without extra filtering.

3. Final Answer:

   Subscribe only to "home/#" and print all received messages in on_message -> Option B

4. Quick Check:

   Use topic wildcard subscription for filtering [OK]

Hint: Use 'home/#' to subscribe to all home topics [OK]

Common Mistakes:

• Subscribing to '#' and filtering in code is less efficient
• Using 'home/' without '#' subscribes only to exact topic
• Ignoring message filtering logic