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 to run the cbg_executor example #23

Closed
carlossvg opened this issue Jun 16, 2021 · 6 comments
Closed

Add tutorial to run the cbg_executor example #23

carlossvg opened this issue Jun 16, 2021 · 6 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@carlossvg
Copy link
Contributor

There is one real-time related demo in ros2/examples. It would be useful to create a tutorial explaining how to run the demo and showing some results in a real-time system (i.e. RPI4 with PREEMPT-RT).

Instructions already exists in cbg_executor so maybe this tutorial is not necessary. At least I think it would be useful to create a tutorial document and link the demo readme to make this demo more visible.

More information:

@carlossvg carlossvg added the documentation Improvements or additions to documentation label Jun 16, 2021
@carlossvg carlossvg added this to the ROScon2021 milestone Jun 16, 2021
@carlossvg
Copy link
Contributor Author

Hi @ralph-lange, I created this issue as a proposal to improve the RTWG documentation. Could you provide some feedback on whether this makes sense to you?

@ralph-lange
Copy link

ralph-lange commented Jun 16, 2021

Hi @carlossvg, I'm happy to contribute such a tutorial, including measurement results from a sample hardware platform. Did you have a RTWG website/documentation in mind or the Tutorials section of https://docs.ros.org/, i.e. https://docs.ros.org/en/galactic/Tutorials.html? Currently, the demo is listed on this website in the Features Status section only.

@carlossvg
Copy link
Contributor Author

@ralph-lange My idea was to create a tutorial in https://real-time-working-group.readthedocs.io/en/latest/index.html and add it to the tutorial section (not created yet). The rationale is to collect all the real-time related resources in one place. If you prefer to have a tutorial in the ROS2 docs I would just add an entry in the RTWG docs and link the external tutorial so it's visible from there too.

Also, I will be happy to support with the tutorial reproducing the results in additional hardware platforms.

@ralph-lange
Copy link

I'll make a PR for the ROS 2 docs and will share the link with you as soon as it is accepted. But it will take me a few days to make this PR.

@carlossvg
Copy link
Contributor Author

Great, thanks!

@carlossvg
Copy link
Contributor Author

This will be done as part of this issue: #32

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
Projects
Status: Done
Development

No branches or pull requests

2 participants