Skip to content
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
24 changes: 24 additions & 0 deletions .github/workflows/upload-esp-registry.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Upload ESP Component Registry

on:
pull_request:
push:
branches:
- kilted
workflow_dispatch:

jobs:
upload_components:
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write
steps:
- uses: actions/checkout@v4

- name: Upload component to the component registry
uses: espressif/upload-components-ci-action@v2
with:
components: "micro_ros_espidf_component:."
namespace: "micro-ros"
dry_run: ${{ github.event_name == 'pull_request' || github.ref_name != 'kilted' }}
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,45 @@ In order to select it, use `idf.py menuconfig` and go to `micro-ROS Settings > m

## Usage

You can clone this repo directly in the `components` folder of your project.
### From the ESP Component Registry

To align with the semantic versioning scheme of the ESP Component Registry, the ROS 2 distribution release year is used as the major version of the component:

| ROS 2 distro | Version |
|:------------:|:-------:|
| humble | 22.x.y |
| iron | 23.x.y |
| jazzy | 24.x.y |
| kilted | 25.x.y |
| lyrical | 26.x.y |

Rolling is published as a prerelease of the next version, for example `27.0.0-rolling.20260806`.

This branch corresponds to kilted and publishes `25.x.y` versions.

Add the component to your project with the IDF Component Manager:

```bash
idf.py add-dependency "micro-ros/micro_ros_espidf_component^25"
```

Or declare it in your main component's `idf_component.yml`:

```yaml
dependencies:
micro-ros/micro_ros_espidf_component: "^25"
```

Then build your project as usual. The Component Manager downloads the matching `25.x.y` release for Kilted.

### From this repository

You can also clone this repo into the `components` folder of your project:

```bash
cd your_project/components
git clone -b kilted https://github.com/micro-ROS/micro_ros_espidf_component.git
```

If you encounter issues during the build process, ensure that you are running in a clean shell environment _without_ the ROS 2 setup script sourced.

Expand Down
2 changes: 0 additions & 2 deletions examples/addtwoints_server/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
cmake_minimum_required(VERSION 3.5)

set (EXTRA_COMPONENT_DIRS "./../../.")

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(addtwoints_server)

4 changes: 4 additions & 0 deletions examples/addtwoints_server/main/idf_component.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dependencies:
micro-ros/micro_ros_espidf_component:
version: "^25.0.0"
override_path: "../../../"
2 changes: 0 additions & 2 deletions examples/handle_static_types/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
cmake_minimum_required(VERSION 3.5)

set (EXTRA_COMPONENT_DIRS "./../../.")

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(handle_static_types)

4 changes: 4 additions & 0 deletions examples/handle_static_types/main/idf_component.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dependencies:
micro-ros/micro_ros_espidf_component:
version: "^25.0.0"
override_path: "../../../"
2 changes: 0 additions & 2 deletions examples/int32_publisher/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
cmake_minimum_required(VERSION 3.5)

set (EXTRA_COMPONENT_DIRS "./../../.")

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(int32_publisher)

4 changes: 4 additions & 0 deletions examples/int32_publisher/main/idf_component.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dependencies:
micro-ros/micro_ros_espidf_component:
version: "^25.0.0"
override_path: "../../../"
2 changes: 0 additions & 2 deletions examples/int32_publisher_custom_transport/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
cmake_minimum_required(VERSION 3.5)

set (EXTRA_COMPONENT_DIRS "./../../.")

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(int32_publisher)

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dependencies:
micro-ros/micro_ros_espidf_component:
version: "^25.0.0"
override_path: "../../../"
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
cmake_minimum_required(VERSION 3.5)

set (EXTRA_COMPONENT_DIRS "./../../.")

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(int32_publisher)

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dependencies:
micro-ros/micro_ros_espidf_component:
version: "^25.0.0"
override_path: "../../../"
2 changes: 0 additions & 2 deletions examples/int32_publisher_embeddedrtps/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
cmake_minimum_required(VERSION 3.5)

set (EXTRA_COMPONENT_DIRS "./../../.")

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(int32_publisher)

4 changes: 4 additions & 0 deletions examples/int32_publisher_embeddedrtps/main/idf_component.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dependencies:
micro-ros/micro_ros_espidf_component:
version: "^25.0.0"
override_path: "../../../"
2 changes: 0 additions & 2 deletions examples/int32_sub_pub/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
cmake_minimum_required(VERSION 3.5)

set (EXTRA_COMPONENT_DIRS "./../../.")

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(int32_pub_sub)

4 changes: 4 additions & 0 deletions examples/int32_sub_pub/main/idf_component.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dependencies:
micro-ros/micro_ros_espidf_component:
version: "^25.0.0"
override_path: "../../../"
2 changes: 0 additions & 2 deletions examples/low_consumption/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
cmake_minimum_required(VERSION 3.5)

set (EXTRA_COMPONENT_DIRS "./../../.")

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(int32_publisher)

4 changes: 4 additions & 0 deletions examples/low_consumption/main/idf_component.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dependencies:
micro-ros/micro_ros_espidf_component:
version: "^25.0.0"
override_path: "../../../"
2 changes: 0 additions & 2 deletions examples/multithread_publisher/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
cmake_minimum_required(VERSION 3.5)

set (EXTRA_COMPONENT_DIRS "./../../.")

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(multithread_publisher)

4 changes: 4 additions & 0 deletions examples/multithread_publisher/main/idf_component.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dependencies:
micro-ros/micro_ros_espidf_component:
version: "^25.0.0"
override_path: "../../../"
2 changes: 0 additions & 2 deletions examples/parameters/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
cmake_minimum_required(VERSION 3.5)

set (EXTRA_COMPONENT_DIRS "./../../.")

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(int32_pub_sub)

4 changes: 4 additions & 0 deletions examples/parameters/main/idf_component.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dependencies:
micro-ros/micro_ros_espidf_component:
version: "^25.0.0"
override_path: "../../../"
2 changes: 0 additions & 2 deletions examples/ping_pong/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
cmake_minimum_required(VERSION 3.5)

set (EXTRA_COMPONENT_DIRS "./../../.")

include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(ping_pong)

4 changes: 4 additions & 0 deletions examples/ping_pong/main/idf_component.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dependencies:
micro-ros/micro_ros_espidf_component:
version: "^25.0.0"
override_path: "../../../"
20 changes: 20 additions & 0 deletions idf_component.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
version: "25.0.0"
description: "Micro-ROS ESP-IDF component and sample code"
url: "https://github.com/micro-ROS/micro_ros_espidf_component"
repository: "https://github.com/micro-ROS/micro_ros_espidf_component.git"
license: "Apache-2.0"
tags:
- micro-ros
- ros2
targets:
- esp32
- esp32s2
- esp32s3
- esp32c3
- esp32c6
dependencies:
idf: ">=5.2"
files:
use_gitignore: true
exclude:
- ".github/**"
Loading