Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added ROS 2 Integration Tutorials #371

Merged
merged 10 commits into from Sep 12, 2023
Merged

Added ROS 2 Integration Tutorials #371

merged 10 commits into from Sep 12, 2023

Conversation

quarkytale
Copy link
Contributor

@quarkytale quarkytale commented Aug 24, 2023

🎉 New feature

Summary

Changes:

  • Added a Guide to ros_gz_project_template for ROS 2 and Gazebo Development which aims to explain how to use the template as well what comprises it and why
  • Added ROS 2 and Gazebo Integration Tutorial using rrbot

Test it

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

Signed-off-by: Dharini Dutia <dharini@openrobotics.org>
Signed-off-by: Dharini Dutia <dharini@openrobotics.org>
@github-actions github-actions bot added the 🌱 garden Gazebo Garden label Aug 24, 2023
@quarkytale quarkytale changed the title Quarkytale/tutorials Added ROS 2 Integration Tutorials Aug 24, 2023
Signed-off-by: Dharini Dutia <dharini@openrobotics.org>
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
garden/ros_gz_project_template_guide.md Outdated Show resolved Hide resolved
garden/ros_gz_project_template_guide.md Outdated Show resolved Hide resolved
garden/ros_gz_project_template_guide.md Outdated Show resolved Hide resolved
@quarkytale quarkytale added 🏯 fortress Ignition Fortress 🎵 harmonic Gazebo Harmonic labels Aug 24, 2023
Signed-off-by: Dharini Dutia <dharini@openrobotics.org>
@azeey azeey added the beta label Aug 29, 2023
@quarkytale quarkytale removed 🏯 fortress Ignition Fortress 🎵 harmonic Gazebo Harmonic labels Aug 30, 2023
Signed-off-by: Dharini Dutia <dharini@openrobotics.org>
@quarkytale quarkytale marked this pull request as ready for review August 30, 2023 09:16
Copy link
Contributor

@mabelzhang mabelzhang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Posting comments for one tutorial while I read the other

garden/ros_gz_project_template_guide.md Outdated Show resolved Hide resolved
garden/ros_gz_project_template_guide.md Outdated Show resolved Hide resolved
garden/ros_gz_project_template_guide.md Outdated Show resolved Hide resolved
garden/ros_gz_project_template_guide.md Outdated Show resolved Hide resolved
garden/ros_gz_project_template_guide.md Outdated Show resolved Hide resolved

* `ros_gz_example_description` - holds the sdf description of the simulated system and any other simulation assets.
Simulation assets means your models or robot descriptions in URDF or SDF, meshes and materials files to help visualize different parts of the robot and finally compiling all these elements in a simulated world SDF. Existing assets can be used by installing the models directory and exporting the paths to your environment.
Setting up paths can be also automated using ament environment hooks with a DSV file prepending the model share path to Gazebo resource path.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is going to sound very advanced to a beginner. Is there an example we can link to? I link to the colcon page, but that is pretty cryptic. In fact, the dsv files themselves look cryptic without a concrete example.

Suggested change
Setting up paths can be also automated using ament environment hooks with a DSV file prepending the model share path to Gazebo resource path.
Setting up paths can be also automated using colcon environment hooks with a [DSV file](https://colcon.readthedocs.io/en/released/developer/environment.html?highlight=dsv#dsv-files) prepending the model share path to Gazebo resource path.

garden/ros_gz_project_template_guide.md Outdated Show resolved Hide resolved
garden/ros_gz_project_template_guide.md Outdated Show resolved Hide resolved
garden/ros_gz_project_template_guide.md Outdated Show resolved Hide resolved
garden/ros_gz_project_template_guide.md Show resolved Hide resolved
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
quarkytale and others added 2 commits August 31, 2023 00:18
Co-authored-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Dharini Dutia <dharinidutia@gmail.com>
@mabelzhang
Copy link
Contributor

Summarizing what we said offline for visibility:
I'm fine with what's here. It can be merged after the comments are addressed and any longer remaining ones moved to an issue ticket to track them.

Signed-off-by: Dharini Dutia <dharini@openrobotics.org>
@quarkytale
Copy link
Contributor Author

Created issue #382 for tracking pending enhancements.

Signed-off-by: Dharini Dutia <dharini@openrobotics.org>
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
garden/ros2_gazebo_integration_tutorial.md Outdated Show resolved Hide resolved
garden/ros_gz_project_template_guide.md Outdated Show resolved Hide resolved
Signed-off-by: Dharini Dutia <dharini@openrobotics.org>
@quarkytale quarkytale merged commit 52d545a into master Sep 12, 2023
1 check passed
@quarkytale quarkytale deleted the quarkytale/tutorials branch September 12, 2023 09:26
@quarkytale quarkytale linked an issue Sep 12, 2023 that may be closed by this pull request
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beta 🌱 garden Gazebo Garden
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

ROS Integration Pages
4 participants