Request-response communication model in ROS - Mini Project: Build & Apply

Request-response communication model

📖 Scenario: You are building a simple ROS system where a client requests a number and the server responds with the square of that number.

🎯 Goal: Create a ROS request-response communication model with a server node that calculates the square of a number sent by a client node.

📋 What You'll Learn

Create a ROS service definition file named Square.srv with a request integer and a response integer.

Write a server node named square_server.py that receives a number and returns its square.

Write a client node named square_client.py that sends a number and receives the squared result.

Use ROS Python API (rospy) for implementation.

💡 Why This Matters

🌍 Real World

ROS request-response communication is used in robotics to ask for data or commands and get immediate answers, like asking a robot for sensor data or to perform a calculation.

💼 Career

Understanding ROS services is essential for robotics developers to build interactive and responsive robot applications.

1

Create the service definition file

Create a file named Square.srv with a request integer named number and a response integer named square. The file should contain exactly these two lines separated by a blank line.

ROS

# Create Square.srv with request and response integers
# Your code here

Hint

The service file has two parts separated by ---. The first part is the request, the second is the response.

2

Write the server node

Create a Python file named square_server.py. Import rospy and the service Square. Initialize a ROS node called square_server. Define a function handle_square(req) that returns req.number * req.number as the square. Create a service named square using Square and the handler function. Use rospy.spin() to keep the server running.

ROS

import rospy
from your_package.srv import Square, SquareResponse

# Initialize node
# Your code here

Hint

The handler function receives the request and returns the response wrapped in SquareResponse.

3

Write the client node

Create a Python file named square_client.py. Import rospy and the service Square. Initialize a ROS node called square_client. Wait for the square service to be available. Create a service proxy for square. Call the service with number=5 and store the response in resp.

ROS

import rospy
from your_package.srv import Square

# Initialize node
# Your code here

Hint

Use rospy.wait_for_service before creating the proxy to ensure the service is ready.

4

Complete the client with output

Add a line to print the squared result from resp.square with the message "Square of 5 is:". Use print function.

ROS

import rospy
from your_package.srv import Square

rospy.init_node('square_client')
rospy.wait_for_service('square')
square_service = rospy.ServiceProxy('square', Square)
resp = square_service(number=5)
# Your code here

Hint

Use print("Square of 5 is:", resp.square) to show the result.

Practice

1. In ROS, what does the request-response communication model primarily allow?

easy

A. One node sends a request and waits for a reply from another node

B. Nodes continuously publish data without expecting a reply

C. Nodes broadcast messages to all other nodes simultaneously

D. Nodes store data locally without communication

Solution

1. Step 1: Understand the request-response model in ROS

   This model involves one node sending a request message and waiting for a response from another node.

2. Step 2: Compare options with this model

   Only One node sends a request and waits for a reply from another node describes this direct ask-and-reply behavior, while others describe different communication types.

3. Final Answer:

   One node sends a request and waits for a reply from another node -> Option A

4. Quick Check:

   Request-response = direct ask and reply [OK]

Hint: Request-response means ask first, then wait for answer [OK]

Common Mistakes:

• Confusing request-response with continuous publishing
• Thinking request-response is broadcasting
• Assuming no reply is needed

2. Which of the following is the correct way to define a ROS service server in Python using the request-response model?

easy

A. service = rospy.Service('service_name', ServiceType, handler_function)

B. service = rospy.Publisher('service_name', ServiceType, handler_function)

C. service = rospy.Subscriber('service_name', ServiceType, handler_function)

D. service = rospy.Client('service_name', ServiceType, handler_function)

Solution

1. Step 1: Recall ROS Python service server syntax

   In ROS, a service server is created using rospy.Service with the service name, type, and handler function.

2. Step 2: Identify correct function

   Only rospy.Service matches this pattern; Publisher and Subscriber are for topics, Client is not a rospy function.

3. Final Answer:

   service = rospy.Service('service_name', ServiceType, handler_function) -> Option A

4. Quick Check:

   Service server uses rospy.Service [OK]

Hint: Service server uses rospy.Service, not Publisher or Subscriber [OK]

Common Mistakes:

• Using Publisher or Subscriber instead of Service
• Confusing client and server creation
• Wrong function names like rospy.Client

