Skip to content

Commit c306f5f

Browse files
committed
Added badges for distro status to individual programming with rcl and rclc tutorials.
Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com>
1 parent bae8329 commit c306f5f

8 files changed

Lines changed: 18 additions & 6 deletions

File tree

_docs/tutorials/programming_rcl_rclc/executor/executor.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Executor and timers
33
permalink: /docs/tutorials/programming_rcl_rclc/executor/
44
---
55

6+
<img src="https://img.shields.io/badge/Written_for-Foxy-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Galactic-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Rolling-green" style="display:inline"/>
7+
68
- [Timers](#timers)
79
- [Initialization](#initialization)
810
- [Callback](#callback)

_docs/tutorials/programming_rcl_rclc/micro-ROS/micro-ROS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@ title: micro-ROS utilities
33
permalink: /docs/tutorials/programming_rcl_rclc/micro-ROS/
44
---
55

6-
// TODO: Change section name
6+
<!-- TODO: Change section name -->
77

8+
<img src="https://img.shields.io/badge/Written_for-Galactic-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Rolling-green" style="display:inline"/>
9+
810
- [Allocators](#allocators)
911
- [Custom allocator](#custom-allocator)
1012
- [Time sync](#time-sync)

_docs/tutorials/programming_rcl_rclc/node/node.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Nodes
33
permalink: /docs/tutorials/programming_rcl_rclc/node/
44
---
55

6+
<img src="https://img.shields.io/badge/Written_for-Foxy-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Galactic-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Rolling-green" style="display:inline"/>
7+
68
ROS 2 nodes are the main participants on ROS 2 ecosystem. They will communicate between each other using publishers, subscriptions, services, etc. Further information about ROS 2 nodes can be found [here](https://docs.ros.org/en/galactic/Tutorials/Understanding-ROS2-Nodes.html)
79

810

_docs/tutorials/programming_rcl_rclc/overview/index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ redirect_from:
55
- /docs/tutorials/programming_rcl_rclc/
66
---
77

8-
<img src="https://img.shields.io/badge/Written_for-Foxy-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Galactic-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Rolling-green" style="display:inline"/>
9-
108
In this section, you'll learn the basics of the micro-ROS C API: **rclc**.
119

1210
The major concepts (publishers, subscriptions, services, timers, ...) are identical with ROS 2. They even rely on the *same* implementation, as the micro-ROS C API is based on the ROS 2 client support library (rcl), enriched with a set of convenience functions by the package [rclc](https://github.com/ros2/rclc/). That is, rclc does not add a new layer of types on top of rcl (like rclcpp and rclpy do) but only provides functions that ease the programming with the rcl types. New types are introduced only for concepts that are missing in rcl, such as the concept of an executor.
@@ -16,5 +14,5 @@ The major concepts (publishers, subscriptions, services, timers, ...) are identi
1614
* [**Services**](../service/)
1715
* [**Parameters**](../parameters/)
1816
* [**Executor and timers**](../executor/)
19-
* [**QoS**](../qos/)
20-
* [**micro-ROS Utils**](../micro-ROS/)
17+
* [**Quality of service**](../qos/)
18+
* [**micro-ROS utilities**](../micro-ROS/)

_docs/tutorials/programming_rcl_rclc/parameters/parameters.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Parameter server
33
permalink: /docs/tutorials/programming_rcl_rclc/parameters/
44
---
55

6+
<img src="https://img.shields.io/badge/Written_for-Foxy-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Galactic-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Rolling-green" style="display:inline"/>
7+
68
ROS 2 parameters allow the user to create variables on a node and manipulate/read them with different ROS2 commands. Further information about ROS 2 parameters can be found [here](https://docs.ros.org/en/galactic/Tutorials/Parameters/Understanding-ROS2-Parameters.html)
79

810
Ready to use code related to this tutorial can be found in [`rclc/rclc_examples/src/example_parameter_server.c`](https://github.com/ros2/rclc/blob/master/rclc_examples/src/example_parameter_server.c). Fragments of code from this example is used on this tutorial.

_docs/tutorials/programming_rcl_rclc/pub_sub/pub_sub.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
---
2-
title: Publishers and Subscribers
2+
title: Publishers and subscribers
33
permalink: /docs/tutorials/programming_rcl_rclc/pub_sub/
44
---
55

6+
<img src="https://img.shields.io/badge/Written_for-Foxy-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Galactic-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Rolling-green" style="display:inline"/>
7+
68
ROS 2 publishers and subscribers are the basic communication mechanism between nodes using topics. Further information about ROS 2 publish–subscribe pattern can be found [here](https://docs.ros.org/en/foxy/Tutorials/Topics/Understanding-ROS2-Topics.html).
79

810
Ready to use code related to this concepts can be found in [`micro-ROS-demos/rclc/int32_publisher`](https://github.com/micro-ROS/micro-ROS-demos/blob/foxy/rclc/int32_publisher/main.c) and [`micro-ROS-demos/rclc/int32_subscriber`](https://github.com/micro-ROS/micro-ROS-demos/blob/foxy/rclc/int32_subscriber/main.c) folders. Fragments of code from this examples are used on this tutorial.

_docs/tutorials/programming_rcl_rclc/qos/QoS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Quality of service
33
permalink: /docs/tutorials/programming_rcl_rclc/qos/
44
---
55

6+
<img src="https://img.shields.io/badge/Written_for-Foxy-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Galactic-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Rolling-green" style="display:inline"/>
7+
68
- [Reliable QoS](#reliable-qos)
79
- [Best Effort](#best-effort)
810
- [Custom QoS configuration](#custom-qos-configuration)

_docs/tutorials/programming_rcl_rclc/service/services.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Services
33
permalink: /docs/tutorials/programming_rcl_rclc/service/
44
---
55

6+
<img src="https://img.shields.io/badge/Written_for-Foxy-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Galactic-green" style="display:inline"/> <img src="https://img.shields.io/badge/Tested_on-Rolling-green" style="display:inline"/>
7+
68
ROS 2 services are another communication mechanism between nodes. Services implement a client-server paradigm based on ROS 2 messages and types. Further information about ROS 2 services can be found [here](https://index.ros.org/doc/ros2/Tutorials/Services/Understanding-ROS2-Services/)
79

810
Ready to use code related to this concepts can be found in [`micro-ROS-demos/rclc/addtwoints_server`](https://github.com/micro-ROS/micro-ROS-demos/blob/foxy/rclc/addtwoints_server/main.c) and [`micro-ROS-demos/rclc/addtwoints_client`](https://github.com/micro-ROS/micro-ROS-demos/blob/foxy/rclc/addtwoints_client/main.c) folders. Fragments of code from this examples are used on this tutorial.

0 commit comments

Comments
 (0)