Skip to content

Commit c1cef25

Browse files
committed
feat : Remove esp32s2 config and update document
Signed-off-by: Junyoun <[email protected]>
1 parent 2f77beb commit c1cef25

File tree

6 files changed

+34
-5460
lines changed

6 files changed

+34
-5460
lines changed

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,10 @@ Install the toolchain defined in the chipset SDK you use according to the direct
4545
Usage: python setup.py [BSP_NAME]
4646
--------------------------------------------------
4747
ex) python setup.py esp32
48-
ex) python setup.py esp32s2
4948
ex) python setup.py esp32c3
5049
```
5150

52-
2. Check the build configuration of a sample device application (`apps` folder). If you want to use specific build options, you can directly modify the build configuration file (e.g. `sdkconfig`, `sdkconfig.h`) at the root directory of a sample device application. On the Espressif chipset, you can additionally use the `menuconfig` option for configuration.
51+
2. Check the build configuration of a sample device application (`apps` folder). If you want to use specific build options, you can directly modify the each chipset build configuration file (e.g. `sdkconfig.esp32`, `sdkconfig.esp32c3`) at the root directory of a sample device application. On the Espressif chipset, you can additionally use the `menuconfig` option for configuration.
5352

5453
> If you want to use the default build configuration, you can skip this step.
5554
@@ -59,13 +58,23 @@ Install the toolchain defined in the chipset SDK you use according to the direct
5958
# python build.py {app_path} {option}
6059
$ cd ~/st-device-sdk-c-ref
6160
$ python build.py apps/esp32/switch_example menuconfig
61+
or
62+
# python build.py {bsp_name} {app_name} {option}
63+
$ python build.py esp32 switch_example menuconfig
64+
65+
# For other esp32 chipset series.
66+
$ python build.py esp32c3 switch_example menuconfig
6267
```
6368

6469
3. Run `build.py` in the SDK's root directory. This builds the sample executables and places them in `output/{chip_name}/`.
6570
6671
```sh
6772
$ python build.py apps/esp32/switch_example # python build.py {app_path}
73+
or
74+
$ python build.py esp32 switch_example # python build.py {bsp_name} {app_name}
6875
76+
# For other esp32 chipset series.
77+
$ python build.py esp32c3 switch_example
6978
```
7079
7180
### Flash and Monitor
@@ -85,20 +94,32 @@ Flashing can be done according to the method outlined by the applicable chipset
8594
8695
You can flash the executables into a target device via `build.py` with additional options.
8796
88-
> You do not need to run `python build.py esp32 st_switch` before running `python build.py esp32 st_switch flash`; this will automatically rebuild anything which needs it.
97+
> You do not need to run `python build.py esp32 switch_example` before running `python build.py esp32 switch_example flash`; this will automatically rebuild anything which needs it.
8998
9099
Available Options:
91100
92101
- **clean**: clean previous build outputs
93102
```sh
94103
# python build.py {app_path} {options}
95104
$ python build.py apps/esp32/switch_example clean
105+
or
106+
# python build.py {bsp_name} {app_name} {options}
107+
$ python build.py esp32 switch_example clean
108+
109+
# For other esp32 chipset series.
110+
$ python build.py esp32c3 switch_example clean
96111
```
97112
- **flash**: download executable binaries to the device
98113
- **monitor**: monitor the serial output of device. this option can be used with flash option.
99114
```sh
100115
# python build.py {app_path} {options}
101116
$ python build.py apps/esp32/switch_example flash monitor
117+
or
118+
# python build.py {bsp_name} {app_name} {options}
119+
$ python build.py esp32 switch_example flash monitor
120+
121+
# For other esp32 chipset series.
122+
$ python build.py esp32c3 switch_example flash monitor
102123
```
103124
104125
## License

0 commit comments

Comments
 (0)