3. Given this ROS Python service client code snippet, what will be printed if the service responds with response.result = 42?

import rospy
from example.srv import AddTwoInts

def call_service():
    rospy.wait_for_service('add_two_ints')
    try:
        add_two_ints = rospy.ServiceProxy('add_two_ints', AddTwoInts)
        response = add_two_ints(20, 22)
        print(response.result)
    except rospy.ServiceException as e:
        print("Service call failed", e)

call_service()

medium

A. Service call failed

B. 42

C. 20

D. None

Solution

1. Step 1: Understand the service client call

   The client waits for the service, calls it with 20 and 22, and expects a response with a 'result' attribute.

2. Step 2: Analyze the response printing

   The code prints response.result, which is given as 42 in the question.

3. Final Answer:

   42 -> Option B

4. Quick Check:

   Print response.result = 42 [OK]

Hint: Prints the response.result value returned by the service [OK]

Common Mistakes:

• Confusing request parameters with response
• Expecting print of input values instead of response
• Assuming exception without error

4. What is wrong with this ROS Python service server code snippet?

import rospy
from example.srv import Multiply

def handle_multiply(req):
    return req.a * req.b

rospy.init_node('multiply_server')
service = rospy.Service('multiply', Multiply, handle_multiply)
rospy.spin()

medium

A. The service type Multiply is not imported correctly

B. The service name cannot be 'multiply'

C. The handler must return a response object, not just a number

D. rospy.spin() is missing

Solution

1. Step 1: Check the handler function return type

   In ROS services, the handler must return a response message object, not a raw value.

2. Step 2: Identify the error in return statement

   Returning req.a * req.b (a number) is incorrect; it should return MultiplyResponse(req.a * req.b) or equivalent.

3. Final Answer:

   The handler must return a response object, not just a number -> Option C

4. Quick Check:

   Handler returns response object, not raw value [OK]

Hint: Handler must return response message object, not raw data [OK]

Common Mistakes:

• Returning raw values instead of response objects
• Forgetting to import response message class
• Missing rospy.spin() (though present here)

5. You want to implement a ROS service that returns the sum of two integers only if both are positive; otherwise, it returns zero. Which handler function correctly implements this request-response logic?

hard

A. def handle_sum(req):
return SumTwoIntsResponse(req.a + req.b)

B. def handle_sum(req):
return SumTwoIntsResponse(req.a + req.b if req.a > 0 or req.b > 0 else 0)

C. def handle_sum(req):
if req.a > 0 or req.b > 0:
return SumTwoIntsResponse(req.a + req.b)
else:
return SumTwoIntsResponse(0)

D. def handle_sum(req):
if req.a > 0 and req.b > 0:
return SumTwoIntsResponse(req.a + req.b)
else:
return SumTwoIntsResponse(0)

Solution

1. Step 1: Understand the condition for sum

   The sum should be returned only if both req.a and req.b are positive (greater than zero).

2. Step 2: Check each option's condition logic

   def handle_sum(req): if req.a > 0 and req.b > 0: return SumTwoIntsResponse(req.a + req.b) else: return SumTwoIntsResponse(0) uses 'and' to check both positive, returning sum or zero correctly. def handle_sum(req): return SumTwoIntsResponse(req.a + req.b if req.a > 0 or req.b > 0 else 0) uses 'or' incorrectly and missing parentheses in ternary. def handle_sum(req): if req.a > 0 or req.b > 0: return SumTwoIntsResponse(req.a + req.b) else: return SumTwoIntsResponse(0) uses 'or' which is wrong logic. def handle_sum(req): return SumTwoIntsResponse(req.a + req.b) always returns sum ignoring condition.

3. Final Answer:

   def handle_sum(req): if req.a > 0 and req.b > 0: return SumTwoIntsResponse(req.a + req.b) else: return SumTwoIntsResponse(0) -> Option D

4. Quick Check:

   Both positive check with 'and' = def handle_sum(req): if req.a > 0 and req.b > 0: return SumTwoIntsResponse(req.a + req.b) else: return SumTwoIntsResponse(0) [OK]

Hint: Use 'and' to check both positive before summing [OK]

Common Mistakes:

• Using 'or' instead of 'and' for both positive check
• Returning sum without condition
• Incorrect ternary syntax in return