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

Ref #8286. Join RTOS tutorials #149

Merged
merged 46 commits into from
May 20, 2020
Merged

Conversation

pablogs9
Copy link
Member

This PR removes FreeRTOS and Zephyr specific tutorials and merge them all into First micro-ROS Application on an RTOS

@pablogs9 pablogs9 changed the title Feature/join rtos tutorials Join RTOS tutorials Apr 27, 2020
@ralph-lange ralph-lange mentioned this pull request Apr 27, 2020
42 tasks
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
![pingpong](http://www.plantuml.com/plantuml/png/ZOwnIWGn48RxFCNFzSkoUG2vqce5jHEHi1dtWZkPa6GByNntavZY10yknMJu-ORlFwPiOjvvK-d3-M2YOR1uMKvHc93ZJafvoMML07d7h1NAE-DPWblg_na8vnwEx9OeZmzFOt1-BK7AzetJciPxCfRYVw1S0SbRLBEg1IpXPIvpUWLCmZpXIm6BS3addt7uQpu0ZQlxT1MK2r0g-7sfqbsbRrVfMrMwgbev3CDTlsqJGtJhATUmSMrMg5TKwaZUxfcttuMt7m00)

The files contained in a micro-ROS app is slightly RTOS specific. The following table aims to clarify which files are required for creating a new app:

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe here in the 'File' column you could specify the path as well, since as I can remember these files do not go all into the same folder.
Also, I remember that before you were creating a folder named my_brand_new_app, I liked that flow of the tutorial since it was taking the user by hand and explaining step by step what he should do. I think we should follow the same line of action, with the only difference that now the text that goes into the files is reference and not directly in the tutorial.

Copy link
Member Author

Choose a reason for hiding this comment

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

Please check the new approach

_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved

## Installing the micro-ROS build system

First of all, make sure that you have a **ROS 2** installation in the computer. On the **ROS 2** installation open a command line and follow these steps:
Copy link
Contributor

Choose a reason for hiding this comment

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

I assume that the following section can be shortened even more. We agreed to build this tutorial on top of the 'First micro-ROS application on Linux tutorial', i.e. we assume that the reader already completed the Linux-based tutorial and thus has ROS2 and micro-ROS installed, knows the ping-pong application an so on.
I propose to add a prominent note on this assumption here. See also my overview at https://micro-ros.github.io/docs/tutorials/core/overview/

Copy link
Member Author

Choose a reason for hiding this comment

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

Please check the new approach. Maybe the four-step workflow explanation can be also removed, let me know if so.

_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
cd uros_pingpong
touch Kconfig
touch Makefile
touch uros_pingpong_main.c
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
touch uros_pingpong_main.c
touch app.c

_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
@pablogs9 pablogs9 changed the title Join RTOS tutorials Ref # 8286. Join RTOS tutorials Apr 28, 2020
@pablogs9 pablogs9 changed the title Ref # 8286. Join RTOS tutorials Ref #8286. Join RTOS tutorials Apr 28, 2020
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
FranFin
FranFin previously approved these changes Apr 30, 2020
pablogs9 and others added 11 commits May 6, 2020 15:20
Co-Authored-By: FranFin <58737168+FranFin@users.noreply.github.com>
Co-Authored-By: FranFin <58737168+FranFin@users.noreply.github.com>
Co-Authored-By: FranFin <58737168+FranFin@users.noreply.github.com>
Co-Authored-By: FranFin <58737168+FranFin@users.noreply.github.com>
Co-Authored-By: FranFin <58737168+FranFin@users.noreply.github.com>
Co-Authored-By: FranFin <58737168+FranFin@users.noreply.github.com>
Co-Authored-By: FranFin <58737168+FranFin@users.noreply.github.com>
Co-Authored-By: Ralph Lange <ralph-lange@users.noreply.github.com>
pablogs9 and others added 13 commits May 6, 2020 15:20
Co-authored-by: FranFin <58737168+FranFin@users.noreply.github.com>
Co-authored-by: FranFin <58737168+FranFin@users.noreply.github.com>
Co-authored-by: FranFin <58737168+FranFin@users.noreply.github.com>
Co-authored-by: FranFin <58737168+FranFin@users.noreply.github.com>
Co-authored-by: FranFin <58737168+FranFin@users.noreply.github.com>
Co-authored-by: FranFin <58737168+FranFin@users.noreply.github.com>
Co-authored-by: FranFin <58737168+FranFin@users.noreply.github.com>
Co-authored-by: FranFin <58737168+FranFin@users.noreply.github.com>
Co-authored-by: FranFin <58737168+FranFin@users.noreply.github.com>
Co-authored-by: FranFin <58737168+FranFin@users.noreply.github.com>
Co-authored-by: FranFin <58737168+FranFin@users.noreply.github.com>
@pablogs9 pablogs9 force-pushed the feature/join_RTOS_tutorials branch from 5dc4bb8 to d586b19 Compare May 6, 2020 13:20
Copy link
Contributor

@ralph-lange ralph-lange left a comment

Choose a reason for hiding this comment

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

Very good work. The integration of the three RTOS is very good. I've only few small change requests.

_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
<td rowspan="4">Nuttx</td>
<td >app.c</td>
<td >micro-ROS app code.</td>
<td rowspan="4"><a href="https://github.com/micro-ROS/apps/tree/dashing/examples/uros_pingpong">Sample app</a></td>
Copy link
Contributor

Choose a reason for hiding this comment

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

Link does not work.

_docs/tutorials/core/first_application_rtos/index.md Outdated Show resolved Hide resolved
pablogs9 and others added 11 commits May 11, 2020 08:17
Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com>
Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com>
Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com>
Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com>
Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com>
Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com>
Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com>
Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com>
Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com>
Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com>
Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com>
@ralph-lange ralph-lange marked this pull request as ready for review May 20, 2020 07:06
@ralph-lange ralph-lange merged commit 5d758c5 into master May 20, 2020
@ralph-lange ralph-lange deleted the feature/join_RTOS_tutorials branch June 3, 2020 07:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants