Skip to content

Commit a5b3aa7

Browse files
FranFinralph-lange
andauthored
Add overview page to advanced tutorials. (#304)
* Add overview page to advanced tutorials. * Updated non-existing link. * Update _docs/tutorials/advanced/overview/index.md Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com> * Update _docs/tutorials/advanced/overview/index.md Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com> * Update _docs/tutorials/advanced/overview/index.md Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com> Co-authored-by: Ralph Lange <ralph-lange@users.noreply.github.com>
1 parent 97643a5 commit a5b3aa7

4 files changed

Lines changed: 39 additions & 2 deletions

File tree

_data/docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454

5555
- title: Advanced Tutorials
5656
docs:
57+
- tutorials/advanced/overview
5758
- tutorials/advanced/microxrcedds_rmw_configuration
5859
- tutorials/advanced/create_new_type
5960
- tutorials/advanced/create_dds_entities_by_ref

_docs/tutorials/advanced/microxrcedds_rmw_configuration/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,4 +114,4 @@ rcl_init(0, NULL, &init_options, &context);
114114
// ... micro-ROS code ...
115115
```
116116
117-
Notice that it is also possible to set the Micro XRCE-DDS `client_key`, which would otherwise be set randomly. This feature is useful for reusing DDS entities already created on the agent side. Further information can be found [here](https://micro-xrce-dds.readthedocs.io/en/latest/deployment.html#configurate-the-publisher) and [here](https://github.com/micro-ROS/rmw-microxrcedds#rmw-micro-xrce-dds-implementation).
117+
Notice that it is also possible to set the Micro XRCE-DDS `client_key`, which would otherwise be set randomly. This feature is useful for reusing DDS entities already created on the agent side. Further information can be found [here](https://micro-xrce-dds.docs.eprosima.com/en/latest/getting_started.html#publisher-configuration) and [here](https://github.com/micro-ROS/rmw-microxrcedds#rmw-micro-xrce-dds-implementation).
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Overview
3+
permalink: /docs/tutorials/advanced/overview/
4+
redirect_from:
5+
- /docs/tutorials/advanced/
6+
---
7+
8+
This chapter provides a number of advanced tutorials for those users who already have some previous micro-ROS knowledge. They are useful to interact with micro-ROS at a deeper level compared with the [**First Step Tutorials**](../../core/overview). There is no specific order recommended to take these tutorials, as each addresses a different aspect of the micro-ROS stack and toolchain.
9+
10+
* [**Optimizing the Middleware Configuration**](../microxrcedds_rmw_configuration/)
11+
12+
In this tutorial, we'll guide you through the configuration of the middleware between a microcontroller and the micro-ROS agent running on some Linux-based microprocessor, to optimize it for your specific use-case and application.
13+
14+
* [**How to include a custom ROS message in micro-ROS**](../create_new_type/)
15+
16+
This tutorial explains how to create or include a custom ROS message type in a micro-ROS application - and in particular how to bring it into the [build system](https://github.com/micro-ROS/micro_ros_setup).
17+
18+
* [**How to use custom QoS in micro-ROS**](../create_dds_entities_by_ref/)
19+
20+
This tutorial explains the procedure for creating micro-ROS entities using fully configurable QoS settings by using the ROS 2 (DDS) entities creation mode *by references* as allowed by the micro-ROS default middleware (Micro XRCE-DDS Client).
21+
22+
* [**Creating custom micro-ROS transports**](../create_custom_transports/)
23+
24+
This tutorial aims at providing step-by-step guidance for those users interested in creating micro-ROS custom transports, instead of using the ones provided by default in the micro-ROS tools set.
25+
26+
* [**Creating custom static micro-ROS library**](../create_custom_static_library/)
27+
28+
This tutorial aims at providing step-by-step guidance for those users interested in compiling micro-ROS as a standalone library in order to integrate it in custom development tools.
29+
30+
* [**Benchmarking with the Shadow-Builder**](../benchmarking/)
31+
32+
This tutorial aims at describing a specific benchmarking tooling called the *Shadow Builder*. More specifically, it explains how to create a plugin from A to Z and how to instrument the code.
33+
34+
* [**Getting started with ROS 2 tracing**](../tracing/)
35+
36+
Tracing is a method for recording run-time data which is already well integrated with operating systems. This tutorial aims to introduce our ongoing effort to instrument ROS 2 and provide trace analysis tools.

_docs/tutorials/core/overview/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ redirect_from:
66
- /docs/tutorials/
77
---
88

9-
This chapter provides you a number of tutorials to learn micro-ROS and relevant tools for the different RTOS supported by micro-ROS. We divided this chapter into two sections core tutorials and advanced tutorials.
9+
This chapter provides the user with a number of tutorials to learn micro-ROS and relevant tools for the different RTOSes supported by micro-ROS. In the [**Advanced Tutorials**](../../advanced/overview/) section, you'll find more advanced tutorials to strenghten your micro-ROS knowledge.
1010

1111
If you are new to micro-ROS, we strongly suggest that you take the tutorials in the following order:
1212

0 commit comments

Comments
 (0)