Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove micro-ROS Renesas platforms #207

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -9,33 +9,6 @@ Build System Components
:local:
:backlinks: none


.. figure:: /rst/figures/micro/platforms_logos/renesas_e2_studio.png
:align: center

.. _micro_ros_renesas_e2_studio:

Renesas e\ :sup:`2` Studio
^^^^^^^^^^^^^^^^^^^^^^^^^^

`Renesas RA Family <https://www.renesas.com/us/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus>`_ is the **official supported hardware** of micro-ROS.
This family of MCUs provides a wide range of features based on Arm® Cortex®-M33, M23, and M4 processor cores.

Renesas e\ :sup:`2` Studio provides a whole integrated development environment that allows for professional development, test and profiling of embedded applications.
The micro-ROS component for Renesas provides a set of tools and instructions to integrate the build and configuration of micro-ROS within a Renesas e\ :sup:`2` Studio project.

This package supports multiple RTOSes (FreeRTOS and Azure RTOS), as well as a bare-metal approach.
Also, a wide range of transport layers are available: UART, UDP/IP, TCP/IP, USB-CDC and CAN/FD.

.. note::

For detailed instructions on how to use micro-ROS with this platform, please refer to `micro-ROS for Renesas e2 Studio <https://github.com/micro-ROS/micro_ros_renesas2estudio_component>`_ Github repository or use your Vulcanexus distribution to download this module:

.. code-block:: bash

source /opt/vulcanexus/iron/setup.bash
ros2 run micro_ros_setup component renesas_e2_studio

.. figure:: /rst/figures/micro/platforms_logos/esp_idf.png
:align: center

Expand Down
2 changes: 1 addition & 1 deletion docs/rst/microros_documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ micro-ROS provides a set of tools for integrating it in many build systems, tool
Those packages are heterogeneous due to the diversity of tools used by different vendors.

In general, micro-ROS provides standalone solutions for most used RTOSes and environments such as: :ref:`Zephyr RTOS <micro_ros_zephyr_rtos>`, :ref:`Espressif ESP-IDF <micro_ros_esp_idf>`, FreeRTOS, :ref:`Microsoft Azure RTOS <micro_ros_azure_rtos>`, etc.
It also provides packages for integrating it in major vendor tools: :ref:`Renesas e2 Studio<micro_ros_renesas_e2_studio>` or :ref:`STM32 Cube IDE/MX <micro_ros_stm32cube>`.
It also provides packages for integrating it in major vendor tools like :ref:`STM32 Cube IDE/MX <micro_ros_stm32cube>`.

Finally ``micro_ros_setup`` is a package that provides simple scripts for navigating the micro-ROS support packages.
``micro_ros_setup`` is distributed along with `Vulcanexus Micro <https://docs.vulcanexus.org/en/latest/>`_.
Expand Down
1 change: 0 additions & 1 deletion docs/rst/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ rcl
rclc
reconfigurations
reconnections
Renesas
repository
retransmit
Robotstadium
Expand Down
2 changes: 1 addition & 1 deletion docs/rst/tutorials/micro/custom_types/custom_types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Further information can be found in :ref:`Implementing custom interfaces <Single

This tutorial starts from a previously created micro-ROS environment. Check the first steps of `Getting started micro-ROS <https://docs.vulcanexus.org/en/latest/rst/tutorials/micro/getting_started/getting_started.html>`_ for instructions on how to create a micro-ROS environment for embedded platforms.

For creating custom types in a :ref:`Build System Component <micro_build_system_components>`, check the instructions in each component repository. For example `Renesas e2 Studio Readme <https://github.com/micro-ROS/micro_ros_renesas2estudio_component#adding-custom-packages-to-the-micro-ros-build>`_ or `ST Micro ST Cube IDE/MX <https://github.com/micro-ROS/micro_ros_stm32cubemx_utils#adding-custom-packages>`_.
For creating custom types in a :ref:`Build System Component <micro_build_system_components>`, check the instructions in each component repository.

Simple types
------------
Expand Down
Loading