Users Manual

FCC ID: 2AC7Z-ESP32

Users Manual

Download: PDF
FCCID_2921009

ESP32 User Guide Version 0.1 Copyright © 2015

About This Guide This guide describes the software, firmware environment and development recommendations required to build an application around the 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 l the ESP32 development board. a This document is structured as follows: it Chapter Title Subject Introduces the ESP32 and software and hardware required. Chapter 1 Introduction Explains the software package with details on its architecture and n contents. Guides users how to build and upload an application firmware Chapter 2 Getting Started provided by Espressif. Appendix Style Identifiers Notices e FCC/CE compliance statement. d fi This is a code input style. Code Input o Code output n This is a code output style. C Release Notes Date Version Release notes 2015.12 V0.1 Confidential for internal use only.

Table of Contents 1. Introduction ...............................................................................................................................................4 1.1. ESP32 .......................................................................................................................................................................4 1.2. Requirements .........................................................................................................................................................4 1.2.1. Hardware ......................................................................................................................................................... 4 1.2.2. Software ...........................................................................................................................................................6 2. Getting Started ..........................................................................................................................................8 2.1. a l Getting Started to Use SDK ................................................................................................................................8 it 2.1.1. Process Overview ......................................................................................................................................... 8 2.1.2. Building Toolchain ........................................................................................................................................8 2.1.3. Building Firmware ........................................................................................................................................ 11 2.1.4. Uploading Firmware ................................................................................................................................... 12 2.2. 2.1.5. n Running Application.................................................................................................................................... 15 SSC Command Reference ...................................................................................................................................15 2.2.1. e op ......................................................................................................................................................................15 2.2.2. sta..................................................................................................................................................................... 16 d 2.2.3. ap ......................................................................................................................................................................17 2.2.4. mac...................................................................................................................................................................17 fi 2.2.5. dhcp................................................................................................................................................................. 18 2.2.6. ip....................................................................................................................................................................... 18 n 2.2.7. reboot ............................................................................................................................................................. 19 2.2.8. ram ................................................................................................................................................................... 19 o Appendix - Notices ......................................................................................................................................20 I. Federal Communications Commission (FCC) Declaration of Conformity ..............................................20 C II. EC Declaration of Conformity ..........................................................................................................................20

1. Introduction 1. 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. l 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.2. Requirements it a Before getting started to run and develop firmware applications on your ESP32, there are some hardware and software requirements. 1.2.1. Hardware e n • An ESP32 development board or ESP-WROOM-03(build-in ESP32). • A USB TTL Serial cable or a Micro-USB cable. d • Debian GNU/Linux OS on an x86 machine. fi Notes： 1. We assume to use the Debian or Ubuntu Linux OS. You may make some modifications for the other Linux OS. 2. n For more information about ESP-WROOM-03, refer to “ESP-WROOM-03 Specification". o C Espressif 2015.12

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. l Bin files to be downloaded to the flash Bin files for SSC a Example codes of SDK applications it driver codes e n Sample project template fi d Extra head files for compiling o n Header files required for compilation Header files provided by Espressif Header files of freeRTOS C Header files of Json library Header files of LwIP library Header files of SSL library Files for SDK compilation and link Library files of SDK compilation Library files of open source code Compilation tools Figure 1-2. Package Components Espressif 2015.12

1. Introduction Serial Terminal Tool We recommend using Minicom as a serial terminal tool to show the communication information and debug code. Uploading Tool We recommend using Python 2.6 or 2.7 and esptool_ESP32.py to upload firmware to the flash. • 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. l Package Components. • For the details of instructions, refer to 2.5.2 Uploading Files. it a e n fi d o n C Espressif 2015.12

2. Getting Started 2. Getting Started 2.1. Getting Started to Use SDK l 2.1.1. Process Overview a Start Building toolchain it Building firmware e n fi d Uploading firmware n Configuring firmware 2.1.2. C Building Toolchain o End Figure 2-1. Process Overview 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

