Skip to content

Conversation

@1078249029
Copy link
Contributor

拉取/合并请求描述:(PR description)

[

为什么提交这份PR (why to submit this PR)

添加dockerfile和并提供docker image来提高ESP32C3的易用性,同时修改readme文件添加维护者

你的解决方案是什么 (what is your solution)

请提供验证的bsp和config (provide the config and bsp)

  • BSP:
  • .config:
  • action:

]

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

  • 本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
  • 本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality:

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

  • 已经仔细查看过代码改动的对比 Already check the difference between PR and old code
  • 代码风格正确,包括缩进空格,命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
  • 没有垃圾代码,代码尽量精简,不包含#if 0代码,不包含已经被注释了的代码 All redundant code is removed and cleaned up
  • 所有变更均有原因及合理的,并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
  • 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
  • 代码是高质量的 Code in this PR is of high quality
  • 已经使用formatting 等源码格式化工具确保格式符合RT-Thread代码规范 This PR complies with RT-Thread code specification
  • 如果是新增bsp, 已经添加ci检查到.github/workflows/bsp_buildings.yml 详细请参考链接BSP自查

@1078249029 1078249029 requested a review from supperthomas as a code owner May 22, 2025 13:10
@github-actions github-actions bot added the BSP label May 22, 2025
@supperthomas supperthomas requested a review from Copilot May 22, 2025 13:38
Copy link
Contributor

Copilot AI left a 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.md and README.md with 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

Comment on lines +28 to +31
# 4. Clone RT-Thread and switch master
RUN git clone https://github.com/RT-Thread/rt-thread.git && \
cd rt-thread && \
git switch master
Copy link

Copilot AI May 22, 2025

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.

Suggested change
# 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

Copilot uses AI. Check for mistakes.
add-apt-repository universe && \
apt update && \
apt install -y --no-install-recommends \
sudo git wget python3 python3-pip scons vim xz-utils minicom && \
Copy link

Copilot AI May 22, 2025

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/*).

Suggested change
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/* && \

Copilot uses AI. Check for mistakes.

### Docker

如果想要通轻度尝鲜esp32c3,推荐使用docker快速搭建环境,否则请使用原生环境搭建
Copy link

Copilot AI May 22, 2025

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.

Suggested change
如果想要通轻度尝鲜esp32c3,推荐使用docker快速搭建环境,否则请使用原生环境搭建
如果想要轻度尝鲜 ESP32C3,推荐使用 Docker 快速搭建环境,否则请使用原生环境搭建

Copilot uses AI. Check for mistakes.
Comment on lines +44 to +45
| 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 |
Copy link

Copilot AI May 22, 2025

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.

Suggested change
| 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 |

Copilot uses AI. Check for mistakes.
@supperthomas supperthomas merged commit 9e9669b into RT-Thread:master May 22, 2025
36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants