Skip to content

Commit e8a0eac

Browse files
committed
Merge branch 'feature/doc_theme' of https://github.com/microROS/microros.github.io into feature/doc_theme
2 parents 8b4f009 + e36ce64 commit e8a0eac

3 files changed

Lines changed: 20 additions & 21 deletions

File tree

_data/authors.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
lui3si:
2-
twitter: ingoluetkebohle
1+
iluetkeb:
2+
twitter: ingoluetkebohle

_docs/FIROS2/index.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: micro-ROS & FIWARE
2+
title: microROS & FIWARE
33
permalink: /docs/FIROS2/
44
redirect_from: /FIROS2/
55
---
66

77

88
## Interoperability
99

10-
This subsection will explain all the design alternatives for the interoperability of FIROS2 with micro-ROS.
10+
This subsection will explain all the design alternatives for the interoperability of FIROS2 with microROS.
1111

1212
### Mechanisms for the deserialisation of incoming data in the transformation library
1313

@@ -25,7 +25,7 @@ For solving this issue, various methods to get it are proposed:
2525

2626
#### Use serialisation/deserialisation method provided by the middleware layer
2727

28-
This is currently the method used in micro-ROS - FIROS 2 integration.
28+
This is currently the method used in microROS - FIROS 2 integration.
2929

3030
In this case, the transformation library will use user selected middleware interface to serialise/deserialise the bridged ROS2 messages.
3131
This method requires to get the message typesupport for the bridged message type.
@@ -63,25 +63,25 @@ Note the call to ROS 2 interface __rosidl_typesupport_cpp::get_message_type_supp
6363
#### Use serialisation/deserialisation method for an specific type support
6464

6565
In this case, the transformation library will use one specific type support to serialise/deserialise the bridged ROS2 messages.
66-
In micro-ROS case, the implementation to be used will be rosidl_typesupport_microxrcedds.
66+
In microROS case, the implementation to be used will be rosidl_typesupport_microxrcedds.
6767
This method is trivial to develop as it does not require additional source code on the micro-ROS side.
6868

69-
In the case of micro-ROS, the transformation library should use the serialisation/deserialisation API exposed by its typesupport, rosidl_typesupport_microxrcedds.
69+
In the case of microROS, the transformation library should use the serialisation/deserialisation API exposed by its typesupport, rosidl_typesupport_microxrcedds.
7070
This mechanism requires the user to have access to the typesupport API, which sometimes is not always possible.
7171

7272
#### Used serialisation/deserialisation method generated from IDL file
7373