2. Getting Started 2. Install the required toolchain packages. sudo apt-get install git autoconf build-essential gperf bison flex texinfo libtool libncurses5-dev wget gawk libc6 python-serial libexpat-dev 2 upgraded, 37 newly installed, 0 to remove and 395 not upgraded. Need to get 10.4 MB of archives. After this operation, 48.7 MB of additional disk space will be used. Do you want to continue? [Y/n] y Setting up texinfo (5.2.0.dfsg.1-2) ... a l it Setting up libwww-perl (6.05-2) ... Setting up liblwp-protocol-https-perl (6.04-2ubuntu0.1) ... Setting up libxml-parser-perl (2.41-1build3) ... Setting up libxml-sax-expat-perl (0.40-2) ... e n update-perl-sax-parsers: Registering Perl SAX parser XML::SAX::Expat with priority 50... update-perl-sax-parsers: Updating overall Perl SAX parser modules d info file... Replacing config file /etc/perl/XML/SAX/ParserDetails.ini with new fi version 3. Create a directory to store the toolchain. 4. n sudo mkdir /opt/Espressif o Make the current user as the owner. sudo chown $USER /opt/Espressif/ C 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'... remote: Counting objects: 28443, done. remote: Total 28443 (delta 0), reused 0 (delta 0), pack-reused 28443 Receiving objects: 100% (28443/28443), 15.83 MiB | 71.00 KiB/s, done. Resolving deltas: 100% (16473/16473), done. Checking connectivity... done. Espressif 2015.12

2. Getting Started 6. Install toolchain. cd crosstool-NG/ ./bootstrap && ./configure --prefix=`pwd` && make && make install For auto-completion, do not forget to install 'ct-ng.comp' into your bash completion directory (usually /etc/bash_completion.d) username:/opt/Espressif/crosstool-NG$ ./ct-ng xtensa-esp108-elf *********************************************************** WARNING! This sample may enable experimental features. a l it Please be sure to review the configuration prior to building and using your toolchain! Now, you have been warned! n *********************************************************** Now configured for "xtensa-esp108-elf" e username:/opt/Espressif/crosstool-NG$ d ./ct-ng build [INFO ] Cleaning-up the toolchain's directory fi [INFO ] Stripping all toolchain executables [INFO ] Cleaning-up the toolchain's directory: done in 1.85s (at n 24:28) [INFO ] Build completed at 20151210.175153 o [INFO ] (elapsed: 24:27.54) [INFO ] Finishing installation (may take a few seconds)... C 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. Espressif 2015.12

2. Getting Started Note： You need to do Step 6 every time you open a new shell, or you can put it inside your .bashrc file. � 2.1.3. Building Firmware 1. Create a directory to store a new project. mkdir ~/Workspace l cd ~/Workspace 2. Download the latest ESP32 RTOS SDK. git clone https://github.com/espressif/ESP32_RTOS_SDK.git Notes： 1. it For the package components of the SDK, refer to “1.3 Package Components”. a 2. 3. mkdir –p ~/Workspace/ESP32_BIN e Create a directory to store the.bin files compiled. n You can build customized project according the ESP32_RTOS_SDK/examples/project_template. d 4. Set the PATHs variable to point to the SDK and BIN files. fi export SDK_PATH=~/Workspace/ESP32_RTOS_SDK export BIN_PATH=~/Workspace/ESP32_BIN ⚠ Warning： o n Make sure you set the correct paths, or it will occur a compile error. 5. Start to compile files. C cd ~/Workspace/project_template make clean make Note： You need to do Step 3 every time you open a new shell, or you can put it inside your .bashrc file. � Espressif 2015.12

2. Getting Started Note： If your project is successfully compiled, the irom1.bin, irom0_flash.bin, and user.ota files will be generated in /Workspace/ESP32_BIN directory. Current contents of /Workspace/ESP32_BIN directory is shown as Table2-1. Table 2-1. ESP32_BIN Directory Files File Name Description blank.bin • Provided with the SDK. l • Used to initialize the system parameters. boot.bin • Provided with the SDK. • Main program. it a irom1.bin • Generated from compiling. • Main program. irom0_flash.bin • Generated from compiling. • Main program. n User.ota • Generated from compiling. • Main program. • Don’t need to be uploaded, and will be updated by OTA. 2.1.4. Uploading Firmware 1. 2. d Power on the board with 5V/1A power. Connect the development board to a PC. e 3. 4. n Install Minicom. sudo apt-get install minicom fi Toggle 8-digit Toggle Switch to the Download Boot as Table 1-2. o 5. Run Minicom. sudo minicom -s C 6. Configure the items as Figure 2-2. Figure 2-2. Configuration items of Minicom Espressif 2015.12

2. Getting Started The configuration items are shown in Table 2-2. Table 2-2. Configuration Items of Minicom Item Value Bps/Par/Bits 115200 8N1 Hardware Flow Control No Software Flow Control No l 7. Upload files. >python esptool_ESP32.py -p dev/tty8 -b 115200 write_flash -ff 40m - a fm qio -fs 2m it 0x0 ~/Workspace/ESP32_BIN/boot.bin 0x04000 ~/Workspace/ESP32_BIN/irom1.bin 0x40000 ~/Workspace/ESP32_BIN/bin/irom0_flash.bin n 0xFC000 ~/Workspace/ESP32_BIN/blank.bin 0x1FC000 ~/Workspace/ESP32_BIN/esp_init_data_default.bin below. Connecting... d e For the configuration instructions, refer to Table 2-3. The system will show the information as fi Erasing flash... Wrote 3072 bytes at 0x00000000 in 0.3 seconds (73.8 kbit/s)... n Erasing flash... Wrote 395264 bytes at 0x04000000 in 43.2 seconds (73.2 kbit/s)... o Erasing flash... Wrote 1024 bytes at 0x40000000 in 0.1 seconds (74.5 kbit/s)... C Erasing flash... Wrote 4096 bytes at 0xfc000000 in 0.4 seconds (73.5 kbit/s)... Erasing flash... Wrote 4096 bytes at 0x1fc00000 in 0.5 seconds (73.8 kbit/s)... Leaving... 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

2. Getting Started Item Value SPI Speed Set the SPI speed of the uploading. The default value is 40 MHz. SPI Mode Set the SPI speed of the uploading. The default value is QIO. Flash Size The size of your flash, We use 2Mbit flash in this example. The flash size of 1MB, 2MB, 4MB, 8MB, 16MB and 32MB are supported. Start Address Set the start addresses of the bin files. The start address of blank.bin and esp_init_data_default.bin may be different when you use a different flash size. For the start Address of different size of flash, refer to Table 2-4. Table 2-4. Configuration Items of uploading files Start Address a l it File Name Notes Flash Size: 1 MB Flash Size: 2 MB boot.bin 0x00000 - irom1.bin 0x04000 - irom0_flash.bin user.ota① blank.bin 0x40000 Doesn’t need to be uploaded. 0xFE000 0x1FE000 e n - - As shown in the figure above, the file will start from the second section(4K) from d bottom of the flash.② As shown in the figure above, the file will esp_init_data_defa fi 0xFC000 0x1FC000 start from the fourth section(4K) from ult.bin③ bottom of the flash.② Notes: n 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. o 3. esp_init_data_default.bin isn’t provided in the version 1.0.0. � C Espressif 2015.12

2. Getting Started Result The flash layout is shown as Figure 2-3. esp_init_data_default.bin 16K 240K 3840K 4K 4K 4K 4K boot.bin irom1.bin irom0_flash.bin blank.bin l System Parameter a Available segment it Figure 2-3. Flash Layout For the flash usage, refer to Table 2-5. n Table 2-5. Flash Usage Segment Name Start Address Length dport0_0_seg dram0_0_seg iram1_0_seg org = 0x3FF00000 d org = 0x3FFD8000 org = 0x40040000 e len = 0x10 len = 0x24000 len = 0x20000 fi irom0_0_seg org = 0x40080010 len = 0x37FFF0 irom0_1_seg org = 0x3FE04010 len = 0x3BFF0 2.1.5. Running Application o n 1. Power off and switch the hardware to the running mode. 2. Power on the hardware and run the application. C � 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

2. Getting Started op -S -o wmode Parameter Table 2-6. op Command Parameter Parameter Description -Q Query Wi-Fi mode. -S Set Wi-Fi mode. l There are 3 Wi-Fi modes: • mode = 1: STA mode a wmode • mode = 2: AP mode it • mode = 3: STA+AP mode 2.2.2. sta n Description sta commands are used to scan the STA network interface, connect or disconnect AP, and e query the connecting status of STA network interface. Example d sta -S [-s ssid] [-b bssid] [-n channel] [-h] sta -Q fi sta -C [-s ssid] [-p password] n sta -D Parameter o Table 2-7. sta Command Parameter Parameter Description C -S scan Scan Access Points. -s ssid Scan or connect Access Points with the ssid. -b bssid Scan the Access Points with the bssid. -n channel Scan the channel. -h Show scan results with hidden ssid Access Points. -Q Show STA connect stutus. -D Disconnected with current Access Points. Espressif 2015.12

2. Getting Started 2.2.3. ap Description ap commands are used to set the parameter of AP network interface. Example ap -S [-s ssid] [-p password] [-t encrypt] [-n channel] [-h] [-m max_sta] ap –Q l ap –L Parameter Parameter -S Table 2-8. ap Command Parameter Set AP mode. it Description a n -s ssid Set AP ssid. -p password Set AP password. e -t encrypt Set AP encrypt mode. -h Hide ssid. d -m max_sta Set AP max connections. fi -Q Show AP parameters. -L Show MAC Address and IP Address of the connected station. 2.2.4. Description Example mac o n mac commands are used to query the MAC address of the network interface. Parameter C mac -Q [-o mode] Parameter -Q Table 2-9. mac Command Parameter Show MAC address. Description • mode = 1: MAC address in STA mode. -o mode • mode = 2: MAC address in AP mode. Espressif 2015.12

