Page 1
ESP32 User Guide Version 0.1 Copyright 2015...
Page 2
ESP32 development board with build-in ESP32 chip. Note: This guide is only for SDK Verison 1.0.0. Refer to the “ESP32 System Description” for more details on the ESP32 development board. This document is structured as follows:...
Table of Contents 1. Introduction ............................... 1.1. ESP32 ..................................1.2. Requirements ................................. 1.2.1. Hardware ................................. 1.2.2. Software ................................2. Getting Started ............................2.1. Getting Started to Use SDK ..........................2.1.1. Process Overview ............................2.1.2. Building Toolchain ............................2.1.3. Building Firmware ............................
Page 4
1. Introduction Introduction 1.1. ESP32 ESP32 provides a Wi-Fi solution in the 2.4GHz band by using 40nm technology. It delivers highly integrated Wi-Fi SoC solution to meet the continuous demands for efficient power usage, compact design and reliable performance. You can use ESP32 series hardware and software provided by Espressif to develop and program some useful Wi-Fi and wearable electronics applications and products in Internet of Things(IoT) industry.
1. Introduction 1.2.2. Software Development Platform ESP32 RTOS SDK is a development platform provided for the users to develop their project. • For the latest version, go to Download ESP32 RTOS SDK in Github. • For the package components, refer to Figure 1-2.
Page 6
• For the latest version of Python, go to Download Python. • esptool_ESP32.py file is in the ESP32 RTOS SDK > tools folder, refer to Figure 1-2. Package Components. • For the details of instructions, refer to 2.5.2 Uploading Files.
Figure 2-1. Process Overview 2.1.2. Building Toolchain We suggest to choose Crosstool-ng as the compiler toolchain. Follow the instructions below to install Crosstool-ng. Note: Your PC needs to connect to the Internet. 1. Update the system. sudo apt-get update Espressif 2015.12...
Page 8
3. Create a directory to store the toolchain. sudo mkdir /opt/Espressif 4. Make the current user as the owner. sudo chown $USER /opt/Espressif/ 5. Download the latest toolchain installation file. cd /opt/Espressif/ git clone -b esp108-1.21.0 git://github.com/jcmvbkbc/crosstool-NG.git Cloning into 'crosstool-NG'...
Page 9
Note: It takes about dozens of minutes to build toolchain. 7. Set the PATH variable to point to the newly compiled toolchain. export PATH=/opt/Espressif/crosstool-NG/builds/xtensa-esp108-elf/bin: $PATH ⚠ Notice: Make sure you set the correct path, or it will occur a compile error.
2.1.3. Building Firmware 1. Create a directory to store a new project. mkdir ~/Workspace cd ~/Workspace 2. Download the latest ESP32 RTOS SDK. git clone https://github.com/espressif/ESP32_RTOS_SDK.git Notes: For the package components of the SDK, refer to “1.3 Package Components”. You can build customized project according the ESP32_RTOS_SDK/examples/project_template.
3. Toggle 8-digit Toggle Switch to the Download Boot as Table 1-2. 4. Install Minicom. sudo apt-get install minicom 5. Run Minicom. sudo minicom -s 6. Configure the items as Figure 2-2. Figure 2-2. Configuration items of Minicom Espressif 2015.12...
Page 12
Table 2-3. Configuration Items of uploading files Item Value COM Port You can choose an available COM port for the uploading. We use dev/tty in this example. Baud Rate Set the baud rate of the uploading. The default value is 115200 bps. Espressif 2015.12...
Page 13
1. User.ota file doesn’t need to be uploaded, and will be used in OTA upgrading. 2. The flash size of 1MB, 2MB, 4MB, 8MB, 16MB and 32MB are supported. 3. esp_init_data_default.bin isn’t provided in the version 1.0.0. Espressif 2015.12...
2. Power on the hardware and run the application. 2.2. SSC Command Reference Here lists some common Wi-Fi commands for you to test the board. 2.2.1. op Description op commands are used to set and query the Wi-Fi mode of the system. Example op -Q Espressif 2015.12...
Scan or connect Access Points with the ssid. -b bssid Scan the Access Points with the bssid. -n channel Scan the channel. Show scan results with hidden ssid Access Points. Show STA connect stutus. Disconnected with current Access Points. Espressif 2015.12...
MAC address of the network interface. Example mac -Q [-o mode] Parameter Table 2-9. mac Command Parameter Parameter Description Show MAC address. • mode = 1: MAC address in STA mode. -o mode • mode = 2: MAC address in AP mode. Espressif 2015.12...
= 1 : IP address of interface STA. • -o mode mode = 2 : IP address of interface AP. • mode = 3 : both Set IP address. -i ip IP address. -m mask Subnet address mask. -g gateway Default gateway. Espressif 2015.12...
2. Getting Started 2.2.7. reboot Description reboot command is used to reboot the board. Example reboot 2.2.8. ram ram command is used to query the size of the remaining heap in the system. Example Espressif 2015.12...
This equipment can be used in member states of the European Union once the corresponding administrative license is obtained. Espressif, as manufacturer of the product ESP32, declares that the said product complies with the essential requirements established in Article 3 of the Council of Europe Directive 1999/5/ CE, dated 9th March, 1999. ...
Page 20
“Contains Transmitter Module FCC ID: 2AC7Z-ESP32” or “Contains FCC ID: 2AC7Z-ESP32.” Any similar wording that expresses the same meaning may be used. The Grantee may either provide such a label, an example of which must be included in the application for equipment authorization, or, must provide adequate instructions along with the module which explain this requirement.
Need help?
Do you have a question about the ESP32 and is the answer not in the manual?
Questions and answers