Skip to content

Commit a9d8505

Browse files
author
Juan Flores
committed
Merge remote-tracking branch 'origin/master' into nuttx-6lowpan
2 parents 9aad827 + 211c8f2 commit a9d8505

35 files changed

Lines changed: 3356 additions & 168 deletions

‎.gitlab-ci.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
image:
2+
jekyll/jekyll
3+
before_script:
4+
- bundle install
5+
pagecheck:
6+
script:
7+
- ./scripts/cibuild
8+

‎README.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1-
# microROS web site
1+
# micro-ROS web site
22

3-
This is the source for the microROS website, available
4-
at [https://microros.github.io/](https://microros.github.io/)
3+
[![pipeline status](https://gitlab.com/micro-ROS/ci-support/micro-ROS-github-io/badges/master/pipeline.svg)](https://gitlab.com/micro-ROS/ci-support/micro-ROS-github-io/commits/master)
4+
5+
This is the source for the micro-ROS website, available
6+
at [https://micro-ros.github.io/](https://micro-ros.github.io/)
57

68
## Editing
79

810
See [editing instructions](EDITING-INSTRUCTIONS.md)
911

1012
## Running locally
1113

12-
To test locally, you need a local version of Jekyll, the site-generation
14+
To test locally, you need a local version of Jekyll, the site-generation
1315
engine used by Github Pages. See [Jekyll Quickstart](https://jekyllrb.com/docs/)
1416
for installation instructions.
1517

@@ -28,7 +30,7 @@ To install it, It has been incorporated in the Gemfile so the previous dependenc
2830

2931
You can run the following gem to tests the generated site.
3032

31-
```bash
33+
```bash
3234
bundle exec jekyll build
3335
bundle exec htmlproofer ./_site
3436
```

‎_data/authors.yml‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
1-
iluetkeb:
1+
# The author entry will be looked for each post.
2+
# From all the author data, 'link' will be used to locate which will be prominent in the post, as a link.
3+
# 'link' should contain the name of the data to be used; twitter, web or github are currently supported.
4+
lui3si:
5+
name: iluetkeb
26
twitter: ingoluetkebohle
7+
link: twitter
38
anordman:
49
name: Arne Nordmann
510
twitter: norro58
611
web: http://arne-nordmann.de
12+
link: twitter
13+
borjaouterelo:
14+
name: Borja Outerelo
15+
twitter: boouga
16+
github: BorjaOuterelo
17+
link: twitter
18+
ralph-lange:
19+
name: Ralph Lange
20+
web: http://lange-ralph.de
21+
link: web

‎_docs/FIROS2/index.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: microROS & FIWARE
2+
title: micro-ROS & 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 microROS.
10+
This subsection will explain all the design alternatives for the interoperability of FIROS2 with micro-ROS.
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 microROS - FIROS 2 integration.
28+
This is currently the method used in micro-ROS - 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 microROS case, the implementation to be used will be rosidl_typesupport_microxrcedds.
66+
In micro-ROS 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 microROS, the transformation library should use the serialisation/deserialisation API exposed by its typesupport, rosidl_typesupport_microxrcedds.
69+
In the case of micro-ROS, 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 microROS 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 micro-ROS 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/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.
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.
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, microROS Agent will act as a bridge between DDS-XRCE and NGSIv2.
93+
In this case, micro-ROS 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, microROS 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, 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.
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, 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.
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.
128128

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

131-
This approach is the one followed by microROS, and it is limited due to current FIROS 2 implementation.
131+
This approach is the one followed by micro-ROS, 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

‎_docs/embedded_tf/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Table of contents
1818

1919
The TF transform graph, with its support for both a temporal history, and distributed information sources, has been a novel tool for robotics frameworks when it was released in 2008. Functionally, it is based in scene graph concepts known from computer graphics [[Foote 2013]](https://ieeexplore.ieee.org/document/6556373), but these only rarely offer distribution, and did not offer temporal histories at all (mainly, because this is not needed for frame-based rendering applications like in computer graphics). Distributed scene graphs have become more widely available also in computer graphics. In robotics, work by de Laet et al. [[De Laet et al. 2013]](https://ieeexplore.ieee.org/document/6696693) has extended transforms graphs to also contain twist (i.e., angular motion) information, and to provide more compile-time error checking. This is currently not integrated with distribution mechanisms, but could be used on a single system.
2020
One persistent issue with transform graphs has been their resource use. ROS TF works through replicated copies of the entire transform tree at every node that uses it, and is implemented through unicast TCP connections between nodes. In systems with many dynamic parts, this has sometimes been called the ``TF firehose``, because of the large stream of incoming messages.
21-
micro-ROS will go beyond this state of the art by running the dynamic transform tree in an embedded device, while keeping resource use to a minimum based on an analysis of the spatial and temporal details actually necessary. Further, enabling real-time queries even in the face of concurrent updates through integration will be realized through integration with the microROS real-time executor. It is also planned to integrate the embedded TF will with the node lifecycle to achieve further power-savings
21+
micro-ROS will go beyond this state of the art by running the dynamic transform tree in an embedded device, while keeping resource use to a minimum based on an analysis of the spatial and temporal details actually necessary. Further, enabling real-time queries even in the face of concurrent updates through integration will be realized through integration with the micro-ROS real-time executor. It is also planned to integrate the embedded TF will with the node lifecycle to achieve further power-savings
2222

2323

2424
## Requirements

‎_docs/hardware_support.md‎

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,45 @@
11
---
22
title: Supported Hardware
3-
---
3+
---
4+
5+
This page lists the hardware platforms that we use to test and develop micro-ROS, and also accessories that we frequently refer to, such as add-on boards, and JTAG probes.
6+
7+
## Reference Platforms {#evaluation-boards}
8+
9+
Even that micro-ROS technology can be ported to many targets, we have decided to select development platforms to support them. This page describes the main characteristic of those boards.
10+
11+
## Olimex LTD STM32-E407
12+
13+
![Olimex](https://www.olimex.com/Products/ARM/ST/STM32-E407/images/STM32-E407-02.jpg)
14+
15+
The [Olimex LTD STM32-E407](https://www.olimex.com/Products/ARM/ST/STM32-E407/open-source-hardware) is an open-hardware low-cost entry board for developing custom applications with the STM32F407ZGT6 Cortex-M4F microcontrollers from STMicroelectronics.
16+
17+
It contains 196KB of RAM and 1MB of Flash. It is a very complete board thanks to the wide variety of communication interfaces it offers: USB OTG, Ethernet, SD Card slot, SPI, CAN or I2C buses are exposed. The board contains various expansion options available: Arduino-like headers for attaching daughter boards, many pins exposed, as well as a UEXT connector. This connector is a custom pin-out bus and is used to attach sensor breakouts sensors that manufacturer sells.
18+
19+
### Development tools
20+
21+
In order to flash and debug the board, it is required to get a JTAG probe. We recommend getting on of the next JTAG probes:
422

5-
This page lists the hardware that microROS currently supports, and also accessories that we frequently refer to, such as add-on boards, and JTAG probes.
23+
+ [ARM-USB-OCD-H](https://www.olimex.com/Products/ARM/JTAG/ARM-USB-OCD-H/)
24+
+ [ARM-USB-TINY-H](https://www.olimex.com/Products/ARM/JTAG/ARM-USB-TINY-H/)
625

7-
## Evaluation Boards
26+
### Resources
827

9-
### Olimex STM32-E407
28+
+ [Vendor main page](https://www.olimex.com/Products/ARM/ST/STM32-E407/open-source-hardware)
29+
+ [Schematics in PDF](https://github.com/OLIMEX/STM32F4/blob/master/HARDWARE/STM32-E407/STM32-E407_Rev_F.pdf)
30+
+ [CAD files](https://github.com/OLIMEX/STM32F4)
31+
+ [User Manual](https://www.olimex.com/Products/ARM/ST/STM32-E407/resources/STM32-E407.pdf)
1032

11-
This is a fairly bare-bones evaluation board with an STM32F407ZGT6 microcontroller.
33+
## STM32L1 Discovery
1234

13-
## Development Tools
35+
![](https://www.st.com/content/ccc/fragment/product_related/rpn_information/board_photo/48/0b/aa/9b/b5/d7/43/89/32l152cdiscovery.jpg/files/32l152cdiscovery.jpg/_jcr_content/translations/en.32l152cdiscovery.jpg)
1436

15-
### Olimex ARM-USB-OCD-H JTAG probe
37+
The (STM32L1 Discovery Kit)[https://www.st.com/en/evaluation-tools/32l152cdiscovery.html] is an open hardware design, ultra low power and low-cost entry board for developing custom applications. It contains an STM32L152RCT6 Cortex-M3 microcontroller manufactured by ST Microelectronics. This part number contains 32KB of RAM and 256KB of flash memory. It also includes an ST-Link in-circuit debugger that allows flashing and debugging the target microcontroller.
1638

17-
This is a JTAG probe with a USB and RS232 port that can also power the board. It looks as follows:
18-
![image of ARM-USB-OCD-H](https://www.olimex.com/Products/ARM/JTAG/ARM-USB-OCD-H/images/thumbs/310x230/ARM-USB-OCD-H-2.png)
39+
### Resources
1940

20-
See the [Olimex product page for ARM-USB-OCD-H](https://www.olimex.com/Products/ARM/JTAG/ARM-USB-OCD-H/) for details.
41+
+ [Vendor main page](https://www.st.com/en/evaluation-tools/32l152cdiscovery.html)
42+
+ [User Manual](https://www.st.com/content/ccc/resource/technical/document/user_manual/08/f8/63/f5/7b/3d/40/ff/DM00027954.pdf/files/DM00027954.pdf/jcr:content/translations/en.DM00027954.pdf)
43+
+ [Schematics in PDF](https://www.st.com/resource/en/schematic_pack/32l152cdiscovery_sch.zip)
44+
+ [Bill of Material](https://www.st.com/resource/en/bill_of_materials/32l152cdiscovery_bom.zip)
45+
+ [Gerber files](https://www.st.com/resource/en/bill_of_materials/32l152cdiscovery_bom.zip)

‎_docs/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ permalink: /docs/home/
33
title: Overview
44
---
55

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.
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.
77

88
## Tutorials
99

‎_docs/real-time_executor/index.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ In this section, we describe the necessary changes to the Executor API and repor
7474

7575
### API Changes
7676

77-
* [include/rclcpp/callback\_group.hpp](https://github.com/microROS/rclcpp/blob/cbg-executor-0.5.1/rclcpp/include/rclcpp/callback_group.hpp):
77+
* [include/rclcpp/callback\_group.hpp](https://github.com/micro-ROS/rclcpp/blob/cbg-executor-0.5.1/rclcpp/include/rclcpp/callback_group.hpp):
7878

7979
Introduced enum to distinguish up to three real-time classes (requirements) per node.
8080

@@ -102,7 +102,7 @@ In this section, we describe the necessary changes to the Executor API and repor
102102
}
103103
```
104104

105-
* [include/rclcpp/executor.hpp](https://github.com/microROS/rclcpp/blob/cbg-executor-0.5.1/rclcpp/include/rclcpp/executor.hpp)
105+
* [include/rclcpp/executor.hpp](https://github.com/micro-ROS/rclcpp/blob/cbg-executor-0.5.1/rclcpp/include/rclcpp/executor.hpp)
106106

107107
Added functions to add and remove individual callback groups in addition to whole nodes.
108108

@@ -136,11 +136,11 @@ In this section, we describe the necessary changes to the Executor API and repor
136136
WeakCallbackGroupsToNodesMap weak_groups_to_nodes_;
137137
```
138138

139-
* [include/rclcpp/memory\_strategy.hpp](https://github.com/microROS/rclcpp/blob/cbg-executor-0.5.1/rclcpp/include/rclcpp/memory_strategy.hpp)
139+
* [include/rclcpp/memory\_strategy.hpp](https://github.com/micro-ROS/rclcpp/blob/cbg-executor-0.5.1/rclcpp/include/rclcpp/memory_strategy.hpp)
140140

141141
Changed all functions that expect a vector of nodes to the just mentioned map.
142142

143-
* [include/rclcpp/node.hpp](https://github.com/microROS/rclcpp/blob/cbg-executor-0.5.1/rclcpp/include/rclcpp/node.hpp) and [include/rclcpp/node_interfaces/node_base.hpp](https://github.com/microROS/rclcpp/blob/cbg-executor-0.5.1/rclcpp/include/rclcpp/node_interfaces/node_base.hpp)
143+
* [include/rclcpp/node.hpp](https://github.com/micro-ROS/rclcpp/blob/cbg-executor-0.5.1/rclcpp/include/rclcpp/node.hpp) and [include/rclcpp/node_interfaces/node_base.hpp](https://github.com/micro-ROS/rclcpp/blob/cbg-executor-0.5.1/rclcpp/include/rclcpp/node_interfaces/node_base.hpp)
144144

145145
Extended arguments of create\_callback\_group function for the real-time class.
146146

@@ -153,7 +153,7 @@ In this section, we describe the necessary changes to the Executor API and repor
153153

154154
Removed the get\_associated\_with\_executor\_atomic function.
155155

156-
All the changes can be found in the branches [cbg-executor-0.5.1](https://github.com/microROS/rclcpp/tree/cbg-executor-0.5.1/rclcpp) and [cbg-executor-0.6.1](https://github.com/microROS/rclcpp/tree/cbg-executor-0.6.1/rclcpp) for the corresponding version 0.5.1 and 0.6.1 of the rclcpp in the fork at [github.com/microROS/rclcpp/](https://github.com/microROS/rclcpp/).
156+
All the changes can be found in the branches [cbg-executor-0.5.1](https://github.com/micro-ROS/rclcpp/tree/cbg-executor-0.5.1/rclcpp) and [cbg-executor-0.6.1](https://github.com/micro-ROS/rclcpp/tree/cbg-executor-0.6.1/rclcpp) for the corresponding version 0.5.1 and 0.6.1 of the rclcpp in the fork at [github.com/micro-ROS/rclcpp/](https://github.com/micro-ROS/rclcpp/).
157157

158158

159159
### Meta-Executor Concept
@@ -175,7 +175,7 @@ With the test bench, we validated the functioning of the approach - here on ROS
175175

176176
![Results from Callback-group-level Executor test bench](cbg-executor_test-bench_results.png)
177177

178-
The test bench is provided in the [bg-executor_ping-pong_cpp](https://github.com/microROS/microROS_experiments/tree/experiment/cbg-executor-0.6.1/cbg-executor_ping-pong) package of the [microROS_experiments](https://github.com/microROS/microROS_experiments) repository.
178+
The test bench is provided in the [bg-executor_ping-pong_cpp](https://github.com/micro-ROS/micro-ROS_experiments/tree/experiment/cbg-executor-0.6.1/cbg-executor_ping-pong) package of the [micro-ROS_experiments](https://github.com/micro-ROS/micro-ROS_experiments) repository.
179179

180180

181181
## Roadmap

0 commit comments

Comments
 (0)