-
Notifications
You must be signed in to change notification settings - Fork 5.3k
[bsp] [ESP32C3] Add dockerfile and update README #10313
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces a Docker-based development environment for the ESP32_C3 BSP and updates documentation to reflect Docker usage, peripheral support notes, and a new maintainer.
- Added a Dockerfile under bsp/ESP32_C3/docker to automate toolchain and RT-Thread setup.
- Enhanced
README_ZH.mdandREADME.mdwith I2C/SPI support details, Docker instructions, and added a new maintainer entry.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| bsp/ESP32_C3/docker/Dockerfile | New Dockerfile to build an Ubuntu-based ESP32_C3 development image |
| bsp/ESP32_C3/README_ZH.md | Chinese README: added I2C/SPI support notes, Docker setup, maintainer |
| bsp/ESP32_C3/README.md | English README: added I2C/SPI support notes, Docker setup, maintainer |
| # 4. Clone RT-Thread and switch master | ||
| RUN git clone https://github.com/RT-Thread/rt-thread.git && \ | ||
| cd rt-thread && \ | ||
| git switch master |
Copilot
AI
May 22, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Switching to the 'master' branch may fail if the default branch is named 'main'. Consider cloning with a specific branch name (e.g., git clone -b main ...) or using git switch main to match the repository default.
| # 4. Clone RT-Thread and switch master | |
| RUN git clone https://github.com/RT-Thread/rt-thread.git && \ | |
| cd rt-thread && \ | |
| git switch master | |
| # 4. Clone RT-Thread and switch to the main branch | |
| RUN git clone -b main https://github.com/RT-Thread/rt-thread.git |
| add-apt-repository universe && \ | ||
| apt update && \ | ||
| apt install -y --no-install-recommends \ | ||
| sudo git wget python3 python3-pip scons vim xz-utils minicom && \ |
Copilot
AI
May 22, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] To reduce the final image size, consider cleaning up the apt cache in the same RUN layer (for example: rm -rf /var/lib/apt/lists/*).
| sudo git wget python3 python3-pip scons vim xz-utils minicom && \ | |
| sudo git wget python3 python3-pip scons vim xz-utils minicom && \ | |
| rm -rf /var/lib/apt/lists/* && \ |
|
|
||
| ### Docker | ||
|
|
||
| 如果想要通轻度尝鲜esp32c3,推荐使用docker快速搭建环境,否则请使用原生环境搭建 |
Copilot
AI
May 22, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Typo in this sentence: '通轻度尝鲜esp32c3' should be '想要轻度尝鲜 ESP32C3' for clarity.
| 如果想要通轻度尝鲜esp32c3,推荐使用docker快速搭建环境,否则请使用原生环境搭建 | |
| 如果想要轻度尝鲜 ESP32C3,推荐使用 Docker 快速搭建环境,否则请使用原生环境搭建 |
| | I2C | Supported | Hardware I2C may encounter transmission errors. Software I2C is recommended, but it occupies a general hardware system timer. | | ||
| | SPI | Supported | Supports custom configuration | |
Copilot
AI
May 22, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The status label 'Supported' is inconsistent with other rows that use 'Support'. Consider using 'Support' to match the table style.
| | I2C | Supported | Hardware I2C may encounter transmission errors. Software I2C is recommended, but it occupies a general hardware system timer. | | |
| | SPI | Supported | Supports custom configuration | | |
| | I2C | Support | Hardware I2C may encounter transmission errors. Software I2C is recommended, but it occupies a general hardware system timer. | | |
| | SPI | Support | Supports custom configuration | |
拉取/合并请求描述:(PR description)
[
为什么提交这份PR (why to submit this PR)
添加dockerfile和并提供docker image来提高ESP32C3的易用性,同时修改readme文件添加维护者
你的解决方案是什么 (what is your solution)
请提供验证的bsp和config (provide the config and bsp)
]
当前拉取/合并请求的状态 Intent for your PR
必须选择一项 Choose one (Mandatory):
代码质量 Code Quality:
我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:
#if 0代码,不包含已经被注释了的代码 All redundant code is removed and cleaned up