paho-mqtt library usage in Raspberry Pi - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the main purpose of the paho-mqtt library?

The paho-mqtt library helps devices like Raspberry Pi send and receive messages using the MQTT protocol, which is a simple way for devices to talk to each other over the internet.

beginner

How do you connect a Raspberry Pi client to an MQTT broker using paho-mqtt?

You create a client object, then use the connect() method with the broker's address and port to connect. For example:
client = mqtt.Client()
client.connect('broker.hivemq.com', 1883)

intermediate

What is the role of the on_message callback in paho-mqtt?

The on_message callback is a function you define to handle messages that arrive on topics you subscribed to. It runs automatically when a new message comes in.

beginner

How do you subscribe to a topic using paho-mqtt?

After connecting, you call client.subscribe('topic/name') to listen for messages sent to that topic.

beginner

What method do you use to send a message to a topic with paho-mqtt?

Use client.publish('topic/name', 'message') to send a message to the MQTT broker on the chosen topic.

Which method connects your Raspberry Pi client to the MQTT broker?

A connect()

B subscribe()

C publish()

D loop_forever()

The connect() method establishes the connection to the MQTT broker.

What does the subscribe() method do in paho-mqtt?

A Sends a message to a topic

B Connects to the broker

C Stops the client

D Listens for messages on a topic

subscribe() tells the client to listen for messages on a specific topic.

Which callback function handles incoming messages?

A on_connect

B on_message

C on_publish

D on_disconnect

on_message is called when a new message arrives on a subscribed topic.

What is the purpose of client.loop_forever()?

A To keep the client running and processing network events

B To disconnect from the broker

C To publish messages repeatedly

D To subscribe to multiple topics

loop_forever() keeps the client active to send and receive messages.

How do you publish a message 'Hello' to topic 'test/topic'?

A client.connect('test/topic', 'Hello')

B client.subscribe('test/topic', 'Hello')

C client.publish('test/topic', 'Hello')

D client.loop('test/topic', 'Hello')

publish() sends the message 'Hello' to the specified topic.

Explain the basic steps to set up a Raspberry Pi client using paho-mqtt to receive messages.

Think about how the client connects, listens, and reacts to messages.

Describe how to send a message from Raspberry Pi to an MQTT topic using paho-mqtt.

Focus on connection and publishing steps.

Practice

1. What is the main purpose of the paho-mqtt library on a Raspberry Pi?

easy

A. To send and receive messages using the MQTT protocol

B. To control the Raspberry Pi's GPIO pins

C. To create a web server on the Raspberry Pi

D. To manage file storage on the Raspberry Pi

Solution

1. Step 1: Understand MQTT protocol usage

   MQTT is a messaging protocol used for sending and receiving messages between devices.

2. Step 2: Identify paho-mqtt library role

   The paho-mqtt library allows Raspberry Pi to connect to MQTT brokers to publish and subscribe messages.

3. Final Answer:

   To send and receive messages using the MQTT protocol -> Option A

4. Quick Check:

   paho-mqtt = MQTT messaging [OK]

Hint: Remember: paho-mqtt is for MQTT messaging only [OK]

Common Mistakes:

• Confusing paho-mqtt with GPIO control libraries
• Thinking it manages web servers
• Assuming it handles file storage

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

easy

A. import mqtt.paho.client

B. import paho_mqtt_client as mqtt

C. import paho.mqtt.client as mqtt

D. import paho.mqtt as client

Solution

1. Step 1: Recall correct import syntax

   The official paho-mqtt Python client is imported as import paho.mqtt.client as mqtt.

2. Step 2: Check other options

   Other options use incorrect module names or syntax.

3. Final Answer:

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

4. Quick Check:

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

Hint: Use dots for module import, underscores are wrong here [OK]

Common Mistakes:

• Using underscores instead of dots in import
• Swapping module parts order
• Importing incomplete module path

3. What will the following code print when a message is received on topic 'test/topic'?

import paho.mqtt.client as mqtt

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

client = mqtt.Client()
client.on_message = on_message
client.connect('broker.hivemq.com', 1883)
client.subscribe('test/topic')
client.loop_start()

