ESPRESSIF SYSTEMS ESP32 Users manual

!

Version 0.1

Copyright © 2015

ESP32

User Guide

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.

This document is structured as follows:

Style Identifiers

This is a code input style.

This is a code output style.

Release Notes

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.

Chapter

Title

Subject

Chapter 1

Introduction

Introduces the ESP32 and software and hardware required.
Explains the software package with details on its architecture and

contents.

Chapter 2

Getting Started

Guides users how to build and upload an application firmware
provided by Espressif.

Appendix

Notices

FCC/CE compliance statement.

Code Input

Code output

Date

Version

Release notes

2015.12

V0.1

Confidential for internal use only.

Confidential

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.

Getting Started to Use SDK 8 ................................................................................................................................

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.1.5.

Running Application 15 ....................................................................................................................................

2.2.

SSC Command Reference 15 ...................................................................................................................................

2.2.1.

op 15 ......................................................................................................................................................................

2.2.2.

sta 16 .....................................................................................................................................................................

2.2.3.

ap 17 ......................................................................................................................................................................

2.2.4.

mac 17 ...................................................................................................................................................................

2.2.5.

dhcp 18 .................................................................................................................................................................

2.2.6.

ip 18 .......................................................................................................................................................................

2.2.7.

reboot 19 .............................................................................................................................................................

2.2.8.

ram 19 ...................................................................................................................................................................

Appendix - Notices 20 ......................................................................................................................................

I.

Federal Communications Commission (FCC) Declaration of Conformity 20 ..............................................

II.

EC Declaration of Conformity 20..........................................................................................................................

Confidential

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.

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

Before getting started to run and develop firmware applications on your ESP32, there are
some hardware and software requirements.

1.2.1.

Hardware

•

An ESP32 development board or ESP-WROOM-03(build-in ESP32).

•

A USB TTL Serial cable or a Micro-USB cable.

•

Debian GNU/Linux OS on an x86 machine.

Notes：

1.

We assume to use the Debian or Ubuntu Linux OS. You may make some modifications for the
other Linux OS.

2.

For more information about ESP-WROOM-03, refer to “ESP-WROOM-03 Specification".

Espressif

2015.12

Confidential

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.

Figure 1-2. Package Components

Bin files to be downloaded to the flash

Example codes of SDK applications

Header files required for compilation

Files for SDK compilation and link

Library files of SDK compilation

Library files of open source code

Compilation tools

Bin files for SSC

driver codes

Sample project template

Extra head files for compiling

Header files provided by Espressif

Header files of freeRTOS

Header files of Json library

Header files of LwIP library

Header files of SSL library

Espressif

2015.12

Confidential

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.
Package Components.

•

For the details of instructions, refer to 2.5.2 Uploading Files.

Espressif

2015.12

Confidential