INTEGRATION¶

Introduction¶

Note

In this section, we introduce how to integrate the lcder 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 activate the ESP-IDF environment. Then type in the following command to create a new component named node_lcd:

idf.py -C driver create-component node_lcd

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

Alternatively, you can mannually create the node_lcd directory in the driver directory, and then create the CMakeLists.txt, node_lcd.h, and node_lcd.c files in the node_lcd directory.

Note

There is also an lcdfont.h file in this chapter, which you can put in the include directory of the node_lcd directory.

Replace the Code¶

Component Level

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

Project Level

Replace the code in main.c/cpp 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, you will see the LCD screen light up and display content.