https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/
Get Started
This document is intended to help you set up the software development environment for the hardware based on the ESP32 chip by Espressif. After that, a simple example will show you how to use ESP-IDF (Espressif IoT Development Framework) for menu configuration, then for building and flashing firmware onto an ESP32 board.
Note
This is documentation for stable version v4.4.1 of ESP-IDF. Other ESP-IDF Versions are also available.
Introduction
ESP32 is a system on a chip that integrates the following features:
- Wi-Fi (2.4 GHz band)
- Bluetooth
- Dual high performance Xtensa® 32-bit LX6 CPU cores
- Ultra Low Power co-processor
- Multiple peripherals
Powered by 40 nm technology, ESP32 provides a robust, highly integrated platform, which helps meet the continuous demands for efficient power usage, compact design, security, high performance, and reliability.
Espressif provides basic hardware and software resources to help application developers realize their ideas using the ESP32 series hardware. The software development framework by Espressif is intended for development of Internet-of-Things (IoT) applications with Wi-Fi, Bluetooth, power management and several other system features.
What You Need
Hardware:
- An ESP32 board
- USB cable - USB A / micro USB B
- Computer running Windows, Linux, or macOS
Software:
You have a choice to either download and install the following software manually
- Toolchain to compile code for ESP32
> sudo apt install cmake- Build tools - CMake and Ninja to build a full Application for ESP32
- ESP-IDF that essentially contains API (software libraries and source code) for ESP32 and scripts to operate the Toolchain
or get through the onboarding process using the following official plugins for integrated development environments (IDE) described in separate documents
Development of applications for ESP32
Development Board Overviews
If you have one of ESP32 development boards listed below, you can click on the link to learn more about its hardware.
Installation Step by Step
This is a detailed roadmap to walk you through the installation process.
Setting up Development Environment
Step 1. Install prerequisites
Some tools need to be installed on the computer before proceeding to the next steps. Follow the links below for the instructions for your OS:
Note
This guide uses the directory ~/esp on Linux and macOS or %userprofile%\esp on Windows as an installation folder for ESP-IDF. You can use any directory, but you will need to adjust paths for the commands respectively. Keep in mind that ESP-IDF does not support spaces in paths.
Step 2. Get ESP-IDF
To build applications for the ESP32, you need the software libraries provided by Espressif in ESP-IDF repository.
To get ESP-IDF, navigate to your installation directory and clone the repository with git clone, following instructions below specific to your operating system.
Linux and macOS
Open Terminal, and run the following commands:
mkdir -p ~/esp
cd ~/esp
git clone -b v4.4.1 --recursive https://github.com/espressif/esp-idf.git
ESP-IDF will be downloaded into ~/esp/esp-idf.
Consult ESP-IDF Versions for information about which ESP-IDF version to use in a given situation.
Windows
In addition to installing the tools, ESP-IDF Tools Installer for Windows introduced in Step 1 can also download a copy of ESP-IDF.
Consult ESP-IDF Versions for information about which ESP-IDF version to use in a given situation.
If you wish to download ESP-IDF without the help of ESP-IDF Tools Installer, refer to these instructions.
Step 3. Set up the tools
Aside from the ESP-IDF, you also need to install the tools used by ESP-IDF, such as the compiler, debugger, Python packages, etc.
Windows
ESP-IDF Tools Installer for Windows introduced in Step 1 installs all the required tools.
If you want to install the tools without the help of ESP-IDF Tools Installer, open the Command Prompt and follow these steps:
cd %userprofile%\esp\esp-idf
install.bat esp32
or with Windows PowerShell
cd ~/esp/esp-idf
./install.ps1 esp32
Linux and macOS
cd ~/esp/esp-idf
./install.sh esp32
or with Fish shell
cd ~/esp/esp-idf
./install.fish esp32
Note
To install tools for multiple targets you can specify those targets at once. For example: ./install.sh esp32,esp32c3,esp32s3. To install tools for all supported targets, run the script without specifying targets ./install.sh or use ./install.sh all.
Alternative File Downloads
The tools installer downloads a number of files attached to GitHub Releases. If accessing GitHub is slow then it is possible to set an environment variable to prefer Espressif’s download server for GitHub asset downloads.
Note
This setting only controls individual tools downloaded from GitHub releases, it doesn’t change the URLs used to access any Git repositories.
Windows
To prefer the Espressif download server when running the ESP-IDF Tools Installer, mark the Use Espressif download mirror instead of GitHub in the screen Select Components section Optimization.
Linux and macOS
To prefer the Espressif download server when installing tools, use the following sequence of commands when running install.sh:
cd ~/esp/esp-idf
export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets"
./install.sh
Customizing the tools installation path
The scripts introduced in this step install compilation tools required by ESP-IDF inside the user home directory: $HOME/.espressif on Linux and macOS, %USERPROFILE%\.espressif on Windows. If you wish to install the tools into a different directory, set the environment variable IDF_TOOLS_PATH before running the installation scripts. Make sure that your user account has sufficient permissions to read and write this path.
If changing the IDF_TOOLS_PATH, make sure it is set to the same value every time the Install script (install.bat, install.ps1 or install.sh) and an Export script (export.bat, export.ps1 or export.sh) are executed.
Step 4. Set up the environment variables
The installed tools are not yet added to the PATH environment variable. To make the tools usable from the command line, some environment variables must be set. ESP-IDF provides another script which does that.
Windows
ESP-IDF Tools Installer for Windows creates an “ESP-IDF Command Prompt” shortcut in the Start Menu. This shortcut opens the Command Prompt and sets up all the required environment variables. You can open this shortcut and proceed to the next step.
Alternatively, if you want to use ESP-IDF in an existing Command Prompt window, you can run:
%userprofile%\esp\esp-idf\export.bat
or with Windows PowerShell
.$HOME/esp/esp-idf/export.ps1
Linux and macOS
In the terminal where you are going to use ESP-IDF, run:
. $HOME/esp/esp-idf/export.sh
or for fish (supported only since fish version 3.0.0):
. $HOME/esp/esp-idf/export.fish
Note the space between the leading dot and the path!
If you plan to use esp-idf frequently, you can create an alias for executing export.sh:
- Copy and paste the following command to your shell’s profile (.profile, .bashrc, .zprofile, etc.)
-
alias get_idf='. $HOME/esp/esp-idf/export.sh'
- Refresh the configuration by restarting the terminal session or by running source [path to profile], for example, source ~/.bashrc.
Now you can run get_idf to set up or refresh the esp-idf environment in any terminal session.
Technically, you can add export.sh to your shell’s profile directly; however, it is not recommended. Doing so activates IDF virtual environment in every terminal session (including those where IDF is not needed), defeating the purpose of the virtual environment and likely affecting other software.
Step 5. Start a Project
Now you are ready to prepare your application for ESP32. You can start with get-started/hello_world project from examples directory in IDF.
Copy the project get-started/hello_world to ~/esp directory:
Linux and macOS
cd ~/esp
cp -r $IDF_PATH/examples/get-started/hello_world .
Windows
cd %userprofile%\esp
xcopy /e /i %IDF_PATH%\examples\get-started\hello_world hello_world
There is a range of example projects in the examples directory in ESP-IDF. You can copy any project in the same way as presented above and run it. It is also possible to build examples in-place, without copying them first.
Important
The ESP-IDF build system does not support spaces in the paths to either ESP-IDF or to projects.
Step 6. Connect Your Device
Now connect your ESP32 board to the computer and check under what serial port the board is visible.
Serial ports have the following patterns in their names:
- Windows: names like COM1
- Linux: starting with /dev/tty
- macOS: starting with /dev/cu.
If you are not sure how to check the serial port name, please refer to Establish Serial Connection with ESP32 for full details.
> ls /dev/tty*
> sudo chmod a+rw /dev/ttyUSB0
> sudo usermod -a -G dialout $USER
Note
Keep the port name handy as you will need it in the next steps.
Step 7. Configure
Navigate to your hello_world directory from Step 5. Start a Project, set ESP32 chip as the target and run the project configuration utility menuconfig.
Linux and macOS
cd ~/esp/hello_world
idf.py set-target esp32
idf.py menuconfig
Windows
cd %userprofile%\esp\hello_world
idf.py set-target esp32
idf.py menuconfig
Setting the target with idf.py set-target esp32 should be done once, after opening a new project. If the project contains some existing builds and configuration, they will be cleared and initialized. The target may be saved in environment variable to skip this step at all. See Selecting the Target for additional information.
If the previous steps have been done correctly, the following menu appears:
Project configuration - Home window
You are using this menu to set up project specific variables, e.g. Wi-Fi network name and password, the processor speed, etc. Setting up the project with menuconfig may be skipped for “hello_word”. This example will run with default configuration.
Attention
If you use ESP32-DevKitC board with the ESP32-SOLO-1 module, or ESP32-DevKitM-1 board with the ESP32-MIN1-1(1U) module, enable single core mode (CONFIG_FREERTOS_UNICORE) in menuconfig before flashing examples.
Note
The colors of the menu could be different in your terminal. You can change the appearance with the option --style. Please run idf.py menuconfig --help for further information.
Step 8. Build the Project
Build the project by running:
idf.py build
This command will compile the application and all ESP-IDF components, then it will generate the bootloader, partition table, and application binaries.
$ idf.py build
Running cmake in directory /path/to/hello_world/build
Executing "cmake -G Ninja --warn-uninitialized /path/to/hello_world"...
Warn about uninitialized values.
-- Found Git: /usr/bin/git (found version "2.17.0")
-- Building empty aws_iot component due to configuration
-- Component names: ...
-- Component paths: ...
... (more lines of build system output)
[527/527] Generating hello_world.bin
esptool.py v2.3.1
Project build complete. To flash, run this command:
../../../components/esptool_py/esptool/esptool.py -p (PORT) -b 921600 write_flash --flash_mode dio --flash_size detect --flash_freq 40m 0x10000 build/hello_world.bin build 0x1000 build/bootloader/bootloader.bin 0x8000 build/partition_table/partition-table.bin
or run 'idf.py -p PORT flash'
If there are no errors, the build will finish by generating the firmware binary .bin files.
Step 9. Flash onto the Device
Flash the binaries that you just built (bootloader.bin, partition-table.bin and hello_world.bin) onto your ESP32 board by running:
idf.py -p PORT [-b BAUD] flash
Replace PORT with your ESP32 board’s serial port name from Step 6. Connect Your Device.
> idf.py -p /dev/ttyUSB0 flash
You can also change the flasher baud rate by replacing BAUD with the baud rate you need. The default baud rate is 460800.
For more information on idf.py arguments, see idf.py.
Note
The option flash automatically builds and flashes the project, so running idf.py build is not necessary.
Encountered Issues While Flashing?
If you run the given command and see errors such as “Failed to connect”, there might be several reasons for this. One of the reasons might be issues encountered by esptool.py, the utility that is called by the build system to reset the chip, interact with the ROM bootloader, and flash firmware. One simple solution to try is manual reset described below, and if it does not help you can find more details about possible issues in Troubleshooting.
esptool.py resets ESP32 automatically by asserting DTR and RTS control lines of the USB to serial converter chip, i.e., FTDI or CP210x (for more information, see Establish Serial Connection with ESP32). The DTR and RTS control lines are in turn connected to GPIO0 and CHIP_PU (EN) pins of ESP32, thus changes in the voltage levels of DTR and RTS will boot ESP32 into Firmware Download mode. As an example, check the schematic for the ESP32 DevKitC development board.
In general, you should have no problems with the official esp-idf development boards. However, esptool.py is not able to reset your hardware automatically in the following cases:
- Your hardware does not have the DTR and RTS lines connected to GPIO0 and CHIP_PU
- The DTR and RTS lines are configured differently
- There are no such serial control lines at all
Depending on the kind of hardware you have, it may also be possible to manually put your ESP32 board into Firmware Download mode (reset).
- For development boards produced by Espressif, this information can be found in the respective getting started guides or user guides. For example, to manually reset an esp-idf development board, hold down the Boot button (GPIO0) and press the EN button (CHIP_PU).
- For other types of hardware, try pulling GPIO0 down.
Troubleshooting: Permission denied
> sudo chmod a+rw /dev/ttyUSB0
Normal Operation
When flashing, you will see the output log similar to the following:
...
esptool.py --chip esp32 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 40m --flash_size 2MB 0x8000 partition_table/partition-table.bin 0x1000 bootloader/bootloader.bin 0x10000 hello_world.bin
esptool.py v3.0-dev
Serial port /dev/ttyUSB0
Connecting........_
Chip is ESP32D0WDQ6 (revision 0)
Features: WiFi, BT, Dual Core, Coding Scheme None
Crystal is 40MHz
MAC: 24:0a:c4:05:b9:14
Uploading stub...
Running stub...
Stub running...
Changing baud rate to 460800
Changed.
Configuring flash size...
Compressed 3072 bytes to 103...
Writing at 0x00008000... (100 %)
Wrote 3072 bytes (103 compressed) at 0x00008000 in 0.0 seconds (effective 5962.8 kbit/s)...
Hash of data verified.
Compressed 26096 bytes to 15408...
Writing at 0x00001000... (100 %)
Wrote 26096 bytes (15408 compressed) at 0x00001000 in 0.4 seconds (effective 546.7 kbit/s)...
Hash of data verified.
Compressed 147104 bytes to 77364...
Writing at 0x00010000... (20 %)
Writing at 0x00014000... (40 %)
Writing at 0x00018000... (60 %)
Writing at 0x0001c000... (80 %)
Writing at 0x00020000... (100 %)
Wrote 147104 bytes (77364 compressed) at 0x00010000 in 1.9 seconds (effective 615.5 kbit/s)...
Hash of data verified.
Leaving...
Hard resetting via RTS pin...
Done
If there are no issues by the end of the flash process, the board will reboot and start up the “hello_world” application.
If you’d like to use the Eclipse or VS Code IDE instead of running idf.py, check out the Eclipse guide, VS Code guide.
Step 10. Monitor
To check if “hello_world” is indeed running, type idf.py -p PORT monitor (Do not forget to replace PORT with your serial port name).
This command launches the IDF Monitor application:
$ idf.py -p /dev/ttyUSB0 monitor
Running idf_monitor in directory [...]/esp/hello_world/build
Executing "python [...]/esp-idf/tools/idf_monitor.py -b 115200 [...]/esp/hello_world/build/hello_world.elf"...
--- idf_monitor on /dev/ttyUSB0 115200 ---
--- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H ---
ets Jun 8 2016 00:22:57
rst:0x1 (POWERON_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)
ets Jun 8 2016 00:22:57
...
After startup and diagnostic logs scroll up, you should see “Hello world!” printed out by the application.
...
Hello world!
Restarting in 10 seconds...
This is esp32 chip with 2 CPU core(s), WiFi/BT/BLE, silicon revision 1, 2MB external flash
Minimum free heap size: 298968 bytes
Restarting in 9 seconds...
Restarting in 8 seconds...
Restarting in 7 seconds...
To exit IDF monitor use the shortcut Ctrl+].
If IDF monitor fails shortly after the upload, or, if instead of the messages above, you see random garbage similar to what is given below, your board is likely using a 26 MHz crystal. Most development board designs use 40 MHz, so ESP-IDF uses this frequency as a default value.
If you have such a problem, do the following:
- Exit the monitor.
- Go back to menuconfig.
- Go to Component config –> ESP32-specific –> Main XTAL frequency, then change CONFIG_ESP32_XTAL_FREQ_SEL to 26 MHz.
- After that, build and flash the application again.
Note
You can combine building, flashing and monitoring into one step by running:
idf.py -p PORT flash monitor
See also:
- IDF Monitor for handy shortcuts and more details on using IDF monitor.
- idf.py for a full reference of idf.py commands and options.
That’s all that you need to get started with ESP32!
Now you are ready to try some other examples, or go straight to developing your own applications.
Important
Some of examples do not support ESP32 because required hardware is not included in ESP32 so it cannot be supported.
If building an example, please check the README file for the Supported Targets table. If this is present including ESP32 target, or the table does not exist at all, the example will work on ESP32.
Updating ESP-IDF
You should update ESP-IDF from time to time, as newer versions fix bugs and provide new features. The simplest way to do the update is to delete the existing esp-idf folder and clone it again, as if performing the initial installation described in Step 2. Get ESP-IDF.
Another solution is to update only what has changed. The update procedure depends on the version of ESP-IDF you are using.
After updating ESP-IDF, execute the Install script again, in case the new ESP-IDF version requires different versions of tools. See instructions at Step 3. Set up the tools.
Once the new tools are installed, update the environment using the Export script. See instructions at Step 4. Set up the environment variables.
========================================================
카메라 제어 예전부터 꿈(?)꾸던 아이템인데 기회가 없어 접근을 하지 못하다 최근 접근할 기회가 생겨 알아보게 되었다. 사실..의지가 없었던 거지.
뭐 아무튼 이것저것 알아보던 중 ESP-EYE라는 개발 보드와 SDK 가 있다는 것을 알게 되었다. 이전에 이미 ESP32 One 보드(waveshare에서 판매하는 ESP32+camera 개발 보드)가 있지만 ESP 정품 개발 보드를 사용해 예상하지 못한 변수를 제외하고 싶어 ESP-EYE를 구매했다. ESP 사이트와 한국대리점인 IDK에도 단종인데 가치창조기술에 아직 판매하고 있어서 구매했다.(정가보다 조금 비쌈)
구성품은 아래 그림과 같이 귀여운 케이스에 ESP-EYE 보드와 연결할 수 있는 케이블이 들어있다. 구매는 각자 알아서.
그럼 지금부터 저 보드를 어떻게 써먹을 것인가? 시작해보자!
1. SDK 다운로드
ESP의 ESP-EYE 소개 링크다. 들어가 보면 ESP-EYE에 대한 소개와 각종 자료를 다운로드할 수 있다.
https://www.espressif.com/en/products/devkits/esp-eye/overview
아래로 쭉 내리다 보면 아래와 같은 메뉴가 보임! 아래 이미지는 본 포스팅을 작성하는 2021년 10월 기준이다.
여기서 "Download on GitHub"을 눌러 SDK를 다운로드하도록 하자.
"Download on GitHub"을 클릭하면 위와 같은 페이지가 나타날 것이다. 우측 중간? 쯤 보면 "Code"가 보일 것이고 이 버튼을 클릭하고 "Download ZIP" 버튼을 클릭해 코드를 다운로드한다.
그럼 이렇게 다운로드가 될 것이고, 이것을 적절한 경로에 압축을 풀어준다. 나 같은 경우는 아래 그림과 같이 압축을 풀었다.
여기까지는 그냥 따라 하면 된다. 이렇게 압축을 풀어서 VSC로 열면... 컴파일이.. 당연히 안된다.
하...
컴파일을 해보자!!!
(VSC 개발환경 구축은 https://vuzwa.tistory.com/entry/ESPEspressif-%EA%B0%9C%EB%B0%9C-%ED%99%98%EA%B2%BD-%EA%B5%AC%EC%B6%95%ED%95%98%EA%B8%B0with-Visual-Studio-Code?category=955289) 이 포스팅 참조!
2. ESP-WHO-MASTER 컴파일 하기
esp-who-master 압축을 풀면 examples 폴더가 보인다.
examples -> single_chip 순서대로 들어가면 아래와 같은 예제 폴더가 보인다.
ESP-EYE라는 개발 보드의 이름에 어울리게 얼굴인식, 손인식, 음성인식 등의 예제가 있지만 나는 가장 기본적인 Wi-Fi 카메라의 기능만 확인해볼 것이다. 이거 하면 나머지도 쉽게 할 수 있지 않을까?
camera_web_server 폴더로 이동하면 아래와 같이 보일 것이다.
자 그럼 VSC를 실행하고 camera_web_server폴더를 열어보자. 처음 폴더를 열면 VSC가 무언가를 열심히 하고 아래와 같이 완료된 화면을 볼 수 있다.
아무것도 없으니 먼저 configure를 해주자.
F1을 눌러 "ESP-IDF: SDK Configuration editor (menuconfig)"를 입력하고 엔터!! 우측 하단에 뭔가 실행되는 것이 보일 것이다.
이 화면에서 한~~~~~~~~참 동안 멈춰있을 것이다.(아마도?) 자 그럼 취소를 누르고 esp-who-master 폴더로 다시 가보자. esp-who-master 폴더에 component 폴더가 보일 것이다. 여기 들어가면 아래 그림과 같이 폴더 4개가 있다.
각 폴더를 열어 확인해 보면 esp32-camera와 esp-face 폴더에는 내용이 비어있는 것을 확인할 수 있다. 하.. 해주려면 다 해주지 저건 왜 비워놓은 건데?
저기다.. 뭘 넣어야 할까? 정답은 README.md 파일에서 찾을 수 있다. 다시 뒤로 돌아가 esp-who-master 폴더로 이동해 README.md 파일을 열어 내용을 확인해보면
이렇단다. 링크 들어가서 다운로드하여서 넣으란다. 따라 해 보자.
https://github.com/espressif/esp32-camera/tree/master
위에서 esp-who-master 받을 때와 마찬가지로 Code -> Download ZIP를 눌러 다운로드한다.
이것도 다운로드한다.
https://github.com/espressif/esp-face/tree/master
다운로드하고, 압축 풀어서, 그대로 복사해서
esp32-camera-master는 esp32-camera에 그대로 복사, esp-dl-master은 esp-face에 그대로 복사한다. 그리고 다시 VSC로 돌아와 F1을 눌러 "ESP-IDF: SDK Configuration editor (menuconfig)"를 입력하고 엔터!!
그럼 아래 그림과 같이 configuration editor 화면이 나타난다.
여기까지 완료했으면 Save를 누르고 좌측 하단의 "ESP-IDF Build project"(6번째 버튼)를 누른다. 한~~~ 참 걸린다. 현재 사용 중인 PC가 RAM 32GB에 i7인데도.. 휴
빌드 중... 힘내라 힘!!!
한 3 분기 다렸는데 에러가 난다.. 아 idf가 없구나? 넣어줘야지. esp-who-master 폴더에 esp-idf 폴더를 보면 비어있는 것을 확인할 수 있다. idf의 경로를 변경해주면 되겠지만 귀찮아서 그냥 idf를 전부 복사해서 넣었다.(하드디스크 용량은 차고 넘치니까~~~~!)
자, 다시 빌드!!!
하 또 에러가 난다. "fd_forward.h"가 없단다. 이건 또 뭐야??? 그래서 찾아봤지. 후
이 뒤로 정신없이 하다 보니 파일을 찾아서 컴파일하고 다운로드까지 성공했는데 파일을 어디서 받았는지 기억이 안 난다..^^; 그래서 내가 작업 완료한 파일 올리려고 했으나, 용량제한이 있어요 ㅜㅜ 필요하신분은 쪽지주시면 보내드릴게요!
완료되면 아래와 같은 창을 확인할 수 있다.
PC or 스마트폰의 Wi-Fi를 켜면 "ESP Camera"가 보일 것이다.
연결에 성공하면 아래와 같은 로그를 확인할 수 있다.
연결하고 웹 브라우저를 열어 "192.168.4.1"을 입력해 들어가면 아래와 같은 창이 나온다.
여기서 "Start Stream"을 누르면 영상이 나타날 것이다.
자 이제.. OmniVision의 Image sensor 칩의 데이터 시트를 파보고, Wi-Fi를 열심히 들여다봐야겠다.
'프로세싱+아두이노+안드로이드' 카테고리의 다른 글
Arduino I2C SPI (1) | 2022.06.26 |
---|---|
Moving Average Filter (Physical Computing) (0) | 2022.06.21 |
아두이노 ESP32 - 환경 설정 - 윈도우 (0) | 2022.06.05 |
Laser Engraver Software Update for XY-Plotter V2.0&V2.02——BenBox 2.12.45 (0) | 2022.05.24 |
Benbox With Eleks Laser Engraver (GearBest /Banggood) (0) | 2022.05.24 |
댓글