ros2-engineering-skills
by @dbwls99706
Comprehensive ROS 2 engineering guide covering workspace setup, node architecture, communication patterns (topics/services/actions with QoS), lifecycle and c...
clawhub install ros2-engineering-skillsπ About This Skill
name: ros2-engineering-skills description: > Comprehensive ROS 2 engineering guide covering workspace setup, node architecture, communication patterns (topics/services/actions with QoS), lifecycle and component nodes, launch composition, tf2/URDF, ros2_control hardware interfaces, real-time constraints, Nav2, MoveIt 2, perception pipelines, simulation (Gazebo/Isaac Sim), security (SROS2/DDS), micro-ROS (MCU/RTOS), multi-robot systems (fleet management/Open-RMF), testing, debugging, deployment, and ROS 1 migration. Trigger whenever the user works on ROS 2 code, packages, launch files, URDF/xacro, DDS configuration, ros2_control, Nav2, MoveIt 2, or any robotics middleware task involving rclcpp, rclpy, colcon, ament, rosbag2, ros2 CLI tools, Gazebo/Isaac Sim, micro-ROS, SROS2, or multi-robot coordination. Also trigger for ROS 1 to ROS 2 migration, cross-compilation, Docker-based ROS 2 workflows, and CI/CD for robotics.
ROS 2 Engineering Skills
A progressive-disclosure skill for ROS 2 development β from first workspace to
production fleet deployment. Each section below gives you the essential decision
framework; detailed patterns, code templates, and anti-patterns live in the
references/ directory. Read the relevant reference file before writing code.
How to use this skill
1. Identify what the user is building (see Decision Router below).
2. Read the matching references/*.md file for detailed guidance.
3. Apply the Core Engineering Principles in every piece of code you generate.
4. When multiple domains intersect (e.g. Nav2 + ros2_control), read both files.
Decision router
| User is doing... | Read |
|---------------------------------------------------|-----------------------------------|
| Creating a workspace, package, or build config | references/workspace-build.md |
| Writing nodes, executors, callback groups | references/nodes-executors.md |
| Topics, services, actions, custom interfaces, QoS | references/communication.md |
| Lifecycle nodes, component loading, composition | references/lifecycle-components.md |
| Launch files, conditional logic, event handlers | references/launch-system.md |
| tf2, URDF, xacro, robot_state_publisher | references/tf2-urdf.md |
| ros2_control, hardware interfaces, controllers | references/hardware-interface.md |
| Real-time constraints, PREEMPT_RT, memory, jitter | references/realtime.md |
| Nav2, SLAM, costmaps, behavior trees | references/navigation.md |
| MoveIt 2, planning scene, grasp pipelines | references/manipulation.md |
| Camera, LiDAR, PCL, cv_bridge, depth processing | references/perception.md |
| Unit tests, integration tests, launch_testing, CI | references/testing.md |
| ros2 doctor, tracing, profiling, rosbag2 | references/debugging.md |
| Docker, cross-compile, fleet deployment, OTA | references/deployment.md |
| Gazebo, Isaac Sim, sim-to-real, use_sim_time | references/simulation.md |
| SROS2, DDS security, certificates, supply chain | references/security.md |
| micro-ROS, MCU/RTOS, XRCE-DDS, rclc | references/micro-ros.md |
| Multi-robot fleet, Open-RMF, DDS discovery scale | references/multi-robot.md |
| Message types, units, covariance, frame conventions | references/message-types.md |
| ROS 1 migration, ros1_bridge, hybrid operation | references/migration-ros1.md |
When a task spans multiple domains, read all relevant files and reconcile conflicting recommendations by favoring safety, then determinism, then simplicity.
Cross-cutting concern β Security: Security is not isolated to references/security.md.
Every domain should consider its security implications: hardware interfaces need safe
shutdown on auth failure, DDS topics may need encryption, deployment images need supply
chain verification, and fleet communication must use TLS. When reviewing code in any
domain, check whether the data path crosses a trust boundary.
Core engineering principles
These apply to every ROS 2 artifact you produce, regardless of domain.
1. Distro awareness
Always ask which ROS 2 distribution the user targets. Key differences:
| Feature | Foxy (EOL) | Humble (LTS) | Jazzy (LTS) | Kilted (non-LTS) | Rolling | |---------------------------|----------------------|--------------------|--------------------|--------------------|--------------------| | EOL | Jun 2023 (ended) | May 2027 | May 2029 | Nov 2025 | Rolling | | Ubuntu | 20.04 | 22.04 | 24.04 | 24.04 | Latest | | Default DDS | Fast DDS | Fast DDS | Fast DDS | Fast DDS | Fast DDS | | Zenoh support | β | β | β | Tier 1 | Tier 1 | | Type description support | No | No | Yes | Yes | Yes | | Service introspection | No | No | Yes | Yes | Yes | | EventsExecutor | No | No | Experimental | Stable (+ rclpy) | Stable (+ rclpy) | | Default bag format | sqlite3 | sqlite3 | MCAP | MCAP | MCAP | | ros2_control interface | N/A (separate) | 2.x | 4.x | 4.x | Latest | | CMake recommendation | ament_target_deps | ament_target_deps | either | target_link_libs | target_link_libs |
When the user does not specify, default to the latest LTS (Jazzy). Pin the exact distro in Dockerfile, CI, and documentation so builds are reproducible.
2. C++ vs Python decision
Choose the language based on the node's role, not personal preference.
Use rclcpp (C++) when:
Use rclpy (Python) when:
Mixed stacks are normal. A typical robot has C++ drivers/controllers and Python
orchestration/monitoring. Note: component_container (composition) only loads
C++ components via pluginlib. Python nodes run as separate processes, but can
share a launch file and communicate via zero-overhead intra-host DDS.
Intra-process communication works for any nodes sharing a process β not only
composable components. Any nodes instantiated in the same process with
use_intra_process_comms(true) can use zero-copy transfer.
3. Package structure conventions
Every package should follow this layout. Consistency across a workspace reduces onboarding time and makes CI scripts portable.
my_package/
βββ CMakeLists.txt # or setup.py for pure Python
βββ package.xml # format 3, with tags
βββ config/
β βββ params.yaml # default parameters
βββ launch/
β βββ bringup.launch.py # Python launch file
βββ include/my_package/ # C++ public headers (if library)
βββ src/ # C++ source files
βββ my_package/ # Python modules (if ament_python or mixed)
βββ test/ # gtest, pytest, launch_testing
βββ urdf/ # URDF/xacro (if applicable)
βββ msg/ srv/ action/ # custom interfaces (dedicated _interfaces package preferred)
βββ README.md
Separate interface definitions into a *_interfaces package so downstream
packages can depend on interfaces without pulling in implementation.
4. Parameter discipline
ParameterDescriptor with FloatingPointRange or IntegerRangecontroller.kp, controller.ki, controller.kd.
config/params.yaml; allow launch-time overrides.set_parameters_callback and5. Error handling philosophy
FINALIZED and alert the operator).6. Quality of Service defaults
Start from these profiles and adjust per use case:
| Use case | Reliability | Durability | History | Depth | Deadline | Lifespan | |-----------------------|---------------|------------------|---------|-------|-------------|-------------| | Sensor stream | BEST_EFFORT | VOLATILE | KEEP_LAST | 5 | β | β | | Command velocity | RELIABLE | VOLATILE | KEEP_LAST | 1 | 100 ms | 200 ms | | Map (latched) | RELIABLE | TRANSIENT_LOCAL | KEEP_LAST | 1 | β | β | | Diagnostics | RELIABLE | VOLATILE | KEEP_LAST | 10 | β | β | | Parameter events | RELIABLE | VOLATILE | KEEP_LAST | 1000| β | β | | Action feedback | RELIABLE | VOLATILE | KEEP_LAST | 1 | β | β | | Safety heartbeat | RELIABLE | VOLATILE | KEEP_LAST | 1 | 500 ms | 1 s |
QoS mismatches are the #1 cause of "I published but nobody receives."
Always check compatibility with ros2 topic info -v when debugging.
DEADLINE and LIFESPAN are critical for safety-critical systems. DEADLINE fires an
event when no message arrives within the specified period (detect stale data). LIFESPAN
discards messages older than the specified duration before delivery (prevent acting on
stale data). See references/communication.md section 9 for full API and examples.
7. Naming conventions
| Entity | Convention | Example |
|-------------|-----------------------------|--------------------------------|
| Package | snake_case | arm_controller |
| Node | snake_case | joint_state_broadcaster |
| Topic | /snake_case with ns | /arm/joint_states |
| Service | /snake_case | /arm/set_mode |
| Action | /snake_case | /arm/follow_joint_trajectory |
| Parameter | snake_case with dot ns | controller.publish_rate |
| Frame | snake_case | base_link, camera_optical |
| Interface | PascalCase.msg/srv/action | JointState.msg |
8. Thread safety and callbacks
MutuallyExclusiveCallbackGroup serializes its callbacks β safe forReentrantCallbackGroup allows parallel execution β you must protectstd::mutex (C++) or threading.Lock (Python).
MutuallyExclusiveCallbackGroup from the calling callback. Otherwise
the executor deadlocks β the callback waits for the response while the executor
cannot deliver it. Always use async_send_request with a response callback;
never use spin_until_future_complete inside an executor callback.
sleep) inside aMultiThreadedExecutor with a reentrant group.
std::shared_ptr in subscription9. Lifecycle-first design
Default to lifecycle (managed) nodes for anything that owns resources: hardware drivers, sensor pipelines, planners, controllers.
ββββββββββββββββ
create() βββΊ β Unconfigured β
ββββββββ¬ββββββββ
on_configure β
ββββββββΌββββββββ
β Inactive β
ββββββββ¬ββββββββ
on_activate β
ββββββββΌββββββββ
β Active β
ββββββββ¬ββββββββ
on_deactivate β
ββββββββΌββββββββ
β Inactive β
ββββββββ¬ββββββββ
on_cleanup β
ββββββββΌββββββββ
β Unconfigured β
ββββββββ¬ββββββββ
on_shutdown β
ββββββββΌββββββββ
β Finalized β
βββββββββββββββββ
This gives the system manager (launch file, orchestrator, or operator) explicit control over when resources are allocated, when the node starts processing, and how it shuts down. It also makes error recovery predictable.
10. Build and CI hygiene
colcon build --cmake-args -DCMAKE_BUILD_TYPE=RelWithDebInfo forRelease for deployment.
-Wall -Wextra -Wpedantic and treat warnings as errors in CI.colcon test with --event-handlers console_cohesion+ so testrosdep.yaml for reproducible dependency resolution./opt/ros/, .ccache/, and build//install/ in CI to cut buildCommon anti-patterns
| Anti-pattern | Why it hurts | Fix |
|---|---|---|
| Global variables for node state | Breaks composition, untestable | Store state as class members |
| spin() in main() for multi-node processes | Starves other nodes | Use MultiThreadedExecutor or component composition |
| Hardcoded topic names | Breaks reuse across robots | Use relative names + namespace remapping |
| KEEP_ALL history with no bound | Memory grows unbounded on slow subscribers | Use KEEP_LAST with explicit depth |
| Using time.sleep() / std::this_thread::sleep_for | Blocks the executor thread | Use create_wall_timer or a dedicated thread |
| Monolithic launch file for everything | Unmanageable past 10 nodes | Compose launch files with IncludeLaunchDescription |
| Skipping package.xml dependencies | Builds locally, breaks CI and Docker | Declare every dependency explicitly |
| Publishing in constructor | Subscribers may not be ready, messages lost | Publish in on_activate or after a short timer |
| Ignoring QoS compatibility | Silent communication failure | Match publisher/subscriber QoS or check with ros2 topic info -v |
| Creating timers/subs in callbacks | Resource leak, unpredictable behavior | Create all entities in constructor or on_configure |
| Synchronous service call in callback | Deadlocks the executor thread | Use async_send_request with a callback or dedicated thread |
| Service client in same callback group as caller | Deadlocks even with async in MultiThreadedExecutor | Put service client in a separate MutuallyExclusiveCallbackGroup |
| No safe command on shutdown | Motors hold last velocity after node exits | Send zero-velocity in on_deactivate AND destructor (see references/hardware-interface.md) |
| Dynamic subscriptions with StaticSingleThreadedExecutor | New subs are never picked up after spin() | Use SingleThreadedExecutor or MultiThreadedExecutor for dynamic entities |
| CPU frequency governor left on powersave/ondemand | 10-100 ms latency spikes in RT path | Set performance governor, disable turbo boost (see references/realtime.md) |
Distro-specific migration notes
When upgrading between distributions, check these breaking changes first:
Foxy β Humble:
ros2_control was not bundled in Foxy β must be built separately.Humble β Jazzy:
ros2_control API changed from 2.x to 4.x β export_state_interfaces() andexport_command_interfaces() are now auto-generated by the framework. Manual
overrides use on_export_state_interfaces(). See references/hardware-interface.md.
get_value() deprecated β use get_optional() on LoanedStateInterface /LoanedCommandInterface (controller side). Hardware interfaces use set_state() /
get_state() / set_command() / get_command() helpers with fully qualified names.
tag must exist in the URDF.--param-file with spawner.storage_id='mcap'.nav2_params.yaml schema changes β recoveries_server renamed to behavior_server.ROS_AUTOMATIC_DISCOVERY_RANGE replaces ROS_LOCALHOST_ONLY (values: LOCALHOST,SUBNET, OFF, SYSTEM_DEFAULT).
launch_ros actions have new parameter handling β test launch files explicitly.Jazzy β Kilted (non-LTS):
rmw_zenoh is production-ready.sudo apt install ros-kilted-rmw-zenoh-cpp, set
RMW_IMPLEMENTATION=rmw_zenoh_cpp. Supports router/peer/client modes.
rclcpp::executorsexperimental namespace). Also ported to rclpy.
ament_target_dependencies() deprecated β use target_link_libraries() withrclcpp::rclcpp, std_msgs::std_msgs__rosidl_typesupport_cpp).
ros2 bag play.ROS 1 β ROS 2:
references/migration-ros1.md for a step-by-step strategy.Quick reference β ros2 CLI
# Workspace
colcon build --symlink-install --packages-select my_pkg
colcon test --packages-select my_pkg
colcon graph --dot # dependency graph (DOT format)
source install/setup.bashIntrospection
ros2 node list
ros2 topic list -t
ros2 topic info /topic_name -v # shows QoS details
ros2 topic hz /topic_name
ros2 topic bw /topic_name
ros2 service list -t
ros2 action list -t
ros2 param list /node_name
ros2 param describe /node_name param
ros2 interface show std_msgs/msg/Stringros2_control
ros2 control list_controllers
ros2 control list_hardware_interfaces
ros2 control list_hardware_componentsDebugging
ros2 doctor --report # alias: ros2 wtf
ros2 run tf2_tools view_frames
ros2 bag record -a -o my_bag
ros2 bag info my_bag
ros2 bag play my_bag --clockLifecycle
ros2 lifecycle list /node_name
ros2 lifecycle set /node_name configure
ros2 lifecycle set /node_name activate