From 549a6078d4fc0fd03603f1a55e7f2c0e91f136f6 Mon Sep 17 00:00:00 2001 From: FranFin Date: Tue, 30 Mar 2021 11:51:58 +0200 Subject: [PATCH 01/12] Refactored webpage. --- _docs/overview/ext_platforms/index.md | 129 +++++++++ _docs/overview/hardware/index.md | 328 ++++++++++++++-------- _docs/overview/transports/index.md | 30 -- _docs/overview/users_and_clients/index.md | 4 + 4 files changed, 343 insertions(+), 148 deletions(-) create mode 100644 _docs/overview/ext_platforms/index.md delete mode 100644 _docs/overview/transports/index.md diff --git a/_docs/overview/ext_platforms/index.md b/_docs/overview/ext_platforms/index.md new file mode 100644 index 00000000..dfb3865e --- /dev/null +++ b/_docs/overview/ext_platforms/index.md @@ -0,0 +1,129 @@ +--- +title: Integration into External Platforms +permalink: /docs/overview/ext_platforms/ +--- + + + +micro-ROS aims to **bring ROS 2 to microcontrollers** to allow having first-class ROS 2 entities in the embedded world. + +One of the approaches offered by micro-ROS to build an application for embedded platforms consists in a [proprietary build system](https://github.com/micro-ROS/micro_ros_setup) comprising modules which integrate the software for cross-compiling said apps on the supported plaforms, both hardware and firmware-wise. A different approach consists in generating standalone modules and components allowing to integrate micro-ROS into external or custom development frameworks, made possible by a [tool dedicated to compiling micro-ROS as a standalone library](../../tutorials/advanced/create_custom_static_library). + +The configuration of the generated micro-ROS libraries is based on a `colcon.meta` file. + +The modules that exist up to date for integrating into external build systems are the following: + +### **micro-ROS component for the ESP-IDF** + +
+
+
+ ESP-IDF is the official development framework for the ESP32, ESP32-S and ESP32-C Series SoCs. + To date, it has been tested in ESP-IDF v4.1 and v4.2 with ESP32 and ESP32-S2. + The micro-ROS component for the ESP-IDF 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. + The current ports support Serial (UART), + WiFi, and Ethernet. +
Resources: + +
+
+ +
+ +
+
+ +### **micro-ROS module for the Zephyr build system** + +
+
+
+ Zephyr is a scalable RTOS built with security in mind, and based on a small-footprint kernel designed for use on resource-constrained systems. + The Zephyr kernel supports multiple hardware architectures, including ARM Cortex-M, Intel x86, ARC, Nios II, Tensilica Xtensa, and RISC-V, and can count with large number of supported boards. + The micro-ROS module for Zephyr allows to integrate the micro-ROS API and utilities in an existing Zephyr-based project just by cloning or copying a folder. +
Resources: + +
+
+ +
+ +
+
+ +### **micro-ROS for Arduino** + +
+
+
+ Arduino is an open-source platform based on an I/O board and a development environment that implements the Processing/Wiring language, intended to enable users to easily generate interactive projects. A CLI is also offered, which aims to be an all-in-one solution providing the tools needed to use any Arduino compatible platform from the command line. + The micro-ROS for Arduino support package is a special bare-metal port of micro-ROS provided as a set of precompiled libraries for specific platforms. +
Resources: + +
+
+ +
+ +
+
+ +### **micro-ROS for STM32CubeMX** + + +
+
+
+ The STM32CubeMX is a graphical tool by ST for configuring STM32 microcontrollers and microprocessors. It enables to optimally program and manipulate the software thanks to a set of utilities that help setting up pinouts, peripherals, and middleware stacks. + micro-ROS for STM32CubeMX is based on a Dockerfile and allows micro-ROS to be virtually supported by the full set of boards offered by STMicroelectronics, in turn enabling the seamless integration of micro-ROS into any STM32 controller based project. +
Resources: + +
+
+ +
+ +
+
+ +{% include logos_disclaimer.md %} diff --git a/_docs/overview/hardware/index.md b/_docs/overview/hardware/index.md index 9a8fcfa7..d126cd97 100644 --- a/_docs/overview/hardware/index.md +++ b/_docs/overview/hardware/index.md @@ -5,7 +5,7 @@ permalink: /docs/overview/hardware/ @@ -34,63 +34,39 @@ The main targets of micro-ROS are mid-range 32-bits microcontroller families. Us In general micro-ROS will need MCUs that have tens of kilobytes of RAM memory and communication peripherals that enable the micro-ROS [Client to Agent communication](https://micro-ros.github.io//docs/overview/features/). -The micro-ROS hardware support is divided into three categories: -- reference micro-ROS board, -- tier 2 boards and, -- community supported boards. +The micro-ROS hardware support is divided into two categories: +- Officially supported boards +- Community supported boards *In order to check the most recent hardware support visit the [micro_ros_setup repo](https://github.com/micro-ROS/micro_ros_setup)*. -## Reference micro-ROS board +## Officially supported boards -The micro-ROS reference boards are the ones officially supported for all RTOSes and with complete support for all available transports. - -
-
-

Olimex LTD STM32-E407

-
- Key features: -
    -
  • MCU: STM32F407ZGT6 Cortex-M4F
    • -
  • RAM: 196 kB
    • -
  • Flash: 1 MB
    • -
  • Peripherals: USB OTG, Ethernet, SD Card slot, SPI, CAN, I2C...
    • -
- - Resources: - -
-
- -
- -
-
- -## Tier 2 micro-ROS boards - -The micro-ROS Tier 2 boards are officially supported for one or more RTOSes and transports. +The officially supported boards are those which have been carried out or tested officially, and to which LTS is guaranteed.

Espressif ESP32 DevKitC

- Key features: + ✔ Key features:
  • MCU: ultra-low power dual-core Xtensa LX6
  • RAM: 520 kB
  • Flash: 4 MB
  • Peripherals: Ethernet MAC, Wi-Fi 802.11 b/g/n, Bluetooth v4.2 BR/EDR, BLE, SPI, I2C, I2S, UART, SDIO, CAN, GPIO, ADC/DAC, PWM
- Resources: + 🌎 Resources: + + ⚙ Supported platforms: +
    +
  • RTOS: FreeRTOS
    • +
  • External platform: ESP-IDF
    • +
+ 🔌 Supported transports: + UART, WiFi UDP, Ethernet UDP
@@ -99,70 +75,92 @@ The micro-ROS Tier 2 boards are officially supported for one or more RTOSes and
+
-

Teensy 3.2

+

Arduino Portenta H7

- Key features: + ✔ Key features:
    -
  • MCU: ARM Cortex-M4 MK20DX256VLH7
    • -
  • RAM: 64 kB
    • -
  • Flash: 256 kB
    • -
  • Peripherals: USB, SPI, I2C, CAN, I2S...
    • +
  • MCU: Dual-core Arm Cortex-M7 and Cortex-M4
    • +
  • RAM: 8 MB
    • +
  • Flash: 16 MB
    • +
  • Peripherals: USB HS, Ethernet, WiFi/BT...
- Resources: + 🌎 Resources: - This board is supported under micro-ROS for Arduino -
+ ⚙ Supported platforms: +
    +
  • RTOS: –
    • +
  • External platform: Arduino
    • +
+ 🔌 Supported transports: + USB, WiFi UDP
+
- +
+
-

Teensy 4.0/4.1

+

Raspberry Pi Pico RP2040

- Key features: + ✔ Key features:
    -
  • MCU: ARM Cortex-M7 iMXRT1062
    • -
  • RAM: 1024 kB
    • -
  • Flash: 2048 kB
    • -
  • Peripherals: USB, PWM, SPI, I2C, CAN, I2S, SDIO,...
    • -
- Resources: +
  • MCU: Dual-core Arm Cortex-M0+
    • +
  • RAM: 264 kB
    • +
  • Flash: up to 16 MB
    • +
  • Peripherals: I2C, SPI, PIO...
    • + + 🌎 Resources: + ⚙ Supported platforms: +
      +
    • RTOS: –
      • +
    • External platform: Raspberry Pi Pico SDK
    - This board is supported under micro-ROS for Arduino + 🔌 Supported transports: + USB, UART
    - +
    +

    ROBOTIS OpenCR 1.0

    - Key features: + ✔ Key features:
    • MCU: ARM Cortex-M7 STM32F746ZGT6
    • RAM: 320 kB
    • Flash: 1024 kB
    • Peripherals: 3-axis IMU, Dynamixel ports, SPI, I2C...
    - Resources: + 🌎 Resources: - This board is supported under micro-ROS for Arduino + ⚙ Supported platforms: +
      +
    • RTOS: –
      • +
    • External platform: Arduino
      • +
    + 🔌 Supported transports: + USB, UART
    @@ -171,46 +169,91 @@ The micro-ROS Tier 2 boards are officially supported for one or more RTOSes and
    +
    -

    STM32L4 Discovery kit IoT

    +

    Teensy 3.2

    - Key features: + ✔ Key features:
      -
    • MCU: ARM Cortex-M4 STM32L4
      • -
    • RAM: 128 kB
      • -
    • Flash: 1 MB
      • -
    • Peripherals: Bluetooth, low-power RF module, 802.11 b/g/n, NFC, 2 digital microphone, temperature/humidity sensor, 3 axis IMU, ToF sensor...
      • +
    • MCU: ARM Cortex-M4 MK20DX256VLH7
      • +
    • RAM: 64 kB
      • +
    • Flash: 256 kB
      • +
    • Peripherals: USB, SPI, I2C, CAN, I2S...
    - - Resources: + 🌎 Resources: +
  • Official website
    • + + ⚙ Supported platforms: +
      +
    • RTOS: –
      • +
    • External platform: Arduino
      • +
    + 🔌 Supported transports: + USB, UART
    - + +
    +
    + + +
    +
    +

    Teensy 4.0/4.1

    +
    + ✔ Key features: +
      +
    • MCU: ARM Cortex-M7 iMXRT1062
      • +
    • RAM: 1024 kB
      • +
    • Flash: 2048 kB
      • +
    • Peripherals: USB, PWM, SPI, I2C, CAN, I2S, SDIO,...
      • +
    + 🌎 Resources: + + ⚙ Supported platforms: +
      +
    • RTOS: –
      • +
    • External platform: Arduino
      • +
    + 🔌 Supported transports: + USB, UART +
    +
    + +
    +
    +

    Crazyflie 2.1 Drone

    - Key features: + ✔ Key features:
    • MCU: ARM Cortex-M4 STM32F405
    • RAM: 192 kB
    • Flash: 1 MB
    • Peripherals: 3 axis IMU, pressure sensor, SPI, I2C, UART, nRF51822 radio...
    - - Resources: + 🌎 Resources: + + ⚙ Supported platforms: +
      +
    • RTOS: FreeRTOS
      • +
    • External platform: –
      • +
    + 🔌 Supported transports: + Custom Radio Link
    @@ -219,52 +262,68 @@ The micro-ROS Tier 2 boards are officially supported for one or more RTOSes and
    +
    -

    Raspberry Pi Pico RP2040

    +

    STM32L4 Discovery kit IoT

    - Key features: + ✔ Key features:
      -
    • MCU: Dual-core Arm Cortex-M0+
      • -
    • RAM: 264 kB
      • -
    • Flash: up to 16 MB
      • -
    • Peripherals: I2C, SPI, PIO...
      • +
    • MCU: ARM Cortex-M4 STM32L4
      • +
    • RAM: 128 kB
      • +
    • Flash: 1 MB
      • +
    • Peripherals: Bluetooth, low-power RF module, 802.11 b/g/n, NFC, 2 digital microphone, temperature/humidity sensor, 3 axis IMU, ToF sensor...
    - - Resources: + 🌎 Resources: +
  • Official website
    • + + ⚙ Supported platforms: +
      +
    • RTOS: Zephyr
      • +
    • External platform: –
      • +
    + 🔌 Supported transports: + USB, UART, Ethernet UDP
    - +
    +
    -

    Arduino Portenta H7

    +

    Olimex LTD STM32-E407

    - Key features: + ✔ Key features:
      -
    • MCU: Dual-core Arm Cortex-M7 and Cortex-M4
      • -
    • RAM: 8 MB
      • -
    • Flash: 16 MB
      • -
    • Peripherals: USB HS, Ethernet, WiFi/BT...
      • +
    • MCU: STM32F407ZGT6 Cortex-M4F
      • +
    • RAM: 196 kB
      • +
    • Flash: 1 MB
      • +
    • Peripherals: USB OTG, Ethernet, SD Card slot, SPI, CAN, I2C...
    - - Resources: + 🌎 Resources: +
  • Official website
    • +
  • Schematics
    • +
  • User Manual
    • + + ⚙ Supported platforms: +
      +
    • RTOS: Zephyr, FreeRTOS, NuttX
      • +
    • External platform: –
      • +
    + 🔌 Supported transports: + USB (Z, N), UART (Z, F, N), Ethernet UDP (F, N) +
    Note: Only RTOS initials used for convenience.
    - +
    @@ -276,17 +335,23 @@ The micro-ROS community supported boards are contributions of micro-ROS' users a

    Arduino Due

    - Key features: + ✔ Key features:
    • MCU: ARM Cortex-M3 AT91SAM3X8E
    • RAM: 96 kB
    • Flash: 512 kB
    - Resources: + 🌎 Resources: - This board is supported under micro-ROS for Arduino + ⚙ Supported platforms: +
      +
    • RTOS: –
      • +
    • External platform: Arduino
      • +
    + 🔌 Supported transports: + USB, UART
    @@ -299,17 +364,23 @@ The micro-ROS community supported boards are contributions of micro-ROS' users a

    Arduino Zero

    - Key features: + ✔ Key features:
    • MCU: ARM Cortex-M0+ ATSAMD21G18
    • RAM: 32 kB
    • Flash: 256 kB
    - Resources: + 🌎 Resources: - This board is supported under micro-ROS for Arduino + ⚙ Supported platforms: +
      +
    • RTOS: –
      • +
    • External platform: Arduino
      • +
    + 🔌 Supported transports: + USB, UART
    @@ -322,10 +393,17 @@ The micro-ROS community supported boards are contributions of micro-ROS' users a

    ST NUCLEO-F446ZE

    - Resources: + 🌎 Resources: + + ⚙ Supported platforms: +
      +
    • RTOS: FreeRTOS
      • +
    • External platform: STM32CubeMX
      • +
    + 🔌 Supported transports: + UART
    @@ -338,10 +416,17 @@ The micro-ROS community supported boards are contributions of micro-ROS' users a

    ST NUCLEO-F746ZG

    - Resources: + 🌎 Resources: + + ⚙ Supported platforms: +
      +
    • RTOS: FreeRTOS
      • +
    • External platform: STM32CubeMX
      • +
    + 🔌 Supported transports: + UART
    @@ -354,10 +439,17 @@ The micro-ROS community supported boards are contributions of micro-ROS' users a

    ST NUCLEO-H743ZI

    - Resources: + 🌎 Resources: + + ⚙ Supported platforms: +
      +
    • RTOS: FreeRTOS
      • +
    • External platform: STM32CubeMX
      • +
    + 🔌 Supported transports: + UART
    diff --git a/_docs/overview/transports/index.md b/_docs/overview/transports/index.md deleted file mode 100644 index 662be3a1..00000000 --- a/_docs/overview/transports/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: Transports and Data Links -permalink: /docs/overview/transports/ ---- - -micro-ROS uses the resource-optimized [DDS for Extremely Resource Constrained Environments (DDS-XRCE) standard](https://www.omg.org/spec/DDS-XRCE/), implemented by [eProsima's Micro-XRCE-DDS](https://github.com/eProsima/Micro-XRCE-DDS/). - -It supports a variety of data link and transport protocols. However, the support depends on the underlying RTOS and selected hardware. - -The following table specifies the available transports for the Reference and Tier-2 micro-ROS boards for each officially supported RTOS. You can find detailed information about hardware support [here](/docs/overview/hardware/). - -| | [**NuttX**](http://nuttx.apache.org/) | [**FreeRTOS**](https://www.freertos.org/) | [**Zephyr**](https://www.zephyrproject.org/) | [Arduino](https://github.com/micro-ROS/micro_ros_arduino) | -| ------------------ | :-----------------------------------: | :---------------------------------------: | :------------------------------------------: | :---------------------------------------------------------------------: | -| Olimex STM32-E407 | USB, UART, Network | UART, Network | USB, UART | - | -| ST B-L475E-IOT01A | - | - | USB, UART, Network | - | -| Crazyflie 2.1 | - | Custom Radio Link | - | - | -| Espressif ESP32 | - | UART, WiFI UDP | - | - | -| Teensy 3.2 | - | - | - | USB, UART | -| Teensy 4.0/4.1 | - | - | - | USB, UART | -| ROBOTIS OpenCR 1.0 | - | - | - | USB, UART | - -Regarding the **community supported** boards, at the moment of writing the available transports are: - -| | [**NuttX**](http://nuttx.apache.org/) | [**FreeRTOS**](https://www.freertos.org/) | [**Zephyr**](https://www.zephyrproject.org/) | [Arduino](https://github.com/micro-ROS/micro_ros_arduino) | -| ---------------- | :-----------------------------------: | :---------------------------------------: | :------------------------------------------: | :---------------------------------------------------------------------: | -| Arduino Due | - | - | - | USB, UART | -| Arduino Zero | - | - | - | USB, UART | -| ST Nucleo F446ZE | - | UART | - | - | -| ST Nucleo H743ZI | - | UART | - | - | -| ST Nucleo F746ZG | - | UART | - | - | diff --git a/_docs/overview/users_and_clients/index.md b/_docs/overview/users_and_clients/index.md index d78da74c..530ae810 100644 --- a/_docs/overview/users_and_clients/index.md +++ b/_docs/overview/users_and_clients/index.md @@ -73,6 +73,10 @@ collaborators: text: Espressif Systems is a public multinational, fabless semiconductor company focused on developing cutting-edge Wi-Fi-and-Bluetooth, low-power, AIoT solutions. They have created the popular ESP8266, ESP32, ESP32-S and ESP32-C series of chips, modules and development boards, and offer several open-source frameworks for building AIoT applications, among which the Espressif's IoT Development Framework ESP-IDF. title: Espressif url: www.espressif.com + - path: http://hydrasystem.pl/img/hydra_system_black.png + text: Hydra System provides a multi-component solution, designed specifically for precise localisation of agricultural machines with work efficiency in mind Hydra System is composed of navigation module for agricultural machine (Hydra Box), specialised software (Hydra Nav) and an optional base station module (Hydra Base). + title: Hydra System + url: www.hydrasystem.pl/index.en_GB.html --- From 5a7faa30988b061d81b1e6db5776d61817bb7245 Mon Sep 17 00:00:00 2001 From: FranFin Date: Tue, 30 Mar 2021 11:53:02 +0200 Subject: [PATCH 02/12] Refactorization. --- _data/docs.yml | 37 +++++++++--------- .../external_build_systems/index.md | 6 +++ .../create_dds_entities_by_ref/index.md | 2 +- .../create_new_type/index.md | 2 +- .../imgs/best_effort_stream.svg | 0 .../imgs/micro_ros_memory.svg | 0 .../imgs/reliable_strea.svg | 0 .../microxrcedds_rmw_configuration/index.md | 2 +- .../first_application_linux/index.md | 2 +- .../first_application_rtos/freertos.md | 2 +- .../first_application_rtos/imgs/1.jpg | Bin .../first_application_rtos/imgs/2.jpg | Bin .../first_application_rtos/imgs/5.jpg | Bin .../first_application_rtos/imgs/6.jpg | Bin .../first_application_rtos/imgs/7.jpg | Bin .../imgs/nuttx_examples.png | Bin .../imgs}/nuttx_menuconfig.png | Bin .../first_application_rtos/index.md | 2 +- .../first_application_rtos/nuttx.md | 2 +- .../first_application_rtos/zephyr.md | 2 +- .../{core => firststeps}/overview/index.md | 4 +- .../doc/highPriorityPath.png | Bin .../doc/scheduling_01.png | Bin .../doc/scheduling_02.png | Bin .../doc/scheduling_LET.png | Bin .../doc/sensePlanActScheme.png | Bin .../doc/sensorFusion_01.png | Bin .../doc/sensorFusion_02.png | Bin .../doc/sensorFusion_03.png | Bin .../programming_rcl_rclc/index.md | 2 +- .../zephyr_emulator/imgs/4.jpg | Bin .../zephyr_emulator/index.md | 2 +- .../{advanced/nuttx => old}/6lowpan/index.md | 2 +- .../images}/nuttx_menuconfig.png | Bin .../add_microros_config/index.md | 2 +- .../nuttx => old}/debugging/index.md | 2 +- .../microros_nuttx_bsp/index.md | 2 +- .../nsh/images/olimex_nsh_usb.jpg | Bin .../nuttx => old}/nsh/images/olimex_uart.jpg | Bin .../{advanced/nuttx => old}/nsh/index.md | 2 +- _posts/2020-08-27-esp32.md | 2 +- 41 files changed, 42 insertions(+), 37 deletions(-) rename _docs/tutorials/{core => advanced}/create_dds_entities_by_ref/index.md (99%) rename _docs/tutorials/{core => advanced}/create_new_type/index.md (98%) rename _docs/tutorials/{core => advanced}/microxrcedds_rmw_configuration/imgs/best_effort_stream.svg (100%) rename _docs/tutorials/{core => advanced}/microxrcedds_rmw_configuration/imgs/micro_ros_memory.svg (100%) rename _docs/tutorials/{core => advanced}/microxrcedds_rmw_configuration/imgs/reliable_strea.svg (100%) rename _docs/tutorials/{core => advanced}/microxrcedds_rmw_configuration/index.md (99%) rename _docs/tutorials/{core => firststeps}/first_application_linux/index.md (98%) rename _docs/tutorials/{core => firststeps}/first_application_rtos/freertos.md (97%) rename _docs/tutorials/{core => firststeps}/first_application_rtos/imgs/1.jpg (100%) rename _docs/tutorials/{core => firststeps}/first_application_rtos/imgs/2.jpg (100%) rename _docs/tutorials/{core => firststeps}/first_application_rtos/imgs/5.jpg (100%) rename _docs/tutorials/{core => firststeps}/first_application_rtos/imgs/6.jpg (100%) rename _docs/tutorials/{core => firststeps}/first_application_rtos/imgs/7.jpg (100%) rename _docs/tutorials/{core => firststeps}/first_application_rtos/imgs/nuttx_examples.png (100%) rename _docs/tutorials/{advanced/nuttx/add_microros_config/images => firststeps/first_application_rtos/imgs}/nuttx_menuconfig.png (100%) rename _docs/tutorials/{core => firststeps}/first_application_rtos/index.md (96%) rename _docs/tutorials/{core => firststeps}/first_application_rtos/nuttx.md (98%) rename _docs/tutorials/{core => firststeps}/first_application_rtos/zephyr.md (97%) rename _docs/tutorials/{core => firststeps}/overview/index.md (95%) rename _docs/tutorials/{core => firststeps}/programming_rcl_rclc/doc/highPriorityPath.png (100%) rename _docs/tutorials/{core => firststeps}/programming_rcl_rclc/doc/scheduling_01.png (100%) rename _docs/tutorials/{core => firststeps}/programming_rcl_rclc/doc/scheduling_02.png (100%) rename _docs/tutorials/{core => firststeps}/programming_rcl_rclc/doc/scheduling_LET.png (100%) rename _docs/tutorials/{core => firststeps}/programming_rcl_rclc/doc/sensePlanActScheme.png (100%) rename _docs/tutorials/{core => firststeps}/programming_rcl_rclc/doc/sensorFusion_01.png (100%) rename _docs/tutorials/{core => firststeps}/programming_rcl_rclc/doc/sensorFusion_02.png (100%) rename _docs/tutorials/{core => firststeps}/programming_rcl_rclc/doc/sensorFusion_03.png (100%) rename _docs/tutorials/{core => firststeps}/programming_rcl_rclc/index.md (99%) rename _docs/tutorials/{advanced => firststeps}/zephyr_emulator/imgs/4.jpg (100%) rename _docs/tutorials/{advanced => firststeps}/zephyr_emulator/index.md (98%) rename _docs/tutorials/{advanced/nuttx => old}/6lowpan/index.md (99%) rename _docs/tutorials/{core/first_application_rtos/imgs => old/add_microros_config/images}/nuttx_menuconfig.png (100%) rename _docs/tutorials/{advanced/nuttx => old}/add_microros_config/index.md (98%) rename _docs/tutorials/{advanced/nuttx => old}/debugging/index.md (99%) rename _docs/tutorials/{advanced => old}/microros_nuttx_bsp/index.md (98%) rename _docs/tutorials/{advanced/nuttx => old}/nsh/images/olimex_nsh_usb.jpg (100%) rename _docs/tutorials/{advanced/nuttx => old}/nsh/images/olimex_uart.jpg (100%) rename _docs/tutorials/{advanced/nuttx => old}/nsh/index.md (98%) diff --git a/_data/docs.yml b/_data/docs.yml index 5638332d..642b22b2 100644 --- a/_data/docs.yml +++ b/_data/docs.yml @@ -3,7 +3,7 @@ - overview/features - overview/hardware - overview/rtos - - overview/transports + - overview/ext_platforms - overview/comparison - overview/ROS_2_feature_comparison - overview/docker_ci_status @@ -45,24 +45,31 @@ docs: - concepts/fiware_interoperability -- title: Core Tutorials +- title: First-steps Tutorials docs: - - tutorials/core/overview - - tutorials/core/first_application_linux - - tutorials/core/first_application_rtos - - tutorials/core/programming_rcl_rclc - - tutorials/core/microxrcedds_rmw_configuration - - tutorials/core/create_new_type - - tutorials/core/create_dds_entities_by_ref + - tutorials/firststeps/overview + - tutorials/firststeps/first_application_linux + - tutorials/firststeps/first_application_rtos + - tutorials/firststeps/programming_rcl_rclc + - tutorials/firststeps/zephyr_emulator - title: Advanced Tutorials docs: + - tutorials/advanced/microxrcedds_rmw_configuration + - tutorials/advanced/create_new_type + - tutorials/advanced/create_dds_entities_by_ref - tutorials/advanced/create_custom_transports - tutorials/advanced/create_custom_static_library - tutorials/advanced/benchmarking - tutorials/advanced/tracing - - tutorials/advanced/zephyr_emulator - - tutorials/advanced/microros_nuttx_bsp + +- title: Unmaintained Tutorials + docs: + - tutorials/old/microros_nuttx_bsp + - tutorials/old/nsh + - tutorials/old/6lowpan + - tutorials/old/debugging + - tutorials/old/add_microros_config - title: Demos docs: @@ -76,11 +83,3 @@ - tutorials/demos/thumper_demo - tutorials/demos/combined_demos - tutorials/demos/moveit2_demo - -- title: Nuttx-specific Tutorials - docs: - - tutorials/advanced/nuttx/nsh - - tutorials/advanced/nuttx/6lowpan - - tutorials/advanced/nuttx/debugging - - tutorials/advanced/nuttx/add_microros_config - diff --git a/_docs/concepts/build_system/external_build_systems/index.md b/_docs/concepts/build_system/external_build_systems/index.md index 3e576676..de1aeeb7 100644 --- a/_docs/concepts/build_system/external_build_systems/index.md +++ b/_docs/concepts/build_system/external_build_systems/index.md @@ -22,3 +22,9 @@ The procedure for configuring the built micro-ROS library is based in `colcon.me The [micro-ROS for Arduino](https://github.com/micro-ROS/micro_ros_arduino) support package is a special port of micro-ROS provided as a set of precompiled libraries for specific platforms. The main reason for this approach is that Arduino does not allow the build of a complex library such as micro-ROS, so by using this approach a ready-to-use solution is provided to the Arduino users. Along with this support package, there are [detailed instructions](https://github.com/micro-ROS/micro_ros_arduino#how-to-build-the-precompiled-library) for rebuilding the micro-ROS for Arduino libraries for users that need to tune the default configuration. + +## micro-ROS for STM32CubeMX + +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 any STM32 controller based project. As such, it allows micro-ROS to be virtually supported by the full set of boards offered by STMicroelectronics. + +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 the project configuration and execution. diff --git a/_docs/tutorials/core/create_dds_entities_by_ref/index.md b/_docs/tutorials/advanced/create_dds_entities_by_ref/index.md similarity index 99% rename from _docs/tutorials/core/create_dds_entities_by_ref/index.md rename to _docs/tutorials/advanced/create_dds_entities_by_ref/index.md index 4d7491cb..e06f5915 100644 --- a/_docs/tutorials/core/create_dds_entities_by_ref/index.md +++ b/_docs/tutorials/advanced/create_dds_entities_by_ref/index.md @@ -1,6 +1,6 @@ --- title: How to use custom QoS in micro-ROS -permalink: /docs/tutorials/core/create_dds_entities_by_ref/ +permalink: /docs/tutorials/advanced/create_dds_entities_by_ref/ --- diff --git a/_docs/tutorials/core/create_new_type/index.md b/_docs/tutorials/advanced/create_new_type/index.md similarity index 98% rename from _docs/tutorials/core/create_new_type/index.md rename to _docs/tutorials/advanced/create_new_type/index.md index c8d17068..e97c925e 100644 --- a/_docs/tutorials/core/create_new_type/index.md +++ b/_docs/tutorials/advanced/create_new_type/index.md @@ -1,6 +1,6 @@ --- title: How to create a new micro-ROS message type -permalink: /docs/tutorials/core/create_new_type/ +permalink: /docs/tutorials/advanced/create_new_type/ --- This tutorial starts in a previously created micro-ROS environment. Check [**First micro-ROS application on an RTOS**](../first_application_rtos/) for instructions about how to create a micro-ROS environment for embedded platforms. diff --git a/_docs/tutorials/core/microxrcedds_rmw_configuration/imgs/best_effort_stream.svg b/_docs/tutorials/advanced/microxrcedds_rmw_configuration/imgs/best_effort_stream.svg similarity index 100% rename from _docs/tutorials/core/microxrcedds_rmw_configuration/imgs/best_effort_stream.svg rename to _docs/tutorials/advanced/microxrcedds_rmw_configuration/imgs/best_effort_stream.svg diff --git a/_docs/tutorials/core/microxrcedds_rmw_configuration/imgs/micro_ros_memory.svg b/_docs/tutorials/advanced/microxrcedds_rmw_configuration/imgs/micro_ros_memory.svg similarity index 100% rename from _docs/tutorials/core/microxrcedds_rmw_configuration/imgs/micro_ros_memory.svg rename to _docs/tutorials/advanced/microxrcedds_rmw_configuration/imgs/micro_ros_memory.svg diff --git a/_docs/tutorials/core/microxrcedds_rmw_configuration/imgs/reliable_strea.svg b/_docs/tutorials/advanced/microxrcedds_rmw_configuration/imgs/reliable_strea.svg similarity index 100% rename from _docs/tutorials/core/microxrcedds_rmw_configuration/imgs/reliable_strea.svg rename to _docs/tutorials/advanced/microxrcedds_rmw_configuration/imgs/reliable_strea.svg diff --git a/_docs/tutorials/core/microxrcedds_rmw_configuration/index.md b/_docs/tutorials/advanced/microxrcedds_rmw_configuration/index.md similarity index 99% rename from _docs/tutorials/core/microxrcedds_rmw_configuration/index.md rename to _docs/tutorials/advanced/microxrcedds_rmw_configuration/index.md index a1d08be3..72665429 100644 --- a/_docs/tutorials/core/microxrcedds_rmw_configuration/index.md +++ b/_docs/tutorials/advanced/microxrcedds_rmw_configuration/index.md @@ -1,6 +1,6 @@ --- title: Middleware Configuration -permalink: /docs/tutorials/core/microxrcedds_rmw_configuration/ +permalink: /docs/tutorials/advanced/microxrcedds_rmw_configuration/ --- micro-ROS targets microcontroller, devices with low memory resources. diff --git a/_docs/tutorials/core/first_application_linux/index.md b/_docs/tutorials/firststeps/first_application_linux/index.md similarity index 98% rename from _docs/tutorials/core/first_application_linux/index.md rename to _docs/tutorials/firststeps/first_application_linux/index.md index 7a527e16..7e62dcf9 100644 --- a/_docs/tutorials/core/first_application_linux/index.md +++ b/_docs/tutorials/firststeps/first_application_linux/index.md @@ -1,6 +1,6 @@ --- title: First micro-ROS Application on Linux -permalink: /docs/tutorials/core/first_application_linux/ +permalink: /docs/tutorials/firststeps/first_application_linux/ --- ## Target platform diff --git a/_docs/tutorials/core/first_application_rtos/freertos.md b/_docs/tutorials/firststeps/first_application_rtos/freertos.md similarity index 97% rename from _docs/tutorials/core/first_application_rtos/freertos.md rename to _docs/tutorials/firststeps/first_application_rtos/freertos.md index b5fa8042..bdf29db2 100644 --- a/_docs/tutorials/core/first_application_rtos/freertos.md +++ b/_docs/tutorials/firststeps/first_application_rtos/freertos.md @@ -1,6 +1,6 @@ --- title: First micro-ROS Application on FreeRTOS -permalink: /docs/tutorials/core/first_application_rtos/freertos/ +permalink: /docs/tutorials/firststeps/first_application_rtos/freertos/ redirect_from: - /docs/tutorials/advanced/freertos/freertos_getting_started/ --- diff --git a/_docs/tutorials/core/first_application_rtos/imgs/1.jpg b/_docs/tutorials/firststeps/first_application_rtos/imgs/1.jpg similarity index 100% rename from _docs/tutorials/core/first_application_rtos/imgs/1.jpg rename to _docs/tutorials/firststeps/first_application_rtos/imgs/1.jpg diff --git a/_docs/tutorials/core/first_application_rtos/imgs/2.jpg b/_docs/tutorials/firststeps/first_application_rtos/imgs/2.jpg similarity index 100% rename from _docs/tutorials/core/first_application_rtos/imgs/2.jpg rename to _docs/tutorials/firststeps/first_application_rtos/imgs/2.jpg diff --git a/_docs/tutorials/core/first_application_rtos/imgs/5.jpg b/_docs/tutorials/firststeps/first_application_rtos/imgs/5.jpg similarity index 100% rename from _docs/tutorials/core/first_application_rtos/imgs/5.jpg rename to _docs/tutorials/firststeps/first_application_rtos/imgs/5.jpg diff --git a/_docs/tutorials/core/first_application_rtos/imgs/6.jpg b/_docs/tutorials/firststeps/first_application_rtos/imgs/6.jpg similarity index 100% rename from _docs/tutorials/core/first_application_rtos/imgs/6.jpg rename to _docs/tutorials/firststeps/first_application_rtos/imgs/6.jpg diff --git a/_docs/tutorials/core/first_application_rtos/imgs/7.jpg b/_docs/tutorials/firststeps/first_application_rtos/imgs/7.jpg similarity index 100% rename from _docs/tutorials/core/first_application_rtos/imgs/7.jpg rename to _docs/tutorials/firststeps/first_application_rtos/imgs/7.jpg diff --git a/_docs/tutorials/core/first_application_rtos/imgs/nuttx_examples.png b/_docs/tutorials/firststeps/first_application_rtos/imgs/nuttx_examples.png similarity index 100% rename from _docs/tutorials/core/first_application_rtos/imgs/nuttx_examples.png rename to _docs/tutorials/firststeps/first_application_rtos/imgs/nuttx_examples.png diff --git a/_docs/tutorials/advanced/nuttx/add_microros_config/images/nuttx_menuconfig.png b/_docs/tutorials/firststeps/first_application_rtos/imgs/nuttx_menuconfig.png similarity index 100% rename from _docs/tutorials/advanced/nuttx/add_microros_config/images/nuttx_menuconfig.png rename to _docs/tutorials/firststeps/first_application_rtos/imgs/nuttx_menuconfig.png diff --git a/_docs/tutorials/core/first_application_rtos/index.md b/_docs/tutorials/firststeps/first_application_rtos/index.md similarity index 96% rename from _docs/tutorials/core/first_application_rtos/index.md rename to _docs/tutorials/firststeps/first_application_rtos/index.md index e9cd80ab..a0f6fc77 100644 --- a/_docs/tutorials/core/first_application_rtos/index.md +++ b/_docs/tutorials/firststeps/first_application_rtos/index.md @@ -1,6 +1,6 @@ --- title: First micro-ROS Application on an RTOS -permalink: /docs/tutorials/core/first_application_rtos/ +permalink: /docs/tutorials/firststeps/first_application_rtos/ --- After you have completed the [First micro-ROS application on Linux tutorial](../first_application_linux), you are now ready to flash a microcontroller with this application based on a Real-Time Operating System (RTOS). diff --git a/_docs/tutorials/core/first_application_rtos/nuttx.md b/_docs/tutorials/firststeps/first_application_rtos/nuttx.md similarity index 98% rename from _docs/tutorials/core/first_application_rtos/nuttx.md rename to _docs/tutorials/firststeps/first_application_rtos/nuttx.md index 1ee29ed8..8f2a9c14 100644 --- a/_docs/tutorials/core/first_application_rtos/nuttx.md +++ b/_docs/tutorials/firststeps/first_application_rtos/nuttx.md @@ -1,6 +1,6 @@ --- title: First micro-ROS Application on NuttX -permalink: /docs/tutorials/core/first_application_rtos/nuttx/ +permalink: /docs/tutorials/firststeps/first_application_rtos/nuttx/ redirect_from: - /docs/tutorials/advanced/nuttx/nuttx_getting_started/ --- diff --git a/_docs/tutorials/core/first_application_rtos/zephyr.md b/_docs/tutorials/firststeps/first_application_rtos/zephyr.md similarity index 97% rename from _docs/tutorials/core/first_application_rtos/zephyr.md rename to _docs/tutorials/firststeps/first_application_rtos/zephyr.md index 892e0853..8176f3e6 100644 --- a/_docs/tutorials/core/first_application_rtos/zephyr.md +++ b/_docs/tutorials/firststeps/first_application_rtos/zephyr.md @@ -1,6 +1,6 @@ --- title: First micro-ROS Application on Zephyr -permalink: /docs/tutorials/core/first_application_rtos/zephyr/ +permalink: /docs/tutorials/firststeps/first_application_rtos/zephyr/ redirect_from: - /docs/tutorials/advanced/zephyr/zephyr_getting_started/ --- diff --git a/_docs/tutorials/core/overview/index.md b/_docs/tutorials/firststeps/overview/index.md similarity index 95% rename from _docs/tutorials/core/overview/index.md rename to _docs/tutorials/firststeps/overview/index.md index 616fd308..44975b0f 100644 --- a/_docs/tutorials/core/overview/index.md +++ b/_docs/tutorials/firststeps/overview/index.md @@ -1,8 +1,8 @@ --- title: Overview -permalink: /docs/tutorials/core/overview/ +permalink: /docs/tutorials/firststeps/overview/ redirect_from: - - /docs/tutorials/core/ + - /docs/tutorials/firststeps/ - /docs/tutorials/ --- diff --git a/_docs/tutorials/core/programming_rcl_rclc/doc/highPriorityPath.png b/_docs/tutorials/firststeps/programming_rcl_rclc/doc/highPriorityPath.png similarity index 100% rename from _docs/tutorials/core/programming_rcl_rclc/doc/highPriorityPath.png rename to _docs/tutorials/firststeps/programming_rcl_rclc/doc/highPriorityPath.png diff --git a/_docs/tutorials/core/programming_rcl_rclc/doc/scheduling_01.png b/_docs/tutorials/firststeps/programming_rcl_rclc/doc/scheduling_01.png similarity index 100% rename from _docs/tutorials/core/programming_rcl_rclc/doc/scheduling_01.png rename to _docs/tutorials/firststeps/programming_rcl_rclc/doc/scheduling_01.png diff --git a/_docs/tutorials/core/programming_rcl_rclc/doc/scheduling_02.png b/_docs/tutorials/firststeps/programming_rcl_rclc/doc/scheduling_02.png similarity index 100% rename from _docs/tutorials/core/programming_rcl_rclc/doc/scheduling_02.png rename to _docs/tutorials/firststeps/programming_rcl_rclc/doc/scheduling_02.png diff --git a/_docs/tutorials/core/programming_rcl_rclc/doc/scheduling_LET.png b/_docs/tutorials/firststeps/programming_rcl_rclc/doc/scheduling_LET.png similarity index 100% rename from _docs/tutorials/core/programming_rcl_rclc/doc/scheduling_LET.png rename to _docs/tutorials/firststeps/programming_rcl_rclc/doc/scheduling_LET.png diff --git a/_docs/tutorials/core/programming_rcl_rclc/doc/sensePlanActScheme.png b/_docs/tutorials/firststeps/programming_rcl_rclc/doc/sensePlanActScheme.png similarity index 100% rename from _docs/tutorials/core/programming_rcl_rclc/doc/sensePlanActScheme.png rename to _docs/tutorials/firststeps/programming_rcl_rclc/doc/sensePlanActScheme.png diff --git a/_docs/tutorials/core/programming_rcl_rclc/doc/sensorFusion_01.png b/_docs/tutorials/firststeps/programming_rcl_rclc/doc/sensorFusion_01.png similarity index 100% rename from _docs/tutorials/core/programming_rcl_rclc/doc/sensorFusion_01.png rename to _docs/tutorials/firststeps/programming_rcl_rclc/doc/sensorFusion_01.png diff --git a/_docs/tutorials/core/programming_rcl_rclc/doc/sensorFusion_02.png b/_docs/tutorials/firststeps/programming_rcl_rclc/doc/sensorFusion_02.png similarity index 100% rename from _docs/tutorials/core/programming_rcl_rclc/doc/sensorFusion_02.png rename to _docs/tutorials/firststeps/programming_rcl_rclc/doc/sensorFusion_02.png diff --git a/_docs/tutorials/core/programming_rcl_rclc/doc/sensorFusion_03.png b/_docs/tutorials/firststeps/programming_rcl_rclc/doc/sensorFusion_03.png similarity index 100% rename from _docs/tutorials/core/programming_rcl_rclc/doc/sensorFusion_03.png rename to _docs/tutorials/firststeps/programming_rcl_rclc/doc/sensorFusion_03.png diff --git a/_docs/tutorials/core/programming_rcl_rclc/index.md b/_docs/tutorials/firststeps/programming_rcl_rclc/index.md similarity index 99% rename from _docs/tutorials/core/programming_rcl_rclc/index.md rename to _docs/tutorials/firststeps/programming_rcl_rclc/index.md index ba53e732..3b6abeed 100644 --- a/_docs/tutorials/core/programming_rcl_rclc/index.md +++ b/_docs/tutorials/firststeps/programming_rcl_rclc/index.md @@ -1,6 +1,6 @@ --- title: Programming with rcl and rclc -permalink: /docs/tutorials/core/programming_rcl_rclc/ +permalink: /docs/tutorials/firststeps/programming_rcl_rclc/ --- In this tutorial, you'll learn the basics of the micro-ROS C API. 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. diff --git a/_docs/tutorials/advanced/zephyr_emulator/imgs/4.jpg b/_docs/tutorials/firststeps/zephyr_emulator/imgs/4.jpg similarity index 100% rename from _docs/tutorials/advanced/zephyr_emulator/imgs/4.jpg rename to _docs/tutorials/firststeps/zephyr_emulator/imgs/4.jpg diff --git a/_docs/tutorials/advanced/zephyr_emulator/index.md b/_docs/tutorials/firststeps/zephyr_emulator/index.md similarity index 98% rename from _docs/tutorials/advanced/zephyr_emulator/index.md rename to _docs/tutorials/firststeps/zephyr_emulator/index.md index 3fb94ce3..1e7a4cc1 100644 --- a/_docs/tutorials/advanced/zephyr_emulator/index.md +++ b/_docs/tutorials/firststeps/zephyr_emulator/index.md @@ -1,6 +1,6 @@ --- title: Zephyr Emulator -permalink: /docs/tutorials/advanced/zephyr_emulator/ +permalink: /docs/tutorials/firststeps/zephyr_emulator/ --- ## Target platform diff --git a/_docs/tutorials/advanced/nuttx/6lowpan/index.md b/_docs/tutorials/old/6lowpan/index.md similarity index 99% rename from _docs/tutorials/advanced/nuttx/6lowpan/index.md rename to _docs/tutorials/old/6lowpan/index.md index 160d6eda..c15af474 100644 --- a/_docs/tutorials/advanced/nuttx/6lowpan/index.md +++ b/_docs/tutorials/old/6lowpan/index.md @@ -1,6 +1,6 @@ --- title: 6LoWPAN Guide -permalink: /docs/tutorials/advanced/nuttx/6lowpan/ +permalink: /docs/tutorials/old/6lowpan/ --- **Disclaimer: this tutorial is currently unmantained** diff --git a/_docs/tutorials/core/first_application_rtos/imgs/nuttx_menuconfig.png b/_docs/tutorials/old/add_microros_config/images/nuttx_menuconfig.png similarity index 100% rename from _docs/tutorials/core/first_application_rtos/imgs/nuttx_menuconfig.png rename to _docs/tutorials/old/add_microros_config/images/nuttx_menuconfig.png diff --git a/_docs/tutorials/advanced/nuttx/add_microros_config/index.md b/_docs/tutorials/old/add_microros_config/index.md similarity index 98% rename from _docs/tutorials/advanced/nuttx/add_microros_config/index.md rename to _docs/tutorials/old/add_microros_config/index.md index 10c78e98..50cdecc9 100644 --- a/_docs/tutorials/advanced/nuttx/add_microros_config/index.md +++ b/_docs/tutorials/old/add_microros_config/index.md @@ -1,6 +1,6 @@ --- title: Micro-ROS configuration for NuttX -permalink: /docs/tutorials/advanced/nuttx/add_microros_config/ +permalink: /docs/tutorials/old/add_microros_config/ --- **Disclaimer: this tutorial is currently unmantained** diff --git a/_docs/tutorials/advanced/nuttx/debugging/index.md b/_docs/tutorials/old/debugging/index.md similarity index 99% rename from _docs/tutorials/advanced/nuttx/debugging/index.md rename to _docs/tutorials/old/debugging/index.md index e717f8bc..c5e82392 100644 --- a/_docs/tutorials/advanced/nuttx/debugging/index.md +++ b/_docs/tutorials/old/debugging/index.md @@ -1,6 +1,6 @@ --- title: Debugging a NuttX Application -permalink: /docs/tutorials/advanced/nuttx/debugging/ +permalink: /docs/tutorials/old/debugging/ author: Ingo Lütkebohle (merged by Tomasz Kołcon) --- diff --git a/_docs/tutorials/advanced/microros_nuttx_bsp/index.md b/_docs/tutorials/old/microros_nuttx_bsp/index.md similarity index 98% rename from _docs/tutorials/advanced/microros_nuttx_bsp/index.md rename to _docs/tutorials/old/microros_nuttx_bsp/index.md index e25549b1..68a6bcb3 100644 --- a/_docs/tutorials/advanced/microros_nuttx_bsp/index.md +++ b/_docs/tutorials/old/microros_nuttx_bsp/index.md @@ -1,6 +1,6 @@ --- title: Adding Micro-ROS to a NuttX board configuration -permalink: /docs/tutorials/advanced/microros_nuttx_bsp/ +permalink: /docs/tutorials/old/microros_nuttx_bsp/ --- # Introduction diff --git a/_docs/tutorials/advanced/nuttx/nsh/images/olimex_nsh_usb.jpg b/_docs/tutorials/old/nsh/images/olimex_nsh_usb.jpg similarity index 100% rename from _docs/tutorials/advanced/nuttx/nsh/images/olimex_nsh_usb.jpg rename to _docs/tutorials/old/nsh/images/olimex_nsh_usb.jpg diff --git a/_docs/tutorials/advanced/nuttx/nsh/images/olimex_uart.jpg b/_docs/tutorials/old/nsh/images/olimex_uart.jpg similarity index 100% rename from _docs/tutorials/advanced/nuttx/nsh/images/olimex_uart.jpg rename to _docs/tutorials/old/nsh/images/olimex_uart.jpg diff --git a/_docs/tutorials/advanced/nuttx/nsh/index.md b/_docs/tutorials/old/nsh/index.md similarity index 98% rename from _docs/tutorials/advanced/nuttx/nsh/index.md rename to _docs/tutorials/old/nsh/index.md index 6308e481..62f08497 100644 --- a/_docs/tutorials/advanced/nuttx/nsh/index.md +++ b/_docs/tutorials/old/nsh/index.md @@ -1,6 +1,6 @@ --- title: NSH console over UART & USB -permalink: /docs/tutorials/advanced/nuttx/nsh/ +permalink: /docs/tutorials/old/nsh/ --- **Disclaimer: this tutorial is currently unmantained** diff --git a/_posts/2020-08-27-esp32.md b/_posts/2020-08-27-esp32.md index c2431deb..697ac997 100644 --- a/_posts/2020-08-27-esp32.md +++ b/_posts/2020-08-27-esp32.md @@ -13,7 +13,7 @@ Specifically, the port has been carried out for an Espressif [ESP32-DevKitC-32E] The recent port of micro-ROS to ESP32 thus sets a milestone towards expanding the family of MCUs supported by micro-ROS and paves the way for further ports, ensuring this project an ever wider base of hardware support. -In order to try the new port, follow one of the [core tutorials](https://micro-ros.github.io//docs/tutorials/core/overview/) to install the micro-ROS build system, and then follow the instructions below: +In order to try the new port, follow one of the [core tutorials](https://micro-ros.github.io//docs/tutorials/firststeps/overview/) to install the micro-ROS build system, and then follow the instructions below: ```bash From 0d239068a72fee70b08bbad4b97aa23d55a8dc25 Mon Sep 17 00:00:00 2001 From: FranFin <58737168+FranFin@users.noreply.github.com> Date: Tue, 30 Mar 2021 12:10:56 +0200 Subject: [PATCH 03/12] Update _docs/concepts/build_system/external_build_systems/index.md Co-authored-by: Pablo Garrido --- _docs/concepts/build_system/external_build_systems/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs/concepts/build_system/external_build_systems/index.md b/_docs/concepts/build_system/external_build_systems/index.md index de1aeeb7..8f672a65 100644 --- a/_docs/concepts/build_system/external_build_systems/index.md +++ b/_docs/concepts/build_system/external_build_systems/index.md @@ -25,6 +25,6 @@ Along with this support package, there are [detailed instructions](https://githu ## micro-ROS for STM32CubeMX -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 any STM32 controller based project. As such, it allows micro-ROS to be virtually supported by the full set of boards offered by STMicroelectronics. +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 STMicroelectronics. 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 the project configuration and execution. From 6d37dfccd7f7060d047d5a0e68e8e07a34477c2e Mon Sep 17 00:00:00 2001 From: FranFin <58737168+FranFin@users.noreply.github.com> Date: Tue, 30 Mar 2021 12:11:07 +0200 Subject: [PATCH 04/12] Update _docs/concepts/build_system/external_build_systems/index.md Co-authored-by: Pablo Garrido --- _docs/concepts/build_system/external_build_systems/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs/concepts/build_system/external_build_systems/index.md b/_docs/concepts/build_system/external_build_systems/index.md index 8f672a65..6983faee 100644 --- a/_docs/concepts/build_system/external_build_systems/index.md +++ b/_docs/concepts/build_system/external_build_systems/index.md @@ -27,4 +27,4 @@ Along with this support package, there are [detailed instructions](https://githu 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 STMicroelectronics. -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 the project configuration and execution. +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. From 220d340a2bbf072f1ea372592e3e5ce1ef17fe85 Mon Sep 17 00:00:00 2001 From: FranFin Date: Tue, 30 Mar 2021 15:36:41 +0200 Subject: [PATCH 05/12] Added missing links and changed title into external tools. --- _data/docs.yml | 3 +- .../{ext_platforms => ext_tools}/index.md | 4 +- _docs/overview/hardware/index.md | 56 +++++++++---------- 3 files changed, 31 insertions(+), 32 deletions(-) rename _docs/overview/{ext_platforms => ext_tools}/index.md (98%) diff --git a/_data/docs.yml b/_data/docs.yml index 642b22b2..ec89aba0 100644 --- a/_data/docs.yml +++ b/_data/docs.yml @@ -3,13 +3,12 @@ - overview/features - overview/hardware - overview/rtos - - overview/ext_platforms + - overview/ext_tools - overview/comparison - overview/ROS_2_feature_comparison - overview/docker_ci_status - overview/users_and_clients - - title: Client Library docs: - concepts/client_library/introduction diff --git a/_docs/overview/ext_platforms/index.md b/_docs/overview/ext_tools/index.md similarity index 98% rename from _docs/overview/ext_platforms/index.md rename to _docs/overview/ext_tools/index.md index dfb3865e..9b97ac84 100644 --- a/_docs/overview/ext_platforms/index.md +++ b/_docs/overview/ext_tools/index.md @@ -1,6 +1,6 @@ --- -title: Integration into External Platforms -permalink: /docs/overview/ext_platforms/ +title: Integration into External Tools +permalink: /docs/overview/ext_tools/ ---