New Project

Create Demo

• Using the shortcut F1, enter esp-idf:show examples projects
  

• Select your current IDF version
  

• Take the Hello world demo as an example

①Select the corresponding demo
②Its readme will state what chip the demo applies to (how to use the demo and the file structure are described below, omitted here)
③Click to create the demo

• Select the path to save the demo, and require that the demos cannot use folders with the same name
  

Modify COM Port

• The corresponding COM ports are shown here, click to modify them
  
• Please select the COM ports according to your device (You can view it from the device manager)
  
• In case of a download failure, please press the Reset button for more than 1 second or enter download mode, and wait for the PC to recognize the device again before downloading once more
  

Modify Driver Object

• Select the object we need to drive, which is our main chip ESP32S3
  

• Choose the path to openocd, it doesn't affect us here, so let's just choose one
  

Other Status Bar Functions

①.ESP-IDF Development Environment Version Manager, when our project requires differentiation of development environment versions, it can be managed by installing different versions of ESP-IDF. When the project uses a specific version, it can be switched to by utilizing it
②.Device flashing COM port, select to flash the compiled program into the chip
③.Select set-target chip model, select the corresponding chip model, for example, ESP32-P4-NANO needs to choose esp32p4 as the target chip
④.menuconfig, click it to Modify sdkconfig configuration file Project configuration details
⑤.fullclean button, when the project compilation error or other operations pollute the compiled content, you can clean up all the compiled content by clicking it
⑥.Build project, when a project satisfies the build, click this button to compile
⑦.Current download mode, the default is UART
⑧.flash button, when a project build is completed, select the COM port of the corresponding development board, and click this button to flash the compiled firmware to the chip
⑨.monitor enable flashing port monitoring, when a project passes through Build --> Flash, click this button to view the log of output from flashing port and debugging port, so as to observe whether the application works normally
⑩.Debug
⑪.Build Flash Monitor one-click button, which is used to continuously execute Build --> Flash --> Monitor, often referred to as "little flame"

Compile, Flash and Serial Port Monitor

• Click on the all-in-one button we described before to compile, flash and open the serial port monitor
  

• It may take a long time to compile especially for the first time
  

• During this process, the ESP-IDF may take up a lot of CPU resources, so it may cause the system to lag
  
• If it is the first time to flash the program for a new project, you will need to select the download method, and select UART
  

• This can also be changed later in the Download methods section (click on it to pop up the options)
  

• As it comes with the onboard automatic download circuit, it can be downloaded automatically without manual operation
• After successful download, it will automatically enter the serial monitor, you can see the chip output the corresponding information and be prompted to restart after 10S
  

Use the IDF Demos

Open In the Software

• Open VScode software and select the folder to open the demo
  

• Select the provided ESP-IDF example and click to select the file (located in the /Demo/ESP-IDF path under demo)
  

Open from Outside the Software

• Select the project directory correctly and open the project, otherwise it will affect the compilation and flashing of subsequent programs
  

• After connecting the device, select the COM port and model, click below to compile and flash to achieve program control
  

ESP-IDF Project Details

• Component: The components in ESP-IDF are the basic modules for building applications, each component is usually a relatively independent code base or library, which can implement specific functions or services, and can be reused by applications or other components, similar to the definition of libraries in Python development.
  • Component reference: The import of libraries in the Python development environment only requires to "import library name or path", while ESP-IDF is based on the C language, and the importing of libraries is configured and defined through CMakeLists.txt.
  • The purpose of CmakeLists.txt: When compiling ESP-IDF, the build tool CMake first reads the content of the top-level CMakeLists.txt in the project directory to read the build rules and identify the content to be compiled. When the required components and demos are imported into the CMakeLists.txt, the compilation tool CMake will import each content that needs to be compiled according to the index. The compilation process is as follows:

Demo description

• This example demonstrates the functions of each device on the board, page 1 displays SD Card, Flash Size, Battery Voltage and other parameters, and page 2 shows the music playback interface; In addition, speech recognition is added to this demo.

Hardware connection

• Insert the TF card into the development board (can be used without a TF card)
• Connect the development board to the computer

Code analysis

• Driver_Init(): Initializes the resources required by the hardware, driver, and system, and creates a task to cycle through the hardware driver
  • Hardware initialization: Driver_Init() is responsible for initializing multiple hardware modules, such as power management, clock, I2C bus, external I/O, sensors, etc.
  • Task creation: xTaskCreatePinnedToCore() creates a FreeRTOS task Driver_Loop and binds it to Core 0. This means that the Driver_Loop function will be executed in a loop, handling the hardware-related operations. This task will run concurrently with other tasks, contributing to the real-time performance of the hardware driver
  • Modular design: The initialization function disperses the initialization of each hardware into different modules, which is easy to maintain and expand. If there's new hardware that needs to be supported, just add the initialization code here

• Driver_Loop(): This function runs in a loop in a FreeRTOS task, periodically performing the work of each hardware driver. It is the core component of most hardware driver operations
  • Loop execution hardware driver: Call multiple hardware driver functions in a loop within the Driver_Loop() function, such as QMI8658_Loop(), PCF85063_Loop(), BAT_Get_Volts() and PWR_Loop(), these are hardware operations that are performed in real time
    • QMI8658_Loop(): Handles interaction with QMI8658 sensor and reads sensor data
    • PCF85063_Loop(): Handles PCF85063 clock module and updates the time
    • BAT_Get_Volts(): Gets the current battery voltage to ensure that the device battery level meets the requirements
    • PWR_Loop(): Performs power management tasks, monitors power supply status, and controls power on or off
  • Scheduled task: Using vTaskDelay(pdMS_TO_TICKS(100)), the Driver_Loop() function delays once every 100 milliseconds. This helps ensure that the task does not consume excessive CPU resources and avoids too frequent operations on hardware
  • Delete task: vTaskDelete(NULL) is used to delete the current task, but since while(1) is an infinite loop, the actual line of code will never be executed

Result demonstration

• LCD screen display

• LCD screen display parameter description

• Page 2 is the UI page for playing mp3 audio in the root directory of the TF card
• This program enables speech recognition by default, the wake-up word is "hi esp", after waking up, you can speak the command after the backlight is dimmed (if the backlight is not dimmed, it means that it has not been woken up, the recognition requirements are strict, the pronunciation needs to be standard, and the speech speed is slowed down)
• The following are available in several formats of MIC test audio (Please note that every time the hi esp wake-up fails, please reset the audio to the playback location of the wake-up word and replay it)
• Please do not perform speech recognition when using the speaker to play audio
• The reason the wake-up word plays twice in the test audio is due to the current firmware version's initial wake-up requiring the device to be focused (an analogy), and the current firmware does not permit the disabling of this function

// Commands
Turn on the backlight
Turn off the backlight
Backlight is brightest
Backlight is darkest