INTEGRATION¶

Introduction¶

Note

In this section, we introduce how to integrate the KEY(exit) driver into the project.

Create a New Component¶

Warning

Before you create a component in the driver directory, make sure you have incorporated the driver directory into the project by adding the path to the driver directory to the EXTRA_COMPONENT_DIRS variable in the project-level CMakeLists.txt file.

Open the project in VSCode, open the integrated terminal, and type in

get_idf

to actiate the ESP-IDF environment. Then type in the following command to create a new component named exit`:

idf.py -C driver create-component exit

The command above means to create a new component named exitin thedriverdirectory. After executing the command, you will see a new directory named exit in the driver directory. And the command will automatically generate the CMakeLists.txt file for the new component, as well as the exit.h and exit.c files.

Alternatively, you can mannually create the exitdirectory in thedriverdirectory, and then create theCMakeLists.txt,exit.h, andexit.cfiles in the exit directory.

Replace the Code¶

Component Level

Replace the code in this section into the CMakelists.txt, exit.h, and exit.c files under the component.

Project Level

Replace the code in main.c with the corresponding code. No need to change the CMakeLists.txt file at the project level.

Compile and Flash the Project¶

Open the project in VSCode, open the integrated terminal, and type in

idf.py build flash monitor

Now, press the button, and the LED status flips.