Skip to content
This repository was archived by the owner on Jan 14, 2022. It is now read-only.

Commit 22ad130

Browse files
author
Espressif Systems
committed
Update README.md
1 parent b51216e commit 22ad130

File tree

1 file changed

+86
-62
lines changed

1 file changed

+86
-62
lines changed

‎README.md

Lines changed: 86 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,89 @@
1-
# ESP32_RTOS_SDK #
1+
# ESP32_RTOS_SDK #
22

3-
----------
4-
5-
ESP32 SDK based on FreeRTOS.
6-
7-
## Toolchain ##
8-
9-
We suggest to choose **Crosstool-ng** as the compiler toolchain. Follow the instructions below to install Crosstool-ng.
10-
11-
1. Install the required toolchain packages.
12-
sudo apt-get install git autoconf build-essential gperf bison flex texinfo libtool libncurses5-dev wget gawk libc6-dev-i386 python-serial libexpat-dev`
13-
2. Create a directory (e.g./opt/Espressif) to store thetoolchain.
14-
sudo mkdir /opt/Espressif
15-
3. Make the current user the owner.
16-
sudo chown $USER /opt/Espressif/
17-
4. Download the latest toolchain installation file to the directory created in step 2.
18-
cd /opt/Espressif/
19-
git clone -b esp108-1.21.0 git://github.com/jcmvbkbc/crosstool-NG.git
20-
5. Install toolchain.
21-
cd crosstool-NG
22-
./bootstrap && ./configure --prefix=`pwd` && make && make install
23-
./ct-ng xtensa-esp108-elf
24-
./ct-ng build
25-
6. Set the PATH variable to point to the newly compiled toolchain.
26-
export PATH=/opt/Espressif/crosstool-NG/builds/xtensa-esp108-elf/bin:$PATH
27-
> Note：
28-
You need to do Step 6 once you open a new shell, or you can put it inside your .bashrcfile
29-
30-
## Compile ##
31-
32-
1. Create a directory (e.g.~/Workspace) to store a new project.
33-
mkdir ~/Workspace
34-
2. Clone ESP32 RTOS SDK.
35-
cd ~/Workspace
36-
git clone https://github.com/espressif/ESP32_RTOS_SDK.git
37-
3. Copy ESP32_RTOS_SDK/examples/project_template to Workspace directory created in step 1.
38-
cp ~/Workspace/ESP32_RTOS_SDK/examples/project_template ~/Workspace/ -r
39-
4. Create a directory (e.g./Workspace/ESP32_BIN) to store the bin files compiled.
40-
mkdir –p ~/Workspace/ESP32_BIN
41-
5. Set SDK_PATH as the path of SDK files and BIN_PATH as the path of .bin files compiled.
42-
export SDK_PATH=~/Workspace/ESP32_RTOS_SDK
43-
export BIN_PATH=~/Workspace/ESP32_BIN
3+
ESP32 SDK based on FreeRTOS.
4+
5+
## Toolchain ##
6+
7+
We suggest to choose **Crosstool-ng** as the compiler toolchain. Follow the instructions below to install Crosstool-ng.
8+
9+
Step 1. Install the required toolchain packages.
10+
```
11+
sudo apt-get install git autoconf build-essential gperf bison flex texinfo libtool libncurses5-dev wget gawk libc6-dev-i386 python-serial libexpat-dev
12+
```
13+
Step 2. Create a directory (e.g./opt/Espressif) to store the toolchain.
14+
```
15+
sudo mkdir /opt/Espressif
16+
```
17+
Step 3. Make the current user the owner.
18+
```
19+
sudo chown $USER /opt/Espressif/
20+
```
21+
Step 4. Download the latest toolchain installation file to the directory created in Step 2.
22+
```
23+
cd /opt/Espressif/
24+
git clone -b esp108-1.21.0 git://github.com/jcmvbkbc/crosstool-NG.git
25+
```
26+
Step 5. Install toolchain.
27+
```
28+
cd crosstool-NG
29+
./bootstrap && ./configure --prefix=`pwd` && make && make install
30+
./ct-ng xtensa-esp108-elf
31+
./ct-ng build
32+
```
33+
Step 6. Set the PATH variable to point to the newly compiled toolchain.
34+
```
35+
export PATH=/opt/Espressif/crosstool-NG/builds/xtensa-esp108-elf/bin:$PATH
36+
```
37+
> Note：
38+
You need to do Step 6 once you open a new shell, or you can put it inside your .bashrc file
39+
40+
## Project template Compile ##
41+
42+
Step 1. Create a directory (e.g.~/Workspace) to store a new project.
43+
```
44+
mkdir ~/Workspace
45+
```
46+
Step 2. Clone ESP32 RTOS SDK.
47+
```
48+
cd ~/Workspace
49+
git clone https://github.com/espressif/ESP32_RTOS_SDK.git
50+
```
51+
Step 3. Copy ESP32_RTOS_SDK/examples/project_template to Workspace directory created in Step 1.
52+
```
53+
cp ~/Workspace/ESP32_RTOS_SDK/examples/project_template ~/Workspace/ -r
54+
```
55+
Step 4. Create a directory (e.g.~/Workspace/ESP32_BIN) to store the bin files compiled.
56+
```
57+
mkdir –p ~/Workspace/ESP32_BIN
58+
```
59+
Step 5. Set SDK_PATH as the path of SDK files and BIN_PATH as the path of .bin files compiled.
60+
```
61+
export SDK_PATH=~/Workspace/ESP32_RTOS_SDK
62+
export BIN_PATH=~/Workspace/ESP32_BIN
63+
```
4464
> Notice：
4565
> Make sure you set the correct paths, or it will occur a compile error.
46-
6. Start to compile files
47-
make clean
48-
make
49-
> Note：
50-
You need to do Step 3 every time you open a new shell, or you can put it inside your .bashrc file.
51-
52-
If your project is successfully compiled, the irom1.bin, irom0_flash.bin, and user.ota files will
53-
be generated in ~/Workspace/ESP32_BIN directory.
54-
55-
## Download ##
56-
57-
Please use espressif's **Flash Download tools**.
58-
Download addresses:
59-
60-
boot.bin---------->0x00000
61-
irom1.bin--------->0x04000
62-
irom0_flash.bin--->0x40000
63-
blank.bin--------->0xfe000(for 1MB SPI Flash)
64-
65-
For more details, please refer to http://www.esp32.com
66+
67+
Step 6. Start to compile files
68+
```
69+
make clean
70+
make
71+
```
72+
> Note：
73+
You need to do Step 3 every time you open a new shell, or you can put it inside your .bashrc file.
74+
75+
If your project is successfully compiled, the irom1.bin, irom0_flash.bin, and user.ota files will
76+
be generated in ~/Workspace/ESP32_BIN directory.
77+
78+
## Download ##
79+
80+
Please use espressif's **Flash Download tools**.
81+
82+
Download addresses:
83+
```
84+
boot.bin---------->0x00000
85+
irom1.bin--------->0x04000
86+
irom0_flash.bin--->0x40000
87+
blank.bin--------->0xfe000(for 1MB SPI Flash)
88+
```
89+
For more details, please refer to http://www.esp32.com

0 commit comments

Comments
 (0)