This is a template application to be used with:
- ESP32-PICO-D4 / ESP-IDF / VS Code template app
The following instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
You will need to install these packages on your PC:
| Tool | Version | Link | Platforms | Comment |
|---|---|---|---|---|
| ESP toolchain | 2.2 | Installation instructions | Windows/Linux/Mac OS | |
| ESP-IDF | 3.3.1 | ESP-IDF files | Platform independent | This version is highly recommended, download via git clone |
| VS Code | 14.1 | https://code.visualstudio.com/ | Windows/Linux/Mac OS |
You may also check Espressifs Get Started Guide for further reference (The link references ESP-IDF version 3.3.1 which is used for this project).
Remark: This project is using the CMAKE build system. GNU make is not supported since the Espressif toolchain will not support this make tool in the future.
This project is based on an Espressif ESP-PICO-D4 chip. Supported hardware includes:
- Espressif board ESP32-PICO-KIT
The ESP32-PICO-Kit is an evaluation board featuring an ESP-PICO-D4 chip including WIFI/BT frontend, a voltage regulator and a USB interface for flashing/monitoring. It features a Micro USB port for connecting to a host PC.
Detailed information about the ESP32-PICO-KIT hardware can be found here: Official ESP32-PICO-KIT V4 / V4.1 Getting Started Guide from Espressif.
REMARK: This project is tested with ESP PICO KIT HW V4.0 but should also work with V4.1.
Perform the following steps to install all tools and perform needed adaption for your environment:
- Install Espressif toolchain
- Install Visual Studio Code
- Install recommended VS Code addins
The easiest way to install ESP-IDF’s prerequisites is to download the ESP-IDF Tools installer from this URL: ESP-IDF tools setup V2.2.
The installer includes the cross-compilers, OpenOCD, cmake and Ninja build tool. The installer can also download and run installers for Python 3.7 and Git For Windows if they are not already installed on the computer. The installer also offers to download one of the ESP-IDF release versions.
Remark: This project was tested with ESP-IDF Release 3.3.1 so it is highly recommended to download this version.
You can also download the required tools and components separately and perform a manual configuration of paths etc.
Detailed information about this step can be found here: ESP IDF get started.
Download and install the free VS Code IDE from here: VS Code homepage.
- Open Extensions view in VS Code (in sidebar or by pressing CTRL+SHIFT+X)
- Search for ms-vscode.cpptools
- Press "install" button
- Wait for installation to complete
After installation of all tools, you can now proceed to setting up the project and building/deploying oit on the ESP32-PICO-D4 target by following these steps:
- Clone this GitHub repository
- Open this project in VS Code
- Adjust project directory settings to your tool installation paths
- Modify ESP-IDF project configuration
- Build the application
- Deploy the application on target
To clone this repository, open a command prompt and type:
git clone https://github.com/slot-tronic/esp32-pico-d4-idf-vscode
The repository will then be cloned into your local git repositories folder.
Detailed information about this step can be found here Cloning a repository.
- Open the VS Code IDE
- Go to Menu "File" -> "Open folder..."
- Select the root folder of this repository and confirm.
- Open the file c_cpp_properties.json in this repository
- Go to the section "env"
- Change the variable "IDF_PATH" to your ESP-IDF installation path
- Change the variable ""COMPILER_PATH" to your gcc compiler path
...
"env": {
"IDF_PATH": "<your_ESP-IDF_path_goes_here>",
"COMPILER_PATH": "<your_gcc-compiler_path_goes_here>"
},
...- Press CTRL+SHIFT+B to open the build target list
- Select build target "menuconfig"
- Change your settings as preferred
- Save settings and exit the configurator
- Rebuild and deploy your application as described in the following sections
Remark: This template project contains a sdkconfig.defaults file. This file overrides some project specific settings in order to allow easy later updates of the ESP-IDF framework. In case you want to change settings listed in sdkconfig.defaults, you have to remove them from this file in order to become effective.
- Press CTRL+SHIFT+B to open the build target list
- Select the build target "build"
- Wait for flash procedure to complete
Perform the following steps to deploy this project on an Espressif ESP-PICO-KIT board:
- Connect the Espressif ESP32-PICO-KIT board to your PC via USB
- Press ALT+CTRL+B to open the build target list
- Select the build target "flash"
- Wait for flash procedure to complete
- Connect to the ESP32-PICO-KIT console with a monitor program and check output
Other targets with a ESP32-PICO-D4 should work in a similar way but were not tested.
Code in this repository is in the Public Domain (or CC0 licensed, at your option.) Unless required by applicable law or agreed to in writing, this software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.