What Is This?

This package contains the following ROS 2 nodes:

1. listener
2. talker
3. add_two_ints_client
4. add_two_ints_server
5. set_parameters_callback
6. add_two_ints_client_async
7. listener_qos
8. talker_qos
9. listerner_serialized
10. async_param_client

Build

Run this command to build the package:

colcon build --packages-select demo_nodes_py

Run

Basic Listener & Talker

This runs talker and listener ROS 2 nodes which exchange the following string with incremeting integer:

Hello World:

# Open new terminal
ros2 run demo_nodes_py talker

# Open new terminal
ros2 run demo_nodes_py listener

Server & Client

This runs add_two_ints_client and add_two_ints_server ROS 2 client and server where the server processes two integers sent from the client and publishes its sum to the client to be printed out.

Server

# Open new terminal
ros2 run demo_nodes_py add_two_ints_server

Client [Synchronous]

# Open new terminal
ros2 run demo_nodes_py add_two_ints_client

Client [Asynchronous]

# Open new terminal
ros2 run demo_nodes_py add_two_ints_client_async

QoS Listener & Talker

Similar to previous, this runs talker_qos and listener_qos ROS 2 nodes which exchange messages using the Quality of Service (QoS) best effort policy.

# Open new terminal
ros2 run demo_nodes_py talker_qos

# Open new terminal
ros2 run demo_nodes_py listener_qos

Set Parameters Callback

This runs set_parameters_callback ROS 2 node which triggers a callback when ROS 2 double parameter param1 is set. The callback then sets ROS 2 double parameter param2 to a fixed 4.0:

# Open new terminal
ros2 run demo_nodes_py set_parameters_callback

Asynchronous Parameter Client

This runs async_param_client ROS 2 node which demonstrates how to set, list, get, load and delete parameters from the parameter blackboard in an asynchronous manner:

# Open new terminal
ros2 run demo_nodes_cpp parameter_blackboard

For more details on parameter_blackboard, please refer to demo_nodes_cpp README.md.

# Open new terminal
ros2 run demo_nodes_py async_param_client

Serialized Subscriber

This runs serialized_subscriber ROS 2 node that subscribes to the ROS 2 topic, /chatter, and deserializes as well as prints out received strings:

# Open new terminal
ros2 run demo_nodes_py listener_serialized

Verify

Basic Listener & Talker

When executed correctly, strings should be printed to the terminal similar to what is shown below:

# In terminal running talker
[INFO] [1674573022.635075580] [talker]: Publishing: "Hello World: 0"
[INFO] [1674573023.593075728] [talker]: Publishing: "Hello World: 1"
[INFO] [1674573024.592438479] [talker]: Publishing: "Hello World: 2"

# In terminal running listener
[INFO] [1674573025.634810166] [listener]: I heard: [Hello World: 0]
[INFO] [1674573026.596392653] [listener]: I heard: [Hello World: 1]
[INFO] [1674573027.596400384] [listener]: I heard: [Hello World: 2]
#...

Basic Server & Client

When executed correctly, strings should be printed to the terminal similar to what is shown below:

Server

# In terminal running add_two_ints_server
[INFO] [1674553268.912391774] [add_two_ints_server]: Incoming request
a: 2 b: 3

Client [Synchronous]

# In terminal running add_two_ints_client
[INFO] [1674553268.912602310] [add_two_ints_client]: Result of add_two_ints: 5

Client [Asynchronous]

# In terminal running add_two_ints_client_async
[INFO] [1674553718.598690033] [add_two_ints_client]: Result of add_two_ints: 5

QoS Listener & Talker

When executed correctly, strings should be printed to the terminal similar to what is shown below:

# In terminal running talker_qos
[INFO] [1674572630.018298164] [talker_qos]: Best effort talker
[INFO] [1674572631.021168516] [talker_qos]: Publishing: "Hello World: 0"
[INFO] [1674572632.021072723] [talker_qos]: Publishing: "Hello World: 1"
[INFO] [1674572633.021197421] [talker_qos]: Publishing: "Hello World: 2"
#...

# In terminal running listener_qos
[INFO] [1674572639.695289182] [listener_qos]: Best effort listener
[INFO] [1674572640.023684925] [listener_qos]: I heard: [Hello World: 0]
[INFO] [1674572641.023416691] [listener_qos]: I heard: [Hello World: 1]
[INFO] [1674572642.024505343] [listener_qos]: I heard: [Hello World: 2]
#...

Set Parameters Callback

[Before]

Run ros2 param get /set_parameters_callback param1 should print the following to the terminal:

Double value is: 0.0

Run ros2 param get /set_parameters_callback param2 should print the following to the terminal:

Double value is 0.0

[Change]

Run ros2 param set /set_parameters_callback param1 28.0 should print the following to the terminal:

Set parameter successful

[After]

