ROS workspace and package structure - Mini Project: Build & Apply

ROS Workspace and Package Structure

📖 Scenario: You are starting a robotics project using ROS (Robot Operating System). You need to create a workspace and a package inside it to organize your robot's code and resources.

🎯 Goal: Build a basic ROS workspace directory and create a ROS package with the correct structure and files.

📋 What You'll Learn

Create a ROS workspace directory named my_robot_ws

Inside the workspace, create the src folder

Create a ROS package named robot_control inside src

Include the essential files package.xml and CMakeLists.txt in the package

💡 Why This Matters

🌍 Real World

ROS workspaces and packages organize robot software projects, making it easier to build, share, and maintain code.

💼 Career

Understanding ROS workspace and package structure is essential for robotics engineers and developers working with ROS-based systems.

1

Create the ROS workspace directory and src folder

Create a directory named my_robot_ws and inside it create a folder named src.

ROS

# Create the directory structure
# Your code here

Hint

Use mkdir -p my_robot_ws/src in the terminal or create folders manually.

2

Initialize the ROS workspace

Inside my_robot_ws, run the command catkin_make to initialize the workspace build system.

ROS

# Initialize the workspace with catkin_make
# Your code here

Hint

Open a terminal, navigate to my_robot_ws, and run catkin_make.

3

Create the ROS package inside src

Inside my_robot_ws/src, create a ROS package named robot_control using the command catkin_create_pkg robot_control std_msgs rospy roscpp.

ROS

# Create the robot_control package
# Your code here

Hint

Use the catkin_create_pkg command with the package name and dependencies.

4

Verify package files and workspace build

Check that package.xml and CMakeLists.txt exist inside robot_control and run catkin_make again in my_robot_ws to build the package.

ROS

# Verify package files and build workspace
# Your code here

Hint

Use ls to check files and catkin_make to build.

Practice

1. What is the main purpose of a ROS workspace?

easy

A. To organize multiple ROS packages and build them together

B. To store robot hardware components physically

C. To run ROS nodes directly without packages

D. To replace the operating system for robots

Solution

1. Step 1: Understand what a ROS workspace is

   A ROS workspace is a directory where you keep your ROS packages organized and ready to build.

2. Step 2: Identify the workspace role

   The workspace allows you to build all packages together and manage dependencies easily.

3. Final Answer:

   To organize multiple ROS packages and build them together -> Option A

4. Quick Check:

   Workspace = Organize and build packages [OK]

Hint: Workspace groups packages for building and management [OK]

Common Mistakes:

• Confusing workspace with physical robot parts
• Thinking workspace runs nodes directly
• Assuming workspace replaces OS

2. Which file must every ROS package contain to define its metadata?

easy

A. package.xml

B. CMakeLists.txt

C. README.md

D. setup.py

Solution

1. Step 1: Identify metadata files in ROS packages

   Every ROS package must have a package.xml file that describes the package name, version, dependencies, and other metadata.

2. Step 2: Differentiate from build files

   CMakeLists.txt is for build instructions, not metadata. README.md is documentation, and setup.py is for Python packages but not mandatory in ROS.

3. Final Answer:

   package.xml -> Option A

4. Quick Check:

   Metadata file = package.xml [OK]

Hint: Metadata always in package.xml file [OK]

Common Mistakes:

• Confusing CMakeLists.txt with metadata
• Thinking README.md defines package info
• Assuming setup.py is mandatory for all packages

3. Given a ROS workspace with packages pkg1 and pkg2, what happens after running colcon build and then source install/setup.bash?

medium

A. The packages are deleted from the workspace

B. Only pkg1 is built and pkg2 is ignored

C. The workspace is built and environment is set to use the packages

D. The ROS master node starts automatically

Solution

1. Step 1: Understand colcon build role

   This command builds all packages in the workspace, compiling code and preparing install files.

2. Step 2: Understand source install/setup.bash role

   This command sets environment variables so ROS can find and use the newly built packages.

3. Final Answer:

   The workspace is built and environment is set to use the packages -> Option C

4. Quick Check:

   Build + source = ready to use packages [OK]

Hint: Build then source to use packages in ROS [OK]

Common Mistakes:

• Thinking only one package builds
• Assuming packages get deleted after build
• Believing ROS master starts automatically

4. You created a new package inside your ROS workspace but forgot to run colcon build. What problem will you face?

medium

A. The package will run but with errors

B. The package will build automatically when you run any node

C. The package will be deleted from the workspace

D. ROS will not recognize the new package when you try to use it

Solution

1. Step 1: Understand build necessity

   ROS requires running colcon build to compile and register new packages in the workspace environment.

2. Step 2: Consequence of skipping build

   If you skip building, ROS environment does not know about the new package, so it cannot find or use it.

3. Final Answer:

   ROS will not recognize the new package when you try to use it -> Option D

4. Quick Check:

   Build missing = package not recognized [OK]

Hint: Always build after adding new packages [OK]

Common Mistakes:

• Assuming packages build automatically
• Thinking package deletion happens without build
• Believing package runs with errors without build

5. You want to add a new ROS package that depends on an existing package std_msgs. Which steps correctly update your workspace to include this dependency?

hard

A. Run rosdep install std_msgs without modifying any files

B. Add std_msgs to package.xml dependencies, update CMakeLists.txt, then run colcon build

C. Delete package.xml and create a new one with std_msgs listed

D. Only add std_msgs to README.md and run colcon build

Solution

1. Step 1: Add dependency in package.xml

   You must declare std_msgs as a dependency in package.xml so ROS knows your package needs it.

2. Step 2: Update CMakeLists.txt for build

   Modify CMakeLists.txt to find and link std_msgs during build.

3. Step 3: Build workspace

   Run colcon build to compile your package with the new dependency.

4. Final Answer:

   Add std_msgs to package.xml dependencies, update CMakeLists.txt, then run colcon build -> Option B

5. Quick Check:

   Declare dependency + update build + build workspace [OK]

Hint: Declare dependencies in package.xml and CMakeLists.txt before build [OK]

Common Mistakes:

• Only updating README.md without build changes
• Deleting package.xml unnecessarily
• Relying on rosdep without declaring dependencies