Skip to content

Commit 2ba3b95

Browse files
pablogs9pablogs9
authored
Galactic update (#314)
* Initial * Update * Update * Update * Update
1 parent e60cc72 commit 2ba3b95

12 files changed

Lines changed: 570 additions & 48 deletions

File tree

‎.github/ISSUE_TEMPLATE/general-issue.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ assignees: ''
1212
- Hardware description: <!-- hardware where you are using micro-ROS -->
1313
- RTOS: <!-- RTOS where you are using micro-ROS -->
1414
- Installation type: <!-- micro_ros_setup, modules, etc -->
15-
- Version or commit hash: <!-- version of micro-ROS used: foxy, rolling -->
15+
- Version or commit hash: <!-- version of micro-ROS used: foxy, galactic, rolling -->
1616

1717
#### Steps to reproduce the issue
1818
<!-- Detailed instructions on how to reliably reproduce this issue http://sscce.org/-->

‎.github/workflows/generate_api_reference.yml‎

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: API reference generator
2-
on:
2+
on:
33
workflow_dispatch:
44
inputs:
55
name:
@@ -8,7 +8,7 @@ on:
88
- cron: '0 6 * * *'
99

1010
jobs:
11-
generate_api_reference:
11+
generate_rmw_api_reference:
1212
runs-on: ubuntu-latest
1313
container: ros:foxy
1414
steps:
@@ -27,8 +27,8 @@ jobs:
2727
unzip doxybook2-linux-amd64-v1.3.3.zip -d doxybook2
2828
2929
mkdir -p ros2_ws/src; cd ros2_ws
30-
git clone -b foxy https://github.com/eProsima/Micro-CDR src/Micro-CDR
31-
git clone -b foxy https://github.com/eProsima/Micro-XRCE-DDS-Client src/Micro-XRCE-DDS-Client
30+
git clone -b foxy https://github.com/eProsima/Micro-CDR src/Micro-CDR
31+
git clone -b foxy https://github.com/eProsima/Micro-XRCE-DDS-Client src/Micro-XRCE-DDS-Client
3232
git clone -b foxy https://github.com/micro-ROS/rosidl_typesupport_microxrcedds src/rosidl_typesupport_microxrcedds
3333
git clone -b foxy https://github.com/micro-ROS/rmw-microxrcedds src/rmw-microxrcedds
3434
@@ -40,9 +40,45 @@ jobs:
4040
- name: Create Pull Request
4141
uses: peter-evans/create-pull-request@v3
4242
with:
43-
commit-message: micro-ROS API reference auto-update ${{ steps.date.outputs.date }}
44-
title: micro-ROS API reference auto-update ${{ steps.date.outputs.date }}
45-
body: This PR is autogenerated and updates the micro-ROS API reference. Close and reopen to trigger CI.
46-
branch: autoupdate_micro_ros_api_reference
43+
commit-message: micro-ROS RMW API reference auto-update ${{ steps.date.outputs.date }}
44+
title: micro-ROS RMW API reference auto-update ${{ steps.date.outputs.date }}
45+
body: This PR is autogenerated and updates the micro-ROS RMW API reference. Close and reopen to trigger CI.
46+
branch: autoupdate_micro_ros_rmw_api_reference
47+
delete-branch: true
48+
base: master
49+
50+
generate_utils_api_reference:
51+
runs-on: ubuntu-latest
52+
container: ros:foxy
53+
steps:
54+
- uses: actions/checkout@v2
55+
- name: Get date
56+
id: date
57+
run: echo "::set-output name=date::$(date +'%d-%m-%Y %H:%M')"
58+
- name: Update libraries
59+
shell: bash
60+
run: |
61+
apt update
62+
apt install -y doxygen wget git unzip cmake ros-foxy-osrf-testing-tools-cpp
63+
64+
pushd /
65+
wget https://github.com/matusnovak/doxybook2/releases/download/v1.3.3/doxybook2-linux-amd64-v1.3.3.zip
66+
unzip doxybook2-linux-amd64-v1.3.3.zip -d doxybook2
67+
68+
mkdir -p ros2_ws/src; cd ros2_ws
69+
git clone -b galactic https://github.com/micro-ROS/micro_ros_utilities src/micro_ros_utilities
70+
71+
source /opt/ros/$ROS_DISTRO/setup.bash
72+
colcon build --packages-up-to micro_ros_utilities --cmake-args -DBUILD_DOCUMENTATION=ON
73+
popd
74+
75+
/doxybook2/bin/doxybook2 --input /ros2_ws/build/micro_ros_utilities/doc/xml --output _includes/utils_doc -c utils/doxy_config -t utils/doxy_templates
76+
- name: Create Pull Request
77+
uses: peter-evans/create-pull-request@v3
78+
with:
79+
commit-message: micro-ROS Utils API reference auto-update ${{ steps.date.outputs.date }}
80+
title: micro-ROS Utils API reference auto-update ${{ steps.date.outputs.date }}
81+
body: This PR is autogenerated and updates the micro-ROS Utils API reference. Close and reopen to trigger CI.
82+
branch: autoupdate_micro_ros_utils_api_reference
4783
delete-branch: true
4884
base: master

‎_data/docs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,4 +89,5 @@
8989
docs:
9090
- api/overview
9191
- api/rmw
92+
- api/utils
9293
- api/rclc

‎_docs/api/overview/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ redirect_from:
66
---
77

88
* [**RMW Micro XRCE-DDS**](../rmw/)
9+
* [**micro-ROS Utils**](../utils/)
910
* [**RCLC**](../rclc/)

‎_docs/api/utils/index.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: micro-ROS Utils
3+
permalink: /docs/api/utils/
4+
---
5+
6+
{% include utils_doc/Modules/group__typeutils.md %}
7+
{% include utils_doc/Modules/group__stringutils.md %}

‎_docs/concepts/build_system/external_build_systems/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Once you have read about the official [**micro_ros_setup** tool](/docs/concepts/
77

88
## micro-ROS component for ESP-IDF
99

10-
The [micro-ROS component for ESP-IDF](https://github.com/micro-ROS/micro_ros_espidf_component) allows to integrate micro-ROS as a component in an Espressif ESP-IDF Build System. This component allows the user to integrate the micro-ROS API and utilities in an already created ESP-IDF project just by cloning or copying a folder.
10+
The [micro-ROS component for ESP-IDF](https://github.com/micro-ROS/micro_ros_espidf_component) allows to integrate micro-ROS as a component in an Espressif ESP-IDF Build System. This component allows the user to integrate the micro-ROS API and utilities in an already created ESP-IDF project just by cloning or copying a folder.
1111

1212
Configuration of the micro-ROS library is based on the `colcon.meta` file. For more details visit the [Git repository](https://github.com/micro-ROS/micro_ros_espidf_component).
1313

@@ -27,4 +27,4 @@ Along with this support package, there are [detailed instructions](https://githu
2727

2828
The [micro-ROS for STM32CubeMX](https://github.com/micro-ROS/micro_ros_stm32cubemx_utils) package is a set of utilities which enables the seamless configuration, set-up and integration of micro-ROS into an STM32 controller based project. As such, it allows micro-ROS to be virtually supported by the full set of boards offered by <a href="https://www.st.com/content/st_com/en.html">STMicroelectronics</a>.
2929

30-
Its usage is based on Dockers, via a prepared [Dockerfile](https://github.com/micro-ROS/micro_ros_stm32cubemx_utils/blob/foxy/microros_component/Dockerfile) which eases micro-ROS library generation outside of a ROS 2 environment.
30+
Its usage is based on Dockers, via a prepared [Dockerfile](https://github.com/micro-ROS/docker/blob/foxy/micro-ROS-static-library-builder/Dockerfile) which eases micro-ROS library generation outside of a ROS 2 environment.

‎_docs/concepts/build_system/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ ros2 run micro_ros_setup create_firmware_ws.sh [RTOS] [HARDWARE BOARD]
2323
```
2424

2525
It is possible to obtain a list of the supported hardware by running the command without any argument. By doing so, it is possible to see that along with the RTOSes and hardware supported by micro-ROS this build system also provides with three extra options:
26-
- By using `zephyr` as RTOS and `host` as hardware name, it is possible to obtain a Zephyr RTOS image with your micro-ROS app that runs in your host computer.
26+
- By using `zephyr` as RTOS and `host` as hardware name, it is possible to obtain a Zephyr RTOS image with your micro-ROS app that runs in your host computer.
2727
- By using just `host` as RTOS, micro-ROS will build a set of [micro-ROS demo applications](https://github.com/micro-ROS/micro-ROS-demos) natively in your host machine. These applications behave just like micro-ROS apps (using the same abstraction layers and middleware implementation) and allow the user to debug and test the applications on a PC.
2828
- By using `generate_lib` as RTOS it is possible to configure the build system for generating static libraries (`.a`) and a set of headers (`include`) that can be linked in any other external tool. This option requires a valid CMake toolchain.
2929

@@ -66,4 +66,4 @@ ros2 run micro_ros_agent micro_ros_agent [OPTIONS]
6666

6767
**Tip 1:** To learn use of the micro_ros_setup build system hands-on, please see the [core tutorials](https://micro-ros.github.io/docs/tutorials/core/first_application_rtos/).
6868

69-
**Tip 2 :** Remember that the micro-ROS Agent can be also be used with this simple Docker command: `docker run -it --rm -v /dev:/dev --privileged --net=host microros/micro-ros-agent:foxy [OPTIONS]`
69+
**Tip 2 :** Remember that the micro-ROS Agent can be also be used with this simple Docker command: `docker run -it --rm -v /dev:/dev --privileged --net=host microros/micro-ros-agent:$ROS_DISTRO [OPTIONS]`

0 commit comments

Comments
 (0)