Skip to content

Commit 73fcd57

Browse files
committed
update REDEME.md
1 parent b7b1f9a commit 73fcd57

File tree

2 files changed

+29
-18
lines changed

2 files changed

+29
-18
lines changed

.github/workflows/build_micropython_xiao_esp32c5.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ on:
1111
jobs:
1212
build:
1313
runs-on: ubuntu-latest
14+
permissions:
15+
contents: write
1416

1517
steps:
1618
- name: Checkout MicroPython

README.md

Lines changed: 27 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,28 @@ This README provides instructions for building and running MicroPython firmware
77
Before building the MicroPython firmware, ensure you have the following:
88

99
1. **Zephyr Development Environment**:
10-
- Install the Zephyr SDK and set up the development environment by following the [Zephyr Getting Started Guide](https://docs.zephyrproject.org/latest/getting_started/index.html).
11-
- Ensure you have Zephyr version 4.0 or later installed, as the Xiao nRF54L15 requires a recent version due to its nRF54L15 SoC.
12-
- Example command to initialize Zephyr v4.0.0:
13-
```bash
14-
west init zephyrproject -m https://github.com/zephyrproject-rtos/zephyr --mr v4.0.0
15-
cd zephyrproject/zephyr
16-
west update
17-
```
18-
- Source the Zephyr environment:
19-
```bash
20-
source zephyrproject/zephyr/zephyr-env.sh
21-
```
10+
- Install the Zephyr SDK and set up the development environment by following the [Zephyr Getting Started Guide](https://docs.zephyrproject.org/latest/getting_started/index.html).
11+
- Ensure you have Zephyr version 4.0 or later installed, as the Xiao nRF54L15 requires a recent version due to its nRF54L15 SoC.
12+
- Example command to initialize Zephyr v4.0.0:
13+
```bash
14+
west init zephyrproject -m https://github.com/zephyrproject-rtos/zephyr --mr v4.0.0
15+
cd zephyrproject/zephyr
16+
west update
17+
```
18+
- Source the Zephyr environment:
19+
```bash
20+
source zephyrproject/zephyr/zephyr-env.sh
21+
```
2222

2323
2. **MicroPython Repository**:
24-
- Clone the MicroPython repository to your local machine:
25-
```bash
26-
git clone --recurse-submodules https://github.com/Seeed-Studio/micropython-seeed-boards.git
27-
```
24+
- Clone the MicroPython repository to your local machine:
25+
```bash
26+
git clone --recurse-submodules https://github.com/Seeed-Studio/micropython-seeed-boards.git
27+
```
2828

2929
4. **Dependencies**:
30-
- Install required tools: Python 3.10 or later, CMake 3.20.0 or later, and the Zephyr SDK toolchain.
31-
- Verify the installation by building a sample Zephyr application to confirm your setup.
30+
- Install required tools: Python 3.10 or later, CMake 3.20.0 or later, and the Zephyr SDK toolchain.
31+
- Verify the installation by building a sample Zephyr application to confirm your setup.
3232

3333
## Building the Firmware
3434

@@ -68,6 +68,15 @@ west build ./lib/micropython/ports/zephyr --pristine --board xiao_nrf54l15/nrf54
6868
west build ./lib/micropython/ports/zephyr --pristine --board xiao_ble -- -DCONF_FILE=./lib/micropython/ports/zephyr/prj_minimal.conf
6969
```
7070
71+
#### For Xiao esp32c5
72+
* For the MicroPython firmware of the Seeed XIAO ESP32C5, a CI (Continuous Integration) automatic compilation workflow has been added. You only need to download the corresponding firmware from the release and use the appropriate flashing method.
73+
* Here, the esptool tool is recommended for flashing. It should be noted that when flashing the MicroPython firmware, **the starting address must be specified as 0x2000.**
74+
```bash
75+
# e.g. Flashing the Firmware
76+
esptool.py --chip esp32c5 --port /dev/cu.usbmodem11301 --baud 460800 write_flash -z 0x2000 micropython_xiao_esp32c5.bin
77+
```
78+
79+
7180
### Notes
7281
- If you encounter issues with undefined Kconfig symbols (e.g., `NET_SOCKETS_POSIX_NAMES`), check the `lib/micropython/ports/zephyr/prj.conf` file and comment out or remove unsupported configurations.
7382
- Ensure the Zephyr version matches the requirements of the MicroPython port (v4.0 is recommended).

0 commit comments

Comments
 (0)