Run ros2 param get /set_parameters_callback param1 should print the following to the terminal:

Double value is: 28.0

Run ros2 param get /set_parameters_callback param2 should print the following to the terminal:

Double value is 4.0

Asynchronous Parameter Client

Running ros2 run demo_nodes_cpp parameter_blackboard should print the output to the terminal similar to what is shown below:

# In terminal running async_param_client
[INFO] [1674574042.977327137] [async_param_client]: Setting parameters:
[INFO] [1674574042.978217825] [async_param_client]:     int_parameter:
[INFO] [1674574042.978474500] [async_param_client]:         successful: True
[INFO] [1674574042.978718655] [async_param_client]:     bool_parameter:
[INFO] [1674574042.978960532] [async_param_client]:         successful: True
[INFO] [1674574042.979200840] [async_param_client]:     string_parameter:
[INFO] [1674574042.979446692] [async_param_client]:         successful: True
[INFO] [1674574042.979687030] [async_param_client]: Listing Parameters:
[INFO] [1674574042.980229123] [async_param_client]:     - bool_parameter
[INFO] [1674574042.980476617] [async_param_client]:     - int_parameter
[INFO] [1674574042.980717248] [async_param_client]:     - string_parameter
[INFO] [1674574042.980956813] [async_param_client]: Getting parameters:
[INFO] [1674574042.981544032] [async_param_client]:     - int_parameter: 10
[INFO] [1674574042.981794832] [async_param_client]:     - bool_parameter: False
[INFO] [1674574042.982038493] [async_param_client]:     - string_parameter: Fee Fi Fo Fum
[INFO] [1674574042.982281892] [async_param_client]: Loading parameters:
[INFO] [1674574042.987160462] [async_param_client]:     other_int_parameter:
[INFO] [1674574042.987431457] [async_param_client]:         successful: True
[INFO] [1674574042.987679192] [async_param_client]:         value: 0
[INFO] [1674574042.987920948] [async_param_client]:     int_parameter:
[INFO] [1674574042.988162645] [async_param_client]:         successful: True
[INFO] [1674574042.988402691] [async_param_client]:         value: 12
[INFO] [1674574042.988643394] [async_param_client]:     string_parameter:
[INFO] [1674574042.988884034] [async_param_client]:         successful: True
[INFO] [1674574042.989125729] [async_param_client]:         value: I smell the blood of an Englishman
[INFO] [1674574042.989365771] [async_param_client]:     other_string_parameter:
[INFO] [1674574042.989605537] [async_param_client]:         successful: True
[INFO] [1674574042.989847066] [async_param_client]:         value: One fish, two fish, Red fish, blue fish
[INFO] [1674574042.990086215] [async_param_client]:     bool_parameter:
[INFO] [1674574042.990325361] [async_param_client]:         successful: True
[INFO] [1674574042.990565005] [async_param_client]:         value: False
[INFO] [1674574042.990804701] [async_param_client]: Deleting parameters:
[INFO] [1674574042.991497679] [async_param_client]:     other_int_parameter:
[INFO] [1674574042.991746545] [async_param_client]:         successful: True
[INFO] [1674574042.991986980] [async_param_client]:         reason:
[INFO] [1674574042.992226951] [async_param_client]:     other_string_parameter:
[INFO] [1674574042.992465274] [async_param_client]:         successful: True
[INFO] [1674574042.992703259] [async_param_client]:         reason:
[INFO] [1674574042.992941566] [async_param_client]:     string_parameter:
[INFO] [1674574042.993179508] [async_param_client]:         successful: True
[INFO] [1674574042.993416599] [async_param_client]:         reason:

Serialized Subscriber

Running ros2 run demo_nodes_py talker should print output to the terminal similar to the following:

# In terminal running listener_serialized
[INFO] [1674574499.556053634] [serialized_subscriber]: I heard: "b'\x00\x01\x00\x00\x0f\x00\x00\x00Hello World: 0\x00\x00'"
[INFO] [1674574500.506343148] [serialized_subscriber]: I heard: "b'\x00\x01\x00\x00\x0f\x00\x00\x00Hello World: 1\x00\x00'"
[INFO] [1674574501.508214693] [serialized_subscriber]: I heard: "b'\x00\x01\x00\x00\x0f\x00\x00\x00Hello World: 2\x00\x00'"

References

1. About Quality of Service Settings

Changelog for package demo_nodes_py

0.35.1 (2024-11-20)