# Assume a message with payload 'Hello' is published to 'test/topic'

medium

A. Received b'Hello' on topic 'test/topic'

B. Received 'Hello' on topic 'test/topic'

C. Received 'Hello' on topic 'broker.hivemq.com'

D. No output because loop_start() is missing

Solution

1. Step 1: Understand on_message callback

   The callback decodes the message payload bytes to string and prints it with the topic.

2. Step 2: Check code behavior on receiving 'Hello'

   The payload 'Hello' is decoded and printed with the subscribed topic 'test/topic'.

3. Final Answer:

   Received 'Hello' on topic 'test/topic' -> Option B

4. Quick Check:

   Decoded payload + topic = Received 'Hello' on topic 'test/topic' [OK]

Hint: Decode payload bytes to string before printing [OK]

Common Mistakes:

• Printing raw bytes without decoding
• Confusing topic with broker address
• Forgetting to start the loop

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

import paho.mqtt.client as mqtt

client = mqtt.Client()
client.connect('broker.hivemq.com', 1883)
client.subscribe('home/temperature')
client.on_message = lambda c, u, m: print(m.payload)
# Missing client.loop_forever()

medium

A. The on_message callback is assigned after subscribe()

B. The subscribe topic is invalid

C. The broker address is incorrect

D. The client loop method to process network events is missing

Solution

1. Step 1: Check client loop usage

   MQTT client needs a loop method like loop_forever() or loop_start() to process messages.

2. Step 2: Verify other parts

   Assigning on_message after subscribe is allowed; broker and topic are valid.

3. Final Answer:

   The client loop method to process network events is missing -> Option D

4. Quick Check:

   Missing loop = no message processing [OK]

Hint: Always run client.loop_start() or loop_forever() after setup [OK]

Common Mistakes:

• Not running the client loop to handle messages
• Thinking on_message must be set before subscribe
• Assuming broker or topic is wrong without checking

5. You want your Raspberry Pi to publish temperature data every 10 seconds to topic 'home/temperature' using paho-mqtt. Which code snippet correctly implements this with proper connection, publishing, and loop handling? A)

import paho.mqtt.client as mqtt
import time

client = mqtt.Client()
client.connect('broker.hivemq.com', 1883)

while True:
    client.publish('home/temperature', '22.5')
    time.sleep(10)

B)

import paho.mqtt.client as mqtt
import time

client = mqtt.Client()
client.connect('broker.hivemq.com', 1883)
client.loop_start()

while True:
    client.publish('home/temperature', '22.5')
    time.sleep(10)

C)

import paho.mqtt.client as mqtt
import time

client = mqtt.Client()
client.loop_start()
client.connect('broker.hivemq.com', 1883)

while True:
    client.publish('home/temperature', '22.5')
    time.sleep(10)

D)

import paho.mqtt.client as mqtt
import time

client = mqtt.Client()
client.connect('broker.hivemq.com', 1883)
client.loop_forever()

while True:
    client.publish('home/temperature', '22.5')
    time.sleep(10)

hard

A. Connect, start loop, then publish in a loop

B. Connect and publish without starting the loop

C. Start loop before connecting, then publish

D. Use loop_forever() which blocks before publishing

Solution

1. Step 1: Understand client loop and connection order

   Client must connect first, then start the network loop with loop_start() to handle background MQTT tasks.

2. Step 2: Check each option's order and behavior

   Connect and publish without starting the loop connects and publishes without starting the loop, missing network processing. Connect, start loop, then publish in a loop correctly connects, starts loop, then publishes repeatedly. Start loop before connecting, then publish starts loop before connect (incorrect order). Use loop_forever() which blocks before publishing blocks with loop_forever() preventing publishing.

3. Final Answer:

   Connect, start loop, then publish in a loop -> Option A

4. Quick Check:

   Connect -> loop_start() -> publish loop = Connect, start loop, then publish in a loop [OK]

Hint: Always connect before loop_start(), loop_forever() blocks code [OK]

Common Mistakes:

• Starting loop before connecting
• Not starting loop at all
• Using loop_forever() which blocks publishing code