2. Getting Started 2.2.5. dhcp Description dhcp commands are used to enable or disable dhcp server/client. Example dchp -S [-o mode] dhcp -E [-o mode] dhcp -Q [-o mode] l Parameter a Table 2-10. dhcp Command Parameter it Parameter Description -S Start DHCP (Client/Server). -E End DHCP (Client/Server). n -Q show DHCP status. • mode = 1 : DHCP client of STA interface. e -o mode • mode = 2 : DHCP server of AP interface. • mode = 3 : both. 2.2.6. Description ip fi d ip command are used to set and query the IP address of the network interface. Example Parameter o n ip -Q [-o mode] ip -S [-i ip] [-o mode] [-m mask] [-g gateway] C Parameter -Q -o mode Table 2-11. ip Command Parameter Show IP address. Description • mode = 1 : IP address of interface STA. • mode = 2 : IP address of interface AP. • mode = 3 : both -S 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 l ram command is used to query the size of the remaining heap in the system. Example a ram it e n fi d o n C Espressif 2015.12

Appendix - Notices Appendix - Notices I. Federal Communications Commission (FCC) Declaration of Conformity This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable l protection against harmful interference in a residential installation. This equipment generates uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is a no guarantee that interference will not occur in a particular installation. If this equipment does it cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures: • Reorient or relocate the receiving antenna. n • Increase the separation between the equipment and the receiver. • Connect the equipment into an outlet on a circuit different from that to which the receiver e is connected. • Consult the dealer or an experienced radio/TV technician for help. Any changes or modifications to this equipment not expressly approved by Espressif may d cause harmful interference and void the user’s authority to operate this equipment. This device complies with Part 15 of the FCC Rules. Operation is subject to the following two fi conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. n FCC Radiation Exposure Statement This equipment complies with FCC radiation exposure limits set forth for an uncontrolled o environment. This equipment should be installed and operated with minimum distance 20cm between the radiator& your body. This transmitter must not be co-located or operating in conjunction with any other antenna or transmitter. II. C EC Declaration of Conformity 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. Espressif 2015.12

The OEM or final integrator must ensure that FCC labeling requirements are met. This includes an additional label on the outside of the final product housing with the following contents: Company Name Model:ESP32 FCC ID:2AC7Z-ESP32 This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) This device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. To satisfy FCC RF Exposure requirements for this transmission devices, a separation distance of 20cm or more should be maintained between the antenna of this device and persons during operation. To ensure compliance, operation at closer than this distance is not recommended. The antenna(s) used for this transmitter must not be co‐located or operating in conjunction with any other antenna or transmitter. Changes or modifications not expressly approved by the party responsible for compliance could void the user's authority to operate the equipment. The modular transmitter must be equipped with either a permanently affixed label or must be capable of electronically displaying its FCC identification number： (A) If using a permanently affixed label, the modular transmitter must be labeled with its own FCC identification number, and, if the FCC identification number is not visible when the module is installed inside another device, then the outside of the device into which the module is installed must also display a label referring to the enclosed module. This exterior label can use wording such as the following: “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. In the latter case, a copy of these instructions must be included in the application for equipment authorization Disclaimer and Copyright Notice Information in this document, including URL references, is subject to change without notice. THIS DOCUMENT IS PROVIDED AS IS WITH NO WARRANTIES WHATSOEVER, INCLUDING ANY WARRANTY OF MERCHANTABILITY, NON-INFRINGEMENT, FITNESS FOR ANY PARTICULAR PURPOSE, OR ANY WARRANTY OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION OR SAMPLE. All liability, including liability for infringement of any proprietary rights, relating to use of information in this document is disclaimed. No licenses express or implied, by estoppel or otherwise, to any intellectual property rights are granted herein. The Wi-Fi Alliance Member logo is a trademark of the Wi-Fi Alliance. Espressif IOT Team All trade names, trademarks and registered trademarks mentioned in this document are http://bbs.espressif.com property of their respective owners, and are hereby acknowledged. Copyright © 2015 Espressif Inc. All rights reserved.


Document Created: 2017-11-19 18:36:09
Document Modified: 2017-11-19 18:36:09
© 2024 FCC.report
This site is not affiliated with or endorsed by the FCC