7474
In this case, transformation library will use generated code to serialise/deserialise the bridged ROS2 messages.
7575
The generated code may be made using an IDL parser tool.
76-
In the micro-ROS case, Micro XRCE-DDS provides with Micro XRCE-DDS code generator, which accepts an IDL file as input and generates type code.
76+
In the microROS case, Micro XRCE-DDS provides with Micro XRCE-DDS code generator, which accepts an IDL file as input and generates type code.
7777
This IDL files should correspond with those messages types the transformation is wanted.
7878
This is the [integration service](https://github.com/eProsima/Integration-Service) native method.
7979
Integration services uses this method, but it makes the development of the library slower as it needs to be generated per each message to be bridged.
8080

8181
![image](http://www.plantuml.com/plantuml/svg/bP8_2y8m4CNtV8f7tOIArd-R2DR1GGTT70eIqciRQ1D8qkzl4sr1iA0t11xlxjsF97lhk75jKxEQ2WUdOMHPEUJIa71IAwPqJeZGLQOoTPR2QDolXsESfZS8RvQao72dZM_mZH6unIbzB32XENN52baF8GrPoql20ZAluPtFgGIiGv855mvHfcwwDO9UcmfjC8ptsp2TYH1Z1rtrEbDzwX9V8P8HYDLl4Cb_4Ell49SHYCrl49V_8BPWZ8LxZkFTwvbOEDzo6UHgn5q7kHbnk-mzgTp_foS0)
8282

83-
In the case of ROS2/micro-ROS workspaces, there are tools which generate those IDL files.
84-
The rosidl_gen package is the package micro-ROS/ROS2 could use to create IDL from ROS2 interfaces.
83+
In the case of ROS2/microROS workspaces, there are tools which generate those IDL files.
84+
The rosidl_gen package is the package microROS/ROS2 could use to create IDL from ROS2 interfaces.
8585

8686
### Integration proposals
8787

@@ -90,7 +90,7 @@ This section presents all the integrations possibilities.
9090

9191
#### Direct integration
9292

93-
In this case, micro-ROS Agent will act as a bridge between DDS-XRCE and NGSIv2.
93+
In this case, microROS Agent will act as a bridge between DDS-XRCE and NGSIv2.
9494

9595
Selected bridged topics and their corresponding transformations must be configured on the micro-ROS Agent node.
9696

@@ -106,7 +106,7 @@ This proposal requires micro-ROS Agent changes, but it is the direct native inte
106106

107107
#### Indirect integration with a single FIROS2 node
108108

109-
In this case, micro-ROS nodes will publish the configured topics on DDS, and a FIROS2 node will subscribe to those topics and convert them into NGSIv2 protocol.
109+
In this case, microROS nodes will publish the configured topics on DDS, and a FIROS2 node will subscribe to those topics and convert them into NGSIv2 protocol.
110110
Selected bridged topics must be configured on that single FIROS2 node.
111111
Each ROS 2 topic type should have a corresponding transformation library configured on that FIROS2 node.
112112

@@ -124,11 +124,11 @@ This proposal requires transformation library development, but the integration w
124124

125125
#### Indirect integration with multiple FIROS2 nodes
126126

127-
In this case, micro-ROS nodes will publish the configured topic on DDS and multiple FIROS2 nodes, one for each set topic, will subscribe to those topics and convert them into NGSIv2 protocol.
127+
In this case, microROS nodes will publish the configured topic on DDS and multiple FIROS2 nodes, one for each set topic, will subscribe to those topics and convert them into NGSIv2 protocol.
128128

129129
This approach would require more nodes on the network and individual configurations.
130130

131-
This approach is the one followed by micro-ROS, and it is limited due to current FIROS 2 implementation.
131+
This approach is the one followed by microROS, and it is limited due to current FIROS 2 implementation.
132132

133133
This proposal requires transformation library development, but the integration will be the same as a regular ROS2 node, so no micro-ROS specific development should be expected.
134134

@@ -142,7 +142,7 @@ This proposal requires transformation library development, but the integration w
142142

143143
## Demonstration
144144

145-
This section explains how to demonstrate the interoperability of FIROS2 with Micro-ROS.
145+
This section explains how to demonstrate the interoperability of FIROS2 with microROS.
146146
The purpose is to demonstrate the interoperability, although the final design is not closed.
147147

148148
To run the demonstration a step by step guide is presented in this document.
@@ -233,7 +233,7 @@ docker pull microros/client_linux
233233
docker run -it --rm --privileged --net=host microros/client_linux
234234
```
235235

236-
Once in the docker run the micro-ROS Client.
236+
Once in the docker run the microROS Client.
237237

238238
```shell
239239
int32_publisher_c
@@ -271,4 +271,4 @@ In a Linux terminal execute the below sub-shell script
271271
)
272272
```
273273

274-
For further information please refer to the official FIROS2 documentation: [FIROS2 documentation](https://github.com/eProsima/FIROS2)
274+
For further information please refer to the official FIROS2 documentation: [FIROS2 documentation](https://github.com/eProsima/FIROS2)

_docs/index.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,20 @@ permalink: /docs/home/
33
title: Overview
44
---
55

6-
[micro-ROS](https://cordis.europa.eu/project/rcn/213167_en.html) puts ROS2 onto microcontrollers, making them first class participants of the ROS 2 environment.
6+
[microROS](https://cordis.europa.eu/project/rcn/213167_en.html) puts ROS2 onto microcontrollers, making them first class participants of the ROS 2 environment.
77

88
## Tutorials
99

1010
See [Tutorial List](/docs/tutorials/).
1111

1212
## Architecture
1313

14-
We're basically following the ROS2 architecture and make use of its middleware pluggability to use DDS-XRCE, which is suitable for micro-controllers. Moreover, we use an RTOS (NuttX) instead of Linux. On micro-controllers many different RTOS's are used, so we also add an RTOS abstraction layer (AL), to make porting to other RTOS possible.
14+
We're basically following the ROS2 architecture and make use of its middleware pluggability to use [DDS-XRCE](https://www.omg.org/spec/DDS-XRCE/), which is suitable for microcontrollers. Moreover, we use an RTOS (NuttX) instead of Linux. On microcontrollers many different RTOS's are used, so we also add an RTOS abstraction layer (AL), to make porting to other RTOS possible.
1515

1616
![](/img/micro-ROS_architecture.png)
1717

1818
## Concept Documentation
1919

20-
- Library to support the implementation of language-specific ROS Client Libraries: [rcl](https://github.com/microROS/rcl)
2120
- Predictable scheduling and execution: [real-time_executor](real-time_executor/)
2221
- System modes and system hierarchy: [system_modes](system_modes/)
2322
- Embedded transform (tf) library: [embedded_tf](embedded_tf/)
@@ -28,7 +27,7 @@ We're basically following the ROS2 architecture and make use of its middleware p
2827
## Source Code Repositories
2928

3029
- Middleware
31-
- RMW layer [rmw-microxrcedds](https://github.com/microROS/rmw-microxrcedds)
30+
- RMW adapter for Micro-XRCE-DDS [rmw-microxrcedds](https://github.com/microROS/rmw-microxrcedds)
3231
- Type Support [rosidl_typesupport_microxrcedds](https://github.com/microROS/rosidl_typesupport_microxrcedds)
3332
- "Agent" (bridge) [micro-ROS-Agent](https://github.com/microROS/micro-ROS-Agent)
3433
- RTOS

0 commit comments

Comments
 (0)