Creating a subscriber node in ROS

Introduction

A subscriber node listens to messages from other parts of a robot system. It helps your program react when new data arrives.

When you want your robot to receive sensor data like camera images or distance measurements.

When you need to react to commands sent from another node, like moving or stopping.

When you want to monitor status updates from other parts of your robot system.

When you want to log or process information coming from other nodes in real time.

Syntax

ROS

import rclpy
from rclpy.node import Node
from std_msgs.msg import String

class MinimalSubscriber(Node):
    def __init__(self):
        super().__init__('minimal_subscriber')
        self.subscription = self.create_subscription(
            String,
            'topic',
            self.listener_callback,
            10)
        self.subscription  # prevent unused variable warning

    def listener_callback(self, msg):
        self.get_logger().info('I heard: "%s"' % msg.data)


def main(args=None):
    rclpy.init(args=args)
    minimal_subscriber = MinimalSubscriber()
    rclpy.spin(minimal_subscriber)
    minimal_subscriber.destroy_node()
    rclpy.shutdown()

if __name__ == '__main__':
    main()

The create_subscription method sets up the subscriber.

The callback function runs every time a new message arrives.

Examples

Subscribe to the 'chatter' topic with message type String and a callback.

ROS

self.subscription = self.create_subscription(String, 'chatter', self.listener_callback, 10)

Callback prints the received message data.

ROS

def listener_callback(self, msg):
    self.get_logger().info(f'Received: {msg.data}')

Sample Program

This program creates a subscriber node named 'minimal_subscriber'. It listens to the 'greetings' topic for String messages. When a message arrives, it prints the message content.

ROS

import rclpy
from rclpy.node import Node
from std_msgs.msg import String

class MinimalSubscriber(Node):
    def __init__(self):
        super().__init__('minimal_subscriber')
        self.subscription = self.create_subscription(
            String,
            'greetings',
            self.listener_callback,
            10)
        self.subscription  # prevent unused variable warning

    def listener_callback(self, msg):
        self.get_logger().info(f'I heard: "{msg.data}"')


def main(args=None):
    rclpy.init(args=args)
    minimal_subscriber = MinimalSubscriber()
    rclpy.spin(minimal_subscriber)
    minimal_subscriber.destroy_node()
    rclpy.shutdown()

if __name__ == '__main__':
    main()

Important Notes

Make sure the topic name matches the publisher's topic exactly.

The queue size (here 10) controls how many messages to store if they arrive faster than processed.

Use rclpy.spin() to keep the node alive and listening.

Summary

A subscriber node listens to messages on a topic.

Use create_subscription with message type, topic name, callback, and queue size.

The callback runs each time a new message arrives.

Practice

1.

What is the main purpose of a subscriber node in ROS?

easy

A. To send messages to other nodes

B. To listen and react to messages published on a topic

C. To create new topics for communication

D. To store messages permanently

Solution

1. Step 1: Understand the role of a subscriber node

   A subscriber node listens to messages sent on a specific topic in ROS.

2. Step 2: Compare options with the subscriber role

   Only To listen and react to messages published on a topic describes listening and reacting to messages, which matches the subscriber's purpose.

3. Final Answer:

   To listen and react to messages published on a topic -> Option B

4. Quick Check:

   Subscriber node = listens to messages [OK]

Hint: Subscriber nodes always listen to topics, not send [OK]

Common Mistakes:

• Confusing subscriber with publisher
• Thinking subscriber creates topics
• Assuming subscriber stores messages permanently

2.

Which of the following is the correct way to create a subscriber in ROS 2 Python?

node.create_subscription(____, 'chatter', callback, 10)

easy

A. std_msgs.msg.String

B. String

C. std_msgs/String

D. string

Solution

1. Step 1: Identify the correct message type import

   In ROS 2 Python, message types are imported as modules, e.g., std_msgs.msg.String.

2. Step 2: Match the correct syntax for create_subscription

   The first argument must be the full message type class, so std_msgs.msg.String is correct.

3. Final Answer:

   std_msgs.msg.String -> Option A

4. Quick Check:

   Message type = std_msgs.msg.String [OK]

Hint: Use full message type path with .msg in ROS 2 Python [OK]

Common Mistakes:

• Using just 'String' without module path
• Using slash notation like 'std_msgs/String'
• Using lowercase 'string' instead of class name

3.

Given this ROS 2 Python subscriber code snippet, what will be printed when a message with data 'Hello' arrives?

def callback(msg):
    print(f'Received: {msg.data}')

node.create_subscription(std_msgs.msg.String, 'chatter', callback, 10)

medium

A. Received: msg.data

B. Hello

C. Received: Hello

D. msg.data

Solution

1. Step 1: Understand the callback function

   The callback prints 'Received: ' followed by the message's data attribute.

2. Step 2: Substitute the message data value

   When the message data is 'Hello', the print outputs 'Received: Hello'.

3. Final Answer:

   Received: Hello -> Option C

4. Quick Check:

   Prints 'Received: ' + msg.data [OK]

Hint: Callback prints 'Received: ' plus message data [OK]

Common Mistakes:

• Printing just the data without prefix
• Printing the variable name instead of its value
• Confusing string formatting syntax

4.

What is wrong with this ROS 2 Python subscriber code?

def callback(msg):
    print(msg.data)

node.create_subscription(std_msgs.msg.String, 'chatter', callback())

medium

A. Missing message type in create_subscription

B. Queue size argument is missing but required

C. Topic name should be a variable, not a string

D. Callback is called immediately instead of passed as a function

Solution

1. Step 1: Check how callback is passed

   The code uses callback() which calls the function immediately instead of passing the function reference.

2. Step 2: Understand correct callback usage

   We must pass callback without parentheses so it is called on message arrival.

3. Final Answer:

   Callback is called immediately instead of passed as a function -> Option D

4. Quick Check:

   Pass callback function, not call it [OK]

Hint: Pass callback without () to create_subscription [OK]

Common Mistakes:

• Adding parentheses to callback in subscription
• Omitting queue size argument (optional in some versions)
• Using variable instead of string for topic name

5.

You want to create a subscriber node that listens to the topic 'sensor_data' and prints only messages where the data is greater than 10. Which callback function correctly implements this?

def callback(msg):
    # Fill in the condition
    if ____:
        print(f"Data: {msg.data}")

hard

A. msg.data > 10

B. msg.data >= 10

C. msg.data < 10

D. msg.data == 10

Solution

1. Step 1: Understand the requirement

   We want to print messages only if data is greater than 10, so the condition must check msg.data > 10.

2. Step 2: Compare options with condition

   msg.data > 10 matches exactly 'greater than 10'. Others check equal or less, which do not meet the requirement.

3. Final Answer:

   msg.data > 10 -> Option A

4. Quick Check:

   Condition for data > 10 is msg.data > 10 [OK]

Hint: Use > 10 to filter messages with data above 10 [OK]

Common Mistakes:

• Using >= instead of > changes condition
• Using < or == prints wrong messages
• Not adding any condition prints all messages