Skip to content

Commit 7d5efa5

Browse files
Change README build steps to use the official ESP-IDF image (backport #300) (#301)
* 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 * Resolve conflicts --------- Co-authored-by: Carlos Espinoza Curto <148376273+Carlosespicur@users.noreply.github.com>
1 parent 6b96268 commit 7d5efa5

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,29 @@ docker run -it --rm --net=host microros/micro-ros-agent:humble udp4 --port 8888
5858

5959
## Build with docker container
6060

61-
It's possible to build this example application using preconfigured docker container. Execute this line to build an example app using docker container:
61+
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:
6262

6363
```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-
```
64+
docker pull espressif/idf:release-v5.2
65+
# Run ESP-IDF container
66+
docker run --name micro-ros-espidf-component-test -it espressif/idf:release-v5.2 bash
67+
68+
git clone https://github.com/micro-ROS/micro_ros_espidf_component.git
69+
cd micro_ros_espidf_component/
70+
71+
# Install dependencies
72+
pip3 install catkin_pkg lark-parser colcon-common-extensions
6673

67-
Dockerfile for this container is provided in the ./docker directory and available in dockerhub. This approach uses ESP-IDF v5.
74+
$IDF_PATH/export.sh
75+
cd examples/int32_publisher
76+
# Set target board [esp32|esp32s2|esp32s3|esp32c3]
77+
idf.py set-target esp32
78+
idf.py menuconfig
79+
# Set your micro-ROS configuration and WiFi credentials under micro-ROS Settings
80+
idf.py build
81+
idf.py flash
82+
idf.py monitor
83+
```
6884

6985
## Using serial transport
7086

0 commit comments

Comments
 (0)