Skip to content

Commit 64e668a

Browse files
authored
Merge pull request awsdocs#15 from jasonpcarroll/patch-1
Update getting_started_espressif.md
2 parents 3c237ea + a63e31e commit 64e668a

File tree

1 file changed

+50
-25
lines changed

1 file changed

+50
-25
lines changed

doc_source/userguide/getting_started_espressif.md

+50-25
Original file line numberDiff line numberDiff line change
@@ -74,64 +74,89 @@ For more information about IAM and user accounts, see the [IAM User Guide](https
7474

7575
For more information about policies, see [Permissions and policies in IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_access-management.html)\.
7676

77-
## Get started with the ESP\-IDF v4\.2<a name="setup-espressif-idf42"></a>
77+
## Get started<a name="setup-espressif-idf42"></a>
7878

7979
**Note**
8080
The Linux commands in this tutorial require that you use the Bash shell\.
8181

82-
1. Set up the Espressif hardware\.
82+
### Set up the Espressif Hardware
8383

84-
For information about setting up the ESP32\-DevKitC development board hardware, see the [ ESP32\-DevKitC V4 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/release-v4.2/esp32/hw-reference/esp32/get-started-devkitc.html)\.
85-
86-
For information about setting up the ESP\-WROVER\-KIT development board hardware, see the [ ESP\-WROVER\-KIT V4\.1 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/release-v4.2/esp32/hw-reference/esp32/get-started-wrover-kit.html)\.
84+
+ For information about setting up the ESP32\-DevKitC development board hardware, see the [ ESP32\-DevKitC V4 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/release-v4.2/esp32/hw-reference/esp32/get-started-devkitc.html)\.
85+
+ For information about setting up the ESP\-WROVER\-KIT development board hardware, see the [ ESP\-WROVER\-KIT V4\.1 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/release-v4.2/esp32/hw-reference/esp32/get-started-wrover-kit.html)\.
8786
**Important**
8887
When you reach the **Get Started** section of the Espressif guides, stop, and then return to the instructions on this page\.
8988

90-
1. Set up your development environment\.
89+
### Download Amazon FreeRTOS<a name="download-and-configure-espressif-idf42"></a>
90+
91+
You can download Amazon FreeRTOS from either
92+
+ [GitHub](https://github.com/aws/amazon-freertos) \(For instructions, see the [README\.md](https://github.com/aws/amazon-freertos/blob/main/README.md) file\.\)
93+
+ [FreeRTOS console](https://console.aws.amazon.com/freertos) \(Select the correct **Configuration** and **Hardware Platform** that matches your device, for example "**Connect to AWS IoT \- ESP32\-DevKitC**"\.\)
94+
95+
### Set up your development environment\.
96+
97+
To communicate with your board, you must install a toolchain\. Espressif provides ESP-IDF to develop for their boards. Since ESP-IDF has its own version of the FreeRTOS Kernel integrated as a component, Amazon FreeRTOS includes a custom version of ESP-IDF v4.2 with the FreeRTOS Kernel removed to fix problems with duplicate files when compiling\. To use the custom version of ESP-IDF v4.2 included with Amazon FreeRTOS, follow the below instructions for your host machine's operating system\.
98+
99+
#### Windows
100+
1. Download ESP-IDF's **Universal Online Installer** for Windows from [here](https://dl.espressif.com/dl/esp-idf/?idf=4.2)\.
91101

92-
To communicate with your board, you must download and install a toolchain\. Follow these instructions for your host machine's operating system:
93-
+ [ Standard Setup of Toolchain and prerequisites \(ESP\-IDF v4\.2\) for Windows](https://docs.espressif.com/projects/esp-idf/en/release-v4.2/esp32/get-started/windows-setup.html)\.
94-
+ [ Standard Setup of Toolchain prerequisites \(ESP\-IDF v4\.2\) for macOS](https://docs.espressif.com/projects/esp-idf/en/release-v4.2/esp32/get-started/macos-setup.html)\.
95-
+ [ Standard Setup of Toolchain prerequisites \(ESP\-IDF v4\.2\) for Linux](https://docs.espressif.com/projects/esp-idf/en/release-v4.2/esp32/get-started/linux-setup.html)\.
102+
1. Run the **Universal Online Installer**\.
103+
104+
1. When you get to the **Download or use ESP-IDF** step, choose **Use an existing ESP-IDF directory** and set the **Choose existing ESP-IDF directory** to `freertos/vendors/espressif/esp-idf`\.
105+
106+
1. Complete the installation.
107+
108+
#### macOS
109+
110+
1. Follow [ Standard Setup of Toolchain prerequisites \(ESP\-IDF v4\.2\) for macOS](https://docs.espressif.com/projects/esp-idf/en/release-v4.2/esp32/get-started/macos-setup.html)\.
96111
**Important**
97112
When you reach the "Get ESP\-IDF" instructions under **Next Steps**, stop, and then return to the instructions on this page\.
98113

99-
1. Complete the installation \(Linux / macOS\)\.
114+
1. Open a command line window\.
115+
116+
1. Navigate to the FreeRTOS download directory, and then run the following script to download and install the espressif toolchain for your platform\.
117+
118+
```
119+
vendors/espressif/esp-idf/install.sh
120+
```
121+
122+
1. Add the ESP-IDF toolchain tools to your terminal's path with the following command\.
123+
124+
```
125+
source vendors/espressif/esp-idf/export.sh
126+
```
127+
128+
#### Linux
100129
101-
The ESP\-IDF Windows installer installs all of the necessary tools\. The Linux and macOS platforms require an additional step to complete the installation\. Please follow the steps below after you [Download and configure FreeRTOS](#download-and-configure-espressif-idf42)\.
130+
1. Follow [ Standard Setup of Toolchain prerequisites \(ESP\-IDF v4\.2\) for Linux](https://docs.espressif.com/projects/esp-idf/en/release-v4.2/esp32/get-started/linux-setup.html)\.
131+
**Important**
132+
When you reach the "Get ESP\-IDF" instructions under **Next Steps**, stop, and then return to the instructions on this page\.
102133
103-
1. Open a command line window\.
134+
1. Open a command line window\.
104135
105-
1. Navigate to the FreeRTOS download directory, and then run the following script to download and install the espressif toolchain for your platform\.
136+
1. Navigate to the FreeRTOS download directory, and then run the following script to download and install the espressif toolchain for your platform\.
106137
107138
```
108139
vendors/espressif/esp-idf/install.sh
109140
```
110141
111-
1. Add the ESP\\\-IDF toolchain tools to your terminal's path with the following command\.
142+
1. Add the ESP-IDF toolchain tools to your terminal's path with the following command\.
112143
113144
```
114145
source vendors/espressif/esp-idf/export.sh
115146
```
116147
117-
1. Establish a serial connection\.
148+
### Establish a serial connection
118149
119150
To establish a serial connection between your host machine and the ESP32\-DevKitC, you must install the CP210x USB to UART Bridge VCP drivers\. You can download these drivers from [ Silicon Labs](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)\.
120151
121152
To establish a serial connection between your host machine and the ESP32\-WROVER\-KIT, you must install the FTDI virtual COM port driver\. You can download this driver from [FTDI](https://www.ftdichip.com/Drivers/VCP.htm)\.
122153
123-
For more information, see [ Establish Serial Connection with ESP32](https://docs.espressif.com/projects/esp-idf/en/release-v4.2/esp32/get-started/establish-serial-connection.html)\. After you establish a serial connection, make a note of the serial port for your board's connection\. You need it when you build the demo\.
154+
For more information, see [ Establish Serial Connection with ESP32](https://docs.espressif.com/projects/esp-idf/en/release-v4.2/esp32/get-started/establish-serial-connection.html)\. After you establish a serial connection, make a note of the serial port for your board's connection\. You need it to flash the demo\.
124155
125-
### Download and configure FreeRTOS<a name="download-and-configure-espressif-idf42"></a>
126-
127-
After you set up your environment, you can download FreeRTOS from either
128-
+ [GitHub](https://github.com/aws/amazon-freertos) \(For instructions, see the [README\.md](https://github.com/aws/amazon-freertos/blob/main/README.md) file\.\)
129-
+ [FreeRTOS console](https://console.aws.amazon.com/freertos) \(Select the correct **Configuration** and **Hardware Platform** that matches your device, for example "**Connect to AWS IoT \- ESP32\-DevKitC**"\.\)
156+
### Configure the FreeRTOS demo applications
130157
131158
For this tutorial, the FreeRTOS configuration file is located at `freertos/vendors/espressif/boards/board-name/aws_demos/config_files/FreeRTOSConfig.h`\. \(For example, if `AFR_BOARD espressif.esp32_devkitc` is chosen, the configuration file is located at `freertos/vendors/espressif/boards/esp32/aws_demos/config_files/FreeRTOSConfig.h`\.\)
132159
133-
**Configure the FreeRTOS demo applications**
134-
135160
1. If you're running macOS or Linux, open a terminal prompt\. If you're running Windows, open the "ESP\-IDF 4\.x CMD" app \(if you included this option when you installed the ESP\-IDF toolchain\), or the "Command Prompt" app otherwise\.
136161
137162
1. To verify that you have Python3 installed, run
@@ -902,4 +927,4 @@ The ESP32 supports a maximum of two break points\.
902927
idf.py gdb
903928
```
904929
905-
The program should stop in `main()`\.
930+
The program should stop in `main()`\.

0 commit comments

Comments
 (0)