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

Add tutorial for using the Pose component #2219

Merged
merged 25 commits into from
Jun 14, 2024

Conversation

mabelzhang
Copy link
Contributor

🎉 New feature

Depends on #2207, which adds the main component tutorial page. This PR is a sub-page.

Summary

Adds a tutorial on how to use the Pose component, using OdometryPublisher system as an example, because that system depends on only 1 component, good as a standalone example.

Test it

colcon build --merge-install --packages-select gz-sim8 --cmake-target doc

Navigate browser to build/gz-sim8/doxygen/html/usingcomponents.html (parent page) and build/gz-sim8/doxygen/html/posecomponent.html (child page).

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.

azeey and others added 19 commits October 31, 2023 21:33
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
* Remove ci-focal

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
---------

Signed-off-by: Ian Chen <ichen@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Mabel Zhang <mabel.m.zhang@gmail.com>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Mabel Zhang <mabel.m.zhang@gmail.com>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Mabel Zhang <mabel.m.zhang@gmail.com>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Mabel Zhang <mabel.m.zhang@gmail.com>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
@mabelzhang mabelzhang added the documentation Improvements or additions to documentation label Nov 1, 2023
@mabelzhang mabelzhang requested a review from azeey November 1, 2023 01:53
Base automatically changed from mabelzhang/component_tutorial to gz-sim8 February 6, 2024 19:52
@azeey azeey added the 🎵 harmonic Gazebo Harmonic label Feb 6, 2024
…nt_tutorial_pose2

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
…bosim/gz-sim into mabelzhang/component_tutorial_pose2
Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
@azeey
Copy link
Contributor

azeey commented Jun 10, 2024

@azeey to take another look.

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
@azeey azeey merged commit 4fde852 into gz-sim8 Jun 14, 2024
7 of 8 checks passed
@azeey azeey deleted the mabelzhang/component_tutorial_pose2 branch June 14, 2024 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 🎵 harmonic Gazebo Harmonic
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants