Skip to content

Commit c802338

Browse files
Carlosespicurmergify[bot]
authored andcommitted
Change README build steps to use the official ESP-IDF image (#300)
* Change README build steps to use the official ESP-IDF image Signed-off-by: Carlosespicur <carlosespicur@proton.me> * Apply suggestions --------- Signed-off-by: Carlosespicur <carlosespicur@proton.me> (cherry picked from commit 3fb203b) # Conflicts: # README.md
1 parent 6b96268 commit c802338

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,18 +53,38 @@ Is possible to use a micro-ROS Agent just with this docker command:
5353

5454
```bash
5555
# UDPv4 micro-ROS Agent
56+
<<<<<<< HEAD
5657
docker run -it --rm --net=host microros/micro-ros-agent:humble udp4 --port 8888 -v6
58+
=======
59+
docker run -it --rm --net=host microros/micro-ros-agent:kilted udp4 --port 8888 -v6
60+
>>>>>>> 3fb203b (Change README build steps to use the official ESP-IDF image (#300))
5761
```
5862
5963
## Build with docker container
6064
61-
It's possible to build this example application using preconfigured docker container. Execute this line to build an example app using docker container:
65+
It's possible to build this example application using the official Espressif [docker images](https://hub.docker.com/r/espressif/idf), following the same steps:
6266
6367
```bash
64-
docker run -it --rm --user espidf --volume="/etc/timezone:/etc/timezone:ro" -v $(pwd):/micro_ros_espidf_component -v /dev:/dev --privileged --workdir /micro_ros_espidf_component microros/esp-idf-microros:latest /bin/bash -c "cd examples/int32_publisher; idf.py menuconfig build flash monitor"
65-
```
68+
docker pull espressif/idf:release-v5.2
69+
# Run ESP-IDF container
70+
docker run --name micro-ros-espidf-component-test -it espressif/idf:release-v5.2 bash
71+
72+
git clone https://github.com/micro-ROS/micro_ros_espidf_component.git
73+
cd micro_ros_espidf_component/
74+
75+
# Install dependencies
76+
pip3 install catkin_pkg lark-parser colcon-common-extensions
6677
67-
Dockerfile for this container is provided in the ./docker directory and available in dockerhub. This approach uses ESP-IDF v5.
78+
$IDF_PATH/export.sh
79+
cd examples/int32_publisher
80+
# Set target board [esp32|esp32s2|esp32s3|esp32c3]
81+
idf.py set-target esp32
82+
idf.py menuconfig
83+
# Set your micro-ROS configuration and WiFi credentials under micro-ROS Settings
84+
idf.py build
85+
idf.py flash
86+
idf.py monitor
87+
```
6888
6989
## Using serial transport
7090
@@ -90,7 +110,11 @@ Is possible to use a micro-ROS Agent just with this docker command:
90110
91111
```bash
92112
# Serial micro-ROS Agent
113+
<<<<<<< HEAD
93114
docker run -it --rm -v /dev:/dev --privileged --net=host microros/micro-ros-agent:humble serial --dev [YOUR BOARD PORT] -v6
115+
=======
116+
docker run -it --rm -v /dev:/dev --privileged --net=host microros/micro-ros-agent:kilted serial --dev [YOUR BOARD PORT] -v6
117+
>>>>>>> 3fb203b (Change README build steps to use the official ESP-IDF image (#300))
94118
```
95119
96120
## Purpose of the Project

0 commit comments

Comments
 (0)