• Add test_xmllint.py to all of the ament_python packages. (#704)
• Contributors: Chris Lalancette

0.35.0 (2024-10-03)

0.34.2 (2024-07-29)

• Change all of the demos to use the new rclpy context manager. (#694)
• Contributors: Chris Lalancette

0.34.1 (2024-06-17)

0.34.0 (2024-04-26)

0.33.2 (2024-03-28)

• Update maintainer list in package.xml files (#665)
• Contributors: Michael Jeronimo

0.33.1 (2024-02-07)

0.33.0 (2024-01-24)

0.32.1 (2023-12-26)

0.32.0 (2023-11-06)

0.31.1 (2023-09-07)

0.31.0 (2023-08-21)

0.30.1 (2023-07-11)

0.30.0 (2023-06-12)

• Change the service introspection parameter off value to 'disabled' (#634) With this we can avoid the tricky bits around YAML interpretation of 'off' as a boolean.
• Contributors: Chris Lalancette

0.29.0 (2023-06-07)

• Add demos for using logger service (#611)
• Contributors: Barry Xu

0.28.1 (2023-05-11)

0.28.0 (2023-04-27)

0.27.0 (2023-04-13)

• Change all ROS2 -> ROS 2. (#610)
• Add matched event demo for rclcpp and rclpy (#607)
• Contributors: Barry Xu, Chris Lalancette

0.26.0 (2023-04-11)

• Enable document generation using rosdoc2 (#606)
• Contributors: Yadu

0.25.0 (2023-03-01)

• Service introspection (#602)
• Contributors: Chris Lalancette

0.24.1 (2023-02-24)

0.24.0 (2023-02-14)

• Added README.md for demo_nodes_py (#600)
• [rolling] Update maintainers - 2022-11-07 (#589)
• Contributors: Audrow Nash, Gary Bey

0.23.0 (2022-11-02)

• Demo for pre and post set parameter callback support (#565)
• Contributors: Deepanshu Bansal

0.22.0 (2022-09-13)

• Add demo for rclpy parameter client (#566)
• Exit with code 0 if ExternalShutdownException is raised (#581)
• Contributors: Brian, Jacob Perron

0.21.0 (2022-04-29)

0.20.1 (2022-04-08)

0.20.0 (2022-03-01)

• Cleanups in demo_nodes_py. (#555)
• Contributors: Chris Lalancette

0.19.0 (2022-01-14)

0.18.0 (2021-12-17)

• Update maintainers to Audrow Nash and Michael Jeronimo (#543)
• Fixed typo executor -> executors (#542)
• Update python nodes SIGINT handling (#539)
• Contributors: Audrow Nash, Ivan Santiago Paunovic, ori155

0.17.0 (2021-10-18)

0.16.0 (2021-08-11)

0.15.0 (2021-05-14)

0.14.2 (2021-04-26)

0.14.1 (2021-04-19)

• Use underscores instead of dashes in setup.cfg (#502)
• Contributors: Ivan Santiago Paunovic

0.14.0 (2021-04-06)

0.13.0 (2021-03-25)

0.12.1 (2021-03-18)

0.12.0 (2021-01-25)

0.11.0 (2020-12-10)

• Update deprecated qos policy value names (#468)
• Update the package.xml files with the latest Open Robotics maintainers (#466)
• Contributors: Ivan Santiago Paunovic, Michael Jeronimo

0.10.1 (2020-09-21)

0.10.0 (2020-06-17)

0.9.3 (2020-06-01)

0.9.2 (2020-05-26)

0.9.1 (2020-05-12)

0.9.0 (2020-04-30)

• more verbose test_flake8 error messages (same as ros2/launch_ros#135)
• Contributors: Dirk Thomas

0.8.4 (2019-11-19)

• Make demos handle SIGINT gracefully. (#377)
• Contributors: Michel Hidalgo

0.8.3 (2019-11-11)

0.8.2 (2019-11-08)

0.8.1 (2019-10-23)

• Prevent argparse from parsing ROS args in Python demo nodes. (#396)
• Update setup.py versions
• Contributors: Jacob Perron, Michel Hidalgo

0.8.0 (2019-09-26)

0.7.6 (2019-05-30)

0.7.5 (2019-05-29)

• Fix reliable option for Python QoS demo (#352)
• Contributors: Jacob Perron

0.7.4 (2019-05-20)

• Fix deprecation warnings (#334)
• Contributors: Jacob Perron

0.7.3 (2019-05-10)

0.7.2 (2019-05-08)

0.7.1 (2019-04-26)

0.7.0 (2019-04-14)

0.6.2 (2019-01-15)

• Added serialized listener demo for python (#287)
• Contributors: Joseph Duchesne

0.6.1 (2018-12-13)

0.6.0 (2018-12-07)

• Updated package maintainer. (#286)
• Removed now redundant args=sys.argv (#274)
• Contributors: Michael Carroll, Mikael Arguedas

0.5.1 (2018-06-28)

0.5.0 (2018-06-27)

• Updated demos so that they support remapping arguments to python nodes by passing arguments to rclpy from argparse. (#252 and #253)
• Updated client demo to handle multiple requests. (#228)
• Contributors: Dirk Thomas, Mikael Arguedas, Shane Loretz, dhood