Skip to content

Commit 57bf8b2

Browse files
committed
docs(build-system): Modify for ESP8266 platform
1 parent d7fe33b commit 57bf8b2

File tree

1 file changed

+7
-10
lines changed

1 file changed

+7
-10
lines changed

docs/en/api-guides/build-system.rst

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ concept of "components"
66

77
Read this document if you want to know how to organise a new ESP-IDF project.
88

9-
We recommend using the esp-idf-template_ project as a starting point for your project.
9+
We recommend using the project_template project at directory of examples/get-started as a starting point for your project.
1010

1111
Using the Build System
1212
======================
@@ -17,19 +17,17 @@ Overview
1717
========
1818

1919
An ESP-IDF project can be seen as an amalgamation of a number of components.
20-
For example, for a webserver that shows the current humidity, there could be:
20+
For example, for a http request example that shows the current humidity, there could be:
2121

22-
- The ESP32 base libraries (libc, rom bindings etc)
22+
- The SoC base libraries (libc, rom bindings etc)
2323
- The WiFi drivers
2424
- A TCP/IP stack
2525
- The FreeRTOS operating system
26-
- A webserver
27-
- A driver for the humidity sensor
2826
- Main code tying it all together
2927

3028
ESP-IDF makes these components explicit and configurable. To do that,
3129
when a project is compiled, the build environment will look up all the
32-
components in the ESP-IDF directories, the project directories and
30+
components in the SDK directories, the project directories and
3331
(optionally) in additional custom component directories. It then
3432
allows the user to configure the ESP-IDF project using a a text-based
3533
menu system to customize each component. After the components in the
@@ -567,7 +565,7 @@ The file's contents will be added to the .rodata section in flash, and are avail
567565

568566
The names are generated from the full name of the file, as given in COMPONENT_EMBED_FILES. Characters /, ., etc. are replaced with underscores. The _binary prefix in the symbol name is added by objcopy and is the same for both text and binary files.
569567

570-
For an example of using this technique, see :example:`protocols/https_request` - the certificate file contents are loaded from the text .pem file at compile time.
568+
For an example of using this technique, see :example:`protocols/https_mbedtls` - the certificate file contents are loaded from the text .pem file at compile time.
571569

572570

573571
Fully Overriding The Component Makefile
@@ -586,7 +584,6 @@ $(COMPONENT_LIBRARY) for the project make process to link into the app binary.
586584
is overridden then the component can instruct the linker to link other binaries instead.)
587585

588586

589-
.. _esp-idf-template: https://github.com/espressif/esp-idf-template
590587
.. _GNU Make Manual: https://www.gnu.org/software/make/manual/make.html
591588

592589

@@ -605,11 +602,11 @@ Save flash arguments
605602

606603
There're some scenarios that we want to flash the target board without IDF. For this case we want to save the built binaries, esptool.py and esptool write_flash arguments. It's simple to write a script to save binaries and esptool.py. We can use command ``make print_flash_cmd``, it will print the flash arguments::
607604

608-
--flash_mode dio --flash_freq 40m --flash_size detect 0x1000 bootloader/bootloader.bin 0x10000 example_app.bin 0x8000 partition_table_unit_test_app.bin
605+
--flash_mode qio --flash_freq 40m --flash_size 2MB 0x0000 bootloader/bootloader.bin 0x10000 ssc.bin 0x8000 partitions_singleapp.bin
609606

610607
Then use flash arguments as the arguemnts for esptool write_flash arguments::
611608

612-
python esptool.py --chip esp32 --port /dev/ttyUSB0 --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 40m --flash_size detect 0x1000 bootloader/bootloader.bin 0x10000 example_app.bin 0x8000 partition_table_unit_test_app.bin
609+
python esptool.py --chip esp8266 --port /dev/ttyUSB0 --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode qio --flash_freq 40m --flash_size detect 0 bootloader/bootloader.bin 0x10000 example_app.bin 0x8000 partitions_singleapp.bin
613610

614611
Building the Bootloader
615612
=======================

0 commit comments

Comments
 (0)